@twin.org/context 0.9.1 → 0.9.2-next.2

package/dist/es/helpers/contextIdHelper.js

@@ -60,6 +60,39 @@ export class ContextIdHelper {
             }
         }
     }
+    /**
+     * Gets the long version of a context ID, expanding from a short form if a handler is registered.
+     * @param contextIds The context IDs to get the long version from.
+     * @param key The context ID key to get the long version for.
+     * @returns The long version of the context ID.
+     * @throws Guard error if the value is invalid.
+     */
+    static long(contextIds, key) {
+        Guards.stringValue(ContextIdHelper.CLASS_NAME, "key", key);
+        if (Is.undefined(contextIds?.[key])) {
+            throw new GeneralError(ContextIdHelper.CLASS_NAME, "contextIdMissing", { key });
+        }
+        const handler = ContextIdHandlerFactory.getIfExists(key);
+        if (handler?.long) {
+            return handler.long(contextIds[key]);
+        }
+        return contextIds[key];
+    }
+    /**
+     * Gets the long versions of multiple context IDs.
+     * @param contextIds The context IDs to get the long versions from.
+     * @param keys The context ID keys to get the long versions for.
+     * @returns The long versions of the context IDs.
+     */
+    static longAll(contextIds, keys) {
+        const long = {};
+        if (Is.arrayValue(keys)) {
+            for (const key of keys) {
+                long[key] = ContextIdHelper.long(contextIds, key);
+            }
+        }
+        return long;
+    }
     /**
      * Gets the short versions of multiple context IDs.
      * @param contextIds The context IDs to get the short versions from.

package/dist/es/helpers/contextIdHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"contextIdHelper.js","sourceRoot":"","sources":["../../../src/helpers/contextIdHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAGlF;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;OAEG;IACI,MAAM,CAAU,UAAU,qBAAqC;IAEtE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAClB,UAAyB,EACzB,GAAM;QAEN,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjE,IAAI,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,EAAE,cAAc,GAAG,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,UAAmC,EAAE,GAAW;QACnE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CACrB,UAAyB,EACzB,IAA8B;QAE9B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CACrB,UAAmC,EACnC,IAA0B;QAE1B,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,KAAK,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACrD,CAAC;QACF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAC1B,UAAmC,EACnC,IAA0B,EAC1B,YAAoB,GAAG;QAEvB,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,UAAU,CAAC,IAAc,EAAE,QAAgB,EAAE,YAAoB,GAAG;QACjF,MAAM,CAAC,UAAU,CAAS,eAAe,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC1E,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,MAAM,GAAgB,EAAE,CAAC;QAE/B,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAClC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,wBAAwB,EAAE;gBAC5E,QAAQ,EAAE,IAAI,CAAC,MAAM;gBACrB,MAAM,EAAE,KAAK,CAAC,MAAM;aACpB,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAC/B,UAAmC,EACnC,IAA0B,EAC1B,YAAoB,GAAG;QAEvB,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAE3C,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAEzD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAAC,aAAwB,EAAE,WAAsB;QACnF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAClE,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { ContextIdHandlerFactory } from \"../factories/contextIdHandlerFactory.js\";\nimport type { IContextIds } from \"../models/IContextIds.js\";\n\n/**\n * Class to help with context IDs.\n */\nexport class ContextIdHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ContextIdHelper>();\n\n\t/**\n\t * Perform a runtime guard on the provided context ID value.\n\t * @param contextIds The context IDs to guard.\n\t * @param key The context ID key to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static guard<T extends { [k: string]: string | undefined }, K extends string>(\n\t\tcontextIds: T | undefined,\n\t\tkey: K\n\t): asserts contextIds is T & { [P in K]: string } {\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(key), key);\n\n\t\tif (Is.undefined(contextIds?.[key])) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdMissing\", { key });\n\t\t}\n\n\t\tconst handler = ContextIdHandlerFactory.getIfExists(key);\n\t\tif (handler?.guard) {\n\t\t\thandler.guard(contextIds[key]);\n\t\t} else {\n\t\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, `contextIds.${key}`, contextIds[key]);\n\t\t}\n\t}\n\n\t/**\n\t * Gets the short version of a context ID.\n\t * @param contextIds The context IDs to get the short version from.\n\t * @param key The context ID key to get the short version for.\n\t * @returns The short version of the context ID.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static short(contextIds: IContextIds | undefined, key: string): string {\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(key), key);\n\t\tif (Is.undefined(contextIds?.[key])) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdMissing\", { key });\n\t\t}\n\n\t\tconst handler = ContextIdHandlerFactory.getIfExists(key);\n\t\tif (handler?.short) {\n\t\t\treturn handler.short(contextIds[key]);\n\t\t}\n\t\treturn contextIds[key];\n\t}\n\n\t/**\n\t * Perform a runtime guard on the provided context ID values.\n\t * @param contextIds The context IDs to guard.\n\t * @param keys The context ID keys to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static guardAll<T extends { [k: string]: string | undefined }, K extends string>(\n\t\tcontextIds: T | undefined,\n\t\tkeys: readonly K[] | undefined\n\t): asserts contextIds is T & { [P in K]: string } {\n\t\tif (Is.arrayValue(keys)) {\n\t\t\tfor (const key of keys) {\n\t\t\t\tContextIdHelper.guard(contextIds, key);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Gets the short versions of multiple context IDs.\n\t * @param contextIds The context IDs to get the short versions from.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @returns The short versions of the context IDs.\n\t */\n\tpublic static shortAll(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined\n\t): IContextIds {\n\t\tconst short: IContextIds = {};\n\t\tif (Is.arrayValue(keys)) {\n\t\t\tfor (const key of keys) {\n\t\t\t\tshort[key] = ContextIdHelper.short(contextIds, key);\n\t\t\t}\n\t\t}\n\t\treturn short;\n\t}\n\n\t/**\n\t * Gets the combined short version.\n\t * @param contextIds The context IDs to get the short versions from.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param separator The separator to use between parts.\n\t * @returns The short version combined.\n\t */\n\tpublic static shortCombined(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined,\n\t\tseparator: string = \"/\"\n\t): string | undefined {\n\t\tconst short = ContextIdHelper.shortAll(contextIds, keys);\n\t\tif (Object.keys(short).length === 0) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn Object.values(short).join(separator);\n\t}\n\n\t/**\n\t * Split a combined short version in to the separate context IDs.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param combined The combined short version to separate.\n\t * @param separator The separator used between parts.\n\t * @returns The short version combined.\n\t * @throws GeneralError if the number of parts does not match the number of keys.\n\t */\n\tpublic static shortSplit(keys: string[], combined: string, separator: string = \"/\"): IContextIds {\n\t\tGuards.arrayValue<string>(ContextIdHelper.CLASS_NAME, nameof(keys), keys);\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(combined), combined);\n\n\t\tconst parts = combined.split(separator);\n\t\tconst result: IContextIds = {};\n\n\t\tif (parts.length !== keys.length) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdSplitMismatch\", {\n\t\t\t\texpected: keys.length,\n\t\t\t\tactual: parts.length\n\t\t\t});\n\t\t}\n\n\t\tfor (let i = 0; i < keys.length; i++) {\n\t\t\tresult[keys[i]] = parts[i];\n\t\t}\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Create a combined key.\n\t * @param contextIds The context IDs to create the combined key for.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param separator The separator to use between parts.\n\t * @returns The short version combined.\n\t */\n\tpublic static combinedContextKey(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined,\n\t\tseparator: string = \"/\"\n\t): string | undefined {\n\t\tContextIdHelper.guardAll(contextIds, keys);\n\n\t\tconst short = ContextIdHelper.shortAll(contextIds, keys);\n\n\t\tif (Object.keys(short).length === 0) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\treturn Object.values(short).join(separator);\n\t}\n\n\t/**\n\t * Pick only the desired keys from the available keys.\n\t * @param availableKeys The available keys to pick from.\n\t * @param desiredKeys The desired keys to pick.\n\t * @returns The picked keys.\n\t */\n\tpublic static pickKeysFromAvailable(availableKeys?: string[], desiredKeys?: string[]): string[] {\n\t\tif (!Is.arrayValue(availableKeys) || !Is.arrayValue(desiredKeys)) {\n\t\t\treturn [];\n\t\t}\n\n\t\treturn desiredKeys.filter(key => availableKeys.includes(key));\n\t}\n}\n"]}
+{"version":3,"file":"contextIdHelper.js","sourceRoot":"","sources":["../../../src/helpers/contextIdHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAGlF;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;OAEG;IACI,MAAM,CAAU,UAAU,qBAAqC;IAEtE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAClB,UAAyB,EACzB,GAAM;QAEN,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjE,IAAI,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,EAAE,cAAc,GAAG,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,UAAmC,EAAE,GAAW;QACnE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CACrB,UAAyB,EACzB,IAA8B;QAE9B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,UAAmC,EAAE,GAAW;QAClE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,OAAO,EAAE,IAAI,EAAE,CAAC;YACnB,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CACpB,UAAmC,EACnC,IAA0B;QAE1B,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACnD,CAAC;QACF,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CACrB,UAAmC,EACnC,IAA0B;QAE1B,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,KAAK,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YACrD,CAAC;QACF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAC1B,UAAmC,EACnC,IAA0B,EAC1B,YAAoB,GAAG;QAEvB,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,UAAU,CAAC,IAAc,EAAE,QAAgB,EAAE,YAAoB,GAAG;QACjF,MAAM,CAAC,UAAU,CAAS,eAAe,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC1E,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,MAAM,GAAgB,EAAE,CAAC;QAE/B,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAClC,MAAM,IAAI,YAAY,CAAC,eAAe,CAAC,UAAU,EAAE,wBAAwB,EAAE;gBAC5E,QAAQ,EAAE,IAAI,CAAC,MAAM;gBACrB,MAAM,EAAE,KAAK,CAAC,MAAM;aACpB,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAC/B,UAAmC,EACnC,IAA0B,EAC1B,YAAoB,GAAG;QAEvB,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAE3C,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAEzD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAAC,aAAwB,EAAE,WAAsB;QACnF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAClE,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { ContextIdHandlerFactory } from \"../factories/contextIdHandlerFactory.js\";\nimport type { IContextIds } from \"../models/IContextIds.js\";\n\n/**\n * Class to help with context IDs.\n */\nexport class ContextIdHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ContextIdHelper>();\n\n\t/**\n\t * Perform a runtime guard on the provided context ID value.\n\t * @param contextIds The context IDs to guard.\n\t * @param key The context ID key to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static guard<T extends { [k: string]: string | undefined }, K extends string>(\n\t\tcontextIds: T | undefined,\n\t\tkey: K\n\t): asserts contextIds is T & { [P in K]: string } {\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(key), key);\n\n\t\tif (Is.undefined(contextIds?.[key])) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdMissing\", { key });\n\t\t}\n\n\t\tconst handler = ContextIdHandlerFactory.getIfExists(key);\n\t\tif (handler?.guard) {\n\t\t\thandler.guard(contextIds[key]);\n\t\t} else {\n\t\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, `contextIds.${key}`, contextIds[key]);\n\t\t}\n\t}\n\n\t/**\n\t * Gets the short version of a context ID.\n\t * @param contextIds The context IDs to get the short version from.\n\t * @param key The context ID key to get the short version for.\n\t * @returns The short version of the context ID.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static short(contextIds: IContextIds | undefined, key: string): string {\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(key), key);\n\t\tif (Is.undefined(contextIds?.[key])) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdMissing\", { key });\n\t\t}\n\n\t\tconst handler = ContextIdHandlerFactory.getIfExists(key);\n\t\tif (handler?.short) {\n\t\t\treturn handler.short(contextIds[key]);\n\t\t}\n\t\treturn contextIds[key];\n\t}\n\n\t/**\n\t * Perform a runtime guard on the provided context ID values.\n\t * @param contextIds The context IDs to guard.\n\t * @param keys The context ID keys to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static guardAll<T extends { [k: string]: string | undefined }, K extends string>(\n\t\tcontextIds: T | undefined,\n\t\tkeys: readonly K[] | undefined\n\t): asserts contextIds is T & { [P in K]: string } {\n\t\tif (Is.arrayValue(keys)) {\n\t\t\tfor (const key of keys) {\n\t\t\t\tContextIdHelper.guard(contextIds, key);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Gets the long version of a context ID, expanding from a short form if a handler is registered.\n\t * @param contextIds The context IDs to get the long version from.\n\t * @param key The context ID key to get the long version for.\n\t * @returns The long version of the context ID.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tpublic static long(contextIds: IContextIds | undefined, key: string): string {\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(key), key);\n\t\tif (Is.undefined(contextIds?.[key])) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdMissing\", { key });\n\t\t}\n\n\t\tconst handler = ContextIdHandlerFactory.getIfExists(key);\n\t\tif (handler?.long) {\n\t\t\treturn handler.long(contextIds[key]);\n\t\t}\n\t\treturn contextIds[key];\n\t}\n\n\t/**\n\t * Gets the long versions of multiple context IDs.\n\t * @param contextIds The context IDs to get the long versions from.\n\t * @param keys The context ID keys to get the long versions for.\n\t * @returns The long versions of the context IDs.\n\t */\n\tpublic static longAll(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined\n\t): IContextIds {\n\t\tconst long: IContextIds = {};\n\t\tif (Is.arrayValue(keys)) {\n\t\t\tfor (const key of keys) {\n\t\t\t\tlong[key] = ContextIdHelper.long(contextIds, key);\n\t\t\t}\n\t\t}\n\t\treturn long;\n\t}\n\n\t/**\n\t * Gets the short versions of multiple context IDs.\n\t * @param contextIds The context IDs to get the short versions from.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @returns The short versions of the context IDs.\n\t */\n\tpublic static shortAll(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined\n\t): IContextIds {\n\t\tconst short: IContextIds = {};\n\t\tif (Is.arrayValue(keys)) {\n\t\t\tfor (const key of keys) {\n\t\t\t\tshort[key] = ContextIdHelper.short(contextIds, key);\n\t\t\t}\n\t\t}\n\t\treturn short;\n\t}\n\n\t/**\n\t * Gets the combined short version.\n\t * @param contextIds The context IDs to get the short versions from.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param separator The separator to use between parts.\n\t * @returns The short version combined.\n\t */\n\tpublic static shortCombined(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined,\n\t\tseparator: string = \"/\"\n\t): string | undefined {\n\t\tconst short = ContextIdHelper.shortAll(contextIds, keys);\n\t\tif (Object.keys(short).length === 0) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn Object.values(short).join(separator);\n\t}\n\n\t/**\n\t * Split a combined short version in to the separate context IDs.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param combined The combined short version to separate.\n\t * @param separator The separator used between parts.\n\t * @returns The short version combined.\n\t * @throws GeneralError if the number of parts does not match the number of keys.\n\t */\n\tpublic static shortSplit(keys: string[], combined: string, separator: string = \"/\"): IContextIds {\n\t\tGuards.arrayValue<string>(ContextIdHelper.CLASS_NAME, nameof(keys), keys);\n\t\tGuards.stringValue(ContextIdHelper.CLASS_NAME, nameof(combined), combined);\n\n\t\tconst parts = combined.split(separator);\n\t\tconst result: IContextIds = {};\n\n\t\tif (parts.length !== keys.length) {\n\t\t\tthrow new GeneralError(ContextIdHelper.CLASS_NAME, \"contextIdSplitMismatch\", {\n\t\t\t\texpected: keys.length,\n\t\t\t\tactual: parts.length\n\t\t\t});\n\t\t}\n\n\t\tfor (let i = 0; i < keys.length; i++) {\n\t\t\tresult[keys[i]] = parts[i];\n\t\t}\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Create a combined key.\n\t * @param contextIds The context IDs to create the combined key for.\n\t * @param keys The context ID keys to get the short versions for.\n\t * @param separator The separator to use between parts.\n\t * @returns The short version combined.\n\t */\n\tpublic static combinedContextKey(\n\t\tcontextIds: IContextIds | undefined,\n\t\tkeys: string[] | undefined,\n\t\tseparator: string = \"/\"\n\t): string | undefined {\n\t\tContextIdHelper.guardAll(contextIds, keys);\n\n\t\tconst short = ContextIdHelper.shortAll(contextIds, keys);\n\n\t\tif (Object.keys(short).length === 0) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\treturn Object.values(short).join(separator);\n\t}\n\n\t/**\n\t * Pick only the desired keys from the available keys.\n\t * @param availableKeys The available keys to pick from.\n\t * @param desiredKeys The desired keys to pick.\n\t * @returns The picked keys.\n\t */\n\tpublic static pickKeysFromAvailable(availableKeys?: string[], desiredKeys?: string[]): string[] {\n\t\tif (!Is.arrayValue(availableKeys) || !Is.arrayValue(desiredKeys)) {\n\t\t\treturn [];\n\t\t}\n\n\t\treturn desiredKeys.filter(key => availableKeys.includes(key));\n\t}\n}\n"]}

