@contractspec/example.analytics-dashboard 1.57.0 → 1.58.0

package/dist/query/index.js

@@ -1,5 +1,160 @@
-import { QueryTypeEnum } from "./query.enum.js";
-import { CreateQueryInputModel, ExecuteQueryInputModel, QueryModel, QueryResultModel } from "./query.schema.js";
-import { CreateQueryContract, ExecuteQueryContract } from "./query.operation.js";
+// @bun
+// src/query/query.enum.ts
+import { defineEnum } from "@contractspec/lib.schema";
+var QueryTypeEnum = defineEnum("QueryType", [
+  "SQL",
+  "METRIC",
+  "AGGREGATION",
+  "CUSTOM"
+]);
 
-export { CreateQueryContract, CreateQueryInputModel, ExecuteQueryContract, ExecuteQueryInputModel, QueryModel, QueryResultModel, QueryTypeEnum };
+// src/query/query.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var QueryModel = defineSchemaModel({
+  name: "QueryModel",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    type: { type: QueryTypeEnum, isOptional: false },
+    definition: { type: ScalarTypeEnum.JSON(), isOptional: false },
+    sql: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    cacheTtlSeconds: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    isShared: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var QueryResultModel = defineSchemaModel({
+  name: "QueryResultModel",
+  fields: {
+    queryId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    data: { type: ScalarTypeEnum.JSON(), isOptional: false },
+    columns: { type: ScalarTypeEnum.JSON(), isOptional: false },
+    rowCount: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    executionTimeMs: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    cachedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    error: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var CreateQueryInputModel = defineSchemaModel({
+  name: "CreateQueryInput",
+  fields: {
+    name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    type: { type: QueryTypeEnum, isOptional: false },
+    definition: { type: ScalarTypeEnum.JSON(), isOptional: false },
+    sql: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    metricIds: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isArray: true,
+      isOptional: true
+    },
+    cacheTtlSeconds: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    isShared: { type: ScalarTypeEnum.Boolean(), isOptional: true }
+  }
+});
+var ExecuteQueryInputModel = defineSchemaModel({
+  name: "ExecuteQueryInput",
+  fields: {
+    queryId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    parameters: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    dateRange: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    filters: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    forceRefresh: { type: ScalarTypeEnum.Boolean(), isOptional: true }
+  }
+});
+
+// src/query/query.operation.ts
+import {
+  defineCommand,
+  defineQuery
+} from "@contractspec/lib.contracts/operations";
+var OWNERS = ["@example.analytics-dashboard"];
+var CreateQueryContract = defineCommand({
+  meta: {
+    key: "analytics.query.create",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "query", "create"],
+    description: "Create a data query.",
+    goal: "Define reusable data queries.",
+    context: "Query builder."
+  },
+  io: { input: CreateQueryInputModel, output: QueryModel },
+  policy: { auth: "user" },
+  sideEffects: {
+    emits: [
+      {
+        key: "analytics.query.created",
+        version: "1.0.0",
+        stability: "stable",
+        owners: [...OWNERS],
+        tags: ["analytics", "query", "created"],
+        when: "Query created",
+        payload: QueryModel
+      }
+    ],
+    audit: ["analytics.query.created"]
+  },
+  acceptance: {
+    scenarios: [
+      {
+        key: "create-query-happy-path",
+        given: ["User is authenticated"],
+        when: ["User submits valid query definition"],
+        then: ["Query is created", "QueryCreated event is emitted"]
+      }
+    ],
+    examples: [
+      {
+        key: "create-sql-query",
+        input: {
+          name: "Monthly Revenue",
+          sql: "SELECT SUM(amount) FROM orders WHERE date >= :startDate"
+        },
+        output: { id: "query-123", name: "Monthly Revenue", type: "sql" }
+      }
+    ]
+  }
+});
+var ExecuteQueryContract = defineQuery({
+  meta: {
+    key: "analytics.query.execute",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["analytics", "query", "execute"],
+    description: "Execute a data query.",
+    goal: "Fetch data for visualizations.",
+    context: "Dashboard rendering."
+  },
+  io: { input: ExecuteQueryInputModel, output: QueryResultModel },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "execute-query-happy-path",
+        given: ["Query exists"],
+        when: ["User executes query with parameters"],
+        then: ["Query results are returned"]
+      }
+    ],
+    examples: [
+      {
+        key: "execute-with-params",
+        input: { queryId: "query-123", params: { startDate: "2025-01-01" } },
+        output: { columns: ["total"], rows: [{ total: 50000 }], rowCount: 1 }
+      }
+    ]
+  }
+});
+export {
+  QueryTypeEnum,
+  QueryResultModel,
+  QueryModel,
+  ExecuteQueryInputModel,
+  ExecuteQueryContract,
+  CreateQueryInputModel,
+  CreateQueryContract
+};

package/dist/query/query.enum.d.ts

