@leaflow/sdk 0.175.0 → 0.177.1

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

@@ -0,0 +1,364 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. Neither the path
+ * nor the headers carry a `project_id`: the current project is determined by the token.
+ *
+ * ## 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.
+ *
+ * A project event belongs to the current project. A global event has no `project_id`; it is
+ * defined by a platform service and is read-only in this API. Global events are listed alongside
+ * the project's own events.
+ *
+ * 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
+ *
+ * Publishing returns the identity of the 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. Consumers receive messages through the realtime API or the platform's service API.
+ *
+ * ## Realtime
+ *
+ * Create a ticket, connect to the returned URL with the ticket, and authenticate the connection
+ * with a scoped token. A ticket is single-use and short-lived. The connection ends when the
+ * token expires unless it is refreshed with a new scoped token for the same user and project.
+ * 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";
+};
+export interface EventResource {
+    /**
+     * The full event name
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * The owning project; absent for a global event
+     * @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 owning project; absent for a global event
+     * @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;
+}
+/**
+ * The message payload
+ */
+export type PublishRequestData = {
+    [key: string]: unknown;
+};
+export interface PublishRequest {
+    /**
+     * The version to validate against; zero selects the highest active version
+     * @minimum 0
+     */
+    version?: number;
+    /**
+     * The ordering key. Messages with the same key reach an individual consumer in publication
+     * order. Defaults to the project id when absent.
+     * @maxLength 256
+     */
+    key?: string;
+    /** The message payload */
+    data: PublishRequestData;
+}
+export interface PublishResponse {
+    /** 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 RealtimeTicket {
+    /** The WebSocket URL to connect to */
+    url: string;
+    /** The ticket to present when connecting */
+    ticket: string;
+    /** When the ticket expires, in UTC RFC 3339 */
+    expires_at: string;
+}
+/**
+ * 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 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,8 @@
+export const EventStatus = {
+    active: "active",
+    archived: "archived",
+};
+export const EventVersionStatus = {
+    active: "active",
+    archived: "archived",
+};

package/dist/eventbus/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. Neither the path
+ * nor the headers carry a `project_id`: the current project is determined by the token.
+ *
+ * ## 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.
+ *
+ * A project event belongs to the current project. A global event has no `project_id`; it is
+ * defined by a platform service and is read-only in this API. Global events are listed alongside
+ * the project's own events.
+ *
+ * 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
+ *
+ * Publishing returns the identity of the 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. Consumers receive messages through the realtime API or the platform's service API.
+ *
+ * ## Realtime
+ *
+ * Create a ticket, connect to the returned URL with the ticket, and authenticate the connection
+ * with a scoped token. A ticket is single-use and short-lived. The connection ends when the
+ * token expires unless it is refreshed with a new scoped token for the same user and project.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * Returns the global events visible to the project and the project's own events. Ordered by
+ * name.
+ * @summary List event definitions
+ */
+export declare const listEventsQueryPageDefault = 1;
+export declare const listEventsQueryPageMax = 2147483647;
+export declare const listEventsQueryPageSizeDefault = 50;
+export declare const listEventsQueryPageSizeMax = 200;
+export declare const listEventsQueryNamespaceMax = 64;
+export declare const listEventsQueryKeywordMax = 128;
+export declare const listEventsQueryIncludeArchivedDefault = false;
+export declare const ListEventsQueryParams: zod.ZodObject<{
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+    namespace: zod.ZodOptional<zod.ZodString>;
+    keyword: zod.ZodOptional<zod.ZodString>;
+    include_archived: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strict>;
+/**
+ * Creates a project event with its first version. The name is unique within the project. The
+ * first segment of the name is the event's namespace and must not be a platform namespace.
+ * @summary Create an event definition
+ */
+export declare const CreateEventBody: zod.ZodObject<{
+    name: zod.ZodString;
+    description: zod.ZodOptional<zod.ZodString>;
+    schema: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+    data_example: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+}, zod.z.core.$strict>;
+/**
+ * Returns the event and every version, newest first.
+ * @summary Get an event definition
+ */
+export declare const getEventPathEventNameMax = 128;
+export declare const getEventPathEventNameRegExp: RegExp;
+export declare const GetEventParams: zod.ZodObject<{
+    eventName: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Changes the description, tags, or status. Only the fields present in the request are
+ * changed. An archived event stops accepting new messages; existing versions remain readable.
+ * @summary Update an event definition
+ */
+export declare const updateEventPathEventNameMax = 128;
+export declare const updateEventPathEventNameRegExp: RegExp;
+export declare const UpdateEventParams: zod.ZodObject<{
+    eventName: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const UpdateEventBody: zod.ZodObject<{
+    description: zod.ZodOptional<zod.ZodString>;
+    tags: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        active: "active";
+        archived: "archived";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * Adds a version to an existing event. The version number must be greater than every existing
+ * version. A version number's schema may gain optional properties, but it may not remove or
+ * change existing ones; use a new version for a breaking change.
+ * @summary Add an event version
+ */
+export declare const createEventVersionPathEventNameMax = 128;
+export declare const createEventVersionPathEventNameRegExp: RegExp;
+export declare const CreateEventVersionParams: zod.ZodObject<{
+    eventName: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const CreateEventVersionBody: zod.ZodObject<{
+    version: zod.ZodInt;
+    schema: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+    data_example: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+}, zod.z.core.$strict>;
+/**
+ * Returns one version of an event.
+ * @summary Get an event version
+ */
+export declare const getEventVersionPathEventNameMax = 128;
+export declare const getEventVersionPathEventNameRegExp: RegExp;
+export declare const GetEventVersionParams: zod.ZodObject<{
+    eventName: zod.ZodString;
+    version: zod.ZodInt;
+}, zod.z.core.$strict>;
+/**
+ * Validates the payload against the selected version and publishes the message. The response
+ * carries the message identity; it does not mean a consumer received it. A version of zero
+ * selects the highest active version.
+ * @summary Publish an event message
+ */
+export declare const publishEventPathEventNameMax = 128;
+export declare const publishEventPathEventNameRegExp: RegExp;
+export declare const PublishEventParams: zod.ZodObject<{
+    eventName: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const PublishEventBody: zod.ZodObject<{
+    version: zod.ZodDefault<zod.ZodInt>;
+    key: zod.ZodOptional<zod.ZodString>;
+    data: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+}, zod.z.core.$strict>;

package/dist/eventbus/v1/generated/schemas.zod.js

@@ -0,0 +1,163 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Event Bus API
+ * Event definitions, versions, publishing, and realtime access.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. Neither the path
+ * nor the headers carry a `project_id`: the current project is determined by the token.
+ *
+ * ## 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.
+ *
+ * A project event belongs to the current project. A global event has no `project_id`; it is
+ * defined by a platform service and is read-only in this API. Global events are listed alongside
+ * the project's own events.
+ *
+ * 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
+ *
+ * Publishing returns the identity of the 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. Consumers receive messages through the realtime API or the platform's service API.
+ *
+ * ## Realtime
+ *
+ * Create a ticket, connect to the returned URL with the ticket, and authenticate the connection
+ * with a scoped token. A ticket is single-use and short-lived. The connection ends when the
+ * token expires unless it is refreshed with a new scoped token for the same user and project.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { CreateEventRequest } from "./validators/createEventRequest.zod.js";
+import { CreateVersionRequest } from "./validators/createVersionRequest.zod.js";
+import { PublishRequest } from "./validators/publishRequest.zod.js";
+import { UpdateEventRequest } from "./validators/updateEventRequest.zod.js";
+/**
+ * Returns the global events visible to the project and the project's own events. Ordered by
+ * name.
+ * @summary List event definitions
+ */
+export const listEventsQueryPageDefault = 1;
+export const listEventsQueryPageMax = 2147483647;
+export const listEventsQueryPageSizeDefault = 50;
+export const listEventsQueryPageSizeMax = 200;
+export const listEventsQueryNamespaceMax = 64;
+export const listEventsQueryKeywordMax = 128;
+export const listEventsQueryIncludeArchivedDefault = false;
+export const ListEventsQueryParams = zod.strictObject({
+    page: zod
+        .int()
+        .min(1)
+        .max(listEventsQueryPageMax)
+        .default(listEventsQueryPageDefault)
+        .describe("1-based page number. Defaults to 1."),
+    page_size: zod
+        .int()
+        .min(1)
+        .max(listEventsQueryPageSizeMax)
+        .default(listEventsQueryPageSizeDefault)
+        .describe("Items per page. Defaults to 50; at most 200."),
+    namespace: zod
+        .string()
+        .max(listEventsQueryNamespaceMax)
+        .optional()
+        .describe("Return only events in this namespace; omit for all namespaces"),
+    keyword: zod
+        .string()
+        .max(listEventsQueryKeywordMax)
+        .optional()
+        .describe("Match the event name or description, case-insensitively"),
+    include_archived: zod
+        .boolean()
+        .default(listEventsQueryIncludeArchivedDefault)
+        .describe("Include archived events; defaults to false"),
+});
+/**
+ * Creates a project event with its first version. The name is unique within the project. The
+ * first segment of the name is the event's namespace and must not be a platform namespace.
+ * @summary Create an event definition
+ */
+export const CreateEventBody = CreateEventRequest;
+/**
+ * Returns the event and every version, newest first.
+ * @summary Get an event definition
+ */
+export const getEventPathEventNameMax = 128;
+export const getEventPathEventNameRegExp = new RegExp("^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$");
+export const GetEventParams = zod.strictObject({
+    eventName: zod
+        .string()
+        .max(getEventPathEventNameMax)
+        .regex(getEventPathEventNameRegExp)
+        .describe("The event's full name, such as `acme.order.created`"),
+});
+/**
+ * Changes the description, tags, or status. Only the fields present in the request are
+ * changed. An archived event stops accepting new messages; existing versions remain readable.
+ * @summary Update an event definition
+ */
+export const updateEventPathEventNameMax = 128;
+export const updateEventPathEventNameRegExp = new RegExp("^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$");
+export const UpdateEventParams = zod.strictObject({
+    eventName: zod
+        .string()
+        .max(updateEventPathEventNameMax)
+        .regex(updateEventPathEventNameRegExp)
+        .describe("The event's full name, such as `acme.order.created`"),
+});
+export const UpdateEventBody = UpdateEventRequest;
+/**
+ * Adds a version to an existing event. The version number must be greater than every existing
+ * version. A version number's schema may gain optional properties, but it may not remove or
+ * change existing ones; use a new version for a breaking change.
+ * @summary Add an event version
+ */
+export const createEventVersionPathEventNameMax = 128;
+export const createEventVersionPathEventNameRegExp = new RegExp("^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$");
+export const CreateEventVersionParams = zod.strictObject({
+    eventName: zod
+        .string()
+        .max(createEventVersionPathEventNameMax)
+        .regex(createEventVersionPathEventNameRegExp)
+        .describe("The event's full name, such as `acme.order.created`"),
+});
+export const CreateEventVersionBody = CreateVersionRequest;
+/**
+ * Returns one version of an event.
+ * @summary Get an event version
+ */
+export const getEventVersionPathEventNameMax = 128;
+export const getEventVersionPathEventNameRegExp = new RegExp("^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$");
+export const GetEventVersionParams = zod.strictObject({
+    eventName: zod
+        .string()
+        .max(getEventVersionPathEventNameMax)
+        .regex(getEventVersionPathEventNameRegExp)
+        .describe("The event's full name, such as `acme.order.created`"),
+    version: zod.int().min(1).describe("The version number, starting at 1"),
+});
+/**
+ * Validates the payload against the selected version and publishes the message. The response
+ * carries the message identity; it does not mean a consumer received it. A version of zero
+ * selects the highest active version.
+ * @summary Publish an event message
+ */
+export const publishEventPathEventNameMax = 128;
+export const publishEventPathEventNameRegExp = new RegExp("^[a-z](?:[a-z0-9_]*[a-z0-9])?(?:\\.[a-z](?:[a-z0-9_]*[a-z0-9])?){2,}$");
+export const PublishEventParams = zod.strictObject({
+    eventName: zod
+        .string()
+        .max(publishEventPathEventNameMax)
+        .regex(publishEventPathEventNameRegExp)
+        .describe("The event's full name, such as `acme.order.created`"),
+});
+export const PublishEventBody = PublishRequest;