@webiny/api-headless-cms 0.0.0-unstable.bca7b3e350 → 0.0.0-unstable.c27f4d8a31

package/types/modelField.d.ts

@@ -0,0 +1,346 @@
+import type { CmsModel, CmsModelLayout } from "./model.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+import type { CmsDynamicZoneTemplate } from "../types/fields/dynamicZoneField.js";
+export type FieldRuleAction = "hide" | "disable" | string;
+export interface FieldRule {
+    type: "accessControl" | "entryValue";
+    target: string;
+    operator: string;
+    value: string | number | boolean | null;
+    action: FieldRuleAction;
+}
+export type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "json" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
+export type ICmsModelFieldStorageId = `${string}@${string}` | 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: ICmsModelFieldStorageId;
+    /**
+     * 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;
+    /**
+     * Field description right below the label.
+     */
+    description?: string | null;
+    /**
+     * Note displayed below the input.
+     */
+    note?: string | null;
+    /**
+     * Text in the tooltip next to the input label.
+     */
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: 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?
+     *
+     */
+    list?: boolean;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Any user defined settings.
+     *
+     * @default {}
+     */
+    settings?: CmsModelFieldSettings;
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
+}
+/**
+ * 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;
+    /**
+     * Field description right below the label.
+     */
+    description?: string | null;
+    /**
+     * Note displayed below the input.
+     */
+    note?: string | null;
+    /**
+     * Text in the tooltip next to the input label.
+     */
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: string | null;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Are multiple values allowed?
+     */
+    list?: 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?: {
+        [key: string]: any;
+    };
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
+}
+/**
+ * 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: CmsModelLayout;
+    /**
+     * Tags for the content model.
+     */
+    tags?: string[];
+    /**
+     * Fields fieldId which are picked to represent the CMS entry.
+     */
+    titleFieldId?: string | null;
+    descriptionFieldId?: string | null;
+    imageFieldId?: string | null;
+}
+/**
+ * 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;
+    /**
+     * Renderer settings allow you to configure field renderer on a field level.
+     */
+    settings?: GenericRecord<string> | null;
+}
+/**
+ * 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 | boolean | 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?: CmsModelLayout;
+    /**
+     * Ref field.
+     */
+    models?: Pick<CmsModel, "modelId">[];
+    /**
+     * Date field.
+     */
+    type?: string;
+    /**
+     * Disable full text search explicitly on this field.
+     */
+    disableFullTextSearch?: boolean;
+    /**
+     * Dynamic zone field templates.
+     */
+    templates?: CmsDynamicZoneTemplate[];
+    /**
+     * 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,3 @@
+export {};
+
+//# sourceMappingURL=modelField.js.map

package/types/modelField.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["modelField.ts"],"sourcesContent":["import type { CmsModel, CmsModelLayout } from \"./model.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type { CmsDynamicZoneTemplate } from \"~/types/fields/dynamicZoneField.js\";\n\nexport type FieldRuleAction = \"hide\" | \"disable\" | string;\n\nexport interface FieldRule {\n    type: \"accessControl\" | \"entryValue\";\n    target: string;\n    operator: string;\n    value: string | number | boolean | null;\n    action: FieldRuleAction;\n}\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\nexport type ICmsModelFieldStorageId = `${string}@${string}` | string;\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: ICmsModelFieldStorageId;\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     * Field description right below the label.\n     */\n    description?: string | null;\n    /**\n     * Note displayed below the input.\n     */\n    note?: string | null;\n    /**\n     * Text in the tooltip next to the input label.\n     */\n    help?: string | null;\n    /**\n     * Placeholder text to be displayed in the field\n     */\n    placeholder?: 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    list?: 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     * Rules that control field visibility and editability (access control and entry value conditions).\n     */\n    rules?: FieldRule[];\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     * Field description right below the label.\n     */\n    description?: string | null;\n    /**\n     * Note displayed below the input.\n     */\n    note?: string | null;\n    /**\n     * Text in the tooltip next to the input label.\n     */\n    help?: string | null;\n    /**\n     * Placeholder text to be displayed in the field\n     */\n    placeholder?: 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    list?: 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?: {\n        [key: string]: any;\n    };\n    /**\n     * Rules that control field visibility and editability (access control and entry value conditions).\n     */\n    rules?: FieldRule[];\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: CmsModelLayout;\n    /**\n     * Tags for the content model.\n     */\n    tags?: 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 * 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     * Renderer settings allow you to configure field renderer on a field level.\n     */\n    settings?: GenericRecord<string> | null;\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 | boolean | 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?: CmsModelLayout;\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     * Dynamic zone field templates.\n     */\n    templates?: CmsDynamicZoneTemplate[];\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,70 @@
+import type { CmsIdentity } from "./identity.js";
+import type { CmsIcon } from "../types/types.js";
+/**
+ * @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;
+    /**
+     * Description for the group.
+     */
+    description: string | null;
+    /**
+     * Icon for the group. In a form of "ico/ico".
+     */
+    icon: CmsIcon | null;
+    /**
+     * CreatedBy reference object.
+     */
+    createdBy?: CmsIdentity;
+    /**
+     * Date group was created on.
+     */
+    createdOn?: string;
+    /**
+     * Date group was created or changed on.
+     */
+    savedOn?: 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,3 @@
+export {};
+
+//# sourceMappingURL=modelGroup.js.map

package/types/modelGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["modelGroup.ts"],"sourcesContent":["import type { CmsIdentity } from \"./identity.js\";\nimport type { CmsIcon } from \"~/types/types.js\";\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     * Description for the group.\n     */\n    description: string | null;\n    /**\n     * Icon for the group. In a form of \"ico/ico\".\n     */\n    icon: CmsIcon | null;\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    /**\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":[]}