@cellaware/utils 8.11.19 → 8.11.20

package/dist/chatwms/developer.d.ts

@@ -0,0 +1,27 @@
+import { KeyValuePair } from "../util.js";
+import { DataContext } from "./client.js";
+export interface SqlCacheContext {
+    contextName: DataContext;
+    variables: KeyValuePair[];
+    tables: {
+        table_name: string;
+        table_description: string;
+    }[];
+    columns: {
+        table_name: string;
+        column_id: number;
+        column_name: string;
+        data_type: string;
+        column_description: string;
+        column_comment: string;
+    }[];
+    functions: {
+        name: string;
+        type: string;
+        args: string[];
+        description: string;
+    }[];
+    tableMappings: KeyValuePair[];
+    columnMappings: KeyValuePair[];
+}
+export declare function initSqlCacheContext(): SqlCacheContext;

package/dist/chatwms/developer.js

@@ -0,0 +1,12 @@
+import { CHATWMS_CONTEXT_NAME } from "./client.js";
+export function initSqlCacheContext() {
+    return {
+        contextName: CHATWMS_CONTEXT_NAME,
+        variables: [],
+        tables: [],
+        columns: [],
+        functions: [],
+        tableMappings: [],
+        columnMappings: []
+    };
+}

package/dist/chatwms/github/issue.d.ts

@@ -0,0 +1 @@
+export declare function chatwmsGithubCreateIssue(title: string, body: any, labels: string[]): Promise<boolean>;

package/dist/chatwms/github/issue.js

@@ -0,0 +1,4 @@
+import { githubCreateIssue } from "../../github/issue.js";
+export async function chatwmsGithubCreateIssue(title, body, labels) {
+    return githubCreateIssue(`https://api.github.com/repos/cellaware/chatwms-feedback/issues`, title, body, labels);
+}

package/dist/chatwms/instance.d.ts

@@ -0,0 +1,16 @@
+export interface ChatWMSInstance {
+    id: string;
+    clientId: string;
+    customer: string;
+    description: string;
+    url: string;
+    key: string;
+}
+export declare function initChatWMSInstance(): ChatWMSInstance;
+export interface ChatWMSInstanceWarehouse {
+    instanceId: string;
+    clientId: string;
+    customer: string;
+    warehouse: string;
+}
+export declare function initChatWMSInstanceWarehouse(): ChatWMSInstanceWarehouse;

package/dist/chatwms/instance.js

@@ -0,0 +1,18 @@
+export function initChatWMSInstance() {
+    return {
+        id: '',
+        clientId: '',
+        customer: '',
+        description: '',
+        url: '',
+        key: ''
+    };
+}
+export function initChatWMSInstanceWarehouse() {
+    return {
+        instanceId: '',
+        clientId: '',
+        customer: '',
+        warehouse: '',
+    };
+}

package/dist/chatwms/integration.d.ts

@@ -0,0 +1,24 @@
+export declare const INTEGRATION_VISIBILITY_PRIVATE = "private";
+export declare const INTEGRATION_VISIBILITY_PUBLIC = "public";
+export declare const INTEGRATION_VENDOR_TEAMS = "teams";
+export declare const INTEGRATION_VENDOR_SLACK = "slack";
+export declare const INTEGRATION_TYPE_WEBHOOK = "webhook";
+export interface SubscriptionIntegration {
+    integrationId: string;
+    name: string;
+    description: string;
+    visibility: string;
+    readonly: boolean;
+    /**
+     * `teams` | `slack`
+     */
+    vendor: string;
+    /**
+     * `webhook`
+     */
+    type: string;
+    url: string;
+    clientId: string;
+    userId: string;
+}
+export declare function initSubscriptionIntegration(): SubscriptionIntegration;

package/dist/chatwms/integration.js

@@ -0,0 +1,19 @@
+export const INTEGRATION_VISIBILITY_PRIVATE = 'private';
+export const INTEGRATION_VISIBILITY_PUBLIC = 'public';
+export const INTEGRATION_VENDOR_TEAMS = 'teams';
+export const INTEGRATION_VENDOR_SLACK = 'slack';
+export const INTEGRATION_TYPE_WEBHOOK = 'webhook';
+export function initSubscriptionIntegration() {
+    return {
+        integrationId: '',
+        name: '',
+        description: '',
+        visibility: INTEGRATION_VISIBILITY_PRIVATE,
+        readonly: false,
+        vendor: INTEGRATION_VENDOR_TEAMS,
+        type: INTEGRATION_TYPE_WEBHOOK,
+        url: '',
+        clientId: '',
+        userId: ''
+    };
+}

