@webiny/app-headless-cms-common 0.0.0-unstable.085ff6572f

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @webiny/app-headless-cms-common
+
+[![](https://img.shields.io/npm/dw/@webiny/app-headless-cms-common.svg)](https://www.npmjs.com/package/@webiny/app-headless-cms-common)
+[![](https://img.shields.io/npm/v/@webiny/app-headless-cms-common.svg)](https://www.npmjs.com/package/@webiny/app-headless-cms-common)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+## Install
+
+```
+npm install --save @webiny/app-headless-cms-common
+```
+
+Or if you prefer yarn:
+
+```
+yarn add @webiny/app-headless-cms-common
+```

package/createFieldsList.d.ts

@@ -0,0 +1,7 @@
+import { CmsModelField, CmsModel } from "./types";
+interface CreateFieldsListParams {
+    model: CmsModel;
+    fields: CmsModelField[];
+}
+export declare function createFieldsList({ model, fields }: CreateFieldsListParams): string;
+export {};

package/createFieldsList.js

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createFieldsList = createFieldsList;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectSpread3 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+var _plugins = require("@webiny/plugins");
+function createFieldsList(_ref) {
+  var model = _ref.model,
+    fields = _ref.fields;
+  var fieldPlugins = _plugins.plugins.byType("cms-editor-field-type").reduce(function (acc, item) {
+    return (0, _objectSpread3.default)((0, _objectSpread3.default)({}, acc), {}, (0, _defineProperty2.default)({}, item.field.type, item.field));
+  }, {});
+
+  // console.log(fields, model);
+  return fields.map(function (field) {
+    if (!fieldPlugins[field.type]) {
+      console.log("Unknown field plugin for field type \"".concat(field.type, "\"."));
+      return null;
+    }
+    var graphql = fieldPlugins[field.type].graphql;
+    if (graphql && graphql.queryField) {
+      var queryField = graphql.queryField;
+      var selection = typeof queryField === "string" ? queryField : queryField({
+        model: model,
+        field: field
+      });
+      return "".concat(field.fieldId, " ").concat(selection);
+    }
+    return field.fieldId;
+  }).filter(Boolean).join("\n");
+}

package/createFieldsList.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createFieldsList","model","fields","fieldPlugins","plugins","byType","reduce","acc","item","field","type","map","console","log","graphql","queryField","selection","fieldId","filter","Boolean","join"],"sources":["createFieldsList.ts"],"sourcesContent":["import { CmsModelField, CmsEditorFieldTypePlugin, CmsModel } from \"~/types\";\nimport { plugins } from \"@webiny/plugins\";\n\ninterface CreateFieldsListParams {\n    model: CmsModel;\n    fields: CmsModelField[];\n}\n\nexport function createFieldsList({ model, fields }: CreateFieldsListParams): string {\n    const fieldPlugins: Record<string, CmsEditorFieldTypePlugin[\"field\"]> = plugins\n        .byType<CmsEditorFieldTypePlugin>(\"cms-editor-field-type\")\n        .reduce((acc, item) => ({ ...acc, [item.field.type]: item.field }), {});\n\n    // console.log(fields, model);\n    return fields\n        .map(field => {\n            if (!fieldPlugins[field.type]) {\n                console.log(`Unknown field plugin for field type \"${field.type}\".`);\n                return null;\n            }\n            const { graphql } = fieldPlugins[field.type];\n\n            if (graphql && graphql.queryField) {\n                const { queryField } = graphql;\n                const selection =\n                    typeof queryField === \"string\" ? queryField : queryField({ model, field });\n\n                return `${field.fieldId} ${selection}`;\n            }\n\n            return field.fieldId;\n        })\n        .filter(Boolean)\n        .join(\"\\n\");\n}\n"],"mappings":";;;;;;;;;AACA;AAOO,SAASA,gBAAgB,OAAoD;EAAA,IAAjDC,KAAK,QAALA,KAAK;IAAEC,MAAM,QAANA,MAAM;EAC5C,IAAMC,YAA+D,GAAGC,gBAAO,CAC1EC,MAAM,CAA2B,uBAAuB,CAAC,CACzDC,MAAM,CAAC,UAACC,GAAG,EAAEC,IAAI;IAAA,mEAAWD,GAAG,yCAAGC,IAAI,CAACC,KAAK,CAACC,IAAI,EAAGF,IAAI,CAACC,KAAK;EAAA,CAAG,EAAE,CAAC,CAAC,CAAC;;EAE3E;EACA,OAAOP,MAAM,CACRS,GAAG,CAAC,UAAAF,KAAK,EAAI;IACV,IAAI,CAACN,YAAY,CAACM,KAAK,CAACC,IAAI,CAAC,EAAE;MAC3BE,OAAO,CAACC,GAAG,iDAAyCJ,KAAK,CAACC,IAAI,SAAK;MACnE,OAAO,IAAI;IACf;IACA,IAAQI,OAAO,GAAKX,YAAY,CAACM,KAAK,CAACC,IAAI,CAAC,CAApCI,OAAO;IAEf,IAAIA,OAAO,IAAIA,OAAO,CAACC,UAAU,EAAE;MAC/B,IAAQA,UAAU,GAAKD,OAAO,CAAtBC,UAAU;MAClB,IAAMC,SAAS,GACX,OAAOD,UAAU,KAAK,QAAQ,GAAGA,UAAU,GAAGA,UAAU,CAAC;QAAEd,KAAK,EAALA,KAAK;QAAEQ,KAAK,EAALA;MAAM,CAAC,CAAC;MAE9E,iBAAUA,KAAK,CAACQ,OAAO,cAAID,SAAS;IACxC;IAEA,OAAOP,KAAK,CAACQ,OAAO;EACxB,CAAC,CAAC,CACDC,MAAM,CAACC,OAAO,CAAC,CACfC,IAAI,CAAC,IAAI,CAAC;AACnB"}

package/entries.graphql.d.ts

@@ -0,0 +1,146 @@
+import { CmsContentEntryRevision, CmsContentEntry, CmsEditorContentModel, CmsErrorResponse, CmsMetaResponse, CmsModelField } from "./types";
+/**
+ * ############################################
+ * Get CMS Entry Query
+ */
+export interface CmsEntryGetQueryResponse {
+    content: {
+        data: CmsContentEntry;
+        error: CmsErrorResponse | null;
+    };
+}
+export interface CmsEntryGetQueryVariables {
+    revision?: string;
+    entryId?: string;
+}
+export declare const createReadQuery: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * List CMS Entry Revisions Query
+ */
+export interface CmsEntriesListRevisionsQueryResponse {
+    revisions: {
+        data: CmsContentEntryRevision[];
+        error: CmsErrorResponse | null;
+        meta: CmsMetaResponse;
+    };
+}
+export interface CmsEntriesListRevisionsQueryVariables {
+    id: string;
+}
+export declare const createRevisionsQuery: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * List CMS Entries Query
+ */
+export interface CmsEntriesListQueryResponse {
+    content: {
+        data: CmsContentEntry[];
+        error: CmsErrorResponse | null;
+        meta: CmsMetaResponse;
+    };
+}
+export interface CmsEntriesListQueryVariables {
+    where?: {
+        [key: string]: any;
+    };
+    sort?: string[];
+    limit?: number;
+    after?: string;
+}
+export declare const createListQuery: (model: CmsEditorContentModel, fields?: CmsModelField[]) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Delete Mutation
+ */
+export interface CmsEntryDeleteMutationResponse {
+    content: {
+        data: CmsContentEntry | null;
+        error: CmsErrorResponse | null;
+    };
+}
+export interface CmsEntryDeleteMutationVariables {
+    revision: string;
+}
+export declare const createDeleteMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Create Mutation
+ */
+export interface CmsEntryCreateMutationResponse {
+    content: {
+        data: CmsContentEntry | null;
+        error: CmsErrorResponse | null;
+    };
+}
+export interface CmsEntryCreateMutationVariables {
+    /**
+     * We have any here because we do not know which fields does entry have
+     */
+    data: Record<string, any>;
+}
+export declare const createCreateMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Create From Mutation
+ */
+export interface CmsEntryCreateFromMutationResponse {
+    content: {
+        data?: CmsContentEntry;
+        error?: CmsErrorResponse;
+    };
+}
+export interface CmsEntryCreateFromMutationVariables {
+    revision: string;
+    /**
+     * We have any here because we do not know which fields does entry have
+     */
+    data?: Record<string, any>;
+}
+export declare const createCreateFromMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Update Mutation
+ */
+export interface CmsEntryUpdateMutationResponse {
+    content: {
+        data?: CmsContentEntry;
+        error?: CmsErrorResponse;
+    };
+}
+export interface CmsEntryUpdateMutationVariables {
+    revision: string;
+    /**
+     * We have any here because we do not know which fields does entry have
+     */
+    data: Record<string, any>;
+}
+export declare const createUpdateMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Publish Mutation
+ */
+export interface CmsEntryPublishMutationResponse {
+    content: {
+        data?: CmsContentEntry;
+        error?: CmsErrorResponse;
+    };
+}
+export interface CmsEntryPublishMutationVariables {
+    revision: string;
+}
+export declare const createPublishMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;
+/**
+ * ############################################
+ * Unpublish Mutation
+ */
+export interface CmsEntryUnpublishMutationResponse {
+    content: {
+        data?: CmsContentEntry;
+        error?: CmsErrorResponse;
+    };
+}
+export interface CmsEntryUnpublishMutationVariables {
+    revision: string;
+}
+export declare const createUnpublishMutation: (model: CmsEditorContentModel) => import("graphql").DocumentNode;

package/entries.graphql.js

@@ -0,0 +1,115 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createUpdateMutation = exports.createUnpublishMutation = exports.createRevisionsQuery = exports.createReadQuery = exports.createPublishMutation = exports.createListQuery = exports.createDeleteMutation = exports.createCreateMutation = exports.createCreateFromMutation = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _createFieldsList = require("./createFieldsList");
+var _getModelTitleFieldId = require("./getModelTitleFieldId");
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9;
+var CONTENT_META_FIELDS = /* GraphQL */"\n    meta {\n        title\n        description\n        image\n        publishedOn\n        version\n        locked\n        status\n    }\n";
+var CONTENT_ENTRY_SYSTEM_FIELDS = /* GraphQL */"\n    id\n    entryId\n    savedOn\n    createdOn\n    createdBy {\n        id\n        type\n        displayName\n    }\n    ownedBy {\n        id\n        type\n        displayName\n    }\n    wbyAco_location {\n        folderId\n    }\n    ".concat(CONTENT_META_FIELDS, "\n");
+var ERROR_FIELD = /* GraphQL */"\n    {\n        message\n        code\n        data\n    }\n";
+
+/**
+ * ############################################
+ * Get CMS Entry Query
+ */
+
+var createReadQuery = function createReadQuery(model) {
+  /**
+   * This query now accepts both revision or entryId as we can load exact revision or latest (if entryId was sent).
+   */
+  return (0, _graphqlTag.default)(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n        query CmsEntriesGet", "($revision: ID, $entryId: ID) {\n            content: get", "(revision: $revision, entryId: $entryId) {\n                data {\n                    ", "\n                    ", "\n                }\n                error ", "\n            }\n        }\n    "])), model.singularApiName, model.singularApiName, CONTENT_ENTRY_SYSTEM_FIELDS, (0, _createFieldsList.createFieldsList)({
+    model: model,
+    fields: model.fields
+  }), ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * List CMS Entry Revisions Query
+ */
+exports.createReadQuery = createReadQuery;
+var createRevisionsQuery = function createRevisionsQuery(model) {
+  return (0, _graphqlTag.default)(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n        query CmsEntriesGet", "Revisions($id: ID!) {\n            revisions: get", "Revisions(id: $id) {\n                data {\n                    ", "\n                }\n                error ", "\n            }\n        }\n    "])), model.singularApiName, model.singularApiName, CONTENT_ENTRY_SYSTEM_FIELDS, ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * List CMS Entries Query
+ */
+exports.createRevisionsQuery = createRevisionsQuery;
+var createListQuery = function createListQuery(model, fields) {
+  return (0, _graphqlTag.default)(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n        query CmsEntriesList", "($where: ", "ListWhereInput, $sort: [", "ListSorter], $limit: Int, $after: String, $search: String) {\n            content: list", "(\n            where: $where\n            sort: $sort\n            limit: $limit\n            after: $after\n            search: $search\n            ) {\n                data {\n                    ", "\n                    ", "\n                    ", "\n                }\n                meta {\n                    cursor\n                    hasMoreItems\n                    totalCount\n                }\n                error ", "\n            }\n        }\n    "])), model.pluralApiName, model.singularApiName, model.singularApiName, model.pluralApiName, CONTENT_ENTRY_SYSTEM_FIELDS, fields ? (0, _createFieldsList.createFieldsList)({
+    model: model,
+    fields: fields
+  }) : "", !fields ? (0, _getModelTitleFieldId.getModelTitleFieldId)(model) : "", ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Delete Mutation
+ */
+exports.createListQuery = createListQuery;
+var createDeleteMutation = function createDeleteMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsEntriesDelete", "($revision: ID!) {\n            content: delete", "(revision: $revision) {\n                data\n                error ", "\n            }\n        }\n    "])), model.singularApiName, model.singularApiName, ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Create Mutation
+ */
+exports.createDeleteMutation = createDeleteMutation;
+var createCreateMutation = function createCreateMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsEntriesCreate", "($data: ", "Input!) {\n            content: create", "(data: $data) {\n                data {\n                    ", "\n                    ", "\n                }\n                error ", "\n            }\n        }\n    "])), model.singularApiName, model.singularApiName, model.singularApiName, CONTENT_ENTRY_SYSTEM_FIELDS, (0, _createFieldsList.createFieldsList)({
+    model: model,
+    fields: model.fields
+  }), ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Create From Mutation
+ */
+exports.createCreateMutation = createCreateMutation;
+var createCreateFromMutation = function createCreateFromMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsCreate", "From($revision: ID!, $data: ", "Input) {\n        content: create", "From(revision: $revision, data: $data) {\n                data {\n                    ", "\n                    ", "\n                }\n                error ", "\n            }\n        }"])), model.singularApiName, model.singularApiName, model.singularApiName, CONTENT_ENTRY_SYSTEM_FIELDS, (0, _createFieldsList.createFieldsList)({
+    model: model,
+    fields: model.fields
+  }), ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Update Mutation
+ */
+exports.createCreateFromMutation = createCreateFromMutation;
+var createUpdateMutation = function createUpdateMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsUpdate", "($revision: ID!, $data: ", "Input!) {\n            content: update", "(revision: $revision, data: $data) {\n                data {\n                    ", "\n                    ", "\n                }\n                error ", "\n            }\n        }\n    "])), model.singularApiName, model.singularApiName, model.singularApiName, CONTENT_ENTRY_SYSTEM_FIELDS, (0, _createFieldsList.createFieldsList)({
+    model: model,
+    fields: model.fields
+  }), ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Publish Mutation
+ */
+exports.createUpdateMutation = createUpdateMutation;
+var createPublishMutation = function createPublishMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsPublish", "($revision: ID!) {\n            content: publish", "(revision: $revision) {\n                data {\n                    id\n                    ", "\n                }\n                error ", "\n            }\n        }"])), model.singularApiName, model.singularApiName, CONTENT_META_FIELDS, ERROR_FIELD);
+};
+
+/**
+ * ############################################
+ * Unpublish Mutation
+ */
+exports.createPublishMutation = createPublishMutation;
+var createUnpublishMutation = function createUnpublishMutation(model) {
+  return (0, _graphqlTag.default)(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2.default)(["\n        mutation CmsUnpublish", "($revision: ID!) {\n            content: unpublish", "(revision: $revision) {\n                data {\n                    id\n                    ", "\n                }\n                error ", "\n            }\n        }"])), model.singularApiName, model.singularApiName, CONTENT_META_FIELDS, ERROR_FIELD);
+};
+exports.createUnpublishMutation = createUnpublishMutation;

