@webiny/feature-flags 6.0.0-rc.1 → 6.0.0-rc.2

package/index.d.ts

@@ -1,3 +1,36 @@
-export type FeatureFlags<TFeatureFlags = Record<string, any>> = {} & TFeatureFlags;
-declare let featureFlags: FeatureFlags;
-export { featureFlags };
+export interface IAaclFeatureFlags {
+    teams?: boolean;
+    privateFiles?: boolean;
+    folderLevelPermissions?: boolean;
+}
+export interface IFileManagerFeatureFlags {
+    threatDetection?: boolean;
+}
+/**
+ * Top-level feature flags interface. Add new flags here as needed.
+ * A boolean value controls whether the feature is enabled.
+ * An object value means the feature is enabled, but with specific sub-options.
+ * Keep this file free of @webiny/* package imports.
+ */
+export interface IFeatureFlagsDto {
+    multiTenancy?: boolean;
+    advancedPublishingWorkflow?: boolean;
+    advancedAccessControlLayer?: boolean | IAaclFeatureFlags;
+    auditLogs?: boolean;
+    recordLocking?: boolean;
+    fileManager?: boolean | IFileManagerFeatureFlags;
+}
+export declare class FeatureFlags {
+    private readonly flags;
+    static fromDto(dto: IFeatureFlagsDto): FeatureFlags;
+    constructor(flags?: IFeatureFlagsDto);
+    isMultiTenancyEnabled(): boolean;
+    isWorkflowsEnabled(): boolean;
+    isAaclEnabled(): boolean;
+    isTeamsEnabled(): boolean;
+    isPrivateFilesEnabled(): boolean;
+    isFolderLevelPermissionsEnabled(): boolean;
+    isAuditLogsEnabled(): boolean;
+    isRecordLockingEnabled(): boolean;
+    isFileManagerThreatDetectionEnabled(): boolean;
+}

package/index.js

@@ -1,13 +1,68 @@
-let featureFlags = {};
+/**
+ * Top-level feature flags interface. Add new flags here as needed.
+ * A boolean value controls whether the feature is enabled.
+ * An object value means the feature is enabled, but with specific sub-options.
+ * Keep this file free of @webiny/* package imports.
+ */
 