package/dist/chatwms/pdf.d.ts

@@ -0,0 +1,95 @@
+export interface PdfOptions {
+    /**
+     * Display header and footer. Defaults to `false`.
+     */
+    displayHeaderFooter?: boolean;
+    /**
+     * HTML template for the print footer. Should use the same format as the
+     * [`headerTemplate`](https://playwright.dev/docs/api/class-page#page-pdf-option-header-template).
+     */
+    footerTemplate?: string;
+    /**
+     * Paper format. If set, takes priority over
+     * [`width`](https://playwright.dev/docs/api/class-page#page-pdf-option-width) or
+     * [`height`](https://playwright.dev/docs/api/class-page#page-pdf-option-height) options. Defaults to 'Letter'.
+     */
+    format?: string;
+    /**
+     * HTML template for the print header. Should be valid HTML markup with following classes used to inject printing
+     * values into them:
+     * - `'date'` formatted print date
+     * - `'title'` document title
+     * - `'url'` document location
+     * - `'pageNumber'` current page number
+     * - `'totalPages'` total pages in the document
+     */
+    headerTemplate?: string;
+    /**
+     * Paper height, accepts values labeled with units.
+     */
+    height?: string | number;
+    /**
+     * Paper orientation. Defaults to `false`.
+     */
+    landscape?: boolean;
+    /**
+     * Paper margins, defaults to none.
+     */
+    margin?: {
+        /**
+         * Top margin, accepts values labeled with units. Defaults to `0`.
+         */
+        top?: string | number;
+        /**
+         * Right margin, accepts values labeled with units. Defaults to `0`.
+         */
+        right?: string | number;
+        /**
+         * Bottom margin, accepts values labeled with units. Defaults to `0`.
+         */
+        bottom?: string | number;
+        /**
+         * Left margin, accepts values labeled with units. Defaults to `0`.
+         */
+        left?: string | number;
+    };
+    /**
+     * Whether or not to embed the document outline into the PDF. Defaults to `false`.
+     */
+    outline?: boolean;
+    /**
+     * Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
+     */
+    pageRanges?: string;
+    /**
+     * The file path to save the PDF to. If [`path`](https://playwright.dev/docs/api/class-page#page-pdf-option-path) is a
+     * relative path, then it is resolved relative to the current working directory. If no path is provided, the PDF won't
+     * be saved to the disk.
+     */
+    path?: string;
+    /**
+     * Give any CSS `@page` size declared in the page priority over what is declared in
+     * [`width`](https://playwright.dev/docs/api/class-page#page-pdf-option-width) and
+     * [`height`](https://playwright.dev/docs/api/class-page#page-pdf-option-height) or
+     * [`format`](https://playwright.dev/docs/api/class-page#page-pdf-option-format) options. Defaults to `false`, which
+     * will scale the content to fit the paper size.
+     */
+    preferCSSPageSize?: boolean;
+    /**
+     * Print background graphics. Defaults to `false`.
+     */
+    printBackground?: boolean;
+    /**
+     * Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
+     */
+    scale?: number;
+    /**
+     * Whether or not to generate tagged (accessible) PDF. Defaults to `false`.
+     */
+    tagged?: boolean;
+    /**
+     * Paper width, accepts values labeled with units.
+     */
+    width?: string | number;
+}
+export declare function generatePdf(html: string, options?: PdfOptions): Promise<Buffer>;

package/dist/chatwms/pdf.js

