Portal v5.2

@ibnlanre/portal is a state management library designed to bridge the gap between simple state hooks and complex state machines. It provides an intuitive, type-safe approach to state management that grows with your application's needs.

Perfect for teams that:

• Need a consistent state management pattern across their application
• Want to leverage TypeScript's type system for safer code
• Build complex React applications with nested state requirements
• Require flexible state persistence options
• Value code organization and maintainability

Whether you're building a small React component or a large-scale application, @ibnlanre/portal adapts to your needs without forcing specific architectural patterns or unnecessary complexity.

• Features
• Get started
  • Prerequisites
  • Install the library
• Understand core concepts
  • What is a store?
  • Store types: Primitive and Composite
  • Immutability and reactivity
  • ⚠️ Important: Use Types, Not Interfaces
• Configure your stores
• Use the API: Reference and examples
  • Create stores: createStore()
    • Using createStore()
    • Using createPrimitiveStore()
    • Using createCompositeStore()
  • Create context stores: createContextStore()
  • Use store instance methods
    • $get()
    • $set()
    • $act()
    • $key()
    • $use() (React Hook)
  • Define actions: Functions in stores
  • Actions as hooks
  • Asynchronous effects: useAsync
  • Memoized computations: useSync
  • Deep dependency tracking: useVersion
  • Handle circular references
  • Handle arrays in stores
  • Normalize objects: normalizeObject()
  • Infer state types: InferType
• Persist state
  • Web Storage adapters
  • Cookie Storage adapter
  • Browser Storage adapter
  • Async Browser Storage adapter
• Cookie Storage
  • sign()
  • unsign()
  • getItem()
  • setItem()
  • removeItem()
  • clear()
  • createKey()
  • key()
  • length (Property)
• Optimize performance
• Understand limitations
• Follow best practices
• Troubleshoot common issues
• Contribute to the project
• Get help and support
• License

@ibnlanre/portal offers powerful features for efficient state management:

• 📦 Flexible Store Types

  • Manage both primitive values and complex nested objects
  • Automatic type inference based on initial state
  • Full TypeScript support with robust type checking

• 🔄 Intuitive State Management

  • Simple, consistent API with $get, $set, and $act
  • Deep partial updates for nested structures
  • Safe handling of circular references

• ⚛️ Seamless React Integration

  • Connect to components with the $use hook
  • Context-based stores via createContextStore
  • Co-locate state logic using actions-as-hooks

• 🔌 Built-in State Persistence

  • Local Storage and Session Storage adapters
  • Cookie Storage with signing support
  • Customizable async storage adapters

• 🛠️ Advanced Capabilities

  • Async operations with built-in loading states
  • Deep dependency tracking for computed values
  • Interface normalization for complex objects

This section guides you through setting up @ibnlanre/portal in your project.

Before you begin, ensure your development environment includes:

• Node.js (version 16.x or later recommended)
• A package manager: npm, pnpm, or yarn
• TypeScript (version 4.5 or later, if you are using TypeScript in your project)

You can add @ibnlanre/portal to your project using a package manager or by including it from a CDN.

1. Navigate to your project directory in the terminal.

2. Run one of the following commands, depending on your package manager:

   npm

   npm install @ibnlanre/portal

   pnpm

   pnpm add @ibnlanre/portal

   yarn

   yarn add @ibnlanre/portal

   The library includes TypeScript definitions, so no separate @types package is needed.

For projects that don't use a package manager (e.g., simple HTML pages or online playgrounds), you can include @ibnlanre/portal from a CDN:

Skypack

unpkg

jsDelivr

Understanding these core concepts will help you use @ibnlanre/portal effectively.

A store is an object that holds your application's state. It allows you to read the state, update it, and subscribe to changes. @ibnlanre/portal stores can hold any kind of data, from simple primitive values to complex, nested objects.

Store Type Description Example Initial State

Primitive Store	Manages a single primitive value (string, number, boolean, null, undefined)	0, "Alex", true
Composite Store	Manages an object with nested properties, each as a sub-store	{ name: "Alex", age: 30 }

@ibnlanre/portal distinguishes between two main types of stores, created automatically based on the initial state you provide:

1. Primitive Store: Manages a single, primitive value (e.g., a string, number, boolean, null, or undefined). At times, it can also manage a single object as a primitive-like store, where the entire object is treated as a single value.

   • Example: A store holding a user's name as a string or a count as a number.
   • Primitive stores provide methods to get the current value, set a new value, and subscribe to changes.

2. Composite Store: Manages an object, enabling nested state structures. Each property in a composite store's initial object can itself become a store instance (either primitive or composite), allowing for granular state management and access.

   • Example: A store holding user details, where each property (like name, email, address) can be accessed and updated independently.
   • Composite stores provide methods to get the current state, set new values for specific properties, and subscribe to changes at any level of the nested structure.

Both store types share a consistent API for getting, setting, and subscribing to state.

@ibnlanre/portal embraces immutability. When you update the state, the library creates a new state object instead of modifying the existing one. This helps prevent bugs and makes state changes predictable.

Tip: Stores are reactive. When a store's state changes, any components or subscribers listening to that store (or its parts) are notified, allowing your UI to update automatically.

@ibnlanre/portal works best with type aliases rather than interfaces when defining your state structure. This is because createStore() expects a dictionary type (Record<string, unknown>), and interfaces don't automatically extend this constraint.

Why this matters:

• Interfaces and dictionary types have different structural characteristics in TypeScript
• Using interfaces can break type inference for composite stores
• Arrays and other object types are properly typed as Record<string, any>, but interfaces would disrupt this consistency

✅ Recommended - Use type aliases:

❌ Avoid - Interfaces can cause type issues:

Alternative for interfaces: If you must work with existing interfaces (e.g., from APIs), use the normalizeObject() utility to convert them to dictionary-compatible types:

Alternatively, you can use the Normalize type utility directly on the interface to convert it to a dictionary type:

@ibnlanre/portal is designed to work with minimal configuration. The primary configuration points are:

1. Store Initialization: When you call createStore(), you provide the initial state. This is the main configuration for a store's structure and default values.
2. Persistence Adapters: If you use state persistence, you configure adapters with options like storage keys and serialization functions.

Refer to the Persist state section for detailed configuration of each adapter.

This section provides a comprehensive reference for the @ibnlanre/portal API, with detailed explanations and examples.

The createStore() function is the primary way to initialize a new store. For specific scenarios or finer control, you can also use the direct store creation functions createPrimitiveStore() and createCompositeStore().

Syntax:

