@webiny/api-headless-cms-utils-os 0.0.0-unstable.0156a4c312

package/helpers/entryIndexHelpers.d.ts

@@ -0,0 +1,20 @@
+import type { CmsEntry, CmsEntryValues, CmsModel } from "@webiny/api-headless-cms/types/index.js";
+import type { CmsIndexEntry } from "../types.js";
+import type { CmsModelFieldToGraphQLRegistry } from "@webiny/api-headless-cms/exports/api/cms/graphql.js";
+import type { CmsEntryOpenSearchFieldIndexRegistry } from "../features/CmsEntryOpenSearchFieldIndex/index.js";
+interface SetupEntriesIndexHelpersParams {
+    fieldRegistry: CmsModelFieldToGraphQLRegistry.Interface;
+    fieldIndexRegistry: CmsEntryOpenSearchFieldIndexRegistry.Interface;
+}
+interface ExtractEntriesFromIndexParams<T extends CmsEntryValues = CmsEntryValues> extends SetupEntriesIndexHelpersParams {
+    model: CmsModel;
+    entries: CmsIndexEntry<T>[];
+}
+interface PrepareElasticsearchDataParams<T extends CmsEntryValues = CmsEntryValues> extends Omit<SetupEntriesIndexHelpersParams, "fieldRegistry"> {
+    model: CmsModel;
+    entry: CmsEntry<T>;
+    storageEntry: CmsEntry<T>;
+}
+export declare const prepareEntryToIndex: <T extends CmsEntryValues = CmsEntryValues>(params: PrepareElasticsearchDataParams<T>) => CmsIndexEntry<T>;
+export declare const extractEntriesFromIndex: <T extends CmsEntryValues = CmsEntryValues>({ fieldRegistry, fieldIndexRegistry, entries, model }: ExtractEntriesFromIndexParams<T>) => CmsEntry<T>[];
+export {};

package/helpers/entryIndexHelpers.js

@@ -0,0 +1,80 @@
+import { WebinyError } from "@webiny/error";
+import { getFieldIdentifier, getFieldIdentifiers } from "./fieldIdentifier.js";
+const prepareEntryToIndex = (params)=>{
+    const { fieldIndexRegistry, storageEntry, entry, model } = params;
+    function getFieldIndex(type) {
+        const fieldIndexing = fieldIndexRegistry.get(type);
+        if (fieldIndexing) return fieldIndexing;
+        return fieldIndexRegistry.getDefault();
+    }
+    const values = {};
+    const rawValues = {};
+    for (const field of model.fields){
+        const identifier = getFieldIdentifier(storageEntry.values, field);
+        if (!identifier) continue;
+        const fieldIndex = getFieldIndex(field.type);
+        const { value, rawValue } = fieldIndex.toIndex({
+            model,
+            field,
+            rawValue: entry.values[identifier],
+            value: storageEntry.values[identifier],
+            getFieldIndex
+        });
+        if (void 0 !== value) values[identifier] = value;
+        if (void 0 !== rawValue) rawValues[identifier] = rawValue;
+    }
+    return {
+        ...storageEntry,
+        values,
+        rawValues
+    };
+};
+const extractEntriesFromIndex = ({ fieldRegistry, fieldIndexRegistry, entries, model })=>{
+    function getFieldIndex(type) {
+        const fieldIndex = fieldIndexRegistry.get(type);
+        if (fieldIndex) return fieldIndex;
+        return fieldIndexRegistry.getDefault();
+    }
+    const list = [];
+    for (const entry of entries){
+        const indexValues = {};
+        for (const field of model.fields){
+            const fieldType = fieldRegistry.get(field.type);
+            if (!fieldType) throw new WebinyError(`Missing field type "${field.type}". Extract entries from index.`);
+            const fieldIndex = getFieldIndex(field.type);
+            const identifiers = getFieldIdentifiers(entry.values, entry.rawValues, field);
+            if (identifiers) try {
+                const key = identifiers.valueIdentifier;
+                const rawKey = identifiers.rawValueIdentifier;
+                indexValues[key] = fieldIndex.fromIndex({
+                    model,
+                    field,
+                    getFieldIndex,
+                    value: entry.values[key || rawKey],
+                    rawValue: entry.rawValues ? entry.rawValues[rawKey || key] : null
+                });
+            } catch (ex) {
+                throw new WebinyError(ex.message || "Could not transform entry field from index.", ex.code || "FIELD_FROM_INDEX_ERROR", {
+                    field,
+                    entry
+                });
+            }
+        }
+        const newEntry = {
+            ...entry,
+            values: indexValues
+        };
+        delete newEntry["rawValues"];
+        delete newEntry["TYPE"];
+        delete newEntry["__type"];
+        delete newEntry["latest"];
+        delete newEntry["published"];
+        list.push({
+            ...newEntry
+        });
+    }
+    return list;
+};
+export { extractEntriesFromIndex, prepareEntryToIndex };
+
+//# sourceMappingURL=entryIndexHelpers.js.map

