@thi.ng/api 7.1.7 → 8.0.0

package/README.md

@@ -14,7 +14,6 @@ This project is part of the
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [API](#api)
-  - [Environment variables](#environment-variables)
 - [Authors](#authors)
   - [Maintainer](#maintainer)
   - [Contributors](#contributors)
@@ -24,14 +23,12 @@ This project is part of the
 
 Common, generic types, interfaces & mixins.
 
-This package is implicitly used by most other projects in this
-repository. It defines:
+This package is implicitly used by most other projects in this repository. It
+defines:
 
 - Dozens of generic, common interfaces & types
 - Class & method decorators
 - Mixins
-- Logging
-- Assert (can be disabled for production builds)
 - Typedarray utilities
 
 ### Status
@@ -46,15 +43,23 @@ repository. It defines:
 yarn add @thi.ng/api
 ```
 
+ES module import:
+
 ```html
-// ES module
-<script type="module" src="https://unpkg.com/@thi.ng/api?module" crossorigin></script>
+<script type="module" src="https://cdn.skypack.dev/@thi.ng/api"></script>
+```
+
+[Skypack documentation](https://docs.skypack.dev/)
+
+For NodeJS (v14.6+):
 
-// UMD
-<script src="https://unpkg.com/@thi.ng/api/lib/index.umd.js" crossorigin></script>
+```text
+node --experimental-specifier-resolution=node --experimental-repl-await
+
+> const api = await import("@thi.ng/api");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 2.18 KB / CJS: 2.35 KB / UMD: 2.27 KB
+Package sizes (gzipped, pre-treeshake): ESM: 1.73 KB
 
 ## Dependencies
 
@@ -64,21 +69,6 @@ None
 
 [Generated API docs](https://docs.thi.ng/umbrella/api/)
 
-### Environment variables
-
-The following env variables are used to control the behavior of some functions in production builds:
-
-- `UMBRELLA_ASSERTS` -  if set to `1` the
-  [assert](https://github.com/thi-ng/umbrella/tree/develop/packages/api/src/assert.ts)
-  function will **always** be enabled. By default, `assert()` is
-  disabled for production builds, i.e. if `process.env.NODE_ENV ===
-  "production"`.
-- `UMBRELLA_GLOBALS` -  if set to `1` the
-  [exposeGlobal](https://github.com/thi-ng/umbrella/tree/develop/packages/api/src/expose.ts)
-  function will **always** be enabled. By default, `exposeGlobal()` is
-  disabled for production builds, i.e. if `process.env.NODE_ENV ===
-  "production"`.
-
 ## Authors
 
 ### Maintainer

package/{constants.d.ts → api.d.ts}

@@ -15,4 +15,4 @@ export declare const NO_OP: () => void;
 export declare const EVENT_ALL = "*";
 export declare const EVENT_ENABLE = "enable";
 export declare const EVENT_DISABLE = "disable";
-//# sourceMappingURL=constants.d.ts.map
+//# sourceMappingURL=api.d.ts.map

package/decorators/deprecated.js

@@ -1,4 +1,3 @@
-import { assert } from "../assert";
 /**
  * Method property decorator factory. Augments original method with
  * deprecation message (via console), shown when method is invoked.
@@ -10,7 +9,9 @@ import { assert } from "../assert";
 export const deprecated = (msg, log = console.log) => function (target, prop, descriptor) {
     const signature = `${target.constructor.name}#${prop.toString()}`;
     const fn = descriptor.value;
-    assert(typeof fn === "function", `${signature} is not a function`);
+    if (typeof fn !== "function") {
+        throw new Error(`${signature} is not a function`);
+    }
     descriptor.value = function () {
         log(`DEPRECATED ${signature}: ${msg || "will be removed soon"}`);
         return fn.apply(this, arguments);

package/index.d.ts

@@ -1,46 +1,42 @@
-export * from "./api/assoc";
-export * from "./api/bind";
-export * from "./api/buffered";
-export * from "./api/clear";
-export * from "./api/compare";
-export * from "./api/contains";
-export * from "./api/copy";
-export * from "./api/deref";
-export * from "./api/dissoc";
-export * from "./api/empty";
-export * from "./api/enable";
-export * from "./api/equiv";
-export * from "./api/event";
-export * from "./api/fn";
-export * from "./api/get";
-export * from "./api/hash";
-export * from "./api/hiccup";
-export * from "./api/id";
-export * from "./api/indexed";
-export * from "./api/into";
-export * from "./api/keyval";
-export * from "./api/length";
-export * from "./api/logger";
-export * from "./api/meta";
-export * from "./api/null";
-export * from "./api/object";
-export * from "./api/path";
-export * from "./api/predicate";
-export * from "./api/prim";
-export * from "./api/range";
-export * from "./api/release";
-export * from "./api/reset";
-export * from "./api/select";
-export * from "./api/seq";
-export * from "./api/set";
-export * from "./api/stack";
-export * from "./api/tuple";
-export * from "./api/typedarray";
-export * from "./api/watch";
-export * from "./assert";
-export * from "./constants";
-export * from "./expose";
-export * from "./logger";
+export * from "./assoc";
+export * from "./bind";
+export * from "./buffered";
+export * from "./clear";
+export * from "./compare";
+export * from "./contains";
+export * from "./copy";
+export * from "./deref";
+export * from "./dissoc";
+export * from "./empty";
+export * from "./enable";
+export * from "./equiv";
+export * from "./event";
+export * from "./fn";
+export * from "./get";
+export * from "./hash";
+export * from "./hiccup";
+export * from "./id";
+export * from "./indexed";
+export * from "./into";
+export * from "./keyval";
+export * from "./length";
+export * from "./meta";
+export * from "./null";
+export * from "./object";
+export * from "./path";
+export * from "./predicate";
+export * from "./prim";
+export * from "./range";
+export * from "./release";
+export * from "./reset";
+export * from "./select";
+export * from "./seq";
+export * from "./set";
+export * from "./stack";
+export * from "./tuple";
+export * from "./typedarray";
+export * from "./watch";
+export * from "./api";
 export * from "./mixin";
 export * from "./decorators/configurable";
 export * from "./decorators/deprecated";

package/index.js

@@ -1,46 +1,42 @@
-export * from "./api/assoc";
-export * from "./api/bind";
-export * from "./api/buffered";
-export * from "./api/clear";
-export * from "./api/compare";
-export * from "./api/contains";
-export * from "./api/copy";
-export * from "./api/deref";
-export * from "./api/dissoc";
-export * from "./api/empty";
-export * from "./api/enable";
-export * from "./api/equiv";
-export * from "./api/event";
-export * from "./api/fn";
-export * from "./api/get";
-export * from "./api/hash";
-export * from "./api/hiccup";
-export * from "./api/id";
-export * from "./api/indexed";
-export * from "./api/into";
-export * from "./api/keyval";
-export * from "./api/length";
-export * from "./api/logger";
-export * from "./api/meta";
-export * from "./api/null";
-export * from "./api/object";
-export * from "./api/path";
-export * from "./api/predicate";
-export * from "./api/prim";
-export * from "./api/range";
-export * from "./api/release";
-export * from "./api/reset";
-export * from "./api/select";
-export * from "./api/seq";
-export * from "./api/set";
-export * from "./api/stack";
-export * from "./api/tuple";
-export * from "./api/typedarray";
-export * from "./api/watch";
-export * from "./assert";
-export * from "./constants";
-export * from "./expose";
-export * from "./logger";
+export * from "./assoc";
+export * from "./bind";
+export * from "./buffered";
+export * from "./clear";
+export * from "./compare";
+export * from "./contains";
+export * from "./copy";
+export * from "./deref";
+export * from "./dissoc";
+export * from "./empty";
+export * from "./enable";
+export * from "./equiv";
+export * from "./event";
+export * from "./fn";
+export * from "./get";
+export * from "./hash";
+export * from "./hiccup";
+export * from "./id";
+export * from "./indexed";
+export * from "./into";
+export * from "./keyval";
+export * from "./length";
+export * from "./meta";
+export * from "./null";
+export * from "./object";
+export * from "./path";
+export * from "./predicate";
+export * from "./prim";
+export * from "./range";
+export * from "./release";
+export * from "./reset";
+export * from "./select";
+export * from "./seq";
+export * from "./set";
+export * from "./stack";
+export * from "./tuple";
+export * from "./typedarray";
+export * from "./watch";
+export * from "./api";
 export * from "./mixin";
 export * from "./decorators/configurable";
 export * from "./decorators/deprecated";

package/mixins/ienable.js

@@ -1,4 +1,4 @@
-import { EVENT_DISABLE, EVENT_ENABLE } from "../constants";
+import { EVENT_DISABLE, EVENT_ENABLE } from "../api";
 import { mixin } from "../mixin";
 /**
  * Mixin class decorator, injects IEnable default implementation, incl.

package/mixins/inotify.d.ts

@@ -1,4 +1,4 @@
-import type { Event } from "../api/event";
+import type { Event } from "../event";
 export declare const inotify_dispatch: (listeners: any[][], e: Event) => void;
 /**
  * Mixin class decorator, injects INotify default implementation, incl.

package/mixins/inotify.js

@@ -1,4 +1,4 @@
-import { EVENT_ALL } from "../constants";
+import { EVENT_ALL } from "../api";
 import { mixin } from "../mixin";
 export const inotify_dispatch = (listeners, e) => {
     if (!listeners)

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@thi.ng/api",
-    "version": "7.1.7",
+    "version": "8.0.0",
     "description": "Common, generic types, interfaces & mixins",
+    "type": "module",
     "module": "./index.js",
-    "main": "./lib/index.js",
-    "umd:main": "./lib/index.umd.js",
     "typings": "./index.d.ts",
+    "sideEffects": false,
     "repository": {
         "type": "git",
         "url": "https://github.com/thi-ng/umbrella.git"
@@ -24,27 +24,18 @@
     "author": "Karsten Schmidt <k+npm@thi.ng>",
     "license": "Apache-2.0",
     "scripts": {
-        "build": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module",
-        "build:release": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module all",
-        "build:es6": "tsc --declaration",
-        "build:test": "rimraf build && tsc -p test/tsconfig.json",
-        "build:check": "tsc --isolatedModules --noEmit",
-        "test": "mocha test",
-        "cover": "nyc mocha test && nyc report --reporter=lcov",
-        "clean": "rimraf *.js *.d.ts *.map .nyc_output build coverage doc lib api decorators mixins",
-        "doc:readme": "ts-node -P ../../tools/tsconfig.json ../../tools/src/readme.ts",
-        "doc": "typedoc --excludePrivate --out doc --theme ../../tools/doc/typedoc-theme src/index.ts",
+        "build": "yarn clean && tsc --declaration",
+        "clean": "rimraf *.js *.d.ts *.map doc api decorators mixins",
+        "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
         "doc:ae": "mkdir -p .ae/doc .ae/temp && node_modules/.bin/api-extractor run --local --verbose",
-        "pub": "yarn build:release && yarn publish --access public"
+        "doc:readme": "yarn doc:stats && ../../scripts/node-esm ../../tools/src/readme.ts",
+        "doc:stats": "../../scripts/node-esm ../../tools/src/module-stats.ts",
+        "pub": "yarn build && yarn publish --access public",
+        "test": "testament test"
+    },
+    "devDependencies": {
+        "@thi.ng/testament": "^0.1.0"
     },
-    "files": [
-        "*.js",
-        "*.d.ts",
-        "lib",
-        "api",
-        "decorators",
-        "mixins"
-    ],
     "keywords": [
         "assert",
         "constants",
@@ -62,6 +53,160 @@
         "process": false,
         "setTimeout": false
     },
-    "sideEffects": false,
-    "gitHead": "a85a4dd69e086a18d97d22204667c6b5334b01e0"
+    "files": [
+        "*.js",
+        "*.d.ts",
+        "decorators",
+        "mixins"
+    ],
+    "exports": {
+        ".": {
+            "import": "./index.js"
+        },
+        "./api": {
+            "import": "./api.js"
+        },
+        "./assoc": {
+            "import": "./assoc.js"
+        },
+        "./bind": {
+            "import": "./bind.js"
+        },
+        "./buffered": {
+            "import": "./buffered.js"
+        },
+        "./clear": {
+            "import": "./clear.js"
+        },
+        "./compare": {
+            "import": "./compare.js"
+        },
+        "./contains": {
+            "import": "./contains.js"
+        },
+        "./copy": {
+            "import": "./copy.js"
+        },
+        "./decorators/configurable": {
+            "import": "./decorators/configurable.js"
+        },
+        "./decorators/deprecated": {
+            "import": "./decorators/deprecated.js"
+        },
+        "./decorators/nomixin": {
+            "import": "./decorators/nomixin.js"
+        },
+        "./decorators/sealed": {
+            "import": "./decorators/sealed.js"
+        },
+        "./deref": {
+            "import": "./deref.js"
+        },
+        "./dissoc": {
+            "import": "./dissoc.js"
+        },
+        "./empty": {
+            "import": "./empty.js"
+        },
+        "./enable": {
+            "import": "./enable.js"
+        },
+        "./equiv": {
+            "import": "./equiv.js"
+        },
+        "./event": {
+            "import": "./event.js"
+        },
+        "./fn": {
+            "import": "./fn.js"
+        },
+        "./get": {
+            "import": "./get.js"
+        },
+        "./hash": {
+            "import": "./hash.js"
+        },
+        "./hiccup": {
+            "import": "./hiccup.js"
+        },
+        "./id": {
+            "import": "./id.js"
+        },
+        "./indexed": {
+            "import": "./indexed.js"
+        },
+        "./into": {
+            "import": "./into.js"
+        },
+        "./keyval": {
+            "import": "./keyval.js"
+        },
+        "./length": {
+            "import": "./length.js"
+        },
+        "./meta": {
+            "import": "./meta.js"
+        },
+        "./mixin": {
+            "import": "./mixin.js"
+        },
+        "./mixins/ienable": {
+            "import": "./mixins/ienable.js"
+        },
+        "./mixins/inotify": {
+            "import": "./mixins/inotify.js"
+        },
+        "./mixins/iterable": {
+            "import": "./mixins/iterable.js"
+        },
+        "./mixins/iwatch": {
+            "import": "./mixins/iwatch.js"
+        },
+        "./null": {
+            "import": "./null.js"
+        },
+        "./object": {
+            "import": "./object.js"
+        },
+        "./path": {
+            "import": "./path.js"
+        },
+        "./predicate": {
+            "import": "./predicate.js"
+        },
+        "./prim": {
+            "import": "./prim.js"
+        },
+        "./range": {
+            "import": "./range.js"
+        },
+        "./release": {
+            "import": "./release.js"
+        },
+        "./reset": {
+            "import": "./reset.js"
+        },
+        "./select": {
+            "import": "./select.js"
+        },
+        "./seq": {
+            "import": "./seq.js"
+        },
+        "./set": {
+            "import": "./set.js"
+        },
+        "./stack": {
+            "import": "./stack.js"
+        },
+        "./tuple": {
+            "import": "./tuple.js"
+        },
+        "./typedarray": {
+            "import": "./typedarray.js"
+        },
+        "./watch": {
+            "import": "./watch.js"
+        }
+    },
+    "gitHead": "9ac1344b38b565eb894306fbf72233b6c0b2d115"
 }