@@ -0,0 +1,147 @@
+import { sleep } from "../util.js";
+/*
+
+In summary -- try to generate a PDF, and if Browserless is busy, politely wait and try again a few times — then give up cleanly.
+
+Step by step details:
+
+1. Send HTML to Browserless
+   - We make an HTTP request to Browserless’s `/pdf` endpoint.
+   - Browserless runs a browser, renders the HTML, and sends back a PDF.
+
+2. If it works → we’re done
+   - We return the PDF immediately.
+
+3. If Browserless is too busy
+   - Browserless may say:
+     - “Too many requests” (429), or
+     - “Service temporarily unavailable” (503/502/504)
+   - This usually means you hit your concurrency limit, not that something is broken.
+
+4. When that happens
+   - We wait a bit
+   - Then try again
+   - But:
+     - We don’t retry forever
+     - We wait slightly longer each time
+     - We add a little randomness so many requests don’t retry at once
+
+5. If Browserless tells us how long to wait
+   - We listen (`Retry-After` header)
+   - That’s the best signal
+
+6. If the request hangs or the network glitches
+   - We cancel it after a timeout
+   - Then retry (once or twice)
+
+7. If it keeps failing
+   - We stop retrying
+   - We throw a clear error explaining what happened
+*/
+const ENDPOINT = "https://production-sfo.browserless.io/pdf";
+const TIMEOUT_MS = 60_000;
+const RETRIES = 3;
+const BASE_DELAY_MS = 3_000;
+const MAX_DELAY_MS = 15_000;
+const JITTER_MS = 1_000;
+function parseRetryAfterMs(retryAfter) {
+    if (!retryAfter)
+        return null;
+    const asSeconds = Number(retryAfter);
+    if (Number.isFinite(asSeconds) && asSeconds >= 0)
+        return Math.floor(asSeconds * 1000);
+    const asDate = Date.parse(retryAfter);
+    if (!Number.isNaN(asDate)) {
+        const delta = asDate - Date.now();
+        return delta > 0 ? delta : 0;
+    }
+    return null;
+}
+function backoffMs(attempt) {
+    const backoff = BASE_DELAY_MS * Math.pow(2, Math.max(0, attempt - 1));
+    const capped = Math.min(backoff, MAX_DELAY_MS);
+    const jitter = Math.floor(Math.random() * (JITTER_MS + 1));
+    return capped + jitter;
+}
+function shouldRetryStatus(status) {
+    return status === 429 || status === 503 || status === 502 || status === 504;
+}
+export async function generatePdf(html, options) {
+    const token = process.env.BROWSERLESS_TOKEN;
+    if (!token) {
+        throw new Error('PDF: `BROWSER_TOKEN` environment variable is not set');
+    }
+    const url = new URL(ENDPOINT);
+    url.searchParams.set("token", token);
+    const totalAttempts = 1 + RETRIES;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+            console.log(`PDF: attempt ${attempt} timed out after ${TIMEOUT_MS}ms`);
+            controller.abort();
+        }, TIMEOUT_MS);
+        try {
+            const res = await fetch(url.toString(), {
+                method: "POST",
+                headers: {
+                    "content-type": "application/json",
+                    "accept": "application/pdf",
+                },
+                body: JSON.stringify({
+                    html,
+                    options: options ??
+                        {
+                            format: "Letter",
+                            printBackground: true,
+                            preferCSSPageSize: true,
+                        }
+                }),
+                signal: controller.signal,
+            });
+            if (res.ok) {
+                const ab = await res.arrayBuffer();
+                return Buffer.from(ab);
+            }
+            console.log(`PDF: attempt ${attempt} failed with status ${res.status} ${res.statusText}`);
+            const retryable = shouldRetryStatus(res.status);
+            if (retryable && attempt < totalAttempts) {
+                const retryAfter = parseRetryAfterMs(res.headers.get("retry-after"));
+                const delay = retryAfter !== null
+                    ? retryAfter + Math.floor(Math.random() * (JITTER_MS + 1))
+                    : backoffMs(attempt);
+                console.log(`PDF: retryable failure (status ${res.status}), waiting ${delay}ms before retry`);
+                await sleep(delay);
+                continue;
+            }
+            const bodyText = await res.text().catch(() => "");
+            const preview = bodyText ? bodyText.slice(0, 1000) : "";
+            throw new Error(`PDF: Browserless /pdf failed (${res.status} ${res.statusText})` + (preview ? ` — ${preview}` : ""));
+        }
+        catch (err) {
+            const isAbort = err?.name === "AbortError";
+            const isTransientNetwork = isAbort ||
+                err?.code === "ECONNRESET" ||
+                err?.code === "ETIMEDOUT" ||
+                err?.code === "EAI_AGAIN" ||
+                err?.cause?.code === "ECONNRESET" ||
+                err?.cause?.code === "ETIMEDOUT";
+            if (isAbort) {
+                console.log(`PDF: attempt ${attempt} aborted`);
+            }
+            else {
+                console.log(`PDF: attempt ${attempt} threw error`, err);
+            }
+            if (isTransientNetwork && attempt < totalAttempts) {
+                const delay = backoffMs(attempt);
+                console.log(`PDF: transient error, waiting ${delay}ms before retry`);
+                await sleep(delay);
+                continue;
+            }
+            throw err;
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+    throw new Error("PDF: Browserless /pdf failed");
+}

