@stripe/extensibility-sdk 0.24.0 → 0.25.0

package/dist/stdlib/refs.d.ts

@@ -20,15 +20,23 @@ export type Ref<T extends {
 } = {
     readonly object: string;
 }> = {
-    id: string;
+    /** The object tag of the referenced resource (e.g., "v2.core.customer"). */
     type: ExtractObjectTag<T>;
+    /** The ID of the referenced resource. */
+    id: string;
 } & {
-    readonly __type?: T;
     readonly [__brand]: 'Ref';
+    readonly __type?: T;
     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> };
+export declare const Ref: {
+    create: <T extends {
+        readonly object: string;
+    }>(step: T & {
+        readonly id: string;
+    }) => Ref<T>;
+};
 /**
  * A paginated list of references to objects of type T.
  *
@@ -38,11 +46,17 @@ export type PaginatedRefList<T extends {
     readonly object: string;
 } = {
     readonly object: string;
-}> = {
-    readonly __type?: T;
+}> = Ref<T>[] & {
     readonly [__brand]: 'PaginatedRefList';
+    readonly __type?: T;
     readonly [__stripeType]: `list<${Ref<T>[StripeTypeSymbol]}>`;
-} & Ref<T>[];
+};
 /** Factory for creating {@link PaginatedRefList} values from an array of {@link Ref} items. @public */
-export declare const PaginatedRefList: { create: <T extends { readonly object: string } = { readonly object: string }>(items?: Ref<T>[]) => PaginatedRefList<T> };
+export declare const PaginatedRefList: {
+    create: <T extends {
+        readonly object: string;
+    } = {
+        readonly object: string;
+    }>(items?: Ref<T>[]) => PaginatedRefList<T>;
+};
 //# sourceMappingURL=refs.d.ts.map

package/dist/stdlib/scalars.d.ts

@@ -1,25 +1,35 @@
 import { type __integerBrand } from '@formspec/core';
 import { type __brand, type __stripeType } from './brand.js';
+import { Decimal } from './decimal.js';
 /** A branded object type representing a JSON map (`map<string>`) in the Stripe type system. @public */
-export type JsonObject = {
+export type JsonObject = object & {
     readonly [__brand]: 'JsonObject';
     readonly [__stripeType]: 'map<string>';
-} & object;
+};
 /** Factory for creating {@link JsonObject} branded values. @public */
-export declare const JsonObject: { create: (value: object) => JsonObject };
+export declare const JsonObject: {
+    create: (value: object) => JsonObject;
+};
 /** A branded integer — a `number` guaranteed to satisfy `Number.isInteger`. @public */
-export type Integer = {
+export type Integer = number & {
     readonly [__integerBrand]: true;
     readonly [__stripeType]: 'int';
-} & number;
+};
 /**
- * Distinct brand for PositiveInteger so an Integer is not assignable to
+ * 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.
- * @internal
+ *
+ * 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
  */
-declare const __positiveIntegerBrand: unique symbol;
+export declare const __positiveIntegerBrand: '__positiveIntegerBrand';
 /**
  * A branded non-negative integer — a `number` guaranteed to be an integer ≥ 0.
  *
@@ -37,11 +47,11 @@ declare const __positiveIntegerBrand: unique symbol;
  *
  * @public
  */
-export type PositiveInteger = {
+export type PositiveInteger = number & {
     readonly [__integerBrand]: true;
     readonly [__positiveIntegerBrand]: true;
     readonly [__stripeType]: 'int';
-} & number;
+};
 /**
  * Rounding directions for coercing a number to an integer.
  *
@@ -57,30 +67,53 @@ export type PositiveInteger = {
  *
  * @public
  */