package/helpers/entryIndexHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers/entryIndexHelpers.js","sources":["../../src/helpers/entryIndexHelpers.ts"],"sourcesContent":["import { WebinyError } from \"@webiny/error\";\nimport type { CmsEntry, CmsEntryValues, CmsModel } from \"@webiny/api-headless-cms/types/index.js\";\nimport type { CmsIndexEntry } from \"~/types.js\";\nimport { getFieldIdentifier, getFieldIdentifiers } from \"~/helpers/fieldIdentifier.js\";\nimport type { CmsModelFieldToGraphQLRegistry } from \"@webiny/api-headless-cms/exports/api/cms/graphql.js\";\nimport type {\n    CmsEntryOpenSearchFieldIndex,\n    CmsEntryOpenSearchFieldIndexRegistry\n} from \"~/features/CmsEntryOpenSearchFieldIndex/index.js\";\n\ninterface SetupEntriesIndexHelpersParams {\n    fieldRegistry: CmsModelFieldToGraphQLRegistry.Interface;\n    fieldIndexRegistry: CmsEntryOpenSearchFieldIndexRegistry.Interface;\n}\n\ninterface ExtractEntriesFromIndexParams<\n    T extends CmsEntryValues = CmsEntryValues\n> extends SetupEntriesIndexHelpersParams {\n    model: CmsModel;\n    entries: CmsIndexEntry<T>[];\n}\n\ninterface PrepareElasticsearchDataParams<T extends CmsEntryValues = CmsEntryValues> extends Omit<\n    SetupEntriesIndexHelpersParams,\n    \"fieldRegistry\"\n> {\n    model: CmsModel;\n    entry: CmsEntry<T>;\n    storageEntry: CmsEntry<T>;\n}\n\nexport const prepareEntryToIndex = <T extends CmsEntryValues = CmsEntryValues>(\n    params: PrepareElasticsearchDataParams<T>\n): CmsIndexEntry<T> => {\n    const { fieldIndexRegistry, storageEntry, entry, model } = params;\n\n    function getFieldIndex(type: string): CmsEntryOpenSearchFieldIndex.Interface {\n        const fieldIndexing = fieldIndexRegistry.get(type);\n        if (fieldIndexing) {\n            return fieldIndexing;\n        }\n        return fieldIndexRegistry.getDefault();\n    }\n\n    // These objects will contain values processed by field index implementations\n    const values: T = {} as T;\n    const rawValues: T = {} as T;\n\n    // We're only interested in current model fields.\n    for (const field of model.fields) {\n        const identifier = getFieldIdentifier(storageEntry.values, field) as keyof T;\n        if (!identifier) {\n            continue;\n        }\n\n        const fieldIndex = getFieldIndex(field.type);\n\n        const { value, rawValue } = fieldIndex.toIndex({\n            model,\n            field,\n            rawValue: entry.values[identifier],\n            value: storageEntry.values[identifier],\n            getFieldIndex\n        });\n\n        if (typeof value !== \"undefined\") {\n            values[identifier] = value;\n        }\n\n        if (typeof rawValue !== \"undefined\") {\n            rawValues[identifier] = rawValue;\n        }\n    }\n    return {\n        ...storageEntry,\n        values,\n        rawValues\n    };\n};\n\nexport const extractEntriesFromIndex = <T extends CmsEntryValues = CmsEntryValues>({\n    fieldRegistry,\n    fieldIndexRegistry,\n    entries,\n    model\n}: ExtractEntriesFromIndexParams<T>): CmsEntry<T>[] => {\n    function getFieldIndex(type: string): CmsEntryOpenSearchFieldIndex.Interface {\n        const fieldIndex = fieldIndexRegistry.get(type);\n        if (fieldIndex) {\n            return fieldIndex;\n        }\n        return fieldIndexRegistry.getDefault();\n    }\n\n    const list: CmsEntry<T>[] = [];\n\n    for (const entry of entries) {\n        // This object will contain values processed by field index plugins\n        const indexValues: T = {} as T;\n\n        // We only consider fields that are present in the model\n        for (const field of model.fields) {\n            const fieldType = fieldRegistry.get(field.type);\n            if (!fieldType) {\n                throw new WebinyError(\n                    `Missing field type \"${field.type}\". Extract entries from index.`\n                );\n            }\n\n            const fieldIndex = getFieldIndex(field.type);\n            /**\n             * We can safely cast as the code will not continue in case of no identifiers.\n             */\n            const identifiers = getFieldIdentifiers(entry.values, entry.rawValues, field);\n            if (!identifiers) {\n                continue;\n            }\n            try {\n                const key = identifiers.valueIdentifier as keyof T;\n                const rawKey = identifiers.rawValueIdentifier as keyof T;\n                indexValues[key] = fieldIndex.fromIndex({\n                    model,\n                    field,\n                    getFieldIndex,\n                    value: entry.values[key || rawKey],\n                    /**\n                     * Possibly no rawValues so we must check for the existence of the field.\n                     */\n                    rawValue: entry.rawValues ? entry.rawValues[rawKey || key] : null\n                });\n            } catch (ex) {\n                throw new WebinyError(\n                    ex.message || \"Could not transform entry field from index.\",\n                    ex.code || \"FIELD_FROM_INDEX_ERROR\",\n                    {\n                        field,\n                        entry\n                    }\n                );\n            }\n        }\n        /**\n         * Let's have a new entry so we do not modify the original one.\n         */\n        const newEntry: CmsEntry<T> = {\n            ...entry,\n            values: indexValues\n        };\n        /**\n         * If we want to remove the rawValues, TYPE, latest, published and __type, we must make them optional or ignore them.\n         */\n        // @ts-expect-error\n        delete newEntry[\"rawValues\"];\n        // @ts-expect-error\n        delete newEntry[\"TYPE\"];\n        // @ts-expect-error\n        delete newEntry[\"__type\"];\n        // @ts-expect-error\n        delete newEntry[\"latest\"];\n        // @ts-expect-error\n        delete newEntry[\"published\"];\n        list.push({\n            ...newEntry\n        });\n    }\n\n    return list;\n};\n"],"names":["prepareEntryToIndex","params","fieldIndexRegistry","storageEntry","entry","model","getFieldIndex","type","fieldIndexing","values","rawValues","field","identifier","getFieldIdentifier","fieldIndex","value","rawValue","extractEntriesFromIndex","fieldRegistry","entries","list","indexValues","fieldType","WebinyError","identifiers","getFieldIdentifiers","key","rawKey","ex","newEntry"],"mappings":";;AA+BO,MAAMA,sBAAsB,CAC/BC;IAEA,MAAM,EAAEC,kBAAkB,EAAEC,YAAY,EAAEC,KAAK,EAAEC,KAAK,EAAE,GAAGJ;IAE3D,SAASK,cAAcC,IAAY;QAC/B,MAAMC,gBAAgBN,mBAAmB,GAAG,CAACK;QAC7C,IAAIC,eACA,OAAOA;QAEX,OAAON,mBAAmB,UAAU;IACxC;IAGA,MAAMO,SAAY,CAAC;IACnB,MAAMC,YAAe,CAAC;IAGtB,KAAK,MAAMC,SAASN,MAAM,MAAM,CAAE;QAC9B,MAAMO,aAAaC,mBAAmBV,aAAa,MAAM,EAAEQ;QAC3D,IAAI,CAACC,YACD;QAGJ,MAAME,aAAaR,cAAcK,MAAM,IAAI;QAE3C,MAAM,EAAEI,KAAK,EAAEC,QAAQ,EAAE,GAAGF,WAAW,OAAO,CAAC;YAC3CT;YACAM;YACA,UAAUP,MAAM,MAAM,CAACQ,WAAW;YAClC,OAAOT,aAAa,MAAM,CAACS,WAAW;YACtCN;QACJ;QAEA,IAAI,AAAiB,WAAVS,OACPN,MAAM,CAACG,WAAW,GAAGG;QAGzB,IAAI,AAAoB,WAAbC,UACPN,SAAS,CAACE,WAAW,GAAGI;IAEhC;IACA,OAAO;QACH,GAAGb,YAAY;QACfM;QACAC;IACJ;AACJ;AAEO,MAAMO,0BAA0B,CAA4C,EAC/EC,aAAa,EACbhB,kBAAkB,EAClBiB,OAAO,EACPd,KAAK,EAC0B;IAC/B,SAASC,cAAcC,IAAY;QAC/B,MAAMO,aAAaZ,mBAAmB,GAAG,CAACK;QAC1C,IAAIO,YACA,OAAOA;QAEX,OAAOZ,mBAAmB,UAAU;IACxC;IAEA,MAAMkB,OAAsB,EAAE;IAE9B,KAAK,MAAMhB,SAASe,QAAS;QAEzB,MAAME,cAAiB,CAAC;QAGxB,KAAK,MAAMV,SAASN,MAAM,MAAM,CAAE;YAC9B,MAAMiB,YAAYJ,cAAc,GAAG,CAACP,MAAM,IAAI;YAC9C,IAAI,CAACW,WACD,MAAM,IAAIC,YACN,CAAC,oBAAoB,EAAEZ,MAAM,IAAI,CAAC,8BAA8B,CAAC;YAIzE,MAAMG,aAAaR,cAAcK,MAAM,IAAI;YAI3C,MAAMa,cAAcC,oBAAoBrB,MAAM,MAAM,EAAEA,MAAM,SAAS,EAAEO;YACvE,IAAKa,aAGL,IAAI;gBACA,MAAME,MAAMF,YAAY,eAAe;gBACvC,MAAMG,SAASH,YAAY,kBAAkB;gBAC7CH,WAAW,CAACK,IAAI,GAAGZ,WAAW,SAAS,CAAC;oBACpCT;oBACAM;oBACAL;oBACA,OAAOF,MAAM,MAAM,CAACsB,OAAOC,OAAO;oBAIlC,UAAUvB,MAAM,SAAS,GAAGA,MAAM,SAAS,CAACuB,UAAUD,IAAI,GAAG;gBACjE;YACJ,EAAE,OAAOE,IAAI;gBACT,MAAM,IAAIL,YACNK,GAAG,OAAO,IAAI,+CACdA,GAAG,IAAI,IAAI,0BACX;oBACIjB;oBACAP;gBACJ;YAER;QACJ;QAIA,MAAMyB,WAAwB;YAC1B,GAAGzB,KAAK;YACR,QAAQiB;QACZ;QAKA,OAAOQ,QAAQ,CAAC,YAAY;QAE5B,OAAOA,QAAQ,CAAC,OAAO;QAEvB,OAAOA,QAAQ,CAAC,SAAS;QAEzB,OAAOA,QAAQ,CAAC,SAAS;QAEzB,OAAOA,QAAQ,CAAC,YAAY;QAC5BT,KAAK,IAAI,CAAC;YACN,GAAGS,QAAQ;QACf;IACJ;IAEA,OAAOT;AACX"}

