@objectstack/service-analytics 9.11.0 → 10.2.0

package/dist/index.d.cts

@@ -221,12 +221,31 @@ interface AnalyticsServiceConfig {
      * `StrategyContext.coerceTemporalFilterValue` for the full rationale.
      */
     coerceTemporalFilterValue?: (objectName: string, fieldName: string, value: unknown) => unknown;
+    /**
+     * ADR-0062 D6 — report whether an object is federated (external datasource).
+     * Threaded into the StrategyContext so `NativeSQLStrategy` declines external
+     * objects (which it would otherwise query against the wrong physical table),
+     * routing them to the driver-correct ObjectQL aggregate path instead. See
+     * `StrategyContext.isExternalObject`.
+     */
+    isExternalObject?: (objectName: string) => boolean;
     /**
      * ADR-0021 — optional object-graph resolver used when compiling datasets:
      * `(baseObject, relationshipName) => relatedObjectName | undefined`. When
      * provided, `queryDataset` validates that every declared `include` exists.
      */
     relationshipResolver?: RelationshipResolver;
+    /**
+     * ADR-0053 currency chain — resolve a measure's SOURCE FIELD currency
+     * metadata so a monetary measure that omits an explicit `currency` falls back
+     * to the field's declared currency, then the tenant default (`ctx.currency`).
+     * Returns the source field's `type` and (fixed-mode) `defaultCurrency`;
+     * `undefined` for an unknown field. Non-`currency` fields never get a code.
+     */
+    measureCurrency?: (object: string, field: string) => {
+        type?: string;
+        defaultCurrency?: string;
+    } | undefined;
     /** Pre-defined datasets to compile + register at construction (ADR-0021). */
     datasets?: Dataset[];
     /**
@@ -276,6 +295,7 @@ declare class AnalyticsService implements IAnalyticsService {
     private readonly datasetRegistry;
     /** Optional object-graph resolver used when compiling datasets. */
     private readonly relationshipResolver?;
+    private readonly measureCurrency?;
     /** Optional dimension display-label resolver (select options / lookup names). */
     private readonly labelResolver?;
     /** ADR-0037 P3: pending-seed row resolver for draft data preview. */

package/dist/index.d.ts

@@ -221,12 +221,31 @@ interface AnalyticsServiceConfig {
      * `StrategyContext.coerceTemporalFilterValue` for the full rationale.
      */
     coerceTemporalFilterValue?: (objectName: string, fieldName: string, value: unknown) => unknown;
+    /**
+     * ADR-0062 D6 — report whether an object is federated (external datasource).
+     * Threaded into the StrategyContext so `NativeSQLStrategy` declines external
+     * objects (which it would otherwise query against the wrong physical table),
+     * routing them to the driver-correct ObjectQL aggregate path instead. See
+     * `StrategyContext.isExternalObject`.
+     */
+    isExternalObject?: (objectName: string) => boolean;
     /**
      * ADR-0021 — optional object-graph resolver used when compiling datasets:
      * `(baseObject, relationshipName) => relatedObjectName | undefined`. When
      * provided, `queryDataset` validates that every declared `include` exists.
      */
     relationshipResolver?: RelationshipResolver;
+    /**
+     * ADR-0053 currency chain — resolve a measure's SOURCE FIELD currency
+     * metadata so a monetary measure that omits an explicit `currency` falls back
+     * to the field's declared currency, then the tenant default (`ctx.currency`).
+     * Returns the source field's `type` and (fixed-mode) `defaultCurrency`;
+     * `undefined` for an unknown field. Non-`currency` fields never get a code.
+     */
+    measureCurrency?: (object: string, field: string) => {
+        type?: string;
+        defaultCurrency?: string;
+    } | undefined;
     /** Pre-defined datasets to compile + register at construction (ADR-0021). */
     datasets?: Dataset[];
     /**
@@ -276,6 +295,7 @@ declare class AnalyticsService implements IAnalyticsService {
     private readonly datasetRegistry;
     /** Optional object-graph resolver used when compiling datasets. */
     private readonly relationshipResolver?;
+    private readonly measureCurrency?;
     /** Optional dimension display-label resolver (select options / lookup names). */
     private readonly labelResolver?;
     /** ADR-0037 P3: pending-seed row resolver for draft data preview. */

package/dist/index.js

@@ -320,6 +320,17 @@ var NativeSQLStrategy = class {
   canHandle(query, ctx) {
     if (!query.cube) return false;
     if (query.timeDimensions?.some((td) => !!td.granularity)) return false;
+    if (typeof ctx.isExternalObject === "function") {
+      const cube = ctx.getCube(query.cube);
+      if (cube) {
+        if (ctx.isExternalObject(this.extractObjectName(cube))) return false;
+        const joinTargets = cube.joins ? Object.values(cube.joins) : [];
+        for (const j of joinTargets) {
+          const joinedObject = j?.name;
+          if (joinedObject && ctx.isExternalObject(joinedObject)) return false;
+        }
+      }
+    }
     const caps = ctx.queryCapabilities(query.cube);
     return caps.nativeSql && typeof ctx.executeRawSql === "function";
   }
@@ -1456,6 +1467,7 @@ var AnalyticsService = class {
     }
     this.readScopeProvider = config.getReadScope;
     this.relationshipResolver = config.relationshipResolver;
+    this.measureCurrency = config.measureCurrency;
     this.labelResolver = config.labelResolver;
     this.draftRowsResolver = config.draftRowsResolver;
     if (config.datasets) {
@@ -1476,7 +1488,8 @@ var AnalyticsService = class {
       // Prefer a compiled dataset's declared relationships (D-C join allowlist);
       // fall back to any explicitly-configured provider for legacy cubes.
       getAllowedRelationships: (cubeName) => this.datasetRegistry.get(cubeName)?.allowedRelationships ?? config.getAllowedRelationships?.(cubeName),
-      coerceTemporalFilterValue: config.coerceTemporalFilterValue
+      coerceTemporalFilterValue: config.coerceTemporalFilterValue,
+      isExternalObject: config.isExternalObject
     };
     const builtIn = [
       new NativeSQLStrategy(),
@@ -1633,8 +1646,21 @@ var AnalyticsService = class {
       }
       throw err;
     }
-    if (this.labelResolver && selection.dimensions?.length) {
-      const dims = selection.dimensions.map((name) => dataset.dimensions?.find((d) => d.name === name)).filter((d) => !!d?.field).map((d) => ({ name: d.name, field: d.field, type: d.type, dateGranularity: d.dateGranularity }));
+    const selectedDims = (selection.dimensions ?? []).map((name) => dataset.dimensions?.find((d) => d.name === name)).filter((d) => !!d);
+    const drillDims = selectedDims.filter((d) => !!d.field && d.type !== "date");
+    if (drillDims.length && result.rows.length) {
+      result.object = dataset.object;
+      result.dimensionFields = Object.fromEntries(
+        drillDims.map((d) => [d.name, d.field])
+      );
+      result.drillRawRows = result.rows.map((row) => {
+        const raw = {};
+        for (const d of drillDims) raw[d.name] = row[d.name];
+        return raw;
+      });
+    }
+    if (this.labelResolver && selectedDims.length) {
+      const dims = selectedDims.filter((d) => !!d.field).map((d) => ({ name: d.name, field: d.field, type: d.type, dateGranularity: d.dateGranularity }));
       if (dims.length) {
         try {
           await resolveDimensionLabels(dataset.object, dims, result.rows, this.labelResolver);
@@ -1656,6 +1682,25 @@ var AnalyticsService = class {
         if (!m) continue;
         if (f.label == null && typeof m.label === "string") f.label = m.label;
         if (f.format == null && m.format) f.format = m.format;
+        const fc = f;
+        const mc = m;
+        if (fc.currency == null) {
+          const meta = m.field ? this.measureCurrency?.(dataset.object, m.field) : void 0;
+          const monetary = !!mc.currency || meta?.type === "currency";
+          if (monetary) {
+            const resolved = mc.currency ?? meta?.defaultCurrency ?? context?.currency;
+            if (resolved) fc.currency = resolved;
+          }
+        }
+      }
+    }
+    if (result.fields?.length && selectedDims.length) {
+      const dimByName = new Map(selectedDims.map((d) => [d.name, d]));
+      const dimByField = new Map(selectedDims.filter((d) => !!d.field).map((d) => [d.field, d]));
+      for (const f of result.fields) {
+        if (f.label != null) continue;
+        const d = dimByName.get(f.name) ?? dimByField.get(f.name);
+        if (d && typeof d.label === "string") f.label = d.label;
       }
     }
     return result;
@@ -2044,6 +2089,18 @@ var AnalyticsServicePlugin = class {
       coerceTemporalFilterValue,
       relationshipResolver,
       labelResolver,
+      // ADR-0053 — source-field currency metadata for the measure currency chain.
+      measureCurrency: (object, field) => {
+        const f = dataEngine()?.getObject?.(object)?.fields?.[field];
+        return f ? { type: f.type, defaultCurrency: f.currencyConfig?.defaultCurrency } : void 0;
+      },
+      // ADR-0062 D6 — a federated object carries an `external` block (ADR-0015).
+      // Reported so NativeSQLStrategy declines it (its hand-compiled FROM would
+      // hit the wrong physical table) and the driver-correct ObjectQL path runs.
+      isExternalObject: (objectName) => {
+        const obj = dataEngine()?.getObject?.(objectName);
+        return !!(obj && obj.external != null);
+      },
       draftRowsResolver
     };
     if (autoBridgedReadScope) {