package/entries.graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CONTENT_META_FIELDS","CONTENT_ENTRY_SYSTEM_FIELDS","ERROR_FIELD","createReadQuery","model","gql","singularApiName","createFieldsList","fields","createRevisionsQuery","createListQuery","pluralApiName","getModelTitleFieldId","createDeleteMutation","createCreateMutation","createCreateFromMutation","createUpdateMutation","createPublishMutation","createUnpublishMutation"],"sources":["entries.graphql.ts"],"sourcesContent":["import gql from \"graphql-tag\";\nimport {\n    CmsContentEntryRevision,\n    CmsContentEntry,\n    CmsEditorContentModel,\n    CmsErrorResponse,\n    CmsMetaResponse,\n    CmsModelField\n} from \"~/types\";\nimport { createFieldsList } from \"./createFieldsList\";\nimport { getModelTitleFieldId } from \"./getModelTitleFieldId\";\n\nconst CONTENT_META_FIELDS = /* GraphQL */ `\n    meta {\n        title\n        description\n        image\n        publishedOn\n        version\n        locked\n        status\n    }\n`;\n\nconst CONTENT_ENTRY_SYSTEM_FIELDS = /* GraphQL */ `\n    id\n    entryId\n    savedOn\n    createdOn\n    createdBy {\n        id\n        type\n        displayName\n    }\n    ownedBy {\n        id\n        type\n        displayName\n    }\n    wbyAco_location {\n        folderId\n    }\n    ${CONTENT_META_FIELDS}\n`;\n\nconst ERROR_FIELD = /* GraphQL */ `\n    {\n        message\n        code\n        data\n    }\n`;\n\n/**\n * ############################################\n * Get CMS Entry Query\n */\nexport interface CmsEntryGetQueryResponse {\n    content: {\n        data: CmsContentEntry;\n        error: CmsErrorResponse | null;\n    };\n}\n\nexport interface CmsEntryGetQueryVariables {\n    revision?: string;\n    entryId?: string;\n}\n\nexport const createReadQuery = (model: CmsEditorContentModel) => {\n    /**\n     * This query now accepts both revision or entryId as we can load exact revision or latest (if entryId was sent).\n     */\n    return gql`\n        query CmsEntriesGet${model.singularApiName}($revision: ID, $entryId: ID) {\n            content: get${model.singularApiName}(revision: $revision, entryId: $entryId) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                    ${createFieldsList({ model, fields: model.fields })}\n                }\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * List CMS Entry Revisions Query\n */\nexport interface CmsEntriesListRevisionsQueryResponse {\n    revisions: {\n        data: CmsContentEntryRevision[];\n        error: CmsErrorResponse | null;\n        meta: CmsMetaResponse;\n    };\n}\n\nexport interface CmsEntriesListRevisionsQueryVariables {\n    id: string;\n}\n\nexport const createRevisionsQuery = (model: CmsEditorContentModel) => {\n    return gql`\n        query CmsEntriesGet${model.singularApiName}Revisions($id: ID!) {\n            revisions: get${model.singularApiName}Revisions(id: $id) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                }\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * List CMS Entries Query\n */\nexport interface CmsEntriesListQueryResponse {\n    content: {\n        data: CmsContentEntry[];\n        error: CmsErrorResponse | null;\n        meta: CmsMetaResponse;\n    };\n}\n\nexport interface CmsEntriesListQueryVariables {\n    // TODO @ts-refactor better list types\n    where?: {\n        [key: string]: any;\n    };\n    sort?: string[];\n    limit?: number;\n    after?: string;\n}\n\nexport const createListQuery = (model: CmsEditorContentModel, fields?: CmsModelField[]) => {\n    return gql`\n        query CmsEntriesList${model.pluralApiName}($where: ${\n        model.singularApiName\n    }ListWhereInput, $sort: [${\n        model.singularApiName\n    }ListSorter], $limit: Int, $after: String, $search: String) {\n            content: list${model.pluralApiName}(\n            where: $where\n            sort: $sort\n            limit: $limit\n            after: $after\n            search: $search\n            ) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                    ${fields ? createFieldsList({ model, fields }) : \"\"}\n                    ${!fields ? getModelTitleFieldId(model) : \"\"}\n                }\n                meta {\n                    cursor\n                    hasMoreItems\n                    totalCount\n                }\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * Delete Mutation\n */\nexport interface CmsEntryDeleteMutationResponse {\n    content: {\n        data: CmsContentEntry | null;\n        error: CmsErrorResponse | null;\n    };\n}\n\nexport interface CmsEntryDeleteMutationVariables {\n    revision: string;\n}\n\nexport const createDeleteMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsEntriesDelete${model.singularApiName}($revision: ID!) {\n            content: delete${model.singularApiName}(revision: $revision) {\n                data\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * Create Mutation\n */\nexport interface CmsEntryCreateMutationResponse {\n    content: {\n        data: CmsContentEntry | null;\n        error: CmsErrorResponse | null;\n    };\n}\n\nexport interface CmsEntryCreateMutationVariables {\n    /**\n     * We have any here because we do not know which fields does entry have\n     */\n    data: Record<string, any>;\n}\n\nexport const createCreateMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsEntriesCreate${model.singularApiName}($data: ${model.singularApiName}Input!) {\n            content: create${model.singularApiName}(data: $data) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                    ${createFieldsList({ model, fields: model.fields })}\n                }\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * Create From Mutation\n */\nexport interface CmsEntryCreateFromMutationResponse {\n    content: {\n        data?: CmsContentEntry;\n        error?: CmsErrorResponse;\n    };\n}\n\nexport interface CmsEntryCreateFromMutationVariables {\n    revision: string;\n    /**\n     * We have any here because we do not know which fields does entry have\n     */\n    data?: Record<string, any>;\n}\n\nexport const createCreateFromMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsCreate${model.singularApiName}From($revision: ID!, $data: ${\n        model.singularApiName\n    }Input) {\n        content: create${model.singularApiName}From(revision: $revision, data: $data) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                    ${createFieldsList({ model, fields: model.fields })}\n                }\n                error ${ERROR_FIELD}\n            }\n        }`;\n};\n\n/**\n * ############################################\n * Update Mutation\n */\nexport interface CmsEntryUpdateMutationResponse {\n    content: {\n        data?: CmsContentEntry;\n        error?: CmsErrorResponse;\n    };\n}\n\nexport interface CmsEntryUpdateMutationVariables {\n    revision: string;\n    /**\n     * We have any here because we do not know which fields does entry have\n     */\n    data: Record<string, any>;\n}\n\nexport const createUpdateMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsUpdate${model.singularApiName}($revision: ID!, $data: ${\n        model.singularApiName\n    }Input!) {\n            content: update${model.singularApiName}(revision: $revision, data: $data) {\n                data {\n                    ${CONTENT_ENTRY_SYSTEM_FIELDS}\n                    ${createFieldsList({ model, fields: model.fields })}\n                }\n                error ${ERROR_FIELD}\n            }\n        }\n    `;\n};\n\n/**\n * ############################################\n * Publish Mutation\n */\nexport interface CmsEntryPublishMutationResponse {\n    content: {\n        data?: CmsContentEntry;\n        error?: CmsErrorResponse;\n    };\n}\n\nexport interface CmsEntryPublishMutationVariables {\n    revision: string;\n}\n\nexport const createPublishMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsPublish${model.singularApiName}($revision: ID!) {\n            content: publish${model.singularApiName}(revision: $revision) {\n                data {\n                    id\n                    ${CONTENT_META_FIELDS}\n                }\n                error ${ERROR_FIELD}\n            }\n        }`;\n};\n\n/**\n * ############################################\n * Unpublish Mutation\n */\nexport interface CmsEntryUnpublishMutationResponse {\n    content: {\n        data?: CmsContentEntry;\n        error?: CmsErrorResponse;\n    };\n}\n\nexport interface CmsEntryUnpublishMutationVariables {\n    revision: string;\n}\n\nexport const createUnpublishMutation = (model: CmsEditorContentModel) => {\n    return gql`\n        mutation CmsUnpublish${model.singularApiName}($revision: ID!) {\n            content: unpublish${model.singularApiName}(revision: $revision) {\n                data {\n                    id\n                    ${CONTENT_META_FIELDS}\n                }\n                error ${ERROR_FIELD}\n            }\n        }`;\n};\n"],"mappings":";;;;;;;;AAAA;AASA;AACA;AAA8D;AAE9D,IAAMA,mBAAmB,GAAG,6JAU3B;AAED,IAAMC,2BAA2B,GAAG,0QAkB9BD,mBAAmB,OACxB;AAED,IAAME,WAAW,GAAG,4EAMnB;;AAED;AACA;AACA;AACA;;AAaO,IAAMC,eAAe,GAAG,SAAlBA,eAAe,CAAIC,KAA4B,EAAK;EAC7D;AACJ;AACA;EACI,WAAOC,mBAAG,wXACeD,KAAK,CAACE,eAAe,EACxBF,KAAK,CAACE,eAAe,EAEzBL,2BAA2B,EAC3B,IAAAM,kCAAgB,EAAC;IAAEH,KAAK,EAALA,KAAK;IAAEI,MAAM,EAAEJ,KAAK,CAACI;EAAO,CAAC,CAAC,EAE/CN,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAgBO,IAAMO,oBAAoB,GAAG,SAAvBA,oBAAoB,CAAIL,KAA4B,EAAK;EAClE,WAAOC,mBAAG,kUACeD,KAAK,CAACE,eAAe,EACtBF,KAAK,CAACE,eAAe,EAE3BL,2BAA2B,EAEzBC,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAsBO,IAAMQ,eAAe,GAAG,SAAlBA,eAAe,CAAIN,KAA4B,EAAEI,MAAwB,EAAK;EACvF,WAAOH,mBAAG,otBACgBD,KAAK,CAACO,aAAa,EACzCP,KAAK,CAACE,eAAe,EAErBF,KAAK,CAACE,eAAe,EAEFF,KAAK,CAACO,aAAa,EAQxBV,2BAA2B,EAC3BO,MAAM,GAAG,IAAAD,kCAAgB,EAAC;IAAEH,KAAK,EAALA,KAAK;IAAEI,MAAM,EAANA;EAAO,CAAC,CAAC,GAAG,EAAE,EACjD,CAACA,MAAM,GAAG,IAAAI,0CAAoB,EAACR,KAAK,CAAC,GAAG,EAAE,EAOxCF,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAeO,IAAMW,oBAAoB,GAAG,SAAvBA,oBAAoB,CAAIT,KAA4B,EAAK;EAClE,WAAOC,mBAAG,0RACqBD,KAAK,CAACE,eAAe,EAC3BF,KAAK,CAACE,eAAe,EAE1BJ,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAkBO,IAAMY,oBAAoB,GAAG,SAAvBA,oBAAoB,CAAIV,KAA4B,EAAK;EAClE,WAAOC,mBAAG,8VACqBD,KAAK,CAACE,eAAe,EAAWF,KAAK,CAACE,eAAe,EAC3DF,KAAK,CAACE,eAAe,EAE5BL,2BAA2B,EAC3B,IAAAM,kCAAgB,EAAC;IAAEH,KAAK,EAALA,KAAK;IAAEI,MAAM,EAAEJ,KAAK,CAACI;EAAO,CAAC,CAAC,EAE/CN,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAmBO,IAAMa,wBAAwB,GAAG,SAA3BA,wBAAwB,CAAIX,KAA4B,EAAK;EACtE,WAAOC,mBAAG,yXACcD,KAAK,CAACE,eAAe,EACzCF,KAAK,CAACE,eAAe,EAEJF,KAAK,CAACE,eAAe,EAExBL,2BAA2B,EAC3B,IAAAM,kCAAgB,EAAC;IAAEH,KAAK,EAALA,KAAK;IAAEI,MAAM,EAAEJ,KAAK,CAACI;EAAO,CAAC,CAAC,EAE/CN,WAAW;AAGnC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAmBO,IAAMc,oBAAoB,GAAG,SAAvBA,oBAAoB,CAAIZ,KAA4B,EAAK;EAClE,WAAOC,mBAAG,4XACcD,KAAK,CAACE,eAAe,EACzCF,KAAK,CAACE,eAAe,EAEAF,KAAK,CAACE,eAAe,EAE5BL,2BAA2B,EAC3B,IAAAM,kCAAgB,EAAC;IAAEH,KAAK,EAALA,KAAK;IAAEI,MAAM,EAAEJ,KAAK,CAACI;EAAO,CAAC,CAAC,EAE/CN,WAAW;AAInC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAeO,IAAMe,qBAAqB,GAAG,SAAxBA,qBAAqB,CAAIb,KAA4B,EAAK;EACnE,WAAOC,mBAAG,sVACeD,KAAK,CAACE,eAAe,EACpBF,KAAK,CAACE,eAAe,EAG7BN,mBAAmB,EAEjBE,WAAW;AAGnC,CAAC;;AAED;AACA;AACA;AACA;AAHA;AAeO,IAAMgB,uBAAuB,GAAG,SAA1BA,uBAAuB,CAAId,KAA4B,EAAK;EACrE,WAAOC,mBAAG,0VACiBD,KAAK,CAACE,eAAe,EACpBF,KAAK,CAACE,eAAe,EAG/BN,mBAAmB,EAEjBE,WAAW;AAGnC,CAAC;AAAC"}

