@webiny/api-headless-cms 0.0.0-mt-2 → 0.0.0-unstable.06b2ede40f

package/constants.d.ts

@@ -0,0 +1,44 @@
+import type { CmsIdentity } from "./types";
+export declare const ROOT_FOLDER = "root";
+export declare const CMS_MODEL_SINGLETON_TAG = "singleton";
+export declare const ENTRY_META_FIELDS: readonly ["createdOn", "modifiedOn", "savedOn", "deletedOn", "restoredOn", "firstPublishedOn", "lastPublishedOn", "createdBy", "modifiedBy", "savedBy", "deletedBy", "restoredBy", "firstPublishedBy", "lastPublishedBy", "revisionCreatedOn", "revisionModifiedOn", "revisionSavedOn", "revisionDeletedOn", "revisionRestoredOn", "revisionFirstPublishedOn", "revisionLastPublishedOn", "revisionCreatedBy", "revisionModifiedBy", "revisionSavedBy", "revisionDeletedBy", "revisionRestoredBy", "revisionFirstPublishedBy", "revisionLastPublishedBy"];
+export type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];
+export interface RecordWithEntryMetaFields {
+    revisionCreatedOn: string;
+    revisionSavedOn: string;
+    revisionModifiedOn: string | null;
+    revisionDeletedOn: string | null;
+    revisionRestoredOn: string | null;
+    revisionFirstPublishedOn: string | null;
+    revisionLastPublishedOn: string | null;
+    revisionCreatedBy: CmsIdentity;
+    revisionSavedBy: CmsIdentity;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionRestoredBy: CmsIdentity | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    createdOn: string;
+    savedOn: string;
+    modifiedOn: string | null;
+    deletedOn: string | null;
+    restoredOn: string | null;
+    firstPublishedOn: string | null;
+    lastPublishedOn: string | null;
+    createdBy: CmsIdentity;
+    savedBy: CmsIdentity;
+    modifiedBy: CmsIdentity | null;
+    deletedBy: CmsIdentity | null;
+    restoredBy: CmsIdentity | null;
+    firstPublishedBy: CmsIdentity | null;
+    lastPublishedBy: CmsIdentity | null;
+}
+export declare const pickEntryMetaFields: (object: Partial<RecordWithEntryMetaFields>, filter?: ((fieldName: EntryMetaFieldName | string) => boolean) | undefined) => Partial<RecordWithEntryMetaFields>;
+export declare const isNullableEntryMetaField: (fieldName: string) => boolean;
+export declare const isNonNullableEntryMetaField: (fieldName: string) => boolean;
+export declare const isDateTimeEntryMetaField: (fieldName: string) => boolean;
+export declare const isIdentityEntryMetaField: (fieldName: string) => boolean;
+export declare const isRevisionEntryMetaField: (fieldName: string) => boolean;
+export declare const isEntryLevelEntryMetaField: (fieldName: string) => boolean;
+export declare const isDeletedEntryMetaField: (fieldName: string) => boolean;
+export declare const isRestoredEntryMetaField: (fieldName: string) => boolean;

