@qaecy/cue-sdk 0.0.33 → 0.0.35

package/lib/sync.d.ts

@@ -0,0 +1,153 @@
+import { CueBlobStorage } from 'js-databases';
+import { LocalFile } from 'js-sync-tools';
+import { CueAuth } from './auth';
+import { CueApi } from './api';
+import { CueProfile } from './profile';
+import { CueProjects } from './project';
+import { ScanOutputRecord, SyncOptions, SyncPreview, SyncResult } from './models';
+/**
+ * Configure the URL from which the WASM scanner assets are loaded in browser environments.
+ * Call this once during app initialisation (e.g. Angular APP_INITIALIZER) before any credit
+ * calculations are requested.
+ *
+ * @param baseUrl - URL prefix for `dir_scanner_wasm_bg.wasm` and `dir_scanner_wasm.mjs`,
+ *   e.g. `'/assets/wasm'` or `'https://cdn.example.com/wasm'`.
+ */
+export declare function configureScanWasm(baseUrl: string): void;
+export declare class CueSyncApi {
+    private readonly _auth;
+    private readonly _projects;
+    private readonly _blob;
+    private readonly _gatewayUrl;
+    private readonly _graphMap;
+    private _api?;
+    private _profile?;
+    private _pendingItems;
+    private _pendingSpaceId;
+    private _flushTimer;
+    private _legacy;
+    constructor(_auth: CueAuth, _projects: CueProjects, _blob: CueBlobStorage, _gatewayUrl: string);
+    /** @internal Injected by CueApi after construction to avoid circular dependency. */
+    _bindApi(api: CueApi): void;
+    /** @internal Injected by Cue after construction so sync can read/refresh org-level credits. */
+    _bindProfile(profile: CueProfile): void;
+    /**
+     * Credits are tracked per-organization (a shared pool across every project
+     * the org owns), not per-project — resolve the project's org and read from
+     * there instead of the legacy per-project `getConsumption` endpoint.
+     * `unitsAvailable` is set to the same org-level `available` figure, mirroring
+     * how the legacy per-project formula already treated the two as the same pool.
+     *
+     * Goes through `CueProfile.getOrgCredits()` rather than fetching directly so
+     * its `orgCredits` signal also refreshes as a side effect — consumers bound
+     * to that signal see balance changes after every preview/sync automatically.
+     */
+    private _getAvailableCredits;
+    /**
+     * Initialises browser-mode sync for a project space.
+     * - Flushes any metadata items that were queued but not sent in a previous session
+     *   (persisted in `localStorage`).
+     * - Starts the 60-second periodic flush timer.
+     *
+     * Call this once when the file manager component is created (or when the active
+     * project changes) so that interrupted uploads are recovered immediately.
+     */
+    initBrowserSync(spaceId: string): Promise<void>;
+    /**
+     * Pushes filesystem-structure metadata for all provided files directly to the
+     * commands API, without checking what is already on the remote or accounting for
+     * credits.  Use this when you want to force-write metadata for every file in a
+     * local path (e.g. to repair missing graph data after a migration).
+     */
+    pushAllMetadata(localFiles: LocalFile[], options: Pick<SyncOptions, 'spaceId' | 'providerId' | 'verbose' | 'legacy'>): Promise<void>;
+    /**
+     * Flushes any pending file-location metadata from a previously interrupted sync.
+     * Safe to call even when there are no new files to upload (e.g. when the process
+     * died after uploading to blob storage but before the commands-API batch POST).
+     */
+    flushPendingMetadata(spaceId: string, verbose?: boolean, legacy?: boolean): Promise<void>;
+    /**
+     * Returns a preview of what would be synced: cost breakdown for new files only,
+     * units required, and units still available. Use this before calling {@link sync}
+     * to show the user an accurate cost estimate.
+     */
+    previewSync(localFiles: LocalFile[], options: SyncOptions): Promise<SyncPreview>;
+    sync(localFiles: LocalFile[], options: SyncOptions): Promise<SyncResult>;
+    private _getOrCreateGraph;
+    private _listRemoteFiles;
+    private _getGraphFiles;
+    private _initPendingBatch;
+    private _queueFileLocation;
+    /**
+     * Flush all queued file-location items to the commands API in a single batch.
+     * Call this once after a group of `syncBrowserFile` calls completes so that
+     * all items are sent together rather than one POST per file.
+     *
+     * Also refreshes the org's credit pool (best-effort) once the batch is
+     * flushed, so `CueProfile.orgCredits` reflects the just-uploaded files
+     * without the caller having to remember to ask for it — `syncBrowserFile`
+     * itself never touches credits, unlike the CLI's `sync()`.
+     */
+    drainPending(): Promise<void>;
+    private _drainPending;
+    private _flushBatch;
+    private _postFssBatch;
+    private _stopFlushTimer;
+    /**
+     * Scans `localFiles` and returns a per-extension cost breakdown.
+     *
+     * Each {@link ScanOutputRecord} contains `units` — the billable metric for
+     * that extension (e.g. pages for PDFs, rows for spreadsheets) — which can be
+     * shown to the user before or after calling {@link sync}.
+     */
+    scanCost(localFiles: LocalFile[]): Promise<ScanOutputRecord[]>;
+    /**
+     * Compute the credit cost for a set of local files without uploading anything.
+     * Intended for browser use where the full {@link previewSync} (which requires a
+     * remote file listing) would be too heavy for a quick estimate.
+     *
+     * @param localFiles - Files to analyse.  Each entry must carry `data` when
+     *   called from a browser context.
+     * @param spaceId    - Project/space identifier used to fetch tier settings and resolve the owning org.
+     * @returns Per-extension cost breakdown and the number of credits currently
+     *   available in the project's organization (shared pool).
+     */
+    computeCredits(localFiles: LocalFile[], spaceId: string): Promise<{
+        costRecords: ScanOutputRecord[];
+        creditsToConsume: number;
+        creditsAvailable: number;
+    }>;
+    /**
+     * Upload a single browser-supplied file and write its metadata to the knowledge graph.
+     *
+     * Unlike {@link sync} (which performs a full remote comparison), this method is
+     * designed for the web file-manager flow where the user has already confirmed the
+     * upload via the credit modal.  The file's binary data must be provided in
+     * `file.data`; the `file.fullPath` field is ignored.
+     *
+     * Cancellation is supported via `options.signal`.  Aborting the signal cancels
+     * the Firebase Storage upload; metadata is never written for a cancelled upload.
+     *
+     * @param file    - `LocalFile` with `data` populated (e.g. from `File.arrayBuffer()`).
+     * @param options - Upload options including project/provider/user context and an
+     *   optional `AbortSignal` for cancellation and `onProgress` for tracking.
+     */
+    syncBrowserFile(file: LocalFile, options: {
+        spaceId: string;
+        providerId: string;
+        userId: string;
+        signal?: AbortSignal;
+        onProgress?: (percent: number) => void;
+    }): Promise<void>;
+    getTierNames(): Promise<Record<string, string>>;
+    /**
+     * Per-extension credit rates for `tier` (e.g. `{ pdf: 4, ifc: 2, dwg: 2 }`),
+     * read from the public `unit-credit.json` rate table. Used by host apps to
+     * show usage estimates (e.g. the sign-up plan-selection step) without
+     * running a full {@link computeCredits} scan.
+     */
+    getUnitCredits(tier: 's' | 'm' | 'l'): Promise<Record<string, number>>;
+    private _fetchTierNames;
+    private _fetchUnitCreditMap;
+    private _logProgress;
+}

