@intrig/react 0.0.7 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intrig/react",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "type": "module",
   "main": "./index.esm.js",
   "module": "./index.esm.js",
@@ -39,9 +39,5 @@
       "import": "./index.esm.js",
       "default": "./index.esm.js"
     }
-  },
-  "files": [
-    ".",
-    "!**/*.tsbuildinfo"
-  ]
+  }
 }

package/src/extra.d.ts

@@ -0,0 +1,53 @@
+import { BinaryFunctionHook, BinaryHookOptions, BinaryProduceHook, ConstantHook, NetworkState, UnaryFunctionHook, UnaryHookOptions, UnaryProduceHook, UnitHook, UnitHookOptions } from '@intrig/react/network-state';
+/**
+ * Converts a given hook into a promise-based function.
+ *
+ * @param {IntrigHook<P, B, T>} hook - The hook function to be converted.
+ * @param {string} [key='default'] - An optional key to uniquely identify the hook instance.
+ *
+ * @return {[(...params: Parameters<ReturnType<IntrigHook<P, B, T>>[1]>) => Promise<T>, () => void]}
+ * Returns a tuple containing a function that invokes the hook as a promise and a function to clear the state.
+ */
+export declare function useAsPromise<E>(hook: UnitHook<E>, options: UnitHookOptions): [() => Promise<never>, () => void];
+export declare function useAsPromise<T, E>(hook: ConstantHook<T, E>, options: UnitHookOptions): [() => Promise<T>, () => void];
+export declare function useAsPromise<P, E>(hook: UnaryProduceHook<P, E>, options?: UnaryHookOptions<P>): [(params: P) => Promise<never>, () => void];
+export declare function useAsPromise<P, T, E>(hook: UnaryFunctionHook<P, T, E>, options?: UnaryHookOptions<P>): [(params: P) => Promise<T>, () => void];
+export declare function useAsPromise<P, B, E>(hook: BinaryProduceHook<P, B, E>, options?: BinaryHookOptions<P, B>): [(body: B, params: P) => Promise<never>, () => void];
+export declare function useAsPromise<P, B, T, E>(hook: BinaryFunctionHook<P, B, T, E>, options?: BinaryHookOptions<P, B>): [(body: B, params: P) => Promise<T>, () => void];
+/**
+ * A custom hook that manages and returns the network state of a promise-based function,
+ * providing a way to execute the function and clear its state.
+ *
+ * @param fn The promise-based function whose network state is to be managed. It should be a function that returns a promise.
+ * @param key An optional identifier for the network state. Defaults to 'default'.
+ * @return A tuple containing the current network state, a function to execute the promise, and a function to clear the state.
+ */
+export declare function useAsNetworkState<T, F extends (...args: any) => Promise<T>>(fn: F, key?: string): [NetworkState<T>, (...params: Parameters<F>) => void, () => void];
+/**
+ * A custom hook that resolves the value from the provided hook's state and updates it whenever the state changes.
+ *
+ * @param {IntrigHook<P, B, T>} hook - The hook that provides the state to observe and resolve data from.
+ * @param options
+ * @return {T | undefined} The resolved value from the hook's state or undefined if the state is not successful.
+ */
+export declare function useResolvedValue<E>(hook: UnitHook<E>, options: UnitHookOptions): undefined;
+export declare function useResolvedValue<T, E>(hook: ConstantHook<T, E>, options: UnitHookOptions): T | undefined;
+export declare function useResolvedValue<P, E>(hook: UnaryProduceHook<P, E>, options: UnaryHookOptions<P>): undefined;
+export declare function useResolvedValue<P, T, E>(hook: UnaryFunctionHook<P, T, E>, options: UnaryHookOptions<P>): T | undefined;
+export declare function useResolvedValue<P, B, E>(hook: BinaryProduceHook<P, B, E>, options: BinaryHookOptions<P, B>): undefined;
+export declare function useResolvedValue<P, B, T, E>(hook: BinaryFunctionHook<P, B, T, E>, options: BinaryHookOptions<P, B>): T | undefined;
+/**
+ * A custom hook that resolves and caches the value from a successful state provided by the given hook.
+ * The state is updated only when it is in a successful state.
+ *
+ * @param {IntrigHook<P, B, T>} hook - The hook that provides the state to observe and cache data from.
+ * @param options
+ * @return {T | undefined} The cached value from the hook's state or undefined if the state is not successful.
+ */
+export declare function useResolvedCachedValue<E>(hook: UnitHook<E>, options: UnitHookOptions): undefined;
+export declare function useResolvedCachedValue<T, E>(hook: ConstantHook<T, E>, options: UnitHookOptions): T | undefined;
+export declare function useResolvedCachedValue<P, E>(hook: UnaryProduceHook<P, E>, options: UnaryHookOptions<P>): undefined;
+export declare function useResolvedCachedValue<P, T, E>(hook: UnaryFunctionHook<P, T, E>, options: UnaryHookOptions<P>): T | undefined;
+export declare function useResolvedCachedValue<P, B, E>(hook: BinaryProduceHook<P, B, E>, options: BinaryHookOptions<P, B>): undefined;
+export declare function useResolvedCachedValue<P, B, T, E>(hook: BinaryFunctionHook<P, B, T, E>, options: BinaryHookOptions<P, B>): T | undefined;
+//# sourceMappingURL=extra.d.ts.map