package/helpers/fieldIdentifier.d.ts

@@ -0,0 +1,6 @@
+import type { CmsEntryValues, CmsModelField } from "@webiny/api-headless-cms/types/index.js";
+export declare const getFieldIdentifier: (values: CmsEntryValues | null | undefined, field: CmsModelField) => string | undefined;
+export declare const getFieldIdentifiers: (values: CmsEntryValues, rawValues: CmsEntryValues | null | undefined, field: CmsModelField) => {
+    valueIdentifier: string;
+    rawValueIdentifier: string;
+} | null;

package/helpers/fieldIdentifier.js

@@ -0,0 +1,23 @@
+const fieldIdentifier_hasOwnProperty = (values = {}, property)=>{
+    if (!values) return false;
+    else if (values.hasOwnProperty) return values.hasOwnProperty(property);
+    return void 0 !== values[property];
+};
+const getFieldIdentifier = (values, field)=>{
+    if (field.storageId && fieldIdentifier_hasOwnProperty(values, field.storageId)) return field.storageId;
+    else if (fieldIdentifier_hasOwnProperty(values, field.fieldId)) return field.fieldId;
+};
+const getFieldIdentifiers = (values, rawValues, field)=>{
+    let valueIdentifier = getFieldIdentifier(values, field);
+    let rawValueIdentifier = getFieldIdentifier(rawValues, field);
+    if (!valueIdentifier && !rawValueIdentifier) return null;
+    if (!valueIdentifier) valueIdentifier = rawValueIdentifier;
+    if (!rawValueIdentifier) rawValueIdentifier = valueIdentifier;
+    return {
+        valueIdentifier,
+        rawValueIdentifier
+    };
+};
+export { getFieldIdentifier, getFieldIdentifiers };
+
+//# sourceMappingURL=fieldIdentifier.js.map

