@equinor/fusion-framework-module-context 8.0.0 → 8.0.1

package/dist/esm/parse-context-item.js

@@ -0,0 +1,31 @@
+/**
+ * Parses the context type from the response of the GetContext API.
+ *
+ * @param type The type property from the GetContext response.
+ * @returns The parsed context item type.
+ */
+const parseContextType = (type) => ({
+    id: type.id,
+    isChildType: type.isChildType,
+    parentTypeIds: type.parentTypeIds ?? [],
+});
+/**
+ * Parses an ApiContextEntity object into a ContextItem object.
+ * @param item The ApiContextEntity object to parse.
+ * @returns The parsed ContextItem object.
+ */
+export const parseContextItem = (item) => {
+    return {
+        id: item.id,
+        externalId: item.externalId ?? undefined,
+        isActive: item.isActive,
+        isDeleted: item.isDeleted,
+        created: new Date(item.created),
+        source: item.source ?? undefined,
+        title: item.title ?? undefined,
+        type: parseContextType(item.type),
+        // TODO(#5115): parse and map the raw `value` payload into a typed context item value
+        value: item.value ?? {},
+    };
+};
+//# sourceMappingURL=parse-context-item.js.map

package/dist/esm/parse-context-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-context-item.js","sourceRoot":"","sources":["../../src/parse-context-item.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAsC,EAAmB,EAAE,CAAC,CAAC;IACrF,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,WAAW,EAAE,IAAI,CAAC,WAAW;IAC7B,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;CACxC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAqC,EAAe,EAAE;IACrF,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,SAAS;QACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QAC/B,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,SAAS;QAChC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,SAAS;QAC9B,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,qFAAqF;QACrF,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;KACxB,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/query-context-selector.js

@@ -0,0 +1,12 @@
+import { parseContextItem } from './parse-context-item';
+/**
+ * Parse the response from the QueryContext API into an array of context items.
+ * @param response The response object.
+ * @returns A promise that resolves to an array of context items.
+ */
+export const queryContextSelector = async (response) => {
+    const result = (await response.json());
+    // parse each raw API entry into a ContextItem
+    return result.map(parseContextItem);
+};
+//# sourceMappingURL=query-context-selector.js.map

package/dist/esm/query-context-selector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-context-selector.js","sourceRoot":"","sources":["../../src/query-context-selector.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,QAAkB,EAA0B,EAAE;IACvF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA+B,CAAC;IACrE,8CAA8C;IAC9C,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/dist/esm/related-context-selector.js

@@ -0,0 +1,12 @@
+import { parseContextItem } from './parse-context-item';
+/**
+ * Parse the response from the RelatedContext API into an array of context items.
+ * @param response The response object containing the related context items.
+ * @returns A promise that resolves to an array of ContextItem objects.
+ */
+export const relatedContextSelector = async (response) => {
+    const result = (await response.json());
+    // parse each raw API entry into a ContextItem
+    return result.map(parseContextItem);
+};
+//# sourceMappingURL=related-context-selector.js.map

