@t4h.framework/webhook 0.0.0 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# @t4h.framework/webhook
+
+## 0.1.0
+
+### Minor Changes
+
+- [#158](https://github.com/tech4humans-brasil/framework/pull/158) [`8e8ffb2`](https://github.com/tech4humans-brasil/framework/commit/8e8ffb2ac0739e2f2a1f0af2ed9ebeffe2964776) Thanks [@gusteycamargo](https://github.com/gusteycamargo)! - Adds `@t4h.framework/webhook` and unifies the external advance of a pending
+  activity behind one callback route.
+
+  **webhook**: `webhook()` sends an outbound request (with `<<callbackUrl>>`
+  replaced by the activity callback URL, 60s timeout) through
+  `HttpClientRequestClaim` and suspends the workflow until the third party posts
+  to that URL. The partner's answer is kept as `callback.dispatch`; the callback
+  body is validated against `schema`; `{ wait: false }` returns a handle to wait
+  on later. Ships `deriveCallbackToken`/`isCallbackTokenValid` and
+  `verifyCallbackAuth` for hosts.
+
+  **core**: `AsyncActivityCallbackAuth` (hmac, basic, header, bearer, jwt),
+  `pending({ auth })`, `advance(payload, bootstrap, context?)` receiving the
+  callback method and headers, and the `GetActivityCallbackUrlClaim` hosts must
+  provide.
+
+  **http**: `timeoutInMs` on `HttpClientRequestClaimInput`.
+
+  **dev**: `POST /projects/:project/workflows/:workflow/runs/:run/activities/:activity/callbacks?token=…`
+  replaces the `PATCH …/activities/:id` advance route. Each delivery is stored
+  as a pending callback (method + request); the token is derived from the
+  activity id, the declared `auth` is verified before the workflow advances.
+
+  **vite-panel-plugin**: the Inbox advance route follows the new callbacks
+  endpoint, with the token in the curl.
+
+### Patch Changes
+
+- Updated dependencies [[`8e8ffb2`](https://github.com/tech4humans-brasil/framework/commit/8e8ffb2ac0739e2f2a1f0af2ed9ebeffe2964776)]:
+  - @t4h.framework/core@0.11.0
+  - @t4h.framework/http@0.6.0
+  - @t4h.framework/hmac@0.2.1
+  - @t4h.framework/jwks@0.5.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tech for humans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t4h.framework/webhook",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Webhook module for the T4H Framework",
   "homepage": "https://github.com/tech4humans-brasil/framework/tree/main/packages/webhook",
   "bugs": "https://github.com/tech4humans-brasil/framework/issues",
@@ -31,19 +31,19 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@t4h.framework/hmac": "^0.1.0",
-    "@t4h.framework/jwks": "^0.4.0",
+    "@t4h.framework/hmac": "^0.2.1",
+    "@t4h.framework/jwks": "^0.5.1",
     "typebox": "^1.1.6"
   },
   "devDependencies": {
-    "@t4h.framework/core": "^0.9.1",
-    "@t4h.framework/http": "^0.4.4",
+    "@t4h.framework/core": "^0.11.0",
+    "@t4h.framework/http": "^0.6.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {
-    "@t4h.framework/core": "^0.9.1",
-    "@t4h.framework/http": "^0.4.4"
+    "@t4h.framework/core": "^0.11.0",
+    "@t4h.framework/http": "^0.6.0"
   },
   "packageManager": "yarn@4.12.0",
   "engines": {

package/dist/models/WebhookClaim.d.ts

@@ -1,19 +0,0 @@
-import type { WebhookRequest } from './WebhookRequest.js';
-export type WebhookClaimDispatchInput = {
-    /** Id of the activity that will wait for the callback. */
-    activityId: string;
-    /** Outbound request; `{{callbackUrl}}` inside it is replaced by `callbackUrl`. */
-    request: WebhookRequest;
-    callbackUrl: string;
-};
-/**
- * Host side of the outbound half of a webhook. `dispatch` is called from
- * `WebhookActivity.bootstrap`, so in a transactional host it runs inside the
- * activity transaction: defer the HTTP call (outbox, queue) to after the
- * commit, so the third party can never call back before the pending exists.
- * A dispatch that fails must reject the activity with `dispatch_failed`.
- */
-export declare abstract class WebhookClaim {
-    abstract dispatch(input: WebhookClaimDispatchInput): void | Promise<void>;
-}
-//# sourceMappingURL=WebhookClaim.d.ts.map

package/dist/models/WebhookClaim.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebhookClaim.d.ts","sourceRoot":"","sources":["../../src/models/WebhookClaim.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD,MAAM,MAAM,yBAAyB,GAAG;IACtC,0DAA0D;IAC1D,UAAU,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,OAAO,EAAE,cAAc,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;;GAMG;AACH,8BAAsB,YAAY;aAChB,QAAQ,CACtB,KAAK,EAAE,yBAAyB,GAC/B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CACxB"}

package/dist/models/WebhookClaim.js

@@ -1,10 +0,0 @@
-/**
- * Host side of the outbound half of a webhook. `dispatch` is called from
- * `WebhookActivity.bootstrap`, so in a transactional host it runs inside the
- * activity transaction: defer the HTTP call (outbox, queue) to after the
- * commit, so the third party can never call back before the pending exists.
- * A dispatch that fails must reject the activity with `dispatch_failed`.
- */
-export class WebhookClaim {
-}
-//# sourceMappingURL=WebhookClaim.js.map

package/dist/models/WebhookClaim.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebhookClaim.js","sourceRoot":"","sources":["../../src/models/WebhookClaim.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,MAAM,OAAgB,YAAY;CAIjC"}