@zayne-labs/toolkit-type-helpers 0.8.22

package/dist/esm/index.d.ts

@@ -0,0 +1,63 @@
+type Prettify<TObject> = NonNullable<unknown> & {
+    [Key in keyof TObject]: TObject[Key];
+};
+type UnmaskType<TType> = {
+    _: TType;
+}["_"];
+type PrettyOmit<TObject, Key extends keyof TObject> = Prettify<Omit<TObject, Key>>;
+type PrettyPick<TObject, Key extends keyof TObject> = Prettify<Pick<TObject, Key>>;
+type CallbackFn<in TParams, out TResult = void> = (...params: TParams[]) => TResult;
+type SelectorFn<TStore, TResult> = (state: TStore) => TResult;
+type WriteableLevel = "deep" | "shallow";
+type Writeable<TObject, TType extends WriteableLevel = "shallow"> = {
+    -readonly [key in keyof TObject]: TType extends "shallow" ? TObject[key] : TType extends "deep" ? TObject[key] extends object ? Writeable<TObject[key], TType> : TObject[key] : never;
+};
+type InferEnum<TObject, TVariant extends "keys" | "values" = "values"> = TObject extends Array<infer TUnion> | ReadonlyArray<infer TUnion> | Set<infer TUnion> ? TUnion : TObject extends Record<infer TKeys, infer TValues> ? TVariant extends "keys" ? TKeys : Prettify<Writeable<TValues, "deep">> : never;
+type NonEmptyArray<TArrayItem> = [TArrayItem, ...TArrayItem[]];
+type AnyObject = UnmaskType<Record<string, unknown>>;
+type AnyFunction<TResult = any> = UnmaskType<(...args: any[]) => TResult>;
+type AnyAsyncFunction<TResult = any> = UnmaskType<(...args: any[]) => Promise<TResult>>;
+/**
+ *  - This types allows for adding arbitrary literal types, while still provided autocomplete for defaults.
+ *  - Usually intersection with "{}" or "NonNullable<unknown>" would make it work fine, but the "ignore" property with never type will help make it appear at the bottom of intellisense list and errors because of never .
+ * @see [typescript issue](https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609)
+ */
+type AnyString = string & Record<never, never>;
+/**
+ *  - This types allows for adding arbitrary literal types, while still provided autocomplete for defaults.
+ *  - Usually intersection with "{}" or "NonNullable<unknown>" would make it work fine, but the "ignore" property with never type will help make it appear at the bottom of intellisense list and errors because of never .
+ * @see [typescript issue](https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609)
+ */
+type AnyNumber = number & Record<never, never>;
+type LiteralUnion<TUnion extends TBase, TBase = string> = TUnion | (TBase & Record<never, never>);
+
+declare const isString: (value: unknown) => value is string;
+declare const isBoolean: (value: unknown) => value is boolean;
+declare const isArray: <TArray>(value: unknown) => value is TArray[];
+declare const isFormData: (value: unknown) => value is FormData;
+declare const isObject: (value: unknown) => value is object;
+declare const isObjectAndNotArray: <TObject = Record<string, unknown>>(value: unknown) => value is TObject;
+declare const isPlainObject: <TObject extends AnyObject>(value: unknown) => value is TObject;
+declare const isFunction: <TFunction extends AnyFunction>(value: unknown) => value is TFunction;
+declare const isAsyncFunction: <TAsyncFunction extends AnyAsyncFunction>(value: unknown) => value is TAsyncFunction;
+declare const isFile: (value: unknown) => value is File;
+declare const isIterable: <TIterable>(obj: object) => obj is Iterable<TIterable>;
+
+declare class AssertionError extends Error {
+    name: string;
+    constructor(message?: string);
+}
+declare const assertDefined: <TValue>(value: TValue) => NonNullable<TValue>;
+declare const assertENV: (variable: string | undefined, message?: string) => string;
+type AssertOptions = {
+    message: string;
+};
+type AssertFn = {
+    (condition: boolean, messageOrOptions?: string | AssertOptions): asserts condition;
+    <TValue>(value: TValue, messageOrOptions?: string | AssertOptions): asserts value is NonNullable<TValue>;
+};
+declare const assert: AssertFn;
+
+declare const defineEnum: <const TValue, TWriteableLevel extends WriteableLevel = "shallow">(value: TValue) => Prettify<Writeable<TValue, TWriteableLevel>>;
+
+export { type AnyAsyncFunction, type AnyFunction, type AnyNumber, type AnyObject, type AnyString, AssertionError, type CallbackFn, type InferEnum, type LiteralUnion, type NonEmptyArray, type Prettify, type PrettyOmit, type PrettyPick, type SelectorFn, type UnmaskType, type Writeable, type WriteableLevel, assert, assertDefined, assertENV, defineEnum, isArray, isAsyncFunction, isBoolean, isFile, isFormData, isFunction, isIterable, isObject, isObjectAndNotArray, isPlainObject, isString };

