@stripe/extensibility-custom-objects-tools 0.40.0

package/dist/build/extract-schemas.d.ts

@@ -0,0 +1,17 @@
+import { type ActionSchemaResult, type BuildCustomObjectTarget, type BuildDiagnostic, type CustomObjectBuildResult, type CustomObjectPackageBuildResult } from './package-build.js';
+/**
+ * Options for extracting schemas from a custom object class export.
+ *
+ * @internal
+ */
+export type ExtractSchemasOptions = BuildCustomObjectTarget;
+export type { ActionSchemaResult, BuildDiagnostic, CustomObjectBuildResult, CustomObjectPackageBuildResult, };
+/**
+ * Extracts schemas from one custom object export.
+ *
+ * This is a convenience wrapper over the package-scoped builder.
+ *
+ * @internal
+ */
+export declare function extractCustomObjectSchemas(options: ExtractSchemasOptions): CustomObjectBuildResult;
+//# sourceMappingURL=extract-schemas.d.ts.map

package/dist/build/extract-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-schemas.d.ts","sourceRoot":"","sources":["../../src/build/extract-schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACpC,MAAM,oBAAoB,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAE5D,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,uBAAuB,EACvB,8BAA8B,GAC/B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,qBAAqB,GAC7B,uBAAuB,CAgCzB"}

package/dist/build/package-build.d.ts

@@ -0,0 +1,115 @@
+import * as ts from 'typescript';
+import { type JsonSchema2020, type UISchema } from '@formspec/build';
+/**
+ * One custom object export to include in a package-scoped build.
+ *
+ * @internal
+ */
+export interface BuildCustomObjectTarget {
+    modulePath: string;
+    exportName: string;
+}
+/**
+ * Diagnostic emitted while building custom object package artifacts.
+ *
+ * @internal
+ */
+export interface BuildDiagnostic {
+    severity: 'error' | 'warning';
+    code: string;
+    message: string;
+    modulePath?: string;
+    exportName?: string;
+}
+/**
+ * Platform naming metadata for one built custom object.
+ *
+ * @internal
+ */
+export interface CustomObjectPlatformMetadata {
+    modulePath: string;
+    className: string;
+    apiName: string;
+    displayName: string;
+    displayNamePlural: string;
+    apiNamePlural: string;
+}
+/**
+ * The JSON Schema and JSON Forms artifacts for one extracted surface.
+ *
+ * @internal
+ */
+export interface CustomObjectSchemaArtifacts {
+    jsonSchema: JsonSchema2020;
+    uiSchema: UISchema | null;
+}
+/**
+ * Schema artifacts extracted for one action method.
+ *
+ * @internal
+ */
+export interface ActionSchemaResult {
+    name: string;
+    methodName: string;
+    apiName: string;
+    input: CustomObjectSchemaArtifacts | null;
+    output: {
+        jsonSchema: JsonSchema2020;
+    };
+    paramsSchema: JsonSchema2020 | Record<string, never>;
+    returnSchema: JsonSchema2020;
+}
+/**
+ * Combined schema and metadata artifacts for one custom object export.
+ *
+ * @internal
+ */
+export interface CustomObjectBuildResult {
+    platformMetadata: CustomObjectPlatformMetadata;
+    fields: CustomObjectSchemaArtifacts;
+    fieldsSchema: JsonSchema2020;
+    fieldsUiSchema: UISchema | null;
+    actions: Record<string, ActionSchemaResult>;
+    primaryDisplayProperty?: string;
+    secondaryDisplayProperty?: string;
+}
+/**
+ * Backwards-compatible alias for the combined build artifact.
+ *
+ * @internal
+ */
+export type CustomObjectBuildArtifact = CustomObjectBuildResult;
+/**
+ * Package-scoped custom object build output.
+ *
+ * @internal
+ */
+export interface CustomObjectPackageBuildResult {
+    objects: Record<string, CustomObjectBuildResult>;
+    transformedModules: Record<string, string>;
+    diagnostics: BuildDiagnostic[];
+}
+/**
+ * Options for building a package-scoped custom object artifact set.
+ *
+ * @internal
+ */
+export interface BuildCustomObjectPackageOptions {
+    targets: BuildCustomObjectTarget[];
+}
+/**
+ * Build schemas, UI specs, platform metadata, and transformed modules for a set of
+ * custom object exports using one shared TypeScript program.
+ *
+ * @internal
+ */
+export declare function buildCustomObjectPackage(options: BuildCustomObjectPackageOptions, dependencies?: {
+    createProgram?: (rootNames: readonly string[], options: ts.CompilerOptions) => ts.Program;
+}): CustomObjectPackageBuildResult;
+/**
+ * Build the canonical lookup key for one package-build target.
+ *
+ * @internal
+ */
+export declare function toObjectKey(target: BuildCustomObjectTarget): string;
+//# sourceMappingURL=package-build.d.ts.map

