@nexia/sdk 0.5.0

package/dist/resource-composition.d.ts

@@ -0,0 +1,104 @@
+interface CompositionSpecBody {
+    readonly sources: readonly {
+        readonly alias: string;
+        readonly resource_key: string;
+    }[];
+    readonly fields: readonly {
+        readonly source: string;
+        readonly field: string;
+    }[];
+    readonly filters: readonly {
+        readonly source: string;
+        readonly field: string;
+        readonly operator: 'eq' | 'in';
+        readonly value: string | number | boolean | readonly (string | number | boolean)[];
+    }[];
+    readonly dimensions: readonly {
+        readonly source: string;
+        readonly field: string;
+        readonly bucket: 'day' | 'week' | 'month' | null;
+    }[];
+    readonly measures: readonly {
+        readonly alias: string;
+        readonly source: string;
+        readonly field: string | null;
+        readonly operation: 'count' | 'distinct_count' | 'sum' | 'avg';
+        readonly result_type: 'integer' | 'decimal';
+        readonly null_behavior: 'zero' | 'null_if_empty';
+        readonly unit: string;
+    }[];
+    readonly result: {
+        readonly shape: 'rows' | 'aggregate';
+    };
+}
+/** Strict, presentation-free intent for one bounded read-only Resource composition. */
+export interface CompositionSpecV1 extends CompositionSpecBody {
+    readonly schema_version: 1;
+    readonly relationship: {
+        readonly key: string;
+    } | null;
+    readonly relationships?: never;
+}
+export interface CompositionSpecV2 extends CompositionSpecBody {
+    readonly schema_version: 2;
+    readonly relationship?: never;
+    readonly relationships: readonly [{
+        readonly key: string;
+    }, {
+        readonly key: string;
+    }];
+}
+export interface CompositionSpecV3 extends CompositionSpecBody {
+    readonly schema_version: 3;
+    readonly relationship?: never;
+    readonly relationships: readonly {
+        readonly key: string;
+        readonly source: string;
+        readonly target: string;
+    }[];
+}
+/** Advanced reports retain one strict CompositionSpec wire; Core gates live capabilities. */
+export interface CompositionSpecV4 {
+    readonly schema_version: 4;
+    readonly sources: CompositionSpecBody['sources'];
+    readonly relationships: readonly {
+        readonly key: string;
+        readonly source: string;
+        readonly target: string;
+    }[];
+    readonly fields: readonly ({
+        readonly source: string;
+        readonly field: string;
+    } | {
+        readonly derived: string;
+    })[];
+    readonly timezone: string;
+    readonly where: Record<string, unknown>;
+    readonly dimensions: readonly {
+        readonly target: Record<string, unknown>;
+        readonly bucket: 'day' | 'week' | 'month' | 'quarter' | 'year' | null;
+    }[];
+    readonly measures: readonly Record<string, unknown>[];
+    readonly having: Record<string, unknown>;
+    readonly derived: readonly Record<string, unknown>[];
+    readonly comparison: Record<string, unknown> | null;
+    readonly sort: readonly Record<string, unknown>[];
+    readonly limit: {
+        readonly count: number;
+    } | null;
+    readonly result: {
+        readonly shape: 'rows' | 'aggregate';
+    };
+}
+export type CompositionSpec = CompositionSpecV1 | CompositionSpecV2 | CompositionSpecV3 | CompositionSpecV4;
+export declare class CompositionSpecValidationError extends Error {
+    readonly code: 'invalid_shape' | 'unsupported_schema_version' | 'unknown_key' | 'invalid_identifier' | 'duplicate_identifier' | 'invalid_source_count' | 'unknown_source_alias' | 'relationship_required' | 'relationship_not_allowed' | 'invalid_filter_value' | 'invalid_measure' | 'result_shape_mismatch';
+    readonly path: string;
+    constructor(code: 'invalid_shape' | 'unsupported_schema_version' | 'unknown_key' | 'invalid_identifier' | 'duplicate_identifier' | 'invalid_source_count' | 'unknown_source_alias' | 'relationship_required' | 'relationship_not_allowed' | 'invalid_filter_value' | 'invalid_measure' | 'result_shape_mismatch', path: string, message: string);
+}
+/**
+ * Parses the stable wire shape. Resource, field, operator, relationship, grain,
+ * and authorization semantics remain live host-catalog decisions.
+ */
+export declare function parseCompositionSpec(value: unknown): CompositionSpec;
+export {};