@webiny/api-headless-cms-utils-os 6.6.0-alpha.0

package/operations/entry/elasticsearch/initialQuery.js

@@ -0,0 +1,45 @@
+import error from "@webiny/error";
+import { createLatestRecordType, createPublishedRecordType } from "../recordType.js";
+import { isSharedOpenSearchIndex } from "@webiny/api-opensearch";
+const createBaseQuery = ()=>({
+        must: [],
+        must_not: [],
+        should: [],
+        filter: []
+    });
+const createInitialQuery = (params)=>{
+    const { model, where } = params;
+    const query = createBaseQuery();
+    const sharedIndex = isSharedOpenSearchIndex();
+    if (sharedIndex) {
+        query.filter.push({
+            term: {
+                "tenant.keyword": model.tenant
+            }
+        });
+        query.filter.push({
+            term: {
+                "modelId.keyword": model.modelId
+            }
+        });
+    }
+    if (true === where.published) query.filter.push({
+        term: {
+            "__type.keyword": createPublishedRecordType()
+        }
+    });
+    else if (true === where.latest) query.filter.push({
+        term: {
+            "__type.keyword": createLatestRecordType()
+        }
+    });
+    else throw new error('Cannot call Elasticsearch query when not setting "published" or "latest".', "OPENSEARCH_UNSUPPORTED_QUERY", {
+        where
+    });
+    delete where.published;
+    delete where.latest;
+    return query;
+};
+export { createBaseQuery, createInitialQuery };
+
+//# sourceMappingURL=initialQuery.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/initialQuery.js","sources":["../../../../src/operations/entry/elasticsearch/initialQuery.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport type { OpenSearchBoolQueryConfig } from \"@webiny/api-opensearch/types.js\";\nimport type { CmsEntryListWhere, CmsModel } from \"@webiny/api-headless-cms/types/index.js\";\nimport { createLatestRecordType, createPublishedRecordType } from \"../recordType.js\";\nimport { isSharedOpenSearchIndex as isSharedElasticsearchIndex } from \"@webiny/api-opensearch\";\n\nexport const createBaseQuery = (): OpenSearchBoolQueryConfig => {\n    return {\n        must: [],\n        must_not: [],\n        should: [],\n        filter: []\n    };\n};\n\ninterface Params {\n    model: CmsModel;\n    where: CmsEntryListWhere;\n}\n/**\n * Latest and published are specific in Elasticsearch to that extend that they are tagged in the __type property.\n * We allow either published or either latest.\n * Latest is used in the manage API and published in the read API.\n *\n *\n * We add the query.filter terms because we do not need scored search here and it is a bit faster.\n */\nexport const createInitialQuery = (params: Params): OpenSearchBoolQueryConfig => {\n    const { model, where } = params;\n\n    const query = createBaseQuery();\n\n    /**\n     * When ES index is shared between tenants, we need to filter records by tenant ID\n     *\n     * TODO determine if we want to search across tenants in shared index?\n     */\n    const sharedIndex = isSharedElasticsearchIndex();\n    if (sharedIndex) {\n        /**\n         * Tenant for the filtering is taken from the model.\n         *\n         * TODO determine if we want to send it in the \"where\" parameter?\n         */\n        query.filter.push({\n            term: {\n                \"tenant.keyword\": model.tenant\n            }\n        });\n        /**\n         * Also, we must search only in selected model.\n         */\n        query.filter.push({\n            term: {\n                \"modelId.keyword\": model.modelId\n            }\n        });\n    }\n\n    /**\n     * We must transform published and latest where args into something that is understandable by our Elasticsearch\n     */\n    if (where.published === true) {\n        query.filter.push({\n            term: {\n                \"__type.keyword\": createPublishedRecordType()\n            }\n        });\n    } else if (where.latest === true) {\n        query.filter.push({\n            term: {\n                \"__type.keyword\": createLatestRecordType()\n            }\n        });\n    }\n    //\n    /**\n     * We do not allow filtering without the published or latest parameter.\n     * Also, we do not want to set the default one, as there is a large possibility for user error when filtering.\n     */\n    else {\n        throw new WebinyError(\n            `Cannot call Elasticsearch query when not setting \"published\" or \"latest\".`,\n            \"OPENSEARCH_UNSUPPORTED_QUERY\",\n            {\n                where\n            }\n        );\n    }\n    /**\n     * We need to remove fields that actually do not exist on the record - it will break otherwise.\n     * This will modify the original object, which is what we want.\n     */\n    delete where.published;\n    delete where.latest;\n\n    return query;\n};\n"],"names":["createBaseQuery","createInitialQuery","params","model","where","query","sharedIndex","isSharedElasticsearchIndex","createPublishedRecordType","createLatestRecordType","WebinyError"],"mappings":";;;AAMO,MAAMA,kBAAkB,IACpB;QACH,MAAM,EAAE;QACR,UAAU,EAAE;QACZ,QAAQ,EAAE;QACV,QAAQ,EAAE;IACd;AAeG,MAAMC,qBAAqB,CAACC;IAC/B,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAE,GAAGF;IAEzB,MAAMG,QAAQL;IAOd,MAAMM,cAAcC;IACpB,IAAID,aAAa;QAMbD,MAAM,MAAM,CAAC,IAAI,CAAC;YACd,MAAM;gBACF,kBAAkBF,MAAM,MAAM;YAClC;QACJ;QAIAE,MAAM,MAAM,CAAC,IAAI,CAAC;YACd,MAAM;gBACF,mBAAmBF,MAAM,OAAO;YACpC;QACJ;IACJ;IAKA,IAAIC,AAAoB,SAApBA,MAAM,SAAS,EACfC,MAAM,MAAM,CAAC,IAAI,CAAC;QACd,MAAM;YACF,kBAAkBG;QACtB;IACJ;SACG,IAAIJ,AAAiB,SAAjBA,MAAM,MAAM,EACnBC,MAAM,MAAM,CAAC,IAAI,CAAC;QACd,MAAM;YACF,kBAAkBI;QACtB;IACJ;SAQA,MAAM,IAAIC,MACN,6EACA,gCACA;QACIN;IACJ;IAOR,OAAOA,MAAM,SAAS;IACtB,OAAOA,MAAM,MAAM;IAEnB,OAAOC;AACX"}

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