-export type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
-/** Factory and type guard for {@link (Integer:type)} branded values. @public */
-export declare const Integer: {
-    from: (value: number, rounding: IntegerRoundDirection) => Integer;
-    is: (value: number) => value is Integer;
-};
-/** Factory and type guard for {@link (PositiveInteger:type)} branded values. @public */
-export declare const PositiveInteger: {
-    from: (value: number, rounding: IntegerRoundDirection) => PositiveInteger;
-    is: (value: number) => value is PositiveInteger;
-};
+export type IntegerRoundDirection = 'ceil' | 'floor' | 'round-down' | 'round-up' | 'half-up';
+/** @public */
+export 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: string | number | Decimal | Integer, 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;
+}
+/** Factory, type guard, and utilities for {@link (Integer:type)} branded values. @public */
+export declare const Integer: IntegerCompanion;
+/** @public */
+export 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: string | number | Decimal | Integer, rounding: IntegerRoundDirection): PositiveInteger;
+}
+/** Factory, type guard, and utilities for {@link (PositiveInteger:type)} branded values. @public */
+export declare const PositiveInteger: PositiveIntegerCompanion;
 /** A branded string representing a street address. @public */
-export type StreetAddress = {
+export type StreetAddress = string & {
     readonly [__brand]: 'StreetAddress';
     readonly [__stripeType]: 'string';
-} & string;
+};
 /** Factory for creating {@link (StreetAddress:type)} branded values. @public */
-export declare const StreetAddress: { create: (address: string) => StreetAddress };
+export declare const StreetAddress: {
+    create: (address: string) => StreetAddress;
+};
 /** A branded string representing an ISO 8601 datetime. @public */
-export type Timestamp = {
+export type Timestamp = string & {
     readonly [__brand]: 'Timestamp';
     readonly [__stripeType]: 'string';
-} & string;
+};
 /** Factory for creating {@link (Timestamp:type)} branded values. @public */
-export declare const Timestamp: { create: (value: string) => Timestamp };
-export {};
+export declare const Timestamp: {
+    create: (value: string) => Timestamp;
+};
 //# sourceMappingURL=scalars.d.ts.map

