@webiny/api-headless-cms 5.17.4 → 5.18.0-beta.3

package/types.js

@@ -14,19 +14,19 @@ exports.CONTENT_ENTRY_STATUS = void 0;
 /**
  * Object containing content model field predefined options and values.
  *
- * @category ContentModelField
+ * @category CmsModelField
  */
 
 /**
  * Object containing content model field renderer options.
  *
- * @category ContentModelField
+ * @category CmsModelField
  */
 
 /**
  * A definition for content model field. This type exists on the app side as well.
  *
- * @category ContentModelField
+ * @category ModelField
  * @category Database model
  */
 
@@ -37,7 +37,7 @@ exports.CONTENT_ENTRY_STATUS = void 0;
 /**
  * Arguments for the field validator validate method.
  *
- * @category ContentModelField
+ * @category ModelField
  * @category FieldValidation
  */
 
@@ -45,7 +45,7 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * Definition for the field validator.
  *
  * @category Plugin
- * @category ContentModelField
+ * @category ModelField
  * @category FieldValidation
  */
 
@@ -53,32 +53,32 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * A pattern validator for the content entry field value.
  *
  * @category Plugin
- * @category ContentModelField
+ * @category ModelField
  * @category FieldValidation
  */
 
 /**
  * Locked field in the content model
  *
- * @see CmsContentModel.lockedFields
+ * @see CmsModel.lockedFields
  *
- * @category ContentModelField
+ * @category ModelField
  */
 
 /**
- * Content model defining an entry.
+ * Cms Model defining an entry.
  *
  * @category Database model
- * @category ContentModel
+ * @category CmsModel
  */
 
 /**
- * @category ContentModelField
+ * @category ModelField
  */
 
 /**
  * @category Plugin
- * @category ContentModelField
+ * @category ModelField
  * @category GraphQL
  */
 
@@ -86,12 +86,12 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * Check for content model locked field.
  * A custom plugin definable by the user.
  *
