@abdokouta/react-support 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2024-03-31
+
+### Added
+
+- Initial release
+- `Str` class with 100+ Laravel-style string manipulation methods
+- `Collection` class for array collections (powered by collect.js)
+- `MapCollection` class for Map data structures
+- `SetCollection` class for Set data structures
+- `BaseRegistry` class for building extensible registry patterns
+- Full TypeScript support with comprehensive type definitions

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Refine
+
+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,178 @@
+# @abdokouta/support
+
+Laravel-style utilities for JavaScript/TypeScript. Provides powerful string manipulation, collection handling, and registry patterns inspired by Laravel's support package.
+
+## Features
+
+- 🎯 **Str Class**: 100+ string manipulation methods matching Laravel's API
+- 📦 **Collection**: Array collection with 50+ chainable methods (powered by collect.js)
+- 🗺️ **MapCollection**: Map data structure with collection methods
+- 🎲 **SetCollection**: Set data structure with collection methods
+- 🏗️ **BaseRegistry**: Generic registry pattern for building extensible systems
+- 💪 **TypeScript**: Full type safety with comprehensive type definitions
+- 🔗 **Chainable**: Fluent, chainable API for elegant code
+- 🚀 **Zero Config**: Works out of the box
+
+## Installation
+
+```bash
+npm install @abdokouta/support
+# or
+pnpm add @abdokouta/support
+# or
+yarn add @abdokouta/support
+```
+
+## Usage
+
+### Str Class
+
+```typescript
+import { Str } from '@abdokouta/support';
+
+// String manipulation
+Str.camel('foo_bar');                    // 'fooBar'
+Str.snake('fooBar');                     // 'foo_bar'
+Str.kebab('fooBar');                     // 'foo-bar'
+Str.studly('foo_bar');                   // 'FooBar'
+Str.title('a nice title');               // 'A Nice Title'
+
+// String inspection
+Str.contains('This is my name', 'my');   // true
+Str.startsWith('Hello World', 'Hello');  // true
+Str.endsWith('Hello World', 'World');    // true
+Str.isJson('{"key": "value"}');          // true
+Str.isUrl('https://example.com');        // true
+Str.isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de'); // true
+
+// String extraction
+Str.after('This is my name', 'This is'); // ' my name'
+Str.before('This is my name', 'my');     // 'This is '
+Str.between('This is my name', 'This', 'name'); // ' is my '
+
+// String modification
+Str.limit('The quick brown fox', 10);    // 'The quick...'
+Str.slug('Laravel 5 Framework', '-');    // 'laravel-5-framework'
+
+// And 80+ more methods!
+```
+
+### Collection (Array)
+
+```typescript
+import { collect } from '@abdokouta/support';
+
+// Create a collection
+const collection = collect([1, 2, 3, 4, 5]);
+
+// Chainable methods
+collection
+  .filter(item => item > 2)
+  .map(item => item * 2)
+  .sum();  // 24
+
+// Working with objects
+const users = collect([
+  { name: 'John', age: 30 },
+  { name: 'Jane', age: 25 },
+  { name: 'Bob', age: 35 }
+]);
+
+users.where('age', '>', 25).pluck('name').all();
+// ['John', 'Bob']
+
+// Aggregation
+collect([1, 2, 3, 4, 5]).sum();          // 15
+collect([1, 2, 3, 4, 5]).avg();          // 3
+collect([1, 2, 3, 4, 5]).max();          // 5
+collect([1, 2, 3, 4, 5]).min();          // 1
+```
+
+### MapCollection
+
+```typescript
+import { collectMap } from '@abdokouta/support';
+
+const map = collectMap({ name: 'John', age: 30 });
+
+map.set('city', 'New York');
+map.get('name');                         // 'John'
+map.has('age');                          // true
+map.keys();                              // ['name', 'age', 'city']
+map.values();                            // ['John', 30, 'New York']
+```
+
+### SetCollection
+
+```typescript
+import { collectSet } from '@abdokouta/support';
+
+const set1 = collectSet([1, 2, 3]);
+const set2 = collectSet([2, 3, 4]);
+
+set1.union(set2).all();                  // [1, 2, 3, 4]
+set1.intersect(set2).all();              // [2, 3]
+set1.diff(set2).all();                   // [1]
+```
+
+### BaseRegistry
+
+```typescript
+import { BaseRegistry } from '@abdokouta/support';
+
+// Create a typed registry
+interface Theme {
+  name: string;
+  colors: Record<string, string>;
+}
+
+const themeRegistry = new BaseRegistry<Theme>({
+  validateBeforeAdd: (key, theme) => {
+    if (!theme.name) {
+      return { valid: false, error: 'Theme must have a name' };
+    }
+    return { valid: true };
+  },
+  afterAdd: (key, theme) => {
+    console.log(`Registered theme: ${theme.name}`);
+  }
+});
+
+// Register items
+themeRegistry.register('dark', { name: 'Dark', colors: { bg: '#000' } });
+themeRegistry.register('light', { name: 'Light', colors: { bg: '#fff' } });
+
+// Retrieve items
+const theme = themeRegistry.get('dark');
+const allThemes = themeRegistry.getAll();
+const hasTheme = themeRegistry.has('dark');
+```
+
+## TypeScript Support
+
+Full TypeScript support with comprehensive type definitions:
+
+```typescript
+import { Str, Collection, MapCollection, SetCollection, BaseRegistry } from '@abdokouta/support';
+
+// Type-safe collections
+const numbers: Collection<number> = collect([1, 2, 3]);
+
+// Type-safe maps
+const userMap: MapCollection<string, User> = collectMap();
+
+// Type-safe sets
+const tags: SetCollection<string> = collectSet(['tag1', 'tag2']);
+
+// Type-safe registries
+const registry = new BaseRegistry<MyType>();
+```
+
+## License
+
+MIT
+
+## Credits
+
+- Inspired by [Laravel](https://laravel.com)'s support package
+- Array collections powered by [collect.js](https://collect.js.org/)