@webiny/api-aco 5.34.8 → 5.35.0-beta.0

package/types.d.ts

@@ -1,9 +1,13 @@
-import { TenancyContext } from "@webiny/api-tenancy/types";
+import { Tenant, TenancyContext } from "@webiny/api-tenancy/types";
 import { Context as BaseContext } from "@webiny/handler/types";
-import { I18NContext } from "@webiny/api-i18n/types";
+import { I18NContext, I18NLocale } from "@webiny/api-i18n/types";
 import { SecurityContext, SecurityIdentity } from "@webiny/api-security/types";
-import { Topic } from "@webiny/pubsub/types";
-export interface CreatedBy {
+import { CmsContext } from "@webiny/api-headless-cms/types";
+import { AcoSearchRecordCrud, AcoSearchRecordStorageOperations } from "./record/record.types";
+import { AcoFolderCrud, AcoFolderStorageOperations } from "./folder/folder.types";
+export * from "./folder/folder.types";
+export * from "./record/record.types";
+export interface User {
     id: string;
     type: string;
     displayName: string | null;
@@ -13,207 +17,33 @@ export interface ListMeta {
     totalCount: number;
     hasMoreItems: boolean;
 }
-export interface Folder {
-    id: string;
-    name: string;
-    slug: string;
-    type: string;
-    parentId?: string;
-    createdOn: string;
-    createdBy: CreatedBy;
-    tenant: string;
-    locale: string;
-    webinyVersion: string;
-}
-export declare type FolderInput = Pick<Folder, "name" | "slug" | "type" | "parentId">;
-export interface GetFolderParams {
-    id: string;
-}
-export interface ListFoldersWhere {
-    type: string;
-}
-export interface ListFoldersParams {
-    where: ListFoldersWhere;
-}
-export interface CreateFolderParams {
-    folder: Folder;
-}
-export interface UpdateFolderParams {
-    original: Folder;
-    folder: Folder;
+export declare enum ListSortDirection {
+    ASC = 0,
+    DESC = 1
 }
-export interface DeleteFolderParams {
-    folder: Folder;
-}
-export interface StorageOperationsGetFolderParams {
-    id?: string;
-    slug?: string;
-    type?: string;
-    parentId?: string;
-    tenant: string;
-    locale: string;
-}
-export interface StorageOperationsListFoldersParams extends ListFoldersParams {
-    where: ListFoldersParams["where"] & {
-        tenant: string;
-        locale: string;
-    };
-    sort: string[];
-}
-export declare type StorageOperationsCreateFolderParams = CreateFolderParams;
-export declare type StorageOperationsUpdateFolderParams = UpdateFolderParams;
-export declare type StorageOperationsDeleteFolderParams = DeleteFolderParams;
-export interface OnFolderBeforeCreateTopicParams {
-    folder: Folder;
-}
-export interface OnFolderAfterCreateTopicParams {
-    folder: Folder;
-}
-export interface OnFolderBeforeUpdateTopicParams {
-    folder: Folder;
-    original: Folder;
-}
-export interface OnFolderAfterUpdateTopicParams {
-    folder: Folder;
-    original: Folder;
-}
-export interface OnFolderBeforeDeleteTopicParams {
-    folder: Folder;
-}
-export interface OnFolderAfterDeleteTopicParams {
-    folder: Folder;
-}
-export interface Link {
+export declare type ListSort = Record<string, ListSortDirection>;
+export interface AcoBaseFields {
     id: string;
-    linkId: string;
-    folderId: string;
+    entryId: string;
     createdOn: string;
-    createdBy: CreatedBy;
-    tenant: string;
-    locale: string;
-    webinyVersion: string;
-}
-export declare type LinkInput = Pick<Link, "id" | "folderId">;
-export interface ListLinksWhere {
-    folderId: string;
+    createdBy: User;
+    savedOn: string;
 }
-export interface ListLinksParams {
-    where: ListLinksWhere;
-    limit?: number;
-    after?: string | null;
+export interface AdvancedContentOrganisation {
+    folder: AcoFolderCrud;
+    search: AcoSearchRecordCrud;
 }
-export declare type ListLinksResponse = [Link[], ListMeta];
-export interface CreateLinkParams {
-    link: Link;
-}
-export interface UpdateLinkParams {
-    original: Link;
-    link: Link;
-}
-export interface DeleteLinkParams {
-    link: Link;
-}
-export interface DeleteLinksParams {
-    tenant: string;
-    locale: string;
-    folderIds: string[];
-}
-export interface StorageOperationsGetLinkParams {
-    id?: string;
-    folderId?: string;
-    tenant: string;
-    locale: string;
-}
-export interface StorageOperationsListLinksParams extends ListLinksParams {
-    where: ListLinksParams["where"] & {
-        tenant: string;
-        locale: string;
-    };
-    sort: string[];
-}
-export declare type StorageOperationListLinksResponse = ListLinksResponse;
-export declare type StorageOperationsCreateLinkParams = CreateLinkParams;
-export declare type StorageOperationsUpdateLinkParams = UpdateLinkParams;
-export declare type StorageOperationsDeleteLinkParams = DeleteLinkParams;
-export declare type StorageOperationsDeleteLinksParams = DeleteLinksParams;
-export interface OnLinkBeforeCreateTopicParams {
-    link: Link;
-}
-export interface OnLinkAfterCreateTopicParams {
-    link: Link;
-}
-export interface OnLinkBeforeUpdateTopicParams {
-    link: Link;
-    original: Link;
-}
-export interface OnLinkAfterUpdateTopicParams {
-    link: Link;
-    original: Link;
-}
-export interface OnLinkBeforeDeleteTopicParams {
-    link: Link;
-}
-export interface OnLinkAfterDeleteTopicParams {
-    link: Link;
-}
-export interface OnLinkBeforeDeleteBatchTopicParams {
-    folderIds: string[];
-}
-export interface OnLinkAfterDeleteBatchTopicParams {
-    folderIds: string[];
-}
-export interface ACOContext extends BaseContext, I18NContext, TenancyContext, SecurityContext {
-    folders: Folders;
-}
-export declare type Folders = IFolders & ILinks;
-export interface IFolders {
-    getFolder(params: GetFolderParams): Promise<Folder>;
-    listFolders(params: ListFoldersParams): Promise<Folder[]>;
-    createFolder(input: FolderInput): Promise<Folder>;
-    updateFolder(id: string, input: Partial<Folder>): Promise<Folder>;
-    deleteFolder(id: string): Promise<void>;
-    onFolderBeforeCreate: Topic<OnFolderBeforeCreateTopicParams>;
-    onFolderAfterCreate: Topic<OnFolderAfterCreateTopicParams>;
-    onFolderBeforeUpdate: Topic<OnFolderBeforeUpdateTopicParams>;
-    onFolderAfterUpdate: Topic<OnFolderAfterUpdateTopicParams>;
-    onFolderBeforeDelete: Topic<OnFolderBeforeDeleteTopicParams>;
-    onFolderAfterDelete: Topic<OnFolderAfterDeleteTopicParams>;
-}
-export interface ILinks {
-    getLink(id: string): Promise<Link>;
-    listLinks(params: ListLinksParams): Promise<ListLinksResponse>;
-    createLink(input: LinkInput): Promise<Link>;
-    updateLink(id: string, input: Partial<Link>): Promise<Link>;
-    deleteLink(id: string): Promise<void>;
-    deleteLinks(folderIds: string[]): Promise<void>;
-    onLinkBeforeCreate: Topic<OnLinkBeforeCreateTopicParams>;
-    onLinkAfterCreate: Topic<OnLinkAfterCreateTopicParams>;
-    onLinkBeforeUpdate: Topic<OnLinkBeforeUpdateTopicParams>;
-    onLinkAfterUpdate: Topic<OnLinkAfterUpdateTopicParams>;
-    onLinkBeforeDelete: Topic<OnLinkBeforeDeleteTopicParams>;
-    onLinkAfterDelete: Topic<OnLinkAfterDeleteTopicParams>;
-    onLinkBeforeDeleteBatch: Topic<OnLinkBeforeDeleteBatchTopicParams>;
-    onLinkAfterDeleteBatch: Topic<OnLinkAfterDeleteBatchTopicParams>;
-}
-export interface FoldersConfig {
-    getTenantId: () => string;
-    getLocaleCode: () => string;
+export interface CreateAcoParams {
     getIdentity: () => SecurityIdentity;
-    storageOperations: StorageOperations;
-}
-export declare type StorageOperations = FoldersStorageOperations & LinksStorageOperations;
-export interface FoldersStorageOperations {
-    getFolder(params: StorageOperationsGetFolderParams): Promise<Folder | undefined>;
-    listFolders(params: StorageOperationsListFoldersParams): Promise<Folder[]>;
-    createFolder(params: StorageOperationsCreateFolderParams): Promise<Folder>;
-    updateFolder(params: StorageOperationsUpdateFolderParams): Promise<Folder>;
-    deleteFolder(params: StorageOperationsDeleteFolderParams): Promise<void>;
-}
-export interface LinksStorageOperations {
-    getLink(params: StorageOperationsGetLinkParams): Promise<Link | undefined>;
-    listLinks(params: StorageOperationsListLinksParams): Promise<StorageOperationListLinksResponse>;
-    createLink(params: StorageOperationsCreateLinkParams): Promise<Link>;
-    updateLink(params: StorageOperationsUpdateLinkParams): Promise<Link>;
-    deleteLink(params: StorageOperationsDeleteLinkParams): Promise<void>;
-    deleteLinks(params: StorageOperationsDeleteLinksParams): Promise<void>;
-}
+    getLocale: () => I18NLocale;
+    getTenant: () => Tenant;
+    storageOperations: AcoStorageOperations;
+}
+export declare type AcoStorageOperations = AcoFolderStorageOperations & AcoSearchRecordStorageOperations;
+export interface AcoContext extends BaseContext, I18NContext, TenancyContext, SecurityContext, CmsContext {
+    aco: AdvancedContentOrganisation;
+}
+/**
+ * @deprecated Use AcoContext instead
+ */
+export declare type ACOContext = AcoContext;

package/types.js

@@ -2,4 +2,38 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+var _exportNames = {
+  ListSortDirection: true
+};
+exports.ListSortDirection = void 0;
+var _folder = require("./folder/folder.types");
+Object.keys(_folder).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _folder[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _folder[key];
+    }
+  });
+});
+var _record = require("./record/record.types");
+Object.keys(_record).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _record[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _record[key];
+    }
+  });
+});
+let ListSortDirection;
+exports.ListSortDirection = ListSortDirection;
+(function (ListSortDirection) {
+  ListSortDirection[ListSortDirection["ASC"] = 0] = "ASC";
+  ListSortDirection[ListSortDirection["DESC"] = 1] = "DESC";
+})(ListSortDirection || (exports.ListSortDirection = ListSortDirection = {}));

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { TenancyContext } from \"@webiny/api-tenancy/types\";\nimport { Context as BaseContext } from \"@webiny/handler/types\";\nimport { I18NContext } from \"@webiny/api-i18n/types\";\nimport { SecurityContext, SecurityIdentity } from \"@webiny/api-security/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\n\nexport interface CreatedBy {\n    id: string;\n    type: string;\n    displayName: string | null;\n}\n\nexport interface ListMeta {\n    cursor: string | null;\n    totalCount: number;\n    hasMoreItems: boolean;\n}\n\nexport interface Folder {\n    id: string;\n    name: string;\n    slug: string;\n    type: string;\n    parentId?: string;\n    createdOn: string;\n    createdBy: CreatedBy;\n    tenant: string;\n    locale: string;\n    webinyVersion: string;\n}\n\nexport type FolderInput = Pick<Folder, \"name\" | \"slug\" | \"type\" | \"parentId\">;\n\nexport interface GetFolderParams {\n    id: string;\n}\n\nexport interface ListFoldersWhere {\n    type: string;\n}\n\nexport interface ListFoldersParams {\n    where: ListFoldersWhere;\n}\n\nexport interface CreateFolderParams {\n    folder: Folder;\n}\n\nexport interface UpdateFolderParams {\n    original: Folder;\n    folder: Folder;\n}\n\nexport interface DeleteFolderParams {\n    folder: Folder;\n}\n\nexport interface StorageOperationsGetFolderParams {\n    id?: string;\n    slug?: string;\n    type?: string;\n    parentId?: string;\n    tenant: string;\n    locale: string;\n}\n\nexport interface StorageOperationsListFoldersParams extends ListFoldersParams {\n    where: ListFoldersParams[\"where\"] & {\n        tenant: string;\n        locale: string;\n    };\n    sort: string[];\n}\n\nexport type StorageOperationsCreateFolderParams = CreateFolderParams;\nexport type StorageOperationsUpdateFolderParams = UpdateFolderParams;\nexport type StorageOperationsDeleteFolderParams = DeleteFolderParams;\n\nexport interface OnFolderBeforeCreateTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderAfterCreateTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderBeforeUpdateTopicParams {\n    folder: Folder;\n    original: Folder;\n}\n\nexport interface OnFolderAfterUpdateTopicParams {\n    folder: Folder;\n    original: Folder;\n}\n\nexport interface OnFolderBeforeDeleteTopicParams {\n    folder: Folder;\n}\n\nexport interface OnFolderAfterDeleteTopicParams {\n    folder: Folder;\n}\n\nexport interface Link {\n    id: string;\n    linkId: string;\n    folderId: string;\n    createdOn: string;\n    createdBy: CreatedBy;\n    tenant: string;\n    locale: string;\n    webinyVersion: string;\n}\n\nexport type LinkInput = Pick<Link, \"id\" | \"folderId\">;\n\nexport interface ListLinksWhere {\n    folderId: string;\n}\n\nexport interface ListLinksParams {\n    where: ListLinksWhere;\n    limit?: number;\n    after?: string | null;\n}\n\nexport type ListLinksResponse = [Link[], ListMeta];\n\nexport interface CreateLinkParams {\n    link: Link;\n}\n\nexport interface UpdateLinkParams {\n    original: Link;\n    link: Link;\n}\n\nexport interface DeleteLinkParams {\n    link: Link;\n}\n\nexport interface DeleteLinksParams {\n    tenant: string;\n    locale: string;\n    folderIds: string[];\n}\n\nexport interface StorageOperationsGetLinkParams {\n    id?: string;\n    folderId?: string;\n    tenant: string;\n    locale: string;\n}\n\nexport interface StorageOperationsListLinksParams extends ListLinksParams {\n    where: ListLinksParams[\"where\"] & {\n        tenant: string;\n        locale: string;\n    };\n    sort: string[];\n}\n\nexport type StorageOperationListLinksResponse = ListLinksResponse;\n\nexport type StorageOperationsCreateLinkParams = CreateLinkParams;\nexport type StorageOperationsUpdateLinkParams = UpdateLinkParams;\nexport type StorageOperationsDeleteLinkParams = DeleteLinkParams;\nexport type StorageOperationsDeleteLinksParams = DeleteLinksParams;\n\nexport interface OnLinkBeforeCreateTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkAfterCreateTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkBeforeUpdateTopicParams {\n    link: Link;\n    original: Link;\n}\n\nexport interface OnLinkAfterUpdateTopicParams {\n    link: Link;\n    original: Link;\n}\n\nexport interface OnLinkBeforeDeleteTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkAfterDeleteTopicParams {\n    link: Link;\n}\n\nexport interface OnLinkBeforeDeleteBatchTopicParams {\n    folderIds: string[];\n}\n\nexport interface OnLinkAfterDeleteBatchTopicParams {\n    folderIds: string[];\n}\n\nexport interface ACOContext extends BaseContext, I18NContext, TenancyContext, SecurityContext {\n    folders: Folders;\n}\n\nexport type Folders = IFolders & ILinks;\n\nexport interface IFolders {\n    getFolder(params: GetFolderParams): Promise<Folder>;\n    listFolders(params: ListFoldersParams): Promise<Folder[]>;\n    createFolder(input: FolderInput): Promise<Folder>;\n    updateFolder(id: string, input: Partial<Folder>): Promise<Folder>;\n    deleteFolder(id: string): Promise<void>;\n    onFolderBeforeCreate: Topic<OnFolderBeforeCreateTopicParams>;\n    onFolderAfterCreate: Topic<OnFolderAfterCreateTopicParams>;\n    onFolderBeforeUpdate: Topic<OnFolderBeforeUpdateTopicParams>;\n    onFolderAfterUpdate: Topic<OnFolderAfterUpdateTopicParams>;\n    onFolderBeforeDelete: Topic<OnFolderBeforeDeleteTopicParams>;\n    onFolderAfterDelete: Topic<OnFolderAfterDeleteTopicParams>;\n}\n\nexport interface ILinks {\n    getLink(id: string): Promise<Link>;\n    listLinks(params: ListLinksParams): Promise<ListLinksResponse>;\n    createLink(input: LinkInput): Promise<Link>;\n    updateLink(id: string, input: Partial<Link>): Promise<Link>;\n    deleteLink(id: string): Promise<void>;\n    deleteLinks(folderIds: string[]): Promise<void>;\n    onLinkBeforeCreate: Topic<OnLinkBeforeCreateTopicParams>;\n    onLinkAfterCreate: Topic<OnLinkAfterCreateTopicParams>;\n    onLinkBeforeUpdate: Topic<OnLinkBeforeUpdateTopicParams>;\n    onLinkAfterUpdate: Topic<OnLinkAfterUpdateTopicParams>;\n    onLinkBeforeDelete: Topic<OnLinkBeforeDeleteTopicParams>;\n    onLinkAfterDelete: Topic<OnLinkAfterDeleteTopicParams>;\n    onLinkBeforeDeleteBatch: Topic<OnLinkBeforeDeleteBatchTopicParams>;\n    onLinkAfterDeleteBatch: Topic<OnLinkAfterDeleteBatchTopicParams>;\n}\n\nexport interface FoldersConfig {\n    getTenantId: () => string;\n    getLocaleCode: () => string;\n    getIdentity: () => SecurityIdentity;\n    storageOperations: StorageOperations;\n}\n\nexport type StorageOperations = FoldersStorageOperations & LinksStorageOperations;\n\nexport interface FoldersStorageOperations {\n    getFolder(params: StorageOperationsGetFolderParams): Promise<Folder | undefined>;\n    listFolders(params: StorageOperationsListFoldersParams): Promise<Folder[]>;\n    createFolder(params: StorageOperationsCreateFolderParams): Promise<Folder>;\n    updateFolder(params: StorageOperationsUpdateFolderParams): Promise<Folder>;\n    deleteFolder(params: StorageOperationsDeleteFolderParams): Promise<void>;\n}\n\nexport interface LinksStorageOperations {\n    getLink(params: StorageOperationsGetLinkParams): Promise<Link | undefined>;\n    listLinks(params: StorageOperationsListLinksParams): Promise<StorageOperationListLinksResponse>;\n    createLink(params: StorageOperationsCreateLinkParams): Promise<Link>;\n    updateLink(params: StorageOperationsUpdateLinkParams): Promise<Link>;\n    deleteLink(params: StorageOperationsDeleteLinkParams): Promise<void>;\n    deleteLinks(params: StorageOperationsDeleteLinksParams): Promise<void>;\n}\n"],"mappings":""}
+{"version":3,"names":["ListSortDirection"],"sources":["types.ts"],"sourcesContent":["import { Tenant, TenancyContext } from \"@webiny/api-tenancy/types\";\nimport { Context as BaseContext } from \"@webiny/handler/types\";\nimport { I18NContext, I18NLocale } from \"@webiny/api-i18n/types\";\nimport { SecurityContext, SecurityIdentity } from \"@webiny/api-security/types\";\nimport { CmsContext } from \"@webiny/api-headless-cms/types\";\nimport { AcoSearchRecordCrud, AcoSearchRecordStorageOperations } from \"~/record/record.types\";\nimport { AcoFolderCrud, AcoFolderStorageOperations } from \"~/folder/folder.types\";\n\nexport * from \"./folder/folder.types\";\nexport * from \"./record/record.types\";\n\nexport interface User {\n    id: string;\n    type: string;\n    displayName: string | null;\n}\n\nexport interface ListMeta {\n    cursor: string | null;\n    totalCount: number;\n    hasMoreItems: boolean;\n}\n\nexport enum ListSortDirection {\n    ASC,\n    DESC\n}\n\nexport type ListSort = Record<string, ListSortDirection>;\n\nexport interface AcoBaseFields {\n    id: string;\n    entryId: string;\n    createdOn: string;\n    createdBy: User;\n    savedOn: string;\n}\n\nexport interface AdvancedContentOrganisation {\n    folder: AcoFolderCrud;\n    search: AcoSearchRecordCrud;\n}\n\nexport interface CreateAcoParams {\n    getIdentity: () => SecurityIdentity;\n    getLocale: () => I18NLocale;\n    getTenant: () => Tenant;\n    storageOperations: AcoStorageOperations;\n}\n\nexport type AcoStorageOperations = AcoFolderStorageOperations & AcoSearchRecordStorageOperations;\n\nexport interface AcoContext\n    extends BaseContext,\n        I18NContext,\n        TenancyContext,\n        SecurityContext,\n        CmsContext {\n    aco: AdvancedContentOrganisation;\n}\n\n/**\n * @deprecated Use AcoContext instead\n */\nexport type ACOContext = AcoContext;\n"],"mappings":";;;;;;;;;AAQA;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AAAsC,IAc1BA,iBAAiB;AAAA;AAAA,WAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;EAAjBA,iBAAiB,CAAjBA,iBAAiB;AAAA,GAAjBA,iBAAiB,iCAAjBA,iBAAiB"}

