@tailor-platform/sdk 1.72.0 → 1.73.0

package/dist/cli/commands/generate/types.d.mts

@@ -0,0 +1,126 @@
+import { PluginAttachment } from "../../../configure/services/tailordb/types.mjs";
+import { IdProvider, OAuth2Client } from "../../../types/auth.generated.mjs";
+import { PluginGeneratedTypeSource, TailorDBType, TypeSourceInfoEntry, UserDefinedTypeSource } from "../../../parser/service/tailordb/types.mjs";
+import { Executor } from "../../../types/executor.generated.mjs";
+import { Resolver } from "../../../types/resolver.generated.mjs";
+//#region src/cli/commands/generate/types.d.ts
+interface GeneratedFile {
+  path: string;
+  content: string;
+  skipIfExists?: boolean;
+  executable?: boolean;
+}
+interface GeneratorResult {
+  files: GeneratedFile[];
+  errors?: string[];
+}
+interface TailorDBNamespaceResult<T> {
+  namespace: string;
+  types: T;
+}
+interface ResolverNamespaceResult<R> {
+  namespace: string;
+  resolvers: R;
+}
+interface GeneratorAuthInput {
+  name: string;
+  userProfile?: {
+    typeName: string;
+    namespace: string;
+    usernameField: string;
+  };
+  machineUsers?: Record<string, {
+    attributes?: Record<string, unknown>;
+  }>;
+  oauth2Clients?: Record<string, OAuth2Client>;
+  idProvider?: IdProvider;
+}
+type DependencyKind = "tailordb" | "resolver" | "executor";
+type ArrayIncludes<T extends readonly unknown[], U> = T extends readonly [infer First, ...infer Rest] ? First extends U ? true : ArrayIncludes<Rest, U> : false;
+type HasDependency<Deps extends readonly DependencyKind[], D extends DependencyKind> = ArrayIncludes<Deps, D>;
+interface TailorDBProcessMethods<T, Ts> {
+  processType(args: {
+    type: TailorDBType;
+    namespace: string;
+    source: TypeSourceInfoEntry; /** Plugin attachments configured on this type via .plugin() method */
+    plugins: readonly PluginAttachment[];
+  }): T | Promise<T>;
+  processTailorDBNamespace?(args: {
+    namespace: string;
+    types: Record<string, T>;
+  }): Ts | Promise<Ts>;
+}
+interface ResolverProcessMethods<R, Rs> {
+  processResolver(args: {
+    resolver: Resolver;
+    namespace: string;
+  }): R | Promise<R>;
+  processResolverNamespace?(args: {
+    namespace: string;
+    resolvers: Record<string, R>;
+  }): Rs | Promise<Rs>;
+}
+interface ExecutorProcessMethods<E> {
+  processExecutor(executor: Executor): E | Promise<E>;
+}
+type SelectMethods<Deps extends readonly DependencyKind[], T, R, E, Ts, Rs> = (HasDependency<Deps, "tailordb"> extends true ? TailorDBProcessMethods<T, Ts> : object) & (HasDependency<Deps, "resolver"> extends true ? ResolverProcessMethods<R, Rs> : object) & (HasDependency<Deps, "executor"> extends true ? ExecutorProcessMethods<E> : object);
+interface TailorDBInputPart<Ts> {
+  tailordb: TailorDBNamespaceResult<Ts>[];
+}
+interface ResolverInputPart<Rs> {
+  resolver: ResolverNamespaceResult<Rs>[];
+}
+interface ExecutorInputPart<E> {
+  executor: E[];
+}
+interface AuthPart {
+  auth?: GeneratorAuthInput;
+}
+type SelectInput<Deps extends readonly DependencyKind[], Ts, Rs, E> = (HasDependency<Deps, "tailordb"> extends true ? TailorDBInputPart<Ts> : object) & (HasDependency<Deps, "resolver"> extends true ? ResolverInputPart<Rs> : object) & (HasDependency<Deps, "executor"> extends true ? ExecutorInputPart<E> : object) & AuthPart;
+/** Input type for TailorDB-only generators */
+type TailorDBInput<Ts> = TailorDBInputPart<Ts> & AuthPart;
+/** Input type for Resolver-only generators */
+type ResolverInput<Rs> = ResolverInputPart<Rs> & AuthPart;
+/** Input type for Executor-only generators */
+type ExecutorInput<E> = ExecutorInputPart<E> & AuthPart;
+/** Input type for full generators (TailorDB + Resolver + Executor) */
+type FullInput<Ts, Rs, E> = TailorDBInputPart<Ts> & ResolverInputPart<Rs> & ExecutorInputPart<E> & AuthPart;
+/** Arguments type for aggregate method */
+interface AggregateArgs<Input> {
+  input: Input;
+  baseDir: string;
+  configPath: string;
+}
+interface CodeGeneratorCore {
+  readonly id: string;
+  readonly description: string;
+}
+/**
+ * Generator interface with dependencies-based conditional methods.
+ * @template Deps - Dependencies array (e.g., ['tailordb'], ['tailordb', 'resolver'])
+ * @template T - Return type of processType
+ * @template R - Return type of processResolver
+ * @template E - Return type of processExecutor
+ * @template Ts - Return type of processTailorDBNamespace (default: Record<string, T>)
+ * @template Rs - Return type of processResolverNamespace (default: Record<string, R>)
+ */
+type CodeGenerator<Deps extends readonly DependencyKind[], T = unknown, R = unknown, E = unknown, Ts = Record<string, T>, Rs = Record<string, R>> = CodeGeneratorCore & SelectMethods<Deps, T, R, E, Ts, Rs> & {
+  readonly dependencies: Deps;
+  aggregate(args: {
+    input: SelectInput<Deps, Ts, Rs, E>;
+    baseDir: string;
+    configPath: string;
+  }): GeneratorResult | Promise<GeneratorResult>;
+};
+/** TailorDB-only generator */
+type TailorDBGenerator<T = unknown, Ts = Record<string, T>> = CodeGenerator<readonly ["tailordb"], T, never, never, Ts, never>;
+/** Resolver-only generator */
+type ResolverGenerator<R = unknown, Rs = Record<string, R>> = CodeGenerator<readonly ["resolver"], never, R, never, never, Rs>;
+/** Executor-only generator */
+type ExecutorGenerator<E = unknown> = CodeGenerator<readonly ["executor"], never, never, E, never, never>;
+/** TailorDB + Resolver generator */
+type TailorDBResolverGenerator<T = unknown, R = unknown, Ts = Record<string, T>, Rs = Record<string, R>> = CodeGenerator<readonly ["tailordb", "resolver"], T, R, never, Ts, Rs>;
+/** Full generator (all dependencies) */
+type FullCodeGenerator<T = unknown, R = unknown, E = unknown, Ts = Record<string, T>, Rs = Record<string, R>> = CodeGenerator<readonly ["tailordb", "resolver", "executor"], T, R, E, Ts, Rs>;
+//#endregion
+export { AggregateArgs, CodeGenerator, DependencyKind, ExecutorGenerator, ExecutorInput, ExecutorProcessMethods, FullCodeGenerator, FullInput, GeneratorAuthInput, GeneratorResult, HasDependency, type PluginAttachment, ResolverGenerator, ResolverInput, ResolverNamespaceResult, ResolverProcessMethods, TailorDBGenerator, TailorDBInput, TailorDBNamespaceResult, TailorDBProcessMethods, TailorDBResolverGenerator, type TypeSourceInfoEntry };

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

