@partite-ai/particle-signing 0.1.0

package/README.md

@@ -0,0 +1,25 @@
+# @partite-ai/particle-signing
+
+TypeScript types for the `@partite-ai/particle-signing` host capability
+consumed by [Particle](https://github.com/partite-ai/particles) particles.
+
+Types only — the runtime implementation lives in the Particle wasm
+runtime. Key material never enters the particle's address space; sign
+and verify are host calls.
+
+```ts
+import { signing } from "@partite-ai/particle-signing";
+
+const data = new TextEncoder().encode(payload);
+const sig = await signing.sign("webhook-key", data);
+// post `sig` as a header / body field per the upstream's protocol
+```
+
+## API
+
+- `signing.sign(name, data)` — host-side signature. v1 supports
+  HMAC-SHA-256 and HMAC-SHA-512.
+- `signing.verify(name, data, signature)` — host-side verify.
+
+See the [Particle README](https://github.com/partite-ai/particles) for
+the manifest schema.

package/index.d.ts

@@ -0,0 +1,22 @@
+// TypeScript types for the host-provided `@partite-ai/particle-signing`
+// module. The runtime resolves this import to a JS shim that wraps
+// the WIT-imported `particle:host/signing@0.1.0` interface — see
+// the Particle repository for the implementation. Types only.
+
+/**
+ * Cryptographic operations against a host-stored key. The key
+ * material never enters JS; sign / verify happen entirely on the
+ * host side. Importing this requires at least one
+ * `type: "signing-key"` credential in the manifest.
+ */
+export const signing: {
+  /** Returns the signature of `data` under the named key. */
+  sign(name: string, data: Uint8Array): Promise<Uint8Array>;
+  /** Returns whether `signature` matches `data` under the named key. */
+  verify(name: string, data: Uint8Array, signature: Uint8Array): Promise<boolean>;
+};
+
+export type SigningError =
+  | { tag: "not-configured" }
+  | { tag: "not-signing-key" }
+  | { tag: "invalid-input"; val: string };

package/index.js

@@ -0,0 +1,10 @@
+// This package ships TypeScript types only. The runtime
+// implementation is provided by the Particle wasm runtime — see
+// components/runtime/src/host-shim.ts in the Particle repo.
+// Loading this file outside that runtime throws so the misuse
+// is loud rather than silent.
+throw new Error(
+  "@partite-ai/particle-signing is only callable inside the Particle runtime. " +
+    "Run your particle with `particle run` / `particle serve-mcp`, or build it into " +
+    "a .particle artifact.",
+);

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@partite-ai/particle-signing",
+  "version": "0.1.0",
+  "description": "TypeScript types for `@partite-ai/particle-signing` — host-side cryptographic sign/verify for Particle particles.",
+  "license": "MIT",
+  "homepage": "https://github.com/partite-ai/particles",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/partite-ai/particles.git",
+    "directory": "js-types/particle-signing"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "keywords": ["particle", "wasm", "signing", "hmac", "credentials", "mcp"],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false
+}