redux-astroglide 0.1.21 → 0.1.24

package/dist/types/astroglide.d.ts

@@ -1,20 +1,101 @@
-import type { ConfigureStoreOptions, Slice } from "@reduxjs/toolkit";
-type ExtendedSlice = Slice & {
-    hooks: object;
-    selectors: object;
+import { injectMiddleware } from "redux-injectable-middleware";
+import type { Slice, Reducer, Action, Dispatch, Store, CaseReducer, PayloadAction } from "@reduxjs/toolkit";
+/** Capitalize first letter of a string type */
+type Capitalize<S extends string> = S extends `${infer F}${infer R}` ? `${Uppercase<F>}${R}` : S;
+/** Return type for hooks - [value, setter, extras] */
+type HookReturn<T> = [
+    T,
+    (value: T | ((prev: T) => T)) => void,
+    {
+        dispatch: Dispatch;
+        toggle?: T extends boolean ? () => void : never;
+    }
+];
+/** A hook with static methods for non-component usage */
+interface SliceHook<T> {
+    (setterCb?: (value: T) => T): [T, (value: T | ((prev: T) => T)) => void];
+    select: (state: any) => T;
+    update: (value: T | ((prev: T) => T)) => Action;
+}
+/** Generate hook types from initial state - creates useFieldName for each field */
+type GeneratedHooks<S> = {
+    [K in keyof S as `use${Capitalize<string & K>}`]: SliceHook<S[K]>;
 };
-export declare const configure: ({ middleware, devTools, preloadedState, enhancers, ...staticReducers }: ConfigureStoreOptions) => {
-    createSlice: (name: string | {
+/** Domain hook for the entire slice state */
+interface SliceDomainHook<S> {
+    (): [S, (value: Partial<S> | ((prev: S) => Partial<S>)) => void, (value: S) => void];
+    select: (state: any) => S;
+    update: (value: Partial<S> | ((prev: S) => Partial<S>)) => Action;
+}
+/** Generate selector types from initial state - creates selectFieldName for each field */
+type GeneratedSelectors<S> = {
+    [K in keyof S as `select${Capitalize<string & K>}`]: (state: any) => S[K];
+} & {
+    selectDomain: (state: any) => S;
+};
+/** Generate setter action types from initial state - creates setFieldName for each field */
+type GeneratedSetterActions<S> = {
+    [K in keyof S as `set${Capitalize<string & K>}`]: (payload: S[K]) => PayloadAction<S[K]>;
+};
+/** Slice-level setter action */
+type SliceSetterAction<S> = (payload: Partial<S>) => PayloadAction<Partial<S>>;
+/** Extract action types from custom reducers */
+type CustomReducerActions<R> = {
+    [K in keyof R]: R[K] extends CaseReducer<any, infer A> ? A extends PayloadAction<infer P> ? (payload: P) => PayloadAction<P> : () => Action<string> : never;
+};
+/** Extended slice with hooks, selectors, and properly typed actions */
+interface ExtendedSlice<S extends Record<string, any> = Record<string, any>, CustomReducers extends Record<string, CaseReducer<S, any>> = {}> extends Omit<Slice<S>, 'actions'> {
+    name: string;
+    reducer: Reducer<S>;
+    actions: GeneratedSetterActions<S> & CustomReducerActions<CustomReducers> & {
+        setSlice: SliceSetterAction<S>;
+        __override__slice__caution: (payload: S) => PayloadAction<S>;
+    };
+    selectors: GeneratedSelectors<S>;
+    hooks: GeneratedHooks<S> & {
+        useSlice: SliceDomainHook<S>;
+    };
+    getInitialState: () => S;
+}
+/** Configuration options for the store - reducer is NOT required */
+interface AstroglideConfigureOptions {
+    middleware?: any;
+    devTools?: boolean;
+    preloadedState?: any;
+    enhancers?: any;
+    [key: string]: any;
+}
+/** RTK-compatible configuration for custom reducers */
+interface RtkConfig<S, R extends Record<string, CaseReducer<S, any>> = {}> {
+    reducers?: R;
+    extraReducers?: any;
+    selectors?: Record<string, (state: S) => any>;
+}
+/** Astroglide-specific configuration overrides */
+interface AstroglideConfig {
+}
+/** Result returned from configure() */
+interface ConfigureResult {
+    store: Store;
+    /** Create a slice with simple form: createSlice("name", initialState) */
+    createSlice<S extends Record<string, any>>(name: string, initialState: S): ExtendedSlice<S>;
+    /** Create a slice with RTK config: createSlice("name", initialState, { reducers }) */
+    createSlice<S extends Record<string, any>, R extends Record<string, CaseReducer<S, any>>>(name: string, initialState: S, rtkConfig: RtkConfig<S, R>): ExtendedSlice<S, R>;
+    /** Create a slice with RTK-compatible object form: createSlice({ name, initialState }) */
+    createSlice<S extends Record<string, any>>(config: {
         name: string;
-        initialState: object;
-    }, initialState: object, rtkConfig?: {}, astroglideConfigOverrides?: {}) => ExtendedSlice;
-    astroglide: (name: string | {
+        initialState: S;
+    }): ExtendedSlice<S>;
+    /** Create a slice with RTK-compatible object form and reducers: createSlice({ name, initialState }, {}, { reducers }) */
+    createSlice<S extends Record<string, any>, R extends Record<string, CaseReducer<S, any>>>(config: {
         name: string;
-        initialState: object;
-    }, initialState: object, rtkConfig?: {}, astroglideConfigOverrides?: {}) => ExtendedSlice;
-    injectReducer: (key: any, asyncReducer: any) => void;
-    injectSlice: (slice: any) => void;
-    injectMiddleware: any;
-    store: import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<any, import("@reduxjs/toolkit").AnyAction, any[]>;
-};
-export {};
+        initialState: S;
+    }, _unused: any, rtkConfig: RtkConfig<S, R>): ExtendedSlice<S, R>;
+    /** Alias for createSlice */
+    astroglide: ConfigureResult['createSlice'];
+    injectReducer: (key: string, reducer: Reducer) => void;
+    injectSlice: (slice: Slice | ExtendedSlice<any>) => void;
+    injectMiddleware: typeof injectMiddleware;
+}
+export declare const configure: ({ middleware, devTools, preloadedState, enhancers, ...staticReducers }?: AstroglideConfigureOptions) => ConfigureResult;
+export type { ExtendedSlice, ConfigureResult, AstroglideConfigureOptions, RtkConfig, AstroglideConfig, SliceHook, SliceDomainHook, GeneratedHooks, GeneratedSelectors, GeneratedSetterActions, HookReturn, };

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ import { configure } from "./astroglide";
 export { createSelectorHook, createSelectorUpdateHook } from "./selectors";
 export { configure };
 export { plugins, addPlugin, addPlugins } from "./plugins/service";
+export type { ExtendedSlice, ConfigureResult, AstroglideConfigureOptions, RtkConfig, AstroglideConfig, SliceHook, SliceDomainHook, GeneratedHooks, GeneratedSelectors, GeneratedSetterActions, HookReturn, } from "./astroglide";
 export default configure;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-astroglide",
-  "version": "0.1.21",
+  "version": "0.1.24",
   "description": "Taking the pain out of redux state management",
   "keywords": [
     "redux",
@@ -19,23 +19,61 @@
   },
   "license": "MIT",
   "author": "Dustin Schultz <dmanke@gmail.com>",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./plugins": {
+      "types": "./dist/types/plugins/index.d.ts",
+      "import": "./dist/plugins/index.mjs",
+      "require": "./dist/plugins/index.js"
+    },
+    "./plugins/set": {
+      "types": "./dist/types/plugins/set/index.d.ts",
+      "import": "./dist/plugins/set/index.mjs",
+      "require": "./dist/plugins/set/index.js"
+    },
+    "./plugins/type": {
+      "types": "./dist/types/plugins/type/index.d.ts",
+      "import": "./dist/plugins/type/index.mjs",
+      "require": "./dist/plugins/type/index.js"
+    },
+    "./plugins/persist": {
+      "types": "./dist/types/plugins/persist/index.d.ts",
+      "import": "./dist/plugins/persist/index.mjs",
+      "require": "./dist/plugins/persist/index.js"
+    },
+    "./selectors": {
+      "types": "./dist/types/selectors/index.d.ts",
+      "import": "./dist/selectors/index.mjs",
+      "require": "./dist/selectors/index.js"
+    }
+  },
   "main": "./dist/index.js",
