@sqlrooms/utils 0.6.0 → 0.7.0

package/README.md

@@ -0,0 +1,98 @@
+A collection of utility functions and helpers for SQLRooms applications. This package provides common utilities for string manipulation, file handling, color management, formatting, and more.
+
+## Features
+
+- 🔠 **String Utilities**: Functions for string manipulation and formatting
+- 📁 **File Path Handling**: Tools for working with file paths and extensions
+- 🎨 **Color Utilities**: Color conversion and manipulation functions
+- 📊 **Formatting**: Data formatting for display purposes
+- 🔄 **XHR Helpers**: Utilities for working with XMLHttpRequests
+- 🧰 **General Helpers**: Common helper functions for everyday tasks
+
+## Installation
+
+```bash
+npm install @sqlrooms/utils
+# or
+yarn add @sqlrooms/utils
+```
+
+## Basic Usage
+
+### String Utilities
+
+```tsx
+import {truncate, capitalize, slugify} from '@sqlrooms/utils';
+
+// Truncate long text
+const shortText = truncate(
+  'This is a very long text that needs to be shortened',
+  20,
+);
+console.log(shortText); // 'This is a very long...'
+
+// Capitalize text
+const capitalized = capitalize('hello world');
+console.log(capitalized); // 'Hello world'
+
+// Create a URL-friendly slug
+const slug = slugify('Hello World! This is a test');
+console.log(slug); // 'hello-world-this-is-a-test'
+```
+
+### File Path Utilities
+
+```tsx
+import {getFileExtension, joinPaths, normalizePath} from '@sqlrooms/utils';
+
+// Get file extension
+const ext = getFileExtension('document.pdf');
+console.log(ext); // 'pdf'
+
+// Join path segments
+const fullPath = joinPaths('/base/path', 'subfolder', 'file.txt');
+console.log(fullPath); // '/base/path/subfolder/file.txt'
+
+// Normalize a path
+const normalized = normalizePath('/path//to/../folder/./file.txt');
+console.log(normalized); // '/path/folder/file.txt'
+```
+
+### JSON Utilities
+
+```tsx
+import {safeJsonParse} from '@sqlrooms/utils';
+
+// Safely parse JSON without throwing exceptions
+const result = safeJsonParse('{"name": "John", "age": 30}');
+console.log(result); // { name: 'John', age: 30 }
+
+// Handle invalid JSON gracefully
+const invalid = safeJsonParse('{"name": "John", age: 30}');
+console.log(invalid); // null
+```
+
+### Formatting Utilities
+
+```tsx
+import {formatBytes, formatNumber, formatDate} from '@sqlrooms/utils';
+
+// Format file size
+console.log(formatBytes(1024)); // '1 KB'
+console.log(formatBytes(1048576)); // '1 MB'
+
+// Format numbers
+console.log(formatNumber(1234567.89)); // '1,234,567.89'
+
+// Format dates
+console.log(formatDate(new Date(), 'yyyy-MM-dd')); // '2023-04-15'
+```
+
+## Advanced Features
+
+- **Type Safety**: All utilities are fully typed with TypeScript
+- **Browser Compatibility**: Works in all modern browsers
+- **Tree-Shakable**: Import only what you need to minimize bundle size
+- **No Dependencies**: Zero external runtime dependencies
+
+For more information, visit the SQLRooms documentation.

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export * from './color';
 export * from './format';
 export * from './helpers';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAC"}

package/dist/index.js

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export * from './color';
 export * from './format';
 export * from './helpers';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAC","sourcesContent":["export * from './color';\nexport * from './format';\nexport * from './helpers';\nexport * from './random';\nexport * from './str';\nexport * from './xhr';\nexport * from './filepaths';\nexport {safeJsonParse} from './json';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport * from './color';\nexport * from './format';\nexport * from './helpers';\nexport * from './random';\nexport * from './str';\nexport * from './xhr';\nexport * from './filepaths';\nexport {safeJsonParse} from './json';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/utils",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -41,5 +41,5 @@
     "react": "^19.0.0",
     "usehooks-ts": "^3.1.1"
   },
-  "gitHead": "f46dfe6b5d135e1a039b49b3ba71cda7150eab0f"
+  "gitHead": "8be65f051c588d3a963f721322429657913b6c63"
 }