package/getModelTitleFieldId.d.ts

@@ -0,0 +1,2 @@
+import { CmsEditorContentModel } from "./types";
+export declare const getModelTitleFieldId: (model: CmsEditorContentModel) => string;

package/getModelTitleFieldId.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getModelTitleFieldId = void 0;
+var getModelTitleFieldId = function getModelTitleFieldId(model) {
+  if (!model.titleFieldId || model.titleFieldId === "id") {
+    return "";
+  }
+  return model.titleFieldId;
+};
+exports.getModelTitleFieldId = getModelTitleFieldId;

package/getModelTitleFieldId.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getModelTitleFieldId","model","titleFieldId"],"sources":["getModelTitleFieldId.ts"],"sourcesContent":["import { CmsEditorContentModel } from \"~/types\";\n\nexport const getModelTitleFieldId = (model: CmsEditorContentModel): string => {\n    if (!model.titleFieldId || model.titleFieldId === \"id\") {\n        return \"\";\n    }\n    return model.titleFieldId;\n};\n"],"mappings":";;;;;;AAEO,IAAMA,oBAAoB,GAAG,SAAvBA,oBAAoB,CAAIC,KAA4B,EAAa;EAC1E,IAAI,CAACA,KAAK,CAACC,YAAY,IAAID,KAAK,CAACC,YAAY,KAAK,IAAI,EAAE;IACpD,OAAO,EAAE;EACb;EACA,OAAOD,KAAK,CAACC,YAAY;AAC7B,CAAC;AAAC"}

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./entries.graphql";
+export * from "./getModelTitleFieldId";
+export * from "./createFieldsList";

