@wemush/wols 0.1.0 → 1.3.0

package/dist/types/utils/environment.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Environment Detection Utilities
+ *
+ * This module provides runtime environment detection for selecting
+ * appropriate crypto implementations and other environment-specific behavior.
+ *
+ * @module utils/environment
+ * @since 1.2.0
+ */
+/**
+ * Runtime environment type.
+ *
+ * @since 1.2.0
+ */
+export type RuntimeEnvironment = 'node' | 'browser' | 'webworker' | 'deno' | 'bun' | 'unknown';
+/**
+ * Check if running in a server-side Node.js environment.
+ *
+ * @returns True if running in Node.js, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isServer()) {
+ *   // Use Node.js crypto module
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function isServer(): boolean;
+/**
+ * Check if running in a browser environment.
+ *
+ * @returns True if running in a browser, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isBrowser()) {
+ *   // Use Web Crypto API
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function isBrowser(): boolean;
+/**
+ * Check if running in a Web Worker environment.
+ *
+ * @returns True if running in a Web Worker, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function isWebWorker(): boolean;
+/**
+ * Check if running in Deno environment.
+ *
+ * @returns True if running in Deno, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function isDeno(): boolean;
+/**
+ * Check if running in Bun environment.
+ *
+ * @returns True if running in Bun, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function isBun(): boolean;
+/**
+ * Get the current runtime environment.
+ *
+ * @returns The detected runtime environment
+ *
+ * @example
+ * ```typescript
+ * const env = getRuntimeEnvironment();
+ * console.log(`Running in: ${env}`);
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function getRuntimeEnvironment(): RuntimeEnvironment;
+/**
+ * Check if Web Crypto API is available.
+ *
+ * @returns True if Web Crypto API is available, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function supportsWebCrypto(): boolean;
+/**
+ * Check if Node.js crypto module is available.
+ *
+ * Note: This performs a synchronous check and does not actually import the module.
+ *
+ * @returns True if likely running in Node.js with crypto support, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function supportsNodeCrypto(): boolean;
+/**
+ * Check if any cryptographic support is available.
+ *
+ * This is useful for determining if encryption/decryption features can be used.
+ *
+ * @returns True if crypto is supported, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isCryptoSupported()) {
+ *   const encrypted = await encryptSpecimen(specimen, { key: password });
+ * } else {
+ *   console.warn('Crypto not supported in this environment');
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function isCryptoSupported(): boolean;
+/**
+ * Check if TextEncoder/TextDecoder are available.
+ *
+ * @returns True if text encoding is supported, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function supportsTextEncoding(): boolean;
+/**
+ * Check if URL and URLSearchParams are available.
+ *
+ * @returns True if URL APIs are supported, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function supportsURLAPIs(): boolean;
+//# sourceMappingURL=environment.d.ts.map

package/dist/types/utils/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/utils/environment.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;AAM/F;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAMlC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAkBrC;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,IAAI,OAAO,CAKhC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAK/B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,IAAI,kBAAkB,CAO1D;AAMD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAM3C;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAE5C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAMD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAM9C;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAMzC"}

package/dist/types/utils/migration.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Version Migration Utilities
+ *
+ * This module provides utilities for comparing WOLS versions and
+ * migrating specimens between versions.
+ *
+ * @module utils/migration
+ * @since 1.2.0
+ */
+import type { Specimen } from '../types.js';
+/**
+ * Version comparison result.
+ *
+ * - `-1`: First version is older than second
+ * - `0`: Versions are equal
+ * - `1`: First version is newer than second
+ *
+ * @since 1.2.0
+ */
+export type VersionComparison = -1 | 0 | 1;
+/**
+ * Migration handler function signature.
+ *
+ * @since 1.2.0
+ */
+export type MigrationHandler = (specimen: Specimen) => Specimen;
+/**
+ * Migration definition.
+ *
+ * @since 1.2.0
+ */
+interface MigrationDefinition {
+    from: string;
+    to: string;
+    handler: MigrationHandler;
+}
+/**
+ * Compare two semantic versions.
+ *
+ * @param a - First version string
+ * @param b - Second version string
+ * @returns -1 if a < b, 0 if a === b, 1 if a > b
+ *
+ * @example
+ * ```typescript
+ * compareVersions('1.0.0', '1.1.0') // Returns -1
+ * compareVersions('1.1.0', '1.1.0') // Returns 0
+ * compareVersions('2.0.0', '1.9.0') // Returns 1
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function compareVersions(a: string, b: string): VersionComparison;
+/**
+ * Check if a specimen is using an outdated WOLS version.
+ *
+ * @param specimen - Specimen object or version string
+ * @returns True if the specimen version is older than current library version
+ *
+ * @example
+ * ```typescript
+ * isOutdated(specimen) // True if specimen.version < WOLS_VERSION
+ * isOutdated('1.0.0')  // True (older than current)
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function isOutdated(specimen: Specimen | string): boolean;
+/**
+ * Check if a specimen is using a newer WOLS version than this library.
+ *
+ * This can happen when specimens are created by a newer library version.
+ *
+ * @param specimen - Specimen object or version string
+ * @returns True if the specimen version is newer than current library version
+ *
+ * @example
+ * ```typescript
+ * isNewer(specimen)  // True if specimen.version > WOLS_VERSION
+ * isNewer('2.0.0')   // True if library is 1.x
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function isNewer(specimen: Specimen | string): boolean;
+/**
+ * Get the current library WOLS version.
+ *
+ * @returns The WOLS version this library implements
+ *
+ * @since 1.2.0
+ */
+export declare function getCurrentVersion(): string;
+/**
+ * Register a migration handler for upgrading specimens between versions.
+ *
+ * Migrations are applied in order from oldest to newest when calling `migrate()`.
+ *
+ * @param from - Source version (e.g., "1.0.0")
+ * @param to - Target version (e.g., "1.1.0")
+ * @param handler - Function to transform the specimen
+ *
+ * @example
+ * ```typescript
+ * registerMigration('1.0.0', '1.1.0', (specimen) => {
+ *   // Add new required field with default value
+ *   return { ...specimen, newField: 'default' };
+ * });
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function registerMigration(from: string, to: string, handler: MigrationHandler): void;
+/**
+ * Check if a specimen can be migrated to the current version.
+ *
+ * @param specimen - Specimen to check
+ * @returns True if migration path exists, false otherwise
+ *
+ * @since 1.2.0
+ */
+export declare function canMigrate(specimen: Specimen): boolean;
+/**
+ * Migrate a specimen to the current WOLS version.
+ *
+ * Applies all registered migrations in order from the specimen's version
+ * to the current library version.
+ *
+ * @param specimen - Specimen to migrate
+ * @returns Migrated specimen with updated version
+ * @throws Error if no migration path exists
+ *
+ * @example
+ * ```typescript
+ * const oldSpecimen = parseSpecimen(oldJson);
+ * if (isOutdated(oldSpecimen)) {
+ *   const updated = migrate(oldSpecimen);
+ *   console.log('Migrated to:', updated.version);
+ * }
+ * ```
+ *
+ * @since 1.2.0
+ */
+export declare function migrate(specimen: Specimen): Specimen;
+/**
+ * Get all registered migrations.
+ *
+ * @returns Array of migration definitions
+ *
+ * @since 1.2.0
+ */
+export declare function getMigrations(): readonly MigrationDefinition[];
+/**
+ * Clear all registered migrations.
+ *
+ * Primarily useful for testing.
+ *
+ * @since 1.2.0
+ */
+export declare function clearMigrations(): void;
+export {};
+//# sourceMappingURL=migration.d.ts.map

