[x-license] Add support for plan version

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

@@ -9,9 +9,10 @@ describe('License: generateLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  }),
  ).to.equal(
- 'b2b2ea9c6fd846e11770da3c795d6f63Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1zdWJzY3JpcHRpb24sS1Y9Mg==',
+ '076fc290e354b9a04720190023e1f868Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1zdWJzY3JpcHRpb24sUFY9bGVnYWN5LEtWPTI=',
  );
  });
 
@@ -22,9 +23,10 @@ describe('License: generateLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'premium',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  }),
  ).to.equal(
- 'ac8d20b4ecd1f919157f3713f8ba1651Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXByZW1pdW0sTE09c3Vic2NyaXB0aW9uLEtWPTI=',
+ 'fafc52d1dbb97e825702a7ccf5986fbbTz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXByZW1pdW0sTE09c3Vic2NyaXB0aW9uLFBWPWxlZ2FjeSxLVj0y',
  );
  });
 
@@ -35,9 +37,10 @@ describe('License: generateLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  }),
  ).to.equal(
- 'b2b2ea9c6fd846e11770da3c795d6f63Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1zdWJzY3JpcHRpb24sS1Y9Mg==',
+ '076fc290e354b9a04720190023e1f868Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1zdWJzY3JpcHRpb24sUFY9bGVnYWN5LEtWPTI=',
  );
  });
 
@@ -48,9 +51,10 @@ describe('License: generateLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'perpetual',
+ planVersion: 'legacy',
  }),
  ).to.equal(
- 'b16edd8e6bc83293a723779a259f520cTz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1wZXJwZXR1YWwsS1Y9Mg==',
+ 'a32c4d6c8cce5d9ca0132527a252e999Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1wZXJwZXR1YWwsUFY9bGVnYWN5LEtWPTI=',
  );
  });
 });

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

@@ -1,6 +1,6 @@
 import { md5 } from '../encoding/md5';
 import { base64Encode } from '../encoding/base64';
-import { LICENSE_SCOPES, LicenseScope } from '../utils/licenseScope';
+import { LICENSE_SCOPES, LicenseScope, PlanVersion } from '../utils/licenseScope';
 import { LICENSING_MODELS, LicensingModel } from '../utils/licensingModel';
 
 const licenseVersion = '2';
