@voltro/plugin-webhooks 0.27.0 → 0.29.0

package/THIRD-PARTY-NOTICES.md

@@ -5,7 +5,7 @@ property of its respective copyright holders and is used under the terms of
 its license. This file is provided for attribution; it grants no rights in
 @voltro/plugin-webhooks itself, which is proprietary (see LICENSE).
 
-Generated from the resolved runtime dependency closure (49 packages).
+Generated from the resolved runtime dependency closure (52 packages).
 
 ---
 
@@ -3956,6 +3956,34 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
+## isomorphic.js@0.2.5
+
+License: MIT
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2020 Kevin Jahns <kevin.jahns@protonmail.com>.
+
+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.
+```
+
 ## jose@6.2.4
 
 License: MIT
@@ -4018,6 +4046,34 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 ```
 
+## lib0@0.2.117
+
+License: MIT
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2019 Kevin Jahns <kevin.jahns@protonmail.com>.
+
+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.
+```
+
 ## mime@3.0.0
 
 License: MIT
@@ -4566,3 +4622,33 @@ 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.
 ```
 
+## yjs@13.6.31
+
+License: MIT
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2023
+  - Kevin Jahns <kevin.jahns@protonmail.com>.
+  - Chair of Computer Science 5 (Databases & Information Systems), RWTH Aachen University, Germany
+
+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/dist/index.d.ts

@@ -196,6 +196,31 @@ export declare interface DeliverySummary {
  *  Covers ms / s / m / h / d. Default seconds (no suffix). */
 export declare type DurationLiteral = `${number}${'ms' | 's' | 'm' | 'h' | 'd'}` | `${number}`;
 
+/**
+ * Per-emit scoping.
+ *
+ * **The outgoing fan-out was NOT tenant-scoped, and this is what closes it.**
+ * The service is built once at boot with the app-level store, so the `tenant()`
+ * mixin on `_voltro_webhook_targets` had no request subject to scope by — the
+ * target lookup was `eq('event', name)` and nothing else. Confinement therefore
+ * rested entirely on each target's own `filter`, i.e. on the app remembering.
+ *
+ * A consumer found this by reading the CLI, and named exactly why it had looked
+ * safe: target filters usually predicate on a globally unique app id, so a
+ * cross-tenant match is impossible **by accident**. It stopped being accidental
+ * for them the moment they introduced a value deliberately equal across teams
+ * (a tenant-wide audience marker).
+ *
+ * `ctx.webhooks` binds this from the request subject, so an emit inside a
+ * handler is scoped without the handler saying anything. Absent — a background
+ * job, a schedule, a replay — keeps the unscoped behaviour, because there is no
+ * tenant to scope BY and refusing would break every system emit.
+ */
+export declare interface EmitOptions {
+    /** Only deliver to targets of this tenant. Absent ⇒ every target. */
+    readonly tenantId?: string | null;
+}
+
 export declare interface EmitResult {
     /** Stable id matching the row(s) the deliverWebhook workflow
      *  writes to `_voltro_webhook_deliveries`. Use as the foreign
@@ -421,7 +446,7 @@ export declare const isWebhookDescriptor: (value: unknown) => value is WebhookDe
  *  when the target should receive this delivery. Supports the
  *  simple key-path form `'payload.field': value` for v1; future
  *  versions can grow operators ({ gt, lt, in, … }). */
-export declare const matchesFilter: (filter: Readonly<Record<string, unknown>> | null, payload: unknown) => boolean;
+export declare const matchesFilter: (filter: WebhookFilter | Readonly<Record<string, unknown>> | null, payload: unknown) => boolean;
 
 /**
  * Build a request handler for a specific `IncomingWebhookDescriptor`.
@@ -636,10 +661,12 @@ export declare interface SubscribeInput {
     readonly secret?: string;
     readonly signing?: SignatureScheme;
     readonly retry?: RetryPolicy;
-    /** Optional predicate filter — only emits whose payload matches
-     *  this predicate fan-out to this target. The shape mirrors the
-     *  schema-builder's `Predicate` from `@voltro/database`. */
-    readonly filter?: Readonly<Record<string, unknown>>;
+    /**
+     * Optional routing filter — only emits whose payload matches fan out to this
+     * target. See {@link WebhookFilter}: dotted paths into `{ payload }`, a bare
+     * value for equality, or `{ eq | in | gt | gte | lt | lte }`.
+     */
+    readonly filter?: WebhookFilter;
     /**
      * Subscribe ONE url to SEVERAL events at once.
      *
@@ -701,7 +728,7 @@ export declare interface SubscribeResult {
 export declare interface TargetPatch {
     readonly url?: string;
     readonly description?: string | null;
-    readonly filter?: Readonly<Record<string, unknown>> | null;
+    readonly filter?: WebhookFilter | null;
     readonly scope?: Readonly<Record<string, unknown>> | null;
     readonly headers?: Readonly<Record<string, string>> | null;
     readonly rateLimitPerMinute?: number | null;
@@ -1019,6 +1046,24 @@ declare const WebhookDeliveryNotFound_base: Schema.TaggedErrorClass<WebhookDeliv
 
 export declare type WebhookDescriptor = OutgoingEventDescriptor<unknown> | IncomingWebhookDescriptor<unknown> | WebhookProviderDescriptor;
 
+/**
+ * A target's routing filter: dotted paths INTO the emitted envelope.
+ *
+ * The root is `{ payload }`, so every path starts `payload.` — a path that does
+ * not resolve reads as `undefined` and the comparison fails, which is how a
+ * typo'd path silently routes nothing.
+ */
+export declare type WebhookFilter = Readonly<Record<string, WebhookFilterValue>>;
+
+export declare type WebhookFilterValue = string | number | boolean | null | {
+    readonly eq?: string | number | boolean | null;
+    readonly in?: ReadonlyArray<string | number | boolean | null>;
+    readonly gt?: number | string;
+    readonly gte?: number | string;
+    readonly lt?: number | string;
+    readonly lte?: number | string;
+};
+
 /** Stable identifier for an event or webhook. Drives the database
  *  primary key, the inspect endpoint URL, the dashboard listing. Use
  *  dotted-camelCase (`order.completed`, `user.signedUp`). */
@@ -1115,7 +1160,7 @@ export declare interface WebhooksServiceShape {
      *  discovered-events registry) the payload is DECODED against its
      *  schema and a mismatch throws `WebhookPayloadInvalid` before any
      *  delivery is created. */
-    readonly emit: <P>(event: string | OutgoingEventDescriptor<P> | DeclaredEventLike, payload: P) => Promise<EmitResult>;
+    readonly emit: <P>(event: string | OutgoingEventDescriptor<P> | DeclaredEventLike, payload: P, options?: EmitOptions) => Promise<EmitResult>;
     /** Manual re-trigger for the dashboard's "Replay" button on a
      *  failed delivery row. Re-runs the workflow at attempt 1 with
      *  the original payload. */