- * @category ContentModel
+ * @category CmsModel
  * @category Plugin
  */
 
 /**
- * @category ContentModelField
+ * @category ModelField
  */
 
 /**
@@ -113,152 +113,182 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  */
 
 /**
- * A GraphQL args.data parameter received when creating content model group.
+ * A GraphQL params.data parameter received when creating content model group.
  *
- * @category ContentModelGroup
- * @category GraphQL args
+ * @category CmsGroup
+ * @category GraphQL params
  */
 
 /**
- * A GraphQL args.data parameter received when updating content model group.
+ * A GraphQL params.data parameter received when updating content model group.
  *
- * @category ContentModelGroup
- * @category GraphQL args
+ * @category CmsGroup
+ * @category GraphQL params
  */
 
 /**
  * A representation of content model group in the database.
  *
- * @category ContentModelGroup
+ * @category CmsGroup
  * @category Database model
  */
 
 /**
  * A data.where parameter received when listing content model groups.
  *
- * @category ContentModelGroup
- * @category GraphQL args
+ * @category CmsGroup
+ * @category GraphQL params
  */
 
 /**
- * Content model group in context.
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+
+/**
+ * Cms Group in context.
  *
  * @category Context
- * @category ContentModelGroup
+ * @category CmsGroup
  */
 
 /**
  * Definition for content model field validator.
  *
- * @category ContentModelField
+ * @category ModelField
  * @category FieldValidation
  */
 
 /**
- * A GraphQL args.data parameter received when creating content model.
+ * A GraphQL params.data parameter received when creating content model.
  *
- * @category GraphQL args
- * @category ContentModel
+ * @category GraphQL params
+ * @category CmsModel
  */
 
 /**
  * A definition for content model field received from the user.
  *
- * Input type for `CmsContentModelField`.
- * @see CmsContentModelField
+ * Input type for `CmsModelField`.
+ * @see CmsModelField
  *
- * @category GraphQL args
- * @category ContentModelField
+ * @category GraphQL params
+ * @category ModelField
  */
 
 /**
- * A GraphQL args.data parameter received when updating content model.
+ * A GraphQL params.data parameter received when updating content model.
  *
- * @category GraphQL args
- * @category ContentModel
+ * @category GraphQL params
+ * @category CmsModel
  */
 
 /**
- * A plugin to load a CmsContentModelManager.
+ * A plugin to load a CmsModelManager.
  *
- * @see CmsContentModelManager
+ * @see CmsModelManager
  *
  * @category Plugin
- * @category ContentModel
- * @category ContentEntry
+ * @category CmsModel
+ * @category CmsEntry
  */
 
 /**
  * A content entry definition for and from the database.
  *
  * @category Database model
- * @category ContentEntry
+ * @category CmsEntry
  */
 
 /**
  * A definition for content model manager to be used in the code.
- * The default one uses `CmsContentEntryContext` methods internally, but devs can change to what every they want.
+ * The default one uses `CmsEntryContext` methods internally, but devs can change to what every they want.
  *
- * @see CmsContentEntryContext
+ * @see CmsEntryContext
  *
  * @category Context
- * @category ContentEntry
- * @category ContentModel
+ * @category CmsEntry
+ * @category CmsModel
  */
 
 /**
- * Content model in the context.
+ * Cms Model in the context.
  *
  * @category Context
- * @category ContentModel
+ * @category CmsModel
  */
 
 /**
  * Available statuses for content entry.
  *
- * @category ContentEntry
+ * @category CmsEntry
  */
 
 /**
- * Entry listing where args.
+ * Entry listing where params.
  *
- * @category ContentEntry
- * @category GraphQL args
+ * @category CmsEntry
+ * @category GraphQL params
  */
 
 /**
  * Entry listing sort.
  *
- * @category ContentEntry
- * @category GraphQL args
+ * @category CmsEntry
+ * @category GraphQL params
  */
 
 /**
- * Get entry GraphQL resolver args.
+ * Get entry GraphQL resolver params.
  *
- * @category ContentEntry
- * @category GraphQL args
+ * @category CmsEntry
+ * @category GraphQL params
  */
 
 /**
- * List entries GraphQL resolver args.
+ * List entries GraphQL resolver params.
  *
- * @category ContentEntry
- * @category GraphQL args
+ * @category CmsEntry
+ * @category GraphQL params
  */
 
 /**
  * Meta information for GraphQL output.
  *
- * @category ContentEntry
+ * @category CmsEntry
  * @category GraphQL output
  */
 
 /**
- * Content entry CRUD methods in the context.
+ * Cms Entry CRUD methods in the context.
  *
  * @category Context
- * @category ContentEntry
+ * @category CmsEntry
  */
 
 /**
@@ -268,17 +298,17 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  */
 
 /**
- * Parameters for ContentEntryResolverFactory.
+ * Parameters for CmsEntryResolverFactory.
  *
  * @category GraphQL resolver
- * @category ContentEntry
+ * @category CmsEntry
  */
 
 /**
- * A type for ContentEntryResolvers. Used when creating get, list, update, publish, ...etc.
+ * A type for EntryResolvers. Used when creating get, list, update, publish, ...etc.
  *
  * @category GraphQL resolver
- * @category ContentEntry
+ * @category CmsEntry
  */
 
 /**
@@ -292,222 +322,43 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * A security permission for content model.
  *
  * @category SecurityPermission
- * @category ContentModel
+ * @category CmsModel
  */
 
 /**
  * The security permission for content model groups.
  *
  * @category SecurityPermission
- * @category ContentModelGroup
+ * @category CmsGroup
  */
 
 /**
  * The security permission for content entry.
  *
  * @category SecurityPermission
- * @category ContentEntry
- */
-
-/**
- * A argument definition for CmsModelFieldToStoragePlugin.toStorage
- *
- * @see CmsModelFieldToStoragePlugin.toStorage
- *
- * @category Plugin
- * @category ContentModelField
- * @category Storage
- */
-
-/**
- * A argument definition for CmsModelFieldToStoragePlugin.fromStorage
- *
- * @see CmsModelFieldToStoragePlugin.fromStorage
- *
- * @category Plugin
- * @category ContentModelField
- * @category Storage
+ * @category CmsEntry
  */
 
 /**
- * A plugin defining transformation of field value to and from storage.
- *
- * @category Plugin
- * @category ContentModelField
- * @category ContentEntry
- * @category Storage
- */
-
-/**
- * @category LifecycleHook
- * @category ContentModel
- */
-
-/**
- * @category LifecycleHook
- * @category ContentModel
- */
-
-/**
- * @category LifecycleHook
- * @category ContentModel
- */
-
-/**
- * A plugin type that defines lifecycle hooks for content model.
- *
- * @category Plugin
- * @category ContentModel
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * A plugin type that defines lifecycle hooks for content entry.
- *
- * @category Plugin
- * @category ContentEntry
- * @category LifecycleHook
- */
-
-/**
- * Arguments for the group storage operations provider method.
- */
-
-/**
- * A plugin that provides the group storage operations implementation.
- */
-
-/**
- * Description of the ContentModelGroup CRUD operations.
+ * Description of the CmsGroup CRUD operations.
  * If user wants to add another database to the application, this is how it is done.
  * This is just plain read, update, write, delete and list - no authentication or permission checks.
  */
 
 /**
- * Arguments for the model storage operations provider method.
- */
-
-/**
- * A plugin that provides the model storage operations implementation.
- */
-
-/**
- * Description of the ContentModel storage operations.
+ * Description of the CmsModel storage operations.
  * If user wants to add another database to the application, this is how it is done.
  * This is just plain read, update, write, delete and list - no authentication or permission checks.
  */
 
 /**
- * Arguments for the entry storage provider method.
- */
-
-/**
- * A plugin that provides the entry storage operations implementation.
- */
-
-/**
- * Description of the ContentModel storage operations.
+ * Description of the CmsModel storage operations.
  * If user wants to add another database to the application, this is how it is done.
  * This is just plain read, update, write, delete and list - no authentication or permission checks.
  *
  *
  * @category StorageOperations
- * @category ContentEntry
+ * @category CmsEntry
  */
 let CONTENT_ENTRY_STATUS;
 exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS;