@@ -10,6 +10,7 @@ export interface LicenseDetails {
  expiryDate: Date;
  scope: LicenseScope;
  licensingModel: LicensingModel;
+ planVersion: PlanVersion;
 }
 
 function getClearLicenseString(details: LicenseDetails) {
@@ -21,9 +22,16 @@ function getClearLicenseString(details: LicenseDetails) {
  throw new Error('MUI X: Invalid licensing model');
  }
 
- return `O=${details.orderNumber},E=${details.expiryDate.getTime()},S=${details.scope},LM=${
- details.licensingModel
- },KV=${licenseVersion}`;
+ const keyParts = [
+ `O=${details.orderNumber}`,
+ `E=${details.expiryDate.getTime()}`,
+ `S=${details.scope}`,
+ `LM=${details.licensingModel}`,
+ `PV=${details.planVersion}`,
+ `KV=${licenseVersion}`,
+ ];
+
+ return keyParts.join(',');
 }
 
 export function generateLicense(details: LicenseDetails) {

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

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

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

@@ -1,3 +1,20 @@
 export const LICENSE_SCOPES = ['pro', 'premium'] as const;
+export const PRODUCT_SCOPES = ['data-grid', 'date-pickers', 'charts', 'tree-view', null] as const;
+export const PLAN_VERSIONS = ['legacy', 'Q3-2024'] as const;
 
 export type LicenseScope = (typeof LICENSE_SCOPES)[number];
+export type ProductScope = (typeof PRODUCT_SCOPES)[number];
+export type PlanVersion = (typeof PLAN_VERSIONS)[number];
+
+export const extractProductScope = (packageName: string): ProductScope => {
+ // extract the part between "x-" and "-pro"/"-premium"
+ const regex = /x-(.*?)(-pro|-premium)?$/;
+ const match = packageName.match(regex);
+ return match ? (match[1] as ProductScope) : null;
+};
+
+export const extractAcceptedScopes = (packageName: string): readonly LicenseScope[] => {
+ return packageName.includes('premium')
+ ? LICENSE_SCOPES.filter((scope) => scope.includes('premium'))
+ : LICENSE_SCOPES;
+};

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

@@ -53,6 +53,7 @@ describe('License: verifyLicense', () => {
  scope: 'pro',
  licensingModel: 'perpetual',
  orderNumber: 'MUI-123',
+ planVersion: 'legacy',
  });
 
  expect(
@@ -83,13 +84,15 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  });
 
  const licenseKeyPremium = generateLicense({
  expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
  orderNumber: 'MUI-123',
  scope: 'premium',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  });
 
  it('should log an error when ReleaseInfo is not valid', () => {
@@ -147,6 +150,7 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  });
 
  expect(
@@ -164,6 +168,7 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  });
 
  expect(
@@ -182,6 +187,7 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'subscription',
+ planVersion: 'legacy',
  });
 
  expect(
@@ -199,6 +205,7 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'perpetual',
+ planVersion: 'legacy',
  });
 
  expect(
@@ -230,6 +237,7 @@ describe('License: verifyLicense', () => {
  orderNumber: 'MUI-123',
  scope: 'pro',
  licensingModel: 'annual',
+ planVersion: 'legacy',
  });
 
  it('should accept licensingModel="annual"', () => {

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

@@ -1,7 +1,7 @@
 import { base64Decode, base64Encode } from '../encoding/base64';
 import { md5 } from '../encoding/md5';
 import { LICENSE_STATUS, LicenseStatus } from '../utils/licenseStatus';
-import { LicenseScope, LICENSE_SCOPES } from '../utils/licenseScope';
+import { LicenseScope, LICENSE_SCOPES, ProductScope, PlanVersion } from '../utils/licenseScope';
 import { LicensingModel, LICENSING_MODELS } from '../utils/licensingModel';
 
 const getDefaultReleaseDate = () => {
@@ -21,6 +21,7 @@ interface MuiLicense {
  licensingModel: LicensingModel | null;
  scope: LicenseScope | null;
  expiryTimestamp: number | null;
+ planVersion?: PlanVersion | null;
 }
 
 /**
@@ -45,7 +46,7 @@ const decodeLicenseVersion1 = (license: string): MuiLicense => {
 };
 
 /**
- * Format: O=${orderNumber},E=${expiryTimestamp},S=${scope},LM=${licensingModel},KV=2`;
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${scope},LM=${licensingModel},PV=${planVersion},KV=2`;
  */
 const decodeLicenseVersion2 = (license: string): MuiLicense => {
  const licenseInfo: MuiLicense = {
@@ -73,6 +74,10 @@ const decodeLicenseVersion2 = (license: string): MuiLicense => {
  licenseInfo.expiryTimestamp = expiryTimestamp;
  }
  }
+
+ if (key === 'PV') {
+ licenseInfo.planVersion = value as PlanVersion;
+ }
  });
 
  return licenseInfo;
@@ -99,10 +104,12 @@ export function verifyLicense({
  releaseInfo,
  licenseKey,
  acceptedScopes,
+ productScope = null,
 }: {
  releaseInfo: string;
  licenseKey: string | undefined;
- acceptedScopes: LicenseScope[];
+ acceptedScopes: readonly LicenseScope[];
+ productScope?: ProductScope;
 }): { status: LicenseStatus; meta?: any } {
  if (!releaseInfo) {
  throw new Error('MUI X: The release information is missing. Not able to validate license.');
@@ -169,6 +176,15 @@ export function verifyLicense({
  return { status: LICENSE_STATUS.Invalid };
  }
 
+ // 'legacy' is only available for licenses ordered between 2024-06-20 and 2024-07-20
+ if (!license.planVersion || license.planVersion === 'legacy') {
+ // check if the productScope is 'charts' or 'tree-view'
+ if (productScope === 'charts' || productScope === 'tree-view') {
+ console.error('Error checking license. Plan version not found or invalid!');
+ return { status: LICENSE_STATUS.OutOfScope };
+ }
+ }
+
  if (!acceptedScopes.includes(license.scope)) {
  return { status: LICENSE_STATUS.OutOfScope };
  }