Adds configuration options to `auth.disableLocalStrategy` to allow customization of how payload treats an auth enabled collection. Two new properties have been added to `disableLocalStrategy`: - `enableFields` Include auth fields on the collection even though the local strategy is disabled. Useful when you do not want the database or types to vary depending on the auth configuration used. - `optionalPassword`: makes the password field not required
470 lines
11 KiB
TypeScript
470 lines
11 KiB
TypeScript
/* tslint:disable */
|
|
/* eslint-disable */
|
|
/**
|
|
* This file was automatically generated by Payload.
|
|
* DO NOT MODIFY IT BY HAND. Instead, modify your source Payload config,
|
|
* and re-run `payload generate:types` to regenerate this file.
|
|
*/
|
|
|
|
export interface Config {
|
|
auth: {
|
|
users: UserAuthOperations;
|
|
'partial-disable-locale-strategies': PartialDisableLocaleStrategyAuthOperations;
|
|
'api-keys': ApiKeyAuthOperations;
|
|
'public-users': PublicUserAuthOperations;
|
|
};
|
|
collections: {
|
|
users: User;
|
|
'partial-disable-locale-strategies': PartialDisableLocaleStrategy;
|
|
'api-keys': ApiKey;
|
|
'public-users': PublicUser;
|
|
relationsCollection: RelationsCollection;
|
|
'payload-locked-documents': PayloadLockedDocument;
|
|
'payload-preferences': PayloadPreference;
|
|
'payload-migrations': PayloadMigration;
|
|
};
|
|
collectionsJoins: {};
|
|
collectionsSelect: {
|
|
users: UsersSelect<false> | UsersSelect<true>;
|
|
'partial-disable-locale-strategies': PartialDisableLocaleStrategiesSelect<false> | PartialDisableLocaleStrategiesSelect<true>;
|
|
'api-keys': ApiKeysSelect<false> | ApiKeysSelect<true>;
|
|
'public-users': PublicUsersSelect<false> | PublicUsersSelect<true>;
|
|
relationsCollection: RelationsCollectionSelect<false> | RelationsCollectionSelect<true>;
|
|
'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
|
|
'payload-preferences': PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>;
|
|
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
|
|
};
|
|
db: {
|
|
defaultIDType: number;
|
|
};
|
|
globals: {};
|
|
globalsSelect: {};
|
|
locale: null;
|
|
user:
|
|
| (User & {
|
|
collection: 'users';
|
|
})
|
|
| (PartialDisableLocaleStrategy & {
|
|
collection: 'partial-disable-locale-strategies';
|
|
})
|
|
| (ApiKey & {
|
|
collection: 'api-keys';
|
|
})
|
|
| (PublicUser & {
|
|
collection: 'public-users';
|
|
});
|
|
jobs: {
|
|
tasks: unknown;
|
|
workflows: unknown;
|
|
};
|
|
}
|
|
export interface UserAuthOperations {
|
|
forgotPassword: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
login: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
registerFirstUser: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
unlock: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
}
|
|
export interface PartialDisableLocaleStrategyAuthOperations {
|
|
forgotPassword: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
login: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
registerFirstUser: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
unlock: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
}
|
|
export interface ApiKeyAuthOperations {
|
|
forgotPassword: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
login: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
registerFirstUser: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
unlock: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
}
|
|
export interface PublicUserAuthOperations {
|
|
forgotPassword: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
login: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
registerFirstUser: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
unlock: {
|
|
email: string;
|
|
password: string;
|
|
};
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "users".
|
|
*/
|
|
export interface User {
|
|
id: number;
|
|
adminOnlyField?: string | null;
|
|
roles: ('admin' | 'editor' | 'moderator' | 'user' | 'viewer')[];
|
|
namedSaveToJWT?: string | null;
|
|
group?: {
|
|
liftedSaveToJWT?: string | null;
|
|
};
|
|
groupSaveToJWT?: {
|
|
saveToJWTString?: string | null;
|
|
saveToJWTFalse?: string | null;
|
|
};
|
|
saveToJWTTab?: {
|
|
test?: string | null;
|
|
};
|
|
tabSaveToJWTString?: {
|
|
includedByDefault?: string | null;
|
|
};
|
|
tabLiftedSaveToJWT?: string | null;
|
|
unnamedTabSaveToJWTString?: string | null;
|
|
unnamedTabSaveToJWTFalse?: string | null;
|
|
custom?: string | null;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
enableAPIKey?: boolean | null;
|
|
apiKey?: string | null;
|
|
apiKeyIndex?: string | null;
|
|
email: string;
|
|
resetPasswordToken?: string | null;
|
|
resetPasswordExpiration?: string | null;
|
|
salt?: string | null;
|
|
hash?: string | null;
|
|
loginAttempts?: number | null;
|
|
lockUntil?: string | null;
|
|
password?: string | null;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "partial-disable-locale-strategies".
|
|
*/
|
|
export interface PartialDisableLocaleStrategy {
|
|
id: number;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
email: string;
|
|
resetPasswordToken?: string | null;
|
|
resetPasswordExpiration?: string | null;
|
|
salt?: string | null;
|
|
hash?: string | null;
|
|
loginAttempts?: number | null;
|
|
lockUntil?: string | null;
|
|
password?: string | null;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "api-keys".
|
|
*/
|
|
export interface ApiKey {
|
|
id: number;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
enableAPIKey?: boolean | null;
|
|
apiKey?: string | null;
|
|
apiKeyIndex?: string | null;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "public-users".
|
|
*/
|
|
export interface PublicUser {
|
|
id: number;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
email: string;
|
|
resetPasswordToken?: string | null;
|
|
resetPasswordExpiration?: string | null;
|
|
salt?: string | null;
|
|
hash?: string | null;
|
|
_verified?: boolean | null;
|
|
_verificationToken?: string | null;
|
|
loginAttempts?: number | null;
|
|
lockUntil?: string | null;
|
|
password?: string | null;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "relationsCollection".
|
|
*/
|
|
export interface RelationsCollection {
|
|
id: number;
|
|
rel?: (number | null) | User;
|
|
text?: string | null;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-locked-documents".
|
|
*/
|
|
export interface PayloadLockedDocument {
|
|
id: number;
|
|
document?:
|
|
| ({
|
|
relationTo: 'users';
|
|
value: number | User;
|
|
} | null)
|
|
| ({
|
|
relationTo: 'partial-disable-locale-strategies';
|
|
value: number | PartialDisableLocaleStrategy;
|
|
} | null)
|
|
| ({
|
|
relationTo: 'api-keys';
|
|
value: number | ApiKey;
|
|
} | null)
|
|
| ({
|
|
relationTo: 'public-users';
|
|
value: number | PublicUser;
|
|
} | null)
|
|
| ({
|
|
relationTo: 'relationsCollection';
|
|
value: number | RelationsCollection;
|
|
} | null);
|
|
globalSlug?: string | null;
|
|
user:
|
|
| {
|
|
relationTo: 'users';
|
|
value: number | User;
|
|
}
|
|
| {
|
|
relationTo: 'partial-disable-locale-strategies';
|
|
value: number | PartialDisableLocaleStrategy;
|
|
}
|
|
| {
|
|
relationTo: 'api-keys';
|
|
value: number | ApiKey;
|
|
}
|
|
| {
|
|
relationTo: 'public-users';
|
|
value: number | PublicUser;
|
|
};
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-preferences".
|
|
*/
|
|
export interface PayloadPreference {
|
|
id: number;
|
|
user:
|
|
| {
|
|
relationTo: 'users';
|
|
value: number | User;
|
|
}
|
|
| {
|
|
relationTo: 'partial-disable-locale-strategies';
|
|
value: number | PartialDisableLocaleStrategy;
|
|
}
|
|
| {
|
|
relationTo: 'api-keys';
|
|
value: number | ApiKey;
|
|
}
|
|
| {
|
|
relationTo: 'public-users';
|
|
value: number | PublicUser;
|
|
};
|
|
key?: string | null;
|
|
value?:
|
|
| {
|
|
[k: string]: unknown;
|
|
}
|
|
| unknown[]
|
|
| string
|
|
| number
|
|
| boolean
|
|
| null;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-migrations".
|
|
*/
|
|
export interface PayloadMigration {
|
|
id: number;
|
|
name?: string | null;
|
|
batch?: number | null;
|
|
updatedAt: string;
|
|
createdAt: string;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "users_select".
|
|
*/
|
|
export interface UsersSelect<T extends boolean = true> {
|
|
adminOnlyField?: T;
|
|
roles?: T;
|
|
namedSaveToJWT?: T;
|
|
group?:
|
|
| T
|
|
| {
|
|
liftedSaveToJWT?: T;
|
|
};
|
|
groupSaveToJWT?:
|
|
| T
|
|
| {
|
|
saveToJWTString?: T;
|
|
saveToJWTFalse?: T;
|
|
};
|
|
saveToJWTTab?:
|
|
| T
|
|
| {
|
|
test?: T;
|
|
};
|
|
tabSaveToJWTString?:
|
|
| T
|
|
| {
|
|
includedByDefault?: T;
|
|
};
|
|
tabLiftedSaveToJWT?: T;
|
|
unnamedTabSaveToJWTString?: T;
|
|
unnamedTabSaveToJWTFalse?: T;
|
|
custom?: T;
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
enableAPIKey?: T;
|
|
apiKey?: T;
|
|
apiKeyIndex?: T;
|
|
email?: T;
|
|
resetPasswordToken?: T;
|
|
resetPasswordExpiration?: T;
|
|
salt?: T;
|
|
hash?: T;
|
|
loginAttempts?: T;
|
|
lockUntil?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "partial-disable-locale-strategies_select".
|
|
*/
|
|
export interface PartialDisableLocaleStrategiesSelect<T extends boolean = true> {
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
email?: T;
|
|
resetPasswordToken?: T;
|
|
resetPasswordExpiration?: T;
|
|
salt?: T;
|
|
hash?: T;
|
|
loginAttempts?: T;
|
|
lockUntil?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "api-keys_select".
|
|
*/
|
|
export interface ApiKeysSelect<T extends boolean = true> {
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
enableAPIKey?: T;
|
|
apiKey?: T;
|
|
apiKeyIndex?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "public-users_select".
|
|
*/
|
|
export interface PublicUsersSelect<T extends boolean = true> {
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
email?: T;
|
|
resetPasswordToken?: T;
|
|
resetPasswordExpiration?: T;
|
|
salt?: T;
|
|
hash?: T;
|
|
_verified?: T;
|
|
_verificationToken?: T;
|
|
loginAttempts?: T;
|
|
lockUntil?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "relationsCollection_select".
|
|
*/
|
|
export interface RelationsCollectionSelect<T extends boolean = true> {
|
|
rel?: T;
|
|
text?: T;
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-locked-documents_select".
|
|
*/
|
|
export interface PayloadLockedDocumentsSelect<T extends boolean = true> {
|
|
document?: T;
|
|
globalSlug?: T;
|
|
user?: T;
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-preferences_select".
|
|
*/
|
|
export interface PayloadPreferencesSelect<T extends boolean = true> {
|
|
user?: T;
|
|
key?: T;
|
|
value?: T;
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "payload-migrations_select".
|
|
*/
|
|
export interface PayloadMigrationsSelect<T extends boolean = true> {
|
|
name?: T;
|
|
batch?: T;
|
|
updatedAt?: T;
|
|
createdAt?: T;
|
|
}
|
|
/**
|
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
* via the `definition` "auth".
|
|
*/
|
|
export interface Auth {
|
|
[k: string]: unknown;
|
|
}
|
|
|
|
|
|
declare module 'payload' {
|
|
// @ts-ignore
|
|
export interface GeneratedTypes extends Config {}
|
|
} |