@transcend-io/type-utils 2.0.1 → 3.0.0

package/package.json

@@ -1,62 +1,52 @@
 {
-  "author": "Transcend Inc.",
   "name": "@transcend-io/type-utils",
-  "description": "Small package containing useful typescript utilities.",
-  "version": "2.0.1",
-  "homepage": "https://github.com/transcend-io/type-utils",
+  "version": "3.0.0",
+  "description": "Typed runtime and compile-time utilities for the Transcend developer tools monorepo.",
+  "homepage": "https://github.com/transcend-io/tools/tree/main/packages/type-utils",
+  "license": "Apache-2.0",
+  "author": "Transcend Inc.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/transcend-io/type-utils.git"
+    "url": "https://github.com/transcend-io/tools.git",
+    "directory": "packages/type-utils"
   },
-  "license": "MIT",
+  "files": [
+    "dist"
+  ],
   "type": "module",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": "./build/index.js",
-      "types": "./build/index.d.ts",
-      "module-sync": "./build/index.js",
-      "default": "./build/index.js"
+      "@transcend-io/source": "./src/index.ts",
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     }
   },
-  "files": [
-    "build/**/*",
-    "package.json"
-  ],
-  "scripts": {
-    "update:sdks": "yarn set version from sources && yarn dlx @yarnpkg/sdks base",
-    "update:deps": "yarn upgrade-interactive && yarn update:sdks",
-    "build": "yarn tsc --build",
-    "clean": "yarn tsc --build --clean",
-    "lint": "yarn eslint ./src --ext .js --ext .ts --ext .tsx --ext .jsx",
-    "prepublish": "yarn build",
-    "test": "yarn mocha './src/**/*.test.ts'"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
     "fp-ts": "^2.16.1",
     "io-ts": "^2.2.21"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.11",
-    "@types/deep-equal-in-any-order": "1.0.1",
+    "@arethetypeswrong/cli": "^0.18.2",
     "@types/json-schema": "^7.0.15",
-    "@types/mocha": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
-    "chai": "^4.3.10",
-    "deep-equal-in-any-order": "^1.0.28",
-    "depcheck": "^1.4.7",
-    "eslint": "^8.55.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-jsdoc": "^46.9.0",
-    "mocha": "^11.0.0",
-    "prettier": "^2.7.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5.3.2"
+    "@types/node": "^22.19.15",
+    "publint": "^0.3.18",
+    "tsdown": "^0.21.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
-  "packageManager": "yarn@4.12.0"
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "check:exports": "attw --pack . --ignore-rules cjs-resolves-to-esm",
+    "check:publint": "publint --level warning --strict --pack pnpm"
+  }
 }

package/.yarn/sdks/eslint/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "eslint",
-  "version": "8.55.0-sdk",
-  "main": "./lib/api.js",
-  "type": "commonjs",
-  "bin": {
-    "eslint": "./bin/eslint.js"
-  },
-  "exports": {
-    "./package.json": "./package.json",
-    ".": "./lib/api.js",
-    "./use-at-your-own-risk": "./lib/unsupported-api.js"
-  }
-}

package/.yarn/sdks/prettier/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "prettier",
-  "version": "2.8.8-sdk",
-  "main": "./index.js",
-  "type": "commonjs",
-  "bin": "./bin-prettier.js"
-}

package/.yarn/sdks/typescript/package.json

@@ -1,10 +0,0 @@
-{
-  "name": "typescript",
-  "version": "5.3.2-sdk",
-  "main": "./lib/typescript.js",
-  "type": "commonjs",
-  "bin": {
-    "tsc": "./bin/tsc",
-    "tsserver": "./bin/tsserver"
-  }
-}

package/README.md