@@ -1,10 +1,5 @@
-import * as _contractspec_lib_schema0 from "@contractspec/lib.schema";
-
-//#region src/query/query.enum.d.ts
 /**
  * Query type enum.
  */
-declare const QueryTypeEnum: _contractspec_lib_schema0.EnumType<[string, string, string, string]>;
-//#endregion
-export { QueryTypeEnum };
+export declare const QueryTypeEnum: import("@contractspec/lib.schema").EnumType<[string, string, string, string]>;
 //# sourceMappingURL=query.enum.d.ts.map

package/dist/query/query.enum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.enum.d.ts","names":[],"sources":["../../src/query/query.enum.ts"],"mappings":";;;;;;cAKa,aAAA,EAKX,yBAAA,CALwB,QAAA"}
+{"version":3,"file":"query.enum.d.ts","sourceRoot":"","sources":["../../src/query/query.enum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,aAAa,+EAKxB,CAAC"}

package/dist/query/query.enum.js

@@ -1,16 +1,12 @@
+// @bun
+// src/query/query.enum.ts
 import { defineEnum } from "@contractspec/lib.schema";
-
-//#region src/query/query.enum.ts
-/**
-* Query type enum.
-*/
-const QueryTypeEnum = defineEnum("QueryType", [
-	"SQL",
-	"METRIC",
-	"AGGREGATION",
-	"CUSTOM"
+var QueryTypeEnum = defineEnum("QueryType", [
+  "SQL",
+  "METRIC",
+  "AGGREGATION",
+  "CUSTOM"
 ]);
-
-//#endregion
-export { QueryTypeEnum };
-//# sourceMappingURL=query.enum.js.map
+export {
+  QueryTypeEnum
+};

package/dist/query/query.operation.d.ts

@@ -1,181 +1,175 @@
-import * as _contractspec_lib_contracts0 from "@contractspec/lib.contracts";
-import * as _contractspec_lib_schema0 from "@contractspec/lib.schema";
-
-//#region src/query/query.operation.d.ts
 /**
  * Create a data query.
  */
-declare const CreateQueryContract: _contractspec_lib_contracts0.OperationSpec<_contractspec_lib_schema0.SchemaModel<{
-  name: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  description: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: true;
-  };
-  type: {
-    type: _contractspec_lib_schema0.EnumType<[string, string, string, string]>;
-    isOptional: false;
-  };
-  definition: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: false;
-  };
-  sql: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: true;
-  };
-  metricIds: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isArray: true;
-    isOptional: true;
-  };
-  cacheTtlSeconds: {
-    type: _contractspec_lib_schema0.FieldType<number, number>;
-    isOptional: true;
-  };
-  isShared: {
-    type: _contractspec_lib_schema0.FieldType<boolean, boolean>;
-    isOptional: true;
-  };
-}>, _contractspec_lib_schema0.SchemaModel<{
-  id: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  name: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  description: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: true;
-  };
-  type: {
-    type: _contractspec_lib_schema0.EnumType<[string, string, string, string]>;
-    isOptional: false;
-  };
-  definition: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: false;
-  };
-  sql: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: true;
-  };
-  cacheTtlSeconds: {
-    type: _contractspec_lib_schema0.FieldType<number, number>;
-    isOptional: false;
-  };
-  isShared: {
-    type: _contractspec_lib_schema0.FieldType<boolean, boolean>;
-    isOptional: false;
-  };
-  createdAt: {
-    type: _contractspec_lib_schema0.FieldType<Date, string>;
-    isOptional: false;
-  };
-}>, {
-  key: string;
-  version: string;
-  stability: string;
-  owners: "@example.analytics-dashboard"[];
-  tags: string[];
-  when: string;
-  payload: _contractspec_lib_schema0.SchemaModel<{
+export declare const CreateQueryContract: import("@contractspec/lib.contracts").OperationSpec<import("@contractspec/lib.schema").SchemaModel<{
+    name: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
+    };
+    description: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: true;
+    };
+    type: {
+        type: import("@contractspec/lib.schema").EnumType<[string, string, string, string]>;
+        isOptional: false;
+    };
+    definition: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: false;
+    };
+    sql: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: true;
+    };
+    metricIds: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isArray: true;
+        isOptional: true;
+    };
+    cacheTtlSeconds: {
+        type: import("@contractspec/lib.schema").FieldType<number, number>;
+        isOptional: true;
+    };
+    isShared: {
+        type: import("@contractspec/lib.schema").FieldType<boolean, boolean>;
+        isOptional: true;
+    };
+}>, import("@contractspec/lib.schema").SchemaModel<{
     id: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     name: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
     };
     description: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: true;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: true;
     };
     type: {
-      type: _contractspec_lib_schema0.EnumType<[string, string, string, string]>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").EnumType<[string, string, string, string]>;
+        isOptional: false;
     };
     definition: {
-      type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: false;
     };
     sql: {
-      type: _contractspec_lib_schema0.FieldType<string, string>;
-      isOptional: true;
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: true;
     };
     cacheTtlSeconds: {
-      type: _contractspec_lib_schema0.FieldType<number, number>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<number, number>;
+        isOptional: false;
     };
     isShared: {
-      type: _contractspec_lib_schema0.FieldType<boolean, boolean>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<boolean, boolean>;
+        isOptional: false;
     };
     createdAt: {
-      type: _contractspec_lib_schema0.FieldType<Date, string>;
-      isOptional: false;
+        type: import("@contractspec/lib.schema").FieldType<Date, string>;
+        isOptional: false;
     };
