@atlaskit/platform-feature-flags - npm Package Compare versions

Comparing version 0.0.12 to 0.1.0

CHANGELOG.md

 # @atlaskit/platform-feature-flags
 
+## 0.1.0
+
+### Minor Changes
+
+- [`1d3a3683ed9`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1d3a3683ed9) - Revamp platform feature flag package to allow deferral to outside client instead
+
 ## 0.0.12
@@ -4,0 +10,0 @@

dist/cjs/debug.js

@@ -7,5 +7,3 @@ "use strict";
 exports.debug = void 0;
-
 var _ref, _globalThis$process, _globalThis$process$e, _globalThis$process2, _globalThis$process2$;
-
 // We can't rely on NODE_ENV === 'test' if its value is already configured by the consumer to some other value, so better to use JEST_WORKER_ID
@@ -15,14 +13,11 @@ // https://jestjs.io/docs/environment-variables#jest_worker_id
 var DEBUG_MODE = !TESTS_MODE && (globalThis === null || globalThis === void 0 ? void 0 : (_globalThis$process2 = globalThis.process) === null || _globalThis$process2 === void 0 ? void 0 : (_globalThis$process2$ = _globalThis$process2.env) === null || _globalThis$process2$ === void 0 ? void 0 : _globalThis$process2$.NODE_ENV) !== 'production';
-
 var debug = function debug() {
   var _console;
-
   if (!DEBUG_MODE) {
     return;
-  } // eslint-disable-next-line no-console
+  }
 
-
+  // eslint-disable-next-line no-console
   (_console = console).debug.apply(_console, arguments);
 };
-
 exports.debug = debug;

dist/cjs/index.js

@@ -7,26 +7,18 @@ "use strict";
 exports.getBooleanFF = getBooleanFF;
-exports.setBooleanFF = setBooleanFF;
-
-var _registry = require("./registry");
-
+exports.setBooleanFeatureFlagResolver = setBooleanFeatureFlagResolver;
+var _resolvers = require("./resolvers");
 /**
- * Sets a feature flag to a given value.
- *
- * @param name
- * @param value
+ * Sets the flag resolver for boolean flags.
+ * @param flagResolver
  */
-function setBooleanFF(name, value) {
-  _registry.store[name] = value;
+function setBooleanFeatureFlagResolver(flagResolver) {
+  (0, _resolvers.setBooleanResolver)(flagResolver);
 }
+
 /**
- * Returns the value of a feature flag. If the flag is not set, returns the "false" as a default value.
+ * Returns the value of a feature flag. If the flag does not resolve, it returns the "false" as a default value.
  * @param name
  */
-
-
 function getBooleanFF(name) {
-  var _store$name;
-
-  var defaultValue = false;
-  return (_store$name = _registry.store === null || _registry.store === void 0 ? void 0 : _registry.store[name]) !== null && _store$name !== void 0 ? _store$name : defaultValue;
+  return (0, _resolvers.resolveBooleanFlag)(name);
 }

dist/cjs/version.json

 {
 	"name": "@atlaskit/platform-feature-flags",
-	"version": "0.0.12",
+	"version": "0.1.0",
 	"sideEffects": false
 }

dist/es2019/debug.js

 var _ref, _globalThis$process, _globalThis$process$e, _globalThis$process2, _globalThis$process2$;
-
 // We can't rely on NODE_ENV === 'test' if its value is already configured by the consumer to some other value, so better to use JEST_WORKER_ID
@@ -10,6 +9,6 @@ // https://jestjs.io/docs/environment-variables#jest_worker_id
     return;
-  } // eslint-disable-next-line no-console
+  }
 
-
+  // eslint-disable-next-line no-console
   console.debug(...args);
 };

dist/es2019/index.js

@@ -1,22 +0,17 @@
-import { store } from './registry';
+import { setBooleanResolver, resolveBooleanFlag } from './resolvers';
+
 /**
- * Sets a feature flag to a given value.
- *
- * @param name
- * @param value
+ * Sets the flag resolver for boolean flags.
+ * @param flagResolver
  */
+export function setBooleanFeatureFlagResolver(flagResolver) {
+  setBooleanResolver(flagResolver);
+}
 
-export function setBooleanFF(name, value) {
-  store[name] = value;
-}
 /**
- * Returns the value of a feature flag. If the flag is not set, returns the "false" as a default value.
+ * Returns the value of a feature flag. If the flag does not resolve, it returns the "false" as a default value.
  * @param name
  */
-
 export function getBooleanFF(name) {
-  var _store$name;
-
-  const defaultValue = false;
-  return (_store$name = store === null || store === void 0 ? void 0 : store[name]) !== null && _store$name !== void 0 ? _store$name : defaultValue;
+  return resolveBooleanFlag(name);
 }

dist/es2019/version.json

 {
 	"name": "@atlaskit/platform-feature-flags",
-	"version": "0.0.12",
+	"version": "0.1.0",
 	"sideEffects": false
 }

dist/esm/debug.js

 var _ref, _globalThis$process, _globalThis$process$e, _globalThis$process2, _globalThis$process2$;
-
 // We can't rely on NODE_ENV === 'test' if its value is already configured by the consumer to some other value, so better to use JEST_WORKER_ID
