[x-license] Add support for plan version

packages/x-license/src/generateLicense/generateLicense.ts

@@ -1,4 +1,3 @@
-import { LICENSE_UPDATE_TIMESTAMPS } from '@mui/x-license/generateLicense/licenseUpdateTimestamps';
 import { md5 } from '../encoding/md5';
 import { base64Encode } from '../encoding/base64';
 import { LICENSE_SCOPES, LicenseScope } from '../utils/licenseScope';
@@ -9,7 +8,6 @@ const licenseVersion = '2';
 export interface LicenseDetails {
  orderNumber: string;
  expiryDate: Date;
- purchaseDate?: Date;
  scope: LicenseScope;
  licensingModel: LicensingModel;
 }
@@ -23,23 +21,9 @@ function getClearLicenseString(details: LicenseDetails) {
  throw new Error('MUI X: Invalid licensing model');
  }
 
- if (!details.purchaseDate || new Date().getTime() < LICENSE_UPDATE_TIMESTAMPS['2024-07']) {
- throw new Error('MUI X: Licenses generated without a purchaseDate are not supported');
- }
-
- const parts = [
- `O=${details.orderNumber}`,
- `E=${details.expiryDate.getTime()}`,
- `S=${details.scope}`,
- `LM=${details.licensingModel}`,
- `KV=${licenseVersion}`,
- ];
-
- if (details.purchaseDate) {
- parts.splice(1, 0, `P=${details.purchaseDate.getTime()}`);
- }
-
- return parts.join(',');
+ return `O=${details.orderNumber},E=${details.expiryDate.getTime()},S=${details.scope},LM=${
+ details.licensingModel
+ },KV=${licenseVersion}`;
 }
 
 export function generateLicense(details: LicenseDetails) {

packages/x-license/src/useLicenseVerifier/useLicenseVerifier.ts

@@ -10,7 +10,7 @@ import {
  showExpiredPackageVersionError,
 } from '../utils/licenseErrorMessageUtils';
 import { LICENSE_STATUS, LicenseStatus } from '../utils/licenseStatus';
-import { LicenseScope } from '../utils/licenseScope';
+import { extractAcceptedScopes, LicenseScope } from '../utils/licenseScope';
 import MuiLicenseInfoContext from '../Unstable_LicenseInfoProvider/MuiLicenseInfoContext';
 
 export type MuiCommercialPackageName =
@@ -47,16 +47,13 @@ export function useLicenseVerifier(
  return sharedLicenseStatuses[packageName]!.licenseVerifier;
  }
 
- const acceptedScopes: LicenseScope[] = packageName.includes('premium')
- ? ['premium']
- : ['pro', 'premium'];
+ const acceptedScopes: readonly LicenseScope[] = extractAcceptedScopes(packageName);
 
  const plan = packageName.includes('premium') ? 'Premium' : 'Pro';
  const licenseStatus = verifyLicense({
  releaseInfo,
  licenseKey,
  acceptedScopes,
- packageName,
  });
 
  const fullPackageName = `@mui/${packageName}`;

packages/x-license/src/utils/licenseScope.ts

@@ -1,5 +1,24 @@
-export const LICENSE_SCOPES = ['pro', 'premium'] as const;
+export const LICENSE_SCOPES = ['pro', 'premium', 'pro2024', 'premium2024'] as const;
 export const PRODUCT_SCOPES = ['data-grid', 'date-pickers', 'charts', 'tree-view'] as const;
 
 export type LicenseScope = (typeof LICENSE_SCOPES)[number];
-export type ProductScope = (typeof PRODUCT_SCOPES)[number];
+export type ProductScope = (typeof PRODUCT_SCOPES)[number] | null;
+
+export const extractProductScope = (packageName: string): ProductScope | null => {
+ const regex = /x-(.*?)(-pro|-premium)?$/;
+ const match = packageName.match(regex);
+ return match ? (match[1] as ProductScope) : null;
+};
+
+export const extractAcceptedScopes = (packageName: string): readonly LicenseScope[] => {
+ const productScope = extractProductScope(packageName);
+
+ const scopes = packageName.includes('premium')
+ ? LICENSE_SCOPES.filter((scope) => scope.includes('premium'))
+ : LICENSE_SCOPES;
+
+ if (productScope === 'charts' || productScope === 'tree-view') {
+ return scopes.filter((scope) => scope.includes('2024'));
+ }
+ return scopes;
+};

packages/x-license/src/utils/licenseStatus.ts

@@ -7,7 +7,6 @@ export enum LICENSE_STATUS {
  ExpiredVersion = 'ExpiredVersion',
  Valid = 'Valid',
  OutOfScope = 'OutOfScope',
- ProductScope = 'ProductScope',
 }
 
 export type LicenseStatus = keyof typeof LICENSE_STATUS;

packages/x-license/src/verifyLicense/verifyLicense.ts

@@ -1,8 +1,7 @@
-import { LICENSE_UPDATE_TIMESTAMPS } from '@mui/x-license/generateLicense/licenseUpdateTimestamps';
 import { base64Decode, base64Encode } from '../encoding/base64';
 import { md5 } from '../encoding/md5';
 import { LICENSE_STATUS, LicenseStatus } from '../utils/licenseStatus';
-import { LicenseScope, LICENSE_SCOPES, ProductScope } from '../utils/licenseScope';
+import { LicenseScope, LICENSE_SCOPES } from '../utils/licenseScope';
 import { LicensingModel, LICENSING_MODELS } from '../utils/licensingModel';
 
 const getDefaultReleaseDate = () => {
@@ -22,7 +21,6 @@ interface MuiLicense {
  licensingModel: LicensingModel | null;
  scope: LicenseScope | null;
  expiryTimestamp: number | null;
- purchaseTimestamp?: number | null;
 }
 
 /**
@@ -47,8 +45,7 @@ const decodeLicenseVersion1 = (license: string): MuiLicense => {
 };
 
 /**
- * Format: O=${orderNumber}[,P=${purchaseTimestamp}],E=${expiryTimestamp},S=${scope},LM=${licensingModel},KV=2`;
- * purchaseTimestamp is optional.
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${scope},LM=${licensingModel},KV=2`;
  */
 const decodeLicenseVersion2 = (license: string): MuiLicense => {
  const licenseInfo: MuiLicense = {
@@ -76,13 +73,6 @@ const decodeLicenseVersion2 = (license: string): MuiLicense => {
  licenseInfo.expiryTimestamp = expiryTimestamp;
  }
  }
-
- if (key === 'P') {
- const purchaseTimestamp = parseInt(value, 10);
- if (purchaseTimestamp && !Number.isNaN(purchaseTimestamp)) {
- licenseInfo.purchaseTimestamp = purchaseTimestamp;
- }
- }
  });
 
  return licenseInfo;
@@ -105,22 +95,14 @@ const decodeLicense = (encodedLicense: string): MuiLicense | null => {
  return null;
 };
 
-const extractProductScope = (packageName: string): ProductScope | null => {
- const regex = /x-(.*?)(-pro|-premium)?$/;
- const match = packageName.match(regex);
- return match ? (match[1] as ProductScope) : null;
-};
-
 export function verifyLicense({
  releaseInfo,
  licenseKey,
  acceptedScopes,
- packageName,
 }: {
  releaseInfo: string;
  licenseKey: string | undefined;
- acceptedScopes: LicenseScope[];
- packageName: string;
+ acceptedScopes: readonly LicenseScope[];
 }): { status: LicenseStatus; meta?: any } {
  if (!releaseInfo) {
  throw new Error('MUI X: The release information is missing. Not able to validate license.');
@@ -154,11 +136,6 @@ export function verifyLicense({
  return { status: LICENSE_STATUS.Invalid };
  }
 
- if (license.purchaseTimestamp && license.purchaseTimestamp > license.expiryTimestamp) {
- console.error('MUI X: Error checking license. Purchase timestamp cannot be later than expiry!');
- return { status: LICENSE_STATUS.Invalid };
- }
-
  if (license.licensingModel === 'perpetual' || process.env.NODE_ENV === 'production') {
  const pkgTimestamp = parseInt(base64Decode(releaseInfo), 10);
  if (Number.isNaN(pkgTimestamp)) {
@@ -196,28 +173,5 @@ export function verifyLicense({
  return { status: LICENSE_STATUS.OutOfScope };
  }
 
- if (packageName) {
- const productScope = extractProductScope(packageName);
-
- switch (productScope) {
- case 'charts':
- case 'tree-view':
- if (
- license.purchaseTimestamp &&
- license.purchaseTimestamp >= LICENSE_UPDATE_TIMESTAMPS['2024-06']
- ) {
- // NEW LICENSE
- // therefore usage of charts-pro and tree-view-pro is allowed
- break;
- }
-
- return { status: LICENSE_STATUS.ProductScope };
- case 'data-grid':
- case 'date-pickers':
- default:
- break;
- }
- }
-
  return { status: LICENSE_STATUS.Valid };
 }