package/helpers/fieldIdentifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers/fieldIdentifier.js","sources":["../../src/helpers/fieldIdentifier.ts"],"sourcesContent":["import type { CmsEntryValues, CmsModelField } from \"@webiny/api-headless-cms/types/index.js\";\n\nconst hasOwnProperty = (\n    values: CmsEntryValues | null | undefined = {},\n    property: string\n): boolean => {\n    if (!values) {\n        return false;\n    } else if (values.hasOwnProperty) {\n        return values.hasOwnProperty(property);\n    }\n    return values[property] !== undefined;\n};\n\nexport const getFieldIdentifier = (\n    values: CmsEntryValues | null | undefined,\n    field: CmsModelField\n): string | undefined => {\n    if (field.storageId && hasOwnProperty(values, field.storageId)) {\n        return field.storageId;\n    } else if (hasOwnProperty(values, field.fieldId)) {\n        return field.fieldId;\n    }\n    return undefined;\n};\n\nexport const getFieldIdentifiers = (\n    values: CmsEntryValues,\n    rawValues: CmsEntryValues | null | undefined,\n    field: CmsModelField\n) => {\n    let valueIdentifier = getFieldIdentifier(values, field);\n    let rawValueIdentifier = getFieldIdentifier(rawValues, field);\n    if (!valueIdentifier && !rawValueIdentifier) {\n        return null;\n    }\n    if (!valueIdentifier) {\n        valueIdentifier = rawValueIdentifier as string;\n    }\n    if (!rawValueIdentifier) {\n        rawValueIdentifier = valueIdentifier as string;\n    }\n    return {\n        valueIdentifier,\n        rawValueIdentifier\n    };\n};\n"],"names":["hasOwnProperty","values","property","undefined","getFieldIdentifier","field","getFieldIdentifiers","rawValues","valueIdentifier","rawValueIdentifier"],"mappings":"AAEA,MAAMA,iCAAiB,CACnBC,SAA4C,CAAC,CAAC,EAC9CC;IAEA,IAAI,CAACD,QACD,OAAO;SACJ,IAAIA,OAAO,cAAc,EAC5B,OAAOA,OAAO,cAAc,CAACC;IAEjC,OAAOD,AAAqBE,WAArBF,MAAM,CAACC,SAAS;AAC3B;AAEO,MAAME,qBAAqB,CAC9BH,QACAI;IAEA,IAAIA,MAAM,SAAS,IAAIL,+BAAeC,QAAQI,MAAM,SAAS,GACzD,OAAOA,MAAM,SAAS;SACnB,IAAIL,+BAAeC,QAAQI,MAAM,OAAO,GAC3C,OAAOA,MAAM,OAAO;AAG5B;AAEO,MAAMC,sBAAsB,CAC/BL,QACAM,WACAF;IAEA,IAAIG,kBAAkBJ,mBAAmBH,QAAQI;IACjD,IAAII,qBAAqBL,mBAAmBG,WAAWF;IACvD,IAAI,CAACG,mBAAmB,CAACC,oBACrB,OAAO;IAEX,IAAI,CAACD,iBACDA,kBAAkBC;IAEtB,IAAI,CAACA,oBACDA,qBAAqBD;IAEzB,OAAO;QACHA;QACAC;IACJ;AACJ"}

package/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./entryIndexHelpers.js";
+export * from "./fieldIdentifier.js";

package/helpers/index.js

@@ -0,0 +1,2 @@
+export * from "./entryIndexHelpers.js";
+export * from "./fieldIdentifier.js";

package/index.d.ts

@@ -0,0 +1 @@
+export { CmsEntryOpenSearchUtilsFeature } from "./features/CmsEntryOpenSearchUtilsFeature.js";

package/index.js

@@ -0,0 +1 @@
+export { CmsEntryOpenSearchUtilsFeature } from "./features/CmsEntryOpenSearchUtilsFeature.js";

package/operations/entry/elasticsearch/assignMinimumShouldMatchToQuery.d.ts

@@ -0,0 +1,18 @@
+import type { QueryDslBoolQuery as BoolQueryConfig } from "@webiny/api-opensearch/types.js";
+/**
+ * This function will assign a minimum_should_match for the query if conditions are met:
+ * * should is an array
+ * * it is not empty
+ * * minimum_should_match is not already set
+ *
+ *
+ * By the default we set it to 1 as we want at least one OR condition to produce results.
+ *
+ * Users can modify minimum_should_match value via the body or query modification plugins.
+ */
+interface Params {
+    query: BoolQueryConfig;
+    value?: number;
+}
+export declare const assignMinimumShouldMatchToQuery: ({ query, value }: Params) => void;
+export {};

package/operations/entry/elasticsearch/assignMinimumShouldMatchToQuery.js

@@ -0,0 +1,9 @@
+const assignMinimumShouldMatchToQuery = ({ query, value = 1 })=>{
+    if (!Array.isArray(query.should)) return;
+    else if (0 === query.should.length) return;
+    else if (query.minimum_should_match) return;
+    query.minimum_should_match = value > 0 ? value : 1;
+};
+export { assignMinimumShouldMatchToQuery };
+
+//# sourceMappingURL=assignMinimumShouldMatchToQuery.js.map

package/operations/entry/elasticsearch/assignMinimumShouldMatchToQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/assignMinimumShouldMatchToQuery.js","sources":["../../../../src/operations/entry/elasticsearch/assignMinimumShouldMatchToQuery.ts"],"sourcesContent":["import type { QueryDslBoolQuery as BoolQueryConfig } from \"@webiny/api-opensearch/types.js\";\n\n/**\n * This function will assign a minimum_should_match for the query if conditions are met:\n * * should is an array\n * * it is not empty\n * * minimum_should_match is not already set\n *\n *\n * By the default we set it to 1 as we want at least one OR condition to produce results.\n *\n * Users can modify minimum_should_match value via the body or query modification plugins.\n */\ninterface Params {\n    query: BoolQueryConfig;\n    value?: number;\n}\nexport const assignMinimumShouldMatchToQuery = ({ query, value = 1 }: Params): void => {\n    if (!Array.isArray(query.should)) {\n        return;\n    } else if (query.should.length === 0) {\n        return;\n    } else if (query.minimum_should_match) {\n        return;\n    }\n    query.minimum_should_match = value > 0 ? value : 1;\n};\n"],"names":["assignMinimumShouldMatchToQuery","query","value","Array"],"mappings":"AAiBO,MAAMA,kCAAkC,CAAC,EAAEC,KAAK,EAAEC,QAAQ,CAAC,EAAU;IACxE,IAAI,CAACC,MAAM,OAAO,CAACF,MAAM,MAAM,GAC3B;SACG,IAAIA,AAAwB,MAAxBA,MAAM,MAAM,CAAC,MAAM,EAC1B;SACG,IAAIA,MAAM,oBAAoB,EACjC;IAEJA,MAAM,oBAAoB,GAAGC,QAAQ,IAAIA,QAAQ;AACrD"}