@@ -0,0 +1,2 @@
+import type { ModelField } from "./types.js";
+export declare const hasKeyword: (field: ModelField) => boolean;

package/operations/entry/elasticsearch/keyword.js

@@ -0,0 +1,17 @@
+import { getBaseFieldType } from "@webiny/api-headless-cms/utils/getBaseFieldType.js";
+const noKeywordFields = [
+    "date",
+    "datetime",
+    "number",
+    "boolean"
+];
+const hasKeyword = (field)=>{
+    const fieldType = getBaseFieldType(field);
+    if (noKeywordFields.includes(fieldType)) return false;
+    if (field.unmappedType) return false;
+    if (false === field.keyword) return false;
+    return true;
+};
+export { hasKeyword };
+
+//# sourceMappingURL=keyword.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/keyword.js","sources":["../../../../src/operations/entry/elasticsearch/keyword.ts"],"sourcesContent":["import type { ModelField } from \"./types.js\";\nimport { getBaseFieldType } from \"@webiny/api-headless-cms/utils/getBaseFieldType.js\";\n\nconst noKeywordFields: string[] = [\"date\", \"datetime\", \"number\", \"boolean\"];\nexport const hasKeyword = (field: ModelField): boolean => {\n    const fieldType = getBaseFieldType(field);\n    /**\n     * We defined some field types that MUST have no keyword added to the field path\n     */\n    if (noKeywordFields.includes(fieldType)) {\n        return false;\n    }\n    /**\n     * If field has unmapped type defined, do not add keyword.\n     */\n    //\n    else if (field.unmappedType) {\n        return false;\n    }\n    /**\n     * And if specifically defined that field has no keyword, do not add it.\n     */\n    //\n    else if (field.keyword === false) {\n        return false;\n    }\n    /**\n     * All other fields have keyword added.\n     */\n    return true;\n};\n"],"names":["noKeywordFields","hasKeyword","field","fieldType","getBaseFieldType"],"mappings":";AAGA,MAAMA,kBAA4B;IAAC;IAAQ;IAAY;IAAU;CAAU;AACpE,MAAMC,aAAa,CAACC;IACvB,MAAMC,YAAYC,iBAAiBF;IAInC,IAAIF,gBAAgB,QAAQ,CAACG,YACzB,OAAO;IAMN,IAAID,MAAM,YAAY,EACvB,OAAO;IAMN,IAAIA,AAAkB,UAAlBA,MAAM,OAAO,EAClB,OAAO;IAKX,OAAO;AACX"}

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