package/utils/acoRecordId.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 006
+ * PageDataMigration in ddb-es and ddb
+ */
+export declare const attachAcoRecordPrefix: (id: string) => string;
+export declare const removeAcoRecordPrefix: (id: string) => string;

package/utils/acoRecordId.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeAcoRecordPrefix = exports.attachAcoRecordPrefix = void 0;
+/**
+ * !!! DO NOT CHANGE THIS !!!
+ * If this is changed, you will need to create new migration which changes the IDs for the users.
+ *
+ * packages/migrations/src/migrations/5.35.0/006/ddb/PageDataMigration.ts:236
+ * packages/migrations/src/migrations/5.35.0/006/ddb-es/PageDataMigration.ts:419
+ */
+const WBY_ACO_PREFIX = "wby-aco-";
+/**
+ * 006
+ * PageDataMigration in ddb-es and ddb
+ */
+
+const attachAcoRecordPrefix = id => {
+  if (id.startsWith(WBY_ACO_PREFIX)) {
+    return id;
+  }
+  return `${WBY_ACO_PREFIX}${id}`;
+};
+exports.attachAcoRecordPrefix = attachAcoRecordPrefix;
+const removeAcoRecordPrefix = id => {
+  if (id.startsWith(WBY_ACO_PREFIX) === false) {
+    return id;
+  }
+  return id.substring(WBY_ACO_PREFIX.length);
+};
+exports.removeAcoRecordPrefix = removeAcoRecordPrefix;