package/operations/entry/elasticsearch/fields/createSystemField.d.ts

@@ -0,0 +1,4 @@
+import type { CmsModelField } from "@webiny/api-headless-cms/types/index.js";
+type PartialCmsModelField = Partial<CmsModelField> & Pick<CmsModelField, "storageId" | "fieldId" | "type">;
+export declare const createSystemField: (field: PartialCmsModelField) => CmsModelField;
+export {};

package/operations/entry/elasticsearch/fields/createSystemField.js

@@ -0,0 +1,9 @@
+import { createModelField } from "@webiny/api-headless-cms";
+const createSystemField = (field)=>createModelField({
+        ...field,
+        id: field.fieldId,
+        label: field.fieldId
+    });
+export { createSystemField };
+
+//# sourceMappingURL=createSystemField.js.map

package/operations/entry/elasticsearch/fields/createSystemField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/fields/createSystemField.js","sources":["../../../../../src/operations/entry/elasticsearch/fields/createSystemField.ts"],"sourcesContent":["import type { CmsModelField } from \"@webiny/api-headless-cms/types/index.js\";\nimport { createModelField } from \"@webiny/api-headless-cms\";\n\ntype PartialCmsModelField = Partial<CmsModelField> &\n    Pick<CmsModelField, \"storageId\" | \"fieldId\" | \"type\">;\nexport const createSystemField = (field: PartialCmsModelField): CmsModelField => {\n    return createModelField({\n        ...field,\n        id: field.fieldId,\n        label: field.fieldId\n    });\n};\n"],"names":["createSystemField","field","createModelField"],"mappings":";AAKO,MAAMA,oBAAoB,CAACC,QACvBC,iBAAiB;QACpB,GAAGD,KAAK;QACR,IAAIA,MAAM,OAAO;QACjB,OAAOA,MAAM,OAAO;IACxB"}

package/operations/entry/elasticsearch/fields/live.d.ts

@@ -0,0 +1,2 @@
+import type { ModelFields } from "../../../../operations/entry/elasticsearch/types.js";
+export declare const liveFields: ModelFields;

package/operations/entry/elasticsearch/fields/live.js

@@ -0,0 +1,50 @@
+import { createSystemField } from "./createSystemField.js";
+import { createModelField } from "@webiny/api-headless-cms";
+const liveFields = {
+    live: {
+        type: "object",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        field: createSystemField({
+            storageId: "live",
+            fieldId: "live",
+            type: "object",
+            settings: {
+                fields: [
+                    createModelField({
+                        id: "version",
+                        fieldId: "version",
+                        storageId: "version",
+                        type: "number",
+                        label: "Version"
+                    })
+                ]
+            }
+        }),
+        parents: []
+    },
+    "live.version": {
+        type: "number",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        parents: [
+            {
+                fieldId: "live",
+                type: "object",
+                storageId: "live"
+            }
+        ],
+        field: createSystemField({
+            id: "version",
+            fieldId: "version",
+            storageId: "version",
+            type: "number",
+            label: "Version"
+        })
+    }
+};
+export { liveFields };
+
+//# sourceMappingURL=live.js.map

package/operations/entry/elasticsearch/fields/live.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/fields/live.js","sources":["../../../../../src/operations/entry/elasticsearch/fields/live.ts"],"sourcesContent":["import type { ModelFields } from \"~/operations/entry/elasticsearch/types.js\";\nimport { createSystemField } from \"./createSystemField.js\";\nimport { createModelField } from \"@webiny/api-headless-cms\";\n\nexport const liveFields: ModelFields = {\n    live: {\n        type: \"object\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        field: createSystemField({\n            storageId: \"live\",\n            fieldId: \"live\",\n            type: \"object\",\n            settings: {\n                fields: [\n                    createModelField({\n                        id: \"version\",\n                        fieldId: \"version\",\n                        storageId: \"version\",\n                        type: \"number\",\n                        label: \"Version\"\n                    })\n                ]\n            }\n        }),\n        parents: []\n    },\n    \"live.version\": {\n        type: \"number\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        parents: [\n            {\n                fieldId: \"live\",\n                type: \"object\",\n                storageId: \"live\"\n            }\n        ],\n        field: createSystemField({\n            id: \"version\",\n            fieldId: \"version\",\n            storageId: \"version\",\n            type: \"number\",\n            label: \"Version\"\n        })\n    }\n};\n"],"names":["liveFields","createSystemField","createModelField"],"mappings":";;AAIO,MAAMA,aAA0B;IACnC,MAAM;QACF,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,OAAOC,kBAAkB;YACrB,WAAW;YACX,SAAS;YACT,MAAM;YACN,UAAU;gBACN,QAAQ;oBACJC,iBAAiB;wBACb,IAAI;wBACJ,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,OAAO;oBACX;iBACH;YACL;QACJ;QACA,SAAS,EAAE;IACf;IACA,gBAAgB;QACZ,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,SAAS;YACL;gBACI,SAAS;gBACT,MAAM;gBACN,WAAW;YACf;SACH;QACD,OAAOD,kBAAkB;YACrB,IAAI;YACJ,SAAS;YACT,WAAW;YACX,MAAM;YACN,OAAO;QACX;IACJ;AACJ"}

