@mui/x-license 9.0.0-alpha.0 → 9.0.0-alpha.2

package/{esm/verifyLicense/verifyLicense.js → verifyLicense/verifyLicense.mjs}

@@ -1,16 +1,9 @@
-import { base64Decode, base64Encode } from "../encoding/base64.js";
-import { md5 } from "../encoding/md5.js";
-import { LICENSE_STATUS } from "../utils/licenseStatus.js";
-import { PLAN_SCOPES } from "../utils/plan.js";
-import { LICENSE_MODELS } from "../utils/licenseModel.js";
-const getDefaultReleaseDate = () => {
-  const today = new Date();
-  today.setHours(0, 0, 0, 0);
-  return today;
-};
-export function generateReleaseInfo(releaseDate = getDefaultReleaseDate()) {
-  return base64Encode(releaseDate.getTime().toString());
-}
+import _formatErrorMessage from "@mui/x-internals/formatErrorMessage";
+import { base64Decode } from "../encoding/base64.mjs";
+import { md5 } from "../encoding/md5.mjs";
+import { LICENSE_STATUS } from "../utils/licenseStatus.mjs";
+import { PLAN_SCOPES } from "../utils/licensePlan.mjs";
+import { LICENSE_MODELS } from "../utils/licenseModel.mjs";
 function isPlanScopeSufficient(packageName, planScope) {
   let acceptedScopes;
   if (packageName.includes('-pro')) {
@@ -46,29 +39,24 @@ function decodeLicenseVersion1(license) {
     orderId = null;
   }
   return {
-    version: 1,
+    keyVersion: 1,
     licenseModel: 'perpetual',
     planScope: 'pro',
     planVersion: 'initial',
     expiryTimestamp,
     expiryDate: expiryTimestamp ? new Date(expiryTimestamp) : null,
-    orderId
+    orderId,
+    appType: 'multi',
+    quantity: null,
+    isTestKey: license.includes('T=true')
   };
 }
 
 /**
- * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},KV=2`;
+ * Parse a comma-separated key=value license string into a NullableLicenseDetails object.
+ * Shared by v2 and v3 decoders.
  */
-function decodeLicenseVersion2(license) {
-  const licenseInfo = {
-    version: 2,
-    licenseModel: null,
-    planScope: null,
-    planVersion: 'initial',
-    expiryTimestamp: null,
-    expiryDate: null,
-    orderId: null
-  };
+export function parseLicenseTokens(license, licenseInfo) {
   license.split(',').map(token => token.split('=')).filter(el => el.length === 2).forEach(([key, value]) => {
     if (key === 'S') {
       licenseInfo.planScope = value;
@@ -92,14 +80,65 @@ function decodeLicenseVersion2(license) {
         licenseInfo.orderId = orderNum;
       }
     }
+    if (key === 'Q') {
+      const qty = parseInt(value, 10);
+      if (qty && !Number.isNaN(qty)) {
+        licenseInfo.quantity = qty;
+      }
+    }
+    if (key === 'AT') {
+      licenseInfo.appType = value;
+    }
+    if (key === 'T') {
+      licenseInfo.isTestKey = value === 'true';
+    }
   });
+}
+
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},KV=2
+ */
+export function decodeLicenseVersion2(license) {
+  const licenseInfo = {
+    keyVersion: 2,
+    licenseModel: null,
+    planScope: null,
+    planVersion: 'initial',
+    expiryTimestamp: null,
+    expiryDate: null,
+    orderId: null,
+    appType: 'multi',
+    quantity: null,
+    isTestKey: false
+  };
+  parseLicenseTokens(license, licenseInfo);
   return licenseInfo;
 }
 
 /**
- * Decode the license based on its key version and return a version-agnostic `MuiLicense` object.
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},Q=${quantity},AT=${appType},KV=3
  */
-function decodeLicense(encodedLicense) {
+export function decodeLicenseVersion3(license) {
+  const licenseInfo = {
+    keyVersion: 3,
+    licenseModel: null,
+    planScope: null,
+    planVersion: 'initial',
+    expiryTimestamp: null,
+    expiryDate: null,
+    orderId: null,
+    appType: null,
+    quantity: null,
+    isTestKey: false
+  };
+  parseLicenseTokens(license, licenseInfo);
+  return licenseInfo;
+}
+
+/**
+ * Decode the license based on its key version and return a version-agnostic `NullableLicenseDetails` object.
+ */
+export function decodeLicense(encodedLicense) {
   const license = base64Decode(encodedLicense);
   if (license.includes('KEYVERSION=1')) {
     return decodeLicenseVersion1(license);
@@ -107,6 +146,9 @@ function decodeLicense(encodedLicense) {
   if (license.includes('KV=2')) {
     return decodeLicenseVersion2(license);
   }
+  if (license.includes('KV=3')) {
+    return decodeLicenseVersion3(license);
+  }
   return null;
 }
 export function verifyLicense({
@@ -114,23 +156,16 @@ export function verifyLicense({
   licenseKey,
   packageName
 }) {
-  // Gets replaced at build time
-  // @ts-ignore
-  if (false) {
-    return {
-      status: LICENSE_STATUS.Valid
-    };
-  }
   if (!releaseInfo) {
-    throw new Error('MUI X: The release information is missing. Not able to validate license.');
+    throw new Error(process.env.NODE_ENV !== "production" ? 'MUI X: The release information is missing and license validation cannot proceed. ' + 'This is an internal error that should not occur in normal usage. ' + 'Please report this issue if you encounter it.' : _formatErrorMessage(188));
   }
   if (!licenseKey) {
     return {
       status: LICENSE_STATUS.NotFound
     };
   }
-  const hash = licenseKey.substr(0, 32);
-  const encoded = licenseKey.substr(32);
+  const hash = licenseKey.slice(0, 32);
+  const encoded = licenseKey.slice(32);
   if (hash !== md5(encoded)) {
     return {
       status: LICENSE_STATUS.Invalid
@@ -143,6 +178,17 @@ export function verifyLicense({
       status: LICENSE_STATUS.Invalid
     };
   }
+
+  // Reject test license keys outside of test environments.
+  // Gets replaced with `false` during production builds, making it impossible
+  // for users of published packages to use test licenses.
+  // @ts-ignore
+  if (license.isTestKey && !false) {
+    console.error('MUI X: Error checking license. Test license key used in a non-test environment!');
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
   if (license.licenseModel == null || !LICENSE_MODELS.includes(license.licenseModel)) {
     console.error('MUI X: Error checking license. License model not found or invalid!');
     return {
@@ -158,7 +204,7 @@ export function verifyLicense({
   if (license.licenseModel === 'perpetual' || process.env.NODE_ENV === 'production') {
     const pkgTimestamp = parseInt(base64Decode(releaseInfo), 10);
     if (Number.isNaN(pkgTimestamp)) {
-      throw new Error('MUI X: The release information is invalid. Not able to validate license.');
+      throw new Error(process.env.NODE_ENV !== "production" ? 'MUI X: The release information is invalid and license validation cannot proceed. ' + 'The package release timestamp could not be parsed. ' + 'This may indicate a corrupted package. Try reinstalling the MUI X packages.' : _formatErrorMessage(189));
     }
     if (license.expiryTimestamp < pkgTimestamp) {
       return {

package/esm/Watermark/index.d.ts

@@ -1 +0,0 @@
-export * from "./Watermark.js";

package/esm/Watermark/index.js

@@ -1 +0,0 @@
-export * from "./Watermark.js";

package/esm/encoding/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./base64.js";
-export * from "./md5.js";

package/esm/encoding/index.js

@@ -1,2 +0,0 @@
-export * from "./base64.js";
-export * from "./md5.js";

package/esm/generateLicense/generateLicense.d.ts

@@ -1,10 +0,0 @@
-import { PlanScope, PlanVersion } from "../utils/plan.js";
-import { LicenseModel } from "../utils/licenseModel.js";
-export interface LicenseDetails {
-  expiryDate: Date;
-  licenseModel?: LicenseModel;
-  orderNumber: string;
-  planScope?: PlanScope;
-  planVersion: PlanVersion;
-}
-export declare function generateLicense(details: LicenseDetails): string;

package/esm/generateLicense/generateLicense.js

@@ -1,19 +0,0 @@
-import { md5 } from "../encoding/md5.js";
-import { base64Encode } from "../encoding/base64.js";
-import { PLAN_SCOPES } from "../utils/plan.js";
-import { LICENSE_MODELS } from "../utils/licenseModel.js";
-const licenseVersion = '2';
-function getClearLicenseString(details) {
-  if (details.planScope && !PLAN_SCOPES.includes(details.planScope)) {
-    throw new Error('MUI X: Invalid scope');
-  }
-  if (details.licenseModel && !LICENSE_MODELS.includes(details.licenseModel)) {
-    throw new Error('MUI X: Invalid licensing model');
-  }
-  const keyParts = [`O=${details.orderNumber}`, `E=${details.expiryDate.getTime()}`, `S=${details.planScope}`, `LM=${details.licenseModel}`, `PV=${details.planVersion}`, `KV=${licenseVersion}`];
-  return keyParts.join(',');
-}
-export function generateLicense(details) {
-  const licenseStr = getClearLicenseString(details);
-  return `${md5(base64Encode(licenseStr))}${base64Encode(licenseStr)}`;
-}

package/esm/generateLicense/index.d.ts

@@ -1 +0,0 @@
-export * from "./generateLicense.js";

package/esm/generateLicense/index.js

@@ -1 +0,0 @@
-export * from "./generateLicense.js";

package/esm/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./generateLicense/index.js";
-export * from "./utils/index.js";
-export * from "./verifyLicense/index.js";
-export * from "./useLicenseVerifier/index.js";
-export * from "./Watermark/index.js";
-export * from "./Unstable_LicenseInfoProvider/index.js";
-export { muiXTelemetrySettings } from '@mui/x-telemetry';

package/esm/index.js

@@ -1,14 +0,0 @@
-/**
- * @mui/x-license v9.0.0-alpha.0
- *
- * @license SEE LICENSE IN LICENSE
- * This source code is licensed under the SEE LICENSE IN LICENSE license found in the
- * LICENSE file in the root directory of this source tree.
- */
-export * from "./generateLicense/index.js";
-export * from "./utils/index.js";
-export * from "./verifyLicense/index.js";
-export * from "./useLicenseVerifier/index.js";
-export * from "./Watermark/index.js";
-export * from "./Unstable_LicenseInfoProvider/index.js";
-export { muiXTelemetrySettings } from '@mui/x-telemetry';

package/esm/package.json

@@ -1 +0,0 @@
-{"type":"module","sideEffects":["./utils/licenseInfo.js","./esm/utils/licenseInfo.js"]}

package/esm/utils/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./licenseErrorMessageUtils.js";
-export * from "./licenseInfo.js";
-export * from "./licenseStatus.js";
-export type { PlanScope } from "./plan.js";
-export type { LicenseModel } from "./licenseModel.js";
-export type { MuiCommercialPackageName } from "./commercialPackages.js";

package/esm/utils/index.js

@@ -1,4 +0,0 @@
-export * from "./licenseErrorMessageUtils.js";
-export * from "./licenseInfo.js";
-export * from "./licenseStatus.js";
-export {};

package/esm/utils/plan.js

@@ -1,2 +0,0 @@
-export const PLAN_SCOPES = ['pro', 'premium'];
-export const PLAN_VERSIONS = ['initial', 'Q3-2024'];

package/esm/verifyLicense/index.d.ts

@@ -1 +0,0 @@
-export * from "./verifyLicense.js";

package/esm/verifyLicense/index.js

@@ -1 +0,0 @@
-export * from "./verifyLicense.js";

package/esm/verifyLicense/verifyLicense.d.ts

@@ -1,15 +0,0 @@
-import { LicenseStatus } from "../utils/licenseStatus.js";
-import { MuiCommercialPackageName } from "../utils/commercialPackages.js";
-export declare function generateReleaseInfo(releaseDate?: Date): string;
-export declare function verifyLicense({
-  releaseInfo,
-  licenseKey,
-  packageName
-}: {
-  releaseInfo: string;
-  licenseKey?: string;
-  packageName: MuiCommercialPackageName;
-}): {
-  status: LicenseStatus;
-  meta?: any;
-};

package/generateLicense/generateLicense.d.ts

@@ -1,10 +0,0 @@
-import { PlanScope, PlanVersion } from "../utils/plan.js";
-import { LicenseModel } from "../utils/licenseModel.js";
-export interface LicenseDetails {
-  expiryDate: Date;
-  licenseModel?: LicenseModel;
-  orderNumber: string;
-  planScope?: PlanScope;
-  planVersion: PlanVersion;
-}
-export declare function generateLicense(details: LicenseDetails): string;

package/generateLicense/generateLicense.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.generateLicense = generateLicense;
-var _md = require("../encoding/md5");
-var _base = require("../encoding/base64");
-var _plan = require("../utils/plan");
-var _licenseModel = require("../utils/licenseModel");
-const licenseVersion = '2';
-function getClearLicenseString(details) {
-  if (details.planScope && !_plan.PLAN_SCOPES.includes(details.planScope)) {
-    throw new Error('MUI X: Invalid scope');
-  }
-  if (details.licenseModel && !_licenseModel.LICENSE_MODELS.includes(details.licenseModel)) {
-    throw new Error('MUI X: Invalid licensing model');
-  }
-  const keyParts = [`O=${details.orderNumber}`, `E=${details.expiryDate.getTime()}`, `S=${details.planScope}`, `LM=${details.licenseModel}`, `PV=${details.planVersion}`, `KV=${licenseVersion}`];
-  return keyParts.join(',');
-}
-function generateLicense(details) {
-  const licenseStr = getClearLicenseString(details);
-  return `${(0, _md.md5)((0, _base.base64Encode)(licenseStr))}${(0, _base.base64Encode)(licenseStr)}`;
-}

package/generateLicense/index.d.ts

@@ -1 +0,0 @@
-export * from "./generateLicense.js";

package/generateLicense/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _generateLicense = require("./generateLicense");
-Object.keys(_generateLicense).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _generateLicense[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _generateLicense[key];
-    }
-  });
-});