package/dist/build/package-build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-build.d.ts","sourceRoot":"","sources":["../../src/build/package-build.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAOL,KAAK,cAAc,EAEnB,KAAK,QAAQ,EACd,MAAM,iBAAiB,CAAC;AAmBzB;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,2BAA2B,GAAG,IAAI,CAAC;IAC1C,MAAM,EAAE;QACN,UAAU,EAAE,cAAc,CAAC;KAC5B,CAAC;IACF,YAAY,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,YAAY,EAAE,cAAc,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,EAAE,4BAA4B,CAAC;IAC/C,MAAM,EAAE,2BAA2B,CAAC;IACpC,YAAY,EAAE,cAAc,CAAC;IAC7B,cAAc,EAAE,QAAQ,GAAG,IAAI,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC5C,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;IACjD,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,uBAAuB,EAAE,CAAC;CACpC;AA2BD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,+BAA+B,EACxC,YAAY,GAAE;IACZ,aAAa,CAAC,EAAE,CACd,SAAS,EAAE,SAAS,MAAM,EAAE,EAC5B,OAAO,EAAE,EAAE,CAAC,eAAe,KACxB,EAAE,CAAC,OAAO,CAAC;CACZ,GACL,8BAA8B,CAoGhC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,uBAAuB,GAAG,MAAM,CAEnE"}

package/dist/extensibility-custom-objects-tools-alpha.d.ts

@@ -0,0 +1,153 @@
+/**
+ * `@stripe/extensibility-custom-objects-tools`
+ *
+ * Build-time tooling for custom object extensions: schema transformation,
+ * metadata extraction, and code generation helpers.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Metadata for a single action (method).
+ * @alpha
+ */
+export declare interface ActionMetadata {
+    /** The method name */
+    methodName: string;
+    /** String representation of argument types */
+    argType: string;
+    /** String representation of return type */
+    returnType: string;
+    /** API name for the action (defaults to snake_case of method name) */
+    apiName: string;
+}
+
+/**
+ * Actions metadata for a custom object.
+ * Only instance methods are supported — static methods cannot be actions.
+ * @alpha
+ */
+export declare interface ActionsMetadata {
+    /** Instance-level actions */
+    instance: Record<string, ActionMetadata>;
+}
+
+/**
+ * Builds the custom objects by transforming TypeScript files.
+ *
+ * @param options - Build options
+ * @returns Build result
+ * @alpha
+ */
+export declare function build(options: BuildOptions): Promise<BuildResult>;
+
+/**
+ * Options for the build process.
+ * @alpha
+ */
+export declare interface BuildOptions {
+    /** Input directory containing TypeScript source files */
+    inputDir: string;
+    /** Output directory for transformed files */
+    outputDir: string;
+    /** Whether to generate source maps (not yet implemented) */
+    sourceMap?: boolean;
+}
+
+/**
+ * Result of the entire build process.
+ * @alpha
+ */
+export declare interface BuildResult {
+    /** Results for each processed file */
+    files: FileResult[];
+    /** Any global errors */
+    errors: TransformError[];
+}
+
+/**
+ * Result of transforming a single file.
+ * @alpha
+ */
+export declare interface FileResult {
+    /** Input file path */
+    inputPath: string;
+    /** Output file path */
+    outputPath: string;
+    /** Whether the transformation succeeded */
+    success: boolean;
+    /** Any errors that occurred */
+    errors: TransformError[];
+}
+
+/**
+ * Platform metadata for a custom object class.
+ * @alpha
+ */
+export declare interface PlatformMetadata {
+    /** Module path that defined this custom object */
+    modulePath?: string;
+    /** Original TypeScript class name */
+    className?: string;
+    /** Canonical class api name */
+    classApiName?: string;
+    /** The api name of the custom object */
+    apiName: string;
+    /** All actions for this custom object */
+    actions: ActionsMetadata;
+}
+
+/**
+ * Transforms TypeScript source code with custom object decorators.
+ * Injects runtime code and extracts platform metadata.
+ *
+ * @param sourceCode - The TypeScript source code to transform
+ * @param fileName - Optional file name for error reporting
+ * @returns Transform result with code, metadata, and errors
+ * @deprecated Use `buildCustomObjectPackage` + `transformWithPlan` instead. This
+ * function performs source-only discovery without build-time schema analysis, so it
+ * cannot generate wire conversion descriptors and falls back to the legacy passthrough
+ * wrapper (no Decimal/DateTime hydration).
+ * @alpha
+ */
+export declare function transform(sourceCode: string, fileName?: string): TransformResult;
+
+/**
+ * An error that occurred during transformation.
+ * @alpha
+ */
+export declare interface TransformError {
+    /** Error message */
+    message: string;
+    /** File path (if available) */
+    file?: string;
+    /** Line number (if available) */
+    line?: number;
+    /** Column number (if available) */
+    column?: number;
+}
+
+/**
+ * Transforms a TypeScript file from disk.
+ *
+ * @param filePath - Path to the TypeScript file
+ * @returns Transform result with code, metadata, and errors
+ * @deprecated Delegates to the deprecated `transform()`. Use `buildCustomObjectPackage` instead.
+ * @alpha
+ */
+export declare function transformFile(filePath: string): Promise<TransformResult>;
+
+/**
+ * Result of transforming source code.
+ * @alpha
+ */
+export declare interface TransformResult {
+    /** Transformed source code */
+    code: string;
+    /** Platform metadata extracted from all custom objects */
+    metadata: PlatformMetadata[];
+    /** Any errors encountered during transformation */
+    errors: TransformError[];
+}
+
+export { }

