[license] Clean-up terminology to match codebase (mui#14531)

packages/x-data-grid-premium/src/tests/license.DataGridPremium.test.tsx

@@ -13,7 +13,7 @@ describe('<DataGridPremium /> - License', () => {
       generateLicense({
         expiryDate: addYears(new Date(), 1),
         orderNumber: 'Test',
-        licensingModel: 'subscription',
+        licenseModel: 'subscription',
         scope: 'pro',
         planVersion: 'initial',
       }),

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

@@ -7,8 +7,8 @@ describe('License: generateLicense', () => {
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'initial',
       }),
     ).to.equal(
@@ -21,36 +21,36 @@ describe('License: generateLicense', () => {
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'premium',
-        licensingModel: 'subscription',
+        planScope: 'premium',
+        licenseModel: 'subscription',
         planVersion: 'initial',
       }),
     ).to.equal(
       '8ca0384bfb92ec214d4cd72483f5110bTz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXByZW1pdW0sTE09c3Vic2NyaXB0aW9uLFBWPWluaXRpYWwsS1Y9Mg==',
     );
   });
 
-  it('should generate annual license when `licensingModel: "subscription"`', () => {
+  it('should generate annual license when `licenseModel: "subscription"`', () => {
     expect(
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'initial',
       }),
     ).to.equal(
       'e8fad422a82720084ec67dd693f08056Tz1NVUktMTIzLEU9MTU5MTcyMzg3OTA2MixTPXBybyxMTT1zdWJzY3JpcHRpb24sUFY9aW5pdGlhbCxLVj0y',
     );
   });
 