@@ -0,0 +1,27 @@
+import { Order } from "../../shared/args.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/machineuser/list.d.ts
+interface ListMachineUsersOptions {
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+  order?: Order;
+  limit?: number;
+}
+interface MachineUserInfo {
+  name: string;
+  clientId: string;
+  clientSecret: string;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+  attributes: Record<string, unknown>;
+}
+/**
+ * List machine users for the current application.
+ * @param options - Machine user listing options
+ * @returns List of machine users
+ */
+declare function listMachineUsers(options?: ListMachineUsersOptions): Promise<MachineUserInfo[]>;
+//#endregion
+export { ListMachineUsersOptions, MachineUserInfo, listMachineUsers };

package/dist/cli/commands/machineuser/token.d.mts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+
+//#region src/cli/commands/machineuser/token.d.ts
+interface GetMachineUserTokenOptions {
+  name?: string;
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+}
+interface MachineUserTokenInfo {
+  accessToken: string;
+  tokenType: string;
+  expiresAt: string;
+}
+/**
+ * Get a machine user access token for the current application.
+ * @param options - Token retrieval options
+ * @returns Machine user token info
+ */
+declare function getMachineUserToken(options: GetMachineUserTokenOptions): Promise<MachineUserTokenInfo>;
+//#endregion
+export { GetMachineUserTokenOptions, MachineUserTokenInfo, getMachineUserToken };

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

