@contractspec/example.analytics-dashboard 0.0.0-canary-20260113170453

package/dist/dashboard/dashboard.operation.d.ts

@@ -0,0 +1,537 @@
+import * as _contractspec_lib_contracts20 from "@contractspec/lib.contracts";
+import * as _contractspec_lib_schema195 from "@contractspec/lib.schema";
+
+//#region src/dashboard/dashboard.operation.d.ts
+/**
+ * Create a new analytics dashboard.
+ */
+declare const CreateDashboardContract: _contractspec_lib_contracts20.OperationSpec<_contractspec_lib_schema195.SchemaModel<{
+  name: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  slug: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  refreshInterval: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string]>;
+    isOptional: true;
+  };
+  dateRange: {
+    type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema195.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  slug: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string]>;
+    isOptional: false;
+  };
+  refreshInterval: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string]>;
+    isOptional: false;
+  };
+  isPublic: {
+    type: _contractspec_lib_schema195.FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  widgets: {
+    type: _contractspec_lib_schema195.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      dashboardId: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      name: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      type: {
+        type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+        isOptional: false;
+      };
+      gridX: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridY: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridWidth: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridHeight: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      queryId: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: true;
+      };
+      config: {
+        type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+        isOptional: true;
+      };
+    }>;
+    isArray: true;
+    isOptional: true;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema195.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, {
+  key: string;
+  version: string;
+  stability: string;
+  owners: "@example.analytics-dashboard"[];
+  tags: string[];
+  when: string;
+  payload: _contractspec_lib_schema195.SchemaModel<{
+    id: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    name: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    slug: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    description: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: true;
+    };
+    status: {
+      type: _contractspec_lib_schema195.EnumType<[string, string, string]>;
+      isOptional: false;
+    };
+    refreshInterval: {
+      type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string]>;
+      isOptional: false;
+    };
+    isPublic: {
+      type: _contractspec_lib_schema195.FieldType<boolean, boolean>;
+      isOptional: false;
+    };
+    widgets: {
+      type: _contractspec_lib_schema195.SchemaModel<{
+        id: {
+          type: _contractspec_lib_schema195.FieldType<string, string>;
+          isOptional: false;
+        };
+        dashboardId: {
+          type: _contractspec_lib_schema195.FieldType<string, string>;
+          isOptional: false;
+        };
+        name: {
+          type: _contractspec_lib_schema195.FieldType<string, string>;
+          isOptional: false;
+        };
+        type: {
+          type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+          isOptional: false;
+        };
+        gridX: {
+          type: _contractspec_lib_schema195.FieldType<number, number>;
+          isOptional: false;
+        };
+        gridY: {
+          type: _contractspec_lib_schema195.FieldType<number, number>;
+          isOptional: false;
+        };
+        gridWidth: {
+          type: _contractspec_lib_schema195.FieldType<number, number>;
+          isOptional: false;
+        };
+        gridHeight: {
+          type: _contractspec_lib_schema195.FieldType<number, number>;
+          isOptional: false;
+        };
+        queryId: {
+          type: _contractspec_lib_schema195.FieldType<string, string>;
+          isOptional: true;
+        };
+        config: {
+          type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+          isOptional: true;
+        };
+      }>;
+      isArray: true;
+      isOptional: true;
+    };
+    createdAt: {
+      type: _contractspec_lib_schema195.FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>;
+}[]>;
+/**
+ * Add a widget to a dashboard.
+ */
+declare const AddWidgetContract: _contractspec_lib_contracts20.OperationSpec<_contractspec_lib_schema195.SchemaModel<{
+  dashboardId: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  type: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+    isOptional: false;
+  };
+  gridX: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+  };
+  gridY: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+  };
+  gridWidth: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+  };
+  gridHeight: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+  };
+  queryId: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  config: {
+    type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema195.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  dashboardId: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  type: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+    isOptional: false;
+  };
+  gridX: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: false;
+  };
+  gridY: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: false;
+  };
+  gridWidth: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: false;
+  };
+  gridHeight: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: false;
+  };
+  queryId: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  config: {
+    type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+    isOptional: true;
+  };
+}>, {
+  key: string;
+  version: string;
+  stability: string;
+  owners: "@example.analytics-dashboard"[];
+  tags: string[];
+  when: string;
+  payload: _contractspec_lib_schema195.SchemaModel<{
+    id: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    dashboardId: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    name: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: false;
+    };
+    type: {
+      type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+      isOptional: false;
+    };
+    gridX: {
+      type: _contractspec_lib_schema195.FieldType<number, number>;
+      isOptional: false;
+    };
+    gridY: {
+      type: _contractspec_lib_schema195.FieldType<number, number>;
+      isOptional: false;
+    };
+    gridWidth: {
+      type: _contractspec_lib_schema195.FieldType<number, number>;
+      isOptional: false;
+    };
+    gridHeight: {
+      type: _contractspec_lib_schema195.FieldType<number, number>;
+      isOptional: false;
+    };
+    queryId: {
+      type: _contractspec_lib_schema195.FieldType<string, string>;
+      isOptional: true;
+    };
+    config: {
+      type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+      isOptional: true;
+    };
+  }>;
+}[]>;
+/**
+ * List dashboards.
+ */
+declare const ListDashboardsContract: _contractspec_lib_contracts20.OperationSpec<_contractspec_lib_schema195.SchemaModel<{
+  status: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string]>;
+    isOptional: true;
+  };
+  search: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  limit: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+    defaultValue: number;
+  };
+  offset: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: true;
+    defaultValue: number;
+  };
+}>, _contractspec_lib_schema195.SchemaModel<{
+  dashboards: {
+    type: _contractspec_lib_schema195.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      name: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      slug: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      description: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: true;
+      };
+      status: {
+        type: _contractspec_lib_schema195.EnumType<[string, string, string]>;
+        isOptional: false;
+      };
+      refreshInterval: {
+        type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string]>;
+        isOptional: false;
+      };
+      isPublic: {
+        type: _contractspec_lib_schema195.FieldType<boolean, boolean>;
+        isOptional: false;
+      };
+      widgets: {
+        type: _contractspec_lib_schema195.SchemaModel<{
+          id: {
+            type: _contractspec_lib_schema195.FieldType<string, string>;
+            isOptional: false;
+          };
+          dashboardId: {
+            type: _contractspec_lib_schema195.FieldType<string, string>;
+            isOptional: false;
+          };
+          name: {
+            type: _contractspec_lib_schema195.FieldType<string, string>;
+            isOptional: false;
+          };
+          type: {
+            type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+            isOptional: false;
+          };
+          gridX: {
+            type: _contractspec_lib_schema195.FieldType<number, number>;
+            isOptional: false;
+          };
+          gridY: {
+            type: _contractspec_lib_schema195.FieldType<number, number>;
+            isOptional: false;
+          };
+          gridWidth: {
+            type: _contractspec_lib_schema195.FieldType<number, number>;
+            isOptional: false;
+          };
+          gridHeight: {
+            type: _contractspec_lib_schema195.FieldType<number, number>;
+            isOptional: false;
+          };
+          queryId: {
+            type: _contractspec_lib_schema195.FieldType<string, string>;
+            isOptional: true;
+          };
+          config: {
+            type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+            isOptional: true;
+          };
+        }>;
+        isArray: true;
+        isOptional: true;
+      };
+      createdAt: {
+        type: _contractspec_lib_schema195.FieldType<Date, string>;
+        isOptional: false;
+      };
+    }>;
+    isArray: true;
+    isOptional: false;
+  };
+  total: {
+    type: _contractspec_lib_schema195.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Get a dashboard with widgets.
+ */
+declare const GetDashboardContract: _contractspec_lib_contracts20.OperationSpec<_contractspec_lib_schema195.SchemaModel<{
+  dashboardId: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  slug: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  shareToken: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema195.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  slug: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: false;
+  };
+  description: {
+    type: _contractspec_lib_schema195.FieldType<string, string>;
+    isOptional: true;
+  };
+  status: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string]>;
+    isOptional: false;
+  };
+  refreshInterval: {
+    type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string]>;
+    isOptional: false;
+  };
+  isPublic: {
+    type: _contractspec_lib_schema195.FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  widgets: {
+    type: _contractspec_lib_schema195.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      dashboardId: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      name: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: false;
+      };
+      type: {
+        type: _contractspec_lib_schema195.EnumType<[string, string, string, string, string, string, string, string, string, string, string, string]>;
+        isOptional: false;
+      };
+      gridX: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridY: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridWidth: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      gridHeight: {
+        type: _contractspec_lib_schema195.FieldType<number, number>;
+        isOptional: false;
+      };
+      queryId: {
+        type: _contractspec_lib_schema195.FieldType<string, string>;
+        isOptional: true;
+      };
+      config: {
+        type: _contractspec_lib_schema195.FieldType<unknown, unknown>;
+        isOptional: true;
+      };
+    }>;
+    isArray: true;
+    isOptional: true;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema195.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, undefined>;
+//#endregion
+export { AddWidgetContract, CreateDashboardContract, GetDashboardContract, ListDashboardsContract };
+//# sourceMappingURL=dashboard.operation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard.operation.d.ts","names":[],"sources":["../../src/dashboard/dashboard.operation.ts"],"sourcesContent":[],"mappings":";;;;;;;cAmBa,uDAAuB,0CAAA;EAAvB,IAAA,EAAA;IA+CX,IAAA,EAAA,2BAAA,CAAA,SAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;EA/CkC,CAAA;;;;;;;;;;;;;;;UAAA,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAAA,IAAA,yCAAA,CAAA;MAoDvB,EAAA,EAAA;QAgDX,IAAA,uCAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;;;;yBAhD4B;MAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;mDAAA,CAAA,MAAA,EAAA,MAAA,CAAA;QAAA,UAAA,EAAA,IAAA;MAqDjB,CAAA;MA8BX,MAAA,EAAA;;;;;IA9BiC,OAAA,EAAA,IAAA;;;;;;;;;;;;;;;;;;;;;;;;MAAA,IAAA,uCAAA,CAAA,MAAA,EAAA,MAAA,CAAA;MAmCtB,UAAA,EAAA,KA8BX;IAAA,CAAA;;;;IA9B+B,CAAA;;;;;;;;;;;;;;;;;;;;;sBAAA,KAAA;QAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAxFpB,iDAAiB,0CAAA;;UAgD5B,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAhD4B,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAqDjB,sDAAsB,0CAAA;;UA8BjC,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;cA9BiC,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAmCtB,oDAAoB,0CAAA;;UA8B/B,2BAAA,CAAA;;;;;;;;;;;;;UA9B+B,2BAAA,CAAA"}