@cleanweb/react 2.1.0 → 2.1.1-beta.0

package/build/classy/class/index.d.ts

@@ -1,5 +1,6 @@
 import type { Extractor } from './types/extractor';
 import { ComponentInstance } from '../instance';
+import { TPropsBase } from '../logic';
 /**
  * A superset of {@link ComponentInstance} that allows defining your
  * component's JSX template directly inside the class.
@@ -8,7 +9,7 @@ import { ComponentInstance } from '../instance';
  * making it easier to migrate older class components to the newer hooks-based system
  * with little to no changes to their existing semantics/implementation.
  */
-export declare class ClassComponent<TProps extends object = WeakEmptyObject> extends ComponentInstance<TProps> {
+export declare class ClassComponent<TProps extends TPropsBase = null> extends ComponentInstance<TProps> {
     /**
      * Analogous to {@link React.Component.render}. A function that returns
      * your component's JSX template.

package/build/classy/instance/index.d.ts

@@ -1,5 +1,5 @@
 import type { UseInstance } from './types/hook';
-import { ComponentLogic } from '../../classy/logic';
+import { ComponentLogic, type TPropsBase } from '../../classy/logic';
 type AsyncAllowedEffectCallback = () => Awaitable<IVoidFunction>;
 /** An empty function. It returns (void) without performing any operations. */
 export declare const noOp: () => void;
@@ -10,7 +10,7 @@ export declare const noOp: () => void;
  *
  * @see https://github.com/cleanjsweb/neat-react#lifecycle-useinstance
  */
-export declare class ComponentInstance<TProps extends object = NonPrimitive> extends ComponentLogic<TProps> {
+export declare class ComponentInstance<TProps extends TPropsBase = null> extends ComponentLogic<TProps> {
     /**
      * Runs only _before_ first render,
      * i.e before the component instance is mounted.

package/build/classy/instance/types/hook.d.ts

@@ -1,6 +1,7 @@
+import { TPropsBase } from '../../../classy/logic';
 import { ComponentInstance } from '..';
-type UIClassParam = typeof ComponentInstance<any>;
-type UIProplessClassParam = typeof ComponentInstance<HardEmptyObject>;
+type UIClassParam = typeof ComponentInstance<NonNullable<TPropsBase>>;
+type UIProplessClassParam = typeof ComponentInstance<null>;
 export type UseInstance = {
     <Class extends UIProplessClassParam>(Methods: Class): InstanceType<Class>;
     <Class extends UIClassParam>(Methods: Class, props: InstanceType<Class>['props']): InstanceType<Class>;

package/build/classy/logic/index.d.ts

@@ -1,7 +1,6 @@
 import type { TCleanState } from '../../base/state';
 import type { UseLogic } from './types/hook';
-export type HardEmpty = HardEmptyObject;
-export type WeakEmpty = WeakEmptyObject;
+export type TPropsBase = NonPrimitive | null;
 /**
  * Base class for a class that holds methods intended for use in a function component,
  * as well as a static method for initializing state.
@@ -14,15 +13,16 @@ export type WeakEmpty = WeakEmptyObject;
  *
  * Call the {@link useLogic} hook inside your function component to instantiate the class.
  */
-export declare class ComponentLogic<TProps extends object = NonPrimitive> {
+export declare class ComponentLogic<TProps extends TPropsBase = null> {
     /**
      * A {@link TCleanState | `CleanState`} object.
      * Holds all of your component's state,
      * and methods for conveniently manipulating those values.
+     * Initialiazed with the object returned from your `getInitialState` method.
      */
     readonly state: TCleanState<ReturnType<this['getInitialState']>>;
-    /** The props pass into your component at the time of rendering. */
-    readonly props: TProps;
+    /** The props passed into your component at the time of rendering. */
+    readonly props: TProps extends null ? EmptyObject : TProps;
     /**
      * Values received from the hooks your component consumes.
      * This holds the latest copy of the object returned by
@@ -34,7 +34,7 @@ export declare class ComponentLogic<TProps extends object = NonPrimitive> {
      * It receives the initial `props` object and should return
      * an object with the initial values for your component's state.
      */
-    getInitialState: (props?: TProps) => object;
+    getInitialState: (props?: this["props"]) => object;
     /**
      * Call React hooks from here. If your component needs
      * access to values return from the hooks you call,
@@ -45,6 +45,10 @@ export declare class ComponentLogic<TProps extends object = NonPrimitive> {
      */
     useHooks: () => object | void;
 }
+/**
+ * @group Component Logic
+ * @category Classy
+ */
 export declare const useLogic: UseLogic;
 /** /
 testing: {

package/build/classy/logic/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useLogic = exports.ComponentLogic = void 0;
 var react_1 = require("react");
 var state_1 = require("../../base/state");
+//////////////////////////////////
 /**
  * Base class for a class that holds methods intended for use in a function component,
  * as well as a static method for initializing state.
@@ -37,6 +38,10 @@ var ComponentLogic = /** @class */ (function () {
 }());
 exports.ComponentLogic = ComponentLogic;
 ;
+/**
+ * @group Component Logic
+ * @category Classy
+ */
 var useLogic = function () {
     var _a;
     var args = [];

package/build/classy/logic/types/hook.d.ts

@@ -1,10 +1,9 @@
-import type { ComponentLogic } from '..';
+import type { ComponentLogic, TPropsBase } from '..';
 /*************************************
  *        # Hooks                    *
 **************************************/
-/** */
-type ULClassParam = typeof ComponentLogic<any>;
-type ULProplessClassParam = typeof ComponentLogic<HardEmptyObject>;
+type ULClassParam = typeof ComponentLogic<NonNullable<TPropsBase>>;
+type ULProplessClassParam = typeof ComponentLogic<null>;
 export type UseLogic = {
     <Class extends ULProplessClassParam>(Methods: Class): InstanceType<Class>;
     <Class extends ULClassParam>(Methods: Class, props: InstanceType<Class>['props']): InstanceType<Class>;

package/build/globals.d.ts

@@ -59,6 +59,7 @@ declare global {
     interface WeakEmptyObject {
         [UniqueSecretSymbolKey]?: never;
     }
+    type EmptyObject = WeakEmptyObject;
     /**
      * Describes an object that can have any key, but all keys have
      * a type of `never`. This effectively prevents any value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleanweb/react",
-  "version": "2.1.0",
+  "version": "2.1.1-beta.0",
   "description": "A suite of helpers for writing cleaner React function components.",
   "engines": {
     "node": ">=18"
@@ -23,6 +23,7 @@
   "scripts": {
     "prebuild": "rimraf ./build",
     "build": "tsc && tsc-alias",
+    "build:docs": "npx typedoc",
     "postbuild": "copyfiles tsconfig.json build",
     "_": "",
     "prepublishOnly": "npm run build",
@@ -69,6 +70,7 @@
     "globals": "^15.12.0",
     "rimraf": "^6.0.1",
     "tsc-alias": "1.8.10",
+    "typedoc-plugin-markdown": "^4.4.1",
     "typescript": "^5.6.2"
   },
   "peerDependencies": {