aws-service-stack 0.18.449 → 0.18.451

package/dist/utils/opensearch/opensearch.mapping.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearMappingCache = exports.resolveSortFields = exports.applyKeywordSortFields = void 0;
+const KEYWORD_SUFFIX = ".keyword";
+/** One in-flight/resolved mapping lookup per index, for the lifetime of the container. */
+const mappingCache = new Map();
+/** Walk a dotted path such as `location.area` through nested `properties` blocks. */
+const findMappingNode = (properties, path) => {
+    const segments = path.split(".");
+    let node = properties[segments[0]];
+    for (const segment of segments.slice(1)) {
+        if (!node?.properties)
+            return undefined;
+        node = node.properties[segment];
+    }
+    return node;
+};
+/** The name of a keyword sub-field, if this node is a text field that has one. */
+const keywordSubField = (node) => {
+    if (node?.type !== "text" || !node.fields)
+        return undefined;
+    return Object.entries(node.fields).find(([, subField]) => subField?.type === "keyword")?.[0];
+};
+/**
+ * Rewrite sort entries that target an analysed `text` field onto its keyword sub-field.
+ *
+ * OpenSearch cannot sort on a `text` field (fielddata is disabled by default), so sorting on one
+ * fails the whole search. The correct target is decided from the index mapping rather than guessed:
+ * `keyword`, numeric and date fields are left alone, and an unknown field is left alone too, so a
+ * genuine mapping mistake still surfaces as a real error instead of being silently swallowed.
+ */
+const applyKeywordSortFields = (sort, properties) => {
+    if (!Array.isArray(sort) || sort.length === 0)
+        return [];
+    if (!properties)
+        return sort;
+    return sort.map((entry) => {
+        if (!entry || typeof entry !== "object")
+            return entry;
+        const [field, order] = Object.entries(entry)[0] ?? [];
+        if (typeof field !== "string" || field.endsWith(KEYWORD_SUFFIX))
+            return entry;
+        const subField = keywordSubField(findMappingNode(properties, field));
+        if (!subField)
+            return entry;
+        return { [`${field}.${subField}`]: order };
+    });
+};
+exports.applyKeywordSortFields = applyKeywordSortFields;
+const readMappingProperties = async (client, index) => {
+    const response = await client.indices.getMapping({ index });
+    const body = response?.body ?? response;
+    // getMapping is keyed by concrete index name, which may differ from the alias we asked for.
+    const indexBlock = body?.[index] ?? Object.values(body ?? {})[0];
+    return indexBlock?.mappings?.properties;
+};
+/**
+ * Resolve a query's sort fields against the live index mapping, caching the mapping per index.
+ *
+ * Fails open: if the mapping cannot be read the sort is returned untouched, so a mapping-service
+ * hiccup degrades to today's behaviour instead of breaking search.
+ */
+const resolveSortFields = async (client, index, sort) => {
+    if (!Array.isArray(sort) || sort.length === 0)
+        return sort;
+    if (!client?.indices?.getMapping || !index)
+        return sort;
+    try {
+        let pending = mappingCache.get(index);
+        if (!pending) {
+            pending = readMappingProperties(client, index).catch((err) => {
+                mappingCache.delete(index); // a failed lookup must not be cached forever
+                throw err;
+            });
+            mappingCache.set(index, pending);
+        }
+        const properties = await pending;
+        if (!properties)
+            return sort;
+        return (0, exports.applyKeywordSortFields)(sort, properties);
+    }
+    catch {
+        return sort;
+    }
+};
+exports.resolveSortFields = resolveSortFields;
+/** Exposed for tests and for callers that rebuild an index. */
+const clearMappingCache = (index) => {
+    if (index)
+        mappingCache.delete(index);
+    else
+        mappingCache.clear();
+};
+exports.clearMappingCache = clearMappingCache;
+//# sourceMappingURL=opensearch.mapping.js.map

