@equinor/fusion-framework-module-msal 11.0.0 → 11.0.1

package/src/version.ts

@@ -1,2 +0,0 @@
-// Generated by genversion.
-export const version = '11.0.0';

package/src/versioning/VersionError.ts

@@ -1,64 +0,0 @@
-import type { SemVer } from 'semver';
-
-/**
- * Error class for version-related issues in the MSAL module.
- *
- * This error is thrown when there are version compatibility problems,
- * such as requesting an incompatible major version or providing an invalid version string.
- *
- * @example
- * ```typescript
- * try {
- *   resolveVersion('3.0.0'); // Assuming latest is 2.x
- * } catch (error) {
- *   if (error instanceof VersionError) {
- *     console.error('Version error:', error.message);
- *     console.error('Requested:', error.requestedVersion);
- *     console.error('Latest:', error.latestVersion);
- *     console.error('Type:', error.type);
- *   }
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Create a version error manually
- * const error = VersionError.create(
- *   VersionError.Type.MajorIncompatibility,
- *   '3.0.0',
- *   '2.1.0'
- * );
- * ```
- */
-export class VersionError extends Error {
-  /** The version that was requested by the user */
-  public readonly requestedVersion: string;
-
-  /** The latest available version in the system */
-  public readonly latestVersion: string;
-
-  /** The error name for instanceof checks */
-  static Name = 'VersionError';
-
-  /**
-   * Creates a new VersionError instance.
-   *
-   * @param message - The error message describing the version issue
-   * @param requestedVersion - The version that was requested (will be stored as string)
-   * @param latestVersion - The latest available version (will be stored as string)
-   * @param options - Additional error options including the error type
-   */
-  constructor(
-    message: string,
-    requestedVersion: string | SemVer,
-    latestVersion: string | SemVer,
-    options?: ErrorOptions,
-  ) {
-    super(message, options);
-    this.name = VersionError.Name;
-
-    // Store versions as strings
-    this.requestedVersion = String(requestedVersion);
-    this.latestVersion = String(latestVersion);
-  }
-}

package/src/versioning/index.ts

@@ -1,29 +0,0 @@
-/**
- * @fileoverview Versioning module for MSAL module compatibility checking.
- *
- * This module provides comprehensive version resolution and validation functionality
- * for the MSAL module, ensuring compatibility between different MSAL library versions.
- *
- * @example
- * ```typescript
- * import { resolveVersion, VersionError } from '@equinor/fusion-framework-module-msal/versioning';
- *
- * try {
- *   const result = resolveVersion('2.1.0');
- *   console.log('Version is compatible:', result.satisfiesLatest);
- * } catch (error) {
- *   if (error instanceof VersionError) {
- *     console.error('Version error:', error.message);
- *   }
- * }
- * ```
- */
-
-// Core versioning functionality
-export { resolveVersion } from './resolve-version';
-
-// Error handling
-export { VersionError } from './VersionError';
-
-// Types
-export type { ResolvedVersion } from './types';

package/src/versioning/resolve-version.ts