package/dist/stdlib/scalars.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scalars.d.ts","sourceRoot":"","sources":["../../src/stdlib/scalars.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE7D,uGAAuG;AACvG,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAChC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;CACxC,CAAC;AAEF,sEAAsE;AACtE,eAAO,MAAM,UAAU;oBACL,MAAM,KAAG,UAAU;CAIpC,CAAC;AAEF,uFAAuF;AACvF,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG;IAC7B,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IAChC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AAEF;;;;;;GAMG;AACH,OAAO,CAAC,MAAM,sBAAsB,EAAE,OAAO,MAAM,CAAC;AAEpD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IACrC,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IAChC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC;IACxC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,OAAO,GACP,YAAY,GACZ,UAAU,GACV,SAAS,CAAC;AAuBd,gFAAgF;AAChF,eAAO,MAAM,OAAO;IAClB;;;;;;;;;;;;OAYG;gBACS,MAAM,KAAG,KAAK,IAAI,OAAO;IAErC;;;;;;;;;;;OAWG;kBACW,MAAM,YAAY,qBAAqB,KAAG,OAAO;CAOhE,CAAC;AAEF,wFAAwF;AACxF,eAAO,MAAM,eAAe;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,KAAG,KAAK,IAAI,eAAe;IAE7C;;;;;;;;;;OAUG;kBACW,MAAM,YAAY,qBAAqB,KAAG,eAAe;CAcxE,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IACnC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC;IACpC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;CACnC,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,aAAa;sBACN,MAAM,KAAG,aAAa;CAIzC,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAC/B,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAEhC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;CACnC,CAAC;AAEF,4EAA4E;AAC5E,eAAO,MAAM,SAAS;oBACJ,MAAM,KAAG,SAAS;CAInC,CAAC"}
+{"version":3,"file":"scalars.d.ts","sourceRoot":"","sources":["../../src/stdlib/scalars.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAI7D,OAAO,EAAE,OAAO,EAAa,MAAM,cAAc,CAAC;AAElD,uGAAuG;AACvG,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAChC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;CACxC,CAAC;AAEF,sEAAsE;AACtE,eAAO,MAAM,UAAU;oBACL,MAAM,KAAG,UAAU;CAIpC,CAAC;AAEF,uFAAuF;AACvF,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG;IAC7B,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IAChC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,sBAAsB,EAAE,wBAAwB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IACrC,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IAChC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC;IACxC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,OAAO,GACP,YAAY,GACZ,UAAU,GACV,SAAS,CAAC;AAiEd,cAAc;AACd,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,uEAAuE;IACvE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAAC;IACrC,wEAAwE;IACxE,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC;IACjD,oEAAoE;IACpE,IAAI,CACF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,EAC1C,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC;IACX,gDAAgD;IAChD,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;IACnC,4FAA4F;IAC5F,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAAC;IACrD,kEAAkE;IAClE,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,eAAe,CAAC;CACpE;AAED,4FAA4F;AAC5F,eAAO,MAAM,OAAO,EAAE,gBAgKrB,CAAC;AAEF,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,+EAA+E;IAC/E,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAAC;IAC7C,+EAA+E;IAC/E,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,eAAe,CAAC;IACzD,gGAAgG;IAChG,IAAI,CACF,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,EAC1C,QAAQ,EAAE,qBAAqB,GAC9B,eAAe,CAAC;CACpB;AAED,oGAAoG;AACpG,eAAO,MAAM,eAAe,EAAE,wBAoE7B,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IACnC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC;IACpC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;CACnC,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,aAAa;sBACN,MAAM,KAAG,aAAa;CAIzC,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAC/B,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAEhC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;CACnC,CAAC;AAEF,4EAA4E;AAC5E,eAAO,MAAM,SAAS;oBACJ,MAAM,KAAG,SAAS;CAInC,CAAC"}

package/dist/stdlib/to-const.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 type DeepReadonly<T> = T extends string | number | boolean | bigint | symbol | undefined | null ? T : T extends readonly (infer Item)[] ? readonly DeepReadonly<Item>[] : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
+/**
+ * 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>;
+//# sourceMappingURL=to-const.d.ts.map

package/dist/stdlib/to-const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-const.d.ts","sourceRoot":"","sources":["../../src/stdlib/to-const.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAC3B,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACT,IAAI,GACJ,CAAC,GACD,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,GAC/B,SAAS,YAAY,CAAC,IAAI,CAAC,EAAE,GAC7B,CAAC,SAAS,MAAM,GACd;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC/C,CAAC,CAAC;AAEV;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAoBpD"}

package/dist/stdlib/type-utils.d.ts

@@ -3,5 +3,7 @@
  *
  * @public
  */
-export type ExtractObjectTag<T> = T extends { readonly object: infer O } ? O extends string ? O : never : never;
+export type ExtractObjectTag<T> = T extends {
+    readonly object: infer O;
+} ? O extends string ? O : never : never;
 //# sourceMappingURL=type-utils.d.ts.map

package/dist/stdlib/types.d.ts

@@ -52,12 +52,12 @@ export interface _EnumSpec {
      * Convert a wire value to an SDK value, or `null` if unknown.
      * @internal
      */
-    fromWire(value: string): null | string;
+    fromWire(value: string): string | null;
     /**
      * Convert an SDK value to a wire value, or `null` if unknown.
      * @internal
      */
-    toWire(value: string): null | string;
+    toWire(value: string): string | null;
 }
 /**
  * Bidirectional enum spec for proto-backed enums. Accepts a single
@@ -74,12 +74,12 @@ export declare class _ProtoEnum implements _EnumSpec {
      * Convert a proto wire value to an SDK value, or `null` if unknown.
      * @internal
      */
-    fromWire(value: string): null | string;
+    fromWire(value: string): string | null;
     /**
      * Convert an SDK value to a proto wire value, or `null` if unknown.
      * @internal
      */
-    toWire(value: string): null | string;
+    toWire(value: string): string | null;
 }
 /**
  * Validation-only enum spec for config values. Accepts a set of known
@@ -95,12 +95,12 @@ export declare class _ConfigEnum implements _EnumSpec {
      * Validate and return the wire value unchanged, or `null` if unknown.
      * @internal
      */
-    fromWire(value: string): null | string;
+    fromWire(value: string): string | null;
     /**
      * Validate and return the SDK value unchanged, or `null` if unknown.
      * @internal
      */
-    toWire(value: string): null | string;
+    toWire(value: string): string | null;
 }
 /**
  * A field transformer with the strategy threaded through so transforms can