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

package/utils/commercialPackages.d.ts

@@ -1 +1 @@
-export type MuiCommercialPackageName = 'x-data-grid-pro' | 'x-data-grid-premium' | 'x-date-pickers-pro' | 'x-tree-view-pro' | 'x-charts-pro' | 'x-charts-premium';
+export type MuiCommercialPackageName = 'x-data-grid-pro' | 'x-data-grid-premium' | 'x-date-pickers-pro' | 'x-tree-view-pro' | 'x-charts-pro' | 'x-charts-premium' | 'x-scheduler-premium';

package/utils/index.d.mts

@@ -0,0 +1,8 @@
+export * from "./licenseErrorMessageUtils.mjs";
+export * from "./licenseInfo.mjs";
+export * from "./licenseStatus.mjs";
+export type { AppType } from "./licenseAppType.mjs";
+export type { PlanScope } from "./licensePlan.mjs";
+export type { LicenseModel } from "./licenseModel.mjs";
+export type { KeyVersion, LicenseDetails, NullableLicenseDetails } from "./licenseDetails.mjs";
+export type { MuiCommercialPackageName } from "./commercialPackages.mjs";

package/utils/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./licenseErrorMessageUtils.js";
 export * from "./licenseInfo.js";
 export * from "./licenseStatus.js";
-export type { PlanScope } from "./plan.js";
+export type { AppType } from "./licenseAppType.js";
+export type { PlanScope } from "./licensePlan.js";
 export type { LicenseModel } from "./licenseModel.js";
+export type { KeyVersion, LicenseDetails, NullableLicenseDetails } from "./licenseDetails.js";
 export type { MuiCommercialPackageName } from "./commercialPackages.js";

package/utils/index.mjs

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

package/utils/licenseAppType.d.mts

@@ -0,0 +1,8 @@
+/**
+ * The supported application types for a MUI X license.
+ */
+export declare const APP_TYPES: readonly ["single", "multi"];
+/**
+ * The type of application the license covers.
+ */
+export type AppType = (typeof APP_TYPES)[number];

package/utils/licenseAppType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The supported application types for a MUI X license.
+ */
+export declare const APP_TYPES: readonly ["single", "multi"];
+/**
+ * The type of application the license covers.
+ */
+export type AppType = (typeof APP_TYPES)[number];

package/utils/licenseAppType.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.APP_TYPES = void 0;
+/**
+ * The supported application types for a MUI X license.
+ */
+const APP_TYPES = exports.APP_TYPES = [/** A single application. */
+'single', /** Multiple applications. */
+'multi'];
+
+/**
+ * The type of application the license covers.
+ */

package/utils/licenseAppType.mjs

@@ -0,0 +1,10 @@
+/**
+ * The supported application types for a MUI X license.
+ */
+export const APP_TYPES = [/** A single application. */
+'single', /** Multiple applications. */
+'multi'];
+
+/**
+ * The type of application the license covers.
+ */

package/utils/licenseDetails.d.mts

