@webiny/api-headless-cms 5.40.0-beta.2 → 5.40.0-beta.3

package/types/modelAst.d.ts

@@ -0,0 +1,39 @@
+/**
+ * CMS Model AST
+ */
+import { CmsModelField } from "./modelField";
+export interface ICmsModelFieldToAst {
+    toAst(field: CmsModelField): CmsModelFieldAstNode;
+}
+export declare type CmsModelAst = {
+    type: "root";
+    children: CmsModelFieldAstNode[];
+};
+export declare type CmsModelFieldAstNodeCollection = {
+    type: "collection";
+    collection: {
+        discriminator: string;
+    } & Record<string, any>;
+    children: CmsModelFieldAstNode[];
+};
+export declare type CmsModelFieldAstNodeField = {
+    type: "field";
+    field: CmsModelField;
+    children: CmsModelFieldAstNode[];
+};
+export declare type CmsModelFieldAstNode = CmsModelFieldAstNodeCollection | CmsModelFieldAstNodeField;
+export interface GetCmsModelFieldAst<TField> {
+    (field: TField, converter: ICmsModelFieldToAst): CmsModelFieldAstNode;
+}
+export interface ContentEntryNode {
+    field: CmsModelField;
+    value: any;
+    path: string;
+}
+export interface ContentEntryNodeContext {
+    node: CmsModelAst | CmsModelFieldAstNode;
+    parent: CmsModelAst | CmsModelFieldAstNode | null;
+}
+export interface ContentEntryValueVisitor {
+    (params: ContentEntryNode, context: ContentEntryNodeContext): Promise<void> | void;
+}

package/types/modelAst.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=modelAst.js.map

package/types/modelAst.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["modelAst.ts"],"sourcesContent":["/**\n * CMS Model AST\n */\nimport { CmsModelField } from \"./modelField\";\n\nexport interface ICmsModelFieldToAst {\n    toAst(field: CmsModelField): CmsModelFieldAstNode;\n}\n\nexport type CmsModelAst = {\n    type: \"root\";\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeCollection = {\n    type: \"collection\";\n    collection: { discriminator: string } & Record<string, any>;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNodeField = {\n    type: \"field\";\n    field: CmsModelField;\n    children: CmsModelFieldAstNode[];\n};\n\nexport type CmsModelFieldAstNode = CmsModelFieldAstNodeCollection | CmsModelFieldAstNodeField;\n\nexport interface GetCmsModelFieldAst<TField> {\n    (field: TField, converter: ICmsModelFieldToAst): CmsModelFieldAstNode;\n}\n\nexport interface ContentEntryNode {\n    field: CmsModelField;\n    value: any;\n    path: string;\n    // parentField: CmsModelField | undefined;\n    // parent => parent object (e.g., entry)\n}\n\nexport interface ContentEntryNodeContext {\n    node: CmsModelAst | CmsModelFieldAstNode;\n    parent: CmsModelAst | CmsModelFieldAstNode | null;\n}\n\nexport interface ContentEntryValueVisitor {\n    (params: ContentEntryNode, context: ContentEntryNodeContext): Promise<void> | void;\n}\n"],"mappings":"","ignoreList":[]}

package/types/modelField.d.ts

