@stripe/extensibility-sdk 0.25.0 → 0.26.0

package/README.md

@@ -298,18 +298,15 @@ there are no implicit defaults to prevent silent precision loss.
 | ----------------- | -------------------------- | ------------------------------------ |
 | `Integer`         | Whole number (no decimals) | `Integer.from(n, direction)`         |
 | `PositiveInteger` | Non-negative integer (≥ 0) | `PositiveInteger.from(n, direction)` |
-| `Timestamp`       | ISO 8601 datetime string   | `Timestamp.create(s)`                |
-| `StreetAddress`   | Non-empty string           | `StreetAddress.create(s)`            |
 
 These are branded types — they carry a compile-time brand so TypeScript rejects raw
 `number` or `string` where the stricter type is required.
 
 ```typescript
-import { Integer, PositiveInteger, Timestamp } from '@stripe/extensibility-sdk/stdlib';
+import { Integer, PositiveInteger } from '@stripe/extensibility-sdk';
 
 const count = Integer.from(42, 'round-down'); // Integer
 const qty = PositiveInteger.from(3, 'round-down'); // PositiveInteger
-const ts = Timestamp.create('2024-01-15T00:00:00.000Z'); // Timestamp
 ```
 
 ---
@@ -326,30 +323,6 @@ type CustomerRef = Ref<{ id: string; name: string }>;
 
 ---
 
-### Wire errors
-
-Thrown by the platform dispatch wrapper when wire-format data is invalid.
-
-| Class            | When thrown                                               |
-| ---------------- | --------------------------------------------------------- |
-| `WireReadError`  | Invalid or missing field in the **incoming** wire request |
-| `WireWriteError` | Invalid or missing field in the **outgoing** SDK response |
-
-```typescript
-import { WireReadError, WireWriteError } from '@stripe/extensibility-sdk/stdlib';
-```
-
-In production, the platform catches and surfaces these as structured errors. In tests,
-assert against them directly by invoking the generated interface-specific
-`$platformWrap...` helper for the interface under test. For example:
-
-```typescript
-// Pseudocode: replace `$platformWrap...` with the generated wrapper for your interface.
-expect(() => $platformWrap...(MyImpl, badInput, {}, ctx)).toThrow(WireReadError);
-```
-
----
-
 ## License
 
 MIT

package/dist/config-values/generate.cjs

@@ -157,7 +157,7 @@ function isStdlibDecimalType(type) {
     if (symbol?.getName() !== "Decimal") return false;
     return symbol.getDeclarations().some((declaration) => {
       const srcPath = declaration.getSourceFile().getFilePath();
-      return srcPath.includes("stdlib/decimal") || srcPath.includes("stdlib/index");
+      return srcPath.includes("stdlib/decimal") || srcPath.includes("stdlib/index") || srcPath.includes("extensibility-sdk");
     });
   });
 }

package/dist/config-values/generate.js

@@ -128,7 +128,7 @@ function isStdlibDecimalType(type) {
     if (symbol?.getName() !== "Decimal") return false;
     return symbol.getDeclarations().some((declaration) => {
       const srcPath = declaration.getSourceFile().getFilePath();
-      return srcPath.includes("stdlib/decimal") || srcPath.includes("stdlib/index");
+      return srcPath.includes("stdlib/decimal") || srcPath.includes("stdlib/index") || srcPath.includes("extensibility-sdk");
     });
   });
 }

package/dist/extensibility-sdk-alpha.d.ts

@@ -1144,25 +1144,6 @@ declare interface InvoiceCollectionSetting<Config> {
     collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
 }
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /* Excluded from this release type: _isPromiseLike */
 
 /* Excluded from this release type: _JsonWireToType */
@@ -1816,15 +1797,6 @@ export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even
 
 /* Excluded from this release type: _ShapeDescriptor */
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
@@ -1839,15 +1811,6 @@ declare interface TimeRange {
     endDate: Date;
 }
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -1892,31 +1855,9 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
 
 /* Excluded from this release type: _UnionDescriptor */
 
-/**
- * Shared types and error classes for the transform pipeline.
- * See transforms.ts for the module overview.
- */
-/**
- * Thrown when incoming wire data (proto → SDK) cannot be parsed.
- * Indicates malformed or unexpected data from the proto infrastructure —
- * not a bug in the user's code.
- *
- * @public
- */
-export declare class WireReadError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireReadError */
 