package/utils/acoRecordId.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["WBY_ACO_PREFIX","attachAcoRecordPrefix","id","startsWith","removeAcoRecordPrefix","substring","length"],"sources":["acoRecordId.ts"],"sourcesContent":["/**\n * !!! DO NOT CHANGE THIS !!!\n * If this is changed, you will need to create new migration which changes the IDs for the users.\n *\n * packages/migrations/src/migrations/5.35.0/006/ddb/PageDataMigration.ts:236\n * packages/migrations/src/migrations/5.35.0/006/ddb-es/PageDataMigration.ts:419\n */\nconst WBY_ACO_PREFIX = \"wby-aco-\";\n/**\n * 006\n * PageDataMigration in ddb-es and ddb\n */\n\nexport const attachAcoRecordPrefix = (id: string) => {\n    if (id.startsWith(WBY_ACO_PREFIX)) {\n        return id;\n    }\n    return `${WBY_ACO_PREFIX}${id}`;\n};\n\nexport const removeAcoRecordPrefix = (id: string) => {\n    if (id.startsWith(WBY_ACO_PREFIX) === false) {\n        return id;\n    }\n    return id.substring(WBY_ACO_PREFIX.length);\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,cAAc,GAAG,UAAU;AACjC;AACA;AACA;AACA;;AAEO,MAAMC,qBAAqB,GAAIC,EAAU,IAAK;EACjD,IAAIA,EAAE,CAACC,UAAU,CAACH,cAAc,CAAC,EAAE;IAC/B,OAAOE,EAAE;EACb;EACA,OAAQ,GAAEF,cAAe,GAAEE,EAAG,EAAC;AACnC,CAAC;AAAC;AAEK,MAAME,qBAAqB,GAAIF,EAAU,IAAK;EACjD,IAAIA,EAAE,CAACC,UAAU,CAACH,cAAc,CAAC,KAAK,KAAK,EAAE;IACzC,OAAOE,EAAE;EACb;EACA,OAAOA,EAAE,CAACG,SAAS,CAACL,cAAc,CAACM,MAAM,CAAC;AAC9C,CAAC;AAAC"}

