@webiny/feature-flags 0.0.0-unstable.bca7b3e350 → 0.0.0-unstable.c27f4d8a31

package/FeatureFlags.d.ts

@@ -0,0 +1,16 @@
+import type { IFeatureFlagsDto } from "./types.js";
+export declare class FeatureFlags {
+    private readonly flags;
+    static fromDto(dto: IFeatureFlagsDto): FeatureFlags;
+    constructor(flags?: IFeatureFlagsDto);
+    toDto(): IFeatureFlagsDto;
+    isMultiTenancyEnabled(): boolean;
+    isWorkflowsEnabled(): boolean;
+    isAaclEnabled(): boolean;
+    isTeamsEnabled(): boolean;
+    isPrivateFilesEnabled(): boolean;
+    isFolderLevelPermissionsEnabled(): boolean;
+    isAuditLogsEnabled(): boolean;
+    isRecordLockingEnabled(): boolean;
+    isFileManagerThreatDetectionEnabled(): boolean;
+}

package/FeatureFlags.js

@@ -0,0 +1,58 @@
+export class FeatureFlags {
+  static fromDto(dto) {
+    return new FeatureFlags(dto);
+  }
+  constructor(flags = {}) {
+    this.flags = flags;
+  }
+  toDto() {
+    return structuredClone(this.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() {
+    return this.flags.fileManager?.threatDetection !== false;
+  }
+}
+
+//# sourceMappingURL=FeatureFlags.js.map

package/FeatureFlags.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["FeatureFlags","fromDto","dto","constructor","flags","toDto","structuredClone","isMultiTenancyEnabled","multiTenancy","isWorkflowsEnabled","advancedPublishingWorkflow","isAaclEnabled","advancedAccessControlLayer","isTeamsEnabled","teams","isPrivateFilesEnabled","privateFiles","isFolderLevelPermissionsEnabled","folderLevelPermissions","isAuditLogsEnabled","auditLogs","isRecordLockingEnabled","recordLocking","isFileManagerThreatDetectionEnabled","fileManager","threatDetection"],"sources":["FeatureFlags.ts"],"sourcesContent":["import type { IFeatureFlagsDto } from \"./types.js\";\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    toDto(): IFeatureFlagsDto {\n        return structuredClone(this.flags);\n    }\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        return this.flags.fileManager?.threatDetection !== false;\n    }\n}\n"],"mappings":"AAEA,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,KAAKA,CAAA,EAAqB;IACtB,OAAOC,eAAe,CAAC,IAAI,CAACF,KAAK,CAAC;EACtC;EAEAG,qBAAqBA,CAAA,EAAY;IAC7B,OAAO,IAAI,CAACH,KAAK,CAACI,YAAY,KAAK,KAAK;EAC5C;EAEAC,kBAAkBA,CAAA,EAAY;IAC1B,OAAO,IAAI,CAACL,KAAK,CAACM,0BAA0B,KAAK,KAAK;EAC1D;EAEAC,aAAaA,CAAA,EAAY;IACrB,OAAO,IAAI,CAACP,KAAK,CAACQ,0BAA0B,KAAK,KAAK;EAC1D;EAEAC,cAAcA,CAAA,EAAY;IACtB,IAAI,IAAI,CAACT,KAAK,CAACQ,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,CAACE,KAAK,KAAK,KAAK;IAChE;IACA,OAAO,IAAI;EACf;EAEAC,qBAAqBA,CAAA,EAAY;IAC7B,IAAI,IAAI,CAACX,KAAK,CAACQ,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,CAACI,YAAY,KAAK,KAAK;IACvE;IACA,OAAO,IAAI;EACf;EAEAC,+BAA+BA,CAAA,EAAY;IACvC,IAAI,IAAI,CAACb,KAAK,CAACQ,0BAA0B,KAAK,KAAK,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAI,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,KAAK,QAAQ,EAAE;MAC3D,OAAO,IAAI,CAACR,KAAK,CAACQ,0BAA0B,CAACM,sBAAsB,KAAK,KAAK;IACjF;IACA,OAAO,IAAI;EACf;EAEAC,kBAAkBA,CAAA,EAAY;IAC1B,OAAO,IAAI,CAACf,KAAK,CAACgB,SAAS,KAAK,KAAK;EACzC;EAEAC,sBAAsBA,CAAA,EAAY;IAC9B,OAAO,IAAI,CAACjB,KAAK,CAACkB,aAAa,KAAK,KAAK;EAC7C;EAEAC,mCAAmCA,CAAA,EAAY;IAC3C,OAAO,IAAI,CAACnB,KAAK,CAACoB,WAAW,EAAEC,eAAe,KAAK,KAAK;EAC5D;AACJ","ignoreList":[]}

package/README.md

@@ -1,97 +1,11 @@
-# `@webiny/feature-flags`
-[![](https://img.shields.io/npm/dw/@webiny/feature-flags.svg)](https://www.npmjs.com/package/@webiny/feature-flags)
-[![](https://img.shields.io/npm/v/@webiny/feature-flags.svg)](https://www.npmjs.com/package/@webiny/feature-flags)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+# @webiny/feature-flags
 
-A small library that provides a simple way to define and read feature flags in a Webiny project.
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
 
-## Table of Contents
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
 
--   [Installation](#installation)
--   [Overview](#overview)
--   [Examples](#examples)
--   [Reference](#reference)
-    -   [Objects](#objects)
-        -   [`featureFlags`](#featureFlags)
+---
 
-## Installation
-
-```
-npm install --save @webiny/feature-flags
-```
-
-Or if you prefer yarn:
-
-```
-yarn add @webiny/feature-flags
-```
-
-
-## Overview
-
-The `@webiny/feature-flags` exports a single `featureFlags` object which contains all of the feature flags initially set via the Webiny project's `webiny.project.ts` config file, via its `featureFlags` property.
-
-For example, given the following `webiny.project.ts` config file;
-
-```ts
-// webiny.project.ts
-export default {
-    name: "webiny-js",
-    cli: {
-        ...
-    },
-    
-    // Feature flags are defined via a simple JavaScript object.
-    featureFlags: {
-        myCustomFeatureFlag: false,
-        someFeature: { enabled: true, myCustomProperty: 123, thisIsJson: "yes"}
-    }
-};
-```
-
-Within both backend and frontend application code, the `featureFlags` object can then be read like so:
-
-```ts
-import { featureFlags } from "@webiny/feature-flags"; 
-
-const useMyCustomFeature = featureFlags.myCustomFeatureFlag;
-
-const someOtherFeatureMyCustomProperty = featureFlags.someFeature.myCustomProperty;
-```
-
-> **NOTE**
-> 
-> Behind the scenes, it's the [Webiny CLI](https://www.webiny.com/docs/core-development-concepts/basics/webiny-cli) that enables the propagation of the `featureFlags` object into the actual applications. As mentioned, the `featureFlags` object can be accessed within both backend and frontend application code. 
-
-## Examples
-
-No additional examples.
-
-## Reference
-
-### Objects
-
-#### `featureFlags`
-
-<details>
-<summary>Type Declaration</summary>
-<p>
-
-```ts
-declare let featureFlags: Record<string, any>;
-```
-
-</p>
-</details>  
-
-The `featureFlags` object contains all of the feature flags initially set via the Webiny project's `webiny.project.ts` config file, via its `featureFlags` property.
-
-
-```ts
-import { featureFlags } from "@webiny/feature-flags";
-
-const useMyCustomFeature = featureFlags.myCustomFeatureFlag;
-
-const someOtherFeatureMyCustomProperty = featureFlags.someFeature.myCustomProperty;
-```
+_This README file is automatically generated during the publish process._

package/index.d.ts

@@ -1,2 +1,2 @@
-declare let featureFlags: Record<string, any>;
-export { featureFlags };
+export * from "./types.js";
+export * from "./FeatureFlags.js";

package/index.js

@@ -1,15 +1,4 @@
-"use strict";
+export * from "./types.js";
+export * from "./FeatureFlags.js";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.featureFlags = void 0;
-let featureFlags = {}; // In API applications.
-
-exports.featureFlags = featureFlags;
-
-if (process.env.WEBINY_FEATURE_FLAGS) {
-  exports.featureFlags = featureFlags = JSON.parse(process.env.WEBINY_FEATURE_FLAGS); // In React applications.
-} else if (process.env.REACT_APP_WEBINY_FEATURE_FLAGS) {
-  exports.featureFlags = featureFlags = JSON.parse(process.env.REACT_APP_WEBINY_FEATURE_FLAGS);
-}
+//# 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":["let featureFlags: Record<string, any> = {};\n\n// In API applications.\nif (process.env.WEBINY_FEATURE_FLAGS) {\n    featureFlags = JSON.parse(process.env.WEBINY_FEATURE_FLAGS);\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);\n}\n\nexport { featureFlags };\n"],"mappings":";;;;;;AAAA,IAAIA,YAAiC,GAAG,EAAxC,C,CAEA;;;;AACA,IAAIC,OAAO,CAACC,GAAR,CAAYC,oBAAhB,EAAsC;EAClC,uBAAAH,YAAY,GAAGI,IAAI,CAACC,KAAL,CAAWJ,OAAO,CAACC,GAAR,CAAYC,oBAAvB,CAAf,CADkC,CAGlC;AACH,CAJD,MAIO,IAAIF,OAAO,CAACC,GAAR,CAAYI,8BAAhB,EAAgD;EACnD,uBAAAN,YAAY,GAAGI,IAAI,CAACC,KAAL,CAAWJ,OAAO,CAACC,GAAR,CAAYI,8BAAvB,CAAf;AACH"}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./types.js\";\nexport * from \"./FeatureFlags.js\";\n"],"mappings":"AAAA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,7 @@
 {
 	"name": "@webiny/feature-flags",
-	"version": "0.0.0-unstable.bca7b3e350",
+	"version": "0.0.0-unstable.c27f4d8a31",
+	"type": "module",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -11,26 +12,15 @@
 		"Adrian Smijulj <adrian@webiny.com>"
 	],
 	"license": "MIT",
-	"dependencies": {
-		"@babel/runtime": "7.20.13"
-	},
 	"devDependencies": {
-		"@babel/cli": "^7.19.3",
-		"@babel/core": "^7.19.3",
-		"@types/uniqid": "^5.3.2",
-		"@webiny/cli": "^0.0.0-unstable.bca7b3e350",
-		"@webiny/project-utils": "^0.0.0-unstable.bca7b3e350",
-		"rimraf": "^3.0.2",
-		"ttypescript": "^1.5.13",
-		"typescript": "4.7.4"
+		"@types/uniqid": "5.3.4",
+		"@webiny/build-tools": "0.0.0-unstable.c27f4d8a31",
+		"rimraf": "6.1.3",
+		"typescript": "5.9.3"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "dist"
 	},
-	"scripts": {
-		"build": "yarn webiny run build",
-		"watch": "yarn webiny run watch"
-	},
-	"gitHead": "bca7b3e35084d7012061bda0d3f08202fe611581"
+	"gitHead": "c27f4d8a31c3af1570817797441855292b6c1f20"
 }

package/types.d.ts

@@ -0,0 +1,23 @@
+export interface IAaclFeatureFlags {
+    teams?: boolean;
+    privateFiles?: boolean;
+    folderLevelPermissions?: boolean;
+    hcmsFieldPermissions?: 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?: IFileManagerFeatureFlags;
+}

package/types.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["export interface IAaclFeatureFlags {\n    teams?: boolean;\n    privateFiles?: boolean;\n    folderLevelPermissions?: boolean;\n    hcmsFieldPermissions?: 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?: IFileManagerFeatureFlags;\n}\n"],"mappings":"","ignoreList":[]}