@thi.ng/api 8.10.1 → 8.11.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-11T12:32:44Z
+- **Last updated**: 2024-04-23T07:02:17Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [8.11.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.11.0) (2024-04-20)
+
+#### 🚀 Features
+
+- add Maybe type alias, refactor related ([0777d33](https://github.com/thi-ng/umbrella/commit/0777d33))
+
 ## [8.10.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.10.0) (2024-04-08)
 
 #### 🚀 Features

package/README.md

@@ -55,10 +55,10 @@ import * as api from "@thi.ng/api";
 Browser ESM import:
 
 ```html
-<script type="module" src="https://cdn.skypack.dev/@thi.ng/api"></script>
+<script type="module" src="https://esm.run/@thi.ng/api"></script>
 ```
 
-[Skypack documentation](https://docs.skypack.dev/)
+[JSDelivr documentation](https://www.jsdelivr.com/)
 
 For Node.js REPL:
 

package/get.d.ts

@@ -1,15 +1,16 @@
+import type { Maybe } from "./null.js";
 /**
  * @param K - key type
  * @param V - value type
  */
 export interface IGet<K, V> {
-    get(key: K, notfound?: V): V | undefined;
+    get(key: K, notfound?: V): Maybe<V>;
 }
 /**
  * @param K - key type
  * @param V - value type
  */
 export interface IGetIn<K, V> {
-    getIn(key: K[], notfound?: V): V | undefined;
+    getIn(key: K[], notfound?: V): Maybe<V>;
 }
 //# sourceMappingURL=get.d.ts.map

package/null.d.ts

@@ -1,3 +1,4 @@
+export type Maybe<T> = T | undefined;
 export type Nullable<T> = T | null | undefined;
 /**
  * Similar to `NonNullable`, but only excludes `undefined`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/api",
-  "version": "8.10.1",
+  "version": "8.11.1",
   "description": "Common, generic types, interfaces & mixins",
   "type": "module",
   "module": "./index.js",
@@ -30,7 +30,7 @@
     "build": "yarn build:esbuild && yarn build:decl",
     "build:decl": "tsc --declaration --emitDeclarationOnly",
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
-    "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc api decorators mixins",
+    "clean": "bun ../../tools/src/clean-package.ts decorators mixins",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
@@ -41,7 +41,6 @@
   "devDependencies": {
     "@microsoft/api-extractor": "^7.43.0",
     "esbuild": "^0.20.2",
-    "rimraf": "^5.0.5",
     "typedoc": "^0.25.12",
     "typescript": "^5.4.3"
   },
@@ -229,5 +228,5 @@
       "default": "./watch.js"
     }
   },
-  "gitHead": "18a0c063a7b33d790e5bc2486c106f45f663ac28\n"
+  "gitHead": "5dd66c18a3862a3af69a5b2f49563f7cbdd960c2\n"
 }

package/path.d.ts

@@ -1,6 +1,7 @@
-import type { NumOrString } from "./prim.js";
 import type { Keys, Keys1, Keys2, Keys3, Keys4, Keys5, Keys6, Keys7, ValN } from "./keyval.js";
-import type { Head, Tail, IsEmpty } from "./tuple.js";
+import type { Maybe } from "./null.js";
+import type { NumOrString } from "./prim.js";
+import type { Head, IsEmpty, Tail } from "./tuple.js";
 /**
  * Unchecked lookup path for nested data structures.
  */
@@ -47,9 +48,9 @@ export type Path8<T, A, B, C, D, E, F, G, H> = A extends Keys<T> ? B extends Key
  */
 export type DeepPath<T, A, B, C, D, E, F, G, H> = A extends Keys<T> ? B extends Keys1<T, A> ? C extends Keys2<T, A, B> ? D extends Keys3<T, A, B, C> ? E extends Keys4<T, A, B, C, D> ? F extends Keys5<T, A, B, C, D, E> ? G extends Keys6<T, A, B, C, D, E, F> ? H extends Keys7<T, A, B, C, D, E, F, G> ? readonly [A, B, C, D, E, F, G, H, ...NumOrString[]] : never : never : never : never : never : never : never : never;
 /**
- * Returns `RES` if `PRED` is `never`, else `RES | undefined`
+ * Returns `RES` if `PRED` is `never`, else `Maybe<RES>`
  */
-export type OptVal<PRED, RES> = [PRED] extends [never] ? RES : RES | undefined;
+export type OptVal<PRED, RES> = [PRED] extends [never] ? RES : Maybe<RES>;
 /**
  * Returns true if `T` includes undefined.
  */

package/seq.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from "./null.js";
 /**
  * Lisp-like sequence abstraction for arbitrary types using `first` &
  * `next` operations only.
@@ -18,7 +19,7 @@ export interface ISeq<T> {
      * determine the end. If the sequence DOES contain `undefined`
      * values, the check should use `seq.next()`.
      */
-    first(): T | undefined;
+    first(): Maybe<T>;
     /**
      * Returns a new sequence of the remaining elements or `undefined`
      * if there're no further values.
@@ -28,7 +29,7 @@ export interface ISeq<T> {
      * a new sequence instance and not mutate some internal cursor. I.e.
      * `seq.next() !== seq`
      */
-    next(): ISeq<T> | undefined;
+    next(): Maybe<ISeq<T>>;
 }
 /**
  * Interface for data types providing an {@link ISeq} abstraction.
@@ -38,6 +39,6 @@ export interface ISeqable<T> {
      * Returns an {@link ISeq} of the type's data or `undefined` if
      * there're no values available. See {@link ISeq.next}
      */
-    seq(): ISeq<T> | undefined;
+    seq(): Maybe<ISeq<T>>;
 }
 //# sourceMappingURL=seq.d.ts.map

package/stack.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from "./null.js";
 /**
  * Generic interface for collections implementing
  * stack functionality.
@@ -10,11 +11,16 @@ export interface IStack<V, P, S> {
     /**
      * Returns top-of-stack item.
      */
-    peek(): V | undefined;
+    peek(): Maybe<V>;
     /**
      * Removes top-of-stack item and returns type P.
      */
-    pop(): P | undefined;
+    pop(): Maybe<P>;
+    /**
+     * Pushes item onto stack, returns type S.
+     *
+     * @param x
+     */
     push(x: V): S;
 }
 //# sourceMappingURL=stack.d.ts.map

package/typedarray.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from "./null.js";
 export type ArrayLikeIterable<T> = ArrayLike<T> & Iterable<T>;
 export type NumericArray = number[] | TypedArray;
 export type TypedArray = Float32Array | Float64Array | Int8Array | Int16Array | Int32Array | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array;
@@ -49,7 +50,7 @@ export declare const GL2TYPE: Record<GLType, Type>;
  * - `F64` maps to `undefined`, since unsupported by WebGL
  * - `U8C` maps to "u8"
  */
-export declare const TYPE2GL: Record<Type, GLType | undefined>;
+export declare const TYPE2GL: Record<Type, Maybe<GLType>>;
 /**
  * Size information (in bytes) for {@link Type} and {@link BigType}. Also see
  * {@link sizeOf}.