@m4rctr3y/reutjs 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Reut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,483 @@
+# @reut/reutjs
+
+TypeScript/JavaScript client library for Reut backend API. Provides a type-safe, fluent API similar to Supabase's JavaScript client but tailored for the Reut API structure.
+
+## Features
+
+- 🎯 **Type Safety**: Full TypeScript support with generics
+- 🔗 **Fluent API**: Chainable query builder methods
+- 🔄 **Relationship Loading**: Easy eager loading with `.with()`
+- 🔍 **Advanced Filtering**: Support for relationship filters and operators
+- 📄 **Pagination**: Built-in pagination support
+- 🌐 **Framework Agnostic**: Works in Node.js, React, Vue, Angular, etc.
+- 🚀 **Axios-based**: Reliable HTTP client with interceptors support
+
+## Installation
+
+```bash
+npm install @reut/reutjs axios
+```
+
+or
+
+```bash
+yarn add @reut/reutjs axios
+```
+
+or
+
+```bash
+pnpm add @reut/reutjs axios
+```
+
+## Quick Start
+
+```typescript
+import { ReutClient } from '@reut/reutjs';
+
+// Initialize client
+const client = new ReutClient({
+  url: 'http://localhost:9000'
+});
+
+// Define your types
+interface Post {
+  id: number;
+  title: string;
+  content: string;
+  user_id: number;
+  created_at: string;
+  updated_at: string;
+}
+
+// Query data
+const posts = await client.from<Post>('posts')
+  .select(['title', 'user_id'])
+  .where('user_id', 1)
+  .with(['user_id'])
+  .page(1)
+  .limit(10)
+  .all();
+
+console.log(posts.results);
+```
+
+## API Reference
+
+### ReutClient
+
+The main client class for interacting with the Reut API.
+
+#### Constructor
+
+```typescript
+new ReutClient(config: ReutClientConfig)
+```
+
+**Config Options:**
+- `url` (string, required): Base URL of the Reut API server
+- `token` (string, optional): Authentication token
+- `axiosConfig` (AxiosRequestConfig, optional): Additional axios configuration
+
+**Example:**
+```typescript
+const client = new ReutClient({
+  url: 'http://localhost:9000',
+  token: 'your-auth-token',
+  axiosConfig: {
+    timeout: 5000
+  }
+});
+```
+
+#### Methods
+
+##### `from<T>(tableName: string): Table<T>`
+
+Get a table instance for querying.
+
+```typescript
+const postsTable = client.from<Post>('posts');
+```
+
+##### `setToken(token: string): void`
+
+Set authentication token.
+
+```typescript
+client.setToken('new-token');
+```
+
+##### `removeToken(): void`
+
+Remove authentication token.
+
+```typescript
+client.removeToken();
+```
+
+### Table
+
+Represents a database table and provides CRUD operations.
+
+#### Query Methods (Chainable)
+
+All query methods return the Table instance for chaining.
+
+##### `select(columns: string[]): Table<T>`
+
+Select specific columns.
+
+```typescript
+.select(['title', 'user_id'])
+```
+
+##### `where(column: string, operatorOrValue: WhereOperator | WhereValue, value?: WhereValue): Table<T>`
+
+Add a where condition.
+
+```typescript
+// Simple equality
+.where('user_id', 1)
+
+// With operator
+.where('age', 'gt', 18)
+.where('name', 'like', 'John')
+```
+
+##### `whereIn(column: string, values: (string | number)[]): Table<T>`
+
+Filter where column value is in array.
+
+```typescript
+.whereIn('user_id', [1, 2, 3])
+```
+
+##### `whereNotIn(column: string, values: (string | number)[]): Table<T>`
+
+Filter where column value is not in array.
+
+```typescript
+.whereNotIn('status', ['deleted', 'archived'])
+```
+
+##### `whereLike(column: string, value: string): Table<T>`
+
+Filter with LIKE operator (contains).
+
+```typescript
+.whereLike('title', 'test')
+```
+
+##### `whereGt(column: string, value: number): Table<T>`
+
+Filter where column is greater than value.
+
+```typescript
+.whereGt('age', 18)
+```
+
+##### `whereGte(column: string, value: number): Table<T>`
+
+Filter where column is greater than or equal to value.
+
+```typescript
+.whereGte('price', 100)
+```
+
+##### `whereLt(column: string, value: number): Table<T>`
+
+Filter where column is less than value.
+
+```typescript
+.whereLt('age', 65)
+```
+
+##### `whereLte(column: string, value: number): Table<T>`
+
+Filter where column is less than or equal to value.
+
+```typescript
+.whereLte('price', 1000)
+```
+
+##### `whereNe(column: string, value: WhereValue): Table<T>`
+
+Filter where column is not equal to value.
+
+```typescript
+.whereNe('status', 'deleted')
+```
+
+##### `whereIsNull(column: string): Table<T>`
+
+Filter where column is null.
+
+```typescript
+.whereIsNull('deleted_at')
+```
+
+##### `whereIsNotNull(column: string): Table<T>`
+
+Filter where column is not null.
+
+```typescript
+.whereIsNotNull('email')
+```
+
+##### `with(relationships: string[]): Table<T>`
+
+Eager load relationships.
+
+```typescript
+.with(['user_id', 'comments'])
+```
+
+##### `join(joinConfig: JoinConfig): Table<T>`
+
+Add a manual join.
+
+```typescript
+.join({
+  table: 'Users',
+  localColumn: 'user_id',
+  refColumn: 'id',
+  type: 'INNER',
+  alias: 'user'
+})
+```
+
+##### `page(page: number): Table<T>`
+
+Set page number for pagination.
+
+```typescript
+.page(1)
+```
+
+##### `limit(limit: number): Table<T>`
+
+Set limit for pagination.
+
+```typescript
+.limit(10)
+```
+
+##### `offset(offset: number): Table<T>`
+
+Set offset for pagination.
+
+```typescript
+.offset(20)
+```
+
+##### `orderBy(column: string, direction: 'asc' | 'desc' = 'asc'): Table<T>`
+
+Order results by column.
+
+```typescript
+.orderBy('created_at', 'desc')
+```
+
+#### CRUD Methods
+
+##### `all(options?: QueryOptions): Promise<PaginatedResponse<T>>`
+
+Get all records with optional query options.
+
+```typescript
+const result = await client.from<Post>('posts')
+  .select(['title'])
+  .where('user_id', 1)
+  .page(1)
+  .limit(10)
+  .all();
+
+console.log(result.results);      // Array of posts
+console.log(result.totalPages);   // Total pages
+console.log(result.page);         // Current page
+console.log(result.limit);        // Items per page
+console.log(result.totalItems);   // Total items
+```
+
+##### `find(id: string | number, options?: { with?: string[] }): Promise<SingleResponse<T>>`
+
+Find a single record by ID.
+
+```typescript
+const post = await client.from<Post>('posts')
+  .find(1, { with: ['user_id'] });
+```
+
+##### `add(data: Partial<T>): Promise<SingleResponse<T>>`
+
+Create a new record.
+
+```typescript
+const newPost = await client.from<Post>('posts')
+  .add({
+    title: 'New Post',
+    content: 'Post content',
+    user_id: 1
+  });
+```
+
+##### `update(id: string | number, data: Partial<T>): Promise<SingleResponse<T>>`
+
+Update a record by ID.
+
+```typescript
+const updatedPost = await client.from<Post>('posts')
+  .update(1, {
+    title: 'Updated Title'
+  });
+```
+
+##### `delete(id: string | number): Promise<void>`
+
+Delete a record by ID.
+
+```typescript
+await client.from<Post>('posts').delete(1);
+```
+
+## Examples
+
+### Basic Query
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .page(1)
+  .limit(10)
+  .all();
+```
+
+### Select Specific Columns
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .select(['title', 'user_id'])
+  .all();
+```
+
+### Eager Load Relationships
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .with(['user_id'])
+  .all();
+```
+
+### Filter by Column
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .where('user_id', 1)
+  .all();
+```
+
+### Filter by Relationship
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .where('user.name', 'John Doe')
+  .all();
+```
+
+### Complex Query
+
+```typescript
+const posts = await client.from<Post>('posts')
+  .select(['id', 'title', 'user_id'])
+  .where('user_id', 1)
+  .whereGt('created_at', '2024-01-01')
+  .with(['user_id'])
+  .page(1)
+  .limit(10)
+  .orderBy('created_at', 'desc')
+  .all();
+```
+
+### Create Record
+
+```typescript
+const newPost = await client.from<Post>('posts')
+  .add({
+    title: 'New Post',
+    content: 'Content here',
+    user_id: 1
+  });
+```
+
+### Update Record
+
+```typescript
+const updated = await client.from<Post>('posts')
+  .update(1, {
+    title: 'Updated Title'
+  });
+```
+
+### Delete Record
+
+```typescript
+await client.from<Post>('posts').delete(1);
+```
+
+## Type Definitions
+
+### PaginatedResponse<T>
+
+```typescript
+interface PaginatedResponse<T> {
+  results: T[];
+  totalPages: number;
+  page: number;
+  limit: number;
+  totalItems: number;
+}
+```
+
+### SingleResponse<T>
+
+```typescript
+type SingleResponse<T> = T;
+```
+
+### WhereOperator
+
+```typescript
+type WhereOperator = 
+  | 'eq'   // equals
+  | 'ne'   // not equals
+  | 'gt'   // greater than
+  | 'gte'  // greater than or equal
+  | 'lt'   // less than
+  | 'lte'  // less than or equal
+  | 'like' // like (contains)
+  | 'in'   // in array
+  | 'nin'  // not in array
+  | 'is'   // is null
+  | 'isn'; // is not null
+```
+
+## Error Handling
+
+The library throws errors for failed requests. Always wrap API calls in try-catch blocks:
+
+```typescript
+try {
+  const posts = await client.from<Post>('posts').all();
+} catch (error) {
+  console.error('Error fetching posts:', error.message);
+}
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+