package/constants.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pickEntryMetaFields = exports.isRevisionEntryMetaField = exports.isRestoredEntryMetaField = exports.isNullableEntryMetaField = exports.isNonNullableEntryMetaField = exports.isIdentityEntryMetaField = exports.isEntryLevelEntryMetaField = exports.isDeletedEntryMetaField = exports.isDateTimeEntryMetaField = exports.ROOT_FOLDER = exports.ENTRY_META_FIELDS = exports.CMS_MODEL_SINGLETON_TAG = void 0;
+const ROOT_FOLDER = exports.ROOT_FOLDER = "root";
+const CMS_MODEL_SINGLETON_TAG = exports.CMS_MODEL_SINGLETON_TAG = "singleton";
+
+// Content entries - xOn and xBy meta fields.
+const ENTRY_META_FIELDS = exports.ENTRY_META_FIELDS = [
+// Entry-level meta fields.
+"createdOn", "modifiedOn", "savedOn", "deletedOn", "restoredOn", "firstPublishedOn", "lastPublishedOn", "createdBy", "modifiedBy", "savedBy", "deletedBy", "restoredBy", "firstPublishedBy", "lastPublishedBy",
+// Revision-level meta fields.
+"revisionCreatedOn", "revisionModifiedOn", "revisionSavedOn", "revisionDeletedOn", "revisionRestoredOn", "revisionFirstPublishedOn", "revisionLastPublishedOn", "revisionCreatedBy", "revisionModifiedBy", "revisionSavedBy", "revisionDeletedBy", "revisionRestoredBy", "revisionFirstPublishedBy", "revisionLastPublishedBy"];
+const pickEntryMetaFields = (object, filter) => {
+  const pickedEntryMetaFields = {};
+  for (const entryMetaFieldName of ENTRY_META_FIELDS) {
+    const fieldExists = entryMetaFieldName in object;
+    if (!fieldExists) {
+      object[entryMetaFieldName] = undefined;
+    }
+    const mustPick = !filter || filter(entryMetaFieldName);
+    if (mustPick) {
+      Object.assign(pickedEntryMetaFields, {
+        [entryMetaFieldName]: object[entryMetaFieldName]
+      });
+    }
+  }
+  return pickedEntryMetaFields;
+};
+exports.pickEntryMetaFields = pickEntryMetaFields;
+const isNullableEntryMetaField = fieldName => {
+  // Only modifiedX, publishedX, deletedX fields are nullable.
+  const lcFieldName = fieldName.toLowerCase();
+  return lcFieldName.includes("modified") || lcFieldName.includes("published") || lcFieldName.includes("deleted") || lcFieldName.includes("restored");
+};
+exports.isNullableEntryMetaField = isNullableEntryMetaField;
+const isNonNullableEntryMetaField = fieldName => {
+  return !isNullableEntryMetaField(fieldName);
+};
+exports.isNonNullableEntryMetaField = isNonNullableEntryMetaField;
+const isDateTimeEntryMetaField = fieldName => {
+  // Only field ending with "On" are date/time fields.
+  return fieldName.endsWith("On");
+};
+exports.isDateTimeEntryMetaField = isDateTimeEntryMetaField;
+const isIdentityEntryMetaField = fieldName => {
+  // Only field ending with "On" are date/time fields.
+  return fieldName.endsWith("By");
+};
+exports.isIdentityEntryMetaField = isIdentityEntryMetaField;
+const isRevisionEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.startsWith("revision");
+};
+exports.isRevisionEntryMetaField = isRevisionEntryMetaField;
+const isEntryLevelEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && !fieldName.startsWith("revision");
+};
+exports.isEntryLevelEntryMetaField = isEntryLevelEntryMetaField;
+const isDeletedEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("deleted");
+};
+exports.isDeletedEntryMetaField = isDeletedEntryMetaField;
+const isRestoredEntryMetaField = fieldName => {
+  return ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("restored");
+};
+exports.isRestoredEntryMetaField = isRestoredEntryMetaField;
+
+//# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ROOT_FOLDER","exports","CMS_MODEL_SINGLETON_TAG","ENTRY_META_FIELDS","pickEntryMetaFields","object","filter","pickedEntryMetaFields","entryMetaFieldName","fieldExists","undefined","mustPick","Object","assign","isNullableEntryMetaField","fieldName","lcFieldName","toLowerCase","includes","isNonNullableEntryMetaField","isDateTimeEntryMetaField","endsWith","isIdentityEntryMetaField","isRevisionEntryMetaField","startsWith","isEntryLevelEntryMetaField","isDeletedEntryMetaField","isRestoredEntryMetaField"],"sources":["constants.ts"],"sourcesContent":["import type { CmsIdentity } from \"~/types\";\n\nexport const ROOT_FOLDER = \"root\";\n\nexport const CMS_MODEL_SINGLETON_TAG = \"singleton\";\n\n// Content entries - xOn and xBy meta fields.\nexport const ENTRY_META_FIELDS = [\n    // Entry-level meta fields.\n    \"createdOn\",\n    \"modifiedOn\",\n    \"savedOn\",\n    \"deletedOn\",\n    \"restoredOn\",\n    \"firstPublishedOn\",\n    \"lastPublishedOn\",\n    \"createdBy\",\n    \"modifiedBy\",\n    \"savedBy\",\n    \"deletedBy\",\n    \"restoredBy\",\n    \"firstPublishedBy\",\n    \"lastPublishedBy\",\n\n    // Revision-level meta fields.\n    \"revisionCreatedOn\",\n    \"revisionModifiedOn\",\n    \"revisionSavedOn\",\n    \"revisionDeletedOn\",\n    \"revisionRestoredOn\",\n    \"revisionFirstPublishedOn\",\n    \"revisionLastPublishedOn\",\n    \"revisionCreatedBy\",\n    \"revisionModifiedBy\",\n    \"revisionSavedBy\",\n    \"revisionDeletedBy\",\n    \"revisionRestoredBy\",\n    \"revisionFirstPublishedBy\",\n    \"revisionLastPublishedBy\"\n] as const;\n\nexport type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];\n\nexport interface RecordWithEntryMetaFields {\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionRestoredOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionRestoredBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    // Entry-level meta fields.\n    createdOn: string;\n    savedOn: string;\n    modifiedOn: string | null;\n    deletedOn: string | null;\n    restoredOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    savedBy: CmsIdentity;\n    modifiedBy: CmsIdentity | null;\n    deletedBy: CmsIdentity | null;\n    restoredBy: CmsIdentity | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedBy: CmsIdentity | null;\n}\n\nexport const pickEntryMetaFields = (\n    object: Partial<RecordWithEntryMetaFields>,\n    filter?: (fieldName: EntryMetaFieldName | string) => boolean\n) => {\n    const pickedEntryMetaFields: Partial<RecordWithEntryMetaFields> = {};\n    for (const entryMetaFieldName of ENTRY_META_FIELDS) {\n        const fieldExists = entryMetaFieldName in object;\n        if (!fieldExists) {\n            object[entryMetaFieldName] = undefined;\n        }\n\n        const mustPick = !filter || filter(entryMetaFieldName);\n        if (mustPick) {\n            Object.assign(pickedEntryMetaFields, {\n                [entryMetaFieldName]: object[entryMetaFieldName]\n            });\n        }\n    }\n\n    return pickedEntryMetaFields;\n};\n\nexport const isNullableEntryMetaField = (fieldName: string) => {\n    // Only modifiedX, publishedX, deletedX fields are nullable.\n    const lcFieldName = fieldName.toLowerCase();\n    return (\n        lcFieldName.includes(\"modified\") ||\n        lcFieldName.includes(\"published\") ||\n        lcFieldName.includes(\"deleted\") ||\n        lcFieldName.includes(\"restored\")\n    );\n};\n\nexport const isNonNullableEntryMetaField = (fieldName: string) => {\n    return !isNullableEntryMetaField(fieldName);\n};\n\nexport const isDateTimeEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"On\");\n};\n\nexport const isIdentityEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"By\");\n};\n\nexport const isRevisionEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isEntryLevelEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        !fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isDeletedEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) && fieldName.includes(\"deleted\")\n    );\n};\n\nexport const isRestoredEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.includes(\"restored\")\n    );\n};\n"],"mappings":";;;;;;AAEO,MAAMA,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG,MAAM;AAE1B,MAAME,uBAAuB,GAAAD,OAAA,CAAAC,uBAAA,GAAG,WAAW;;AAElD;AACO,MAAMC,iBAAiB,GAAAF,OAAA,CAAAE,iBAAA,GAAG;AAC7B;AACA,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,iBAAiB;AAEjB;AACA,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,CACnB;AAqCH,MAAMC,mBAAmB,GAAGA,CAC/BC,MAA0C,EAC1CC,MAA4D,KAC3D;EACD,MAAMC,qBAAyD,GAAG,CAAC,CAAC;EACpE,KAAK,MAAMC,kBAAkB,IAAIL,iBAAiB,EAAE;IAChD,MAAMM,WAAW,GAAGD,kBAAkB,IAAIH,MAAM;IAChD,IAAI,CAACI,WAAW,EAAE;MACdJ,MAAM,CAACG,kBAAkB,CAAC,GAAGE,SAAS;IAC1C;IAEA,MAAMC,QAAQ,GAAG,CAACL,MAAM,IAAIA,MAAM,CAACE,kBAAkB,CAAC;IACtD,IAAIG,QAAQ,EAAE;MACVC,MAAM,CAACC,MAAM,CAACN,qBAAqB,EAAE;QACjC,CAACC,kBAAkB,GAAGH,MAAM,CAACG,kBAAkB;MACnD,CAAC,CAAC;IACN;EACJ;EAEA,OAAOD,qBAAqB;AAChC,CAAC;AAACN,OAAA,CAAAG,mBAAA,GAAAA,mBAAA;AAEK,MAAMU,wBAAwB,GAAIC,SAAiB,IAAK;EAC3D;EACA,MAAMC,WAAW,GAAGD,SAAS,CAACE,WAAW,CAAC,CAAC;EAC3C,OACID,WAAW,CAACE,QAAQ,CAAC,UAAU,CAAC,IAChCF,WAAW,CAACE,QAAQ,CAAC,WAAW,CAAC,IACjCF,WAAW,CAACE,QAAQ,CAAC,SAAS,CAAC,IAC/BF,WAAW,CAACE,QAAQ,CAAC,UAAU,CAAC;AAExC,CAAC;AAACjB,OAAA,CAAAa,wBAAA,GAAAA,wBAAA;AAEK,MAAMK,2BAA2B,GAAIJ,SAAiB,IAAK;EAC9D,OAAO,CAACD,wBAAwB,CAACC,SAAS,CAAC;AAC/C,CAAC;AAACd,OAAA,CAAAkB,2BAAA,GAAAA,2BAAA;AAEK,MAAMC,wBAAwB,GAAIL,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAACpB,OAAA,CAAAmB,wBAAA,GAAAA,wBAAA;AAEK,MAAME,wBAAwB,GAAIP,SAAiB,IAAK;EAC3D;EACA,OAAOA,SAAS,CAACM,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAACpB,OAAA,CAAAqB,wBAAA,GAAAA,wBAAA;AAEK,MAAMC,wBAAwB,GAAIR,SAAiB,IAAK;EAC3D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAExC,CAAC;AAACvB,OAAA,CAAAsB,wBAAA,GAAAA,wBAAA;AAEK,MAAME,0BAA0B,GAAIV,SAAiB,IAAK;EAC7D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3D,CAACA,SAAS,CAACS,UAAU,CAAC,UAAU,CAAC;AAEzC,CAAC;AAACvB,OAAA,CAAAwB,0BAAA,GAAAA,0BAAA;AAEK,MAAMC,uBAAuB,GAAIX,SAAiB,IAAK;EAC1D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAAIA,SAAS,CAACG,QAAQ,CAAC,SAAS,CAAC;AAEpG,CAAC;AAACjB,OAAA,CAAAyB,uBAAA,GAAAA,uBAAA;AAEK,MAAMC,wBAAwB,GAAIZ,SAAiB,IAAK;EAC3D,OACIZ,iBAAiB,CAACe,QAAQ,CAACH,SAA+B,CAAC,IAC3DA,SAAS,CAACG,QAAQ,CAAC,UAAU,CAAC;AAEtC,CAAC;AAACjB,OAAA,CAAA0B,wBAAA,GAAAA,wBAAA","ignoreList":[]}

