@webiny/app-headless-cms-common 6.0.0-rc.1 → 6.0.0-rc.3

package/types/model.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import type { Validator } from \"@webiny/validation/types.js\";\nimport type { CmsModelFieldValidator } from \"~/types/validation.js\";\nimport type {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type React from \"react\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport interface CmsModelFieldSettings<T = unknown> {\n    defaultValue?: string | boolean | number | null | undefined;\n    defaultSetValue?: string;\n    type?: string;\n    fields?: CmsModelField<T>[];\n    layout?: string[][];\n    models?: Pick<CmsModel, \"modelId\">[];\n    templates?: CmsDynamicZoneTemplate[];\n    imagesOnly?: boolean;\n    [key: string]: any;\n}\n\nexport type CmsModelField<T = unknown> = T & {\n    id: string;\n    type: string;\n    fieldId: CmsEditorFieldId;\n    storageId?: string;\n    label: string;\n    help?: string | React.ReactNode;\n    description?: string | React.ReactNode;\n    note?: string | React.ReactNode;\n    placeholder?: string;\n    validation?: (CmsModelFieldValidator | Validator)[];\n    listValidation?: CmsModelFieldValidator[];\n    list?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: CmsModelFieldSettings<T>;\n    renderer:\n        | {\n              name: string;\n              settings?: Record<string, any>;\n          }\n        /**\n         * Use this only for programmatic assignment of renderers.\n         * Since functions cannot be serialized, this can only work via code.\n         */\n        | CmsModelFieldRendererPlugin[\"renderer\"][\"render\"];\n    tags?: string[];\n};\n\nexport type CmsEditorFieldId = string;\nexport type CmsEditorFieldsLayout = CmsEditorFieldId[][];\n\n/**\n * @category GraphQL\n * @category Model\n */\nexport type CmsEditorContentModel = CmsModel;\n\n/**\n * @category GraphQL\n * @category Group\n */\nexport interface CmsGroup {\n    id: string;\n    name: string;\n    slug: string;\n    icon: string;\n    description?: string;\n    contentModels: CmsModel[];\n    createdBy: CmsIdentity;\n    /**\n     * Tells if this group is a plugin one (cannot be changed/deleted)\n     */\n    plugin?: boolean;\n}\n\nexport interface CmsModel {\n    id: string;\n    group: string;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    icon: string;\n    name: string;\n    modelId: string;\n    singularApiName: string;\n    pluralApiName: string;\n    titleFieldId: string | null;\n    descriptionFieldId: string | null;\n    imageFieldId: string | null;\n    status: string;\n    savedOn: string;\n    meta: any;\n    createdBy: CmsIdentity;\n    tags: string[];\n    /**\n     * If model is a plugin one (it cannot be changed/deleted)\n     */\n    plugin?: boolean;\n    /**\n     * Is model currently being deleted?\n     */\n    isBeingDeleted?: boolean;\n    settings: {\n        [key: string]: any;\n    };\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":["isLayoutDescriptor","cell","type"],"sources":["model.ts"],"sourcesContent":["import type { Validator } from \"@webiny/validation/types.js\";\nimport type { CmsModelFieldValidator } from \"~/types/validation.js\";\nimport type {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type React from \"react\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport interface CmsModelFieldSettings<T = unknown> {\n    defaultValue?: string | boolean | number | null | undefined;\n    defaultSetValue?: string;\n    type?: string;\n    fields?: CmsModelField<T>[];\n    layout?: CmsEditorFieldsLayout;\n    models?: Pick<CmsModel, \"modelId\">[];\n    templates?: CmsDynamicZoneTemplate[];\n    imagesOnly?: boolean;\n    [key: string]: any;\n}\n\nexport type FieldRuleAction = \"hide\" | \"disable\" | string;\n\nexport interface FieldRule {\n    type: \"accessControl\" | \"condition\";\n    target: string;\n    operator: string;\n    value: string | number | boolean | null;\n    action: FieldRuleAction;\n}\n\nexport type CmsModelField<T = unknown> = T & {\n    id: string;\n    type: string;\n    fieldId: CmsEditorFieldId;\n    storageId?: string;\n    label: string;\n    help?: string | React.ReactNode;\n    description?: string | React.ReactNode;\n    note?: string | React.ReactNode;\n    placeholder?: string;\n    validation?: (CmsModelFieldValidator | Validator)[];\n    listValidation?: CmsModelFieldValidator[];\n    list?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: CmsModelFieldSettings<T>;\n    renderer:\n        | {\n              name: string;\n              settings?: Record<string, any>;\n          }\n        /**\n         * Use this only for programmatic assignment of renderers.\n         * Since functions cannot be serialized, this can only work via code.\n         */\n        | CmsModelFieldRendererPlugin[\"renderer\"][\"render\"];\n    tags?: string[];\n    rules?: FieldRule[];\n};\n\nexport type CmsEditorFieldId = string;\n\nexport interface CmsBaseLayoutDescriptor {\n    id: string;\n    type: string;\n    rules?: FieldRule[];\n}\n\nexport interface CmsSeparatorLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"separator\";\n    label: string;\n    description?: string;\n}\n\nexport interface CmsAlertLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"alert\";\n    label: string;\n    alertType: \"info\" | \"success\" | \"warning\" | \"danger\";\n}\n\nexport interface CmsTabLayoutTab {\n    id: string;\n    label: string;\n    icon?: string;\n    layout: CmsEditorFieldsLayout;\n    rules?: FieldRule[];\n}\n\nexport interface CmsTabLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"tabs\";\n    label: string;\n    description?: string | null;\n    help?: string | null;\n    tabs: CmsTabLayoutTab[];\n}\n\nexport type CmsLayoutDescriptor =\n    | CmsSeparatorLayoutDescriptor\n    | CmsAlertLayoutDescriptor\n    | CmsTabLayoutDescriptor\n    | CmsBaseLayoutDescriptor;\n\nexport type CmsEditorLayoutCell = CmsEditorFieldId | CmsLayoutDescriptor;\nexport type CmsEditorFieldsLayout = CmsEditorLayoutCell[][];\n\n/**\n * Distinguish layout descriptors from field IDs (strings) and CmsModelField objects.\n *\n * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)\n * or layout descriptor objects — the `typeof` check handles that.\n *\n * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`\n * or layout descriptor objects — both have `{ id, type }`, but only `CmsModelField`\n * has `fieldId`, so we use its absence as the discriminator.\n */\nexport function isLayoutDescriptor(cell: unknown): cell is CmsLayoutDescriptor {\n    return (\n        typeof cell === \"object\" &&\n        cell !== null &&\n        \"type\" in cell &&\n        typeof (cell as any).type === \"string\" &&\n        !(\"fieldId\" in cell)\n    );\n}\n\n/**\n * @category GraphQL\n * @category Model\n */\nexport type CmsEditorContentModel = CmsModel;\n\n/**\n * @category GraphQL\n * @category Group\n */\nexport interface CmsGroup {\n    id: string;\n    name: string;\n    slug: string;\n    icon: string;\n    description?: string;\n    contentModels: CmsModel[];\n    createdBy: CmsIdentity;\n    /**\n     * Tells if this group is a plugin one (cannot be changed/deleted)\n     */\n    plugin?: boolean;\n}\n\nexport interface CmsModel {\n    id: string;\n    group: string;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    icon: string;\n    name: string;\n    modelId: string;\n    singularApiName: string;\n    pluralApiName: string;\n    titleFieldId: string | null;\n    descriptionFieldId: string | null;\n    imageFieldId: string | null;\n    status: string;\n    savedOn: string;\n    meta: any;\n    createdBy: CmsIdentity;\n    tags: string[];\n    /**\n     * If model is a plugin one (it cannot be changed/deleted)\n     */\n    plugin?: boolean;\n    /**\n     * Is model currently being deleted?\n     */\n    isBeingDeleted?: boolean;\n    settings: {\n        [key: string]: any;\n    };\n}\n"],"mappings":"AAUA;AACA;AACA;;AAmGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,kBAAkBA,CAACC,IAAa,EAA+B;EAC3E,OACI,OAAOA,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,IACb,MAAM,IAAIA,IAAI,IACd,OAAQA,IAAI,CAASC,IAAI,KAAK,QAAQ,IACtC,EAAE,SAAS,IAAID,IAAI,CAAC;AAE5B;;AAEA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA","ignoreList":[]}