@esportsplus/reactivity 0.4.6 → 0.4.8

package/.github/dependabot.yml

@@ -4,11 +4,13 @@
 # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
 
 version: 2
+
 registries:
   npm-npmjs:
     token: ${{secrets.NPM_TOKEN}}
     type: npm-registry
     url: https://registry.npmjs.org
+
 updates:
   - package-ecosystem: "npm"
     directory: "/"

package/.github/workflows/bump.yml

@@ -1,7 +1,9 @@
 name: bump
+
 on:
   push:
     branches: '**' # only trigger on branches, not on tags
+
 jobs:
   bump:
     uses: esportsplus/workflows/.github/workflows/bump.yml@main

package/.github/workflows/dependabot.yml

@@ -0,0 +1,12 @@
+name: dependabot automerge
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled]
+  workflow_dispatch:
+
+jobs:
+  automerge:
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    uses: esportsplus/workflows/.github/workflows/dependabot.yml@main

package/.github/workflows/publish.yml

@@ -1,4 +1,5 @@
 name: publish to npm
+
 on:
   release:
     types: [published]
@@ -7,6 +8,7 @@ on:
     workflows: [bump]
     types:
       - completed
+
 jobs:
   publish:
     secrets:

package/build/index.d.ts

@@ -1,5 +1,4 @@
 export { default as macro } from './macro.js';
-export { default as resource } from './resource.js';
 export { default as reactive } from './reactive/index.js';
 export { computed, dispose, effect, root, signal } from './signal.js';
 export * from './constants.js';

package/build/index.js

@@ -1,5 +1,4 @@
 export { default as macro } from './macro.js';
-export { default as resource } from './resource.js';
 export { default as reactive } from './reactive/index.js';
 export { computed, dispose, effect, root, signal } from './signal.js';
 export * from './constants.js';

package/build/reactive/index.js

@@ -10,7 +10,7 @@ export default (data, options = {}) => {
         value = object(data, options);
     }
     else {
-        throw new Error(`Reactivity: 'reactive' received invalid input - ${JSON.stringify(data)}`);
+        throw new Error(`@esportsplus/reactivity: 'reactive' received invalid input - ${JSON.stringify(data)}`);
     }
     return value;
 };

package/build/reactive/object.d.ts

@@ -4,6 +4,5 @@ type API<T> = Prettify<{
 } & {
     dispose: VoidFunction;
 }>;
-declare const _default: <T extends Record<PropertyKey, unknown>>(input: T, options?: Options) => API<T>;
-export default _default;
+export default function object<T extends Record<PropertyKey, unknown>>(input: T, options?: Options): API<T>;
 export type { API as ReactiveObject };

package/build/reactive/object.js