package/dist/client.d.ts

@@ -0,0 +1,29 @@
+import { type AxiosInstance } from 'axios';
+import { Table } from './table.js';
+import type { ReutClientConfig } from './types.js';
+/**
+ * Main Reut client class
+ */
+export declare class ReutClient {
+    private axiosInstance;
+    private baseUrl;
+    constructor(config: ReutClientConfig);
+    /**
+     * Get a table instance for querying
+     * @param tableName Name of the table (will be lowercased)
+     */
+    from<T = any>(tableName: string): Table<T>;
+    /**
+     * Get the underlying axios instance for advanced usage
+     */
+    getAxiosInstance(): AxiosInstance;
+    /**
+     * Set authentication token
+     */
+    setToken(token: string): void;
+    /**
+     * Remove authentication token
+     */
+    removeToken(): void;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAA2B,MAAM,OAAO,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,gBAAgB;IAiBpC;;;OAGG;IACH,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAK1C;;OAEG;IACH,gBAAgB,IAAI,aAAa;IAIjC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B;;OAEG;IACH,WAAW,IAAI,IAAI;CAGpB"}

package/dist/client.js

@@ -0,0 +1,48 @@
+import axios from 'axios';
+import { Table } from './table.js';
+/**
+ * Main Reut client class
+ */
+export class ReutClient {
+    constructor(config) {
+        this.baseUrl = config.url.replace(/\/$/, ''); // Remove trailing slash
+        // Create axios instance
+        const axiosConfig = {
+            baseURL: this.baseUrl,
+            headers: {
+                'Content-Type': 'application/json',
+                ...(config.token && { Authorization: `Bearer ${config.token}` }),
+                ...config.axiosConfig?.headers,
+            },
+            ...config.axiosConfig,
+        };
+        this.axiosInstance = axios.create(axiosConfig);
+    }
+    /**
+     * Get a table instance for querying
+     * @param tableName Name of the table (will be lowercased)
+     */
+    from(tableName) {
+        const normalizedTableName = tableName.toLowerCase();
+        return new Table(this.axiosInstance, normalizedTableName);
+    }
+    /**
+     * Get the underlying axios instance for advanced usage
+     */
+    getAxiosInstance() {
+        return this.axiosInstance;
+    }
+    /**
+     * Set authentication token
+     */
+    setToken(token) {
+        this.axiosInstance.defaults.headers.common['Authorization'] = `Bearer ${token}`;
+    }
+    /**
+     * Remove authentication token
+     */
+    removeToken() {
+        delete this.axiosInstance.defaults.headers.common['Authorization'];
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAsD,MAAM,OAAO,CAAC;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC;;GAEG;AACH,MAAM,OAAO,UAAU;IAIrB,YAAY,MAAwB;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,wBAAwB;QAEtE,wBAAwB;QACxB,MAAM,WAAW,GAAuB;YACtC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBAChE,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO;aAC/B;YACD,GAAG,MAAM,CAAC,WAAW;SACtB,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAI,CAAU,SAAiB;QAC7B,MAAM,mBAAmB,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACpD,OAAO,IAAI,KAAK,CAAI,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,UAAU,KAAK,EAAE,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACrE,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @reut/reutjs - TypeScript/JavaScript client library for Reut backend API
+ */
+export { ReutClient } from './client.js';
+export { Table } from './table.js';
+export { QueryBuilder } from './query-builder.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+/**
+ * @reut/reutjs - TypeScript/JavaScript client library for Reut backend API
+ */
+export { ReutClient } from './client.js';
+export { Table } from './table.js';
+export { QueryBuilder } from './query-builder.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,cAAc,YAAY,CAAC"}

package/dist/query-builder.d.ts

@@ -0,0 +1,91 @@
+import type { QueryOptions, JoinConfig, WhereOperator, WhereValue } from './types.js';
+/**
+ * Query builder for constructing complex queries
+ */
+export declare class QueryBuilder {
+    private options;
+    /**
+     * Select specific columns
+     */
+    select(columns: string[]): this;
+    /**
+     * Add a where condition
+     * @param column Column name or relationship path (e.g., 'user.name')
+     * @param operatorOrValue Operator (if three params) or value (if two params)
+     * @param value Value (if operator provided)
+     */
+    where(column: string, operatorOrValue: WhereOperator | WhereValue, value?: WhereValue): this;
+    /**
+     * Add multiple where conditions
+     */
+    whereIn(column: string, values: (string | number)[]): this;
+    /**
+     * Add a 'not in' condition
+     */
+    whereNotIn(column: string, values: (string | number)[]): this;
+    /**
+     * Add a 'like' condition (contains)
+     */
+    whereLike(column: string, value: string): this;
+    /**
+     * Add a 'greater than' condition
+     */
+    whereGt(column: string, value: number): this;
+    /**
+     * Add a 'greater than or equal' condition
+     */
+    whereGte(column: string, value: number): this;
+    /**
+     * Add a 'less than' condition
+     */
+    whereLt(column: string, value: number): this;
+    /**
+     * Add a 'less than or equal' condition
+     */
+    whereLte(column: string, value: number): this;
+    /**
+     * Add a 'not equal' condition
+     */
+    whereNe(column: string, value: WhereValue): this;
+    /**
+     * Add an 'is null' condition
+     */
+    whereIsNull(column: string): this;
+    /**
+     * Add an 'is not null' condition
+     */
+    whereIsNotNull(column: string): this;
+    /**
+     * Eager load relationships
+     */
+    with(relationships: string[]): this;
+    /**
+     * Add a manual join
+     */
+    join(joinConfig: JoinConfig): this;
+    /**
+     * Set page number for pagination
+     */
+    page(page: number): this;
+    /**
+     * Set limit for pagination
+     */
+    limit(limit: number): this;
+    /**
+     * Set offset for pagination
+     */
+    offset(offset: number): this;
+    /**
+     * Order by column
+     */
+    orderBy(column: string, direction?: 'asc' | 'desc'): this;
+    /**
+     * Get the built query options
+     */
+    getOptions(): QueryOptions;
+    /**
+     * Reset the query builder
+     */
+    reset(): this;
+}
+//# sourceMappingURL=query-builder.d.ts.map