@tailor-platform/sdk 2.0.0-next.2 → 2.0.0-next.4

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 };

package/dist/cli/commands/tailordb/migrate/diff-calculator.d.mts

@@ -0,0 +1,223 @@
+import { SnapshotFieldConfig, SnapshotGqlPermission, SnapshotIndexConfig, SnapshotRecordPermission, SnapshotRelationship, TailorDBSnapshotType } from "./snapshot-types.mjs";
+
+//#region src/cli/commands/tailordb/migrate/diff-calculator.d.ts
+/**
+ * Properties shared by all diff change variants
+ */
+interface DiffChangeBase {
+  typeName: string;
+  reason?: string;
+}
+/**
+ * Type-level settings patch carried by legacy `type_modified` changes.
+ * Current SDK versions no longer produce this kind, but persisted
+ * diff.json files written by older versions may still contain it.
+ */
+interface TypeSettingsPatch {
+  indexes?: Record<string, SnapshotIndexConfig>;
+  files?: Record<string, string>;
+}
+/** Type-level settings and metadata state used by current diffs. */
+interface SnapshotTypeSettingsState {
+  description?: string;
+  pluralForm: string;
+  settings?: TailorDBSnapshotType["settings"];
+}
+/**
+ * Permission state carried by `permission_modified` changes.
+ */
+interface SnapshotPermissionState {
+  recordPermission?: SnapshotRecordPermission;
+  gqlPermission?: SnapshotGqlPermission;
+}
+/** A new type was added to the schema. */
+interface TypeAddedChange extends DiffChangeBase {
+  kind: "type_added";
+  after: TailorDBSnapshotType;
+}
+/** An existing type was removed from the schema. */
+interface TypeRemovedChange extends DiffChangeBase {
+  kind: "type_removed";
+  before: TailorDBSnapshotType;
+}
+/**
+ * Legacy type-level settings change. Kept for backward compatibility with
+ * diff.json files written by older SDK versions; `before`/`after` may be
+ * absent in those files, hence optional.
+ */
+interface TypeModifiedChange extends DiffChangeBase {
+  kind: "type_modified";
+  before?: TypeSettingsPatch;
+  after?: TypeSettingsPatch;
+}
+/** Type-level settings or metadata changed. */
+interface TypeSettingsModifiedChange extends DiffChangeBase {
+  kind: "type_settings_modified";
+  before: SnapshotTypeSettingsState;
+  after: SnapshotTypeSettingsState;
+}
+/** A field was added to a type. */
+interface FieldAddedChange extends DiffChangeBase {
+  kind: "field_added";
+  fieldName: string;
+  after: SnapshotFieldConfig;
+}
+/** A field was removed from a type. */
+interface FieldRemovedChange extends DiffChangeBase {
+  kind: "field_removed";
+  fieldName: string;
+  before: SnapshotFieldConfig;
+}
+/** A field configuration was modified. */
+interface FieldModifiedChange extends DiffChangeBase {
+  kind: "field_modified";
+  fieldName: string;
+  before: SnapshotFieldConfig;
+  after: SnapshotFieldConfig;
+}
+/** An index was added to a type. */
+interface IndexAddedChange extends DiffChangeBase {
+  kind: "index_added";
+  indexName: string;
+  after: SnapshotIndexConfig;
+}
+/** An index was removed from a type. */
+interface IndexRemovedChange extends DiffChangeBase {
+  kind: "index_removed";
+  indexName: string;
+  before: SnapshotIndexConfig;
+}
+/** An index configuration was modified. */
+interface IndexModifiedChange extends DiffChangeBase {
+  kind: "index_modified";
+  indexName: string;
+  before: SnapshotIndexConfig;
+  after: SnapshotIndexConfig;
+}
+/** A file field was added to a type. `before`/`after` hold the description. */
+interface FileAddedChange extends DiffChangeBase {
+  kind: "file_added";
+  fieldName: string;
+  after: string;
+}
+/** A file field was removed from a type. */
+interface FileRemovedChange extends DiffChangeBase {
+  kind: "file_removed";
+  fieldName: string;
+  before: string;
+}
+/** A file field description was modified. */
+interface FileModifiedChange extends DiffChangeBase {
+  kind: "file_modified";
+  fieldName: string;
+  before: string;
+  after: string;
+}
+/**
+ * A relationship was added to a type. `relationshipType` is optional for
+ * backward compatibility: diff.json files written by older SDK versions
+ * predate the field.
+ */
+interface RelationshipAddedChange extends DiffChangeBase {
+  kind: "relationship_added";
+  relationshipName: string;
+  relationshipType?: "forward" | "backward";
+  after: SnapshotRelationship;
+}
+/** A relationship was removed from a type. */
+interface RelationshipRemovedChange extends DiffChangeBase {
+  kind: "relationship_removed";
+  relationshipName: string;
+  relationshipType?: "forward" | "backward";
+  before: SnapshotRelationship;
+}
+/** A relationship configuration was modified. */
+interface RelationshipModifiedChange extends DiffChangeBase {
+  kind: "relationship_modified";
+  relationshipName: string;
+  relationshipType?: "forward" | "backward";
+  before: SnapshotRelationship;
+  after: SnapshotRelationship;
+}
+/**
+ * Type-level permissions were modified. `before`/`after` are optional for
+ * robustness against hand-edited or legacy diff.json files; consumers guard
+ * on their presence.
+ */
+interface PermissionModifiedChange extends DiffChangeBase {
+  kind: "permission_modified";
+  before?: SnapshotPermissionState;
+  after?: SnapshotPermissionState;
+}
+/**
+ * Single change in migration diff, discriminated by `kind` so that
+ * `before`/`after` are typed per change kind.
+ */
+type DiffChange = TypeAddedChange | TypeRemovedChange | TypeModifiedChange | TypeSettingsModifiedChange | FieldAddedChange | FieldRemovedChange | FieldModifiedChange | IndexAddedChange | IndexRemovedChange | IndexModifiedChange | FileAddedChange | FileRemovedChange | FileModifiedChange | RelationshipAddedChange | RelationshipRemovedChange | RelationshipModifiedChange | PermissionModifiedChange;
+/**
+ * Migration diff - changes between two schema versions
+ * Stored as XXXX/diff.json (e.g., 0001/diff.json)
+ */
+interface MigrationDiff {
+  /** Format version for future compatibility */
+  version: number;
+  namespace: string;
+  createdAt: string;
+  description?: string;
+  changes: DiffChange[];
+  /** Whether there are breaking changes (data loss or constraint violations possible) */
+  hasBreakingChanges: boolean;
+  /** List of breaking changes */
+  breakingChanges: BreakingChangeInfo[];
+  /** Whether there are non-breaking changes that may cause data loss (e.g. field/type removal) */
+  hasWarnings: boolean;
+  /** List of non-breaking warnings */
+  warnings: WarningChangeInfo[];
+  /** Whether a migration script is required to handle data migration */
+  requiresMigrationScript: boolean;
+}
+/**
+ * Breaking change information in migration diff
+ */
+interface BreakingChangeInfo {
+  typeName: string;
+  fieldName?: string;
+  reason: string;
+  /** If true, this change is not supported and migration generation will fail */
+  unsupported?: boolean;
+  /** If true, show 3-step migration instructions for this unsupported change */
+  showThreeStepHint?: boolean;
+}
+/**
+ * Warning change information in migration diff.
+ *
+ * Warnings are non-breaking changes that may still cause data loss
+ * (e.g. removing a field or type). Unlike breaking changes, a migration
+ * script is not required, but writing one is recommended if you need to
+ * preserve or transform data before the change applies.
+ */
+interface WarningChangeInfo {
+  typeName: string;
+  fieldName?: string;
+  reason: string;
+}
+/**
+ * Check if a migration diff has any changes
+ * @param {MigrationDiff} diff - Migration diff to check
+ * @returns {boolean} True if diff has changes
+ */
+declare function hasChanges(diff: MigrationDiff): boolean;
+/**
+ * Format a migration diff for display
+ * @param {MigrationDiff} diff - Migration diff to format
+ * @returns {string} Formatted diff string
+ */
+declare function formatMigrationDiff(diff: MigrationDiff): string;
+/**
+ * Format a summary of the migration diff
+ * @param {MigrationDiff} diff - Migration diff to summarize
+ * @returns {string} Formatted summary string
+ */
+declare function formatDiffSummary(diff: MigrationDiff): string;
+//#endregion
+export { BreakingChangeInfo, DiffChange, FieldAddedChange, FieldModifiedChange, FieldRemovedChange, FileAddedChange, FileModifiedChange, FileRemovedChange, IndexAddedChange, IndexModifiedChange, IndexRemovedChange, MigrationDiff, PermissionModifiedChange, RelationshipAddedChange, RelationshipModifiedChange, RelationshipRemovedChange, SnapshotPermissionState, SnapshotTypeSettingsState, TypeAddedChange, TypeModifiedChange, TypeRemovedChange, TypeSettingsModifiedChange, TypeSettingsPatch, WarningChangeInfo, formatDiffSummary, formatMigrationDiff, hasChanges };

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

@@ -0,0 +1,17 @@
+import { z } from "zod";
+
+//#region src/cli/commands/tailordb/migrate/generate.d.ts
+interface GenerateOptions {
+  configPath?: string;
+  name?: string;
+  yes?: boolean;
+  init?: boolean;
+}
+/**
+ * Generate migration files for TailorDB schema changes
+ * @param {GenerateOptions} options - Generation options
+ * @returns {Promise<void>} Promise that resolves when generation is complete
+ */
+declare function generate(options: GenerateOptions): Promise<void>;
+//#endregion
+export { GenerateOptions, generate };