@qaecy/cue-sdk 0.0.32 → 0.0.33

package/lib/models.d.ts

@@ -1,460 +0,0 @@
-export type CueEnvironment = 'production' | 'emulator';
-export interface CueEndpoints {
-    /** API gateway base URL */
-    gatewayUrl: string;
-    /** Token exchange endpoint for API key sign-in */
-    tokenUrl: string;
-    /** Firebase Auth emulator URL */
-    authEmulatorUrl: string;
-    /** Firebase Storage emulator hostname, no protocol (emulator mode only, default: 'localhost') */
-    storageEmulatorHost: string;
-    /** Firebase Storage emulator port (emulator mode only, default: 9199) */
-    storageEmulatorPort: number;
-    /** Firebase Firestore emulator hostname, no protocol (emulator mode only, default: 'localhost') */
-    firestoreEmulatorHost: string;
-    /** Firebase Firestore emulator port (emulator mode only, default: 8080) */
-    firestoreEmulatorPort: number;
-}
-export interface CueSdkConfig {
-    /** Firebase API key for this project. Defaults to the QAECY demo app if omitted. */
-    apiKey?: string;
-    /** Firebase App ID. Defaults to the QAECY demo app if omitted. */
-    appId?: string;
-    /** Firebase Measurement ID. Defaults to the QAECY demo app if omitted. */
-    measurementId?: string;
-    /** Target environment. Defaults to 'production'. */
-    environment?: CueEnvironment;
-    /** Override individual endpoint URLs. Takes precedence over environment. */
-    endpoints?: Partial<CueEndpoints>;
-    /** Enable verbose debug logging for all entity/document store operations. */
-    verbose?: boolean;
-}
-export type SsoProvider = 'google' | 'microsoft';
-export interface PasswordCredentials {
-    email: string;
-    password: string;
-}
-export interface SearchRequest {
-    /** Natural language query or search term */
-    term: string;
-    /** Project ID to search within */
-    projectId: string;
-    /** Optional category filters */
-    categories?: string[];
-}
-/** Options for `CueProjectView.search()`. */
-export interface SearchOptions {
-    /** Optional content category IRI filters. */
-    categories?: string[];
-}
-export interface SearchSource {
-    item: string;
-    parent: string;
-    content: string;
-}
-export interface SearchResponse {
-    id: string;
-    question: string;
-    questionHTML: string;
-    response: string;
-    sources: SearchSource[];
-    rankedSources: SearchSource[];
-}
-export interface ContextItem {
-    id: string;
-    type: string;
-    relevance: number;
-    info: Record<string, unknown>;
-    sub_items: ContextItem[];
-}
-export interface ContextDoc {
-    id: string;
-    total: number;
-    operation: {
-        type: string;
-    };
-    input: string;
-    items: ContextItem[];
-    within: string[];
-    meta: {
-        time_created: string;
-    };
-}
-export interface ProjectSettings {
-    views?: Array<{
-        id: string;
-        pinned?: boolean;
-    }>;
-    chatDisabled: boolean;
-    graph?: {
-        type: 'qlever' | 'fuseki';
-        uri?: string;
-    };
-    /** Processing tier determining credit costs. Defaults to "l" if not set. */
-    tier?: 's' | 'm' | 'l';
-}
-export interface ProjectData {
-    id: string;
-    name: string;
-    organizationID: string;
-    created: string;
-    lastSync: string | null;
-    isPublic: boolean;
-    members: string[];
-    syncers: string[];
-    admins: string[];
-    alternativeIDs: string[];
-    projectSettings: ProjectSettings;
-}
-export interface CreateProjectOptions {
-    /** The organization this project belongs to */
-    organizationID: string;
-    /** Human-readable project name */
-    name: string;
-    /** Explicit project ID. Defaults to a new UUID. */
-    id?: string;
-    /** UIDs to set as project admins. Non-superadmin callers are always included automatically. */
-    admins?: string[];
-    /** UIDs to set as project syncers. Non-superadmin callers are always included automatically. */
-    syncers?: string[];
-    /** UIDs to set as project members. Non-superadmin callers are always included automatically. */
-    members?: string[];
-    /** Graph backend type. The service maps this to the configured URI. */
-    graphType?: 'fuseki' | 'qlever';
-    /** Processing tier determining credit costs. */
-    tier?: 's' | 'm' | 'l';
-}
-export interface SyncProgress {
-    percent: number;
-    syncCount: number;
-    totalCount: number;
-    syncSize: number;
-    totalSize: number;
-}
-export interface SyncOptions {
-    /** The project/space ID to sync into */
-    spaceId: string;
-    /** Provider ID identifying the file source (e.g. 'local', 's3') */
-    providerId: string;
-    /** Authenticated user ID */
-    userId: string;
-    /** Enable verbose logging */
-    verbose?: boolean;
-    /** Called whenever upload progress changes */
-    onProgress?: (progress: SyncProgress) => void;
-    /** Write RDF as BLOBs to the processed bucket instead of patching the graph directly */
-    legacy?: boolean;
-}
-/**
- * Credit cost table fetched from the public bucket (`unit-credit.json`).
- * Maps file extension → tier → credits per unit.
- */
-export type UnitCreditMap = Partial<Record<'s' | 'm' | 'l', Record<string, number>>>;
-/** Per-extension cost breakdown returned by {@link CueSyncApi.scanCost}. */
-export interface ScanOutputRecord {
-    /** File extension (without leading dot), e.g. `"pdf"`, `"ifc"`. */
-    ext: string;
-    /** Number of files with this extension. */
-    count: number;
-    /** Share of this extension among supported files (0–100). */
-    percentOfFiltered: number;
-    /** Share of this extension among all files (0–100). */
-    percentOfAll: number;
-    /** Billable units for this extension (e.g. pages for PDFs, rows for spreadsheets). */
-    units: number;
-    /** Total size of files with this extension in megabytes. */
-    sizeMb: number;
-    /** Credits to consume for this extension (units × credit-per-unit for the project tier). */
-    credits?: number;
-}
-export interface UnitsConsumedDto {
-    creditsAvailable: number;
-    creditsConsumed: number;
-    filesProcessed: number;
-    unitsAvailable: number;
-    unitsConsumed: number;
-}
-export interface ShaclViolation {
-    '@type': string;
-    'sh:focusNode': {
-        '@id': string;
-    } | {
-        '@value': string;
-    };
-    'sh:resultPath'?: {
-        '@id': string;
-    };
-    'sh:resultSeverity': {
-        '@id': string;
-    };
-    'sh:sourceConstraintComponent': {
-        '@id': string;
-    };
-    'sh:sourceShape'?: {
-        '@id': string;
-    };
-    'sh:resultMessage': string;
-    'sh:value'?: string;
-}
-export interface ShaclValidationReport {
-    '@context': Record<string, string>;
-    '@type': string;
-    'sh:conforms': boolean;
-    'sh:result'?: ShaclViolation[];
-}
-export interface SyncPreview {
-    /** Per-extension cost breakdown for files not yet synced */
-    costRecords: ScanOutputRecord[];
-    /** Project tier used for cost calculation */
-    tier: 's' | 'm' | 'l';
-    /** Human-readable tier name from tier-names.json */
-    tierName: string;
-    /** Total units required for the new files */
-    unitsToConsume: number;
-    /** Total credits to consume (derived from unit-credit.json + project tier) */
-    creditsToConsume: number;
-    /** Credits currently available for this project */
-    creditsAvailable: number;
-    /** Units still available for this project */
-    unitsAvailable: number;
-    /** Number of new files that would be uploaded */
-    filesToUpload: number;
-    /** Total local files scanned */
-    totalLocalFiles: number;
-}
-export interface SyncResult {
-    /** Number of files successfully synced in this run */
-    syncCount: number;
-    /** Total bytes synced in this run */
-    syncSize: number;
-    /** Number of files that failed to upload */
-    failedUploads: number;
-    /** Total file count (local + remote combined) */
-    totalCount: number;
-    /** Total size across all files */
-    totalSize: number;
-    /** Whether any RDF metadata was written */
-    rdfWritten: boolean;
-    /** Updated credit balance after sync, fetched from the consumption endpoint */
-    creditsAvailable: number;
-}
-export interface OrgMember {
-    uid: string;
-    name: string;
-    email: string;
-    isAdmin: boolean;
-}
-export interface OrganizationData {
-    id: string;
-    name: string;
-    created: string;
-    admins: string[];
-    members: string[];
-    alternativeIDs: string[];
-    domain: string;
-}
-export interface ProfileSSOAccount {
-    id: string;
-    label: string;
-}
-export interface APIKeyInfo {
-    key: string;
-    expiration: string;
-}
-export interface APIKeyDoc {
-    key: string;
-    uid: string;
-    expiration: string;
-}
-/** Alias for {@link ProjectData} — the Firestore document shape for a project. */
-export type ProjectDoc = ProjectData;
-/** Alias for {@link OrganizationData} — the Firestore document shape for an org. */
-export type OrganizationDoc = OrganizationData;
-export interface UserDoc {
-    id: string;
-    name: string;
-    email: string;
-    created: string;
-    lastVisit: string;
-    lastVisitProjects?: Record<string, string>;
-    organizations: string[];
-    locale?: string;
-    hasAcceptedTermsAndConditions: boolean;
-}
-export interface RDFWritingDoc {
-    id: string;
-    accumulatedSizeSinceLastIdleEvent: number;
-    accumulatedFilesSinceLastIdleEvent: number;
-    firstRDFWrite: string;
-    lastRDFWrite: string;
-}
-export interface ViewDefinition {
-    id: string;
-    pinned?: boolean;
-}
-/**
- * Minimal cache interface for SPARQL query results.
- *
- * Implement this against any storage backend (Cloud Storage, localStorage,
- * IndexedDB, in-memory Map) and pass it to the project-view classes to enable
- * stale-while-revalidate query caching.
- *
- * The Angular adapter wires this to `CueCache` from `cue-repos`.
- */
-export interface QueryCache {
-    get(key: string): Promise<unknown | undefined>;
-    set(key: string, data: unknown): Promise<void>;
-}
-/**
- * A multilingual string keyed by BCP-47 language tag. The special `default`
- * key always resolves to the English value (or, when no English value exists,
- * to the untagged/first available value).
- */
-export type LangMap = {
-    [lang: string]: string;
-};
-/** A taxonomy node (content category or entity category) from the triplestore. */
-export interface CategoryDef {
-    iri: string;
-    /**
-     * Label resolved for the currently active language (falls back to `default`
-     * / English). This is a computed convenience view of {@link CategoryDef.labels}.
-     */
-    label: string;
-    /**
-     * Definition resolved for the currently active language (falls back to
-     * `default` / English). Computed view of {@link CategoryDef.definitions}.
-     */
-    definition?: string;
-    /** Full set of labels keyed by language tag (plus a `default` key). */
-    labels: LangMap;
-    /** Full set of definitions keyed by language tag (plus a `default` key). */
-    definitions?: LangMap;
-    /** IRI of the parent category (skos:broader), if any. */
-    parent?: string;
-    /** Whether this category is marked as deprecated in the triplestore. */
-    deprecated?: boolean;
-}
-/**
- * A relationship type discovered in the triplestore via `qcy:relatedEntity` property scan.
- * The IRI is the property IRI, label is its rdfs:label.
- */
-export type RelationshipDef = CategoryDef;
-/** Core label + classification data for a single entity. */
-export interface EntityCoreData {
-    value: string;
-    categories: string[];
-    mentionCount?: number;
-}
-/** A single directed relationship edge between two entities. */
-export interface EntityRelationship {
-    /** IRI of the property used (e.g. `qcy:hasContractor`). */
-    relIRI: string;
-    /** Full IRI of the related entity. */
-    nodeIRI: string;
-    /** Label of the related entity. */
-    nodeValue: string;
-    /** Category IRIs of the related entity. */
-    nodeCategories: string[];
-}
-/** Incoming and outgoing relationship edges for one entity. */
-export interface EntityRelationships {
-    incoming: EntityRelationship[];
-    outgoing: EntityRelationship[];
-}
-/** An OSM geometry associated with an entity or related entity. */
-export interface MapGeometry {
-    osmIRI: string;
-    wkt: string;
-}
-/** Fully resolved data for a single entity, merging all lazy-loaded slices. */
-export interface EntityDetailedData extends EntityCoreData {
-    relationshipData?: EntityRelationships;
-    /** UUIDs of documents that reference this entity. */
-    documentRefs?: string[];
-    directMapGeometries?: MapGeometry[];
-    indirectMapGeometries?: Array<{
-        rel: string;
-        entityUUID: string;
-        geometries: MapGeometry[];
-    }>;
-}
-/**
- * Project-level entity category graph — nodes are category IRIs, edges
- * represent the `qcy:relatedEntity` connection at the category level.
- */
-export interface ProjectEntitiesData {
-    entities: Array<{
-        iri: string;
-        size?: number;
-    }>;
-    relations: Array<{
-        sourceID: string;
-        targetID: string;
-    }>;
-}
-/**
- * Structured summary graph returned by `buildSummaryGraph('graph')`.
- * Nodes are deduplicated category IRIs; edges carry the predicate and
- * occurrence count from the summary query.
- */
-export interface SummaryGraphData {
-    entities: Array<{
-        iri: string;
-    }>;
-    relations: Array<{
-        sourceID: string;
-        predicate: string;
-        targetID: string;
-        weight: number;
-    }>;
-}
-/** Core metadata for a single document (FileContent node). */
-export interface DocumentInfo {
-    id: string;
-    contentIRI: string;
-    path: string;
-    suffix: string;
-    size: number;
-    tags: string[];
-    categories: string[];
-    subject?: string;
-    summary?: string;
-    providerId?: string;
-    /** Full storage path in the processed bucket (e.g. `{projectId}/fragments/{uuid}.fragments`).
-     *  Only present on alternative representations that carry a `qcy:remoteRelativePath`. */
-    remoteRelativePath?: string;
-}
-/** Count + total size for a group of documents (e.g. grouped by suffix or category). */
-export interface DocumentSummary {
-    size: number;
-    count: number;
-}
-/** Project-level document overview — fetched once on project init. */
-export interface ProjectDocumentsData {
-    duplicateCount: number;
-    /** File extension → `{ size, count }` */
-    documentsBySuffix: Record<string, DocumentSummary>;
-    /** Content-category IRI → `{ size, count }` */
-    documentsByContentCategory: Record<string, DocumentSummary>;
-}
-export interface IndexSearchRequest {
-    input: string;
-    limit?: number;
-    aggregate?: boolean;
-    /** `'loose'` (default) allows partial matches; `'strict'` requires exact term presence. */
-    mode?: 'loose' | 'strict';
-    /** Pre-seed the context with these document UUIDs before running the search. */
-    identifiers?: string[];
-}
-export interface IndexItem {
-    id: string;
-    type: string;
-    relevance: number;
-    sub_items?: IndexItem[];
-}
-export interface IndexSearchResponse {
-    id?: string;
-    total?: number;
-    items: IndexItem[];
-}