package/dist/esm/related-context-selector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"related-context-selector.js","sourceRoot":"","sources":["../../src/related-context-selector.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAAE,QAAkB,EAA0B,EAAE;IACzF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiC,CAAC;IACvE,8CAA8C;IAC9C,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/dist/esm/utils/extract-context-id-from-path.js

@@ -0,0 +1,25 @@
+// GUID pattern
+const matchGUID = /^(?:(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12})$/;
+/**
+ * Method will try to extract a context id from a path.
+ * The default matcher is a GUID pattern.
+ * Will iterate over the path and return the first match.
+ *
+ * @example
+ * ```ts
+ * const path = '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?dsadasdas#example';
+ * const contextId = extractContextIdFromPath(path); // '7fd97952-7fe6-409b-a6dc-292dbf0e50d7'
+ * ```
+ *
+ * @param path string - the path to extract the context id from
+ * @param matcher RegExp - the pattern to match against
+ * @returns string | undefined - the context id or undefined
+ */
+export const extractContextIdFromPath = (path, matcher = matchGUID) => path
+    // remove leading slashes
+    .replace(/^\/+/, '')
+    // split path by slashes
+    .split('/')
+    // find the first path fragment that matches the matcher
+    .find((x) => x.match(matcher));
+//# sourceMappingURL=extract-context-id-from-path.js.map

package/dist/esm/utils/extract-context-id-from-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-context-id-from-path.js","sourceRoot":"","sources":["../../../src/utils/extract-context-id-from-path.ts"],"names":[],"mappings":"AAAA,eAAe;AACf,MAAM,SAAS,GACb,uGAAuG,CAAC;AAE1G;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAAY,EACZ,OAAO,GAAW,SAAS,EACP,EAAE,CACtB,IAAI;IACF,yBAAyB;KACxB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IACpB,wBAAwB;KACvB,KAAK,CAAC,GAAG,CAAC;IACX,wDAAwD;KACvD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/dist/esm/utils/resolve-context-from-path.js

@@ -1,36 +1,25 @@
 import { EMPTY } from 'rxjs';
-// GUID pattern
+import { extractContextIdFromPath } from './extract-context-id-from-path';
+export { extractContextIdFromPath } from './extract-context-id-from-path';
+// GUID pattern, used as the default context id validator
 const matchGUID = /^(?:(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12})$/;
+const validateContextId = (contextId) => !!contextId.match(matchGUID);
 /**
- * Method will try to extract a context id from a path.
- * The default matcher is a GUID pattern.
- * Will iterate over the path and return the first match.
- *
- * @example
- * ```ts
- * const path = '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?dsadasdas#example';
- * const contextId = extractContextIdFromPath(path); // '7fd97952-7fe6-409b-a6dc-292dbf0e50d7'
- * ```
- *
- * @param path string - the path to extract the context id from
- * @param matcher RegExp - the pattern to match against
- * @returns string | undefined - the context id or undefined
+ * Resolves a context item from a path, using the provided extract/validate callbacks or the defaults.
+ * @param context The context module.
+ * @param args The arguments for resolving the path.
+ * @returns A function that takes a path and returns an Observable of the resolved context item.
+ * @throws Error if the extracted context id fails validation.
  */
-export const extractContextIdFromPath = (path, matcher = matchGUID) => path
-    // remove leading slashes
-    .replace(/^\/+/, '')
-    // split path by slashes
-    .split('/')
-    // find the first path fragment that matches the matcher
-    .find((x) => x.match(matcher));
-const validateContextId = (contextId) => !!contextId.match(matchGUID);
 export function resolveContextFromPath(context, args) {
     return (path) => {
         const { extract = extractContextIdFromPath, validate = validateContextId } = args ?? {};
         const contextId = extract(path);
+        // no context id found in the path, nothing to resolve
         if (!contextId) {
             return EMPTY;
         }
+        // only resolve the context if the extracted id passes validation
         if (validate(contextId)) {
             return context.contextClient.resolveContext(contextId);
         }

package/dist/esm/utils/resolve-context-from-path.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-context-from-path.js","sourceRoot":"","sources":["../../../src/utils/resolve-context-from-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAmB,MAAM,MAAM,CAAC;AAyB9C,eAAe;AACf,MAAM,SAAS,GACb,uGAAuG,CAAC;AAE1G;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAAY,EACZ,UAAkB,SAAS,EACP,EAAE,CACtB,IAAI;IACF,yBAAyB;KACxB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IACpB,wBAAwB;KACvB,KAAK,CAAC,GAAG,CAAC;IACX,wDAAwD;KACvD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAEnC,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAkDvF,MAAM,UAAU,sBAAsB,CACpC,OAAkC,EAClC,IAA6B;IAE7B,OAAO,CAAC,IAAY,EAAE,EAAE;QACtB,MAAM,EAAE,OAAO,GAAG,wBAAwB,EAAE,QAAQ,GAAG,iBAAiB,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QACxF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,KAAK,CAAC,+BAA+B,SAAS,gBAAgB,IAAI,GAAG,CAAC,CAAC;IAC/E,CAAC,CAAC;AACJ,CAAC;AAED,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"resolve-context-from-path.js","sourceRoot":"","sources":["../../../src/utils/resolve-context-from-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAmB,MAAM,MAAM,CAAC;AAM9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAoB1E,yDAAyD;AACzD,MAAM,SAAS,GACb,uGAAuG,CAAC;AAE1G,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAkDvF;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAkC,EAClC,IAA6B;IAE7B,OAAO,CAAC,IAAY,EAAE,EAAE;QACtB,MAAM,EAAE,OAAO,GAAG,wBAAwB,EAAE,QAAQ,GAAG,iBAAiB,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QACxF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,sDAAsD;QACtD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,iEAAiE;QACjE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,KAAK,CAAC,+BAA+B,SAAS,gBAAgB,IAAI,GAAG,CAAC,CAAC;IAC/E,CAAC,CAAC;AACJ,CAAC;AAED,eAAe,sBAAsB,CAAC"}

package/dist/esm/utils/resolve-initial-context.js

@@ -23,6 +23,8 @@ export const resolveContextFromParent = ({ ref }) => {
  * @param options - Optional configuration for resolving the context path.
  * @returns A function that accepts the module's reference and modules, and returns an Observable of the resolved initial context.
  */
+// Deliberately co-located with resolveContextFromParent, which it composes with
+// fusion-lint-disable-next-line single-export-per-file
 export const resolveInitialContext = (options) => ({ ref, modules }) => {
     const { context, navigation } = modules;
     // create a path resolver from the context module

package/dist/esm/utils/resolve-initial-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-initial-context.js","sourceRoot":"","sources":["../../../src/utils/resolve-initial-context.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAEhD,OAAO,EAA+B,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGlG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAiD,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;IAChG,MAAM,aAAa,GAAI,GAAwC,EAAE,OAAO,CAAC;IACzE,yCAAyC;IACzC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,KAAK,CAAC,CAAC,8BAA8B,EAAE,+BAA+B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5F,CAAC;IACD,4FAA4F;IAC5F,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,OAEA,EAA0D,EAAE,CAC7D,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;IACnB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACxC,iDAAiD;IACjD,MAAM,YAAY,GAAG,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACpE,yFAAyF;IACzF,MAAM,QAAQ,GACZ,UAAU,EAAE,IAAI,CAAC,QAAQ;QACxB,GAAoD,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC;IAClF,0GAA0G;IAC1G,OAAO,MAAM,CACX,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EACzC,wBAAwB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAC3C,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC;AAEJ,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"resolve-initial-context.js","sourceRoot":"","sources":["../../../src/utils/resolve-initial-context.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAEhD,OAAO,EAA+B,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGlG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAiD,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;IAChG,MAAM,aAAa,GAAI,GAAwC,EAAE,OAAO,CAAC;IACzE,yCAAyC;IACzC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,KAAK,CAAC,CAAC,8BAA8B,EAAE,+BAA+B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5F,CAAC;IACD,4FAA4F;IAC5F,OAAO,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,gFAAgF;AAChF,uDAAuD;AACvD,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,OAEA,EAA0D,EAAE,CAC7D,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;IACnB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACxC,iDAAiD;IACjD,MAAM,YAAY,GAAG,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACpE,yFAAyF;IACzF,MAAM,QAAQ,GACZ,UAAU,EAAE,IAAI,CAAC,QAAQ;QACxB,GAAoD,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC;IAClF,0GAA0G;IAC1G,OAAO,MAAM,CACX,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EACzC,wBAAwB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAC3C,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC;AAEJ,eAAe,qBAAqB,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '8.0.0';
+export const version = '8.0.1';
 //# sourceMappingURL=version.js.map