package/utils/createListSort.d.ts

@@ -0,0 +1,2 @@
+import { ListSort } from "../types";
+export declare const createListSort: (sort?: ListSort) => string[] | undefined;

package/utils/createListSort.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createListSort = void 0;
+const createListSort = sort => {
+  if (!sort) {
+    return;
+  }
+  return Object.keys(sort).map(key => `${key}_${sort[key]}`);
+};
+exports.createListSort = createListSort;

package/utils/createListSort.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createListSort","sort","Object","keys","map","key"],"sources":["createListSort.ts"],"sourcesContent":["import { ListSort } from \"~/types\";\n\nexport const createListSort = (sort?: ListSort): string[] | undefined => {\n    if (!sort) {\n        return;\n    }\n\n    return Object.keys(sort).map(key => `${key}_${sort[key]}`);\n};\n"],"mappings":";;;;;;AAEO,MAAMA,cAAc,GAAIC,IAAe,IAA2B;EACrE,IAAI,CAACA,IAAI,EAAE;IACP;EACJ;EAEA,OAAOC,MAAM,CAACC,IAAI,CAACF,IAAI,CAAC,CAACG,GAAG,CAACC,GAAG,IAAK,GAAEA,GAAI,IAAGJ,IAAI,CAACI,GAAG,CAAE,EAAC,CAAC;AAC9D,CAAC;AAAC"}

