@leaflow/sdk 0.0.0-dev.45.g5125469 → 0.0.0-dev.451.gfd4baf5

package/dist/eventbus/v1/generated/validators/realtimeTicket.zod.js

@@ -0,0 +1,94 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const RealtimeTicket = zod.strictObject({
+    ticket: zod
+        .string()
+        .describe("The ticket to present in the first frame of a realtime connection"),
+    expires_at: zod.iso
+        .datetime({ offset: true })
+        .describe("When the ticket expires, in UTC RFC 3339; renew the connection before then"),
+    topics: zod
+        .array(zod.string())
+        .describe("The topic filters the ticket covers; subscribe to these or to filters within them"),
+});

package/dist/eventbus/v1/generated/validators/realtimeTicketRequest.zod.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const realtimeTicketRequestEventsItemMax = 128;
+export declare const realtimeTicketRequestEventsMax = 64;
+export declare const RealtimeTicketRequest: zod.ZodObject<{
+    events: zod.ZodArray<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type RealtimeTicketRequest = zod.input<typeof RealtimeTicketRequest>;
+export type RealtimeTicketRequestOutput = zod.output<typeof RealtimeTicketRequest>;

package/dist/eventbus/v1/generated/validators/realtimeTicketRequest.zod.js

@@ -0,0 +1,92 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const realtimeTicketRequestEventsItemMax = 128;
+export const realtimeTicketRequestEventsMax = 64;
+export const RealtimeTicketRequest = zod.strictObject({
+    events: zod
+        .array(zod.string().max(realtimeTicketRequestEventsItemMax))
+        .min(1)
+        .max(realtimeTicketRequestEventsMax)
+        .describe("The events to receive, each named once"),
+});

package/dist/eventbus/v1/generated/validators/recipient.zod.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const Recipient: zod.ZodObject<{
+    project_id: zod.ZodOptional<zod.ZodUUID>;
+    id: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type Recipient = zod.input<typeof Recipient>;
+export type RecipientOutput = zod.output<typeof Recipient>;

package/dist/eventbus/v1/generated/validators/recipient.zod.js

@@ -0,0 +1,89 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const Recipient = zod
+    .strictObject({
+    project_id: zod.uuid().optional(),
+    id: zod.string().optional(),
+})
+    .describe("Who a message is sent to; absent for a message sent to no recipient. With only `project_id` the\nmessage goes to the members of the project; with only `id` it goes to that person outside any\nproject; with both it goes to that person as a member of the project.");

package/dist/eventbus/v1/generated/validators/sender.zod.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const Sender: zod.ZodObject<{
+    id: zod.ZodString;
+    name: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type Sender = zod.input<typeof Sender>;
+export type SenderOutput = zod.output<typeof Sender>;

package/dist/eventbus/v1/generated/validators/sender.zod.js

@@ -0,0 +1,92 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Definitions and messages
+ *
+ * An event is a definition: a name, a description, and one or more versions. A version carries a
+ * JSON Schema that every published payload must satisfy. Messages are not stored here and are
+ * not part of the event definition.
+ *
+ * Every event belongs to a namespace, and its name is the namespace's name, a dot, and at least a
+ * resource and an action, such as `acme.order.created`. A project creates its own namespaces and
+ * defines events in them. Platform namespaces, such as `leaflow.notification`, are maintained by
+ * platform services: their events are listed alongside the project's own and can be subscribed
+ * to, but cannot be changed or published here, and the namespaces cannot be changed or deleted.
+ * Events in a platform namespace are called platform events below.
+ *
+ * A version number never changes meaning. Adding optional properties is allowed within a version;
+ * a breaking change creates a new version. Publishing without a version uses the highest active
+ * version.
+ *
+ * ## Publishing
+ *
+ * Messages are published in batches of up to 64. A batch is validated as a whole: if any message
+ * is rejected, none is published. Publishing returns the identity of each message and does not
+ * wait for consumers. Messages are not stored and are not replayed: a consumer that connects
+ * later does not receive earlier messages.
+ *
+ * Messages published through this API are sent to the current project. A message may name a
+ * `recipient`, a member of the project; it is then sent to that member only. Without a recipient
+ * it is sent to every member of the project.
+ *
+ * Every message names its `sender`: an `id` and the `name` the publisher had when the message was
+ * accepted. A publication may also carry a `client_id`, any label the client chooses, such as one
+ * per browser tab. Receivers get it unchanged, so a client can recognise its own messages by
+ * `sender` and `client_id`. A client ID need not be unique; a realtime connection is identified
+ * by its `connection_id`.
+ *
+ * ## Realtime
+ *
+ * Every message has a topic `{event}/{recipient project_id|-}/{recipient id|-}/{key levels}`, where
+ * `-` stands for a missing recipient and the key, split at `/`, supplies the remaining levels. A topic filter
+ * uses `+` to match exactly one level and `#`, only as the last level, to match that level and
+ * every level below it, including none. For example, `{event}/{project_id}/-/#` matches every
+ * message sent to the members of a project, and `{event}/-/{user_id}/#` every message sent to one
+ * person outside any project.
+ *
+ * 1. Create a ticket with `POST /api/v1/realtime/tickets`, naming the events to receive. The
+ *    response lists the topic filters the ticket covers. For a platform event they cover messages sent to the caller, messages sent to no recipient and,
+ *    where the caller's permissions allow, messages sent within the project; for a project event
+ *    they cover messages sent within the project. Without a selected project, use
+ *    `POST /api/v1/account/realtime/tickets`; such a ticket covers only messages sent to the
+ *    caller or to no recipient, and cannot publish.
+ * 2. Open a WebSocket to `wss://eventbus.leaflow.cloud/realtime` and send, within 15 seconds:
+ *    `{"type":"authenticate","ticket":"…","client_id":"…"}`, where `client_id` is optional. The
+ *    reply is `{"type":"authenticated","client_id":"…","connection_id":"…","expires_at":"…"}`.
+ *    `connection_id` identifies this connection; it is assigned by EventBus and changes on
+ *    every reconnection.
+ * 3. Only after `authenticated`, send `{"type":"subscribe","id":"…","topics":[…]}`; a
+ *    subscription sent before is rejected. Each topic must be one of the returned
+ *    `topics` or lie within one of them, for example by naming a key level where the ticket has
+ *    `#`; a batch with any other topic is rejected as a whole. The reply is `subscribed`.
+ *    `unsubscribe` takes the same form and replies `unsubscribed`.
+ * 4. Messages arrive as `{"type":"messages","messages":[…]}`, each element an `EventMessage`. A
+ *    message matching several subscriptions on one connection arrives once for each of them.
+ * 5. A connection may switch to another ticket of the same user at any time by sending
+ *    `authenticate` again: to renew before `expires_at`, to move from an account ticket to a
+ *    project ticket, or to move to another project. Wait for its `authenticated` reply before
+ *    changing subscriptions; if it is rejected, the previous ticket stays in effect. `client_id`
+ *    may be omitted to keep the current one. Subscriptions the new ticket does not cover are removed at once and reported in a
+ *    `{"type":"revoked","topics":[…]}` frame. A ticket for another user closes the connection
+ *    with code 4401, as does letting the ticket expire.
+ *
+ * A connection holding a project ticket may publish the project's own events with
+ * `{"type":"publish","id":"…","messages":[{"event":"…","key":"…","recipient":{"id":"…"},"data":{…}}]}`;
+ * the reply is `published` with the identity of each message. `ping` is answered with `pong`.
+ * A rejected request is answered with `{"type":"error","id":"…","code":"…","message":"…"}`.
+ * Every reply carries the `id` of the request it answers.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const Sender = zod
+    .strictObject({
+    id: zod.string().describe("The publisher's identity"),
+    name: zod
+        .string()
+        .optional()
+        .describe("The publisher's display name when the message was accepted; absent when none is known"),
+})
+    .describe("Who published a message, as established when it was accepted");