@@ -0,0 +1,60 @@
+import { AppType } from "./licenseAppType.mjs";
+import { LicenseModel } from "./licenseModel.mjs";
+import { PlanScope, PlanVersion } from "./licensePlan.mjs";
+/**
+ * The version of the license key encoding format.
+ * - `1`: Legacy format.
+ * - `2`: Adds plan scope and license model.
+ * - `3`: Adds quantity and app type.
+ */
+export type KeyVersion = 1 | 2 | 3;
+/**
+ * The details of a MUI X license.
+ */
+export interface LicenseDetails {
+  /**
+   * The type of application the license covers.
+   * - `'single'`: A single application.
+   * - `'multi'`: Multiple applications.
+   * Only available in key version 3+.
+   */
+  appType?: AppType;
+  /**
+   * The date when the license expires.
+   */
+  expiryDate: Date;
+  /**
+   * The timestamp (in milliseconds) when the license expires.
+   */
+  expiryTimestamp: number;
+  /**
+   * The license model.
+   * Only available in key version 2+.
+   */
+  licenseModel?: LicenseModel;
+  /**
+   * The order id associated with the license.
+   */
+  orderId: number;
+  /**
+   * The plan scope (e.g., 'pro' or 'premium').
+   * Only available in key version 2+.
+   */
+  planScope?: PlanScope;
+  /**
+   * The plan version (e.g., 'initial', 'Q3-2024').
+   */
+  planVersion: PlanVersion;
+  /**
+   * The number of developer seats covered by the license.
+   * Only available in key version 3+.
+   */
+  quantity?: number;
+  /**
+   * The version of the license key encoding format.
+   */
+  keyVersion: KeyVersion;
+}
+export type NullableLicenseDetails = { [K in keyof LicenseDetails]: LicenseDetails[K] | null } & {
+  isTestKey: boolean;
+};

package/utils/licenseDetails.d.ts

@@ -0,0 +1,60 @@
+import { AppType } from "./licenseAppType.js";
+import { LicenseModel } from "./licenseModel.js";
+import { PlanScope, PlanVersion } from "./licensePlan.js";
+/**
+ * The version of the license key encoding format.
+ * - `1`: Legacy format.
+ * - `2`: Adds plan scope and license model.
+ * - `3`: Adds quantity and app type.
+ */
+export type KeyVersion = 1 | 2 | 3;
+/**
+ * The details of a MUI X license.
+ */
+export interface LicenseDetails {
+  /**
+   * The type of application the license covers.
+   * - `'single'`: A single application.
+   * - `'multi'`: Multiple applications.
+   * Only available in key version 3+.
+   */
+  appType?: AppType;
+  /**
+   * The date when the license expires.
+   */
+  expiryDate: Date;
+  /**
+   * The timestamp (in milliseconds) when the license expires.
+   */
+  expiryTimestamp: number;
+  /**
+   * The license model.
+   * Only available in key version 2+.
+   */
+  licenseModel?: LicenseModel;
+  /**
+   * The order id associated with the license.
+   */
+  orderId: number;
+  /**
+   * The plan scope (e.g., 'pro' or 'premium').
+   * Only available in key version 2+.
+   */
+  planScope?: PlanScope;
+  /**
+   * The plan version (e.g., 'initial', 'Q3-2024').
+   */
+  planVersion: PlanVersion;
+  /**
+   * The number of developer seats covered by the license.
+   * Only available in key version 3+.
+   */
+  quantity?: number;
+  /**
+   * The version of the license key encoding format.
+   */
+  keyVersion: KeyVersion;
+}
+export type NullableLicenseDetails = { [K in keyof LicenseDetails]: LicenseDetails[K] | null } & {
+  isTestKey: boolean;
+};

package/utils/licenseDetails.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/utils/licenseDetails.mjs

@@ -0,0 +1 @@
+export {};

package/utils/licenseErrorMessageUtils.js

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -10,6 +11,7 @@ exports.showInvalidLicenseKeyError = showInvalidLicenseKeyError;
 exports.showLicenseKeyPlanMismatchError = showLicenseKeyPlanMismatchError;
 exports.showMissingLicenseKeyError = showMissingLicenseKeyError;
 exports.showNotAvailableInInitialProPlanError = showNotAvailableInInitialProPlanError;