-  }>;
+}>, {
+    key: string;
+    version: string;
+    stability: string;
+    owners: "@example.analytics-dashboard"[];
+    tags: string[];
+    when: string;
+    payload: import("@contractspec/lib.schema").SchemaModel<{
+        id: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        name: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: false;
+        };
+        description: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: true;
+        };
+        type: {
+            type: import("@contractspec/lib.schema").EnumType<[string, string, string, string]>;
+            isOptional: false;
+        };
+        definition: {
+            type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+            isOptional: false;
+        };
+        sql: {
+            type: import("@contractspec/lib.schema").FieldType<string, string>;
+            isOptional: true;
+        };
+        cacheTtlSeconds: {
+            type: import("@contractspec/lib.schema").FieldType<number, number>;
+            isOptional: false;
+        };
+        isShared: {
+            type: import("@contractspec/lib.schema").FieldType<boolean, boolean>;
+            isOptional: false;
+        };
+        createdAt: {
+            type: import("@contractspec/lib.schema").FieldType<Date, string>;
+            isOptional: false;
+        };
+    }>;
 }[]>;
 /**
  * Execute a data query.
  */
-declare const ExecuteQueryContract: _contractspec_lib_contracts0.OperationSpec<_contractspec_lib_schema0.SchemaModel<{
-  queryId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  parameters: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: true;
-  };
-  dateRange: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: true;
-  };
-  filters: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: true;
-  };
-  forceRefresh: {
-    type: _contractspec_lib_schema0.FieldType<boolean, boolean>;
-    isOptional: true;
-  };
-}>, _contractspec_lib_schema0.SchemaModel<{
-  queryId: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: false;
-  };
-  data: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: false;
-  };
-  columns: {
-    type: _contractspec_lib_schema0.FieldType<unknown, unknown>;
-    isOptional: false;
-  };
-  rowCount: {
-    type: _contractspec_lib_schema0.FieldType<number, number>;
-    isOptional: false;
-  };
-  executionTimeMs: {
-    type: _contractspec_lib_schema0.FieldType<number, number>;
-    isOptional: false;
-  };
-  cachedAt: {
-    type: _contractspec_lib_schema0.FieldType<Date, string>;
-    isOptional: true;
-  };
-  error: {
-    type: _contractspec_lib_schema0.FieldType<string, string>;
-    isOptional: true;
-  };
+export declare const ExecuteQueryContract: import("@contractspec/lib.contracts").OperationSpec<import("@contractspec/lib.schema").SchemaModel<{
+    queryId: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
+    };
+    parameters: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: true;
+    };
+    dateRange: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: true;
+    };
+    filters: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: true;
+    };
+    forceRefresh: {
+        type: import("@contractspec/lib.schema").FieldType<boolean, boolean>;
+        isOptional: true;
+    };
+}>, import("@contractspec/lib.schema").SchemaModel<{
+    queryId: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: false;
+    };
+    data: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: false;
+    };
+    columns: {
+        type: import("@contractspec/lib.schema").FieldType<unknown, unknown>;
+        isOptional: false;
+    };
+    rowCount: {
+        type: import("@contractspec/lib.schema").FieldType<number, number>;
+        isOptional: false;
+    };
+    executionTimeMs: {
+        type: import("@contractspec/lib.schema").FieldType<number, number>;
+        isOptional: false;
+    };
+    cachedAt: {
+        type: import("@contractspec/lib.schema").FieldType<Date, string>;
+        isOptional: true;
+    };
+    error: {
+        type: import("@contractspec/lib.schema").FieldType<string, string>;
+        isOptional: true;
+    };
 }>, undefined>;
-//#endregion
-export { CreateQueryContract, ExecuteQueryContract };
 //# sourceMappingURL=query.operation.d.ts.map

package/dist/query/query.operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.operation.d.ts","names":[],"sources":["../../src/query/query.operation.ts"],"mappings":";;;;;;;cAgBa,mBAAA,+BAAmB,aAAA,2BAAA,WAAA;;UA+C9B,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA/C8B,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAoDnB,oBAAA,+BAAoB,aAAA,2BAAA,WAAA;;UA8B/B,yBAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;UA9B+B,yBAAA,CAAA,SAAA"}
+{"version":3,"file":"query.operation.d.ts","sourceRoot":"","sources":["../../src/query/query.operation.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+C9B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA8B/B,CAAC"}