@tailor-platform/sdk 2.0.0-next.0 → 2.0.0-next.10

package/dist/cli/commands/workflow/get.d.mts

@@ -0,0 +1,30 @@
+import "../../../tailor-proto/src/tailor/v1/workflow_resource_pb.mjs";
+import "../../shared/client.mjs";
+import { WorkflowInfo } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workflow/get.d.ts
+type WorkflowLike = {
+  name: string;
+};
+type GetWorkflowTypedOptions<W extends WorkflowLike = WorkflowLike> = {
+  workflow: W;
+  workspaceId?: string;
+  profile?: string;
+};
+/**
+ * @deprecated Use GetWorkflowTypedOptions instead.
+ */
+interface GetWorkflowOptions {
+  name: string;
+  workspaceId?: string;
+  profile?: string;
+}
+/**
+ * Get a workflow by name and return CLI-friendly info.
+ * @param options - Workflow lookup options
+ * @returns Workflow information
+ */
+declare function getWorkflow<W extends WorkflowLike>(options: GetWorkflowTypedOptions<W>): Promise<WorkflowInfo>;
+declare function getWorkflow(options: GetWorkflowOptions): Promise<WorkflowInfo>;
+//#endregion
+export { GetWorkflowOptions, GetWorkflowTypedOptions, getWorkflow };

package/dist/cli/commands/workflow/list.d.mts

@@ -0,0 +1,18 @@
+import { Order } from "../../shared/args.mjs";
+import { WorkflowListInfo } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workflow/list.d.ts
+interface ListWorkflowsOptions {
+  workspaceId?: string;
+  profile?: string;
+  order?: Order;
+  limit?: number;
+}
+/**
+ * List workflows in the workspace and return CLI-friendly info.
+ * @param options - Workflow listing options
+ * @returns List of workflows
+ */
+declare function listWorkflows(options?: ListWorkflowsOptions): Promise<WorkflowListInfo[]>;
+//#endregion
+export { ListWorkflowsOptions, listWorkflows };

package/dist/cli/commands/workflow/resume.d.mts

@@ -0,0 +1,22 @@
+import { WorkflowWaitResult } from "./waiter.mjs";
+import { WaitOptions } from "./start.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workflow/resume.d.ts
+interface ResumeWorkflowOptions {
+  executionId: string;
+  workspaceId?: string;
+  profile?: string;
+  interval?: number;
+}
+interface ResumeWorkflowResultWithWait {
+  executionId: string;
+  wait: (options?: WaitOptions) => Promise<WorkflowWaitResult>;
+}
+/**
+ * Resume a suspended workflow execution and return a handle to wait for completion.
+ * @param options - Resume options
+ * @returns Resume result with wait helper
+ */
+declare function resumeWorkflow(options: ResumeWorkflowOptions): Promise<ResumeWorkflowResultWithWait>;
+//#endregion
+export { ResumeWorkflowOptions, ResumeWorkflowResultWithWait, resumeWorkflow };

package/dist/cli/commands/workflow/start.d.mts

@@ -0,0 +1,60 @@
+import { WorkflowWaitUntil } from "./status.mjs";
+import { WorkflowWaitResult } from "./waiter.mjs";
+import { Jsonifiable } from "type-fest";
+import { z } from "zod";
+import { MachineUserName } from "@tailor-platform/sdk";
+//#region src/cli/commands/workflow/start.d.ts
+type WorkflowLike = {
+  name: string;
+  mainJob: {
+    body: unknown;
+  };
+};
+type WorkflowInput<W extends WorkflowLike> = W extends WorkflowLike ? W["mainJob"]["body"] extends ((...args: infer Args) => unknown) ? Args[0] : never : never;
+type StartWorkflowArgOptionForSingleWorkflow<W extends WorkflowLike> = WorkflowLike extends W ? {
+  arg?: Jsonifiable;
+} : undefined extends WorkflowInput<W> ? {
+  arg?: WorkflowInput<W>;
+} : {
+  arg: WorkflowInput<W>;
+};
+type StartWorkflowArgOption<W extends WorkflowLike> = W extends WorkflowLike ? StartWorkflowArgOptionForSingleWorkflow<W> : never;
+/**
+ * @deprecated Use StartWorkflowTypedOptions instead.
+ */
+interface StartWorkflowOptions {
+  name: string;
+  machineUser?: string;
+  arg?: Jsonifiable;
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+  interval?: number;
+}
+type StartWorkflowTypedBaseOptions<W extends WorkflowLike> = {
+  workflow: W;
+  invoker: MachineUserName;
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+  interval?: number;
+};
+type StartWorkflowTypedOptions<W extends WorkflowLike = WorkflowLike> = W extends WorkflowLike ? StartWorkflowTypedBaseOptions<W> & StartWorkflowArgOption<W> : never;
+interface WaitOptions {
+  showProgress?: boolean;
+  timeout?: number;
+  until?: WorkflowWaitUntil;
+}
+interface StartWorkflowResultWithWait {
+  executionId: string;
+  wait: (options?: WaitOptions) => Promise<WorkflowWaitResult>;
+}
+/**
+ * Start a workflow and return a handle to wait for completion.
+ * @param options - Start options
+ * @returns Start result with wait helper
+ */
+declare function startWorkflow<W extends WorkflowLike>(options: StartWorkflowTypedOptions<W>): Promise<StartWorkflowResultWithWait>;
+declare function startWorkflow(options: StartWorkflowOptions): Promise<StartWorkflowResultWithWait>;
+//#endregion
+export { StartWorkflowOptions, StartWorkflowResultWithWait, StartWorkflowTypedOptions, WaitOptions, startWorkflow };