package/src/extra.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extra.d.ts","sourceRoot":"","sources":["../../../lib/src/extra.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EAQZ,YAAY,EAGZ,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EACR,eAAe,EAChB,MAAM,6BAA6B,CAAC;AAWrC;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EACjB,OAAO,EAAE,eAAe,GACvB,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AACtC,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAC/B,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,OAAO,EAAE,eAAe,GACvB,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AAClC,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAC/B,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC5B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAClC,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC5B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AAC3C,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAClC,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AACxD,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACrC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACpC,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AA6CpD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,EACzE,EAAE,EAAE,CAAC,EACL,GAAG,SAAY,GACd,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,IAAI,CAAC,CAiCnE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EACjB,OAAO,EAAE,eAAe,GACvB,SAAS,CAAC;AAEb,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EACnC,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,OAAO,EAAE,eAAe,GACvB,CAAC,GAAG,SAAS,CAAC;AAEjB,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EACnC,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC3B,SAAS,CAAC;AAEb,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACtC,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC3B,CAAC,GAAG,SAAS,CAAC;AAEjB,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACtC,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,SAAS,CAAC;AAEb,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACzC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACpC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,CAAC,GAAG,SAAS,CAAC;AAsBjB;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EACjB,OAAO,EAAE,eAAe,GACvB,SAAS,CAAC;AAEb,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EACzC,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,OAAO,EAAE,eAAe,GACvB,CAAC,GAAG,SAAS,CAAC;AAEjB,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EACzC,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC3B,SAAS,CAAC;AAEb,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5C,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC3B,CAAC,GAAG,SAAS,CAAC;AAEjB,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5C,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAChC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,SAAS,CAAC;AAEb,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAC/C,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACpC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,CAAC,GAAG,SAAS,CAAC"}

package/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from './intrig-provider';
+export * from './network-state';
+export * from './extra';
+export * from './media-type-utils';
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC"}

package/src/intrig-context.d.ts

@@ -0,0 +1,37 @@
+import { NetworkAction, NetworkState } from '@intrig/react/network-state';
+import { AxiosRequestConfig } from 'axios';
+import { ZodSchema } from 'zod';
+import { DefaultConfigs } from '@intrig/react/intrig-provider';
+type GlobalState = Record<string, NetworkState>;
+interface RequestType<T = any> extends AxiosRequestConfig {
+    originalData?: T;
+    key: string;
+    source: string;
+}
+/**
+ * Defines the ContextType interface for managing global state, dispatching actions,
+ * and holding a collection of Axios instances.
+ *
+ * @interface ContextType
+ * @property {GlobalState} state - The global state of the application.
+ * @property {React.Dispatch<NetworkAction<unknown>>} dispatch - The dispatch function to send network actions.
+ * @property {Record<string, AxiosInstance>} axios - A record of Axios instances for making HTTP requests.
+ */
+export interface ContextType {
+    state: GlobalState;
+    filteredState: GlobalState;
+    dispatch: React.Dispatch<NetworkAction<unknown, unknown>>;
+    configs: DefaultConfigs;
+    execute: <T>(request: RequestType, dispatch: (state: NetworkState<T>) => void, schema: ZodSchema<T> | undefined, errorSchema: ZodSchema<T> | undefined) => Promise<void>;
+}
+/**
+ * Context object created using `createContext` function. Provides a way to share state, dispatch functions,
+ * and axios instance across components without having to pass props down manually at every level.
+ *
+ * @type {ContextType}
+ */
+declare const Context: import("react").Context<ContextType>;
+export declare function useIntrigContext(): ContextType;
+export { Context };
+export type { GlobalState, RequestType };
+//# sourceMappingURL=intrig-context.d.ts.map

