@stackfactor/client-api 1.19.0 → 1.20.1

package/dist/esm/lib/knowledgeBase/skills.js

@@ -0,0 +1,189 @@
+import { client } from "../axiosClient.js";
+/**
+ * List the skills a knowledge base's content was labelled with, across its
+ * processed documents, most named first: `{ items, total, limit }`, each item
+ * `{ name, nameNormalized, scope, proficiencyLevels, documentCount }`, where
+ * `scope` is "organization", "general" or null (labelled before skills had one).
+ * GET /api/v1/knowledge-base/:id/skills
+ * @param {String} id The knowledge base id
+ * @param {SkillListParams} params Optional limit
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const listSkills = (id, params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills`, {
+            headers: { authorization: authToken },
+            params: params,
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Set how a knowledge base's skills are named, and rename them on every
+ * document and chunk already labelled; every document labelled later takes
+ * them too. The mappings replace the ones before; an empty list gives back
+ * every skill as labelling named it. Owner or editor only; refused while a sync
+ * of one of its sources is under way (409) and for mappings that do not hold —
+ * a skill mapped twice, or mappings that lead a skill back to itself (400).
+ * PUT /api/v1/knowledge-base/:id/skill-mappings
+ * @param {String} id The knowledge base id
+ * @param {SkillMapping[]} skillMappings The mappings, `[{ from, to }]`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} { knowledgeBase, documents, chunks }: the knowledge
+ *   base with the mappings as stored, and how many documents and chunks were
+ *   rewritten
+ */
+export const setSkillMappings = (id, skillMappings, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.put(`/api/v1/knowledge-base/${id}/skill-mappings`, { skillMappings }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * What the knowledge bases the caller can open hold about one skill: how many
+ * of their documents name it (any spelling, under the names set with Edit
+ * skill names), in which knowledge bases, and the microskills their passages
+ * cover. The skill and skill template Additional Information dialogs ask it
+ * before they offer StackFactor as a data source. Only what the caller may
+ * open counts: their role on each knowledge base and each document's source
+ * permissions decide. Requires VIEW_KNOWLEDGE_BASE; the name must be 1 to 200
+ * characters (400 otherwise).
+ * GET /api/v1/knowledge-base/skill-coverage
+ * @param {String} skill The skill's or skill template's name
+ * @param {String} authToken Authentication token
+ * @returns {Promise<SkillCoverage>}
+ */
+export const getSkillCoverage = (skill, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/skill-coverage`, {
+            headers: { authorization: authToken },
+            params: { skill },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * The skill names the knowledge bases the caller can open suggest while a
+ * skill's or skill template's name is typed: the skills their documents were
+ * classified with whose name has a word starting with what was typed, in any
+ * spelling ("gov" suggests "AI Governance"), one per skill, most documents
+ * first. Only what the caller may open counts, as for `getSkillCoverage`.
+ * Fewer than 2 characters to match answer no suggestions. Requires
+ * VIEW_KNOWLEDGE_BASE; `q` is at most 200 characters (400 otherwise).
+ * GET /api/v1/knowledge-base/skill-suggestions
+ * @param {String} q What was typed
+ * @param {SkillSuggestionParams} params Optional limit, catalog and the id of
+ *   the skill or skill template being edited
+ * @param {String} authToken Authentication token
+ * @returns {Promise<SkillSuggestion[]>}
+ */
+export const getSkillSuggestions = (q, params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/skill-suggestions`, {
+            headers: { authorization: authToken },
+            params: { ...params, q },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * One of a knowledge base's skills, opened on its page: its microskills, as
+ * grouped, each with how many passages teach it, most first, and where the
+ * knowledge base's grouping stands (`grouping`). Any spelling of the skill
+ * matches. Requires VIEW_KNOWLEDGE_BASE and a role on the knowledge base; the
+ * name must be 1 to 200 characters (400 otherwise).
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills
+ * @param {String} id The knowledge base id
+ * @param {String} skill The skill's name
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkills>}
+ */
+export const listMicroSkills = (id, skill, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills/micro-skills`, {
+            headers: { authorization: authToken },
+            params: { skill },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Where a knowledge base's microskill grouping stands: queued, running or
+ * idle, and when the last one ended. What a page polls while a grouping is
+ * under way, rather than `listMicroSkills`: the platform reads the knowledge
+ * base and nothing else. Requires VIEW_KNOWLEDGE_BASE and a role on the
+ * knowledge base.
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills/grouping
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>}
+ */
+export const getMicroSkillGrouping = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills/micro-skills/grouping`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Group now: groups the knowledge base's skills' passage tags into their
+ * microskills, in the background. Owner or editor only, as setting how its
+ * skills are named (403 otherwise; 404 for no such knowledge base). Asked
+ * while a grouping runs, nothing more is asked: the answer is that it is
+ * running. `getMicroSkillGrouping` says when it is done (no longer queued or
+ * running). The skills whose grouping failed are sent again now.
+ * POST /api/v1/knowledge-base/:id/skills/micro-skills/group
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>} Where the grouping
+ *   stands: queued or running, and when the last one ended
+ */
+export const groupMicroSkills = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/skills/micro-skills/group`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+//# sourceMappingURL=skills.js.map

package/dist/esm/lib/knowledgeBase/skills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skills.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/skills.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAsK3C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,EAAU,EACV,MAAuB,EACvB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,SAAS,EAAE;YAChE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,aAA6B,EAC7B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,iBAAiB,EAC7C,EAAE,aAAa,EAAE,EACjB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,KAAa,EACb,SAAiB,EACO,EAAE;IAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAClE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,CAAS,EACT,MAAyC,EACzC,SAAiB,EACW,EAAE;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YACrE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE;SACzB,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,EAAU,EACV,KAAa,EACb,SAAiB,EACkB,EAAE;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,sBAAsB,EAClD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,EAAU,EACV,SAAiB,EACyB,EAAE;IAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,+BAA+B,EAC3D,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACyB,EAAE;IAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,4BAA4B,EACxD,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/esm/lib/knowledgeBase/sources.d.ts

@@ -0,0 +1,136 @@
+import type { SkillSettings } from "./skills.js";
+/**
+ * What happens to sensitive data found in content: it is masked and the
+ * document indexed (`"redact_in_place"`), the document is held for review
+ * (`"quarantine"`), or it is refused (`"fail"`). `providerIntegrationId` names
+ * a DLP_PROVIDER integration; null falls back to the tenant's default.
+ */
+export interface RedactionPolicy {
+    behavior: "redact_in_place" | "quarantine" | "fail";
+    providerIntegrationId?: string | null;
+}
+/**
+ * A connection's configuration, as `addSource` and `updateSource` send it.
+ *
+ * `skillSettings` and `redactionPolicy` are the connection's — the knowledge
+ * base holds neither. Omitted on add, a connection discovers and redacts in
+ * place; omitted on update, they are left as they are; null is refused.
+ * Setting `redactionPolicy` asks for MANAGE_COMPLIANCE; without it the call is
+ * refused (403) and nothing else in the same payload is saved either. Changing
+ * `skillSettings` labels that connection's documents again on the sync the
+ * save raises. A knowledge base read gives every connection both.
+ */
+export interface SourceInput {
+    name?: string;
+    /** The KB_SOURCE_CONNECTOR integration to sync through. */
+    integrationId?: string;
+    type?: string | null;
+    url?: string;
+    /** The connector's own selection rules, or null for none. */
+    syncFilters?: object | null;
+    /** 1 to 365 days, or null for manual-only. Default 7. */
+    syncFrequencyDays?: number | null;
+    /** One-time handle for credentials parked at OAuth exchange. */
+    authenticationHandle?: string;
+    /** `null` clears the stored credentials; omitted leaves them alone. */
+    authentication?: object | null;
+    /** What labelling looks for in this connection's content. */
+    skillSettings?: SkillSettings;
+    /** What happens to sensitive data found in it. Needs MANAGE_COMPLIANCE. */
+    redactionPolicy?: RedactionPolicy;
+}
+/**
+ * List the available KB_SOURCE_CONNECTOR integrations (enabled integrations +
+ * capability manifests for the source-creation form).
+ * GET /api/v1/knowledge-base/source-connectors
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listSourceConnectors: (authToken: string) => Promise<object>;
+/**
+ * Add a source to a knowledge base (`integrationId` + credentials +
+ * `syncFrequencyDays`, default 7). Publishes a kb-source-event (changeType="add").
+ * POST /api/v1/knowledge-base/:id/sources
+ * @param {String} id The knowledge base id
+ * @param {SourceInput} source The source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const addSource: (id: string, source: SourceInput, authToken: string) => Promise<object>;
+/**
+ * Update a knowledge base source. Publishes a kb-source-event per changed source.
+ * PUT /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {SourceInput} source The updated source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const updateSource: (id: string, sourceId: string, source: SourceInput, authToken: string) => Promise<object>;
+/**
+ * Remove a source from a knowledge base. Publishes a kb-source-event
+ * (changeType="delete").
+ * DELETE /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const deleteSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Trigger a manual re-sync of a source. Publishes a kb-source-event
+ * (changeType="update", trigger="manual_sync").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/sync
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const syncSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Process every processed document of a source again — classification, labels,
+ * chunks and embeddings redone — on a run of the source. Quarantined and blocked
+ * documents are left as they are. A run starts now, or a follow-up run is owed
+ * while one is outstanding (trigger="reprocess").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/reprocess
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} { ok, documents, correlationId, started }: how many
+ *   documents were marked, the run, and whether it started now
+ */
+export declare const reprocessSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Test a source's connector credentials (dispatches TEST_CONNECTION).
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/test
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const testSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * List the current user's source-side identities.
+ * GET /api/v1/identity/source-mappings
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listSourceMappings: (authToken: string) => Promise<object>;
+/**
+ * Tenant-admin override for a user's source identity mapping.
+ * PUT /api/v1/identity/source-mappings/:sourceType
+ * @param {String} sourceType The source type key
+ * @param {object} data The mapping override
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const updateSourceMapping: (sourceType: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Bulk-resolve source principal IDs → tenant users (internal / service-to-service).
+ * POST /api/v1/identity/source-mappings/resolve
+ * @param {object} data Body carrying the principal IDs to resolve
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const resolveSourceMappings: (data: object, authToken: string) => Promise<object>;
+//# sourceMappingURL=sources.d.ts.map

package/dist/esm/lib/knowledgeBase/sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.d.ts","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/sources.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAOjD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,iBAAiB,GAAG,YAAY,GAAG,MAAM,CAAC;IACpD,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,2EAA2E;IAC3E,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAID;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAatE,CAAC;AAWF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,GACpB,IAAI,MAAM,EACV,QAAQ,WAAW,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,QAAQ,WAAW,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAKF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAapE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}

package/dist/esm/lib/knowledgeBase/sources.js

@@ -0,0 +1,221 @@
+import { client } from "../axiosClient.js";
+// ── Source Management ─────────────────────────────────────────────────────────
+/**
+ * List the available KB_SOURCE_CONNECTOR integrations (enabled integrations +
+ * capability manifests for the source-creation form).
+ * GET /api/v1/knowledge-base/source-connectors
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const listSourceConnectors = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/source-connectors`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+//
+// Between `listSourceConnectors` and `addSource` sit three calls that act on the
+// CONNECTOR itself rather than on a knowledge base — asking it what it accepts,
+// how the user signs in, and how much data is behind the resulting credentials.
+// Those live in the `knowledgeBaseSourceConnectors` module (they take a
+// connection id, not a KB id, and are mounted under
+// /api/v1/exceed/knowledgebasesourceconnectors).
+//
+/**
+ * Add a source to a knowledge base (`integrationId` + credentials +
+ * `syncFrequencyDays`, default 7). Publishes a kb-source-event (changeType="add").
+ * POST /api/v1/knowledge-base/:id/sources
+ * @param {String} id The knowledge base id
+ * @param {SourceInput} source The source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const addSource = (id, source, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/sources`, source, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Update a knowledge base source. Publishes a kb-source-event per changed source.
+ * PUT /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {SourceInput} source The updated source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const updateSource = (id, sourceId, source, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.put(`/api/v1/knowledge-base/${id}/sources/${sourceId}`, source, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Remove a source from a knowledge base. Publishes a kb-source-event
+ * (changeType="delete").
+ * DELETE /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const deleteSource = (id, sourceId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.delete(`/api/v1/knowledge-base/${id}/sources/${sourceId}`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Trigger a manual re-sync of a source. Publishes a kb-source-event
+ * (changeType="update", trigger="manual_sync").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/sync
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const syncSource = (id, sourceId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/sources/${sourceId}/sync`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Process every processed document of a source again — classification, labels,
+ * chunks and embeddings redone — on a run of the source. Quarantined and blocked
+ * documents are left as they are. A run starts now, or a follow-up run is owed
+ * while one is outstanding (trigger="reprocess").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/reprocess
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} { ok, documents, correlationId, started }: how many
+ *   documents were marked, the run, and whether it started now
+ */
+export const reprocessSource = (id, sourceId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/sources/${sourceId}/reprocess`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Test a source's connector credentials (dispatches TEST_CONNECTION).
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/test
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const testSource = (id, sourceId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/sources/${sourceId}/test`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+// ── Identity Mapping ──────────────────────────────────────────────────────────
+// (design §14 — maps source-side principals to tenant users for KB source ACLs.)
+/**
+ * List the current user's source-side identities.
+ * GET /api/v1/identity/source-mappings
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const listSourceMappings = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/identity/source-mappings`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Tenant-admin override for a user's source identity mapping.
+ * PUT /api/v1/identity/source-mappings/:sourceType
+ * @param {String} sourceType The source type key
+ * @param {object} data The mapping override
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const updateSourceMapping = (sourceType, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.put(`/api/v1/identity/source-mappings/${sourceType}`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * Bulk-resolve source principal IDs → tenant users (internal / service-to-service).
+ * POST /api/v1/identity/source-mappings/resolve
+ * @param {object} data Body carrying the principal IDs to resolve
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export const resolveSourceMappings = (data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/identity/source-mappings/resolve`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+//# sourceMappingURL=sources.js.map

package/dist/esm/lib/knowledgeBase/sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/sources.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAkD3C,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAmB,EAAE;IACzE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YACrE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,EAAE;AACF,iFAAiF;AACjF,gFAAgF;AAChF,gFAAgF;AAChF,wEAAwE;AACxE,oDAAoD;AACpD,iDAAiD;AACjD,EAAE;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,EAAU,EACV,MAAmB,EACnB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,UAAU,EACtC,MAAM,EACN,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,EAAU,EACV,QAAgB,EAChB,MAAmB,EACnB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,YAAY,QAAQ,EAAE,EAClD,MAAM,EACN,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,EAAU,EACV,QAAgB,EAChB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAC3B,0BAA0B,EAAE,YAAY,QAAQ,EAAE,EAClD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,EAAU,EACV,QAAgB,EAChB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,YAAY,QAAQ,OAAO,EACvD,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,EAAU,EACV,QAAgB,EAChB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,YAAY,QAAQ,YAAY,EAC5D,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,EAAU,EACV,QAAgB,EAChB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,YAAY,QAAQ,OAAO,EACvD,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iFAAiF;AACjF,iFAAiF;AAEjF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAmB,EAAE;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAC7D,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,UAAkB,EAClB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,oCAAoC,UAAU,EAAE,EAChD,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0CAA0C,EAC1C,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}