package/dist/es/models/IContextIdHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"IContextIdHandler.js","sourceRoot":"","sources":["../../../src/models/IContextIdHandler.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing a context ID handler.\n */\nexport interface IContextIdHandler extends IComponent {\n\t/**\n\t * The short form version of the context ID, should be unique enough to partition data.\n\t * @param value The full context ID value.\n\t * @returns The short form version of the context ID.\n\t */\n\tshort?(value: string): string;\n\n\t/**\n\t * Performs a runtime guard on the provided context ID value.\n\t * @param value The context ID value to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tguard?(value: string): void;\n}\n"]}
+{"version":3,"file":"IContextIdHandler.js","sourceRoot":"","sources":["../../../src/models/IContextIdHandler.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing a context ID handler.\n */\nexport interface IContextIdHandler extends IComponent {\n\t/**\n\t * The short form version of the context ID, should be unique enough to partition data.\n\t * @param value The full context ID value.\n\t * @returns The short form version of the context ID.\n\t */\n\tshort?(value: string): string;\n\n\t/**\n\t * The long form version of the context ID, expanded from a short version.\n\t * @param value The short form context ID value.\n\t * @returns The long form version of the context ID.\n\t */\n\tlong?(value: string): string;\n\n\t/**\n\t * Performs a runtime guard on the provided context ID value.\n\t * @param value The context ID value to guard.\n\t * @throws Guard error if the value is invalid.\n\t */\n\tguard?(value: string): void;\n}\n"]}