package/context.d.ts

@@ -0,0 +1,6 @@
+import type { CmsContext, HeadlessCmsStorageOperations } from "./types";
+import { ContextPlugin } from "@webiny/api";
+export interface CrudParams {
+    storageOperations: HeadlessCmsStorageOperations;
+}
+export declare const createContextPlugin: ({ storageOperations }: CrudParams) => ContextPlugin<CmsContext>;

package/context.js

@@ -0,0 +1,164 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createContextPlugin = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _api = require("@webiny/api");
+var _handlerGraphql = require("@webiny/handler-graphql");
+var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
+var _AccessControl = require("./crud/AccessControl/AccessControl");
+var _system = require("./crud/system.crud");
+var _contentModelGroup = require("./crud/contentModelGroup.crud");
+var _contentModel = require("./crud/contentModel.crud");
+var _contentEntry = require("./crud/contentEntry.crud");
+var _plugins = require("./plugins");
+var _valueKeyStorageConverter = require("./utils/converters/valueKeyStorageConverter");
+var _export = require("./export");
+var _importing = require("./export/crud/importing");
+var _getSchema = require("./graphql/getSchema");
+const getParameters = async context => {
+  const plugins = context.plugins.byType(_CmsParametersPlugin.CmsParametersPlugin.type);
+  for (const plugin of plugins) {
+    const result = await plugin.getParameters(context);
+    if (result !== null) {
+      return result;
+    }
+  }
+  throw new _error.default("Could not determine locale and/or type of the CMS.", "CMS_LOCALE_AND_TYPE_ERROR");
+};
+const createContextPlugin = ({
+  storageOperations
+}) => {
+  const plugin = new _api.ContextPlugin(async context => {
+    const {
+      type,
+      locale: localeCode
+    } = await getParameters(context);
+    if (localeCode) {
+      const locale = context.i18n.getLocale(localeCode);
+      if (locale) {
+        context.i18n.setContentLocale(locale);
+      }
+    }
+    const getLocale = () => {
+      const locale = context.i18n.getContentLocale();
+      if (!locale) {
+        throw new _error.default("Missing content locale in cms context.ts.", "LOCALE_ERROR");
+      }
+      return locale;
+    };
+    const getIdentity = () => {
+      return context.security.getIdentity();
+    };
+    const getTenant = () => {
+      return context.tenancy.getCurrentTenant();
+    };
+    const setSchemaType = type => {
+      if (!type) {
+        return;
+      }
+      context.cms.type = type;
+      switch (type) {
+        case "read":
+          context.cms.READ = true;
+          break;
+        case "preview":
+          context.cms.PREVIEW = true;
+          break;
+        default:
+          context.cms.MANAGE = true;
+      }
+    };
+    async function getExecutableSchema(type) {
+      const originalType = context.cms.type;
+      setSchemaType(type);
+      const schema = await context.security.withoutAuthorization(() => {
+        return (0, _getSchema.getSchema)({
+          context,
+          getTenant,
+          getLocale,
+          type
+        });
+      });
+      setSchemaType(originalType);
+      return async input => {
+        return (0, _handlerGraphql.processRequestBody)(input, schema, context);
+      };
+    }
+    context.plugins.register(new _plugins.StorageOperationsCmsModelPlugin((0, _valueKeyStorageConverter.createCmsModelFieldConvertersAttachFactory)(context.plugins)));
+    await context.benchmark.measure("headlessCms.createContext", async () => {
+      await storageOperations.beforeInit(context);
+      const accessControl = new _AccessControl.AccessControl({
+        getIdentity: context.security.getIdentity,
+        getGroupsPermissions: () => context.security.getPermissions("cms.contentModelGroup"),
+        getModelsPermissions: () => context.security.getPermissions("cms.contentModel"),
+        getEntriesPermissions: () => context.security.getPermissions("cms.contentEntry"),
+        listAllGroups: () => {
+          return context.security.withoutAuthorization(() => {
+            return context.cms.listGroups();
+          });
+        }
+      });
+      context.cms = {
+        type,
+        locale: localeCode,
+        getLocale,
+        READ: type === "read",
+        PREVIEW: type === "preview",
+        MANAGE: type === "manage",
+        storageOperations,
+        accessControl,
+        getExecutableSchema,
+        ...(0, _system.createSystemCrud)({
+          context,
+          getTenant,
+          getLocale,
+          getIdentity,
+          storageOperations
+        }),
+        ...(0, _contentModelGroup.createModelGroupsCrud)({
+          context,
+          getTenant,
+          getLocale,
+          getIdentity,
+          storageOperations,
+          accessControl
+        }),
+        ...(0, _contentModel.createModelsCrud)({
+          context,
+          getLocale,
+          getTenant,
+          getIdentity,
+          storageOperations,
+          accessControl
+        }),
+        ...(0, _contentEntry.createContentEntryCrud)({
+          context,
+          getIdentity,
+          getTenant,
+          getLocale,
+          storageOperations,
+          accessControl
+        }),
+        export: {
+          ...(0, _export.createExportCrud)(context)
+        },
+        importing: {
+          ...(0, _importing.createImportCrud)(context)
+        }
+      };
+      if (!storageOperations.init) {
+        return;
+      }
+      await storageOperations.init(context);
+    });
+  });
+  plugin.name = "cms.createContext";
+  return plugin;
+};
+exports.createContextPlugin = createContextPlugin;
+
+//# sourceMappingURL=context.js.map

