@qaecy/cue-sdk 0.0.5 → 0.0.8

package/lib/sync.d.ts

@@ -4,6 +4,15 @@ import { CueAuth } from './auth';
 import { CueApi } from './api';
 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;
@@ -14,9 +23,33 @@ export declare class CueSyncApi {
     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;
+    /**
+     * 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}
@@ -29,6 +62,12 @@ export declare class CueSyncApi {
     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.
+     */
+    drainPending(): Promise<void>;
     private _drainPending;
     private _flushBatch;
     private _postFssBatch;
@@ -41,5 +80,45 @@ export declare class CueSyncApi {
      * 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 the tier settings.
+     * @returns Per-extension cost breakdown and the number of credits currently
+     *   available in the project.
+     */
+    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>;
+    private _fetchTierNames;
+    private _fetchUnitCreditMap;
     private _logProgress;
 }

package/node.js

@@ -1,312 +1,55 @@
-import { C as v, a as O } from "./cue-y-t8nSnt.js";
-import { b as dt, c as _t, d as gt } from "./cue-y-t8nSnt.js";
-import { getStorage as b, connectStorageEmulator as T } from "firebase/storage";
-import { CueGraphDatabase as q, CueBlobStorage as z } from "js-databases";
-import { readFile as P, writeFile as B, unlink as D } from "fs/promises";
-import { join as y } from "path";
-import { pathToFileURL as j } from "url";
-import { tmpdir as x } from "os";
-import { compareLocalRemote as A } from "js-sync-tools";
-import { uploadedFileMetadata as L } from "js-file-metadata-helpers";
-import { qaecyPrefixes as M } from "js/prefixes";
-let C = null, $ = null;
-async function k() {
-  const c = y(__dirname, "assets", "wasm"), t = await P(y(c, "dir_scanner_wasm_bg.wasm")), e = await import(j(y(c, "dir_scanner_wasm.mjs")).href);
-  await e.default({ module_or_path: t }), C = e.scan;
-}
-const H = "fuseki", G = "/triplestore/query", W = "/sparql/query", K = "/triplestore/update", J = "/sparql/update", Q = "/commands/file-system-structure/batch", F = 1e3, I = "cue:pending:";
-function U(c) {
-  return y(x(), `cue-sync-pending-${c}.json`);
-}
-async function Y(c) {
-  if (typeof window < "u") {
-    const t = window.localStorage.getItem(`${I}${c}`);
-    return t ? JSON.parse(t) : null;
-  }
-  try {
-    const t = await P(U(c), "utf-8");
-    return JSON.parse(t);
-  } catch {
-    return null;
-  }
-}
-async function N(c) {
-  const t = JSON.stringify(c);
-  if (typeof window < "u") {
-    window.localStorage.setItem(`${I}${c.spaceId}`, t);
-    return;
-  }
-  await B(U(c.spaceId), t, "utf-8");
-}
-async function V(c) {
-  if (typeof window < "u") {
-    window.localStorage.removeItem(`${I}${c}`);
-    return;
-  }
-  try {
-    await D(U(c));
-  } catch {
-  }
-}
-class X {
-  constructor(t, o, e, i) {
-    this._auth = t, this._projects = o, this._blob = e, this._gatewayUrl = i;
-  }
-  _auth;
-  _projects;
-  _blob;
-  _gatewayUrl;
-  _graphMap = /* @__PURE__ */ new Map();
-  _api;
-  _pendingItems = [];
-  _pendingSpaceId = null;
-  _flushTimer = null;
-  /** @internal Injected by CueApi after construction to avoid circular dependency. */
-  _bindApi(t) {
-    this._api = t;
-  }
-  /**
-   * 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.
-   */
-  async previewSync(t, o) {
-    const { spaceId: e, providerId: i, verbose: s } = o, n = await this._auth.getToken();
-    if (!n) throw new Error("Not authenticated. Call cue.auth.signIn() first.");
-    const r = await this._getOrCreateGraph(e, n), [a, l] = await Promise.all([
-      this._listRemoteFiles(r, e, i, s),
-      this._api?.getConsumption(e) ?? Promise.reject(new Error("CueSyncApi is not bound to a CueApi instance"))
-    ]), p = (await A(t, a)).localNotOnRemote ?? [], h = p.length > 0 ? await this.scanCost(p) : [], _ = h.reduce((g, m) => g + m.units, 0);
-    return {
-      costRecords: h,
-      unitsToConsume: _,
-      unitsAvailable: l.unitsAvailable,
-      filesToUpload: p.length,
-      totalLocalFiles: t.length
-    };
-  }
-  async sync(t, o) {
-    const { spaceId: e, providerId: i, userId: s, verbose: n } = o, r = await this._auth.getToken();
-    if (!r) throw new Error("Not authenticated. Call cue.auth.signIn() first.");
-    const a = await this._getOrCreateGraph(e, r);
-    n && console.info("Listing remote files ⏳");
-    const [l, d] = await Promise.all([
-      this._listRemoteFiles(a, e, i, n),
-      this._api?.getConsumption(e) ?? Promise.reject(new Error("CueSyncApi is not bound to a CueApi instance"))
-    ]), { unitsAvailable: p } = d, h = await A(t, l);
-    n && (console.info(`Total local files: ${t.length}`), console.info(`Total remote files: ${l.length}`), console.info(
-      `Total files to sync: ${(h.localNotOnRemote?.length ?? 0) + h.localNotOnRemotePathOnly.length}`
-    ));
-    let _ = h.syncCount, g = h.syncSize, m = 0, S = !1;
-    const w = h.localNotOnRemote ?? [];
-    if (w.length > 0) {
-      const f = (await this.scanCost(w)).reduce((E, R) => E + R.units, 0);
-      if (f > p)
-        throw new Error(
-          `Insufficient units: ${f} units required but only ${p} available.`
-        );
-    }
-    await this._initPendingBatch(e, r, n), n && w.length && console.info("Syncing missing files ⏳");
-    for (const u of w)
-      try {
-        const f = L(
-          u.relativePath,
-          e,
-          s,
-          u.md5,
-          i
-        );
-        if (!f.blob_name) throw new Error(`blob_name missing for ${u.relativePath}`);
-        const E = await P(u.fullPath);
-        await this._blob.uploadRaw(
-          f.blob_name,
-          new Uint8Array(E),
-          f
-        ), await this._queueFileLocation({
-          relativePath: u.relativePath,
-          md5: u.md5,
-          size: u.size,
-          providerId: i,
-          fileContentExists: !1
-        }), S = !0, _ += 1, g += u.size || 0, this._logProgress(_, h.totalCount, g, h.totalSize, n);
-      } catch (f) {
-        m += 1, console.error(`[CueSyncApi] Failed to upload file: ${u.fullPath}`), n && console.error("[CueSyncApi] Upload error details:", f);
-      }
-    n && h.localNotOnRemotePathOnly.length && console.info(`Syncing missing file locations (on provider "${i}") ⏳`);
-    for (const u of h.localNotOnRemotePathOnly)
-      await this._queueFileLocation({
-        relativePath: u.relativePath,
-        md5: u.md5,
-        size: u.size,
-        providerId: i,
-        fileContentExists: !0
-      }), S = !0, _ += 1, g += u.size || 0, this._logProgress(_, h.totalCount, g, h.totalSize, n);
-    return await this._drainPending(n), this._stopFlushTimer(), {
-      syncCount: _,
-      syncSize: g,
-      failedUploads: m,
-      totalCount: h.totalCount,
-      totalSize: h.totalSize,
-      rdfWritten: S
-    };
-  }
-  async _getOrCreateGraph(t, o) {
-    const e = this._graphMap.get(t);
-    if (e) return e;
-    const s = (await this._projects.getProject(t))?.projectSettings?.graph?.type ?? H, n = s === "qlever" ? `${this._gatewayUrl}${W}` : `${this._gatewayUrl}${G}`, r = s === "qlever" ? `${this._gatewayUrl}${J}` : `${this._gatewayUrl}${K}`, a = new q({
-      graphType: s,
-      queryEndpoint: n,
-      updateEndpoint: r,
-      originalHeaders: {
-        "x-project-id": t,
-        authorization: `Bearer ${o}`
-      }
-    });
-    return this._graphMap.set(t, a), a;
-  }
-  async _listRemoteFiles(t, o, e, i) {
-    i && console.info(`Listing files in raw space: ${o}`);
-    const [s, n] = await Promise.all([
-      this._blob.listRaw(o),
-      this._getGraphFiles(t, e)
-    ]);
-    i && console.info(`Found ${s.length} files in raw store for space: ${o}`);
-    const r = [];
-    for (const a of s) {
-      const l = a.substring(0, 36), d = n[l] ?? [];
-      if (d.length === 0)
-        i && console.warn(`No location data found for contentUUID: ${l}`), r.push({ contentUUID: l });
-      else
-        for (const p of d)
-          r.push({
-            contentUUID: l,
-            locationUUID: p.locationUUID,
-            created: p.created,
-            size: p.size
-          });
-    }
-    return r;
-  }
-  async _getGraphFiles(t, o) {
-    const e = `PREFIX qcy: <${M.qcy}>
-SELECT ?fc ?loc ?created ?fp ?size
-WHERE {
-  ?fc a qcy:FileContent ;
-      qcy:sizeBytes ?size ;
-      qcy:hasFileLocation ?loc .
-  ?loc qcy:remoteProviderId "${o}" ;
-       qcy:dateCreated ?created ;
-       qcy:filePath ?fp .
-}`, i = await t.query(e, "application/sparql-results+json"), s = {};
-    if (typeof i == "string") return s;
-    for (const n of i.results.bindings) {
-      const r = n.loc.value.split("/").at(-1) ?? "", a = n.fc.value.split("/").at(-1) ?? "", l = n.created.value, d = n.size.value;
-      s[a] || (s[a] = []), s[a].push({ locationUUID: r, created: l, size: d });
-    }
-    return s;
-  }
-  async _initPendingBatch(t, o, e) {
-    this._pendingSpaceId = t, this._pendingItems = [];
-    const i = await Y(t);
-    i && i.items.length > 0 && (e && console.info(`Flushing ${i.items.length} pending file location(s) from previous sync ⏳`), await this._flushBatch(i.items, t, o, e));
-    const s = setInterval(() => {
-      this._drainPending(e).catch(
-        (n) => console.error("[CueSyncApi] Periodic flush failed:", n)
-      );
-    }, 6e4);
-    typeof s == "object" && typeof s.unref == "function" && s.unref(), this._flushTimer = s;
-  }
-  async _queueFileLocation(t) {
-    this._pendingItems.push(t), this._pendingSpaceId && await N({ spaceId: this._pendingSpaceId, items: this._pendingItems });
-  }
-  async _drainPending(t) {
-    if (!this._pendingSpaceId || this._pendingItems.length === 0) return;
-    const o = await this._auth.getToken();
-    o && await this._flushBatch(this._pendingItems, this._pendingSpaceId, o, t);
-  }
-  async _flushBatch(t, o, e, i) {
-    const s = [...t];
-    this._pendingSpaceId === o && (this._pendingItems = []), await V(o);
-    try {
-      for (let n = 0; n < s.length; n += F)
-        await this._postFssBatch(s.slice(n, n + F), o, e);
-      i && console.info(`Wrote ${s.length} file location(s) to commands API ✅`);
-    } catch (n) {
-      const r = [...s, ...this._pendingItems];
-      throw this._pendingItems = r, await N({ spaceId: o, items: r }), n;
-    }
-  }
-  async _postFssBatch(t, o, e) {
-    const i = await fetch(`${this._gatewayUrl}${Q}`, {
-      method: "POST",
-      headers: {
-        Authorization: `Bearer ${e}`,
-        "Content-Type": "application/json",
-        "x-project-id": o
-      },
-      body: JSON.stringify({ items: t })
-    });
-    if (!i.ok) {
-      const s = await i.text().catch(() => "");
-      throw new Error(`File structure batch POST failed: ${i.status} ${i.statusText}${s ? ` — ${s}` : ""}`);
-    }
-  }
-  _stopFlushTimer() {
-    this._flushTimer !== null && (clearInterval(this._flushTimer), this._flushTimer = null);
-  }
-  /**
-   * 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}.
-   */
-  async scanCost(t) {
-    if ($ || ($ = k()), await $, !C) throw new Error("WASM scan function not initialised");
-    const o = 200, e = /* @__PURE__ */ new Map();
-    for (let i = 0; i < t.length; i += o) {
-      const s = t.slice(i, i + o), n = await Promise.all(
-        s.map(async (a) => ({
-          originalPath: a.relativePath,
-          data: new Uint8Array(await P(a.fullPath))
-        }))
-      ), r = C(n);
-      for (const a of r) {
-        const l = e.get(a.ext);
-        l ? (l.count += a.count, l.units += a.units, l.sizeMb += a.sizeMb) : e.set(a.ext, { ...a });
-      }
-    }
-    return Array.from(e.values());
-  }
-  _logProgress(t, o, e, i, s) {
-    if (!s || o === 0 || t % Math.ceil(o / 100) !== 0) return;
-    const n = Math.floor(t / o * 100);
-    console.info(
-      `Progress: ${n}% (${t}/${o} files, ${e}/${i} bytes)`
-    );
-  }
-}
-const Z = "spaces_raw_eu_west6", tt = "spaces_processed_eu_west6";
-class ut extends v {
+import { C as _, B as E, o as l, p as S, q as m, r as P, t as d, l as U, u as B, a as R } from "./cue-BIvMahsX.js";
+import { b as y, c as I, d as L, e as O, f as x, g as D, h as H, i as N, j as W, k as v, R as k, m as q, n as G, s as Q } from "./cue-BIvMahsX.js";
+import { getStorage as s, connectStorageEmulator as o } from "firebase/storage";
+import "firebase/firestore";
+class w extends _ {
   constructor(t) {
     super(t);
   }
   _buildApi(t) {
-    const o = b(this._app, Z), e = b(this._app, tt);
+    const p = s(this._app, E), C = s(this._app, l), i = s(this._app, S), g = s(this._app, m), r = s(this._app, P), n = s(this._app, d);
     if (this._isEmulator) {
-      const r = this._endpoints.storageEmulatorHost, a = this._endpoints.storageEmulatorPort;
-      T(o, r, a), T(e, r, a);
+      const e = this._endpoints.storageEmulatorHost, a = this._endpoints.storageEmulatorPort;
+      o(i, e, a), o(r, e, a), o(n, e, a);
     }
-    const i = new z({ storageRaw: o, storageProcessed: e }), s = new X(this.auth, t, i, this._endpoints.gatewayUrl), n = new O(this.auth, this._endpoints.gatewayUrl, t, s);
-    return s._bindApi(n), n;
+    const h = new B({
+      storageChatSessions: p,
+      storageLogs: C,
+      storageRaw: i,
+      storagePersistence: g,
+      storageProcessed: r,
+      storagePublic: n
+    }), c = new U(
+      this.auth,
+      t,
+      h,
+      this._endpoints.gatewayUrl
+    ), u = new R(
+      this.auth,
+      this._endpoints.gatewayUrl,
+      t,
+      c
+    );
+    return c._bindApi(u), u;
   }
 }
 export {
-  v as Cue,
-  O as CueApi,
-  dt as CueAuth,
-  ut as CueNode,
-  _t as CueProfile,
-  gt as CueProjects,
-  X as CueSyncApi
+  _ as Cue,
+  R as CueApi,
+  y as CueAuth,
+  I as CueCache,
+  w as CueNode,
+  L as CuePrivileges,
+  O as CueProfile,
+  x as CueProjectDocuments,
+  D as CueProjectEntities,
+  H as CueProjectSchema,
+  N as CueProjectView,
+  W as CueProjects,
+  v as CueSignal,
+  U as CueSyncApi,
+  k as REQUIRED_ROLES,
+  q as configureScanWasm,
+  G as cueComputed,
+  Q as staleWhileRevalidate
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qaecy/cue-sdk",
-  "version": "0.0.5",
+  "version": "0.0.8",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",

package/variables.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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_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_ORG_MEMBERS: (orgId: string) => string;
+export declare const ENDPOINT_CREATE_PROJECT = "/commands/admin/project";
+export declare const ENDPOINT_SEARCH = "/assistant/search";
+export declare const ENDPOINT_FUSEKI_QUERY = "/triplestore/query";
+export declare const ENDPOINT_FUSEKI_UPDATE = "/triplestore/update";
+export declare const ENDPOINT_QLEVER_QUERY = "/qlever-server/qlever/query";
+export declare const ENDPOINT_QLEVER_UPDATE = "/qlever-server/qlever/update";
+export declare const ENDPOINT_FSS_BATCH = "/commands/file-system-structure/batch";
+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/";