@atproto-labs/pipe 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atproto-labs/pipe
 
+## 0.1.1
+
+### Patch Changes
+
+- [#3821](https://github.com/bluesky-social/atproto/pull/3821) [`5050b6550`](https://github.com/bluesky-social/atproto/commit/5050b6550e07e71b0a524eda0b71b837583294d4) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Allow first pipeline function to have more than one argument
+
 ## 0.1.0
 
 ### Minor Changes

package/LICENSE.txt

@@ -1,6 +1,6 @@
 Dual MIT/Apache-2.0 License
 
-Copyright (c) 2022-2024 Bluesky PBC, and Contributors
+Copyright (c) 2022-2025 Bluesky Social PBC, and Contributors
 
 Except as otherwise noted in individual files, this software is licensed under the MIT license (<http://opensource.org/licenses/MIT>), or the Apache License, Version 2.0 (<http://www.apache.org/licenses/LICENSE-2.0>).
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { pipe, pipeTwo } from './pipe.js';
-export { type Transformer } from './transformer.js';
+export type * from './type.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACzC,mBAAmB,WAAW,CAAA"}

package/dist/pipe.d.ts

@@ -1,13 +1,11 @@
-import { Transformer } from './transformer.js';
-type PipelineInput<T extends readonly Transformer<any>[]> = T extends [
-    Transformer<infer I, any>,
+import { Fn, Transformer } from './type.js';
+type PipelineArgs<T> = T extends [
+    Fn<infer A extends readonly unknown[], any>,
     ...any[]
-] ? I : T extends Transformer<infer I, any>[] ? I : never;
-type PipelineOutput<T extends readonly Transformer<any>[]> = T extends [
-    ...any[],
-    Transformer<any, infer O>
-] ? O : T extends Transformer<any, infer O>[] ? O : never;
-type Pipeline<F extends readonly Transformer<any>[], Acc extends readonly Transformer<any>[] = []> = F extends [Transformer<infer I, infer O>] ? [...Acc, Transformer<I, O>] : F extends [Transformer<infer A, any>, ...infer Tail] ? Tail extends [Transformer<infer B, any>, ...any[]] ? Pipeline<Tail, [...Acc, Transformer<A, B>]> : Acc : Acc;
+] ? A : never;
+type PipelineOutput<T> = T extends [...any[], Fn<any, infer O>] ? O : never;
+type PipelineRecursive<F extends readonly Transformer<any>[], Acc extends any[]> = F extends readonly [Transformer<infer I, infer O>] ? [...Acc, Transformer<I, O>] : F extends readonly [Transformer<infer A, any>, ...infer Tail] ? Tail extends readonly [Transformer<infer B, any>, ...any[]] ? PipelineRecursive<Tail, [...Acc, Transformer<A, B>]> : never : never;
+type Pipeline<F extends readonly [Fn<any, any>, ...Transformer<any>[]]> = F extends readonly [Fn<infer A, infer O>] ? [Fn<A, O>] : F extends readonly [Fn<infer A, any>, ...infer Tail] ? Tail extends readonly [Transformer<infer B, any>, ...any[]] ? PipelineRecursive<Tail, [Fn<A, B>]> : never : never;
 /**
  * This utility function allows to properly type a pipeline of transformers.
  *
@@ -24,8 +22,7 @@ type Pipeline<F extends readonly Transformer<any>[], Acc extends readonly Transf
  * )
  * ```
  */
-export declare function pipe(): never;
-export declare function pipe<T extends readonly Transformer<any>[]>(...pipeline: Pipeline<T> extends T ? T : Pipeline<T>): (input: PipelineInput<T>) => Promise<PipelineOutput<T>>;
-export declare function pipeTwo<I, O, X = unknown>(first: Transformer<I, X>, second: Transformer<X, O>): (input: I) => Promise<O>;
+export declare function pipe<T extends readonly [Fn<any, any>, ...Transformer<any>[]]>(...pipeline: Pipeline<T> extends T ? T : Pipeline<T>): (...args: PipelineArgs<T>) => Promise<PipelineOutput<T>>;
+export declare function pipeTwo<A extends readonly unknown[], O, X = unknown>(first: Fn<A, X>, second: Transformer<X, O>): (...args: A) => Promise<O>;
 export {};
 //# sourceMappingURL=pipe.d.ts.map

package/dist/pipe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pipe.d.ts","sourceRoot":"","sources":["../src/pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS;IACpE,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;IACzB,GAAG,GAAG,EAAE;CACT,GACG,CAAC,GACD,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GACnC,CAAC,GACD,KAAK,CAAA;AAEX,KAAK,cAAc,CAAC,CAAC,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS;IACrE,GAAG,GAAG,EAAE;IACR,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;CAC1B,GACG,CAAC,GACD,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,GACnC,CAAC,GACD,KAAK,CAAA;AAEX,KAAK,QAAQ,CACX,CAAC,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,EACrC,GAAG,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,IAC1C,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GACzC,CAAC,GAAG,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC3B,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,GAClD,IAAI,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAChD,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAC3C,GAAG,GACL,GAAG,CAAA;AAET;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,IAAI,IAAI,KAAK,CAAA;AAC7B,wBAAgB,IAAI,CAAC,CAAC,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,EACxD,GAAG,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GACnD,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;AAO1D,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO,EACvC,KAAK,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GACxB,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAE1B"}
+{"version":3,"file":"pipe.d.ts","sourceRoot":"","sources":["../src/pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE3C,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;IAC/B,EAAE,CAAC,MAAM,CAAC,SAAS,SAAS,OAAO,EAAE,EAAE,GAAG,CAAC;IAC3C,GAAG,GAAG,EAAE;CACT,GACG,CAAC,GACD,KAAK,CAAA;AAET,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAE3E,KAAK,iBAAiB,CACpB,CAAC,SAAS,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,EACrC,GAAG,SAAS,GAAG,EAAE,IACf,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAClD,CAAC,GAAG,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC3B,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,GAC3D,IAAI,SAAS,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GACzD,iBAAiB,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACpD,KAAK,GACP,KAAK,CAAA;AAEX,KAAK,QAAQ,CAAC,CAAC,SAAS,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IACpE,CAAC,SAAS,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GACrC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,GAClD,IAAI,SAAS,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GACzD,iBAAiB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACnC,KAAK,GACP,KAAK,CAAA;AAEb;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAC3E,GAAG,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAEjB,CACjC,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,KACrB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAChC;AAED,wBAAgB,OAAO,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,OAAO,EAClE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EACf,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GACxB,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAE5B"}

package/dist/pipe.js

@@ -1,12 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pipeTwo = exports.pipe = void 0;
+exports.pipe = pipe;
+exports.pipeTwo = pipeTwo;
+/**
+ * This utility function allows to properly type a pipeline of transformers.
+ *
+ * @example
+ * ```ts
+ * // Will be typed as "(input: string) => Promise<number>"
+ * const parse = pipe(
+ *   async (input: string) => JSON.parse(input),
+ *   async (input: unknown) => {
+ *     if (typeof input === 'number') return input
+ *     throw new TypeError('Invalid input')
+ *   },
+ *   (input: number) => input * 2,
+ * )
+ * ```
+ */
 function pipe(...pipeline) {
     return pipeline.reduce(pipeTwo);
 }
-exports.pipe = pipe;
 function pipeTwo(first, second) {
-    return async (input) => second(await first(input));
+    return async (...args) => second(await first(...args));
 }
-exports.pipeTwo = pipeTwo;
 //# sourceMappingURL=pipe.js.map

package/dist/pipe.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../src/pipe.ts"],"names":[],"mappings":";;;AAmDA,SAAgB,IAAI,CAClB,GAAG,QAAiD;IAEpD,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC;AAJD,oBAIC;AAED,SAAgB,OAAO,CACrB,KAAwB,EACxB,MAAyB;IAEzB,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;AACpD,CAAC;AALD,0BAKC"}
+{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../src/pipe.ts"],"names":[],"mappings":";;AA+CA,oBAMC;AAED,0BAKC;AA7BD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,IAAI,CAClB,GAAG,QAAiD;IAEpD,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAEC,CAAA;AACjC,CAAC;AAED,SAAgB,OAAO,CACrB,KAAe,EACf,MAAyB;IAEzB,OAAO,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;AACxD,CAAC"}

package/dist/type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generic, potentially async, function. Parametrized for convenience reasons.
+ */
+export type Fn<A extends readonly unknown[], O> = (...args: A) => O | PromiseLike<O>;
+/**
+ * Single input, single output, potentially async transformer function.
+ */
+export type Transformer<I, O = I> = (...args: [I]) => O | PromiseLike<O>;
+//# sourceMappingURL=type.d.ts.map

package/dist/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EAAE,CAAC,IAAI,CAChD,GAAG,IAAI,EAAE,CAAC,KACP,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAEvB;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA"}

package/dist/{transformer.js → type.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=transformer.js.map
+//# sourceMappingURL=type.js.map

package/dist/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto-labs/pipe",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "description": "Library for combining multiple functions into a single function.",
   "keywords": [
@@ -22,9 +22,8 @@
       "default": "./dist/index.js"
     }
   },
-  "dependencies": {},
   "devDependencies": {
-    "typescript": "^5.3.3"
+    "typescript": "^5.6.3"
   },
   "scripts": {
     "build": "tsc --build tsconfig.json"

package/src/index.ts

@@ -1,2 +1,2 @@
 export { pipe, pipeTwo } from './pipe.js'
-export { type Transformer } from './transformer.js'
+export type * from './type.js'

package/src/pipe.ts

@@ -1,33 +1,33 @@
-import { Transformer } from './transformer.js'
+import { Fn, Transformer } from './type.js'
 
-type PipelineInput<T extends readonly Transformer<any>[]> = T extends [
-  Transformer<infer I, any>,
+type PipelineArgs<T> = T extends [
+  Fn<infer A extends readonly unknown[], any>,
   ...any[],
 ]
-  ? I
-  : T extends Transformer<infer I, any>[]
-    ? I
-    : never
+  ? A
+  : never
 
-type PipelineOutput<T extends readonly Transformer<any>[]> = T extends [
-  ...any[],
-  Transformer<any, infer O>,
-]
-  ? O
-  : T extends Transformer<any, infer O>[]
-    ? O
-    : never
+type PipelineOutput<T> = T extends [...any[], Fn<any, infer O>] ? O : never
 
-type Pipeline<
+type PipelineRecursive<
   F extends readonly Transformer<any>[],
-  Acc extends readonly Transformer<any>[] = [],
-> = F extends [Transformer<infer I, infer O>]
+  Acc extends any[],
+> = F extends readonly [Transformer<infer I, infer O>]
   ? [...Acc, Transformer<I, O>]
-  : F extends [Transformer<infer A, any>, ...infer Tail]
-    ? Tail extends [Transformer<infer B, any>, ...any[]]
-      ? Pipeline<Tail, [...Acc, Transformer<A, B>]>
-      : Acc
-    : Acc
+  : F extends readonly [Transformer<infer A, any>, ...infer Tail]
+    ? Tail extends readonly [Transformer<infer B, any>, ...any[]]
+      ? PipelineRecursive<Tail, [...Acc, Transformer<A, B>]>
+      : never
+    : never
+
+type Pipeline<F extends readonly [Fn<any, any>, ...Transformer<any>[]]> =
+  F extends readonly [Fn<infer A, infer O>]
+    ? [Fn<A, O>]
+    : F extends readonly [Fn<infer A, any>, ...infer Tail]
+      ? Tail extends readonly [Transformer<infer B, any>, ...any[]]
+        ? PipelineRecursive<Tail, [Fn<A, B>]>
+        : never
+      : never
 
 /**
  * This utility function allows to properly type a pipeline of transformers.
@@ -45,19 +45,17 @@ type Pipeline<
  * )
  * ```
  */
-export function pipe(): never
-export function pipe<T extends readonly Transformer<any>[]>(
-  ...pipeline: Pipeline<T> extends T ? T : Pipeline<T>
-): (input: PipelineInput<T>) => Promise<PipelineOutput<T>>
-export function pipe<T extends readonly Transformer<any>[]>(
+export function pipe<T extends readonly [Fn<any, any>, ...Transformer<any>[]]>(
   ...pipeline: Pipeline<T> extends T ? T : Pipeline<T>
-): (input: PipelineInput<T>) => Promise<PipelineOutput<T>> {
-  return pipeline.reduce(pipeTwo)
+) {
+  return pipeline.reduce(pipeTwo) as (
+    ...args: PipelineArgs<T>
+  ) => Promise<PipelineOutput<T>>
 }
 
-export function pipeTwo<I, O, X = unknown>(
-  first: Transformer<I, X>,
+export function pipeTwo<A extends readonly unknown[], O, X = unknown>(
+  first: Fn<A, X>,
   second: Transformer<X, O>,
-): (input: I) => Promise<O> {
-  return async (input) => second(await first(input))
+): (...args: A) => Promise<O> {
+  return async (...args) => second(await first(...args))
 }

package/src/type.ts

@@ -0,0 +1,11 @@
+/**
+ * Generic, potentially async, function. Parametrized for convenience reasons.
+ */
+export type Fn<A extends readonly unknown[], O> = (
+  ...args: A
+) => O | PromiseLike<O>
+
+/**
+ * Single input, single output, potentially async transformer function.
+ */
+export type Transformer<I, O = I> = (...args: [I]) => O | PromiseLike<O>

package/tsconfig.build.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts","./src/pipe.ts","./src/type.ts"],"version":"5.8.2"}

package/dist/transformer.d.ts

@@ -1,2 +0,0 @@
-export type Transformer<I, O = I> = (input: I) => O | PromiseLike<O>;
-//# sourceMappingURL=transformer.d.ts.map

package/dist/transformer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transformer.d.ts","sourceRoot":"","sources":["../src/transformer.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA"}

package/dist/transformer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transformer.js","sourceRoot":"","sources":["../src/transformer.ts"],"names":[],"mappings":""}

package/src/transformer.ts

@@ -1 +0,0 @@
-export type Transformer<I, O = I> = (input: I) => O | PromiseLike<O>