package/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _entries = require("./entries.graphql");
+Object.keys(_entries).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _entries[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _entries[key];
+    }
+  });
+});
+var _getModelTitleFieldId = require("./getModelTitleFieldId");
+Object.keys(_getModelTitleFieldId).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _getModelTitleFieldId[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _getModelTitleFieldId[key];
+    }
+  });
+});
+var _createFieldsList = require("./createFieldsList");
+Object.keys(_createFieldsList).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _createFieldsList[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _createFieldsList[key];
+    }
+  });
+});

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./entries.graphql\";\nexport * from \"./getModelTitleFieldId\";\nexport * from \"./createFieldsList\";\n"],"mappings":";;;;;AAAA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/package.json

@@ -0,0 +1,52 @@
+{
+	"name": "@webiny/app-headless-cms-common",
+	"version": "0.0.0-unstable.085ff6572f",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.20.13",
+		"@fortawesome/fontawesome-svg-core": "1.3.0",
+		"@types/react": "17.0.39",
+		"@webiny/app-security": "0.0.0-unstable.085ff6572f",
+		"@webiny/form": "0.0.0-unstable.085ff6572f",
+		"@webiny/plugins": "0.0.0-unstable.085ff6572f",
+		"graphql": "15.8.0",
+		"graphql-tag": "2.12.6",
+		"prop-types": "15.8.1",
+		"react": "17.0.2",
+		"react-dnd": "11.1.3"
+	},
+	"devDependencies": {
+		"@babel/cli": "7.20.7",
+		"@babel/core": "7.20.12",
+		"@babel/preset-env": "7.20.2",
+		"@babel/preset-react": "7.18.6",
+		"@babel/preset-typescript": "7.18.6",
+		"@webiny/cli": "0.0.0-unstable.085ff6572f",
+		"@webiny/project-utils": "0.0.0-unstable.085ff6572f",
+		"babel-plugin-emotion": "9.2.11",
+		"babel-plugin-lodash": "3.3.4",
+		"babel-plugin-module-resolver": "4.1.0",
+		"rimraf": "3.0.2",
+		"ttypescript": "1.5.15",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "085ff6572f6bb6a76d218088b06d9f4ef92bbea7"
+}

package/types/index.d.ts