package/dist/cli/commands/workflow/status.d.mts

@@ -0,0 +1,6 @@
+import "../../../tailor-proto/src/tailor/v1/workflow_resource_pb.mjs";
+//#region src/cli/commands/workflow/status.d.ts
+type WorkflowWaitUntil = "success" | "suspended" | "terminal";
+type WorkflowExecutionStatusClass = "success" | "suspended" | "failure" | "transient";
+//#endregion
+export { WorkflowExecutionStatusClass, WorkflowWaitUntil };

package/dist/cli/commands/workflow/transform.d.mts

@@ -0,0 +1,34 @@
+import "../../../tailor-proto/src/tailor/v1/workflow_resource_pb.mjs";
+//#region src/cli/commands/workflow/transform.d.ts
+interface WorkflowListInfo {
+  name: string;
+  mainJob: string;
+  jobFunctions: number;
+  updatedAt: Date | null;
+}
+interface WorkflowInfo {
+  name: string;
+  id: string;
+  mainJob: string;
+  jobFunctions: Record<string, string>;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+}
+interface WorkflowJobExecutionInfo {
+  id: string;
+  stackedJobName: string;
+  status: string;
+  executionId: string;
+  startedAt: Date | null;
+  finishedAt: Date | null;
+}
+interface WorkflowExecutionInfo {
+  id: string;
+  workflowName: string;
+  status: string;
+  jobExecutions: number;
+  startedAt: Date | null;
+  finishedAt: Date | null;
+}
+//#endregion
+export { WorkflowExecutionInfo, WorkflowInfo, WorkflowJobExecutionInfo, WorkflowListInfo };

package/dist/cli/commands/workflow/wait.d.mts

@@ -0,0 +1,15 @@
+import { WaitWorkflowExecutionOptions, WorkflowWaitResult } from "./waiter.mjs";
+import { getWorkflowExecution } from "./executions.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workflow/wait.d.ts
+interface WorkflowWaitOutput extends WorkflowWaitResult {
+  jobDetails?: Awaited<ReturnType<typeof getWorkflowExecution>>["execution"]["jobDetails"];
+}
+/**
+ * Wait for an existing workflow execution by ID.
+ * @param options - Workflow wait options
+ * @returns Workflow wait result
+ */
+declare function waitWorkflowExecution(options: WaitWorkflowExecutionOptions): Promise<WorkflowWaitResult>;
+//#endregion
+export { WorkflowWaitOutput, waitWorkflowExecution };

package/dist/cli/commands/workflow/waiter.d.mts

@@ -0,0 +1,23 @@
+import "../../shared/client.mjs";
+import { WorkflowExecutionInfo } from "./transform.mjs";
+import { WorkflowExecutionStatusClass, WorkflowWaitUntil } from "./status.mjs";
+//#region src/cli/commands/workflow/waiter.d.ts
+interface WaitWorkflowExecutionOptions {
+  executionId: string;
+  workspaceId?: string;
+  profile?: string;
+  interval?: number;
+  timeout?: number;
+  until?: WorkflowWaitUntil;
+  showProgress?: boolean;
+  trackJobs?: boolean;
+}
+interface WorkflowWaitResult extends WorkflowExecutionInfo {
+  statusClass: WorkflowExecutionStatusClass | "unknown";
+  elapsedMs: number;
+  attempts: number;
+  timedOut: boolean;
+  lastError: string | null;
+}
+//#endregion
+export { WaitWorkflowExecutionOptions, WorkflowWaitResult };

package/dist/cli/commands/workspace/app/health.d.mts

