@webiny/feature-flags 0.0.0-unstable.615a930a68

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# `@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)
+
+A small library that provides a simple way to define and read feature flags in a Webiny project.
+
+## Table of Contents
+
+-   [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;
+```

package/index.d.ts

@@ -0,0 +1,2 @@
+declare let featureFlags: Record<string, any>;
+export { featureFlags };

package/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+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);
+}

package/index.js.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "@webiny/feature-flags",
+	"version": "0.0.0-unstable.615a930a68",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "A small library that provides a simple way to define and read feature flags in a Webiny project.",
+	"contributors": [
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.19.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.19.3",
+		"@babel/core": "^7.19.3",
+		"@types/uniqid": "^5.3.2",
+		"@webiny/cli": "^0.0.0-unstable.615a930a68",
+		"@webiny/project-utils": "^0.0.0-unstable.615a930a68",
+		"rimraf": "^3.0.2",
+		"ttypescript": "^1.5.13",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "615a930a68d692c832e4f100405eeb3f5a8874af"
+}