@webiny/feature-flags 6.0.0-alpha.5 → 6.0.0-rc.0

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,8 +1,3 @@
-export type FeatureFlags<TFeatureFlags = Record<string, any>> = {
-    allowCmsLegacyRichTextInput?: boolean;
-    cmsLegacyEntryEditor?: boolean;
-    experimentalDynamicPages?: boolean;
-    newWatchCommand?: boolean;
-} & TFeatureFlags;
+export type FeatureFlags<TFeatureFlags = Record<string, any>> = {} & TFeatureFlags;
 declare let featureFlags: FeatureFlags;
 export { featureFlags };

package/index.js

@@ -1,18 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.featureFlags = void 0;
-let featureFlags = exports.featureFlags = {};
+let featureFlags = {};
 
 // In API applications.
 if (process.env.WEBINY_FEATURE_FLAGS) {
-  exports.featureFlags = featureFlags = JSON.parse(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) {
-  exports.featureFlags = featureFlags = JSON.parse(process.env.REACT_APP_WEBINY_FEATURE_FLAGS);
+  featureFlags = JSON.parse(process.env.REACT_APP_WEBINY_FEATURE_FLAGS);
 }
+export { featureFlags };
 
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["featureFlags","exports","process","env","WEBINY_FEATURE_FLAGS","JSON","parse","REACT_APP_WEBINY_FEATURE_FLAGS"],"sources":["index.ts"],"sourcesContent":["export type FeatureFlags<TFeatureFlags = Record<string, any>> = {\n    allowCmsLegacyRichTextInput?: boolean;\n    cmsLegacyEntryEditor?: boolean;\n    experimentalDynamicPages?: boolean;\n    newWatchCommand?: boolean;\n} & 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":";;;;;;AAOA,IAAIA,YAA0B,GAAAC,OAAA,CAAAD,YAAA,GAAG,CAAC,CAAC;;AAEnC;AACA,IAAIE,OAAO,CAACC,GAAG,CAACC,oBAAoB,EAAE;EAClCH,OAAA,CAAAD,YAAA,GAAAA,YAAY,GAAGK,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACC,GAAG,CAACC,oBAAoB,CAAiB;;EAE3E;AACJ,CAAC,MAAM,IAAIF,OAAO,CAACC,GAAG,CAACI,8BAA8B,EAAE;EACnDN,OAAA,CAAAD,YAAA,GAAAA,YAAY,GAAGK,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACC,GAAG,CAACI,8BAA8B,CAAiB;AACzF","ignoreList":[]}
+{"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":[]}

package/package.json

@@ -1,6 +1,7 @@
 {
 	"name": "@webiny/feature-flags",
-	"version": "6.0.0-alpha.5",
+	"version": "6.0.0-rc.0",
+	"type": "module",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -12,18 +13,14 @@
 	],
 	"license": "MIT",
 	"devDependencies": {
-		"@types/uniqid": "5.3.2",
-		"@webiny/project-utils": "6.0.0-alpha.5",
-		"rimraf": "6.0.1",
-		"typescript": "5.3.3"
+		"@types/uniqid": "5.3.4",
+		"@webiny/build-tools": "6.0.0-rc.0",
+		"rimraf": "6.1.3",
+		"typescript": "5.9.3"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "dist"
 	},
-	"scripts": {
-		"build": "node ../cli/bin.js run build",
-		"watch": "node ../cli/bin.js run watch"
-	},
-	"gitHead": "b7e120541b093e91f214904a9f13e4c2c4640978"
+	"gitHead": "0f2aa699f4642e550ab62c96fcd050e8d02345c9"
 }