package/dist/chatwms/report.d.ts

@@ -0,0 +1,126 @@
+import { DataContext } from "./client.js";
+import { DatagridStateBase } from "./datagrid.js";
+import { SubscriptionIntegration } from "./integration.js";
+export declare const REPORT_VISIBILITY_PRIVATE = "private";
+export declare const REPORT_VISIBILITY_PUBLIC = "public";
+export declare const REPORT_VISIBILITY_GLOBAL = "global";
+export interface ReportParameter {
+    sequence: number;
+    name: string;
+    required: boolean;
+    exampleValue: string;
+}
+export interface ReportParameterValue {
+    parameterName: string;
+    /** `text` | `number` | `date` | `boolean` */
+    dataType: string;
+    rule: string;
+    value: string;
+    value2?: string;
+}
+export declare function initReportParameterValue(): ReportParameterValue;
+export interface Report {
+    reportId: string;
+    reportTitle: string;
+    reportRoute: string;
+    visibility: string;
+    readonly: boolean;
+    landscape?: boolean;
+    parameters: ReportParameter[];
+    folder: string;
+    brief: string;
+    email?: {
+        subject: string;
+        body: string;
+    };
+    clientId: string;
+    userId: string;
+    customerLevel?: boolean;
+}
+export declare function initReport(): Report;
+export interface ReportWithLines extends Report {
+    lines: ReportLine[];
+}
+export interface InstanceReport extends ReportWithLines {
+    schedules: InstanceReportSchedule[];
+}
+export interface LineReportParameter {
+    parameterName: string;
+    columnName: string;
+}
+export interface ReportLineContentInfo extends DatagridStateBase {
+    visualizationOption: string;
+    reportParameters: LineReportParameter[];
+    contextName: DataContext;
+    specification: string;
+    query: string;
+    summary: string;
+    reviewOk?: boolean;
+    reviewConfidence?: string;
+    reviewFeedback?: string;
+    tableGroups?: string[];
+    developer?: boolean;
+    archive?: boolean;
+    referenceLineId?: string;
+}
+export interface ReportLine {
+    lineId: string;
+    lineTitle: string;
+    reportId: string;
+    contentInfo: ReportLineContentInfo;
+    sequence: number;
+    clientId: string;
+    userId: string;
+}
+export interface ReportLineResult {
+    rows: any[];
+    htmlRows: string;
+    teamsRows: any[];
+    chartRows: any[];
+    htmlTranspose: string;
+    teamsTranspose: any[];
+    briefRows: string;
+    briefRowCount: number;
+}
+export declare function initReportLineResult(): ReportLineResult;
+export interface ReportUsage {
+    reportId: string;
+    reportTitle: string;
+    visibility: string;
+    clientId: string;
+    userId: string;
+    datetime: Date;
+    customerLevel?: boolean;
+}
+export interface ReportSchedule {
+    scheduleId: string;
+    reportId: string;
+    enabled: boolean;
+    cronExpression: string;
+    popup?: boolean;
+    email?: boolean;
+    additionalEmails?: string[];
+    integrations?: string[];
+    excel?: boolean;
+    parameterValues?: ReportParameterValue[];
+    /**
+     * **Important:** An undefined/empty array indicates that all lines are selected.
+     */
+    lineIds?: string[];
+    clientId: string;
+    userId: string;
+    userDetails: string;
+}
+export declare function initReportSchedule(): ReportSchedule;
+export interface InstanceReportSchedule {
+    cronExpression: string;
+    popups: Set<string>;
+    emails: Set<string>;
+    integrations: Set<SubscriptionIntegration>;
+    excel: boolean;
+    parameterValues: ReportParameterValue[];
+    /**
+     * ***Important:** An empty array indicates that all lines are selected.
+     */
+    lineIds: string[];
+}

