@x12i/analytix-contracts 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,89 @@
1
+ export type AnalyticType = "query" | "jsFunction" | "funcxFunction" | "matrix" | "dashboard" | "report" | "trend" | "composite";
2
+ export type AnalyticStatus = "draft" | "active" | "deprecated" | "archived";
3
+ export type AnalytixRunResult<T = unknown> = {
4
+ analyticId: string;
5
+ analyticType: AnalyticType;
6
+ version: number;
7
+ status: AnalyticStatus;
8
+ data: T;
9
+ meta: {
10
+ cache: {
11
+ hit: boolean;
12
+ key: string;
13
+ ageMs?: number;
14
+ reason?: "miss" | "fresh" | "probe-clean" | "manual-warm" | "bypassed";
15
+ };
16
+ probes: Array<{
17
+ profileId: string;
18
+ ran: boolean;
19
+ changed?: boolean;
20
+ durationMs?: number;
21
+ }>;
22
+ tier?: {
23
+ tierId: string;
24
+ level: number;
25
+ usedMaterializedInputs: string[];
26
+ };
27
+ execution: {
28
+ durationMs: number;
29
+ startedAt: string;
30
+ finishedAt: string;
31
+ traceId: string;
32
+ };
33
+ funcx?: {
34
+ funcxFunctionId: string;
35
+ model: string;
36
+ usage?: {
37
+ inputTokens: number;
38
+ outputTokens: number;
39
+ totalTokens: number;
40
+ };
41
+ cost?: {
42
+ amount: number;
43
+ currency: string;
44
+ estimated: boolean;
45
+ };
46
+ valueEstimate?: {
47
+ amount: number;
48
+ currency: string;
49
+ basis: string;
50
+ };
51
+ retries: number;
52
+ };
53
+ warnings?: string[];
54
+ };
55
+ };
56
+ export type AnalytixErrorCode = "VALIDATION_ERROR" | "ANALYTIC_NOT_FOUND" | "ANALYTIC_NOT_ACTIVE" | "ANALYTIC_ARCHIVED" | "SOURCE_NOT_FOUND" | "QUERY_NOT_FOUND" | "FUNCTION_NOT_FOUND" | "MATRIX_NOT_FOUND" | "DASHBOARD_NOT_FOUND" | "REPORT_NOT_FOUND" | "TIER_NOT_FOUND" | "TIER_CYCLE_DETECTED" | "TIER_DEPENDENCY_MISSING" | "SANDBOX_VIOLATION" | "TIMEOUT_EXCEEDED" | "MEMORY_EXCEEDED" | "OUTPUT_SIZE_EXCEEDED" | "OUTPUT_VALIDATION_FAILED" | "FUNCX_FUNCTION_NOT_FOUND" | "FUNCX_EXECUTION_ERROR" | "FUNCX_TIMEOUT" | "FUNCX_MODEL_UNAVAILABLE" | "FUNCX_OUTPUT_VALIDATION_FAILED" | "CACHE_WRITE_FAILED" | "CACHE_KEY_COLLISION" | "MATRIX_CELL_NOT_SUPPORTED" | "DRILLDOWN_NOT_SUPPORTED" | "UNAUTHORIZED" | "FORBIDDEN" | "PLAYGROUND_ACCESS_DENIED" | "SOURCE_CONNECTION_FAILED" | "SOURCE_QUERY_TIMEOUT" | "SOURCE_ACCESS_DENIED" | "CATALOX_VALIDATION_FAILED" | "CATALOX_VERSION_CONFLICT" | "CATALOX_REFERENCE_NOT_FOUND" | "DRAFT_VALIDATION_FAILED" | "PROMOTE_CONFLICT" | "RATE_LIMITED" | "INTERNAL_ERROR";
57
+ export type AnalytixError = {
58
+ error: {
59
+ code: AnalytixErrorCode;
60
+ message: string;
61
+ httpStatus: number;
62
+ details?: Record<string, unknown>;
63
+ traceId: string;
64
+ };
65
+ };
66
+ export type AnalyticRef = string;
67
+ export declare function parseAnalyticRef(ref: AnalyticRef): {
68
+ id: string;
69
+ version?: number;
70
+ };
71
+ export type CataloxCommonFields = {
72
+ _catalogId: string;
73
+ id: string;
74
+ version: number;
75
+ status: AnalyticStatus;
76
+ title: string;
77
+ description?: string;
78
+ tags?: string[];
79
+ createdAt: string;
80
+ createdBy: string;
81
+ updatedAt: string;
82
+ updatedBy: string;
83
+ metadata: {
84
+ domainIds?: string[];
85
+ agentIds?: string[];
86
+ };
87
+ };
88
+ export type QueryTarget = "source" | "analytix" | "tier" | "trend" | "matrix" | "report" | "dashboard";
89
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GACpB,OAAO,GACP,YAAY,GACZ,eAAe,GACf,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,OAAO,GACP,WAAW,CAAC;AAEhB,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5E,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,GAAG,EAAE,OAAO,CAAC;YACb,GAAG,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,aAAa,GAAG,UAAU,CAAC;SACxE,CAAC;QACF,MAAM,EAAE,KAAK,CAAC;YACZ,SAAS,EAAE,MAAM,CAAC;YAClB,GAAG,EAAE,OAAO,CAAC;YACb,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC,CAAC;QACH,IAAI,CAAC,EAAE;YACL,MAAM,EAAE,MAAM,CAAC;YACf,KAAK,EAAE,MAAM,CAAC;YACd,sBAAsB,EAAE,MAAM,EAAE,CAAC;SAClC,CAAC;QACF,SAAS,EAAE;YACT,UAAU,EAAE,MAAM,CAAC;YACnB,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;YACnB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,KAAK,CAAC,EAAE;YACN,eAAe,EAAE,MAAM,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE;gBAAE,WAAW,EAAE,MAAM,CAAC;gBAAC,YAAY,EAAE,MAAM,CAAC;gBAAC,WAAW,EAAE,MAAM,CAAA;aAAE,CAAC;YAC3E,IAAI,CAAC,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,SAAS,EAAE,OAAO,CAAA;aAAE,CAAC;YAChE,aAAa,CAAC,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;YACpE,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GACzB,kBAAkB,GAClB,oBAAoB,GACpB,qBAAqB,GACrB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,qBAAqB,GACrB,yBAAyB,GACzB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,sBAAsB,GACtB,0BAA0B,GAC1B,0BAA0B,GAC1B,uBAAuB,GACvB,eAAe,GACf,yBAAyB,GACzB,gCAAgC,GAChC,oBAAoB,GACpB,qBAAqB,GACrB,2BAA2B,GAC3B,yBAAyB,GACzB,cAAc,GACd,WAAW,GACX,0BAA0B,GAC1B,0BAA0B,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,yBAAyB,GACzB,kBAAkB,GAClB,cAAc,GACd,gBAAgB,CAAC;AAErB,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE;QACL,IAAI,EAAE,iBAAiB,CAAC;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAMnF;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,cAAc,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,QAAQ,GACR,UAAU,GACV,MAAM,GACN,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,WAAW,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.parseAnalyticRef = parseAnalyticRef;
4
+ function parseAnalyticRef(ref) {
5
+ const parts = ref.split("@");
6
+ if (parts.length === 2) {
7
+ return { id: parts[0], version: parseInt(parts[1], 10) };
8
+ }
9
+ return { id: ref };
10
+ }
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AA4GA,4CAMC;AAND,SAAgB,gBAAgB,CAAC,GAAgB;IAC/C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;IAC3D,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACrB,CAAC"}
package/package.json ADDED
@@ -0,0 +1,17 @@
1
+ {
2
+ "name": "@x12i/analytix-contracts",
3
+ "version": "1.0.0",
4
+ "main": "dist/index.js",
5
+ "types": "dist/index.d.ts",
6
+ "dependencies": {},
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "publishConfig": {
11
+ "access": "public",
12
+ "registry": "https://registry.npmjs.org/"
13
+ },
14
+ "scripts": {
15
+ "build": "tsc -p tsconfig.json"
16
+ }
17
+ }