@@ -0,0 +1,503 @@
+import * as React from "react";
+import { ReactElement, ReactNode } from "react";
+import { Plugin } from "@webiny/plugins/types";
+import { BindComponent as BaseBindComponent, BindComponentProps as BaseBindComponentProps, BindComponentRenderProp as BaseBindComponentRenderProp, FormAPI } from "@webiny/form";
+import { IconName, IconPrefix } from "@fortawesome/fontawesome-svg-core";
+import { SecurityPermission } from "@webiny/app-security/types";
+import { CmsModelFieldValidator, CmsModelFieldValidatorsFactory, CmsModelFieldValidatorsGroup } from "./validation";
+import { CmsModel, CmsModelField } from "./model";
+import { CmsIdentity } from "./shared";
+import { DragObjectWithType } from "react-dnd";
+export * from "./validation";
+export * from "./model";
+export * from "./shared";
+interface QueryFieldParams {
+    model: CmsModel;
+    field: CmsModelField;
+}
+interface Position {
+    row: number;
+    index: number;
+}
+export interface DragSource extends DragObjectWithType {
+    parent?: string;
+    pos?: Partial<Position>;
+    type: "row" | "field" | "newField";
+    fieldType?: string;
+    field?: CmsModelField | null;
+    fields?: CmsModelField[];
+}
+/**
+ * @deprecated Use `CmsModelFieldTypePlugin`.
+ */
+export declare type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;
+export interface CmsModelFieldTypePlugin extends Plugin {
+    /**
+     * a plugin type
+     */
+    type: "cms-editor-field-type";
+    field: {
+        /**
+         * A unique identifier of the field type (text, number, json, myField, ...).
+         *
+         * ```ts
+         * type: "myField"
+         * ```
+         */
+        type: string;
+        /**
+         * A display name for the field.
+         *
+         * ```ts
+         * label: "Field name"
+         * ```
+         */
+        label: string;
+        /**
+         * A list of available validators for the model field.
+         *
+         * ```ts
+         * validators: [
+         *     "required",
+         *     "gte",
+         *     "lte"
+         * ]
+         * ```
+         */
+        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
+        /**
+         * A list of available validators when a model field accepts a list (array) of values.
+         *
+         * ```ts
+         * listValidators: [
+         *     "minLength",
+         *     "maxLength"
+         * ]
+         * ```
+         */
+        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
+        /**
+         * An explanation of the field displayed beneath the label.
+         *
+         * ```ts
+         * description: "A short description of the field"
+         * ```
+         */
+        description: string;
+        /**
+         * A ReactNode to display the icon for the field.
+         *
+         * ```tsx
+         * icon: <MyIconComponent />
+         * ```
+         */
+        icon: React.ReactNode;
+        /**
+         * Is it allowed to have multiple values in this field?
+         *
+         * ```ts
+         * allowMultipleValues: true
+         * ```
+         */
+        allowMultipleValues?: boolean;
+        /**
+         * Does this field type have a fixed list of values that can be selected?
+         *
+         * ```ts
+         * allowPredefinedValues: false
+         * ```
+         */
+        allowPredefinedValues?: boolean;
+        /**
+         * A ReactNode label when multiple values are enabled.
+         */
+        multipleValuesLabel?: React.ReactNode;
+        /**
+         * These are default values when the field is first created. This is a representation of the field that is stored in the database.
+         *
+         * ```ts
+         * createField: () => ({
+         *     type: "fieldType",
+         *     validation: [],
+         *     renderer: {
+         *         name: "fieldTypeRenderer"
+         *     }
+         * })
+         * ```
+         */
+        createField: () => Pick<CmsModelField, "type" | "validation" | "renderer" | "settings">;
+        /**
+         * If `true` (default), this field will be configurable via a settings dialog.
+         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.
+         */
+        canEditSettings?: boolean;
+        /**
+         * Determine if a `draggable` can be dropped into this field.
+         * NOTE: This is only applicable to nested field types.
+         */
+        canAccept?(field: CmsModelField, draggable: DragSource): boolean;
+        /**
+         * If `true` (default), will allow fields to be laid out into columns (next to each other).
+         * If `false`, horizontal layout will not be allowed.
+         * NOTE: This is only applicable to nested field types.
+         */
+        allowLayout?: boolean;
+        /**
+         * A ReactNode that you can add in the section below the help text when creating/editing field.
+         *
+         * ```tsx
+         * renderSettings: (params) => {
+         *     return <FieldSettingsComponent />;
+         * }
+         * ```
+         */
+        renderSettings?: (params: {
+            afterChangeLabel: (value: string) => void;
+            uniqueFieldIdValidator: (fieldId: string) => void;
+            contentModel: CmsModel;
+        }) => React.ReactNode;
+        /**
+         * A ReactNode that renders in the Predefined values tab.
+         *
+         * ```tsx
+         * renderPredefinedValues: (params) => {
+         *     const {form: {Bind}} = params;
+         *     return (
+         *         <Bind name="fieldProperty">
+         *             <InputComponent />
+         *         </Bind>
+         *     );
+         * }
+         * ```
+         */
+        renderPredefinedValues?: (params: {
+            getBind: (index?: number) => any;
+        }) => React.ReactElement;
+        /**
+         * Object wrapper for GraphQL stuff
+         */
+        graphql?: {
+            /**
+             * Define field selection.
+             *
+             * ```ts
+             * graphql: {
+             *     queryField: `
+             *         {
+             *             id
+             *             title
+             *             createdOn
+             *         }
+             *     `,
+             * }
+             * ```
+             */
+            queryField?: string | ((params: QueryFieldParams) => string);
+        };
+        render?(params: any): React.ReactElement;
+        tags?: string[];
+        /**
+         * Render additional information in the Admin UI Model edit view
+         */
+        renderInfo?: (params: {
+            field: CmsModelField;
+            model: CmsModel;
+        }) => React.ReactElement;
+    };
+}
+export interface CmsModelFieldRendererProps {
+    field: CmsModelField;
+    Label: React.FC;
+    getBind: (index?: number, key?: string) => BindComponent;
+    contentModel: CmsModel;
+}
+/**
+ * @deprecated Use `CmsModelFieldRendererProps`.
+ */
+export declare type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;
+/**
+ * @deprecated Use `CmsModelFieldRendererPlugin`.
+ */
+export declare type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;
+export interface CmsModelFieldRendererPlugin extends Plugin {
+    /**
+     * a plugin type
+     */
+    type: "cms-editor-field-renderer";
+    renderer: {
+        /**
+         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.
+         *
+         * ```ts
+         * renderName: "myFieldTypeRenderer"
+         * ```
+         */
+        rendererName: string;
+        /**
+         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.
+         *
+         * ```tsx
+         * name: <MyFieldNameComponent />
+         * ```
+         */
+        name: React.ReactNode;
+        /**
+         * A description for the field in the UI. Works exactly like the `name` property.
+         *
+         * ```tsx
+         * name: <MyFieldDescriptionComponent />
+         * ```
+         */
+        description: React.ReactNode;
+        /**
+         * A method that determines if the field can be rendered by this plugin.
+         *
+         * ```ts
+         * canUse({ field }) {
+         *     return (
+         *         field.type === "myType" && !field.multipleValues
+         *     );
+         * }
+         * ```
+         */
+        canUse(props: {
+            field: CmsModelField;
+            fieldPlugin: CmsModelFieldTypePlugin;
+        }): boolean;
+        /**
+         * Renders a field in the UI.
+         *
+         * ```tsx
+         * render({ field, getBind }) {
+         *     const Bind = getBind();
+         *
+         *     return (
+         *         <Bind>
+         *             {bind => {
+         *                 return (
+         *                     <Input
+         *                         value={bind.value}
+         *                         onChange={bind.onChange}
+         *                     />
+         *                 )
+         *             }}
+         *         </Bind>
+         *     );
+         * }
+         * ```
+         */
+        render(props: CmsModelFieldRendererProps): React.ReactNode;
+    };
+}
+export interface CmsEditorFieldPredefinedValuesEntry {
+    label: string;
+    value: string;
+    selected?: boolean;
+}
+export interface CmsEditorFieldPredefinedValues {
+    enabled: boolean;
+    values: CmsEditorFieldPredefinedValuesEntry[];
+}
+export interface CmsDynamicZoneTemplate {
+    id: string;
+    name: string;
+    gqlTypeName: string;
+    description: string;
+    icon: string;
+    fields: CmsModelField[];
+    layout: string[][];
+    validation: CmsModelFieldValidator[];
+}
+export declare type CmsContentEntryStatusType = "draft" | "published" | "unpublished";
+/**
+ * @deprecated Use `CmsContentEntry`.
+ */
+export declare type CmsEditorContentEntry = CmsContentEntry;
+export interface CmsContentEntry {
+    id: string;
+    savedOn: string;
+    modelId: string;
+    createdBy: CmsIdentity;
+    meta: {
+        title: string;
+        description?: string;
+        image?: string;
+        publishedOn: string;
+        locked: boolean;
+        status: CmsContentEntryStatusType;
+        version: number;
+    };
+    [key: string]: any;
+}
+export interface CmsContentEntryRevision {
+    id: string;
+    savedOn: string;
+    modelId: string;
+    createdBy: CmsIdentity;
+    meta: {
+        title: string;
+        publishedOn: string;
+        locked: boolean;
+        status: CmsContentEntryStatusType;
+        version: number;
+    };
+}
+export declare type CmsEditorContentTab = React.FC<{
+    activeTab: boolean;
+}>;
+export interface CmsEditorFieldOptionPlugin extends Plugin {
+    type: "cms-editor-field-option";
+    render(): ReactElement;
+}
+export interface CmsContentDetailsPlugin extends Plugin {
+    render: (params: any) => ReactNode;
+}
+export interface FieldLayoutPosition {
+    row: number;
+    index: number | null;
+}
+export interface CmsEditorFormSettingsPlugin extends Plugin {
+    type: "cms-editor-form-settings";
+    title: string;
+    description: string;
+    icon: React.ReactElement;
+    render(props: {
+        Bind: BaseBindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+    renderHeaderActions?(props: {
+        Bind: BaseBindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+}
+export interface CmsIcon {
+    /**
+     * [ pack, icon ], ex: ["fab", "cog"]
+     */
+    id: [IconPrefix, IconName];
+    /**
+     * Icon name
+     */
+    name: string;
+    /**
+     * SVG element
+     */
+    svg: ReactElement;
+}
+export interface CmsIconsPlugin extends Plugin {
+    type: "cms-icons";
+    getIcons(): CmsIcon[];
+}
+/**
+ * Transform field value when sending data to the API.
+ */
+export interface CmsFieldValueTransformer<TField extends CmsModelField = CmsModelField> extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-field-value-transformer";
+    /**
+     * A field type for the value transformer. Or a list of field types.
+     */
+    fieldType: string | string[];
+    /**
+     * A transformer function that takes a value and returns a new one.
+     */
+    transform: (value: any, field: TField) => any;
+}
+/**
+ * Define a custom form layout renderer for a specific content model.
+ */
+export interface CmsContentFormRendererPlugin extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-content-form-renderer";
+    /**
+     * Content model ID that will use this renderer.
+     */
+    modelId: string;
+    /**
+     * A function that will render a custom form layout.
+     */
+    render(props: {
+        /**
+         * Content model that is being rendered.
+         */
+        contentModel: CmsModel;
+        /**
+         * Content entry data handled by the Form element.
+         */
+        data: Record<string, any>;
+        /**
+         * A component to bind data to the Form.
+         */
+        Bind: BindComponent;
+        /**
+         * Content model fields to render.
+         */
+        fields: Record<string, React.ReactElement>;
+    }): React.ReactNode;
+}
+/**
+ * #########################
+ * Data types
+ * #########################
+ */
+export interface CmsSecurityPermission extends SecurityPermission {
+    accessLevel?: "full" | "no" | "custom";
+    models?: Record<string, string>;
+    groups?: Record<string, string>;
+    endpoints?: string[];
+    locales?: string[];
+    rwd?: string;
+    own?: boolean;
+    pw?: string;
+}
+/**
+ * @category GraphQL
+ * @category Error
+ */
+export interface CmsErrorResponse {
+    message: string;
+    code: string;
+    data: Record<string, any> | Record<string, any>[];
+}
+/**
+ * @category GraphQL
+ * @category Meta
+ */
+export interface CmsMetaResponse {
+    totalCount: number;
+    cursor: string | null;
+    hasMoreItems: boolean;
+}
+/***
+ * ###### FORM ########
+ */
+export interface BindComponentRenderProp<T = any, F = Record<string, any>> extends BaseBindComponentRenderProp<T, F> {
+    parentName: string;
+    appendValue: (value: any, index?: number) => void;
+    prependValue: (value: any) => void;
+    appendValues: (values: any[]) => void;
+    removeValue: (index: number) => void;
+    moveValueUp: (index: number) => void;
+    moveValueDown: (index: number) => void;
+}
+interface BindComponentProps extends Omit<BaseBindComponentProps, "children" | "name"> {
+    name?: string;
+    children?: ((props: BindComponentRenderProp) => React.ReactElement) | React.ReactElement;
+}
+export declare type BindComponent = React.FC<BindComponentProps> & {
+    parentName?: string;
+};
+/**
+ * After RequestReview and RequestChanges was removed, we need an option to add new status filters
+ */
+export interface CmsEntryFilterStatusPlugin extends Plugin {
+    type: "cms.entry.filter.status";
+    label: string;
+    value: string;
+}

package/types/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _validation = require("./validation");
+Object.keys(_validation).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _validation[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _validation[key];
+    }
+  });
+});
+var _model = require("./model");
+Object.keys(_model).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _model[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _model[key];
+    }
+  });
+});
+var _shared = require("./shared");
+Object.keys(_shared).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _shared[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _shared[key];
+    }
+  });
+});

