@tailor-platform/sdk 2.36.0 → 2.38.0

package/dist/plugin/types.d.mts

@@ -10,10 +10,11 @@ interface GeneratedFile {
   path: string;
   content: string;
   skipIfExists?: boolean;
-  executable?: boolean;
 }
 /**
  * Result returned by generation-time hooks.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface GeneratorResult {
   files: GeneratedFile[];
@@ -37,6 +38,8 @@ export interface GeneratorAuthInput {
 }
 /**
  * Namespace-level TailorDB data available to generation-time hooks.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface TailorDBNamespaceData {
   /** Namespace name */
@@ -50,6 +53,8 @@ export interface TailorDBNamespaceData {
 }
 /**
  * Namespace-level resolver data available to generation-time hooks.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface ResolverNamespaceData {
   /** Namespace name */
@@ -59,6 +64,8 @@ export interface ResolverNamespaceData {
 }
 /**
  * Context passed to plugin's onTailorDBReady hook.
+ *
+ * **Beta:** This API may change in future releases.
  * @template PluginConfig - Plugin-level configuration type
  */
 export interface TailorDBReadyContext<PluginConfig = unknown> {
@@ -75,6 +82,8 @@ export interface TailorDBReadyContext<PluginConfig = unknown> {
 }
 /**
  * Context passed to plugin's onResolverReady hook.
+ *
+ * **Beta:** This API may change in future releases.
  * @template PluginConfig - Plugin-level configuration type
  */
 export interface ResolverReadyContext<PluginConfig = unknown> {
@@ -93,6 +102,8 @@ export interface ResolverReadyContext<PluginConfig = unknown> {
 }
 /**
  * Context passed to plugin's onExecutorReady hook.
+ *
+ * **Beta:** This API may change in future releases.
  * @template PluginConfig - Plugin-level configuration type
  */
 export interface ExecutorReadyContext<PluginConfig = unknown> {
@@ -116,6 +127,8 @@ export type TableConfigRequired<PluginConfig = unknown> = boolean | ((pluginConf
 /**
  * Interface for plugin configuration mapping.
  * Extend this interface via declaration merging to add typed plugin configs.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginConfigs<Fields extends string = string> {}
 /**
@@ -125,16 +138,22 @@ export interface PluginConfigs<Fields extends string = string> {}
  * by the same `id` used in {@link PluginConfigs}. The value must be a
  * `Record<string, TailorAnyDBField>` of the fields to add — it is merged
  * into the table's existing fields, not a replacement for them.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginFieldExtensions<Fields extends string = string, Config = unknown> {}
 /**
  * Registry mapping a plugin's `id` literal to its plugin-level config type.
  * Extend via declaration merging, keyed by the `id` string, from the
  * owning plugin's own module.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginConfigRegistry {}
 /**
  * Context passed to plugin's process method
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginTableProcessContext<TableConfig = unknown, PluginConfig = unknown> {
   table: TailorAnyDBType;
@@ -144,6 +163,8 @@ export interface PluginTableProcessContext<TableConfig = unknown, PluginConfig =
 }
 /**
  * Context passed to plugin's onNamespaceLoaded hook.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginNamespaceProcessContext<PluginConfig = unknown> {
   pluginConfig: PluginConfig;
@@ -151,13 +172,17 @@ export interface PluginNamespaceProcessContext<PluginConfig = unknown> {
 }
 /**
  * Interface representing a TailorDB table for plugin output.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface TailorDBTableForPlugin {
   readonly name: string;
   readonly fields: Record<string, unknown>;
 }
+/** **Beta:** This API may change in future releases. */
 export type PluginGeneratedTable = TailorDBTableForPlugin;
 type PluginGeneratedTables = Record<string, PluginGeneratedTable>;
+/** **Beta:** This API may change in future releases. */
 export interface PluginGeneratedResolver {
   name: string;
   operation: "query" | "mutation";
@@ -205,16 +230,19 @@ interface PluginWorkflowOperationConfig {
 }
 export type PluginOperationConfig = PluginFunctionOperationConfig | PluginGraphQLOperationConfig | PluginWebhookOperationConfig | PluginWorkflowOperationConfig;
 type PluginExecutorContextValue = TailorAnyDBType | string | number | boolean | null | undefined;
+/** **Beta:** This API may change in future releases. */
 export interface PluginExecutorContextBase {
   sourceTable: TailorAnyDBType | null;
   namespace: string;
 }
+/** **Beta:** This API may change in future releases. */
 export type PluginExecutorContext = PluginExecutorContextBase & {
   [key: string]: PluginExecutorContextValue;
 };
 interface PluginExecutorModule {
   default: unknown;
 }
+/** **Beta:** This API may change in future releases. */
 export interface PluginGeneratedExecutorWithFile<Ctx = PluginExecutorContext> {
   name: string;
   resolve: () => Promise<PluginExecutorModule>;
@@ -226,21 +254,27 @@ export interface PluginGeneratedExecutorLegacy {
   trigger: PluginTriggerConfig;
   operation: PluginOperationConfig;
 }
+/** **Beta:** This API may change in future releases. */
 export type PluginGeneratedExecutor = PluginGeneratedExecutorWithFile | PluginGeneratedExecutorLegacy;
 interface PluginExtends<FieldExtension extends Record<string, TailorAnyDBField>> {
   fields?: FieldExtension;
 }
+/** **Beta:** This API may change in future releases. */
 export interface PluginOutput {
   tables?: PluginGeneratedTables;
   resolvers?: PluginGeneratedResolver[];
   executors?: PluginGeneratedExecutor[];
 }
+/** **Beta:** This API may change in future releases. */
 export interface TablePluginOutput<FieldExtension extends Record<string, TailorAnyDBField> = Record<string, TailorAnyDBField>> extends PluginOutput {
   extends?: PluginExtends<FieldExtension>;
 }
+/** **Beta:** This API may change in future releases. */
 export type NamespacePluginOutput = PluginOutput;
 /**
  * Plugin interface that all plugins must implement.
+ *
+ * **Beta:** This API may change in future releases.
  * @template TableConfig - Type for per-table configuration passed via .plugin() method
  * @template PluginConfig - Type for plugin-level configuration passed via definePlugins()
  * @template FieldExtension - Type of the fields injected into the attached table via `extends.fields`. Should match the corresponding {@link PluginFieldExtensions} entry.
@@ -259,23 +293,31 @@ export interface Plugin<TableConfig = unknown, PluginConfig = unknown, FieldExte
   /** Runs after a successful deploy, including deploys with no resource changes. */
   onDeployed?(context: DeployedContext<PluginConfig>): void | DeployedHookResult | Promise<void | DeployedHookResult>;
 }
+/** **Beta:** This API may change in future releases. */
 export interface PublishStaticWebsiteResult {
   url: string;
   skippedFiles: string[];
 }
+/** **Beta:** This API may change in future releases. */
 export interface DeployedStaticWebsite {
   name: string;
   url: string;
 }
-/** A static website declared in the config that registers the plugin, which the plugin can publish to. */
+/**
+ * A static website declared in the config that registers the plugin, which the plugin can publish to.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface PublishableStaticWebsite extends DeployedStaticWebsite {
   /** Uploads the directory at the absolute path `dir` and publishes it to this website. */
   publish(dir: string): Promise<PublishStaticWebsiteResult>;
 }
+/** **Beta:** This API may change in future releases. */
 export interface DeployedOAuth2Client {
   name: string;
   clientId: string;
 }
+/** **Beta:** This API may change in future releases. */
 export interface DeployedApplication<StaticWebsite extends DeployedStaticWebsite = DeployedStaticWebsite> {
   /** SDK-managed application ID from defineConfig(); undefined when the config has none. */
   id?: string;
@@ -295,11 +337,13 @@ export interface DeployedApplication<StaticWebsite extends DeployedStaticWebsite
     oauth2Clients: DeployedOAuth2Client[];
   };
 }
+/** **Beta:** This API may change in future releases. */
 export interface PluginLogger {
   info(message: string): void;
   warn(message: string): void;
   success(message: string): void;
 }
+/** **Beta:** This API may change in future releases. */
 export interface PluginExecOptions {
   /** Directory to run the command in. */
   workingDir: string;
@@ -311,13 +355,18 @@ export interface PluginExecOptions {
    */
   output?: "stream" | "capture" | "ignore";
 }
+/** **Beta:** This API may change in future releases. */
 export interface PluginExecResult {
   /** Captured stdout. Empty unless `output` is `"capture"`. */
   stdout: string;
   /** Captured stderr. Empty unless `output` is `"capture"`. */
   stderr: string;
 }
-/** Values available after all applications in this deploy run have been applied. */
+/**
+ * Values available after all applications in this deploy run have been applied.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface DeployedContext<PluginConfig = unknown> {
   workspaceId: string;
   /** Application whose config registers this plugin. Only its static websites can be published. */
@@ -346,10 +395,13 @@ type OutputObject = object & {
 /**
  * A value a plugin hook can return in `outputs`. Interface-typed objects are accepted;
  * a `Date` or class instance nested inside one is rejected when the deploy runs.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export type PluginOutputValue = string | number | boolean | null | readonly PluginOutputValue[] | {
   [key: string]: PluginOutputValue;
 } | OutputObject;
+/** **Beta:** This API may change in future releases. */
 export interface DeployedHookResult {
   /** Values included in deploy's JSON result. Interface-typed values are accepted, but a `Date` or class instance nested inside one fails the deploy instead of the type check. */
   outputs?: Record<string, PluginOutputValue>;

package/dist/plugin/with-context.d.mts

@@ -3,11 +3,15 @@ import { TailorEnv, TailorPrincipal } from "../runtime/types.mjs";
  * Plugin executor factory function type.
  * Takes context and returns an executor configuration.
  * Returns unknown since the exact return type depends on createExecutor's generic params.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export type PluginExecutorFactory<Ctx> = (ctx: Ctx) => unknown;
 /**
  * Base args for plugin executor function operations.
  * Provides typed access to runtime context without requiring specific record types.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginFunctionArgs {
   /** Workspace ID where the executor runs */
@@ -25,6 +29,8 @@ export interface PluginFunctionArgs {
 }
 /**
  * Args for plugin executors triggered on record creation.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginRecordCreatedArgs extends PluginFunctionArgs {
   /** The newly created record */
@@ -32,6 +38,8 @@ export interface PluginRecordCreatedArgs extends PluginFunctionArgs {
 }
 /**
  * Args for plugin executors triggered on record update.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginRecordUpdatedArgs extends PluginFunctionArgs {
   /** The record after update */
@@ -41,6 +49,8 @@ export interface PluginRecordUpdatedArgs extends PluginFunctionArgs {
 }
 /**
  * Args for plugin executors triggered on record deletion.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PluginRecordDeletedArgs extends PluginFunctionArgs {
   /** The deleted record */
@@ -49,11 +59,15 @@ export interface PluginRecordDeletedArgs extends PluginFunctionArgs {
 /**
  * Database schema type for plugins.
  * Since plugins work with dynamic types, the schema uses Record types.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export type PluginDBSchema = Record<string, Record<string, unknown>>;
 /**
  * Base record type for TailorDB records.
  * All records have an id field.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export type PluginRecord = {
   id: string;
@@ -62,6 +76,8 @@ export type PluginRecord = {
  * Define a plugin executor that receives context at runtime.
  * This allows executor definitions to be in separate files while
  * still receiving dynamic values like typeName, generated types, and namespace.
+ *
+ * **Beta:** This API may change in future releases.
  * @param factory - Function that takes context and returns executor configuration
  * @returns The same factory function (for type inference)
  * @example