package/utils/createModelField.d.ts

@@ -0,0 +1,5 @@
+import { CmsModelField } from "@webiny/api-headless-cms/types";
+export interface CreateModelFieldParams extends Omit<CmsModelField, "id" | "storageId" | "fieldId"> {
+    fieldId?: string;
+}
+export declare const createModelField: (params: CreateModelFieldParams) => CmsModelField;

package/utils/createModelField.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createModelField = void 0;
+var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
+const createModelField = params => {
+  const {
+    label,
+    fieldId: initialFieldId,
+    type,
+    settings = {},
+    listValidation = [],
+    validation = [],
+    multipleValues = false,
+    predefinedValues = {
+      values: [],
+      enabled: false
+    }
+  } = params;
+  const fieldId = initialFieldId ? (0, _camelCase.default)(initialFieldId) : (0, _camelCase.default)(label);
+  return {
+    id: fieldId,
+    storageId: `${type}@${fieldId}`,
+    fieldId,
+    label,
+    type,
+    settings,
+    listValidation,
+    validation,
+    multipleValues,
+    predefinedValues
+  };
+};
+exports.createModelField = createModelField;

package/utils/createModelField.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createModelField","params","label","fieldId","initialFieldId","type","settings","listValidation","validation","multipleValues","predefinedValues","values","enabled","camelCase","id","storageId"],"sources":["createModelField.ts"],"sourcesContent":["import { CmsModelField } from \"@webiny/api-headless-cms/types\";\nimport camelCase from \"lodash/camelCase\";\n\nexport interface CreateModelFieldParams\n    extends Omit<CmsModelField, \"id\" | \"storageId\" | \"fieldId\"> {\n    fieldId?: string;\n}\n\nexport const createModelField = (params: CreateModelFieldParams): CmsModelField => {\n    const {\n        label,\n        fieldId: initialFieldId,\n        type,\n        settings = {},\n        listValidation = [],\n        validation = [],\n        multipleValues = false,\n        predefinedValues = {\n            values: [],\n            enabled: false\n        }\n    } = params;\n\n    const fieldId = initialFieldId ? camelCase(initialFieldId) : camelCase(label);\n\n    return {\n        id: fieldId,\n        storageId: `${type}@${fieldId}`,\n        fieldId,\n        label,\n        type,\n        settings,\n        listValidation,\n        validation,\n        multipleValues,\n        predefinedValues\n    };\n};\n"],"mappings":";;;;;;;AACA;AAOO,MAAMA,gBAAgB,GAAIC,MAA8B,IAAoB;EAC/E,MAAM;IACFC,KAAK;IACLC,OAAO,EAAEC,cAAc;IACvBC,IAAI;IACJC,QAAQ,GAAG,CAAC,CAAC;IACbC,cAAc,GAAG,EAAE;IACnBC,UAAU,GAAG,EAAE;IACfC,cAAc,GAAG,KAAK;IACtBC,gBAAgB,GAAG;MACfC,MAAM,EAAE,EAAE;MACVC,OAAO,EAAE;IACb;EACJ,CAAC,GAAGX,MAAM;EAEV,MAAME,OAAO,GAAGC,cAAc,GAAG,IAAAS,kBAAS,EAACT,cAAc,CAAC,GAAG,IAAAS,kBAAS,EAACX,KAAK,CAAC;EAE7E,OAAO;IACHY,EAAE,EAAEX,OAAO;IACXY,SAAS,EAAG,GAAEV,IAAK,IAAGF,OAAQ,EAAC;IAC/BA,OAAO;IACPD,KAAK;IACLG,IAAI;IACJC,QAAQ;IACRC,cAAc;IACdC,UAAU;IACVC,cAAc;IACdC;EACJ,CAAC;AACL,CAAC;AAAC"}

