@nacre.work/sdk 0.26.4 → 0.26.6

package/dist/audit-actions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The names the access log records, for a client that has to offer them.
+ *
+ * `GET /v1/audit?action=` is an exact match, so a person filtering the log needs
+ * the names as they are recorded — the console offers these in its Action box,
+ * and nothing else in the product would tell them.
+ *
+ * **A copy, and deliberately one.** The source is `packages/core/audit-actions.ts`,
+ * which the writers and the reader use; this package has no dependencies and a
+ * browser bundle cannot import the core, so the list is repeated here and
+ * `lint:audit-actions` holds the two line for line. Changing one without the
+ * other fails there.
+ *
+ * Not every recorded action is here, and a caller should still accept free
+ * text: a request that fails with a 500 is recorded under its path, and a
+ * commercial module records names of its own.
+ */
+export interface AuditActionInfo {
+    readonly name: string;
+    /** Withheld from a `platform_admin`'s log — a substantive access to a document. */
+    readonly documentAccess: boolean;
+    readonly summary: string;
+}
+export declare const AUDIT_ACTIONS: readonly AuditActionInfo[];
+//# sourceMappingURL=audit-actions.d.ts.map

package/dist/audit-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-actions.d.ts","sourceRoot":"","sources":["../src/audit-actions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,mFAAmF;IACnF,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAA;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,eAAO,MAAM,aAAa,EAAE,SAAS,eAAe,EA0CnD,CAAA"}

package/dist/audit-actions.js

@@ -0,0 +1,44 @@
+export const AUDIT_ACTIONS = [
+    { name: 'add_group_member', documentAccess: false, summary: 'A principal was added to a group' },
+    { name: 'administer_principals', documentAccess: false, summary: 'Someone who is not an org_admin asked for users or groups' },
+    { name: 'admin.delete', documentAccess: false, summary: 'A module route under /v1/admin, DELETE' },
+    { name: 'admin.get', documentAccess: false, summary: 'A module route under /v1/admin, GET' },
+    { name: 'admin.patch', documentAccess: false, summary: 'A module route under /v1/admin, PATCH' },
+    { name: 'admin.post', documentAccess: false, summary: 'A module route under /v1/admin, POST' },
+    { name: 'admin.put', documentAccess: false, summary: 'A module route under /v1/admin, PUT' },
+    { name: 'audit.read', documentAccess: false, summary: 'The access log was read' },
+    { name: 'create_group', documentAccess: false, summary: 'A group was created' },
+    { name: 'create_layer', documentAccess: false, summary: 'A layer was created' },
+    { name: 'create_service_account', documentAccess: false, summary: 'A service account was created' },
+    { name: 'create_user', documentAccess: false, summary: 'A user was created' },
+    { name: 'create_workspace', documentAccess: false, summary: 'A workspace was created' },
+    { name: 'delete_document', documentAccess: false, summary: 'A document was deleted' },
+    { name: 'delete_group', documentAccess: false, summary: 'A group was deleted' },
+    { name: 'delete_layer', documentAccess: false, summary: 'A layer and its documents were deleted' },
+    { name: 'disable_user', documentAccess: false, summary: 'A user was disabled' },
+    { name: 'embedding_provider.create', documentAccess: false, summary: 'An embedding provider was added' },
+    { name: 'embedding_provider.delete', documentAccess: false, summary: 'An embedding provider was removed' },
+    { name: 'get_document', documentAccess: true, summary: 'A document was fetched' },
+    { name: 'ingest', documentAccess: false, summary: 'A document was ingested' },
+    { name: 'issue_grant', documentAccess: false, summary: 'A grant was issued' },
+    { name: 'layer.reindex', documentAccess: false, summary: 'A layer was moved onto another embedding model' },
+    { name: 'login', documentAccess: false, summary: 'A person signed in' },
+    { name: 'oauth.consent', documentAccess: false, summary: 'An application was approved' },
+    { name: 'oauth.revoke', documentAccess: false, summary: 'A connected application was forgotten' },
+    { name: 'password.change', documentAccess: false, summary: 'A person changed their own password' },
+    { name: 'rate_limited', documentAccess: false, summary: 'A request was refused by the rate limiter' },
+    { name: 'reference_queries.replace', documentAccess: false, summary: "A layer's reference queries were replaced" },
+    { name: 'remove_group_member', documentAccess: false, summary: 'A principal was removed from a group' },
+    { name: 'reset_password', documentAccess: false, summary: "An administrator reset someone's password" },
+    { name: 'retry_document', documentAccess: false, summary: 'A failed document was queued again' },
+    { name: 'revoke_grant', documentAccess: false, summary: 'A grant was revoked' },
+    { name: 'revoke_service_account', documentAccess: false, summary: 'A service account was revoked' },
+    { name: 'search', documentAccess: true, summary: 'A search was run' },
+    { name: 'second_factor.enrol', documentAccess: false, summary: 'A second factor was enrolled' },
+    { name: 'second_factor.remove', documentAccess: false, summary: 'A second factor was removed' },
+    { name: 'tenant_override_attempt', documentAccess: false, summary: 'A request tried to name another organization' },
+    { name: 'update_layer', documentAccess: false, summary: 'A layer was renamed' },
+    { name: 'update_metadata', documentAccess: false, summary: "A document's tags were changed" },
+    { name: 'update_user', documentAccess: false, summary: 'A user was changed — role, or enabled again' },
+];
+//# sourceMappingURL=audit-actions.js.map