package/lib/tables.d.ts

@@ -0,0 +1,14 @@
+import { CueAuth } from './auth';
+export interface ProjectTable {
+    id: string;
+    title: string;
+    columnDefs: Record<string, unknown>[];
+    rowDef: string;
+}
+export declare class CueTables {
+    private readonly _auth;
+    private readonly _gatewayUrl;
+    constructor(_auth: CueAuth, _gatewayUrl: string);
+    listTables(projectId: string): Promise<ProjectTable[]>;
+    saveTables(tables: ProjectTable[] | unknown[], projectId: string): Promise<void>;
+}

package/lib/user-settings.d.ts

@@ -0,0 +1,22 @@
+import { CueAuth } from './auth';
+/**
+ * Global, per-user app settings — a single small JSON blob (capped at 100KB
+ * server-side), scoped to the current user only. Unlike {@link CueAppData}
+ * (which namespaces data per studio-app UUID), this is one blob shared across
+ * the whole portal, e.g. `{ language: 'da' }`.
+ */
+export declare class CueUserSettings {
+    private readonly _auth;
+    private readonly _gatewayUrl;
+    constructor(_auth: CueAuth, _gatewayUrl: string);
+    /**
+     * Fetch the current user's settings.
+     * Returns `null` if nothing has been saved yet.
+     */
+    get<T = unknown>(): Promise<T | null>;
+    /**
+     * Save the current user's settings. Overwrites any previous value.
+     * The server rejects payloads larger than 100KB.
+     */
+    set(data: unknown): Promise<void>;
+}

