@contractspec/lib.contracts 1.49.0 → 1.50.0

package/dist/versioning/refs.d.ts

@@ -0,0 +1,179 @@
+//#region src/versioning/refs.d.ts
+/**
+ * Base reference types for ContractSpec versioning.
+ *
+ * Provides canonical reference types for linking between specs.
+ * Domain-specific refs (OpRef, EventRef, etc.) should alias these
+ * base types for consistency and maintainability.
+ *
+ * @module versioning/refs
+ */
+/**
+ * Base reference type for versioned specs.
+ * Used to reference any spec by its key and version.
+ *
+ * @example
+ * ```typescript
+ * const opRef: VersionedSpecRef = { key: 'auth.login', version: '1.0.0' };
+ * ```
+ */
+interface VersionedSpecRef {
+  /** Unique key identifying the spec (e.g., "auth.login", "user.created"). */
+  key: string;
+  /** Semantic version of the spec (e.g., "1.0.0", "2.1.0"). */
+  version: string;
+}
+/**
+ * Base reference type for specs with optional version.
+ * When version is omitted, typically refers to the latest version.
+ *
+ * @example
+ * ```typescript
+ * // Reference to latest version
+ * const latestRef: OptionalVersionedSpecRef = { key: 'auth.login' };
+ *
+ * // Reference to specific version
+ * const specificRef: OptionalVersionedSpecRef = { key: 'auth.login', version: '1.0.0' };
+ * ```
+ */
+interface OptionalVersionedSpecRef {
+  /** Unique key identifying the spec. */
+  key: string;
+  /** Optional semantic version. When omitted, refers to the latest version. */
+  version?: string;
+}
+/**
+ * Base reference type for unversioned spec keys.
+ * Used when only the key is needed without version information.
+ *
+ * @example
+ * ```typescript
+ * const featureRef: SpecKeyRef = { key: 'premium-features' };
+ * ```
+ */
+interface SpecKeyRef {
+  /** Unique key identifying the spec. */
+  key: string;
+}
+/**
+ * Checks if a value is a valid VersionedSpecRef.
+ *
+ * @param ref - The value to check
+ * @returns True if the value has both key and version as strings
+ *
+ * @example
+ * ```typescript
+ * const ref = { key: 'auth.login', version: '1.0.0' };
+ * if (isVersionedSpecRef(ref)) {
+ *   console.log(`Spec: ${ref.key}@${ref.version}`);
+ * }
+ * ```
+ */
+declare function isVersionedSpecRef(ref: unknown): ref is VersionedSpecRef;
+/**
+ * Checks if a value is a valid OptionalVersionedSpecRef.
+ *
+ * @param ref - The value to check
+ * @returns True if the value has a key string and optional version string
+ *
+ * @example
+ * ```typescript
+ * const ref = { key: 'auth.login' };
+ * if (isOptionalVersionedSpecRef(ref)) {
+ *   console.log(`Spec: ${ref.key}${ref.version ? `@${ref.version}` : ''}`);
+ * }
+ * ```
+ */
+declare function isOptionalVersionedSpecRef(ref: unknown): ref is OptionalVersionedSpecRef;
+/**
+ * Checks if a value is a valid SpecKeyRef.
+ *
+ * @param ref - The value to check
+ * @returns True if the value has a key string
+ *
+ * @example
+ * ```typescript
+ * const ref = { key: 'premium-features' };
+ * if (isSpecKeyRef(ref)) {
+ *   console.log(`Feature: ${ref.key}`);
+ * }
+ * ```
+ */
+declare function isSpecKeyRef(ref: unknown): ref is SpecKeyRef;
+/**
+ * Creates a versioned spec reference.
+ *
+ * @param key - The spec key (e.g., "auth.login")
+ * @param version - The semantic version (e.g., "1.0.0")
+ * @returns A VersionedSpecRef object
+ * @throws {Error} If key or version is empty
+ *
+ * @example
+ * ```typescript
+ * const ref = createVersionedRef('auth.login', '1.0.0');
+ * // { key: 'auth.login', version: '1.0.0' }
+ * ```
+ */
+declare function createVersionedRef(key: string, version: string): VersionedSpecRef;
+/**
+ * Creates an optional versioned spec reference.
+ *
+ * @param key - The spec key (e.g., "auth.login")
+ * @param version - Optional semantic version
+ * @returns An OptionalVersionedSpecRef object
+ * @throws {Error} If key is empty
+ *
+ * @example
+ * ```typescript
+ * // Reference to latest version
+ * const latestRef = createOptionalRef('auth.login');
+ * // { key: 'auth.login' }
+ *
+ * // Reference to specific version
+ * const specificRef = createOptionalRef('auth.login', '1.0.0');
+ * // { key: 'auth.login', version: '1.0.0' }
+ * ```
+ */
+declare function createOptionalRef(key: string, version?: string): OptionalVersionedSpecRef;
+/**
+ * Creates a spec key reference.
+ *
+ * @param key - The spec key (e.g., "premium-features")
+ * @returns A SpecKeyRef object
+ * @throws {Error} If key is empty
+ *
+ * @example
+ * ```typescript
+ * const ref = createKeyRef('premium-features');
+ * // { key: 'premium-features' }
+ * ```
+ */
+declare function createKeyRef(key: string): SpecKeyRef;
+/**
+ * Formats a versioned ref as a string key.
+ *
+ * @param ref - The versioned spec reference
+ * @returns A string in the format "key.vversion"
+ *
+ * @example
+ * ```typescript
+ * const str = formatVersionedRefKey({ key: 'auth.login', version: '1.0.0' });
+ * // "auth.login.v1.0.0"
+ * ```
+ */
+declare function formatVersionedRefKey(ref: VersionedSpecRef): string;
+/**
+ * Parses a versioned ref string back into a ref object.
+ *
+ * @param refKey - A string in the format "key.vversion"
+ * @returns A VersionedSpecRef or undefined if parsing fails
+ *
+ * @example
+ * ```typescript
+ * const ref = parseVersionedRefKey('auth.login.v1.0.0');
+ * // { key: 'auth.login', version: '1.0.0' }
+ * ```
+ */
+declare function parseVersionedRefKey(refKey: string): VersionedSpecRef | undefined;
+//#endregion
+export { OptionalVersionedSpecRef, SpecKeyRef, VersionedSpecRef, createKeyRef, createOptionalRef, createVersionedRef, formatVersionedRefKey, isOptionalVersionedSpecRef, isSpecKeyRef, isVersionedSpecRef, parseVersionedRefKey };