package/utils/createOperationsWrapper.d.ts

@@ -0,0 +1,9 @@
+import { CreateAcoStorageOperationsParams } from "../createAcoStorageOperations";
+import { CmsModel } from "@webiny/api-headless-cms/types";
+interface CreateOperationsWrapperParams extends CreateAcoStorageOperationsParams {
+    modelName: string;
+}
+export declare const createOperationsWrapper: (params: CreateOperationsWrapperParams) => {
+    withModel: <TResult>(cb: (model: CmsModel) => Promise<TResult>) => Promise<TResult>;
+};
+export {};

package/utils/createOperationsWrapper.js

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createOperationsWrapper = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+const createOperationsWrapper = params => {
+  const {
+    cms,
+    security,
+    modelName
+  } = params;
+  const withModel = async cb => {
+    return security.withoutAuthorization(async () => {
+      const model = await cms.getModel(modelName);
+      if (!model) {
+        throw new _error.default(`Could not find "${modelName}" model.`, "MODEL_NOT_FOUND_ERROR");
+      }
+      const result = await cb(model);
+      return result;
+    });
+  };
+  return {
+    withModel
+  };
+};
+exports.createOperationsWrapper = createOperationsWrapper;

package/utils/createOperationsWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createOperationsWrapper","params","cms","security","modelName","withModel","cb","withoutAuthorization","model","getModel","WebinyError","result"],"sources":["createOperationsWrapper.ts"],"sourcesContent":["import { CreateAcoStorageOperationsParams } from \"~/createAcoStorageOperations\";\nimport { CmsModel } from \"@webiny/api-headless-cms/types\";\nimport WebinyError from \"@webiny/error\";\n\ninterface CreateOperationsWrapperParams extends CreateAcoStorageOperationsParams {\n    modelName: string;\n}\n\nexport const createOperationsWrapper = (params: CreateOperationsWrapperParams) => {\n    const { cms, security, modelName } = params;\n\n    const withModel = async <TResult>(\n        cb: (model: CmsModel) => Promise<TResult>\n    ): Promise<TResult> => {\n        return security.withoutAuthorization(async () => {\n            const model = await cms.getModel(modelName);\n\n            if (!model) {\n                throw new WebinyError(\n                    `Could not find \"${modelName}\" model.`,\n                    \"MODEL_NOT_FOUND_ERROR\"\n                );\n            }\n\n            const result = await cb(model);\n\n            return result;\n        });\n    };\n\n    return {\n        withModel\n    };\n};\n"],"mappings":";;;;;;;AAEA;AAMO,MAAMA,uBAAuB,GAAIC,MAAqC,IAAK;EAC9E,MAAM;IAAEC,GAAG;IAAEC,QAAQ;IAAEC;EAAU,CAAC,GAAGH,MAAM;EAE3C,MAAMI,SAAS,GAAG,MACdC,EAAyC,IACtB;IACnB,OAAOH,QAAQ,CAACI,oBAAoB,CAAC,YAAY;MAC7C,MAAMC,KAAK,GAAG,MAAMN,GAAG,CAACO,QAAQ,CAACL,SAAS,CAAC;MAE3C,IAAI,CAACI,KAAK,EAAE;QACR,MAAM,IAAIE,cAAW,CAChB,mBAAkBN,SAAU,UAAS,EACtC,uBAAuB,CAC1B;MACL;MAEA,MAAMO,MAAM,GAAG,MAAML,EAAE,CAACE,KAAK,CAAC;MAE9B,OAAOG,MAAM;IACjB,CAAC,CAAC;EACN,CAAC;EAED,OAAO;IACHN;EACJ,CAAC;AACL,CAAC;AAAC"}

