@stripe/extensibility-sdk 0.26.0 → 0.27.1

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

@@ -1,579 +0,0 @@
-/**
- * @deprecated Import from `@stripe/extensibility-sdk` instead.
- * @packageDocumentation
- */
-
-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';
-
-/* Excluded from this release type: __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';
-
-/* Excluded from this release type: _apply */
-
-/* Excluded from this release type: _applyConfig */
-
-/* Excluded from this release type: _applyIncoming */
-
-/* Excluded from this release type: _applyOutgoing */
-
-/* Excluded from this release type: _ApplyStrategy */
-
-/** The type of the opaque brand key used as a property key in SDK branded types. @public */
-export declare type BrandSymbol = typeof __brand;
-
-/* Excluded from this release type: _configAppContextFromContext */
-
-/* Excluded from this release type: _ConfigApplicationContext */
-
-/* Excluded from this release type: _ConfigEnum */
-
-/** @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' | 'mop' | 'mro' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | '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' | '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/stdlib';
- *
- * 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 {
-    /* Excluded from this release type: __brand */
-    /* Excluded from this release type: __decimalBrand */
-    /* Excluded from this release type: __stripeType */
-    /**
-     * 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;
-
-/* Excluded from this release type: _EnumSpec */
-
-/**
- * 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;
-
-/* Excluded from this release type: _FieldDescriptor */
-
-/* Excluded from this release type: _FieldTransformer */
-
-/* Excluded from this release type: _identity */
-
-/** 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';
-
-/* Excluded from this release type: _isPromiseLike */
-
-/* Excluded from this release type: _JsonWireToType */
-
-/* Excluded from this release type: _JsonWireToTypeStrategy */
-
-/**
- * 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;
-}
-
-/* Excluded from this release type: _OneofBranchDescriptor */
-
-/* Excluded from this release type: _OneofFieldDescriptor */
-
-/**
- * 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;
-}
-
-/* Excluded from this release type: _ProtoEnum */
-
-/* Excluded from this release type: _ProtoWireToType */
-
-/* Excluded from this release type: _ProtoWireToTypeStrategy */
-
-/**
- * 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';
-};
-
-/** Factory for creating {@link (Ref:type)} values from an object with `object` and `id` fields. @public */
-export declare const Ref: { create: <T extends { readonly object: string }>(step: { readonly id: string } & T) => Ref<T> };
-
-/* Excluded from this release type: _required */
-
-/**
- * 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';
-
-/* Excluded from this release type: _ShapeDescriptor */
-
-/** 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/stdlib';
- *
- * 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>;
-
-/* Excluded from this release type: _translateArray */
-
-/* Excluded from this release type: _translateDateTime */
-
-/* Excluded from this release type: _translateDecimal */
-
-/* Excluded from this release type: _translateEnum */
-
-/* Excluded from this release type: _translateMap */
-
-/* Excluded from this release type: _translateShape */
-
-/* Excluded from this release type: _translateUnion */
-
-/* Excluded from this release type: _TypeToProtoWire */
-
-/* Excluded from this release type: _TypeToProtoWireStrategy */
-
-/* Excluded from this release type: _UnionBranchDescriptor */
-
-/* Excluded from this release type: _UnionDescriptor */
-
-/* Excluded from this release type: _WireReadError */
-
-/* Excluded from this release type: _WireWriteError */
-
-export { }