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

package/types/context.d.ts

@@ -0,0 +1,146 @@
+import { ContentEntryTraverser } from "../utils/contentEntryTraverser/ContentEntryTraverser";
+import { Topic } from "@webiny/pubsub/types";
+import { CmsDeleteEntryOptions, CmsEntry, CmsEntryGetParams, CmsEntryListParams, CmsEntryMeta, CmsEntryUniqueValue, CmsEntryValidateResponse, CmsEntryValues, CreateCmsEntryInput, CreateCmsEntryOptionsInput, CreateFromCmsEntryInput, CreateRevisionCmsEntryOptionsInput, DeleteMultipleEntriesParams, DeleteMultipleEntriesResponse, EntryBeforeListTopicParams, GetUniqueFieldValuesParams, OnEntryAfterCreateTopicParams, OnEntryAfterDeleteTopicParams, OnEntryAfterMoveTopicParams, OnEntryAfterPublishTopicParams, OnEntryAfterRepublishTopicParams, OnEntryAfterRestoreFromBinTopicParams, OnEntryAfterUnpublishTopicParams, OnEntryAfterUpdateTopicParams, OnEntryBeforeCreateTopicParams, OnEntryBeforeDeleteTopicParams, OnEntryBeforeGetTopicParams, OnEntryBeforeMoveTopicParams, OnEntryBeforePublishTopicParams, OnEntryBeforeRepublishTopicParams, OnEntryBeforeRestoreFromBinTopicParams, OnEntryBeforeUnpublishTopicParams, OnEntryBeforeUpdateTopicParams, OnEntryCreateErrorTopicParams, OnEntryCreateRevisionErrorTopicParams, OnEntryDeleteErrorTopicParams, OnEntryMoveErrorTopicParams, OnEntryPublishErrorTopicParams, OnEntryRepublishErrorTopicParams, OnEntryRestoreFromBinErrorTopicParams, OnEntryRevisionAfterCreateTopicParams, OnEntryRevisionAfterDeleteTopicParams, OnEntryRevisionBeforeCreateTopicParams, OnEntryRevisionBeforeDeleteTopicParams, OnEntryRevisionDeleteErrorTopicParams, OnEntryUnpublishErrorTopicParams, OnEntryUpdateErrorTopicParams, UpdateCmsEntryInput, UpdateCmsEntryOptionsInput } from "./types";
+import { CmsModel } from "./model";
+/**
+ * Cms Entry CRUD methods in the context.
+ *
+ * @category Context
+ * @category CmsEntry
+ */
+export interface CmsEntryContext {
+    /**
+     * Get content entry traverser.
+     */
+    getEntryTraverser: (modelId: string) => Promise<ContentEntryTraverser>;
+    /**
+     * Get a single content entry for a model.
+     */
+    getEntry: (model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry>;
+    /**
+     * Get a list of entries for a model by a given ID (revision).
+     */
+    getEntriesByIds: (model: CmsModel, revisions: string[]) => Promise<CmsEntry[]>;
+    /**
+     * Get the entry for a model by a given ID.
+     */
+    getEntryById: (model: CmsModel, revision: string) => Promise<CmsEntry>;
+    /**
+     * List entries for a model. Internal method used by get, listLatest and listPublished.
+     */
+    listEntries: <T = CmsEntryValues>(model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * Lists the latest entries. Used for manage API.
+     */
+    listLatestEntries: <T = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * List published entries. Used for read API.
+     */
+    listPublishedEntries: <T = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * Lists the deleted entries. Used for manage API.
+     */
+    listDeletedEntries: <T = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
+    /**
+     * List published entries by IDs.
+     */
+    getPublishedEntriesByIds: (model: CmsModel, ids: string[]) => Promise<CmsEntry[]>;
+    /**
+     * List latest entries by IDs.
+     */
+    getLatestEntriesByIds: (model: CmsModel, ids: string[]) => Promise<CmsEntry[]>;
+    /**
+     * Create a new content entry.
+     */
+    createEntry: (model: CmsModel, input: CreateCmsEntryInput, options?: CreateCmsEntryOptionsInput) => Promise<CmsEntry>;
+    /**
+     * Create a new entry from already existing entry.
+     */
+    createEntryRevisionFrom: (model: CmsModel, id: string, input: CreateFromCmsEntryInput, options?: CreateRevisionCmsEntryOptionsInput) => Promise<CmsEntry>;
+    /**
+     * Update existing entry.
+     */
+    updateEntry: (model: CmsModel, id: string, input: UpdateCmsEntryInput, meta?: Record<string, any>, options?: UpdateCmsEntryOptionsInput) => Promise<CmsEntry>;
+    /**
+     * Validate the entry - either new one or existing one.
+     */
+    validateEntry: (model: CmsModel, id?: string, input?: UpdateCmsEntryInput) => Promise<CmsEntryValidateResponse>;
+    /**
+     * Move entry, and all its revisions, to a new folder.
+     */
+    moveEntry: (model: CmsModel, id: string, folderId: string) => Promise<CmsEntry>;
+    /**
+     * Method that republishes entry with given identifier.
+     * @internal
+     */
+    republishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;
+    /**
+     * Delete only a certain revision of the entry.
+     */
+    deleteEntryRevision: (model: CmsModel, id: string) => Promise<void>;
+    /**
+     * Delete entry with all its revisions.
+     */
+    deleteEntry: (model: CmsModel, id: string, options?: CmsDeleteEntryOptions) => Promise<void>;
+    /**
+     * Restore entry from trash bin with all its revisions.
+     */
+    restoreEntryFromBin: (model: CmsModel, id: string) => Promise<CmsEntry>;
+    /**
+     * Delete multiple entries
+     */
+    deleteMultipleEntries: (model: CmsModel, params: DeleteMultipleEntriesParams) => Promise<DeleteMultipleEntriesResponse>;
+    /**
+     * Publish entry.
+     */
+    publishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;
+    /**
+     * Unpublish entry.
+     */
+    unpublishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;
+    /**
+     * Get all entry revisions.
+     */
+    getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
+    /**
+     * List all unique values for a given field.
+     *
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: GetUniqueFieldValuesParams) => Promise<CmsEntryUniqueValue[]>;
+    /**
+     * Lifecycle Events
+     */
+    onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;
+    onEntryAfterCreate: Topic<OnEntryAfterCreateTopicParams>;
+    onEntryCreateError: Topic<OnEntryCreateErrorTopicParams>;
+    onEntryRevisionBeforeCreate: Topic<OnEntryRevisionBeforeCreateTopicParams>;
+    onEntryRevisionAfterCreate: Topic<OnEntryRevisionAfterCreateTopicParams>;
+    onEntryRevisionCreateError: Topic<OnEntryCreateRevisionErrorTopicParams>;
+    onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
+    onEntryAfterUpdate: Topic<OnEntryAfterUpdateTopicParams>;
+    onEntryUpdateError: Topic<OnEntryUpdateErrorTopicParams>;
+    onEntryBeforeMove: Topic<OnEntryBeforeMoveTopicParams>;
+    onEntryAfterMove: Topic<OnEntryAfterMoveTopicParams>;
+    onEntryMoveError: Topic<OnEntryMoveErrorTopicParams>;
+    onEntryBeforeDelete: Topic<OnEntryBeforeDeleteTopicParams>;
+    onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;
+    onEntryDeleteError: Topic<OnEntryDeleteErrorTopicParams>;
+    onEntryBeforeRestoreFromBin: Topic<OnEntryBeforeRestoreFromBinTopicParams>;
+    onEntryAfterRestoreFromBin: Topic<OnEntryAfterRestoreFromBinTopicParams>;
+    onEntryRestoreFromBinError: Topic<OnEntryRestoreFromBinErrorTopicParams>;
+    onEntryRevisionBeforeDelete: Topic<OnEntryRevisionBeforeDeleteTopicParams>;
+    onEntryRevisionAfterDelete: Topic<OnEntryRevisionAfterDeleteTopicParams>;
+    onEntryRevisionDeleteError: Topic<OnEntryRevisionDeleteErrorTopicParams>;
+    onEntryBeforePublish: Topic<OnEntryBeforePublishTopicParams>;
+    onEntryAfterPublish: Topic<OnEntryAfterPublishTopicParams>;
+    onEntryPublishError: Topic<OnEntryPublishErrorTopicParams>;
+    onEntryBeforeRepublish: Topic<OnEntryBeforeRepublishTopicParams>;
+    onEntryAfterRepublish: Topic<OnEntryAfterRepublishTopicParams>;
+    onEntryRepublishError: Topic<OnEntryRepublishErrorTopicParams>;
+    onEntryBeforeUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
+    onEntryAfterUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
+    onEntryUnpublishError: Topic<OnEntryUnpublishErrorTopicParams>;
+    onEntryBeforeGet: Topic<OnEntryBeforeGetTopicParams>;
+    onEntryBeforeList: Topic<EntryBeforeListTopicParams>;
+}

package/types/context.js

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

package/types/context.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["context.ts"],"sourcesContent":["import { ContentEntryTraverser } from \"~/utils/contentEntryTraverser/ContentEntryTraverser\";\nimport { Topic } from \"@webiny/pubsub/types\";\nimport {\n    CmsDeleteEntryOptions,\n    CmsEntry,\n    CmsEntryGetParams,\n    CmsEntryListParams,\n    CmsEntryMeta,\n    CmsEntryUniqueValue,\n    CmsEntryValidateResponse,\n    CmsEntryValues,\n    CreateCmsEntryInput,\n    CreateCmsEntryOptionsInput,\n    CreateFromCmsEntryInput,\n    CreateRevisionCmsEntryOptionsInput,\n    DeleteMultipleEntriesParams,\n    DeleteMultipleEntriesResponse,\n    EntryBeforeListTopicParams,\n    GetUniqueFieldValuesParams,\n    OnEntryAfterCreateTopicParams,\n    OnEntryAfterDeleteTopicParams,\n    OnEntryAfterMoveTopicParams,\n    OnEntryAfterPublishTopicParams,\n    OnEntryAfterRepublishTopicParams,\n    OnEntryAfterRestoreFromBinTopicParams,\n    OnEntryAfterUnpublishTopicParams,\n    OnEntryAfterUpdateTopicParams,\n    OnEntryBeforeCreateTopicParams,\n    OnEntryBeforeDeleteTopicParams,\n    OnEntryBeforeGetTopicParams,\n    OnEntryBeforeMoveTopicParams,\n    OnEntryBeforePublishTopicParams,\n    OnEntryBeforeRepublishTopicParams,\n    OnEntryBeforeRestoreFromBinTopicParams,\n    OnEntryBeforeUnpublishTopicParams,\n    OnEntryBeforeUpdateTopicParams,\n    OnEntryCreateErrorTopicParams,\n    OnEntryCreateRevisionErrorTopicParams,\n    OnEntryDeleteErrorTopicParams,\n    OnEntryMoveErrorTopicParams,\n    OnEntryPublishErrorTopicParams,\n    OnEntryRepublishErrorTopicParams,\n    OnEntryRestoreFromBinErrorTopicParams,\n    OnEntryRevisionAfterCreateTopicParams,\n    OnEntryRevisionAfterDeleteTopicParams,\n    OnEntryRevisionBeforeCreateTopicParams,\n    OnEntryRevisionBeforeDeleteTopicParams,\n    OnEntryRevisionDeleteErrorTopicParams,\n    OnEntryUnpublishErrorTopicParams,\n    OnEntryUpdateErrorTopicParams,\n    UpdateCmsEntryInput,\n    UpdateCmsEntryOptionsInput\n} from \"./types\";\nimport { CmsModel } from \"./model\";\n\n/**\n * Cms Entry CRUD methods in the context.\n *\n * @category Context\n * @category CmsEntry\n */\nexport interface CmsEntryContext {\n    /**\n     * Get content entry traverser.\n     */\n    getEntryTraverser: (modelId: string) => Promise<ContentEntryTraverser>;\n    /**\n     * Get a single content entry for a model.\n     */\n    getEntry: (model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry>;\n    /**\n     * Get a list of entries for a model by a given ID (revision).\n     */\n    getEntriesByIds: (model: CmsModel, revisions: string[]) => Promise<CmsEntry[]>;\n    /**\n     * Get the entry for a model by a given ID.\n     */\n    getEntryById: (model: CmsModel, revision: string) => Promise<CmsEntry>;\n    /**\n     * List entries for a model. Internal method used by get, listLatest and listPublished.\n     */\n    listEntries: <T = CmsEntryValues>(\n        model: CmsModel,\n        params: CmsEntryListParams\n    ) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;\n    /**\n     * Lists the latest entries. Used for manage API.\n     */\n    listLatestEntries: <T = CmsEntryValues>(\n        model: CmsModel,\n        params?: CmsEntryListParams\n    ) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;\n    /**\n     * List published entries. Used for read API.\n     */\n    listPublishedEntries: <T = CmsEntryValues>(\n        model: CmsModel,\n        params?: CmsEntryListParams\n    ) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;\n    /**\n     * Lists the deleted entries. Used for manage API.\n     */\n    listDeletedEntries: <T = CmsEntryValues>(\n        model: CmsModel,\n        params?: CmsEntryListParams\n    ) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;\n    /**\n     * List published entries by IDs.\n     */\n    getPublishedEntriesByIds: (model: CmsModel, ids: string[]) => Promise<CmsEntry[]>;\n    /**\n     * List latest entries by IDs.\n     */\n    getLatestEntriesByIds: (model: CmsModel, ids: string[]) => Promise<CmsEntry[]>;\n    /**\n     * Create a new content entry.\n     */\n    createEntry: (\n        model: CmsModel,\n        input: CreateCmsEntryInput,\n        options?: CreateCmsEntryOptionsInput\n    ) => Promise<CmsEntry>;\n    /**\n     * Create a new entry from already existing entry.\n     */\n    createEntryRevisionFrom: (\n        model: CmsModel,\n        id: string,\n        input: CreateFromCmsEntryInput,\n        options?: CreateRevisionCmsEntryOptionsInput\n    ) => Promise<CmsEntry>;\n    /**\n     * Update existing entry.\n     */\n    updateEntry: (\n        model: CmsModel,\n        id: string,\n        input: UpdateCmsEntryInput,\n        meta?: Record<string, any>,\n        options?: UpdateCmsEntryOptionsInput\n    ) => Promise<CmsEntry>;\n    /**\n     * Validate the entry - either new one or existing one.\n     */\n    validateEntry: (\n        model: CmsModel,\n        id?: string,\n        input?: UpdateCmsEntryInput\n    ) => Promise<CmsEntryValidateResponse>;\n    /**\n     * Move entry, and all its revisions, to a new folder.\n     */\n    moveEntry: (model: CmsModel, id: string, folderId: string) => Promise<CmsEntry>;\n    /**\n     * Method that republishes entry with given identifier.\n     * @internal\n     */\n    republishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;\n    /**\n     * Delete only a certain revision of the entry.\n     */\n    deleteEntryRevision: (model: CmsModel, id: string) => Promise<void>;\n    /**\n     * Delete entry with all its revisions.\n     */\n    deleteEntry: (model: CmsModel, id: string, options?: CmsDeleteEntryOptions) => Promise<void>;\n    /**\n     * Restore entry from trash bin with all its revisions.\n     */\n    restoreEntryFromBin: (model: CmsModel, id: string) => Promise<CmsEntry>;\n    /**\n     * Delete multiple entries\n     */\n    deleteMultipleEntries: (\n        model: CmsModel,\n        params: DeleteMultipleEntriesParams\n    ) => Promise<DeleteMultipleEntriesResponse>;\n    /**\n     * Publish entry.\n     */\n    publishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;\n    /**\n     * Unpublish entry.\n     */\n    unpublishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;\n    /**\n     * Get all entry revisions.\n     */\n    getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;\n    /**\n     * List all unique values for a given field.\n     *\n     * @internal\n     */\n    getUniqueFieldValues: (\n        model: CmsModel,\n        params: GetUniqueFieldValuesParams\n    ) => Promise<CmsEntryUniqueValue[]>;\n    /**\n     * Lifecycle Events\n     */\n    onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;\n    onEntryAfterCreate: Topic<OnEntryAfterCreateTopicParams>;\n    onEntryCreateError: Topic<OnEntryCreateErrorTopicParams>;\n\n    onEntryRevisionBeforeCreate: Topic<OnEntryRevisionBeforeCreateTopicParams>;\n    onEntryRevisionAfterCreate: Topic<OnEntryRevisionAfterCreateTopicParams>;\n    onEntryRevisionCreateError: Topic<OnEntryCreateRevisionErrorTopicParams>;\n\n    onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;\n    onEntryAfterUpdate: Topic<OnEntryAfterUpdateTopicParams>;\n    onEntryUpdateError: Topic<OnEntryUpdateErrorTopicParams>;\n\n    onEntryBeforeMove: Topic<OnEntryBeforeMoveTopicParams>;\n    onEntryAfterMove: Topic<OnEntryAfterMoveTopicParams>;\n    onEntryMoveError: Topic<OnEntryMoveErrorTopicParams>;\n\n    onEntryBeforeDelete: Topic<OnEntryBeforeDeleteTopicParams>;\n    onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;\n    onEntryDeleteError: Topic<OnEntryDeleteErrorTopicParams>;\n\n    onEntryBeforeRestoreFromBin: Topic<OnEntryBeforeRestoreFromBinTopicParams>;\n    onEntryAfterRestoreFromBin: Topic<OnEntryAfterRestoreFromBinTopicParams>;\n    onEntryRestoreFromBinError: Topic<OnEntryRestoreFromBinErrorTopicParams>;\n\n    onEntryRevisionBeforeDelete: Topic<OnEntryRevisionBeforeDeleteTopicParams>;\n    onEntryRevisionAfterDelete: Topic<OnEntryRevisionAfterDeleteTopicParams>;\n    onEntryRevisionDeleteError: Topic<OnEntryRevisionDeleteErrorTopicParams>;\n\n    onEntryBeforePublish: Topic<OnEntryBeforePublishTopicParams>;\n    onEntryAfterPublish: Topic<OnEntryAfterPublishTopicParams>;\n    onEntryPublishError: Topic<OnEntryPublishErrorTopicParams>;\n\n    onEntryBeforeRepublish: Topic<OnEntryBeforeRepublishTopicParams>;\n    onEntryAfterRepublish: Topic<OnEntryAfterRepublishTopicParams>;\n    onEntryRepublishError: Topic<OnEntryRepublishErrorTopicParams>;\n\n    onEntryBeforeUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;\n    onEntryAfterUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;\n    onEntryUnpublishError: Topic<OnEntryUnpublishErrorTopicParams>;\n\n    onEntryBeforeGet: Topic<OnEntryBeforeGetTopicParams>;\n    onEntryBeforeList: Topic<EntryBeforeListTopicParams>;\n}\n"],"mappings":"","ignoreList":[]}

package/types/fields/dynamicZoneField.d.ts

@@ -0,0 +1,23 @@
+import { CmsModelField, CmsModelFieldValidation } from "../modelField";
+export interface CmsDynamicZoneTemplate {
+    id: string;
+    name: string;
+    gqlTypeName: string;
+    description: string;
+    icon: string;
+    fields: CmsModelField[];
+    layout: string[][];
+    validation: CmsModelFieldValidation[];
+    tags?: string[];
+}
+/**
+ * A definition for dynamic-zone field to show possible type of the field in settings.
+ */
+export interface CmsModelDynamicZoneField extends CmsModelField {
+    /**
+     * Settings object for the field. Contains `templates` property.
+     */
+    settings: {
+        templates: CmsDynamicZoneTemplate[];
+    };
+}

package/types/fields/dynamicZoneField.js

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

package/types/fields/dynamicZoneField.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["dynamicZoneField.ts"],"sourcesContent":["import { CmsModelField, CmsModelFieldValidation } from \"../modelField\";\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: CmsModelFieldValidation[];\n    tags?: string[];\n}\n\n/**\n * A definition for dynamic-zone field to show possible type of the field in settings.\n */\nexport interface CmsModelDynamicZoneField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `templates` property.\n     */\n    settings: {\n        templates: CmsDynamicZoneTemplate[];\n    };\n}\n"],"mappings":"","ignoreList":[]}

