@stackfactor/client-api 1.19.3 → 1.20.2

package/dist/cjs/lib/knowledgeBase/knowledgeBases.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rightToBeForgotten = exports.updateComplianceProfile = exports.getComplianceProfile = exports.revokeAccess = exports.grantAccess = exports.listAccess = exports.deleteKnowledgeBase = exports.updateKnowledgeBase = exports.getKnowledgeBase = exports.createKnowledgeBase = exports.listKnowledgeBases = void 0;
+const axiosClient_js_1 = require("../axiosClient.js");
+// ── Knowledge Base CRUD ───────────────────────────────────────────────────────
+/**
+ * List the knowledge bases the caller can see.
+ * GET /api/v1/knowledge-base
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listKnowledgeBases = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listKnowledgeBases = listKnowledgeBases;
+/**
+ * Create a knowledge base (the creator becomes owner automatically). Requires the
+ * global CREATE_KNOWLEDGE_BASE capability.
+ * POST /api/v1/knowledge-base
+ * @param {KnowledgeBaseInput} data KB metadata (at minimum `name`)
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const createKnowledgeBase = (data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base`, data, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.createKnowledgeBase = createKnowledgeBase;
+/**
+ * Get a single knowledge base (plus stats).
+ * GET /api/v1/knowledge-base/:id
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const getKnowledgeBase = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getKnowledgeBase = getKnowledgeBase;
+/**
+ * Update a knowledge base's metadata. Owner or editor only. Does not touch
+ * `access[]`, `sources`, or `createdBy` — those have their own gated flows.
+ * PUT /api/v1/knowledge-base/:id
+ * @param {String} id The knowledge base id
+ * @param {KnowledgeBaseInput} data The fields to update
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const updateKnowledgeBase = (id, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.put(`/api/v1/knowledge-base/${id}`, data, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.updateKnowledgeBase = updateKnowledgeBase;
+/**
+ * Delete a knowledge base (cascades to its chunks). Owner only.
+ * DELETE /api/v1/knowledge-base/:id
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const deleteKnowledgeBase = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.delete(`/api/v1/knowledge-base/${id}`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.deleteKnowledgeBase = deleteKnowledgeBase;
+// ── KB Access Management (owner only) ─────────────────────────────────────────
+/**
+ * List a knowledge base's access entries.
+ * GET /api/v1/knowledge-base/:id/access
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listAccess = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/access`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listAccess = listAccess;
+/**
+ * Grant (upsert) an access entry. Owner only. Access is keyed by
+ * `(subjectType, subjectId)`, so re-granting a subject that already has an entry
+ * updates its role — there is no separate "update role" endpoint.
+ * POST /api/v1/knowledge-base/:id/access
+ * @param {String} id The knowledge base id
+ * @param {AccessEntryInput} entry The `{ subjectType, subjectId, role }` grant
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const grantAccess = (id, entry, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/access`, entry, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.grantAccess = grantAccess;
+/**
+ * Revoke a subject's access. Owner only. Keyed by `(subjectType, subjectId)` — the
+ * same composite key `grantAccess` upserts on. The backend refuses to remove the
+ * last owner.
+ * DELETE /api/v1/knowledge-base/:id/access
+ * @param {String} id The knowledge base id
+ * @param {String} subjectType One of `KNOWLEDGE_BASE.SUBJECT_TYPE`
+ * @param {String} subjectId The subject whose access is revoked
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const revokeAccess = (id, subjectType, subjectId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.delete(`/api/v1/knowledge-base/${id}/access`, {
+            headers: { authorization: authToken },
+            data: { subjectType: subjectType, subjectId: subjectId },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.revokeAccess = revokeAccess;
+// ── Compliance ────────────────────────────────────────────────────────────────
+/**
+ * Read the tenant's compliance profile (admin only). Governs which RAG processors
+ * a KB may route to (e.g. HIPAA tenants → BAA-eligible processors only).
+ * GET /api/v1/tenants/compliance-profile
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const getComplianceProfile = (authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/tenants/compliance-profile`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getComplianceProfile = getComplianceProfile;
+/**
+ * Update the tenant's compliance profile (admin only; not exposed via the KB UI).
+ * PUT /api/v1/tenants/compliance-profile
+ * @param {object} profile The compliance profile
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const updateComplianceProfile = (profile, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.put(`/api/v1/tenants/compliance-profile`, profile, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.updateComplianceProfile = updateComplianceProfile;
+/**
+ * Trigger a GDPR subject-purge ("right to be forgotten"; admin only).
+ * POST /api/v1/compliance/right-to-be-forgotten
+ * @param {object} data The subject-purge request
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const rightToBeForgotten = (data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/compliance/right-to-be-forgotten`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.rightToBeForgotten = rightToBeForgotten;
+//# sourceMappingURL=knowledgeBases.js.map

package/dist/cjs/lib/knowledgeBase/knowledgeBases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledgeBases.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/knowledgeBases.ts"],"names":[],"mappings":";;;AACA,sDAA2C;AA+B3C,iFAAiF;AAEjF;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAmB,EAAE;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YACnD,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;AAbW,QAAA,kBAAkB,sBAa7B;AAEF;;;;;;;GAOG;AACI,MAAM,mBAAmB,GAAG,CACjC,IAAwB,EACxB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,EAAE;YAC1D,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;AAhBW,QAAA,mBAAmB,uBAgB9B;AAEF;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,EAAE;YACzD,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;AAhBW,QAAA,gBAAgB,oBAgB3B;AAEF;;;;;;;;GAQG;AACI,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,IAAwB,EACxB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,EAAE,IAAI,EAAE;YAC/D,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;AAjBW,QAAA,mBAAmB,uBAiB9B;AAEF;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,MAAM,CAAC,0BAA0B,EAAE,EAAE,EAAE;YAC5D,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;AAhBW,QAAA,mBAAmB,uBAgB9B;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,EAAU,EAAE,SAAiB,EAAmB,EAAE;IAC3E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,SAAS,EAAE;YAChE,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;AAbW,QAAA,UAAU,cAarB;AAEF;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CACzB,EAAU,EACV,KAAuB,EACvB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE,SAAS,EAAE,KAAK,EAAE;YACxE,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;AAjBW,QAAA,WAAW,eAiBtB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,CAC1B,EAAU,EACV,WAAmB,EACnB,SAAiB,EACjB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,MAAM,CAAC,0BAA0B,EAAE,SAAS,EAAE;YACnE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,IAAI,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE;SACzD,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;AAnBW,QAAA,YAAY,gBAmBvB;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAmB,EAAE;IACzE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE;YAC/D,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;AAbW,QAAA,oBAAoB,wBAa/B;AAEF;;;;;;GAMG;AACI,MAAM,uBAAuB,GAAG,CACrC,OAAe,EACf,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,oCAAoC,EACpC,OAAO,EACP,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;AAlBW,QAAA,uBAAuB,2BAkBlC;AAEF;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAlBW,QAAA,kBAAkB,sBAkB7B"}

package/dist/cjs/lib/knowledgeBase/review.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Overview of all Review Center streams + counts for a knowledge base.
+ * GET /api/v1/knowledge-base/:id/review
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const getReviewOverview: (id: string, authToken: string) => Promise<object>;
+/**
+ * List QUARANTINED documents (Review Center stream 1).
+ * GET /api/v1/knowledge-base/:id/review/quarantine
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listQuarantine: (id: string, authToken: string) => Promise<object>;
+/**
+ * List the documents released from review (Review Center stream 1): every one
+ * released and not held again since, the newest release first, each with
+ * `quarantineReleasedAt` and `quarantineReleasedByName` (who released it, or
+ * null). Requires RELEASE_QUARANTINE + owner|editor, as the held list does.
+ * GET /api/v1/knowledge-base/:id/review/quarantine?state=released
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listReleased: (id: string, authToken: string) => Promise<object>;
+/**
+ * Release a quarantined document. Requires RELEASE_QUARANTINE + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/release
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const releaseQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
+/**
+ * Apply a reviewer's decisions to many held documents at once: release each
+ * named document back through ingestion, keep it in quarantine as reviewed, or
+ * block it from the knowledge base. One run per source released into is asked
+ * for, never one per document. Requires RELEASE_QUARANTINE + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/decisions
+ * @param {String} id The knowledge base id
+ * @param {Array<{documentId: string, decision: "release"|"quarantine"|"block", reason?: string}>} decisions One decision per document, at most 500
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} `{ results: [{ documentId, decision, outcome }], runs: [{ sourceId, correlationId, started }] }`
+ */
+export declare const decideQuarantine: (id: string, decisions: Array<{
+    documentId: string;
+    decision: string;
+    reason?: string;
+}>, authToken: string) => Promise<object>;
+/**
+ * Re-ingest a quarantined document (optionally with an updated redaction policy).
+ * Publishes a kb-source-event (trigger="quarantine_re_ingest"). Requires
+ * RELEASE_QUARANTINE + owner.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/re-ingest
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {object} data Optional body, e.g. `{ updatedRedactionPolicy }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const reingestQuarantine: (id: string, docId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Delete a quarantined document. Requires RELEASE_QUARANTINE + owner.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/delete
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const deleteQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
+/**
+ * List generated artifacts awaiting review (needsReview=true).
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * GET /api/v1/knowledge-base/:id/review/generated
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listGeneratedReview: (id: string, authToken: string) => Promise<object>;
+/**
+ * Approve a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/approve
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, notes? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const approveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Approve a generated artifact with edits.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/edit-approve
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, edits, notes? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const editApproveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Reject a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/reject
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, reason }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const rejectGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Regenerate a generated artifact using current chunks.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/regenerate
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, regenerationHints? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const regenerateGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * List chunks with non-empty contradictionFlags[].
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * GET /api/v1/knowledge-base/:id/review/contradictions
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listContradictions: (id: string, authToken: string) => Promise<object>;
+/**
+ * Decide a contradiction between two chunks.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/contradictions/:chunkId/decide
+ * @param {String} id The knowledge base id
+ * @param {String} chunkId The chunk id carrying the contradiction flag
+ * @param {object} data Body `{ decision, otherChunkId, notes }` — `decision` is one
+ *   of `KNOWLEDGE_BASE.CONTRADICTION_DECISION`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const decideContradiction: (id: string, chunkId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Regenerate a stale artifact from a notification using current chunks.
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/regenerate
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const regenerateArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Retire (soft-delete) a stale artifact from a notification.
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/retire
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const retireArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Dismiss a stale-artifact flag (mark the staleness acceptable).
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/dismiss
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType, reason? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const dismissArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Dismiss an entire out-of-sync notification (all artifacts).
+ * POST /api/v1/notifications/:notificationId/dismiss-all
+ * @param {String} notificationId The notification id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const dismissAllArtifacts: (notificationId: string, authToken: string) => Promise<object>;
+//# sourceMappingURL=review.d.ts.map

package/dist/cjs/lib/knowledgeBase/review.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/review.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,WAAW,KAAK,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,EAC3E,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,SAAS,MAAM,EACf,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAMF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAC7B,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,gBAAgB,MAAM,EACtB,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,gBAAgB,MAAM,EACtB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}