vivth 1.2.0 → 1.2.2

package/README.md

@@ -62,7 +62,6 @@ npm i vivth
  - [Base64URL](#base64url)
  - [Base64URLFromFile](#base64urlfromfile)
  - [EventNameSpace](#eventnamespace)
- - [JSautoDOC](#jsautodoc)
  - [CreateImmutable](#createimmutable)
  - [EventCheck](#eventcheck)
  - [EventObject](#eventobject)
@@ -74,6 +73,7 @@ npm i vivth
  - [TryAsync](#tryasync)
  - [TrySync](#trysync)
  - [TsToMjs](#tstomjs)
+ - [JSautoDOC](#jsautodoc)
  - [AnyButUndefined](#anybutundefined)
  - [ExtnameType](#extnametype)
  - [IsListSignal](#islistsignal)
@@ -2129,16 +2129,13 @@ npm i vivth
  * @param {typeof WorkerMainThread["pathValidator"]} param0.pathValidator 	 
  * - example: 	 
  * ```js 	 
- * async (workerPath, root, base) => { 	 
+ * async (workerPath, root) => { 	 
  *  const truePathCheck = `${root}/${base}/${workerPath}`; 	 
  * 	const res = await fetch(truePathCheck); 	 
  * 	// might also check wheter it need base or not 	 
  * 	return await res.ok; 	 
  * } 	 
  * ``` 	 
- * @param {typeof WorkerMainThread["basePath"]} [param0.basePath] 	 
- * - additonal realtivePath from rootPath; 	 
- * - default: ''; 	 
  */
 ```
  - <i>example</i>:
@@ -2148,11 +2145,15 @@ npm i vivth
  	 
  WorkerMainThread.setup({ 	 
  	workerClass: Worker, 	 
- 	basePath: 'public/assets/js/workers', 	 
- 	pathValidator: async (workerPath, root, base) => { 	 
- 		const res = await fetch(`${root}/${base}/${workerPath}`); 	 
- 		// might also check wheter it need base or not 	 
- 		return await res.ok; 	 
+ 	pathValidator: async ({worker, root}) => { 	 
+ 		const res = await fetch(`${root}/${worker}`); 	 
+ 		if (res.ok) { 	 
+ 			return res 	 
+ 		} 	 
+ 		const res2 = await fetch(`${root}/someAdditionalPath/${worker}`); 	 
+ 		if (res2.ok) { 	 
+ 			return res2 	 
+ 		} 	 
  	}, 	 
  });
  
@@ -2168,23 +2169,13 @@ npm i vivth
  */
 ```
 
-#### reference:`WorkerMainThread.basePath`
-- reference for worker file `basePath`; 	 
-- edit via `setup`;
-
-```js
-/**
- * @type {string}
- */
-```
-
 #### reference:`WorkerMainThread.pathValidator`
 - reference for validating path; 	 
 - edit via `setup`;
 
 ```js
 /**
- * @type {(paths:{worker: string, root:string, base: string})=>Promise<string>}
+ * @type {(paths:{worker: string, root:string})=>Promise<string>}
  */
 ```
 
@@ -2328,60 +2319,6 @@ npm i vivth
 
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
-<h2 id="jsautodoc">JSautoDOC</h2>
-
-
-#### reference:`JSautoDOC`
-- class for auto documenting mjs package/project, using jsdoc;  
-- this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;  
-- this class also is used to generate this `README.md`;  
-- behaviours:  
->1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;  
->>- auto export must follows the following rules, and there's no way to override;  
->2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
->3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
->4) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
->5) extract `"at"description` jsdoc:  
->>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;  
->>- `"at"description` are treated as plain `markdown`;  
->>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;  
->>- `"at"example` are treated as `javascript` block on the `markdown` file, and should be placed last on the same comment block;  
->>- you can always look at `vivth/src` files to check how the source, and the `README.md` and `index.mjs` documentation/generation results;
-
-
-#### reference:`new JSautoDOC`
-
-
-```js
-/**
- * @param {Object} [options] 	 
- * @param {Object} [options.paths] 	 
- * @param {string} [options.paths.file] 	 
- * - entry point; 	 
- * @param {string} [options.paths.readMe] 	 
- * - readme target; 	 
- * @param {string} [options.paths.dir] 	 
- * - source directory; 	 
- * @param {string} [options.copyright] 	 
- * @param {string} [options.tableOfContentTitle] 	 
- * @param {import('chokidar').ChokidarOptions} [options.option] 	 
- * - ChokidarOptions; 	 
- */
-```
- - <i>example</i>:
-```js  
- import { JSautoDOC } from 'vivth'; 	 
- 	 
-  new JSautoDOC({ 	 
- 	paths: { dir: 'src', file: 'index.mjs', readMe: 'README.md' }, 	 
- 	copyright: 'this library is made and distributed under MIT license;', 	 
- 	tableOfContentTitle: 'list of exported API and typehelpers', 	 
- }); 	 
-  
-```
-
-*) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
-
 <h2 id="createimmutable">CreateImmutable</h2>
 
 
@@ -2749,6 +2686,60 @@ npm i vivth
 
 *) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
 
+<h2 id="jsautodoc">JSautoDOC</h2>
+
+
+#### reference:`JSautoDOC`
+- class for auto documenting mjs package/project, using jsdoc;  
+- this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;  
+- this class also is used to generate this `README.md`;  
+- behaviours:  
+>1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;  
+>>- auto export must follows the following rules, and there's no way to override;  
+>2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
+>3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
+>4) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
+>5) extract `"at"description` jsdoc:  
+>>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;  
+>>- `"at"description` are treated as plain `markdown`;  
+>>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;  
+>>- `"at"example` are treated as `javascript` block on the `markdown` file, and should be placed last on the same comment block;  
+>>- you can always look at `vivth/src` files to check how the source, and the `README.md` and `index.mjs` documentation/generation results;
+
+
+#### reference:`new JSautoDOC`
+
+
+```js
+/**
+ * @param {Object} [options] 	 
+ * @param {Object} [options.paths] 	 
+ * @param {string} [options.paths.file] 	 
+ * - entry point; 	 
+ * @param {string} [options.paths.readMe] 	 
+ * - readme target; 	 
+ * @param {string} [options.paths.dir] 	 
+ * - source directory; 	 
+ * @param {string} [options.copyright] 	 
+ * @param {string} [options.tableOfContentTitle] 	 
+ * @param {import('chokidar').ChokidarOptions} [options.option] 	 
+ * - ChokidarOptions; 	 
+ */
+```
+ - <i>example</i>:
+```js  
+ import { JSautoDOC } from 'vivth'; 	 
+ 	 
+  new JSautoDOC({ 	 
+ 	paths: { dir: 'src', file: 'index.mjs', readMe: 'README.md' }, 	 
+ 	copyright: 'this library is made and distributed under MIT license;', 	 
+ 	tableOfContentTitle: 'list of exported API and typehelpers', 	 
+ }); 	 
+  
+```
+
+*) <sub>[go to list of exported API and typehelpers](#list-of-exported-api-and-typehelpers)</sub>
+
 <h2 id="anybutundefined">AnyButUndefined</h2>
 
 - jsdoc types:

package/index.mjs

@@ -29,7 +29,6 @@ export { WorkerMainThread } from './src/class/WorkerMainThread.mjs';
 export { Base64URL } from './src/common/Base64URL.mjs';
 export { Base64URLFromFile } from './src/common/Base64URLFromFile.mjs';
 export { EventNameSpace } from './src/common/EventNameSpace.mjs';
-export { JSautoDOC } from './src/doc/JSautoDOC.mjs';
 export { CreateImmutable } from './src/function/CreateImmutable.mjs';
 export { EventCheck } from './src/function/EventCheck.mjs';
 export { EventObject } from './src/function/EventObject.mjs';
@@ -41,6 +40,7 @@ export { Try } from './src/function/Try.mjs';
 export { TryAsync } from './src/function/TryAsync.mjs';
 export { TrySync } from './src/function/TrySync.mjs';
 export { TsToMjs } from './src/function/TsToMjs.mjs';
+export { JSautoDOC } from './src/doc/JSautoDOC.mjs';
 export { WorkerResult } from './src/class/WorkerResult.mjs';
 export { WorkerThread } from './src/class/WorkerThread.mjs';
 export { ToBundledJSPlugin } from './src/bundler/adds/ToBundledJSPlugin.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vivth",
-	"version": "1.2.0",
+	"version": "1.2.2",
 	"description": "library primitives",
 	"main": "index.mjs",
 	"types": "./types/index.d.mts",

package/src/class/WorkerMainThread.mjs

@@ -43,31 +43,32 @@ export class WorkerMainThread {
 	 * @param {typeof WorkerMainThread["pathValidator"]} param0.pathValidator
 	 * - example:
 	 * ```js
-	 * async (workerPath, root, base) => {
+	 * async (workerPath, root) => {
 	 *  const truePathCheck = `${root}/${base}/${workerPath}`;
 	 * 	const res = await fetch(truePathCheck);
 	 * 	// might also check wheter it need base or not
 	 * 	return await res.ok;
 	 * }
 	 * ```
-	 * @param {typeof WorkerMainThread["basePath"]} [param0.basePath]
-	 * - additonal realtivePath from rootPath;
-	 * - default: '';
 	 * @example
 	 * import { Worker } from 'node:worker_threads';
 	 * import { WorkerMainThread } from 'vivth';
 	 *
 	 * WorkerMainThread.setup({
 	 * 	workerClass: Worker,
-	 * 	basePath: 'public/assets/js/workers',
-	 * 	pathValidator: async (workerPath, root, base) => {
-	 * 		const res = await fetch(`${root}/${base}/${workerPath}`);
-	 * 		// might also check wheter it need base or not
-	 * 		return await res.ok;
+	 * 	pathValidator: async ({worker, root}) => {
+	 * 		const res = await fetch(`${root}/${worker}`);
+	 * 		if (res.ok) {
+	 * 			return res
+	 * 		}
+	 * 		const res2 = await fetch(`${root}/someAdditionalPath/${worker}`);
+	 * 		if (res2.ok) {
+	 * 			return res2
+	 * 		}
 	 * 	},
 	 * });
 	 */
-	static setup = ({ workerClass, pathValidator, basePath = '' }) => {
+	static setup = ({ workerClass, pathValidator }) => {
 		if (!Paths.root) {
 			return;
 		}
@@ -78,7 +79,6 @@ export class WorkerMainThread {
 		WorkerMainThread.#isRegistered = true;
 		WorkerMainThread.workerClass = workerClass;
 		WorkerMainThread.pathValidator = pathValidator;
-		WorkerMainThread.basePath = basePath;
 	};
 	/**
 	 * @description
@@ -87,18 +87,11 @@ export class WorkerMainThread {
 	 * @type {typeof Worker|typeof import('worker_threads').Worker}
 	 */
 	static workerClass;
-	/**
-	 * @description
-	 * - reference for worker file `basePath`;
-	 * - edit via `setup`;
-	 * @type {string}
-	 */
-	static basePath;
 	/**
 	 * @description
 	 * - reference for validating path;
 	 * - edit via `setup`;
-	 * @type {(paths:{worker: string, root:string, base: string})=>Promise<string>}
+	 * @type {(paths:{worker: string, root:string})=>Promise<string>}
 	 */
 	static pathValidator;
 	static #options = /** @type {import('worker_threads').WorkerOptions & { type?: 'module' }} */ ({
@@ -157,7 +150,6 @@ export class WorkerMainThread {
 			return await pathValidator({
 				worker: handler,
 				root: Paths.root,
-				base: WorkerMainThread.basePath,
 			});
 		});
 		if (error) {

package/src/class/WorkerMainThreadBundled.mjs

@@ -33,9 +33,8 @@ export class WorkerMainThread {
 	 * @param {Object} param0
 	 * @param {typeof WorkerMainThread["workerClass"]} param0.workerClass
 	 * @param {typeof WorkerMainThread["pathValidator"]} param0.pathValidator
-	 * @param {typeof WorkerMainThread["basePath"]} [param0.basePath]
 	 */
-	static setup = ({ workerClass, pathValidator, basePath = '' }) => {
+	static setup = ({ workerClass, pathValidator }) => {
 		if (!Paths.root) {
 			return;
 		}
@@ -46,18 +45,13 @@ export class WorkerMainThread {
 		WorkerMainThread.#isRegistered = true;
 		WorkerMainThread.workerClass = workerClass;
 		WorkerMainThread.pathValidator = pathValidator;
-		WorkerMainThread.basePath = basePath;
 	};
 	/**
 	 * @type {typeof Worker|typeof import('worker_threads').Worker}
 	 */
 	static workerClass;
 	/**
-	 * @type {string}
-	 */
-	static basePath;
-	/**
-	 * @type {(paths:{worker: string, root:string, base: string})=>Promise<string>}
+	 * @type {(paths:{worker: string, root:string})=>Promise<string>}
 	 */
 	static pathValidator;
 	static #options = /** @type {import('worker_threads').WorkerOptions & { type?: 'module' }} */ ({

package/types/index.d.mts

@@ -21,7 +21,6 @@ export { WorkerMainThread } from "./src/class/WorkerMainThread.mjs";
 export { Base64URL } from "./src/common/Base64URL.mjs";
 export { Base64URLFromFile } from "./src/common/Base64URLFromFile.mjs";
 export { EventNameSpace } from "./src/common/EventNameSpace.mjs";
-export { JSautoDOC } from "./src/doc/JSautoDOC.mjs";
 export { CreateImmutable } from "./src/function/CreateImmutable.mjs";
 export { EventCheck } from "./src/function/EventCheck.mjs";
 export { EventObject } from "./src/function/EventObject.mjs";
@@ -33,6 +32,7 @@ export { Try } from "./src/function/Try.mjs";
 export { TryAsync } from "./src/function/TryAsync.mjs";
 export { TrySync } from "./src/function/TrySync.mjs";
 export { TsToMjs } from "./src/function/TsToMjs.mjs";
+export { JSautoDOC } from "./src/doc/JSautoDOC.mjs";
 export { WorkerResult } from "./src/class/WorkerResult.mjs";
 export { WorkerThread } from "./src/class/WorkerThread.mjs";
 export { ToBundledJSPlugin } from "./src/bundler/adds/ToBundledJSPlugin.mjs";

package/types/src/class/Setup.d.mts

@@ -54,10 +54,9 @@ export class Setup {
      * 	},
      * });
      */
-    static workerMain: ({ workerClass, pathValidator, basePath }: {
+    static workerMain: ({ workerClass, pathValidator }: {
         workerClass: (typeof WorkerMainThread)["workerClass"];
         pathValidator: (typeof WorkerMainThread)["pathValidator"];
-        basePath?: (typeof WorkerMainThread)["basePath"];
     }) => void;
     /**
      * @description

package/types/src/class/WorkerMainThread.d.mts

@@ -29,34 +29,34 @@ export class WorkerMainThread<WT extends WorkerThread> {
      * @param {typeof WorkerMainThread["pathValidator"]} param0.pathValidator
      * - example:
      * ```js
-     * async (workerPath, root, base) => {
+     * async (workerPath, root) => {
      *  const truePathCheck = `${root}/${base}/${workerPath}`;
      * 	const res = await fetch(truePathCheck);
      * 	// might also check wheter it need base or not
      * 	return await res.ok;
      * }
      * ```
-     * @param {typeof WorkerMainThread["basePath"]} [param0.basePath]
-     * - additonal realtivePath from rootPath;
-     * - default: '';
      * @example
      * import { Worker } from 'node:worker_threads';
      * import { WorkerMainThread } from 'vivth';
      *
      * WorkerMainThread.setup({
      * 	workerClass: Worker,
-     * 	basePath: 'public/assets/js/workers',
-     * 	pathValidator: async (workerPath, root, base) => {
-     * 		const res = await fetch(`${root}/${base}/${workerPath}`);
-     * 		// might also check wheter it need base or not
-     * 		return await res.ok;
+     * 	pathValidator: async ({worker, root}) => {
+     * 		const res = await fetch(`${root}/${worker}`);
+     * 		if (res.ok) {
+     * 			return res
+     * 		}
+     * 		const res2 = await fetch(`${root}/someAdditionalPath/${worker}`);
+     * 		if (res2.ok) {
+     * 			return res2
+     * 		}
      * 	},
      * });
      */
-    static setup: ({ workerClass, pathValidator, basePath }: {
+    static setup: ({ workerClass, pathValidator }: {
         workerClass: (typeof WorkerMainThread)["workerClass"];
         pathValidator: (typeof WorkerMainThread)["pathValidator"];
-        basePath?: (typeof WorkerMainThread)["basePath"];
     }) => void;
     /**
      * @description
@@ -65,23 +65,15 @@ export class WorkerMainThread<WT extends WorkerThread> {
      * @type {typeof Worker|typeof import('worker_threads').Worker}
      */
     static workerClass: typeof Worker | typeof import("worker_threads").Worker;
-    /**
-     * @description
-     * - reference for worker file `basePath`;
-     * - edit via `setup`;
-     * @type {string}
-     */
-    static basePath: string;
     /**
      * @description
      * - reference for validating path;
      * - edit via `setup`;
-     * @type {(paths:{worker: string, root:string, base: string})=>Promise<string>}
+     * @type {(paths:{worker: string, root:string})=>Promise<string>}
      */
     static pathValidator: (paths: {
         worker: string;
         root: string;
-        base: string;
     }) => Promise<string>;
     static #options: import("worker_threads").WorkerOptions & {
         type?: "module";

package/types/src/class/WorkerMainThreadBundled.d.mts

@@ -18,28 +18,21 @@ export class WorkerMainThread<WT extends WorkerThread> {
      * @param {Object} param0
      * @param {typeof WorkerMainThread["workerClass"]} param0.workerClass
      * @param {typeof WorkerMainThread["pathValidator"]} param0.pathValidator
-     * @param {typeof WorkerMainThread["basePath"]} [param0.basePath]
      */
-    static setup: ({ workerClass, pathValidator, basePath }: {
+    static setup: ({ workerClass, pathValidator }: {
         workerClass: (typeof WorkerMainThread)["workerClass"];
         pathValidator: (typeof WorkerMainThread)["pathValidator"];
-        basePath?: (typeof WorkerMainThread)["basePath"];
     }) => void;
     /**
      * @type {typeof Worker|typeof import('worker_threads').Worker}
      */
     static workerClass: typeof Worker | typeof import("worker_threads").Worker;
     /**
-     * @type {string}
-     */
-    static basePath: string;
-    /**
-     * @type {(paths:{worker: string, root:string, base: string})=>Promise<string>}
+     * @type {(paths:{worker: string, root:string})=>Promise<string>}
      */
     static pathValidator: (paths: {
         worker: string;
         root: string;
-        base: string;
     }) => Promise<string>;
     static #options: import("worker_threads").WorkerOptions & {
         type?: "module";

package/.vivth-temp/README.src.md

@@ -1,35 +0,0 @@
-## HOW TO INSTALL
-
-- example uses `npm`, you can allways use your own favourite package manager;
-
-```shell
-npm i vivth
-```
-
-## vivth
-
-- `vivth` are intended to be a collections of usefull `primitives`, and not to be directly used as
-  underlying framework;
-- completely `JSruntime` agnostic:
-  > - instead of `vivth` trying to guess, all runtime specific API should be provided by dev;
-- contains helpers to help you write data driven javascript program, including:
-  > - collections of extremely ⚡ performant `signal` classes;
-  >   > - `vivth` deliberately take away `auto-subscription`:
-  >   >   > - and introducing more imperative way of subsrciption yet still simple enough, which in
-  >   >   >   turn, it completely removes total code blocking on previously needed auto subsrciption
-  >   >   >   process on first run;
-  >   >   > - and also make previously unthinkable dynamic subscription on conditionals that runs
-  >   >   >   outside first run, now completely possible;
-  > - collections of `queue-helper` classes;
-  > - fully typed `worker-threads` abstraction;
-  > - ` error as value` function helper;
-  > - opionated `autoDocumentation`;
-  > - opionated `bundler`;
-
-## versions:
-
-- `1.0.0+:b`:
-  > - beta release;
-  > - checking edge cases;
-  > - stable API, the exposed API access are highly unlikely to changes, only the underlying code
-  >   might changes for improving performance;