@tailor-platform/sdk 2.5.0 → 2.7.0

package/dist/cli/shared/args.d.mts

@@ -9,5 +9,75 @@ declare const orderArg: z.ZodEnum<{
   desc: "desc";
 }>;
 type Order = z.infer<typeof orderArg>;
+type EnvFileArg = string | string[] | undefined;
+/**
+ * Load env files from parsed arguments.
+ * Processes --env-file first, then --env-file-if-exists.
+ *
+ * Follows Node.js --env-file behavior:
+ * - Variables already set in the environment are NOT overwritten
+ * - Variables from later files override those from earlier files
+ * @param envFiles - Required env file path(s) that must exist
+ * @param envFilesIfExists - Optional env file path(s) that are loaded if they exist
+ */
+declare function loadEnvFiles(envFiles: EnvFileArg, envFilesIfExists: EnvFileArg): void;
+interface CommonArgsOptions {
+  /** Extra short alias for `--verbose` (e.g. `"v"`), for plugins that need one */
+  verboseAlias?: string;
+}
+/**
+ * Build the common arguments for all CLI commands. CLI plugins call this so
+ * their forwarded global flags parse identically to the host Tailor CLI and
+ * feed the same logger state.
+ *
+ * NOTE: --env-file and --env-file-if-exists collide with Node.js flags due to a bug
+ * (https://github.com/nodejs/node/issues/54232). Node.js parses these even after the
+ * script path, causing warnings (twice due to tsx loader).
+ * @param options - Per-plugin adjustments to the shared arguments
+ * @returns Argument shape suitable for spreading into a command schema
+ */
+declare function createCommonArgs(options?: CommonArgsOptions): {
+  "env-file": z.ZodOptional<z.ZodString>;
+  "env-file-if-exists": z.ZodOptional<z.ZodString>;
+  verbose: z.ZodDefault<z.ZodBoolean>;
+  json: z.ZodDefault<z.ZodBoolean>;
+};
+/**
+ * Common arguments for all CLI commands
+ */
+declare const commonArgs: {
+  "env-file": z.ZodOptional<z.ZodString>;
+  "env-file-if-exists": z.ZodOptional<z.ZodString>;
+  verbose: z.ZodDefault<z.ZodBoolean>;
+  json: z.ZodDefault<z.ZodBoolean>;
+};
+/**
+ * Arguments for commands that require workspace context
+ */
+declare const workspaceArgs: {
+  "workspace-id": z.ZodOptional<z.ZodString>;
+  profile: z.ZodOptional<z.ZodString>;
+};
+/**
+ * Shared config arg for commands that accept a config file path
+ */
+declare const configArg: {
+  config: z.ZodDefault<z.ZodString>;
+};
+/**
+ * Arguments for commands that interact with deployed resources (includes config)
+ */
+declare const deploymentArgs: {
+  config: z.ZodDefault<z.ZodString>;
+  "workspace-id": z.ZodOptional<z.ZodString>;
+  profile: z.ZodOptional<z.ZodString>;
+};
+/**
+ * Arguments for commands that require confirmation
+ */
+declare const confirmationArgs: {
+  yes: z.ZodDefault<z.ZodBoolean>;
+};
+type CommonArgsType = z.infer<z.ZodObject<typeof commonArgs>>;
 //#endregion
-export { Order, orderArg };
+export { CommonArgsType, Order, commonArgs, configArg, confirmationArgs, createCommonArgs, deploymentArgs, loadEnvFiles, orderArg, workspaceArgs };

package/dist/cli/shared/beta.d.mts

@@ -0,0 +1,8 @@
+//#region src/cli/shared/beta.d.ts
+/**
+ * Warn that a feature is in beta.
+ * @param {string} featureName - Name of the beta feature (e.g., "tailordb migration")
+ */
+declare function logBetaWarning(featureName: string): void;
+//#endregion
+export { logBetaWarning };

package/dist/cli/shared/client.d.mts

