@starbeam/core-utils - npm Package Compare versions

Comparing version 0.8.10-unstable.398c1bd to 0.8.10-unstable.3b6efdd

.eslintrc.json

 {
-  "root": false,
-  "overrides": [
-    {
-      "extends": ["plugin:@starbeam/tight"],
-      "files": ["index.ts", "src/**/*.ts"],
-      "parserOptions": {
-        "project": "tsconfig.json"
-      }
-    }
-  ]
+  "root": true,
+  "extends": ["plugin:@starbeam-dev/library:recommended"]
 }

CHANGELOG.md

@@ -1,150 +0,2 @@
-# @starbeam/core-utils
+# Changelog
 
-## 0.8.9
-
-### Patch Changes
-
-- e459bf2: Fix CJS builds
-
-## 0.8.8
-
-### Patch Changes
-
-- 2a1f728: Improve @starbeam/react
-
-## 0.8.7
-
-### Patch Changes
-
-- 14f961b: Fixes #75
-
-## 0.8.7
-
-### Patch Changes
-
-- ded6421: Add /setup to preact
-
-## 0.8.6
-
-### Patch Changes
-
-- 6502cc7: Remove errant import
-
-## 0.8.5
-
-### Patch Changes
-
-- de755c6: Improve type inference
-
-## 0.8.4
-
-### Patch Changes
-
-- 3bf1221: Prepare for Starbeam 0.8.4
-
-## 0.8.0
-
-### Minor Changes
-
-- 1a553c5: Prepare for 0.8
-
-## 0.7.3
-
-### Patch Changes
-
-- 40844fd: Try to fix the build
-
-## 0.7.2
-
-### Patch Changes
-
-- 50f7a8f: Publish @domtree
-- Updated dependencies [50f7a8f]
-  - @starbeam/shared@1.2.1
-
-## 0.7.0
-
-### Minor Changes
-
-- 58f7974: Starbeam 0.7.0
-
-  - Significant improvements to debugging infrastructure
-
-### Patch Changes
-
-- Updated dependencies [58f7974]
-  - @starbeam/shared@1.2.0
-
-## 0.6.0
-
-### Minor Changes
-
-- Prepare 0.6.0
-
-### Patch Changes
-
-- Updated dependencies
-  - @starbeam/shared@1.1.0
-
-## 0.5.8
-
-### Patch Changes
-
-- Prepare 0.5.8
-- Updated dependencies
-  - @starbeam/shared@1.0.8
-
-## 0.5.7
-
-### Patch Changes
-
-- Fix a bug in the transition from uninitialized to initialized reactive Map
-- Updated dependencies
-  - @starbeam/shared@1.0.7
-
-## 0.5.6
-
-### Patch Changes
-
-- Fix ESM package mistakes
-- Updated dependencies
-  - @starbeam/shared@1.0.6
-
-## 0.5.5
-
-### Patch Changes
-
-- Another attempt to get the build right
-- Updated dependencies
-  - @starbeam/shared@1.0.5
-
-## 0.5.4
-
-### Patch Changes
-
-- The 0.5.3 release was missing dists
-- Updated dependencies
-  - @starbeam/shared@1.0.4
-
-## 0.5.3
-
-### Patch Changes
-
-- d21391d: Update resources to support React's three-phase lifecycle
-- Updated dependencies [d21391d]
-  - @starbeam/shared@1.0.3
-
-## 0.5.2
-
-### Patch Changes
-
-- 719a6fe: Updated package export maps
-- Updated dependencies [719a6fe]
-  - @starbeam/shared@1.0.2
-
-## 0.5.1
-
-### Patch Changes
-
-- 2a957e5: Try to fix types
-- e03c2a0: Initial publish

