[license] Add new license status 'Out of scope'

docs/data/introduction/licensing/licensing.md

@@ -211,6 +211,11 @@ For example, if you purchase a one-year license today, you will be able to updat
 Those versions will always be available for use in a deployed application,
 however you'll be required to renew your license if you need to continue development with a version released after twelve months.
 
+#### Out of scope license key
+
+This error indicates that the component you are trying to use is not included in your license.
+This can happen if you try to use `DataGridPremium` with a Pro license.
+
 #### Invalid license key
 
 This error indicates that your license key doesn't match what is expected. This is likely a typo.

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

@@ -0,0 +1,24 @@
+import * as React from 'react';
+import addYears from 'date-fns/addYears';
+import { expect } from 'chai';
+// @ts-ignore Remove once the test utils are typed
+import { createRenderer } from '@mui/monorepo/test/utils';
+import { DataGridPremium, LicenseInfo } from '@mui/x-data-grid-premium';
+import { generateLicense } from '@mui/x-license-pro';
+
+describe('<DataGridPremium /> - License', () => {
+  const { render } = createRenderer();
+
+  it('should throw out of scope error when using DataGridPremium with a pro license', () => {
+    LicenseInfo.setLicenseKey(
+      generateLicense({
+        expiryDate: addYears(new Date(), 1),
+        orderNumber: 'Test',
+        scope: 'pro',
+      }),
+    );
+    expect(() => render(<DataGridPremium columns={[]} rows={[]} autoHeight />)).toErrorDev([
+      'Your MUI X license key isn\'t valid. You are rendering a DataGridPremium component that requires a license key with the "premium" feature scope but your license key has the "pro" feature scope',
+    ]);
+  });
+});

packages/x-license-pro/src/Watermark/Watermark.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { useLicenseVerifier, MuiCommercialPackageName } from '../useLicenseVerifier';
+import { MuiCommercialPackageName, useLicenseVerifier } from '../useLicenseVerifier';
 import { LicenseStatus } from '../utils/licenseStatus';
 
 function getLicenseErrorMessage(licenseStatus: LicenseStatus) {
@@ -8,6 +8,8 @@ function getLicenseErrorMessage(licenseStatus: LicenseStatus) {
       return 'MUI X: License key expired';
     case LicenseStatus.Invalid:
       return 'MUI X: Invalid license key';
+    case LicenseStatus.OutOfScope:
+      return 'MUI X: Out of scope license key';
     case LicenseStatus.NotFound:
       return 'MUI X: Missing license key';
     default:

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

@@ -5,6 +5,7 @@ import {
   showExpiredLicenseError,
   showInvalidLicenseError,
   showNotFoundLicenseError,
+  showOutOfScopeLicenseError,
 } from '../utils/licenseErrorMessageUtils';
 import { LicenseStatus } from '../utils/licenseStatus';
 import { LicenseScope } from '../utils/licenseScope';
@@ -47,6 +48,8 @@ export function useLicenseVerifier(
 
     if (licenseStatus === LicenseStatus.Invalid) {
       showInvalidLicenseError();
+    } else if (licenseStatus === LicenseStatus.OutOfScope) {
+      showOutOfScopeLicenseError();
     } else if (licenseStatus === LicenseStatus.NotFound) {
       showNotFoundLicenseError({ plan, packageName: `@mui/${packageName}` });
     } else if (licenseStatus === LicenseStatus.Expired) {

packages/x-license-pro/src/utils/licenseErrorMessageUtils.ts

@@ -20,6 +20,17 @@ export function showInvalidLicenseError() {
   ]);
 }
 
+export function showOutOfScopeLicenseError() {
+  showError([
+    'MUI: Out of scope license key.',
+    '',
+    'Your MUI X license key isn\'t valid. You are rendering a DataGridPremium component that requires a license key with the "premium" feature scope but your license key has the "pro" feature scope.',
+    '',
+    'You can solve the issue by purchasing a Premium license at https://mui.com/r/x-get-license?scope=premium',
+    'Alternatively, you can replace the import on DataGridPremium with DataGridPro.',
+  ]);
+}
+
 export function showNotFoundLicenseError({
   plan,
   packageName,

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

@@ -3,6 +3,7 @@ enum LicenseStatus {
   Invalid = 'Invalid',
   Expired = 'Expired',
   Valid = 'Valid',
+  OutOfScope = 'OutOfScope',
 }
 
 export { LicenseStatus };

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

@@ -120,7 +120,7 @@ describe('License: verifyLicense', () => {
             acceptedScopes: ['premium'],
             isProduction: true,
           }),
-        ).to.equal(LicenseStatus.Invalid);
+        ).to.equal(LicenseStatus.OutOfScope);
       });
     });
 

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

@@ -159,7 +159,7 @@ export function verifyLicense({
   }
 
   if (!acceptedScopes.includes(license.scope)) {
-    return LicenseStatus.Invalid;
+    return LicenseStatus.OutOfScope;
   }
 
   return LicenseStatus.Valid;

scripts/x-license-pro.exports.json

@@ -10,6 +10,7 @@
   { "name": "showExpiredLicenseError", "kind": "Function" },
   { "name": "showInvalidLicenseError", "kind": "Function" },
   { "name": "showNotFoundLicenseError", "kind": "Function" },
+  { "name": "showOutOfScopeLicenseError", "kind": "Function" },
   { "name": "useLicenseVerifier", "kind": "Function" },
   { "name": "verifyLicense", "kind": "Function" },
   { "name": "Watermark", "kind": "Function" }