package/node.js

@@ -1,34 +1,43 @@
-import { C as s } from "./document-filter-Cmavbe75.js";
-import { a as r, b as c, c as i, d as n, e as l, f as m, g as p, h as P, i as d, j, k as x, l as S, m as f, n as g, o as h, p as E, q as R, r as A, s as v, R as D, t as b, u as I, v as W } from "./document-filter-Cmavbe75.js";
-class t extends s {
+import { C as s } from "./document-filter-Dr_-QbaZ.js";
+import { B as o, f as c, A as i, D as n, c as p, v as E, z as S, w as P, m as R, y as m, a as A, g, h as l, s as x, k as j, r as D, o as U, n as d, l as f, p as h, q as y, e as I, d as N, t as _, b, i as q, x as v, E as w, R as B, S as O, j as T, u as k } from "./document-filter-Dr_-QbaZ.js";
+class C extends s {
   constructor(e) {
     super(e);
   }
 }
 export {
+  o as BASE_CURRENCY,
   s as Cue,
-  r as CueApi,
-  c as CueAuth,
-  i as CueCache,
-  n as CueContexts,
-  l as CueDocumentFilter,
+  c as CueApi,
+  i as CueAppData,
+  n as CueApps,
+  p as CueAuth,
+  E as CueCache,
+  S as CueContexts,
+  P as CueCurrency,
+  R as CueDocumentFilter,
   m as CueExtraction,
-  p as CueGis,
-  P as CueIndexApi,
-  t as CueNode,
-  d as CuePrivileges,
-  j as CueProfile,
-  x as CueProjectDocuments,
-  S as CueProjectEntities,
+  A as CueGis,
+  g as CueIndexApi,
+  l as CueMcp,
+  C as CueNode,
+  x as CuePrivileges,
+  j as CueProcessingApi,
+  D as CueProfile,
+  U as CueProjectDocuments,
+  d as CueProjectEntities,
   f as CueProjectSchema,
-  g as CueProjectView,
-  h as CueProjects,
-  E as CueSignal,
-  R as CueStorage,
-  A as CueSyncApi,
+  h as CueProjectView,
+  y as CueProjects,
+  I as CueRequestError,
+  N as CueSignUp,
+  _ as CueSignal,
+  b as CueStorage,
+  q as CueSyncApi,
   v as CueTables,
-  D as REQUIRED_ROLES,
-  b as configureScanWasm,
-  I as cueComputed,
-  W as staleWhileRevalidate
+  w as CueUserSettings,
+  B as REQUIRED_ROLES,
+  O as SUPPORTED_CURRENCIES,
+  T as configureScanWasm,
+  k as cueComputed
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qaecy/cue-sdk",
-  "version": "0.0.33",
+  "version": "0.0.35",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -18,11 +18,10 @@
     }
   },
   "files": [
-    "index.js",
-    "index.d.ts",
-    "node.js",
-    "node.d.ts",
-    "browser.js"
+    "*.js",
+    "*.d.ts",
+    "lib",
+    "assets"
   ],
   "peerDependencies": {
     "firebase": ">=10.0.0"

package/variables.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Default Firebase configuration for the QAECY SDK demo app ("sdk-default").
+ * These are safe to use for evaluation and development purposes.
+ * For production use, obtain your own configuration from QAECY.
+ */
+export declare const DEFAULT_SDK_CONFIG: {
+    readonly apiKey: "AIzaSyAiW42QBx9HS4Khu88pCW7MV66IhBAQul0";
+    readonly appId: "1:151132927589:web:d2ffdb377dfadfd23ab88c";
+    readonly measurementId: "G-YT4PK6HGZD";
+};
+export declare const FIREBASE_PROJECT_ID = "qaecy-mvp-406413";
+export declare const FIREBASE_SENDER_ID = "734737865998";
+export declare const GCP_REGION = "europe-west6";
+export declare const COLLECTION_API_KEYS = "apiKeys";
+export declare const COLLECTION_ORGANIZATIONS = "organizations";
+export declare const COLLECTION_PROJECTS = "projects";
+export declare const BUCKET_SESSIONS = "sessions_eu_west6";
+export declare const BUCKET_CHAT_SESSIONS = "spaces_chats_eu_west6";
+export declare const BUCKET_RAW = "spaces_raw_eu_west6";
+export declare const BUCKET_PROCESSED = "spaces_processed_eu_west6";
+export declare const BUCKET_LOGS = "spaces_logs_eu_west6";
+export declare const BUCKET_PUBLIC = "cue_public_eu_west6";
+export declare const BUCKET_PERSISTENCE = "db_persistence_eu_west6";
+export declare const ENDPOINT_CONSUMPTION = "/data-views/admin/consumption";
+export declare const ENDPOINT_PROFILE_ORGANIZATIONS = "/data-views/admin/profile/organizations";
+export declare const ENDPOINT_PROFILE_API_KEYS = "/data-views/admin/profile/api-keys";
+export declare const ENDPOINT_COMMANDS_PROFILE_API_KEYS = "/commands/admin/profile/api-keys";
+export declare const ENDPOINT_COMMANDS_PROFILE_TERMS = "/commands/admin/profile/terms";
+export declare const ENDPOINT_ORG_MEMBERS: (orgId: string) => string;
+export declare const ENDPOINT_ORG_CREDITS: (orgId: string) => string;
+export declare const ENDPOINT_ORG_CREDITS_REPORT: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_USER_SIGNUP = "/commands/admin/user/signup";
+export declare const ENDPOINT_COMMANDS_USER_SIGNUP_RESEND = "/commands/admin/user/signup/resend";
+export declare const ENDPOINT_COMMANDS_USER_SETTINGS = "/commands/admin/user/settings";
+export declare const ENDPOINT_DATA_VIEWS_USER_SETTINGS = "/data-views/admin/users/settings";
+export declare const ENDPOINT_COMMANDS_ORG_SIGNUP = "/commands/admin/organization/signup";
+export declare const ENDPOINT_COMMANDS_ORG_CREDITS: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_PLAN: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_CHECKOUT: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_BILLING_PORTAL: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_MEMBERS: (orgId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_MEMBER_ROLE: (orgId: string, userId: string) => string;
+export declare const ENDPOINT_COMMANDS_ORG_MEMBER: (orgId: string, userId: string) => string;
+export declare const ENDPOINT_PROJECTS = "/data-views/admin/projects";
+export declare const ENDPOINT_CREATE_PROJECT = "/commands/admin/project";
+export declare const ENDPOINT_DELETE_PROJECT: (projectId: string) => string;
+export declare const ENDPOINT_SEARCH = "/assistant/search";
+export declare const ENDPOINT_MCP = "/mcp";
+export declare const ENDPOINT_INDEX_SEARCH = "/index/search";
+export declare const ENDPOINT_INDEX_LOOKUP = "/index/lookup";
+export declare const ENDPOINT_INDEX_AVAILABLE_FILTERS = "/index/available-filters";
+export declare const ENDPOINT_FUSEKI_QUERY = "/triplestore/query";
+export declare const ENDPOINT_FUSEKI_UPDATE = "/triplestore/update";
+export declare const ENDPOINT_FUSEKI_SHACL = "/triplestore/shacl";
+export declare const ENDPOINT_QLEVER_QUERY = "/qlever-server/qlever/query";
+export declare const ENDPOINT_QLEVER_UPDATE = "/qlever-server/qlever/update";
+export declare const ENDPOINT_QLEVER_SHACL = "/qlever-server/qlever/shacl";
+export declare const ENDPOINT_QLEVER_ADMIN_REBUILD = "/qlever-server/qlever/admin/rebuild";
+export declare const ENDPOINT_QLEVER_ADMIN_STATS_REFRESH = "/qlever-server/admin/stats/refresh";
+export declare const ENDPOINT_FSS_BATCH = "/commands/file-system-structure/batch";
+export declare const ENDPOINT_STORAGE_SESSIONS = "/storage/sessions";
+export declare const ENDPOINT_STORAGE_RAW = "/storage/raw";
+export declare const ENDPOINT_STORAGE_PROCESSED = "/storage/processed";
+export declare const ENDPOINT_PROCESSING_STATUS_WS = "/data-views/processing-status";
+export declare const MICROSOFT_PROVIDER_ID = "microsoft.com";
+export declare const SUPERADMIN_ROLE = "superadmin";
+/**
+ * Base URL for all RDF resource IRIs: `https://cue.qaecy.com/r/{projectId}/{entityUUID}`.
+ * Entity IRIs are constructed as `${RESOURCE_BASE}${projectId}/${uuid}`.
+ */
+export declare const RESOURCE_BASE = "https://cue.qaecy.com/r/";