package/operations/entry/elasticsearch/fields/location.d.ts

@@ -0,0 +1,2 @@
+import type { ModelFields } from "../../../../operations/entry/elasticsearch/types.js";
+export declare const locationFields: ModelFields;

package/operations/entry/elasticsearch/fields/location.js

@@ -0,0 +1,50 @@
+import { createSystemField } from "./createSystemField.js";
+import { createModelField } from "@webiny/api-headless-cms";
+const locationFields = {
+    wbyAco_location: {
+        type: "object",
+        systemField: true,
+        searchable: true,
+        sortable: true,
+        field: createSystemField({
+            storageId: "location",
+            fieldId: "wbyAco_location",
+            type: "object",
+            settings: {
+                fields: [
+                    createModelField({
+                        id: "folderId",
+                        fieldId: "folderId",
+                        storageId: "folderId",
+                        type: "text",
+                        label: "Folder ID"
+                    })
+                ]
+            }
+        }),
+        parents: []
+    },
+    "wbyAco_location.folderId": {
+        type: "text",
+        systemField: true,
+        searchable: true,
+        sortable: true,
+        field: createSystemField({
+            id: "folderId",
+            fieldId: "folderId",
+            storageId: "folderId",
+            type: "text",
+            label: "Folder ID"
+        }),
+        parents: [
+            {
+                fieldId: "wbyAco_location",
+                type: "object",
+                storageId: "location"
+            }
+        ]
+    }
+};
+export { locationFields };
+
+//# sourceMappingURL=location.js.map

package/operations/entry/elasticsearch/fields/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/fields/location.js","sources":["../../../../../src/operations/entry/elasticsearch/fields/location.ts"],"sourcesContent":["import type { ModelFields } from \"~/operations/entry/elasticsearch/types.js\";\nimport { createSystemField } from \"./createSystemField.js\";\nimport { createModelField } from \"@webiny/api-headless-cms\";\n\nexport const locationFields: ModelFields = {\n    wbyAco_location: {\n        type: \"object\",\n        systemField: true,\n        searchable: true,\n        sortable: true,\n        field: createSystemField({\n            storageId: \"location\",\n            fieldId: \"wbyAco_location\",\n            type: \"object\",\n            settings: {\n                fields: [\n                    createModelField({\n                        id: \"folderId\",\n                        fieldId: \"folderId\",\n                        storageId: \"folderId\",\n                        type: \"text\",\n                        label: \"Folder ID\"\n                    })\n                ]\n            }\n        }),\n        parents: []\n    },\n    \"wbyAco_location.folderId\": {\n        type: \"text\",\n        systemField: true,\n        searchable: true,\n        sortable: true,\n        field: createSystemField({\n            id: \"folderId\",\n            fieldId: \"folderId\",\n            storageId: \"folderId\",\n            type: \"text\",\n            label: \"Folder ID\"\n        }),\n        parents: [\n            {\n                fieldId: \"wbyAco_location\",\n                type: \"object\",\n                storageId: \"location\"\n            }\n        ]\n    }\n};\n"],"names":["locationFields","createSystemField","createModelField"],"mappings":";;AAIO,MAAMA,iBAA8B;IACvC,iBAAiB;QACb,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,OAAOC,kBAAkB;YACrB,WAAW;YACX,SAAS;YACT,MAAM;YACN,UAAU;gBACN,QAAQ;oBACJC,iBAAiB;wBACb,IAAI;wBACJ,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,OAAO;oBACX;iBACH;YACL;QACJ;QACA,SAAS,EAAE;IACf;IACA,4BAA4B;QACxB,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,OAAOD,kBAAkB;YACrB,IAAI;YACJ,SAAS;YACT,WAAW;YACX,MAAM;YACN,OAAO;QACX;QACA,SAAS;YACL;gBACI,SAAS;gBACT,MAAM;gBACN,WAAW;YACf;SACH;IACL;AACJ"}

package/operations/entry/elasticsearch/fields/state.d.ts

@@ -0,0 +1,2 @@
+import type { ModelFields } from "../../../../operations/entry/elasticsearch/types.js";
+export declare const stateFields: ModelFields;

package/operations/entry/elasticsearch/fields/state.js

@@ -0,0 +1,104 @@
+import { createSystemField } from "./createSystemField.js";
+import { createModelField } from "@webiny/api-headless-cms";
+const stateFields = {
+    state: {
+        type: "object",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        field: createSystemField({
+            storageId: "object@state",
+            fieldId: "state",
+            type: "object",
+            settings: {
+                fields: [
+                    createModelField({
+                        id: "stepId",
+                        fieldId: "stepId",
+                        storageId: "text@stepId",
+                        type: "text",
+                        label: "Step ID"
+                    }),
+                    createModelField({
+                        id: "stepName",
+                        fieldId: "stepName",
+                        storageId: "text@stepName",
+                        type: "text",
+                        label: "Step Name"
+                    }),
+                    createModelField({
+                        id: "state",
+                        fieldId: "state",
+                        storageId: "text@state",
+                        type: "text",
+                        label: "State"
+                    })
+                ]
+            }
+        }),
+        parents: []
+    },
+    "state.stepId": {
+        type: "text",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        parents: [
+            {
+                fieldId: "state",
+                type: "object",
+                storageId: "object@state"
+            }
+        ],
+        field: createSystemField({
+            id: "stepId",
+            fieldId: "stepId",
+            storageId: "text@stepId",
+            type: "text",
+            label: "Step ID"
+        })
+    },
+    "state.stepName": {
+        type: "text",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        parents: [
+            {
+                fieldId: "state",
+                type: "object",
+                storageId: "object@state"
+            }
+        ],
+        field: createSystemField({
+            id: "stepName",
+            fieldId: "stepName",
+            storageId: "text@stepName",
+            type: "text",
+            label: "Step Name"
+        })
+    },
+    "state.state": {
+        type: "text",
+        systemField: true,
+        searchable: true,
+        sortable: false,
+        parents: [
+            {
+                fieldId: "state",
+                type: "object",
+                storageId: "object@state"
+            }
+        ],
+        field: createSystemField({
+            id: "state",
+            fieldId: "state",
+            storageId: "text@state",
+            type: "text",
+            label: "State"
+        })
+    }
+};
+export { stateFields };
+
+//# sourceMappingURL=state.js.map