package/dist/versioning/refs.js

@@ -0,0 +1,161 @@
+//#region src/versioning/refs.ts
+/**
+* Checks if a value is a valid VersionedSpecRef.
+*
+* @param ref - The value to check
+* @returns True if the value has both key and version as strings
+*
+* @example
+* ```typescript
+* const ref = { key: 'auth.login', version: '1.0.0' };
+* if (isVersionedSpecRef(ref)) {
+*   console.log(`Spec: ${ref.key}@${ref.version}`);
+* }
+* ```
+*/
+function isVersionedSpecRef(ref) {
+	return typeof ref === "object" && ref !== null && "key" in ref && typeof ref.key === "string" && ref.key.length > 0 && "version" in ref && typeof ref.version === "string" && ref.version.length > 0;
+}
+/**
+* Checks if a value is a valid OptionalVersionedSpecRef.
+*
+* @param ref - The value to check
+* @returns True if the value has a key string and optional version string
+*
+* @example
+* ```typescript
+* const ref = { key: 'auth.login' };
+* if (isOptionalVersionedSpecRef(ref)) {
+*   console.log(`Spec: ${ref.key}${ref.version ? `@${ref.version}` : ''}`);
+* }
+* ```
+*/
+function isOptionalVersionedSpecRef(ref) {
+	if (typeof ref !== "object" || ref === null) return false;
+	if (!("key" in ref)) return false;
+	if (typeof ref.key !== "string" || ref.key.length === 0) return false;
+	if ("version" in ref && ref.version != null) return typeof ref.version === "string";
+	return true;
+}
+/**
+* Checks if a value is a valid SpecKeyRef.
+*
+* @param ref - The value to check
+* @returns True if the value has a key string
+*
+* @example
+* ```typescript
+* const ref = { key: 'premium-features' };
+* if (isSpecKeyRef(ref)) {
+*   console.log(`Feature: ${ref.key}`);
+* }
+* ```
+*/
+function isSpecKeyRef(ref) {
+	return typeof ref === "object" && ref !== null && "key" in ref && typeof ref.key === "string" && ref.key.length > 0;
+}
+/**
+* Creates a versioned spec reference.
+*
+* @param key - The spec key (e.g., "auth.login")
+* @param version - The semantic version (e.g., "1.0.0")
+* @returns A VersionedSpecRef object
+* @throws {Error} If key or version is empty
+*
+* @example
+* ```typescript
+* const ref = createVersionedRef('auth.login', '1.0.0');
+* // { key: 'auth.login', version: '1.0.0' }
+* ```
+*/
+function createVersionedRef(key, version) {
+	if (!key || key.trim().length === 0) throw new Error("Spec key cannot be empty");
+	if (!version || version.trim().length === 0) throw new Error("Spec version cannot be empty");
+	return {
+		key: key.trim(),
+		version: version.trim()
+	};
+}
+/**
+* Creates an optional versioned spec reference.
+*
+* @param key - The spec key (e.g., "auth.login")
+* @param version - Optional semantic version
+* @returns An OptionalVersionedSpecRef object
+* @throws {Error} If key is empty
+*
+* @example
+* ```typescript
+* // Reference to latest version
+* const latestRef = createOptionalRef('auth.login');
+* // { key: 'auth.login' }
+*
+* // Reference to specific version
+* const specificRef = createOptionalRef('auth.login', '1.0.0');
+* // { key: 'auth.login', version: '1.0.0' }
+* ```
+*/
+function createOptionalRef(key, version) {
+	if (!key || key.trim().length === 0) throw new Error("Spec key cannot be empty");
+	const ref = { key: key.trim() };
+	if (version != null && version.trim().length > 0) ref.version = version.trim();
+	return ref;
+}
+/**
+* Creates a spec key reference.
+*
+* @param key - The spec key (e.g., "premium-features")
+* @returns A SpecKeyRef object
+* @throws {Error} If key is empty
+*
+* @example
+* ```typescript
+* const ref = createKeyRef('premium-features');
+* // { key: 'premium-features' }
+* ```
+*/
+function createKeyRef(key) {
+	if (!key || key.trim().length === 0) throw new Error("Spec key cannot be empty");
+	return { key: key.trim() };
+}
+/**
+* Formats a versioned ref as a string key.
+*
+* @param ref - The versioned spec reference
+* @returns A string in the format "key.vversion"
+*
+* @example
+* ```typescript
+* const str = formatVersionedRefKey({ key: 'auth.login', version: '1.0.0' });
+* // "auth.login.v1.0.0"
+* ```
+*/
+function formatVersionedRefKey(ref) {
+	return `${ref.key}.v${ref.version}`;
+}
+/**
+* Parses a versioned ref string back into a ref object.
+*
+* @param refKey - A string in the format "key.vversion"
+* @returns A VersionedSpecRef or undefined if parsing fails
+*
+* @example
+* ```typescript
+* const ref = parseVersionedRefKey('auth.login.v1.0.0');
+* // { key: 'auth.login', version: '1.0.0' }
+* ```
+*/
+function parseVersionedRefKey(refKey) {
+	const match = refKey.match(/^(.+)\.v(\d+\.\d+\.\d+(?:-.+)?)$/);
+	if (!match) return void 0;
+	const key = match[1];
+	const version = match[2];
+	if (!key || !version) return void 0;
+	return {
+		key,
+		version
+	};
+}
+
+//#endregion
+export { createKeyRef, createOptionalRef, createVersionedRef, formatVersionedRefKey, isOptionalVersionedSpecRef, isSpecKeyRef, isVersionedSpecRef, parseVersionedRefKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/lib.contracts",
-  "version": "1.49.0",
+  "version": "1.50.0",
   "description": "Core contract specification definitions and runtime",
   "keywords": [
     "contractspec",
@@ -25,8 +25,8 @@
     "test": "bun test"
   },
   "devDependencies": {
-    "@contractspec/tool.tsdown": "1.49.0",
-    "@contractspec/tool.typescript": "1.49.0",
+    "@contractspec/tool.tsdown": "1.50.0",
+    "@contractspec/tool.typescript": "1.50.0",
     "@types/express": "^5.0.3",
     "@types/turndown": "^5.0.6",
     "tsdown": "^0.19.0",
@@ -35,8 +35,8 @@
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "^3.966.0",
     "@aws-sdk/client-sqs": "^3.966.0",
-    "@contractspec/lib.logger": "1.49.0",
-    "@contractspec/lib.schema": "1.49.0",
+    "@contractspec/lib.logger": "1.50.0",
+    "@contractspec/lib.schema": "1.50.0",
     "@elevenlabs/elevenlabs-js": "^2.30.0",
     "@google-cloud/secret-manager": "^6.1.1",
     "@google-cloud/storage": "^7.18.0",
@@ -339,6 +339,7 @@
     "./translations/tenant": "./dist/translations/tenant.js",
     "./types": "./dist/types.js",
     "./versioning": "./dist/versioning/index.js",
+    "./versioning/refs": "./dist/versioning/refs.js",
     "./versioning/types": "./dist/versioning/types.js",
     "./versioning/utils": "./dist/versioning/utils.js",
     "./workflow": "./dist/workflow/index.js",