hooklatch 0.0.0-stage → 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,69 @@
+/** Contract version 1. Verification never parses or validates payload schemas. */
+export type Provider = 'stripe' | 'github' | 'shopify' | 'standard-webhooks' | 'clerk' | 'svix' | 'razorpay' | 'paddle' | 'lemon-squeezy' | 'dodo-payments' | 'gitlab' | 'replicate' | 'workos' | 'sentry' | 'doppler' | 'sanity' | 'grafana' | 'polar' | 'linear' | 'vercel' | 'fal';
+export type HeaderInput = Headers | Readonly<Record<string, string | readonly string[] | undefined>> | readonly (readonly [string, string])[];
+export interface WebhookRequest {
+    readonly rawBody: Uint8Array;
+    readonly headers: HeaderInput;
+}
+export type GrafanaOptions = {
+    readonly mode: 'body';
+    readonly signatureHeader?: string;
+    readonly timestampHeader?: never;
+} | {
+    readonly mode: 'timestamped';
+    readonly signatureHeader?: string;
+    readonly timestampHeader: string;
+};
+export interface PolarOptions {
+    readonly secretMode?: 'current' | 'legacy';
+}
+interface CommonVerifyOptions {
+    readonly toleranceSeconds?: number;
+    readonly now?: () => number;
+    readonly maxBodyBytes?: number;
+}
+export type FalVerifyOptions = CommonVerifyOptions & {
+    readonly provider: 'fal';
+    readonly publicKeys: readonly Uint8Array[];
+    readonly expectedUserId: string;
+    readonly secrets?: never;
+    readonly providerOptions?: never;
+};
+export type VerifyOptions = FalVerifyOptions | (CommonVerifyOptions & {
+    readonly secrets: readonly string[];
+} & ({
+    readonly provider: Exclude<Provider, 'grafana' | 'polar' | 'fal'>;
+    readonly providerOptions?: never;
+} | {
+    readonly provider: 'grafana';
+    readonly providerOptions: GrafanaOptions;
+} | {
+    readonly provider: 'polar';
+    readonly providerOptions?: PolarOptions;
+}));
+export type IdentityField = 'deliveryId' | 'eventId' | 'timestamp';
+export interface EventIdentity {
+    readonly deliveryId: string | null;
+    readonly eventId: string | null;
+    readonly timestamp: number | null;
+    readonly authenticatedFields: readonly IdentityField[];
+}
+export type VerificationFailureReason = 'missing-signature' | 'malformed-signature' | 'unsupported-scheme' | 'invalid-signature' | 'missing-identity' | 'missing-timestamp' | 'timestamp-expired' | 'timestamp-future' | 'body-too-large';
+export interface FailureDetails {
+    readonly ok: false;
+    readonly reason: VerificationFailureReason;
+    readonly message: string;
+}
+export interface VerificationSuccess {
+    readonly ok: true;
+    readonly provider: Provider;
+    readonly rawBody: Uint8Array;
+    readonly identity: EventIdentity;
+}
+export interface VerificationFailure extends FailureDetails {
+    readonly provider: Provider;
+}
+export type VerificationResult = VerificationSuccess | VerificationFailure;
+export type HooklatchErrorCode = 'unknown-provider' | 'missing-secrets' | 'invalid-secret' | 'invalid-options' | 'invalid-input' | 'body-consumed' | 'body-read-failed' | 'crypto-unavailable' | 'internal';
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,mBAAmB,GACxE,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,eAAe,GAC1D,eAAe,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GACrF,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEtD,MAAM,MAAM,WAAW,GAAG,OAAO,GAC7B,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,GAChE,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;AAE3C,MAAM,WAAW,cAAc;IAAG,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE;AAE/F,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAA;CAAE,GAC9F;IAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1G,MAAM,WAAW,YAAY;IAAG,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;CAAE;AAE5E,UAAU,mBAAmB;IAC3B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACnD,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IACzB,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,gBAAgB,GAAG,CAAC,mBAAmB,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAAG,CAC5G;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC;IAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAA;CAAE,GACvG;IAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAA;CAAE,GAC1E;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,YAAY,CAAA;CAAE,CAC1E,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG,SAAS,GAAG,WAAW,CAAC;AAEnE,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,mBAAmB,EAAE,SAAS,aAAa,EAAE,CAAC;CACxD;AAED,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG,qBAAqB,GAC/E,oBAAoB,GAAG,mBAAmB,GAAG,kBAAkB,GAC/D,mBAAmB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAEtF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;CAClC;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IAAG,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE;AAE3F,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAE3E,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,gBAAgB,GACtF,iBAAiB,GAAG,eAAe,GAAG,eAAe,GAAG,kBAAkB,GAC1E,oBAAoB,GAAG,UAAU,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,202 @@
 {
   "name": "hooklatch",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Portable webhook signature verification with a zero-dependency core",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Its-amanjha/Hooklatch.git"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "main": "./dist/cjs/index.cjs",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "hooklatch": "./dist/cli/index.js"
+  },
+  "exports": {
+    ".": {
+      "node": {
+        "import": {
+          "types": "./dist/node/index.d.ts",
+          "default": "./dist/node/index.js"
+        },
+        "require": {
+          "types": "./dist/cjs/index.d.cts",
+          "default": "./dist/cjs/index.cjs"
+        }
+      },
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./diagnostics": {
+      "node": {
+        "import": {
+          "types": "./dist/node/diagnostics/index.d.ts",
+          "default": "./dist/node/diagnostics/index.js"
+        },
+        "require": {
+          "types": "./dist/cjs/diagnostics/index.d.cts",
+          "default": "./dist/cjs/diagnostics/index.cjs"
+        }
+      },
+      "types": "./dist/diagnostics/index.d.ts",
+      "import": "./dist/diagnostics/index.js",
+      "default": "./dist/diagnostics/index.js"
+    },
+    "./express": {
+      "node": {
+        "import": {
+          "types": "./dist/node/adapters/express.d.ts",
+          "default": "./dist/node/adapters/express.js"
+        },
+        "require": {
+          "types": "./dist/cjs/adapters/express.d.cts",
+          "default": "./dist/cjs/adapters/express.cjs"
+        }
+      },
+      "types": "./dist/adapters/express.d.ts",
+      "import": "./dist/adapters/express.js",
+      "default": "./dist/adapters/express.js"
+    },
+    "./nextjs": {
+      "node": {
+        "import": {
+          "types": "./dist/node/adapters/nextjs.d.ts",
+          "default": "./dist/node/adapters/nextjs.js"
+        },
+        "require": {
+          "types": "./dist/cjs/adapters/nextjs.d.cts",
+          "default": "./dist/cjs/adapters/nextjs.cjs"
+        }
+      },
+      "types": "./dist/adapters/nextjs.d.ts",
+      "import": "./dist/adapters/nextjs.js",
+      "default": "./dist/adapters/nextjs.js"
+    },
+    "./cloudflare": {
+      "node": {
+        "import": {
+          "types": "./dist/node/adapters/cloudflare.d.ts",
+          "default": "./dist/node/adapters/cloudflare.js"
+        },
+        "require": {
+          "types": "./dist/cjs/adapters/cloudflare.d.cts",
+          "default": "./dist/cjs/adapters/cloudflare.cjs"
+        }
+      },
+      "types": "./dist/adapters/cloudflare.d.ts",
+      "import": "./dist/adapters/cloudflare.js",
+      "default": "./dist/adapters/cloudflare.js"
+    },
+    "./hono": {
+      "node": {
+        "import": {
+          "types": "./dist/node/adapters/hono.d.ts",
+          "default": "./dist/node/adapters/hono.js"
+        },
+        "require": {
+          "types": "./dist/cjs/adapters/hono.d.cts",
+          "default": "./dist/cjs/adapters/hono.cjs"
+        }
+      },
+      "types": "./dist/adapters/hono.d.ts",
+      "import": "./dist/adapters/hono.js",
+      "default": "./dist/adapters/hono.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "verify": "node scripts/verify.mjs",
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cli.json && node scripts/phase11/build-node-distribution.mjs",
+    "dev": "tsc -p tsconfig.json --watch",
+    "typecheck": "tsc -p tsconfig.check.json --noEmit",
+    "typecheck:workers": "tsc -p tsconfig.workers.json --noEmit",
+    "typecheck:examples": "tsc -p tsconfig.examples.json --noEmit",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand",
+    "test:coverage": "npm test -- --coverage",
+    "lint": "npm run lint:eslint && npm run lint:anti-slop",
+    "test:workers": "node scripts/workers-smoke.mjs && node scripts/workers-providers.mjs",
+    "test:package": "node scripts/package-smoke.mjs",
+    "test:templates": "node scripts/templates-smoke.mjs",
+    "lint:eslint": "eslint src tests scripts examples --no-error-on-unmatched-pattern",
+    "lint:anti-slop": "oxlint --config .oxlintrc.json src tests scripts examples",
+    "test:mutations": "node scripts/phase6-mutations.mjs --include-controls",
+    "test:public-contracts": "node scripts/public-contract-smoke.mjs",
+    "test:provider-config": "node scripts/phase7-config-qualification.mjs --json",
+    "test:configured-templates": "node scripts/phase7-cli-config-smoke.mjs",
+    "test:crypto-runtime": "node scripts/phase9-runtime-qualification.mjs --json",
+    "test:docs-contract": "node scripts/phase10/docs-contract-controls.mjs && node scripts/phase10/docs-contract.mjs",
+    "test:api-freeze": "node scripts/phase10/api-freeze.mjs --self-test && node scripts/phase10/api-freeze.mjs --results notes/phase-10/coordinator-api-freeze-results.json",
+    "test:generated-runtime": "node scripts/phase10/generated-handlers-runtime.mjs --controls && node scripts/phase10/generated-handlers-runtime.mjs --runtime current",
+    "test:conformance": "node scripts/phase10/provider-conformance-controls.mjs && node scripts/phase10/provider-conformance.mjs --controls",
+    "test:cjs-prototype": "node scripts/phase10/cjs-consumers.mjs",
+    "test:node-distribution": "node --test tests/build/phase11-node-distribution.test.mjs",
+    "test:compat-package": "node scripts/phase11/package-contract.mjs --self-test && node scripts/phase11/package-contract.mjs",
+    "test:compat-types": "node scripts/phase11/types-compatibility.mjs --self-test && node scripts/phase11/types-compatibility.mjs",
+    "test:compat-runtime": "node scripts/phase11/mixed-format-runtime.mjs --self-test && node scripts/phase11/mixed-format-runtime.mjs --current",
+    "test:compat-frameworks": "node scripts/phase11/workers-compatibility.mjs --self-test",
+    "test:evidence": "node scripts/phase12/evidence-contract.mjs --self-test && node scripts/phase12/evidence-contract.mjs",
+    "test:release-readiness": "node scripts/phase12/release-readiness-controls.mjs && node scripts/phase12/release-readiness.mjs",
+    "test:release-candidate-controls": "node scripts/phase13/release-candidate.mjs --self-test && node scripts/phase13/release-candidate-controls.mjs",
+    "test:onboarding-controls": "node scripts/phase13/onboarding-smoke.mjs --self-test && node scripts/phase13/onboarding-controls.mjs"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0 || ^5.0.0",
+    "hono": "^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    },
+    "hono": {
+      "optional": true
+    }
+  },
+  "overrides": {
+    "miniflare": {
+      "sharp": "0.35.5",
+      "undici": "7.29.1"
+    }
+  },
+  "devDependencies": {
+    "@oxlint/plugins": "1.89.0",
+    "@types/express": "5.0.6",
+    "@types/jest": "30.0.0",
+    "@types/node": "^22.0.0",
+    "esbuild": "0.28.2",
+    "eslint": "10.13.0",
+    "express": "5.3.0",
+    "hono": "4.13.13",
+    "jest": "30.5.2",
+    "miniflare": "4.20260730.0",
+    "oxlint": "1.89.0",
+    "ts-jest": "29.4.15",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.72.0"
+  },
+  "homepage": "https://github.com/Its-amanjha/Hooklatch#readme",
+  "bugs": {
+    "url": "https://github.com/Its-amanjha/Hooklatch/issues"
+  },
+  "keywords": [
+    "webhooks",
+    "webhook-security",
+    "signature-verification",
+    "hmac",
+    "ed25519",
+    "typescript",
+    "express",
+    "hono",
+    "nextjs",
+    "cloudflare-workers",
+    "nodejs"
+  ]
+}