package/context.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","_interopRequireDefault","require","_api","_handlerGraphql","_CmsParametersPlugin","_AccessControl","_system","_contentModelGroup","_contentModel","_contentEntry","_plugins","_valueKeyStorageConverter","_export","_importing","_getSchema","getParameters","context","plugins","byType","CmsParametersPlugin","type","plugin","result","WebinyError","createContextPlugin","storageOperations","ContextPlugin","locale","localeCode","i18n","getLocale","setContentLocale","getContentLocale","getIdentity","security","getTenant","tenancy","getCurrentTenant","setSchemaType","cms","READ","PREVIEW","MANAGE","getExecutableSchema","originalType","schema","withoutAuthorization","getSchema","input","processRequestBody","register","StorageOperationsCmsModelPlugin","createCmsModelFieldConvertersAttachFactory","benchmark","measure","beforeInit","accessControl","AccessControl","getGroupsPermissions","getPermissions","getModelsPermissions","getEntriesPermissions","listAllGroups","listGroups","createSystemCrud","createModelGroupsCrud","createModelsCrud","createContentEntryCrud","export","createExportCrud","importing","createImportCrud","init","name","exports"],"sources":["context.ts"],"sourcesContent":["import type { ApiEndpoint, CmsContext, HeadlessCmsStorageOperations } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport type { GraphQLRequestBody } from \"@webiny/handler-graphql/types\";\nimport { processRequestBody } from \"@webiny/handler-graphql\";\nimport type { CmsParametersPluginResponse } from \"~/plugins/CmsParametersPlugin\";\nimport { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin\";\nimport { AccessControl } from \"~/crud/AccessControl/AccessControl\";\nimport { createSystemCrud } from \"~/crud/system.crud\";\nimport { createModelGroupsCrud } from \"~/crud/contentModelGroup.crud\";\nimport { createModelsCrud } from \"~/crud/contentModel.crud\";\nimport { createContentEntryCrud } from \"~/crud/contentEntry.crud\";\nimport { StorageOperationsCmsModelPlugin } from \"~/plugins\";\nimport { createCmsModelFieldConvertersAttachFactory } from \"~/utils/converters/valueKeyStorageConverter\";\nimport { createExportCrud } from \"~/export\";\nimport { createImportCrud } from \"~/export/crud/importing\";\nimport { getSchema } from \"~/graphql/getSchema\";\n\nconst getParameters = async (context: CmsContext): Promise<CmsParametersPluginResponse> => {\n    const plugins = context.plugins.byType<CmsParametersPlugin>(CmsParametersPlugin.type);\n\n    for (const plugin of plugins) {\n        const result = await plugin.getParameters(context);\n        if (result !== null) {\n            return result;\n        }\n    }\n    throw new WebinyError(\n        \"Could not determine locale and/or type of the CMS.\",\n        \"CMS_LOCALE_AND_TYPE_ERROR\"\n    );\n};\n\nexport interface CrudParams {\n    storageOperations: HeadlessCmsStorageOperations;\n}\n\nexport const createContextPlugin = ({ storageOperations }: CrudParams) => {\n    const plugin = new ContextPlugin<CmsContext>(async context => {\n        const { type, locale: localeCode } = await getParameters(context);\n\n        if (localeCode) {\n            const locale = context.i18n.getLocale(localeCode);\n            if (locale) {\n                context.i18n.setContentLocale(locale);\n            }\n        }\n\n        const getLocale = () => {\n            const locale = context.i18n.getContentLocale();\n            if (!locale) {\n                throw new WebinyError(\"Missing content locale in cms context.ts.\", \"LOCALE_ERROR\");\n            }\n            return locale;\n        };\n\n        const getIdentity = () => {\n            return context.security.getIdentity();\n        };\n\n        const getTenant = () => {\n            return context.tenancy.getCurrentTenant();\n        };\n\n        const setSchemaType = (type: ApiEndpoint | null) => {\n            if (!type) {\n                return;\n            }\n\n            context.cms.type = type;\n\n            switch (type) {\n                case \"read\":\n                    context.cms.READ = true;\n                    break;\n                case \"preview\":\n                    context.cms.PREVIEW = true;\n                    break;\n                default:\n                    context.cms.MANAGE = true;\n            }\n        };\n\n        async function getExecutableSchema(type: ApiEndpoint) {\n            const originalType = context.cms.type;\n            setSchemaType(type);\n\n            const schema = await context.security.withoutAuthorization(() => {\n                return getSchema({\n                    context,\n                    getTenant,\n                    getLocale,\n                    type\n                });\n            });\n\n            setSchemaType(originalType);\n\n            return async <TData, TExtensions>(input: GraphQLRequestBody | GraphQLRequestBody[]) => {\n                return processRequestBody<TData, TExtensions>(input, schema, context);\n            };\n        }\n\n        context.plugins.register(\n            new StorageOperationsCmsModelPlugin(\n                createCmsModelFieldConvertersAttachFactory(context.plugins)\n            )\n        );\n\n        await context.benchmark.measure(\"headlessCms.createContext\", async () => {\n            await storageOperations.beforeInit(context);\n\n            const accessControl = new AccessControl({\n                getIdentity: context.security.getIdentity,\n                getGroupsPermissions: () =>\n                    context.security.getPermissions(\"cms.contentModelGroup\"),\n                getModelsPermissions: () => context.security.getPermissions(\"cms.contentModel\"),\n                getEntriesPermissions: () => context.security.getPermissions(\"cms.contentEntry\"),\n                listAllGroups: () => {\n                    return context.security.withoutAuthorization(() => {\n                        return context.cms.listGroups();\n                    });\n                }\n            });\n\n            context.cms = {\n                type,\n                locale: localeCode,\n                getLocale,\n                READ: type === \"read\",\n                PREVIEW: type === \"preview\",\n                MANAGE: type === \"manage\",\n                storageOperations,\n                accessControl,\n                getExecutableSchema,\n                ...createSystemCrud({\n                    context,\n                    getTenant,\n                    getLocale,\n                    getIdentity,\n                    storageOperations\n                }),\n                ...createModelGroupsCrud({\n                    context,\n                    getTenant,\n                    getLocale,\n                    getIdentity,\n                    storageOperations,\n                    accessControl\n                }),\n                ...createModelsCrud({\n                    context,\n                    getLocale,\n                    getTenant,\n                    getIdentity,\n                    storageOperations,\n                    accessControl\n                }),\n                ...createContentEntryCrud({\n                    context,\n                    getIdentity,\n                    getTenant,\n                    getLocale,\n                    storageOperations,\n                    accessControl\n                }),\n                export: {\n                    ...createExportCrud(context)\n                },\n                importing: {\n                    ...createImportCrud(context)\n                }\n            };\n\n            if (!storageOperations.init) {\n                return;\n            }\n            await storageOperations.init(context);\n        });\n    });\n\n    plugin.name = \"cms.createContext\";\n\n    return plugin;\n};\n"],"mappings":";;;;;;;AACA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,IAAA,GAAAD,OAAA;AAEA,IAAAE,eAAA,GAAAF,OAAA;AAEA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,cAAA,GAAAJ,OAAA;AACA,IAAAK,OAAA,GAAAL,OAAA;AACA,IAAAM,kBAAA,GAAAN,OAAA;AACA,IAAAO,aAAA,GAAAP,OAAA;AACA,IAAAQ,aAAA,GAAAR,OAAA;AACA,IAAAS,QAAA,GAAAT,OAAA;AACA,IAAAU,yBAAA,GAAAV,OAAA;AACA,IAAAW,OAAA,GAAAX,OAAA;AACA,IAAAY,UAAA,GAAAZ,OAAA;AACA,IAAAa,UAAA,GAAAb,OAAA;AAEA,MAAMc,aAAa,GAAG,MAAOC,OAAmB,IAA2C;EACvF,MAAMC,OAAO,GAAGD,OAAO,CAACC,OAAO,CAACC,MAAM,CAAsBC,wCAAmB,CAACC,IAAI,CAAC;EAErF,KAAK,MAAMC,MAAM,IAAIJ,OAAO,EAAE;IAC1B,MAAMK,MAAM,GAAG,MAAMD,MAAM,CAACN,aAAa,CAACC,OAAO,CAAC;IAClD,IAAIM,MAAM,KAAK,IAAI,EAAE;MACjB,OAAOA,MAAM;IACjB;EACJ;EACA,MAAM,IAAIC,cAAW,CACjB,oDAAoD,EACpD,2BACJ,CAAC;AACL,CAAC;AAMM,MAAMC,mBAAmB,GAAGA,CAAC;EAAEC;AAA8B,CAAC,KAAK;EACtE,MAAMJ,MAAM,GAAG,IAAIK,kBAAa,CAAa,MAAMV,OAAO,IAAI;IAC1D,MAAM;MAAEI,IAAI;MAAEO,MAAM,EAAEC;IAAW,CAAC,GAAG,MAAMb,aAAa,CAACC,OAAO,CAAC;IAEjE,IAAIY,UAAU,EAAE;MACZ,MAAMD,MAAM,GAAGX,OAAO,CAACa,IAAI,CAACC,SAAS,CAACF,UAAU,CAAC;MACjD,IAAID,MAAM,EAAE;QACRX,OAAO,CAACa,IAAI,CAACE,gBAAgB,CAACJ,MAAM,CAAC;MACzC;IACJ;IAEA,MAAMG,SAAS,GAAGA,CAAA,KAAM;MACpB,MAAMH,MAAM,GAAGX,OAAO,CAACa,IAAI,CAACG,gBAAgB,CAAC,CAAC;MAC9C,IAAI,CAACL,MAAM,EAAE;QACT,MAAM,IAAIJ,cAAW,CAAC,2CAA2C,EAAE,cAAc,CAAC;MACtF;MACA,OAAOI,MAAM;IACjB,CAAC;IAED,MAAMM,WAAW,GAAGA,CAAA,KAAM;MACtB,OAAOjB,OAAO,CAACkB,QAAQ,CAACD,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,MAAME,SAAS,GAAGA,CAAA,KAAM;MACpB,OAAOnB,OAAO,CAACoB,OAAO,CAACC,gBAAgB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAMC,aAAa,GAAIlB,IAAwB,IAAK;MAChD,IAAI,CAACA,IAAI,EAAE;QACP;MACJ;MAEAJ,OAAO,CAACuB,GAAG,CAACnB,IAAI,GAAGA,IAAI;MAEvB,QAAQA,IAAI;QACR,KAAK,MAAM;UACPJ,OAAO,CAACuB,GAAG,CAACC,IAAI,GAAG,IAAI;UACvB;QACJ,KAAK,SAAS;UACVxB,OAAO,CAACuB,GAAG,CAACE,OAAO,GAAG,IAAI;UAC1B;QACJ;UACIzB,OAAO,CAACuB,GAAG,CAACG,MAAM,GAAG,IAAI;MACjC;IACJ,CAAC;IAED,eAAeC,mBAAmBA,CAACvB,IAAiB,EAAE;MAClD,MAAMwB,YAAY,GAAG5B,OAAO,CAACuB,GAAG,CAACnB,IAAI;MACrCkB,aAAa,CAAClB,IAAI,CAAC;MAEnB,MAAMyB,MAAM,GAAG,MAAM7B,OAAO,CAACkB,QAAQ,CAACY,oBAAoB,CAAC,MAAM;QAC7D,OAAO,IAAAC,oBAAS,EAAC;UACb/B,OAAO;UACPmB,SAAS;UACTL,SAAS;UACTV;QACJ,CAAC,CAAC;MACN,CAAC,CAAC;MAEFkB,aAAa,CAACM,YAAY,CAAC;MAE3B,OAAO,MAA2BI,KAAgD,IAAK;QACnF,OAAO,IAAAC,kCAAkB,EAAqBD,KAAK,EAAEH,MAAM,EAAE7B,OAAO,CAAC;MACzE,CAAC;IACL;IAEAA,OAAO,CAACC,OAAO,CAACiC,QAAQ,CACpB,IAAIC,wCAA+B,CAC/B,IAAAC,oEAA0C,EAACpC,OAAO,CAACC,OAAO,CAC9D,CACJ,CAAC;IAED,MAAMD,OAAO,CAACqC,SAAS,CAACC,OAAO,CAAC,2BAA2B,EAAE,YAAY;MACrE,MAAM7B,iBAAiB,CAAC8B,UAAU,CAACvC,OAAO,CAAC;MAE3C,MAAMwC,aAAa,GAAG,IAAIC,4BAAa,CAAC;QACpCxB,WAAW,EAAEjB,OAAO,CAACkB,QAAQ,CAACD,WAAW;QACzCyB,oBAAoB,EAAEA,CAAA,KAClB1C,OAAO,CAACkB,QAAQ,CAACyB,cAAc,CAAC,uBAAuB,CAAC;QAC5DC,oBAAoB,EAAEA,CAAA,KAAM5C,OAAO,CAACkB,QAAQ,CAACyB,cAAc,CAAC,kBAAkB,CAAC;QAC/EE,qBAAqB,EAAEA,CAAA,KAAM7C,OAAO,CAACkB,QAAQ,CAACyB,cAAc,CAAC,kBAAkB,CAAC;QAChFG,aAAa,EAAEA,CAAA,KAAM;UACjB,OAAO9C,OAAO,CAACkB,QAAQ,CAACY,oBAAoB,CAAC,MAAM;YAC/C,OAAO9B,OAAO,CAACuB,GAAG,CAACwB,UAAU,CAAC,CAAC;UACnC,CAAC,CAAC;QACN;MACJ,CAAC,CAAC;MAEF/C,OAAO,CAACuB,GAAG,GAAG;QACVnB,IAAI;QACJO,MAAM,EAAEC,UAAU;QAClBE,SAAS;QACTU,IAAI,EAAEpB,IAAI,KAAK,MAAM;QACrBqB,OAAO,EAAErB,IAAI,KAAK,SAAS;QAC3BsB,MAAM,EAAEtB,IAAI,KAAK,QAAQ;QACzBK,iBAAiB;QACjB+B,aAAa;QACbb,mBAAmB;QACnB,GAAG,IAAAqB,wBAAgB,EAAC;UAChBhD,OAAO;UACPmB,SAAS;UACTL,SAAS;UACTG,WAAW;UACXR;QACJ,CAAC,CAAC;QACF,GAAG,IAAAwC,wCAAqB,EAAC;UACrBjD,OAAO;UACPmB,SAAS;UACTL,SAAS;UACTG,WAAW;UACXR,iBAAiB;UACjB+B;QACJ,CAAC,CAAC;QACF,GAAG,IAAAU,8BAAgB,EAAC;UAChBlD,OAAO;UACPc,SAAS;UACTK,SAAS;UACTF,WAAW;UACXR,iBAAiB;UACjB+B;QACJ,CAAC,CAAC;QACF,GAAG,IAAAW,oCAAsB,EAAC;UACtBnD,OAAO;UACPiB,WAAW;UACXE,SAAS;UACTL,SAAS;UACTL,iBAAiB;UACjB+B;QACJ,CAAC,CAAC;QACFY,MAAM,EAAE;UACJ,GAAG,IAAAC,wBAAgB,EAACrD,OAAO;QAC/B,CAAC;QACDsD,SAAS,EAAE;UACP,GAAG,IAAAC,2BAAgB,EAACvD,OAAO;QAC/B;MACJ,CAAC;MAED,IAAI,CAACS,iBAAiB,CAAC+C,IAAI,EAAE;QACzB;MACJ;MACA,MAAM/C,iBAAiB,CAAC+C,IAAI,CAACxD,OAAO,CAAC;IACzC,CAAC,CAAC;EACN,CAAC,CAAC;EAEFK,MAAM,CAACoD,IAAI,GAAG,mBAAmB;EAEjC,OAAOpD,MAAM;AACjB,CAAC;AAACqD,OAAA,CAAAlD,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/crud/AccessControl/AccessControl.d.ts