package/dist/esm/index.js

@@ -0,0 +1,58 @@
+// src/guard.ts
+var isString = (value) => typeof value === "string";
+var isBoolean = (value) => typeof value === "boolean";
+var isArray = (value) => Array.isArray(value);
+var isFormData = (value) => value instanceof FormData;
+var isObject = (value) => typeof value === "object" && value !== null;
+var isObjectAndNotArray = (value) => {
+  return isObject(value) && !isArray(value);
+};
+var isPlainObject = (value) => {
+  if (!isObject(value)) {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  return (prototype == null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value);
+};
+var isFunction = (value) => {
+  return typeof value === "function";
+};
+var isAsyncFunction = (value) => {
+  return isFunction(value) && value.constructor.name === "AsyncFunction";
+};
+var isFile = (value) => value instanceof File;
+var isIterable = (obj) => Symbol.iterator in obj;
+
+// src/assert.ts
+var AssertionError = class extends Error {
+  name = "AssertionError";
+  constructor(message) {
+    const prefix = "Assertion failed";
+    super(message ? `${prefix}: ${message}` : message);
+  }
+};
+var assertDefined = (value) => {
+  if (value == null) {
+    throw new AssertionError(`The value passed is "${value}!"`);
+  }
+  return value;
+};
+var assertENV = (variable, message) => {
+  if (variable === void 0) {
+    throw new AssertionError(message);
+  }
+  return variable;
+};
+var assert = (input, messageOrOptions) => {
+  if (input === false || input == null) {
+    const message = isString(messageOrOptions) ? messageOrOptions : messageOrOptions?.message;
+    throw new AssertionError(message);
+  }
+};
+
+// src/common.ts
+var defineEnum = (value) => value;
+
+export { AssertionError, assert, assertDefined, assertENV, defineEnum, isArray, isAsyncFunction, isBoolean, isFile, isFormData, isFunction, isIterable, isObject, isObjectAndNotArray, isPlainObject, isString };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/guard.ts","../../src/assert.ts","../../src/common.ts"],"names":[],"mappings":";AAEO,IAAM,QAAW,GAAA,CAAC,KAAoC,KAAA,OAAO,KAAU,KAAA;AAEvE,IAAM,SAAY,GAAA,CAAC,KAAmB,KAAA,OAAO,KAAU,KAAA;AAEvD,IAAM,OAAU,GAAA,CAAS,KAAsC,KAAA,KAAA,CAAM,QAAQ,KAAK;AAE5E,IAAA,UAAA,GAAa,CAAC,KAAA,KAAmB,KAAiB,YAAA;AAExD,IAAM,WAAW,CAAC,KAAA,KAAmB,OAAO,KAAA,KAAU,YAAY,KAAU,KAAA;AAEtE,IAAA,mBAAA,GAAsB,CAClC,KACsB,KAAA;AACtB,EAAA,OAAO,QAAS,CAAA,KAAK,CAAK,IAAA,CAAC,QAAQ,KAAK,CAAA;AACzC;AAEa,IAAA,aAAA,GAAgB,CAA4B,KAAqC,KAAA;AAC7F,EAAI,IAAA,CAAC,QAAS,CAAA,KAAK,CAAG,EAAA;AACrB,IAAO,OAAA,KAAA;AAAA;AAGR,EAAM,MAAA,SAAA,GAAY,MAAO,CAAA,cAAA,CAAe,KAAK,CAAA;AAG7C,EAAA,OAAA,CACE,SAAa,IAAA,IAAA,IAAQ,SAAc,KAAA,MAAA,CAAO,SAAa,IAAA,MAAA,CAAO,cAAe,CAAA,SAAS,CAAM,KAAA,IAAA,KAC7F,EAAE,MAAA,CAAO,WAAe,IAAA,KAAA,CAAA;AAE1B;AAEa,IAAA,UAAA,GAAa,CAAgC,KAAuC,KAAA;AAChG,EAAA,OAAO,OAAO,KAAU,KAAA,UAAA;AACzB;AAEa,IAAA,eAAA,GAAkB,CAC9B,KAC6B,KAAA;AAC7B,EAAA,OAAO,UAAW,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,YAAY,IAAS,KAAA,eAAA;AACxD;AAEa,IAAA,MAAA,GAAS,CAAC,KAAA,KAAkC,KAAiB,YAAA;AAEnE,IAAM,UAAa,GAAA,CAAY,GAA4C,KAAA,MAAA,CAAO,QAAY,IAAA;;;AC1CxF,IAAA,cAAA,GAAN,cAA6B,KAAM,CAAA;AAAA,EAChC,IAAO,GAAA,gBAAA;AAAA,EAEhB,YAAY,OAAkB,EAAA;AAC7B,IAAA,MAAM,MAAS,GAAA,kBAAA;AAEf,IAAA,KAAA,CAAM,UAAU,CAAG,EAAA,MAAM,CAAK,EAAA,EAAA,OAAO,KAAK,OAAO,CAAA;AAAA;AAEnD;AAEa,IAAA,aAAA,GAAgB,CAAS,KAAkB,KAAA;AACvD,EAAA,IAAI,SAAS,IAAM,EAAA;AAClB,IAAA,MAAM,IAAI,cAAA,CAAe,CAAwB,qBAAA,EAAA,KAAyB,CAAI,EAAA,CAAA,CAAA;AAAA;AAG/E,EAAO,OAAA,KAAA;AACR;AAEa,IAAA,SAAA,GAAY,CAAC,QAAA,EAA8B,OAAqB,KAAA;AAC5E,EAAA,IAAI,aAAa,KAAW,CAAA,EAAA;AAC3B,IAAM,MAAA,IAAI,eAAe,OAAO,CAAA;AAAA;AAGjC,EAAO,OAAA,QAAA;AACR;AAea,IAAA,MAAA,GAAmB,CAAC,KAAA,EAAgB,gBAA8C,KAAA;AAC9F,EAAI,IAAA,KAAA,KAAU,KAAS,IAAA,KAAA,IAAS,IAAM,EAAA;AACrC,IAAA,MAAM,OAAU,GAAA,QAAA,CAAS,gBAAgB,CAAA,GAAI,mBAAmB,gBAAkB,EAAA,OAAA;AAElF,IAAM,MAAA,IAAI,eAAe,OAAO,CAAA;AAAA;AAElC;;;AC7Ca,IAAA,UAAA,GAAa,CACzB,KACI,KAAA","file":"index.js","sourcesContent":["import type { AnyAsyncFunction, AnyFunction, AnyObject } from \"./type-utils\";\n\nexport const isString = (value: unknown): value is string => typeof value === \"string\";\n\nexport const isBoolean = (value: unknown) => typeof value === \"boolean\";\n\nexport const isArray = <TArray>(value: unknown): value is TArray[] => Array.isArray(value);\n\nexport const isFormData = (value: unknown) => value instanceof FormData;\n\nexport const isObject = (value: unknown) => typeof value === \"object\" && value !== null;\n\nexport const isObjectAndNotArray = <TObject = Record<string, unknown>>(\n\tvalue: unknown\n): value is TObject => {\n\treturn isObject(value) && !isArray(value);\n};\n\nexport const isPlainObject = <TObject extends AnyObject>(value: unknown): value is TObject => {\n\tif (!isObject(value)) {\n\t\treturn false;\n\t}\n\n\tconst prototype = Object.getPrototypeOf(value) as unknown;\n\n\t// == Check if it's a plain object\n\treturn (\n\t\t(prototype == null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) &&\n\t\t!(Symbol.toStringTag in value)\n\t);\n};\n\nexport const isFunction = <TFunction extends AnyFunction>(value: unknown): value is TFunction => {\n\treturn typeof value === \"function\";\n};\n\nexport const isAsyncFunction = <TAsyncFunction extends AnyAsyncFunction>(\n\tvalue: unknown\n): value is TAsyncFunction => {\n\treturn isFunction(value) && value.constructor.name === \"AsyncFunction\";\n};\n\nexport const isFile = (value: unknown): value is File => value instanceof File;\n\nexport const isIterable = <TIterable>(obj: object): obj is Iterable<TIterable> => Symbol.iterator in obj;\n","import { isString } from \"./guard\";\n\nexport class AssertionError extends Error {\n\toverride name = \"AssertionError\";\n\n\tconstructor(message?: string) {\n\t\tconst prefix = \"Assertion failed\";\n\n\t\tsuper(message ? `${prefix}: ${message}` : message);\n\t}\n}\n\nexport const assertDefined = <TValue>(value: TValue) => {\n\tif (value == null) {\n\t\tthrow new AssertionError(`The value passed is \"${value as null | undefined}!\"`);\n\t}\n\n\treturn value;\n};\n\nexport const assertENV = (variable: string | undefined, message?: string) => {\n\tif (variable === undefined) {\n\t\tthrow new AssertionError(message);\n\t}\n\n\treturn variable;\n};\n\ntype AssertOptions = {\n\tmessage: string;\n};\n\ntype AssertFn = {\n\t(condition: boolean, messageOrOptions?: string | AssertOptions): asserts condition;\n\n\t<TValue>(\n\t\tvalue: TValue,\n\t\tmessageOrOptions?: string | AssertOptions\n\t): asserts value is NonNullable<TValue>;\n};\n\nexport const assert: AssertFn = (input: unknown, messageOrOptions?: string | AssertOptions) => {\n\tif (input === false || input == null) {\n\t\tconst message = isString(messageOrOptions) ? messageOrOptions : messageOrOptions?.message;\n\n\t\tthrow new AssertionError(message);\n\t}\n};\n","import type { Prettify, Writeable, WriteableLevel } from \"./type-utils\";\n\nexport const defineEnum = <const TValue, TWriteableLevel extends WriteableLevel = \"shallow\">(\n\tvalue: TValue\n) => value as Prettify<Writeable<TValue, TWriteableLevel>>;\n"]}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@zayne-labs/toolkit-type-helpers",
+  "type": "module",
+  "version": "0.8.22",
+  "description": "A collection of utility functions, types and composables used by my other projects. Nothing too fancy but can be useful.",
+  "author": "Ryan Zayne",
+  "license": "MIT",
+  "homepage": "https://github.com/zayne-labs/toolkit#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zayne-labs/toolkit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/zayne-labs/toolkit/issues"
+  },
+  "keywords": [
+    "utilities",
+    "types",
+    "hooks"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/esm/index.js"
+  },
+  "main": "./dist/esm/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.x"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.2",
+    "@changesets/cli": "^2.27.11",
+    "@size-limit/esbuild-why": "^11.1.6",
+    "@size-limit/preset-small-lib": "^11.1.6",
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@types/node": "^22.10.3",
+    "@zayne-labs/tsconfig": "0.2.1",
+    "clsx": "^2.1.1",
+    "concurrently": "^9.1.2",
+    "cross-env": "^7.0.3",
+    "publint": "^0.2.12",
+    "size-limit": "^11.1.6",
+    "terser": "^5.37.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "provenance": true
+  },
+  "size-limit": [
+    {
+      "path": "./src/index.ts",
+      "limit": "500 b"
+    }
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:dev": "cross-env NODE_ENV=development tsup",
+    "build:test": "concurrently --prefix-colors \"yellow.bold,#7da4f8.bold,magenta\" --names PUBLINT,TSUP 'pnpm:lint:publint' 'pnpm:build:dev'",
+    "lint:attw": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "lint:check-types": "tsc --pretty --incremental -p tsconfig.json",
+    "lint:publint": "publint --strict .",
+    "lint:size": "size-limit",
+    "release": "pnpm publish --no-git-checks",
+    "test:release": "pnpx pkg-pr-new publish"
+  }
+}