+var _formatErrorMessage2 = _interopRequireDefault(require("@mui/x-internals/formatErrorMessage"));
 /**
  * Workaround for the codesadbox preview error.
  *
@@ -60,5 +62,17 @@ function showExpiredAnnualLicenseKeyError({
   licenseKey,
   expiryTimestamp
 }) {
-  throw new Error(['MUI X: Expired license key.', '', `Your annual license key to use MUI X ${plan} in non-production environments has expired. If you are seeing this development console message, you might be close to breach the license terms by making direct or indirect changes to the frontend of an app that render a MUI X ${plan} component (more details in https://mui.com/r/x-license-annual).`, '', 'To solve the problem you can either:', '', '- Renew your license https://mui.com/r/x-get-license and use the new key', `- Stop making changes to code depending directly or indirectly on MUI X ${plan}'s APIs`, '', 'Note that your license is perpetual in production environments with any version released before your license term ends.', '', `- License key expiry timestamp: ${new Date(expiryTimestamp)}`, `- Installed license key: ${licenseKey}`, ''].join('\n'));
+  throw new Error(process.env.NODE_ENV !== "production" ? `MUI X: Expired license key.
+
+Your annual license key to use MUI X ${plan} in non-production environments has expired. If you are seeing this development console message, you might be close to breach the license terms by making direct or indirect changes to the frontend of an app that render a MUI X ${plan} component (more details in https://mui.com/r/x-license-annual).
+
+To solve the problem you can either:
+
+- Renew your license https://mui.com/r/x-get-license and use the new key
+- Stop making changes to code depending directly or indirectly on MUI X ${plan}'s APIs
+
+Note that your license is perpetual in production environments with any version released before your license term ends.
+
+- License key expiry timestamp: ${new Date(expiryTimestamp)}
+- Installed license key: ${licenseKey}` : (0, _formatErrorMessage2.default)(187, plan, plan, plan, new Date(expiryTimestamp), licenseKey));
 }

package/{esm/utils/licenseErrorMessageUtils.js → utils/licenseErrorMessageUtils.mjs}

@@ -1,3 +1,4 @@
+import _formatErrorMessage from "@mui/x-internals/formatErrorMessage";
 /**
  * Workaround for the codesadbox preview error.
  *
@@ -48,5 +49,17 @@ export function showExpiredAnnualLicenseKeyError({
   licenseKey,
   expiryTimestamp
 }) {
-  throw new Error(['MUI X: Expired license key.', '', `Your annual license key to use MUI X ${plan} in non-production environments has expired. If you are seeing this development console message, you might be close to breach the license terms by making direct or indirect changes to the frontend of an app that render a MUI X ${plan} component (more details in https://mui.com/r/x-license-annual).`, '', 'To solve the problem you can either:', '', '- Renew your license https://mui.com/r/x-get-license and use the new key', `- Stop making changes to code depending directly or indirectly on MUI X ${plan}'s APIs`, '', 'Note that your license is perpetual in production environments with any version released before your license term ends.', '', `- License key expiry timestamp: ${new Date(expiryTimestamp)}`, `- Installed license key: ${licenseKey}`, ''].join('\n'));
+  throw new Error(process.env.NODE_ENV !== "production" ? `MUI X: Expired license key.
+
+Your annual license key to use MUI X ${plan} in non-production environments has expired. If you are seeing this development console message, you might be close to breach the license terms by making direct or indirect changes to the frontend of an app that render a MUI X ${plan} component (more details in https://mui.com/r/x-license-annual).
+
+To solve the problem you can either:
+
+- Renew your license https://mui.com/r/x-get-license and use the new key
+- Stop making changes to code depending directly or indirectly on MUI X ${plan}'s APIs
+
+Note that your license is perpetual in production environments with any version released before your license term ends.
+
+- License key expiry timestamp: ${new Date(expiryTimestamp)}
+- Installed license key: ${licenseKey}` : _formatErrorMessage(187, plan, plan, plan, new Date(expiryTimestamp), licenseKey));
 }

package/{esm/utils/plan.d.ts → utils/licensePlan.d.mts}

@@ -1,4 +1,4 @@
 export declare const PLAN_SCOPES: readonly ["pro", "premium"];
-export declare const PLAN_VERSIONS: readonly ["initial", "Q3-2024"];
+export declare const PLAN_VERSIONS: readonly ["initial", "Q3-2024", "Q1-2026"];
 export type PlanScope = (typeof PLAN_SCOPES)[number];
 export type PlanVersion = (typeof PLAN_VERSIONS)[number];

package/utils/{plan.d.ts → licensePlan.d.ts}

@@ -1,4 +1,4 @@
 export declare const PLAN_SCOPES: readonly ["pro", "premium"];
-export declare const PLAN_VERSIONS: readonly ["initial", "Q3-2024"];
+export declare const PLAN_VERSIONS: readonly ["initial", "Q3-2024", "Q1-2026"];
 export type PlanScope = (typeof PLAN_SCOPES)[number];
 export type PlanVersion = (typeof PLAN_VERSIONS)[number];

package/utils/{plan.js → licensePlan.js}

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.PLAN_VERSIONS = exports.PLAN_SCOPES = void 0;
 const PLAN_SCOPES = exports.PLAN_SCOPES = ['pro', 'premium'];
-const PLAN_VERSIONS = exports.PLAN_VERSIONS = ['initial', 'Q3-2024'];
+const PLAN_VERSIONS = exports.PLAN_VERSIONS = ['initial', 'Q3-2024', 'Q1-2026'];

package/utils/licensePlan.mjs

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

package/verifyLicense/index.d.mts

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

package/verifyLicense/index.mjs

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

package/verifyLicense/verifyLicense.d.mts

@@ -0,0 +1,32 @@
+import { LicenseStatus } from "../utils/licenseStatus.mjs";
+import type { NullableLicenseDetails } from "../utils/licenseDetails.mjs";
+import { MuiCommercialPackageName } from "../utils/commercialPackages.mjs";
+/**
+ * Parse a comma-separated key=value license string into a NullableLicenseDetails object.
+ * Shared by v2 and v3 decoders.
+ */
+export declare function parseLicenseTokens(license: string, licenseInfo: NullableLicenseDetails): void;
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},KV=2
+ */
+export declare function decodeLicenseVersion2(license: string): NullableLicenseDetails;
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},Q=${quantity},AT=${appType},KV=3
+ */
+export declare function decodeLicenseVersion3(license: string): NullableLicenseDetails;
+/**
+ * Decode the license based on its key version and return a version-agnostic `NullableLicenseDetails` object.
+ */
+export declare function decodeLicense(encodedLicense: string): NullableLicenseDetails | null;
+export declare function verifyLicense({
+  releaseInfo,
+  licenseKey,
+  packageName
+}: {
+  releaseInfo: string;
+  licenseKey?: string;
+  packageName: MuiCommercialPackageName;
+}): {
+  status: LicenseStatus;
+  meta?: any;
+};