-  it('should generate perpetual license when `licensingModel: "perpetual"`', () => {
+  it('should generate perpetual license when `licenseModel: "perpetual"`', () => {
     expect(
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'perpetual',
+        planScope: 'pro',
+        licenseModel: 'perpetual',
         planVersion: 'initial',
       }),
     ).to.equal(
@@ -63,8 +63,8 @@ describe('License: generateLicense', () => {
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'Q3-2024',
       }),
     ).to.equal(
@@ -77,8 +77,8 @@ describe('License: generateLicense', () => {
       generateLicense({
         expiryDate: new Date(1591723879062),
         orderNumber: 'MUI-123',
-        scope: 'premium',
-        licensingModel: 'subscription',
+        planScope: 'premium',
+        licenseModel: 'subscription',
         planVersion: 'Q3-2024',
       }),
     ).to.equal(

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

@@ -1,17 +1,23 @@
 import { md5 } from '../encoding/md5';
 import { base64Encode } from '../encoding/base64';
-import { LICENSE_SCOPES, LicenseScope, PlanVersion } from '../utils/licenseScope';
-import { LICENSING_MODELS, LicensingModel } from '../utils/licensingModel';
+import { PLAN_SCOPES, PlanScope, PlanVersion } from '../utils/plan';
+import { LICENSE_MODELS, LicenseModel } from '../utils/licenseModel';
 
 const licenseVersion = '2';
 
 export interface LicenseDetails {
   orderNumber: string;
   expiryDate: Date;
-  scope?: LicenseScope;
-  planScope?: LicenseScope; // TODO deprecate
-  licenseModel?: LicensingModel;
-  licensingModel?: LicensingModel; // TODO deprecate
+  /**
+   * @deprecated Use planScope instead.
+   */
+  scope?: PlanScope;
+  planScope?: PlanScope;
+  /**
+   * @deprecated Use licenseModel instead.
+   */
+  licensingModel?: LicenseModel; // TODO deprecate
+  licenseModel?: LicenseModel;
   planVersion: PlanVersion;
 }
 
@@ -25,11 +31,11 @@ function getClearLicenseString(details: LicenseDetails) {
     details.planScope = details.scope;
   }
 
-  if (details.planScope && !LICENSE_SCOPES.includes(details.planScope)) {
+  if (details.planScope && !PLAN_SCOPES.includes(details.planScope)) {
     throw new Error('MUI X: Invalid scope');
   }
 
-  if (details.licenseModel && !LICENSING_MODELS.includes(details.licenseModel)) {
+  if (details.licenseModel && !LICENSE_MODELS.includes(details.licenseModel)) {
     throw new Error('MUI X: Invalid licensing model');
   }
 

packages/x-license/src/useLicenseVerifier/useLicenseVerifier.test.tsx

@@ -61,9 +61,9 @@ describe('useLicenseVerifier', function test() {
     it('should detect an override of a valid license key in the context', () => {
       const key = generateLicense({
         expiryDate: new Date(3001, 0, 0, 0, 0, 0, 0),
-        licensingModel: 'perpetual',
+        licenseModel: 'perpetual',
         orderNumber: '12345',
-        scope: 'pro',
+        planScope: 'pro',
         planVersion: 'initial',
       });
 
@@ -88,8 +88,8 @@ describe('useLicenseVerifier', function test() {
       const expiredLicenseKey = generateLicense({
         expiryDate: new Date(new Date().getTime() - oneDayInMS * 30),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'initial',
       });
       LicenseInfo.setLicenseKey(expiredLicenseKey);
@@ -117,8 +117,8 @@ describe('useLicenseVerifier', function test() {
       const licenseKey = generateLicense({
         expiryDate: new Date(3001, 0, 0, 0, 0, 0, 0),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'initial',
       });
 
@@ -141,8 +141,8 @@ describe('useLicenseVerifier', function test() {
       const licenseKey = generateLicense({
         expiryDate: new Date(3001, 0, 0, 0, 0, 0, 0),
         orderNumber: 'MUI-123',
-        scope: 'pro',
-        licensingModel: 'subscription',
+        planScope: 'pro',
+        licenseModel: 'subscription',
         planVersion: 'Q3-2024',
       });
 
@@ -165,8 +165,8 @@ describe('useLicenseVerifier', function test() {
       const licenseKey = generateLicense({
         expiryDate: new Date(3001, 0, 0, 0, 0, 0, 0),
         orderNumber: 'MUI-123',
-        scope: 'premium',
-        licensingModel: 'subscription',
+        planScope: 'premium',
+        licenseModel: 'subscription',
         planVersion: 'Q3-2024',
       });
 

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

@@ -1,6 +1,6 @@
 export * from './licenseErrorMessageUtils';
 export * from './licenseInfo';
 export * from './licenseStatus';
-export type { LicenseScope } from './licenseScope';
-export type { LicensingModel } from './licensingModel';
+export type { PlanScope } from './plan';
+export type { LicenseModel } from './licenseModel';
 export type { MuiCommercialPackageName } from './commercialPackages';

packages/x-license/src/utils/licensingModel.ts → packages/x-license/src/utils/licenseModel.ts

@@ -1,4 +1,4 @@
-export const LICENSING_MODELS = [
+export const LICENSE_MODELS = [
   /**
    * A license is outdated if the current version of the software was released after the expiry date of the license.
    * But the license can be used indefinitely with an older version of the software.
@@ -10,9 +10,9 @@ export const LICENSING_MODELS = [
    */
   'annual',
   /**
-   * TODO 2025 remove, legacy name of annual.
+   * TODO 2026 remove, legacy name of annual.
    */
   'subscription',
 ] as const;
 
-export type LicensingModel = (typeof LICENSING_MODELS)[number];
+export type LicenseModel = (typeof LICENSE_MODELS)[number];

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

@@ -1,5 +1,5 @@
-export const LICENSE_SCOPES = ['pro', 'premium'] as const;
+export const PLAN_SCOPES = ['pro', 'premium'] as const;
 export const PLAN_VERSIONS = ['initial', 'Q3-2024'] as const;
 
-export type LicenseScope = (typeof LICENSE_SCOPES)[number];
+export type PlanScope = (typeof PLAN_SCOPES)[number];
 export type PlanVersion = (typeof PLAN_VERSIONS)[number];

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

@@ -50,8 +50,8 @@ describe('License: verifyLicense', () => {
       process.env.NODE_ENV = 'production';
       const expiredLicenseKey = generateLicense({
         expiryDate: new Date(releaseDate.getTime() - oneDayInMS),
-        scope: 'pro',
-        licensingModel: 'perpetual',
+        planScope: 'pro',
+        licenseModel: 'perpetual',
         orderNumber: 'MUI-123',
         planVersion: 'initial',
       });
@@ -82,16 +82,16 @@ describe('License: verifyLicense', () => {
     const licenseKeyPro = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'pro',
-      licensingModel: 'subscription',
+      planScope: 'pro',
+      licenseModel: 'subscription',
       planVersion: 'initial',
     });
 
     const licenseKeyPremium = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'premium',
-      licensingModel: 'subscription',
+      planScope: 'premium',
+      licenseModel: 'subscription',
       planVersion: 'initial',
     });
 
@@ -148,8 +148,8 @@ describe('License: verifyLicense', () => {
         const expiredLicenseKey = generateLicense({
           expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
           orderNumber: 'MUI-123',
-          scope: 'pro',
-          licensingModel: 'subscription',
+          planScope: 'pro',
+          licenseModel: 'subscription',
           planVersion: 'initial',
         });
 
@@ -166,8 +166,8 @@ describe('License: verifyLicense', () => {
         const expiredLicenseKey = generateLicense({
           expiryDate: new Date(new Date().getTime() - oneDayInMS),
           orderNumber: 'MUI-123',
-          scope: 'pro',
-          licensingModel: 'subscription',
+          planScope: 'pro',
+          licenseModel: 'subscription',
           planVersion: 'initial',
         });
 
@@ -185,8 +185,8 @@ describe('License: verifyLicense', () => {
         const expiredLicenseKey = generateLicense({
           expiryDate: new Date(new Date().getTime() - oneDayInMS * 30),
           orderNumber: 'MUI-123',
-          scope: 'pro',
-          licensingModel: 'subscription',
+          planScope: 'pro',
+          licenseModel: 'subscription',
           planVersion: 'initial',
         });
 
@@ -203,8 +203,8 @@ describe('License: verifyLicense', () => {
         const expiredLicenseKey = generateLicense({
           expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
           orderNumber: 'MUI-123',
-          scope: 'pro',
-          licensingModel: 'perpetual',
+          planScope: 'pro',
+          licenseModel: 'perpetual',
           planVersion: 'initial',
         });
 
@@ -235,12 +235,12 @@ describe('License: verifyLicense', () => {
     const licenseKeyPro = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'pro',
-      licensingModel: 'annual',
+      planScope: 'pro',
+      licenseModel: 'annual',
       planVersion: 'initial',
     });
 
-    it('should accept licensingModel="annual"', () => {
+    it('should accept licenseModel="annual"', () => {
       process.env.NODE_ENV = 'production';
       expect(
         verifyLicense({
@@ -256,24 +256,24 @@ describe('License: verifyLicense', () => {
     const proLicenseKeyInitial = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'pro',
-      licensingModel: 'annual',
+      planScope: 'pro',
+      licenseModel: 'annual',
       planVersion: 'initial',
     });
 
     const premiumLicenseKeyInitial = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'premium',
-      licensingModel: 'annual',
+      planScope: 'premium',
+      licenseModel: 'annual',
       planVersion: 'initial',
     });
 
     const proLicenseKeyQ32024 = generateLicense({
       expiryDate: new Date(releaseDate.getTime() + oneDayInMS),
       orderNumber: 'MUI-123',
-      scope: 'pro',
-      licensingModel: 'annual',
+      planScope: 'pro',
+      licenseModel: 'annual',
       planVersion: 'Q3-2024',
     });