@cellaware/utils 8.21.0 → 9.0.0

package/dist/chatwms/bi-studio.d.ts

@@ -1,3 +1,4 @@
+import { DataContext } from "./client.js";
 import { DatagridStateBase } from "./datagrid.js";
 import { Tag } from "./tag.js";
 export declare const BI_STUDIO_VISIBILITY_PRIVATE = "private";
@@ -37,3 +38,65 @@ export interface BiCanvasUsage {
     datetime: Date;
     customerLevel?: boolean;
 }
+export interface BIDataSourceExternal {
+    name: string;
+    displayName: string;
+    description: string;
+    tables: any[];
+    expressions: any[];
+    relationships: any[];
+    calendars: any[];
+}
+export interface BIDataSource {
+    dataSourceId: string;
+    revision: number;
+    dataSourceTitle: string;
+    dataSourceRoute: string;
+    contextName: DataContext;
+    description: string;
+    /** **Important:** will always be `public` for now -- we may allow `private` in the future. */
+    visibility: string;
+    readonly: boolean;
+    folder: string;
+    tags: Tag[];
+    views: BIDataSourceView[];
+    measures: BIDataSourceExpression[];
+    clientId: string;
+    userId: string;
+}
+export declare function initBIDataSource(): BIDataSource;
+export interface BIDataSourceView {
+    tableName: string;
+    displayName: string;
+    description: string;
+    query: string;
+    columns: BIDataSourceColumn[];
+    compiledQuery: string;
+    disabled?: boolean;
+}
+export interface BIDataSourceColumnRelationship {
+    tableName: string;
+    columnName: string;
+    type: 'many-to-one' | 'one-to-one' | 'many-to-many';
+}
+export interface BIDataSourceColumnCalendar {
+    /** https://www.ag-grid.com/studio/angular/calendars/#fragment-reference */
+    fragments: string[];
+}
+export interface BIDataSourceColumn {
+    columnName: string;
+    dataType: string;
+    description: string;
+    comment: string;
+    relationship?: BIDataSourceColumnRelationship;
+    /** Important: a calendar represents the semantics of a **particular** date -- each date field should have its own calendar. */
+    calendar?: BIDataSourceColumnCalendar;
+}
+/** https://www.ag-grid.com/studio/angular/expressions/#api */
+export interface BIDataSourceExpression {
+    columnName: string;
+    description: string;
+    comment: string;
+    /** https://www.ag-grid.com/studio/angular/expressions/#function-expression-operators */
+    expression: any;
+}

package/dist/chatwms/bi-studio.js

@@ -1,3 +1,5 @@
+import { CHATWMS_CONTEXT_NAME } from "./client.js";
+import { chatwmsGenerateRevision } from "./revision.js";
 export const BI_STUDIO_VISIBILITY_PRIVATE = 'private';
 export const BI_STUDIO_VISIBILITY_PUBLIC = 'public';
 export const BI_STUDIO_VISIBILITY_GLOBAL = 'global';
@@ -23,3 +25,21 @@ export function initBICanvasState() {
         datagridStates: []
     };
 }
+export function initBIDataSource() {
+    return {
+        dataSourceId: '',
+        revision: chatwmsGenerateRevision(),
+        dataSourceTitle: '',
+        dataSourceRoute: '',
+        contextName: CHATWMS_CONTEXT_NAME,
+        description: '',
+        visibility: BI_STUDIO_VISIBILITY_PRIVATE,
+        readonly: false,
+        folder: '',
+        tags: [],
+        views: [],
+        measures: [],
+        clientId: '',
+        userId: ''
+    };
+}

package/dist/chatwms/revision.d.ts

@@ -0,0 +1,2 @@
+export declare const CHATWMS_REVISION_DOES_NOT_EXIST = -1;
+export declare function chatwmsGenerateRevision(): number;

package/dist/chatwms/revision.js

@@ -0,0 +1,4 @@
+export const CHATWMS_REVISION_DOES_NOT_EXIST = -1;
+export function chatwmsGenerateRevision() {
+    return Date.now();
+}

package/dist/chatwms/tag.d.ts

@@ -1,3 +1,4 @@
+export declare const TAG_COLORS: string[];
 export interface Tag {
     name: string;
     color: string;

package/dist/chatwms/tag.js

@@ -1 +1 @@
-export {};
+export const TAG_COLORS = ['tag-red', 'tag-orange', 'tag-yellow', 'tag-green', 'tag-teal', 'tag-cyan', 'tag-blue', 'tag-indigo', 'tag-violet', 'tag-purple', 'tag-pink', 'tag-gray'];

package/dist/chatwms/user.d.ts

@@ -24,6 +24,7 @@ export interface ChatWMSUserSettings {
     language: string;
     theme: ChatWMSTheme;
     analystOption?: ChatWMSAnalystOption;
+    /** Deprecated: this is a legacy value that can no longer be written to. It still exists here due legacy support requirements. */
     developer?: boolean;
     dateFormat?: ChatWMSDateFormat;
     clientId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cellaware/utils",
-    "version": "8.21.0",
+    "version": "9.0.0",
     "description": "Cellaware Utilities for Node.js",
     "author": "Cellaware Technologies",
     "type": "module",