package/dist/utils/opensearch/opensearch.mapping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opensearch.mapping.js","sourceRoot":"","sources":["../../../src/utils/opensearch/opensearch.mapping.ts"],"names":[],"mappings":";;;AAAA,MAAM,cAAc,GAAG,UAAU,CAAC;AAclC,0FAA0F;AAC1F,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkD,CAAC;AAE/E,qFAAqF;AACrF,MAAM,eAAe,GAAG,CAAC,UAA6B,EAAE,IAAY,EAA2B,EAAE;IAC/F,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,IAAI,GAA4B,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5D,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,IAAI,EAAE,UAAU;YAAE,OAAO,SAAS,CAAC;QACxC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,kFAAkF;AAClF,MAAM,eAAe,GAAG,CAAC,IAA6B,EAAsB,EAAE;IAC5E,IAAI,IAAI,EAAE,IAAI,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAE5D,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,IAAI,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC/F,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CAAC,IAAW,EAAE,UAA6B,EAAS,EAAE;IAC1F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACzD,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAE7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACxB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAEtD,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC;YAAE,OAAO,KAAK,CAAC;QAE9E,MAAM,QAAQ,GAAG,eAAe,CAAC,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC;QAE5B,OAAO,EAAE,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAfW,QAAA,sBAAsB,GAAtB,sBAAsB,CAejC;AAEF,MAAM,qBAAqB,GAAG,KAAK,EAAE,MAAqB,EAAE,KAAa,EAA0C,EAAE;IACnH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAG,QAAQ,EAAE,IAAI,IAAI,QAAQ,CAAC;IAExC,4FAA4F;IAC5F,MAAM,UAAU,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjE,OAAQ,UAAkB,EAAE,QAAQ,EAAE,UAAU,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,KAAK,EAAE,MAAqB,EAAE,KAAa,EAAE,IAAW,EAAkB,EAAE;IAC3G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3D,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExD,IAAI,CAAC;QACH,IAAI,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3D,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,6CAA6C;gBACzE,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC,CAAC;YACH,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC;QACjC,IAAI,CAAC,UAAU;YAAE,OAAO,IAAI,CAAC;QAE7B,OAAO,IAAA,QAAA,sBAAsB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAtBW,QAAA,iBAAiB,GAAjB,iBAAiB,CAsB5B;AAEF,+DAA+D;AACxD,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAQ,EAAE;IACxD,IAAI,KAAK;QAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;;QACjC,YAAY,CAAC,KAAK,EAAE,CAAC;AAC5B,CAAC,CAAC;AAHW,QAAA,iBAAiB,GAAjB,iBAAiB,CAG5B","sourcesContent":["const KEYWORD_SUFFIX = \".keyword\";\n\ntype MappingNode = {\n  type?: string;\n  fields?: Record<string, { type?: string }>;\n  properties?: Record<string, MappingNode>;\n};\n\ntype MappingProperties = Record<string, MappingNode>;\n\ntype MappingClient = {\n  indices: { getMapping: (params: { index: string }) => Promise<any> };\n};\n\n/** One in-flight/resolved mapping lookup per index, for the lifetime of the container. */\nconst mappingCache = new Map<string, Promise<MappingProperties | undefined>>();\n\n/** Walk a dotted path such as `location.area` through nested `properties` blocks. */\nconst findMappingNode = (properties: MappingProperties, path: string): MappingNode | undefined => {\n  const segments = path.split(\".\");\n  let node: MappingNode | undefined = properties[segments[0]];\n\n  for (const segment of segments.slice(1)) {\n    if (!node?.properties) return undefined;\n    node = node.properties[segment];\n  }\n\n  return node;\n};\n\n/** The name of a keyword sub-field, if this node is a text field that has one. */\nconst keywordSubField = (node: MappingNode | undefined): string | undefined => {\n  if (node?.type !== \"text\" || !node.fields) return undefined;\n\n  return Object.entries(node.fields).find(([, subField]) => subField?.type === \"keyword\")?.[0];\n};\n\n/**\n * Rewrite sort entries that target an analysed `text` field onto its keyword sub-field.\n *\n * OpenSearch cannot sort on a `text` field (fielddata is disabled by default), so sorting on one\n * fails the whole search. The correct target is decided from the index mapping rather than guessed:\n * `keyword`, numeric and date fields are left alone, and an unknown field is left alone too, so a\n * genuine mapping mistake still surfaces as a real error instead of being silently swallowed.\n */\nexport const applyKeywordSortFields = (sort: any[], properties: MappingProperties): any[] => {\n  if (!Array.isArray(sort) || sort.length === 0) return [];\n  if (!properties) return sort;\n\n  return sort.map((entry) => {\n    if (!entry || typeof entry !== \"object\") return entry;\n\n    const [field, order] = Object.entries(entry)[0] ?? [];\n    if (typeof field !== \"string\" || field.endsWith(KEYWORD_SUFFIX)) return entry;\n\n    const subField = keywordSubField(findMappingNode(properties, field));\n    if (!subField) return entry;\n\n    return { [`${field}.${subField}`]: order };\n  });\n};\n\nconst readMappingProperties = async (client: MappingClient, index: string): Promise<MappingProperties | undefined> => {\n  const response = await client.indices.getMapping({ index });\n  const body = response?.body ?? response;\n\n  // getMapping is keyed by concrete index name, which may differ from the alias we asked for.\n  const indexBlock = body?.[index] ?? Object.values(body ?? {})[0];\n\n  return (indexBlock as any)?.mappings?.properties;\n};\n\n/**\n * Resolve a query's sort fields against the live index mapping, caching the mapping per index.\n *\n * Fails open: if the mapping cannot be read the sort is returned untouched, so a mapping-service\n * hiccup degrades to today's behaviour instead of breaking search.\n */\nexport const resolveSortFields = async (client: MappingClient, index: string, sort: any[]): Promise<any[]> => {\n  if (!Array.isArray(sort) || sort.length === 0) return sort;\n  if (!client?.indices?.getMapping || !index) return sort;\n\n  try {\n    let pending = mappingCache.get(index);\n\n    if (!pending) {\n      pending = readMappingProperties(client, index).catch((err) => {\n        mappingCache.delete(index); // a failed lookup must not be cached forever\n        throw err;\n      });\n      mappingCache.set(index, pending);\n    }\n\n    const properties = await pending;\n    if (!properties) return sort;\n\n    return applyKeywordSortFields(sort, properties);\n  } catch {\n    return sort;\n  }\n};\n\n/** Exposed for tests and for callers that rebuild an index. */\nexport const clearMappingCache = (index?: string): void => {\n  if (index) mappingCache.delete(index);\n  else mappingCache.clear();\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-service-stack",
-  "version": "0.18.449",
+  "version": "0.18.451",
   "packageManager": "pnpm@10.33.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=24"
   },
   "scripts": {
     "check": "tsc --noEmit",
@@ -33,19 +33,19 @@
     "reflect-metadata": "^0.2.2"
   },
   "peerDependencies": {
-    "@aws-sdk/client-apigatewaymanagementapi": "^3.1111.0",
-    "@aws-sdk/client-cognito-identity-provider": "^3.1111.0",
-    "@aws-sdk/client-dynamodb": "^3.1111.0",
-    "@aws-sdk/client-secrets-manager": "^3.1111.0",
-    "@aws-sdk/credential-provider-node": "^3.972.80",
-    "@aws-sdk/lib-dynamodb": "^3.1111.0",
+    "@aws-sdk/client-apigatewaymanagementapi": "^3.1167.0",
+    "@aws-sdk/client-cognito-identity-provider": "^3.1167.0",
+    "@aws-sdk/client-dynamodb": "^3.1167.0",
+    "@aws-sdk/client-secrets-manager": "^3.1167.0",
+    "@aws-sdk/credential-provider-node": "^3.972.97",
+    "@aws-sdk/lib-dynamodb": "^3.1167.0",
     "@aws-sdk/util-dynamodb": "^3.996.9",
-    "@opensearch-project/opensearch": "^3.6.0",
-    "axios": "^1.19.0",
-    "dayjs": "^1.11.21",
+    "@opensearch-project/opensearch": "^3.10.0",
+    "axios": "^1.21.1",
+    "dayjs": "^1.11.23",
     "typedi": "0.10.0",
     "yup": "^1.7.1",
-    "zod": "^4.3.6"
+    "zod": "^4.6.7"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/client-apigatewaymanagementapi": {
@@ -89,27 +89,27 @@
     }
   },
   "devDependencies": {
-    "@aws-sdk/client-apigatewaymanagementapi": "^3.1111.0",
-    "@aws-sdk/client-cognito-identity-provider": "^3.1111.0",
-    "@aws-sdk/client-dynamodb": "^3.1111.0",
-    "@aws-sdk/client-secrets-manager": "^3.1111.0",
-    "@aws-sdk/credential-provider-node": "^3.972.80",
-    "@aws-sdk/lib-dynamodb": "^3.1111.0",
+    "@aws-sdk/client-apigatewaymanagementapi": "^3.1167.0",
+    "@aws-sdk/client-cognito-identity-provider": "^3.1167.0",
+    "@aws-sdk/client-dynamodb": "^3.1167.0",
+    "@aws-sdk/client-secrets-manager": "^3.1167.0",
+    "@aws-sdk/credential-provider-node": "^3.972.97",
+    "@aws-sdk/lib-dynamodb": "^3.1167.0",
     "@aws-sdk/util-dynamodb": "^3.996.9",
-    "@biomejs/biome": "^2.5.8",
-    "@opensearch-project/opensearch": "^3.6.0",
-    "@types/aws-lambda": "^8.10.162",
-    "@types/node": "^20.19.43",
-    "@vitest/coverage-v8": "^4.1.10",
-    "axios": "^1.19.0",
-    "dayjs": "^1.11.21",
+    "@biomejs/biome": "^2.6.7",
+    "@opensearch-project/opensearch": "^3.10.0",
+    "@types/aws-lambda": "^8.10.164",
+    "@types/node": "^24.19.2",
+    "@vitest/coverage-v8": "^5.1.0",
+    "axios": "^1.21.1",
+    "dayjs": "^1.11.23",
     "ts-node": "^10.9.2",
-    "tsc-alias": "^1.9.1",
+    "tsc-alias": "^1.9.10",
     "typedi": "0.10.0",
     "typescript": "^7.0.2",
     "typescript-transform-paths": "^4.0.0",
-    "vitest": "^4.1.10",
+    "vitest": "^5.1.0",
     "yup": "^1.7.1",
-    "zod": "^4.3.6"
+    "zod": "^4.6.7"
   }
 }