package/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["import * as React from \"react\";\nimport { ReactElement, ReactNode } from \"react\";\nimport { Plugin } from \"@webiny/plugins/types\";\nimport {\n    BindComponent as BaseBindComponent,\n    BindComponentProps as BaseBindComponentProps,\n    BindComponentRenderProp as BaseBindComponentRenderProp,\n    FormAPI\n} from \"@webiny/form\";\nimport { IconName, IconPrefix } from \"@fortawesome/fontawesome-svg-core\";\nimport { SecurityPermission } from \"@webiny/app-security/types\";\nimport {\n    CmsModelFieldValidator,\n    CmsModelFieldValidatorsFactory,\n    CmsModelFieldValidatorsGroup\n} from \"./validation\";\nimport { CmsModel, CmsModelField } from \"./model\";\nimport { CmsIdentity } from \"~/types/shared\";\nimport { DragObjectWithType } from \"react-dnd\";\n\nexport * from \"./validation\";\nexport * from \"./model\";\nexport * from \"./shared\";\n\ninterface QueryFieldParams {\n    model: CmsModel;\n    field: CmsModelField;\n}\n\ninterface Position {\n    row: number;\n    index: number;\n}\n\nexport interface DragSource extends DragObjectWithType {\n    parent?: string;\n    pos?: Partial<Position>;\n    type: \"row\" | \"field\" | \"newField\";\n    fieldType?: string;\n    field?: CmsModelField | null;\n    fields?: CmsModelField[];\n}\n\n/**\n * @deprecated Use `CmsModelFieldTypePlugin`.\n */\nexport type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;\n\nexport interface CmsModelFieldTypePlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-type\";\n    field: {\n        /**\n         * A unique identifier of the field type (text, number, json, myField, ...).\n         *\n         * ```ts\n         * type: \"myField\"\n         * ```\n         */\n        type: string;\n        /**\n         * A display name for the field.\n         *\n         * ```ts\n         * label: \"Field name\"\n         * ```\n         */\n        label: string;\n        /**\n         * A list of available validators for the model field.\n         *\n         * ```ts\n         * validators: [\n         *     \"required\",\n         *     \"gte\",\n         *     \"lte\"\n         * ]\n         * ```\n         */\n        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * A list of available validators when a model field accepts a list (array) of values.\n         *\n         * ```ts\n         * listValidators: [\n         *     \"minLength\",\n         *     \"maxLength\"\n         * ]\n         * ```\n         */\n        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * An explanation of the field displayed beneath the label.\n         *\n         * ```ts\n         * description: \"A short description of the field\"\n         * ```\n         */\n        description: string;\n        /**\n         * A ReactNode to display the icon for the field.\n         *\n         * ```tsx\n         * icon: <MyIconComponent />\n         * ```\n         */\n        icon: React.ReactNode;\n        /**\n         * Is it allowed to have multiple values in this field?\n         *\n         * ```ts\n         * allowMultipleValues: true\n         * ```\n         */\n        allowMultipleValues?: boolean;\n        /**\n         * Does this field type have a fixed list of values that can be selected?\n         *\n         * ```ts\n         * allowPredefinedValues: false\n         * ```\n         */\n        allowPredefinedValues?: boolean;\n        /**\n         * A ReactNode label when multiple values are enabled.\n         */\n        multipleValuesLabel?: React.ReactNode;\n        /**\n         * These are default values when the field is first created. This is a representation of the field that is stored in the database.\n         *\n         * ```ts\n         * createField: () => ({\n         *     type: \"fieldType\",\n         *     validation: [],\n         *     renderer: {\n         *         name: \"fieldTypeRenderer\"\n         *     }\n         * })\n         * ```\n         */\n        createField: () => Pick<CmsModelField, \"type\" | \"validation\" | \"renderer\" | \"settings\">;\n        /**\n         * If `true` (default), this field will be configurable via a settings dialog.\n         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.\n         */\n        canEditSettings?: boolean;\n        /**\n         * Determine if a `draggable` can be dropped into this field.\n         * NOTE: This is only applicable to nested field types.\n         */\n        canAccept?(field: CmsModelField, draggable: DragSource): boolean;\n        /**\n         * If `true` (default), will allow fields to be laid out into columns (next to each other).\n         * If `false`, horizontal layout will not be allowed.\n         * NOTE: This is only applicable to nested field types.\n         */\n        allowLayout?: boolean;\n        /**\n         * A ReactNode that you can add in the section below the help text when creating/editing field.\n         *\n         * ```tsx\n         * renderSettings: (params) => {\n         *     return <FieldSettingsComponent />;\n         * }\n         * ```\n         */\n        renderSettings?: (params: {\n            afterChangeLabel: (value: string) => void;\n            uniqueFieldIdValidator: (fieldId: string) => void;\n            contentModel: CmsModel;\n        }) => React.ReactNode;\n        /**\n         * A ReactNode that renders in the Predefined values tab.\n         *\n         * ```tsx\n         * renderPredefinedValues: (params) => {\n         *     const {form: {Bind}} = params;\n         *     return (\n         *         <Bind name=\"fieldProperty\">\n         *             <InputComponent />\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        renderPredefinedValues?: (params: {\n            getBind: (index?: number) => any;\n        }) => React.ReactElement;\n        /**\n         * Object wrapper for GraphQL stuff\n         */\n        graphql?: {\n            /**\n             * Define field selection.\n             *\n             * ```ts\n             * graphql: {\n             *     queryField: `\n             *         {\n             *             id\n             *             title\n             *             createdOn\n             *         }\n             *     `,\n             * }\n             * ```\n             */\n            queryField?: string | ((params: QueryFieldParams) => string);\n        };\n        render?(params: any): React.ReactElement;\n        tags?: string[];\n        /**\n         * Render additional information in the Admin UI Model edit view\n         */\n        renderInfo?: (params: { field: CmsModelField; model: CmsModel }) => React.ReactElement;\n    };\n}\n\nexport interface CmsModelFieldRendererProps {\n    field: CmsModelField;\n    Label: React.FC;\n    getBind: (index?: number, key?: string) => BindComponent;\n    contentModel: CmsModel;\n}\n\n/**\n * @deprecated Use `CmsModelFieldRendererProps`.\n */\nexport type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;\n\n/**\n * @deprecated Use `CmsModelFieldRendererPlugin`.\n */\nexport type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;\n\nexport interface CmsModelFieldRendererPlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-renderer\";\n    renderer: {\n        /**\n         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.\n         *\n         * ```ts\n         * renderName: \"myFieldTypeRenderer\"\n         * ```\n         */\n        rendererName: string;\n        /**\n         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.\n         *\n         * ```tsx\n         * name: <MyFieldNameComponent />\n         * ```\n         */\n        name: React.ReactNode;\n        /**\n         * A description for the field in the UI. Works exactly like the `name` property.\n         *\n         * ```tsx\n         * name: <MyFieldDescriptionComponent />\n         * ```\n         */\n        description: React.ReactNode;\n        /**\n         * A method that determines if the field can be rendered by this plugin.\n         *\n         * ```ts\n         * canUse({ field }) {\n         *     return (\n         *         field.type === \"myType\" && !field.multipleValues\n         *     );\n         * }\n         * ```\n         */\n        canUse(props: { field: CmsModelField; fieldPlugin: CmsModelFieldTypePlugin }): boolean;\n        /**\n         * Renders a field in the UI.\n         *\n         * ```tsx\n         * render({ field, getBind }) {\n         *     const Bind = getBind();\n         *\n         *     return (\n         *         <Bind>\n         *             {bind => {\n         *                 return (\n         *                     <Input\n         *                         value={bind.value}\n         *                         onChange={bind.onChange}\n         *                     />\n         *                 )\n         *             }}\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        render(props: CmsModelFieldRendererProps): React.ReactNode;\n    };\n}\n\nexport interface CmsEditorFieldPredefinedValuesEntry {\n    label: string;\n    value: string;\n    selected?: boolean;\n}\n\nexport interface CmsEditorFieldPredefinedValues {\n    enabled: boolean;\n    values: CmsEditorFieldPredefinedValuesEntry[];\n}\n\nexport interface CmsDynamicZoneTemplate {\n    id: string;\n    name: string;\n    gqlTypeName: string;\n    description: string;\n    icon: string;\n    fields: CmsModelField[];\n    layout: string[][];\n    validation: CmsModelFieldValidator[];\n}\n\nexport type CmsContentEntryStatusType = \"draft\" | \"published\" | \"unpublished\";\n\n/**\n * @deprecated Use `CmsContentEntry`.\n */\nexport type CmsEditorContentEntry = CmsContentEntry;\n\nexport interface CmsContentEntry {\n    id: string;\n    savedOn: string;\n    modelId: string;\n    createdBy: CmsIdentity;\n    meta: {\n        title: string;\n        description?: string;\n        image?: string;\n        publishedOn: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n    [key: string]: any;\n}\n\nexport interface CmsContentEntryRevision {\n    id: string;\n    savedOn: string;\n    modelId: string;\n    createdBy: CmsIdentity;\n    meta: {\n        title: string;\n        publishedOn: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n}\n\nexport type CmsEditorContentTab = React.FC<{ activeTab: boolean }>;\n\n// ------------------------------------------------------------------------------------------------------------\nexport interface CmsEditorFieldOptionPlugin extends Plugin {\n    type: \"cms-editor-field-option\";\n    render(): ReactElement;\n}\n\nexport interface CmsContentDetailsPlugin extends Plugin {\n    render: (params: any) => ReactNode;\n}\n\nexport interface FieldLayoutPosition {\n    row: number;\n    index: number | null;\n}\n\nexport interface CmsEditorFormSettingsPlugin extends Plugin {\n    type: \"cms-editor-form-settings\";\n    title: string;\n    description: string;\n    icon: React.ReactElement;\n    render(props: { Bind: BaseBindComponent; form: FormAPI; formData: any }): React.ReactNode;\n    renderHeaderActions?(props: {\n        Bind: BaseBindComponent;\n        form: FormAPI;\n        formData: any;\n    }): React.ReactNode;\n}\n\nexport interface CmsIcon {\n    /**\n     * [ pack, icon ], ex: [\"fab\", \"cog\"]\n     */\n    id: [IconPrefix, IconName];\n    /**\n     * Icon name\n     */\n    name: string;\n    /**\n     * SVG element\n     */\n    svg: ReactElement;\n}\n\nexport interface CmsIconsPlugin extends Plugin {\n    type: \"cms-icons\";\n    getIcons(): CmsIcon[];\n}\n\n/**\n * Transform field value when sending data to the API.\n */\nexport interface CmsFieldValueTransformer<TField extends CmsModelField = CmsModelField>\n    extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-field-value-transformer\";\n    /**\n     * A field type for the value transformer. Or a list of field types.\n     */\n    fieldType: string | string[];\n    /**\n     * A transformer function that takes a value and returns a new one.\n     */\n    transform: (value: any, field: TField) => any;\n}\n\n/**\n * Define a custom form layout renderer for a specific content model.\n */\nexport interface CmsContentFormRendererPlugin extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-content-form-renderer\";\n    /**\n     * Content model ID that will use this renderer.\n     */\n    modelId: string;\n\n    /**\n     * A function that will render a custom form layout.\n     */\n    render(props: {\n        /**\n         * Content model that is being rendered.\n         */\n        contentModel: CmsModel;\n        /**\n         * Content entry data handled by the Form element.\n         */\n        data: Record<string, any>;\n        /**\n         * A component to bind data to the Form.\n         */\n        Bind: BindComponent;\n        /**\n         * Content model fields to render.\n         */\n        fields: Record<string, React.ReactElement>;\n    }): React.ReactNode;\n}\n/**\n * #########################\n * Data types\n * #########################\n */\nexport interface CmsSecurityPermission extends SecurityPermission {\n    accessLevel?: \"full\" | \"no\" | \"custom\";\n    models?: Record<string, string>;\n    groups?: Record<string, string>;\n    endpoints?: string[];\n    locales?: string[];\n    rwd?: string;\n    own?: boolean;\n    pw?: string;\n}\n\n/**\n * @category GraphQL\n * @category Error\n */\nexport interface CmsErrorResponse {\n    message: string;\n    code: string;\n    data: Record<string, any> | Record<string, any>[];\n}\n/**\n * @category GraphQL\n * @category Meta\n */\nexport interface CmsMetaResponse {\n    totalCount: number;\n    cursor: string | null;\n    hasMoreItems: boolean;\n}\n\n/***\n * ###### FORM ########\n */\nexport interface BindComponentRenderProp<T = any, F = Record<string, any>>\n    extends BaseBindComponentRenderProp<T, F> {\n    parentName: string;\n    appendValue: (value: any, index?: number) => void;\n    prependValue: (value: any) => void;\n    appendValues: (values: any[]) => void;\n    removeValue: (index: number) => void;\n    moveValueUp: (index: number) => void;\n    moveValueDown: (index: number) => void;\n}\n\ninterface BindComponentProps extends Omit<BaseBindComponentProps, \"children\" | \"name\"> {\n    name?: string;\n    children?: ((props: BindComponentRenderProp) => React.ReactElement) | React.ReactElement;\n}\n\nexport type BindComponent = React.FC<BindComponentProps> & {\n    parentName?: string;\n};\n\n/**\n * After RequestReview and RequestChanges was removed, we need an option to add new status filters\n */\nexport interface CmsEntryFilterStatusPlugin extends Plugin {\n    type: \"cms.entry.filter.status\";\n    label: string;\n    value: string;\n}\n"],"mappings":";;;;;AAoBA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/types/model.d.ts