package/utils/fieldResolver.d.ts

@@ -0,0 +1,16 @@
+import { CmsContext, CmsEntry, CmsModel } from "@webiny/api-headless-cms/types";
+import { AcoBaseFields } from "../types";
+interface Transformer {
+    fieldId: keyof AcoBaseFields;
+    model: any;
+    field: any;
+}
+interface GetFieldValuesParams {
+    entry: CmsEntry;
+    fields: string[];
+    transformers?: Transformer[];
+    context: CmsContext;
+}
+export declare const getFieldValues: <T extends AcoBaseFields>(params: GetFieldValuesParams) => Promise<T>;
+export declare const getTransformer: (model: CmsModel, fieldId: string) => Transformer;
+export {};

package/utils/fieldResolver.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTransformer = exports.getFieldValues = void 0;
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+var _pick = _interopRequireDefault(require("lodash/pick"));
+var _apiHeadlessCms = require("@webiny/api-headless-cms");
+const getFieldValues = async params => {
+  const {
+    entry,
+    context,
+    transformers = [],
+    fields
+  } = params;
+  const values = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, (0, _pick.default)(entry, fields)), entry.values);
+  /**
+   * Transform field value for each transformers.
+   */
+  for (const transformer of transformers) {
+    const {
+      fieldId,
+      model,
+      field
+    } = transformer;
+    // Get transformed value (eg. data decompression)
+    values[fieldId] = await (0, _apiHeadlessCms.entryFieldFromStorageTransform)({
+      context,
+      model,
+      field,
+      value: values[fieldId]
+    });
+  }
+  return values;
+};
+exports.getFieldValues = getFieldValues;
+const getTransformer = (model, fieldId) => ({
+  fieldId: fieldId,
+  model: model,
+  field: model.fields.find(field => field.fieldId === fieldId)
+});
+exports.getTransformer = getTransformer;

package/utils/fieldResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getFieldValues","params","entry","context","transformers","fields","values","pick","transformer","fieldId","model","field","entryFieldFromStorageTransform","value","getTransformer","find"],"sources":["fieldResolver.ts"],"sourcesContent":["import pick from \"lodash/pick\";\nimport { CmsContext, CmsEntry, CmsModel } from \"@webiny/api-headless-cms/types\";\nimport { entryFieldFromStorageTransform } from \"@webiny/api-headless-cms\";\nimport { AcoBaseFields } from \"~/types\";\n\ninterface Transformer {\n    fieldId: keyof AcoBaseFields;\n    model: any;\n    field: any;\n}\n\ninterface GetFieldValuesParams {\n    entry: CmsEntry;\n    fields: string[];\n    transformers?: Transformer[];\n    context: CmsContext;\n}\n\nexport const getFieldValues = async <T extends AcoBaseFields>(\n    params: GetFieldValuesParams\n): Promise<T> => {\n    const { entry, context, transformers = [], fields } = params;\n    const values = {\n        ...pick(entry, fields),\n        ...entry.values\n    } as T;\n    /**\n     * Transform field value for each transformers.\n     */\n    for (const transformer of transformers) {\n        const { fieldId, model, field } = transformer;\n        // Get transformed value (eg. data decompression)\n        values[fieldId] = await entryFieldFromStorageTransform({\n            context,\n            model,\n            field,\n            value: values[fieldId]\n        });\n    }\n\n    return values;\n};\n\nexport const getTransformer = (model: CmsModel, fieldId: string): Transformer => ({\n    fieldId: fieldId as unknown as keyof AcoBaseFields,\n    model: model,\n    field: model.fields.find(field => field.fieldId === fieldId)\n});\n"],"mappings":";;;;;;;;AAAA;AAEA;AAgBO,MAAMA,cAAc,GAAG,MAC1BC,MAA4B,IACf;EACb,MAAM;IAAEC,KAAK;IAAEC,OAAO;IAAEC,YAAY,GAAG,EAAE;IAAEC;EAAO,CAAC,GAAGJ,MAAM;EAC5D,MAAMK,MAAM,+DACL,IAAAC,aAAI,EAACL,KAAK,EAAEG,MAAM,CAAC,GACnBH,KAAK,CAACI,MAAM,CACb;EACN;AACJ;AACA;EACI,KAAK,MAAME,WAAW,IAAIJ,YAAY,EAAE;IACpC,MAAM;MAAEK,OAAO;MAAEC,KAAK;MAAEC;IAAM,CAAC,GAAGH,WAAW;IAC7C;IACAF,MAAM,CAACG,OAAO,CAAC,GAAG,MAAM,IAAAG,8CAA8B,EAAC;MACnDT,OAAO;MACPO,KAAK;MACLC,KAAK;MACLE,KAAK,EAAEP,MAAM,CAACG,OAAO;IACzB,CAAC,CAAC;EACN;EAEA,OAAOH,MAAM;AACjB,CAAC;AAAC;AAEK,MAAMQ,cAAc,GAAG,CAACJ,KAAe,EAAED,OAAe,MAAmB;EAC9EA,OAAO,EAAEA,OAAyC;EAClDC,KAAK,EAAEA,KAAK;EACZC,KAAK,EAAED,KAAK,CAACL,MAAM,CAACU,IAAI,CAACJ,KAAK,IAAIA,KAAK,CAACF,OAAO,KAAKA,OAAO;AAC/D,CAAC,CAAC;AAAC"}