@@ -1,37 +0,0 @@
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-## Table of Contents
-
-- [Overview](#overview)
-- [Typescript Build](#typescript-build)
-- [Lint](#lint)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Overview
-
-This package contains utilities for overriding require statement to support aliases, functions like `apply` and `decodeCodec` as well as generic typescript types useful in any typescript project.
-
-## Typescript Build
-
-Build this package only:
-
-```sh
-yarn run tsc
-yarn run tsc --watch # Watch mode
-```
-
-Create a fresh build:
-
-```sh
-yarn clean && yarn run tsc
-```
-
-## Lint
-
-Lint the typescript files in this package:
-
-```sh
-yarn lint
-```

package/build/aggregateObjects.d.ts

@@ -1,27 +0,0 @@
-/**
- *
- * Aggregates multiple objects into a single object by combining values of matching keys.
- * For each key present in any of the input objects, creates a comma-separated string
- * of values from all objects.
- * @param param - the objects to aggregate and the aggregation method
- * @returns a single object containing all unique keys with aggregated values
- * @example
- * const obj1 = { name: 'John', age: 30 };
- * const obj2 = { name: 'Jane', city: 'NY' };
- * const obj3 = { name: 'Bob', age: 25 };
- *
- * // Without wrap
- * aggregateObjects({ objs: [obj1, obj2, obj3] })
- * // Returns: { name: 'John,Jane,Bob', age: '30,,25', city: ',NY,' }
- *
- * // With wrap
- * aggregateObjects({ objs: [obj1, obj2, obj3], wrap: true })
- * // Returns: { name: '[John],[Jane],[Bob]', age: '[30],[],[25]', city: '[],[NY],[]' }
- */
-export declare const aggregateObjects: ({ objs, wrap, }: {
-    /** the objects to aggregate in a single one */
-    objs: any[];
-    /** whether to wrap the concatenated values in a [] */
-    wrap?: boolean | undefined;
-}) => any;
-//# sourceMappingURL=aggregateObjects.d.ts.map

package/build/aggregateObjects.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"aggregateObjects.d.ts","sourceRoot":"","sources":["../src/aggregateObjects.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB;IAI3B,+CAA+C;UACzC,GAAG,EAAE;IACX,sDAAsD;;MAEpD,GAkBH,CAAC"}

package/build/aggregateObjects.js

@@ -1,34 +0,0 @@
-// eslint-disable-next-line eslint-comments/disable-enable-pair
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- *
- * Aggregates multiple objects into a single object by combining values of matching keys.
- * For each key present in any of the input objects, creates a comma-separated string
- * of values from all objects.
- * @param param - the objects to aggregate and the aggregation method
- * @returns a single object containing all unique keys with aggregated values
- * @example
- * const obj1 = { name: 'John', age: 30 };
- * const obj2 = { name: 'Jane', city: 'NY' };
- * const obj3 = { name: 'Bob', age: 25 };
- *
- * // Without wrap
- * aggregateObjects({ objs: [obj1, obj2, obj3] })
- * // Returns: { name: 'John,Jane,Bob', age: '30,,25', city: ',NY,' }
- *
- * // With wrap
- * aggregateObjects({ objs: [obj1, obj2, obj3], wrap: true })
- * // Returns: { name: '[John],[Jane],[Bob]', age: '[30],[],[25]', city: '[],[NY],[]' }
- */
-export const aggregateObjects = ({ objs, wrap = false, }) => {
-    const allKeys = Array.from(new Set(objs.flatMap((a) => (a && typeof a === 'object' ? Object.keys(a) : []))));
-    // Reduce into a single object, where each key contains concatenated values from all input objects
-    return allKeys.reduce((acc, key) => {
-        const values = objs
-            .map((o) => { var _a, _b; return (wrap ? `[${(_a = o === null || o === void 0 ? void 0 : o[key]) !== null && _a !== void 0 ? _a : ''}]` : (_b = o === null || o === void 0 ? void 0 : o[key]) !== null && _b !== void 0 ? _b : ''); })
-            .join(',');
-        acc[key] = values;
-        return acc;
-    }, {});
-};
-//# sourceMappingURL=aggregateObjects.js.map

package/build/aggregateObjects.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"aggregateObjects.js","sourceRoot":"","sources":["../src/aggregateObjects.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,uDAAuD;AAEvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAC/B,IAAI,EACJ,IAAI,GAAG,KAAK,GAMb,EAAO,EAAE;IACR,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CACxB,IAAI,GAAG,CACL,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACxE,CACF,CAAC;IAEF,kGAAkG;IAClG,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACX,MAAM,MAAM,GAAG,IAAI;aAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,eAAC,OAAA,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,GAAG,CAAC,mCAAI,EAAE,GAAG,CAAC,CAAC,CAAC,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,GAAG,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC;aAC3D,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QAClB,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAyB,CAC1B,CAAC;AACJ,CAAC,CAAC"}

package/build/apply.d.ts

@@ -1,35 +0,0 @@
-import type { ObjByString, StringKeys } from './types.js';
-/**
- * Apply a function to each value of an object. Similar to lodash.mapValues but should preserve the typing of the keys.
- *
- * This allows one to define an object keys in an enum and then the resulting map should keep the same typing
- * @param obj - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export declare function apply<TInput extends ObjByString, TOutput>(obj: TInput, applyFunc: (value: TInput[keyof TInput], key: StringKeys<TInput>, fullObj: typeof obj, index: number) => TOutput): {
-    [key in keyof TInput]: TOutput;
-};
-/**
- * Apply a function to each value of an object. Similar to lodash.mapValues but should preserve the typing of the keys.
- *
- * This allows one to define an object keys in an enum and then the resulting map should keep the same typing
- * @param obj - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export declare function asyncApply<TInput extends ObjByString, TOutput>(obj: TInput, applyFunc: (value: TInput[keyof TInput], key: StringKeys<TInput>, fullObj: typeof obj, index: number) => Promise<TOutput>): Promise<{
-    [key in keyof TInput]: TOutput;
-}>;
-/**
- * Convert a typescript enum to a mapping of [value]: [value] and then call apply on that
- * @param enm - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export declare function applyEnum<TEnum extends string, TOutput>(enm: {
-    [k in string]: TEnum;
-}, applyFunc: (value: TEnum, key: TEnum, fullObj: typeof enm, index: number) => TOutput): {
-    [key in TEnum]: TOutput;
-};
-//# sourceMappingURL=apply.d.ts.map

package/build/apply.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apply.d.ts","sourceRoot":"","sources":["../src/apply.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE1D;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,MAAM,SAAS,WAAW,EAAE,OAAO,EACvD,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CACT,KAAK,EAAE,MAAM,CAAC,MAAM,MAAM,CAAC,EAC3B,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,EACvB,OAAO,EAAE,OAAO,GAAG,EACnB,KAAK,EAAE,MAAM,KACV,OAAO,GACX;KAAG,GAAG,IAAI,MAAM,MAAM,GAAG,OAAO;CAAE,CASpC;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,MAAM,SAAS,WAAW,EAAE,OAAO,EAClE,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CACT,KAAK,EAAE,MAAM,CAAC,MAAM,MAAM,CAAC,EAC3B,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,EACvB,OAAO,EAAE,OAAO,GAAG,EACnB,KAAK,EAAE,MAAM,KACV,OAAO,CAAC,OAAO,CAAC,GACpB,OAAO,CAAC;KAAG,GAAG,IAAI,MAAM,MAAM,GAAG,OAAO;CAAE,CAAC,CAiB7C;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EACrD,GAAG,EAAE;KAAG,CAAC,IAAI,MAAM,GAAG,KAAK;CAAE,EAC7B,SAAS,EAAE,CACT,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,KAAK,EACV,OAAO,EAAE,OAAO,GAAG,EACnB,KAAK,EAAE,MAAM,KACV,OAAO,GACX;KAAG,GAAG,IAAI,KAAK,GAAG,OAAO;CAAE,CAI7B"}

package/build/apply.js

@@ -1,47 +0,0 @@
-// local
-import { createEnum } from './enum.js';
-import { getKeys } from './getKeys.js';
-/**
- * Apply a function to each value of an object. Similar to lodash.mapValues but should preserve the typing of the keys.
- *
- * This allows one to define an object keys in an enum and then the resulting map should keep the same typing
- * @param obj - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export function apply(obj, applyFunc) {
-    const result = Object.keys(obj).reduce((acc, key, ind) => Object.assign(acc, {
-        [key]: applyFunc(obj[key], key, obj, ind),
-    }), {});
-    return result;
-}
-/**
- * Apply a function to each value of an object. Similar to lodash.mapValues but should preserve the typing of the keys.
- *
- * This allows one to define an object keys in an enum and then the resulting map should keep the same typing
- * @param obj - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export async function asyncApply(obj, applyFunc) {
-    const entries = await Promise.all(getKeys(obj).map(async (key, ind) => ({
-        key,
-        value: await applyFunc(obj[key], key, obj, ind),
-    })));
-    const result = entries.reduce((acc, { key, value }) => Object.assign(acc, {
-        [key]: value,
-    }), {});
-    return result;
-}
-/**
- * Convert a typescript enum to a mapping of [value]: [value] and then call apply on that
- * @param enm - The object to apply the function to
- * @param applyFunc - The function to apply
- * @returns The updated object
- */
-export function applyEnum(enm, applyFunc) {
-    const obj = createEnum(Object.values(enm));
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return apply(obj, applyFunc);
-}
-//# sourceMappingURL=apply.js.map

package/build/apply.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"apply.js","sourceRoot":"","sources":["../src/apply.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CACnB,GAAW,EACX,SAKY;IAEZ,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAChB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QACjB,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAyB,EAAE,GAAG,EAAE,GAAG,CAAC;KAChE,CAAC,EACJ,EAAE,CACH,CAAC;IACF,OAAO,MAA4C,CAAC;AACtD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAW,EACX,SAKqB;IAErB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG;QACH,KAAK,EAAE,MAAM,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAyB,EAAE,GAAG,EAAE,GAAG,CAAC;KACtE,CAAC,CAAC,CACJ,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAC3B,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CACtB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QACjB,CAAC,GAAG,CAAC,EAAE,KAAK;KACb,CAAC,EACJ,EAAE,CACH,CAAC;IAEF,OAAO,MAA4C,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CACvB,GAA6B,EAC7B,SAKY;IAEZ,MAAM,GAAG,GAAG,UAAU,CAAe,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,8DAA8D;IAC9D,OAAO,KAAK,CAAC,GAAG,EAAE,SAAS,CAAQ,CAAC;AACtC,CAAC"}

package/build/codecTools/FixedLengthArray.d.ts

@@ -1,20 +0,0 @@
-import * as t from 'io-ts';
-export interface FixedLengthArrayBrand<T> extends Array<T> {
-    /** Unique symbol to ensure uniqueness of this type across modules/packages */
-    readonly fixedLengthArray: unique symbol;
-    /** The min length of the array */
-    readonly min: number;
-    /** The max of the array */
-    readonly max: number;
-}
-/**
- * The refinement for encoding/decoding strings of fixed length
- * @param min - The array min length
- * @param max - The array max length
- * @param a - The array type
- * @returns The fixed length array codec
- */
-export declare const FixedLengthArray: <C extends t.Mixed>(min: number, max: number, a: C) => t.BrandC<t.ArrayC<C>, FixedLengthArrayBrand<C>>;
-/** Override types */
-export type FixedLengthArray<C extends t.Mixed> = t.TypeOf<t.BrandC<t.ArrayC<C>, FixedLengthArrayBrand<C>>>;
-//# sourceMappingURL=FixedLengthArray.d.ts.map

package/build/codecTools/FixedLengthArray.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FixedLengthArray.d.ts","sourceRoot":"","sources":["../../src/codecTools/FixedLengthArray.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,MAAM,WAAW,qBAAqB,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IACxD,8EAA8E;IAC9E,QAAQ,CAAC,gBAAgB,EAAE,OAAO,MAAM,CAAC;IAEzC,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,2BAA2B;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,2BACtB,MAAM,OACN,MAAM,0DAQV,CAAC;AAEJ,qBAAqB;AACrB,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,CACxD,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAChD,CAAC"}

package/build/codecTools/FixedLengthArray.js

@@ -1,11 +0,0 @@
-// external
-import * as t from 'io-ts';
-/**
- * The refinement for encoding/decoding strings of fixed length
- * @param min - The array min length
- * @param max - The array max length
- * @param a - The array type
- * @returns The fixed length array codec
- */
-export const FixedLengthArray = (min, max, a) => t.brand(t.array(a), (n) => min <= n.length && n.length <= max, 'fixedLengthArray');
-//# sourceMappingURL=FixedLengthArray.js.map

package/build/codecTools/FixedLengthArray.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FixedLengthArray.js","sourceRoot":"","sources":["../../src/codecTools/FixedLengthArray.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAa3B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,GAAW,EACX,GAAW,EACX,CAAI,EAC6C,EAAE,CACnD,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EACV,CAAC,CAAW,EAAsD,EAAE,CAClE,GAAG,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,EACpC,kBAAkB,CACnB,CAAC"}

package/build/codecTools/FixedLengthString.d.ts

@@ -1,17 +0,0 @@
-import * as t from 'io-ts';
-/** The type refinement for encoding/decoding strings of fixed length */
-export type FixedLengthStringBrand<N extends number> = {
-    /** The length of the string */
-    readonly length: N;
-    /** Unique symbol to ensure uniqueness of this type across modules/packages */
-    readonly FixedLengthString: unique symbol;
-};
-/**
- * The refinement for encoding/decoding strings of fixed length
- * @param len - The string's length
- * @returns The fixed length string codec
- */
-export declare const FixedLengthString: <N extends number>(len: N) => t.BrandC<t.StringC, FixedLengthStringBrand<N>>;
-/** Override types */
-export type FixedLengthString<N extends number> = t.TypeOf<t.BrandC<t.StringC, FixedLengthStringBrand<N>>>;
-//# sourceMappingURL=FixedLengthString.d.ts.map

package/build/codecTools/FixedLengthString.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FixedLengthString.d.ts","sourceRoot":"","sources":["../../src/codecTools/FixedLengthString.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,wEAAwE;AACxE,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,IAAI;IACrD,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,CAAC,iBAAiB,EAAE,OAAO,MAAM,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,8EAO3B,CAAC;AAEJ,qBAAqB;AACrB,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,MAAM,CACxD,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAC/C,CAAC"}

package/build/codecTools/FixedLengthString.js

@@ -1,10 +0,0 @@
-// external
-import * as t from 'io-ts';
-/**
- * The refinement for encoding/decoding strings of fixed length
- * @param len - The string's length
- * @returns The fixed length string codec
- */
-export const FixedLengthString = (len) => t.brand(t.string, // a codec representing the type to be refined
-(s) => s.length === len, 'FixedLengthString');
-//# sourceMappingURL=FixedLengthString.js.map

package/build/codecTools/FixedLengthString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FixedLengthString.js","sourceRoot":"","sources":["../../src/codecTools/FixedLengthString.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAU3B;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAM,EAC0C,EAAE,CAClD,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,EAAE,8CAA8C;AACxD,CAAC,CAAC,EAAqD,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,GAAG,EAC1E,mBAAmB,CACpB,CAAC"}

package/build/codecTools/NonEmptyString.d.ts

@@ -1,12 +0,0 @@
-import * as t from 'io-ts';
-/** The type refinement for encoding/decoding non-empty strings */
-type NonEmptyStringBrand = {
-    /** Unique symbol to ensure uniqueness of this type across modules/packages */
-    readonly NonEmptyString: symbol;
-};
-/** The refinement for encoding/decoding non-empty strings */
-export declare const NonEmptyString: t.BrandC<t.StringC, NonEmptyStringBrand>;
-/** Override types */
-export type NonEmptyString = t.TypeOf<typeof NonEmptyString>;
-export {};
-//# sourceMappingURL=NonEmptyString.d.ts.map

package/build/codecTools/NonEmptyString.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NonEmptyString.d.ts","sourceRoot":"","sources":["../../src/codecTools/NonEmptyString.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,kEAAkE;AAClE,KAAK,mBAAmB,GAAG;IACzB,8EAA8E;IAC9E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,6DAA6D;AAC7D,eAAO,MAAM,cAAc,0CAI1B,CAAC;AAEF,qBAAqB;AACrB,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/build/codecTools/NonEmptyString.js

@@ -1,6 +0,0 @@
-// external
-import * as t from 'io-ts';
-/** The refinement for encoding/decoding non-empty strings */
-export const NonEmptyString = t.brand(t.string, // a codec representing the type to be refined
-(s) => s.trim().length !== 0, 'NonEmptyString');
-//# sourceMappingURL=NonEmptyString.js.map

package/build/codecTools/NonEmptyString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NonEmptyString.js","sourceRoot":"","sources":["../../src/codecTools/NonEmptyString.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAQ3B,6DAA6D;AAC7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CACnC,CAAC,CAAC,MAAM,EAAE,8CAA8C;AACxD,CAAC,CAAC,EAA+C,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EACzE,gBAAgB,CACjB,CAAC"}

package/build/codecTools/createDefaultCodec.d.ts

@@ -1,39 +0,0 @@
-import * as t from 'io-ts';
-/**
- *  Creates a default value for an io-ts codec.
- * @param codec - the codec whose default we want to create
- * @returns an object honoring the io-ts codec
- *
- * Use Case: CSV Generation from Typed Objects
- * Consider the following codec:
- *
- * const UserCodec = t.intersection([
- *  t.type({
- *    id: t.string,
- *    name: t.string,
- *  }),
- *  t.partial({
- *    email: t.string,
- *  })
- * ])
- *
- * Suppose we want to generate a CSV file from the objects below with UserCodec type:
- *
- * const users = [
- *   { id: '1', name: 'Alice', email: 'alice@email.com' },
- *   { id: '2', name: 'Bob' },
- * ]
- *
- * To generate a CSV, we need a consistent set of columns (headers) that includes
- * ALL possible fields, even if some objects don't have all properties. In the example
- * above, though, notice that the second user does not have the email property.
- *
- * In such a case, createDefaultCodec(UserCodec) is useful to construct an object
- * with all possible fields, which can then be used to generate the complete CSV header:
- * "id,name,email".
- *
- * The example above is pretty simple, but things get very compliated the more complex
- * is the codec. In any case, createDefaultCodec is useful for outputting the expected CSV header.
- */
-export declare const createDefaultCodec: <C extends t.Mixed>(codec: C) => t.TypeOf<C>;
-//# sourceMappingURL=createDefaultCodec.d.ts.map

package/build/codecTools/createDefaultCodec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createDefaultCodec.d.ts","sourceRoot":"","sources":["../../src/codecTools/createDefaultCodec.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,kBAAkB,8CAkG9B,CAAC"}

package/build/codecTools/createDefaultCodec.js

@@ -1,114 +0,0 @@
-// eslint-disable-next-line eslint-comments/disable-enable-pair
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import * as t from 'io-ts';
-/**
- *  Creates a default value for an io-ts codec.
- * @param codec - the codec whose default we want to create
- * @returns an object honoring the io-ts codec
- *
- * Use Case: CSV Generation from Typed Objects
- * Consider the following codec:
- *
- * const UserCodec = t.intersection([
- *  t.type({
- *    id: t.string,
- *    name: t.string,
- *  }),
- *  t.partial({
- *    email: t.string,
- *  })
- * ])
- *
- * Suppose we want to generate a CSV file from the objects below with UserCodec type:
- *
- * const users = [
- *   { id: '1', name: 'Alice', email: 'alice@email.com' },
- *   { id: '2', name: 'Bob' },
- * ]
- *
- * To generate a CSV, we need a consistent set of columns (headers) that includes
- * ALL possible fields, even if some objects don't have all properties. In the example
- * above, though, notice that the second user does not have the email property.
- *
- * In such a case, createDefaultCodec(UserCodec) is useful to construct an object
- * with all possible fields, which can then be used to generate the complete CSV header:
- * "id,name,email".
- *
- * The example above is pretty simple, but things get very compliated the more complex
- * is the codec. In any case, createDefaultCodec is useful for outputting the expected CSV header.
- */
-export const createDefaultCodec = (codec) => {
-    // If the codec is an union
-    if (codec instanceof t.UnionType) {
-        // The default for a union containing arrays is a default array
-        const arrayType = codec.types.find((type) => type instanceof t.ArrayType);
-        if (arrayType) {
-            return createDefaultCodec(arrayType);
-        }
-        // If the union does not have an array, but have objects, the default is the object
-        const objectType = codec.types.find((type) => type instanceof t.InterfaceType ||
-            type instanceof t.PartialType ||
-            type instanceof t.IntersectionType ||
-            type instanceof t.ArrayType);
-        if (objectType) {
-            return createDefaultCodec(objectType);
-        }
-        // Otherwise, null is next in priority
-        const hasNull = codec.types.some((type) => type instanceof t.NullType || type.name === 'null');
-        if (hasNull) {
-            return null;
-        }
-        // If no null type found, default to first type
-        return createDefaultCodec(codec.types[0]);
-    }
-    // The default of an interface or partial type, is an object with that interface or partial type
-    if (codec instanceof t.InterfaceType || codec instanceof t.PartialType) {
-        const defaults = {};
-        Object.entries(codec.props).forEach(([key, type]) => {
-            defaults[key] = createDefaultCodec(type);
-        });
-        return defaults;
-    }
-    // The default of an intersection, is the merged defaults of the intersection values
-    if (codec instanceof t.IntersectionType) {
-        return codec.types.reduce((acc, type) => ({
-            ...acc,
-            ...createDefaultCodec(type),
-        }), {});
-    }
-    /**
-     * The default of an Array is an empty array, unless it is an array of objects, in which
-     * case the default is an array of one default object.
-     */
-    if (codec instanceof t.ArrayType) {
-        const elementType = codec.type;
-        const isObjectType = elementType instanceof t.InterfaceType ||
-            elementType instanceof t.PartialType ||
-            elementType instanceof t.IntersectionType;
-        return (isObjectType ? [createDefaultCodec(elementType)] : []);
-    }
-    // The default of a literal type is its value
-    if (codec instanceof t.LiteralType) {
-        return codec.value;
-    }
-    // The default of an object type is an empty object
-    if (codec instanceof t.ObjectType) {
-        return {};
-    }
-    // Handle primitive and common types
-    switch (codec.name) {
-        case 'string':
-            return '';
-        case 'number':
-            return 0;
-        case 'boolean':
-            return false;
-        case 'null':
-            return null;
-        case 'undefined':
-            return undefined;
-        default:
-            return null;
-    }
-};
-//# sourceMappingURL=createDefaultCodec.js.map

package/build/codecTools/createDefaultCodec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createDefaultCodec.js","sourceRoot":"","sources":["../../src/codecTools/createDefaultCodec.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,uDAAuD;AACvD,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAQ,EACK,EAAE;IACf,2BAA2B;IAC3B,IAAI,KAAK,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;QACjC,+DAA+D;QAC/D,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAChC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,CAAC,SAAS,CAC3C,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC;QAED,mFAAmF;QACnF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CACjC,CAAC,IAAS,EAAE,EAAE,CACZ,IAAI,YAAY,CAAC,CAAC,aAAa;YAC/B,IAAI,YAAY,CAAC,CAAC,WAAW;YAC7B,IAAI,YAAY,CAAC,CAAC,gBAAgB;YAClC,IAAI,YAAY,CAAC,CAAC,SAAS,CAC9B,CAAC;QACF,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;QAED,sCAAsC;QACtC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAC9B,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAClE,CAAC;QACF,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,IAAmB,CAAC;QAC7B,CAAC;QAED,+CAA+C;QAC/C,OAAO,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,gGAAgG;IAChG,IAAI,KAAK,YAAY,CAAC,CAAC,aAAa,IAAI,KAAK,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QACvE,MAAM,QAAQ,GAAwB,EAAE,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YAClD,QAAQ,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,IAAW,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QACH,OAAO,QAAuB,CAAC;IACjC,CAAC;IAED,oFAAoF;IACpF,IAAI,KAAK,YAAY,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CACvB,CAAC,GAAgB,EAAE,IAAS,EAAE,EAAE,CAAC,CAAC;YAChC,GAAG,GAAG;YACN,GAAG,kBAAkB,CAAC,IAAI,CAAC;SAC5B,CAAC,EACF,EAAE,CACH,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC;QAC/B,MAAM,YAAY,GAChB,WAAW,YAAY,CAAC,CAAC,aAAa;YACtC,WAAW,YAAY,CAAC,CAAC,WAAW;YACpC,WAAW,YAAY,CAAC,CAAC,gBAAgB,CAAC;QAE5C,OAAO,CACL,YAAY,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CACvC,CAAC;IACnB,CAAC;IAED,6CAA6C;IAC7C,IAAI,KAAK,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC,KAAoB,CAAC;IACpC,CAAC;IAED,mDAAmD;IACnD,IAAI,KAAK,YAAY,CAAC,CAAC,UAAU,EAAE,CAAC;QAClC,OAAO,EAAiB,CAAC;IAC3B,CAAC;IAED,oCAAoC;IACpC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,EAAiB,CAAC;QAC3B,KAAK,QAAQ;YACX,OAAO,CAAgB,CAAC;QAC1B,KAAK,SAAS;YACZ,OAAO,KAAoB,CAAC;QAC9B,KAAK,MAAM;YACT,OAAO,IAAmB,CAAC;QAC7B,KAAK,WAAW;YACd,OAAO,SAAwB,CAAC;QAClC;YACE,OAAO,IAAmB,CAAC;IAC/B,CAAC;AACH,CAAC,CAAC"}

package/build/codecTools/decodeCodec.d.ts

@@ -1,12 +0,0 @@
-import * as t from 'io-ts';
-export declare const CODEC_ERROR_MESSAGE = "Failed to decode codec:";
-/**
- * Decode a codec, returning the value if contents are validated, else throws an error
- * @param codec - The codec to decode with
- * @param txt - The text to JSON parse
- * @param parse - If a string is provided, assume it is JSON and call JSON.parse on it
- * @param customErrorFromContext - a function to custom process validation contexts to error messages
- * @returns The result of the function or the object if it was not a function
- */
-export declare function decodeCodec<TCodec extends t.Any>(codec: TCodec, txt: string | object | object[] | null | unknown, parse?: boolean, customErrorFromContext?: ((validationContext: t.Context) => string) | undefined): t.TypeOf<TCodec>;
-//# sourceMappingURL=decodeCodec.d.ts.map

package/build/codecTools/decodeCodec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"decodeCodec.d.ts","sourceRoot":"","sources":["../../src/codecTools/decodeCodec.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AA0C3B,eAAO,MAAM,mBAAmB,4BAA4B,CAAC;AAE7D;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,SAAS,CAAC,CAAC,GAAG,EAC9C,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,OAAO,EAChD,KAAK,UAAO,EACZ,sBAAsB,GAClB,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,GAC1C,SAAqB,GACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAyBlB"}