-/**
- * Thrown when outgoing SDK data (SDK → proto) cannot be serialized.
- * Indicates that the user's code returned a value that cannot be translated
- * back to wire format.
- *
- * @public
- */
-export declare class WireWriteError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireWriteError */
 
 declare namespace Workflows {
     export {

package/dist/extensibility-sdk-beta.d.ts

@@ -1144,25 +1144,6 @@ declare interface InvoiceCollectionSetting<Config> {
     collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
 }
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /* Excluded from this release type: _isPromiseLike */
 
 /* Excluded from this release type: _JsonWireToType */
@@ -1816,15 +1797,6 @@ export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even
 
 /* Excluded from this release type: _ShapeDescriptor */
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
@@ -1839,15 +1811,6 @@ declare interface TimeRange {
     endDate: Date;
 }
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -1892,31 +1855,9 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
 
 /* Excluded from this release type: _UnionDescriptor */
 
-/**
- * Shared types and error classes for the transform pipeline.
- * See transforms.ts for the module overview.
- */
-/**
- * Thrown when incoming wire data (proto → SDK) cannot be parsed.
- * Indicates malformed or unexpected data from the proto infrastructure —
- * not a bug in the user's code.
- *
- * @public
- */
-export declare class WireReadError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireReadError */
 
-/**
- * Thrown when outgoing SDK data (SDK → proto) cannot be serialized.
- * Indicates that the user's code returned a value that cannot be translated
- * back to wire format.
- *
- * @public
- */
-export declare class WireWriteError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireWriteError */
 
 declare namespace Workflows {
     export {

package/dist/extensibility-sdk-extensions-internal.d.ts

@@ -25,7 +25,7 @@ declare const __brand: '__brand';
  *
  * Using a dedicated key (rather than the shared `__brand`) lets formspec's
  * structural brand-detection distinguish `Decimal` from other SDK branded
- * types (e.g., `Ref`, `StreetAddress`) that also carry `[__brand]`.
+ * types (e.g., `Ref`) that also carry `[__brand]`.
  *
  * String-literal const (not `unique symbol`) so that independent
  * declaration rollups (root vs subpath) produce structurally compatible

package/dist/extensibility-sdk-internal.d.ts

@@ -31,7 +31,7 @@ export declare const __brand: '__brand';
  *
  * Using a dedicated key (rather than the shared `__brand`) lets formspec's
  * structural brand-detection distinguish `Decimal` from other SDK branded
- * types (e.g., `Ref`, `StreetAddress`) that also carry `[__brand]`.
+ * types (e.g., `Ref`) that also carry `[__brand]`.
  *
  * String-literal const (not `unique symbol`) so that independent
  * declaration rollups (root vs subpath) produce structurally compatible
@@ -1314,25 +1314,6 @@ declare interface InvoiceCollectionSetting<Config> {
     collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
 }
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /**
  * Returns `true` if `value` conforms to the `PromiseLike` contract:
  * a non-null object or function with a callable `then` method.
@@ -2051,7 +2032,7 @@ export declare const Ref: { create: <T extends { readonly object: string }>(step
 /**
  * Wraps a transformer so that a `null` / `undefined` result throws
  * `WireParseError('Required field is missing')`, which `strategy.applyField`
- * will catch and re-throw as WireReadError / WireWriteError with field context.
+ * will catch and re-throw as _WireReadError / _WireWriteError with field context.
  *
  * The inner transformer runs first, so strategies that backfill absent values
  * (e.g. clock-aware `translateDateTime`) can satisfy the requirement.
@@ -2098,15 +2079,6 @@ export declare class _ShapeDescriptor<_S extends _ApplyStrategy = _ApplyStrategy
     constructor(typeName: string, fields: _FieldDescriptor[], oneofFields?: _OneofFieldDescriptor[]);
 }
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
@@ -2121,15 +2093,6 @@ declare interface TimeRange {
     endDate: Date;
 }
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -2274,9 +2237,9 @@ export declare class _UnionDescriptor<_S extends _ApplyStrategy = _ApplyStrategy
  * Indicates malformed or unexpected data from the proto infrastructure —
  * not a bug in the user's code.
  *
- * @public
+ * @internal
  */
-export declare class WireReadError extends Error {
+export declare class _WireReadError extends Error {
     /**
      * Error class name for `instanceof`-free identification.
      * @internal
@@ -2289,9 +2252,9 @@ export declare class WireReadError extends Error {
  * Indicates that the user's code returned a value that cannot be translated
  * back to wire format.
  *
- * @public
+ * @internal
  */
-export declare class WireWriteError extends Error {
+export declare class _WireWriteError extends Error {
     /**
      * Error class name for `instanceof`-free identification.
      * @internal

package/dist/extensibility-sdk-public.d.ts

@@ -1144,25 +1144,6 @@ declare interface InvoiceCollectionSetting<Config> {
     collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
 }
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /* Excluded from this release type: _isPromiseLike */
 
 /* Excluded from this release type: _JsonWireToType */
@@ -1816,15 +1797,6 @@ export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even
 
 /* Excluded from this release type: _ShapeDescriptor */
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
@@ -1839,15 +1811,6 @@ declare interface TimeRange {
     endDate: Date;
 }
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -1892,31 +1855,9 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
 
 /* Excluded from this release type: _UnionDescriptor */
 
-/**
- * Shared types and error classes for the transform pipeline.
- * See transforms.ts for the module overview.
- */
-/**
- * Thrown when incoming wire data (proto → SDK) cannot be parsed.
- * Indicates malformed or unexpected data from the proto infrastructure —
- * not a bug in the user's code.
- *
- * @public
- */
-export declare class WireReadError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireReadError */
 
-/**
- * Thrown when outgoing SDK data (SDK → proto) cannot be serialized.
- * Indicates that the user's code returned a value that cannot be translated
- * back to wire format.
- *
- * @public
- */
-export declare class WireWriteError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireWriteError */
 
 declare namespace Workflows {
     export {

package/dist/extensibility-sdk-stdlib-alpha.d.ts

@@ -404,25 +404,6 @@ export declare interface IntegerCompanion {
  */
 export declare type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /* Excluded from this release type: _isPromiseLike */
 
 /* Excluded from this release type: _JsonWireToType */
@@ -544,27 +525,9 @@ export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even
 
 /* Excluded from this release type: _ShapeDescriptor */
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -609,30 +572,8 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
 
 /* Excluded from this release type: _UnionDescriptor */
 
-/**
- * Shared types and error classes for the transform pipeline.
- * See transforms.ts for the module overview.
- */
-/**
- * Thrown when incoming wire data (proto → SDK) cannot be parsed.
- * Indicates malformed or unexpected data from the proto infrastructure —
- * not a bug in the user's code.
- *
- * @public
- */
-export declare class WireReadError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireReadError */
 
-/**
- * Thrown when outgoing SDK data (SDK → proto) cannot be serialized.
- * Indicates that the user's code returned a value that cannot be translated
- * back to wire format.
- *
- * @public
- */
-export declare class WireWriteError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireWriteError */
 
 export { }

package/dist/extensibility-sdk-stdlib-beta.d.ts

@@ -404,25 +404,6 @@ export declare interface IntegerCompanion {
  */
 export declare type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
 
-/**
- * Check whether a value is a `Decimal` instance.
- *
- * @remarks
- * Use this instead of `instanceof` — the underlying class is not
- * publicly exported, so `instanceof` checks are not available to
- * consumers.
- *
- * @example
- * ```ts
- * if (isDecimal(value)) {
- *   value.add(Decimal.from('1')); // value is Decimal
- * }
- * ```
- *
- * @public
- */
-export declare function isDecimal(value: unknown): value is Decimal;
-
 /* Excluded from this release type: _isPromiseLike */
 
 /* Excluded from this release type: _JsonWireToType */
@@ -544,27 +525,9 @@ export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even
 
 /* Excluded from this release type: _ShapeDescriptor */
 
-/** A branded string representing a street address. @public */
-export declare type StreetAddress = {
-    readonly [__brand]: 'StreetAddress';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
-
 /** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
 export declare type StripeTypeSymbol = typeof __stripeType;
 
-/** A branded string representing an ISO 8601 datetime. @public */
-export declare type Timestamp = {
-    readonly [__brand]: 'Timestamp';
-    readonly [__stripeType]: 'string';
-} & string;
-
-/** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-
 /**
  * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
  *
@@ -609,30 +572,8 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
 
 /* Excluded from this release type: _UnionDescriptor */
 
-/**
- * Shared types and error classes for the transform pipeline.
- * See transforms.ts for the module overview.
- */
-/**
- * Thrown when incoming wire data (proto → SDK) cannot be parsed.
- * Indicates malformed or unexpected data from the proto infrastructure —
- * not a bug in the user's code.
- *
- * @public
- */
-export declare class WireReadError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireReadError */
 
-/**
- * Thrown when outgoing SDK data (SDK → proto) cannot be serialized.
- * Indicates that the user's code returned a value that cannot be translated
- * back to wire format.
- *
- * @public
- */
-export declare class WireWriteError extends Error {
-    /* Excluded from this release type: name */
-}
+/* Excluded from this release type: _WireWriteError */
 
 export { }