index.ts

 export {
+  FIRST_OFFSET,
   firstNItems,
@@ -9,4 +10,7 @@ getFirst,
   isEmptyArray,
+  isEmptyCollection,
   isPresentArray,
+  isPresentCollection,
   isSingleItemArray,
+  LAST_OFFSET,
   mapArray,
@@ -26,14 +30,2 @@ mapIfPresent,
 export { type UnknownFn } from "./src/function.js";
-export {
-  DisplayStruct,
-  type DisplayStructOptions,
-} from "./src/inspect/display-struct.js";
-export {
-  DEBUG,
-  DEBUG_NAME,
-  INSPECT,
-  type Inspect,
-  inspect,
-  inspector,
-} from "./src/inspect/inspect-support.js";
 export { iterableHasItems, reverse } from "./src/iterable.js";
@@ -52,2 +44,3 @@ export type {
   defMethod,
+  type Expand,
   getter,
@@ -60,9 +53,2 @@ isObject,
 export { type Matcher, Overload, type TypedOverload } from "./src/overload.js";
-export { isEmptyMatch, matchPattern, Pattern } from "./src/regexp.js";
-export {
-  asIntIndex,
-  isPresentString,
-  stringify,
-  TO_STRING,
-} from "./src/string.js";
 export { isPresent } from "./src/value.js";

package.json

 {
   "name": "@starbeam/core-utils",
-  "version": "0.8.10-unstable.398c1bd",
   "type": "module",
-  "main": "index.ts",
-  "types": "index.ts",
+  "version": "0.8.10-unstable.3b6efdd",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.ts",
   "exports": {
-    "default": "./index.ts"
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "default": "./dist/index.cjs"
   },
-  "publishConfig": {
-    "exports": {
-      ".": {
-        "types": "./dist/index.d.ts",
-        "import": "./dist/index.js",
-        "default": "./dist/index.cjs"
-      }
-    },
-    "main": "dist/index.cjs",
-    "types": "dist/index.d.ts"
+  "starbeam": {
+    "type": "library:public"
   },
-  "starbeam:type": "library:public",
+  "dependencies": {},
+  "devDependencies": {
+    "@starbeam-dev/eslint-plugin": "^1.0.6",
+    "rollup": "^4.0.2",
+    "@starbeam-dev/compile": "1.2.0"
+  },
   "scripts": {
-    "test:lint": "eslint \"index.ts\" \"src/**/*.ts\"",
-    "test:specs": "vitest --run",
+    "build": "rollup -c",
+    "test:lint": "eslint . --max-warnings 0",
+    "test:specs": "vitest --run --pool forks",
     "test:types": "tsc -b"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "@starbeam-dev/build-support": "workspace:*",
-    "rollup": "^3.20.6"
   }
-}
+}

src/array.ts

@@ -0,1 +1,3 @@
+/* eslint-disable @typescript-eslint/no-magic-numbers -- this file absorbs magic
+numbers for the rest of the codebase */
 const EMPTY_LENGTH = 0;
@@ -6,2 +8,3 @@
 export type PresentArray<T> = MutablePresentArray<T> | ReadonlyPresentArray<T>;
+export type ArrayItem<T> = T extends unknown[] ? T[number] : never;
 
@@ -11,8 +14,10 @@ export type AnyArray<T> = T[] | readonly T[];
 type PresentArrayFor<T extends unknown[] | readonly unknown[] | undefined> =
-  T extends readonly (infer Item)[] | (infer Item)[]
-    ? readonly [Item, ...Item[]]
-    : never;
+  T extends (infer Item)[]
+    ? [Item, ...Item[]]
+    : T extends readonly (infer Item)[]
+      ? readonly [Item, ...Item[]]
+      : never;
 
 export function isPresentArray<
-  T extends unknown[] | readonly unknown[] | undefined
+  T extends unknown[] | readonly unknown[] | undefined,
 >(list: T): list is T & PresentArrayFor<T> {
@@ -24,11 +29,11 @@ return list && list.length > EMPTY_LENGTH;
   list: PresentArray<T>,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): MutablePresentArray<U>;
 export function mapArray<T, U>(
   list: T[] | readonly T[],
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): U[];
 export function mapArray<T, U>(
   list: T[] | readonly T[] | PresentArray<T>,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): U[] | PresentArray<U> {
@@ -40,3 +45,3 @@ return list.map(mapper);
   list: PresentArray<T>,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): PresentArray<U> {
@@ -48,11 +53,11 @@ return list.map(mapper) as PresentArray<U>;
   list: T[] | undefined | null,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): MutablePresentArray<U> | undefined;
 export function mapIfPresent<T, U>(
   list: readonly T[] | undefined | null,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): ReadonlyPresentArray<U> | undefined;
 export function mapIfPresent<T, U>(
   list: T[] | readonly T[] | undefined | null,
-  mapper: (item: T, index: number) => U
+  mapper: (item: T, index: number) => U,
 ): MutablePresentArray<U> | ReadonlyPresentArray<U> | undefined {
@@ -68,11 +73,11 @@ if (list && isPresentArray(list)) {
   T extends [unknown, ...unknown[]] | readonly [unknown, ...unknown[]],
-  U
+  U,
 >(list: T, callback: (value: PresentArrayFor<T>) => U): U;
 export function ifPresentArray<T extends unknown[] | readonly unknown[], U>(
   list: T | undefined | null,
-  callback: (value: PresentArrayFor<T>) => U
+  callback: (value: PresentArrayFor<T>) => U,
 ): U | undefined;
 export function ifPresentArray<T extends unknown[] | readonly unknown[], U>(
   list: T | undefined | null,
-  callback: (value: PresentArrayFor<T>) => U
+  callback: (value: PresentArrayFor<T>) => U,
 ): U | undefined {
@@ -88,10 +93,16 @@ if (list && isPresentArray(list)) {
 
-export function isSingleItemArray<T>(
-  list: T[] | readonly T[] | undefined | null
-): list is [T] {
-  return list?.length === SINGLE_ITEM;
+export function isSingleItemArray<T>(list: T): list is T & [ArrayItem<T>] {
+  return Array.isArray(list) && list.length === SINGLE_ITEM;
 }
 
+export function isEmptyCollection(collection: { size: number }): boolean {
+  return collection.size === EMPTY_LENGTH;
+}
+
+export function isPresentCollection(collection: { size: number }): boolean {
+  return collection.size > EMPTY_LENGTH;
+}
+
 export function isEmptyArray<T extends unknown[] | readonly unknown[]>(
-  list: T
+  list: T,
 ): list is T & [] {
@@ -104,3 +115,3 @@ return list.length === EMPTY_LENGTH;
   b: U[] | readonly U[],
-  zipper: (a: T, b: U) => V
+  zipper: (a: T, b: U) => V,
 ): readonly V[] {
@@ -117,3 +128,3 @@ const result: V[] = [];
 export function nullifyEmptyArray<U extends unknown[] | readonly unknown[]>(
-  list: U
+  list: U,
 ): PresentArrayFor<U> | null {
@@ -123,8 +134,8 @@ return isEmptyArray(list) ? null : (list as unknown as PresentArrayFor<U>);
 
-const FIRST_OFFSET = 0;
+export const FIRST_OFFSET = 0;
 const TAIL_OFFSET = 1;
-const LAST_OFFSET = -1;
+export const LAST_OFFSET = -1;
 
 export function withoutFirst<T, U extends unknown[]>(
-  list: [T, ...U] | readonly [T, ...U]
+  list: [T, ...U] | readonly [T, ...U],
 ): U;
@@ -140,10 +151,14 @@ export function withoutFirst<T>(list: T[] | readonly T[]): T[];
 
-export function firstNItems<T>(list: T[], n: number): T[] {
+export function firstNItems<T>(list: readonly T[], n: number): readonly T[];
+export function firstNItems<T>(list: T[], n: number): T[];
+export function firstNItems<T>(
+  list: T[] | readonly T[],
+  n: number,
+): T[] | readonly T[] {
   return list.slice(FIRST_OFFSET, n);
 }
 
-export function getFirst<I>(
-  list: [I, ...unknown[]] | readonly [I, ...unknown[]]
-): I;
-export function getFirst<T>(list: PresentArray<T>): T;
+export function getFirst<const T extends unknown[] | readonly unknown[]>(
+  list: T,
+): T[0];
 export function getFirst<T>(list: AnyArray<T> | undefined): T | undefined;
@@ -154,6 +169,86 @@ export function getFirst<T>(list: AnyArray<T> | undefined): T | undefined {
 
+// Borrowed from SimplyTyped:
+type Prev<T extends number> = [
+  -1,
+  0,
+  1,
+  2,
+  3,
+  4,
+  5,
+  6,
+  7,
+  8,
+  9,
+  10,
+  11,
+  12,
+  13,
+  14,
+  15,
+  16,
+  17,
+  18,
+  19,
+  20,
+  21,
+  22,
+  23,
+  24,
+  25,
+  26,
+  27,
+  28,
+  29,
+  30,
+  31,
+  32,
+  33,
+  34,
+  35,
+  36,
+  37,
+  38,
+  39,
+  40,
+  41,
+  42,
+  43,
+  44,
+  45,
+  46,
+  47,
+  48,
+  49,
+  50,
+  51,
+  52,
+  53,
+  54,
+  55,
+  56,
+  57,
+  58,
+  59,
+  60,
+  61,
+  62,
+][T];
+
+// Actual, legit sorcery
+// Borrowed from pelotom/hkts:
+type GetLength<original extends unknown[] | readonly unknown[]> =
+  original extends {
+    length: infer L;
+  }
+    ? L
+    : never;
+type GetLast<original extends unknown[] | readonly unknown[]> = original[Prev<
+  GetLength<original>
+>];
+
+export function getLast<T extends AnyArray<unknown>>(list: T): GetLast<T>;
 export function getLast<T>(list: PresentArray<T>): T;
-export function getLast<T>(list: T[] | readonly T[] | undefined): T | undefined;
 export function getLast<T>(
-  list: readonly T[] | T[] | undefined
+  list: readonly T[] | T[] | undefined,
 ): T | undefined {
@@ -165,6 +260,6 @@ return isPresentArray(list) ? list[getLastIndex(list)] : undefined;
 export function getLastIndex(
-  list: unknown[] | readonly unknown[]
+  list: unknown[] | readonly unknown[],
 ): number | undefined;
 export function getLastIndex(
-  list: unknown[] | readonly unknown[]
+  list: unknown[] | readonly unknown[],
 ): number | undefined {
@@ -191,6 +286,6 @@ if (isPresentArray(list)) {
 
-export function isArray<T>(
+export function isArray<T extends AnyArray<unknown>>(
   // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
-  value: unknown | readonly T[]
-): value is readonly T[];
+  value: unknown | T,
+): value is T;
 // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
@@ -202,1 +297,45 @@ export function isArray<T>(value: unknown | T[]): value is T[];
 }
+
+if (import.meta.vitest) {
+  const { describe, test, expect } = import.meta.vitest;
+
+  describe("getLastIndex", () => {
+    test("should return the last index of a non-empty array", () => {
+      const array = [1, 2, 3];
+      expect(getLastIndex(array)).toBe(2);
+    });
+
+    test("should return undefined for an empty array", () => {
+      const array: number[] = [];
+      expect(getLastIndex(array)).toBeUndefined();
+    });
+  });
+
+  describe("removeItemAt", () => {
+    test("should remove item at a given index from the array", () => {
+      const array = [1, 2, 3];
+      removeItemAt(array, 1);
+      expect(array).toEqual([1, 3]);
+    });
+  });
+
+  describe("removeItem", () => {
+    test("should remove a given item from the array", () => {
+      const array = [1, 2, 3];
+      removeItem(array, 2);
+      expect(array).toEqual([1, 3]);
+    });
+  });
+
+  describe("isArray", () => {
+    test("should return true if the input is an array", () => {
+      const array = [1, 2, 3];
+      expect(isArray(array)).toBe(true);
+    });
+
+    test("should return false if the input is not an array", () => {
+      const notArray = "not an array";
+      expect(isArray(notArray)).toBe(false);
+    });
+  });
+}

src/iterable.ts

@@ -15,1 +15,36 @@ import type { AnyArray, PresentArray } from "./array.js";
 }
+
+if (import.meta.vitest) {
+  const { test, describe, expect } = import.meta.vitest;
+
+  describe("reverse", () => {
+    test("should reverse an array", () => {
+      const input = ["a", "b", "c"];
+      const output = reverse(input);
+      expect(output).toEqual(["c", "b", "a"]);
+    });
+
+    test("should reverse a set", () => {
+      const input = new Set(["a", "b", "c"]);
+      const output = reverse(input);
+      expect(output).toEqual(["c", "b", "a"]);
+    });
+
+    test("should return an empty array when input is empty", () => {
+      expect(reverse([])).toEqual([]);
+      expect(reverse(new Set())).toEqual([]);
+    });
+  });
+
+  describe("iterableHasItems", () => {
+    test("should return true when iterable has items", () => {
+      expect(iterableHasItems(["a", "b", "c"])).toBe(true);
+      expect(iterableHasItems(new Set(["a", "b", "c"]))).toBe(true);
+    });
+
+    test("should return false when iterable is empty", () => {
+      expect(iterableHasItems([])).toBe(false);
+      expect(iterableHasItems(new Set())).toBe(false);
+    });
+  });
+}

src/object.ts

@@ -11,3 +11,3 @@ import { getFirst, isPresentArray, isSingleItemArray } from "./array.js";
 
-type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;
+export type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;
 
@@ -20,7 +20,12 @@ type WithReadonly<T, K extends keyof T> = Expand<
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+/*
+ eslint-disable @typescript-eslint/no-explicit-any -- These `any`s are necessary
+ because they express the full generalization of the key, function and
+ descriptor types. These `any`s avoid unchecked `any`s in other part of this
+ file.
+ */
 type AnyKey = keyof any;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 type AnyFunction = (...args: any[]) => any;
+type AnyTypedDescriptorMap = Record<string, TypedPropertyDescriptor<any>>;
+/* eslint-enable @typescript-eslint/no-explicit-any */
 
@@ -41,3 +46,3 @@ type DefineReadonly<T, K extends AnyKey, V> = Expand<
 export function method<T, K extends AnyKey, V extends AnyFunction>(
-  fn: V
+  fn: V,
 ): Define<T, { [P in K]: V }>;
@@ -55,3 +60,3 @@ export function method(fn: AnyFunction): TypedPropertyDescriptor<AnyFunction> {
   key: K,
-  fn: T[K] & AnyFunction
+  fn: T[K] & AnyFunction,
 ): T;
@@ -61,3 +66,3 @@ export function defMethod<T, K extends AnyKey, V extends AnyFunction>(
   key: K,
-  fn: V
+  fn: V,
 ): Define<T, { [P in K]: V }>;
@@ -67,3 +72,3 @@ export function defMethod(
   key: AnyKey,
-  fn: AnyFunction
+  fn: AnyFunction,
 ): object {
@@ -83,3 +88,3 @@ Object.defineProperty(object, key, {
   key: K,
-  fn: (object: T) => T[K]
+  fn: (object: T) => T[K],
 ): T;
@@ -89,3 +94,3 @@ export function getter<T, K extends AnyKey, V>(
   key: K,
-  fn: (object: T) => V
+  fn: (object: T) => V,
 ): Define<T, { readonly [P in K]: V }>;
@@ -95,3 +100,3 @@ export function getter(
   key: AnyKey,
-  fn: (object: object) => unknown
+  fn: (object: object) => unknown,
 ): object {
@@ -114,6 +119,5 @@ Object.defineProperty(object, key, {
 
-export function defineObject<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  R extends Record<string, TypedPropertyDescriptor<any>>
->(properties: R): DefinedObject<R> {
+export function defineObject<R extends AnyTypedDescriptorMap>(
+  properties: R,
+): DefinedObject<R> {
   return Object.defineProperties({}, properties) as DefinedObject<R>;
@@ -129,6 +133,5 @@ }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function def<T, R extends Record<string, TypedPropertyDescriptor<any>>>(
+export function def<T, R extends AnyTypedDescriptorMap>(
   object: T,
-  properties: R
+  properties: R,
 ): T & DefinedObject<R> {
@@ -146,3 +149,3 @@ return Object.defineProperties(object, properties) as T & DefinedObject<R>;
   key: K,
-  value: V
+  value: V,
 ): DefineReadonly<T, K, V>;
@@ -149,0 +152,0 @@ export function readonly(

tests/.eslintrc.json

 {
-  "root": false,
-  "overrides": [
-    {
-      "extends": ["plugin:@starbeam/loose"],
-      "files": ["**/*.ts"],
-      "parserOptions": {
-        "project": "tsconfig.json"
-      }
-    }
-  ]
+  "root": true,
+  "extends": ["plugin:@starbeam-dev/library:recommended"]
 }

tests/object.spec.ts

@@ -1,11 +0,7 @@
-import { isObject } from "@starbeam/core-utils";
 import { describe, expect, test } from "vitest";
 
-describe("object utils", () => {
-  test("isObject", () => {
-    expect(isObject(null)).toBe(false);
-    expect(isObject({})).toBe(true);
-    expect(isObject(new (class {})())).toBe(true);
-    expect(isObject([])).toBe(true);
+describe("now", () => {
+  test("ok", () => {
+    expect(true).toBe(true);
   });
 });

tests/package.json

 {
   "private": true,
   "name": "@starbeam-tests/core-utils",
+  "type": "module",
   "version": "1.0.0",
-  "type": "module",
-  "starbeam:type": "tests",
+  "starbeam": {
+    "source": "tsx",
+    "type": "tests"
+  },
   "scripts": {
-    "test:lint": "eslint ",
+    "test:lint": "eslint . --max-warnings 0",
     "test:types": "tsc -b"
@@ -13,3 +16,6 @@ },
     "@starbeam/core-utils": "workspace:^"
+  },
+  "devDependencies": {
+    "@starbeam-dev/eslint-plugin": "^1.0.6"
   }
 }

tests/tsconfig.json

@@ -5,9 +5,12 @@ {
     "composite": true,
+    "jsx": "react-jsx",
+    "jsxImportSource": "react",
+    "types": ["../../../env.d.ts"],
     "declaration": true,
     "declarationDir": "../../../../dist/types",
     "declarationMap": true,
-    "outDir": "../../../../dist/packages",
-    "types": ["../../../env"]
+    "emitDeclarationOnly": true
   },
+  "include": ["**/*.ts"],
   "exclude": ["dist/**/*"]
 }

tsconfig.json

@@ -5,9 +5,9 @@ {
     "composite": true,
+    "types": ["../../env.d.ts"],
     "declaration": true,
     "declarationDir": "../../../dist/types",
     "declarationMap": true,
-    "outDir": "../../../dist/packages",
-    "types": ["../../env"]
+    "emitDeclarationOnly": true
   },
   "exclude": ["dist/**/*"]
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

169900

increased by511.26%

Number of package files

30

increased by20%

Number of low license alerts

0

decreased by-100%

Lines of code

1497

increased by85.04%

Worsened metrics

Dev dependency count

3

increased by50%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes