openalgo-charts 2.3.2 → 2.4.5

package/dist/workspace/index.d.ts

@@ -0,0 +1,170 @@
+import { ChartState, ChartSettingsState, IndicatorState } from 'openalgo-charts';
+
+declare class WorkspaceDocumentError extends Error {
+    constructor(message: string);
+}
+
+declare const WORKSPACE_VERSION = 1;
+type WorkspaceKind = 'workspace' | 'indicator-template';
+type WorkspaceSettings = Record<string, string | number | boolean>;
+type WorkspaceChartState = ChartState & ChartSettingsState & {
+    timezone?: string;
+};
+interface WorkspaceComparison {
+    id: string;
+    symbol: string;
+    exchange: string;
+    color?: string;
+    visible: boolean;
+}
+interface WorkspaceSlot {
+    paneId: string;
+    row: number;
+    column: number;
+    rowSpan: number;
+    columnSpan: number;
+}
+interface WorkspacePane {
+    id: string;
+    symbol: string;
+    exchange: string;
+    interval: string;
+    chartType: string;
+    chart: WorkspaceChartState;
+    settings: WorkspaceSettings;
+    volume: boolean;
+    magnet: 'off' | 'weak' | 'strong';
+    stay: boolean;
+    comparisons: WorkspaceComparison[];
+    comparisonMode: 'price' | 'percent';
+    historyPeriod?: string;
+}
+interface WorkspacePayload {
+    layout: {
+        rows: number;
+        columns: number;
+        slots: WorkspaceSlot[];
+        preset?: string;
+        rowWeights?: number[];
+        columnWeights?: number[];
+    };
+    panes: WorkspacePane[];
+    activePaneId: string;
+    sync: {
+        crosshair: boolean;
+        viewport: boolean;
+        symbol: boolean;
+        interval: boolean;
+    };
+}
+interface DocumentMetadata {
+    version: 1;
+    id: string;
+    name: string;
+    createdAt: number;
+    updatedAt: number;
+}
+interface WorkspaceDocument extends DocumentMetadata, WorkspacePayload {
+    kind: 'workspace';
+}
+interface IndicatorTemplateDocument extends DocumentMetadata {
+    kind: 'indicator-template';
+    indicators: IndicatorState[];
+}
+/** Keep repeated/custom descriptor IDs; availability is checked by the applying host. */
+declare function parseIndicatorStates(input: unknown): IndicatorState[];
+/** Validate, detach and project a portable chart-only workspace. */
+declare function parseWorkspaceDocument(input: unknown): WorkspaceDocument;
+declare function parseWorkspacePayload(input: unknown): WorkspacePayload;
+declare function parseIndicatorTemplate(input: unknown): IndicatorTemplateDocument;
+/** Explicit migration of the existing single-widget state; no input is modified. */
+declare function migrateWidgetWorkspace(input: unknown, meta: {
+    id: string;
+    name: string;
+    now: number;
+}): WorkspaceDocument;
+
+interface WorkspaceCatalog {
+    version: 1;
+    revision: number;
+    workspaces: WorkspaceDocument[];
+    templates: IndicatorTemplateDocument[];
+    recentWorkspaceIds: string[];
+    activeWorkspaceId: string | null;
+    autosave: boolean;
+}
+/** Cancellation is effective until the storage transaction commits. */
+interface WorkspaceOperationOptions {
+    signal?: AbortSignal;
+}
+interface WorkspaceOpenOptions extends WorkspaceOperationOptions {
+    /** Reject if a grid was prepared from a catalog that has since changed. */
+    expectedRevision?: number;
+}
+/** The host must atomically reject writes whose expectedRevision is stale. */
+interface WorkspaceStorage {
+    read(namespace: string): Promise<unknown | null>;
+    write(namespace: string, catalog: WorkspaceCatalog, expectedRevision: number, options?: WorkspaceOperationOptions): Promise<void>;
+}
+interface WorkspaceRepositoryOptions {
+    now?: () => number;
+    id?: () => string;
+}
+declare class WorkspaceConflictError extends Error {
+    constructor();
+}
+/** Parse the complete catalog before any mutation; corrupt storage is never replaced. */
+declare function parseWorkspaceCatalog(input: unknown): WorkspaceCatalog;
+/**
+ * Named configuration with serialized, revision-checked writes. Create a new
+ * repository when the account changes; an in-flight operation keeps its owner.
+ */
+declare class WorkspaceRepository {
+    private readonly _storage;
+    private readonly _namespace;
+    private readonly _now;
+    private readonly _id;
+    private _queue;
+    constructor(storage: WorkspaceStorage, namespace: string, options?: WorkspaceRepositoryOptions);
+    get namespace(): string;
+    load(): Promise<WorkspaceCatalog>;
+    createWorkspace(name: string, input: WorkspacePayload): Promise<WorkspaceDocument>;
+    saveWorkspace(id: string, input: WorkspacePayload): Promise<WorkspaceDocument>;
+    createTemplate(name: string, input: IndicatorState[]): Promise<IndicatorTemplateDocument>;
+    /** Update reusable study settings without changing the saved template identity. */
+    saveTemplate(id: string, input: IndicatorState[]): Promise<IndicatorTemplateDocument>;
+    rename(kind: WorkspaceKind, id: string, name: string): Promise<void>;
+    duplicate(kind: WorkspaceKind, id: string, name: string): Promise<WorkspaceDocument | IndicatorTemplateDocument>;
+    remove(kind: WorkspaceKind, id: string): Promise<void>;
+    openWorkspace(id: string, options?: WorkspaceOpenOptions): Promise<WorkspaceDocument>;
+    setAutosave(enabled: boolean): Promise<void>;
+    importDocument(input: unknown): Promise<WorkspaceDocument | IndicatorTemplateDocument>;
+    exportDocument(kind: WorkspaceKind, id: string): Promise<string>;
+    private _read;
+    private _transact;
+    private _find;
+    private _updatedAt;
+    private _newId;
+    private _insert;
+}
+
+interface IndexedDbWorkspaceStorage extends WorkspaceStorage {
+    /** Release the connection. Existing transactions may finish; new calls reject. */
+    close(): Promise<void>;
+}
+/**
+ * Browser persistence with one atomic compare-and-write transaction per catalog.
+ * Pass the host's indexedDB explicitly; importing this module needs no browser.
+ */
+declare function createIndexedDbWorkspaceStorage(factory: IDBFactory, databaseName?: string): IndexedDbWorkspaceStorage;
+
+type IndicatorTemplateMode = 'replace' | 'append';
+/**
+ * Validate and detach a study plan before the host changes a chart. Append keeps
+ * current instance identities and places positive incoming pane groups after the
+ * existing panes; pane zero remains the price pane. Copied studies have no identity.
+ * Pass the chart's pane count as nextPaneIndex. This function creates no chart or UI.
+ */
+declare function planIndicatorTemplate(current: IndicatorState[], incoming: IndicatorState[], mode: IndicatorTemplateMode, available: ReadonlySet<string>, nextPaneIndex: number): IndicatorState[];
+
+export { type IndexedDbWorkspaceStorage, type IndicatorTemplateDocument, type IndicatorTemplateMode, WORKSPACE_VERSION, type WorkspaceCatalog, type WorkspaceChartState, type WorkspaceComparison, WorkspaceConflictError, type WorkspaceDocument, WorkspaceDocumentError, type WorkspaceKind, type WorkspaceOpenOptions, type WorkspaceOperationOptions, type WorkspacePane, type WorkspacePayload, WorkspaceRepository, type WorkspaceRepositoryOptions, type WorkspaceSettings, type WorkspaceSlot, type WorkspaceStorage, createIndexedDbWorkspaceStorage, migrateWidgetWorkspace, parseIndicatorStates, parseIndicatorTemplate, parseWorkspaceCatalog, parseWorkspaceDocument, parseWorkspacePayload, planIndicatorTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openalgo-charts",
-  "version": "2.3.2",
+  "version": "2.4.5",
   "description": "From-scratch, dependency-free canvas charting engine for OpenAlgo: professional-grade interactive rendering, advanced on-chart trading, and a one-call widget tier that adds the toolbar, drawing rail, dialogs and shortcuts.",
   "license": "Apache-2.0",
   "author": "marketcalls",
@@ -63,6 +63,10 @@
       "types": "./dist/webgl/index.d.ts",
       "import": "./dist/openalgo-charts.webgl.mjs"
     },
+    "./workspace": {
+      "types": "./dist/workspace/index.d.ts",
+      "import": "./dist/openalgo-charts.workspace.mjs"
+    },
     "./widget": {
       "types": "./dist/widget/index.d.ts",
       "import": "./dist/openalgo-charts.widget.mjs"
@@ -99,10 +103,12 @@
     "size": "size-limit",
     "bench": "node scripts/bench-indicators.mjs",
     "soak": "node --expose-gc scripts/soak.mjs",
+    "endurance:browser": "node scripts/browser-endurance.mjs",
+    "test:endurance": "node --test scripts/browser-endurance.test.mjs",
     "skills:coverage": "node scripts/check-skills-coverage.mjs",
     "docs": "typedoc",
     "test:demo": "vitest run --config examples/yfinance/vitest.config.ts",
-    "verify": "npm run lint && npm run typecheck && npm run test && npm run build && npm run test:demo && npm run check:dts && npm run size && npm run shake",
+    "verify": "npm run lint && npm run typecheck && npm run test && npm run test:endurance && npm run build && npm run test:demo && npm run check:dts && npm run size && npm run shake",
     "prepublishOnly": "npm run verify",
     "check:dts": "node scripts/check-dts.mjs",
     "shake": "node scripts/check-shake.mjs"