@@ -0,0 +1,2 @@
+import type WebinyError from "@webiny/error";
+export declare const shouldIgnoreEsResponseError: (error: WebinyError) => boolean;

package/operations/entry/elasticsearch/shouldIgnoreEsResponseError.js

@@ -0,0 +1,8 @@
+const IGNORED_ES_SEARCH_EXCEPTIONS = [
+    "index_not_found_exception",
+    "search_phase_execution_exception"
+];
+const shouldIgnoreEsResponseError = (error)=>IGNORED_ES_SEARCH_EXCEPTIONS.some((ignoredMessage)=>error.message.includes(ignoredMessage));
+export { shouldIgnoreEsResponseError };
+
+//# sourceMappingURL=shouldIgnoreEsResponseError.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/elasticsearch/shouldIgnoreEsResponseError.js","sources":["../../../../src/operations/entry/elasticsearch/shouldIgnoreEsResponseError.ts"],"sourcesContent":["import type WebinyError from \"@webiny/error\";\n\nconst IGNORED_ES_SEARCH_EXCEPTIONS = [\n    \"index_not_found_exception\",\n    \"search_phase_execution_exception\"\n];\n\nexport const shouldIgnoreEsResponseError = (error: WebinyError) => {\n    return IGNORED_ES_SEARCH_EXCEPTIONS.some(ignoredMessage =>\n        error.message.includes(ignoredMessage)\n    );\n};\n"],"names":["IGNORED_ES_SEARCH_EXCEPTIONS","shouldIgnoreEsResponseError","error","ignoredMessage"],"mappings":"AAEA,MAAMA,+BAA+B;IACjC;IACA;CACH;AAEM,MAAMC,8BAA8B,CAACC,QACjCF,6BAA6B,IAAI,CAACG,CAAAA,iBACrCD,MAAM,OAAO,CAAC,QAAQ,CAACC"}

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

@@ -0,0 +1,31 @@
+import type { OpenSearchQueryBuilderOperator } from "@webiny/api-opensearch/exports/api/opensearch.js";
+import type { CmsModelField } from "@webiny/api-headless-cms/types/index.js";
+/**
+ * ./fields
+ */
+type ModelFieldPath = string | ((value: string) => string);
+export type FieldType = "text" | "date" | "datetime" | "time" | "number" | "boolean" | string;
+export interface ModelFieldParent {
+    fieldId: string;
+    storageId: string;
+    type: FieldType;
+}
+export interface ModelField {
+    unmappedType?: string;
+    keyword?: boolean;
+    searchable: boolean;
+    sortable: boolean;
+    type: FieldType;
+    systemField?: boolean;
+    field: CmsModelField;
+    path?: ModelFieldPath;
+    fullTextSearch?: boolean;
+    parents: ModelFieldParent[];
+}
+export interface ModelFields {
+    [fieldId: string]: ModelField;
+}
+export interface OpenSearchQueryBuilderOperators {
+    [key: string]: OpenSearchQueryBuilderOperator.Interface;
+}
+export {};

package/operations/entry/recordType.d.ts

@@ -0,0 +1,3 @@
+export declare const createRecordType: () => string;
+export declare const createLatestRecordType: () => string;
+export declare const createPublishedRecordType: () => string;