package/dist/types/helpers/contextIdHelper.d.ts

@@ -37,6 +37,21 @@ export declare class ContextIdHelper {
     }, K extends string>(contextIds: T | undefined, keys: readonly K[] | undefined): asserts contextIds is T & {
         [P in K]: string;
     };
+    /**
+     * Gets the long version of a context ID, expanding from a short form if a handler is registered.
+     * @param contextIds The context IDs to get the long version from.
+     * @param key The context ID key to get the long version for.
+     * @returns The long version of the context ID.
+     * @throws Guard error if the value is invalid.
+     */
+    static long(contextIds: IContextIds | undefined, key: string): string;
+    /**
+     * Gets the long versions of multiple context IDs.
+     * @param contextIds The context IDs to get the long versions from.
+     * @param keys The context ID keys to get the long versions for.
+     * @returns The long versions of the context IDs.
+     */
+    static longAll(contextIds: IContextIds | undefined, keys: string[] | undefined): IContextIds;
     /**
      * Gets the short versions of multiple context IDs.
      * @param contextIds The context IDs to get the short versions from.

package/dist/types/models/IContextIdHandler.d.ts

@@ -9,6 +9,12 @@ export interface IContextIdHandler extends IComponent {
      * @returns The short form version of the context ID.
      */
     short?(value: string): string;