-  "module": "./dist/index.es.js",
+  "module": "./dist/index.mjs",
   "browser": "./dist/index.umd.js",
-  "types": "./dist/types",
+  "types": "./dist/types/index.d.ts",
   "files": [
-    "dist/*",
-    "plugins/*"
+    "dist"
   ],
   "scripts": {
     "start": "BUILD_ENV=dev npm run build:js -- --watch",
-    "build": "rimraf dist &&  npm run build:js && npm run build:types",
+    "build": "rimraf dist && npm run build:js && npm run build:types",
     "build:js": "rollup -c",
     "build:types": "tsc --emitDeclarationOnly",
     "prepare": "husky install",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
+    "test:coverage": "jest --coverage",
+    "sync:exports": "node scripts/sync-exports.js",
+    "validate:exports": "node scripts/validate-exports.js",
+    "test:exports": "node scripts/test-exports.js",
+    "lint:package": "publint",
+    "prepack": "npm run validate:exports && npm run lint:package",
+    "prepublishOnly": "npm run build && npm run test:exports"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": [
@@ -81,6 +119,7 @@
     "lint-staged": "^12.4.2",
     "prettier": "^2.6.2",
     "prop-types": "^15.8.1",
+    "publint": "^0.2.0",
     "rimraf": "^3.0.2",
     "rollup": "^2.74.1",
     "rollup-plugin-terser": "^7.0.2",

package/dist/types/plugins/persist/__tests__/persist.test.d.ts

@@ -1 +0,0 @@
-export {};