@stripe/extensibility-dev-tools 0.23.5 → 0.24.2

package/dist/extensibility-dev-tools-workspace-beta.d.ts

@@ -1,51 +0,0 @@
-import { z } from 'zod';
-
-/* Excluded from this release type: _CliContext */
-
-/* Excluded from this release type: _CliUx */
-
-/* Excluded from this release type: _defaultServices */
-
-/* Excluded from this release type: _EndpointAuth */
-
-/* Excluded from this release type: _EndpointDefinition */
-
-/* Excluded from this release type: _PackageMetadata */
-
-/* Excluded from this release type: _regenAppProjectWorkspace */
-
-/* Excluded from this release type: _RegenWorkspaceOptions */
-
-/* Excluded from this release type: _regenWorkspaceOptionsSchema */
-
-/* Excluded from this release type: _resolvePackageMetadata */
-
-/* Excluded from this release type: _WorkspaceDependency */
-
-/* Excluded from this release type: _WorkspaceDependencyManager */
-
-/* Excluded from this release type: _WorkspaceExtensionConfig */
-
-/* Excluded from this release type: _WorkspaceFileWriteResult */
-
-/* Excluded from this release type: _WorkspaceFileWriterOptions */
-
-/* Excluded from this release type: _WorkspaceGeneratedFile */
-
-/* Excluded from this release type: _WorkspaceGenerateResult */
-
-/* Excluded from this release type: _WorkspaceManifest */
-
-/* Excluded from this release type: _WorkspaceOverwriteDecision */
-
-/* Excluded from this release type: _WorkspaceOverwritePromptCallback */
-
-/* Excluded from this release type: _WorkspacePendingChange */
-
-/* Excluded from this release type: _WorkspacePostGenerationHook */
-
-/* Excluded from this release type: _WorkspaceServices */
-
-/* Excluded from this release type: _WorkspaceWriteMode */
-
-export { }

package/dist/extensibility-dev-tools-workspace-internal.d.ts