package/src/intrig-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intrig-context.d.ts","sourceRoot":"","sources":["../../../lib/src/intrig-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEhD,UAAU,WAAW,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,kBAAkB;IACvD,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,CAAC;IACnB,aAAa,EAAE,WAAW,CAAC;IAC3B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1D,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC,EACT,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,EAC1C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,EAChC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,KAClC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB;AAED;;;;;GAKG;AACH,QAAA,MAAM,OAAO,sCAUX,CAAC;AAEH,wBAAgB,gBAAgB,gBAE/B;AAED,OAAO,EAAC,OAAO,EAAC,CAAC;AACjB,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC"}

package/src/intrig-provider.d.ts

@@ -0,0 +1,102 @@
+import React, { PropsWithChildren } from 'react';
+import { IntrigHook, NetworkState } from './network-state';
+import { CreateAxiosDefaults } from 'axios';
+import { ZodSchema } from 'zod';
+import { RequestType } from './intrig-context';
+export interface DefaultConfigs extends CreateAxiosDefaults {
+    debounceDelay?: number;
+}
+export interface IntrigProviderProps {
+    configs?: Record<string, DefaultConfigs>;
+    children: React.ReactNode;
+}
+/**
+ * IntrigProvider is a context provider component that sets up global state management
+ * and provides Axios instances for API requests.
+ *
+ * @param {Object} props - The properties object.
+ * @param {React.ReactNode} props.children - The child components to be wrapped by the provider.
+ * @param {Object} [props.configs={}] - Configuration object for Axios instances.
+ * @param {Object} [props.configs.defaults={}] - Default configuration for Axios.
+ * @param {Object} [props.configs.petstore={}] - Configuration specific to the petstore API.
+ * @return {JSX.Element} A context provider component that wraps the provided children.
+ */
+export declare function IntrigProvider({ children, configs, }: IntrigProviderProps): import("react/jsx-runtime").JSX.Element;
+export interface StubType<P, B, T> {
+    <P, B, T>(hook: IntrigHook<P, B, T>, fn: (params: P, body: B, dispatch: (state: NetworkState<T>) => void) => Promise<void>): void;
+}
+export type WithStubSupport<T> = T & {
+    stubs?: (stub: StubType<any, any, any>) => void;
+};
+export interface IntrigProviderStubProps {
+    configs?: DefaultConfigs;
+    stubs?: (stub: StubType<any, any, any>) => void;
+    children: React.ReactNode;
+}
+export declare function IntrigProviderStub({ children, configs, stubs, }: IntrigProviderStubProps): import("react/jsx-runtime").JSX.Element;
+export interface StatusTrapProps {
+    type: 'pending' | 'error' | 'pending + error';
+    propagate?: boolean;
+}
+/**
+ * StatusTrap component is used to track and manage network request states.
+ *
+ * @param {Object} props - The properties object.
+ * @param {React.ReactNode} props.children - The child elements to be rendered.
+ * @param {string} props.type - The type of network state to handle ("error", "pending", "pending + error").
+ * @param {boolean} [props.propagate=true] - Whether to propagate the event to the parent context.
+ * @return {React.ReactElement} The context provider component with filtered state and custom dispatch.
+ */
+export declare function StatusTrap({ children, type, propagate, }: PropsWithChildren<StatusTrapProps>): import("react/jsx-runtime").JSX.Element;
+export interface NetworkStateProps<T, E = unknown> {
+    key: string;
+    operation: string;
+    source: string;
+    schema?: ZodSchema<T>;
+    errorSchema?: ZodSchema<E>;
+    debounceDelay?: number;
+}
+/**
+ * useNetworkState is a custom hook that manages the network state within the specified context.
+ * It handles making network requests, dispatching appropriate states based on the request lifecycle,
+ * and allows aborting ongoing requests.
+ *
+ * @param {Object} params - The parameters required to configure and use the network state.
+ * @param {string} params.key - A unique identifier for the network request.
+ * @param {string} params.operation - The operation type related to the request.
+ * @param {string} params.source - The source or endpoint for the network request.
+ * @param {Object} params.schema - The schema used for validating the response data.
+ * @param {number} [params.debounceDelay] - The debounce delay for executing the network request.
+ *
+ * @return {[NetworkState<T>, (request: AxiosRequestConfig) => void, () => void]}
+ *          Returns a state object representing the current network state,
+ *          a function to execute the network request, and a function to clear the request.
+ */
+export declare function useNetworkState<T, E = unknown>({ key, operation, source, schema, errorSchema, debounceDelay: requestDebounceDelay, }: NetworkStateProps<T>): [
+    NetworkState<T, E>,
+    (request: RequestType) => void,
+    clear: () => void,
+    (state: NetworkState<T, E>) => void
+];
+/**
+ * Handles central error extraction from the provided context.
+ * It filters the state to retain error states and maps them to a structured error object with additional context information.
+ * @return {Object[]} An array of objects representing the error states with context information such as source, operation, and key.
+ */
+export declare function useCentralError(): {
+    source: string;
+    operation: string;
+    key: string;
+    state: "error";
+    error: unknown;
+    statusCode?: number;
+    request?: any;
+}[];
+/**
+ * Uses central pending state handling by aggregating pending states from context.
+ * It calculates the overall progress of pending states if any, or returns an initial state otherwise.
+ *
+ * @return {NetworkState} The aggregated network state based on the pending states and their progress.
+ */
+export declare function useCentralPendingState(): NetworkState<unknown, unknown>;
+//# sourceMappingURL=intrig-provider.d.ts.map