@@ -0,0 +1,18 @@
+import { OAuth2ClientCredentials } from "./transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/oauth2client/get.d.ts
+interface GetOAuth2ClientOptions {
+  name: string;
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+}
+/**
+ * Get OAuth2 client credentials for the current application.
+ * @param options - OAuth2 client lookup options
+ * @returns OAuth2 client credentials
+ */
+declare function getOAuth2Client(options: GetOAuth2ClientOptions): Promise<OAuth2ClientCredentials>;
+//#endregion
+export { GetOAuth2ClientOptions, getOAuth2Client };

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

@@ -0,0 +1,20 @@
+import { Order } from "../../shared/args.mjs";
+import { OAuth2ClientInfo } from "./transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/oauth2client/list.d.ts
+interface ListOAuth2ClientsOptions {
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+  order?: Order;
+  limit?: number;
+}
+/**
+ * List OAuth2 clients for the current application.
+ * @param options - OAuth2 client listing options
+ * @returns List of OAuth2 clients
+ */
+declare function listOAuth2Clients(options?: ListOAuth2ClientsOptions): Promise<OAuth2ClientInfo[]>;
+//#endregion
+export { ListOAuth2ClientsOptions, listOAuth2Clients };

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

@@ -0,0 +1,20 @@
+//#region src/cli/commands/oauth2client/transform.d.ts
+interface OAuth2ClientInfo {
+  name: string;
+  description: string;
+  clientId: string;
+  grantTypes: string[];
+  redirectUris: string[];
+  createdAt: Date | null;
+}
+interface OAuth2ClientCredentials {
+  name: string;
+  description: string;
+  clientId: string;
+  clientSecret: string;
+  grantTypes: string[];
+  redirectUris: string[];
+  createdAt: Date | null;
+}
+//#endregion
+export { OAuth2ClientCredentials, OAuth2ClientInfo };

package/dist/cli/commands/organization/folder/create.d.mts

@@ -0,0 +1,18 @@
+import { FolderInfo } from "../transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/folder/create.d.ts
+declare const createFolderOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  parentFolderId: z.ZodOptional<z.ZodString>;
+  name: z.ZodString;
+}, z.core.$strip>;
+type CreateFolderOptions = z.input<typeof createFolderOptionsSchema>;
+/**
+ * Create a new folder in an organization.
+ * @param options - Folder creation options
+ * @returns Created folder details
+ */
+declare function createFolder(options: CreateFolderOptions): Promise<FolderInfo>;
+//#endregion
+export { CreateFolderOptions, createFolder };

package/dist/cli/commands/organization/folder/delete.d.mts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+
+//#region src/cli/commands/organization/folder/delete.d.ts
+declare const deleteFolderOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  folderId: z.ZodUUID;
+}, z.core.$strip>;
+type DeleteFolderOptions = z.input<typeof deleteFolderOptionsSchema>;
+/**
+ * Delete a folder from an organization.
+ * @param options - Folder deletion options
+ * @returns Promise that resolves when deletion completes
+ */
+declare function deleteFolder(options: DeleteFolderOptions): Promise<void>;
+//#endregion
+export { DeleteFolderOptions, deleteFolder };

package/dist/cli/commands/organization/folder/get.d.mts

@@ -0,0 +1,17 @@
+import { FolderInfo } from "../transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/folder/get.d.ts
+declare const getFolderOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  folderId: z.ZodUUID;
+}, z.core.$strip>;
+type GetFolderOptions = z.input<typeof getFolderOptionsSchema>;
+/**
+ * Get detailed information about a folder.
+ * @param options - Folder get options
+ * @returns Folder details
+ */
+declare function getFolder(options: GetFolderOptions): Promise<FolderInfo>;
+//#endregion
+export { GetFolderOptions, getFolder };

package/dist/cli/commands/organization/folder/list.d.mts

