Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
142 lines
4.0 KiB
Plaintext
142 lines
4.0 KiB
Plaintext
export type Autosave = {
|
|
/**
|
|
* Define an `interval` in milliseconds to automatically save progress while documents are edited.
|
|
* Document updates are "debounced" at this interval.
|
|
*
|
|
* @default 800
|
|
*/
|
|
interval?: number;
|
|
/**
|
|
* When set to `true`, the "Save as draft" button will be displayed even while autosave is enabled.
|
|
* By default, this button is hidden to avoid redundancy with autosave behavior.
|
|
*
|
|
* @default false
|
|
*/
|
|
showSaveDraftButton?: boolean;
|
|
};
|
|
export type SchedulePublish = {
|
|
/**
|
|
* Define a date format to use for the time picker.
|
|
*
|
|
* @example 'hh:mm' will give a 24 hour clock
|
|
*
|
|
* @default 'h:mm aa' which is a 12 hour clock
|
|
*/
|
|
timeFormat?: string;
|
|
/**
|
|
* Intervals for the time picker.
|
|
*
|
|
* @default 5
|
|
*/
|
|
timeIntervals?: number;
|
|
};
|
|
export type IncomingDrafts = {
|
|
/**
|
|
* Enable autosave to automatically save progress while documents are edited.
|
|
* To enable, set to true or pass an object with options.
|
|
*/
|
|
autosave?: Autosave | boolean;
|
|
/**
|
|
* Localizes the status field.
|
|
*
|
|
* Only effective if the experimental `experimental.localizeStatus` is enabled.
|
|
*
|
|
* @experimental
|
|
* @default false
|
|
*/
|
|
localizeStatus?: boolean;
|
|
/**
|
|
* Allow for editors to schedule publish / unpublish events in the future.
|
|
*/
|
|
schedulePublish?: boolean | SchedulePublish;
|
|
/**
|
|
* Set validate to true to validate draft documents when saved.
|
|
*
|
|
* @default false
|
|
*/
|
|
validate?: boolean;
|
|
};
|
|
export type SanitizedDrafts = {
|
|
/**
|
|
* Enable autosave to automatically save progress while documents are edited.
|
|
* To enable, set to true or pass an object with options.
|
|
*/
|
|
autosave: Autosave | false;
|
|
/**
|
|
* Localizes the status field.
|
|
*
|
|
* Only effective if the experimental `experimental.localizeStatus` is enabled.
|
|
*
|
|
* @experimental
|
|
* @default false
|
|
*/
|
|
localizeStatus?: boolean;
|
|
/**
|
|
* Allow for editors to schedule publish / unpublish events in the future.
|
|
*/
|
|
schedulePublish: boolean | SchedulePublish;
|
|
/**
|
|
* Set validate to true to validate draft documents when saved.
|
|
*
|
|
* @default false
|
|
*/
|
|
validate: boolean;
|
|
};
|
|
export type IncomingCollectionVersions = {
|
|
/**
|
|
* Enable Drafts mode for this collection.
|
|
* To enable, set to true or pass an object with draft options.
|
|
*/
|
|
drafts?: boolean | IncomingDrafts;
|
|
/**
|
|
* Use this setting to control how many versions to keep on a document by document basis.
|
|
* Must be an integer. Use 0 to save all versions.
|
|
*
|
|
* @default 100
|
|
*/
|
|
maxPerDoc?: number;
|
|
};
|
|
export interface SanitizedCollectionVersions extends Omit<IncomingCollectionVersions, 'drafts'> {
|
|
/**
|
|
* Enable Drafts mode for this collection.
|
|
* To enable, set to true or pass an object with draft options.
|
|
*/
|
|
drafts: false | SanitizedDrafts;
|
|
/**
|
|
* Use this setting to control how many versions to keep on a document by document basis.
|
|
* Must be an integer. Use 0 to save all versions.
|
|
*
|
|
* @default 100
|
|
*/
|
|
maxPerDoc: number;
|
|
}
|
|
export type IncomingGlobalVersions = {
|
|
drafts?: boolean | IncomingDrafts;
|
|
/**
|
|
* Use this setting to control how many versions to keep on a global by global basis.
|
|
* Must be an integer.
|
|
*/
|
|
max?: number;
|
|
};
|
|
export type SanitizedGlobalVersions = {
|
|
/**
|
|
* Enable Drafts mode for this global. To enable, set to true or pass an object with draft options
|
|
*/
|
|
drafts: false | SanitizedDrafts;
|
|
/**
|
|
* Use this setting to control how many versions to keep on a global by global basis.
|
|
* Must be an integer.
|
|
*/
|
|
max: number;
|
|
};
|
|
export type TypeWithVersion<T> = {
|
|
createdAt: string;
|
|
id: string;
|
|
latest?: boolean;
|
|
parent: number | string;
|
|
publishedLocale?: string;
|
|
snapshot?: boolean;
|
|
updatedAt: string;
|
|
version: T;
|
|
};
|
|
//# sourceMappingURL=types.d.ts.map |