@stackfactor/client-api 1.19.3 → 1.20.2

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"}