@nlozgachev/pipelined 0.63.0 → 0.65.0

package/dist/index-Bs8En5LJ.d.cts

@@ -0,0 +1,238 @@
+//#region src/Types/Brand.d.ts
+declare const _brand: unique symbol;
+/**
+ * Brand<K, T> creates a nominal type by tagging T with a phantom brand K.
+ * Prevents accidentally mixing up values that share the same underlying type.
+ *
+ * @example
+ * ```ts
+ * type UserId = Brand<"UserId", string>;
+ * type ProductId = Brand<"ProductId", string>;
+ *
+ * const toUserId = Brand.wrap<"UserId", string>();
+ * const toProductId = Brand.wrap<"ProductId", string>();
+ *
+ * const userId: UserId = toUserId("user-123");
+ * const productId: ProductId = toProductId("prod-456");
+ *
+ * // Type error: ProductId is not assignable to UserId
+ * // const wrong: UserId = productId;
+ * ```
+ */
+type Brand<K extends string, T> = T & {
+  readonly [_brand]: K;
+};
+declare const Brand: {
+  /**
+   * Returns a constructor that wraps a value of type T in brand K.
+   * The resulting function performs an unchecked cast — only use when the raw
+   * value is known to satisfy the brand's invariants.
+   *
+   * @example
+   * ```ts
+   * type PositiveNumber = Brand<"PositiveNumber", number>;
+   * const toPositiveNumber = Brand.wrap<"PositiveNumber", number>();
+   *
+   * const n: PositiveNumber = toPositiveNumber(42);
+   * ```
+   */
+  wrap: <K extends string, T>() => (value: T) => Brand<K, T>;
+  /**
+   * Strips the brand and returns the underlying value.
+   * Since Brand<K, T> extends T this is rarely needed, but can improve readability.
+   *
+   * @example
+   * ```ts
+   * type UserId = Brand<"UserId", string>;
+   * const toUserId = Brand.wrap<"UserId", string>();
+   * const userId: UserId = toUserId("user-123");
+   * const raw: string = Brand.unwrap(userId); // "user-123"
+   * ```
+   */
+  unwrap: <K extends string, T>(branded: Brand<K, T>) => T;
+};
+//#endregion
+//#region src/Types/Duration.d.ts
+/**
+ * A branded nominal type representing a duration of time in milliseconds.
+ * Use Duration to ensure safe time-based operators and clear unit conversions.
+ *
+ * @example
+ * ```ts
+ * const halfSecond = Duration.milliseconds(500);
+ * const twoSeconds = Duration.seconds(2);
+ * const total = pipe(halfSecond, Duration.add(twoSeconds));
+ *
+ * Duration.to.seconds(total); // 2.5
+ * ```
+ */
+type Duration = Brand<"Duration", number>;
+declare const Duration: {
+  /**
+   * Creates a Duration from milliseconds.
+   *
+   * @example
+   * ```ts
+   * Duration.milliseconds(500); // 500ms Duration
+   * ```
+   */
+  milliseconds: (ms: number) => Duration;
+  /**
+   * Creates a Duration from seconds.
+   *
+   * @example
+   * ```ts
+   * Duration.seconds(2); // 2000ms Duration
+   * ```
+   */
+  seconds: (s: number) => Duration;
+  /**
+   * Creates a Duration from minutes.
+   *
+   * @example
+   * ```ts
+   * Duration.minutes(5); // 300000ms Duration
+   * ```
+   */
+  minutes: (m: number) => Duration;
+  /**
+   * Creates a Duration from hours.
+   *
+   * @example
+   * ```ts
+   * Duration.hours(1); // 3600000ms Duration
+   * ```
+   */
+  hours: (h: number) => Duration;
+  /**
+   * Creates a Duration from days.
+   *
+   * @example
+   * ```ts
+   * Duration.days(1); // 86400000ms Duration
+   * ```
+   */
+  days: (d: number) => Duration;
+  to: {
+    /**
+     * Converts a Duration back to raw milliseconds.
+     *
+     * @example
+     * ```ts
+     * Duration.to.milliseconds(Duration.seconds(2)); // 2000
+     * ```
+     */
+    milliseconds: (d: Duration) => number;
+    /**
+     * Converts a Duration to seconds.
+     *
+     * @example
+     * ```ts
+     * Duration.to.seconds(Duration.milliseconds(2500)); // 2.5
+     * ```
+     */
+    seconds: (d: Duration) => number;
+    /**
+     * Converts a Duration to minutes.
+     *
+     * @example
+     * ```ts
+     * Duration.to.minutes(Duration.seconds(120)); // 2
+     * ```
+     */
+    minutes: (d: Duration) => number;
+    /**
+     * Converts a Duration to hours.
+     *
+     * @example
+     * ```ts
+     * Duration.to.hours(Duration.minutes(90)); // 1.5
+     * ```
+     */
+    hours: (d: Duration) => number;
+    /**
+     * Converts a Duration to days.
+     *
+     * @example
+     * ```ts
+     * Duration.to.days(Duration.hours(36)); // 1.5
+     * ```
+     */
+    days: (d: Duration) => number;
+  };
+  /**
+   * Adds two Durations together.
+   *
+   * @example
+   * ```ts
+   * pipe(Duration.seconds(1), Duration.add(Duration.milliseconds(500))); // 1500ms
+   * ```
+   */
+  add: (other: Duration) => (self: Duration) => Duration;
+  /**
+   * Subtracts the other Duration from this one.
+   *
+   * @example
+   * ```ts
+   * pipe(Duration.seconds(1), Duration.subtract(Duration.milliseconds(500))); // 500ms
+   * ```
+   */
+  subtract: (other: Duration) => (self: Duration) => Duration;
+};
+//#endregion
+//#region src/Types/RetryPolicy.d.ts
+/**
+ * An immutable policy describing retry limits and backoff delay strategies.
+ *
+ * @example
+ * ```ts
+ * const policy: RetryPolicy = RetryPolicy.constant({
+ *   attempts: 3,
+ *   delay: Duration.seconds(1),
+ * });
+ * ```
+ */
+type RetryPolicy = {
+  readonly attempts: number;
+  readonly getDelay: (attempt: number) => Duration;
+};
+declare const RetryPolicy: {
+  /**
+   * Creates a RetryPolicy with a constant delay between retry attempts.
+   *
+   * @example
+   * ```ts
+   * const policy = RetryPolicy.constant({
+   *   attempts: 3,
+   *   delay: Duration.seconds(1),
+   * });
+   * ```
+   */
+  constant: (options: {
+    attempts: number;
+    delay: Duration;
+  }) => RetryPolicy;
+  /**
+   * Creates a RetryPolicy with exponential backoff delays between attempts.
+   * An optional `factor` (default 2) controls the growth rate.
+   * An optional `jitter` (default false) adds randomized variance to prevent thundering herd problems.
+   *
+   * @example
+   * ```ts
+   * const policy = RetryPolicy.exponential({
+   *   attempts: 5,
+   *   initial: Duration.milliseconds(100),
+   *   factor: 2,
+   *   jitter: true,
+   * });
+   * ```
+   */
+  exponential: (options: {
+    attempts: number;
+    initial: Duration;
+    factor?: number;
+    jitter?: boolean;
+  }) => RetryPolicy;
+};
+//#endregion
+export { Duration as n, Brand as r, RetryPolicy as t };

