@stripe/extensibility-sdk 1.1.0 → 1.3.0

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

@@ -0,0 +1,1096 @@
+import { __integerBrand } from '@formspec/core';
+
+/**
+ * Opaque brand key used as a property key in SDK branded types.
+ *
+ * @remarks
+ * You do not need to use this directly — it is already embedded in
+ * branded values returned by factory functions like {@link (Integer:type)}.from().
+ *
+ * String-literal const (not `unique symbol`) so that independent
+ * declaration rollups (root vs subpath) produce structurally compatible
+ * branded types.
+ *
+ * @public
+ */
+export declare const __brand: '__brand';
+
+/**
+ * Unique brand key for the `Decimal` type.
+ *
+ * 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`) that also carry `[__brand]`.
+ *
+ * String-literal const (not `unique symbol`) so that independent
+ * declaration rollups (root vs subpath) produce structurally compatible
+ * branded types.
+ *
+ * @internal
+ */
+export declare const __decimalBrand: '__decimalBrand';
+
+/**
+ * Distinct brand key for PositiveInteger so an Integer is not assignable to
+ * PositiveInteger without going through the guard. PositiveInteger is a
+ * subtype of Integer (it carries both brands), so it can be used wherever
+ * Integer is expected.
+ *
+ * String-literal const (not `unique symbol`) so that independent
+ * declaration rollups (root vs subpath) produce structurally compatible
+ * branded types.
+ *
+ * For internal use only — may be removed in a future release.
+ *
+ * @public
+ */
+export declare const __positiveIntegerBrand: '__positiveIntegerBrand';
+
+/**
+ * Opaque type-tag key used by SDK scalar types to carry Stripe type metadata.
+ *
+ * @remarks
+ * You do not need to use this directly — it is already embedded in
+ * branded values returned by factory functions like {@link (Integer:type)}.from().
+ *
+ * String-literal const (not `unique symbol`) so that independent
+ * declaration rollups (root vs subpath) produce structurally compatible
+ * branded types.
+ *
+ * @public
+ */
+export declare const __stripeType: '__stripeType';
+
+/**
+ * Stage-2 outgoing strategy: transforms API-JSON to proto wire format.
+ * Performs structural transformations (camelCase → snake_case key renaming,
+ * SDK enum → proto enum translation, discriminated union → proto oneof,
+ * plain string → `{value: string}` decimal wrapping).
+ *
+ * @internal
+ */
+export declare const _ApiJsonToProto: _ApiJsonToProtoStrategy;
+
+/**
+ * Branded strategy for API-JSON → proto wire (stage 2 outgoing).
+ * Performs structural transformations (key renaming back to snake_case,
+ * enum translation to proto values, union restructuring to oneof, decimal
+ * wrapping as `{value: string}`).
+ *
+ * @internal
+ */
+export declare interface _ApiJsonToProtoStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'ApiJsonToProto';
+}
+
+/**
+ * Stage-2 incoming strategy: hydrates SDK objects from API-JSON.
+ * Reads from camelCase keys (already renamed by stage 1), constructs
+ * Decimal and Date instances from plain strings, validates required
+ * fields, and recursively hydrates nested shapes and unions that are
+ * already in discriminated form.
+ *
+ * @internal
+ */
+export declare const _ApiJsonToType: _ApiJsonToTypeStrategy;
+
+/**
+ * Branded strategy for API-JSON → SDK types (stage 2 incoming).
+ * Hydrates JS objects (Decimal, Date) from the already-restructured
+ * API-JSON intermediate format.
+ *
+ * @internal
+ */
+export declare interface _ApiJsonToTypeStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'ApiJsonToType';
+}
+
+/**
+ * Apply a strategy to a field array, transforming each field.
+ * The strategy determines direction (proto→SDK, SDK→proto, or JSON→SDK).
+ *
+ * @internal
+ */
+export declare function _apply<S extends _ApplyStrategy>(descriptor: _ShapeDescriptor<S>, strategy: S, inputObject: unknown, typeName?: string): Record<string, unknown>;
+
+/**
+ * Apply _JsonWireToType to a config descriptor, returning the typed config value.
+ *
+ * When `appCtx` is provided and contains a `clockTime`, empty datetime fields
+ * are backfilled from the clock time instead of returning `undefined`.
+ *
+ * @internal
+ */
+export declare function _applyConfig<T, S extends _JsonWireToTypeStrategy>(descriptor: _ShapeDescriptor<S, T>, inputObject: unknown, appCtx?: _ConfigApplicationContext): T;
+
+/**
+ * Apply _ProtoWireToType to a descriptor, returning the typed SDK value.
+ *
+ * @internal
+ */
+export declare function _applyIncoming<T, S extends _ProtoWireToTypeStrategy>(descriptor: _ShapeDescriptor<S, T>, inputObject: unknown): T;
+
+/**
+ * Apply _TypeToProtoWire to a descriptor.
+ *
+ * @internal
+ */
+export declare function _applyOutgoing<T, S extends _TypeToProtoWireStrategy>(descriptor: _ShapeDescriptor<S, T>, inputObject: T): Record<string, unknown>;
+
+/**
+ * Encapsulates transformation direction and direction-specific primitives.
+ *
+ * @internal
+ */
+export declare interface _ApplyStrategy {
+    /**
+     * Given a field descriptor and the whole input object, produces the
+     * [outputKey, outputValue] pair for one field. Strategy owns key selection,
+     * value extraction, and error wrapping. `typeName` is used to prefix
+     * error messages as `TypeName.fieldName: message`.
+     */
+    applyField(typeName: string, desc: _FieldDescriptor, input: Record<string, unknown>, strategy: _ApplyStrategy): [outputKey: string, outputValue: unknown];
+    /** Creates the null-input error for this strategy direction. */
+    createNotObjectError(loc: string, received: string): Error;
+    /** Converts a decimal value for this strategy's direction. */
+    translateDecimal(value: unknown): unknown;
+    /** Converts a datetime value for this strategy's direction. */
+    translateDateTime(value: unknown): unknown;
+    /** Validates or translates an enum value using the given spec. */
+    translateEnum(spec: _EnumSpec, value: unknown): unknown;
+    /** Transforms a discriminated union value for this strategy's direction. */
+    applyUnion(descriptor: _UnionDescriptor, input: unknown): unknown;
+    /**
+     * Transforms a oneof field within a shape (mixed message).
+     * Merges the oneof's key-value pairs directly into `result`.
+     *
+     * `excludeWireKeys` lists all wire keys on the parent object that should
+     * not be claimed as an unknown oneof variant: regular fields, all known
+     * oneof branch keys (including this oneof's own), and keys already claimed
+     * by a previous oneof's 'other' fallback.
+     */
+    applyOneofField(typeName: string, oneof: _OneofFieldDescriptor, input: Record<string, unknown>, strategy: _ApplyStrategy, result: Record<string, unknown>, excludeWireKeys: Set<string>): void;
+}
+
+/** The type of the opaque brand key used as a property key in SDK branded types. @public */
+export declare type BrandSymbol = typeof __brand;
+
+/**
+ * Builds a `ConfigApplicationContext` from the raw extension context.
+ *
+ * Extracts `clockTime` when present and validates it is a string.
+ * Returns an empty context when the field is absent or ctx is not an object.
+ *
+ * @internal
+ */
+export declare function _configAppContextFromContext(ctx: unknown): _ConfigApplicationContext;
+
+/**
+ * Context values threaded into config application at runtime.
+ *
+ * The platform dispatch layer builds this from the extension context
+ * (`_configAppContextFromContext`) and passes it through the config
+ * transformer into `_applyConfig`.
+ *
+ * @internal
+ */
+export declare interface _ConfigApplicationContext {
+    /** ISO 8601 clock time for Billing test clocks. */
+    clockTime?: string;
+}
+
+/**
+ * Validation-only enum spec for config values. Accepts a set of known
+ * SDK values; both `fromWire` and `toWire` return the value unchanged
+ * if it is known, or `null` if it is not.
+ *
+ * @internal
+ */
+export declare class _ConfigEnum implements _EnumSpec {
+    private readonly _values;
+    constructor(values: string[]);
+    /**
+     * Validate and return the wire value unchanged, or `null` if unknown.
+     * @internal
+     */
+    fromWire(value: string): null | string;
+    /**
+     * Validate and return the SDK value unchanged, or `null` if unknown.
+     * @internal
+     */
+    toWire(value: string): null | string;
+}
+
+/**
+ * Union of strategies that process config data (JSON → SDK types).
+ *
+ * @internal
+ */
+export declare type _ConfigStrategy = _JsonWireToTypeStrategy;
+
+/** @public */
+export declare type Currency = 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'apt' | 'arb' | 'ars' | 'aud' | 'avax' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnb' | 'bnd' | 'bob' | 'bov' | 'brl' | 'bsd' | 'btc' | 'btn' | 'buidl' | 'bwp' | 'byn' | 'byr' | 'bzd' | 'cad' | 'cdf' | 'celo' | 'che' | 'chf' | 'chw' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'crc' | 'cuc' | 'cup' | 'cve' | 'czk' | 'dai' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'eek' | 'egp' | 'ern' | 'etb' | 'eth' | 'eur' | 'eurc' | 'fjd' | 'fkp' | 'frxusd' | 'gbp' | 'gel' | 'ghc' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'hype' | 'idr' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'lzd' | 'm' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mon' | 'mop' | 'mro' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'open_usd' | 'ord' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pol' | 'pyg' | 'pyusd' | 'qar' | 'rd' | 're' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sll' | 'sol' | 'sos' | 'srd' | 'ssp' | 'std' | 'stn' | 'sui' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'trx' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'usdb' | 'usdc' | 'usdg' | 'usdp' | 'usdsui' | 'usdt' | 'usn' | 'ustb' | 'uyi' | 'uyu' | 'uzs' | 'vef' | 'ves' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xeur' | 'xlm' | 'xof' | 'xpf' | 'xpl' | 'xusd' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwg' | 'zwl';
+
+/**
+ * Arbitrary-precision decimal type for billing calculations.
+ *
+ * @remarks
+ * `Decimal` values are created by the {@link (Decimal:variable) | Decimal companion object}
+ * and store values as `coefficient × 10^exponent` using `BigInt`. They avoid
+ * every common binary floating-point pitfall — `Decimal.from('0.1').add(Decimal.from('0.2'))`
+ * is exactly `0.3`.
+ *
+ * Instances are immutable (frozen) and all arithmetic returns a new
+ * `Decimal`. The public type carries two brand symbols so the type system
+ * prevents accidental assignment from plain `number`, `string`, or
+ * `bigint`.
+ *
+ * Create values via the companion object:
+ *
+ * @example
+ * ```ts
+ * import { Decimal, RoundDirection } from '@stripe/extensibility-sdk';
+ *
+ * const price = Decimal.from('19.99');
+ * const tax   = price.mul(Decimal.from('0.0825'));
+ * const total = price.add(tax);
+ *
+ * console.log(total.toFixed(2, 'half-up'));   // "21.64"
+ * console.log(JSON.stringify({ total }));          // '{"total":"21.639175"}'
+ * console.log(total.toFixed(2, 'half-even')); // "21.64"
+ * ```
+ *
+ * @public
+ */
+export declare interface Decimal {
+    /**
+     * Nominal brand tag.
+     * @internal
+     */
+    readonly [__brand]: 'Decimal';
+    /** @internal */
+    readonly [__decimalBrand]: true;
+    /**
+     * Stripe type discriminator.
+     * @internal
+     */
+    readonly [__stripeType]: 'decimal';
+    /**
+     * Return the sum of this value and `other`.
+     * @public
+     */
+    add(other: DecimalLike): Decimal;
+    /**
+     * Return the difference of this value and `other`.
+     * @public
+     */
+    sub(other: DecimalLike): Decimal;
+    /**
+     * Return the product of this value and `other`.
+     * @public
+     */
+    mul(other: DecimalLike): Decimal;
+    /**
+     * Return the quotient of this value divided by `other`.
+     * @public
+     */
+    div(other: DecimalLike, precision: number, direction: RoundDirection): Decimal;
+    /**
+     * Three-way comparison: returns `-1`, `0`, or `1`.
+     * @public
+     */
+    cmp(other: DecimalLike): -1 | 0 | 1;
+    /**
+     * Return `true` if this value is numerically equal to `other`.
+     * @public
+     */
+    eq(other: DecimalLike): boolean;
+    /**
+     * Return `true` if this value is strictly less than `other`.
+     * @public
+     */
+    lt(other: DecimalLike): boolean;
+    /**
+     * Return `true` if this value is less than or equal to `other`.
+     * @public
+     */
+    lte(other: DecimalLike): boolean;
+    /**
+     * Return `true` if this value is strictly greater than `other`.
+     * @public
+     */
+    gt(other: DecimalLike): boolean;
+    /**
+     * Return `true` if this value is greater than or equal to `other`.
+     * @public
+     */
+    gte(other: DecimalLike): boolean;
+    /**
+     * Return `true` if this value is exactly zero.
+     * @public
+     */
+    isZero(): boolean;
+    /**
+     * Return `true` if this value is strictly less than zero.
+     * @public
+     */
+    isNegative(): boolean;
+    /**
+     * Return `true` if this value is strictly greater than zero.
+     * @public
+     */
+    isPositive(): boolean;
+    /**
+     * Return the additive inverse of this value.
+     * @public
+     */
+    neg(): Decimal;
+    /**
+     * Return the absolute value.
+     * @public
+     */
+    abs(): Decimal;
+    /**
+     * Round this value to the specified precision.
+     * @public
+     */
+    round(direction: RoundDirection, options: DecimalRoundingOptions | keyof typeof DecimalRoundingPresets): Decimal;
+    /**
+     * Return the canonical string representation.
+     * @public
+     */
+    toString(): string;
+    /**
+     * Return the JSON-serializable string representation.
+     * @public
+     */
+    toJSON(): string;
+    /**
+     * Convert to a JavaScript `number` (lossy).
+     * @public
+     */
+    toNumber(): number;
+    /**
+     * Format as a fixed-point string with exactly `decimalPlaces` digits.
+     * @public
+     */
+    toFixed(decimalPlaces: number, direction: RoundDirection): string;
+    /**
+     * Convert to an {@link (Integer:type)} by rounding.
+     * @public
+     */
+    toInteger(direction: RoundDirection): Integer;
+    /**
+     * Rejects implicit coercion; explicit `String(d)` and template literals still work.
+     * @public
+     */
+    [Symbol.toPrimitive](hint: 'default' | 'number' | 'string'): string;
+    /**
+     * Returns the string representation; invoked by the JavaScript engine as a fallback coercion path.
+     * @public
+     */
+    valueOf(): string;
+}
+
+/**
+ * Companion object for creating `Decimal` instances.
+ *
+ * @public
+ */
+export declare const Decimal: DecimalCompanion;
+
+/** @public */
+export declare interface DecimalCompanion {
+    /** Type guard: narrows `unknown` to `Decimal`. @public */
+    is(value: unknown): value is Decimal;
+    /** Assertion guard: throws if not a `Decimal`. @public */
+    assert(value: unknown): asserts value is Decimal;
+    /** Create a Decimal from a {@link DecimalLike} value. @public */
+    from(value: DecimalLike): Decimal;
+    /** The Decimal value `0`. @public */
+    readonly zero: Decimal;
+}
+
+/**
+ * Values that can be coerced to a `Decimal` via `Decimal.from()`.
+ *
+ * @remarks
+ * This union is accepted by `Decimal.from()` and by all arithmetic and
+ * comparison methods on `Decimal` instances. Non-Decimal values are
+ * coerced via `Decimal.from()` before the operation.
+ *
+ * @public
+ */
+export declare type DecimalLike = bigint | Decimal | Integer | number | string;
+
+/**
+ * Precision specification for `Decimal.round()`.
+ *
+ * @remarks
+ * Two modes are supported:
+ * - `"decimal-places"` — round to a fixed number of digits after the decimal point.
+ * - `"significant-figures"` — round to a fixed number of significant digits.
+ *
+ * @example
+ * ```ts
+ * // Round to 2 decimal places
+ * amount.round('half-even', { mode: 'decimal-places', value: 2 });
+ *
+ * // Round to 4 significant figures
+ * amount.round('half-up', { mode: 'significant-figures', value: 4 });
+ * ```
+ *
+ * @public
+ */
+export declare interface DecimalRoundingOptions {
+    /** Whether to count digits from the decimal point (`"decimal-places"`) or from the most significant digit (`"significant-figures"`). */
+    mode: 'decimal-places' | 'significant-figures';
+    /**
+     * The number of digits to retain. Interpreted as decimal places when
+     * `mode` is `"decimal-places"`, or as significant figures when `mode`
+     * is `"significant-figures"`.
+     * @public
+     */
+    value: number;
+}
+
+/**
+ * Built-in rounding presets keyed by semantic name.
+ *
+ * @remarks
+ * Stripe defines the full set of supported preset names accepted by
+ * `Decimal.round()`.
+ *
+ * | Preset              | Equivalent DecimalRoundingOptions                     |
+ * | ------------------- | ----------------------------------------------------- |
+ * | `"ubb-usage-count"` | `{ mode: "significant-figures", value: 15 }`         |
+ * | `"v1-api"`          | `{ mode: "decimal-places", value: 12 }`              |
+ *
+ * @public
+ */
+export declare const DecimalRoundingPresets: Readonly<{
+    'ubb-usage-count': Readonly<{
+        mode: "significant-figures";
+        value: number;
+    }>;
+    'v1-api': Readonly<{
+        mode: "decimal-places";
+        value: number;
+    }>;
+}>;
+
+/**
+ * Recursively converts a type to a deeply-readonly version.
+ *
+ * Primitive types (`string`, `number`, `boolean`, `bigint`, `symbol`,
+ * `undefined`, `null`) are returned as-is. Arrays become `readonly` arrays
+ * of deeply-readonly elements. Object types have each property marked
+ * `readonly`, and the type of each property is recursively transformed.
+ *
+ * @public
+ */
+export declare type DeepReadonly<T> = T extends bigint | boolean | null | number | string | symbol | undefined ? T : T extends readonly (infer Item)[] ? readonly DeepReadonly<Item>[] : T extends object ? { readonly [K in keyof T]: DeepReadonly<T[K]> } : T;
+
+/**
+ * The IEEE 754 decimal128 coefficient size (34 digits) — the recommended
+ * precision for `Decimal.div()` when full precision is desired.
+ *
+ * @remarks
+ * Pass this as the `precision` argument to `div()` when you want the
+ * maximum available precision. Division requires explicit precision —
+ * no invisible defaults in financial code.
+ *
+ * @example
+ * ```ts
+ * // Use the full decimal128 precision explicitly
+ * a.div(b, DEFAULT_DIV_PRECISION, 'half-even');
+ * ```
+ *
+ * @public
+ */
+export declare const DEFAULT_DIV_PRECISION = 34;
+
+/**
+ * Common interface for enum conversion specs. `fromWire` converts an
+ * incoming wire string to an SDK value; `toWire` does the reverse.
+ * Both return `null` for unknown values.
+ *
+ * @internal
+ */
+export declare interface _EnumSpec {
+    /**
+     * Convert a wire value to an SDK value, or `null` if unknown.
+     * @internal
+     */
+    fromWire(value: string): null | string;
+    /**
+     * Convert an SDK value to a wire value, or `null` if unknown.
+     * @internal
+     */
+    toWire(value: string): null | string;
+}
+
+/**
+ * Extracts the string literal type of the `object` property from T.
+ *
+ * @public
+ */
+export declare type ExtractObjectTag<T> = T extends { readonly object: infer O } ? O extends string ? O : never : never;
+
+/**
+ * Describes how to map one field in a shape.
+ *
+ * @internal
+ */
+export declare interface _FieldDescriptor {
+    /** Wire key for this field; falls back to `type` if absent. */
+    wire?: string;
+    /** SDK / type key for this field. */
+    type: string;
+    /** Transform to apply; if absent, passthrough (identity). */
+    transform?: _FieldTransformer;
+}
+
+/**
+ * A field transformer with the strategy threaded through so transforms can
+ * delegate direction-specific behavior (e.g. decimal parsing vs serialization)
+ * to the strategy.
+ *
+ * @internal
+ */
+export declare type _FieldTransformer = (strategy: _ApplyStrategy, value: unknown) => unknown;
+
+/**
+ * Pass a value through unchanged.
+ *
+ * @internal
+ */
+export declare const _identity: _FieldTransformer;
+
+/**
+ * Union of strategies that process incoming runtime data (proto-JSON or
+ * API-JSON). Descriptors branded with this type can be used with either the
+ * full composed pipeline (_ProtoWireToType) or just the hydration stage
+ * (_ApiJsonToType) when structural transformation has already occurred.
+ *
+ * @internal
+ */
+export declare type _IncomingRuntimeStrategy = _ApiJsonToTypeStrategy | _ProtoWireToTypeStrategy;
+
+/** A branded integer — a `number` guaranteed to satisfy `Number.isInteger`. @public */
+export declare type Integer = {
+    readonly [__integerBrand]: true;
+    readonly [__stripeType]: 'int';
+} & number;
+
+/** Factory, type guard, and utilities for {@link (Integer:type)} branded values. @public */
+export declare const Integer: IntegerCompanion;
+
+/** @public */
+export declare interface IntegerCompanion {
+    /** The Integer value `0`. @public */
+    readonly zero: Integer;
+    /** Type guard: narrows `unknown` to {@link (Integer:type)}. @public */
+    is(value: unknown): value is Integer;
+    /** Assertion guard: throws if not an {@link (Integer:type)}. @public */
+    assert(value: unknown): asserts value is Integer;
+    /** Coerce a value to {@link (Integer:type)} by rounding. @public */
+    from(value: Decimal | Integer | number | string, rounding: IntegerRoundDirection): Integer;
+    /** Lossless conversion to `Decimal`. @public */
+    toDecimal(value: Integer): Decimal;
+    /** Type guard: narrows {@link (Integer:type)} to {@link (PositiveInteger:type)}. @public */
+    isPositive(value: Integer): value is PositiveInteger;
+    /** Assertion guard: throws if the Integer is negative. @public */
+    assertIsPositive(value: Integer): asserts value is PositiveInteger;
+}
+
+/**
+ * Rounding directions for coercing a number to an integer.
+ *
+ * A focused subset of {@link https://standards.ieee.org/ieee/754/6210/ | IEEE 754-2019} §4.3:
+ *
+ * | Direction      | Behavior                     | Examples (→ integer)           |
+ * | -------------- | ---------------------------- | ------------------------------ |
+ * | `'ceil'`       | Toward +∞                    | 1.1→2, -1.1→-1                |
+ * | `'floor'`      | Toward -∞                    | 1.9→1, -1.1→-2                |
+ * | `'round-down'` | Toward zero (truncate)       | 1.9→1, -1.9→-1                |
+ * | `'round-up'`   | Away from zero               | 1.1→2, -1.1→-2                |
+ * | `'half-up'`    | Nearest; ties away from zero | 0.5→1, -0.5→-1, 1.4→1         |
+ *
+ * @public
+ */
+export declare type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
+
+/**
+ * Returns `true` if `value` conforms to the `PromiseLike` contract:
+ * a non-null object or function with a callable `then` method.
+ *
+ * @internal
+ */
+export declare function _isPromiseLike(value: unknown): value is PromiseLike<unknown>;
+
+/**
+ * Strategy for transforming JSON config data to SDK types.
+ *
+ * @internal
+ */
+export declare const _JsonWireToType: _JsonWireToTypeStrategy;
+
+/**
+ * Branded strategy for JSON config → SDK transformations.
+ *
+ * @internal
+ */
+export declare interface _JsonWireToTypeStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'JsonWireToType';
+}
+
+/**
+ * Represents a monetary value with amount and currency.
+ * @format monetary-amount
+ * @public
+ */
+export declare interface MonetaryAmount {
+    /** The numerical value. */
+    amount: Decimal;
+    /** The currency code. */
+    currency: Currency;
+}
+
+/**
+ * Describes one branch of a oneof field embedded in a shape.
+ *
+ * @internal
+ */
+export declare interface _OneofBranchDescriptor {
+    /** Wire key for this branch on the parent object (e.g. `'price'`). */
+    wireKey: string;
+    /** SDK discriminant value for this branch (e.g. `'price'`). */
+    typeKey: string;
+    /** Transform to apply to the branch value; if absent, passthrough. */
+    transform?: _FieldTransformer;
+}
+
+/**
+ * Describes a oneof field within a shape — a set of mutually exclusive wire
+ * keys that map to a single discriminated SDK field.
+ *
+ * @internal
+ */
+export declare interface _OneofFieldDescriptor {
+    /** SDK field name for the discriminant (e.g. `'priceKind'`). */
+    discriminant: string;
+    /** Whether the oneof is optional (no branch set → field absent). */
+    optional: boolean;
+    /** The branches for this oneof. */
+    branches: _OneofBranchDescriptor[];
+}
+
+/**
+ * Union of strategies that process outgoing runtime data (SDK types to
+ * proto-JSON or API-JSON). Descriptors branded with this type can be used
+ * with either the full composed pipeline (_TypeToProtoWire) or just the
+ * dehydration stage (_TypeToApiJson) when structural transformation will
+ * occur externally.
+ *
+ * @internal
+ */
+export declare type _OutgoingRuntimeStrategy = _TypeToApiJsonStrategy | _TypeToProtoWireStrategy;
+
+/**
+ * A branded non-negative integer — a `number` guaranteed to be an integer ≥ 0.
+ *
+ * This is a subtype of {@link (Integer:type)}: every non-negative integer is an
+ * integer, so `PositiveInteger` values are assignable to `Integer` contexts.
+ * The reverse is not true — an `Integer` cannot be assigned where a
+ * `PositiveInteger` is expected without going through the `PositiveInteger.is()`
+ * type guard or `PositiveInteger.from()` factory.
+ *
+ * @remarks
+ * Despite the name, this type includes zero (`>= 0`, not `> 0`).
+ * The schema-level constraint `@minimum 0` should be added to fields
+ * typed as `PositiveInteger` to ensure the non-negativity invariant
+ * is enforced at validation time.
+ *
+ * @public
+ */
+export declare type PositiveInteger = {
+    readonly [__integerBrand]: true;
+    readonly [__positiveIntegerBrand]: true;
+    readonly [__stripeType]: 'int';
+} & number;
+
+/** Factory, type guard, and utilities for {@link (PositiveInteger:type)} branded values. @public */
+export declare const PositiveInteger: PositiveIntegerCompanion;
+
+/** @public */
+export declare interface PositiveIntegerCompanion {
+    /** Type guard: narrows `unknown` to {@link (PositiveInteger:type)}. @public */
+    is(value: unknown): value is PositiveInteger;
+    /** Assertion guard: throws if not a {@link (PositiveInteger:type)}. @public */
+    assert(value: unknown): asserts value is PositiveInteger;
+    /** Coerce a value to {@link (PositiveInteger:type)} by rounding. Throws if negative. @public */
+    from(value: Decimal | Integer | number | string, rounding: IntegerRoundDirection): PositiveInteger;
+}
+
+/**
+ * Bidirectional enum spec for proto-backed enums. Accepts a single
+ * `fromProto` map and derives the inverse; throws if the map is not
+ * bijective (duplicate target values).
+ *
+ * @internal
+ */
+export declare class _ProtoEnum implements _EnumSpec {
+    private readonly _from;
+    private readonly _to;
+    constructor(fromProto: Record<string, string>);
+    /**
+     * Convert a proto wire value to an SDK value, or `null` if unknown.
+     * @internal
+     */
+    fromWire(value: string): null | string;
+    /**
+     * Convert an SDK value to a proto wire value, or `null` if unknown.
+     * @internal
+     */
+    toWire(value: string): null | string;
+}
+
+/**
+ * Stage-1 incoming strategy: transforms proto wire data to API-JSON.
+ * Performs all structural operations (key renaming, enum translation,
+ * union/oneof restructuring) but leaves values as plain JSON -- decimals
+ * become plain strings (unwrapped from the proto `{value}` wrapper) and
+ * datetimes pass through as ISO strings.
+ *
+ * @internal
+ */
+export declare const _ProtoToApiJson: _ProtoToApiJsonStrategy;
+
+/**
+ * Branded strategy for proto wire → API-JSON (stage 1 incoming).
+ * Performs structural transformations (key renaming, enum translation,
+ * union restructuring, decimal unwrapping) without hydrating JS objects.
+ *
+ * @internal
+ */
+export declare interface _ProtoToApiJsonStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'ProtoToApiJson';
+}
+
+/**
+ * Composed incoming strategy (proto wire → SDK types).
+ * Delegates structural work to {@link _ProtoToApiJson} and hydration to
+ * {@link _ApiJsonToType}, composed at the per-field-translator level.
+ *
+ * @internal
+ */
+export declare const _ProtoWireToType: _ProtoWireToTypeStrategy;
+
+/**
+ * Branded strategy for proto wire → SDK transformations.
+ *
+ * @internal
+ */
+export declare interface _ProtoWireToTypeStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'ProtoWireToType';
+}
+
+/**
+ * Object reference — a typed pointer to another API resource.
+ *
+ * @example
+ * ```
+ * { type: "v2.core.customer", id: "cus_1234" }
+ * ```
+ *
+ * The type parameter T must have a readonly `object` property
+ * whose string literal type becomes the `type` field's value.
+ *
+ * @discriminator :type T
+ *
+ * @public
+ */
+export declare type Ref<T extends {
+    readonly object: string;
+} = {
+    readonly object: string;
+}> = {
+    id: string;
+    type: ExtractObjectTag<T>;
+} & {
+    readonly __type?: T;
+    readonly [__brand]: 'Ref';
+    readonly [__stripeType]: 'string';
+};
+
+/**
+ * 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.
+ *
+ * The inner transformer runs first, so strategies that backfill absent values
+ * (e.g. clock-aware `translateDateTime`) can satisfy the requirement.
+ *
+ * @internal
+ */
+export declare function _required(fn?: _FieldTransformer): _FieldTransformer;
+
+/**
+ * Rounding direction for Decimal operations.
+ *
+ * @remarks
+ * Seven modes corresponding to
+ * {@link https://standards.ieee.org/ieee/754/6210/ | IEEE 754-2019} §4.3
+ * rounding-direction attributes:
+ *
+ * | Direction      | IEEE 754 name           | Behavior                          | Examples (→ integer)                  |
+ * | -------------- | ----------------------- | --------------------------------- | ------------------------------------- |
+ * | `'ceil'`       | `roundTowardPositive`   | Toward +∞                         |  1.1→2, -1.1→-1                       |
+ * | `'floor'`      | `roundTowardNegative`   | Toward -∞                         |  1.9→1, -1.1→-2                       |
+ * | `'round-down'` | `roundTowardZero`       | Toward zero (truncate)            |  1.9→1, -1.9→-1                       |
+ * | `'round-up'`   | —                       | Away from zero                    |  1.1→2, -1.1→-2                       |
+ * | `'half-up'`    | `roundTiesToAway`       | Nearest; ties away from zero      |  0.5→1, -0.5→-1, 1.4→1               |
+ * | `'half-down'`  | —                       | Nearest; ties toward zero         |  0.5→0, -0.5→0, 1.6→2                |
+ * | `'half-even'`  | `roundTiesToEven`       | Nearest; ties to even (banker's)  |  0.5→0, 1.5→2, 2.5→2, 3.5→4          |
+ *
+ * @public
+ */
+export declare type RoundDirection = 'ceil' | 'floor' | 'half-down' | 'half-even' | 'half-up' | 'round-down' | 'round-up';
+
+/**
+ * Describes how to map a named type. The generic parameter `S` brands the
+ * descriptor with the set of strategies it accepts; `apply` enforces this.
+ *
+ * @internal
+ */
+export declare class _ShapeDescriptor<_S extends _ApplyStrategy = _ApplyStrategy, _T = unknown> {
+    /** The type name, used in error messages. */
+    readonly typeName: string;
+    /** The field descriptors for this shape. */
+    readonly fields: _FieldDescriptor[];
+    /** Optional oneof field descriptors (mixed messages with regular + oneof fields). */
+    readonly oneofFields?: _OneofFieldDescriptor[];
+    constructor(typeName: string, fields: _FieldDescriptor[], oneofFields?: _OneofFieldDescriptor[]);
+}
+
+/** The type of the opaque Stripe type-tag key used in SDK scalar types. @public */
+export declare type StripeTypeSymbol = typeof __stripeType;
+
+/**
+ * Deep-freezes `value` and returns it typed as {@link DeepReadonly}`<T>`.
+ *
+ * Use this helper for module-scoped constant objects and arrays to satisfy
+ * the `dsl/no-module-scoped-mutable-const` lint rule. Unlike `Object.freeze`,
+ * which is shallow, `toConst` recursively freezes all nested objects and arrays.
+ *
+ * @example
+ * ```typescript
+ * import { toConst } from '@stripe/extensibility-sdk';
+ *
+ * const DEFAULTS = toConst({ timeout: 30, retries: 3 });
+ * // Type: { readonly timeout: 30; readonly retries: 3 }
+ *
+ * const STATUSES = toConst(['active', 'pending', 'cancelled']);
+ * // Type: readonly ["active", "pending", "cancelled"]
+ * ```
+ *
+ * @public
+ */
+export declare function toConst<T>(value: T): DeepReadonly<T>;
+
+/**
+ * Apply an element transform to each item in an array.
+ *
+ * @internal
+ */
+export declare function _translateArray(elementFn: _FieldTransformer): _FieldTransformer;
+
+/**
+ * Translate a field using the strategy's datetime conversion.
+ *
+ * @internal
+ */
+export declare const _translateDateTime: _FieldTransformer;
+
+/**
+ * Translate a field using the strategy's decimal conversion.
+ *
+ * @internal
+ */
+export declare const _translateDecimal: _FieldTransformer;
+
+/**
+ * Create a _FieldTransformer that translates an enum value using the given spec.
+ * For bidirectional proto enums, pass a `_ProtoEnum` instance.
+ * For config validation, pass a `_ConfigEnum` instance.
+ *
+ * @internal
+ */
+export declare function _translateEnum(spec: _EnumSpec): _FieldTransformer;
+
+/**
+ * Apply key/value transforms to every entry in a Record.
+ *
+ * @internal
+ */
+export declare function _translateMap(keyFn: _FieldTransformer, valueFn: _FieldTransformer): _FieldTransformer;
+
+/**
+ * Create a _FieldTransformer that applies a nested _ShapeDescriptor,
+ * threading the strategy through. Returns `undefined` for null/undefined input.
+ *
+ * Accepts a factory `() => _ShapeDescriptor` rather than a descriptor directly,
+ * so that the descriptor constant is resolved lazily at call time. This allows
+ * generated descriptors to reference each other without regard to declaration
+ * order (avoiding temporal dead zone errors with `const`).
+ *
+ * @internal
+ */
+export declare function _translateShape(getDesc: () => _ShapeDescriptor): _FieldTransformer;
+
+/**
+ * Create a _FieldTransformer that applies a _UnionDescriptor via the strategy.
+ * Returns `undefined` for null/undefined input.
+ *
+ * Accepts a factory `() => _UnionDescriptor` rather than a descriptor directly,
+ * for the same reason as `_translateShape` — lazy resolution avoids TDZ errors
+ * when generated descriptors reference each other.
+ *
+ * @internal
+ */
+export declare function _translateUnion(getDesc: () => _UnionDescriptor): _FieldTransformer;
+
+/**
+ * Stage-1 outgoing strategy: dehydrates SDK objects to API-JSON.
+ * Converts Decimal → string, Date → ISO string, but keeps camelCase keys
+ * and SDK enum values unchanged (structural transformation is stage 2).
+ *
+ * @internal
+ */
+export declare const _TypeToApiJson: _TypeToApiJsonStrategy;
+
+/**
+ * Branded strategy for SDK types → API-JSON (stage 1 outgoing).
+ * Dehydrates JS objects (Decimal → string, Date → ISO string) without
+ * performing structural transformations (key renaming stays camelCase).
+ *
+ * @internal
+ */
+export declare interface _TypeToApiJsonStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'TypeToApiJson';
+}
+
+/**
+ * Composed outgoing strategy (SDK types → proto wire).
+ * Delegates dehydration to {@link _TypeToApiJson} and structural
+ * transformation to {@link _ApiJsonToProto}, composed at the
+ * per-field-translator level.
+ *
+ * @internal
+ */
+export declare const _TypeToProtoWire: _TypeToProtoWireStrategy;
+
+/**
+ * Branded strategy for SDK → proto wire transformations.
+ *
+ * @internal
+ */
+export declare interface _TypeToProtoWireStrategy extends _ApplyStrategy {
+    /**
+     * Brand marker distinguishing this strategy from other `_ApplyStrategy` implementations.
+     * @internal
+     */
+    readonly _brand: 'TypeToProtoWire';
+}
+
+/**
+ * Describes one branch of a discriminated union.
+ *
+ * @internal
+ */
+export declare interface _UnionBranchDescriptor {
+    /** Wire key for this branch (e.g. `'one_time'`). */
+    wireKey: string;
+    /** SDK discriminant value for this branch (e.g. `'oneTime'`). */
+    typeKey: string;
+    /** Field descriptors for this branch. */
+    shape: _FieldDescriptor[];
+}
+
+/**
+ * Describes how to map a discriminated union type between wire format and
+ * SDK format. The generic parameter `_S` brands the descriptor with the set
+ * of strategies it accepts (mirrors `_ShapeDescriptor<_S>`).
+ *
+ * @internal
+ */
+export declare class _UnionDescriptor<_S extends _ApplyStrategy = _ApplyStrategy, _T = unknown> {
+    /** The type name, used in error messages. */
+    readonly typeName: string;
+    /** The SDK-side discriminant field name (e.g. `'value'`, `'kind'`). */
+    readonly discriminantFieldName: string;
+    /** The branch descriptors for this union. */
+    readonly branches: _UnionBranchDescriptor[];
+    constructor(typeName: string, discriminantFieldName: string, branches: _UnionBranchDescriptor[]);
+}
+
+/**
+ * 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.
+ *
+ * @internal
+ */
+export declare class _WireReadError extends Error {
+    /**
+     * Error class name for `instanceof`-free identification.
+     * @internal
+     */
+    name: string;
+}
+
+/**
+ * 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.
+ *
+ * @internal
+ */
+export declare class _WireWriteError extends Error {
+    /**
+     * Error class name for `instanceof`-free identification.
+     * @internal
+     */
+    name: string;
+}
+
+export { }