@plitzi/nexus 0.31.1 → 0.32.0

package/dist/types/StoreTypes.d.ts

@@ -2,17 +2,13 @@ import { default as PathTrie } from '../createStore/helpers/PathTrie';
 import { default as Subscribers } from '../createStore/helpers/Subscribers';
 export type Path = string;
 export type Primitive = string | number | boolean | null | undefined | symbol | bigint;
-export type PathOf<T, Seen = never> = T extends Primitive ? never : T extends Seen ? never : {
-    [K in keyof T & string]-?: T[K] extends Primitive ? K : T[K] extends Array<infer U> ? K | `${K}.${number}` | `${K}.${number}.${PathOf<U, Seen | T>}` : K | `${K}.${PathOf<T[K], Seen | T>}`;
+export type PathOf<T, Seen = never> = T extends Primitive ? never : T extends Seen ? never : [string] extends [keyof T & string] ? string : {
+    [K in keyof T & string]-?: T[K] extends Primitive ? K : NonNullable<T[K]> extends Array<infer U> ? K | `${K}.${number}` | `${K}.${number}.${PathOf<U, Seen | T>}` : K | `${K}.${PathOf<NonNullable<T[K]>, Seen | T>}`;
 }[keyof T & string];
 export type PathValue<T, P> = T extends undefined ? undefined : P extends `${infer K}.${infer Rest}` ? K extends keyof NonNullable<T> ? NonNullable<T>[K] extends Array<infer U> ? Rest extends `${number}.${infer R}` ? PathValue<U, R> : Rest extends `${number}` ? U : never : PathValue<NonNullable<T>[K], Rest> : never : P extends keyof NonNullable<T> ? NonNullable<T>[P] : never;
 export type PathSetter<TState extends object, P extends PathOf<TState>> = (value: PathValue<TState, P> | ((prev: PathValue<TState, P>) => PathValue<TState, P>)) => void;
-export type __NoDefault = {
-    __noDefault: true;
-};
-type NumericIndex<I> = I extends `${infer N extends number}` ? N : I extends number ? I : never;
-export type PathValues<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>, DefaultValue = __NoDefault> = {
-    [I in keyof Paths]: Paths[I] extends PathOf<TState> ? [DefaultValue] extends [__NoDefault] ? PathValue<TState, Paths[I]> : DefaultValue extends readonly any[] ? NumericIndex<I> extends infer NI ? NI extends keyof DefaultValue ? DefaultValue[NI] extends undefined ? PathValue<TState, Paths[I]> | undefined : NonNullable<PathValue<TState, Paths[I]>> | DefaultValue[NI] : PathValue<TState, Paths[I]> : never : NonNullable<PathValue<TState, Paths[I]>> | DefaultValue : never;
+export type PathValues<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>> = {
+    [I in keyof Paths]: Paths[I] extends PathOf<TState> ? PathValue<TState, Paths[I]> : never;
 };
 export type PathSetters<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>> = {
     [I in keyof Paths]: Paths[I] extends PathOf<TState> ? PathSetter<TState, Paths[I]> : never;
@@ -51,19 +47,40 @@ export type StoreMiddlewareHandlers<T> = {
     beforeChange?: WriteInterceptor<T>;
     onChange?: ChangeListener<T>;
     onError?: StoreErrorHandler<T>;
+    hydrate?: (api: StoreApi<T>) => void;
 };
 export type StoreMiddleware<T extends object> = (api: StoreApi<T>) => StoreMiddlewareHandlers<T> | void;
+export type MiddlewareOptions<T extends object> = {
+    enabled?: boolean | ((state: T) => boolean);
+};
 export type Listener = (changedPath?: Path) => void;
 export type SetState<T> = {
     (path: undefined, value: T | ((prev: T) => T), canPropagate?: boolean): void;
     <P extends PathOf<T>>(path: P, value: PathValue<T, P> | ((prev: PathValue<T, P>) => PathValue<T, P>), canPropagate?: boolean): void;
 };
 export type GetState<T> = () => T;
+export type BoundStore<TBase> = {
+    getState: {
+        (): TBase | undefined;
+        <D>(defaultValue: D): NonNullable<TBase> | D;
+    };
+    getPath: TBase extends object ? {
+        <SubP extends PathOf<TBase>>(subPath: SubP): PathValue<TBase, SubP> | undefined;
+        <SubP extends PathOf<TBase>, D>(subPath: SubP, defaultValue: D): NonNullable<PathValue<TBase, SubP>> | D;
+    } : {
+        (): TBase | undefined;
+        <D>(defaultValue: D): NonNullable<TBase> | D;
+    };
+    setState: SetFromBaseFn<TBase>;
+    subscribe: (listener: Listener) => () => void;
+    subscribePath: TBase extends object ? <SubP extends PathOf<TBase>>(subPath: SubP, listener: Listener) => () => void : (listener: Listener) => () => void;
+};
 export type StoreApi<T> = {
     id?: string;
     getState: GetState<T>;
     getPath: <P extends PathOf<T>>(path: P) => PathValue<T, P> | undefined;
     setState: SetState<T>;
+    withBase: <P extends PathOf<T>>(basePath: P) => BoundStore<NonNullable<PathValue<T, P>>>;
     batch: <R>(fn: () => R) => R;
     subscribe: (listener: Listener) => () => void;
     subscribePath: <P extends PathOf<T>>(path: P, listener: Listener) => () => void;
@@ -71,6 +88,7 @@ export type StoreApi<T> = {
     destroy?: () => void;
     reconnect?: () => void;
     subscribeInvalidate?: (listener: () => void) => () => void;
+    hydrate?: () => void;
 };
 export type StoreApiInternal<T> = StoreApi<T> & {
     listeners: Subscribers<Listener>;
@@ -78,6 +96,7 @@ export type StoreApiInternal<T> = StoreApi<T> & {
     changeListeners: Subscribers<ChangeListener<T>>;
     interceptors: WriteInterceptor<T>[];
     errorHandlers: StoreErrorHandler<T>[];
+    invalidateListeners: Subscribers<() => void>;
     getMergeCount?: () => number;
 };
 export type PathOrFn<TState extends object> = PathOf<TState> | ((state: TState) => PathOf<TState>);
@@ -89,15 +108,16 @@ export type PathOrFnSetter<TState extends object, Entry> = Entry extends PathOf<
 export type PathOrFnSetters<TState extends object, Entries extends ReadonlyArray<PathOrFn<TState>>> = {
     [I in keyof Entries]: PathOrFnSetter<TState, Entries[I]>;
 };
-export type MultiPathReturn<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>, TDefaultValue = __NoDefault> = [PathValues<TState, Paths, TDefaultValue>, ...PathSetters<TState, Paths>];
+export type MultiPathReturn<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>> = [
+    PathValues<TState, Paths>,
+    ...PathSetters<TState, Paths>
+];
 export type UseStoreReturn<TState extends object, TArg> = TArg extends PathOf<TState> ? [PathValue<TState, TArg>, PathSetter<TState, TArg>] : TArg extends (state: TState) => unknown ? [unknown, (value: unknown) => void] : [TState, StoreApi<TState>['setState']];
 export type UseStoreOptions<T, TState extends object = object> = StoreHookReactiveOptions<T, TState> & {
-    defaultValue?: NonNullable<T>;
     transformer?: (value: T) => unknown;
 };
-export type UseStoreMultiOptions<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>, TDefaultValue extends readonly (PathValue<TState, Paths[number]> | undefined)[] | PathValue<TState, Paths[number]> | undefined = undefined> = Omit<StoreHookReactiveOptions<never, TState>, 'equalityFn'> & {
+export type UseStoreMultiOptions<TState extends object, Paths extends ReadonlyArray<PathOf<TState>>> = Omit<StoreHookReactiveOptions<never, TState>, 'equalityFn'> & {
     equalityFn?: (a: PathValues<TState, Paths>, b: PathValues<TState, Paths>) => boolean;
-    defaultValue?: TDefaultValue;
     transformer?: (values: PathValues<TState, Paths>) => unknown;
 };
 export type UseStoreSyncOptions<T, TState extends object = object> = StoreHookReactiveOptions<T, TState> & {
@@ -118,19 +138,11 @@ export type GetValueFromBaseFn<TBase> = TBase extends object ? {
     <SubP extends PathOf<TBase>, D>(path: SubP, defaultValue: D): NonNullable<PathValue<TBase, SubP>> | D;
     <D>(path: undefined, defaultValue: D): NonNullable<TBase> | D;
 } : () => TBase;
-export type GetValueFromBaseWithDefaultFn<TBase, D> = TBase extends object ? {
-    (): NonNullable<TBase> | D;
-    <SubP extends PathOf<NonNullable<TBase>>>(path: SubP): PathValue<NonNullable<TBase>, SubP>;
-    <SubP extends PathOf<NonNullable<TBase>>, D2>(path: SubP, defaultValue: D2): NonNullable<PathValue<NonNullable<TBase>, SubP>> | D2;
-    <D2>(path: undefined, defaultValue: D2): NonNullable<TBase> | D2;
-} : () => NonNullable<TBase> | D;
 type EntryGetter<TState extends object, Entry> = Entry extends PathOf<TState> ? GetValueFromBaseFn<PathValue<TState, Entry>> : Entry extends (state: TState) => infer R ? R extends object ? GetValueFromBaseFn<R> : () => R : never;
 export type GetterTuple<TState extends object, Entries extends ReadonlyArray<PathOf<TState> | ((state: TState) => unknown)>> = {
     [K in keyof Entries]: EntryGetter<TState, Entries[K]>;
 };
-export type UseStoreGetterOptions<TState extends object = object, D = __NoDefault> = StoreHookBaseOptions<TState> & {
-    defaultValue?: D;
-};
+export type UseStoreGetterOptions<TState extends object = object> = StoreHookBaseOptions<TState>;
 export type SetStateFn<TState extends object> = {
     (path: undefined, value: TState | ((prev: TState) => TState)): void;
     <P extends PathOf<TState>>(path: P, value: PathValue<TState, P> | ((prev: PathValue<TState, P>) => PathValue<TState, P>)): void;

package/logo.svg

@@ -0,0 +1,57 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="640" height="180" viewBox="0 0 640 180" fill="none" role="img" aria-label="@plitzi/nexus">
+  <defs>
+    <linearGradient id="bg" x1="0" y1="0" x2="640" y2="180" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#0c0c12" />
+      <stop offset="1" stop-color="#16161f" />
+    </linearGradient>
+    <linearGradient id="mark" x1="0" y1="0" x2="1" y2="1">
+      <stop stop-color="#a78bfa" />
+      <stop offset="1" stop-color="#7c3aed" />
+    </linearGradient>
+    <linearGradient id="word" x1="150" y1="0" x2="560" y2="0" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#ede9fe" />
+      <stop offset="1" stop-color="#a78bfa" />
+    </linearGradient>
+  </defs>
+
+  <rect width="640" height="180" rx="20" fill="url(#bg)" />
+  <rect x="0.5" y="0.5" width="639" height="179" rx="19.5" fill="none" stroke="#2a2a38" />
+
+  <circle cx="96" cy="90" r="130" fill="#7c3aed" opacity="0.10" />
+
+  <!-- nexus mark -->
+  <g transform="translate(90 90)">
+    <rect x="-36" y="-36" width="72" height="72" rx="18" fill="url(#mark)" />
+    <g transform="scale(2.0)" stroke="#fff" stroke-linecap="round" stroke-linejoin="round">
+      <path d="M0 -8.5 7.4 -4.25 7.4 4.25 0 8.5 -7.4 4.25 -7.4 -4.25 Z" stroke-width="1.3" stroke-opacity="0.45" />
+      <g stroke-width="1.5">
+        <path d="M0 0 0 -8.5" />
+        <path d="M0 0 7.4 -4.25" />
+        <path d="M0 0 7.4 4.25" />
+        <path d="M0 0 0 8.5" />
+        <path d="M0 0 -7.4 4.25" />
+        <path d="M0 0 -7.4 -4.25" />
+      </g>
+    </g>
+    <g transform="scale(2.0)" fill="#fff">
+      <circle cx="0" cy="-8.5" r="1.7" />
+      <circle cx="7.4" cy="-4.25" r="1.7" />
+      <circle cx="7.4" cy="4.25" r="1.7" />
+      <circle cx="0" cy="8.5" r="1.7" />
+      <circle cx="-7.4" cy="4.25" r="1.7" />
+      <circle cx="-7.4" cy="-4.25" r="1.7" />
+      <circle cx="0" cy="0" r="2.6" />
+    </g>
+  </g>
+
+  <!-- wordmark -->
+  <text x="158" y="86" font-family="'Inter', system-ui, sans-serif" font-size="46" font-weight="800" letter-spacing="-1" fill="url(#word)">
+    @plitzi/nexus
+  </text>
+  <text x="160" y="120" font-family="'Inter', system-ui, sans-serif" font-size="20" font-weight="500" fill="#a1a1aa">
+    A tiny, type-safe React store
+  </text>
+  <text x="160" y="146" font-family="'JetBrains Mono', ui-monospace, monospace" font-size="15" fill="#8b5cf6">
+    path subscriptions · scoped stores · time-travel
+  </text>
+</svg>

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@plitzi/nexus",
-  "version": "0.31.1",
+  "version": "0.32.0",
   "license": "Apache-2.0",
   "files": [
-    "dist"
+    "dist",
+    "logo.svg"
   ],
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -86,14 +87,6 @@
       "types": "./dist/createStore/helpers/createChainReads.d.ts",
       "import": "./dist/createStore/helpers/createChainReads.mjs"
     },
-    "./createStore/helpers/createGetPath": {
-      "types": "./dist/createStore/helpers/createGetPath.d.ts",
-      "import": "./dist/createStore/helpers/createGetPath.mjs"
-    },
-    "./createStore/helpers/createGetState": {
-      "types": "./dist/createStore/helpers/createGetState.d.ts",
-      "import": "./dist/createStore/helpers/createGetState.mjs"
-    },
     "./createStore/helpers/createSetState": {
       "types": "./dist/createStore/helpers/createSetState.d.ts",
       "import": "./dist/createStore/helpers/createSetState.mjs"
@@ -166,6 +159,10 @@
       "types": "./dist/entities/createEntityAdapter.d.ts",
       "import": "./dist/entities/createEntityAdapter.mjs"
     },
+    "./entities/createEntityStore": {
+      "types": "./dist/entities/createEntityStore.d.ts",
+      "import": "./dist/entities/createEntityStore.mjs"
+    },
     "./entities/index": {
       "types": "./dist/entities/index.d.ts",
       "import": "./dist/entities/index.mjs"
@@ -230,6 +227,10 @@
       "types": "./dist/middleware/index.d.ts",
       "import": "./dist/middleware/index.mjs"
     },
+    "./middleware/isDisabled": {
+      "types": "./dist/middleware/isDisabled.d.ts",
+      "import": "./dist/middleware/isDisabled.mjs"
+    },
     "./middleware/loggerMiddleware": {
       "types": "./dist/middleware/loggerMiddleware.d.ts",
       "import": "./dist/middleware/loggerMiddleware.mjs"
@@ -242,6 +243,17 @@
       "types": "./dist/middleware/reduxDevToolsMiddleware.d.ts",
       "import": "./dist/middleware/reduxDevToolsMiddleware.mjs"
     },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "import": "./dist/next/index.mjs"
+    },
+    "./next/index": {
+      "types": "./dist/next/index.d.ts",
+      "import": "./dist/next/index.mjs"
+    },
+    "./rsc/index": {
+      "import": "./dist/rsc/index.mjs"
+    },
     "./types": {
       "types": "./dist/types/index.d.ts",
       "import": "./dist/types/index.mjs"