package/dist/index-Bs8En5LJ.d.ts

@@ -0,0 +1,238 @@
+//#region src/Types/Brand.d.ts
+declare const _brand: unique symbol;
+/**
+ * Brand<K, T> creates a nominal type by tagging T with a phantom brand K.
+ * Prevents accidentally mixing up values that share the same underlying type.
+ *
+ * @example
+ * ```ts
+ * type UserId = Brand<"UserId", string>;
+ * type ProductId = Brand<"ProductId", string>;
+ *
+ * const toUserId = Brand.wrap<"UserId", string>();
+ * const toProductId = Brand.wrap<"ProductId", string>();
+ *
+ * const userId: UserId = toUserId("user-123");
+ * const productId: ProductId = toProductId("prod-456");
+ *
+ * // Type error: ProductId is not assignable to UserId
+ * // const wrong: UserId = productId;
+ * ```
+ */
+type Brand<K extends string, T> = T & {
+  readonly [_brand]: K;
+};
+declare const Brand: {
+  /**
+   * Returns a constructor that wraps a value of type T in brand K.
+   * The resulting function performs an unchecked cast — only use when the raw
+   * value is known to satisfy the brand's invariants.
+   *
+   * @example
+   * ```ts
+   * type PositiveNumber = Brand<"PositiveNumber", number>;
+   * const toPositiveNumber = Brand.wrap<"PositiveNumber", number>();
+   *
+   * const n: PositiveNumber = toPositiveNumber(42);
+   * ```
+   */
+  wrap: <K extends string, T>() => (value: T) => Brand<K, T>;
+  /**
+   * Strips the brand and returns the underlying value.
+   * Since Brand<K, T> extends T this is rarely needed, but can improve readability.
+   *
+   * @example
+   * ```ts
+   * type UserId = Brand<"UserId", string>;
+   * const toUserId = Brand.wrap<"UserId", string>();
+   * const userId: UserId = toUserId("user-123");
+   * const raw: string = Brand.unwrap(userId); // "user-123"
+   * ```
+   */
+  unwrap: <K extends string, T>(branded: Brand<K, T>) => T;
+};
+//#endregion
+//#region src/Types/Duration.d.ts
+/**
+ * A branded nominal type representing a duration of time in milliseconds.
+ * Use Duration to ensure safe time-based operators and clear unit conversions.
+ *
+ * @example
+ * ```ts
+ * const halfSecond = Duration.milliseconds(500);
+ * const twoSeconds = Duration.seconds(2);
+ * const total = pipe(halfSecond, Duration.add(twoSeconds));
+ *
+ * Duration.to.seconds(total); // 2.5
+ * ```
+ */
+type Duration = Brand<"Duration", number>;
+declare const Duration: {
+  /**
+   * Creates a Duration from milliseconds.
+   *
+   * @example
+   * ```ts
+   * Duration.milliseconds(500); // 500ms Duration
+   * ```
+   */
+  milliseconds: (ms: number) => Duration;
+  /**
+   * Creates a Duration from seconds.
+   *
+   * @example
+   * ```ts
+   * Duration.seconds(2); // 2000ms Duration
+   * ```
+   */
+  seconds: (s: number) => Duration;
+  /**
+   * Creates a Duration from minutes.
+   *
+   * @example
+   * ```ts
+   * Duration.minutes(5); // 300000ms Duration
+   * ```
+   */
+  minutes: (m: number) => Duration;
+  /**
+   * Creates a Duration from hours.
+   *
+   * @example
+   * ```ts
+   * Duration.hours(1); // 3600000ms Duration
+   * ```
+   */
+  hours: (h: number) => Duration;
+  /**
+   * Creates a Duration from days.
+   *
+   * @example
+   * ```ts
+   * Duration.days(1); // 86400000ms Duration
+   * ```
+   */
+  days: (d: number) => Duration;
+  to: {
+    /**
+     * Converts a Duration back to raw milliseconds.
+     *
+     * @example
+     * ```ts
+     * Duration.to.milliseconds(Duration.seconds(2)); // 2000
+     * ```
+     */
+    milliseconds: (d: Duration) => number;
+    /**
+     * Converts a Duration to seconds.
+     *
+     * @example
+     * ```ts
+     * Duration.to.seconds(Duration.milliseconds(2500)); // 2.5
+     * ```
+     */
+    seconds: (d: Duration) => number;
+    /**
+     * Converts a Duration to minutes.
+     *
+     * @example
+     * ```ts
+     * Duration.to.minutes(Duration.seconds(120)); // 2
+     * ```
+     */
+    minutes: (d: Duration) => number;
+    /**
+     * Converts a Duration to hours.
+     *
+     * @example
+     * ```ts
+     * Duration.to.hours(Duration.minutes(90)); // 1.5
+     * ```
+     */
+    hours: (d: Duration) => number;
+    /**
+     * Converts a Duration to days.
+     *
+     * @example
+     * ```ts
+     * Duration.to.days(Duration.hours(36)); // 1.5
+     * ```
+     */
+    days: (d: Duration) => number;
+  };
+  /**
+   * Adds two Durations together.
+   *
+   * @example
+   * ```ts
+   * pipe(Duration.seconds(1), Duration.add(Duration.milliseconds(500))); // 1500ms
+   * ```
+   */
+  add: (other: Duration) => (self: Duration) => Duration;
+  /**
+   * Subtracts the other Duration from this one.
+   *
+   * @example
+   * ```ts
+   * pipe(Duration.seconds(1), Duration.subtract(Duration.milliseconds(500))); // 500ms
+   * ```
+   */
+  subtract: (other: Duration) => (self: Duration) => Duration;
+};
+//#endregion
+//#region src/Types/RetryPolicy.d.ts
+/**
+ * An immutable policy describing retry limits and backoff delay strategies.
+ *
+ * @example
+ * ```ts
+ * const policy: RetryPolicy = RetryPolicy.constant({
+ *   attempts: 3,
+ *   delay: Duration.seconds(1),
+ * });
+ * ```
+ */
+type RetryPolicy = {
+  readonly attempts: number;
+  readonly getDelay: (attempt: number) => Duration;
+};
+declare const RetryPolicy: {
+  /**
+   * Creates a RetryPolicy with a constant delay between retry attempts.
+   *
+   * @example
+   * ```ts
+   * const policy = RetryPolicy.constant({
+   *   attempts: 3,
+   *   delay: Duration.seconds(1),
+   * });
+   * ```
+   */
+  constant: (options: {
+    attempts: number;
+    delay: Duration;
+  }) => RetryPolicy;
+  /**
+   * Creates a RetryPolicy with exponential backoff delays between attempts.
+   * An optional `factor` (default 2) controls the growth rate.
+   * An optional `jitter` (default false) adds randomized variance to prevent thundering herd problems.
+   *
+   * @example
+   * ```ts
+   * const policy = RetryPolicy.exponential({
+   *   attempts: 5,
+   *   initial: Duration.milliseconds(100),
+   *   factor: 2,
+   *   jitter: true,
+   * });
+   * ```
+   */
+  exponential: (options: {
+    attempts: number;
+    initial: Duration;
+    factor?: number;
+    jitter?: boolean;
+  }) => RetryPolicy;
+};
+//#endregion
+export { Duration as n, Brand as r, RetryPolicy as t };