@@ -0,0 +1,22 @@
+import { FolderListInfo } from "../transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/folder/list.d.ts
+declare const listFoldersOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  parentFolderId: z.ZodOptional<z.ZodString>;
+  order: z.ZodOptional<z.ZodEnum<{
+    asc: "asc";
+    desc: "desc";
+  }>>;
+  limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type ListFoldersOptions = z.input<typeof listFoldersOptionsSchema>;
+/**
+ * List folders in an organization.
+ * @param options - Folder listing options
+ * @returns List of folders
+ */
+declare function listFolders(options: ListFoldersOptions): Promise<FolderListInfo[]>;
+//#endregion
+export { ListFoldersOptions, listFolders };

package/dist/cli/commands/organization/folder/update.d.mts

@@ -0,0 +1,18 @@
+import { FolderInfo } from "../transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/folder/update.d.ts
+declare const updateFolderOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  folderId: z.ZodUUID;
+  name: z.ZodString;
+}, z.core.$strip>;
+type UpdateFolderOptions = z.input<typeof updateFolderOptionsSchema>;
+/**
+ * Update a folder's name.
+ * @param options - Folder update options
+ * @returns Updated folder details
+ */
+declare function updateFolder(options: UpdateFolderOptions): Promise<FolderInfo>;
+//#endregion
+export { UpdateFolderOptions, updateFolder };

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

@@ -0,0 +1,16 @@
+import { OrganizationInfo } from "./transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/get.d.ts
+declare const getOrganizationOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+}, z.core.$strip>;
+type GetOrganizationOptions = z.input<typeof getOrganizationOptionsSchema>;
+/**
+ * Get detailed information about an organization.
+ * @param options - Organization get options
+ * @returns Organization details
+ */
+declare function getOrganization(options: GetOrganizationOptions): Promise<OrganizationInfo>;
+//#endregion
+export { GetOrganizationOptions, getOrganization };

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

@@ -0,0 +1,15 @@
+import { UserOrganizationInfo } from "./transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/list.d.ts
+interface ListOrganizationsOptions {
+  limit?: number;
+}
+/**
+ * List organizations the current user belongs to.
+ * @param options - Organization listing options
+ * @returns List of user organizations
+ */
+declare function listOrganizations(options?: ListOrganizationsOptions): Promise<UserOrganizationInfo[]>;
+//#endregion
+export { ListOrganizationsOptions, listOrganizations };

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

@@ -0,0 +1,27 @@
+//#region src/cli/commands/organization/transform.d.ts
+interface UserOrganizationInfo {
+  organizationId: string;
+  organizationName: string;
+  rootFolderId: string;
+  rootFolderName: string;
+  displayName: string;
+}
+interface OrganizationInfo {
+  id: string;
+  name: string;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+}
+interface FolderListInfo {
+  id: string;
+  name: string;
+  organizationId: string;
+  parentFolderId: string;
+  hasChildren: boolean;
+  createdAt: Date | null;
+}
+interface FolderInfo extends FolderListInfo {
+  updatedAt: Date | null;
+}
+//#endregion
+export { FolderInfo, FolderListInfo, OrganizationInfo, UserOrganizationInfo };

package/dist/cli/commands/organization/tree.d.mts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+
+//#region src/cli/commands/organization/tree.d.ts
+interface OrganizationTreeOptions {
+  organizationId?: string;
+  depth?: number;
+}
+interface OrganizationTreeJson {
+  organizationId: string;
+  organizationName: string;
+  folders: FolderTreeJson[];
+}
+interface FolderTreeJson {
+  id: string;
+  name: string;
+  children: FolderTreeJson[];
+}
+/**
+ * Display a tree view of organizations and their folder hierarchy.
+ * @param options - Tree display options
+ * @returns Organization tree as structured data
+ */
+declare function organizationTree(options?: OrganizationTreeOptions): Promise<OrganizationTreeJson[]>;
+//#endregion
+export { OrganizationTreeOptions, organizationTree };

package/dist/cli/commands/organization/update.d.mts