@@ -0,0 +1,89 @@
+import { CmsModelFieldValidator } from "./validation";
+import { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from "./index";
+import { CmsIdentity } from "./shared";
+/**
+ * @deprecated Use `CmsModelField` instead.
+ */
+export declare type CmsEditorField<T = unknown> = CmsModelField<T>;
+export interface CmsModelFieldSettings<T = unknown> {
+    defaultValue?: string | null | undefined;
+    defaultSetValue?: string;
+    type?: string;
+    fields?: CmsModelField<T>[];
+    layout?: string[][];
+    models?: Pick<CmsModel, "modelId">[];
+    templates?: CmsDynamicZoneTemplate[];
+    imagesOnly?: boolean;
+    [key: string]: any;
+}
+export declare type CmsModelField<T = unknown> = T & {
+    id: string;
+    type: string;
+    fieldId: CmsEditorFieldId;
+    storageId?: string;
+    label: string;
+    helpText?: string;
+    placeholderText?: string;
+    validation?: CmsModelFieldValidator[];
+    listValidation?: CmsModelFieldValidator[];
+    multipleValues?: boolean;
+    predefinedValues?: CmsEditorFieldPredefinedValues;
+    settings?: CmsModelFieldSettings<T>;
+    renderer: {
+        name: string;
+    };
+    tags?: string[];
+};
+export declare type CmsEditorFieldId = string;
+export declare type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+/**
+ * @category GraphQL
+ * @category Model
+ */
+export declare type CmsEditorContentModel = CmsModel;
+/**
+ * @category GraphQL
+ * @category Group
+ */
+export interface CmsGroup {
+    id: string;
+    name: string;
+    slug: string;
+    icon?: string;
+    description?: string;
+    contentModels: CmsModel[];
+    createdBy: CmsIdentity;
+    /**
+     * Tells if this group is a plugin one (cannot be changed/deleted)
+     */
+    plugin?: boolean;
+}
+export interface CmsModel {
+    id: string;
+    group: Pick<CmsGroup, "id" | "name">;
+    description?: string;
+    version: number;
+    layout?: CmsEditorFieldsLayout;
+    fields: CmsModelField[];
+    lockedFields: CmsModelField[];
+    icon: string;
+    name: string;
+    modelId: string;
+    singularApiName: string;
+    pluralApiName: string;
+    titleFieldId: string | null;
+    descriptionFieldId: string | null;
+    imageFieldId: string | null;
+    settings: {
+        [key: string]: any;
+    };
+    status: string;
+    savedOn: string;
+    meta: any;
+    createdBy: CmsIdentity;
+    tags: string[];
+    /**
+     * If model is a plugin one (it cannot be changed/deleted)
+     */
+    plugin?: boolean;
+}

package/types/model.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import { CmsModelFieldValidator } from \"~/types/validation\";\nimport { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from \"~/types/index\";\nimport { CmsIdentity } from \"~/types/shared\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport interface CmsModelFieldSettings<T = unknown> {\n    defaultValue?: string | 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    helpText?: string;\n    placeholderText?: string;\n    validation?: CmsModelFieldValidator[];\n    listValidation?: CmsModelFieldValidator[];\n    multipleValues?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: CmsModelFieldSettings<T>;\n    renderer: {\n        name: string;\n    };\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: Pick<CmsGroup, \"id\" | \"name\">;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    lockedFields: 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    settings: {\n        [key: string]: any;\n    };\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"],"mappings":""}