package/src/intrig-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intrig-provider.d.ts","sourceRoot":"","sources":["../../../lib/src/intrig-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,iBAAiB,EAMlB,MAAM,OAAO,CAAC;AACf,OAAO,EAKL,UAAU,EAIV,YAAY,EAIb,MAAM,iBAAiB,CAAC;AACzB,OAAc,EAGZ,mBAAmB,EAEpB,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAKhC,OAAO,EAAW,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAmBrE,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,OAAY,GACb,EAAE,mBAAmB,2CA6GrB;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACN,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACzB,EAAE,EAAE,CACF,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KACvC,OAAO,CAAC,IAAI,CAAC,GACjB,IAAI,CAAC;CACT;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG;IACnC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;IAChD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,wBAAgB,kBAAkB,CAAC,EACjC,QAAQ,EACR,OAAY,EACZ,KAEC,GACF,EAAE,uBAAuB,2CAuDzB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAC9C,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,EACzB,QAAQ,EACR,IAAI,EACJ,SAAgB,GACjB,EAAE,iBAAiB,CAAC,eAAe,CAAC,2CA2DpC;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACtB,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,EAC9C,GAAG,EACH,SAAS,EACT,MAAM,EACN,MAAM,EACN,WAAW,EACX,aAAa,EAAE,oBAAoB,GACpC,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG;IACxB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI;IAC9B,KAAK,EAAE,MAAM,IAAI;IACjB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI;CACpC,CAoFA;AAeD;;;;GAIG;AACH,wBAAgB,eAAe;;;;;;;;IAgB9B;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,mCAwBrC"}

package/src/logger.d.ts