package/dist/audit-actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-actions.js","sourceRoot":"","sources":["../src/audit-actions.ts"],"names":[],"mappings":"AAwBA,MAAM,CAAC,MAAM,aAAa,GAA+B;IACvD,EAAE,IAAI,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,kCAAkC,EAAE;IAChG,EAAE,IAAI,EAAE,uBAAuB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,2DAA2D,EAAE;IAC9H,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,wCAAwC,EAAE;IAClG,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qCAAqC,EAAE;IAC5F,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,uCAAuC,EAAE;IAChG,EAAE,IAAI,EAAE,YAAY,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,sCAAsC,EAAE;IAC9F,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qCAAqC,EAAE;IAC5F,EAAE,IAAI,EAAE,YAAY,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,EAAE;IACjF,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,wBAAwB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,+BAA+B,EAAE;IACnG,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE;IAC7E,EAAE,IAAI,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,EAAE;IACvF,EAAE,IAAI,EAAE,iBAAiB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,wBAAwB,EAAE;IACrF,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,wCAAwC,EAAE;IAClG,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,2BAA2B,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,iCAAiC,EAAE;IACxG,EAAE,IAAI,EAAE,2BAA2B,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,mCAAmC,EAAE;IAC1G,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,wBAAwB,EAAE;IACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,EAAE;IAC7E,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE;IAC7E,EAAE,IAAI,EAAE,eAAe,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,gDAAgD,EAAE;IAC3G,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE;IACvE,EAAE,IAAI,EAAE,eAAe,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,6BAA6B,EAAE;IACxF,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,uCAAuC,EAAE;IACjG,EAAE,IAAI,EAAE,iBAAiB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qCAAqC,EAAE;IAClG,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,2CAA2C,EAAE;IACrG,EAAE,IAAI,EAAE,2BAA2B,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,2CAA2C,EAAE;IAClH,EAAE,IAAI,EAAE,qBAAqB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,sCAAsC,EAAE;IACvG,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,2CAA2C,EAAE;IACvG,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,oCAAoC,EAAE;IAChG,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,wBAAwB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,+BAA+B,EAAE;IACnG,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACrE,EAAE,IAAI,EAAE,qBAAqB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,8BAA8B,EAAE;IAC/F,EAAE,IAAI,EAAE,sBAAsB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,6BAA6B,EAAE;IAC/F,EAAE,IAAI,EAAE,yBAAyB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,8CAA8C,EAAE;IACnH,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAC/E,EAAE,IAAI,EAAE,iBAAiB,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,gCAAgC,EAAE;IAC7F,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,6CAA6C,EAAE;CACvG,CAAA"}

package/dist/index.d.ts

@@ -38,6 +38,7 @@
  *
  * Contract: docs/api.md, machine-readable in docs/openapi.yaml.
  */
+export { AUDIT_ACTIONS, type AuditActionInfo } from './audit-actions.js';
 export { NacreClient, type ClientOptions } from './client.js';
 export { NacreError, NacreTransportError, type Problem } from './errors.js';
 export type { BegunSecondFactor, SecondFactor, SecondFactorKind, ConfirmedSecondFactor, SecondFactorEnrolmentRequired, SecondFactorRequired, WebAuthnAssertion, WebAuthnAssertionOptions, WebAuthnRegistrationOptions, SignIn, Connection, Self, AuditPage, AuditQuery, AuditRecord, CreatedServiceAccount, CreatedUser, Document, Effect, EmbeddingProvider, Grant, GrantInput, Group, GroupMember, IngestOutcome, IngestRequest, Job, JobStatus, Layer, LayerInput, Permission, PrincipalType, RecallCheck, ReferenceQuery, ReferenceQueryInput, ReindexStatus, ReindexStatusName, ScopeType, SearchHit, SearchOptions, ServiceAccount, Tokens, User, UserRole, Workspace, } from './types.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,WAAW,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,KAAK,OAAO,EAAE,MAAM,aAAa,CAAA;AAC3E,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,EACrB,6BAA6B,EAC7B,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,2BAA2B,EAC3B,MAAM,EACN,UAAU,EACV,IAAI,EACJ,SAAS,EACT,UAAU,EACV,WAAW,EACX,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,MAAM,EAGN,iBAAiB,EACjB,KAAK,EACL,UAAU,EACV,KAAK,EACL,WAAW,EACX,aAAa,EACb,aAAa,EACb,GAAG,EACH,SAAS,EACT,KAAK,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,EACd,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,SAAS,GACV,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,EAAE,WAAW,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,KAAK,OAAO,EAAE,MAAM,aAAa,CAAA;AAC3E,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,EACrB,6BAA6B,EAC7B,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,2BAA2B,EAC3B,MAAM,EACN,UAAU,EACV,IAAI,EACJ,SAAS,EACT,UAAU,EACV,WAAW,EACX,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,MAAM,EAGN,iBAAiB,EACjB,KAAK,EACL,UAAU,EACV,KAAK,EACL,WAAW,EACX,aAAa,EACb,aAAa,EACb,GAAG,EACH,SAAS,EACT,KAAK,EACL,UAAU,EACV,UAAU,EACV,aAAa,EACb,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,EACd,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,SAAS,GACV,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -38,6 +38,7 @@
  *
  * Contract: docs/api.md, machine-readable in docs/openapi.yaml.
  */
+export { AUDIT_ACTIONS } from './audit-actions.js';
 export { NacreClient } from './client.js';
 export { NacreError, NacreTransportError } from './errors.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,WAAW,EAAsB,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAgB,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,aAAa,EAAwB,MAAM,oBAAoB,CAAA;AACxE,OAAO,EAAE,WAAW,EAAsB,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAgB,MAAM,aAAa,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nacre.work/sdk",
-  "version": "0.26.4",
+  "version": "0.26.6",
   "description": "TypeScript client for the Nacre REST API",
   "repository": {
     "type": "git",