@parcel/feature-flags 2.12.1-dev.3151 → 2.12.1-dev.3185

package/lib/index.js

@@ -4,6 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_FEATURE_FLAGS = void 0;
+exports.getFeatureFlag = getFeatureFlag;
+exports.setFeatureFlags = setFeatureFlags;
+// We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
+// but we want to export FeatureFlags for Flow
 const DEFAULT_FEATURE_FLAGS = exports.DEFAULT_FEATURE_FLAGS = {
-  exampleFeature: false
-};
+  exampleFeature: false,
+  configKeyInvalidation: false
+};
+let featureFlagValues = {
+  ...DEFAULT_FEATURE_FLAGS
+};
+function setFeatureFlags(flags) {
+  featureFlagValues = flags;
+}
+function getFeatureFlag(flagName) {
+  return featureFlagValues[flagName];
+}

package/lib/types.d.ts

@@ -0,0 +1,11 @@
+export type FeatureFlags = {
+  // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
+  readonly exampleFeature: boolean;
+
+  /**
+   * Enables content hash based invalidation for config keys used in plugins.
+   * This allows Assets not to be invalidated when using
+   * `config.getConfigFrom(..., {packageKey: '...'})` and the value itself hasn't changed.
+   */
+  readonly configKeyInvalidation: boolean;
+};

package/lib/types.js

@@ -0,0 +1 @@
+"use strict";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parcel/feature-flags",
-  "version": "2.12.1-dev.3151+70889ca07",
+  "version": "2.12.1-dev.3185+298c035e0",
   "description": "Blazing fast, zero configuration web application bundler",
   "license": "MIT",
   "publishConfig": {
@@ -16,9 +16,13 @@
   },
   "main": "lib/index.js",
   "source": "src/index.js",
-  "types": "index.d.ts",
+  "types": "lib/types.d.ts",
+  "scripts": {
+    "build-ts": "mkdir -p lib && flow-to-ts src/types.js > lib/types.d.ts",
+    "check-ts": "tsc --noEmit lib/types.d.ts"
+  },
   "engines": {
     "node": ">= 16.0.0"
   },
-  "gitHead": "70889ca07dccb95e21e4c6a2844d632e3723faf4"
+  "gitHead": "298c035e0ffb82d7c5579ce233cc35dce2fe1061"
 }

package/src/index.js

@@ -1,10 +1,21 @@
 // @flow strict
 
-export type FeatureFlags = {|
-  // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
-  +exampleFeature: boolean,
-|};
+import type {FeatureFlags as _FeatureFlags} from './types';
+// We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
+// but we want to export FeatureFlags for Flow
+export type FeatureFlags = _FeatureFlags;
 
 export const DEFAULT_FEATURE_FLAGS: FeatureFlags = {
   exampleFeature: false,
+  configKeyInvalidation: false,
 };
+
+let featureFlagValues: FeatureFlags = {...DEFAULT_FEATURE_FLAGS};
+
+export function setFeatureFlags(flags: FeatureFlags) {
+  featureFlagValues = flags;
+}
+
+export function getFeatureFlag(flagName: $Keys<FeatureFlags>): boolean {
+  return featureFlagValues[flagName];
+}

package/src/types.js

@@ -0,0 +1,12 @@
+// @flow strict
+
+export type FeatureFlags = {|
+  // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
+  +exampleFeature: boolean,
+  /**
+   * Enables content hash based invalidation for config keys used in plugins.
+   * This allows Assets not to be invalidated when using
+   * `config.getConfigFrom(..., {packageKey: '...'})` and the value itself hasn't changed.
+   */
+  +configKeyInvalidation: boolean,
+|};

package/test/feature-flags.test.js

@@ -0,0 +1,21 @@
+// @flow strict
+import assert from 'assert';
+import {getFeatureFlag, DEFAULT_FEATURE_FLAGS, setFeatureFlags} from '../src';
+
+describe('feature-flag test', () => {
+  beforeEach(() => {
+    setFeatureFlags(DEFAULT_FEATURE_FLAGS);
+  });
+
+  it('has defaults', () => {
+    assert.equal(
+      getFeatureFlag('exampleFeature'),
+      DEFAULT_FEATURE_FLAGS.exampleFeature,
+    );
+  });
+
+  it('can override', () => {
+    setFeatureFlags({...DEFAULT_FEATURE_FLAGS, exampleFeature: true});
+    assert.equal(getFeatureFlag('exampleFeature'), true);
+  });
+});