package/types/fields/objectField.d.ts

@@ -0,0 +1,13 @@
+import { CmsModelField } from "../modelField";
+/**
+ * A definition for object field to show possible type of the field in settings.
+ */
+export interface CmsModelObjectField extends CmsModelField {
+    /**
+     * Settings object for the field. Contains `templates` property.
+     */
+    settings: {
+        fields: CmsModelField[];
+        parents?: string[];
+    };
+}

package/types/fields/objectField.js

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

package/types/fields/objectField.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["objectField.ts"],"sourcesContent":["import { CmsModelField } from \"../modelField\";\n\n/**\n * A definition for object field to show possible type of the field in settings.\n */\nexport interface CmsModelObjectField extends CmsModelField {\n    /**\n     * Settings object for the field. Contains `templates` property.\n     */\n    settings: {\n        fields: CmsModelField[];\n        parents?: string[];\n    };\n}\n"],"mappings":"","ignoreList":[]}

package/types/identity.d.ts

@@ -0,0 +1,19 @@
+/**
+ * An interface describing the reference to a user that created some data in the database.
+ *
+ * @category General
+ */
+export interface CmsIdentity {
+    /**
+     * ID if the user.
+     */
+    id: string;
+    /**
+     * Full name of the user.
+     */
+    displayName: string | null;
+    /**
+     * Type of the user (admin, user)
+     */
+    type: string;
+}