• initialState: The initial value for the store.
  • If a primitive value (string, number, boolean, etc.) is provided, or an object that may be undefined or null, a PrimitiveStore<S> is created.
  • If an object is provided, a CompositeStore<S> is created, allowing for nested properties to be accessed as individual stores.
  • If a Promise is provided, the store will be initialized with the resolved value of the promise. The store will be empty until the promise resolves. The resolved value is treated as a single entity; if it's an object, it becomes the state of a primitive-like store, not a composite store with nested properties.
• Returns: A Store instance, which can be a PrimitiveStore<S> or CompositeStore<S> depending on initialState.

Examples:

1. Creating a primitive store:

   import { createStore } from "@ibnlanre/portal"; const countStore = createStore(0); console.log(countStore.$get()); // Output: 0 const messageStore = createStore("Hello, world!"); console.log(messageStore.$get()); // Output: "Hello, world!"

2. Creating a composite store:

   import { createStore } from "@ibnlanre/portal"; const userStore = createStore({ id: 1, name: "Alex Johnson", email: "[email protected]", address: { street: "123 Main St", city: "Anytown", }, }); console.log(userStore.name.$get()); // Output: "Alex Johnson" console.log(userStore.address.city.$get()); // Output: "Anytown"

3. Creating a store with asynchronous initialization:

   import { createStore } from "@ibnlanre/portal"; async function fetchUserData(): Promise<{ id: number; name: string }> { return new Promise((resolve) => { setTimeout(() => resolve({ id: 1, name: "Fetched User" }), 1000); }); } const userProfileStore = await createStore(fetchUserData()); // The store is now initialized as a primitive store with the fetched data. // Note: userProfileStore holds { id: 1, name: "Fetched User" } as a single value. // It's not created as a composite store despite being an object. console.log(userProfileStore.$get()); // Output: { id: 1, name: "Fetched User" }

Creates a store specifically for a single, primitive value (string, number, boolean, null, undefined, symbol, bigint).

Syntax:

• initialState: The initial primitive value.
• Returns: A PrimitiveStore<S> instance.

When to use:

• When you are certain the state will always be a primitive value and want to be explicit.
• In rare cases where createStore() type inference for primitives might need disambiguation (though generally robust).

Example:

Creates a store specifically for an object, enabling nested state structures.

Syntax:

• initialState: The initial object. Each property can become a nested store.
• Returns: A CompositeStore<S> instance.

When to use:

• When you are explicitly defining a store for an object structure.
• If you are building higher-level abstractions on top of the library and need direct access to composite store creation.

Example:

Note: Using createStore() is generally preferred as it automatically determines whether to create a primitive or composite store based on the initial state.

The createContextStore() function creates React Context-based stores that solve a common problem: initializing stores with dynamic values that come from props or external sources. This is particularly useful when you need to create stores that depend on runtime data rather than static initial values.

Key Benefits:

• Dynamic Store Creation: Initialize stores with runtime values from context, props, or API responses
• Type-Safe Integration: Full TypeScript support with proper type inference
• Maximum Flexibility: Full control over store initialization and memoization strategies
• Flexible Architecture: Support for nested providers and multi-tenant applications
• Developer Experience: Clear error messages and seamless React integration

The Problem it Solves:

Global stores are typically created outside of the React component lifecycle, so they can't be initialized with values from props or context. With a global store, you'd need to:

1. Create the store with a known default state
2. Sync props to the store using useEffect in every component that needs it

createContextStore eliminates this boilerplate by allowing you to pass a function that receives the context data needed before the store is initialized.

Syntax:

• initializer: A function that receives the context value and returns a store instance
• Returns: An array containing [StoreProvider, useStore]

Basic Example:

Advanced Example with Actions:

Use Cases:

• User-specific stores: Initialize stores with user data from authentication context
• Feature flags: Create stores based on feature flag configuration
• Multi-tenant applications: Initialize stores with tenant-specific configuration
• Server-side rendering: Initialize stores with server-rendered data
• Theme providers: Create theme-aware stores with runtime theme configuration

Note: The factory function passed to createContextStore runs on every render. You're responsible for memoizing values if needed. This design gives you complete freedom to use any hooks or memoization strategy within the factory function.

All store instances, whether primitive or composite, provide a core set of methods for interacting with the state.

Retrieves the current state of the store. Optionally, you can provide a selector function to compute a derived value from the state without altering the stored state.

Syntax:

• selector (optional): A function that takes the current state (S) as an argument and returns a derived value (R).
• Returns: The current state (S) if no selector is provided, or the derived value (R) if a selector is provided.

Examples:

1. Getting the current state:

   const countStore = createStore(10); const currentCount = countStore.$get(); // 10 const userStore = createStore({ name: "Alex", role: "admin" }); const currentUser = userStore.$get(); // { name: "Alex", role: "admin" } const userName = userStore.name.$get(); // "Alex"

2. Getting a derived value using a selector:

   const countStore = createStore(10); const doubledCount = countStore.$get((count) => count * 2); // 20 console.log(countStore.$get()); // 10 (original state is unchanged) const userStore = createStore({ firstName: "Alex", lastName: "Johnson" }); const fullName = userStore.$get( (user) => `${user.firstName} ${user.lastName}` ); // "Alex Johnson"

Updates the store's state. You can pass a new value directly or provide an update function that receives the previous state and returns the new state.

For composite stores holding objects, $set performs a deep partial update. This means you only need to provide the properties you want to change, and @ibnlanre/portal will merge them intelligently with the existing state.

Syntax:

• newValue: The new state value to set directly.
• updater: A function that takes the previous state (S) as an argument and returns the new state (S).
• Returns: void.

Examples:

1. Setting a new value directly (Primitive Store):

   const countStore = createStore(0); countStore.$set(5); console.log(countStore.$get()); // 5

2. Updating using a function (Primitive Store):

   const countStore = createStore(5); countStore.$set((prevCount) => prevCount + 1); console.log(countStore.$get()); // 6

3. Partial update on a Composite Store:

   const settingsStore = createStore({ theme: "light", fontSize: 12, notifications: true, }); // Update only theme and fontSize; notifications is preserved. settingsStore.$set({ theme: "dark", fontSize: 14 }); // settingsStore.$get() is now { theme: "dark", fontSize: 14, notifications: true } // Functional partial update settingsStore.$set((prevSettings) => ({ ...prevSettings, // Spread previous settings to preserve unspecified ones fontSize: prevSettings.fontSize + 2, // Only update fontSize })); // settingsStore.$get() is now { theme: "dark", fontSize: 16, notifications: true }