package/verifyLicense/verifyLicense.d.ts

@@ -1,6 +1,23 @@
 import { LicenseStatus } from "../utils/licenseStatus.js";
+import type { NullableLicenseDetails } from "../utils/licenseDetails.js";
 import { MuiCommercialPackageName } from "../utils/commercialPackages.js";
-export declare function generateReleaseInfo(releaseDate?: Date): string;
+/**
+ * Parse a comma-separated key=value license string into a NullableLicenseDetails object.
+ * Shared by v2 and v3 decoders.
+ */
+export declare function parseLicenseTokens(license: string, licenseInfo: NullableLicenseDetails): void;
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},KV=2
+ */
+export declare function decodeLicenseVersion2(license: string): NullableLicenseDetails;
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},Q=${quantity},AT=${appType},KV=3
+ */
+export declare function decodeLicenseVersion3(license: string): NullableLicenseDetails;
+/**
+ * Decode the license based on its key version and return a version-agnostic `NullableLicenseDetails` object.
+ */
+export declare function decodeLicense(encodedLicense: string): NullableLicenseDetails | null;
 export declare function verifyLicense({
   releaseInfo,
   licenseKey,

package/verifyLicense/verifyLicense.js

@@ -1,23 +1,20 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.generateReleaseInfo = generateReleaseInfo;
+exports.decodeLicense = decodeLicense;
+exports.decodeLicenseVersion2 = decodeLicenseVersion2;
+exports.decodeLicenseVersion3 = decodeLicenseVersion3;
+exports.parseLicenseTokens = parseLicenseTokens;
 exports.verifyLicense = verifyLicense;
+var _formatErrorMessage2 = _interopRequireDefault(require("@mui/x-internals/formatErrorMessage"));
 var _base = require("../encoding/base64");
 var _md = require("../encoding/md5");
 var _licenseStatus = require("../utils/licenseStatus");
-var _plan = require("../utils/plan");
+var _licensePlan = require("../utils/licensePlan");
 var _licenseModel = require("../utils/licenseModel");
-const getDefaultReleaseDate = () => {
-  const today = new Date();
-  today.setHours(0, 0, 0, 0);
-  return today;
-};
-function generateReleaseInfo(releaseDate = getDefaultReleaseDate()) {
-  return (0, _base.base64Encode)(releaseDate.getTime().toString());
-}
 function isPlanScopeSufficient(packageName, planScope) {
   let acceptedScopes;
   if (packageName.includes('-pro')) {
@@ -53,29 +50,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
-  };
+function parseLicenseTokens(license, licenseInfo) {
   license.split(',').map(token => token.split('=')).filter(el => el.length === 2).forEach(([key, value]) => {
     if (key === 'S') {
       licenseInfo.planScope = value;
@@ -99,12 +91,63 @@ 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
+ */
+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;
+}
+
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${planScope},LM=${licenseModel},PV=${planVersion},Q=${quantity},AT=${appType},KV=3
+ */
+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 `MuiLicense` object.
+ * Decode the license based on its key version and return a version-agnostic `NullableLicenseDetails` object.
  */
 function decodeLicense(encodedLicense) {
   const license = (0, _base.base64Decode)(encodedLicense);
@@ -114,6 +157,9 @@ function decodeLicense(encodedLicense) {
   if (license.includes('KV=2')) {
     return decodeLicenseVersion2(license);
   }
+  if (license.includes('KV=3')) {
+    return decodeLicenseVersion3(license);
+  }
   return null;
 }
 function verifyLicense({
@@ -121,23 +167,16 @@ function verifyLicense({
   licenseKey,
   packageName
 }) {
-  // Gets replaced at build time
-  // @ts-ignore
-  if (false) {
-    return {
-      status: _licenseStatus.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.' : (0, _formatErrorMessage2.default)(188));
   }
   if (!licenseKey) {
     return {
       status: _licenseStatus.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 !== (0, _md.md5)(encoded)) {
     return {
       status: _licenseStatus.LICENSE_STATUS.Invalid
@@ -150,6 +189,17 @@ function verifyLicense({
       status: _licenseStatus.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: _licenseStatus.LICENSE_STATUS.Invalid
+    };
+  }
   if (license.licenseModel == null || !_licenseModel.LICENSE_MODELS.includes(license.licenseModel)) {
     console.error('MUI X: Error checking license. License model not found or invalid!');
     return {
@@ -165,7 +215,7 @@ function verifyLicense({
   if (license.licenseModel === 'perpetual' || process.env.NODE_ENV === 'production') {
     const pkgTimestamp = parseInt((0, _base.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.' : (0, _formatErrorMessage2.default)(189));
     }
     if (license.expiryTimestamp < pkgTimestamp) {
       return {
@@ -194,7 +244,7 @@ function verifyLicense({
       };
     }
   }
-  if (license.planScope == null || !_plan.PLAN_SCOPES.includes(license.planScope)) {
+  if (license.planScope == null || !_licensePlan.PLAN_SCOPES.includes(license.planScope)) {
     console.error('MUI X: Error checking license. planScope not found or invalid!');
     return {
       status: _licenseStatus.LICENSE_STATUS.Invalid