package/lib/privileges.d.ts

@@ -1,72 +0,0 @@
-import { ReadonlySignal } from './signal';
-/** Roles ordered from highest to lowest privilege. */
-declare const ROLE_HIERARCHY: readonly ["superadmin", "admin", "syncer", "member"];
-export type UserProjectRole = (typeof ROLE_HIERARCHY)[number];
-/** Role a user can have within an organization. */
-export type UserOrgRole = 'admin' | 'member';
-export interface Privileges {
-    changeContentCategories: boolean;
-    createEntities: boolean;
-    createProject: boolean;
-    createProvider: boolean;
-    deleteDocuments: boolean;
-    deleteProject: boolean;
-    deleteUserFromProject: boolean;
-    downloadDocuments: boolean;
-    editContentCategories: boolean;
-    editPublicReposAvailableToAgent: boolean;
-    editTier: boolean;
-    inviteUserToProject: boolean;
-    renameDocuments: boolean;
-    uploadDocuments: boolean;
-    viewEntities: boolean;
-}
-/**
- * Minimum project role required for each privilege.
- * Note: `createProject` is intentionally absent — it is gated by the
- * user's organisation role, not their project role.
- */
-export declare const REQUIRED_ROLES: Record<Exclude<keyof Privileges, 'createProject'>, UserProjectRole>;
-/**
- * Manages role-based access control for the current user + selected project.
- *
- * - Call `setProjectRoles()` whenever the selected project changes.
- * - Call `setOrgRole()` whenever the selected project's organisation changes.
- * - Read `privileges` (a `ReadonlySignal<Privileges>`) for reactive access.
- *
- * @example
- * cue.privileges.setProjectRoles(['admin']);
- * cue.privileges.setOrgRole('admin');
- * const canUpload = cue.privileges.privileges.get().uploadDocuments; // true
- * const canCreate = cue.privileges.privileges.get().createProject;  // true
- */
-export declare class CuePrivileges {
-    private readonly _isSuperAdmin;
-    private readonly _projectRoles;
-    private readonly _orgRole;
-    /**
-     * Reactive signal — current user's privileges for the selected project.
-     * Recomputes automatically when `setProjectRoles()` is called or when
-     * the `isSuperAdmin` signal changes.
-     */
-    readonly privileges: ReadonlySignal<Privileges>;
-    constructor(_isSuperAdmin: ReadonlySignal<boolean>);
-    /**
-     * Set the user's role within the organisation that owns the selected project.
-     * Pass `null` to clear the organisation role (e.g. when deselecting a project).
-     *
-     * Only organisation admins (and superadmins) may create projects.
-     */
-    setOrgRole(role: UserOrgRole | null): void;
-    /**
-     * Set the user's roles for the currently selected project.
-     *
-     * Roles are expanded along the hierarchy: `admin` automatically includes
-     * `syncer` and `member`; `syncer` includes `member`. Pass an empty array
-     * to reset to the lowest privilege level.
-     */
-    setProjectRoles(roles: UserProjectRole[]): void;
-    private _expand;
-    private _compute;
-}
-export {};

