@equinor/fusion-framework-module-analytics 3.0.0 → 3.0.2

package/src/collectors/utils/extract-context-metadata.ts

@@ -0,0 +1,19 @@
+import type { ContextItem } from '@equinor/fusion-framework-module-context';
+import type { z } from 'zod';
+import type { contextSchema } from './context-schema.js';
+
+/**
+ * Extracts context metadata from a `ContextItem` for analytics events.
+ *
+ * @param context - The Fusion context item.
+ * @returns An object with id, type, and optional title, externalId, and source.
+ */
+export const extractContextMetadata = (context: ContextItem): z.input<typeof contextSchema> => {
+  return {
+    id: context.id,
+    externalId: context.externalId ?? undefined,
+    title: context.title ?? undefined,
+    type: context.type.id,
+    source: context.source ?? undefined,
+  };
+};

package/src/enable-analytics.ts

@@ -35,6 +35,7 @@ export const enableAnalytics = (
   configurator.addConfig({
     module,
     configure: async (builder) => {
+      // Only invoke the callback when one was supplied by the caller
       if (callback) {
         await Promise.resolve(callback(builder));
       }

package/src/logExporters/fusionOTLPLogExporter/HttpClientExporterTransport.ts

@@ -25,17 +25,20 @@ function isExportRetryable(statusCode: number): boolean {
  * @returns Delay in milliseconds, `-1` for non-positive integers, or `undefined` if absent.
  */
 function parseRetryAfterToMills(retryAfter?: string | undefined | null): number | undefined {
+  // No header present — nothing to compute
   if (retryAfter == null) {
     return undefined;
   }
 
   const seconds = Number.parseInt(retryAfter, 10);
+  // Retry-After given as a plain integer number of seconds
   if (Number.isInteger(seconds)) {
     return seconds > 0 ? seconds * 1000 : -1;
   }
   // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#directives
   const delay = new Date(retryAfter).getTime() - Date.now();
 
+  // Only report a positive delay; a past date means retry is already due
   if (delay >= 0) {
     return delay;
   }
@@ -84,6 +87,7 @@ export class HttpClientExporterTransport implements IExporterTransport {
         signal: abortController.signal,
       });
 
+      // A 2xx response means the export succeeded outright
       if (response.ok) {
         return { status: 'success' };
       } else if (isExportRetryable(response.status)) {
@@ -97,6 +101,7 @@ export class HttpClientExporterTransport implements IExporterTransport {
       };
     } catch (error) {
       const err = error as Error;
+      // Distinguish a timeout (AbortController fired) from other fetch failures
       if (err?.name === 'AbortError') {
         return {
           status: 'failure',

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '3.0.0';
+export const version = '3.0.2';

package/dist/esm/collectors/BaseCollector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseCollector.js","sourceRoot":"","sources":["../../../src/collectors/BaseCollector.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAwB,OAAO,EAAsC,MAAM,MAAM,CAAC;AACpG,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,KAA0B,EAC1B,UAA8B,EAC9B,EAAE;IACF,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;KAClC,CAAC,CAAC;AACL,CAAC,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAgB,aAAa;IAKjC,OAAO,CAAiC;IACxC,KAAK,CAAS;IACd,QAAQ,GAAqD,IAAI,OAAO,EAErE,CAAC;IAEJ;;;;;OAKG;IACH,YAAY,IAAY,EAAE,MAAsC;QAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAaD;;;;OAIG;IACH,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;aACrB,IAAI,CACH,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC5B,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,KAAK;gBAChB,KAAK,EAAE,KAAK;gBACZ,UAAU,EAAE,UAAU;aACvB,CAAC;QACJ,CAAC,CAAC,EACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAClC;aACA,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,QAAoE;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/esm/collectors/utils/extractAppMetadata.js

@@ -1,58 +0,0 @@
-import { z } from 'zod';
-/**
- * Zod schema for an object containing an optional `appKey` string.
- *
- * @remarks
- * Used by {@link AppSelectedCollector} to validate the event body.
- */
-export const appKeySchema = z
-    .object({
-    appKey: z.string().optional(),
-})
-    .optional()
-    .nullable();
-/**
- * Zod schema for a Fusion application metadata object.
- *
- * @remarks
- * Validates core app fields (appKey, displayName, type) and optional build
- * and category information. Used by {@link AppLoadedCollector}.
- */
-export const appSchema = z
-    .object({
-    appKey: z.string(),
-    displayName: z.string(),
-    type: z.string(),
-    categoryName: z.string().optional(),
-    buildVersion: z.string().optional(),
-    buildTag: z.string().optional().nullable(),
-})
-    .optional();
-/**
- * Extracts app-key metadata from a `CurrentApp` instance.
- *
- * @param app - The current app object.
- * @returns An object containing the optional `appKey`.
- */
-export const extractAppKeyMetadata = (app) => {
-    return {
-        appKey: app?.appKey,
-    };
-};
-/**
- * Extracts detailed app metadata from an `AppManifest` for analytics events.
- *
- * @param app - The application manifest.
- * @returns An object with appKey, displayName, type, and optional build/category info.
- */
-export const extractAppMetadata = (app) => {
-    return {
-        appKey: app.appKey,
-        displayName: app.displayName,
-        type: app.type,
-        categoryName: app.category?.name,
-        buildVersion: app.build?.version,
-        buildTag: app.build?.tag,
-    };
-};
-//# sourceMappingURL=extractAppMetadata.js.map

package/dist/esm/collectors/utils/extractAppMetadata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extractAppMetadata.js","sourceRoot":"","sources":["../../../../src/collectors/utils/extractAppMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,EAAE,CAAC;AAEd;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACvB,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC;KACD,QAAQ,EAAE,CAAC;AAQd;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAAe,EAAgC,EAAE;IACrF,OAAO;QACL,MAAM,EAAE,GAAG,EAAE,MAAM;KACpB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,GAAgB,EAA6B,EAAE;IAChF,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI;QAChC,YAAY,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO;QAChC,QAAQ,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG;KACzB,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/collectors/utils/extractContextMetadata.js

@@ -1,34 +0,0 @@
-import { z } from 'zod';
-/**
- * Zod schema for a Fusion context metadata object.
- *
- * @remarks
- * Validates core context fields (id, type) and optional title, externalId,
- * and source. Used by {@link ContextSelectedCollector} and {@link AppLoadedCollector}.
- */
-export const contextSchema = z
-    .object({
-    id: z.string(),
-    type: z.string(),
-    title: z.string().optional(),
-    externalId: z.string().optional(),
-    source: z.string().optional(),
-})
-    .optional()
-    .nullable();
-/**
- * Extracts context metadata from a `ContextItem` for analytics events.
- *
- * @param context - The Fusion context item.
- * @returns An object with id, type, and optional title, externalId, and source.
- */
-export const extractContextMetadata = (context) => {
-    return {
-        id: context.id,
-        externalId: context.externalId ?? undefined,
-        title: context.title ?? undefined,
-        type: context.type.id,
-        source: context.source ?? undefined,
-    };
-};
-//# sourceMappingURL=extractContextMetadata.js.map

package/dist/esm/collectors/utils/extractContextMetadata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extractContextMetadata.js","sourceRoot":"","sources":["../../../../src/collectors/utils/extractContextMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,EAAE,CAAC;AAKd;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAoB,EAAiC,EAAE;IAC5F,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,SAAS;QAC3C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,SAAS;QACjC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;KACpC,CAAC;AACJ,CAAC,CAAC"}

package/dist/types/collectors/utils/extractAppMetadata.d.ts

@@ -1,44 +0,0 @@
-import { z } from 'zod';
-import type { AppManifest, CurrentApp } from '@equinor/fusion-framework-module-app';
-/**
- * Zod schema for an object containing an optional `appKey` string.
- *
- * @remarks
- * Used by {@link AppSelectedCollector} to validate the event body.
- */
-export declare const appKeySchema: z.ZodNullable<z.ZodOptional<z.ZodObject<{
-    appKey: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>>>;
-/**
- * Zod schema for a Fusion application metadata object.
- *
- * @remarks
- * Validates core app fields (appKey, displayName, type) and optional build
- * and category information. Used by {@link AppLoadedCollector}.
- */
-export declare const appSchema: z.ZodOptional<z.ZodObject<{
-    appKey: z.ZodString;
-    displayName: z.ZodString;
-    type: z.ZodString;
-    categoryName: z.ZodOptional<z.ZodString>;
-    buildVersion: z.ZodOptional<z.ZodString>;
-    buildTag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>>;
-/** Inferred type from {@link appKeySchema}. */
-export type AppKeyType = z.infer<typeof appKeySchema>;
-/** Inferred type from {@link appSchema}. */
-export type AppItemType = z.infer<typeof appSchema>;
-/**
- * Extracts app-key metadata from a `CurrentApp` instance.
- *
- * @param app - The current app object.
- * @returns An object containing the optional `appKey`.
- */
-export declare const extractAppKeyMetadata: (app: CurrentApp) => z.input<typeof appKeySchema>;
-/**
- * Extracts detailed app metadata from an `AppManifest` for analytics events.
- *
- * @param app - The application manifest.
- * @returns An object with appKey, displayName, type, and optional build/category info.
- */
-export declare const extractAppMetadata: (app: AppManifest) => z.input<typeof appSchema>;

package/src/collectors/utils/extractAppMetadata.ts

@@ -1,68 +0,0 @@
-import { z } from 'zod';
-import type { AppManifest, CurrentApp } from '@equinor/fusion-framework-module-app';
-
-/**
- * Zod schema for an object containing an optional `appKey` string.
- *
- * @remarks
- * Used by {@link AppSelectedCollector} to validate the event body.
- */
-export const appKeySchema = z
-  .object({
-    appKey: z.string().optional(),
-  })
-  .optional()
-  .nullable();
-
-/**
- * Zod schema for a Fusion application metadata object.
- *
- * @remarks
- * Validates core app fields (appKey, displayName, type) and optional build
- * and category information. Used by {@link AppLoadedCollector}.
- */
-export const appSchema = z
-  .object({
-    appKey: z.string(),
-    displayName: z.string(),
-    type: z.string(),
-    categoryName: z.string().optional(),
-    buildVersion: z.string().optional(),
-    buildTag: z.string().optional().nullable(),
-  })
-  .optional();
-
-/** Inferred type from {@link appKeySchema}. */
-export type AppKeyType = z.infer<typeof appKeySchema>;
-
-/** Inferred type from {@link appSchema}. */
-export type AppItemType = z.infer<typeof appSchema>;
-
-/**
- * Extracts app-key metadata from a `CurrentApp` instance.
- *
- * @param app - The current app object.
- * @returns An object containing the optional `appKey`.
- */
-export const extractAppKeyMetadata = (app: CurrentApp): z.input<typeof appKeySchema> => {
-  return {
-    appKey: app?.appKey,
-  };
-};
-
-/**
- * Extracts detailed app metadata from an `AppManifest` for analytics events.
- *
- * @param app - The application manifest.
- * @returns An object with appKey, displayName, type, and optional build/category info.
- */
-export const extractAppMetadata = (app: AppManifest): z.input<typeof appSchema> => {
-  return {
-    appKey: app.appKey,
-    displayName: app.displayName,
-    type: app.type,
-    categoryName: app.category?.name,
-    buildVersion: app.build?.version,
-    buildTag: app.build?.tag,
-  };
-};