@atproto-labs/pipe 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atproto-labs/pipe
+
+## 0.1.0
+
+### Minor Changes
+
+- [#2482](https://github.com/bluesky-social/atproto/pull/2482) [`a8d6c1123`](https://github.com/bluesky-social/atproto/commit/a8d6c112359f5c4c0cfbe2df63443ed275f2a646) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add OAuth provider capability & support for DPoP signed tokens

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Dual MIT/Apache-2.0 License
+
+Copyright (c) 2022-2024 Bluesky 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>).
+
+Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.

package/dist/index.d.ts

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

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pipeTwo = exports.pipe = void 0;
+var pipe_js_1 = require("./pipe.js");
+Object.defineProperty(exports, "pipe", { enumerable: true, get: function () { return pipe_js_1.pipe; } });
+Object.defineProperty(exports, "pipeTwo", { enumerable: true, get: function () { return pipe_js_1.pipeTwo; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AAAhC,+FAAA,IAAI,OAAA;AAAE,kGAAA,OAAO,OAAA"}

package/dist/pipe.d.ts

@@ -0,0 +1,31 @@
+import { Transformer } from './transformer.js';
+type PipelineInput<T extends readonly Transformer<any>[]> = T extends [
+    Transformer<infer I, 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;
+/**
+ * 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,
+ * )
+ * ```
+ */
+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 {};
+//# sourceMappingURL=pipe.d.ts.map

package/dist/pipe.d.ts.map

@@ -0,0 +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"}

package/dist/pipe.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pipeTwo = exports.pipe = void 0;
+function pipe(...pipeline) {
+    return pipeline.reduce(pipeTwo);
+}
+exports.pipe = pipe;
+function pipeTwo(first, second) {
+    return async (input) => second(await first(input));
+}
+exports.pipeTwo = pipeTwo;
+//# sourceMappingURL=pipe.js.map

package/dist/pipe.js.map

@@ -0,0 +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"}

package/dist/transformer.d.ts

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

package/dist/transformer.d.ts.map

@@ -0,0 +1 @@
+{"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

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

package/dist/transformer.js.map

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

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@atproto-labs/pipe",
+  "version": "0.1.0",
+  "license": "MIT",
+  "description": "Library for combining multiple functions into a single function.",
+  "keywords": [
+    "atproto",
+    "transformer"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/internal/pipe"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.json"
+  }
+}

package/src/index.ts

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

package/src/pipe.ts

@@ -0,0 +1,63 @@
+import { Transformer } from './transformer.js'
+
+type PipelineInput<T extends readonly Transformer<any>[]> = T extends [
+  Transformer<infer I, 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
+
+/**
+ * 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,
+ * )
+ * ```
+ */
+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>[]>(
+  ...pipeline: Pipeline<T> extends T ? T : Pipeline<T>
+): (input: PipelineInput<T>) => Promise<PipelineOutput<T>> {
+  return pipeline.reduce(pipeTwo)
+}
+
+export function pipeTwo<I, O, X = unknown>(
+  first: Transformer<I, X>,
+  second: Transformer<X, O>,
+): (input: I) => Promise<O> {
+  return async (input) => second(await first(input))
+}

package/src/transformer.ts

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

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["../../../tsconfig/isomorphic.json"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "include": [],
+  "references": [{ "path": "./tsconfig.build.json" }]
+}