@alis-build/alis-open-flows-v1 1.11.0 → 1.13.0

package/alis/open/flows/v1/flows_pb.d.ts

@@ -1,7 +1,28 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/flows/v1/flows.proto (package alis.open.flows.v1, syntax proto3)
 /* eslint-disable */
 
+// Records the steps an API request goes through while it runs, so clients can
+// follow the progress of the underlying business logic.
+//
+// `FlowsService` exposes one resource:
+//
+// - `Flow` (`flows/{flow}`, where `{flow}` is 32 lowercase hex characters):
+//   the journey of one API request, identified by the method that produced it
+//   (`source`) and made up of `Flow.Step`s, each with its own `State`.
+//
+// Flows nest. A flow can be the child of a step in another flow, in which case
+// `parent_id` holds `{flow_id}-{step_id}`, the same format as the
+// `x-alis-flow-parent` header. `ListFlows` and `StreamFlows` return the flows
+// under a parent flow, or root flows when no parent is set. `GenerateFlowTree`
+// returns a flow with its descendants populated in the output-only
+// `Step.children`, plus the children of the leaf steps so the tree can be
+// expanded on demand.
+//
+// The service also consumes Pub/Sub push messages
+// (`alis.open.pubsub.v1.PubSubMessage`) through `HandleEvent` and
+// `HandleDeadLetter`.
+
 import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { EmptySchema, FieldMask, FieldMaskJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -13,80 +34,126 @@ import type { PubSubMessageSchema } from "@alis-build/alis-open-pubsub-v1/alis/o
 export declare const file_alis_open_flows_v1_flows: GenFile;
 
 /**
+ * A Flow represents the entire journey of an API request, from its initial receipt to the final
+ * response generation. It encapsulates the sequence of operations and transformations that
+ * occur during the processing of the request.
+ *
  * @generated from message alis.open.flows.v1.Flow
  */
 export declare type Flow = Message<"alis.open.flows.v1.Flow"> & {
   /**
+   * Identifies the particular flow message.
+   * Format: flows/0af7651916cd43dd8448eb211c80319c (32 lowercase hex characters)
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The fully qualified name of the method that produces the flow.
+   * Example: alis.os.resources.products.v1.ProductsService/CreateProduct
+   *
    * @generated from field: string source = 2;
    */
   source: string;
 
   /**
+   * A reference to the parent of the Flow.
+   * Within a current flow the header may contain the relevant parent in the header: `x-alis-flow-parent`
+   * Format: {flow_id}-{step_id}
+   * Header example: 0af7651916cd43dd8448eb211c80319c-0, represents step with id 0
+   *
    * @generated from field: string parent_id = 3;
    */
   parentId: string;
 
   /**
+   * A sequence of steps
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow.Step steps = 7;
    */
   steps: Flow_Step[];
 
   /**
+   * The time at which the Flow was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 97;
    */
   createTime?: Timestamp | undefined;
 
   /**
+   * The time at which the Flow was last updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 98;
    */
   updateTime?: Timestamp | undefined;
 
   /**
+   * The time at which the Flow was published.
+   *
    * @generated from field: google.protobuf.Timestamp publish_time = 99;
    */
   publishTime?: Timestamp | undefined;
 };
 
 /**
+ * A Flow represents the entire journey of an API request, from its initial receipt to the final
+ * response generation. It encapsulates the sequence of operations and transformations that
+ * occur during the processing of the request.
+ *
  * @generated from message alis.open.flows.v1.Flow
  */
 export declare type FlowJson = {
   /**
+   * Identifies the particular flow message.
+   * Format: flows/0af7651916cd43dd8448eb211c80319c (32 lowercase hex characters)
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The fully qualified name of the method that produces the flow.
+   * Example: alis.os.resources.products.v1.ProductsService/CreateProduct
+   *
    * @generated from field: string source = 2;
    */
   source?: string;
 
   /**
+   * A reference to the parent of the Flow.
+   * Within a current flow the header may contain the relevant parent in the header: `x-alis-flow-parent`
+   * Format: {flow_id}-{step_id}
+   * Header example: 0af7651916cd43dd8448eb211c80319c-0, represents step with id 0
+   *
    * @generated from field: string parent_id = 3;
    */
   parentId?: string;
 
   /**
+   * A sequence of steps
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow.Step steps = 7;
    */
   steps?: Flow_StepJson[];
 
   /**
+   * The time at which the Flow was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 97;
    */
   createTime?: TimestampJson;
 
   /**
+   * The time at which the Flow was last updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 98;
    */
   updateTime?: TimestampJson;
 
   /**
+   * The time at which the Flow was published.
+   *
    * @generated from field: google.protobuf.Timestamp publish_time = 99;
    */
   publishTime?: TimestampJson;
@@ -99,80 +166,142 @@ export declare type FlowJson = {
 export declare const FlowSchema: GenMessage<Flow, {jsonType: FlowJson}>;
 
 /**
+ * A Step is a single, distinct action or operation that contributes to the
+ * overall Flow. It's a building block of the larger process, representing
+ * a specific stage or task within the API's business logic.
+ *
  * @generated from message alis.open.flows.v1.Flow.Step
  */
 export declare type Flow_Step = Message<"alis.open.flows.v1.Flow.Step"> & {
   /**
+   * The unique name of the step.
+   * The Id is provided by the user at runtime and may be used to create structure
+   * within a set of steps, for example:
+   *  - 1 Prepare data
+   *  - 1.1 Approved by Operator
+   *  - 1.2 Approved by Manager
+   *  - 1 Validate data
+   *  - etc.
+   * Example: my_subprocess
+   * Example: 1.1
+   *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
+   * Title of the step.
+   *
    * @generated from field: string title = 2;
    */
   title: string;
 
   /**
+   * A short description of the step
+   *
    * @generated from field: string description = 3;
    */
   description: string;
 
   /**
+   * The state of the step
+   *
    * @generated from field: alis.open.flows.v1.Flow.Step.State state = 4;
    */
   state: Flow_Step_State;
 
   /**
+   * Flow children originating from this step.
+   * A step may have multiple children, each representing a different path or outcome.
+   *
+   * This field is OUTPUT ONLY and is not persisted in the database.
+   * It is only populated by the GenerateFlowTree method.
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow children = 8;
    */
   children: Flow[];
 
   /**
+   * The time at which the Step was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 9;
    */
   createTime?: Timestamp | undefined;
 
   /**
+   * The time at which the Step was updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 10;
    */
   updateTime?: Timestamp | undefined;
 };
 
 /**
+ * A Step is a single, distinct action or operation that contributes to the
+ * overall Flow. It's a building block of the larger process, representing
+ * a specific stage or task within the API's business logic.
+ *
  * @generated from message alis.open.flows.v1.Flow.Step
  */
 export declare type Flow_StepJson = {
   /**
+   * The unique name of the step.
+   * The Id is provided by the user at runtime and may be used to create structure
+   * within a set of steps, for example:
+   *  - 1 Prepare data
+   *  - 1.1 Approved by Operator
+   *  - 1.2 Approved by Manager
+   *  - 1 Validate data
+   *  - etc.
+   * Example: my_subprocess
+   * Example: 1.1
+   *
    * @generated from field: string id = 1;
    */
   id?: string;
 
   /**
+   * Title of the step.
+   *
    * @generated from field: string title = 2;
    */
   title?: string;
 
   /**
+   * A short description of the step
+   *
    * @generated from field: string description = 3;
    */
   description?: string;
 
   /**
+   * The state of the step
+   *
    * @generated from field: alis.open.flows.v1.Flow.Step.State state = 4;
    */
   state?: Flow_Step_StateJson;
 
   /**
+   * Flow children originating from this step.
+   * A step may have multiple children, each representing a different path or outcome.
+   *
+   * This field is OUTPUT ONLY and is not persisted in the database.
+   * It is only populated by the GenerateFlowTree method.
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow children = 8;
    */
   children?: FlowJson[];
 
   /**
+   * The time at which the Step was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 9;
    */
   createTime?: TimestampJson;
 
   /**
+   * The time at which the Step was updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 10;
    */
   updateTime?: TimestampJson;
@@ -185,46 +314,64 @@ export declare type Flow_StepJson = {
 export declare const Flow_StepSchema: GenMessage<Flow_Step, {jsonType: Flow_StepJson}>;
 
 /**
+ * The lifecycle state of a step.
+ *
  * @generated from enum alis.open.flows.v1.Flow.Step.State
  */
 export enum Flow_Step_State {
   /**
+   * State is not specified
+   *
    * @generated from enum value: STATE_UNSPECIFIED = 0;
    */
   STATE_UNSPECIFIED = 0,
 
   /**
+   * The step has been queued
+   *
    * @generated from enum value: QUEUED = 1;
    */
   QUEUED = 1,
 
   /**
+   * The step is in progress
+   *
    * @generated from enum value: IN_PROGRESS = 2;
    */
   IN_PROGRESS = 2,
 
   /**
+   * The step has been cancelled
+   *
    * @generated from enum value: CANCELLED = 3;
    */
   CANCELLED = 3,
 
   /**
+   * The step is complete
+   *
    * @generated from enum value: COMPLETED = 4;
    */
   COMPLETED = 4,
 
   /**
+   * The step failed
+   *
    * @generated from enum value: FAILED = 5;
    */
   FAILED = 5,
 
   /**
+   * The step is awaiting human review or input
+   *
    * @generated from enum value: AWAITING_INPUT = 6;
    */
   AWAITING_INPUT = 6,
 }
 
 /**
+ * The lifecycle state of a step.
+ *
  * @generated from enum alis.open.flows.v1.Flow.Step.State
  */
 export declare type Flow_Step_StateJson = "STATE_UNSPECIFIED" | "QUEUED" | "IN_PROGRESS" | "CANCELLED" | "COMPLETED" | "FAILED" | "AWAITING_INPUT";
@@ -235,30 +382,44 @@ export declare type Flow_Step_StateJson = "STATE_UNSPECIFIED" | "QUEUED" | "IN_P
 export declare const Flow_Step_StateSchema: GenEnum<Flow_Step_State, Flow_Step_StateJson>;
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/GetFlow]
+ *
  * @generated from message alis.open.flows.v1.GetFlowRequest
  */
 export declare type GetFlowRequest = Message<"alis.open.flows.v1.GetFlowRequest"> & {
   /**
+   * The name of the Flow resource
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/GetFlow]
+ *
  * @generated from message alis.open.flows.v1.GetFlowRequest
  */
 export declare type GetFlowRequestJson = {
   /**
+   * The name of the Flow resource
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMaskJson;
@@ -271,60 +432,104 @@ export declare type GetFlowRequestJson = {
 export declare const GetFlowRequestSchema: GenMessage<GetFlowRequest, {jsonType: GetFlowRequestJson}>;
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/ListFlows]
+ *
  * @generated from message alis.open.flows.v1.ListFlowsRequest
  */
 export declare type ListFlowsRequest = Message<"alis.open.flows.v1.ListFlowsRequest"> & {
   /**
+   * The name of the parent flow.
+   * If not set, fetches all root flows.
+   *
    * @generated from field: string parent = 1;
    */
   parent: string;
 
   /**
+   * The maximum number of flows to return.
+   * The service may return fewer than this value.
+   * If unspecified, at most 1000 flows will be returned.
+   * The maximum value is 1000; values above 1000 will be coerced to 1000.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize: number;
 
   /**
+   * The page token to use when requesting the next page of results.
+   * This is typically received from a previous `ListFlows` call.
+   * Provide this to retrieve the subsequent page.
+   *
+   * When paginating, all other parameters provided to `ListFlows` must match
+   * the call that provided the page token.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMask | undefined;
 
   /**
+   * Optional filter string to filter results.
+   *
    * @generated from field: string filter = 5;
    */
   filter: string;
 };
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/ListFlows]
+ *
  * @generated from message alis.open.flows.v1.ListFlowsRequest
  */
 export declare type ListFlowsRequestJson = {
   /**
+   * The name of the parent flow.
+   * If not set, fetches all root flows.
+   *
    * @generated from field: string parent = 1;
    */
   parent?: string;
 
   /**
+   * The maximum number of flows to return.
+   * The service may return fewer than this value.
+   * If unspecified, at most 1000 flows will be returned.
+   * The maximum value is 1000; values above 1000 will be coerced to 1000.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize?: number;
 
   /**
+   * The page token to use when requesting the next page of results.
+   * This is typically received from a previous `ListFlows` call.
+   * Provide this to retrieve the subsequent page.
+   *
+   * When paginating, all other parameters provided to `ListFlows` must match
+   * the call that provided the page token.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMaskJson;
 
   /**
+   * Optional filter string to filter results.
+   *
    * @generated from field: string filter = 5;
    */
   filter?: string;
@@ -337,30 +542,44 @@ export declare type ListFlowsRequestJson = {
 export declare const ListFlowsRequestSchema: GenMessage<ListFlowsRequest, {jsonType: ListFlowsRequestJson}>;
 
 /**
+ * Response message for [alis.open.flows.v1.FlowsService/ListFlows]
+ *
  * @generated from message alis.open.flows.v1.ListFlowsResponse
  */
 export declare type ListFlowsResponse = Message<"alis.open.flows.v1.ListFlowsResponse"> & {
   /**
+   * The list of Flows.
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow flows = 1;
    */
   flows: Flow[];
 
   /**
+   * The next page token.
+   * If empty, there are no more pages.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken: string;
 };
 
 /**
+ * Response message for [alis.open.flows.v1.FlowsService/ListFlows]
+ *
  * @generated from message alis.open.flows.v1.ListFlowsResponse
  */
 export declare type ListFlowsResponseJson = {
   /**
+   * The list of Flows.
+   *
    * @generated from field: repeated alis.open.flows.v1.Flow flows = 1;
    */
   flows?: FlowJson[];
 
   /**
+   * The next page token.
+   * If empty, there are no more pages.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken?: string;
@@ -373,30 +592,46 @@ export declare type ListFlowsResponseJson = {
 export declare const ListFlowsResponseSchema: GenMessage<ListFlowsResponse, {jsonType: ListFlowsResponseJson}>;
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/StreamFlows]
+ *
  * @generated from message alis.open.flows.v1.StreamFlowsRequest
  */
 export declare type StreamFlowsRequest = Message<"alis.open.flows.v1.StreamFlowsRequest"> & {
   /**
+   * The name of the parent flow.
+   * If not set, fetches all root flows.
+   *
    * @generated from field: string parent = 1;
    */
   parent: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/StreamFlows]
+ *
  * @generated from message alis.open.flows.v1.StreamFlowsRequest
  */
 export declare type StreamFlowsRequestJson = {
   /**
+   * The name of the parent flow.
+   * If not set, fetches all root flows.
+   *
    * @generated from field: string parent = 1;
    */
   parent?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMaskJson;
@@ -409,50 +644,80 @@ export declare type StreamFlowsRequestJson = {
 export declare const StreamFlowsRequestSchema: GenMessage<StreamFlowsRequest, {jsonType: StreamFlowsRequestJson}>;
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/GenerateFlowTree]
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeRequest
  */
 export declare type GenerateFlowTreeRequest = Message<"alis.open.flows.v1.GenerateFlowTreeRequest"> & {
   /**
+   * The fully qualified name of the parent Flow resource
+   * Format: flows/{flow_id}
+   * Example: flows/0af7651916cd43dd8448eb211c80319c
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The maximum depth of the tree to generate.
+   * The service may return fewer than this value.
+   * If unspecified, all levels up to a max of 20 will be returned.
+   *
    * @generated from field: int32 max_depth = 2;
    */
   maxDepth: number;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 3;
    */
   readMask?: FieldMask | undefined;
 
   /**
+   * Optional filter string to filter results.
+   *
    * @generated from field: string filter = 4;
    */
   filter: string;
 };
 
 /**
+ * Request message for [alis.open.flows.v1.FlowsService/GenerateFlowTree]
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeRequest
  */
 export declare type GenerateFlowTreeRequestJson = {
   /**
+   * The fully qualified name of the parent Flow resource
+   * Format: flows/{flow_id}
+   * Example: flows/0af7651916cd43dd8448eb211c80319c
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The maximum depth of the tree to generate.
+   * The service may return fewer than this value.
+   * If unspecified, all levels up to a max of 20 will be returned.
+   *
    * @generated from field: int32 max_depth = 2;
    */
   maxDepth?: number;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 3;
    */
   readMask?: FieldMaskJson;
 
   /**
+   * Optional filter string to filter results.
+   *
    * @generated from field: string filter = 4;
    */
   filter?: string;
@@ -465,30 +730,46 @@ export declare type GenerateFlowTreeRequestJson = {
 export declare const GenerateFlowTreeRequestSchema: GenMessage<GenerateFlowTreeRequest, {jsonType: GenerateFlowTreeRequestJson}>;
 
 /**
+ * Response message for [alis.open.flows.v1.FlowsService/GenerateFlowTree]
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeResponse
  */
 export declare type GenerateFlowTreeResponse = Message<"alis.open.flows.v1.GenerateFlowTreeResponse"> & {
   /**
+   * The root Flow.
+   *
    * @generated from field: alis.open.flows.v1.Flow flow = 1;
    */
   flow?: Flow | undefined;
 
   /**
+   * Steps with children.
+   * This field returns the next immediate children of the leaf nodes(steps at the max depth).
+   * This can be used to generate the next level of the tree on demand.
+   *
    * @generated from field: repeated alis.open.flows.v1.GenerateFlowTreeResponse.StepChildren step_children = 2;
    */
   stepChildren: GenerateFlowTreeResponse_StepChildren[];
 };
 
 /**
+ * Response message for [alis.open.flows.v1.FlowsService/GenerateFlowTree]
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeResponse
  */
 export declare type GenerateFlowTreeResponseJson = {
   /**
+   * The root Flow.
+   *
    * @generated from field: alis.open.flows.v1.Flow flow = 1;
    */
   flow?: FlowJson;
 
   /**
+   * Steps with children.
+   * This field returns the next immediate children of the leaf nodes(steps at the max depth).
+   * This can be used to generate the next level of the tree on demand.
+   *
    * @generated from field: repeated alis.open.flows.v1.GenerateFlowTreeResponse.StepChildren step_children = 2;
    */
   stepChildren?: GenerateFlowTreeResponse_StepChildrenJson[];
@@ -501,30 +782,48 @@ export declare type GenerateFlowTreeResponseJson = {
 export declare const GenerateFlowTreeResponseSchema: GenMessage<GenerateFlowTreeResponse, {jsonType: GenerateFlowTreeResponseJson}>;
 
 /**
+ * Step children.
+ * Provides the children of a step.
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeResponse.StepChildren
  */
 export declare type GenerateFlowTreeResponse_StepChildren = Message<"alis.open.flows.v1.GenerateFlowTreeResponse.StepChildren"> & {
   /**
+   * The id of the step
+   * Format: {flow_id}-{step_id}
+   *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
+   * The names of the children
+   * Format: [flows/{flow_id}]
+   *
    * @generated from field: repeated string children = 2;
    */
   children: string[];
 };
 
 /**
+ * Step children.
+ * Provides the children of a step.
+ *
  * @generated from message alis.open.flows.v1.GenerateFlowTreeResponse.StepChildren
  */
 export declare type GenerateFlowTreeResponse_StepChildrenJson = {
   /**
+   * The id of the step
+   * Format: {flow_id}-{step_id}
+   *
    * @generated from field: string id = 1;
    */
   id?: string;
 
   /**
+   * The names of the children
+   * Format: [flows/{flow_id}]
+   *
    * @generated from field: repeated string children = 2;
    */
   children?: string[];
@@ -537,10 +836,18 @@ export declare type GenerateFlowTreeResponse_StepChildrenJson = {
 export declare const GenerateFlowTreeResponse_StepChildrenSchema: GenMessage<GenerateFlowTreeResponse_StepChildren, {jsonType: GenerateFlowTreeResponse_StepChildrenJson}>;
 
 /**
+ * Manages Flow resources with an API service.
+ *
+ * When an API wants to communicate more details on the progress or steps while running,
+ * this service would be used by clients to retrieve the Flow resources which will provide
+ * additional details on the underlying business logic.
+ *
  * @generated from service alis.open.flows.v1.FlowsService
  */
 export declare const FlowsService: GenService<{
   /**
+   * Get a Flow resource
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.GetFlow
    */
   getFlow: {
@@ -549,6 +856,8 @@ export declare const FlowsService: GenService<{
     output: typeof FlowSchema;
   },
   /**
+   * Lists Flows.
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.ListFlows
    */
   listFlows: {
@@ -557,6 +866,9 @@ export declare const FlowsService: GenService<{
     output: typeof ListFlowsResponseSchema;
   },
   /**
+   * Streams Flows under a parent flow, or root flows when no parent is set,
+   * as a server stream of `Flow` messages.
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.StreamFlows
    */
   streamFlows: {
@@ -565,6 +877,12 @@ export declare const FlowsService: GenService<{
     output: typeof FlowSchema;
   },
   /**
+   * Generate a tree of Flows and Steps.
+   * This method returns a single Flow resource but with the Flow children populated.
+   *
+   * The response also includes the next immediate children of the leaf nodes(steps at the max depth).
+   * This can be used to generate the next level of the tree on demand.
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.GenerateFlowTree
    */
   generateFlowTree: {
@@ -573,6 +891,8 @@ export declare const FlowsService: GenService<{
     output: typeof GenerateFlowTreeResponseSchema;
   },
   /**
+   * Handles an event from Pub/Sub
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.HandleEvent
    */
   handleEvent: {
@@ -581,6 +901,8 @@ export declare const FlowsService: GenService<{
     output: typeof EmptySchema;
   },
   /**
+   * Handles a dead letter event from Pub/Sub
+   *
    * @generated from rpc alis.open.flows.v1.FlowsService.HandleDeadLetter
    */
   handleDeadLetter: {

package/alis/open/flows/v1/flows_pb.js

@@ -1,7 +1,28 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/flows/v1/flows.proto (package alis.open.flows.v1, syntax proto3)
 /* eslint-disable */
 
+// Records the steps an API request goes through while it runs, so clients can
+// follow the progress of the underlying business logic.
+//
+// `FlowsService` exposes one resource:
+//
+// - `Flow` (`flows/{flow}`, where `{flow}` is 32 lowercase hex characters):
+//   the journey of one API request, identified by the method that produced it
+//   (`source`) and made up of `Flow.Step`s, each with its own `State`.
+//
+// Flows nest. A flow can be the child of a step in another flow, in which case
+// `parent_id` holds `{flow_id}-{step_id}`, the same format as the
+// `x-alis-flow-parent` header. `ListFlows` and `StreamFlows` return the flows
+// under a parent flow, or root flows when no parent is set. `GenerateFlowTree`
+// returns a flow with its descendants populated in the output-only
+// `Step.children`, plus the children of the leaf steps so the tree can be
+// expanded on demand.
+//
+// The service also consumes Pub/Sub push messages
+// (`alis.open.pubsub.v1.PubSubMessage`) through `HandleEvent` and
+// `HandleDeadLetter`.
+
 import { enumDesc, fileDesc, messageDesc, serviceDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
 import { file_alis_open_pubsub_v1_pubsub } from "@alis-build/alis-open-pubsub-v1/alis/open/pubsub/v1/pubsub_pb.js";
 import { file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
@@ -33,6 +54,8 @@ export const Flow_Step_StateSchema = /*@__PURE__*/
   enumDesc(file_alis_open_flows_v1_flows, 0, 0, 0);
 
 /**
+ * The lifecycle state of a step.
+ *
  * @generated from enum alis.open.flows.v1.Flow.Step.State
  */
 export const Flow_Step_State = /*@__PURE__*/
@@ -88,6 +111,12 @@ export const GenerateFlowTreeResponse_StepChildrenSchema = /*@__PURE__*/
   messageDesc(file_alis_open_flows_v1_flows, 6, 0);
 
 /**
+ * Manages Flow resources with an API service.
+ *
+ * When an API wants to communicate more details on the progress or steps while running,
+ * this service would be used by clients to retrieve the Flow resources which will provide
+ * additional details on the underlying business logic.
+ *
  * @generated from service alis.open.flows.v1.FlowsService
  */
 export const FlowsService = /*@__PURE__*/

package/package.json

@@ -25,5 +25,5 @@
   },
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.11.0"
+  "version": "1.13.0"
 }