package/utils/getFieldValues.d.ts

@@ -0,0 +1,5 @@
+import { CmsEntry } from "@webiny/api-headless-cms/types";
+import { SearchRecord } from "../record/record.types";
+import { Folder } from "../folder/folder.types";
+export declare function getRecordFieldValues(entry: CmsEntry, fields: string[]): SearchRecord<any>;
+export declare function getFolderFieldValues(entry: CmsEntry, fields: string[]): Folder;

package/utils/getFieldValues.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFolderFieldValues = getFolderFieldValues;
+exports.getRecordFieldValues = getRecordFieldValues;
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+var _pick = _interopRequireDefault(require("lodash/pick"));
+function getRecordFieldValues(entry, fields) {
+  return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, (0, _pick.default)(entry, fields)), entry.values);
+}
+function getFolderFieldValues(entry, fields) {
+  return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, (0, _pick.default)(entry, fields)), entry.values);
+}

package/utils/getFieldValues.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getRecordFieldValues","entry","fields","pick","values","getFolderFieldValues"],"sources":["getFieldValues.ts"],"sourcesContent":["import pick from \"lodash/pick\";\nimport { CmsEntry } from \"@webiny/api-headless-cms/types\";\nimport { SearchRecord } from \"~/record/record.types\";\nimport { Folder } from \"~/folder/folder.types\";\n\nexport function getRecordFieldValues(entry: CmsEntry, fields: string[]) {\n    return {\n        ...pick(entry, fields),\n        ...entry.values\n    } as SearchRecord<any>;\n}\n\nexport function getFolderFieldValues(entry: CmsEntry, fields: string[]) {\n    return { ...pick(entry, fields), ...entry.values } as Folder;\n}\n"],"mappings":";;;;;;;;;AAAA;AAKO,SAASA,oBAAoB,CAACC,KAAe,EAAEC,MAAgB,EAAE;EACpE,mEACO,IAAAC,aAAI,EAACF,KAAK,EAAEC,MAAM,CAAC,GACnBD,KAAK,CAACG,MAAM;AAEvB;AAEO,SAASC,oBAAoB,CAACJ,KAAe,EAAEC,MAAgB,EAAE;EACpE,mEAAY,IAAAC,aAAI,EAACF,KAAK,EAAEC,MAAM,CAAC,GAAKD,KAAK,CAACG,MAAM;AACpD"}

package/utils/isInstallationPending.d.ts

@@ -0,0 +1,4 @@
+import { AcoContext } from "../types";
+declare type CheckInstallationParams = Pick<AcoContext, "tenancy" | "i18n">;
+export declare const isInstallationPending: ({ tenancy, i18n }: CheckInstallationParams) => boolean;
+export {};

package/utils/isInstallationPending.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isInstallationPending = void 0;
+const isInstallationPending = ({
+  tenancy,
+  i18n
+}) => {
+  /**
+   * In case of a fresh webiny project "tenant" and "locale" won't be there until
+   * installation is completed. So, we need to skip "ACO" creation till then.
+   */
+  const tenant = tenancy.getCurrentTenant();
+  if (!tenant) {
+    return true;
+  }
+  return !i18n.getContentLocale();
+};
+exports.isInstallationPending = isInstallationPending;

package/utils/isInstallationPending.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["isInstallationPending","tenancy","i18n","tenant","getCurrentTenant","getContentLocale"],"sources":["isInstallationPending.ts"],"sourcesContent":["import { AcoContext } from \"~/types\";\n\ntype CheckInstallationParams = Pick<AcoContext, \"tenancy\" | \"i18n\">;\nexport const isInstallationPending = ({ tenancy, i18n }: CheckInstallationParams): boolean => {\n    /**\n     * In case of a fresh webiny project \"tenant\" and \"locale\" won't be there until\n     * installation is completed. So, we need to skip \"ACO\" creation till then.\n     */\n    const tenant = tenancy.getCurrentTenant();\n    if (!tenant) {\n        return true;\n    }\n\n    return !i18n.getContentLocale();\n};\n"],"mappings":";;;;;;AAGO,MAAMA,qBAAqB,GAAG,CAAC;EAAEC,OAAO;EAAEC;AAA8B,CAAC,KAAc;EAC1F;AACJ;AACA;AACA;EACI,MAAMC,MAAM,GAAGF,OAAO,CAACG,gBAAgB,EAAE;EACzC,IAAI,CAACD,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,OAAO,CAACD,IAAI,CAACG,gBAAgB,EAAE;AACnC,CAAC;AAAC"}

package/utils/modelFactory.d.ts

@@ -0,0 +1,15 @@
+import { CmsModelPlugin, CmsPrivateModelFull } from "@webiny/api-headless-cms";
+import { CmsGroup } from "@webiny/api-headless-cms/types";
+interface Params {
+    group: Pick<CmsGroup, "id" | "name">;
+    /**
+     * Locale and tenant do not need to be defined.
+     * In that case model is not bound to any locale or tenant.
+     * You can bind it to locale, tenant, both or none.
+     */
+    locale?: string;
+    tenant?: string;
+    modelDefinition: Omit<CmsPrivateModelFull, "noValidate" | "group">;
+}
+export declare const modelFactory: (params: Params) => CmsModelPlugin;
+export {};