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

package/dist/eventbus/v1/generated/models.d.ts

@@ -0,0 +1,568 @@
+/**
+ * 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
+ */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+/**
+ * `active` accepts new messages. `archived` keeps existing versions readable but rejects new
+ * messages.
+ */
+export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
+export declare const EventStatus: {
+    readonly active: "active";
+    readonly archived: "archived";
+};
+/**
+ * `active` admits its events. `archived` keeps them readable but rejects new events, messages
+ * and subscriptions.
+ */
+export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus];
+export declare const NamespaceStatus: {
+    readonly active: "active";
+    readonly archived: "archived";
+};
+export interface NamespaceResource {
+    /**
+     * The namespace's name; every event in it is named with this prefix and a dot
+     * @maxLength 64
+     */
+    name: string;
+    /** The owning project; absent for a platform namespace, which is maintained by a platform service and is read-only */
+    project_id?: string;
+    /** @maxLength 1024 */
+    description: string;
+    status: NamespaceStatus;
+    created_at: string;
+    updated_at: string;
+}
+export interface NamespaceList {
+    items: NamespaceResource[];
+    /**
+     * The number of namespaces matching the filters
+     * @minimum 0
+     */
+    total_count: number;
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+}
+export interface CreateNamespaceRequest {
+    /**
+     * A single segment of lowercase letters, digits and underscores, starting with a letter
+     * @maxLength 64
+     * @pattern ^[a-z](?:[a-z0-9_]*[a-z0-9])?$
+     */
+    name: string;
+    /** @maxLength 1024 */
+    description?: string;
+}
+export interface UpdateNamespaceRequest {
+    /** @maxLength 1024 */
+    description?: string;
+    status?: NamespaceStatus;
+}
+export interface EventResource {
+    /**
+     * The full event name
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * The namespace the event belongs to; the name starts with it and a dot
+     * @maxLength 64
+     */
+    namespace: string;
+    /**
+     * The owning project; absent for an event in a platform namespace
+     * @nullable
+     */
+    project_id?: string | null;
+    /**
+     * What the event means, for developers
+     * @maxLength 1024
+     */
+    description: string;
+    status: EventStatus;
+    /**
+     * Free-form labels for grouping
+     * @items.maxLength 64
+     */
+    tags?: string[];
+    /** The highest active version; absent when the event has none */
+    latest_version?: number;
+}
+/**
+ * `active` versions accept new messages. `archived` versions stay readable but reject new
+ * messages.
+ */
+export type EventVersionStatus = (typeof EventVersionStatus)[keyof typeof EventVersionStatus];
+export declare const EventVersionStatus: {
+    readonly active: "active";
+    readonly archived: "archived";
+};
+/**
+ * The JSON Schema every payload of this version must satisfy
+ */
+export type EventVersionSchema = {
+    [key: string]: unknown;
+};
+/**
+ * An example payload that satisfies the schema
+ */
+export type EventVersionDataExample = {
+    [key: string]: unknown;
+};
+export interface EventVersion {
+    /**
+     * The version number, starting at 1
+     * @minimum 1
+     */
+    version: number;
+    /** The JSON Schema every payload of this version must satisfy */
+    schema: EventVersionSchema;
+    /** An example payload that satisfies the schema */
+    data_example?: EventVersionDataExample;
+    /**
+     * `active` versions accept new messages. `archived` versions stay readable but reject new
+     * messages.
+     */
+    status: EventVersionStatus;
+    /** A stable hash of the schema's shape */
+    schema_hash: string;
+}
+export interface EventDetail {
+    /**
+     * The full event name
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * The namespace the event belongs to; the name starts with it and a dot
+     * @maxLength 64
+     */
+    namespace: string;
+    /**
+     * The owning project; absent for an event in a platform namespace
+     * @nullable
+     */
+    project_id?: string | null;
+    /**
+     * What the event means, for developers
+     * @maxLength 1024
+     */
+    description: string;
+    status: EventStatus;
+    /**
+     * Free-form labels for grouping
+     * @items.maxLength 64
+     */
+    tags?: string[];
+    /** The highest active version; absent when the event has none */
+    latest_version?: number;
+    /** Every version, newest first */
+    versions: EventVersion[];
+}
+export interface EventList {
+    items: EventResource[];
+    /**
+     * The number of events matching the filters
+     * @minimum 0
+     */
+    total_count: number;
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+}
+/**
+ * The JSON Schema for version 1
+ */
+export type CreateEventRequestSchema = {
+    [key: string]: unknown;
+};
+/**
+ * An example payload that satisfies the schema
+ */
+export type CreateEventRequestDataExample = {
+    [key: string]: unknown;
+};
+export interface CreateEventRequest {
+    /**
+     * The full event name; its first segment is the namespace
+     * @maxLength 128
+     * @pattern ^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$
+     */
+    name: string;
+    /**
+     * What the event means, for developers
+     * @maxLength 1024
+     */
+    description?: string;
+    /** The JSON Schema for version 1 */
+    schema: CreateEventRequestSchema;
+    /** An example payload that satisfies the schema */
+    data_example?: CreateEventRequestDataExample;
+}
+/**
+ * The JSON Schema for this version
+ */
+export type CreateVersionRequestSchema = {
+    [key: string]: unknown;
+};
+/**
+ * An example payload that satisfies the schema
+ */
+export type CreateVersionRequestDataExample = {
+    [key: string]: unknown;
+};
+export interface CreateVersionRequest {
+    /**
+     * The new version number, greater than every existing version
+     * @minimum 1
+     */
+    version: number;
+    /** The JSON Schema for this version */
+    schema: CreateVersionRequestSchema;
+    /** An example payload that satisfies the schema */
+    data_example?: CreateVersionRequestDataExample;
+}
+export interface UpdateEventRequest {
+    /**
+     * The new description
+     * @maxLength 1024
+     */
+    description?: string;
+    /**
+     * The complete new tag list; an empty list removes every tag
+     * @items.maxLength 64
+     */
+    tags?: string[];
+    status?: EventStatus;
+}
+/**
+ * A member of the current project; when set, only that member receives the message
+ */
+export interface PublicationRecipient {
+    /** @maxLength 128 */
+    id: string;
+}
+/**
+ * The message payload
+ */
+export type PublicationData = {
+    [key: string]: unknown;
+};
+export interface Publication {
+    /**
+     * The name of an event defined by the current project
+     * @maxLength 128
+     */
+    event: string;
+    /**
+     * The version to validate against; zero selects the highest active version
+     * @minimum 0
+     */
+    version?: number;
+    /**
+     * The last levels of the message's topic, separated by `/`. Subscribers select messages by
+     * level. No level may be empty, and neither `+` nor `#` may appear.
+     * @maxLength 256
+     */
+    key?: string;
+    recipient?: PublicationRecipient;
+    /** The message payload */
+    data: PublicationData;
+}
+export interface PublishRequest {
+    /**
+     * Any label for the publishing client, such as one per browser tab; it need not be unique
+     * @maxLength 128
+     */
+    client_id?: string;
+    /**
+     * @minItems 1
+     * @maxItems 64
+     */
+    messages: Publication[];
+}
+export interface PublishedMessage {
+    /** The message identity; consumers use it to discard duplicates */
+    id: string;
+    /** The event name */
+    event: string;
+    /**
+     * The version the payload was validated against
+     * @minimum 1
+     */
+    version: number;
+    /** When the message was accepted, in UTC RFC 3339 */
+    created_at: string;
+}
+export interface PublishResponse {
+    /** One entry per published message, in request order */
+    messages: PublishedMessage[];
+}
+export interface RealtimeTicketRequest {
+    /**
+     * The events to receive, each named once
+     * @minItems 1
+     * @maxItems 64
+     * @items.maxLength 128
+     */
+    events: string[];
+}
+export interface RealtimeTicket {
+    /** The ticket to present in the first frame of a realtime connection */
+    ticket: string;
+    /** When the ticket expires, in UTC RFC 3339; renew the connection before then */
+    expires_at: string;
+    /** The topic filters the ticket covers; subscribe to these or to filters within them */
+    topics: string[];
+}
+export type EventMessageData = {
+    [key: string]: unknown;
+};
+/**
+ * Who published a message, as established when it was accepted
+ */
+export interface Sender {
+    /** The publisher's identity */
+    id: string;
+    /** The publisher's display name when the message was accepted; absent when none is known */
+    name?: string;
+}
+/**
+ * Who a message is sent to; absent for a message sent to no recipient. With only `project_id` the
+ * message goes to the members of the project; with only `id` it goes to that person outside any
+ * project; with both it goes to that person as a member of the project.
+ */
+export interface Recipient {
+    project_id?: string;
+    id?: string;
+}
+/**
+ * A message as delivered over a realtime connection
+ */
+export interface EventMessage {
+    id: string;
+    event: string;
+    /** @minimum 1 */
+    version: number;
+    key?: string;
+    sender: Sender;
+    recipient?: Recipient;
+    /** The label the publishing client gave, exactly as given; absent when it gave none */
+    client_id?: string;
+    /** The realtime connection the message was published on; absent for messages published over HTTP or by platform services */
+    connection_id?: string;
+    created_at: string;
+    data: EventMessageData;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export type ListNamespacesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+    /**
+     * Match the namespace name or description, case-insensitively
+     * @maxLength 128
+     */
+    keyword?: string;
+    /**
+     * Include archived namespaces; defaults to false
+     */
+    include_archived?: boolean;
+};
+export type ListEventsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+    /**
+     * Return only events in this namespace; omit for all namespaces
+     * @maxLength 64
+     */
+    namespace?: string;
+    /**
+     * Match the event name or description, case-insensitively
+     * @maxLength 128
+     */
+    keyword?: string;
+    /**
+     * Include archived events; defaults to false
+     */
+    include_archived?: boolean;
+};

package/dist/eventbus/v1/generated/models.js

@@ -0,0 +1,12 @@
+export const EventStatus = {
+    active: "active",
+    archived: "archived",
+};
+export const NamespaceStatus = {
+    active: "active",
+    archived: "archived",
+};
+export const EventVersionStatus = {
+    active: "active",
+    archived: "archived",
+};