@ucdjs/utils 0.2.1-beta.7 → 0.2.1-beta.8

package/README.md

@@ -2,9 +2,10 @@
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![codecov][codecov-src]][codecov-href]
 
-A collection of utility functions and filesystem bridge implementations for the UCD project.
+Curated stable utilities for UCD.js consumers.
+
+This package exposes a small, consumer-safe facade over selected helpers used across the UCD.js ecosystem. More volatile implementation details remain in `@ucdjs-internal/shared`.
 
 ## Installation
 
@@ -12,58 +13,52 @@ A collection of utility functions and filesystem bridge implementations for the
 npm install @ucdjs/utils
 ```
 
-## Usage
-
-### Path Filtering
+## Included utility groups
 
-Creates a filter function that checks if a file path should be included or excluded based on glob patterns.
+- Unicode version helpers
+- API error guards
 
-```typescript
-import { createPathFilter } from "@ucdjs/utils";
+## Usage
 
-const filter = createPathFilter(["*.txt", "!*Test*"]);
-filter("Data.txt"); // true
-filter("DataTest.txt"); // false
-```
+### Unicode version helpers
 
-#### PathFilter Methods
+```ts
+import {
+  getLatestStableUnicodeVersion,
+  isStableUnicodeVersion,
+  isValidUnicodeVersion,
+} from "@ucdjs/utils";
 
-The `PathFilter` object provides additional methods:
+isValidUnicodeVersion("16.0.0"); // true
+isStableUnicodeVersion("16.0.0"); // true
+getLatestStableUnicodeVersion(); // e.g. "16.0.0"
+```
 
-```typescript
-const filter = createPathFilter(["*.js"]);
+### API error guard
 
-// Extend with additional patterns
-filter.extend(["*.ts", "!*.test.*"]);
+```ts
+import { isApiError } from "@ucdjs/utils";
 
-// Get current patterns
-const patterns = filter.patterns(); // ['*.js', '*.ts', '!*.test.*']
+const result: unknown = await fetch("/api").then((r) => r.json());
 
-// Use with extra filters temporarily
-filter("app.js", ["!src/**"]); // Apply extra exclusions
+if (isApiError(result)) {
+  console.error(result.message);
+}
 ```
 
-### Preconfigured Filters
+## Relationship
 
-Pre-defined filter patterns for common exclusions:
+```text
+consumer code
+  -> @ucdjs/utils
+    -> curated public helpers
 
-```typescript
-import { createPathFilter, PRECONFIGURED_FILTERS } from "@ucdjs/utils";
-
-const filter = createPathFilter([
-  "*.txt",
-  PRECONFIGURED_FILTERS.EXCLUDE_TEST_FILES,
-  PRECONFIGURED_FILTERS.EXCLUDE_README_FILES,
-  PRECONFIGURED_FILTERS.EXCLUDE_HTML_FILES
-]);
+internal workspace code
+  -> @ucdjs-internal/shared
+    -> volatile/internal helper families
 ```
 
-Available filters:
-- `EXCLUDE_TEST_FILES`: Excludes files containing "Test" in their name
-- `EXCLUDE_README_FILES`: Excludes ReadMe.txt files
-- `EXCLUDE_HTML_FILES`: Excludes all HTML files
-
-## 📄 License
+## License
 
 Published under [MIT License](./LICENSE).
 
@@ -71,5 +66,3 @@ Published under [MIT License](./LICENSE).
 [npm-version-href]: https://npmjs.com/package/@ucdjs/utils
 [npm-downloads-src]: https://img.shields.io/npm/dm/@ucdjs/utils?style=flat&colorA=18181B&colorB=4169E1
 [npm-downloads-href]: https://npmjs.com/package/@ucdjs/utils
-[codecov-src]: https://img.shields.io/codecov/c/gh/ucdjs/ucd?style=flat&colorA=18181B&colorB=4169E1
-[codecov-href]: https://codecov.io/gh/ucdjs/ucd

package/dist/index.d.mts

@@ -1,6 +1,2 @@
-import { PRECONFIGURED_FILTERS, PathFilter, PathFilterOptions, createPathFilter, filterTreeStructure } from "@ucdjs-internal/shared";
-
-//#region src/index.d.ts
-declare function internal_bingbong(): void;
-//#endregion
-export { PRECONFIGURED_FILTERS, type PathFilter, type PathFilterOptions, createPathFilter, filterTreeStructure, internal_bingbong };
+import { getLatestDraftUnicodeVersion, getLatestStableUnicodeVersion, isApiError, isDraftUnicodeVersion, isStableUnicodeVersion, isValidUnicodeVersion } from "@ucdjs-internal/shared";
+export { getLatestDraftUnicodeVersion, getLatestStableUnicodeVersion, isApiError, isDraftUnicodeVersion, isStableUnicodeVersion, isValidUnicodeVersion };

package/dist/index.mjs

@@ -1,9 +1,2 @@
-import { PRECONFIGURED_FILTERS, createPathFilter, filterTreeStructure } from "@ucdjs-internal/shared";
-
-//#region src/index.ts
-function internal_bingbong() {
-	console.log("Bing Bong");
-}
-
-//#endregion
-export { PRECONFIGURED_FILTERS, createPathFilter, filterTreeStructure, internal_bingbong };
+import { getLatestDraftUnicodeVersion, getLatestStableUnicodeVersion, isApiError, isDraftUnicodeVersion, isStableUnicodeVersion, isValidUnicodeVersion } from "@ucdjs-internal/shared";
+export { getLatestDraftUnicodeVersion, getLatestStableUnicodeVersion, isApiError, isDraftUnicodeVersion, isStableUnicodeVersion, isValidUnicodeVersion };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ucdjs/utils",
-  "version": "0.2.1-beta.7",
+  "version": "0.2.1-beta.8",
   "type": "module",
   "author": {
     "name": "Lucas Nørgård",
@@ -29,15 +29,15 @@
     "node": ">=24.13"
   },
   "dependencies": {
-    "@ucdjs-internal/shared": "0.1.1-beta.7"
+    "@ucdjs-internal/shared": "0.1.1-beta.8"
   },
   "devDependencies": {
-    "@luxass/eslint-config": "7.2.1",
-    "eslint": "10.0.2",
-    "publint": "0.3.17",
-    "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "vitest-testdirs": "4.4.2",
+    "@luxass/eslint-config": "7.4.1",
+    "eslint": "10.1.0",
+    "publint": "0.3.18",
+    "tsdown": "0.21.4",
+    "typescript": "6.0.2",
+    "vitest-testdirs": "4.4.3",
     "@ucdjs-tooling/tsdown-config": "1.0.0",
     "@ucdjs-tooling/tsconfig": "1.0.0"
   },