package/operations/entry/recordType.js

@@ -0,0 +1,6 @@
+const createRecordType = ()=>"cms.entry";
+const createLatestRecordType = ()=>`${createRecordType()}.l`;
+const createPublishedRecordType = ()=>`${createRecordType()}.p`;
+export { createLatestRecordType, createPublishedRecordType, createRecordType };
+
+//# sourceMappingURL=recordType.js.map

package/operations/entry/recordType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/recordType.js","sources":["../../../src/operations/entry/recordType.ts"],"sourcesContent":["export const createRecordType = (): string => {\n    return \"cms.entry\";\n};\nexport const createLatestRecordType = (): string => {\n    return `${createRecordType()}.l`;\n};\nexport const createPublishedRecordType = (): string => {\n    return `${createRecordType()}.p`;\n};\n"],"names":["createRecordType","createLatestRecordType","createPublishedRecordType"],"mappings":"AAAO,MAAMA,mBAAmB,IACrB;AAEJ,MAAMC,yBAAyB,IAC3B,GAAGD,mBAAmB,EAAE,CAAC;AAE7B,MAAME,4BAA4B,IAC9B,GAAGF,mBAAmB,EAAE,CAAC"}

package/operations/entry/transformations/transformEntryToIndex.d.ts

@@ -0,0 +1,10 @@
+import type { CmsEntry, CmsEntryValues, CmsStorageEntry, StorageOperationsCmsModel } from "@webiny/api-headless-cms/types/index.js";
+import type { CmsEntryOpenSearchFieldIndexRegistry } from "../../../features/CmsEntryOpenSearchFieldIndex/index.js";
+interface TransformEntryToIndexParams<T extends CmsEntryValues = CmsEntryValues> {
+    model: StorageOperationsCmsModel<T>;
+    entry: CmsEntry<T>;
+    storageEntry: CmsStorageEntry<T>;
+    fieldIndexRegistry: CmsEntryOpenSearchFieldIndexRegistry.Interface;
+}
+export declare const transformEntryToIndex: <T extends CmsEntryValues = CmsEntryValues>(params: TransformEntryToIndexParams<T>) => import("../../../types").CmsIndexEntry<T>;
+export {};

package/operations/entry/transformations/transformEntryToIndex.js

@@ -0,0 +1,20 @@
+import { prepareEntryToIndex } from "../../../helpers/index.js";
+const transformEntryToIndex = (params)=>{
+    const { model, entry, storageEntry, fieldIndexRegistry } = params;
+    const result = prepareEntryToIndex({
+        model,
+        entry: structuredClone(entry),
+        storageEntry: structuredClone(storageEntry),
+        fieldIndexRegistry
+    });
+    delete result["PK"];
+    delete result["SK"];
+    delete result["GSI1_PK"];
+    delete result["GSI1_SK"];
+    delete result["published"];
+    delete result["latest"];
+    return result;
+};
+export { transformEntryToIndex };
+
+//# sourceMappingURL=transformEntryToIndex.js.map