package/types/identity.js

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

package/types/identity.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["identity.ts"],"sourcesContent":["/**\n * An interface describing the reference to a user that created some data in the database.\n *\n * @category General\n */\nexport interface CmsIdentity {\n    /**\n     * ID if the user.\n     */\n    id: string;\n    /**\n     * Full name of the user.\n     */\n    displayName: string | null;\n    /**\n     * Type of the user (admin, user)\n     */\n    type: string;\n}\n"],"mappings":"","ignoreList":[]}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./types";
+export * from "./modelAst";
+export * from "./context";
+export * from "./identity";
+export * from "./model";
+export * from "./modelField";
+export * from "./modelGroup";
+export * from "./plugins";
+export * from "./fields/dynamicZoneField";
+export * from "./fields/objectField";

package/types/index.js

@@ -0,0 +1,117 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _types = require("./types");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+var _modelAst = require("./modelAst");
+Object.keys(_modelAst).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _modelAst[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _modelAst[key];
+    }
+  });
+});
+var _context = require("./context");
+Object.keys(_context).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _context[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _context[key];
+    }
+  });
+});
+var _identity = require("./identity");
+Object.keys(_identity).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _identity[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _identity[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 () {
+      return _model[key];
+    }
+  });
+});
+var _modelField = require("./modelField");
+Object.keys(_modelField).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _modelField[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _modelField[key];
+    }
+  });
+});
+var _modelGroup = require("./modelGroup");
+Object.keys(_modelGroup).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _modelGroup[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _modelGroup[key];
+    }
+  });
+});
+var _plugins = require("./plugins");
+Object.keys(_plugins).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _plugins[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _plugins[key];
+    }
+  });
+});
+var _dynamicZoneField = require("./fields/dynamicZoneField");
+Object.keys(_dynamicZoneField).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _dynamicZoneField[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _dynamicZoneField[key];
+    }
+  });
+});
+var _objectField = require("./fields/objectField");
+Object.keys(_objectField).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _objectField[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _objectField[key];
+    }
+  });
+});
+
+//# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_types","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_modelAst","_context","_identity","_model","_modelField","_modelGroup","_plugins","_dynamicZoneField","_objectField"],"sources":["index.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./modelAst\";\nexport * from \"./context\";\nexport * from \"./identity\";\nexport * from \"./model\";\nexport * from \"./modelField\";\nexport * from \"./modelGroup\";\nexport * from \"./plugins\";\nexport * from \"./fields/dynamicZoneField\";\nexport * from \"./fields/objectField\";\n"],"mappings":";;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,MAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,MAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,MAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,SAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,SAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,SAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,SAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,QAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,QAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,QAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,QAAA,CAAAN,GAAA;IAAA;EAAA;AAAA;AACA,IAAAO,SAAA,GAAAX,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAS,SAAA,EAAAR,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAO,SAAA,CAAAP,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAG,SAAA,CAAAP,GAAA;IAAA;EAAA;AAAA;AACA,IAAAQ,MAAA,GAAAZ,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAU,MAAA,EAAAT,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAQ,MAAA,CAAAR,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAI,MAAA,CAAAR,GAAA;IAAA;EAAA;AAAA;AACA,IAAAS,WAAA,GAAAb,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAW,WAAA,EAAAV,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAS,WAAA,CAAAT,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAK,WAAA,CAAAT,GAAA;IAAA;EAAA;AAAA;AACA,IAAAU,WAAA,GAAAd,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAY,WAAA,EAAAX,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAU,WAAA,CAAAV,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAM,WAAA,CAAAV,GAAA;IAAA;EAAA;AAAA;AACA,IAAAW,QAAA,GAAAf,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAa,QAAA,EAAAZ,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAW,QAAA,CAAAX,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAO,QAAA,CAAAX,GAAA;IAAA;EAAA;AAAA;AACA,IAAAY,iBAAA,GAAAhB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAc,iBAAA,EAAAb,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAY,iBAAA,CAAAZ,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAQ,iBAAA,CAAAZ,GAAA;IAAA;EAAA;AAAA;AACA,IAAAa,YAAA,GAAAjB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAe,YAAA,EAAAd,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAa,YAAA,CAAAb,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAS,YAAA,CAAAb,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/types/model.d.ts