@@ -0,0 +1,98 @@
+import type { SecurityIdentity } from "@webiny/api-security/types";
+import type { CmsEntry, CmsEntryPermission, CmsGroup, CmsGroupPermission, CmsModel, CmsModelPermission } from "../../types";
+export interface AccessControlParams {
+    getIdentity: () => SecurityIdentity | Promise<SecurityIdentity>;
+    getGroupsPermissions: () => CmsGroupPermission[] | Promise<CmsGroupPermission[]>;
+    getModelsPermissions: () => CmsModelPermission[] | Promise<CmsModelPermission[]>;
+    getEntriesPermissions: () => CmsEntryPermission[] | Promise<CmsEntryPermission[]>;
+    listAllGroups: () => Promise<CmsGroup[]>;
+}
+interface GetGroupsAccessControlListParams {
+    group?: CmsGroup;
+}
+interface CanAccessGroupParams extends GetGroupsAccessControlListParams {
+    rwd?: string;
+}
+interface GetModelsAccessControlListParams {
+    model?: CmsModel;
+}
+interface CanAccessModelParams extends GetModelsAccessControlListParams {
+    rwd?: string;
+}
+interface GetEntriesAccessControlListParams {
+    model: Pick<CmsModel, "modelId" | "createdBy" | "group" | "locale" | "authorization">;
+    entry?: Pick<CmsEntry, "entryId" | "createdBy">;
+}
+export interface CanAccessEntryParams extends GetEntriesAccessControlListParams {
+    rwd?: string;
+    pw?: string;
+}
+interface AccessControlEntry {
+    rwd: string;
+    canAccessNonOwned: boolean;
+    canAccessOnlyOwned: boolean;
+}
+type AccessControlList = AccessControlEntry[];
+interface EntriesAccessControlEntry extends AccessControlEntry {
+    pw?: string;
+}
+type EntriesAccessControlList = EntriesAccessControlEntry[];
+export declare class AccessControl {
+    getIdentity: AccessControlParams["getIdentity"];
+    getGroupsPermissions: AccessControlParams["getGroupsPermissions"];
+    getModelsPermissions: AccessControlParams["getModelsPermissions"];
+    getEntriesPermissions: AccessControlParams["getEntriesPermissions"];
+    listAllGroupsCallback: AccessControlParams["listAllGroups"];
+    private fullAccessPermissions;
+    private allGroups;
+    constructor({ getIdentity, getGroupsPermissions, getModelsPermissions, getEntriesPermissions, listAllGroups }: AccessControlParams);
+    /**
+     * Groups-related methods below. 👇
+     * - canAccessGroup
+     * - ensureCanAccessGroup
+     * - canAccessNonOwnedGroups
+     * - canAccessOnlyOwnedGroups
+     * - getGroupsAccessControlList
+     * - hasFullAccessToGroups
+     */
+    canAccessGroup(params?: CanAccessGroupParams): Promise<boolean>;
+    ensureCanAccessGroup(params?: CanAccessGroupParams): Promise<void>;
+    canAccessNonOwnedGroups(params: GetGroupsAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedGroups(params: GetGroupsAccessControlListParams): Promise<boolean>;
+    getGroupsAccessControlList(params: GetGroupsAccessControlListParams): Promise<AccessControlList>;
+    hasFullAccessToGroups(): Promise<boolean>;
+    /**
+     * Models-related methods below. 👇
+     * - canAccessModel
+     * - ensureCanAccessModel
+     * - canAccessNonOwnedModels
+     * - canAccessOnlyOwnedModels
+     * - getModelsAccessControlList
+     * - hasFullAccessToModels
+     */
+    canAccessModel(params: CanAccessModelParams): Promise<boolean>;
+    ensureCanAccessModel(params?: CanAccessModelParams): Promise<void>;
+    canAccessNonOwnedModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    getModelsAccessControlList(params: GetModelsAccessControlListParams): Promise<AccessControlList>;
+    hasFullAccessToModels(params: GetModelsAccessControlListParams): Promise<boolean>;
+    /**
+     * Entries-related methods below. 👇
+     * - canAccessEntry
+     * - ensureCanAccessEntry
+     * - canAccessNonOwnedEntries
+     * - canAccessOnlyOwnedEntries
+     * - getEntriesAccessControlList
+     * - hasFullAccessToEntries
+     */
+    canAccessEntry(params: CanAccessEntryParams): Promise<boolean>;
+    ensureCanAccessEntry(params: CanAccessEntryParams): Promise<void>;
+    canAccessNonOwnedEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    canAccessOnlyOwnedEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    getEntriesAccessControlList(params: GetEntriesAccessControlListParams): Promise<EntriesAccessControlList>;
+    hasFullAccessToEntries(params: GetEntriesAccessControlListParams): Promise<boolean>;
+    private modelAuthorizationDisabled;
+    listAllGroups(): Promise<CmsGroup[]>;
+    getGroup(id: string): Promise<CmsGroup | undefined>;
+}
+export {};