package/operations/entry/elasticsearch/fields/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/fields/state.js","sources":["../../../../../src/operations/entry/elasticsearch/fields/state.ts"],"sourcesContent":["import type { ModelFields } from \"~/operations/entry/elasticsearch/types.js\";\nimport { createSystemField } from \"./createSystemField.js\";\nimport { createModelField } from \"@webiny/api-headless-cms\";\n\nexport const stateFields: ModelFields = {\n    state: {\n        type: \"object\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        field: createSystemField({\n            storageId: \"object@state\",\n            fieldId: \"state\",\n            type: \"object\",\n            settings: {\n                fields: [\n                    createModelField({\n                        id: \"stepId\",\n                        fieldId: \"stepId\",\n                        storageId: \"text@stepId\",\n                        type: \"text\",\n                        label: \"Step ID\"\n                    }),\n                    createModelField({\n                        id: \"stepName\",\n                        fieldId: \"stepName\",\n                        storageId: \"text@stepName\",\n                        type: \"text\",\n                        label: \"Step Name\"\n                    }),\n                    createModelField({\n                        id: \"state\",\n                        fieldId: \"state\",\n                        storageId: \"text@state\",\n                        type: \"text\",\n                        label: \"State\"\n                    })\n                ]\n            }\n        }),\n        parents: []\n    },\n    \"state.stepId\": {\n        type: \"text\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        parents: [\n            {\n                fieldId: \"state\",\n                type: \"object\",\n                storageId: \"object@state\"\n            }\n        ],\n        field: createSystemField({\n            id: \"stepId\",\n            fieldId: \"stepId\",\n            storageId: \"text@stepId\",\n            type: \"text\",\n            label: \"Step ID\"\n        })\n    },\n    \"state.stepName\": {\n        type: \"text\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        parents: [\n            {\n                fieldId: \"state\",\n                type: \"object\",\n                storageId: \"object@state\"\n            }\n        ],\n        field: createSystemField({\n            id: \"stepName\",\n            fieldId: \"stepName\",\n            storageId: \"text@stepName\",\n            type: \"text\",\n            label: \"Step Name\"\n        })\n    },\n    \"state.state\": {\n        type: \"text\",\n        systemField: true,\n        searchable: true,\n        sortable: false,\n        parents: [\n            {\n                fieldId: \"state\",\n                type: \"object\",\n                storageId: \"object@state\"\n            }\n        ],\n        field: createSystemField({\n            id: \"state\",\n            fieldId: \"state\",\n            storageId: \"text@state\",\n            type: \"text\",\n            label: \"State\"\n        })\n    }\n};\n"],"names":["stateFields","createSystemField","createModelField"],"mappings":";;AAIO,MAAMA,cAA2B;IACpC,OAAO;QACH,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,OAAOC,kBAAkB;YACrB,WAAW;YACX,SAAS;YACT,MAAM;YACN,UAAU;gBACN,QAAQ;oBACJC,iBAAiB;wBACb,IAAI;wBACJ,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,OAAO;oBACX;oBACAA,iBAAiB;wBACb,IAAI;wBACJ,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,OAAO;oBACX;oBACAA,iBAAiB;wBACb,IAAI;wBACJ,SAAS;wBACT,WAAW;wBACX,MAAM;wBACN,OAAO;oBACX;iBACH;YACL;QACJ;QACA,SAAS,EAAE;IACf;IACA,gBAAgB;QACZ,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,SAAS;YACL;gBACI,SAAS;gBACT,MAAM;gBACN,WAAW;YACf;SACH;QACD,OAAOD,kBAAkB;YACrB,IAAI;YACJ,SAAS;YACT,WAAW;YACX,MAAM;YACN,OAAO;QACX;IACJ;IACA,kBAAkB;QACd,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,SAAS;YACL;gBACI,SAAS;gBACT,MAAM;gBACN,WAAW;YACf;SACH;QACD,OAAOA,kBAAkB;YACrB,IAAI;YACJ,SAAS;YACT,WAAW;YACX,MAAM;YACN,OAAO;QACX;IACJ;IACA,eAAe;QACX,MAAM;QACN,aAAa;QACb,YAAY;QACZ,UAAU;QACV,SAAS;YACL;gBACI,SAAS;gBACT,MAAM;gBACN,WAAW;YACf;SACH;QACD,OAAOA,kBAAkB;YACrB,IAAI;YACJ,SAAS;YACT,WAAW;YACX,MAAM;YACN,OAAO;QACX;IACJ;AACJ"}

package/operations/entry/elasticsearch/fields/system.d.ts

@@ -0,0 +1,7 @@
+import type { ModelFields } from "../../../../operations/entry/elasticsearch/types.js";
+import type { CmsModelField } from "@webiny/api-headless-cms/types/index.js";
+/**
+ * Filter fields for the fields registered as `CmsEntrySystemField`. The `system` object is indexed
+ * as-is (raw storage ids), so a text field resolves to `system.<path>.keyword`.
+ */
+export declare const createEntrySystemFields: (fields: CmsModelField[]) => ModelFields;

package/operations/entry/elasticsearch/fields/system.js

