payload
Version:
Node, React, Headless CMS and Application Framework built on Next.js
199 lines • 6.89 kB
TypeScript
import type { GraphQLNonNull, GraphQLObjectType } from 'graphql';
import type { DeepRequired, IsAny } from 'ts-essentials';
import type { CustomPreviewButton, CustomPublishButton, CustomSaveButton, CustomSaveDraftButton } from '../../admin/types.js';
import type { Access, EditConfig, Endpoint, EntityDescription, EntityDescriptionComponent, GeneratePreviewURL, LabelFunction, LivePreviewConfig, MetaConfig, StaticLabel } from '../../config/types.js';
import type { DBIdentifierName } from '../../database/types.js';
import type { Field, FlattenedField } from '../../fields/config/types.js';
import type { GlobalSlug, RequestContext, TypedGlobal, TypedGlobalSelect } from '../../index.js';
import type { PayloadRequest, SelectIncludeType, Where } from '../../types/index.js';
import type { IncomingGlobalVersions, SanitizedGlobalVersions } from '../../versions/types.js';
export type DataFromGlobalSlug<TSlug extends GlobalSlug> = TypedGlobal[TSlug];
export type SelectFromGlobalSlug<TSlug extends GlobalSlug> = TypedGlobalSelect[TSlug];
export type BeforeValidateHook = (args: {
context: RequestContext;
data?: any;
/** The global which this hook is being run on */
global: SanitizedGlobalConfig;
originalDoc?: any;
req: PayloadRequest;
}) => any;
export type BeforeChangeHook = (args: {
context: RequestContext;
data: any;
/** The global which this hook is being run on */
global: SanitizedGlobalConfig;
originalDoc?: any;
req: PayloadRequest;
}) => any;
export type AfterChangeHook = (args: {
context: RequestContext;
doc: any;
/** The global which this hook is being run on */
global: SanitizedGlobalConfig;
previousDoc: any;
req: PayloadRequest;
}) => any;
export type BeforeReadHook = (args: {
context: RequestContext;
doc: any;
/** The global which this hook is being run on */
global: SanitizedGlobalConfig;
req: PayloadRequest;
}) => any;
export type AfterReadHook = (args: {
context: RequestContext;
doc: any;
findMany?: boolean;
/** The global which this hook is being run on */
global: SanitizedGlobalConfig;
query?: Where;
req: PayloadRequest;
}) => any;
export type GlobalAdminOptions = {
/**
* Custom admin components
*/
components?: {
elements?: {
Description?: EntityDescriptionComponent;
/**
* Replaces the "Preview" button
*/
PreviewButton?: CustomPreviewButton;
/**
* Replaces the "Publish" button
* + drafts must be enabled
*/
PublishButton?: CustomPublishButton;
/**
* Replaces the "Save" button
* + drafts must be disabled
*/
SaveButton?: CustomSaveButton;
/**
* Replaces the "Save Draft" button
* + drafts must be enabled
* + autosave must be disabled
*/
SaveDraftButton?: CustomSaveDraftButton;
};
views?: {
/**
* Set to a React component to replace the entire Edit View, including all nested routes.
* Set to an object to replace or modify individual nested routes, or to add new ones.
*/
edit?: EditConfig;
};
};
/** Extension point to add your custom data. Available in server and client. */
custom?: Record<string, any>;
/**
* Custom description for collection
*/
description?: EntityDescription;
/**
* Specify a navigational group for globals in the admin sidebar.
* - Provide a string to place the entity in a custom group.
* - Provide a record to define localized group names.
* - Set to `false` to exclude the entity from the sidebar / dashboard without disabling its routes.
*/
group?: false | Record<string, string> | string;
/**
* Exclude the global from the admin nav and routes
*/
hidden?: ((args: {
user: PayloadRequest['user'];
}) => boolean) | boolean;
/**
* Hide the API URL within the Edit View
*/
hideAPIURL?: boolean;
/**
* Live preview options
*/
livePreview?: LivePreviewConfig;
meta?: MetaConfig;
/**
* Function to generate custom preview URL
*/
preview?: GeneratePreviewURL;
};
export type GlobalConfig<TSlug extends GlobalSlug = any> = {
/**
* Do not set this property manually. This is set to true during sanitization, to avoid
* sanitizing the same global multiple times.
*/
_sanitized?: boolean;
access?: {
read?: Access;
readDrafts?: Access;
readVersions?: Access;
update?: Access;
};
admin?: GlobalAdminOptions;
/** Extension point to add your custom data. Server only. */
custom?: Record<string, any>;
/**
* Customize the SQL table name
*/
dbName?: DBIdentifierName;
endpoints?: false | Omit<Endpoint, 'root'>[];
fields: Field[];
/**
* Specify which fields should be selected always, regardless of the `select` query which can be useful that the field exists for access control / hooks
*/
forceSelect?: IsAny<SelectFromGlobalSlug<TSlug>> extends true ? SelectIncludeType : SelectFromGlobalSlug<TSlug>;
graphQL?: {
disableMutations?: true;
disableQueries?: true;
name?: string;
} | false;
hooks?: {
afterChange?: AfterChangeHook[];
afterRead?: AfterReadHook[];
beforeChange?: BeforeChangeHook[];
beforeRead?: BeforeReadHook[];
beforeValidate?: BeforeValidateHook[];
};
label?: LabelFunction | StaticLabel;
/**
* Enables / Disables the ability to lock documents while editing
* @default true
*/
lockDocuments?: {
duration: number;
} | false;
slug: string;
/**
* Options used in typescript generation
*/
typescript?: {
/**
* Typescript generation name given to the interface type
*/
interface?: string;
};
versions?: boolean | IncomingGlobalVersions;
};
export interface SanitizedGlobalConfig extends Omit<DeepRequired<GlobalConfig>, 'endpoints' | 'fields' | 'slug' | 'versions'> {
endpoints: Endpoint[] | false;
fields: Field[];
/**
* Fields in the database schema structure
* Rows / collapsible / tabs w/o name `fields` merged to top, UIs are excluded
*/
flattenedFields: FlattenedField[];
slug: GlobalSlug;
versions: SanitizedGlobalVersions;
}
export type Globals = {
config: SanitizedGlobalConfig[];
graphQL?: {
[slug: string]: {
mutationInputType: GraphQLNonNull<any>;
type: GraphQLObjectType;
versionType?: GraphQLObjectType;
};
} | false;
};
//# sourceMappingURL=types.d.ts.map