@@ -1,154 +0,0 @@
-import semver, { type SemVer } from 'semver';
-
-import { MsalModuleVersion } from '../static';
-
-import { VersionError } from './VersionError';
-import type { ResolvedVersion } from './types';
-
-import { version as latestVersionString } from '../version';
-
-/**
- * Maps a version string or object to the corresponding MSAL module enum version.
- *
- * @param version - The version string or SemVer object to map
- * @returns The corresponding MsalModuleVersion enum value
- *
- * @remarks
- * Version mapping logic:
- * - Versions <4.0.0 (including 2.x) → MsalModuleVersion.V2
- * - Versions 4.x → MsalModuleVersion.V4
- * - Versions 5.x → MsalModuleVersion.V5
- * - Versions >=6.0.0 → MsalModuleVersion.V5
- *
- * @example
- * ```typescript
- * mapVersionToEnumVersion('2.39.0') // returns MsalModuleVersion.V2
- * mapVersionToEnumVersion('4.28.1') // returns MsalModuleVersion.V4
- * mapVersionToEnumVersion('5.0.2') // returns MsalModuleVersion.V5
- * mapVersionToEnumVersion('7.0.0') // returns MsalModuleVersion.V5
- * ```
- */
-function mapVersionToEnumVersion(version: string | SemVer): MsalModuleVersion {
-  const coercedVersion = semver.coerce(version);
-  // An uncoercible version string cannot be mapped to a module version
-  if (!coercedVersion) {
-    throw new Error(`Invalid version: ${version}`);
-  }
-  // Versions before 4.0.0 (including 2.x) map to the v2-compatible module version
-  if (semver.satisfies(coercedVersion, '<4.0.0')) {
-    return MsalModuleVersion.V2;
-  }
-  // Versions before 7.0.0 (4.x and 5.x/6.x) map to the v4-compatible module version
-  if (semver.satisfies(coercedVersion, '<7.0.0')) {
-    return MsalModuleVersion.V4;
-  }
-  return MsalModuleVersion.V5;
-}
-
-/**
- * Resolves and validates a version string against the latest available MSAL version.
- *
- * This function performs comprehensive version checking including:
- * - Parsing and validating the requested version
- * - Checking major version compatibility (throws on incompatibility)
- * - Warning on minor version mismatches (logs warning but continues)
- * - Ignoring patch version differences for maximum compatibility
- *
- * @param version - The version string or SemVer object to resolve. If not provided, defaults to latest.
- * @returns A ResolvedVersion object containing parsed versions and compatibility information
- *
- * @throws {VersionError} When the requested version is invalid or incompatible
- *
- * @example
- * ```typescript
- * // Resolve a specific version
- * const result = resolveVersion('2.1.0');
- * console.log(result.satisfiesLatest); // true if major version matches
- *
- * // Resolve with SemVer object
- * const result2 = resolveVersion(new SemVer('2.0.0'));
- *
- * // Default to latest version
- * const result3 = resolveVersion();
- * ```
- *
- * @example
- * ```typescript
- * // Error handling
- * try {
- *   const result = resolveVersion('3.0.0'); // Assuming latest is 2.x
- * } catch (error) {
- *   if (error instanceof VersionError) {
- *     console.error('Version error:', error.message);
- *   }
- * }
- * ```
- */
-export function resolveVersion(version?: string | SemVer): ResolvedVersion {
-  // Initialize warnings array to collect any version mismatches
-  const warnings: string[] = [];
-
-  // Parse the requested version, defaulting to latest if not provided
-  let wantedVersion = version ? semver.coerce(version) : semver.coerce(latestVersionString);
-
-  // Parse versions using coerce for backward compatibility
-  const latestVersion = semver.coerce(latestVersionString);
-
-  // This should never happen! Indicates version.ts was not generated correctly
-  // This is a critical build-time issue that needs immediate attention
-  if (!latestVersion) {
-    throw new VersionError(
-      `Failed to parse latest version "${latestVersionString}" - this indicates the version.ts file was not generated correctly. Check for import errors in the build process.`,
-      wantedVersion || '<unknown version>',
-      latestVersionString,
-    );
-  }
-
-  // Validate that the requested version is a valid semver
-  if (!wantedVersion) {
-    const missingVersionWarning = new VersionError(
-      `Failed to parse requested version "${version ?? '<unknown version>'}"`,
-      version ?? '<unknown version>',
-      latestVersion,
-    );
-    warnings.push(missingVersionWarning.message);
-    wantedVersion = latestVersion;
-  }
-
-  // Warn when the requested major version trails the latest major version
-  if (wantedVersion.major < latestVersion.major) {
-    const majorBehindVersionWarning = new VersionError(
-      `Requested major version ${wantedVersion.major} is behind the latest major version ${latestVersion.major}`,
-      wantedVersion,
-      latestVersion,
-    );
-    warnings.push(majorBehindVersionWarning.message);
-  }
-
-  // Minor version mismatch - add warning but don't throw
-  // This helps developers stay aware of version differences without breaking functionality
-  if (wantedVersion.major === latestVersion.major && wantedVersion.minor !== latestVersion.minor) {
-    const minorMismatchWarning = new VersionError(
-      `Requested minor version ${wantedVersion.minor} is different from the latest minor version ${latestVersion.minor}`,
-      wantedVersion,
-      latestVersion,
-    );
-    warnings.push(minorMismatchWarning.message);
-  }
-
-  // Find the corresponding enum version for the requested major version
-  // This is used for module configuration and feature detection
-  const enumVersion = mapVersionToEnumVersion(wantedVersion);
-
-  // Return comprehensive version resolution result
-  return {
-    wantedVersion,
-    latestVersion,
-    isLatest: wantedVersion.compare(latestVersion) === 0,
-    satisfiesLatest: wantedVersion.major === latestVersion.major,
-    enumVersion,
-    warnings: warnings.length > 0 ? warnings : undefined,
-  } satisfies ResolvedVersion;
-}
-
-export default resolveVersion;