@@ -0,0 +1,199 @@
+import { CmsIdentity } from "./identity";
+import { CmsModelField, CmsModelFieldInput, LockedField } from "./modelField";
+import { CmsModelGroup } from "./modelGroup";
+/**
+ * Base CMS Model. Should not be exported and used outside of this package.
+ *
+ * @category Database model
+ * @category CmsModel
+ */
+export interface CmsModel {
+    /**
+     * Name of the content model.
+     */
+    name: string;
+    /**
+     * Unique ID for the content model. Created from name if not defined by user.
+     */
+    modelId: string;
+    /**
+     * Name of the content model in singular form to be used in the API.
+     * example:
+     * - Article
+     * - Fruit
+     * - Vegetable
+     * - Car
+     */
+    singularApiName: string;
+    /**
+     * Name of the content model in plural form to be used in the API.
+     * example:
+     * - Articles
+     * - Fruits
+     * - Vegetables
+     * - Cars
+     */
+    pluralApiName: string;
+    /**
+     * Model tenant.
+     */
+    tenant: string;
+    /**
+     * Locale this model belongs to.
+     */
+    locale: string;
+    /**
+     * Cms Group reference object.
+     */
+    group: CmsModelGroup;
+    /**
+     * Icon for the content model.
+     */
+    icon?: string | null;
+    /**
+     * Description for the content model.
+     */
+    description: string | null;
+    /**
+     * Date created
+     */
+    createdOn?: string;
+    /**
+     * Date saved. Changes on both save and create.
+     */
+    savedOn?: string;
+    /**
+     * CreatedBy object wrapper. Contains id, name and type of the user.
+     */
+    createdBy?: CmsIdentity;
+    /**
+     * List of fields defining entry values.
+     */
+    fields: CmsModelField[];
+    /**
+     * Admin UI field layout
+     *
+     * ```ts
+     * layout: [
+     *      [field1id, field2id],
+     *      [field3id]
+     * ]
+     * ```
+     */
+    layout: string[][];
+    /**
+     * Models can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * List of locked fields. Updated when entry is saved and a field has been used.
+     */
+    lockedFields?: LockedField[];
+    /**
+     * The field that is being displayed as entry title.
+     * It is picked as first available text field. Or user can select own field.
+     */
+    titleFieldId: string;
+    /**
+     * The field which is displayed as the description one.
+     * Only way this is null or undefined is that there are no long-text fields to be set as description.
+     */
+    descriptionFieldId?: string | null;
+    /**
+     * The field which is displayed as the image.
+     * Only way this is null or undefined is that there are no file fields, with images only set, to be set as image.
+     */
+    imageFieldId?: string | null;
+    /**
+     * The version of Webiny which this record was stored with.
+     */
+    webinyVersion: string;
+    /**
+     * Is model private?
+     * This is meant to be used for some internal models - will not be visible in the schema.
+     * Only available for the plugin constructed models.
+     */
+    isPrivate?: boolean;
+    /**
+     * Does this model require authorization to be performed?
+     * Only available for models created via plugins.
+     */
+    authorization?: boolean | CmsModelAuthorization;
+    /**
+     * Is this model created via plugin?
+     */
+    isPlugin?: boolean;
+}
+export interface CmsModelAuthorization {
+    permissions: boolean;
+    [key: string]: any;
+}
+/**
+ * A GraphQL `params.data` parameter received when creating content model.
+ *
+ * @category GraphQL params
+ * @category CmsModel
+ */
+export interface CmsModelCreateInput {
+    /**
+     * Name of the content model.
+     */
+    name: string;
+    /**
+     * Singular name of the content model to be used in the API.
+     */
+    singularApiName: string;
+    /**
+     * Plural name of the content model to be used in the API.
+     */
+    pluralApiName: string;
+    /**
+     * Unique ID of the content model. Created from name if not sent by the user. Cannot be changed.
+     */
+    modelId?: string;
+    /**
+     * Description of the content model.
+     */
+    description?: string | null;
+    /**
+     * Group where to put the content model in.
+     */
+    group: string;
+    /**
+     * A list of content model fields to define the entry values.
+     */
+    fields?: CmsModelFieldInput[];
+    /**
+     * Admin UI field layout
+     *
+     * ```ts
+     * layout: [
+     *      [field1id, field2id],
+     *      [field3id]
+     * ]
+     * ```
+     */
+    layout?: string[][];
+    /**
+     * Models can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Fields fieldId which are picked to represent the CMS entry.
+     */
+    titleFieldId?: string | null;
+    descriptionFieldId?: string | null;
+    imageFieldId?: string | null;
+}
+/**
+ * A GraphQL `params.data` parameter received when creating content model from existing model.
+ *
+ * @category GraphQL params
+ * @category CmsModel
+ */
+export interface CmsModelCreateFromInput extends CmsModelCreateInput {
+    /**
+     * Locale into which we want to clone the model into.
+     */
+    locale?: string;
+}