4. Updating nested properties in a Composite Store:

   const userStore = createStore({ profile: { name: "Alex", age: 30 }, role: "user", }); // Update nested property directly userStore.profile.name.$set("Alexandra"); console.log(userStore.profile.name.$get()); // "Alexandra" // Update part of the nested object userStore.profile.$set({ age: 31 }); // name is preserved // userStore.profile.$get() is { name: "Alexandra", age: 31 }

Note on arrays: When a part of your state is an array, and you use $set on the parent object containing that array, the entire array will be replaced if it's part of the update object. To modify array elements (e.g., add or remove items), access the array store directly or use functional updates on that specific array store.

Subscribes a callback function to state changes. The callback receives the new state (and optionally the old state) whenever it changes. This method returns an unsubscribe function to stop listening for updates.

By default, the callback is invoked immediately with the current state upon subscription. To prevent this initial invocation, pass false as the second argument.

Syntax:

• subscriber: A function that is called when the state changes. It receives newState and optionally oldState.
• immediate (optional, default true): If true, the subscriber is called immediately with the current state. If false, it's only called on subsequent changes. (On the initial immediate call, oldState is undefined.)
• Returns: An unsubscribe function. Call this function to remove the subscription.

Examples:

1. Basic subscription:

   const nameStore = createStore("Alex"); const unsubscribe = nameStore.$act((newName, oldName) => { console.log(`Name changed from "${oldName}" to "${newName}"`); }); // Immediately logs: Name changed from "undefined" to "Alex" // (oldState is undefined on the initial call if immediate: true) nameStore.$set("Jordan"); // Logs: Name changed from "Alex" to "Jordan" unsubscribe(); // Stop listening to changes nameStore.$set("Casey"); // Nothing is logged

2. Subscription without immediate callback execution:

   const statusStore = createStore("idle"); const unsubscribeNonImmediate = statusStore.$act((newStatus) => { console.log(`Status updated to: ${newStatus}`); }, false); // `false` prevents immediate call statusStore.$set("active"); // Logs: "Status updated to: active" // Unsubscribe to stop listening unsubscribeNonImmediate();

3. Subscribing to a composite store:

   const settingsStore = createStore({ theme: "light", volume: 70 }); // Setting up subscription to changes in settings const unsubscribeSettings = settingsStore.$act((newSettings) => { console.log("Settings updated:", newSettings); }); // Changing the theme triggers the subscription settingsStore.theme.$set("dark"); // Logs: Settings updated: { theme: "dark", volume: 70 } unsubscribeSettings(); // Stop listening to changes

(CompositeStore only) Provides convenient access to deeply nested stores using a dot-separated string path. This method returns the nested store instance, allowing you to use its methods ($get, $set, $act, $use, $key) directly.

Syntax:

• path: A dot-separated string representing the path to the nested store (e.g., "user.preferences.theme"). TypeScript provides autocompletion for valid paths.
• Returns: The nested Store instance (N).

Examples:

$key can be used on intermediate stores as well. For example, if you want to access a nested property like user.preferences.language, you can do so directly:

Connects your React components to an @ibnlanre/portal store. It works like React's useState hook, returning a tuple with the current state value (or a derived value) and a function to update the store's state.

The $use hook automatically subscribes the component to store changes and unsubscribes when the component unmounts, ensuring efficient re-renders.

Syntax:

• selector (optional): A function that takes the current store state (S) and returns a transformed value (R) for the component.
• dependencies (optional): An array of dependencies for the selector function. The selector is re-evaluated if any of these dependencies change (similar to React.useMemo).
• Returns: A tuple:
  1. currentStateOrDerivedValue: The current state (S) or the value returned by the selector (R).
  2. setStateFunction: A function to update the store's state. It accepts either a new value of type S or an updater function (prevState: S) => S.

Examples:

1. Basic usage in a React component:

   // src/stores/counter-store.ts import { createStore } from "@ibnlanre/portal"; export const countStore = createStore(0); // src/components/counter.tsx import { countStore } from "../stores/counterStore"; function Counter() { const [count, setCount] = countStore.$use(); return ( <div> <p>Count: {count}</p> <button onClick={() => setCount(count + 1)}>Increment</button> <button onClick={() => setCount((prev) => prev - 1)}> Decrement </button> <button onClick={() => setCount(0)}>Reset</button> </div> ); } export default Counter;

2. Using a selector with $use: Selectors compute derived values from the store state without modifying the original state. The selector is only re-evaluated when necessary, optimizing performance.

   // In your component: // Assume counterStore holds a number. const [displayCount, setCount] = counterStore.$use( (currentCount) => `Current count is: ${currentCount}` ); // If counterStore holds 0, displayCount is "Current count is: 0". // setCount still expects a number to update the original counterStore. return <p>{displayCount}</p>;

