feat: add record-locking feature to WCP license (#4073)

webiny · Apr 9, 2024 · 7f3380f · 7f3380f
1 parent 5b01770
commit 7f3380f
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 3 deletions.
diff --git a/packages/api-aco/__tests__/utils/createTestWcpLicense.ts b/packages/api-aco/__tests__/utils/createTestWcpLicense.ts
@@ -32,6 +32,9 @@ export const createTestWcpLicense = (): DecryptedWcpProjectLicense => {
                 [PROJECT_PACKAGE_FEATURE_NAME.AUDIT_LOGS]: {
                     enabled: false
                 },
+                [PROJECT_PACKAGE_FEATURE_NAME.RECORD_LOCKING]: {
+                    enabled: false
+                },
                 [PROJECT_PACKAGE_FEATURE_NAME.SEATS]: {
                     enabled: true,
                     options: {

diff --git a/packages/api-page-builder-aco/__tests__/utils/createTestWcpLicense.ts b/packages/api-page-builder-aco/__tests__/utils/createTestWcpLicense.ts
@@ -32,6 +32,9 @@ export const createTestWcpLicense = (): DecryptedWcpProjectLicense => {
                 [PROJECT_PACKAGE_FEATURE_NAME.AUDIT_LOGS]: {
                     enabled: false
                 },
+                [PROJECT_PACKAGE_FEATURE_NAME.RECORD_LOCKING]: {
+                    enabled: false
+                },
                 [PROJECT_PACKAGE_FEATURE_NAME.SEATS]: {
                     enabled: true,
                     options: {

diff --git a/packages/api-wcp/__tests__/context.test.ts b/packages/api-wcp/__tests__/context.test.ts
@@ -25,6 +25,8 @@ describe("context", () => {
             canUseFolderLevelPermissions: expect.any(Function),
             canUsePrivateFiles: expect.any(Function),
             canUseTeams: expect.any(Function),
+            canUseAuditLogs: expect.any(Function),
+            canUseRecordLocking: expect.any(Function),
             decrementSeats: expect.any(Function),
             incrementTenants: expect.any(Function),
             decrementTenants: expect.any(Function)

diff --git a/packages/api-wcp/src/createWcp.ts b/packages/api-wcp/src/createWcp.ts
@@ -147,6 +147,14 @@ export const createWcp = async (params: CreateWcpParams = {}): Promise<WcpContex
             return license!.package.features.advancedAccessControlLayer.options.privateFiles;
         },
 
+        canUseAuditLogs() {
+            return this.canUseFeature("auditLogs");
+        },
+
+        canUseRecordLocking() {
+            return this.canUseFeature("recordLocking");
+        },
+
         ensureCanUseFeature(wcpFeatureId: keyof typeof WCP_FEATURE_LABEL) {
             if (this.canUseFeature(wcpFeatureId)) {
                 return;

diff --git a/packages/app-wcp/src/hooks/useWcp.ts b/packages/app-wcp/src/hooks/useWcp.ts
@@ -9,6 +9,8 @@ interface UseWcpHook {
     canUseTeams: () => boolean;
     canUsePrivateFiles: () => boolean;
     canUseFolderLevelPermissions: () => boolean;
+    canUseAuditLogs: () => boolean;
+    canUseRecordLocking: () => boolean;
 }
 
 export function useWcp(): UseWcpHook {
@@ -65,12 +67,22 @@ export function useWcp(): UseWcpHook {
         return advancedAccessControlLayer.options.privateFiles;
     };
 
+    const canUseAuditLogs = () => {
+        return canUseFeature("auditLogs");
+    };
+
+    const canUseRecordLocking = () => {
+        return canUseFeature("recordLocking");
+    };
+
     return {
         getProject,
         canUseFeature,
         canUseAacl,
         canUseTeams,
         canUseFolderLevelPermissions,
-        canUsePrivateFiles
+        canUsePrivateFiles,
+        canUseAuditLogs,
+        canUseRecordLocking
     };
 }
diff --git a/packages/app-wcp/src/types.ts b/packages/app-wcp/src/types.ts
@@ -25,6 +25,9 @@ export type WcpProjectPackage = {
         auditLogs: {
             enabled: boolean;
         };
+        recordLocking: {
+            enabled: boolean;
+        };
     };
 };
 

diff --git a/packages/wcp/src/index.ts b/packages/wcp/src/index.ts
@@ -7,5 +7,6 @@ export const WCP_FEATURE_LABEL = {
     multiTenancy: "Multi-tenancy",
     advancedPublishingWorkflow: "Advanced Publishing Workflow (APW)",
     advancedAccessControlLayer: "Advanced Access Control Layer (ACL)",
-    auditLogs: "Audit Logs"
+    auditLogs: "Audit Logs",
+    recordLocking: "Record Locking"
 };
diff --git a/packages/wcp/src/types.ts b/packages/wcp/src/types.ts
@@ -17,7 +17,8 @@ export enum PROJECT_PACKAGE_FEATURE_NAME {
     APW = "advancedPublishingWorkflow",
     AACL = "advancedAccessControlLayer",
     AL = "auditLogs",
-    AUDIT_LOGS = "auditLogs"
+    AUDIT_LOGS = "auditLogs",
+    RECORD_LOCKING = "recordLocking"
 }
 
 export enum MT_OPTIONS_MAX_COUNT_TYPE {
@@ -49,6 +50,9 @@ export interface ProjectPackageFeatures {
     [PROJECT_PACKAGE_FEATURE_NAME.AUDIT_LOGS]: {
         enabled: boolean;
     };
+    [PROJECT_PACKAGE_FEATURE_NAME.RECORD_LOCKING]: {
+        enabled: boolean;
+    };
     [PROJECT_PACKAGE_FEATURE_NAME.AACL]: {
         enabled: boolean;
         options: { teams: boolean; privateFiles: boolean; folderLevelPermissions: boolean };