floppy-disk 2.10.0 → 2.11.0-beta.1

package/esm/react/create-query.js

@@ -1,5 +1,5 @@
 import { createElement, useState } from 'react';
-import { getValueOrComputedValue, hasValue, identityFn, isClient, noop } from '../utils';
+import { getValue, hasValue, identityFn, isClient, noop } from '../utils';
 import { createStores } from './create-stores';
 const INITIAL_QUERY_STATE = {
     isWaiting: false,
@@ -50,8 +50,8 @@ export const createQuery = (queryFn, options = {}) => {
         const key = _key;
         const getRetryProps = (error, retryCount) => {
             const prevState = get();
-            const maxRetryCount = getValueOrComputedValue(retry, error, prevState) || 0;
-            const delay = getValueOrComputedValue(retryDelay, error, prevState) || 0;
+            const maxRetryCount = getValue(retry, error, prevState) || 0;
+            const delay = getValue(retryDelay, error, prevState) || 0;
             return { shouldRetry: retryCount < maxRetryCount, delay };
         };
         const forceFetch = () => new Promise((resolve) => {
@@ -61,7 +61,7 @@ export const createQuery = (queryFn, options = {}) => {
             const newPageParams = [pageParams[0]];
             let pageParam = pageParams[0];
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
-            if (isWaiting || !getValueOrComputedValue(enabled, key))
+            if (isWaiting || !getValue(enabled, key))
                 return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
@@ -113,7 +113,7 @@ export const createQuery = (queryFn, options = {}) => {
                         pageParams: newPageParams,
                         hasNextPage: hasValue(newPageParam),
                     };
-                    const refetchIntervalValue = isClient && getValueOrComputedValue(refetchInterval, { ...get(), ...nextState });
+                    const refetchIntervalValue = isClient && getValue(refetchInterval, { ...get(), ...nextState });
                     if (refetchIntervalValue) {
                         refetchIntervalTimeoutId.set(keyHash, window.setTimeout(() => {
                             forceFetch();
@@ -190,7 +190,7 @@ export const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage || !getValueOrComputedValue(enabled, key))
+            if (isWaitingNextPage || !hasNextPage || !getValue(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
@@ -258,7 +258,7 @@ export const createQuery = (queryFn, options = {}) => {
     }, (() => {
         const windowFocusHandler = () => {
             useQuery.getAllWithSubscriber().forEach((state) => {
-                const result = getValueOrComputedValue(fetchOnWindowFocus, state.key);
+                const result = getValue(fetchOnWindowFocus, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -267,7 +267,7 @@ export const createQuery = (queryFn, options = {}) => {
         };
         const reconnectHandler = () => {
             useQuery.getAllWithSubscriber().forEach((state) => {
-                const result = getValueOrComputedValue(fetchOnReconnect, state.key);
+                const result = getValue(fetchOnReconnect, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -279,7 +279,7 @@ export const createQuery = (queryFn, options = {}) => {
             defaultDeps,
             onFirstSubscribe: (state) => {
                 if (state.isSuccess) {
-                    const refetchIntervalValue = isClient && getValueOrComputedValue(refetchInterval, state);
+                    const refetchIntervalValue = isClient && getValue(refetchInterval, state);
                     if (refetchIntervalValue) {
                         refetchIntervalTimeoutId.set(state.keyHash, window.setTimeout(() => {
                             state.forceFetch();
@@ -296,7 +296,7 @@ export const createQuery = (queryFn, options = {}) => {
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
-                const result = getValueOrComputedValue(fetchOnMount, state.key);
+                const result = getValue(fetchOnMount, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -390,7 +390,7 @@ export const createQuery = (queryFn, options = {}) => {
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);
-        const optimisticResponse = getValueOrComputedValue(response, prevState);
+        const optimisticResponse = getValue(response, prevState);
         useQuery.set(key, {
             isOptimisticData: true,
             response: optimisticResponse,

package/esm/react/create-stores.d.ts

@@ -2,12 +2,12 @@ import { Maybe } from '../utils';
 import { InitStoreOptions, InitStoreReturn, SelectDeps, SetStoreData, StoreData, Subscribers } from '../vanilla';
 import { WatchProps } from './create-store';
 export type StoreKey = Record<string, any> | undefined;
-export type StoresInitializer<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = (api: {
+export type StoresInitializer<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = T | ((api: {
     get: () => T;
     set: (value: SetStoreData<T>, silent?: boolean) => void;
     key: TKey;
     keyHash: string;
-}) => T;
+}) => T);
 export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = {
     /**
      * @param key (Optional) Store key, an object that will be hashed into a string as a store identifier.

package/esm/react/create-stores.js

@@ -1,5 +1,5 @@
 import { useEffect, useMemo, useRef, useState } from 'react';
-import { hashStoreKey, noop } from '../utils';
+import { getValue, hashStoreKey, noop } from '../utils';
 import { initStore, } from '../vanilla';
 /**
  * @see https://floppy-disk.vercel.app/docs/api#createstores
@@ -11,7 +11,7 @@ export const createStores = (initializer, options = {}) => {
         const key = _key || {};
         const keyHash = hashKeyFn(key);
         if (!stores.has(keyHash)) {
-            stores.set(keyHash, initStore((api) => initializer({ key, keyHash, ...api }), options));
+            stores.set(keyHash, initStore((api) => getValue(initializer, { key, keyHash, ...api }), options));
             onStoreInitialized(key, keyHash);
         }
         return stores.get(keyHash);

package/esm/utils/fetcher.js

@@ -1,5 +1,6 @@
-import { createError, getValueOrComputedValue, identityFn } from '.';
+import { createError, getValue, identityFn } from '.';
 const encodeParams = (params) => Object.entries(params)
+    .filter(([, value]) => value !== undefined && value !== null)
     .map((kv) => kv.map(encodeURIComponent).join('='))
     .join('&');
 /**
@@ -14,7 +15,7 @@ const encodeParams = (params) => Object.entries(params)
  * @returns A function to fetch data
  */
 export const fetcher = (options) => async (...args) => {
-    const { url, query, params, payload, headers, interceptRequest = identityFn, interceptResponse, ...rest } = getValueOrComputedValue(options, ...args);
+    const { url, query, params, payload, headers, interceptRequest = identityFn, interceptResponse, ...rest } = getValue(options, ...args);
     let autoOptions = {};
     let searchParams = params;
     if (query) {

package/esm/utils/index.d.ts

@@ -2,7 +2,7 @@ export declare const noop: () => void;
 export declare const identityFn: <T>(value: T) => T;
 export declare const hasValue: (value: any) => boolean;
 export declare const hashStoreKey: (obj?: any) => string;
-export declare const getValueOrComputedValue: <T, P extends any[]>(valueOrComputeValueFn: T | ((...params: P) => T), ...params: P) => T;
+export declare const getValue: <T, P extends any[]>(valueOrComputeValueFn: T | ((...params: P) => T), ...params: P) => T;
 export type Maybe<T> = T | null | undefined;
 export declare const isClient: boolean;
 export declare const createError: (message: string, props: Record<string, any>) => Error & Record<string, any>;

package/esm/utils/index.js

@@ -2,7 +2,7 @@ export const noop = () => { };
 export const identityFn = (value) => value;
 export const hasValue = (value) => value !== undefined && value !== null;
 export const hashStoreKey = (obj) => JSON.stringify(obj, Object.keys(obj).sort());
-export const getValueOrComputedValue = (valueOrComputeValueFn, ...params) => {
+export const getValue = (valueOrComputeValueFn, ...params) => {
     if (typeof valueOrComputeValueFn === 'function') {
         return valueOrComputeValueFn(...params);
     }

package/esm/vanilla.d.ts

@@ -2,10 +2,10 @@ export type StoreData = Record<string, any>;
 export type SetStoreData<T> = Partial<T> | ((prevState: T) => Partial<T>);
 export type SelectDeps<T> = ((state: T) => any[]) | undefined | null;
 export type Subscribers<T> = Map<(state: T) => void, SelectDeps<T>>;
-export type StoreInitializer<T> = (api: {
+export type StoreInitializer<T> = T | ((api: {
     get: () => T;
     set: (value: SetStoreData<T>, silent?: boolean) => void;
-}) => T;
+}) => T);
 export type StoreEvent<T> = (state: T) => void;
 export type InitStoreOptions<T> = {
     intercept?: (nextState: T, prevState: T) => Partial<T>;

package/esm/vanilla.js

@@ -1,4 +1,4 @@
-import { getValueOrComputedValue, noop } from './utils';
+import { getValue, noop } from './utils';
 export const initStore = (initializer, options = {}) => {
     const { intercept, onFirstSubscribe = noop, onSubscribe = noop, onUnsubscribe = noop, onLastUnsubscribe = noop, } = options;
     const subscribers = new Map();
@@ -7,7 +7,7 @@ export const initStore = (initializer, options = {}) => {
     const get = () => data;
     const set = (value, silent = false) => {
         const prevData = data;
-        data = { ...data, ...getValueOrComputedValue(value, data) };
+        data = { ...data, ...getValue(value, data) };
         if (intercept) {
             data = { ...data, ...intercept(data, prevData) };
         }
@@ -46,6 +46,6 @@ export const initStore = (initializer, options = {}) => {
                 onLastUnsubscribe(data);
         };
     };
-    data = initializer({ get, set });
+    data = getValue(initializer, { get, set });
     return { get, set, subscribe, getSubscribers };
 };

package/lib/react/create-query.js

@@ -53,8 +53,8 @@ const createQuery = (queryFn, options = {}) => {
         const key = _key;
         const getRetryProps = (error, retryCount) => {
             const prevState = get();
-            const maxRetryCount = (0, utils_1.getValueOrComputedValue)(retry, error, prevState) || 0;
-            const delay = (0, utils_1.getValueOrComputedValue)(retryDelay, error, prevState) || 0;
+            const maxRetryCount = (0, utils_1.getValue)(retry, error, prevState) || 0;
+            const delay = (0, utils_1.getValue)(retryDelay, error, prevState) || 0;
             return { shouldRetry: retryCount < maxRetryCount, delay };
         };
         const forceFetch = () => new Promise((resolve) => {
@@ -64,7 +64,7 @@ const createQuery = (queryFn, options = {}) => {
             const newPageParams = [pageParams[0]];
             let pageParam = pageParams[0];
             clearTimeout(refetchIntervalTimeoutId.get(keyHash));
-            if (isWaiting || !(0, utils_1.getValueOrComputedValue)(enabled, key))
+            if (isWaiting || !(0, utils_1.getValue)(enabled, key))
                 return resolve(state);
             if (isLoading)
                 set({ isWaiting: true });
@@ -116,7 +116,7 @@ const createQuery = (queryFn, options = {}) => {
                         pageParams: newPageParams,
                         hasNextPage: (0, utils_1.hasValue)(newPageParam),
                     };
-                    const refetchIntervalValue = utils_1.isClient && (0, utils_1.getValueOrComputedValue)(refetchInterval, { ...get(), ...nextState });
+                    const refetchIntervalValue = utils_1.isClient && (0, utils_1.getValue)(refetchInterval, { ...get(), ...nextState });
                     if (refetchIntervalValue) {
                         refetchIntervalTimeoutId.set(keyHash, window.setTimeout(() => {
                             forceFetch();
@@ -193,7 +193,7 @@ const createQuery = (queryFn, options = {}) => {
             const { isLoading, isWaitingNextPage, data, hasNextPage, pageParam, pageParams } = state;
             if (isLoading)
                 return resolve(forceFetch());
-            if (isWaitingNextPage || !hasNextPage || !(0, utils_1.getValueOrComputedValue)(enabled, key))
+            if (isWaitingNextPage || !hasNextPage || !(0, utils_1.getValue)(enabled, key))
                 return resolve(state);
             set({ isWaitingNextPage: true, isGoingToRetryNextPage: false });
             clearTimeout(retryNextPageTimeoutId.get(keyHash));
@@ -261,7 +261,7 @@ const createQuery = (queryFn, options = {}) => {
     }, (() => {
         const windowFocusHandler = () => {
             useQuery.getAllWithSubscriber().forEach((state) => {
-                const result = (0, utils_1.getValueOrComputedValue)(fetchOnWindowFocus, state.key);
+                const result = (0, utils_1.getValue)(fetchOnWindowFocus, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -270,7 +270,7 @@ const createQuery = (queryFn, options = {}) => {
         };
         const reconnectHandler = () => {
             useQuery.getAllWithSubscriber().forEach((state) => {
-                const result = (0, utils_1.getValueOrComputedValue)(fetchOnReconnect, state.key);
+                const result = (0, utils_1.getValue)(fetchOnReconnect, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -282,7 +282,7 @@ const createQuery = (queryFn, options = {}) => {
             defaultDeps,
             onFirstSubscribe: (state) => {
                 if (state.isSuccess) {
-                    const refetchIntervalValue = utils_1.isClient && (0, utils_1.getValueOrComputedValue)(refetchInterval, state);
+                    const refetchIntervalValue = utils_1.isClient && (0, utils_1.getValue)(refetchInterval, state);
                     if (refetchIntervalValue) {
                         refetchIntervalTimeoutId.set(state.keyHash, window.setTimeout(() => {
                             state.forceFetch();
@@ -299,7 +299,7 @@ const createQuery = (queryFn, options = {}) => {
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
-                const result = (0, utils_1.getValueOrComputedValue)(fetchOnMount, state.key);
+                const result = (0, utils_1.getValue)(fetchOnMount, state.key);
                 if (result === 'always')
                     state.forceFetch();
                 else if (result)
@@ -393,7 +393,7 @@ const createQuery = (queryFn, options = {}) => {
     };
     useQuery.optimisticUpdate = ({ key, response }) => {
         const prevState = useQuery.get(key);
-        const optimisticResponse = (0, utils_1.getValueOrComputedValue)(response, prevState);
+        const optimisticResponse = (0, utils_1.getValue)(response, prevState);
         useQuery.set(key, {
             isOptimisticData: true,
             response: optimisticResponse,

package/lib/react/create-stores.d.ts

@@ -2,12 +2,12 @@ import { Maybe } from '../utils';
 import { InitStoreOptions, InitStoreReturn, SelectDeps, SetStoreData, StoreData, Subscribers } from '../vanilla';
 import { WatchProps } from './create-store';
 export type StoreKey = Record<string, any> | undefined;
-export type StoresInitializer<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = (api: {
+export type StoresInitializer<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = T | ((api: {
     get: () => T;
     set: (value: SetStoreData<T>, silent?: boolean) => void;
     key: TKey;
     keyHash: string;
-}) => T;
+}) => T);
 export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = StoreData> = {
     /**
      * @param key (Optional) Store key, an object that will be hashed into a string as a store identifier.

package/lib/react/create-stores.js

@@ -14,7 +14,7 @@ const createStores = (initializer, options = {}) => {
         const key = _key || {};
         const keyHash = hashKeyFn(key);
         if (!stores.has(keyHash)) {
-            stores.set(keyHash, (0, vanilla_1.initStore)((api) => initializer({ key, keyHash, ...api }), options));
+            stores.set(keyHash, (0, vanilla_1.initStore)((api) => (0, utils_1.getValue)(initializer, { key, keyHash, ...api }), options));
             onStoreInitialized(key, keyHash);
         }
         return stores.get(keyHash);

package/lib/utils/fetcher.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 const _1 = require(".");
 const encodeParams = (params) => Object.entries(params)
+    .filter(([, value]) => value !== undefined && value !== null)
     .map((kv) => kv.map(encodeURIComponent).join('='))
     .join('&');
 /**
@@ -17,7 +18,7 @@ const encodeParams = (params) => Object.entries(params)
  * @returns A function to fetch data
  */
 const fetcher = (options) => async (...args) => {
-    const { url, query, params, payload, headers, interceptRequest = _1.identityFn, interceptResponse, ...rest } = (0, _1.getValueOrComputedValue)(options, ...args);
+    const { url, query, params, payload, headers, interceptRequest = _1.identityFn, interceptResponse, ...rest } = (0, _1.getValue)(options, ...args);
     let autoOptions = {};
     let searchParams = params;
     if (query) {

package/lib/utils/index.d.ts

@@ -2,7 +2,7 @@ export declare const noop: () => void;
 export declare const identityFn: <T>(value: T) => T;
 export declare const hasValue: (value: any) => boolean;
 export declare const hashStoreKey: (obj?: any) => string;
-export declare const getValueOrComputedValue: <T, P extends any[]>(valueOrComputeValueFn: T | ((...params: P) => T), ...params: P) => T;
+export declare const getValue: <T, P extends any[]>(valueOrComputeValueFn: T | ((...params: P) => T), ...params: P) => T;
 export type Maybe<T> = T | null | undefined;
 export declare const isClient: boolean;
 export declare const createError: (message: string, props: Record<string, any>) => Error & Record<string, any>;

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createError = exports.isClient = exports.getValueOrComputedValue = exports.hashStoreKey = exports.hasValue = exports.identityFn = exports.noop = void 0;
+exports.createError = exports.isClient = exports.getValue = exports.hashStoreKey = exports.hasValue = exports.identityFn = exports.noop = void 0;
 const noop = () => { };
 exports.noop = noop;
 const identityFn = (value) => value;
@@ -9,13 +9,13 @@ const hasValue = (value) => value !== undefined && value !== null;
 exports.hasValue = hasValue;
 const hashStoreKey = (obj) => JSON.stringify(obj, Object.keys(obj).sort());
 exports.hashStoreKey = hashStoreKey;
-const getValueOrComputedValue = (valueOrComputeValueFn, ...params) => {
+const getValue = (valueOrComputeValueFn, ...params) => {
     if (typeof valueOrComputeValueFn === 'function') {
         return valueOrComputeValueFn(...params);
     }
     return valueOrComputeValueFn;
 };
-exports.getValueOrComputedValue = getValueOrComputedValue;
+exports.getValue = getValue;
 exports.isClient = typeof window !== 'undefined' && !('Deno' in window);
 const createError = (message, props) => {
     const error = Object.assign(new Error(message), props);

package/lib/vanilla.d.ts

@@ -2,10 +2,10 @@ export type StoreData = Record<string, any>;
 export type SetStoreData<T> = Partial<T> | ((prevState: T) => Partial<T>);
 export type SelectDeps<T> = ((state: T) => any[]) | undefined | null;
 export type Subscribers<T> = Map<(state: T) => void, SelectDeps<T>>;
-export type StoreInitializer<T> = (api: {
+export type StoreInitializer<T> = T | ((api: {
     get: () => T;
     set: (value: SetStoreData<T>, silent?: boolean) => void;
-}) => T;
+}) => T);
 export type StoreEvent<T> = (state: T) => void;
 export type InitStoreOptions<T> = {
     intercept?: (nextState: T, prevState: T) => Partial<T>;

package/lib/vanilla.js

@@ -10,7 +10,7 @@ const initStore = (initializer, options = {}) => {
     const get = () => data;
     const set = (value, silent = false) => {
         const prevData = data;
-        data = { ...data, ...(0, utils_1.getValueOrComputedValue)(value, data) };
+        data = { ...data, ...(0, utils_1.getValue)(value, data) };
         if (intercept) {
             data = { ...data, ...intercept(data, prevData) };
         }
@@ -49,7 +49,7 @@ const initStore = (initializer, options = {}) => {
                 onLastUnsubscribe(data);
         };
     };
-    data = initializer({ get, set });
+    data = (0, utils_1.getValue)(initializer, { get, set });
     return { get, set, subscribe, getSubscribers };
 };
 exports.initStore = initStore;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.10.0",
+  "version": "2.11.0-beta.1",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",