liminal 0.4.0 → 0.5.1

package/util/fixTemplateStrings.ts

@@ -0,0 +1,99 @@
+const INDENTATION_RE = /^\n([ \t]+)/
+const ESCAPE_SEQ_RE = /\\([`${\\]|\n)/g
+const LAST_INDENTATION_RE = /\n[ \t]+$/
+
+export function fixTemplateStrings(template: TemplateStringsArray): { readonly raw: readonly string[] } {
+  const firstSegment = template.raw[0]!
+  const leadingIndentMatch = INDENTATION_RE.exec(firstSegment)
+  const indentation = leadingIndentMatch?.[1]
+
+  const rawLength = template.raw.length
+  const result = new Array(rawLength)
+
+  for (let i = 0; i < rawLength; i++) {
+    let str = template.raw[i]!
+    // Only perform common indentation replacements if needed
+    if (indentation) {
+      // Remove leading newline and indentation in the first segment
+      if (i === 0) {
+        str = str.slice(indentation.length + 1)
+      }
+      // Use a simple string replacement with a regular expression for better performance
+      str = str.replaceAll(`\n${indentation}`, "\n")
+    }
+
+    // Replace common escape sequences in a single pass
+    str = str.replace(ESCAPE_SEQ_RE, (_match, char) => {
+      // Keep the escaped newline replacement separate for clarity
+      return char === "\n" ? "" : char
+    })
+
+    // Handle trailing spaces only for the last segment
+    if (indentation && i === rawLength - 1) {
+      str = str.replace(LAST_INDENTATION_RE, "")
+    }
+
+    result[i] = str
+  }
+
+  return { raw: result }
+}
+
+const LEADING_SPACE_RE = /^([ \t]*)/
+/**
+ * Applies template string indentation to substituted values with line breaks
+ *
+ * @param strings - The template strings array (processed through fixTemplateStrings)
+ * @param values - The substitution values
+ * @returns - The formatted string with properly indented substitutions
+ */
+export function applyTemplateWithIndentation(strings: TemplateStringsArray, ...values: any[]): string {
+  const fixedStrings = fixTemplateStrings(strings)
+  const rawArr = fixedStrings.raw
+  const valuesLength = values.length
+
+  const resultParts = new Array(Math.max(1, rawArr.length * 2 - 1))
+  let resultIndex = 0
+
+  for (let i = 0; i < rawArr.length; i++) {
+    const str = rawArr[i] || ""
+    resultParts[resultIndex++] = str
+
+    // Only process values for non-final segments
+    if (i < valuesLength) {
+      const value = String(values[i])
+
+      // If value has line breaks, we should indent it
+      if (value.includes("\n")) {
+        const lastNewlineIndex = str.lastIndexOf("\n")
+
+        if (lastNewlineIndex !== -1) {
+          // Extract the indentation after the last newline
+          const textAfterLastNewline = str.substring(lastNewlineIndex + 1)
+          const leadingSpaceMatch = LEADING_SPACE_RE.exec(textAfterLastNewline)
+          const indentationToApply = leadingSpaceMatch && leadingSpaceMatch[1] ? leadingSpaceMatch[1] : ""
+
+          if (indentationToApply) {
+            // Split the value into lines once
+            const lines = value.split("\n")
+            const linesLength = lines.length
+
+            // First line doesn't need indentation
+            resultParts[resultIndex++] = lines[0]
+
+            // Apply indentation to subsequent lines
+            for (let j = 1; j < linesLength; j++) {
+              resultParts[resultIndex++] = "\n" + indentationToApply + lines[j]
+            }
+            continue
+          }
+        }
+      }
+      // For simple values or when no indentation is needed
+      resultParts[resultIndex++] = value
+    }
+  }
+
+  // Combine all parts at once
+  return resultParts.slice(0, resultIndex).join("")
+}

package/util/isAsyncIterator.ts

@@ -0,0 +1,6 @@
+export function isAsyncIterator(value: unknown): value is AsyncIteratorObject<unknown, unknown, unknown> {
+  return typeof value === "object"
+    && value != null
+    && Symbol.asyncIterator in value
+    && typeof value[Symbol.asyncIterator] === "function"
+}

package/util/isIterator.ts

@@ -0,0 +1,6 @@
+export function isIterator(value: unknown): value is IteratorObject<unknown, unknown, unknown> {
+  return typeof value === "object"
+    && value != null
+    && Symbol.iterator in value
+    && typeof value[Symbol.iterator] === "function"
+}

package/util/isJSONValue.ts

@@ -0,0 +1,20 @@
+import type { JSONValue } from "./JSONValue.ts"
+
+export function isJSONValue(value: unknown): value is JSONValue {
+  if (value === null) {
+    return true
+  }
+
+  if (Array.isArray(value)) {
+    return value.every((item) => isJSONValue(item))
+  }
+
+  if (typeof value === "object") {
+    if (value === null) {
+      return true
+    }
+    return Object.values(value).every((v) => isJSONValue(v))
+  }
+
+  return typeof value === "string" || typeof value === "number" || typeof value === "boolean"
+}

package/util/isPropertyKey.ts

@@ -0,0 +1,3 @@
+export function isPropertyKey(value: unknown): value is number | string | symbol {
+  return typeof value === "number" || typeof value === "string" || typeof value === "symbol"
+}

package/util/isTemplateStringsArray.ts

@@ -0,0 +1,3 @@
+export function isTemplateStringsArray(value: unknown): value is TemplateStringsArray {
+  return Array.isArray(value) && "raw" in value && Array.isArray(value.raw)
+}

package/util/jsonEquals.ts

@@ -0,0 +1,41 @@
+import type { JSONValue } from "./JSONValue"
+
+export function jsonEquals(actual: JSONValue, expected: JSONValue): boolean {
+  if (actual === expected) {
+    return true
+  }
+
+  if (typeof actual !== typeof expected) {
+    return false
+  }
+
+  if (actual === null || expected === null) {
+    return actual === expected
+  }
+
+  if (Array.isArray(actual)) {
+    if (!Array.isArray(expected)) {
+      return false
+    }
+    if (actual.length !== expected.length) {
+      return false
+    }
+    return actual.every((e, i) => jsonEquals(e, expected[i]!))
+  }
+
+  if (typeof actual === "object") {
+    if (typeof expected !== "object" || Array.isArray(expected)) {
+      return false
+    }
+    const keys = Object.keys(actual)
+    if (keys.length !== Object.keys(expected).length) {
+      return false
+    }
+    return keys.every((key) =>
+      Object.prototype.hasOwnProperty.call(expected, key)
+      && jsonEquals(actual[key]!, expected[key]!)
+    )
+  }
+
+  return actual === expected
+}

package/util/nullaryMemo.ts

@@ -0,0 +1,11 @@
+export function nullaryMemo<T>(f: () => T): () => T {
+  let initialized = false
+  let value: T | undefined = undefined
+  return () => {
+    if (!initialized) {
+      value = f()
+      initialized = true
+    }
+    return value!
+  }
+}

package/util/unimplemented.ts

@@ -0,0 +1,5 @@
+import { LiminalAssertionError } from "../LiminalAssertionError.ts"
+
+export function unimplemented(): never {
+  throw new LiminalAssertionError("Unimplemented")
+}

package/util/unreachable.ts

@@ -0,0 +1,5 @@
+import { LiminalAssertionError } from "../LiminalAssertionError.ts"
+
+export function unreachable(): never {
+  throw new LiminalAssertionError("Unreachable")
+}

package/util/unwrapDeferred.ts

@@ -0,0 +1,5 @@
+import type { DeferredOr } from "./DeferredOr.ts"
+
+export function unwrapDeferred<T>(deferred: DeferredOr<T>): T {
+  return typeof deferred === "function" ? (deferred as () => T)() : deferred
+}

package/util/util.ts

@@ -0,0 +1,10 @@
+export * from "./assert.ts"
+export * from "./dedent.ts"
+export * from "./DeferredOr.ts"
+export * from "./isAsyncIterator.ts"
+export * from "./isIterator.ts"
+export * from "./JSONKey.ts"
+export * from "./JSONSchemaMemo.ts"
+export * from "./JSONValue.ts"
+export * from "./unimplemented.ts"
+export * from "./unwrapDeferred.ts"

package/LICENSE

@@ -1,15 +0,0 @@
-Copyright 2019 Maciej Cąderek
-
-Permission to use, copy, modify, and/or distribute this software
-for any purpose with or without fee is hereby granted,
-provided that the above copyright notice
-and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS.
-IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
-OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
-DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,94 +0,0 @@
-# Liminal - functional tools for composing applications
-
-## Notes
-
-Projects is in a POC stage. Stay tuned!
-
-## API
-
-### Functional composition
-
-#### pipe
-
-Executes functions in provided order, starting with initial value.
-
-```js
-import { pipe } from 'liminal'
-
-const doubleSquare = pipe(
-  (x) => x * 2,
-  (x) => x ** 2,
-)
-
-const result = doubleSquare(2) // -> 16
-```
-
-#### compose
-
-Executes functions in reversed order, starting with initial value.
-
-```js
-import { compose } from 'liminal'
-
-const doubleSquare = compose(
-  (x) => x ** 2,
-  (x) => x * 2,
-)
-
-const result = doubleSquare(2) // -> 16
-```
-
-#### railSync
-
-Works similar to `pipe`, but additionally catches errors and pipes them downstream as a value.
-
-Errors can be thrown or returned.
-
-```js
-import { compose } from 'liminal'
-
-const doubleSquare = compose(
-  (x) => x ** 2,
-  (x) => x * 2,
-)
-
-const result = doubleSquare(2) // -> 16
-```
-
-```js
-import { compose } from 'liminal'
-
-const doubleSquare = compose(
-  (x) => {
-    if (typeof x !== 'number') {
-      return new Error('Number expected')
-    }
-
-    return x ** 2
-  },
-  (x) => x * 2,
-)
-
-const result = doubleSquare('foo') // -> Error object
-```
-
-#### rail
-
-Works similar to `rail`, but additionally waits for promises if are returned and passes result values between functions.
-
-Errors can be thrown or returned.
-
-```js
-import { compose } from 'liminal'
-
-const doubleSquare = compose(
-  (x) => x ** 2,
-  (x) => x * 2,
-)
-
-const main = async () => {
-  const result = await doubleSquare(Promise.resolve(2)) // -> 16
-}
-
-main()
-```

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-}

package/lib/array/array.d.ts

@@ -1,6 +0,0 @@
-export declare const filter: (fn: any) => (arr: any) => any;
-export declare const map: (fn: any) => (arr: any) => any;
-export declare const reduce: (fn: any, initialValue: any) => (arr: any) => any;
-export declare const reduceRight: (fn: any, initialValue: any) => (arr: any) => any;
-export declare const reverse: (arr: any) => any;
-export declare const sort: (fn: any) => (arr: any) => any[];

package/lib/array/array.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filter = (fn) => (arr) => arr.filter(fn);
-exports.map = (fn) => (arr) => arr.map(fn);
-exports.reduce = (fn, initialValue) => (arr) => arr.reduce(fn, initialValue);
-exports.reduceRight = (fn, initialValue) => (arr) => arr.reduceRight(fn, initialValue);
-exports.reverse = (arr) => arr.reverse();
-exports.sort = (fn) => (arr) => {
-    if (fn) {
-        return [...arr].sort(fn);
-    }
-    if (typeof arr[0] === 'number') {
-        return [...arr].sort((a, b) => a - b);
-    }
-    if (typeof arr[0] === 'bigint') {
-        return [...arr].sort((a, b) => {
-            return 1;
-        });
-    }
-    return [...arr].sort();
-};

package/lib/array/index.d.ts

@@ -1,11 +0,0 @@
-import { filter, map, reduce, reduceRight, reverse, sort } from './array';
-export { filter, map, reduce, reduceRight, reverse, sort };
-declare const _default: {
-    filter: (fn: any) => (arr: any) => any;
-    map: (fn: any) => (arr: any) => any;
-    reduce: (fn: any, initialValue: any) => (arr: any) => any;
-    reduceRight: (fn: any, initialValue: any) => (arr: any) => any;
-    reverse: (arr: any) => any;
-    sort: (fn: any) => (arr: any) => any[];
-};
-export default _default;

package/lib/array/index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const array_1 = require("./array");
-exports.filter = array_1.filter;
-exports.map = array_1.map;
-exports.reduce = array_1.reduce;
-exports.reduceRight = array_1.reduceRight;
-exports.reverse = array_1.reverse;
-exports.sort = array_1.sort;
-exports.default = {
-    filter: array_1.filter,
-    map: array_1.map,
-    reduce: array_1.reduce,
-    reduceRight: array_1.reduceRight,
-    reverse: array_1.reverse,
-    sort: array_1.sort,
-};

package/lib/composition/composition.d.ts

@@ -1,6 +0,0 @@
-import { ChainFunctions } from './types';
-declare const compose: ChainFunctions;
-declare const pipe: ChainFunctions;
-declare const rail: ChainFunctions;
-declare const railSync: ChainFunctions;
-export { compose, pipe, rail, railSync };

package/lib/composition/composition.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const array_1 = require("../array");
-const wrapSync = (fn) => (input) => {
-    if (input instanceof Error) {
-        return input;
-    }
-    let result;
-    try {
-        result = fn(input);
-    }
-    catch (error) {
-        result = error;
-    }
-    return typeof result === 'undefined' ? input : result;
-};
-const wrap = (fn) => (input) => {
-    if (input instanceof Promise) {
-        return input.then((rawInput) => {
-            return wrapSync(fn)(rawInput);
-        });
-    }
-    return wrapSync(fn)(input);
-};
-const chain = (reducingFn, wrappingFn = null) => (...fns) => (initialArg) => {
-    return wrappingFn
-        ? reducingFn((arg, fn) => wrappingFn(fn)(arg), initialArg)(fns)
-        : reducingFn((arg, fn) => fn(arg), initialArg)(fns);
-};
-const compose = chain(array_1.reduceRight);
-exports.compose = compose;
-const pipe = chain(array_1.reduce);
-exports.pipe = pipe;
-const rail = chain(array_1.reduce, wrap);
-exports.rail = rail;
-const railSync = chain(array_1.reduce, wrapSync);
-exports.railSync = railSync;

package/lib/composition/index.d.ts

@@ -1,9 +0,0 @@
-import { compose, pipe, rail, railSync } from './composition';
-export { compose, pipe, rail, railSync };
-declare const _default: {
-    compose: import("./types").ChainFunctions;
-    pipe: import("./types").ChainFunctions;
-    rail: import("./types").ChainFunctions;
-    railSync: import("./types").ChainFunctions;
-};
-export default _default;

package/lib/composition/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const composition_1 = require("./composition");
-exports.compose = composition_1.compose;
-exports.pipe = composition_1.pipe;
-exports.rail = composition_1.rail;
-exports.railSync = composition_1.railSync;
-exports.default = {
-    compose: composition_1.compose,
-    pipe: composition_1.pipe,
-    rail: composition_1.rail,
-    railSync: composition_1.railSync,
-};

package/lib/composition/types.d.ts

@@ -1,2 +0,0 @@
-export declare type ChainFunctions = (...fns: Function[]) => (initialArg: any) => any;
-export declare type ChainFactory = (reduceFn: Function, wrappingFn?: Function) => ChainFunctions;

package/lib/composition/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/dispatch/getType.d.ts

@@ -1,2 +0,0 @@
-declare const getType: (val: any) => "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "null" | "regexp";
-export default getType;

package/lib/dispatch/getType.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getType = (val) => {
-    if (Array.isArray(val)) {
-        return 'array';
-    }
-    if (val === null) {
-        return 'null';
-    }
-    if (val instanceof RegExp) {
-        return 'regexp';
-    }
-    return typeof val;
-};
-exports.default = getType;

package/lib/dispatch/identity.d.ts

@@ -1,2 +0,0 @@
-declare const identity: (x: any) => any;
-export default identity;

package/lib/dispatch/identity.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const identity = (x) => x;
-exports.default = identity;

package/lib/dispatch/index.d.ts

@@ -1,22 +0,0 @@
-import getType from './getType';
-import identity from './identity';
-import types from './types';
-export { getType, identity, types };
-declare const _default: {
-    getType: (val: any) => "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "null" | "regexp";
-    identity: (x: any) => any;
-    types: {
-        array: string;
-        object: string;
-        function: string;
-        string: string;
-        number: string;
-        bigint: string;
-        symbol: string;
-        regexp: string;
-        null: string;
-        undefined: string;
-        boolean: string;
-    };
-};
-export default _default;

package/lib/dispatch/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getType_1 = require("./getType");
-exports.getType = getType_1.default;
-const identity_1 = require("./identity");
-exports.identity = identity_1.default;
-const types_1 = require("./types");
-exports.types = types_1.default;
-exports.default = {
-    getType: getType_1.default,
-    identity: identity_1.default,
-    types: types_1.default,
-};

package/lib/dispatch/types.d.ts

@@ -1,14 +0,0 @@
-declare const types: {
-    array: string;
-    object: string;
-    function: string;
-    string: string;
-    number: string;
-    bigint: string;
-    symbol: string;
-    regexp: string;
-    null: string;
-    undefined: string;
-    boolean: string;
-};
-export default types;

package/lib/dispatch/types.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const types = {
-    array: 'array',
-    object: 'object',
-    function: 'function',
-    string: 'string',
-    number: 'number',
-    bigint: 'bigint',
-    symbol: 'symbol',
-    regexp: 'regexp',
-    null: 'null',
-    undefined: 'undefined',
-    boolean: 'boolean',
-};
-exports.default = types;

package/lib/error/error.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="node" />
-declare const _default: {
-    create: ({ name, defaultMessage }: {
-        name: any;
-        defaultMessage?: string;
-    }) => {
-        new (message?: string): {
-            name: string;
-            message: string;
-            stack?: string;
-        };
-        captureStackTrace(targetObject: Object, constructorOpt?: Function): void;
-        prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-        stackTraceLimit: number;
-    };
-    toJSON: (error: any) => {
-        error: {
-            name: any;
-            message: any;
-            stacktrace: any;
-        };
-    };
-};
-export default _default;

package/lib/error/error.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const create = ({ name, defaultMessage = '' }) => {
-    const err = class extends Error {
-        constructor(message = defaultMessage) {
-            super(message);
-            this.name = name;
-            this.message = message;
-        }
-    };
-    return err;
-};
-const toJSON = (error) => {
-    return {
-        error: {
-            name: error.name,
-            message: error.message,
-            stacktrace: error.stack,
-        },
-    };
-};
-exports.default = {
-    create,
-    toJSON,
-};

package/lib/error/index.d.ts

@@ -1,2 +0,0 @@
-import error from './error';
-export default error;

package/lib/error/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const error_1 = require("./error");
-exports.default = error_1.default;