3. Using a selector with dependencies: This is useful when the selector depends on props or other state values. The dependencies can be any value, including primitive values, objects, or arrays. If the dependencies change, the selector will re-run to compute a new value.

   import { useState } from "react"; import { displayStore } from "./store"; interface DisplayValueProps { prefixFromProp: string; } function DisplayValue({ prefixFromProp }: DisplayValueProps) { const [displayValue, setDisplayValue] = displayStore.$use( (value) => `${prefixFromProp}${value}`, [prefixFromProp] // Dependencies array ); return ( <div> <p>{displayValue}</p> <input type="text" value={displayValue} onChange={(e) => setDisplayValue(e.target.value)} /> </div> ); }

4. Partial updates with objects using $use: When a store (or a part of a store accessed via $use) holds an object, the setState function returned by $use supports partial updates. Provide an object with only the properties you want to change.

   // store.ts import { createStore } from "@ibnlanre/portal"; export const userStore = createStore({ name: "Alex", age: 30, city: "Anytown", }); // user-profile.tsx import { userStore } from "./store"; function UserProfile() { const [user, setUser] = userStore.$use(); const handleAgeIncrease = () => { setUser({ age: user.age + 1 }); // Only age is updated; name and city are preserved. }; const handleNameChange = (event: React.ChangeEvent<HTMLInputElement>) => { setUser({ name: event.target.value }); // Only name is updated. }; return ( <div> <input type="text" value={user.name} onChange={handleNameChange} /> <p>Age: {user.age}</p> <p>City: {user.city}</p> <button onClick={handleAgeIncrease}>Increase Age</button> </div> ); }

You can include functions within the initial state object of a composite store. These functions become methods on the store, allowing you to co-locate state logic (actions) with the state itself. This is useful for encapsulating complex state transitions.

When defining actions, to update state, you must use the variable that holds the store instance. For example, if your store is const store = createStore(...), you would use store.property.$set(...) inside an action, not this.property.$set(...).

Examples:

1. Counter with actions:

   import { createStore } from "@ibnlanre/portal"; const counterStore = createStore({ value: 0, increment(amount: number = 1) { // To update 'value', use 'counterStore.value' counterStore.value.$set((prev) => prev + amount); }, decrement(amount: number = 1) { counterStore.value.$set((prev) => prev - amount); }, reset() { counterStore.value.$set(0); }, }); counterStore.increment(5); console.log(counterStore.value.$get()); // 5 counterStore.decrement(); console.log(counterStore.value.$get()); // 4 counterStore.reset(); console.log(counterStore.value.$get()); // 0

2. Reducer pattern: You can structure actions to follow a reducer pattern if that fits your application's architecture.

   import { createStore } from "@ibnlanre/portal"; type CounterAction = | { type: "INCREMENT"; payload: number } | { type: "DECREMENT"; payload: number } | { type: "RESET" }; const counterStore = createStore({ value: 0, dispatch(action: CounterAction) { switch (action.type) { case "INCREMENT": // Use 'counterStore.value' to access $set counterStore.value.$set((prev) => prev + action.payload); break; case "DECREMENT": counterStore.value.$set((prev) => prev - action.payload); break; case "RESET": counterStore.value.$set(0); break; } }, }); counterStore.dispatch({ type: "INCREMENT", payload: 5 }); console.log(counterStore.value.$get()); // 5 counterStore.dispatch({ type: "RESET" }); console.log(counterStore.value.$get()); // 0

@ibnlanre/portal allows you to define functions within your store that can be used as React custom hooks. This powerful feature enables you to co-locate complex, stateful logic—including side effects managed by useEffect or component-level state from useState directly with the store it relates to.

To create an action that functions as a hook, simply follow React's convention:

• prefix the function name with use
• place it directly within the object you pass to createStore
• then use it like any regular custom hook in your React components.

This pattern leverages React's own rules for hooks. It doesn't prevent the function from being recreated on re-renders (which is normal React behavior), but it provides an excellent way to organize and attach reusable hook logic to your store instance.

⚠️ Note: These functions are not automatically memoized. To prevent recreating hook logic on every render, define your store at the module level whenever possible. If you need to create a store inside a React component, use the useMemo hook to ensure the store is created based on stable dependencies.

Example:

Let's create a store with an action that uses useState and useEffect to automatically reset a message after a delay.

Using the hook action in a component:

In this example, useAutoResetMessage encapsulates its own state and side effects, just like a custom React hook, while still being able to interact with the global store. This pattern allows you to:

• Reuse complex hook logic across components
• Co-locate logic with the state it touches
• Maintain a clean separation of concern between logic and UI

The useAsync hook provides a robust solution for handling asynchronous operations within your store actions. It automatically manages loading states, error handling, and data states, making it easy to work with promises and async functions.

Key Features:

• Automatic state management: Tracks loading, error, and data states
• Error handling: Catches and manages errors automatically
• Dependency tracking: Re-runs when dependencies change
• Promise support: Works with any promise-returning function

Basic Usage:

Usage in React component:

The useSync hook provides a useMemo implementation with deep dependency verification. It's designed to compute and memoize values based on complex dependencies, with automatic re-computation when any part of the dependency tree changes.

Key Features:

• Deep dependency tracking: Performs deep equality checks on complex objects and arrays
• Automatic memoization: Only re-computes when dependencies actually change
• Complex object support: Handles nested objects, arrays, and circular references
• Type safety: Full TypeScript support with proper type inference
• Performance optimized: Avoids unnecessary re-computations

Basic Usage:

The useVersion hook provides deep dependency comparison through deep equality checking, making it ideal for complex state management scenarios. It allows you to track changes in deeply nested objects and arrays, providing both deep equality checking and version tracking for React hooks. It's the foundational hook used internally by useAsync and useSync, but can also be used directly when you want to build custom hooks with deep dependency checking using native React hooks like useMemo or useEffect.

Key Features:

• Deep equality checking: Performs deep comparison of complex objects, arrays, and nested structures
• Version tracking: Returns an incrementing version number that changes only when dependencies actually change
• Performance optimized: Avoids unnecessary re-computations by detecting true changes
• Circular reference support: Safely handles objects with circular references
• Type safety: Full TypeScript support with proper type inference

Basic Usage:

The useVersion hook is particularly useful when you want deep dependency tracking for custom hooks, or when native React hooks (useMemo, useEffect, useCallback) need to respond to changes in complex objects or arrays.

Tip: Rather than using useEffect to sync the store state to an external service, consider using $act for more efficient updates. This allows you to subscribe to changes in the store and react accordingly, while also providing a way to unsubscribe when no longer needed.

The createContextStore function enables efficient global store management through React Context. It provides a powerful pattern for creating provider-based stores that can be initialized with external data and shared across component trees.

Key Features:

• Provider-based: Creates React Context providers for store sharing
• Dynamic initialization: Initialize stores with props or external data
• Type safety: Full TypeScript support with proper type inference
• Efficient updates: Only re-renders components that use the specific store parts
• Nested providers: Support for multiple independent or nested providers

Basic Usage:

Using the context-based store in a React application:

The combine() utility performs a deep merge between objects and now supports multiple sources for complex merging scenarios. It's useful for unifying your initial state and actions into one cohesive structure before passing it into createStore.

Unlike shallow merging (such as Object.assign or object spread), combine():

• Recursively merges nested objects
• Preserves store instances within deeply nested structures
• Handles circular references safely
• Supports multiple sources with later sources taking precedence
• Enhanced type definitions for better TypeScript experience

Syntax:

• target: Base state or object.
• source: Object containing actions or additional properties to merge.
• sources: Array of objects to merge in sequence, with later sources taking precedence.
• Returns: A new, deeply merged object with references preserved.

Single Source Example:

Multiple Sources Example:

You can initialize a store with state fetched asynchronously by passing an async function (that returns a Promise) to createStore. The store will initially be empty (or hold the unresolved Promise object itself, depending on internal handling) until the Promise resolves.

Important Considerations:

• The store's methods ($get, $set, $act, $use) will operate on the unresolved Promise or an initial empty state until resolution.
• If the Promise resolves to an object, this object is treated as a single (primitive-like) value within the store. To achieve a nested structure from async data, initialize the store with a placeholder structure (or null) and then update it using $set once the data is fetched.
• For complex or relational data, consider normalizing the data shape or using normalizeObject before store initialization.

Example:

If you need a nested store structure from asynchronously loaded data, initialize the store with a placeholder structure (or null) and then update it using $set once the data is fetched. This allows the composite store structure to be established correctly.

@ibnlanre/portal handles objects with circular references safely during store creation and operations. This is particularly useful for complex data structures, such as graphs or when working with certain browser objects (after normalization).

Example:

Warning: Circular references are supported, but be mindful of performance with very large or deeply nested graphs.

When your store's state includes arrays, @ibnlanre/portal treats them in a specific way:

• Arrays as store properties: If an array is a direct property of your initial state object (e.g., items: [1, 2, 3] in createStore({ items: [...] })), then store.items becomes a store instance that manages this array. You can use $get(), $set(), and $act() on store.items to interact with the entire array.

  const store = createStore({ tags: ["typescript", "state-management"] }); const currentTags = store.tags.$get(); // ['typescript', 'state-management'] store.tags.$set(["javascript", "react"]); // Replaces the array

• Elements within arrays are not individual stores: Objects or other values inside an array are treated as plain data. They are not automatically wrapped as individual store instances. This means you cannot call store methods like $get() or $set() directly on an array element, even if that element is an object.

  const store = createStore({ users: [ { id: 1, name: "Alice" }, { id: 2, name: "Bob" }, ], }); // Correct: Get the array, then access elements const usersArray = store.users.$get(); const firstUserName = usersArray[0].name; // "Alice" // Incorrect: Attempting to treat an array element as a store const firstUserStore = store.users[0]; // This is not how to access it const name = store.users[0].name.$get(); // This will cause an error

• Updating arrays:

  • To replace the entire array, use $set() on the array's store property:

    const listStore = createStore({ items: [1, 2, 3] }); listStore.items.$set([4, 5, 6]); console.log(listStore.items.$get()); // Output: [4, 5, 6]

  • To modify the array (e.g., add, remove, or update elements), use a functional update with $set() on the array's store property. This ensures immutability by creating a new array.

    const userListStore = createStore({ users: [{ id: 1, name: "Alex", details: { age: 30 } }], }); // Add a new user userListStore.users.$set((currentUsers) => [ ...currentUsers, { id: 2, name: "Jordan", details: { age: 25 } }, ]); // Update an existing user's name userListStore.users.$set((currentUsers) => currentUsers.map((user) => user.id === 1 ? { ...user, name: "Alexandra" } : user ) ); // To update a nested property within an object in an array: userListStore.users.$set((currentUsers) => currentUsers.map((user) => user.id === 1 ? { ...user, details: { ...user.details, age: 31 } } : user ) );

• Arrays of primitive values: These are handled straightforwardly. The array itself is the store property.

  const numberListStore = createStore({ ids: [101, 102, 103] }); numberListStore.ids.$set((prevIds) => [...prevIds, 104]);

This behavior ensures that arrays are managed predictably as collections, while direct object properties of a store are augmented for more granular control. If you require each item in a collection to have full store capabilities, consider structuring your state as an object mapping IDs to individual stores, rather than an array of items. For example:

The normalizeObject() function converts interface-typed objects (like window, DOM elements, or complex API responses that might not be plain JavaScript objects) into dictionary types (Record<PropertyKey, unknown>) compatible with composite stores. This is important when an object's structure includes methods, symbols, or other non-serializable parts that shouldn't be part of the reactive state, or when TypeScript's type system for interfaces doesn't align with the expected structure for a composite store.

normalizeObject helps by:

• Converting interface types to store-compatible dictionary types.
• Safely handling circular references within the object during normalization.
• Filtering out non-data properties like functions and Symbols.
• Only preserving properties with string or number keys (symbol keys are excluded).
• Preserving the accessible data structure of the original object.

Important: The normalized object will only contain properties with string or number keys. Symbol keys are excluded during normalization.

Syntax:

• obj: The object to normalize.
• Returns: A new object that is a "plain" JavaScript object representation of obj, suitable for createStore.

Examples:

1. Normalizing the browser's window object:

   import { createStore, normalizeObject } from "@ibnlanre/portal"; // The 'window' object is complex and has an interface type. // Normalizing it makes it suitable for a composite store. const normalizedWindow = normalizeObject(window); const browserInfoStore = createStore(normalizedWindow); // Now you can access properties like browserInfoStore.navigator.userAgent.$get() // Note: Functions on window (like alert) would typically be excluded by normalization. console.log(browserInfoStore.location.href.$get()); // This might work if 'document' is data-like console.log(browserInfoStore.document.title.$get());

2. Normalizing a custom interface with methods and symbols:

   import { createStore, normalizeObject } from "@ibnlanre/portal"; interface UserProfileAPI { id: number; getFullName(): string; // A method lastLogin: Date; internalConfig: symbol; // A symbol data: { value: string }; } const apiResponse: UserProfileAPI = { id: 123, getFullName: () => "Alex Doe", lastLogin: new Date(), internalConfig: Symbol("config"), data: { value: "test" }, }; const normalizedUserProfile = normalizeObject(apiResponse); /* normalizedUserProfile will be: { id: 123, lastLogin: // Date object (preserved as it's data-like) data: { value: "test" } } // The getFullName method and internalConfig symbol are removed by normalization, // as functions and symbol keys are filtered out. */ const userProfileStore = createStore(normalizedUserProfile); console.log(userProfileStore.id.$get()); // 123 console.log(userProfileStore.data.value.$get()); // "test" // userProfileStore.getFullName is undefined (method was stripped) // userProfileStore.internalConfig is undefined (symbol key was excluded)

The InferType utility type allows you to extract TypeScript types from your Portal stores. This is especially useful when you need to work with the underlying state type in other parts of your application, such as API calls, form validation, or when passing state to other components.

Syntax:

Parameters:

• Store: The store from which to infer the type (must extend PrimitiveStore<any>)
• Path (optional): A path within the store's state to extract a specific nested type

Returns: The TypeScript type of the store's state, or the type at the specified path

Examples:

1. Infer the complete state type:

   import { createStore, InferType } from "@ibnlanre/portal"; const userStore = createStore({ age: 30, name: "Alice", preferences: { notifications: true, theme: "dark", }, }); // Infer the complete state type type UserState = InferType<typeof userStore>; function saveUserToAPI(user: UserState) { return fetch("/api/users", { body: JSON.stringify(user), method: "POST", }); } // Get the current state with correct typing const currentUser = userStore.$get(); // Type is automatically UserState saveUserToAPI(currentUser);

2. Infer specific nested types:

   import { createStore, InferType } from "@ibnlanre/portal"; const appStore = createStore({ data: { comments: [], posts: [], }, user: { profile: { email: "[email protected]", name: "Bob", }, settings: { language: "en", theme: "light", }, }, }); type AppData = InferType<typeof appStore, "data">; // UserProfile is: { name: string; email: string; } // Extract specific nested types type UserProfile = InferType<typeof appStore, "user.profile">; // UserSettings is: { theme: string; language: string; } type UserSettings = InferType<typeof appStore, "user.settings">; // AppData is: { posts: any[]; comments: any[]; } // Use inferred types for type-safe operations function updateProfile(newProfile: Partial<UserProfile>) { appStore.user.profile.$set((current) => ({ ...current, ...newProfile })); } function updateSettings(settings: UserSettings) { appStore.user.settings.$set(settings); }

3. Use with primitive stores:

   import { createStore, InferType } from "@ibnlanre/portal"; const countStore = createStore(0); const nameStore = createStore("Hello"); const itemsStore = createStore<string[]>([]); type CountType = InferType<typeof countStore>; // number type ItemsType = InferType<typeof itemsStore>; // string[] type NameType = InferType<typeof nameStore>; // string // Use inferred types in function parameters function processCount(value: CountType) { console.log(`Processing count: ${value}`); } function processItems(items: ItemsType) { return items.map((item) => item.toUpperCase()); }

4. Integration with forms and validation:

   import { createStore, InferType } from "@ibnlanre/portal"; const formStore = createStore({ email: "", profile: { bio: "", firstName: "", lastName: "", }, username: "", }); type FormData = InferType<typeof formStore>; type ProfileData = InferType<typeof formStore, "profile">; async function submitForm(formData: FormData) { const response = await fetch("/api/register", { body: JSON.stringify(formData), headers: { "Content-Type": "application/json" }, method: "POST", }); return response.json(); } function validateForm(data: FormData): boolean { return ( data.username.length > 0 && data.email.includes("@") && data.profile.firstName.length > 0 ); } const currentFormData = formStore.$get(); if (validateForm(currentFormData)) { await submitForm(currentFormData); }

The InferType utility ensures type safety when working with store data outside of the reactive context, making it easier to integrate Portal stores with other parts of your TypeScript application.

@ibnlanre/portal allows you to persist store state across sessions using storage adapters. These adapters provide getState and setState functions that you integrate with your store.

Use createLocalStorageAdapter or createSessionStorageAdapter to persist in the browser's Local Storage or Session Storage.

Syntax:

Parameters:

• key: string: Required. A unique string identifying this store's data in web storage.
• options?: StorageAdapterOptions<State>: Optional configuration object with:
  • stringify?: (state: State) => string: Function to serialize the state before saving. Defaults to JSON.stringify.
  • parse?: (storedString: string) => State: Function to deserialize the state after loading. Defaults to JSON.parse.

Return Value: Both adapters return a tuple: [getStateFunction, setStateFunction].

• getStateFunction(): S | null: Retrieves the state from storage. Returns null if no state is found for the key.
• setStateFunction(newState: S): void: Saves the new state to storage.

Persists state in localStorage. Data remains until explicitly cleared or removed by the user/browser.

Example:

Persists state in sessionStorage. Data remains for the duration of the page session (until the browser tab is closed).

Example:

Use createCookieStorageAdapter for persisting state in browser cookies.

Syntax:

Parameters:

• key: string: Required. The name of the cookie.
• options?: CookieStorageAdapterOptions<State>: Optional configuration object with:
  • secret?: string: Secret string for signing and verifying cookies. If provided, cookies are tamper-proofed.
  • stringify?: (state: State) => string: Function to serialize the state. Defaults to JSON.stringify.
  • parse?: (storedString: string) => State: Function to deserialize the state. Defaults to JSON.parse.
  • Cookie attributes (path, domain, secure, sameSite, maxAge, etc.)
  • path?: string: Cookie path (e.g., /).
  • domain?: string: Cookie domain.
  • maxAge?: number: Max age in seconds (e.g., 3600 * 24 * 7 for 7 days).
  • expires?: Date: Expiration date.
  • secure?: boolean: If true, cookie is only sent over HTTPS.
  • sameSite?: 'strict' | 'lax' | 'none': SameSite attribute.
• stringify? / parse?: Same as web storage adapters.

Return Value: [getCookieStateFunction, setCookieStateFunction]

• getCookieStateFunction(): S | null: Retrieves and unsigns (if secret provided) the cookie value.
• setCookieStateFunction(newState: S, newCookieOptions?: CookieOptions): void: Signs (if secret provided) and sets the cookie. newCookieOptions can override initial options for this specific set.

Example:

Signed cookies: If you provide a secret, cookies are automatically signed before being set and verified when retrieved. This helps protect against client-side tampering.

For custom storage mechanisms (e.g., IndexedDB, a remote API, chrome.storage), use createBrowserStorageAdapter.

Syntax:

Parameters:

• key: string: Required. A key for your custom storage.
• options: BrowserStorageAdapterOptions<State>: Required configuration object with:
  • getItem: (key: string) => string | null: Function to retrieve an item.
  • setItem: (key: string, value: string) => void: Function to save an item.
  • removeItem: (key: string) => void: Function to remove an item.
  • stringify?: (state: State) => string: Function to serialize the state. Defaults to JSON.stringify.
  • parse?: (storedString: string) => State: Function to deserialize the state. Defaults to JSON.parse.

Return Value: [getStorageState, setStorageState]

• getStorageState(fallback?: State): State | undefined
  • Retrieves the state from storage, applying the parse function.
  • If no state is found, it returns the provided fallback value.
• setStorageState(value?: State): void
  • Saves the state to storage, applying the stringify function.

Example (using a simple in-memory object as custom storage):

The createAsyncBrowserStorageAdapter is a more flexible version of createBrowserStorageAdapter. It allows for asynchronous transformations of your state, which is useful when you need to perform operations like encryption, compression, or other async tasks before storing or retrieving the state.

The adapter provides two functions: one for getting the state from storage and another for setting the state to storage. Both functions can handle asynchronous operations, allowing you to work with data that requires processing before being used in your application.

Syntax:

Parameters:

• key: string: Required. A key for your custom storage.
• options: BrowserStorageAdapterOptions<State>: Required configuration object with:
  • getItem: (key: string) => Promise<string | null> | string | null: Function to retrieve an item.
  • setItem: (key: string, value: string) => Promise<void> | void: Function to save an item.
  • removeItem: (key: string) => Promise<void> | void: Function to remove an item.
  • beforeUsage?: A function that transforms the data from storage before it's used in your application.
  • beforeStorage?: A function that transforms the data to be stored.

Return Value: [getStorageState, setStorageState]

• getStorageState(fallback?: State): Promise<State | undefined>
  • Retrieves the state from storage, applying the beforeUsage function.
  • If no state is found, it returns the provided fallback value.
• setStorageState(value?: State): Promise<void>
  • Saves the state to storage, applying the beforeStorage function.

Example:

Let's create an adapter that simulates async encryption and decryption.

Beyond the createCookieStorageAdapter, @ibnlanre/portal also exposes a cookieStorage module. This module provides a collection of utility functions for direct, granular manipulation of browser cookies. You might use these functions if you need to interact with cookies outside the context of a store or require more fine-grained control than the adapter offers.

These utilities are particularly helpful for tasks like signing/unsigning cookie values for security, directly reading or writing specific cookies, or managing cookie properties with precision.

Access the module:

To use these utilities, import cookieStorage:

The cookieStorage object provides the following functions and properties:

Signs a string value using a secret key. This is useful for creating tamper-proof cookie values.

• Parameters:

  • value: string: The string to sign.
  • secret: string: The secret key for signing.

• Returns: string - The signed string.

• Example:

  const originalValue = "user-session-data"; const secretKey = "your-super-secret-key"; const signedValue = cookieStorage.sign(originalValue, secretKey); // signedValue might look like "user-session-data.asdfjklsemf..."

Verifies and unsigns a previously signed string using the corresponding secret key.

• Parameters:

  • signedValue: string: The signed string to unsign.
  • secret: string: The secret key used for signing.

• Returns: string | false - The original string if the signature is valid, or false if tampering is detected or the secret is incorrect.

• Example:

  const potentiallyTamperedValue = "user-session-data.asdfjklsemf..."; const secretKey = "your-super-secret-key"; const originalValue = cookieStorage.unsign( potentiallyTamperedValue, secretKey ); if (originalValue === false) { console.error("Cookie signature is invalid!"); } else { console.log("Original value:", originalValue); }

Retrieves the value of a cookie by its name (key).

• Parameters:

  • key: string: The name of the cookie.

• Returns: string | null - The cookie's value, or null if the cookie is not found.

• Example:

  const themePreference = cookieStorage.getItem("userTheme"); if (themePreference) { console.log("User theme:", themePreference); }

Sets or updates a cookie's value. You can also provide cookie options.

• Parameters:

  • key: string: The name of the cookie.
  • value: string: The value to store in the cookie.
  • options?: CookieOptions: Optional. An object specifying cookie attributes (e.g., path, expires, secure). Refer to the CookieOptions type definition for details.

• Returns: void

• Example:

  cookieStorage.setItem("userToken", "abc123xyz789", { secure: true, path: "/", maxAge: 3600 * 24, // 1 day in seconds });

Removes a cookie by its name.

• Parameters:

  • key: string: The name of the cookie to remove.
  • options?: CookieOptions: Optional. Cookie options (like path and domain) that must match the options used when the cookie was set for successful removal.

• Returns: void

• Example:

  cookieStorage.removeItem("userToken", { path: "/" });

Attempts to clear all cookies accessible to the current document's path and domain by setting their expiration date to the past. Note that this might not remove cookies set with specific path or domain attributes unless those are also iterated and cleared individually.

• Returns: void

• Example:

  cookieStorage.clear(); // Clears cookies for the current path/domain

Constructs a standardized cookie name string based on a set of provided options. This helps maintain consistent naming conventions for cookies across your application.

• Parameters: An object with the following optional properties:

  • cookieFragmentDescription?: string: A description for the cookie's purpose (e.g., "Authentication Token").
  • cookiePrefix?: string: A prefix for the cookie name (e.g., "__Host-"). Default: "".
  • cookieFragmentSizes?: number[]: Array defining sizes for fragments if the description is segmented. Default: [].
  • cookieScope?: string: The scope of the cookie (e.g., "session", "user"). Default: "".
  • cookieScopeCase?: "title" | "upper" | "lower" | "camel" | "snake" | "pascal" | "header" | "constant": The case formatting for the scope part. Default: "title".
  • cookieService?: string: The service associated with the cookie. Default: "".
  • cookieScopeServiceConnector?: string: Connector between scope and service. Default: "-".
  • cookieScopeFragmentConnector?: string: Connector between scope and fragment description. Default: "_".
  • cookieFragmentsConnector?: string: Connector between multiple fragments of the description. Default: "".
  • cookieSuffix?: string: A suffix for the cookie name. Default: "".

• Returns: string - The generated cookie name.

• Example:

  const authTokenKey = cookieStorage.createKey({ cookieFragmentDescription: "Authentication Token", cookiePrefix: "__Secure-", cookieScope: "userSession", cookieScopeCase: "camel", }); // authTokenKey might be "__Secure-userSession_AuthenticationToken" console.log(authTokenKey);

Retrieves the name (key) of a cookie at a specific index in the document's cookie string. The order of cookies can be browser-dependent.

• Parameters:

  • index: number: The zero-based index of the cookie.

• Returns: string | null - The cookie name at the specified index, or null if the index is out of bounds.

• Example:

  const firstCookieName = cookieStorage.key(0); if (firstCookieName) { console.log("Name of the first cookie:", firstCookieName); }

Retrieves the total number of cookies accessible to the current document.

• Type: number

• Example:

  const numberOfCookies = cookieStorage.length; console.log(`There are ${numberOfCookies} cookies.`);

@ibnlanre/portal is designed for performance, but here are some tips for optimal usage in complex applications:

• Use selectors for reactive derived data: When you need derived state that should update when dependencies change, use selectors with $use() that depend on the actual store state, not external variables.

  // ✅ Correct: Selector depends on store state - updates reactively const [userItems] = appStore.$use((state) => state.items.filter((item) => item.ownedBy === state.selectedUserId) ); // ❌ Incorrect: External variable captured in closure - won't update const [userItems] = itemsStore.$use( (items) => items.filter((item) => item.ownedBy === selectedUserId) // selectedUserId is external );

• Leverage dependency arrays for expensive computations: When using selectors with $use(), provide a dependency array for expensive computations to prevent unnecessary recalculations.

  // Expensive calculation with proper dependencies const [processedData] = store.$use( (state) => expensiveDataProcessing(state.rawData, complexConfig), [complexConfig] // Only re-run if complexConfig changes );

• Choose the right approach for derived state: Use different patterns based on your reactivity needs:

  // For reactive derived state (updates components automatically) const [totalPrice] = cartStore.$use((cart) => cart.items.reduce((sum, item) => sum + item.price * item.quantity, 0) ); // For one-time calculations (doesn't subscribe to changes) const handleCheckout = () => { const total = cartStore.$get((cart) => cart.items.reduce((sum, item) => sum + item.price * item.quantity, 0) ); processPayment(total); };

• Avoid common reactivity pitfalls:

  • Don't use useMemo with incomplete dependencies: If you use React's useMemo for derived state, ensure all store data is included in the dependency array.
  • Don't capture external variables in selectors: Selectors should depend only on the store state they receive as their parameter.
  • Use store-level selectors for cross-store dependencies: When deriving data from multiple stores, use a parent store that contains all the data.

• Structure state for optimal updates: Organize your state to minimize unnecessary re-renders:

  // ✅ Good: Related data grouped together const uiStore = createStore({ modals: { loginVisible: false, cartVisible: false }, notifications: { count: 0, items: [] }, theme: "dark", }); // ❌ Less optimal: Separate stores for closely related UI state const loginModalStore = createStore(false); const cartModalStore = createStore(false); const notificationStore = createStore({ count: 0, items: [] });

• Keep components simple: Components should focus on rendering UI and handling user interactions. Move complex logic or data fetching to actions or hooks.

• Use granular subscriptions: Subscribe only to the specific parts of state your component needs:

  // ✅ Subscribe only to theme const [theme] = uiStore.theme.$use(); // ❌ Subscribe to entire UI store when only theme is needed const [uiState] = uiStore.$use(); const theme = uiState.theme;

• Batch related updates: When making multiple related changes, batch them to prevent intermediate re-renders. This is especially important in React, where each state change can trigger a re-render:

  // ✅ Single update for related changes userStore.$set((prevUser) => ({ ...prevUser, name: newName, email: newEmail, lastUpdated: Date.now(), })); // ❌ Multiple separate updates trigger multiple re-renders userStore.name.$set(newName); userStore.email.$set(newEmail); userStore.lastUpdated.$set(Date.now());

• Profile and measure: Use React DevTools Profiler and browser performance tools to identify actual performance bottlenecks rather than premature optimization.

While @ibnlanre/portal is versatile, it's important to be aware of its limitations:

• Serialization for persistence: When using persistence adapters (localStorage, sessionStorage, cookies), the state must be serializable. Functions, Symbols, undefined (in some parts of objects when using JSON.stringify), or complex class instances might not serialize/deserialize correctly by default. Customize stringify and parse options in adapters for complex scenarios. Functions within stores (actions) are not persisted.
• normalizeObject() behavior: The normalizeObject() utility is designed to convert complex objects into plain data structures suitable for stores. It strips out functions and symbol keys, keeping only properties with string or number keys. If you need to retain functions or symbol properties, this utility is not suitable, and you'll need to handle them separately or use a different approach.
• Reactivity scope: Reactivity is triggered by changes to store values. If you mutate an object or array obtained via $get() directly (without using $set()), the store will not detect the change, and subscribers (including React components using $use()) will not update. Always use $set() or the updater function from $use() to modify state.
• Promise resolution in createStore: When createStore is initialized with a Promise, the resolved value is treated as a single entity. If the Promise resolves to an object, this object becomes the state of a primitive-like store, not a composite store with automatically created nested properties. To achieve a nested structure from async data, initialize the store with a placeholder and use $set after data fetching.
• Server-Side Rendering (SSR): While stores can be used in Node.js environments, managing state hydration and consistency in SSR setups requires careful consideration. The library itself doesn't provide out-of-the-box SSR-specific utilities beyond its core functionality.

To make the most of @ibnlanre/portal, consider these best practices:

• Organize stores logically:
  • Feature-based: Create stores related to specific features or domains of your application (e.g., userStore, productStore, settingsStore).
  • UI state: Separate stores for UI-specific state (e.g., modalStore, notificationStore) if it helps with clarity.
• Keep state minimal: Only store data that represents the actual state of your application. Derive computed values using selectors.
• Embrace immutability: Always use $set() or the updater from $use() to change state. Avoid direct mutations.
• Co-locate actions: Define actions (functions) within your composite stores to keep state logic close to the state it manages. This improves encapsulation and maintainability.
• Use selectors for derived data: Prevent redundant state and keep your stores lean by computing derived values on the fly.
  const cartStore = createStore({ items: [{ price: 10, quantity: 2 }] }); const totalCost = cartStore.$get((state) => state.items.reduce((sum, item) => sum + item.price * item.quantity, 0) );
• Choose the right persistence adapter:
  • localStorage: For persistent user preferences or data that should survive browser restarts.
  • sessionStorage: For temporary data related to a single session (e.g., form data, current tab state).
  • cookieStorage: For small pieces of data that need to be sent with HTTP requests or shared across subdomains, or when signed/secure cookies are needed.
• Type safety: Leverage TypeScript. Define clear types for your state and actions.
• Testing:
  • Store logic (actions, selectors) can often be tested independently of UI components.
  • For components using stores, mock the stores or provide initial states suitable for your test cases.
• Naming conventions: Use clear and consistent names for your stores and state properties (e.g., userStore, profileSettingsStore).

Contributions are welcome! We appreciate your help in making @ibnlanre/portal better. You can contribute by:

• Reporting bugs or issues.
• Suggesting new features or enhancements.
• Submitting pull requests with code changes or documentation improvements.

Please read our CONTRIBUTING.md file for detailed guidelines on how to contribute, including coding standards, testing requirements, and the pull request process.

If you need help using @ibnlanre/portal, here are the resources available to you:

1. Documentation:

   • Start with this README and the API Reference.
   • Check our Troubleshooting Guide for solutions to common issues.

2. Community Support:

   • Browse existing GitHub Issues for similar problems and solutions.
   • Join discussions in the GitHub Discussions tab for community help and ideas.

3. Report Issues: If you can't find a solution, open a new issue on GitHub with:

   • Version of @ibnlanre/portal
   • Steps to reproduce the issue
   • Relevant code snippets
   • Error messages (if any)
   • Environment details (browser, OS, etc.)

This project is licensed under the BSD-3-Clause License. Copyright (c) 2025, ibnlanre.