@@ -0,0 +1,14 @@
+import { LogLevelDesc } from 'loglevel';
+declare global {
+    interface window {
+        setLogLevel?: (level: LogLevelDesc) => void;
+    }
+}
+export declare const logger: {
+    info: (msg: unknown, meta?: unknown) => void;
+    warn: (msg: unknown, meta?: unknown) => void;
+    error: (msg: unknown, meta?: unknown) => void;
+    debug: (msg: unknown, meta?: unknown) => void;
+};
+export default logger;
+//# sourceMappingURL=logger.d.ts.map

package/src/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../lib/src/logger.ts"],"names":[],"mappings":"AAEA,OAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAG7C,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;KAC7C;CACF;AAoCD,eAAO,MAAM,MAAM;gBACL,OAAO,SAAS,OAAO,KAAG,IAAI;gBAE9B,OAAO,SAAS,OAAO,KAAG,IAAI;iBAE7B,OAAO,SAAS,OAAO,KAAG,IAAI;iBAE9B,OAAO,SAAS,OAAO,KAAG,IAAI;CAE5C,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/src/media-type-utils.d.ts

@@ -0,0 +1,5 @@
+import { ZodSchema } from 'zod';
+export declare function encode<T>(request: T, mediaType: string, schema: ZodSchema): any;
+export declare function transform<T>(request: Request, mediaType: string, schema: ZodSchema): Promise<T>;
+export declare function transformResponse<T>(data: any, mediaType: string, schema: ZodSchema): Promise<T>;
+//# sourceMappingURL=media-type-utils.d.ts.map

package/src/media-type-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-type-utils.d.ts","sourceRoot":"","sources":["../../../lib/src/media-type-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAiBhC,wBAAgB,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,OAKzE;AAuED,wBAAgB,SAAS,CAAC,CAAC,EACzB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,CAAC,CAAC,CAKZ;AAsFD,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,IAAI,EAAE,GAAG,EACT,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,CAAC,CAAC,CAKZ"}

package/src/network-state.d.ts