@@ -0,0 +1,17 @@
+import { AppHealthInfo } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/app/health.d.ts
+declare const healthOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  name: z.ZodString;
+}, z.core.$strip>;
+type HealthOptions = z.input<typeof healthOptionsSchema>;
+/**
+ * Get application schema health status.
+ * @param options - Health check options
+ * @returns Application health information
+ */
+declare function getAppHealth(options: HealthOptions): Promise<AppHealthInfo>;
+//#endregion
+export { HealthOptions, getAppHealth };

package/dist/cli/commands/workspace/app/list.d.mts

@@ -0,0 +1,21 @@
+import { AppInfo } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/app/list.d.ts
+declare const listAppsOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  order: z.ZodOptional<z.ZodEnum<{
+    asc: "asc";
+    desc: "desc";
+  }>>;
+  limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+type ListAppsOptions = z.input<typeof listAppsOptionsSchema>;
+/**
+ * List applications in a workspace with an optional order and limit.
+ * @param options - Application listing options
+ * @returns List of applications
+ */
+declare function listApps(options: ListAppsOptions): Promise<AppInfo[]>;
+//#endregion
+export { ListAppsOptions, listApps };

package/dist/cli/commands/workspace/app/transform.d.mts

@@ -0,0 +1,20 @@
+import "../../../../tailor-proto/src/tailor/v1/application_resource_pb.mjs";
+import "../../../../tailor-proto/src/tailor/v1/application_pb.mjs";
+//#region src/cli/commands/workspace/app/transform.d.ts
+interface AppInfo {
+  name: string;
+  domain: string;
+  authNamespace: string;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+}
+interface AppHealthInfo {
+  name: string;
+  status: string;
+  currentServingSchemaUpdatedAt: Date | null;
+  lastAttemptStatus: string;
+  lastAttemptAt: Date | null;
+  lastAttemptError: string;
+}
+//#endregion
+export { AppHealthInfo, AppInfo };

package/dist/cli/commands/workspace/create.d.mts

@@ -0,0 +1,27 @@
+import "../../shared/client.mjs";
+import { WorkspaceInfo } from "./transform.mjs";
+import "../../shared/workspace-name.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/create.d.ts
+/**
+ * Schema for workspace creation options
+ * - name: 3-63 chars, lowercase alphanumeric and hyphens, cannot start/end with hyphen
+ * - organizationId, folderId: optional UUIDs
+ */
+declare const createWorkspaceOptionsSchema: z.ZodObject<{
+  name: z.ZodString;
+  region: z.ZodString;
+  deleteProtection: z.ZodOptional<z.ZodBoolean>;
+  organizationId: z.ZodOptional<z.ZodUUID>;
+  folderId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type CreateWorkspaceOptions = z.input<typeof createWorkspaceOptionsSchema>;
+/**
+ * Create a new workspace with the given options.
+ * @param options - Workspace creation options
+ * @returns Created workspace info
+ */
+declare function createWorkspace(options: CreateWorkspaceOptions): Promise<WorkspaceInfo>;
+//#endregion
+export { CreateWorkspaceOptions, createWorkspace };

package/dist/cli/commands/workspace/delete.d.mts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+//#region src/cli/commands/workspace/delete.d.ts
+declare const deleteWorkspaceOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodUUID;
+}, z.core.$strip>;
+type DeleteWorkspaceOptions = z.input<typeof deleteWorkspaceOptionsSchema>;
+/**
+ * Delete a workspace by ID.
+ * @param options - Workspace deletion options
+ * @returns Promise that resolves when deletion completes
+ */
+declare function deleteWorkspace(options: DeleteWorkspaceOptions): Promise<void>;
+//#endregion
+export { DeleteWorkspaceOptions, deleteWorkspace };

package/dist/cli/commands/workspace/get.d.mts

@@ -0,0 +1,16 @@
+import { WorkspaceDetails } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/get.d.ts
+declare const getWorkspaceOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type GetWorkspaceOptions = z.input<typeof getWorkspaceOptionsSchema>;
+/**
+ * Get detailed information about a workspace.
+ * @param options - Workspace get options
+ * @returns Workspace details
+ */
+declare function getWorkspace(options: GetWorkspaceOptions): Promise<WorkspaceDetails>;
+//#endregion
+export { GetWorkspaceOptions, getWorkspace };

package/dist/cli/commands/workspace/list.d.mts

@@ -0,0 +1,17 @@
+import { WorkspaceInfo } from "./transform.mjs";
+import { Order } from "../../shared/args.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/list.d.ts
+interface ListWorkspacesOptions {
+  order?: Order;
+  limit?: number;
+  profile?: string;
+}
+/**
+ * List workspaces with an optional order and limit.
+ * @param options - Workspace listing options
+ * @returns List of workspaces
+ */
+declare function listWorkspaces(options?: ListWorkspacesOptions): Promise<WorkspaceInfo[]>;
+//#endregion
+export { ListWorkspacesOptions, listWorkspaces };