+    /**
+     * The long form version of the context ID, expanded from a short version.
+     * @param value The short form context ID value.
+     * @returns The long form version of the context ID.
+     */
+    long?(value: string): string;
     /**
      * Performs a runtime guard on the provided context ID value.
      * @param value The context ID value to guard.

package/docs/changelog.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## [0.9.2-next.2](https://github.com/iotaledger/twin-framework/compare/context-v0.9.2-next.1...context-v0.9.2-next.2) (2026-07-29)
+
+
+### Features
+
+* context id long method ([#423](https://github.com/iotaledger/twin-framework/issues/423)) ([70a7384](https://github.com/iotaledger/twin-framework/commit/70a7384f201ea5dafdff5de34fb90308d5e80338))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.9.2-next.1 to 0.9.2-next.2
+    * @twin.org/nameof bumped from 0.9.2-next.1 to 0.9.2-next.2
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.9.2-next.1 to 0.9.2-next.2
+    * @twin.org/nameof-vitest-plugin bumped from 0.9.2-next.1 to 0.9.2-next.2
+    * @twin.org/validate-locales bumped from 0.9.2-next.1 to 0.9.2-next.2
+
+## [0.9.2-next.1](https://github.com/iotaledger/twin-framework/compare/context-v0.9.2-next.0...context-v0.9.2-next.1) (2026-07-28)
+
+
+### Features
+
+* add context id features ([#206](https://github.com/iotaledger/twin-framework/issues/206)) ([ef0d4ee](https://github.com/iotaledger/twin-framework/commit/ef0d4ee11a4f5fc6cc6f52a4958ce905c04ee13b))
+* add user organization context key ([a3da436](https://github.com/iotaledger/twin-framework/commit/a3da4360451860052a508bdc147255a0b9ca8410))
+* concurrency in SharedStore ([#388](https://github.com/iotaledger/twin-framework/issues/388)) ([0610198](https://github.com/iotaledger/twin-framework/commit/0610198ba482273c3f6ba918e34f5875a3659571))
+* context id handler derives from component ([c868ec2](https://github.com/iotaledger/twin-framework/commit/c868ec21d3a576d4faa222bf130270a21936e50e))
+* typescript 6 update ([1d10f31](https://github.com/iotaledger/twin-framework/commit/1d10f31e6516ec622773f45e88af82fe749b384a))
+* update dependencies ([4da77ab](https://github.com/iotaledger/twin-framework/commit/4da77ab30f499e52825ac5a76f51436ceb59c26e))
+
+
+### Bug Fixes
+
+* context id backwards compatibility ([#406](https://github.com/iotaledger/twin-framework/issues/406)) ([afab5fa](https://github.com/iotaledger/twin-framework/commit/afab5fa2a876b01736e117e4992536627837afde))
+* ensure __decorate is defined for decorators ([103a563](https://github.com/iotaledger/twin-framework/commit/103a563ce01ebdef6240d2e590e7b026e8692684))
+* use singleton pattern for context storage ([c69f358](https://github.com/iotaledger/twin-framework/commit/c69f358e45361b45d4e46f19846cd5b8c99b0ccd))
+* use singleton pattern for context storage ([5cc706a](https://github.com/iotaledger/twin-framework/commit/5cc706a2bbfc601fa3d00f3efd8b764052e9f91d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.9.2-next.0 to 0.9.2-next.1
+    * @twin.org/nameof bumped from 0.9.2-next.0 to 0.9.2-next.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.9.2-next.0 to 0.9.2-next.1
+    * @twin.org/nameof-vitest-plugin bumped from 0.9.2-next.0 to 0.9.2-next.1
+    * @twin.org/validate-locales bumped from 0.9.2-next.0 to 0.9.2-next.1
+
 ## [0.9.1](https://github.com/iotaledger/twin-framework/compare/context-v0.9.1...context-v0.9.1) (2026-07-26)
 
 

package/docs/reference/classes/ContextIdHelper.md

@@ -134,6 +134,66 @@ Guard error if the value is invalid.
 
 ***
 
+### long() {#long}
+
+> `static` **long**(`contextIds`, `key`): `string`
+
+Gets the long version of a context ID, expanding from a short form if a handler is registered.
+
+#### Parameters
+
+##### contextIds
+
+[`IContextIds`](../interfaces/IContextIds.md) \| `undefined`
+
+The context IDs to get the long version from.
+
+##### key
+
+`string`
+
+The context ID key to get the long version for.
+
+#### Returns
+
+`string`
+
+The long version of the context ID.
+
+#### Throws
+
+Guard error if the value is invalid.
+
+***
+
+### longAll() {#longall}
+
+> `static` **longAll**(`contextIds`, `keys`): [`IContextIds`](../interfaces/IContextIds.md)
+
+Gets the long versions of multiple context IDs.
+
+#### Parameters
+
+##### contextIds
+
+[`IContextIds`](../interfaces/IContextIds.md) \| `undefined`
+
+The context IDs to get the long versions from.
+
+##### keys
+
+`string`[] \| `undefined`
+
+The context ID keys to get the long versions for.
+
+#### Returns
+
+[`IContextIds`](../interfaces/IContextIds.md)
+
+The long versions of the context IDs.
+
+***
+
 ### shortAll() {#shortall}
 
 > `static` **shortAll**(`contextIds`, `keys`): [`IContextIds`](../interfaces/IContextIds.md)

package/docs/reference/interfaces/IContextIdHandler.md

@@ -30,6 +30,28 @@ The short form version of the context ID.
 
 ***
 
+### long()? {#long}
+
+> `optional` **long**(`value`): `string`
+
+The long form version of the context ID, expanded from a short version.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The short form context ID value.
+
+#### Returns
+
+`string`
+
+The long form version of the context ID.
+
+***
+
 ### guard()? {#guard}
 
 > `optional` **guard**(`value`): `void`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/context",
-	"version": "0.9.1",
+	"version": "0.9.2-next.2",
 	"description": "Helper methods/classes for context handling",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=24.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "^0.9.1",
-		"@twin.org/nameof": "^0.9.1"
+		"@twin.org/core": "0.9.2-next.2",
+		"@twin.org/nameof": "0.9.2-next.2"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",