package/dist/types/utils/migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/utils/migration.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAO5C;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC;AAEhE;;;;GAIG;AACH,UAAU,mBAAmB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAgCD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAmBvE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAG/D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAG5D;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAMD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAK3F;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAiBtD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAiCpD;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,SAAS,mBAAmB,EAAE,CAE9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,IAAI,IAAI,CAEtC"}

package/dist/types/validator.d.ts

@@ -7,7 +7,7 @@
  */
 import { type Specimen, type ValidationOptions, type ValidationResult } from './types.js';
 /**
- * Validate a specimen object against the WOLS v1.1.0 schema.
+ * Validate a specimen object against the WOLS v1.3.0 schema.
  *
  * @param specimen - The specimen object to validate
  * @param options - Validation options

package/dist/types/validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validator.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAGL,KAAK,QAAQ,EAGb,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,YAAY,CAAC;AAmZpB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,GAAG,OAAO,EAC5B,OAAO,GAAE,iBAAsB,GAC9B,gBAAgB,CA+ClB"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validator.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAIL,KAAK,QAAQ,EAGb,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,YAAY,CAAC;AA4fpB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,GAAG,OAAO,EAC5B,OAAO,GAAE,iBAAsB,GAC9B,gBAAgB,CAgDlB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wemush/wols",
-  "version": "0.1.0",
+  "version": "1.3.0",
   "description": "Official WOLS (WeMush Open Labeling Standard) library for specimen labeling and traceability",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -8,19 +8,34 @@
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/types/index.d.ts"
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     },
     "./qr": {
-      "import": "./dist/esm/qr/index.js",
-      "require": "./dist/cjs/qr/index.js",
-      "types": "./dist/types/qr/index.d.ts"
+      "import": {
+        "types": "./dist/types/qr/index.d.ts",
+        "default": "./dist/esm/qr/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/qr/index.d.ts",
+        "default": "./dist/cjs/qr/index.js"
+      }
     },
     "./crypto": {
-      "import": "./dist/esm/crypto/index.js",
-      "require": "./dist/cjs/crypto/index.js",
-      "types": "./dist/types/crypto/index.d.ts"
+      "import": {
+        "types": "./dist/types/crypto/index.d.ts",
+        "default": "./dist/esm/crypto/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/crypto/index.d.ts",
+        "default": "./dist/cjs/crypto/index.js"
+      }
     }
   },
   "files": [
@@ -32,18 +47,21 @@
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs && npm run build:types",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node scripts/write-cjs-package.mjs",
     "build:types": "tsc -p tsconfig.types.json",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
+    "test:conformance": "vitest run tests/conformance",
+    "conformance:update": "node scripts/update-conformance-vectors.mjs",
     "lint": "eslint src --ext .ts",
     "lint:fix": "eslint src --ext .ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",
     "typecheck": "tsc --noEmit",
     "bench": "vitest bench",
-    "prepublishOnly": "npm run build && npm test",
-    "clean": "rm -rf dist"
+    "prepublishOnly": "npm run build && npm test && npm run test:package",
+    "clean": "rm -rf dist",
+    "test:package": "node scripts/smoke-package.mjs"
   },
   "keywords": [
     "wols",
@@ -68,7 +86,7 @@
   },
   "homepage": "https://wemush.com/open-standard",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "peerDependencies": {
     "qrcode": ""