package/lib/profile.d.ts

@@ -1,60 +0,0 @@
-import { UserInfo } from 'firebase/auth';
-import { FirebaseApp } from 'firebase/app';
-import { APIKeyDoc, APIKeyInfo, OrgMember, OrganizationData, ProfileSSOAccount } from './models';
-import { CueAuth } from './auth';
-export declare class CueProfile {
-    private readonly _auth;
-    private readonly _gatewayUrl;
-    private readonly _functions;
-    constructor(_auth: CueAuth, app: FirebaseApp, useEmulator: boolean, _gatewayUrl: string);
-    private _url;
-    private _fetch;
-    /** Whether the current user has an active API key. */
-    hasAPIKey(): Promise<boolean>;
-    /** Returns the sign-in methods registered for the current user's email. */
-    getSignInMethods(): Promise<string[]>;
-    /** Builds a human-readable label from a Firebase UserInfo provider entry. */
-    buildProviderLabel(userInfo: UserInfo): string;
-    /** Returns SSO accounts linked to the current user (excludes password). */
-    getSSOAccounts(): ProfileSSOAccount[];
-    /** Links a Google or Microsoft provider to the current account via popup. Returns the new provider label. */
-    linkProvider(ssoProvider: string): Promise<string>;
-    /** Unlinks a provider from the current account. */
-    unlinkProvider(providerId: string): Promise<void>;
-    /** Changes the password. Reauthenticates first. */
-    updatePassword(currentPassword: string, newPassword: string): Promise<void>;
-    /** Adds (sets) a password for an account that currently only uses SSO. */
-    addPassword(password: string): Promise<void>;
-    /** Requests an e-mail change. Sends a verification e-mail to the new address. */
-    updateEmail(newEmail: string, password: string): Promise<void>;
-    /** Creates a new API key for the current user. */
-    createAPIKey(expiration: string): Promise<APIKeyDoc>;
-    /** Revokes the current user's API key. */
-    revokeAPIKey(): Promise<void>;
-    /** Fetches the current user's existing API key. */
-    requestAPIKey(): Promise<APIKeyInfo>;
-    /** Returns organizations the current user is a member of. */
-    listOrganizations(): Promise<(Pick<OrganizationData, 'id' | 'name'> & {
-        isAdmin: boolean;
-    })[]>;
-    /** Returns all members of the given organisation. Caller must be an org admin or superadmin. */
-    getOrgMembers(orgId: string): Promise<OrgMember[]>;
-    private _requireUser;
-    /**
-     * Fetch display name and email for a list of user UIDs.
-     * Uses the `getUserInfo` Firebase callable function.
-     */
-    getUserInfo(uids: string[]): Promise<Record<string, {
-        name: string;
-        email: string;
-    }>>;
-    /** Record that the current user has accepted the terms of service. Sets a `terms` custom claim on the token. */
-    acceptTerms(version: string): Promise<void>;
-    /**
-     * Returns the terms version the current user has accepted (e.g. `"v1"`),
-     * or `null` if they have not accepted any version yet.
-     * Reads from the cached ID token — call after `acceptTerms()` with a
-     * force-refreshed token to see the updated value.
-     */
-    latestTermsAccepted(): Promise<string | null>;
-}