package/dist/extensibility-custom-objects-tools-beta.d.ts

@@ -0,0 +1,32 @@
+/**
+ * `@stripe/extensibility-custom-objects-tools`
+ *
+ * Build-time tooling for custom object extensions: schema transformation,
+ * metadata extraction, and code generation helpers.
+ *
+ * @packageDocumentation
+ */
+
+/* Excluded from this release type: ActionMetadata */
+
+/* Excluded from this release type: ActionsMetadata */
+
+/* Excluded from this release type: build */
+
+/* Excluded from this release type: BuildOptions */
+
+/* Excluded from this release type: BuildResult */
+
+/* Excluded from this release type: FileResult */
+
+/* Excluded from this release type: PlatformMetadata */
+
+/* Excluded from this release type: transform */
+
+/* Excluded from this release type: TransformError */
+
+/* Excluded from this release type: transformFile */
+
+/* Excluded from this release type: TransformResult */
+
+export { }

package/dist/extensibility-custom-objects-tools-internal-alpha.d.ts

@@ -0,0 +1,77 @@
+import { JsonSchema2020 } from '@formspec/build';
+import * as ts from 'typescript';
+import { UISchema } from '@formspec/build';
+
+/* Excluded from this release type: ActionSchemaResult */
+
+/* Excluded from this release type: _AfterExecuteResult */
+
+/* Excluded from this release type: _BeforeExecuteResult */
+
+/* Excluded from this release type: buildCustomObjectPackage */
+
+/* Excluded from this release type: BuildCustomObjectPackageOptions */
+
+/* Excluded from this release type: BuildCustomObjectTarget */
+
+/* Excluded from this release type: BuildDiagnostic */
+
+/* Excluded from this release type: CustomObjectBuildArtifact */
+
+/* Excluded from this release type: CustomObjectBuildResult */
+
+/* Excluded from this release type: _customObjectGenerator */
+
+/* Excluded from this release type: _customObjectGenerators */
+
+/* Excluded from this release type: CustomObjectPackageBuildResult */
+
+/* Excluded from this release type: _CustomObjectParams */
+
+/* Excluded from this release type: CustomObjectPlatformMetadata */
+
+/* Excluded from this release type: CustomObjectSchemaArtifacts */
+
+/* Excluded from this release type: _customObjectsWorkspaceGenerator */
+
+/* Excluded from this release type: _CustomObjectsWorkspaceParams */
+
+/* Excluded from this release type: _customObjectTestGenerator */
+
+/* Excluded from this release type: extractCustomObjectSchemas */
+
+/* Excluded from this release type: ExtractSchemasOptions */
+
+/* Excluded from this release type: _FileWriteOutcome */
+
+/* Excluded from this release type: _Generator */
+
+/* Excluded from this release type: _GeneratorContext */
+
+/* Excluded from this release type: _GeneratorExecuteContext */
+
+/* Excluded from this release type: _GeneratorExecuteResult */
+
+/* Excluded from this release type: _GeneratorPlanResult */
+
+/* Excluded from this release type: _GeneratorRunner */
+
+/* Excluded from this release type: _GeneratorWriteResult */
+
+/* Excluded from this release type: _PlannedFile */
+
+/* Excluded from this release type: _ProjectExecuteContext */
+
+/* Excluded from this release type: _ProjectGeneratorContext */
+
+/* Excluded from this release type: _StandaloneExecuteContext */
+
+/* Excluded from this release type: _StandaloneGeneratorContext */
+
+/* Excluded from this release type: toObjectKey */
+
+/* Excluded from this release type: _WriteCapability */
+
+/* Excluded from this release type: _WriteError */
+
+export { }

