@ewanc26/utils 0.1.2 → 0.1.4

package/README.md

@@ -1,43 +1,12 @@
 # @ewanc26/utils
 
-Shared utility functions extracted from [ewancroft.uk](https://ewancroft.uk). Zero runtime dependencies.
-
-## Modules
-
-- **Date & Locale** — `formatRelativeTime`, `formatLocalizedDate`, `getUserLocale`
-- **Number Formatting** — `formatCompactNumber`, `formatNumber`
-- **URL Utilities** — `getDomain`, `atUriToBlueskyUrl`, `getBlueskyProfileUrl`, `isExternalUrl`
-- **Validators & Text** — `isValidTid`, `isValidDid`, `truncateText`, `escapeHtml`, `getInitials`, `debounce`, `throttle`
-- **RSS Generation** — `generateRSSFeed`, `generateRSSItem`, `createRSSResponse`, `escapeXml`, `normalizeCharacters`, `formatRSSDate`
-
-## Installation
+Shared utility functions — date formatting, number formatting, URL utilities, validators, text helpers, and RSS generation. Zero runtime dependencies.
 
 ```bash
 pnpm add @ewanc26/utils
 ```
 
-## Quick Examples
-
-```typescript
-import { formatRelativeTime, formatCompactNumber, getDomain, isValidDid, generateRSSFeed } from '@ewanc26/utils';
-
-formatRelativeTime('2025-11-13T00:00:00Z'); // '3d ago'
-formatCompactNumber(1500);                   // '1.5K'
-getDomain('https://www.example.com/path');   // 'example.com'
-isValidDid('did:plc:abc123');                // true
-
-const xml = generateRSSFeed({ title: 'My Blog', link: 'https://mysite.com', description: '…' }, items);
-```
-
-All functions are SSR-safe and fall back to `en-GB` when `navigator` / `window` are unavailable.
-
-## Build
-
-```bash
-pnpm build   # tsc
-pnpm dev     # tsc --watch
-pnpm check   # tsc --noEmit
-```
+Full documentation at **[docs.ewancroft.uk](https://docs.ewancroft.uk/projects/utils)**.
 
 ## Licence
 

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export * from './url.js';
 export * from './validators.js';
 export * from './rss.js';
 export * from './locale.js';
+export * from './slug.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/dist/index.js

@@ -4,3 +4,4 @@ export * from './url.js';
 export * from './validators.js';
 export * from './rss.js';
 export * from './locale.js';
+export * from './slug.js';

package/dist/slug.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Normalize a slug to be URI-compatible.
+ *
+ * Transformations:
+ * - Lowercase
+ * - Spaces → hyphens
+ * - Remove all characters except alphanumeric, hyphens, underscores
+ * - Collapse multiple hyphens into one
+ * - Strip leading/trailing hyphens
+ */
+export declare function normalizeSlug(slug: string): string;
+/**
+ * Check if a string matches AT Protocol TID format (12–16 base32 characters).
+ */
+export declare function isTidFormat(str: string): boolean;
+//# sourceMappingURL=slug.d.ts.map

package/dist/slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../src/slug.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQlD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD"}

package/dist/slug.js

@@ -0,0 +1,25 @@
+/**
+ * Normalize a slug to be URI-compatible.
+ *
+ * Transformations:
+ * - Lowercase
+ * - Spaces → hyphens
+ * - Remove all characters except alphanumeric, hyphens, underscores
+ * - Collapse multiple hyphens into one
+ * - Strip leading/trailing hyphens
+ */
+export function normalizeSlug(slug) {
+    return slug
+        .toLowerCase()
+        .trim()
+        .replace(/\s+/g, '-')
+        .replace(/[^a-z0-9\-_]/g, '')
+        .replace(/-+/g, '-')
+        .replace(/^-+|-+$/g, '');
+}
+/**
+ * Check if a string matches AT Protocol TID format (12–16 base32 characters).
+ */
+export function isTidFormat(str) {
+    return /^[a-zA-Z0-9]{12,16}$/.test(str);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ewanc26/utils",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Shared utility functions extracted from ewancroft.uk",
   "type": "module",
   "exports": {

package/src/index.ts

@@ -4,3 +4,4 @@ export * from './url.js';
 export * from './validators.js';
 export * from './rss.js';
 export * from './locale.js';
+export * from './slug.js';

package/src/slug.ts

@@ -0,0 +1,26 @@
+/**
+ * Normalize a slug to be URI-compatible.
+ *
+ * Transformations:
+ * - Lowercase
+ * - Spaces → hyphens
+ * - Remove all characters except alphanumeric, hyphens, underscores
+ * - Collapse multiple hyphens into one
+ * - Strip leading/trailing hyphens
+ */
+export function normalizeSlug(slug: string): string {
+	return slug
+		.toLowerCase()
+		.trim()
+		.replace(/\s+/g, '-')
+		.replace(/[^a-z0-9\-_]/g, '')
+		.replace(/-+/g, '-')
+		.replace(/^-+|-+$/g, '');
+}
+
+/**
+ * Check if a string matches AT Protocol TID format (12–16 base32 characters).
+ */
+export function isTidFormat(str: string): boolean {
+	return /^[a-zA-Z0-9]{12,16}$/.test(str);
+}