@@ -1,410 +0,0 @@
-import { z } from 'zod';
-
-/**
- * Shared context threaded through CLI operations.
- *
- * Carry this through call chains so that output can be redirected in tests
- * without patching global `process.stdout`/`process.stderr`.
- *
- * @internal
- */
-declare interface _CliContext {
-    /** Output abstraction for writing to stdout/stderr. */
-    readonly ux: _CliUx;
-}
-
-/**
- * Thin output abstraction used by CLI entry points and the functions they call.
- *
- * Inject a `_CliUx` constructed with `PassThrough` streams in tests to capture
- * output without spying on `process.stdout`/`process.stderr`.
- *
- * @internal
- */
-declare class _CliUx {
-    #private;
-    constructor(options?: {
-        readonly stderr?: NodeJS.WritableStream;
-        readonly stdout?: NodeJS.WritableStream;
-    });
-    /** Write a product output line to stdout (or the configured stream). */
-    print(message: string): void;
-    /** Write a status/progress line to stderr (or the configured stream). */
-    log(message: string): void;
-    /**
-     * Error message to **stderr** (or the configured stderr stream).
-     *
-     * Behaviorally identical to {@link _CliUx.log} today. Use `error()` for failures
-     * and `log()` for progress/status — the distinction supports future
-     * formatting differentiation (color, prefixes, severity filtering).
-     */
-    error(message: string): void;
-}
-
-/**
- * Default workspace services using real filesystem and dependency implementations.
- * @internal
- */
-export declare const _defaultServices: _WorkspaceServices;
-
-/**
- * Authentication configuration for an endpoint.
- * @internal
- */
-declare interface _EndpointAuth {
-    /** The type of authentication. */
-    type: 'bearer_token' | 'header';
-    /** The name of the secret containing the authentication credential. */
-    secret_name: string;
-    /** The name of the header to use for authentication (required when type is 'header'). */
-    header_name?: string;
-}
-
-/**
- * Configuration for a single endpoint environment (live, test, managed_sandbox).
- * @internal
- */
-declare interface _EndpointDefinition {
-    /** The HTTPS URL of the endpoint. */
-    url?: string;
-    /** The purpose of the endpoint. */
-    purpose?: string;
-    /** Authentication configuration. */
-    auth?: _EndpointAuth;
-}
-
-/**
- * Package metadata (id, name, version)
- * @internal - Exported for testing only
- */
-export declare interface _PackageMetadata {
-    /** The package identifier (from package.json `name`). */
-    id: string;
-    /** Human-readable display name (from package.json `description`). */
-    name: string;
-    /** Package version string (from package.json `version`). */
-    version: string;
-}
-
-/**
- * Regenerate workspace files from templates
- *
- * @param options - Regeneration options
- * @param services - Injectable collaborators (defaults to real implementations)
- * @param context - CLI context for user-facing output. Defaults to a new context with standard stdout/stderr streams.
- *
- * @example
- * ```typescript
- * // Regenerate root workspace (scenario 1)
- * await regenAppProjectWorkspace({ packageDir: '.' });
- *
- * // Create new extension (scenario 2)
- * await regenAppProjectWorkspace({
- *   templateId: 'core.workflows.custom_action',
- *   workspaceId: 'my-ext',
- * });
- *
- * // Regenerate extension from its directory (scenario 3)
- * await regenAppProjectWorkspace({
- *   root: '../..',
- *   packageDir: '.',
- *   templateId: 'core.workflows.custom_action',
- * });
- *
- * // Regenerate extension from project root (scenario 4)
- * await regenAppProjectWorkspace({
- *   packageDir: 'extensions/my-ext',
- *   templateId: 'core.workflows.custom_action',
- * });
- *
- * // Ensure custom-objects workspace (scenario 5)
- * await regenAppProjectWorkspace({
- *   templateId: 'custom-objects',
- *   workspaceId: 'custom-objects',
- * });
- * ```
- * @internal
- */
-export declare function _regenAppProjectWorkspace(options: _RegenWorkspaceOptions, services?: _WorkspaceServices, context?: _CliContext): Promise<void>;
-
-/**
- * Options for regenerating a workspace from templates.
- * @internal
- */
-export declare type _RegenWorkspaceOptions = z.infer<typeof _regenWorkspaceOptionsSchema>;
-
-/**
- * Options for workspace regeneration
- * @internal
- */
-export declare const _regenWorkspaceOptionsSchema: z.ZodObject<{
-    force: z.ZodOptional<z.ZodBoolean>;
-    implementationType: z.ZodOptional<z.ZodEnum<{
-        "remote-function": "remote-function";
-        script: "script";
-    }>>;
-    name: z.ZodOptional<z.ZodString>;
-    packageDir: z.ZodOptional<z.ZodString>;
-    root: z.ZodOptional<z.ZodString>;
-    skipDependencies: z.ZodOptional<z.ZodBoolean>;
-    skipHooks: z.ZodOptional<z.ZodBoolean>;
-    templateId: z.ZodOptional<z.ZodString>;
-    workspaceId: z.ZodOptional<z.ZodString>;
-    workspaceName: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-
-/**
- * Resolve package ID, name, and version from options or package.json
- *
- * @param providedId - ID from options
- * @param providedName - Name from options (overrides package.json)
- * @param packageDir - Directory containing package.json, or undefined to skip reading
- * @returns Object with id, name, and version
- * @throws Error if ID cannot be determined, or if both providedId and package.json ID
- *         exist and differ
- * @internal - Exported for testing only
- */
-export declare function _resolvePackageMetadata(providedId: string | undefined, providedName: string | undefined, packageDir: string | undefined): Promise<_PackageMetadata>;
-
-/**
- * A dependency required by a workspace: runtime npm, dev npm, or Stripe CLI plugin.
- * @internal
- */
-export declare type _WorkspaceDependency = {
-    minVersion?: string;
-    name: string;
-    type: 'stripe-cli-plugin';
-} | {
-    name: string;
-    type: 'dev-npm';
-    version: string;
-} | {
-    name: string;
-    type: 'npm';
-    version: string;
-};
-
-/**
- * Interface for managing workspace dependency installation.
- * @internal
- */
-export declare interface _WorkspaceDependencyManager {
-    /** Analyze and queue the given dependencies for installation. */
-    ensureDependencies(input: {
-        optional?: _WorkspaceDependency[];
-        required: _WorkspaceDependency[];
-    }): Promise<_WorkspacePendingChange[]>;
-    /** Mark a conflicting dependency as resolved so it will be force-installed. */
-    resolveConflict(dep: _WorkspaceDependency): void;
-    /** Apply all queued dependency changes. */
-    commit(): Promise<unknown>;
-}
-
-/**
- * Extension configuration used by the workspace manifest interface.
- * @internal
- */
-export declare interface _WorkspaceExtensionConfig {
-    /** Extension identifier. */
-    id: string;
-    /** Human-readable extension name. */
-    name: string;
-    /** Extension interface ID. */
-    interface_id: string;
-    /** Extension version string. */
-    version: string;
-    /** Legacy entry point script path. */
-    script_entry_point?: string;
-    /** Inline script definition. */
-    script?: {
-        content: string;
-        type: string;
-    };
-    /** Required permissions for the extension. */
-    permissions: string[];
-    /** Method implementations keyed by method name. */
-    methods: Record<string, unknown>;
-    /** Optional configuration schemas. */
-    configuration?: {
-        input_schema: {
-            content: string;
-            type: 'json_schema' | 'jsonforms';
-        };
-        ui_schema: {
-            content: string;
-            type: 'json_schema' | 'jsonforms';
-        };
-    };
-    /** Remote function endpoints. */
-    endpoints?: {
-        id: string;
-        live?: _EndpointDefinition;
-        managed_sandbox?: _EndpointDefinition;
-        test?: _EndpointDefinition;
-        type: 'custom_http' | 'remote_function';
-    }[];
-}
-
-/**
- * Result of writing workspace files to disk.
- * @internal
- */
-export declare interface _WorkspaceFileWriteResult {
-    /** Paths of files that were written or overwritten. */
-    written: string[];
-    /** Paths of files that already existed and were not overwritten. */
-    existing: string[];
-    /** Whether all remaining files were skipped. */
-    skipped: boolean;
-    /** Whether the write operation was aborted by the user. */
-    aborted: boolean;
-}
-
-/**
- * Options for writing workspace generated files to disk.
- * @internal
- */
-export declare interface _WorkspaceFileWriterOptions {
-    /** Working directory to resolve file paths against. */
-    cwd?: string;
-    /** Controls how existing files are handled. */
-    write?: _WorkspaceWriteMode;
-    /** Called after a file is written or overwritten. */
-    onFileWritten?: (file: _WorkspaceGeneratedFile, wasOverwrite: boolean) => void;
-    /** Called when a file is skipped due to the write mode. */
-    onFileSkipped?: (file: _WorkspaceGeneratedFile) => void;
-    /** Called when a file is identical to the existing one on disk. */
-    onFileIdentical?: (file: _WorkspaceGeneratedFile) => void;
-}
-
-/**
- * A file generated by a workspace template.
- * @internal
- */
-export declare interface _WorkspaceGeneratedFile {
-    /** Path to the file, relative to the project root. */
-    path: string;
-    /** File content as a string. */
-    content: string;
-    /** If true, the file will never be overwritten even with `--force`. */
-    precious?: boolean;
-}
-
-/**
- * Result returned by a workspace template generator.
- * @internal
- */
-export declare interface _WorkspaceGenerateResult {
-    /** Files to write to disk. */
-    files: _WorkspaceGeneratedFile[];
-    /** Dependencies to install after file generation. */
-    dependencies?: {
-        dev?: _WorkspaceDependency[];
-        runtime?: _WorkspaceDependency[];
-    };
-    /** Hooks to run after dependencies are installed. */
-    postGenerationHooks?: _WorkspacePostGenerationHook[];
-    /** Methods configuration for the stripe-app.yaml extension entry. */
-    methods?: Record<string, unknown>;
-}
-
-/**
- * Interface for reading and writing the stripe-app.yaml manifest.
- * @internal
- */
-export declare interface _WorkspaceManifest {
-    /** Add a new extension or replace an existing one by ID; returns the extension ID. */
-    addOrUpdateExtension(config: _WorkspaceExtensionConfig): string;
-    /** Get a read-only view of all registered extensions. */
-    getExtensions(): readonly Readonly<_WorkspaceExtensionConfig>[];
-    /** Check whether a custom object entry is already registered in the manifest. */
-    hasCustomObject(entry: {
-        className: string;
-        filePath: string;
-    }): boolean;
-    /** Add a custom object entry to the manifest; returns true if added, false if already present. */
-    addCustomObject(entry: {
-        className: string;
-        filePath: string;
-    }): boolean;
-    /** Persist the manifest to disk. */
-    save(): Promise<void>;
-}
-
-/**
- * Decision returned by an overwrite prompt callback when a file already exists.
- * @internal
- */
-export declare type _WorkspaceOverwriteDecision = 'abort' | 'overwrite-all' | 'overwrite' | 'skip';
-
-/**
- * Callback invoked when a file to be written already exists, prompting for an overwrite decision.
- * @internal
- */
-export declare type _WorkspaceOverwritePromptCallback = (path: string, cwd: string, newContent: string) => Promise<_WorkspaceOverwriteDecision>;
-
-/**
- * A pending dependency change in the workspace dependency manager.
- * @internal
- */
-export declare interface _WorkspacePendingChange {
-    /** The dependency this change applies to. */
-    dependency: _WorkspaceDependency;
-    /** The action that will be taken. */
-    action: 'add' | 'already-satisfied' | 'conflict' | 'update';
-}
-
-/**
- * A post-generation hook to run after files are written: either a pnpm script or a direct exec.
- * @internal
- */
-export declare type _WorkspacePostGenerationHook = {
-    description?: string;
-    exec: string;
-} | {
-    description?: string;
-    script: string;
-};
-
-/**
- * Injectable collaborators for _regenAppProjectWorkspace.
- * Defaults to real implementations; override individual fields for testing.
- * @internal
- */
-export declare interface _WorkspaceServices {
-    /** Generate root workspace files from template variables. */
-    generateRoot: (vars: {
-        appId: string;
-        appName: string;
-        version: string;
-    }) => Promise<_WorkspaceGenerateResult>;
-    /** Generate extension workspace files for the given template key and variables. */
-    generateExtension: (key: string, vars: {
-        id: string;
-        name: string;
-        version: string;
-    }) => Promise<_WorkspaceGenerateResult>;
-    /** Write generated files to disk with the given options. */
-    writeFiles: (files: _WorkspaceGeneratedFile[], options?: _WorkspaceFileWriterOptions) => Promise<_WorkspaceFileWriteResult>;
-    /** Create a dependency manager scoped to the given working directory. */
-    createDepManager: (opts: {
-        context?: _CliContext;
-        cwd: string;
-    }) => _WorkspaceDependencyManager;
-    /** Generate custom object files (definition and test) from a name. */
-    generateCustomObject: (vars: { name: string }) => Promise<_WorkspaceGenerateResult>;
-    /** Generate the custom-objects workspace scaffolding (package.json, tsconfig.json). */
-    generateCustomObjectsWorkspace: (vars: { packagesSubfolder?: string }) => Promise<_WorkspaceGenerateResult>;
-    /** Load the stripe-app.yaml manifest from the given path. */
-    loadManifest: (manifestPath: string) => Promise<_WorkspaceManifest>;
-    /** Run post-generation hooks in the given working directory. */
-    runHooks: (hooks: _WorkspacePostGenerationHook[] | undefined, workingDir: string, disabled?: boolean, context?: _CliContext) => Promise<void>;
-}
-
-/**
- * Controls how the file writer handles existing files.
- * @internal
- */
-export declare type _WorkspaceWriteMode = _WorkspaceOverwritePromptCallback | 'abort-if-existing' | 'if-missing' | 'overwrite-all';
-
-export { }

package/dist/extensibility-dev-tools-workspace-public.d.ts

@@ -1,51 +0,0 @@
-import { z } from 'zod';
-
-/* Excluded from this release type: _CliContext */
-
-/* Excluded from this release type: _CliUx */
-
-/* Excluded from this release type: _defaultServices */
-
-/* Excluded from this release type: _EndpointAuth */
-
-/* Excluded from this release type: _EndpointDefinition */
-
-/* Excluded from this release type: _PackageMetadata */
-
-/* Excluded from this release type: _regenAppProjectWorkspace */
-
-/* Excluded from this release type: _RegenWorkspaceOptions */
-
-/* Excluded from this release type: _regenWorkspaceOptionsSchema */
-
-/* Excluded from this release type: _resolvePackageMetadata */
-
-/* Excluded from this release type: _WorkspaceDependency */
-
-/* Excluded from this release type: _WorkspaceDependencyManager */
-
-/* Excluded from this release type: _WorkspaceExtensionConfig */
-
-/* Excluded from this release type: _WorkspaceFileWriteResult */
-
-/* Excluded from this release type: _WorkspaceFileWriterOptions */
-
-/* Excluded from this release type: _WorkspaceGeneratedFile */
-
-/* Excluded from this release type: _WorkspaceGenerateResult */
-
-/* Excluded from this release type: _WorkspaceManifest */
-
-/* Excluded from this release type: _WorkspaceOverwriteDecision */
-
-/* Excluded from this release type: _WorkspaceOverwritePromptCallback */
-
-/* Excluded from this release type: _WorkspacePendingChange */
-
-/* Excluded from this release type: _WorkspacePostGenerationHook */
-
-/* Excluded from this release type: _WorkspaceServices */
-
-/* Excluded from this release type: _WorkspaceWriteMode */
-
-export { }