-// In API applications.
-if (process.env.WEBINY_FEATURE_FLAGS) {
-  featureFlags = JSON.parse(process.env.WEBINY_FEATURE_FLAGS);
-
-  // In React applications.
-} else if (process.env.REACT_APP_WEBINY_FEATURE_FLAGS) {
-  featureFlags = JSON.parse(process.env.REACT_APP_WEBINY_FEATURE_FLAGS);
+export class FeatureFlags {
+  static fromDto(dto) {
+    return new FeatureFlags(dto);
+  }
+  constructor(flags = {}) {
+    this.flags = flags;
+  }
+  isMultiTenancyEnabled() {
+    return this.flags.multiTenancy !== false;
+  }
+  isWorkflowsEnabled() {
+    return this.flags.advancedPublishingWorkflow !== false;
+  }
+  isAaclEnabled() {
+    return this.flags.advancedAccessControlLayer !== false;
+  }
+  isTeamsEnabled() {
+    if (this.flags.advancedAccessControlLayer === false) {
+      return false;
+    }
+    if (typeof this.flags.advancedAccessControlLayer === "object") {
+      return this.flags.advancedAccessControlLayer.teams !== false;
+    }
+    return true;
+  }
+  isPrivateFilesEnabled() {
+    if (this.flags.advancedAccessControlLayer === false) {
+      return false;
+    }
+    if (typeof this.flags.advancedAccessControlLayer === "object") {
+      return this.flags.advancedAccessControlLayer.privateFiles !== false;
+    }
+    return true;
+  }
+  isFolderLevelPermissionsEnabled() {
+    if (this.flags.advancedAccessControlLayer === false) {
+      return false;
+    }
+    if (typeof this.flags.advancedAccessControlLayer === "object") {
+      return this.flags.advancedAccessControlLayer.folderLevelPermissions !== false;
+    }
+    return true;
+  }
+  isAuditLogsEnabled() {
+    return this.flags.auditLogs !== false;
+  }
+  isRecordLockingEnabled() {
+    return this.flags.recordLocking !== false;
+  }
+  isFileManagerThreatDetectionEnabled() {
+    if (this.flags.fileManager === false) {
+      return false;
+    }
+    if (typeof this.flags.fileManager === "object") {
+      return this.flags.fileManager.threatDetection !== false;
+    }
+    return true;
+  }
 }
-export { featureFlags };
 
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["featureFlags","process","env","WEBINY_FEATURE_FLAGS","JSON","parse","REACT_APP_WEBINY_FEATURE_FLAGS"],"sources":["index.ts"],"sourcesContent":["export type FeatureFlags<TFeatureFlags = Record<string, any>> = {} & TFeatureFlags;\n\nlet featureFlags: FeatureFlags = {};\n\n// In API applications.\nif (process.env.WEBINY_FEATURE_FLAGS) {\n    featureFlags = JSON.parse(process.env.WEBINY_FEATURE_FLAGS) as FeatureFlags;\n\n    // In React applications.\n} else if (process.env.REACT_APP_WEBINY_FEATURE_FLAGS) {\n    featureFlags = JSON.parse(process.env.REACT_APP_WEBINY_FEATURE_FLAGS) as FeatureFlags;\n}\n\nexport { featureFlags };\n"],"mappings":"AAEA,IAAIA,YAA0B,GAAG,CAAC,CAAC;;AAEnC;AACA,IAAIC,OAAO,CAACC,GAAG,CAACC,oBAAoB,EAAE;EAClCH,YAAY,GAAGI,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACC,GAAG,CAACC,oBAAoB,CAAiB;;EAE3E;AACJ,CAAC,MAAM,IAAIF,OAAO,CAACC,GAAG,CAACI,8BAA8B,EAAE;EACnDN,YAAY,GAAGI,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACC,GAAG,CAACI,8BAA8B,CAAiB;AACzF;AAEA,SAASN,YAAY","ignoreList":[]}
+{"version":3,"names":["FeatureFlags","fromDto","dto","constructor","flags","isMultiTenancyEnabled","multiTenancy","isWorkflowsEnabled","advancedPublishingWorkflow","isAaclEnabled","advancedAccessControlLayer","isTeamsEnabled","teams","isPrivateFilesEnabled","privateFiles","isFolderLevelPermissionsEnabled","folderLevelPermissions","isAuditLogsEnabled","auditLogs","isRecordLockingEnabled","recordLocking","isFileManagerThreatDetectionEnabled","fileManager","threatDetection"],"sources":["index.ts"],"sourcesContent":["export interface IAaclFeatureFlags {\n    teams?: boolean;\n    privateFiles?: boolean;\n    folderLevelPermissions?: boolean;\n}\n\nexport interface IFileManagerFeatureFlags {\n    threatDetection?: boolean;\n}\n\n/**\n * Top-level feature flags interface. Add new flags here as needed.\n * A boolean value controls whether the feature is enabled.\n * An object value means the feature is enabled, but with specific sub-options.\n * Keep this file free of @webiny/* package imports.\n */\nexport interface IFeatureFlagsDto {\n    multiTenancy?: boolean;\n    advancedPublishingWorkflow?: boolean;\n    advancedAccessControlLayer?: boolean | IAaclFeatureFlags;\n    auditLogs?: boolean;\n    recordLocking?: boolean;\n    fileManager?: boolean | IFileManagerFeatureFlags;\n}\n\nexport class FeatureFlags {\n    static fromDto(dto: IFeatureFlagsDto): FeatureFlags {\n        return new FeatureFlags(dto);\n    }\n\n    constructor(private readonly flags: IFeatureFlagsDto = {}) {}\n\n    isMultiTenancyEnabled(): boolean {\n        return this.flags.multiTenancy !== false;\n    }\n\n    isWorkflowsEnabled(): boolean {\n        return this.flags.advancedPublishingWorkflow !== false;\n    }\n\n    isAaclEnabled(): boolean {\n        return this.flags.advancedAccessControlLayer !== false;\n    }\n\n    isTeamsEnabled(): boolean {\n        if (this.flags.advancedAccessControlLayer === false) {\n            return false;\n        }\n        if (typeof this.flags.advancedAccessControlLayer === \"object\") {\n            return this.flags.advancedAccessControlLayer.teams !== false;\n        }\n        return true;\n    }\n\n    isPrivateFilesEnabled(): boolean {\n        if (this.flags.advancedAccessControlLayer === false) {\n            return false;\n        }\n        if (typeof this.flags.advancedAccessControlLayer === \"object\") {\n            return this.flags.advancedAccessControlLayer.privateFiles !== false;\n        }\n        return true;\n    }\n\n    isFolderLevelPermissionsEnabled(): boolean {\n        if (this.flags.advancedAccessControlLayer === false) {\n            return false;\n        }\n        if (typeof this.flags.advancedAccessControlLayer === \"object\") {\n            return this.flags.advancedAccessControlLayer.folderLevelPermissions !== false;\n        }\n        return true;\n    }\n\n    isAuditLogsEnabled(): boolean {\n        return this.flags.auditLogs !== false;\n    }\n\n    isRecordLockingEnabled(): boolean {\n        return this.flags.recordLocking !== false;\n    }\n\n    isFileManagerThreatDetectionEnabled(): boolean {\n        if (this.flags.fileManager === false) {\n            return false;\n        }\n        if (typeof this.flags.fileManager === \"object\") {\n            return this.flags.fileManager.threatDetection !== false;\n        }\n        return true;\n    }\n}\n"],"mappings":"AAUA;AACA;AACA;AACA;AACA;AACA;;AAUA,OAAO,MAAMA,YAAY,CAAC;EACtB,OAAOC,OAAOA,CAACC,GAAqB,EAAgB;IAChD,OAAO,IAAIF,YAAY,CAACE,GAAG,CAAC;EAChC;EAEAC,WAAWA,CAAkBC,KAAuB,GAAG,CAAC,CAAC,EAAE;IAAA,KAA9BA,KAAuB,GAAvBA,KAAuB;EAAQ;EAE5DC,qBAAqBA,CAAA,EAAY;IAC7B,OAAO,IAAI,CAACD,KAAK,CAACE,YAAY,KAAK,KAAK;EAC5C;EAEAC,kBAAkBA,CAAA,EAAY;IAC1B,OAAO,IAAI,CAACH,KAAK,CAACI,0BAA0B,KAAK,KAAK;EAC1D;EAEAC,aAAaA,CAAA,EAAY;IACrB,OAAO,IAAI,CAACL,KAAK,CAACM,0BAA0B,KAAK,KAAK;EAC1D;EAEAC,cAAcA,CAAA,EAAY;IACtB,IAAI,IAAI,CAACP,KAAK,CAACM,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,CAACE,KAAK,KAAK,KAAK;IAChE;IACA,OAAO,IAAI;EACf;EAEAC,qBAAqBA,CAAA,EAAY;IAC7B,IAAI,IAAI,CAACT,KAAK,CAACM,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,CAACI,YAAY,KAAK,KAAK;IACvE;IACA,OAAO,IAAI;EACf;EAEAC,+BAA+BA,CAAA,EAAY;IACvC,IAAI,IAAI,CAACX,KAAK,CAACM,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACN,KAAK,CAACM,0BAA0B,CAACM,sBAAsB,KAAK,KAAK;IACjF;IACA,OAAO,IAAI;EACf;EAEAC,kBAAkBA,CAAA,EAAY;IAC1B,OAAO,IAAI,CAACb,KAAK,CAACc,SAAS,KAAK,KAAK;EACzC;EAEAC,sBAAsBA,CAAA,EAAY;IAC9B,OAAO,IAAI,CAACf,KAAK,CAACgB,aAAa,KAAK,KAAK;EAC7C;EAEAC,mCAAmCA,CAAA,EAAY;IAC3C,IAAI,IAAI,CAACjB,KAAK,CAACkB,WAAW,KAAK,KAAK,EAAE;MAClC,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAAClB,KAAK,CAACkB,WAAW,KAAK,QAAQ,EAAE;MAC5C,OAAO,IAAI,CAAClB,KAAK,CAACkB,WAAW,CAACC,eAAe,KAAK,KAAK;IAC3D;IACA,OAAO,IAAI;EACf;AACJ","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/feature-flags",
-	"version": "6.0.0-rc.1",
+	"version": "6.0.0-rc.2",
 	"type": "module",
 	"main": "index.js",
 	"repository": {
@@ -14,7 +14,7 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@types/uniqid": "5.3.4",
-		"@webiny/build-tools": "6.0.0-rc.1",
+		"@webiny/build-tools": "6.0.0-rc.2",
 		"rimraf": "6.1.3",
 		"typescript": "5.9.3"
 	},
@@ -22,5 +22,5 @@
 		"access": "public",
 		"directory": "dist"
 	},
-	"gitHead": "36d702721ff9ed39fb21d6f5fe7922a2a8716e63"
+	"gitHead": "5facada4cbb8617cc60e3c98be0f1839f44be38e"
 }