@@ -518,5 +369,4 @@ exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS;
   CONTENT_ENTRY_STATUS["UNPUBLISHED"] = "unpublished";
   CONTENT_ENTRY_STATUS["CHANGES_REQUESTED"] = "changesRequested";
   CONTENT_ENTRY_STATUS["REVIEW_REQUESTED"] = "reviewRequested";
-})(CONTENT_ENTRY_STATUS || (exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS = {}));
-//# sourceMappingURL=types.js.map
+})(CONTENT_ENTRY_STATUS || (exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS = {}));

package/utils.d.ts

@@ -1,6 +1,5 @@
-import { Plugin } from "@webiny/plugins/types";
 import { SecurityPermission } from "@webiny/api-security/types";
-import { CmsContentModel, CmsContext, CreatedBy, CmsContentModelGroupPermission, CmsContentModelGroup } from "./types";
+import { CmsModel, CmsContext, CreatedBy, CmsGroupPermission, CmsGroup } from "./types";
 export declare const hasRwd: (permission: any, rwd: any) => any;
 export declare const hasPw: (permission: any, pw: any) => any;
 export declare const checkPermissions: <TPermission extends SecurityPermission = SecurityPermission>(context: CmsContext, name: string, check?: {
@@ -19,14 +18,8 @@ export declare const validateOwnership: (context: CmsContext, permission: Securi
  * model access is checking for both specific model or group access
  * if permission has specific models set as access pattern then groups will not matter (although both can be set)
  */
-export declare const checkModelAccess: (context: CmsContext, model: CmsContentModel) => Promise<void>;
-export declare const validateModelAccess: (context: CmsContext, model: CmsContentModel) => Promise<boolean>;
-export declare const validateGroupAccess: (context: CmsContext, permission: CmsContentModelGroupPermission, group: CmsContentModelGroup) => boolean;
+export declare const checkModelAccess: (context: CmsContext, model: CmsModel) => Promise<void>;
+export declare const validateModelAccess: (context: CmsContext, model: CmsModel) => Promise<boolean>;
+export declare const validateGroupAccess: (context: CmsContext, permission: CmsGroupPermission, group: CmsGroup) => boolean;
 export declare const toSlug: (text: any) => string;
-export declare const zeroPad: (version: any) => string;
-export declare const createCmsPK: (context: CmsContext) => string;
-export declare const paginateBatch: <T = Record<string, any>>(items: T[], perPage: number, execute: (items: T[]) => Promise<any>) => Promise<void>;
 export declare const filterAsync: <T = Record<string, any>>(items: T[], predicate: (T: any) => Promise<boolean>) => Promise<T[]>;
-declare type CallbackFallback = (args: any) => void | Promise<void>;
-export declare const executeCallbacks: <TCallbackFunction extends CallbackFallback = CallbackFallback>(plugins: Plugin[], hook: string, args: Parameters<TCallbackFunction>[0]) => Promise<void>;
-export {};

package/utils.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.zeroPad = exports.validateOwnership = exports.validateModelAccess = exports.validateGroupAccess = exports.toSlug = exports.paginateBatch = exports.hasRwd = exports.hasPw = exports.filterAsync = exports.executeCallbacks = exports.createCmsPK = exports.checkPermissions = exports.checkOwnership = exports.checkModelAccess = void 0;
+exports.validateOwnership = exports.validateModelAccess = exports.validateGroupAccess = exports.toSlug = exports.hasRwd = exports.hasPw = exports.filterAsync = exports.checkPermissions = exports.checkOwnership = exports.checkModelAccess = void 0;
 
 var _slugify = _interopRequireDefault(require("slugify"));
 
@@ -233,42 +233,6 @@ const toSlug = text => {
 
 exports.toSlug = toSlug;
 
-const zeroPad = version => `${version}`.padStart(4, "0");
-
-exports.zeroPad = zeroPad;
-
-const createCmsPK = context => {
-  const {
-    tenancy,
-    cms
-  } = context;
-  const tenant = tenancy.getCurrentTenant();
-
-  if (!tenant) {
-    throw new Error("Tenant missing.");
-  }
-
-  const locale = cms.getLocale();
-
-  if (!locale) {
-    throw new Error("Locale missing.");
-  }
-
-  return `T#${tenant.id}#L#${locale.code}#CMS`;
-};
-
-exports.createCmsPK = createCmsPK;
-
-const paginateBatch = async (items, perPage, execute) => {
-  const pages = Math.ceil(items.length / perPage);
-
-  for (let i = 0; i < pages; i++) {
-    await execute(items.slice(i * perPage, i * perPage + perPage));
-  }
-};
-
-exports.paginateBatch = paginateBatch;
-
 const filterAsync = async (items, predicate) => {
   const filteredItems = [];
 
@@ -284,15 +248,4 @@ const filterAsync = async (items, predicate) => {
   return filteredItems;
 };
 
-exports.filterAsync = filterAsync;
-
-const executeCallbacks = async (plugins, hook, args) => {
-  for (const plugin of plugins) {
-    if (typeof plugin[hook] === "function") {
-      await plugin[hook](args);
-    }
-  }
-};
-
-exports.executeCallbacks = executeCallbacks;
-//# sourceMappingURL=utils.js.map
+exports.filterAsync = filterAsync;

package/content/contextSetup.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/content/contextSetup.ts"],"names":["extractHandlerHttpParameters","context","key","http","request","path","parameters","type","locale","split","WebinyError","ContextPlugin","method","cms","systemLocale","i18n","getLocale","READ","PREVIEW","MANAGE"],"mappings":";;;;;;;;;AACA;;AACA;;AAEA,MAAMA,4BAA4B,GAAIC,OAAD,IAAyB;AAAA;;AAC1D,QAAM;AAAEC,IAAAA,GAAG,GAAG;AAAR,MAAe,kBAAAD,OAAO,CAACE,IAAR,yFAAcC,OAAd,0GAAuBC,IAAvB,kFAA6BC,UAA7B,KAA2C,EAAhE;AACA,QAAM,CAACC,IAAD,EAAOC,MAAP,IAAiBN,GAAG,CAACO,KAAJ,CAAU,GAAV,CAAvB;;AACA,MAAI,CAACF,IAAL,EAAW;AACP,UAAM,IAAIG,cAAJ,CAAiB,qDAAjB,CAAN;AACH,GAFD,MAEO,IAAI,CAACF,MAAL,EAAa;AAChB,UAAM,IAAIE,cAAJ,CAAiB,uDAAjB,CAAN;AACH;;AAED,SAAO;AACHH,IAAAA,IADG;AAEHC,IAAAA;AAFG,GAAP;AAIH,CAbD;;eAee,MAAM;AACjB,SAAO,IAAIG,4BAAJ,CAA8B,MAAMV,OAAN,IAAiB;AAAA;;AAClD,QAAI,mBAAAA,OAAO,CAACE,IAAR,2FAAcC,OAAd,gFAAuBQ,MAAvB,MAAkC,SAAtC,EAAiD;AAC7C;AACH,KAFD,MAEO,IAAIX,OAAO,CAACY,GAAZ,EAAiB;AACpB,YAAM,IAAIH,cAAJ,CACF,sFADE,EAEF,+BAFE,CAAN;AAIH;;AAED,UAAM;AAAEH,MAAAA,IAAF;AAAQC,MAAAA;AAAR,QAAmBR,4BAA4B,CAACC,OAAD,CAArD;AAEA,UAAMa,YAAY,GAAGb,OAAO,CAACc,IAAR,CAAaC,SAAb,CAAuBR,MAAvB,CAArB;;AACA,QAAI,CAACM,YAAL,EAAmB;AACf,YAAM,IAAIJ,cAAJ,CAAiB,uBAAsBF,MAAO,kBAA9C,CAAN;AACH;;AAEDP,IAAAA,OAAO,CAACY,GAAR,GAAc;AACVN,MAAAA,IADU;AAEVC,MAAAA,MAFU;AAGVQ,MAAAA,SAAS,EAAE,MAAMF,YAHP;AAIVG,MAAAA,IAAI,EAAEV,IAAI,KAAK,MAJL;AAKVW,MAAAA,OAAO,EAAEX,IAAI,KAAK,SALR;AAMVY,MAAAA,MAAM,EAAEZ,IAAI,KAAK;AANP,KAAd;AAQH,GAzBM,CAAP;AA0BH,C","sourcesContent":["import { CmsContext } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport { ContextPlugin } from \"@webiny/handler/plugins/ContextPlugin\";\n\nconst extractHandlerHttpParameters = (context: CmsContext) => {\n    const { key = \"\" } = context.http?.request?.path?.parameters || {};\n    const [type, locale] = key.split(\"/\");\n    if (!type) {\n        throw new WebinyError(`Missing context.http.request.path parameter \"type\".`);\n    } else if (!locale) {\n        throw new WebinyError(`Missing context.http.request.path parameter \"locale\".`);\n    }\n\n    return {\n        type,\n        locale\n    };\n};\n\nexport default () => {\n    return new ContextPlugin<CmsContext>(async context => {\n        if (context.http?.request?.method === \"OPTIONS\") {\n            return;\n        } else if (context.cms) {\n            throw new WebinyError(\n                \"Context setup plugin must be first to be registered. Cannot have anything before it.\",\n                \"CMS_CONTEXT_INITIALIZED_ERROR\"\n            );\n        }\n\n        const { type, locale } = extractHandlerHttpParameters(context);\n\n        const systemLocale = context.i18n.getLocale(locale);\n        if (!systemLocale) {\n            throw new WebinyError(`There is no locale \"${locale}\" in the system.`);\n        }\n\n        context.cms = {\n            type,\n            locale,\n            getLocale: () => systemLocale,\n            READ: type === \"read\",\n            PREVIEW: type === \"preview\",\n            MANAGE: type === \"manage\"\n        } as any;\n    });\n};\n"],"file":"contextSetup.js"}