@cleanweb/oore 2.0.0-alpha.16 → 2.0.0-alpha.18

package/build/classy/instance/index.js

@@ -1,22 +1,10 @@
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-import { useEffect } from 'react';
-import { ComponentLogic, useLogic } from '../../classy/logic';
-import { useMountCallbacks } from './mount-callbacks';
-import { noOp } from '../../helpers';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInstance = exports.ComponentInstance = void 0;
+const react_1 = require("react");
+const logic_1 = require("../../classy/logic");
+const mount_callbacks_1 = require("./mount-callbacks");
+const helpers_1 = require("../../helpers");
 /**
  * A superset of {@link ComponentLogic} that adds support for lifecycle methods.
  * This provides a declarative API for working with your React function component's lifecycle,
@@ -24,10 +12,9 @@ import { noOp } from '../../helpers';
  *
  * @see https://github.com/cleanjsweb/neat-react#lifecycle-useinstance
  */
-var ComponentInstance = /** @class */ (function (_super) {
-    __extends(ComponentInstance, _super);
-    function ComponentInstance() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
+class ComponentInstance extends logic_1.ComponentLogic {
+    constructor() {
+        super(...arguments);
         /**
          * Runs only _before_ the first render,
          * i.e before the component instance is mounted.
@@ -38,7 +25,7 @@ var ComponentInstance = /** @class */ (function (_super) {
          * PS: You can conditionally update state from here, but with certain caveats.
          * {@link https://react.dev/reference/react/useState#storing-information-from-previous-renders | See the React docs for details}.
          */
-        _this.beforeMount = function () { };
+        this.beforeMount = () => { };
         /**
          * Runs only **_after_** the first render, i.e after the component instance is mounted.
          * It is ignored on subsequent rerenders.
@@ -50,7 +37,7 @@ var ComponentInstance = /** @class */ (function (_super) {
          *
          * Uses `useEffect()` under the hood.
          */
-        _this.onMount = function () { return noOp; };
+        this.onMount = () => helpers_1.noOp;
         /**
          * Runs _before_ every render cycle, including the first.
          * Useful for logic that is involved in determining what to render.
@@ -66,7 +53,7 @@ var ComponentInstance = /** @class */ (function (_super) {
          * PS: You can conditionally update state from here, but with certain caveats.
          * {@link https://react.dev/reference/react/useState#storing-information-from-previous-renders | See the React docs for details}.
          */
-        _this.beforeRender = function () { return ({}); };
+        this.beforeRender = () => ({});
         /**
          * Runs **_after_** every render cycle, including the first.
          *
@@ -77,56 +64,50 @@ var ComponentInstance = /** @class */ (function (_super) {
          *
          * @returns A cleanup function.
          */
-        _this.onRender = function () { return noOp; };
+        this.onRender = () => helpers_1.noOp;
         /**
          * Runs when the component is unmounted.
          * It is called _after_ the cleanup function returned by onMount.
          */
-        _this.cleanUp = function () { };
-        return _this;
+        this.cleanUp = () => { };
     }
-    Object.defineProperty(ComponentInstance.prototype, "templateContext", {
-        /**
-         * Exposes the object returned by {@link beforeRender}.
-         *
-         * This is useful when you need to render some state or props
-         * in a transformed format. Put the transformation logic
-         * in {@link beforeRender} to the keep the main
-         * function component body clean.
-         *
-         * ******
-         *
-         * @example <caption>Using `templateContext`.</caption>
-         *
-         * ```tsx
-         * class MyComponentLogic extends ComponentInstance {
-         *     beforeRender = () => {
-         *         const title = `My Site | ${this.props.title}`;
-         *         return { title };
-         *     }
-         * }
-         * const MyComponent = (props) => {
-         *     const self = useInstance(MyComponentLogic, props);
-         *     const { templateContext: ctx, state } = self;
-         *
-         *     return (
-         *         <h1>
-         *             {ctx.title}
-         *         </h1>
-         *         <p>{props.description}</p>
-         *     );
-         * }
-         * ```
-         */
-        get: function () {
-            return this._templateContext;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return ComponentInstance;
-}(ComponentLogic));
-export { ComponentInstance };
+    /**
+     * Exposes the object returned by {@link beforeRender}.
+     *
+     * This is useful when you need to render some state or props
+     * in a transformed format. Put the transformation logic
+     * in {@link beforeRender} to the keep the main
+     * function component body clean.
+     *
+     * ******
+     *
+     * @example <caption>Using `templateContext`.</caption>
+     *
+     * ```tsx
+     * class MyComponentLogic extends ComponentInstance {
+     *     beforeRender = () => {
+     *         const title = `My Site | ${this.props.title}`;
+     *         return { title };
+     *     }
+     * }
+     * const MyComponent = (props) => {
+     *     const self = useInstance(MyComponentLogic, props);
+     *     const { templateContext: ctx, state } = self;
+     *
+     *     return (
+     *         <h1>
+     *             {ctx.title}
+     *         </h1>
+     *         <p>{props.description}</p>
+     *     );
+     * }
+     * ```
+     */
+    get templateContext() {
+        return this._templateContext;
+    }
+}
+exports.ComponentInstance = ComponentInstance;
 ;
 /**
  * Enables full separation of concerns between a React component's template
@@ -141,39 +122,36 @@ export { ComponentInstance };
  *
  * The provided class should be a subclass of {@link ComponentInstance}.
  */
-export var useInstance = function () {
+const useInstance = (...args) => {
     var _a;
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var Component = args[0], _b = args[1], props = _b === void 0 ? {} : _b;
+    const [Component, props = {}] = args;
     // useHooks.
-    var instance = useLogic(Component, props);
+    const instance = (0, logic_1.useLogic)(Component, props);
     // beforeMount, onMount, cleanUp.
-    useMountCallbacks(instance);
+    (0, mount_callbacks_1.useMountCallbacks)(instance);
     // beforeRender.
     /**
      * A proxy variable to allow typechecking of the assignment
      * to `self.templateContext` despite the need for "readonly" error suppression.
      */
-    var _templateContextProxy_;
+    let _templateContextProxy_;
     // @ts-expect-error Assigning to a readonly property.
     instance._templateContext = (_templateContextProxy_ = (_a = instance.beforeRender) === null || _a === void 0 ? void 0 : _a.call(instance));
     // onRender.
-    useEffect(function () {
+    (0, react_1.useEffect)(() => {
         var _a;
-        var cleanupAfterRerender = (_a = instance.onRender) === null || _a === void 0 ? void 0 : _a.call(instance);
-        return function () {
+        const cleanupAfterRerender = (_a = instance.onRender) === null || _a === void 0 ? void 0 : _a.call(instance);
+        return () => {
             if (typeof cleanupAfterRerender === 'function')
                 cleanupAfterRerender();
             else
-                cleanupAfterRerender === null || cleanupAfterRerender === void 0 ? void 0 : cleanupAfterRerender.then(function (cleanUp) { return cleanUp === null || cleanUp === void 0 ? void 0 : cleanUp(); });
+                cleanupAfterRerender === null || cleanupAfterRerender === void 0 ? void 0 : cleanupAfterRerender.then((cleanUp) => cleanUp === null || cleanUp === void 0 ? void 0 : cleanUp());
         };
     });
     // class FormValues<TValues> extends BrowserMemStore<TValues> {}
     return instance;
 };
+exports.useInstance = useInstance;
 /** /
 testing: {
     class A extends ComponentInstance<EmptyObject> {

package/build/classy/instance/mount-callbacks.js

@@ -1,16 +1,19 @@
-import { useEffect } from 'react';
-import { useMountState } from '../../helpers/mount-state';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useMountCallbacks = void 0;
+const react_1 = require("react");
+const mount_state_1 = require("../../helpers/mount-state");
 /** @internal */
-export var useMountCallbacks = function (instance) {
+const useMountCallbacks = (instance) => {
     var _a;
-    var isMounted = useMountState();
+    const isMounted = (0, mount_state_1.useMountState)();
     if (!isMounted())
         (_a = instance.beforeMount) === null || _a === void 0 ? void 0 : _a.call(instance);
-    useEffect(function () {
+    (0, react_1.useEffect)(() => {
         var _a;
-        var mountHandlerCleanUp = (_a = instance.onMount) === null || _a === void 0 ? void 0 : _a.call(instance);
-        return function () {
-            var doCleanUp = function (runMountCleaners) {
+        const mountHandlerCleanUp = (_a = instance.onMount) === null || _a === void 0 ? void 0 : _a.call(instance);
+        return () => {
+            const doCleanUp = (runMountCleaners) => {
                 var _a;
                 runMountCleaners === null || runMountCleaners === void 0 ? void 0 : runMountCleaners();
                 (_a = instance.cleanUp) === null || _a === void 0 ? void 0 : _a.call(instance);
@@ -24,3 +27,4 @@ export var useMountCallbacks = function (instance) {
         };
     }, []);
 };
+exports.useMountCallbacks = useMountCallbacks;

package/build/classy/instance/types/hook.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/classy/logic/index.js

@@ -1,5 +1,8 @@
-import { useMemo, useRef } from 'react';
-import { useCleanState } from '../../base/state';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLogic = exports.ComponentLogic = void 0;
+const react_1 = require("react");
+const state_1 = require("../../base/state");
 /**
  * Base class for a class that holds methods to be used in a function component.
  *
@@ -13,14 +16,14 @@ import { useCleanState } from '../../base/state';
  *
  * @typeParam TProps - {@include ./types/tprops.md}
  */
-var ComponentLogic = /** @class */ (function () {
-    function ComponentLogic() {
+class ComponentLogic {
+    constructor() {
         /**
          * Called before each instance of your component is mounted.
          * It receives the initial `props` object and should return
          * an object with the initial values for your component's state.
          */
-        this.getInitialState = function (props) { return ({}); };
+        this.getInitialState = (props) => ({});
         /**
          * Call React hooks from here. If your component needs
          * access to values return from the hooks you call,
@@ -29,7 +32,7 @@ var ComponentLogic = /** @class */ (function () {
          * The returned object will be accessible as {@link hooks | `this.hooks`} within
          * your component class.
          */
-        this.useHooks = function () { };
+        this.useHooks = () => { };
         /**
          * Persist class members during HMR. {@include ./hrm-preserve-keys.md}
          * @privateRemarks
@@ -37,9 +40,8 @@ var ComponentLogic = /** @class */ (function () {
          */
         this._hmrPreserveKeys = [];
     }
-    return ComponentLogic;
-}());
-export { ComponentLogic };
+}
+exports.ComponentLogic = ComponentLogic;
 ;
 /**
  * Returns an instance of the provided class, which holds methods for your component and
@@ -49,49 +51,46 @@ export { ComponentLogic };
  *
  * @see https://cleanjsweb.github.io/neat-react/functions/API.useLogic.html
  */
-export var useLogic = function () {
+const useLogic = (...args) => {
     var _a;
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var Logic = args[0], _b = args[1], props = _b === void 0 ? {} : _b;
+    const [Logic, props = {}] = args;
     // In production, we only use the latestInstance the first time, and it's ignored every other time.
     // This means changing the class at runtime will have no effect in production.
     // latestInstance is only extracted into a separate variable for use in dev mode during HMR.
-    var latestInstance = useMemo(function () { return new Logic(); }, [Logic]);
+    const latestInstance = (0, react_1.useMemo)(() => new Logic(), [Logic]);
     // const latestInstance = useMemo(() => new Logic(), []);
-    var instanceRef = useRef(latestInstance);
-    var refreshState = function () {
+    const instanceRef = (0, react_1.useRef)(latestInstance);
+    const refreshState = () => {
         var _a;
         // @ts-expect-error
         instanceRef.current.props = props;
         // @ts-expect-error
-        instanceRef.current.state = useCleanState(instanceRef.current.getInitialState, props);
+        instanceRef.current.state = (0, state_1.useCleanState)(instanceRef.current.getInitialState, props);
         // @ts-expect-error
         instanceRef.current.hooks = (_a = instanceRef.current.useHooks()) !== null && _a !== void 0 ? _a : {};
     };
     if (process.env.NODE_ENV === 'development' && instanceRef.current !== latestInstance) {
-        var oldInstance_1 = instanceRef.current;
-        latestInstance._hmrPreserveKeys.forEach(function (_key) {
-            var key = _key;
+        const oldInstance = instanceRef.current;
+        latestInstance._hmrPreserveKeys.forEach((_key) => {
+            const key = _key;
             // @ts-expect-error We're assigning to readonly properties. Also, Typescript doesn't know that the type of the left and right side will always match, due to the dynamic access.
-            latestInstance[key] = oldInstance_1[key];
+            latestInstance[key] = oldInstance[key];
         });
-        Reflect.ownKeys(oldInstance_1).forEach(function (_key) {
-            var key = _key;
-            delete oldInstance_1[key];
+        Reflect.ownKeys(oldInstance).forEach((_key) => {
+            const key = _key;
+            delete oldInstance[key];
         });
-        Object.setPrototypeOf(oldInstance_1, latestInstance);
+        Object.setPrototypeOf(oldInstance, latestInstance);
         instanceRef.current = latestInstance;
         refreshState();
-        (_a = latestInstance._onHmrUpdate) === null || _a === void 0 ? void 0 : _a.call(latestInstance, oldInstance_1);
+        (_a = latestInstance._onHmrUpdate) === null || _a === void 0 ? void 0 : _a.call(latestInstance, oldInstance);
     }
     else
         refreshState();
     return instanceRef.current;
     ;
 };
+exports.useLogic = useLogic;
 /** /
 testing: {
     const a: object = {b: ''};

package/build/classy/logic/types/hook.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/docs-src/api/base-classes.js

@@ -1,3 +1,9 @@
-export { ComponentMethods } from '../../base/methods';
-export { ComponentLogic } from '../../classy/logic';
-export { ComponentInstance } from '../../classy/instance';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentInstance = exports.ComponentLogic = exports.ComponentMethods = void 0;
+var methods_1 = require("../../base/methods");
+Object.defineProperty(exports, "ComponentMethods", { enumerable: true, get: function () { return methods_1.ComponentMethods; } });
+var logic_1 = require("../../classy/logic");
+Object.defineProperty(exports, "ComponentLogic", { enumerable: true, get: function () { return logic_1.ComponentLogic; } });
+var instance_1 = require("../../classy/instance");
+Object.defineProperty(exports, "ComponentInstance", { enumerable: true, get: function () { return instance_1.ComponentInstance; } });

package/build/docs-src/api/index.js

@@ -1,13 +1,44 @@
+"use strict";
 /**
  * API Reference
  * @module API
  */
-export { useCleanState } from '../../base/state';
-export { useMethods } from '../../base/methods';
-export { useLogic } from '../../classy/logic';
-export { useInstance } from '../../classy/instance';
-export { ClassComponent } from '../../classy/class';
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.References = exports.Helpers = exports.BaseClasses = exports.ClassComponent = exports.useInstance = exports.useLogic = exports.useMethods = exports.useCleanState = void 0;
+var state_1 = require("../../base/state");
+Object.defineProperty(exports, "useCleanState", { enumerable: true, get: function () { return state_1.useCleanState; } });
+var methods_1 = require("../../base/methods");
+Object.defineProperty(exports, "useMethods", { enumerable: true, get: function () { return methods_1.useMethods; } });
+var logic_1 = require("../../classy/logic");
+Object.defineProperty(exports, "useLogic", { enumerable: true, get: function () { return logic_1.useLogic; } });
+var instance_1 = require("../../classy/instance");
+Object.defineProperty(exports, "useInstance", { enumerable: true, get: function () { return instance_1.useInstance; } });
+var class_1 = require("../../classy/class");
+Object.defineProperty(exports, "ClassComponent", { enumerable: true, get: function () { return class_1.ClassComponent; } });
 /** @namespace */
-export * as BaseClasses from './base-classes';
-export * as Helpers from '../../helpers';
-export * as References from './references';
+exports.BaseClasses = __importStar(require("./base-classes"));
+exports.Helpers = __importStar(require("../../helpers"));
+exports.References = __importStar(require("./references"));

package/build/docs-src/api/references.js

@@ -1,5 +1,31 @@
-export * as $CleanState from '../../base/state';
-export * as $ComponentMethods from '../../base/methods';
-export * as ComponentLogic from '../../classy/logic';
-export * as ComponentInstance from '../../classy/instance';
-export * as ClassComponent from '../../classy/class';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassComponent = exports.ComponentInstance = exports.ComponentLogic = exports.$ComponentMethods = exports.$CleanState = void 0;
+exports.$CleanState = __importStar(require("../../base/state"));
+exports.$ComponentMethods = __importStar(require("../../base/methods"));
+exports.ComponentLogic = __importStar(require("../../classy/logic"));
+exports.ComponentInstance = __importStar(require("../../classy/instance"));
+exports.ClassComponent = __importStar(require("../../classy/class"));