@@ -0,0 +1,58 @@
+import { createSystemField } from "./createSystemField.js";
+const systemParent = {
+    fieldId: "system",
+    type: "object",
+    storageId: "system"
+};
+const addFields = (result, fields, parents)=>{
+    for (const field of fields){
+        const path = [
+            ...parents.map((parent)=>parent.fieldId),
+            field.fieldId
+        ].join(".");
+        result[path] = {
+            type: field.type,
+            systemField: true,
+            searchable: true,
+            sortable: false,
+            parents,
+            field
+        };
+        const children = field.settings?.fields;
+        if (children?.length) addFields(result, children, [
+            ...parents,
+            {
+                fieldId: field.fieldId,
+                type: field.type,
+                storageId: field.storageId
+            }
+        ]);
+    }
+};
+const createEntrySystemFields = (fields)=>{
+    if (0 === fields.length) return {};
+    const result = {
+        system: {
+            type: "object",
+            systemField: true,
+            searchable: true,
+            sortable: false,
+            field: createSystemField({
+                storageId: "system",
+                fieldId: "system",
+                type: "object",
+                settings: {
+                    fields
+                }
+            }),
+            parents: []
+        }
+    };
+    addFields(result, fields, [
+        systemParent
+    ]);
+    return result;
+};
+export { createEntrySystemFields };
+
+//# sourceMappingURL=system.js.map

package/operations/entry/elasticsearch/fields/system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/fields/system.js","sources":["../../../../../src/operations/entry/elasticsearch/fields/system.ts"],"sourcesContent":["import type { ModelFieldParent, ModelFields } from \"~/operations/entry/elasticsearch/types.js\";\nimport type { CmsModelField } from \"@webiny/api-headless-cms/types/index.js\";\nimport { createSystemField } from \"./createSystemField.js\";\n\nconst systemParent: ModelFieldParent = {\n    fieldId: \"system\",\n    type: \"object\",\n    storageId: \"system\"\n};\n\n/**\n * ObjectFilter resolves one level at a time, so every nested object needs its own entry.\n */\nconst addFields = (result: ModelFields, fields: CmsModelField[], parents: ModelFieldParent[]) => {\n    for (const field of fields) {\n        const path = [...parents.map(parent => parent.fieldId), field.fieldId].join(\".\");\n        result[path] = {\n            type: field.type,\n            systemField: true,\n            searchable: true,\n            sortable: false,\n            parents,\n            field\n        };\n        const children = field.settings?.fields;\n        if (!children?.length) {\n            continue;\n        }\n        addFields(result, children, [\n            ...parents,\n            {\n                fieldId: field.fieldId,\n                type: field.type,\n                storageId: field.storageId\n            }\n        ]);\n    }\n};\n\n/**\n * Filter fields for the fields registered as `CmsEntrySystemField`. The `system` object is indexed\n * as-is (raw storage ids), so a text field resolves to `system.<path>.keyword`.\n */\nexport const createEntrySystemFields = (fields: CmsModelField[]): ModelFields => {\n    if (fields.length === 0) {\n        return {};\n    }\n    const result: ModelFields = {\n        system: {\n            type: \"object\",\n            systemField: true,\n            searchable: true,\n            sortable: false,\n            field: createSystemField({\n                storageId: \"system\",\n                fieldId: \"system\",\n                type: \"object\",\n                settings: {\n                    fields\n                }\n            }),\n            parents: []\n        }\n    };\n    addFields(result, fields, [systemParent]);\n    return result;\n};\n"],"names":["systemParent","addFields","result","fields","parents","field","path","parent","children","createEntrySystemFields","createSystemField"],"mappings":";AAIA,MAAMA,eAAiC;IACnC,SAAS;IACT,MAAM;IACN,WAAW;AACf;AAKA,MAAMC,YAAY,CAACC,QAAqBC,QAAyBC;IAC7D,KAAK,MAAMC,SAASF,OAAQ;QACxB,MAAMG,OAAO;eAAIF,QAAQ,GAAG,CAACG,CAAAA,SAAUA,OAAO,OAAO;YAAGF,MAAM,OAAO;SAAC,CAAC,IAAI,CAAC;QAC5EH,MAAM,CAACI,KAAK,GAAG;YACX,MAAMD,MAAM,IAAI;YAChB,aAAa;YACb,YAAY;YACZ,UAAU;YACVD;YACAC;QACJ;QACA,MAAMG,WAAWH,MAAM,QAAQ,EAAE;QACjC,IAAKG,UAAU,QAGfP,UAAUC,QAAQM,UAAU;eACrBJ;YACH;gBACI,SAASC,MAAM,OAAO;gBACtB,MAAMA,MAAM,IAAI;gBAChB,WAAWA,MAAM,SAAS;YAC9B;SACH;IACL;AACJ;AAMO,MAAMI,0BAA0B,CAACN;IACpC,IAAIA,AAAkB,MAAlBA,OAAO,MAAM,EACb,OAAO,CAAC;IAEZ,MAAMD,SAAsB;QACxB,QAAQ;YACJ,MAAM;YACN,aAAa;YACb,YAAY;YACZ,UAAU;YACV,OAAOQ,kBAAkB;gBACrB,WAAW;gBACX,SAAS;gBACT,MAAM;gBACN,UAAU;oBACNP;gBACJ;YACJ;YACA,SAAS,EAAE;QACf;IACJ;IACAF,UAAUC,QAAQC,QAAQ;QAACH;KAAa;IACxC,OAAOE;AACX"}

package/operations/entry/elasticsearch/fields.d.ts

@@ -0,0 +1,14 @@
+import type { CmsModel, CmsModelField } from "@webiny/api-headless-cms/types/index.js";
+import { CmsModelFieldToGraphQLRegistry } from "@webiny/api-headless-cms/features/graphql/index.js";
+import { CmsEntryOpenSearchFieldIndexRegistry } from "../../../features/CmsEntryOpenSearchFieldIndex/index.js";
+interface ICreateModelFieldsParams {
+    model: CmsModel;
+    fieldRegistry: CmsModelFieldToGraphQLRegistry.Interface;
+    fieldIndexRegistry: CmsEntryOpenSearchFieldIndexRegistry.Interface;
+    /** Fields registered as `CmsEntrySystemField`, filterable under `system`. */
+    systemFields: CmsModelField[];
+}
+export declare const createModelFields: ({ model, fieldRegistry, fieldIndexRegistry, systemFields }: ICreateModelFieldsParams) => {
+    [x: string]: import("./types.js").ModelField;
+};
+export {};