@@ -0,0 +1,320 @@
+import { CmsModel } from "./model";
+export declare type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "json" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
+/**
+ * A definition for content model field. This type exists on the app side as well.
+ *
+ * @category ModelField
+ * @category Database model
+ */
+export interface CmsModelField {
+    /**
+     * A generated unique ID for the model field.
+     * MUST be absolute unique throughout the models.
+     * Must be in form of a-zA-Z0-9.
+     *
+     * We generate a unique id value when you're building a model via UI,
+     * but when user is creating a model via a plugin it is up to them to be careful about this.
+     */
+    id: string;
+    /**
+     * A type of the field.
+     * We are defining our built-in fields, so people know which are available by the default.
+     */
+    type: CmsModelFieldType;
+    /**
+     * A unique storage ID for storing actual values.
+     * Must in form of a-zA-Z0-9@a-zA-Z0-9
+     *
+     * This is an auto-generated value: uses `id` and `type`
+     *
+     * This is used as path for the entry value.
+     */
+    storageId: `${string}@${string}` | string;
+    /**
+     * Field identifier for the model field that will be available to the outside world.
+     * `storageId` is used as path (or column) to store the data.
+     *
+     * Must in form of a-zA-Z0-9.
+     *
+     * This value MUST be unique in the CmsModel.
+     */
+    fieldId: string;
+    /**
+     * A label for the field
+     */
+    label: string;
+    /**
+     * Text below the field to clarify what is it meant to be in the field value
+     */
+    helpText?: string | null;
+    /**
+     * Text to be displayed in the field
+     */
+    placeholderText?: string | null;
+    /**
+     * Are predefined values enabled? And list of them
+     */
+    predefinedValues?: CmsModelFieldPredefinedValues;
+    /**
+     * Field renderer. Blank if determined automatically.
+     */
+    renderer?: CmsModelFieldRenderer | null;
+    /**
+     * List of validations for the field
+     *
+     * @default []
+     */
+    validation?: CmsModelFieldValidation[];
+    /**
+     * List of validations for the list of values, when a field is set to accept a list of values.
+     * These validations will be applied to the entire list, and `validation` (see above) will be applied
+     * to each individual value in the list.
+     *
+     * @default []
+     */
+    listValidation?: CmsModelFieldValidation[];
+    /**
+     * Is this a multiple values field?
+     *
+     */
+    multipleValues?: boolean;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Any user defined settings.
+     *
+     * @default {}
+     */
+    settings?: CmsModelFieldSettings;
+}
+/**
+ * A definition for content model field received from the user.
+ *
+ * Input type for `CmsModelField`.
+ * @see CmsModelField
+ *
+ * @category GraphQL params
+ * @category ModelField
+ */
+export interface CmsModelFieldInput {
+    /**
+     * Generated ID.
+     */
+    id: string;
+    /**
+     * Type of the field. A plugin for the field must be defined.
+     * @see CmsModelFieldToGraphQLPlugin
+     */
+    type: string;
+    /**
+     * Field outside world identifier for the field. Must be unique in the model.
+     */
+    fieldId: string;
+    /**
+     * Label for the field.
+     */
+    label: string;
+    /**
+     * Text to display below the field to help user what to write in the field.
+     */
+    helpText?: string | null;
+    /**
+     * Text to display in the field.
+     */
+    placeholderText?: string | null;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Are multiple values allowed?
+     */
+    multipleValues?: boolean;
+    /**
+     * Predefined values options for the field. Check the reference for more information.
+     */
+    predefinedValues?: CmsModelFieldPredefinedValues;
+    /**
+     * Renderer options for the field. Check the reference for more information.
+     */
+    renderer?: CmsModelFieldRenderer | null;
+    /**
+     * List of validations for the field.
+     */
+    validation?: CmsModelFieldValidation[];
+    /**
+     * @see CmsModelField.listValidation
+     */
+    listValidation?: CmsModelFieldValidation[];
+    /**
+     * User defined settings.
+     */
+    settings?: Record<string, any>;
+}
+/**
+ * A GraphQL `params.data` parameter received when updating content model.
+ *
+ * @category GraphQL params
+ * @category CmsModel
+ */
+export interface CmsModelUpdateInput {
+    /**
+     * A new content model name.
+     */
+    name?: string;
+    /**
+     * A new singular name of the content model to be used in the API.
+     */
+    singularApiName?: string;
+    /**
+     * A new plural name of the content model to be used in the API.
+     */
+    pluralApiName?: string;
+    /**
+     * A group we want to move the model to.
+     */
+    group?: string;
+    /**
+     * A new description of the content model.
+     */
+    description?: string | null;
+    /**
+     * A list of content model fields to define the entry values.
+     */
+    fields: CmsModelFieldInput[];
+    /**
+     * Admin UI field layout
+     *
+     * ```ts
+     * layout: [
+     *      [field1id, field2id],
+     *      [field3id]
+     * ]
+     * ```
+     */
+    layout: string[][];
+    /**
+     * Fields fieldId which are picked to represent the CMS entry.
+     */
+    titleFieldId?: string | null;
+    descriptionFieldId?: string | null;
+    imageFieldId?: string | null;
+}
+/**
+ * Locked field in the content model
+ *
+ * @see CmsModel.lockedFields
+ *
+ * @category ModelField
+ */
+export interface LockedField {
+    /**
+     * Locked field storage ID - one used to store values.
+     * We cannot change this due to old systems.
+     */
+    fieldId: string;
+    /**
+     * Is the field multiple values field?
+     */
+    multipleValues: boolean;
+    /**
+     * Field type.
+     */
+    type: string;
+    [key: string]: any;
+}
+/**
+ * Object containing content model field renderer options.
+ *
+ * @category CmsModelField
+ */
+interface CmsModelFieldRenderer {
+    /**
+     * Name of the field renderer. Must have one in field renderer plugins.
+     * Can be blank to let automatically determine the renderer.
+     */
+    name: string;
+}
+/**
+ * A definition for content model field settings.
+ *
+ * @category ModelField
+ * @category Database model
+ */
+export interface CmsModelFieldSettings {
+    /**
+     * Predefined values (text, number)
+     * The default value for the field in case it is not predefined values field.
+     */
+    defaultValue?: string | number | null | undefined;
+    /**
+     * Object field has child fields.
+     */
+    fields?: CmsModelField[];
+    /**
+     * Is the file field images only one?
+     */
+    imagesOnly?: boolean;
+    /**
+     * Object field has child fields - so it needs to have a layout.
+     */
+    layout?: string[][];
+    /**
+     * Ref field.
+     */
+    models?: Pick<CmsModel, "modelId">[];
+    /**
+     * Date field.
+     */
+    type?: string;
+    /**
+     * Disable full text search explicitly on this field.
+     */
+    disableFullTextSearch?: boolean;
+    /**
+     * There are a lot of other settings that are possible to add, so we keep the type opened.
+     */
+    [key: string]: any;
+}
+/**
+ * Definition for content model field validator.
+ *
+ * @category ModelField
+ * @category FieldValidation
+ */
+export interface CmsModelFieldValidation {
+    name: string;
+    message: string;
+    settings?: {
+        value?: string | number;
+        values?: string[];
+        preset?: string;
+        [key: string]: any;
+    };
+}
+/**
+ * Object containing content model field predefined options and values.
+ *
+ * @category CmsModelField
+ */
+export interface CmsModelFieldPredefinedValues {
+    /**
+     * Are predefined field values enabled?
+     */
+    enabled: boolean;
+    /**
+     * Predefined values array.
+     */
+    values: CmsModelFieldPredefinedValuesValue[];
+}
+interface CmsModelFieldPredefinedValuesValue {
+    value: string;
+    label: string;
+    /**
+     * Default selected predefined value.
+     */
+    selected?: boolean;
+}
+export {};