package/dist/cli/commands/workspace/restore.d.mts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+//#region src/cli/commands/workspace/restore.d.ts
+declare const restoreWorkspaceOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodUUID;
+}, z.core.$strip>;
+type RestoreWorkspaceOptions = z.input<typeof restoreWorkspaceOptionsSchema>;
+/**
+ * Restore a deleted workspace by ID.
+ * @param options - Workspace restore options
+ * @returns Promise that resolves when restoration completes
+ */
+declare function restoreWorkspace(options: RestoreWorkspaceOptions): Promise<void>;
+//#endregion
+export { RestoreWorkspaceOptions, restoreWorkspace };

package/dist/cli/commands/workspace/transform.d.mts

@@ -0,0 +1,20 @@
+import "../../../tailor-proto/src/tailor/v1/workspace_resource_pb.mjs";
+import "../../shared/client.mjs";
+//#region src/cli/commands/workspace/transform.d.ts
+interface WorkspaceInfo {
+  id: string;
+  name: string;
+  folderName?: string;
+  organizationId?: string;
+  folderId?: string;
+  region: string;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+}
+interface WorkspaceDetails extends WorkspaceInfo {
+  deleteProtection: boolean;
+  organizationId: string;
+  folderId: string;
+}
+//#endregion
+export { WorkspaceDetails, WorkspaceInfo };

package/dist/cli/commands/workspace/user/invite.d.mts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+//#region src/cli/commands/workspace/user/invite.d.ts
+declare const inviteUserOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  email: z.ZodEmail;
+  role: z.ZodEnum<{
+    admin: "admin";
+    editor: "editor";
+    viewer: "viewer";
+  }>;
+}, z.core.$strip>;
+type InviteUserOptions = z.input<typeof inviteUserOptionsSchema>;
+/**
+ * Invite a user to a workspace.
+ * @param options - User invite options
+ * @returns Promise that resolves when invitation is sent
+ */
+declare function inviteUser(options: InviteUserOptions): Promise<void>;
+//#endregion
+export { InviteUserOptions, inviteUser };

package/dist/cli/commands/workspace/user/list.d.mts

@@ -0,0 +1,21 @@
+import { UserInfo } from "./transform.mjs";
+import { z } from "zod";
+//#region src/cli/commands/workspace/user/list.d.ts
+declare const listUsersOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  order: z.ZodOptional<z.ZodEnum<{
+    asc: "asc";
+    desc: "desc";
+  }>>;
+  limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+type ListUsersOptions = z.input<typeof listUsersOptionsSchema>;
+/**
+ * List users in a workspace with an optional order and limit.
+ * @param options - User listing options
+ * @returns List of workspace users
+ */
+declare function listUsers(options: ListUsersOptions): Promise<UserInfo[]>;
+//#endregion
+export { ListUsersOptions, listUsers };

package/dist/cli/commands/workspace/user/remove.d.mts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+//#region src/cli/commands/workspace/user/remove.d.ts
+declare const removeUserOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  email: z.ZodString;
+}, z.core.$strip>;
+type RemoveUserOptions = z.input<typeof removeUserOptionsSchema>;
+/**
+ * Remove a user from a workspace.
+ * @param options - User remove options
+ * @returns Promise that resolves when removal completes
+ */
+declare function removeUser(options: RemoveUserOptions): Promise<void>;
+//#endregion
+export { RemoveUserOptions, removeUser };

package/dist/cli/commands/workspace/user/transform.d.mts

@@ -0,0 +1,9 @@
+import "../../../../tailor-proto/src/tailor/v1/workspace_resource_pb.mjs";
+//#region src/cli/commands/workspace/user/transform.d.ts
+interface UserInfo {
+  userId: string;
+  email: string;
+  role: string;
+}
+//#endregion
+export { UserInfo };

package/dist/cli/commands/workspace/user/update.d.mts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+//#region src/cli/commands/workspace/user/update.d.ts
+declare const updateUserOptionsSchema: z.ZodObject<{
+  workspaceId: z.ZodOptional<z.ZodUUID>;
+  profile: z.ZodOptional<z.ZodString>;
+  email: z.ZodString;
+  role: z.ZodEnum<{
+    admin: "admin";
+    editor: "editor";
+    viewer: "viewer";
+  }>;
+}, z.core.$strip>;
+type UpdateUserOptions = z.input<typeof updateUserOptionsSchema>;
+/**
+ * Update a user's role in a workspace.
+ * @param options - User update options
+ * @returns Promise that resolves when update completes
+ */
+declare function updateUser(options: UpdateUserOptions): Promise<void>;
+//#endregion
+export { UpdateUserOptions, updateUser };