@@ -9,9 +8,8 @@ // https://jestjs.io/docs/environment-variables#jest_worker_id
   var _console;
-
   if (!DEBUG_MODE) {
     return;
-  } // eslint-disable-next-line no-console
+  }
 
-
+  // eslint-disable-next-line no-console
   (_console = console).debug.apply(_console, arguments);
 };

dist/esm/index.js

@@ -1,22 +0,17 @@
-import { store } from './registry';
+import { setBooleanResolver, resolveBooleanFlag } from './resolvers';
+
 /**
- * Sets a feature flag to a given value.
- *
- * @param name
- * @param value
+ * Sets the flag resolver for boolean flags.
+ * @param flagResolver
  */
+export function setBooleanFeatureFlagResolver(flagResolver) {
+  setBooleanResolver(flagResolver);
+}
 
-export function setBooleanFF(name, value) {
-  store[name] = value;
-}
 /**
- * Returns the value of a feature flag. If the flag is not set, returns the "false" as a default value.
+ * Returns the value of a feature flag. If the flag does not resolve, it returns the "false" as a default value.
  * @param name
  */
-
 export function getBooleanFF(name) {
-  var _store$name;
-
-  var defaultValue = false;
-  return (_store$name = store === null || store === void 0 ? void 0 : store[name]) !== null && _store$name !== void 0 ? _store$name : defaultValue;
+  return resolveBooleanFlag(name);
 }

dist/esm/version.json

 {
 	"name": "@atlaskit/platform-feature-flags",
-	"version": "0.0.12",
+	"version": "0.1.0",
 	"sideEffects": false
 }

dist/types/index.d.ts

@@ -0,12 +1,11 @@
+import { FeatureFlagResolverBoolean } from './resolvers';
 /**
- * Sets a feature flag to a given value.
- *
- * @param name
- * @param value
+ * Sets the flag resolver for boolean flags.
+ * @param flagResolver
  */
-export declare function setBooleanFF(name: string, value: boolean): void;
+export declare function setBooleanFeatureFlagResolver(flagResolver: FeatureFlagResolverBoolean): void;
 /**
- * Returns the value of a feature flag. If the flag is not set, returns the "false" as a default value.
+ * Returns the value of a feature flag. If the flag does not resolve, it returns the "false" as a default value.
  * @param name
  */
 export declare function getBooleanFF(name: string): boolean;

package.json

 {
   "name": "@atlaskit/platform-feature-flags",
-  "version": "0.0.12",
-  "description": "DO NOT USE",
+  "version": "0.1.0",
+  "description": "Platform Feature Flags - DO NOT USE (yet)",
   "publishConfig": {
@@ -21,3 +21,3 @@ "registry": "https://registry.npmjs.org/"
   "atlassian": {
-    "team": "UIP: Cycle Time Flex",
+    "team": "UIP - Platform Integration Trust (PITa)",
     "inPublicMirror": true,
@@ -24,0 +24,0 @@ "releaseModel": "continuous",

README.md

@@ -1,20 +0,22 @@
-# platform-feature-flags
+# @atlaskit/platform-feature-flags
 
-Allows usage of feature flags in platform components. 
+Allows usage of feature flags in platform components.
 
-## registration
-Feature flags are required to be registered in their respective package before they will be available in the api. 
+## Registration
+
+Feature flags are required to be registered in their respective package before they will be available in the api.
 This is because the types used in this package are dynamically generated based on flags defined in their "package.json".
 Definitions can be like so:
+
 ```json5
 {
-  "platform-feature-flags": {
-    "flag-name": {
-      "type": "boolean" // required
-    }
-  }
+  'platform-feature-flags': {
+    'flag-name': {
+      type: 'boolean',
+      // required
+    },
+  },
 }
 ```
+
 The only required field for your flag is "type" so we can generate the correct types.
-
-This field is read on "postinstall" and types are generated via "scripts/postinstall.ts"

report.api.md

@@ -18,2 +18,5 @@ <!-- API Report Version: 2.3 -->
 ```ts
+// @public (undocumented)
+type FeatureFlagResolverBoolean = (key: string) => boolean;
+
 // @public
@@ -23,3 +26,5 @@ export function getBooleanFF(name: string): boolean;
 // @public
-export function setBooleanFF(name: string, value: boolean): void;
+export function setBooleanFeatureFlagResolver(
+  flagResolver: FeatureFlagResolverBoolean,
+): void;
 
@@ -26,0 +31,0 @@ // (No @packageDocumentation comment for this package)

tmp/api-report-tmp.d.ts

@@ -7,2 +7,5 @@ ## API Report File for "@atlaskit/platform-feature-flags"
 
+// @public (undocumented)
+type FeatureFlagResolverBoolean = (key: string) => boolean;
+
 // @public
@@ -12,3 +15,3 @@ export function getBooleanFF(name: string): boolean;
 // @public
-export function setBooleanFF(name: string, value: boolean): void;
+export function setBooleanFeatureFlagResolver(flagResolver: FeatureFlagResolverBoolean): void;
 
@@ -15,0 +18,0 @@ // (No @packageDocumentation comment for this package)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

23

increased by9.52%

Worsened metrics

Total package byte prevSize

17180

decreased by-12.52%

Lines of code

245

decreased by-12.81%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes