@aletheia-dev/plugin-sdk 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# @aletheia-dev/plugin-sdk
+
+## 0.3.0
+
+### Minor Changes
+
+- [`a783a44`](https://github.com/akhiljames/aletheia/commit/a783a44a1c27d08d09dbafe937e6aff61af592c4) Thanks [@akhiljames](https://github.com/akhiljames)! - `zod` becomes a peer dependency (`^4.0.0`) so plugins validate with their own zod instance, and the
+  SDK no longer depends on `@aletheia-dev/core`: `Logger`, `LogFn` and `noopLogger` are now the SDK's own
+  structurally identical declarations (a type-level test keeps them assignable both ways).
+
+## 0.2.0
+
+### Minor Changes
+
+- `PluginContext.documents` (optional): `documents.read(documentId)` returns a `DocumentHandle`
+  (`id`, `fileName`, `contentType`, `sizeBytes`, `bytes`) for one of the tenant's documents. Only
+  documents with status `clean` can be read, and the bytes are the platform's post-processing
+  copy (sniffed, size-checked, images re-encoded), never the raw upload. The property is absent
+  when the deployment has no object storage.
+- `Plugin.webhookExternalId(request)` (optional): a pure, secret-free extractor for vendors whose
+  webhook URL cannot carry `?externalId=`. The platform calls it to find the external id, resolves
+  the tenant from it and only then calls `handleWebhook`, which still verifies the signature.
+- Webhook types and HMAC helpers now live in `webhooks.ts` and the document types in
+  `documents.ts`; both are re-exported from the package root, so imports are unchanged.
+
+## 0.1.0
+
+### Minor Changes
+
+- First versioned release. The SDK is the only package a plugin imports; changes to it are
+  tracked here for external plugin authors.
+- Actions can be asynchronous: declare `async: { callbackTimeoutSeconds }` on the action and
+  return `pending(externalId)` from `invoke`. The platform records a callback and waits.
+- `Plugin.handleWebhook(request, ctx)` receives the raw vendor request (`WebhookRequest`) and
+  returns a `WebhookEvent` (`completed`, `failed` or `pending`) or `null` to ignore it. Throw
+  `WebhookRejectedError` when the signature does not verify.
+- `verifyHmacSha256` and `signHmacSha256` helpers for raw-body signatures (constant-time compare).
+- `PluginContext.callbackUrl`: the public URL a plugin registers with its vendor. Append
+  `?externalId=<id>` so the platform can route the callback to the right tenant and run.
+- `PluginContext.idempotencyKey`, action `timeoutMs`, `retry` and `idempotent` flags (from phase 1).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,247 @@
+# @aletheia-dev/plugin-sdk
+
+The contract for writing [Aletheia](https://github.com/akhiljames/aletheia) plugins. Aletheia is
+open-source risk management infrastructure (KYC/KYB onboarding, underwriting, transaction
+monitoring) with a workflow engine, a rule engine and a plugin system. A plugin wraps one vendor
+or capability — sanctions screening, document verification, fraud scoring — behind a typed,
+tenant-configured interface. Workflows call plugins through `call_plugin` steps and rules through
+the `plugin` rule type; the platform validates configuration, resolves secrets per tenant,
+invokes actions with timeouts and retries, audits every call and receives vendor webhooks.
+
+This package is the only thing a plugin imports. It carries no runtime dependency on the
+platform.
+
+## Install
+
+```sh
+npm i @aletheia-dev/plugin-sdk zod
+```
+
+`zod` (v4) is a peer dependency: the schemas in your manifest are validated with your own zod
+instance. Node 22 or later; the package ships ESM and CommonJS builds with type declarations.
+
+## A plugin
+
+A plugin is a module exporting a `Plugin` built with `definePlugin`, whose `manifest` (built with
+`defineManifest`) declares what the plugin needs and what it offers:
+
+```ts
+import { z } from 'zod';
+import { defineManifest, definePlugin } from '@aletheia-dev/plugin-sdk';
+
+export const manifest = defineManifest({
+  name: '@acme/plugin-vendor', // the npm package name; also the key in the catalogue and the API
+  version: '0.1.0',
+  description: 'Screens names against Vendor.',
+  capabilities: ['sanctions.screen'], // tags rules and workflows look plugins up by
+  configSchema: z.object({ threshold: z.number().min(0).max(1).default(0.8) }),
+  secrets: ['apiKey'], // resolved per tenant by the platform, never stored in config
+  actions: {
+    screen: {
+      description: 'Screens one name.',
+      input: z.object({ name: z.string().min(1) }),
+      output: z.object({ hit: z.boolean(), score: z.number() }),
+      timeoutMs: 5_000,
+      idempotent: true,
+      retry: { maxAttempts: 3, backoffMs: 200 },
+    },
+  },
+});
+
+export default definePlugin({
+  manifest,
+  async onInit(ctx) {
+    // Optional: runs once per tenant context; throwing surfaces at worker start.
+  },
+  async invoke(action, input, ctx) {
+    // `input` has already been validated against the action's input schema.
+    const res = await ctx.fetch('https://vendor.example/screen', {
+      method: 'POST',
+      headers: { authorization: `Bearer ${ctx.secrets.apiKey}` },
+      body: JSON.stringify(input),
+      signal: ctx.signal, // aborted at the action deadline
+    });
+    return res.json(); // validated against the output schema by the platform
+  },
+});
+```
+
+### The manifest
+
+| Field          | Purpose                                                                             |
+| -------------- | ----------------------------------------------------------------------------------- |
+| `name`         | npm package name; the catalogue, the API and tenant configuration key off it.       |
+| `capabilities` | Free-form tags such as `sanctions.screen`; the platform finds plugins by them.      |
+| `configSchema` | zod schema for the tenant's non-secret configuration; defaults apply on every call. |
+| `secrets`      | Names of secrets; each tenant maps them to secret references.                       |
+| `actions`      | Named, typed operations. Input and output are validated on every call.              |
+
+Per action: `timeoutMs` bounds one attempt (default 30 s; `ctx.signal` aborts on expiry),
+`retry` is applied only when it is safe (the action is `idempotent` or the caller supplied an
+idempotency key) and `async` marks an action that completes through a webhook.
+`PluginManifestSchema` validates the data parts of a manifest at runtime.
+
+Use `ActionInput<M, K>`, `ActionOutput<M, K>` and `PluginConfig<M>` to type the body of `invoke`
+from the manifest rather than repeating the shapes.
+
+### The context
+
+Every call receives a `PluginContext`:
+
+- `tenantId`, `config` (parsed through `configSchema`) and `secrets` (resolved values keyed by
+  secret name);
+- `logger`, a structured logger with the plugin and tenant already bound, and `fetch` — use it,
+  never the global;
+- `signal`, aborted when the action's deadline passes; pass it to `fetch`;
+- `idempotencyKey`, present when the caller identifies the logical call (workflow run + step);
+- `callbackUrl`, where the vendor must send webhooks for this plugin (see below);
+- `documents`, read access to the tenant's documents when the deployment has object storage.
+
+## Synchronous and asynchronous actions
+
+A synchronous action returns its result from `invoke`. An asynchronous action starts work at the
+vendor and completes later through a webhook. Declare it with `async` and return
+`pending(externalId)`:
+
+```ts
+import { pending } from '@aletheia-dev/plugin-sdk';
+
+actions: {
+  verify: {
+    input: z.object({ documentId: z.string() }),
+    output: z.object({ verdict: z.enum(['pass', 'fail']) }),
+    async: { callbackTimeoutSeconds: 3_600 }, // at most 7 days
+  },
+},
+
+async invoke(action, input, ctx) {
+  const session = await startVendorSession(input, ctx);
+  return pending(session.id); // the vendor's id for the session; webhooks must carry it back
+}
+```
+
+The platform records the pending call, parks the workflow run and waits up to
+`callbackTimeoutSeconds` for a webhook reporting that `externalId`; on timeout the step fails
+with a rule-visible `CallbackTimeout`. `isPending(value)` recognises the marker.
+
+## Webhooks
+
+A plugin with asynchronous actions implements `handleWebhook(request, ctx)`. It receives the raw
+request — `method`, lower-cased `headers`, `rawBody` as bytes and `query` — plus the tenant's
+context, verifies the signature and returns a `WebhookEvent`, or `null` to ignore the request:
+
+```ts
+import { WebhookRejectedError, verifyHmacSha256 } from '@aletheia-dev/plugin-sdk';
+
+async handleWebhook(request, ctx) {
+  const signature = request.headers['x-vendor-signature'] ?? '';
+  if (!verifyHmacSha256(ctx.secrets.webhookSecret, request.rawBody, signature)) {
+    throw new WebhookRejectedError('bad signature'); // HTTP 401
+  }
+  const body = JSON.parse(Buffer.from(request.rawBody).toString('utf8'));
+  if (body.type !== 'session.completed') return null; // ignored, HTTP 202
+  return {
+    externalId: body.sessionId,
+    eventId: body.id, // de-duplicated per tenant
+    status: body.ok ? 'completed' : 'failed',
+    output: body.ok ? { verdict: body.verdict } : undefined, // validated against the output schema
+    error: body.ok ? undefined : body.reason,
+  };
+}
+```
+
+### The `?externalId=` convention
+
+The platform has to know the tenant before it can build a context, and the tenant's secrets are
+what the signature check needs. The external id breaks that cycle, so webhook URLs carry it:
+when you register the callback with the vendor, append it to `ctx.callbackUrl`:
+
+```ts
+const url = `${ctx.callbackUrl}?externalId=${encodeURIComponent(externalId)}`;
+```
+
+The platform resolves the tenant from the id, builds the context and calls `handleWebhook`.
+
+### `webhookExternalId` for dashboard-level webhook URLs
+
+Some vendors take one webhook URL per account and never echo a per-session query string. Such a
+plugin implements `webhookExternalId(request)`, a pure, secret-free extractor that decodes the id
+from the body or headers (or returns `null`). It only selects the tenant; `handleWebhook` still
+verifies the signature with that tenant's secret, so a forged id buys nothing but a 401.
+
+### HMAC helpers
+
+`verifyHmacSha256(secret, rawBody, signature, encoding?)` is a constant-time check of a hex (or
+base64) HMAC-SHA256 over the raw body; `signHmacSha256(secret, rawBody, encoding?)` produces one.
+Vendors that sign differently (timestamped payloads, asymmetric keys) implement their own check
+and should still compare in constant time.
+
+## Reading documents
+
+Document checks receive a `documentId` in their input and read the bytes through the context:
+
+```ts
+async invoke(action, input, ctx) {
+  if (!ctx.documents) throw new Error('document storage is not configured');
+  const doc = await ctx.documents.read(input.documentId);
+  // doc: { id, fileName, contentType, sizeBytes, bytes: Uint8Array }
+}
+```
+
+`ctx.documents` is present only when the deployment has object storage, so check before relying
+on it. Only the tenant's own documents with status `clean` can be read; the bytes are the
+platform's post-processing copy (type sniffed, size checked, images re-encoded, PDFs checked),
+never the raw upload.
+
+## Logging
+
+`ctx.logger` has `debug`, `info`, `warn` and `error` (pino-style: an optional object first, then
+the message) and `child(bindings)`. The plugin name and tenant are already bound. Log vendor
+request ids and outcomes, never secrets or document bytes. `noopLogger` is a silent
+implementation for tests, and the `Logger` type lets you accept any compatible logger.
+
+## Testing locally
+
+A plugin is a plain object, so unit tests call `invoke` and `handleWebhook` directly with a
+hand-built context:
+
+```ts
+import { noopLogger, type PluginContext } from '@aletheia-dev/plugin-sdk';
+
+const ctx: PluginContext<{ threshold: number }> = {
+  tenantId: 'tenant-1',
+  config: { threshold: 0.8 },
+  secrets: { apiKey: 'test' },
+  logger: noopLogger,
+  fetch: async () => new Response(JSON.stringify({ hit: false, score: 0 })),
+  signal: new AbortController().signal,
+  callbackUrl: 'http://localhost:4000/webhooks/plugins/@acme/plugin-vendor',
+};
+```
+
+The repository's example plugins are the reference implementations:
+
+- [`plugins/mock-sanctions`](https://github.com/akhiljames/aletheia/tree/main/plugins/mock-sanctions)
+  — a synchronous action, an asynchronous twin and a signed webhook, with tests;
+- [`plugins/doc-verify-mock`](https://github.com/akhiljames/aletheia/tree/main/plugins/doc-verify-mock)
+  — reads a document through `ctx.documents` and fires its own signed webhook;
+- [`plugins/opensanctions`](https://github.com/akhiljames/aletheia/tree/main/plugins/opensanctions)
+  and [`plugins/sumsub`](https://github.com/akhiljames/aletheia/tree/main/plugins/sumsub) — real
+  vendors, including `webhookExternalId` for a dashboard-level webhook URL.
+
+To run a plugin against the platform, add it to the catalogue and configure it for a tenant:
+[`docs/plugins.md`](https://github.com/akhiljames/aletheia/blob/main/docs/plugins.md) covers the
+catalogue, tenant configuration, input mapping from workflows and rules, and what the platform
+does with each webhook outcome.
+
+## Versioning
+
+The SDK follows [semver](https://semver.org) on its own cadence, independent of the platform.
+While the major version is `0`, a minor release may change the contract (additive changes are
+the norm; anything that requires plugin changes is called out in the
+[changelog](https://github.com/akhiljames/aletheia/blob/main/packages/plugin-sdk/CHANGELOG.md)).
+From 1.0 onwards, breaking changes to the contract are major releases.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,118 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  PluginManifestSchema: () => PluginManifestSchema,
+  WebhookRejectedError: () => WebhookRejectedError,
+  defineManifest: () => defineManifest,
+  definePlugin: () => definePlugin,
+  isPending: () => isPending,
+  noopLogger: () => noopLogger,
+  pending: () => pending,
+  signHmacSha256: () => signHmacSha256,
+  verifyHmacSha256: () => verifyHmacSha256
+});
+module.exports = __toCommonJS(src_exports);
+var import_zod = require("zod");
+
+// src/logger.ts
+var noopLogger = {
+  debug: () => void 0,
+  info: () => void 0,
+  warn: () => void 0,
+  error: () => void 0,
+  child: () => noopLogger
+};
+
+// src/webhooks.ts
+var import_node_crypto = require("crypto");
+var WebhookRejectedError = class extends Error {
+  constructor(message = "webhook rejected") {
+    super(message);
+    this.name = "WebhookRejectedError";
+  }
+};
+function verifyHmacSha256(secret, rawBody, signature, encoding = "hex") {
+  const expected = (0, import_node_crypto.createHmac)("sha256", secret).update(rawBody).digest(encoding);
+  const a = Buffer.from(expected);
+  const b = Buffer.from(signature.trim());
+  return a.length === b.length && (0, import_node_crypto.timingSafeEqual)(a, b);
+}
+function signHmacSha256(secret, rawBody, encoding = "hex") {
+  return (0, import_node_crypto.createHmac)("sha256", secret).update(rawBody).digest(encoding);
+}
+
+// src/index.ts
+function pending(externalId) {
+  return { pending: true, externalId };
+}
+function isPending(value) {
+  return typeof value === "object" && value !== null && value.pending === true && typeof value.externalId === "string";
+}
+function definePlugin(plugin) {
+  return plugin;
+}
+function defineManifest(manifest) {
+  return manifest;
+}
+var isZodSchema = (value) => typeof value === "object" && value !== null && "_zod" in value;
+var ZodSchemaValue = import_zod.z.custom(isZodSchema, { message: "expected a zod schema" });
+var PluginManifestSchema = import_zod.z.object({
+  name: import_zod.z.string().min(1).max(214).regex(
+    /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/,
+    "expected an npm package name"
+  ),
+  version: import_zod.z.string().min(1),
+  description: import_zod.z.string().optional(),
+  capabilities: import_zod.z.array(import_zod.z.string().min(1)),
+  configSchema: ZodSchemaValue,
+  secrets: import_zod.z.array(import_zod.z.string().min(1)),
+  actions: import_zod.z.record(
+    import_zod.z.string().min(1),
+    import_zod.z.object({
+      description: import_zod.z.string().optional(),
+      input: ZodSchemaValue,
+      output: ZodSchemaValue,
+      timeoutMs: import_zod.z.number().int().positive().optional(),
+      retry: import_zod.z.object({
+        maxAttempts: import_zod.z.number().int().min(1).max(5),
+        backoffMs: import_zod.z.number().int().nonnegative()
+      }).optional(),
+      idempotent: import_zod.z.boolean().optional(),
+      async: import_zod.z.object({
+        callbackTimeoutSeconds: import_zod.z.number().int().min(1).max(7 * 24 * 3600)
+      }).optional()
+    })
+  )
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginManifestSchema,
+  WebhookRejectedError,
+  defineManifest,
+  definePlugin,
+  isPending,
+  noopLogger,
+  pending,
+  signHmacSha256,
+  verifyHmacSha256
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/logger.ts","../src/webhooks.ts"],"sourcesContent":["import { z } from 'zod';\nimport type { Logger } from './logger.js';\nimport type { PluginDocuments } from './documents.js';\nimport type { WebhookEvent, WebhookRequest } from './webhooks.js';\n\nexport { noopLogger, type LogFn, type Logger } from './logger.js';\nexport type { DocumentHandle, PluginDocuments } from './documents.js';\nexport {\n  WebhookRejectedError,\n  signHmacSha256,\n  verifyHmacSha256,\n  type WebhookEvent,\n  type WebhookRequest,\n} from './webhooks.js';\n\n/** Retry hints for an action; applied by the runtime only when the call is safe to repeat. */\nexport interface PluginRetryPolicy {\n  /** Total attempts including the first (1 to 5). */\n  maxAttempts: number;\n  /** Base delay between attempts; multiplied by the attempt number. */\n  backoffMs: number;\n}\n\n/** One callable action a plugin exposes. Input and output are validated by the runtime. */\nexport interface PluginAction<I extends z.ZodType = z.ZodType, O extends z.ZodType = z.ZodType> {\n  description?: string;\n  input: I;\n  output: O;\n  /** Deadline for one attempt; the runtime aborts `ctx.signal` and fails the call when exceeded. */\n  timeoutMs?: number;\n  /** Retried by the runtime when `idempotent` is true or the caller supplies an idempotency key. */\n  retry?: PluginRetryPolicy;\n  /** Declares that repeating the action with the same input has no additional effect. */\n  idempotent?: boolean;\n  /**\n   * The action starts work at the vendor and completes later through a webhook. `invoke` must\n   * return `pending(externalId)`; the runtime waits for `handleWebhook` to report that id.\n   */\n  async?: { callbackTimeoutSeconds: number };\n}\n\n/** What an asynchronous action returns after starting work at the vendor. */\nexport interface PendingResult {\n  pending: true;\n  /** The vendor's identifier for the session, job or check; webhooks must carry it back. */\n  externalId: string;\n}\n\nexport function pending(externalId: string): PendingResult {\n  return { pending: true, externalId };\n}\n\nexport function isPending(value: unknown): value is PendingResult {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    (value as { pending?: unknown }).pending === true &&\n    typeof (value as { externalId?: unknown }).externalId === 'string'\n  );\n}\n\nexport type PluginActions = Record<string, PluginAction>;\n\n/** Static description of a plugin package: what it needs (config, secrets) and what it offers. */\nexport interface PluginManifest<\n  C extends z.ZodType = z.ZodType,\n  A extends PluginActions = PluginActions,\n> {\n  /** npm package name, e.g. '@aletheia-dev/plugin-mock-sanctions'. */\n  name: string;\n  version: string;\n  description?: string;\n  /** Capability tags, e.g. ['sanctions.screen']. */\n  capabilities: string[];\n  /** Validates the tenant-provided, non-secret config. */\n  configSchema: C;\n  /** Names of secrets the plugin needs; resolved by the runtime per tenant. */\n  secrets: string[];\n  actions: A;\n}\n\n/** Per-tenant runtime context handed to every plugin call. */\nexport interface PluginContext<C = unknown> {\n  tenantId: string;\n  config: C;\n  secrets: Record<string, string>;\n  logger: Logger;\n  fetch: typeof fetch;\n  /** Aborted when the action's deadline passes; pass it to `fetch` so vendor calls stop too. */\n  signal: AbortSignal;\n  /** Stable key for the logical call (same across retries), when the caller provided one. */\n  idempotencyKey?: string;\n  /** Where the vendor must send webhooks for this plugin, when the deployment exposes one. */\n  callbackUrl?: string;\n  /**\n   * Read-only access to the tenant's clean documents (by document id). Present when the\n   * deployment has object storage; absent otherwise, so plugins must check before relying on it.\n   */\n  documents?: PluginDocuments;\n}\n\n/** Parsed config type of a manifest. */\nexport type PluginConfig<M extends PluginManifest> = z.output<M['configSchema']>;\n/** Union of a manifest's action names. */\nexport type ActionName<M extends PluginManifest> = keyof M['actions'] & string;\n/** Parsed input type of one action. */\nexport type ActionInput<M extends PluginManifest, K extends ActionName<M>> = z.output<\n  M['actions'][K]['input']\n>;\n/** Output type of one action. */\nexport type ActionOutput<M extends PluginManifest, K extends ActionName<M>> = z.output<\n  M['actions'][K]['output']\n>;\n\nexport interface Plugin<M extends PluginManifest = PluginManifest> {\n  manifest: M;\n  onInit?(ctx: PluginContext<PluginConfig<M>>): Promise<void> | void;\n  onShutdown?(): Promise<void> | void;\n  /**\n   * Dispatch one action. The runtime validates `input` against the action's input schema\n   * before calling and the return value against its output schema afterwards, so the\n   * signature stays loose here; use `ActionInput`/`ActionOutput` to type the body.\n   */\n  invoke(\n    action: ActionName<M>,\n    input: unknown,\n    ctx: PluginContext<PluginConfig<M>>,\n  ): Promise<unknown>;\n  /**\n   * Verifies and decodes a vendor webhook for one of this plugin's asynchronous actions.\n   * Return `null` to ignore the request, throw `WebhookRejectedError` for bad signatures.\n   */\n  handleWebhook?(\n    request: WebhookRequest,\n    ctx: PluginContext<PluginConfig<M>>,\n  ): Promise<WebhookEvent | null>;\n  /**\n   * Extracts the vendor's external id from a webhook whose URL carries no `?externalId=`\n   * (vendors with one dashboard-level webhook URL). Must be pure and need no secrets: it runs\n   * before the tenant is known, so it only decodes the body or headers. The platform resolves\n   * the tenant from the id and only then calls `handleWebhook` with the tenant context, which\n   * must still verify the signature. Return `null` when the request carries no id.\n   */\n  webhookExternalId?(request: WebhookRequest): string | null;\n}\n\n/** Identity helper so `manifest` drives inference for `onInit`/`invoke`. */\nexport function definePlugin<M extends PluginManifest>(plugin: Plugin<M>): Plugin<M> {\n  return plugin;\n}\n\n/** Identity helper that preserves the concrete schema and action types. */\nexport function defineManifest<C extends z.ZodType, A extends PluginActions>(\n  manifest: PluginManifest<C, A>,\n): PluginManifest<C, A> {\n  return manifest;\n}\n\nconst isZodSchema = (value: unknown): value is z.ZodType =>\n  typeof value === 'object' && value !== null && '_zod' in value;\n\nconst ZodSchemaValue = z.custom<z.ZodType>(isZodSchema, { message: 'expected a zod schema' });\n\n/** Runtime validation of a manifest's data parts (schemas are only checked to be zod schemas). */\nexport const PluginManifestSchema = z.object({\n  name: z\n    .string()\n    .min(1)\n    .max(214)\n    .regex(\n      /^(@[a-z0-9-~][a-z0-9-._~]*\\/)?[a-z0-9-~][a-z0-9-._~]*$/,\n      'expected an npm package name',\n    ),\n  version: z.string().min(1),\n  description: z.string().optional(),\n  capabilities: z.array(z.string().min(1)),\n  configSchema: ZodSchemaValue,\n  secrets: z.array(z.string().min(1)),\n  actions: z.record(\n    z.string().min(1),\n    z.object({\n      description: z.string().optional(),\n      input: ZodSchemaValue,\n      output: ZodSchemaValue,\n      timeoutMs: z.number().int().positive().optional(),\n      retry: z\n        .object({\n          maxAttempts: z.number().int().min(1).max(5),\n          backoffMs: z.number().int().nonnegative(),\n        })\n        .optional(),\n      idempotent: z.boolean().optional(),\n      async: z\n        .object({\n          callbackTimeoutSeconds: z\n            .number()\n            .int()\n            .min(1)\n            .max(7 * 24 * 3600),\n        })\n        .optional(),\n    }),\n  ),\n});\n","/**\n * Minimal structural logger contract handed to plugins (pino satisfies it).\n *\n * This is a deliberate copy of `@aletheia-dev/core`'s `logger.ts`: the SDK is published on its own\n * and must not pull the platform's core package in for three declarations. `logger.test.ts`\n * asserts the two stay assignable both ways, so the runtime can pass its core logger straight\n * into a plugin context.\n */\nexport type LogFn = (objOrMsg: object | string, msg?: string, ...args: unknown[]) => void;\n\nexport interface Logger {\n  debug: LogFn;\n  info: LogFn;\n  warn: LogFn;\n  error: LogFn;\n  child(bindings: Record<string, unknown>): Logger;\n}\n\nexport const noopLogger: Logger = {\n  debug: () => undefined,\n  info: () => undefined,\n  warn: () => undefined,\n  error: () => undefined,\n  child: () => noopLogger,\n};\n","import { createHmac, timingSafeEqual } from 'node:crypto';\n\n/** A vendor webhook as received by the API, with the raw body for signature verification. */\nexport interface WebhookRequest {\n  method: string;\n  /** Header names lower-cased. */\n  headers: Record<string, string>;\n  rawBody: Uint8Array;\n  query: Record<string, string>;\n}\n\n/** What a plugin extracted from a webhook. `null` from `handleWebhook` means \"ignore\". */\nexport interface WebhookEvent {\n  /** The vendor session id returned by the asynchronous action. */\n  externalId: string;\n  /** Vendor event id (or a stable hash) used for de-duplication. */\n  eventId: string;\n  status: 'completed' | 'failed' | 'pending';\n  /** Validated against the action's output schema when `status` is `completed`. */\n  output?: unknown;\n  error?: string;\n}\n\n/** Thrown by `handleWebhook` when the signature or payload is not acceptable (HTTP 401). */\nexport class WebhookRejectedError extends Error {\n  constructor(message = 'webhook rejected') {\n    super(message);\n    this.name = 'WebhookRejectedError';\n  }\n}\n\n/** Constant-time HMAC-SHA256 check of a raw body against a hex (or base64) signature. */\nexport function verifyHmacSha256(\n  secret: string,\n  rawBody: Uint8Array,\n  signature: string,\n  encoding: 'hex' | 'base64' = 'hex',\n): boolean {\n  const expected = createHmac('sha256', secret).update(rawBody).digest(encoding);\n  const a = Buffer.from(expected);\n  const b = Buffer.from(signature.trim());\n  return a.length === b.length && timingSafeEqual(a, b);\n}\n\nexport function signHmacSha256(\n  secret: string,\n  rawBody: Uint8Array,\n  encoding: 'hex' | 'base64' = 'hex',\n): string {\n  return createHmac('sha256', secret).update(rawBody).digest(encoding);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAAkB;;;ACkBX,IAAM,aAAqB;AAAA,EAChC,OAAO,MAAM;AAAA,EACb,MAAM,MAAM;AAAA,EACZ,MAAM,MAAM;AAAA,EACZ,OAAO,MAAM;AAAA,EACb,OAAO,MAAM;AACf;;;ACxBA,yBAA4C;AAwBrC,IAAM,uBAAN,cAAmC,MAAM;AAAA,EAC9C,YAAY,UAAU,oBAAoB;AACxC,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;AAGO,SAAS,iBACd,QACA,SACA,WACA,WAA6B,OACpB;AACT,QAAM,eAAW,+BAAW,UAAU,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,QAAQ;AAC7E,QAAM,IAAI,OAAO,KAAK,QAAQ;AAC9B,QAAM,IAAI,OAAO,KAAK,UAAU,KAAK,CAAC;AACtC,SAAO,EAAE,WAAW,EAAE,cAAU,oCAAgB,GAAG,CAAC;AACtD;AAEO,SAAS,eACd,QACA,SACA,WAA6B,OACrB;AACR,aAAO,+BAAW,UAAU,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,QAAQ;AACrE;;;AFFO,SAAS,QAAQ,YAAmC;AACzD,SAAO,EAAE,SAAS,MAAM,WAAW;AACrC;AAEO,SAAS,UAAU,OAAwC;AAChE,SACE,OAAO,UAAU,YACjB,UAAU,QACT,MAAgC,YAAY,QAC7C,OAAQ,MAAmC,eAAe;AAE9D;AAwFO,SAAS,aAAuC,QAA8B;AACnF,SAAO;AACT;AAGO,SAAS,eACd,UACsB;AACtB,SAAO;AACT;AAEA,IAAM,cAAc,CAAC,UACnB,OAAO,UAAU,YAAY,UAAU,QAAQ,UAAU;AAE3D,IAAM,iBAAiB,aAAE,OAAkB,aAAa,EAAE,SAAS,wBAAwB,CAAC;AAGrF,IAAM,uBAAuB,aAAE,OAAO;AAAA,EAC3C,MAAM,aACH,OAAO,EACP,IAAI,CAAC,EACL,IAAI,GAAG,EACP;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,SAAS,aAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACzB,aAAa,aAAE,OAAO,EAAE,SAAS;AAAA,EACjC,cAAc,aAAE,MAAM,aAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAAA,EACvC,cAAc;AAAA,EACd,SAAS,aAAE,MAAM,aAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAAA,EAClC,SAAS,aAAE;AAAA,IACT,aAAE,OAAO,EAAE,IAAI,CAAC;AAAA,IAChB,aAAE,OAAO;AAAA,MACP,aAAa,aAAE,OAAO,EAAE,SAAS;AAAA,MACjC,OAAO;AAAA,MACP,QAAQ;AAAA,MACR,WAAW,aAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS;AAAA,MAChD,OAAO,aACJ,OAAO;AAAA,QACN,aAAa,aAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC;AAAA,QAC1C,WAAW,aAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,MAC1C,CAAC,EACA,SAAS;AAAA,MACZ,YAAY,aAAE,QAAQ,EAAE,SAAS;AAAA,MACjC,OAAO,aACJ,OAAO;AAAA,QACN,wBAAwB,aACrB,OAAO,EACP,IAAI,EACJ,IAAI,CAAC,EACL,IAAI,IAAI,KAAK,IAAI;AAAA,MACtB,CAAC,EACA,SAAS;AAAA,IACd,CAAC;AAAA,EACH;AACF,CAAC;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,194 @@
+import { z } from 'zod';
+
+/**
+ * Minimal structural logger contract handed to plugins (pino satisfies it).
+ *
+ * This is a deliberate copy of `@aletheia-dev/core`'s `logger.ts`: the SDK is published on its own
+ * and must not pull the platform's core package in for three declarations. `logger.test.ts`
+ * asserts the two stay assignable both ways, so the runtime can pass its core logger straight
+ * into a plugin context.
+ */
+type LogFn = (objOrMsg: object | string, msg?: string, ...args: unknown[]) => void;
+interface Logger {
+    debug: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    error: LogFn;
+    child(bindings: Record<string, unknown>): Logger;
+}
+declare const noopLogger: Logger;
+
+/**
+ * A clean document of the tenant, read for a plugin. The bytes are what the platform stored
+ * after finalisation (type sniffing, size limits, image re-encoding and PDF checks), never the
+ * applicant's original upload.
+ */
+interface DocumentHandle {
+    id: string;
+    fileName: string;
+    contentType: string;
+    sizeBytes: number;
+    bytes: Uint8Array;
+}
+/** Read-only access to the tenant's documents, present on the context when storage is configured. */
+interface PluginDocuments {
+    /** Throws when the document does not belong to the tenant or its status is not `clean`. */
+    read(documentId: string): Promise<DocumentHandle>;
+}
+
+/** A vendor webhook as received by the API, with the raw body for signature verification. */
+interface WebhookRequest {
+    method: string;
+    /** Header names lower-cased. */
+    headers: Record<string, string>;
+    rawBody: Uint8Array;
+    query: Record<string, string>;
+}
+/** What a plugin extracted from a webhook. `null` from `handleWebhook` means "ignore". */
+interface WebhookEvent {
+    /** The vendor session id returned by the asynchronous action. */
+    externalId: string;
+    /** Vendor event id (or a stable hash) used for de-duplication. */
+    eventId: string;
+    status: 'completed' | 'failed' | 'pending';
+    /** Validated against the action's output schema when `status` is `completed`. */
+    output?: unknown;
+    error?: string;
+}
+/** Thrown by `handleWebhook` when the signature or payload is not acceptable (HTTP 401). */
+declare class WebhookRejectedError extends Error {
+    constructor(message?: string);
+}
+/** Constant-time HMAC-SHA256 check of a raw body against a hex (or base64) signature. */
+declare function verifyHmacSha256(secret: string, rawBody: Uint8Array, signature: string, encoding?: 'hex' | 'base64'): boolean;
+declare function signHmacSha256(secret: string, rawBody: Uint8Array, encoding?: 'hex' | 'base64'): string;
+
+/** Retry hints for an action; applied by the runtime only when the call is safe to repeat. */
+interface PluginRetryPolicy {
+    /** Total attempts including the first (1 to 5). */
+    maxAttempts: number;
+    /** Base delay between attempts; multiplied by the attempt number. */
+    backoffMs: number;
+}
+/** One callable action a plugin exposes. Input and output are validated by the runtime. */
+interface PluginAction<I extends z.ZodType = z.ZodType, O extends z.ZodType = z.ZodType> {
+    description?: string;
+    input: I;
+    output: O;
+    /** Deadline for one attempt; the runtime aborts `ctx.signal` and fails the call when exceeded. */
+    timeoutMs?: number;
+    /** Retried by the runtime when `idempotent` is true or the caller supplies an idempotency key. */
+    retry?: PluginRetryPolicy;
+    /** Declares that repeating the action with the same input has no additional effect. */
+    idempotent?: boolean;
+    /**
+     * The action starts work at the vendor and completes later through a webhook. `invoke` must
+     * return `pending(externalId)`; the runtime waits for `handleWebhook` to report that id.
+     */
+    async?: {
+        callbackTimeoutSeconds: number;
+    };
+}
+/** What an asynchronous action returns after starting work at the vendor. */
+interface PendingResult {
+    pending: true;
+    /** The vendor's identifier for the session, job or check; webhooks must carry it back. */
+    externalId: string;
+}
+declare function pending(externalId: string): PendingResult;
+declare function isPending(value: unknown): value is PendingResult;
+type PluginActions = Record<string, PluginAction>;
+/** Static description of a plugin package: what it needs (config, secrets) and what it offers. */
+interface PluginManifest<C extends z.ZodType = z.ZodType, A extends PluginActions = PluginActions> {
+    /** npm package name, e.g. '@aletheia-dev/plugin-mock-sanctions'. */
+    name: string;
+    version: string;
+    description?: string;
+    /** Capability tags, e.g. ['sanctions.screen']. */
+    capabilities: string[];
+    /** Validates the tenant-provided, non-secret config. */
+    configSchema: C;
+    /** Names of secrets the plugin needs; resolved by the runtime per tenant. */
+    secrets: string[];
+    actions: A;
+}
+/** Per-tenant runtime context handed to every plugin call. */
+interface PluginContext<C = unknown> {
+    tenantId: string;
+    config: C;
+    secrets: Record<string, string>;
+    logger: Logger;
+    fetch: typeof fetch;
+    /** Aborted when the action's deadline passes; pass it to `fetch` so vendor calls stop too. */
+    signal: AbortSignal;
+    /** Stable key for the logical call (same across retries), when the caller provided one. */
+    idempotencyKey?: string;
+    /** Where the vendor must send webhooks for this plugin, when the deployment exposes one. */
+    callbackUrl?: string;
+    /**
+     * Read-only access to the tenant's clean documents (by document id). Present when the
+     * deployment has object storage; absent otherwise, so plugins must check before relying on it.
+     */
+    documents?: PluginDocuments;
+}
+/** Parsed config type of a manifest. */
+type PluginConfig<M extends PluginManifest> = z.output<M['configSchema']>;
+/** Union of a manifest's action names. */
+type ActionName<M extends PluginManifest> = keyof M['actions'] & string;
+/** Parsed input type of one action. */
+type ActionInput<M extends PluginManifest, K extends ActionName<M>> = z.output<M['actions'][K]['input']>;
+/** Output type of one action. */
+type ActionOutput<M extends PluginManifest, K extends ActionName<M>> = z.output<M['actions'][K]['output']>;
+interface Plugin<M extends PluginManifest = PluginManifest> {
+    manifest: M;
+    onInit?(ctx: PluginContext<PluginConfig<M>>): Promise<void> | void;
+    onShutdown?(): Promise<void> | void;
+    /**
+     * Dispatch one action. The runtime validates `input` against the action's input schema
+     * before calling and the return value against its output schema afterwards, so the
+     * signature stays loose here; use `ActionInput`/`ActionOutput` to type the body.
+     */
+    invoke(action: ActionName<M>, input: unknown, ctx: PluginContext<PluginConfig<M>>): Promise<unknown>;
+    /**
+     * Verifies and decodes a vendor webhook for one of this plugin's asynchronous actions.
+     * Return `null` to ignore the request, throw `WebhookRejectedError` for bad signatures.
+     */
+    handleWebhook?(request: WebhookRequest, ctx: PluginContext<PluginConfig<M>>): Promise<WebhookEvent | null>;
+    /**
+     * Extracts the vendor's external id from a webhook whose URL carries no `?externalId=`
+     * (vendors with one dashboard-level webhook URL). Must be pure and need no secrets: it runs
+     * before the tenant is known, so it only decodes the body or headers. The platform resolves
+     * the tenant from the id and only then calls `handleWebhook` with the tenant context, which
+     * must still verify the signature. Return `null` when the request carries no id.
+     */
+    webhookExternalId?(request: WebhookRequest): string | null;
+}
+/** Identity helper so `manifest` drives inference for `onInit`/`invoke`. */
+declare function definePlugin<M extends PluginManifest>(plugin: Plugin<M>): Plugin<M>;
+/** Identity helper that preserves the concrete schema and action types. */
+declare function defineManifest<C extends z.ZodType, A extends PluginActions>(manifest: PluginManifest<C, A>): PluginManifest<C, A>;
+/** Runtime validation of a manifest's data parts (schemas are only checked to be zod schemas). */
+declare const PluginManifestSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    capabilities: z.ZodArray<z.ZodString>;
+    configSchema: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    secrets: z.ZodArray<z.ZodString>;
+    actions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        input: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        output: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        timeoutMs: z.ZodOptional<z.ZodNumber>;
+        retry: z.ZodOptional<z.ZodObject<{
+            maxAttempts: z.ZodNumber;
+            backoffMs: z.ZodNumber;
+        }, z.core.$strip>>;
+        idempotent: z.ZodOptional<z.ZodBoolean>;
+        async: z.ZodOptional<z.ZodObject<{
+            callbackTimeoutSeconds: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+
+export { type ActionInput, type ActionName, type ActionOutput, type DocumentHandle, type LogFn, type Logger, type PendingResult, type Plugin, type PluginAction, type PluginActions, type PluginConfig, type PluginContext, type PluginDocuments, type PluginManifest, PluginManifestSchema, type PluginRetryPolicy, type WebhookEvent, WebhookRejectedError, type WebhookRequest, defineManifest, definePlugin, isPending, noopLogger, pending, signHmacSha256, verifyHmacSha256 };

package/dist/index.d.ts

@@ -0,0 +1,194 @@
+import { z } from 'zod';
+
+/**
+ * Minimal structural logger contract handed to plugins (pino satisfies it).
+ *
+ * This is a deliberate copy of `@aletheia-dev/core`'s `logger.ts`: the SDK is published on its own
+ * and must not pull the platform's core package in for three declarations. `logger.test.ts`
+ * asserts the two stay assignable both ways, so the runtime can pass its core logger straight
+ * into a plugin context.
+ */
+type LogFn = (objOrMsg: object | string, msg?: string, ...args: unknown[]) => void;
+interface Logger {
+    debug: LogFn;
+    info: LogFn;
+    warn: LogFn;
+    error: LogFn;
+    child(bindings: Record<string, unknown>): Logger;
+}
+declare const noopLogger: Logger;
+
+/**
+ * A clean document of the tenant, read for a plugin. The bytes are what the platform stored
+ * after finalisation (type sniffing, size limits, image re-encoding and PDF checks), never the
+ * applicant's original upload.
+ */
+interface DocumentHandle {
+    id: string;
+    fileName: string;
+    contentType: string;
+    sizeBytes: number;
+    bytes: Uint8Array;
+}
+/** Read-only access to the tenant's documents, present on the context when storage is configured. */
+interface PluginDocuments {
+    /** Throws when the document does not belong to the tenant or its status is not `clean`. */
+    read(documentId: string): Promise<DocumentHandle>;
+}
+
+/** A vendor webhook as received by the API, with the raw body for signature verification. */
+interface WebhookRequest {
+    method: string;
+    /** Header names lower-cased. */
+    headers: Record<string, string>;
+    rawBody: Uint8Array;
+    query: Record<string, string>;
+}
+/** What a plugin extracted from a webhook. `null` from `handleWebhook` means "ignore". */
+interface WebhookEvent {
+    /** The vendor session id returned by the asynchronous action. */
+    externalId: string;
+    /** Vendor event id (or a stable hash) used for de-duplication. */
+    eventId: string;
+    status: 'completed' | 'failed' | 'pending';
+    /** Validated against the action's output schema when `status` is `completed`. */
+    output?: unknown;
+    error?: string;
+}
+/** Thrown by `handleWebhook` when the signature or payload is not acceptable (HTTP 401). */
+declare class WebhookRejectedError extends Error {
+    constructor(message?: string);
+}
+/** Constant-time HMAC-SHA256 check of a raw body against a hex (or base64) signature. */
+declare function verifyHmacSha256(secret: string, rawBody: Uint8Array, signature: string, encoding?: 'hex' | 'base64'): boolean;
+declare function signHmacSha256(secret: string, rawBody: Uint8Array, encoding?: 'hex' | 'base64'): string;
+
+/** Retry hints for an action; applied by the runtime only when the call is safe to repeat. */
+interface PluginRetryPolicy {
+    /** Total attempts including the first (1 to 5). */
+    maxAttempts: number;
+    /** Base delay between attempts; multiplied by the attempt number. */
+    backoffMs: number;
+}
+/** One callable action a plugin exposes. Input and output are validated by the runtime. */
+interface PluginAction<I extends z.ZodType = z.ZodType, O extends z.ZodType = z.ZodType> {
+    description?: string;
+    input: I;
+    output: O;
+    /** Deadline for one attempt; the runtime aborts `ctx.signal` and fails the call when exceeded. */
+    timeoutMs?: number;
+    /** Retried by the runtime when `idempotent` is true or the caller supplies an idempotency key. */
+    retry?: PluginRetryPolicy;
+    /** Declares that repeating the action with the same input has no additional effect. */
+    idempotent?: boolean;
+    /**
+     * The action starts work at the vendor and completes later through a webhook. `invoke` must
+     * return `pending(externalId)`; the runtime waits for `handleWebhook` to report that id.
+     */
+    async?: {
+        callbackTimeoutSeconds: number;
+    };
+}
+/** What an asynchronous action returns after starting work at the vendor. */
+interface PendingResult {
+    pending: true;
+    /** The vendor's identifier for the session, job or check; webhooks must carry it back. */
+    externalId: string;
+}
+declare function pending(externalId: string): PendingResult;
+declare function isPending(value: unknown): value is PendingResult;
+type PluginActions = Record<string, PluginAction>;
+/** Static description of a plugin package: what it needs (config, secrets) and what it offers. */
+interface PluginManifest<C extends z.ZodType = z.ZodType, A extends PluginActions = PluginActions> {
+    /** npm package name, e.g. '@aletheia-dev/plugin-mock-sanctions'. */
+    name: string;
+    version: string;
+    description?: string;
+    /** Capability tags, e.g. ['sanctions.screen']. */
+    capabilities: string[];
+    /** Validates the tenant-provided, non-secret config. */
+    configSchema: C;
+    /** Names of secrets the plugin needs; resolved by the runtime per tenant. */
+    secrets: string[];
+    actions: A;
+}
+/** Per-tenant runtime context handed to every plugin call. */
+interface PluginContext<C = unknown> {
+    tenantId: string;
+    config: C;
+    secrets: Record<string, string>;
+    logger: Logger;
+    fetch: typeof fetch;
+    /** Aborted when the action's deadline passes; pass it to `fetch` so vendor calls stop too. */
+    signal: AbortSignal;
+    /** Stable key for the logical call (same across retries), when the caller provided one. */
+    idempotencyKey?: string;
+    /** Where the vendor must send webhooks for this plugin, when the deployment exposes one. */
+    callbackUrl?: string;
+    /**
+     * Read-only access to the tenant's clean documents (by document id). Present when the
+     * deployment has object storage; absent otherwise, so plugins must check before relying on it.
+     */
+    documents?: PluginDocuments;
+}
+/** Parsed config type of a manifest. */
+type PluginConfig<M extends PluginManifest> = z.output<M['configSchema']>;
+/** Union of a manifest's action names. */
+type ActionName<M extends PluginManifest> = keyof M['actions'] & string;
+/** Parsed input type of one action. */
+type ActionInput<M extends PluginManifest, K extends ActionName<M>> = z.output<M['actions'][K]['input']>;
+/** Output type of one action. */
+type ActionOutput<M extends PluginManifest, K extends ActionName<M>> = z.output<M['actions'][K]['output']>;
+interface Plugin<M extends PluginManifest = PluginManifest> {
+    manifest: M;
+    onInit?(ctx: PluginContext<PluginConfig<M>>): Promise<void> | void;
+    onShutdown?(): Promise<void> | void;
+    /**
+     * Dispatch one action. The runtime validates `input` against the action's input schema
+     * before calling and the return value against its output schema afterwards, so the
+     * signature stays loose here; use `ActionInput`/`ActionOutput` to type the body.
+     */
+    invoke(action: ActionName<M>, input: unknown, ctx: PluginContext<PluginConfig<M>>): Promise<unknown>;
+    /**
+     * Verifies and decodes a vendor webhook for one of this plugin's asynchronous actions.
+     * Return `null` to ignore the request, throw `WebhookRejectedError` for bad signatures.
+     */
+    handleWebhook?(request: WebhookRequest, ctx: PluginContext<PluginConfig<M>>): Promise<WebhookEvent | null>;
+    /**
+     * Extracts the vendor's external id from a webhook whose URL carries no `?externalId=`
+     * (vendors with one dashboard-level webhook URL). Must be pure and need no secrets: it runs
+     * before the tenant is known, so it only decodes the body or headers. The platform resolves
+     * the tenant from the id and only then calls `handleWebhook` with the tenant context, which
+     * must still verify the signature. Return `null` when the request carries no id.
+     */
+    webhookExternalId?(request: WebhookRequest): string | null;
+}
+/** Identity helper so `manifest` drives inference for `onInit`/`invoke`. */
+declare function definePlugin<M extends PluginManifest>(plugin: Plugin<M>): Plugin<M>;
+/** Identity helper that preserves the concrete schema and action types. */
+declare function defineManifest<C extends z.ZodType, A extends PluginActions>(manifest: PluginManifest<C, A>): PluginManifest<C, A>;
+/** Runtime validation of a manifest's data parts (schemas are only checked to be zod schemas). */
+declare const PluginManifestSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    capabilities: z.ZodArray<z.ZodString>;
+    configSchema: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    secrets: z.ZodArray<z.ZodString>;
+    actions: z.ZodRecord<z.ZodString, z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        input: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        output: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        timeoutMs: z.ZodOptional<z.ZodNumber>;
+        retry: z.ZodOptional<z.ZodObject<{
+            maxAttempts: z.ZodNumber;
+            backoffMs: z.ZodNumber;
+        }, z.core.$strip>>;
+        idempotent: z.ZodOptional<z.ZodBoolean>;
+        async: z.ZodOptional<z.ZodObject<{
+            callbackTimeoutSeconds: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+
+export { type ActionInput, type ActionName, type ActionOutput, type DocumentHandle, type LogFn, type Logger, type PendingResult, type Plugin, type PluginAction, type PluginActions, type PluginConfig, type PluginContext, type PluginDocuments, type PluginManifest, PluginManifestSchema, type PluginRetryPolicy, type WebhookEvent, WebhookRejectedError, type WebhookRequest, defineManifest, definePlugin, isPending, noopLogger, pending, signHmacSha256, verifyHmacSha256 };

package/dist/index.js

@@ -0,0 +1,85 @@
+// src/index.ts
+import { z } from "zod";
+
+// src/logger.ts
+var noopLogger = {
+  debug: () => void 0,
+  info: () => void 0,
+  warn: () => void 0,
+  error: () => void 0,
+  child: () => noopLogger
+};
+
+// src/webhooks.ts
+import { createHmac, timingSafeEqual } from "crypto";
+var WebhookRejectedError = class extends Error {
+  constructor(message = "webhook rejected") {
+    super(message);
+    this.name = "WebhookRejectedError";
+  }
+};
+function verifyHmacSha256(secret, rawBody, signature, encoding = "hex") {
+  const expected = createHmac("sha256", secret).update(rawBody).digest(encoding);
+  const a = Buffer.from(expected);
+  const b = Buffer.from(signature.trim());
+  return a.length === b.length && timingSafeEqual(a, b);
+}
+function signHmacSha256(secret, rawBody, encoding = "hex") {
+  return createHmac("sha256", secret).update(rawBody).digest(encoding);
+}
+
+// src/index.ts
+function pending(externalId) {
+  return { pending: true, externalId };
+}
+function isPending(value) {
+  return typeof value === "object" && value !== null && value.pending === true && typeof value.externalId === "string";
+}
+function definePlugin(plugin) {
+  return plugin;
+}
+function defineManifest(manifest) {
+  return manifest;
+}
+var isZodSchema = (value) => typeof value === "object" && value !== null && "_zod" in value;
+var ZodSchemaValue = z.custom(isZodSchema, { message: "expected a zod schema" });
+var PluginManifestSchema = z.object({
+  name: z.string().min(1).max(214).regex(
+    /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/,
+    "expected an npm package name"
+  ),
+  version: z.string().min(1),
+  description: z.string().optional(),
+  capabilities: z.array(z.string().min(1)),
+  configSchema: ZodSchemaValue,
+  secrets: z.array(z.string().min(1)),
+  actions: z.record(
+    z.string().min(1),
+    z.object({
+      description: z.string().optional(),
+      input: ZodSchemaValue,
+      output: ZodSchemaValue,
+      timeoutMs: z.number().int().positive().optional(),
+      retry: z.object({
+        maxAttempts: z.number().int().min(1).max(5),
+        backoffMs: z.number().int().nonnegative()
+      }).optional(),
+      idempotent: z.boolean().optional(),
+      async: z.object({
+        callbackTimeoutSeconds: z.number().int().min(1).max(7 * 24 * 3600)
+      }).optional()
+    })
+  )
+});
+export {
+  PluginManifestSchema,
+  WebhookRejectedError,
+  defineManifest,
+  definePlugin,
+  isPending,
+  noopLogger,
+  pending,
+  signHmacSha256,
+  verifyHmacSha256
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/logger.ts","../src/webhooks.ts"],"sourcesContent":["import { z } from 'zod';\nimport type { Logger } from './logger.js';\nimport type { PluginDocuments } from './documents.js';\nimport type { WebhookEvent, WebhookRequest } from './webhooks.js';\n\nexport { noopLogger, type LogFn, type Logger } from './logger.js';\nexport type { DocumentHandle, PluginDocuments } from './documents.js';\nexport {\n  WebhookRejectedError,\n  signHmacSha256,\n  verifyHmacSha256,\n  type WebhookEvent,\n  type WebhookRequest,\n} from './webhooks.js';\n\n/** Retry hints for an action; applied by the runtime only when the call is safe to repeat. */\nexport interface PluginRetryPolicy {\n  /** Total attempts including the first (1 to 5). */\n  maxAttempts: number;\n  /** Base delay between attempts; multiplied by the attempt number. */\n  backoffMs: number;\n}\n\n/** One callable action a plugin exposes. Input and output are validated by the runtime. */\nexport interface PluginAction<I extends z.ZodType = z.ZodType, O extends z.ZodType = z.ZodType> {\n  description?: string;\n  input: I;\n  output: O;\n  /** Deadline for one attempt; the runtime aborts `ctx.signal` and fails the call when exceeded. */\n  timeoutMs?: number;\n  /** Retried by the runtime when `idempotent` is true or the caller supplies an idempotency key. */\n  retry?: PluginRetryPolicy;\n  /** Declares that repeating the action with the same input has no additional effect. */\n  idempotent?: boolean;\n  /**\n   * The action starts work at the vendor and completes later through a webhook. `invoke` must\n   * return `pending(externalId)`; the runtime waits for `handleWebhook` to report that id.\n   */\n  async?: { callbackTimeoutSeconds: number };\n}\n\n/** What an asynchronous action returns after starting work at the vendor. */\nexport interface PendingResult {\n  pending: true;\n  /** The vendor's identifier for the session, job or check; webhooks must carry it back. */\n  externalId: string;\n}\n\nexport function pending(externalId: string): PendingResult {\n  return { pending: true, externalId };\n}\n\nexport function isPending(value: unknown): value is PendingResult {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    (value as { pending?: unknown }).pending === true &&\n    typeof (value as { externalId?: unknown }).externalId === 'string'\n  );\n}\n\nexport type PluginActions = Record<string, PluginAction>;\n\n/** Static description of a plugin package: what it needs (config, secrets) and what it offers. */\nexport interface PluginManifest<\n  C extends z.ZodType = z.ZodType,\n  A extends PluginActions = PluginActions,\n> {\n  /** npm package name, e.g. '@aletheia-dev/plugin-mock-sanctions'. */\n  name: string;\n  version: string;\n  description?: string;\n  /** Capability tags, e.g. ['sanctions.screen']. */\n  capabilities: string[];\n  /** Validates the tenant-provided, non-secret config. */\n  configSchema: C;\n  /** Names of secrets the plugin needs; resolved by the runtime per tenant. */\n  secrets: string[];\n  actions: A;\n}\n\n/** Per-tenant runtime context handed to every plugin call. */\nexport interface PluginContext<C = unknown> {\n  tenantId: string;\n  config: C;\n  secrets: Record<string, string>;\n  logger: Logger;\n  fetch: typeof fetch;\n  /** Aborted when the action's deadline passes; pass it to `fetch` so vendor calls stop too. */\n  signal: AbortSignal;\n  /** Stable key for the logical call (same across retries), when the caller provided one. */\n  idempotencyKey?: string;\n  /** Where the vendor must send webhooks for this plugin, when the deployment exposes one. */\n  callbackUrl?: string;\n  /**\n   * Read-only access to the tenant's clean documents (by document id). Present when the\n   * deployment has object storage; absent otherwise, so plugins must check before relying on it.\n   */\n  documents?: PluginDocuments;\n}\n\n/** Parsed config type of a manifest. */\nexport type PluginConfig<M extends PluginManifest> = z.output<M['configSchema']>;\n/** Union of a manifest's action names. */\nexport type ActionName<M extends PluginManifest> = keyof M['actions'] & string;\n/** Parsed input type of one action. */\nexport type ActionInput<M extends PluginManifest, K extends ActionName<M>> = z.output<\n  M['actions'][K]['input']\n>;\n/** Output type of one action. */\nexport type ActionOutput<M extends PluginManifest, K extends ActionName<M>> = z.output<\n  M['actions'][K]['output']\n>;\n\nexport interface Plugin<M extends PluginManifest = PluginManifest> {\n  manifest: M;\n  onInit?(ctx: PluginContext<PluginConfig<M>>): Promise<void> | void;\n  onShutdown?(): Promise<void> | void;\n  /**\n   * Dispatch one action. The runtime validates `input` against the action's input schema\n   * before calling and the return value against its output schema afterwards, so the\n   * signature stays loose here; use `ActionInput`/`ActionOutput` to type the body.\n   */\n  invoke(\n    action: ActionName<M>,\n    input: unknown,\n    ctx: PluginContext<PluginConfig<M>>,\n  ): Promise<unknown>;\n  /**\n   * Verifies and decodes a vendor webhook for one of this plugin's asynchronous actions.\n   * Return `null` to ignore the request, throw `WebhookRejectedError` for bad signatures.\n   */\n  handleWebhook?(\n    request: WebhookRequest,\n    ctx: PluginContext<PluginConfig<M>>,\n  ): Promise<WebhookEvent | null>;\n  /**\n   * Extracts the vendor's external id from a webhook whose URL carries no `?externalId=`\n   * (vendors with one dashboard-level webhook URL). Must be pure and need no secrets: it runs\n   * before the tenant is known, so it only decodes the body or headers. The platform resolves\n   * the tenant from the id and only then calls `handleWebhook` with the tenant context, which\n   * must still verify the signature. Return `null` when the request carries no id.\n   */\n  webhookExternalId?(request: WebhookRequest): string | null;\n}\n\n/** Identity helper so `manifest` drives inference for `onInit`/`invoke`. */\nexport function definePlugin<M extends PluginManifest>(plugin: Plugin<M>): Plugin<M> {\n  return plugin;\n}\n\n/** Identity helper that preserves the concrete schema and action types. */\nexport function defineManifest<C extends z.ZodType, A extends PluginActions>(\n  manifest: PluginManifest<C, A>,\n): PluginManifest<C, A> {\n  return manifest;\n}\n\nconst isZodSchema = (value: unknown): value is z.ZodType =>\n  typeof value === 'object' && value !== null && '_zod' in value;\n\nconst ZodSchemaValue = z.custom<z.ZodType>(isZodSchema, { message: 'expected a zod schema' });\n\n/** Runtime validation of a manifest's data parts (schemas are only checked to be zod schemas). */\nexport const PluginManifestSchema = z.object({\n  name: z\n    .string()\n    .min(1)\n    .max(214)\n    .regex(\n      /^(@[a-z0-9-~][a-z0-9-._~]*\\/)?[a-z0-9-~][a-z0-9-._~]*$/,\n      'expected an npm package name',\n    ),\n  version: z.string().min(1),\n  description: z.string().optional(),\n  capabilities: z.array(z.string().min(1)),\n  configSchema: ZodSchemaValue,\n  secrets: z.array(z.string().min(1)),\n  actions: z.record(\n    z.string().min(1),\n    z.object({\n      description: z.string().optional(),\n      input: ZodSchemaValue,\n      output: ZodSchemaValue,\n      timeoutMs: z.number().int().positive().optional(),\n      retry: z\n        .object({\n          maxAttempts: z.number().int().min(1).max(5),\n          backoffMs: z.number().int().nonnegative(),\n        })\n        .optional(),\n      idempotent: z.boolean().optional(),\n      async: z\n        .object({\n          callbackTimeoutSeconds: z\n            .number()\n            .int()\n            .min(1)\n            .max(7 * 24 * 3600),\n        })\n        .optional(),\n    }),\n  ),\n});\n","/**\n * Minimal structural logger contract handed to plugins (pino satisfies it).\n *\n * This is a deliberate copy of `@aletheia-dev/core`'s `logger.ts`: the SDK is published on its own\n * and must not pull the platform's core package in for three declarations. `logger.test.ts`\n * asserts the two stay assignable both ways, so the runtime can pass its core logger straight\n * into a plugin context.\n */\nexport type LogFn = (objOrMsg: object | string, msg?: string, ...args: unknown[]) => void;\n\nexport interface Logger {\n  debug: LogFn;\n  info: LogFn;\n  warn: LogFn;\n  error: LogFn;\n  child(bindings: Record<string, unknown>): Logger;\n}\n\nexport const noopLogger: Logger = {\n  debug: () => undefined,\n  info: () => undefined,\n  warn: () => undefined,\n  error: () => undefined,\n  child: () => noopLogger,\n};\n","import { createHmac, timingSafeEqual } from 'node:crypto';\n\n/** A vendor webhook as received by the API, with the raw body for signature verification. */\nexport interface WebhookRequest {\n  method: string;\n  /** Header names lower-cased. */\n  headers: Record<string, string>;\n  rawBody: Uint8Array;\n  query: Record<string, string>;\n}\n\n/** What a plugin extracted from a webhook. `null` from `handleWebhook` means \"ignore\". */\nexport interface WebhookEvent {\n  /** The vendor session id returned by the asynchronous action. */\n  externalId: string;\n  /** Vendor event id (or a stable hash) used for de-duplication. */\n  eventId: string;\n  status: 'completed' | 'failed' | 'pending';\n  /** Validated against the action's output schema when `status` is `completed`. */\n  output?: unknown;\n  error?: string;\n}\n\n/** Thrown by `handleWebhook` when the signature or payload is not acceptable (HTTP 401). */\nexport class WebhookRejectedError extends Error {\n  constructor(message = 'webhook rejected') {\n    super(message);\n    this.name = 'WebhookRejectedError';\n  }\n}\n\n/** Constant-time HMAC-SHA256 check of a raw body against a hex (or base64) signature. */\nexport function verifyHmacSha256(\n  secret: string,\n  rawBody: Uint8Array,\n  signature: string,\n  encoding: 'hex' | 'base64' = 'hex',\n): boolean {\n  const expected = createHmac('sha256', secret).update(rawBody).digest(encoding);\n  const a = Buffer.from(expected);\n  const b = Buffer.from(signature.trim());\n  return a.length === b.length && timingSafeEqual(a, b);\n}\n\nexport function signHmacSha256(\n  secret: string,\n  rawBody: Uint8Array,\n  encoding: 'hex' | 'base64' = 'hex',\n): string {\n  return createHmac('sha256', secret).update(rawBody).digest(encoding);\n}\n"],"mappings":";AAAA,SAAS,SAAS;;;ACkBX,IAAM,aAAqB;AAAA,EAChC,OAAO,MAAM;AAAA,EACb,MAAM,MAAM;AAAA,EACZ,MAAM,MAAM;AAAA,EACZ,OAAO,MAAM;AAAA,EACb,OAAO,MAAM;AACf;;;ACxBA,SAAS,YAAY,uBAAuB;AAwBrC,IAAM,uBAAN,cAAmC,MAAM;AAAA,EAC9C,YAAY,UAAU,oBAAoB;AACxC,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;AAGO,SAAS,iBACd,QACA,SACA,WACA,WAA6B,OACpB;AACT,QAAM,WAAW,WAAW,UAAU,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,QAAQ;AAC7E,QAAM,IAAI,OAAO,KAAK,QAAQ;AAC9B,QAAM,IAAI,OAAO,KAAK,UAAU,KAAK,CAAC;AACtC,SAAO,EAAE,WAAW,EAAE,UAAU,gBAAgB,GAAG,CAAC;AACtD;AAEO,SAAS,eACd,QACA,SACA,WAA6B,OACrB;AACR,SAAO,WAAW,UAAU,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,QAAQ;AACrE;;;AFFO,SAAS,QAAQ,YAAmC;AACzD,SAAO,EAAE,SAAS,MAAM,WAAW;AACrC;AAEO,SAAS,UAAU,OAAwC;AAChE,SACE,OAAO,UAAU,YACjB,UAAU,QACT,MAAgC,YAAY,QAC7C,OAAQ,MAAmC,eAAe;AAE9D;AAwFO,SAAS,aAAuC,QAA8B;AACnF,SAAO;AACT;AAGO,SAAS,eACd,UACsB;AACtB,SAAO;AACT;AAEA,IAAM,cAAc,CAAC,UACnB,OAAO,UAAU,YAAY,UAAU,QAAQ,UAAU;AAE3D,IAAM,iBAAiB,EAAE,OAAkB,aAAa,EAAE,SAAS,wBAAwB,CAAC;AAGrF,IAAM,uBAAuB,EAAE,OAAO;AAAA,EAC3C,MAAM,EACH,OAAO,EACP,IAAI,CAAC,EACL,IAAI,GAAG,EACP;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACzB,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAAA,EACvC,cAAc;AAAA,EACd,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAAA,EAClC,SAAS,EAAE;AAAA,IACT,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,IAChB,EAAE,OAAO;AAAA,MACP,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,MACjC,OAAO;AAAA,MACP,QAAQ;AAAA,MACR,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS;AAAA,MAChD,OAAO,EACJ,OAAO;AAAA,QACN,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC;AAAA,QAC1C,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,MAC1C,CAAC,EACA,SAAS;AAAA,MACZ,YAAY,EAAE,QAAQ,EAAE,SAAS;AAAA,MACjC,OAAO,EACJ,OAAO;AAAA,QACN,wBAAwB,EACrB,OAAO,EACP,IAAI,EACJ,IAAI,CAAC,EACL,IAAI,IAAI,KAAK,IAAI;AAAA,MACtB,CAAC,EACA,SAAS;AAAA,IACd,CAAC;AAAA,EACH;AACF,CAAC;","names":[]}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@aletheia-dev/plugin-sdk",
+  "version": "0.3.0",
+  "description": "SDK for writing Aletheia plugins: manifest, actions, webhooks, document access and the per-tenant context.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/akhiljames/aletheia.git",
+    "directory": "packages/plugin-sdk"
+  },
+  "homepage": "https://github.com/akhiljames/aletheia/tree/main/packages/plugin-sdk#readme",
+  "bugs": "https://github.com/akhiljames/aletheia/issues",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.4",
+    "eslint": "^10.11.0",
+    "tsup": "^8.5.1",
+    "typescript": "5.9.3",
+    "vitest": "^5.0.3",
+    "zod": "^4.6.5",
+    "@aletheia-dev/core": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "clean": "rm -rf dist .turbo"
+  }
+}