package/dist/chatwms/report.js

@@ -0,0 +1,55 @@
+export const REPORT_VISIBILITY_PRIVATE = 'private';
+export const REPORT_VISIBILITY_PUBLIC = 'public';
+export const REPORT_VISIBILITY_GLOBAL = 'global';
+export function initReportParameterValue() {
+    return {
+        parameterName: '',
+        dataType: '',
+        rule: '',
+        value: ''
+    };
+}
+export function initReport() {
+    return {
+        reportId: '',
+        reportTitle: '',
+        reportRoute: '',
+        visibility: REPORT_VISIBILITY_PRIVATE,
+        readonly: false,
+        parameters: [],
+        folder: '',
+        brief: '',
+        clientId: '',
+        userId: ''
+    };
+}
+export function initReportLineResult() {
+    return {
+        rows: [],
+        htmlRows: '',
+        teamsRows: [],
+        chartRows: [],
+        htmlTranspose: '',
+        teamsTranspose: [],
+        briefRows: '',
+        briefRowCount: 0,
+    };
+}
+export function initReportSchedule() {
+    return {
+        scheduleId: '',
+        reportId: '',
+        enabled: false,
+        cronExpression: '',
+        popup: false,
+        email: false,
+        additionalEmails: [],
+        integrations: [],
+        excel: false,
+        parameterValues: [],
+        lineIds: [],
+        clientId: '',
+        userId: '',
+        userDetails: ''
+    };
+}

package/dist/chatwms/response.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Throws error if `res` is not ok.
+ *
+ * **Note:** will throw message 'An error occurred. Please try again in a moment.' if none provided.
+ */
+export declare function assertResponseOk(res: Response, message?: string): Response;
+export interface ChatWMSResponse {
+    ok: boolean;
+    error: string;
+    data: any;
+}
+/**
+ * Initialization:
+ * - `ok`: `true`
+ * - `error`: `''`
+ * - `data`: `{}`
+ */
+export declare function initChatWMSResponse(data?: any): ChatWMSResponse;

package/dist/chatwms/response.js

@@ -0,0 +1,25 @@
+const RESPONSE_ERROR_MESSAGE = 'An error occurred. Please try again in a moment.';
+/**
+ * Throws error if `res` is not ok.
+ *
+ * **Note:** will throw message 'An error occurred. Please try again in a moment.' if none provided.
+ */
+export function assertResponseOk(res, message) {
+    if (!res.ok) {
+        throw new Error(message ?? RESPONSE_ERROR_MESSAGE);
+    }
+    return res;
+}
+/**
+ * Initialization:
+ * - `ok`: `true`
+ * - `error`: `''`
+ * - `data`: `{}`
+ */
+export function initChatWMSResponse(data) {
+    return {
+        ok: true,
+        error: '',
+        data: data ?? {}
+    };
+}

package/dist/chatwms/search.d.ts

@@ -0,0 +1,12 @@
+export declare enum SearchRecordType {
+    DASHBOARD = "dashboard",
+    DASHBOARD_WIDGET = "dashboard_widget",
+    DASHBOARD_FOLDER = "dashboard_folder",
+    REPORT = "report",
+    REPORT_LINE = "report_line",
+    REPORT_FOLDER = "report_folder"
+}
+export interface SearchRecord {
+    type: SearchRecordType;
+    data: any;
+}

package/dist/chatwms/search.js

@@ -0,0 +1,9 @@
+export var SearchRecordType;
+(function (SearchRecordType) {
+    SearchRecordType["DASHBOARD"] = "dashboard";
+    SearchRecordType["DASHBOARD_WIDGET"] = "dashboard_widget";
+    SearchRecordType["DASHBOARD_FOLDER"] = "dashboard_folder";
+    SearchRecordType["REPORT"] = "report";
+    SearchRecordType["REPORT_LINE"] = "report_line";
+    SearchRecordType["REPORT_FOLDER"] = "report_folder";
+})(SearchRecordType || (SearchRecordType = {}));