@@ -0,0 +1,17 @@
+import { OrganizationInfo } from "./transform.mjs";
+import { z } from "zod";
+
+//#region src/cli/commands/organization/update.d.ts
+declare const updateOrganizationOptionsSchema: z.ZodObject<{
+  organizationId: z.ZodUUID;
+  name: z.ZodString;
+}, z.core.$strip>;
+type UpdateOrganizationOptions = z.input<typeof updateOrganizationOptionsSchema>;
+/**
+ * Update an organization's name.
+ * @param options - Organization update options
+ * @returns Updated organization details
+ */
+declare function updateOrganization(options: UpdateOrganizationOptions): Promise<OrganizationInfo>;
+//#endregion
+export { UpdateOrganizationOptions, updateOrganization };

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

@@ -0,0 +1,16 @@
+import { z } from "zod";
+
+//#region src/cli/commands/remove.d.ts
+interface RemoveOptions {
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+}
+/**
+ * Remove all resources managed by the current application.
+ * @param options - Remove options
+ * @returns Promise that resolves when removal completes
+ */
+declare function remove(options?: RemoveOptions): Promise<void>;
+//#endregion
+export { RemoveOptions, remove };

package/dist/cli/commands/show.d.mts

@@ -0,0 +1,34 @@
+import { z } from "zod";
+
+//#region src/cli/commands/show.d.ts
+interface ShowOptions {
+  workspaceId?: string;
+  profile?: string;
+  configPath?: string;
+}
+interface WorkspaceInfo {
+  workspaceId: string;
+  workspaceName: string;
+  workspaceFolderName?: string;
+  workspaceRegion?: string;
+}
+interface ApplicationInfo {
+  name: string;
+  domain: string;
+  url: string;
+  auth: string;
+  cors: string[];
+  allowedIpAddresses: string[];
+  disableIntrospection: boolean;
+  createdAt: Date | null;
+  updatedAt: Date | null;
+}
+interface ShowInfo extends ApplicationInfo, WorkspaceInfo {}
+/**
+ * Show applied application information for the current workspace.
+ * @param options - Show options
+ * @returns Application information
+ */
+declare function show(options?: ShowOptions): Promise<ShowInfo>;
+//#endregion
+export { ApplicationInfo, ShowInfo, ShowOptions, WorkspaceInfo, show };

package/dist/cli/commands/tailordb/migrate/bundler.d.mts

@@ -0,0 +1,28 @@
+//#region src/cli/commands/tailordb/migrate/bundler.d.ts
+/**
+ * Migration script bundler for TailorDB migrations
+ *
+ * Bundles migration scripts to be executed via TestExecScript API
+ */
+interface MigrationBundleResult {
+  namespace: string;
+  migrationNumber: number;
+  bundledCode: string;
+}
+/**
+ * Bundle a single migration script
+ *
+ * Creates an entry that:
+ * 1. Imports the migration script's main function
+ * 2. Defines getDB() function inline
+ * 3. Wraps migration in a transaction using getDB()
+ * 4. Exports as main() for TestExecScript
+ * @param {string} sourceFile - Path to the migration script file
+ * @param {string} namespace - TailorDB namespace
+ * @param {number} migrationNumber - Migration number
+ * @param {Record<string, string | number | boolean>} env - Environment variables to inject into the migration context
+ * @returns {Promise<MigrationBundleResult>} Bundled migration result
+ */
+declare function bundleMigrationScript(sourceFile: string, namespace: string, migrationNumber: number, env?: Record<string, string | number | boolean>): Promise<MigrationBundleResult>;
+//#endregion
+export { MigrationBundleResult, bundleMigrationScript };

package/dist/cli/commands/tailordb/migrate/config.d.mts

@@ -0,0 +1,19 @@
+import { AppConfig } from "../../../../configure/config/types.mjs";
+
+//#region src/cli/commands/tailordb/migrate/config.d.ts
+/**
+ * Namespace with migrations configuration
+ */
+interface NamespaceWithMigrations {
+  namespace: string;
+  migrationsDir: string;
+}
+/**
+ * Get namespaces that have migrations configured
+ * @param {AppConfig} config - Application configuration
+ * @param {string} configDir - Configuration directory path
+ * @returns {NamespaceWithMigrations[]} Array of namespaces with migrations configured
+ */
+declare function getNamespacesWithMigrations(config: AppConfig, configDir: string): NamespaceWithMigrations[];
+//#endregion
+export { NamespaceWithMigrations, getNamespacesWithMigrations };