verdifax 1.2.0 → 1.3.0

package/dist/index.js

@@ -674,7 +674,7 @@ var VerdifaxJob = class {
 };
 
 // src/version.ts
-var SDK_VERSION = "1.2.0";
+var SDK_VERSION = "1.3.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.verdifax.com";
@@ -685,6 +685,10 @@ var SDK_USER_AGENT = `verdifax-sdk-node/${SDK_VERSION}`;
 var HEADER_API_KEY = "X-Verdifax-Key";
 var REQUEST_KEY_PATH = "/keys/request-key";
 var POLICIES_PATH = "/policies";
+var ACCOUNT_PATH = "/account";
+var ACCOUNT_REQUEST_KEY_PATH = "/account/request-key";
+var ACCOUNT_POLICIES_PATH = "/account/policies";
+var ACCOUNT_CHAIN_ID = /^account-[1-9][0-9]*$/;
 var HEADER_EXPORT_TOTAL = "X-Verdifax-Total";
 var HEADER_EXPORT_TRUNCATED = "X-Verdifax-Truncated";
 var RETRYABLE_STATUSES = /* @__PURE__ */ new Set([429, 502, 503, 504]);
@@ -870,15 +874,18 @@ var VerdifaxClient = class {
    *  that the client holds the private key. From then on the server
    *  refuses a run on this API key without a request signature. */
   async registerRequestKey() {
+    return this.registerRequestKeyAt(REQUEST_KEY_PATH, "registerRequestKey");
+  }
+  async registerRequestKeyAt(path, method) {
     this.requireAPIKey();
     if (!this.signingKey) {
       throw new VerdifaxError(
-        "verdifax: registerRequestKey needs the signingKey client option"
+        `verdifax: ${method} needs the signingKey client option`
       );
     }
     return this.request(
       "POST",
-      REQUEST_KEY_PATH,
+      path,
       requestKeyRegistrationBody(this.signingKey)
     );
   }
@@ -917,10 +924,13 @@ var VerdifaxClient = class {
    *  unsigned requests, because the server refuses a signed run on an API
    *  key with no registered key. If the call fails it keeps the key. */
   async clearRequestKey() {
+    await this.clearRequestKeyAt(REQUEST_KEY_PATH);
+  }
+  async clearRequestKeyAt(path) {
     this.requireAPIKey();
     await this.request(
       "DELETE",
-      REQUEST_KEY_PATH,
+      path,
       this.signingKey ? { change: requestKeyChangeApproval(this.signingKey, "") } : void 0
     );
     this.signingKey = void 0;
@@ -932,13 +942,7 @@ var VerdifaxClient = class {
    *  not a string: serializing an object here would change the hash.
    *  Verdifax does not write, review or approve a customer's policy. */
   async uploadPolicy(document) {
-    this.requireAPIKey();
-    if (typeof document !== "string") {
-      throw new VerdifaxError(
-        "verdifax: document must be the policy's exact text, as a string"
-      );
-    }
-    return this.request("POST", POLICIES_PATH, { document });
+    return this.uploadPolicyAt(POLICIES_PATH, document);
   }
   /** This key's stored documents, with the chain its changes belong to,
    *  the newest change in it (64 zeros when there is none yet) and the
@@ -949,44 +953,13 @@ var VerdifaxClient = class {
   }
   /** One stored document, with its exact text as `document`. */
   async getPolicy(documentHash) {
-    this.requireAPIKey();
-    validateHex64(documentHash, "documentHash");
-    return this.request(
-      "GET",
-      `${POLICIES_PATH}/${documentHash}`
-    );
+    return this.getPolicyAt(POLICIES_PATH, documentHash);
   }
   /** Shows which rule would fire on sample inputs, for a document given as
    *  text or one already stored, named by its hash: exactly one of the two.
    *  It seals nothing. */
   async testPolicy(req) {
-    this.requireAPIKey();
-    const { inputs, document, documentHash } = req ?? {};
-    if (document === void 0 === (documentHash === void 0)) {
-      throw new VerdifaxError(
-        "verdifax: testPolicy needs exactly one of document or documentHash"
-      );
-    }
-    if (typeof inputs !== "object" || inputs === null || Array.isArray(inputs)) {
-      throw new VerdifaxError("verdifax: testPolicy needs inputs as an object");
-    }
-    const body = { inputs };
-    if (document !== void 0) {
-      if (typeof document !== "string") {
-        throw new VerdifaxError(
-          "verdifax: document must be the policy's exact text, as a string"
-        );
-      }
-      body.document = document;
-    } else {
-      validateHex64(documentHash, "documentHash");
-      body.document_hash = documentHash;
-    }
-    return this.request(
-      "POST",
-      `${POLICIES_PATH}/test`,
-      body
-    );
+    return this.testPolicyAt(POLICIES_PATH, req, "testPolicy");
   }
   /** This key's policy changes, oldest first, as the list the server sends.
    *  Save it as JSON, for example with
@@ -1012,7 +985,54 @@ var VerdifaxClient = class {
   async activatePolicy(documentHash) {
     this.requireAPIKey();
     validateHex64(documentHash, "documentHash");
-    const chain = await this.listPolicies();
+    return this.activatePolicyAt(
+      POLICIES_PATH,
+      documentHash,
+      await this.listPolicies()
+    );
+  }
+  async uploadPolicyAt(base, document) {
+    this.requireAPIKey();
+    if (typeof document !== "string") {
+      throw new VerdifaxError(
+        "verdifax: document must be the policy's exact text, as a string"
+      );
+    }
+    return this.request("POST", base, { document });
+  }
+  async getPolicyAt(base, documentHash) {
+    this.requireAPIKey();
+    validateHex64(documentHash, "documentHash");
+    return this.request("GET", `${base}/${documentHash}`);
+  }
+  async testPolicyAt(base, req, method) {
+    this.requireAPIKey();
+    const { inputs, document, documentHash } = req ?? {};
+    if (document === void 0 === (documentHash === void 0)) {
+      throw new VerdifaxError(
+        `verdifax: ${method} needs exactly one of document or documentHash`
+      );
+    }
+    if (typeof inputs !== "object" || inputs === null || Array.isArray(inputs)) {
+      throw new VerdifaxError(`verdifax: ${method} needs inputs as an object`);
+    }
+    const body = { inputs };
+    if (document !== void 0) {
+      if (typeof document !== "string") {
+        throw new VerdifaxError(
+          "verdifax: document must be the policy's exact text, as a string"
+        );
+      }
+      body.document = document;
+    } else {
+      validateHex64(documentHash, "documentHash");
+      body.document_hash = documentHash;
+    }
+    return this.request("POST", `${base}/test`, body);
+  }
+  /** Posts the change that follows the newest one in `chain`, signed by
+   *  the request key when the client has one. */
+  async activatePolicyAt(base, documentHash, chain) {
     const previous = chain?.newest_activation_hash;
     if (typeof previous !== "string") {
       throw new VerdifaxError(
@@ -1034,11 +1054,147 @@ var VerdifaxClient = class {
     }
     const out = await this.request(
       "POST",
-      `${POLICIES_PATH}/${documentHash}/activate`,
+      `${base}/${documentHash}/activate`,
       body
     );
     return out.activation;
   }
+  // ── Account, with its owner key (auth) ───────────────────────
+  //
+  // An account is a company on Verdifax. Every key belongs to one account
+  // for life. These methods need the account's owner key, which manages the
+  // account and cannot run anything: the server refuses it on every other
+  // route. The account number is a label Verdifax assigned, not a verified
+  // company identity.
+  /** The owner's account: its number, name, tier, key counts and the
+   *  chain of its policy changes. */
+  async getAccount() {
+    this.requireAPIKey();
+    return this.request("GET", ACCOUNT_PATH);
+  }
+  /** Creates a member key in the account. It takes the account's tier and
+   *  stays in the account for life. The secret is in the result this once.
+   *  On a trial account the key needs a request key before it can run. */
+  async createAccountKey(name, options = {}) {
+    this.requireAPIKey();
+    if (typeof name !== "string" || name.trim() === "") {
+      throw new VerdifaxError(
+        "verdifax: name is required for createAccountKey"
+      );
+    }
+    const body = { name };
+    if (options.expiresAt !== void 0) body.expires_at = options.expiresAt;
+    return this.request(
+      "POST",
+      `${ACCOUNT_PATH}/keys`,
+      body
+    );
+  }
+  /** Every key in the account, owner keys included, without secrets. */
+  async listAccountKeys() {
+    this.requireAPIKey();
+    const out = await this.request(
+      "GET",
+      `${ACCOUNT_PATH}/keys`
+    );
+    return { ...out, keys: out?.keys ?? [] };
+  }
+  /** Revokes one of the account's member keys. A key in another account,
+   *  or an owner key, throws {@link NotFoundError}. */
+  async revokeAccountKey(keyId) {
+    this.requireAPIKey();
+    requirePositiveId(keyId, "keyId");
+    return this.request(
+      "DELETE",
+      `${ACCOUNT_PATH}/keys/${keyId}`
+    );
+  }
+  /** Registers this client's public key as the owner key's request key,
+   *  which must sign every change to the account's policy. It works as
+   *  {@link registerRequestKey} does. */
+  async registerAccountRequestKey() {
+    return this.registerRequestKeyAt(
+      ACCOUNT_REQUEST_KEY_PATH,
+      "registerAccountRequestKey"
+    );
+  }
+  /** Clears the owner key's request key, as {@link clearRequestKey} does
+   *  for a key's own. With none registered the account's policy cannot be
+   *  changed. A trial owner key's request key cannot be cleared. */
+  async clearAccountRequestKey() {
+    await this.clearRequestKeyAt(ACCOUNT_REQUEST_KEY_PATH);
+  }
+  /** The runs of every key in the account, paged as {@link listRuns}. */
+  async listAccountRuns(params = {}) {
+    return this.listRunsAt(`${ACCOUNT_PATH}/runs`, params);
+  }
+  /** The runs of every key in the account in a period, as
+   *  {@link exportRuns} lists a key's, with the account's number, its
+   *  policy documents and its chain of changes. The account's view covers
+   *  the runs its keys made through Verdifax, not runs made elsewhere. */
+  async exportAccountRuns(params = {}) {
+    this.requireAPIKey();
+    return this.request(
+      "GET",
+      this.exportPath(`${ACCOUNT_PATH}/runs/export`, params, "json")
+    );
+  }
+  /** The same rows as {@link exportAccountRuns} as raw CSV text, checked
+   *  as {@link exportRunsCSV} checks a key's. */
+  async exportAccountRunsCSV(params = {}) {
+    return this.exportCSVAt(`${ACCOUNT_PATH}/runs/export`, params);
+  }
+  /** Stores an account policy document, as {@link uploadPolicy} stores a
+   *  key's. Every key in the account must pass the account's policy on top
+   *  of its own. Verdifax does not write, review or approve it. */
+  async uploadAccountPolicy(document) {
+    return this.uploadPolicyAt(ACCOUNT_POLICIES_PATH, document);
+  }
+  /** The account's stored documents, its chain `account-N`, the newest
+   *  change in it and the document in force. */
+  async listAccountPolicies() {
+    this.requireAPIKey();
+    return this.request("GET", ACCOUNT_POLICIES_PATH);
+  }
+  /** One of the account's documents, with its exact text. */
+  async getAccountPolicy(documentHash) {
+    return this.getPolicyAt(ACCOUNT_POLICIES_PATH, documentHash);
+  }
+  /** {@link testPolicy} for the account's documents. It seals nothing. */
+  async testAccountPolicy(req) {
+    return this.testPolicyAt(ACCOUNT_POLICIES_PATH, req, "testAccountPolicy");
+  }
+  /** The account's policy changes, oldest first, in the form
+   *  `verdifax-verify --policy-history FILE` reads. */
+  async getAccountPolicyHistory() {
+    this.requireAPIKey();
+    return this.request(
+      "GET",
+      `${ACCOUNT_POLICIES_PATH}/history`
+    );
+  }
+  /** Makes a stored document the account's policy in force, as
+   *  {@link activatePolicy} does for a key's. It reads
+   *  {@link listAccountPolicies} for the chain and its newest change, and
+   *  the owner key's request key signs the change over that chain,
+   *  `account-N`. The server refuses an unsigned account change, so this
+   *  needs the `signingKey` option and refuses to send without it. */
+  async activateAccountPolicy(documentHash) {
+    this.requireAPIKey();
+    validateHex64(documentHash, "documentHash");
+    if (!this.signingKey) {
+      throw new VerdifaxError(
+        "verdifax: activateAccountPolicy needs the owner key's request key in the signingKey client option, because the server refuses an unsigned account policy change"
+      );
+    }
+    const chain = await this.listAccountPolicies();
+    if (typeof chain?.chain_id !== "string" || !ACCOUNT_CHAIN_ID.test(chain.chain_id)) {
+      throw new VerdifaxError(
+        "verdifax: the server did not report an account chain_id (account-N), so the change cannot be signed"
+      );
+    }
+    return this.activatePolicyAt(ACCOUNT_POLICIES_PATH, documentHash, chain);
+  }
   // ── Runs ──────────────────────────────────────────────────────
   async getRun(runId) {
     this.requireAPIKey();
@@ -1051,6 +1207,9 @@ var VerdifaxClient = class {
     return this.request("GET", `/runs/${runId}/verify`);
   }
   async listRuns(params = {}) {
+    return this.listRunsAt("/runs", params);
+  }
+  async listRunsAt(base, params) {
     this.requireAPIKey();
     const q = new URLSearchParams();
     if (params.limit && params.limit > 0) {
@@ -1060,7 +1219,7 @@ var VerdifaxClient = class {
       q.set("offset", String(params.offset));
     }
     const qs = q.toString();
-    const path = qs ? `/runs?${qs}` : "/runs";
+    const path = qs ? `${base}?${qs}` : base;
     const out = await this.request("GET", path);
     return { runs: out.runs ?? [], total: out.total ?? 0 };
   }
@@ -1098,7 +1257,10 @@ var VerdifaxClient = class {
    *  call that never reached Verdifax cannot appear in it. */
   async exportRuns(params = {}) {
     this.requireAPIKey();
-    return this.request("GET", this.exportPath(params, "json"));
+    return this.request(
+      "GET",
+      this.exportPath("/runs/export", params, "json")
+    );
   }
   /** The same rows as {@link exportRuns}: the raw CSV text with `total`
    *  and `truncated` from the response headers. Check `truncated`: when
@@ -1106,9 +1268,12 @@ var VerdifaxClient = class {
    *  does not send those headers, so that a cut-off export cannot pass
    *  for a complete one. */
   async exportRunsCSV(params = {}) {
+    return this.exportCSVAt("/runs/export", params);
+  }
+  async exportCSVAt(base, params) {
     this.requireAPIKey();
     const { text, headers } = await this.requestRaw(
-      this.exportPath(params, "csv")
+      this.exportPath(base, params, "csv")
     );
     const total = Number.parseInt(headers.get(HEADER_EXPORT_TOTAL) ?? "", 10);
     const truncated = headers.get(HEADER_EXPORT_TRUNCATED);
@@ -1119,13 +1284,13 @@ var VerdifaxClient = class {
     }
     return { csv: text, total, truncated: truncated === "true" };
   }
-  exportPath(params, format) {
+  exportPath(base, params, format) {
     const q = new URLSearchParams();
     if (params.from) q.set("from", params.from);
     if (params.to) q.set("to", params.to);
     if (params.job_id) q.set("job_id", params.job_id);
     q.set("format", format);
-    return `/runs/export?${q.toString()}`;
+    return `${base}?${q.toString()}`;
   }
   // ── Attestation receipts (auth) ──────────────────────────────
   async listAttestations(params = {}) {
@@ -1263,14 +1428,48 @@ var VerdifaxClient = class {
     return this.request("POST", "/dcae/verify", bundle);
   }
   // ── Admin: API keys (auth) ───────────────────────────────────
-  async adminCreateKey(name) {
+  /** Creates a customer key. With `accountId` the key joins that existing
+   *  account; without it the key gets an account of its own. A key never
+   *  changes account. */
+  async adminCreateKey(name, options = {}) {
     this.requireAPIKey();
     if (!name) {
       throw new VerdifaxError("verdifax: name is required for adminCreateKey");
     }
-    return this.request("POST", "/admin/keys", {
-      name
-    });
+    const body = { name };
+    if (options.accountId !== void 0) {
+      requirePositiveId(options.accountId, "accountId");
+      body.account_id = options.accountId;
+    }
+    return this.request("POST", "/admin/keys", body);
+  }
+  /** Creates an account and its first owner key, whose secret is in the
+   *  result this once. The owner key creates the member keys. The account
+   *  number is a label Verdifax assigned, not a verified company identity. */
+  async adminCreateAccount(name, options = {}) {
+    this.requireAPIKey();
+    if (typeof name !== "string" || name.trim() === "") {
+      throw new VerdifaxError(
+        "verdifax: name is required for adminCreateAccount"
+      );
+    }
+    const body = { name };
+    if (options.tier !== void 0) body.tier = options.tier;
+    if (options.expiresAt !== void 0) body.expires_at = options.expiresAt;
+    return this.request(
+      "POST",
+      "/admin/accounts",
+      body
+    );
+  }
+  /** Every account, with its key counts. */
+  async adminListAccounts() {
+    this.requireAPIKey();
+    const out = await this.request(
+      "GET",
+      "/admin/accounts"
+    );
+    return out?.accounts ?? [];
   }
   async adminListKeys() {
     this.requireAPIKey();
@@ -1449,6 +1648,11 @@ var VerdifaxClient = class {
     return this.signingKey ? signRequestV2(this.signingKey, req) : withExecuteFlags(req);
   }
 };
+function requirePositiveId(id, name) {
+  if (!Number.isSafeInteger(id) || id <= 0) {
+    throw new VerdifaxError(`verdifax: ${name} must be a whole number > 0`);
+  }
+}
 function withSignedText(result, sent) {
   return "signed_request" in sent ? { ...result, signed_request: sent.signed_request } : result;
 }