package/operations/entry/transformations/transformEntryToIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations/entry/transformations/transformEntryToIndex.js","sources":["../../../../src/operations/entry/transformations/transformEntryToIndex.ts"],"sourcesContent":["import type {\n    CmsEntry,\n    CmsEntryValues,\n    CmsStorageEntry,\n    StorageOperationsCmsModel\n} from \"@webiny/api-headless-cms/types/index.js\";\nimport { prepareEntryToIndex } from \"~/helpers/index.js\";\nimport type { CmsEntryOpenSearchFieldIndexRegistry } from \"~/features/CmsEntryOpenSearchFieldIndex/index.js\";\n\ninterface TransformEntryToIndexParams<T extends CmsEntryValues = CmsEntryValues> {\n    model: StorageOperationsCmsModel<T>;\n    entry: CmsEntry<T>;\n    storageEntry: CmsStorageEntry<T>;\n    fieldIndexRegistry: CmsEntryOpenSearchFieldIndexRegistry.Interface;\n}\n\nexport const transformEntryToIndex = <T extends CmsEntryValues = CmsEntryValues>(\n    params: TransformEntryToIndexParams<T>\n) => {\n    const { model, entry, storageEntry, fieldIndexRegistry } = params;\n    const result = prepareEntryToIndex<T>({\n        model,\n        entry: structuredClone(entry),\n        storageEntry: structuredClone(storageEntry),\n        fieldIndexRegistry\n    });\n\n    delete result[\"PK\"];\n    delete result[\"SK\"];\n    delete result[\"GSI1_PK\"];\n    delete result[\"GSI1_SK\"];\n    delete result[\"published\"];\n    delete result[\"latest\"];\n\n    return result;\n};\n"],"names":["transformEntryToIndex","params","model","entry","storageEntry","fieldIndexRegistry","result","prepareEntryToIndex","structuredClone"],"mappings":";AAgBO,MAAMA,wBAAwB,CACjCC;IAEA,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,YAAY,EAAEC,kBAAkB,EAAE,GAAGJ;IAC3D,MAAMK,SAASC,oBAAuB;QAClCL;QACA,OAAOM,gBAAgBL;QACvB,cAAcK,gBAAgBJ;QAC9BC;IACJ;IAEA,OAAOC,MAAM,CAAC,KAAK;IACnB,OAAOA,MAAM,CAAC,KAAK;IACnB,OAAOA,MAAM,CAAC,UAAU;IACxB,OAAOA,MAAM,CAAC,UAAU;IACxB,OAAOA,MAAM,CAAC,YAAY;IAC1B,OAAOA,MAAM,CAAC,SAAS;IAEvB,OAAOA;AACX"}

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "@webiny/api-headless-cms-utils-os",
+	"version": "6.6.0-alpha.0",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-headless-cms-utils-os"
+	},
+	"description": "Shared OpenSearch query infrastructure for Headless CMS storage packages.",
+	"license": "MIT",
+	"author": "Webiny Ltd.",
+	"dependencies": {
+		"@webiny/api-headless-cms": "6.6.0-alpha.0",
+		"@webiny/api-opensearch": "6.6.0-alpha.0",
+		"@webiny/error": "6.6.0-alpha.0",
+		"@webiny/feature": "6.6.0-alpha.0"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "6.6.0-alpha.0",
+		"typescript": "7.0.2"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/types.d.ts

@@ -0,0 +1,5 @@
+import type { CmsEntry, CmsEntryValues } from "@webiny/api-headless-cms/types/index.js";
+export interface CmsIndexEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {
+    rawValues: Partial<T>;
+    [key: string]: any;
+}

package/values/NoValueContainer.d.ts

@@ -0,0 +1,5 @@
+export declare class NoValueContainer {
+    private constructor();
+    static create(): NoValueContainer;
+    static is(value: unknown): boolean;
+}

package/values/NoValueContainer.js

@@ -0,0 +1,11 @@
+class NoValueContainer {
+    static create() {
+        return new NoValueContainer();
+    }
+    static is(value) {
+        return value instanceof NoValueContainer;
+    }
+}
+export { NoValueContainer };
+
+//# sourceMappingURL=NoValueContainer.js.map

package/values/NoValueContainer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"values/NoValueContainer.js","sources":["../../src/values/NoValueContainer.ts"],"sourcesContent":["export class NoValueContainer {\n    private constructor() {\n        //\n    }\n\n    public static create(): NoValueContainer {\n        return new NoValueContainer();\n    }\n\n    public static is(value: unknown): boolean {\n        return value instanceof NoValueContainer;\n    }\n}\n"],"names":["NoValueContainer","value"],"mappings":"AAAO,MAAMA;IAKT,OAAc,SAA2B;QACrC,OAAO,IAAIA;IACf;IAEA,OAAc,GAAGC,KAAc,EAAW;QACtC,OAAOA,iBAAiBD;IAC5B;AACJ"}