@@ -14,7 +14,7 @@ import { ListMeterAITokenUsagesRequestSchema, ListMeterAITokenUsagesResponseSche
 import { CreateIdPClientRequestSchema, CreateIdPClientResponseSchema, CreateIdPServiceRequestSchema, CreateIdPServiceResponseSchema, DeleteIdPClientRequestSchema, DeleteIdPClientResponseSchema, DeleteIdPServiceRequestSchema, DeleteIdPServiceResponseSchema, GetIdPClientRequestSchema, GetIdPClientResponseSchema, GetIdPServiceRequestSchema, GetIdPServiceResponseSchema, ListIdPClientsRequestSchema, ListIdPClientsResponseSchema, ListIdPServicesRequestSchema, ListIdPServicesResponseSchema, UpdateIdPServiceRequestSchema, UpdateIdPServiceResponseSchema } from "../../tailor-proto/src/tailor/v1/idp_pb.mjs";
 import { AddCustomDomainRequestSchema, AddCustomDomainResponseSchema, CreateDeploymentRequestSchema, CreateDeploymentResponseSchema, CreateStaticWebsiteRequestSchema, CreateStaticWebsiteResponseSchema, DeleteStaticWebsiteRequestSchema, DeleteStaticWebsiteResponseSchema, GetCustomDomainRequestSchema, GetCustomDomainResponseSchema, GetStaticWebsiteRequestSchema, GetStaticWebsiteResponseSchema, ListCustomDomainsRequestSchema, ListCustomDomainsResponseSchema, ListStaticWebsitesRequestSchema, ListStaticWebsitesResponseSchema, PublishDeploymentRequestSchema, PublishDeploymentResponseSchema, RemoveCustomDomainRequestSchema, RemoveCustomDomainResponseSchema, UpdateStaticWebsiteRequestSchema, UpdateStaticWebsiteResponseSchema, UploadFileRequestSchema, UploadFileResponseSchema } from "../../tailor-proto/src/tailor/v1/staticwebsite_pb.mjs";
 import { CreateWorkflowJobFunctionExecutionPolicyRequestSchema, CreateWorkflowJobFunctionExecutionPolicyResponseSchema, CreateWorkflowJobFunctionRequestSchema, CreateWorkflowJobFunctionResponseSchema, CreateWorkflowRequestSchema, CreateWorkflowResponseSchema, DeleteWorkflowJobFunctionExecutionPolicyRequestSchema, DeleteWorkflowJobFunctionExecutionPolicyResponseSchema, DeleteWorkflowJobFunctionRequestSchema, DeleteWorkflowJobFunctionResponseSchema, DeleteWorkflowRequestSchema, DeleteWorkflowResponseSchema, GetWorkflowByNameRequestSchema, GetWorkflowByNameResponseSchema, GetWorkflowExecutionRequestSchema, GetWorkflowExecutionResponseSchema, GetWorkflowJobFunctionByNameRequestSchema, GetWorkflowJobFunctionByNameResponseSchema, GetWorkflowJobFunctionExecutionPolicyByKeyRequestSchema, GetWorkflowJobFunctionExecutionPolicyByKeyResponseSchema, GetWorkflowJobFunctionExecutionPolicyRequestSchema, GetWorkflowJobFunctionExecutionPolicyResponseSchema, GetWorkflowJobFunctionRequestSchema, GetWorkflowJobFunctionResponseSchema, GetWorkflowRequestSchema, GetWorkflowResponseSchema, ListWorkflowExecutionsRequestSchema, ListWorkflowExecutionsResponseSchema, ListWorkflowJobFunctionExecutionPoliciesRequestSchema, ListWorkflowJobFunctionExecutionPoliciesResponseSchema, ListWorkflowJobFunctionsRequestSchema, ListWorkflowJobFunctionsResponseSchema, ListWorkflowsRequestSchema, ListWorkflowsResponseSchema, ResumeWorkflowExecutionRequestSchema, ResumeWorkflowExecutionResponseSchema, StartWorkflowRequestSchema, StartWorkflowResponseSchema, TestResumeWorkflowRequestSchema, TestResumeWorkflowResponseSchema, TestStartWorkflowRequestSchema, TestStartWorkflowResponseSchema, UpdateWorkflowJobFunctionExecutionPolicyRequestSchema, UpdateWorkflowJobFunctionExecutionPolicyResponseSchema, UpdateWorkflowJobFunctionRequestSchema, UpdateWorkflowJobFunctionResponseSchema, UpdateWorkflowRequestSchema, UpdateWorkflowResponseSchema } from "../../tailor-proto/src/tailor/v1/workflow_pb.mjs";
-import { GetMetadataRequestSchema, GetMetadataResponseSchema, SetMetadataRequestSchema, SetMetadataResponseSchema } from "../../tailor-proto/src/tailor/v1/metadata_pb.mjs";
+import { BulkSetMetadataRequestSchema, BulkSetMetadataResponseSchema, GetMetadataRequestSchema, GetMetadataResponseSchema, ListMetadataRequestSchema, ListMetadataResponseSchema, SetMetadataRequestSchema, SetMetadataResponseSchema } from "../../tailor-proto/src/tailor/v1/metadata_pb.mjs";
 import { CreateOTLPExporterRequestSchema, CreateOTLPExporterResponseSchema, CreateResourceAttributesConfigRequestSchema, CreateResourceAttributesConfigResponseSchema, DeleteOTLPExporterRequestSchema, DeleteOTLPExporterResponseSchema, DeleteResourceAttributesConfigRequestSchema, DeleteResourceAttributesConfigResponseSchema, GetOTLPExporterRequestSchema, GetOTLPExporterResponseSchema, GetResourceAttributesConfigRequestSchema, GetResourceAttributesConfigResponseSchema, ListOTLPExportersRequestSchema, ListOTLPExportersResponseSchema, TestOTLPExporterRequestSchema, TestOTLPExporterResponseSchema, UpdateOTLPExporterRequestSchema, UpdateOTLPExporterResponseSchema, UpdateResourceAttributesConfigRequestSchema, UpdateResourceAttributesConfigResponseSchema } from "../../tailor-proto/src/tailor/v1/telemetryrouter_pb.mjs";
 import { OperatorService, PingRequestSchema, PingResponseSchema } from "../../tailor-proto/src/tailor/v1/service_pb.mjs";
 import "@badgateway/oauth2-client";
@@ -1213,6 +1213,16 @@ declare function initOperatorClient(accessToken: string, config?: PlatformClient
     input: typeof GetMetadataRequestSchema;
     output: typeof GetMetadataResponseSchema;
   };
+  bulkSetMetadata: {
+    methodKind: "unary";
+    input: typeof BulkSetMetadataRequestSchema;
+    output: typeof BulkSetMetadataResponseSchema;
+  };
+  listMetadata: {
+    methodKind: "unary";
+    input: typeof ListMetadataRequestSchema;
+    output: typeof ListMetadataResponseSchema;
+  };
   createControlplaneMachineUser: {
     methodKind: "unary";
     input: typeof CreateControlplaneMachineUserRequestSchema;

package/dist/cli/shared/command.d.mts

@@ -0,0 +1,11 @@
+import { CommonArgsType } from "./args.mjs";
+import { createDefineCommand } from "politty";
+//#region src/cli/shared/command.d.ts
+/**
+ * defineCommand with global args type (CommonArgsType).
+ * Use this for leaf commands with `run` to get type-safe access to global args.
+ * Parent commands with only `subCommands` can use `defineCommand` from politty directly.
+ */
+declare const defineAppCommand: ReturnType<typeof createDefineCommand<CommonArgsType>>;
+//#endregion
+export { defineAppCommand };

package/dist/cli/shared/config.d.mts

@@ -0,0 +1,13 @@
+import { LoadedConfig } from "./config-loader.mjs";
+//#region src/cli/shared/config.d.ts
+/**
+ * Extracts namespace keys under `config.db` that this app owns
+ * (i.e. not declared with `{ external: true }`). Use this for destructive
+ * operations like `tailordb truncate --all` to avoid touching namespaces
+ * owned by other apps.
+ * @param config - Loaded application configuration.
+ * @returns Owned namespace names in insertion order.
+ */
+declare function extractOwnedNamespaces(config: LoadedConfig): string[];
+//#endregion
+export { extractOwnedNamespaces };

package/dist/cli/shared/context.d.mts

@@ -1,5 +1,5 @@
-import "./client.mjs";
 import "./args.mjs";
+import "./client.mjs";
 import { z } from "zod";
 //#region src/cli/shared/context.d.ts
 type LoadWorkspaceIdOptions = {

package/dist/cli/shared/logger.d.mts

@@ -0,0 +1,64 @@
+import { StyleFn } from "../../shared/src/color.mjs";
+//#region src/cli/shared/logger.d.ts
+/**
+ * Semantic style functions for inline text styling
+ */
+declare const styles: {
+  success: StyleFn;
+  error: StyleFn;
+  warning: StyleFn;
+  info: StyleFn;
+  create: StyleFn;
+  update: StyleFn;
+  delete: StyleFn;
+  replace: StyleFn;
+  unchanged: StyleFn;
+  bold: StyleFn;
+  dim: StyleFn;
+  highlight: StyleFn;
+  successBright: StyleFn;
+  errorBright: StyleFn;
+  resourceType: StyleFn;
+  resourceName: StyleFn;
+  path: StyleFn;
+  value: StyleFn;
+  placeholder: (text: string) => string;
+};
+/**
+ * Log output modes
+ */
+type LogMode = "default" | "stream" | "plain";
+interface LogOptions {
+  /** Output mode (default: "default") */
+  mode?: LogMode;
+  /** Number of spaces to indent the entire line (default: 0) */
+  indent?: number;
+}
+/** Field transformer function. null excludes the field from table output. */
+type FieldTransformer = ((value: unknown, item: object) => string) | null;
+interface OutOptions {
+  /** Table display field transform/exclude settings. Only applied in table mode (not JSON). */
+  display?: Record<string, FieldTransformer>;
+  /** Show null values in table output (default: false) */
+  showNull?: boolean;
+}
+/**
+ * The CLI logger. Diagnostics go to stderr; `out()` writes primary output to
+ * stdout as a table, or as JSON when `jsonMode` is on. `--json` and
+ * `--verbose` feed the `jsonMode` / `verbose` state, which CLI plugins share
+ * with the SDK code paths they call.
+ */
+declare const logger: {
+  jsonMode: boolean;
+  verbose: boolean;
+  info(message: string, opts?: LogOptions): void;
+  success(message: string, opts?: LogOptions): void;
+  warn(message: string, opts?: LogOptions): void;
+  error(message: string, opts?: LogOptions): void;
+  log(message: string): void;
+  newline(): void;
+  debug(message: string): void;
+  out(data: string | object | object[], options?: OutOptions): void;
+};
+//#endregion
+export { FieldTransformer, LogMode, LogOptions, OutOptions, logger, styles };

package/dist/cli/shared/prompt.d.mts

@@ -0,0 +1,53 @@
+//#region src/cli/shared/prompt.d.ts
+/** Options accepted by {@link prompt.confirm}. */
+interface ConfirmConfig {
+  message: string;
+  default?: boolean;
+}
+/** Options accepted by {@link prompt.text}. */
+interface TextConfig {
+  message: string;
+  default?: string;
+  required?: boolean;
+  validate?: (value: string) => boolean | string | Promise<boolean | string>;
+}
+/** Options accepted by {@link prompt.password}. */
+interface PasswordConfig {
+  message: string;
+  mask?: boolean | string;
+  validate?: (value: string) => boolean | string | Promise<boolean | string>;
+}
+/** A selectable entry of {@link SelectConfig.choices}. */
+interface SelectChoice<Value> {
+  value: Value;
+  name?: string;
+  description?: string;
+  short?: string;
+  disabled?: boolean | string;
+}
+/** Options accepted by {@link prompt.select}. */
+interface SelectConfig<Value> {
+  message: string;
+  choices: readonly SelectChoice<Value>[];
+  default?: NoInfer<Value>;
+  pageSize?: number;
+  loop?: boolean;
+}
+/**
+ * Interactive prompts that fail with an actionable message instead of hanging
+ * when stdin is not a TTY (CI, piped input), and exit with 130 on Ctrl-C.
+ *
+ * The config types are declared here rather than inferred from
+ * `@inquirer/prompts`: inference pulls `@inquirer/*` internals (`Context`,
+ * `Keybinding`, `PartialDeep`) into this public type, and those cannot be
+ * named portably from the published declarations (TS2883). They cover the
+ * options this CLI uses — widen them here when a call site needs more.
+ */
+declare const prompt: {
+  confirm: (config: ConfirmConfig) => Promise<boolean>;
+  text: (config: TextConfig) => Promise<string>;
+  password: (config: PasswordConfig) => Promise<string>;
+  select: <const Value>(config: SelectConfig<Value>) => Promise<Value>;
+};
+//#endregion
+export { ConfirmConfig, PasswordConfig, SelectChoice, SelectConfig, TextConfig, prompt };

package/dist/cli/shared/script-executor.d.mts

@@ -1,8 +1,8 @@
 import { AuthInvokerSchema } from "../../tailor-proto/src/tailor/v1/auth_resource_pb.mjs";
 import { FunctionExecution_Status } from "../../tailor-proto/src/tailor/v1/function_resource_pb.mjs";
 import { OperatorClient } from "./client.mjs";
-import { Jsonifiable } from "type-fest";
 import { MessageInitShape } from "@bufbuild/protobuf";
+import { Jsonifiable } from "type-fest";
 //#region src/cli/shared/script-executor.d.ts
 /** Authentication context for script execution, provided as a plain object. */
 type ScriptInvoker = MessageInitShape<typeof AuthInvokerSchema>;
@@ -53,7 +53,7 @@ interface ExecutionWaitResult {
  * Wait for a function execution to complete
  *
  * Polls the getFunctionExecution API until the execution reaches a terminal state
- * (SUCCESS or FAILED).
+ * (SUCCESS, FAILED, or CANCELED).
  * @param {OperatorClient} client - Operator client instance
  * @param {string} workspaceId - Workspace ID
  * @param {string} executionId - Execution ID to wait for

package/dist/cli/shared/workspace-name.d.mts

@@ -1 +1,10 @@
-import { z } from "zod";
+import { z } from "zod";
+//#region src/cli/shared/workspace-name.d.ts
+/**
+ * Validates a workspace name against the platform's naming rules: 3-63
+ * lowercase alphanumeric or hyphen characters, not starting or ending with a
+ * hyphen.
+ */
+declare const workspaceNameSchema: z.ZodString;
+//#endregion
+export { workspaceNameSchema };