package/types/shared.d.ts

@@ -0,0 +1,5 @@
+export interface CmsIdentity {
+    id: string;
+    displayName: string;
+    type: string;
+}

package/types/shared.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["shared.ts"],"sourcesContent":["export interface CmsIdentity {\n    id: string;\n    displayName: string;\n    type: string;\n}\n"],"mappings":""}

package/types/validation.d.ts

@@ -0,0 +1,79 @@
+import * as React from "react";
+import { Plugin } from "@webiny/plugins/types";
+import { CmsModelField } from ".";
+export interface CmsModelFieldValidatorConfigAdapter {
+    isRequired(): boolean;
+    getName(): string;
+    getLabel(): string;
+    getDescription(): string;
+    getDefaultMessage(): string;
+    getDefaultSettings(): Record<string, any> | undefined;
+    getVariables(): CmsModelFieldValidatorVariable[];
+    getVariableDescription(variableName: string): string | undefined;
+}
+export interface CmsModelFieldValidatorVariable {
+    name: string;
+    description: string;
+}
+/**
+ * This interface is used in the validator configuration UI (Field dialog).
+ */
+export interface CmsModelFieldValidatorConfig {
+    name: string;
+    required?: boolean;
+    label?: string;
+    description?: string;
+    defaultMessage?: string;
+    defaultSettings?: Record<string, any>;
+    variables?: CmsModelFieldValidatorVariable[];
+}
+/**
+ * This interface allows you to control the title, description, and validators located in the specific
+ * validators group, like `validators` or `listValidators` within the Field dialog.
+ */
+export interface CmsModelFieldValidatorsGroup {
+    validators: (string | CmsModelFieldValidatorConfig)[];
+    title?: string;
+    description?: string;
+}
+/**
+ * This interface allows you to generate validators based on the field configuration.
+ */
+export interface CmsModelFieldValidatorsFactory {
+    (field: CmsModelField): string[] | CmsModelFieldValidatorsGroup;
+}
+export interface CmsModelFieldValidator {
+    name: string;
+    message?: string;
+    settings?: any;
+}
+export interface CmsModelFieldValidatorPlugin<T = any> extends Plugin {
+    type: "cms-model-field-validator";
+    validator: {
+        name: string;
+        label: string;
+        description: string;
+        defaultMessage: string;
+        variables?: CmsModelFieldValidatorVariable[];
+        defaultSettings?: Record<string, any>;
+        getVariableValues?: (context: {
+            validator: CmsModelFieldValidator;
+        }) => Record<string, string>;
+        renderSettings?: (config: CmsModelFieldValidatorConfigAdapter) => React.ReactElement;
+        renderCustomUi?: () => React.ReactElement;
+        validate: (value: T, context: {
+            validator: CmsModelFieldValidator;
+            field: CmsModelField;
+        }) => Promise<any>;
+    };
+}
+export interface CmsModelFieldRegexValidatorExpressionPlugin extends Plugin {
+    type: "cms-model-field-regex-validator-expression";
+    pattern: {
+        name: string;
+        message: string;
+        label: string;
+        regex: string;
+        flags: string;
+    };
+}

package/types/validation.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["validation.ts"],"sourcesContent":["import * as React from \"react\";\nimport { Plugin } from \"@webiny/plugins/types\";\nimport { CmsModelField } from \"~/types\";\n\nexport interface CmsModelFieldValidatorConfigAdapter {\n    isRequired(): boolean;\n    getName(): string;\n    getLabel(): string;\n    getDescription(): string;\n    getDefaultMessage(): string;\n    getDefaultSettings(): Record<string, any> | undefined;\n    getVariables(): CmsModelFieldValidatorVariable[];\n    getVariableDescription(variableName: string): string | undefined;\n}\n\nexport interface CmsModelFieldValidatorVariable {\n    name: string;\n    description: string;\n}\n\n/**\n * This interface is used in the validator configuration UI (Field dialog).\n */\nexport interface CmsModelFieldValidatorConfig {\n    name: string;\n    required?: boolean;\n    label?: string;\n    description?: string;\n    defaultMessage?: string;\n    defaultSettings?: Record<string, any>;\n    variables?: CmsModelFieldValidatorVariable[];\n}\n\n/**\n * This interface allows you to control the title, description, and validators located in the specific\n * validators group, like `validators` or `listValidators` within the Field dialog.\n */\nexport interface CmsModelFieldValidatorsGroup {\n    validators: (string | CmsModelFieldValidatorConfig)[];\n    title?: string;\n    description?: string;\n}\n\n/**\n * This interface allows you to generate validators based on the field configuration.\n */\nexport interface CmsModelFieldValidatorsFactory {\n    (field: CmsModelField): string[] | CmsModelFieldValidatorsGroup;\n}\n\nexport interface CmsModelFieldValidator {\n    name: string;\n    message?: string;\n    settings?: any;\n}\n\nexport interface CmsModelFieldValidatorPlugin<T = any> extends Plugin {\n    type: \"cms-model-field-validator\";\n    validator: {\n        name: string;\n        label: string;\n        description: string;\n        defaultMessage: string;\n        variables?: CmsModelFieldValidatorVariable[];\n        defaultSettings?: Record<string, any>;\n        getVariableValues?: (context: {\n            validator: CmsModelFieldValidator;\n        }) => Record<string, string>;\n        renderSettings?: (config: CmsModelFieldValidatorConfigAdapter) => React.ReactElement;\n        renderCustomUi?: () => React.ReactElement;\n        validate: (\n            value: T,\n            context: {\n                validator: CmsModelFieldValidator;\n                field: CmsModelField;\n            }\n        ) => Promise<any>;\n    };\n}\n\nexport interface CmsModelFieldRegexValidatorExpressionPlugin extends Plugin {\n    type: \"cms-model-field-regex-validator-expression\";\n    pattern: {\n        name: string;\n        message: string;\n        label: string;\n        regex: string;\n        flags: string;\n    };\n}\n"],"mappings":""}