@@ -1,4 +1,4 @@
-import { defineProperty, isArray, isFunction } from '@esportsplus/utilities';
+import { defineProperty, isArray, isFunction, isObject } from '@esportsplus/utilities';
 import { computed, signal } from '../signal.js';
 import { default as array } from './array.js';
 class ReactiveObject {
@@ -6,9 +6,9 @@ class ReactiveObject {
     constructor(data, options = {}) {
         let signals = this.signals;
         for (let key in data) {
-            let input = data[key];
-            if (isArray(input)) {
-                let s = signals[key] = array(input, options);
+            let value = data[key];
+            if (isArray(value)) {
+                let s = signals[key] = array(value, options);
                 defineProperty(this, key, {
                     enumerable: true,
                     get() {
@@ -16,8 +16,8 @@ class ReactiveObject {
                     }
                 });
             }
-            else if (isFunction(input)) {
-                let s = signals[key] = computed(input, options);
+            else if (isFunction(value)) {
+                let s = signals[key] = computed(value, options);
                 defineProperty(this, key, {
                     enumerable: true,
                     get() {
@@ -25,8 +25,17 @@ class ReactiveObject {
                     }
                 });
             }
+            else if (isObject(value)) {
+                let s = signals[key] = new ReactiveObject(value, options);
+                defineProperty(this, key, {
+                    enumerable: true,
+                    get() {
+                        return s;
+                    }
+                });
+            }
             else {
-                let s = signals[key] = signal(input, options);
+                let s = signals[key] = signal(value, options);
                 defineProperty(this, key, {
                     enumerable: true,
                     get() {
@@ -46,6 +55,7 @@ class ReactiveObject {
         }
     }
 }
-export default (input, options = {}) => {
+export default function object(input, options = {}) {
     return new ReactiveObject(input, options);
-};
+}
+;

package/build/signal.js

@@ -25,7 +25,7 @@ class Reactive {
             }
             if (root == null) {
                 if (type === EFFECT) {
-                    throw new Error(`Reactivity: 'effect' cannot be created without a reactive root`);
+                    throw new Error(`@esportsplus/reactivity: 'effect' cannot be created without a reactive root`);
                 }
             }
             else if (root.tracking) {
@@ -95,7 +95,7 @@ class Reactive {
     on(event, listener) {
         if (this.state === DIRTY) {
             if (event !== 'cleanup') {
-                throw new Error(`Reactivity: events set within computed or effects must use the 'cleanup' event name`);
+                throw new Error(`@esportsplus/reactivity: events set within computed or effects must use the 'cleanup' event name`);
             }
             listener.once = true;
         }
@@ -124,7 +124,7 @@ class Reactive {
     }
     set(value) {
         if (this.type !== SIGNAL && observer !== this) {
-            throw new Error(`Reactivity: 'set' method is only available on signals`);
+            throw new Error(`@esportsplus/reactivity: 'set' method is only available on signals`);
         }
         if (this.changed(this.value, value)) {
             this.value = value;
@@ -258,7 +258,7 @@ const root = (fn, scheduler) => {
             scope = o.root;
         }
         if (scope === null) {
-            throw new Error('Reactivity: `root` cannot be created without a task scheduler');
+            throw new Error('@esportsplus/reactivity: `root` cannot be created without a task scheduler');
         }
         scheduler = scope.scheduler;
     }

package/build/types.d.ts

@@ -18,7 +18,7 @@ type Effect = {
 type Infer<T> = T extends (...args: unknown[]) => unknown ? ReturnType<T> : T extends (infer U)[] ? ReactiveArray<U> : T extends ReactiveObject<T> ? ReactiveObject<T> : T extends Record<PropertyKey, unknown> ? {
     [K in keyof T]: T[K];
 } : T;
-type Event = string;
+type Event = 'cleanup' | 'dispose' | 'update' | string;
 type Listener<D> = {
     once?: boolean;
     <V>(data: D, value: V): void;

package/package.json

@@ -2,7 +2,7 @@
   "author": "ICJR",
   "dependencies": {
     "@esportsplus/custom-function": "^0.0.12",
-    "@esportsplus/utilities": "^0.15.0"
+    "@esportsplus/utilities": "^0.19.0"
   },
   "devDependencies": {
     "@esportsplus/typescript": "^0.9.1"
@@ -12,7 +12,7 @@
   "private": false,
   "type": "module",
   "types": "build/index.d.ts",
-  "version": "0.4.6",
+  "version": "0.4.8",
   "scripts": {
     "build": "tsc && tsc-alias",
     "-": "-"

package/src/index.ts

@@ -1,5 +1,4 @@
 export { default as macro } from './macro';
-export { default as resource } from './resource';
 export { default as reactive } from './reactive';
 export { computed, dispose, effect, root, signal } from './signal';
 export * from './constants';

package/src/reactive/index.ts

@@ -22,7 +22,7 @@ export default <T>(data: Guard<T>, options: Options = {}) => {
         value = object(data as { [K in keyof T]: T[K] }, options);
     }
     else {
-        throw new Error(`Reactivity: 'reactive' received invalid input - ${JSON.stringify(data)}`);
+        throw new Error(`@esportsplus/reactivity: 'reactive' received invalid input - ${JSON.stringify(data)}`);
     }
 
     return value as Reactive<T>;

package/src/reactive/object.ts

@@ -1,4 +1,4 @@
-import { defineProperty, isArray, isFunction } from '@esportsplus/utilities';
+import { defineProperty, isArray, isFunction, isObject } from '@esportsplus/utilities';
 import { computed, signal } from '~/signal';
 import { Computed, Infer, Options, Prettify, ReactiveArray, Signal } from '~/types';
 import { default as array } from './array';
@@ -8,17 +8,17 @@ type API<T> = Prettify< { [K in keyof T]: Infer<T[K]> } & { dispose: VoidFunctio
 
 
 class ReactiveObject<T extends Record<PropertyKey, unknown>> {
-    signals: Record<PropertyKey, Computed<any> | ReactiveArray<any> | Signal<any>> = {};
+    signals: Record<PropertyKey, Computed<any> | ReactiveArray<any> | ReactiveObject<any> | Signal<any>> = {};
 
 
     constructor(data: T, options: Options = {}) {
         let signals = this.signals;
 
         for (let key in data) {
-            let input = data[key];
+            let value = data[key];
 
-            if (isArray(input)) {
-                let s = signals[key] = array(input, options);
+            if (isArray(value)) {
+                let s = signals[key] = array(value, options);
 
                 defineProperty(this, key, {
                     enumerable: true,
@@ -27,8 +27,8 @@ class ReactiveObject<T extends Record<PropertyKey, unknown>> {
                     }
                 });
             }
-            else if (isFunction(input)) {
-                let s = signals[key] = computed(input as Computed<T>['fn'], options);
+            else if (isFunction(value)) {
+                let s = signals[key] = computed(value as Computed<T>['fn'], options);
 
                 defineProperty(this, key, {
                     enumerable: true,
@@ -37,8 +37,19 @@ class ReactiveObject<T extends Record<PropertyKey, unknown>> {
                     }
                 });
             }
+            else if (isObject(value)) {
+                // Type issue with factory function below, fix after testing, if this is kept
+                let s = signals[key] = new ReactiveObject(value, options);
+
+                defineProperty(this, key, {
+                    enumerable: true,
+                    get() {
+                        return s;
+                    }
+                });
+            }
             else {
-                let s = signals[key] = signal(input, options);
+                let s = signals[key] = signal(value, options);
 
                 defineProperty(this, key, {
                     enumerable: true,
@@ -64,7 +75,7 @@ class ReactiveObject<T extends Record<PropertyKey, unknown>> {
 }
 
 
-export default <T extends Record<PropertyKey, unknown>>(input: T, options: Options = {}) => {
+export default function object<T extends Record<PropertyKey, unknown>>(input: T, options: Options = {}) {
     return new ReactiveObject(input, options) as API<T>;
 };
 export type { API as ReactiveObject };

package/src/signal.ts

@@ -37,7 +37,7 @@ class Reactive<T> {
 
             if (root == null) {
                 if (type === EFFECT) {
-                    throw new Error(`Reactivity: 'effect' cannot be created without a reactive root`);
+                    throw new Error(`@esportsplus/reactivity: 'effect' cannot be created without a reactive root`);
                 }
             }
             else if (root.tracking) {
@@ -124,7 +124,7 @@ class Reactive<T> {
     on<T>(event: Event, listener: Listener<T>) {
         if (this.state === DIRTY) {
             if (event !== 'cleanup') {
-                throw new Error(`Reactivity: events set within computed or effects must use the 'cleanup' event name`);
+                throw new Error(`@esportsplus/reactivity: events set within computed or effects must use the 'cleanup' event name`);
             }
 
             listener.once = true;
@@ -159,7 +159,7 @@ class Reactive<T> {
 
     set(value: T): T {
         if (this.type !== SIGNAL && observer !== this) {
-            throw new Error(`Reactivity: 'set' method is only available on signals`);
+            throw new Error(`@esportsplus/reactivity: 'set' method is only available on signals`);
         }
 
         if (this.changed!(this.value, value)) {
@@ -339,7 +339,7 @@ const root = <T>(fn: NeverAsync<(instance: Root) => T>, scheduler?: Scheduler) =
         }
 
         if (scope === null) {
-            throw new Error('Reactivity: `root` cannot be created without a task scheduler');
+            throw new Error('@esportsplus/reactivity: `root` cannot be created without a task scheduler');
         }
 
         scheduler = scope.scheduler;

package/src/types.ts

@@ -32,7 +32,7 @@ type Infer<T> =
                     ? { [K in keyof T]: T[K] }
                     : T;
 
-type Event = string;
+type Event = 'cleanup' | 'dispose' | 'update' | string;
 
 type Listener<D> = {
     once?: boolean;

package/build/resource.d.ts

@@ -1,15 +0,0 @@
-import CustomFunction from '@esportsplus/custom-function';
-import { Options } from './types.js';
-declare class Resource<A extends unknown[], R extends Promise<unknown>> extends CustomFunction {
-    private arguments;
-    private okay;
-    private response;
-    stop: boolean | null;
-    constructor(fn: (...args: A) => R, options?: Options);
-    get data(): Awaited<R>;
-    get input(): A | null;
-    get ok(): boolean | null;
-    dispose(): void;
-}
-declare const _default: <A extends unknown[], R extends Promise<unknown>>(fn: (...args: A) => R, options?: Options) => Resource<A, R>;
-export default _default;

package/build/resource.js

@@ -1,50 +0,0 @@
-import CustomFunction from '@esportsplus/custom-function';
-import { signal } from './signal.js';
-class Resource extends CustomFunction {
-    arguments;
-    okay;
-    response;
-    stop = null;
-    constructor(fn, options = {}) {
-        super((...args) => {
-            this.stop = null;
-            this.arguments.set(args);
-            this.okay.set(null);
-            fn(...args)
-                .then((value) => {
-                if (this.stop === true) {
-                    return;
-                }
-                this.response.set(value);
-                this.okay.set(true);
-            })
-                .catch(() => {
-                if (this.stop === true) {
-                    return;
-                }
-                this.response.set(undefined);
-                this.okay.set(false);
-            });
-        });
-        this.response = signal(undefined, options);
-        this.arguments = signal(null, options);
-        this.okay = signal(null, options);
-    }
-    get data() {
-        return this.response.get();
-    }
-    get input() {
-        return this.arguments.get();
-    }
-    get ok() {
-        return this.okay.get();
-    }
-    dispose() {
-        this.arguments.dispose();
-        this.okay.dispose();
-        this.response.dispose();
-    }
-}
-export default (fn, options = {}) => {
-    return new Resource(fn, options);
-};

package/src/resource.ts

@@ -1,68 +0,0 @@
-import CustomFunction from '@esportsplus/custom-function';
-import { signal } from './signal';
-import { Options, Signal } from './types';
-
-
-class Resource<A extends unknown[], R extends Promise<unknown>> extends CustomFunction {
-    private arguments: Signal<A | null>;
-    private okay: Signal<boolean | null>;
-    private response: Signal<Awaited<R>>;
-
-    stop: boolean | null = null;
-
-
-    constructor(fn: (...args: A) => R, options: Options = {}) {
-        super((...args: A) => {
-            this.stop = null;
-
-            this.arguments.set(args);
-            this.okay.set(null);
-
-            fn(...args)
-                .then((value) => {
-                    if (this.stop === true) {
-                        return;
-                    }
-
-                    this.response.set(value as Awaited<R>);
-                    this.okay.set(true);
-                })
-                .catch(() => {
-                    if (this.stop === true) {
-                        return;
-                    }
-
-                    this.response.set(undefined as Awaited<R>);
-                    this.okay.set(false);
-                });
-        });
-        this.response = signal(undefined as Awaited<R>, options);
-        this.arguments = signal<A | null>(null, options);
-        this.okay = signal<boolean | null>(null, options);
-    }
-
-
-    get data() {
-        return this.response.get();
-    }
-
-    get input() {
-        return this.arguments.get();
-    }
-
-    get ok() {
-        return this.okay.get();
-    }
-
-
-    dispose() {
-        this.arguments.dispose();
-        this.okay.dispose();
-        this.response.dispose();
-    }
-}
-
-
-export default <A extends unknown[], R extends Promise<unknown>>(fn: (...args: A) => R, options: Options = {}) => {
-    return new Resource(fn, options);
-};