package/src/versioning/types.ts

@@ -1,60 +0,0 @@
-import type { SemVer } from 'semver';
-import type { MsalModuleVersion } from '../static';
-
-/**
- * Result of version resolution containing parsed versions and compatibility information.
- *
- * This type represents the outcome of resolving a version string against the latest
- * available MSAL version, providing detailed compatibility information for consumers.
- *
- * @example
- * ```typescript
- * const result: ResolvedVersion = {
- *   wantedVersion: new SemVer('2.1.0'),
- *   latestVersion: new SemVer('2.2.0'),
- *   isLatest: false,
- *   satisfiesLatest: true,
- *   enumVersion: MsalModuleVersion.V2
- * };
- * ```
- */
-export type ResolvedVersion = {
-  /**
-   * The version that was requested and successfully parsed.
-   * This is the SemVer object representing the user's requested version.
-   */
-  wantedVersion: SemVer;
-
-  /**
-   * The latest available version in the system.
-   * This represents the most recent MSAL version that the module supports.
-   */
-  latestVersion: SemVer;
-
-  /**
-   * Whether the wanted version is exactly the latest version.
-   * True when wantedVersion.compare(latestVersion) === 0
-   */
-  isLatest: boolean;
-
-  /**
-   * Whether the wanted version satisfies the latest major version.
-   * True when major versions match, regardless of minor/patch differences.
-   * This is the primary compatibility check for MSAL versions.
-   */
-  satisfiesLatest: boolean;
-
-  /**
-   * The corresponding enum version for the wanted version.
-   * Maps the major version number to the appropriate MsalModuleVersion enum value.
-   * Used for module configuration and feature detection.
-   */
-  enumVersion: MsalModuleVersion;
-
-  /**
-   * Optional array of warning messages for version mismatches.
-   * Present when there are minor version differences but major versions match.
-   * Consumers can check this field to log warnings or handle version differences.
-   */
-  warnings?: string[];
-};

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist/esm",
-    "rootDir": "src",
-    "declarationDir": "./dist/types"
-  },
-  "references": [
-    {
-      "path": "../module"
-    },
-    {
-      "path": "../telemetry"
-    }
-  ],
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "lib", "dist", "__tests__"]
-}

package/vitest.config.ts

@@ -1,11 +0,0 @@
-import { defineProject } from 'vitest/config';
-
-import { name, version } from './package.json' with { type: 'json' };
-
-export default defineProject({
-  test: {
-    environment: 'node',
-    include: ['src/__tests__/**/*.test.ts'],
-    name: `${name}@${version}`,
-  },
-});