react-rock 3.1.1 → 3.1.3

package/README.md

@@ -1,94 +1,195 @@
-### React Rock
-`react-rock` is a very powerfull react state management system library. you can use it with your small and big application.
+# React Rock Documentation
 
+**React Rock** is a lightweight state management library designed for React applications. It simplifies state handling with a straightforward API, allowing developers to efficiently manage complex states.
 
-### How to use
-`UserHandler.js`
-```js
-import {createState} from 'react-rock'
+- **NPM**: [react-rock](https://www.npmjs.com/package/react-rock)
+- **GitHub**: [React Rock Repository](https://github.com/devnax/react-rock)
 
-const User = createState()
+---
 
-export default User
+## Installation
+
+To get started, install React Rock via npm:
+
+```bash
+npm install react-rock
 ```
 
-```jsx
-import User from 'UserHandler'
+## Core Concept
+
+The core of React Rock is the `createStore` function. It enables developers to manage application state using an intuitive API for creating, updating, deleting, and querying state records.
+
+---
+
+## Usage
 
-const App = () => {
-    const items = User.getAll()
+### Creating a Store
 
-    return(
-        <div>
-            <ul>
-                {
-                    items.map(item => ...)
-                }
-            </ul>
-            <button onClick={() => {
-                User.insert({
-                    name: "",
-                    email: ""
-                })
-            }}>Add Item</button>
-        </div>
-    )
+```tsx
+import { createStore } from "react-rock";
+
+// Define the shape of your state
+interface Todo {
+  title: string;
+  completed: boolean;
 }
 
+// Create a store for managing Todos
+const todoStore = createStore<Todo>();
 ```
 
-## How to use in class component
-```js
-import {StateComponent} from 'react-rock'
-import User from 'UserHandler'
-
-class View extends StateComponent{
-
-  render(){
-    const items = User.getAll()
-
-    return (
-      <div>
-          <ul>
-            {
-                items.map(item => ...)
-            }
-          </ul>
-          <button onClick={() => {
-                User.insert({
-                    name: "",
-                    email: ""
-                })
-          }}>Add Item</button>
-        </div>
-    )
-  }
-}
+### Adding Data
+
+#### Single Record
+
+```tsx
+todoStore.create({ title: "Learn React Rock", completed: false });
+```
+
+#### Multiple Records
+
+```tsx
+todoStore.createMany([
+  { title: "Write Documentation", completed: true },
+  { title: "Push to GitHub", completed: false },
+]);
+```
+
+### Querying Data
+
+#### Retrieve All Records
+
+```tsx
+const allTodos = todoStore.getAll();
+```
+
+#### Find Records by Criteria
+
+```tsx
+const completedTodos = todoStore.find({ completed: true });
+```
+
+#### Find a Single Record by ID
+
+```tsx
+const todo = todoStore.findById("unique_id");
+```
+
+### Updating Data
+
+#### Update Matching Records
+
+```tsx
+todoStore.update({ completed: true }, { title: "Push to GitHub" });
+```
+
+#### Update All Records
+
+```tsx
+todoStore.updateAll({ completed: false });
+```
+
+### Deleting Data
+
+#### Delete Matching Records
+
+```tsx
+todoStore.delete({ completed: true });
+```
+
+#### Delete All Records
 
+```tsx
+todoStore.clearAll();
 ```
 
-## Methods
+### Meta Data Management
+
+React Rock supports storing metadata alongside your state:
+
+#### Set Metadata
+
+```tsx
+todoStore.setMeta("lastUpdated", new Date());
+```
+
+#### Get Metadata
+
+```tsx
+const lastUpdated = todoStore.getMeta("lastUpdated");
+```
+
+#### Clear Metadata
+
+```tsx
+todoStore.clearMeta();
+```
+
+---
+
+## Advanced Examples
+
+### Pagination
+
+```tsx
+const paginatedTodos = todoStore.getAll({ skip: 0, take: 5 });
+```
+
+### Moving Records
+
+```tsx
+todoStore.move(0, 1); // Move record from index 0 to index 1
+```
+
+### Observing State Changes
+
+React Rock integrates seamlessly with React hooks for real-time updates:
+
+```tsx
+const TodoList = () => {
+  const todos = todoStore.getAll();
+
+  return (
+    <ul>
+      {todos.map(todo => (
+        <li key={todo._id}>{todo.title}</li>
+      ))}
+    </ul>
+  );
+};
+```
+
+---
+
+## API Reference
+
+### `createStore`
+
+Creates a new store for managing state.
+
+#### Methods
+
+- **`create(row: Row)`**: Adds a new record.
+- **`createMany(rows: Row[])`**: Adds multiple records.
+- **`update(row: Partial<Row>, where: WhereType<Row>)`**: Updates matching records.
+- **`updateAll(row: Partial<Row>)`**: Updates all records.
+- **`delete(where: WhereType<Row>)`**: Deletes matching records.
+- **`clearAll()`**: Clears all records.
+- **`find(where: WhereType<Row>)`**: Finds matching records.
+- **`findById(id: string)`**: Finds a record by its ID.
+- **`setMeta(key, value)`**: Sets metadata.
+- **`getMeta(key)`**: Retrieves metadata.
+- **`clearMeta()`**: Clears metadata.
+
+---
+
+## Contributing
 
-```js
-import User from 'UserHandler'
-const users = User.find({name: "nax"})
+Contributions are welcome! Feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/devnax/react-rock).
 
-const users = User.find({
-  name: {
-    contain: "abc",
-    startWith: "a",
-    endWith: "@",
-  }
-})
+---
 
-const users = User.find({
-  age: {
-    lt: 20,
-    gt: 10,
+## License
 
-    lte: 20,
-    gte: 10
-  }
-})
+React Rock is licensed under the MIT License.
 
-```

package/dist/index.d.ts

@@ -4,4 +4,4 @@ export * from './types';
 export declare class StateComponent<P = {}, S = {}, SS = any> extends Component<P, S, SS> {
     constructor(props: P);
 }
-export declare const createState: <Row extends object, MetaProps extends object = {}>() => IStateHandler<Row, MetaProps>;
+export declare const createStore: <Row extends object, MetaProps extends object = {}>() => IStateHandler<Row, MetaProps>;

package/dist/index.js

@@ -16,7 +16,7 @@ const _row = (row) => {
         throw new Error(`State row must be an object. given ${typeof row}: ${row}`);
     return { ...row, _id: row._id || _uid(), _observe: row._observe || _random() };
 };
-export const createState = () => {
+export const createStore = () => {
     const factory = {
         data: {
             state: [],

package/dist/types.d.ts

@@ -36,9 +36,11 @@ export interface IStateHandler<Row, MetaProps> {
     clearMeta(freeze?: boolean): void;
 }
 export type QueryValueType = {
-    contain?: string | number;
+    contain?: string | number | boolean | null | undefined;
     startWith?: string | number;
     endWith?: string | number;
+    equalWith?: string | number | boolean | null | undefined;
+    notEqualWith?: string | number | boolean | null | undefined;
     gt?: number;
     lt?: number;
     gte?: number;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.1.1",
+  "version": "3.1.3",
   "name": "react-rock",
   "author": "Naxrul Ahmed",
   "license": "MIT",
@@ -34,4 +34,4 @@
     "react-dom": "^18.3.1",
     "typescript": "^5.5.3"
   }
-}
+}