package/types/model.js

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

package/types/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import { CmsIdentity } from \"./identity\";\nimport { CmsModelField, CmsModelFieldInput, LockedField } from \"./modelField\";\nimport { CmsModelGroup } from \"./modelGroup\";\n\n/**\n * Base CMS Model. Should not be exported and used outside of this package.\n *\n * @category Database model\n * @category CmsModel\n */\nexport interface CmsModel {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Unique ID for the content model. Created from name if not defined by user.\n     */\n    modelId: string;\n    /**\n     * Name of the content model in singular form to be used in the API.\n     * example:\n     * - Article\n     * - Fruit\n     * - Vegetable\n     * - Car\n     */\n    singularApiName: string;\n    /**\n     * Name of the content model in plural form to be used in the API.\n     * example:\n     * - Articles\n     * - Fruits\n     * - Vegetables\n     * - Cars\n     */\n    pluralApiName: string;\n    /**\n     * Model tenant.\n     */\n    tenant: string;\n    /**\n     * Locale this model belongs to.\n     */\n    locale: string;\n    /**\n     * Cms Group reference object.\n     */\n    group: CmsModelGroup;\n    /**\n     * Icon for the content model.\n     */\n    icon?: string | null;\n    /**\n     * Description for the content model.\n     */\n    description: string | null;\n    /**\n     * Date created\n     */\n    createdOn?: string;\n    /**\n     * Date saved. Changes on both save and create.\n     */\n    savedOn?: string;\n    /**\n     * CreatedBy object wrapper. Contains id, name and type of the user.\n     */\n    createdBy?: CmsIdentity;\n    /**\n     * List of fields defining entry values.\n     */\n    fields: CmsModelField[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout: string[][];\n    /**\n     * Models can be tagged to give them contextual meaning.\n     */\n    tags?: string[];\n    /**\n     * List of locked fields. Updated when entry is saved and a field has been used.\n     */\n    lockedFields?: LockedField[];\n    /**\n     * The field that is being displayed as entry title.\n     * It is picked as first available text field. Or user can select own field.\n     */\n    titleFieldId: string;\n    /**\n     * The field which is displayed as the description one.\n     * Only way this is null or undefined is that there are no long-text fields to be set as description.\n     */\n    descriptionFieldId?: string | null;\n    /**\n     * The field which is displayed as the image.\n     * Only way this is null or undefined is that there are no file fields, with images only set, to be set as image.\n     */\n    imageFieldId?: string | null;\n    /**\n     * The version of Webiny which this record was stored with.\n     */\n    webinyVersion: string;\n\n    /**\n     * Is model private?\n     * This is meant to be used for some internal models - will not be visible in the schema.\n     * Only available for the plugin constructed models.\n     */\n    isPrivate?: boolean;\n\n    /**\n     * Does this model require authorization to be performed?\n     * Only available for models created via plugins.\n     */\n    authorization?: boolean | CmsModelAuthorization;\n\n    /**\n     * Is this model created via plugin?\n     */\n    isPlugin?: boolean;\n}\n\nexport interface CmsModelAuthorization {\n    permissions: boolean;\n\n    [key: string]: any;\n}\n\n/**\n * A GraphQL `params.data` parameter received when creating content model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateInput {\n    /**\n     * Name of the content model.\n     */\n    name: string;\n    /**\n     * Singular name of the content model to be used in the API.\n     */\n    singularApiName: string;\n    /**\n     * Plural name of the content model to be used in the API.\n     */\n    pluralApiName: string;\n    /**\n     * Unique ID of the content model. Created from name if not sent by the user. Cannot be changed.\n     */\n    modelId?: string;\n    /**\n     * Description of the content model.\n     */\n    description?: string | null;\n    /**\n     * Group where to put the content model in.\n     */\n    group: string;\n    /**\n     * A list of content model fields to define the entry values.\n     */\n    fields?: CmsModelFieldInput[];\n    /**\n     * Admin UI field layout\n     *\n     * ```ts\n     * layout: [\n     *      [field1id, field2id],\n     *      [field3id]\n     * ]\n     * ```\n     */\n    layout?: string[][];\n    /**\n     * Models can be tagged to give them contextual meaning.\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 * A GraphQL `params.data` parameter received when creating content model from existing model.\n *\n * @category GraphQL params\n * @category CmsModel\n */\nexport interface CmsModelCreateFromInput extends CmsModelCreateInput {\n    /**\n     * Locale into which we want to clone the model into.\n     */\n    locale?: string;\n}\n"],"mappings":"","ignoreList":[]}