@@ -0,0 +1,383 @@
+import { ZodError } from 'zod';
+/**
+ * State of an asynchronous call. Network state follows the state diagram given below.
+ *
+ *
+ * <pre>
+ *                 ┌──────┐
+ *   ┌─────────────► Init ◄────────────┐
+ *   │             └▲────┬┘            │
+ *   │              │    │             │
+ *   │           Reset  Execute        │
+ * Reset            │    │           Reset
+ *   │           ┌──┴────┴──┐          │
+ *   │      ┌────► Pending  ◄────┐     │
+ *   │      │    └──┬────┬──┘    │     │
+ *   │   Execute    │    │    Execute  │
+ *   │      │       │    │       │     │
+ *   │      │ OnSuccess OnError  │     │
+ *   │ ┌────┴──┐    │    │    ┌──┴───┐ │
+ *   └─┤Success◄────┘    └────►Error ├─┘
+ *     └───────┘              └──────┘
+ *
+ * </pre>
+ */
+export interface NetworkState<T = unknown, E = unknown> {
+    state: 'init' | 'pending' | 'success' | 'error';
+}
+/**
+ * Network call is not yet started
+ */
+export interface InitState<T, E = unknown> extends NetworkState<T, E> {
+    state: 'init';
+}
+/**
+ * Checks whether the state is init state
+ * @param state
+ */
+export declare function isInit<T, E = unknown>(state: NetworkState<T, E>): state is InitState<T, E>;
+/**
+ * Initializes a new state.
+ *
+ * @template T The type of the state.
+ * @return {InitState<T>} An object representing the initial state.
+ */
+export declare function init<T, E = unknown>(): InitState<T, E>;
+/**
+ * Network call is not yet completed
+ */
+export interface PendingState<T, E = unknown> extends NetworkState<T, E> {
+    state: 'pending';
+    progress?: Progress;
+    data?: T;
+}
+/**
+ * Interface representing progress information for an upload or download operation.
+ *
+ * @typedef {object} Progress
+ *
+ * @property {'upload' | 'download'} type - The type of the operation.
+ *
+ * @property {number} loaded - The amount of data that has been loaded so far.
+ *
+ * @property {number} [total] - The total amount of data to be loaded (if known).
+ */
+export interface Progress {
+    type?: 'upload' | 'download';
+    loaded: number;
+    total?: number;
+}
+/**
+ * Checks whether the state is pending state
+ * @param state
+ */
+export declare function isPending<T, E = unknown>(state: NetworkState<T, E>): state is PendingState<T, E>;
+/**
+ * Generates a PendingState object with a state of "pending".
+ *
+ * @return {PendingState<T>} An object representing the pending state.
+ */
+export declare function pending<T, E = unknown>(progress?: Progress | undefined, data?: T | undefined): PendingState<T, E>;
+/**
+ * Network call is completed with success state
+ */
+export interface SuccessState<T, E = unknown> extends NetworkState<T, E> {
+    state: 'success';
+    data: T;
+}
+/**
+ * Checks whether the state is success response
+ * @param state
+ */
+export declare function isSuccess<T, E = unknown>(state: NetworkState<T, E>): state is SuccessState<T, E>;
+/**
+ * Creates a success state object with the provided data.
+ *
+ * @param {T} data - The data to be included in the success state.
+ * @return {SuccessState<T>} An object representing a success state containing the provided data.
+ */
+export declare function success<T, E = unknown>(data: T): SuccessState<T, E>;
+/**
+ * Network call is completed with error response
+ */
+export interface ErrorState<T, E = unknown> extends NetworkState<T, E> {
+    state: 'error';
+    error: E;
+    statusCode?: number;
+    request?: any;
+}
+/**
+ * Checks whether the state is error state
+ * @param state
+ */
+export declare function isError<T, E = unknown>(state: NetworkState<T, E>): state is ErrorState<T, E>;
+/**
+ * Constructs an ErrorState object representing an error.
+ *
+ * @param {any} error - The error object or message.
+ * @param {string} [statusCode] - An optional status code associated with the error.
+ * @return {ErrorState<T>} An object representing the error state.
+ */
+export declare function error<T, E = unknown>(error: E, statusCode?: number, request?: any): ErrorState<T>;
+/**
+ * Represents an error state with additional contextual information.
+ *
+ * @typedef {Object} ErrorWithContext
+ * @template T
+ * @extends ErrorState<T>
+ *
+ * @property {string} source - The origin of the error.
+ * @property {string} operation - The operation being performed when the error occurred.
+ * @property {string} key - A unique key identifying the specific error instance.
+ */
+export interface ErrorWithContext<T = unknown, E = unknown> extends ErrorState<T, E> {
+    source: string;
+    operation: string;
+    key: string;
+}
+/**
+ * Represents an action in the network context.
+ *
+ * @template T - The type of data associated with the network action
+ *
+ * @property {NetworkState<any>} state - The current state of the network action
+ * @property {string} key - The unique identifier for the network action
+ */
+export interface NetworkAction<T, E> {
+    key: string;
+    source: string;
+    operation: string;
+    state: NetworkState<T, E>;
+    handled?: boolean;
+}
+type HookWithKey = {
+    key: string;
+};
+export type UnitHookOptions = {
+    key?: string;
+    fetchOnMount?: false;
+    clearOnUnmount?: boolean;
+} | {
+    key?: string;
+    fetchOnMount: true;
+    params?: Record<string, any>;
+    clearOnUnmount?: boolean;
+};
+export type UnitHook<E = unknown> = ((options: UnitHookOptions) => [
+    NetworkState<never, E>,
+    (params?: Record<string, any>) => DispatchState<any>,
+    () => void
+]) & HookWithKey;
+export type ConstantHook<T, E = unknown> = ((options: UnitHookOptions) => [
+    NetworkState<T, E>,
+    (params?: Record<string, any>) => DispatchState<any>,
+    () => void
+]) & HookWithKey;
+export type UnaryHookOptions<P> = {
+    key?: string;
+    fetchOnMount?: false;
+    clearOnUnmount?: boolean;
+} | {
+    key?: string;
+    fetchOnMount: true;
+    params: P;
+    clearOnUnmount?: boolean;
+};
+export type UnaryProduceHook<P, E = unknown> = ((options?: UnaryHookOptions<P>) => [NetworkState<never, E>, (params: P) => DispatchState<any>, () => void]) & HookWithKey;
+export type UnaryFunctionHook<P, T, E = unknown> = ((options?: UnaryHookOptions<P>) => [NetworkState<T, E>, (params: P) => DispatchState<any>, () => void]) & HookWithKey;
+export type BinaryHookOptions<P, B> = {
+    key?: string;
+    fetchOnMount?: false;
+    clearOnUnmount?: boolean;
+} | {
+    key?: string;
+    fetchOnMount: true;
+    params: P;
+    body: B;
+    clearOnUnmount?: boolean;
+};
+export type BinaryProduceHook<P, B, E = unknown> = ((options?: BinaryHookOptions<P, B>) => [
+    NetworkState<never, E>,
+    (body: B, params: P) => DispatchState<any>,
+    () => void
+]) & HookWithKey;
+export type BinaryFunctionHook<P, B, T, E = unknown> = ((options?: BinaryHookOptions<P, B>) => [
+    NetworkState<T, E>,
+    (body: B, params: P) => DispatchState<any>,
+    () => void
+]) & HookWithKey;
+export type IntrigHookOptions<P = undefined, B = undefined> = UnitHookOptions | UnaryHookOptions<P> | BinaryHookOptions<P, B>;
+export type IntrigHook<P = undefined, B = undefined, T = any, E = unknown> = UnitHook<E> | ConstantHook<T, E> | UnaryProduceHook<P, E> | UnaryFunctionHook<P, T, E> | BinaryProduceHook<P, B, E> | BinaryFunctionHook<P, B, T, E>;
+export interface AsyncRequestOptions {
+    hydrate?: boolean;
+    key?: string;
+}
+/**
+ * Represents the dispatch state of a process.
+ *
+ * @template T The type of the state information.
+ * @interface
+ *
+ * @property {string} state The current state of the dispatch process.
+ */
+export interface DispatchState<T> {
+    state: string;
+}
+/**
+ * Represents a successful dispatch state.
+ *
+ * @template T - Type of the data associated with the dispatch.
+ *
+ * @extends DispatchState<T>
+ *
+ * @property {string} state - The state of the dispatch, always 'success'.
+ */
+export interface SuccessfulDispatch<T> extends DispatchState<T> {
+    state: 'success';
+}
+/**
+ * Indicates a successful dispatch state.
+ *
+ * @return {DispatchState<T>} An object representing a successful state.
+ */
+export declare function successfulDispatch<T>(): DispatchState<T>;
+/**
+ * Determines if the provided dispatch state represents a successful dispatch.
+ *
+ * @param {DispatchState<T>} value - The dispatch state to check.
+ * @return {value is SuccessfulDispatch<T>} - True if the dispatch state indicates success, false otherwise.
+ */
+export declare function isSuccessfulDispatch<T>(value: DispatchState<T>): value is SuccessfulDispatch<T>;
+/**
+ * ValidationError interface represents a specific type of dispatch state
+ * where a validation error has occurred.
+ *
+ * @typeparam T - The type of the data associated with this dispatch state.
+ */
+export interface ValidationError<T> extends DispatchState<T> {
+    state: 'validation-error';
+    error: any;
+}
+/**
+ * Generates a ValidationError object.
+ *
+ * @param error The error details that caused the validation to fail.
+ * @return The ValidationError object containing the error state and details.
+ */
+export declare function validationError<T>(error: any): ValidationError<T>;
+/**
+ * Determines if a provided DispatchState object is a ValidationError.
+ *
+ * @param {DispatchState<T>} value - The DispatchState object to evaluate.
+ * @return {boolean} - Returns true if the provided DispatchState object is a ValidationError, otherwise returns false.
+ */
+export declare function isValidationError<T>(value: DispatchState<T>): value is ValidationError<T>;
+/**
+ * Represents an error structure with a specified type and associated data.
+ *
+ * @template T - The type of the data associated with the error.
+ * @template E - The type of the error detail.
+ *
+ * @property {string} type - A string representing the type of the error.
+ */
+export interface IntrigError<T, E> {
+    type: string;
+}
+/**
+ * Represents an error encountered during a network operation.
+ * Extends from the `IntrigError` interface, adding network-specific properties.
+ *
+ * @template T - The type of the intrinsic data associated with the error.
+ * @template E - The type of the error details, defaulting to `unknown`.
+ *
+ * @property {string} type - A constant property representing the error type, always set to 'network'.
+ * @property {string} statusCode - A string representation of the HTTP status code associated with the error, indicating the nature of the network failure.
+ * @property {E} error - The detailed error information specific to the failure, type extends from the generic E, allowing flexibility in the error details.
+ * @property {any} request - The request object that was attempted when the network error occurred, providing context for what operation failed.
+ */
+export interface NetworkError<T, E = unknown> extends IntrigError<T, E> {
+    type: 'network';
+    statusCode: string;
+    error: E;
+    request: any;
+}
+/**
+ * Constructs a network error object.
+ *
+ * @param error The error object corresponding to the network request.
+ * @param statusCode A string representing the HTTP status code returned.
+ * @param request The request object associated with the network operation.
+ * @return A NetworkError object containing the error type, status code, error details, and the original request.
+ */
+export declare function networkError<T, E>(error: E, statusCode: string, request: any): NetworkError<T, E>;
+/**
+ * Determines if the provided IntrigError is of type 'network'.
+ *
+ * @param {IntrigError<T, E>} value - The error value to check the type of.
+ * @return {boolean} - Returns true if the error is of type 'network', otherwise false.
+ */
+export declare function isNetworkError<T, E>(value: IntrigError<T, E>): value is NetworkError<T, E>;
+/**
+ * Interface representing a request validation error.
+ *
+ * This error occurs when a validation process on a request fails. It extends the IntrigError interface
+ * by adding specific properties related to request validation.
+ *
+ * @template T - The type of the data associated with the error.
+ * @template E - The optional type of additional error information. Defaults to unknown.
+ *
+ * @extends IntrigError<T, E>
+ *
+ * @property {string} type - A string literal indicating the error type as 'request-validation'.
+ * @property {ZodError} error - An instance of ZodError containing detailed validation error information.
+ */
+export interface RequestValidationError<T, E = unknown> extends IntrigError<T, E> {
+    type: 'request-validation';
+    error: ZodError;
+}
+/**
+ * Constructs a RequestValidationError object encapsulating the ZodError.
+ *
+ * @param {ZodError} error - The error object resulting from Zod schema validation.
+ * @return {RequestValidationError<T, E>} A RequestValidationError object containing the validation error information.
+ */
+export declare function requestValidationError<T, E>(error: ZodError): RequestValidationError<T, E>;
+/**
+ * Determines if a given error is of type RequestValidationError.
+ *
+ * @param value The error object to check, which implements the IntrigError interface.
+ * @return A boolean indicating whether the error is a RequestValidationError.
+ */
+export declare function isRequestValidationError<T, E>(value: IntrigError<T, E>): value is RequestValidationError<T, E>;
+/**
+ * ResponseValidationError interface is designed to extend the capabilities of the IntrigError interface,
+ * specifically for handling errors related to response validation.
+ *
+ * @template T - Represents the type of the data or payload associated with the error.
+ * @template E - Represents the type of any additional error information. Defaults to unknown.
+ *
+ * @extends IntrigError
+ *
+ * @property type - A string literal that identifies the type of error as 'response-validation'.
+ * @property error - An instance of ZodError representing the validation error encountered.
+ */
+export interface ResponseValidationError<T, E = unknown> extends IntrigError<T, E> {
+    type: 'response-validation';
+    error: ZodError;
+}
+/**
+ * Constructs a ResponseValidationError object with a specified error.
+ *
+ * @param {ZodError} error - The validation error encountered during response validation.
+ * @return {ResponseValidationError<T, E>} An error object containing the type of error and the validation error details.
+ */
+export declare function responseValidationError<T, E>(error: ZodError): ResponseValidationError<T, E>;
+/**
+ * Determines if the given error is a response validation error.
+ *
+ * @param {IntrigError<T, E>} value - The error object to assess.
+ * @return {boolean} True if the error is a response validation error, otherwise false.
+ */
+export declare function isResponseValidationError<T, E>(value: IntrigError<T, E>): value is ResponseValidationError<T, E>;
+export {};
+//# sourceMappingURL=network-state.d.ts.map