@qaecy/cue-sdk 0.0.35 → 0.0.37

package/index.d.ts

@@ -14,6 +14,8 @@ export type { IndexSearchRequest, IndexItem, IndexSearchResponse, IndexFilterOpt
 export { CueSyncApi, configureScanWasm } from './lib/sync';
 export { CueProcessingApi } from './lib/processing';
 export type { ProcessingStatusWatcher } from './lib/processing';
+export { CueDmsApi } from './lib/dms';
+export type { DmsProviderInfo, DmsRemoteFile, DmsSyncPreviewResponse } from './lib/models';
 export { CueProjectSchema } from './lib/schema';
 export { CueDocumentFilter } from './lib/document-filter';
 export { CueProjectEntities } from './lib/entities';
@@ -30,7 +32,7 @@ export { CueCache } from './lib/cache';
 export type { QueryCacheEntry } from './lib/cache';
 export { CueCurrency, SUPPORTED_CURRENCIES, BASE_CURRENCY } from './lib/currency';
 export type { SupportedCurrency, CurrencyRates } from './lib/currency';
-export type { CueSdkConfig, SsoProvider, PasswordCredentials, SearchRequest, SearchResponse, SearchSource, SearchOptions, ProjectData, ProjectSettings, QleverStats, CreateProjectOptions, SyncOptions, SyncResult, SyncPreview, ScanOutputRecord, UnitCreditMap, UnitsConsumedDto, OrgCreditsDto, OrgPlanSummary, MonthlyConsumptionDto, ProjectConsumptionReportDto, OrgConsumptionReportDto, OrganizationData, OrgMember, ProfileSSOAccount, APIKeyInfo, APIKeyDoc, ProjectDoc, OrganizationDoc, UserDoc, UserSettings, CustomAppRecord, CustomAppWithHtml, CreateCustomAppOptions, UpdateCustomAppOptions, RDFWritingDoc, ProcessingStatus, ProcessingStage, ViewDefinition, QueryCache, LangMap, CategoryDef, RelationshipDef, EntityCoreData, EntityRelationship, EntityRelationships, MapGeometry, EntityDetailedData, ProjectEntitiesData, SummaryGraphData, DocumentInfo, DocumentSummary, ProjectDocumentsData, } from './lib/models';
+export type { CueSdkConfig, SsoProvider, PasswordCredentials, SearchRequest, SearchResponse, SearchSource, SearchOptions, ProjectData, ProjectSettings, QleverStats, CreateProjectOptions, SyncOptions, SyncResult, SyncPreview, ScanOutputRecord, UnitCreditMap, UnitsConsumedDto, OrgCreditsDto, OrgPlanSummary, MonthlyConsumptionDto, ProjectConsumptionReportDto, OrgConsumptionReportDto, FileTypeConsumptionDto, FileTypeBreakdownDto, OrganizationData, OrgMember, ProfileSSOAccount, APIKeyInfo, APIKeyDoc, ProjectDoc, OrganizationDoc, UserDoc, UserSettings, CustomAppRecord, CustomAppWithHtml, CreateCustomAppOptions, UpdateCustomAppOptions, RDFWritingDoc, ProcessingStatus, ProcessingStage, ViewDefinition, QueryCache, LangMap, CategoryDef, RelationshipDef, EntityCoreData, EntityRelationship, EntityRelationships, MapGeometry, EntityDetailedData, ProjectEntitiesData, SummaryGraphData, DocumentInfo, DocumentSummary, ProjectDocumentsData, } from './lib/models';
 export type { AuthStateListener, Unsubscribe } from './lib/auth';
 export { CueTables } from './lib/tables';
 export type { ProjectTable } from './lib/tables';

package/index.js

@@ -1,4 +1,4 @@
-import { B as a, C as u, f as C, A as t, D as r, c as i, v as c, z as o, w as n, m as p, y as E, a as S, g as P, h as R, s as A, k as g, r as m, o as j, n as l, l as D, p as U, q as x, e as f, d as h, t as d, b as y, i as I, x as _, E as b, R as q, S as v, j as w, u as B } from "./document-filter-Dr_-QbaZ.js";
+import { B as a, C as u, a as C, b as t, c as r, d as i, e as c, f as o, g as n, h as p, i as E, j as S, k as A, l as P, m as R, n as g, o as m, p as D, q as j, r as l, s as U, t as x, u as f, v as h, w as d, x as y, y as I, z as _, A as b, D as q, R as v, S as w, E as B, F } from "./document-filter-BNui_ucF.js";
 export {
   a as BASE_CURRENCY,
   u as Cue,
@@ -9,28 +9,29 @@ export {
   c as CueCache,
   o as CueContexts,
   n as CueCurrency,
-  p as CueDocumentFilter,
-  E as CueExtraction,
-  S as CueGis,
+  p as CueDmsApi,
+  E as CueDocumentFilter,
+  S as CueExtraction,
+  A as CueGis,
   P as CueIndexApi,
   R as CueMcp,
-  A as CuePrivileges,
-  g as CueProcessingApi,
-  m as CueProfile,
+  g as CuePrivileges,
+  m as CueProcessingApi,
+  D as CueProfile,
   j as CueProjectDocuments,
   l as CueProjectEntities,
-  D as CueProjectSchema,
-  U as CueProjectView,
-  x as CueProjects,
-  f as CueRequestError,
-  h as CueSignUp,
-  d as CueSignal,
-  y as CueStorage,
-  I as CueSyncApi,
-  _ as CueTables,
-  b as CueUserSettings,
-  q as REQUIRED_ROLES,
-  v as SUPPORTED_CURRENCIES,
-  w as configureScanWasm,
-  B as cueComputed
+  U as CueProjectSchema,
+  x as CueProjectView,
+  f as CueProjects,
+  h as CueRequestError,
+  d as CueSignUp,
+  y as CueSignal,
+  I as CueStorage,
+  _ as CueSyncApi,
+  b as CueTables,
+  q as CueUserSettings,
+  v as REQUIRED_ROLES,
+  w as SUPPORTED_CURRENCIES,
+  B as configureScanWasm,
+  F as cueComputed
 };

package/lib/api.d.ts

@@ -11,6 +11,7 @@ import { CueAppData } from './app-data';
 import { CueApps } from './apps';
 import { CueUserSettings } from './user-settings';
 import { CueProcessingApi } from './processing';
+import { CueDmsApi } from './dms';
 export declare class CueApi {
     private readonly _auth;
     private readonly _gatewayUrl;
@@ -33,6 +34,8 @@ export declare class CueApi {
     readonly userSettings: CueUserSettings;
     /** Live pipeline-progress status for a project (upload → processing → loading → enrichment). */
     readonly processing: CueProcessingApi;
+    /** Sync files into a project from a 3rd-party DMS (e.g. ThinkProject). */
+    readonly dms: CueDmsApi;
     /** Active language used for language-sensitive SPARQL queries across all project classes. */
     language: string;
     /** Updates the active language. All project classes (`CueProjectSchema`, `CueProjectDocuments`, `CueProjectEntities`) read this at query time. */

package/lib/dms.d.ts

@@ -0,0 +1,39 @@
+import { CueAuth } from './auth';
+import { DmsProviderInfo, DmsRemoteFile, DmsSyncPreviewResponse } from './models';
+/**
+ * Sync files into a project from a 3rd-party Document Management System
+ * (e.g. ThinkProject). Credentials (externalProjectId/username/token) are
+ * never persisted — callers must re-supply them on every preview/confirm
+ * call. `token` is a user-generated personal access token, not a password.
+ */
+export declare class CueDmsApi {
+    private readonly _auth;
+    private readonly _gatewayUrl;
+    constructor(_auth: CueAuth, _gatewayUrl: string);
+    /** Lists the DMS providers this project can sync from. */
+    listSupportedProviders(): Promise<DmsProviderInfo[]>;
+    /**
+     * Fetches the file list from the DMS and diffs it against files already
+     * synced for this project+provider. Returns the delta for user confirmation
+     * — no bytes are downloaded and nothing is written yet.
+     */
+    previewSync(providerId: string, projectId: string, params: {
+        externalProjectId: string;
+        username: string;
+        token: string;
+    }): Promise<DmsSyncPreviewResponse>;
+    /**
+     * Downloads and syncs the user-confirmed file subset from the DMS into
+     * this project's raw storage + graph.
+     */
+    confirmSync(providerId: string, projectId: string, params: {
+        externalProjectId: string;
+        username: string;
+        token: string;
+        files: DmsRemoteFile[];
+        comment?: string;
+    }): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+}

package/lib/models.d.ts

@@ -1,4 +1,5 @@
 import { SupportedCurrency } from './currency';
+import { ComparisonResult } from 'js-sync-tools';
 export type CueEnvironment = 'production' | 'emulator';
 export interface CueEndpoints {
     /** API gateway base URL */
@@ -35,6 +36,28 @@ export interface PasswordCredentials {
     email: string;
     password: string;
 }
+/** A supported 3rd-party DMS sync provider (e.g. ThinkProject). */
+export interface DmsProviderInfo {
+    id: string;
+    label: string;
+}
+/** A file found in a 3rd-party DMS, as returned by a preview/dry-run sync. */
+export interface DmsRemoteFile {
+    relativePath: string;
+    size: number;
+    /** Content checksum (e.g. md5), if the provider's listing exposes one. */
+    checksum?: string;
+    /** Opaque id used to fetch this file's bytes when confirming the sync. */
+    externalFileId: string;
+    modifiedAt?: string;
+}
+/** Result of previewing a DMS sync — the delta to show the user for confirmation. */
+export interface DmsSyncPreviewResponse {
+    providerId: string;
+    filesToSync: DmsRemoteFile[];
+    filesAlreadySynced: DmsRemoteFile[];
+    totalRemoteCount: number;
+}
 export interface SearchRequest {
     /** Natural language query or search term */
     term: string;
@@ -254,6 +277,8 @@ export interface SyncPreview {
     filesToUpload: number;
     /** Total local files scanned */
     totalLocalFiles: number;
+    /** Full local/remote comparison — file lists, path-only mismatches, sync stats */
+    report: ComparisonResult;
 }
 export interface SyncResult {
     /** Number of files successfully synced in this run */
@@ -322,6 +347,14 @@ export interface ProjectConsumptionReportDto {
 export interface OrgConsumptionReportDto {
     projects: ProjectConsumptionReportDto[];
 }
+/** Consumption for one raw-file extension (lowercased, no leading dot; `'unknown'` if a file had none). */
+export interface FileTypeConsumptionDto {
+    unitsConsumed: number;
+    creditsConsumed: number;
+    filesProcessed: number;
+}
+/** Per-file-extension breakdown for one project within a given period — see {@link CueProfile.getProjectFileTypeBreakdown}. */
+export type FileTypeBreakdownDto = Record<string, FileTypeConsumptionDto>;
 export interface ProfileSSOAccount {
     id: string;
     label: string;

package/lib/profile.d.ts

@@ -1,6 +1,6 @@
 import { UserInfo } from 'firebase/auth';
 import { FirebaseApp } from 'firebase/app';
-import { APIKeyDoc, APIKeyInfo, OrgConsumptionReportDto, OrgCreditsDto, OrgMember, OrganizationData, ProfileSSOAccount } from './models';
+import { APIKeyDoc, APIKeyInfo, FileTypeBreakdownDto, OrgConsumptionReportDto, OrgCreditsDto, OrgMember, OrganizationData, ProfileSSOAccount } from './models';
 import { CueAuth } from './auth';
 import { ReadonlySignal } from './signal';
 export declare class CueProfile {
@@ -72,6 +72,15 @@ export declare class CueProfile {
      * or superadmin.
      */
     getOrgConsumptionReport(orgId: string): Promise<OrgConsumptionReportDto>;
+    /**
+     * Per-file-extension credit/unit breakdown for one project within `[from, to)` (UTC ISO 8601,
+     * `to` exclusive) — for a report drill-down (e.g. a monthly/yearly PDF export), not the
+     * regular monthly totals (use {@link getOrgConsumptionReport} for those). The backend
+     * recomputes this on every call by re-scanning the project's raw files — only call it when
+     * the user actually asks for a report, not on every page load. Caller must be an org admin
+     * or superadmin.
+     */
+    getProjectFileTypeBreakdown(orgId: string, projectId: string, from: string, to: string): Promise<FileTypeBreakdownDto>;
     /** Manual/support credit grant to an organisation's shared pool. Superadmins only — org admins self-serve via `startOrgCheckout`. */
     topUpOrgCredits(orgId: string, amount: number): Promise<void>;
     /**

package/node.js

@@ -1,5 +1,5 @@
-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";
+import { C as s } from "./document-filter-BNui_ucF.js";
+import { B as o, a as c, b as i, c as n, d as p, e as E, f as S, g as m, h as A, i as P, j as R, k as g, l, m as x, n as D, o as j, p as U, q as d, r as f, s as h, t as y, u as I, v as N, w as _, x as b, y as q, z as v, A as w, D as B, R as F, S as O, E as T, F as k } from "./document-filter-BNui_ucF.js";
 class C extends s {
   constructor(e) {
     super(e);
@@ -14,29 +14,30 @@ export {
   p as CueAuth,
   E as CueCache,
   S as CueContexts,
-  P as CueCurrency,
-  R as CueDocumentFilter,
-  m as CueExtraction,
-  A as CueGis,
-  g as CueIndexApi,
-  l as CueMcp,
+  m as CueCurrency,
+  A as CueDmsApi,
+  P as CueDocumentFilter,
+  R as CueExtraction,
+  g as CueGis,
+  l as CueIndexApi,
+  x as CueMcp,
   C as CueNode,
-  x as CuePrivileges,
+  D as CuePrivileges,
   j as CueProcessingApi,
-  D as CueProfile,
-  U as CueProjectDocuments,
-  d as CueProjectEntities,
-  f as CueProjectSchema,
-  h as CueProjectView,
-  y as CueProjects,
-  I as CueRequestError,
-  N as CueSignUp,
-  _ as CueSignal,
-  b as CueStorage,
-  q as CueSyncApi,
-  v as CueTables,
-  w as CueUserSettings,
-  B as REQUIRED_ROLES,
+  U as CueProfile,
+  d as CueProjectDocuments,
+  f as CueProjectEntities,
+  h as CueProjectSchema,
+  y as CueProjectView,
+  I as CueProjects,
+  N as CueRequestError,
+  _ as CueSignUp,
+  b as CueSignal,
+  q as CueStorage,
+  v as CueSyncApi,
+  w as CueTables,
+  B as CueUserSettings,
+  F 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.35",
+  "version": "0.0.37",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -23,6 +23,12 @@
     "lib",
     "assets"
   ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.26.0",
+    "n3": "^1.26.0",
+    "spark-md5": "^3.0.2",
+    "uuid": "^9.0.0"
+  },
   "peerDependencies": {
     "firebase": ">=10.0.0"
   }

package/variables.d.ts

@@ -29,6 +29,7 @@ export declare const ENDPOINT_COMMANDS_PROFILE_TERMS = "/commands/admin/profile/
 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_ORG_PROJECT_FILE_TYPE_BREAKDOWN: (orgId: string, projectId: 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";
@@ -58,6 +59,9 @@ 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_DMS_SYNC_PROVIDERS = "/commands/dms-sync/providers";
+export declare const ENDPOINT_DMS_SYNC_PREVIEW: (providerId: string) => string;
+export declare const ENDPOINT_DMS_SYNC_CONFIRM: (providerId: string) => string;
 export declare const ENDPOINT_STORAGE_SESSIONS = "/storage/sessions";
 export declare const ENDPOINT_STORAGE_RAW = "/storage/raw";
 export declare const ENDPOINT_STORAGE_PROCESSED = "/storage/processed";