package/types/modelField.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=modelField.js.map

package/types/modelField.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["modelField.ts"],"sourcesContent":["import { CmsModel } from \"./model\";\n\nexport type CmsModelFieldType =\n    | \"boolean\"\n    | \"datetime\"\n    | \"file\"\n    | \"long-text\"\n    | \"number\"\n    | \"json\"\n    | \"object\"\n    | \"ref\"\n    | \"rich-text\"\n    | \"text\"\n    | \"dynamicZone\"\n    | string;\n\n/**\n * A definition for content model field. This type exists on the app side as well.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelField {\n    /**\n     * A generated unique ID for the model field.\n     * MUST be absolute unique throughout the models.\n     * Must be in form of a-zA-Z0-9.\n     *\n     * We generate a unique id value when you're building a model via UI,\n     * but when user is creating a model via a plugin it is up to them to be careful about this.\n     */\n    id: string;\n    /**\n     * A type of the field.\n     * We are defining our built-in fields, so people know which are available by the default.\n     */\n    type: CmsModelFieldType;\n    /**\n     * A unique storage ID for storing actual values.\n     * Must in form of a-zA-Z0-9@a-zA-Z0-9\n     *\n     * This is an auto-generated value: uses `id` and `type`\n     *\n     * This is used as path for the entry value.\n     */\n    storageId: `${string}@${string}` | string;\n    /**\n     * Field identifier for the model field that will be available to the outside world.\n     * `storageId` is used as path (or column) to store the data.\n     *\n     * Must in form of a-zA-Z0-9.\n     *\n     * This value MUST be unique in the CmsModel.\n     */\n    fieldId: string;\n    /**\n     * A label for the field\n     */\n    label: string;\n    /**\n     * Text below the field to clarify what is it meant to be in the field value\n     */\n    helpText?: string | null;\n    /**\n     * Text to be displayed in the field\n     */\n    placeholderText?: string | null;\n    /**\n     * Are predefined values enabled? And list of them\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Field renderer. Blank if determined automatically.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field\n     *\n     * @default []\n     */\n    validation?: CmsModelFieldValidation[];\n    /**\n     * List of validations for the list of values, when a field is set to accept a list of values.\n     * These validations will be applied to the entire list, and `validation` (see above) will be applied\n     * to each individual value in the list.\n     *\n     * @default []\n     */\n    listValidation?: CmsModelFieldValidation[];\n    /**\n     * Is this a multiple values field?\n     *\n     */\n    multipleValues?: boolean;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Any user defined settings.\n     *\n     * @default {}\n     */\n    settings?: CmsModelFieldSettings;\n}\n\n/**\n * A definition for content model field received from the user.\n *\n * Input type for `CmsModelField`.\n * @see CmsModelField\n *\n * @category GraphQL params\n * @category ModelField\n */\nexport interface CmsModelFieldInput {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Type of the field. A plugin for the field must be defined.\n     * @see CmsModelFieldToGraphQLPlugin\n     */\n    type: string;\n    /**\n     * Field outside world identifier for the field. Must be unique in the model.\n     */\n    fieldId: string;\n    /**\n     * Label for the field.\n     */\n    label: string;\n    /**\n     * Text to display below the field to help user what to write in the field.\n     */\n    helpText?: string | null;\n    /**\n     * Text to display in the field.\n     */\n    placeholderText?: string | null;\n    /**\n     * Fields can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * Are multiple values allowed?\n     */\n    multipleValues?: boolean;\n    /**\n     * Predefined values options for the field. Check the reference for more information.\n     */\n    predefinedValues?: CmsModelFieldPredefinedValues;\n    /**\n     * Renderer options for the field. Check the reference for more information.\n     */\n    renderer?: CmsModelFieldRenderer | null;\n    /**\n     * List of validations for the field.\n     */\n    validation?: CmsModelFieldValidation[];\n    /**\n     * @see CmsModelField.listValidation\n     */\n    listValidation?: CmsModelFieldValidation[];\n    /**\n     * User defined settings.\n     */\n    settings?: Record<string, any>;\n}\n\n/**\n * A GraphQL `params.data` parameter received when updating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelUpdateInput {\n    /**\n     * A new content model name.\n     */\n    name?: string;\n    /**\n     * A new singular name of the content model to be used in the API.\n     */\n    singularApiName?: string;\n    /**\n     * A new plural name of the content model to be used in the API.\n     */\n    pluralApiName?: string;\n    /**\n     * A group we want to move the model to.\n     */\n    group?: string;\n    /**\n     * A new description of the content model.\n     */\n    description?: string | null;\n    /**\n     * A list of content model fields to define the entry values.\n     */\n    fields: CmsModelFieldInput[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: string[][];\n    /**\n     * Fields fieldId which are picked to represent the CMS entry.\n     */\n    titleFieldId?: string | null;\n    descriptionFieldId?: string | null;\n    imageFieldId?: string | null;\n}\n\n/**\n * Locked field in the content model\n *\n * @see CmsModel.lockedFields\n *\n * @category ModelField\n */\nexport interface LockedField {\n    /**\n     * Locked field storage ID - one used to store values.\n     * We cannot change this due to old systems.\n     */\n    fieldId: string;\n    /**\n     * Is the field multiple values field?\n     */\n    multipleValues: boolean;\n    /**\n     * Field type.\n     */\n    type: string;\n\n    [key: string]: any;\n}\n\n/**\n * Object containing content model field renderer options.\n *\n * @category CmsModelField\n */\ninterface CmsModelFieldRenderer {\n    /**\n     * Name of the field renderer. Must have one in field renderer plugins.\n     * Can be blank to let automatically determine the renderer.\n     */\n    name: string;\n}\n\n/**\n * A definition for content model field settings.\n *\n * @category ModelField\n * @category Database model\n */\nexport interface CmsModelFieldSettings {\n    /**\n     * Predefined values (text, number)\n     * The default value for the field in case it is not predefined values field.\n     */\n    defaultValue?: string | number | null | undefined;\n    /**\n     * Object field has child fields.\n     */\n    fields?: CmsModelField[];\n    /**\n     * Is the file field images only one?\n     */\n    imagesOnly?: boolean;\n    /**\n     * Object field has child fields - so it needs to have a layout.\n     */\n    layout?: string[][];\n    /**\n     * Ref field.\n     */\n    models?: Pick<CmsModel, \"modelId\">[];\n    /**\n     * Date field.\n     */\n    type?: string;\n    /**\n     * Disable full text search explicitly on this field.\n     */\n    disableFullTextSearch?: boolean;\n\n    /**\n     * There are a lot of other settings that are possible to add, so we keep the type opened.\n     */\n    [key: string]: any;\n}\n\n/**\n * Definition for content model field validator.\n *\n * @category ModelField\n * @category FieldValidation\n */\nexport interface CmsModelFieldValidation {\n    name: string;\n    message: string;\n    settings?: {\n        value?: string | number;\n        values?: string[];\n        preset?: string;\n        [key: string]: any;\n    };\n}\n\n/**\n * Object containing content model field predefined options and values.\n *\n * @category CmsModelField\n */\nexport interface CmsModelFieldPredefinedValues {\n    /**\n     * Are predefined field values enabled?\n     */\n    enabled: boolean;\n    /**\n     * Predefined values array.\n     */\n    values: CmsModelFieldPredefinedValuesValue[];\n}\n\ninterface CmsModelFieldPredefinedValuesValue {\n    value: string;\n    label: string;\n    /**\n     * Default selected predefined value.\n     */\n    selected?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/types/modelGroup.d.ts

@@ -0,0 +1,77 @@
+import { CmsIdentity } from "./identity";
+/**
+ * @category Database model
+ * @category CmsModel
+ */
+export interface CmsModelGroup {
+    /**
+     * Generated ID of the group
+     */
+    id: string;
+    /**
+     * Name of the group
+     */
+    name: string;
+}
+/**
+ * A representation of content model group in the database.
+ *
+ * @category CmsGroup
+ * @category Database model
+ */
+export interface CmsGroup {
+    /**
+     * Generated ID.
+     */
+    id: string;
+    /**
+     * Name of the group.
+     */
+    name: string;
+    /**
+     * Slug for the group. Must be unique.
+     */
+    slug: string;
+    /**
+     * Group tenant.
+     */
+    tenant: string;
+    /**
+     * Locale this group belongs to.
+     */
+    locale: string;
+    /**
+     * Description for the group.
+     */
+    description: string | null;
+    /**
+     * Icon for the group. In a form of "ico/ico".
+     */
+    icon: string;
+    /**
+     * CreatedBy reference object.
+     */
+    createdBy?: CmsIdentity;
+    /**
+     * Date group was created on.
+     */
+    createdOn?: string;
+    /**
+     * Date group was created or changed on.
+     */
+    savedOn?: string;
+    /**
+     * Which Webiny version was this record stored with.
+     */
+    webinyVersion: string;
+    /**
+     * Is group private?
+     * This is meant to be used for some internal groups - will not be visible in the schema.
+     * Only available for the plugin constructed groups.
+     */
+    isPrivate?: boolean;
+    /**
+     * Is this group created via plugin?
+     */
+    isPlugin?: boolean;
+}

package/types/modelGroup.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=modelGroup.js.map

package/types/modelGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["modelGroup.ts"],"sourcesContent":["import { CmsIdentity } from \"./identity\";\n\n/**\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModelGroup {\n    /**\n     * Generated ID of the group\n     */\n    id: string;\n    /**\n     * Name of the group\n     */\n    name: string;\n}\n\n/**\n * A representation of content model group in the database.\n *\n * @category CmsGroup\n * @category Database model\n */\nexport interface CmsGroup {\n    /**\n     * Generated ID.\n     */\n    id: string;\n    /**\n     * Name of the group.\n     */\n    name: string;\n    /**\n     * Slug for the group. Must be unique.\n     */\n    slug: string;\n    /**\n     * Group tenant.\n     */\n    tenant: string;\n    /**\n     * Locale this group belongs to.\n     */\n    locale: string;\n    /**\n     * Description for the group.\n     */\n    description: string | null;\n    /**\n     * Icon for the group. In a form of \"ico/ico\".\n     */\n    icon: string;\n    /**\n     * CreatedBy reference object.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * Date group was created on.\n     */\n    createdOn?: string;\n    /**\n     * Date group was created or changed on.\n     */\n    savedOn?: string;\n    /**\n     * Which Webiny version was this record stored with.\n     */\n    webinyVersion: string;\n    /**\n     * Is group private?\n     * This is meant to be used for some internal groups - will not be visible in the schema.\n     * Only available for the plugin constructed groups.\n     */\n    isPrivate?: boolean;\n    /**\n     * Is this group created via plugin?\n     */\n    isPlugin?: boolean;\n}\n"],"mappings":"","ignoreList":[]}