package/dist/extensibility-custom-objects-tools-internal-beta.d.ts

@@ -0,0 +1,77 @@
+import { JsonSchema2020 } from '@formspec/build';
+import * as ts from 'typescript';
+import { UISchema } from '@formspec/build';
+
+/* Excluded from this release type: ActionSchemaResult */
+
+/* Excluded from this release type: _AfterExecuteResult */
+
+/* Excluded from this release type: _BeforeExecuteResult */
+
+/* Excluded from this release type: buildCustomObjectPackage */
+
+/* Excluded from this release type: BuildCustomObjectPackageOptions */
+
+/* Excluded from this release type: BuildCustomObjectTarget */
+
+/* Excluded from this release type: BuildDiagnostic */
+
+/* Excluded from this release type: CustomObjectBuildArtifact */
+
+/* Excluded from this release type: CustomObjectBuildResult */
+
+/* Excluded from this release type: _customObjectGenerator */
+
+/* Excluded from this release type: _customObjectGenerators */
+
+/* Excluded from this release type: CustomObjectPackageBuildResult */
+
+/* Excluded from this release type: _CustomObjectParams */
+
+/* Excluded from this release type: CustomObjectPlatformMetadata */
+
+/* Excluded from this release type: CustomObjectSchemaArtifacts */
+
+/* Excluded from this release type: _customObjectsWorkspaceGenerator */
+
+/* Excluded from this release type: _CustomObjectsWorkspaceParams */
+
+/* Excluded from this release type: _customObjectTestGenerator */
+
+/* Excluded from this release type: extractCustomObjectSchemas */
+
+/* Excluded from this release type: ExtractSchemasOptions */
+
+/* Excluded from this release type: _FileWriteOutcome */
+
+/* Excluded from this release type: _Generator */
+
+/* Excluded from this release type: _GeneratorContext */
+
+/* Excluded from this release type: _GeneratorExecuteContext */
+
+/* Excluded from this release type: _GeneratorExecuteResult */
+
+/* Excluded from this release type: _GeneratorPlanResult */
+
+/* Excluded from this release type: _GeneratorRunner */
+
+/* Excluded from this release type: _GeneratorWriteResult */
+
+/* Excluded from this release type: _PlannedFile */
+
+/* Excluded from this release type: _ProjectExecuteContext */
+
+/* Excluded from this release type: _ProjectGeneratorContext */
+
+/* Excluded from this release type: _StandaloneExecuteContext */
+
+/* Excluded from this release type: _StandaloneGeneratorContext */
+
+/* Excluded from this release type: toObjectKey */
+
+/* Excluded from this release type: _WriteCapability */
+
+/* Excluded from this release type: _WriteError */
+
+export { }