@warp-drive/build-config 5.6.0-alpha.1 → 5.6.0-alpha.12

package/dist/canary-features-CuKgaVtX.js

@@ -0,0 +1,147 @@
+/**
+ *
+ * # Canary Features <Badge type="warning" text="requires canary" />
+ *
+ * ***Warp*Drive** allows users to test upcoming features that are implemented
+ * but not yet activated in canary builds.
+ *
+ * Typically these features represent work that carries higher risk of breaking
+ * changes, or are not yet fully ready for production use.
+ *
+ * Such features have their implementations guarded by a "feature flag", and the
+ * flag is only activated once the core-data team is prepared to ship the work
+ * in a canary release, beginning the process of it landing in a stable release.
+ *
+ * ### Installing Canary
+ *
+ * ::: warning To test a feature guarded behind a flag, you MUST be using a canary build.
+ * :::
+ *
+ * Canary builds are published to `npm` and can be installed using a precise tag
+ * (such as `@warp-drive/core@5.6.0-alpha.1`) or by installing the latest dist-tag
+ * published to the `canary` channel.
+ *
+ * Because ***Warp*Drive** packages operate on a strict lockstep policy with each other,
+ * you must install the matching canary version of all ***Warp*Drive** packages.
+ *
+ * Below is an example of installing the latest canary version of all the core
+ * packages that are part of the ***Warp*Drive** project when using EmberJS.
+ *
+ * Add/remove packages from this list to match your project.
+ *
+ * ::: code-group
+ *
+ * ```sh [pnpm]
+ * pnpm add -E @warp-drive/core@canary \
+ *   @warp-drive/json-api@canary \
+ *   @warp-drive/ember@canary;
+ * ```
+ *
+ * ```sh [npm]
+ * npm add -E @warp-drive/core@canary \
+ *   @warp-drive/json-api@canary \
+ *   @warp-drive/ember@canary;
+ * ```
+ *
+ * ```sh [yarn]
+ * yarn add -E @warp-drive/core@canary \
+ *   @warp-drive/json-api@canary \
+ *   @warp-drive/ember@canary;
+ * ```
+ *
+ * ```sh [bun]
+ * bun add --exact @warp-drive/core@canary \
+ *   @warp-drive/json-api@canary \
+ *   @warp-drive/ember@canary;
+ * ```
+ *
+ * :::
+ *
+ * ### Activating a Feature
+ *
+ * Once you have installed canary, feature-flags can be activated at build-time
+ *
+ * ```ts
+ * setConfig(app, __dirname, {
+ *   features: {
+ *     FEATURE_A: false, // utilize existing behavior
+ *     FEATURE_B: true // utilize the new behavior
+ *   }
+ * })
+ * ```
+ *
+ * by setting an environment variable:
+ *
+ * ```sh
+ * # Activate a single flag
+ * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG;
+ *
+ * # Activate multiple flags by separating with commas
+ * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG,OTHER_FLAG;
+ *
+ * # Activate all flags
+ * export WARP_DRIVE_FEATURE_OVERRIDE=ENABLE_ALL_OPTIONAL;
+ * ```
+ *
+ * ::: warning To test a feature guarded behind a flag, you MUST be running a development build.
+ * :::
+ *
+ *
+ * ### Preparing a Project to use a Canary Feature
+ *
+ * For most projects and features, simple version detection should be enough.
+ *
+ * Using the provided version compatibility helpers from [embroider-macros](https://github.com/embroider-build/embroider/tree/main/packages/macros#readme)
+ * the following can be done:
+ *
+ * ```js
+ * if (macroCondition(dependencySatisfies('@warp-drive/core', '5.6'))) {
+ *   // do thing
+ * }
+ * ```
+ *
+ * For more complex projects and migrations, configure [@warp-drive/build-config/babel-macros](./babel-macros)
+ *
+ * The current list of features used at build time for canary releases is defined below.
+ *
+ * ::: tip 💡 If empty there are no features currently gated by feature flags.
+ * :::
+ *
+ * The valid values are:
+ *
+ *  - `true` | The feature is **enabled** at all times, and cannot be disabled.
+ *  - `false` | The feature is **disabled** at all times, and cannot be enabled.
+ *  - `null` | The feature is **disabled by default**, but can be enabled via configuration.
+ *
+ * @module
+ * @public
+ */
+
+/**
+ * We use this for some tests etc.
+ *
+ * @internal
+ */
+const SAMPLE_FEATURE_FLAG = null;
+
+/**
+ * This upcoming feature adds a validation step to payloads received
+ * by the JSONAPICache implementation.
+ *
+ * When a request completes and the result is given to the cache via
+ * `cache.put`, the cache will validate the payload against registered
+ * schemas as well as the JSON:API spec.
+ *
+ * @since 5.4
+ * @public
+ */
+const JSON_API_CACHE_VALIDATION_ERRORS = false;
+
+const CURRENT_FEATURES = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	JSON_API_CACHE_VALIDATION_ERRORS,
+	SAMPLE_FEATURE_FLAG
+}, Symbol.toStringTag, { value: 'Module' }));
+
+export { CURRENT_FEATURES as C, JSON_API_CACHE_VALIDATION_ERRORS as J, SAMPLE_FEATURE_FLAG as S };
+//# sourceMappingURL=canary-features-CuKgaVtX.js.map

package/dist/canary-features-CuKgaVtX.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canary-features-CuKgaVtX.js","sources":["../src/canary-features.ts"],"sourcesContent":["/**\n *\n * # Canary Features <Badge type=\"warning\" text=\"requires canary\" />\n *\n * ***Warp*Drive** allows users to test upcoming features that are implemented\n * but not yet activated in canary builds.\n *\n * Typically these features represent work that carries higher risk of breaking\n * changes, or are not yet fully ready for production use.\n *\n * Such features have their implementations guarded by a \"feature flag\", and the\n * flag is only activated once the core-data team is prepared to ship the work\n * in a canary release, beginning the process of it landing in a stable release.\n *\n * ### Installing Canary\n *\n * ::: warning To test a feature guarded behind a flag, you MUST be using a canary build.\n * :::\n *\n * Canary builds are published to `npm` and can be installed using a precise tag\n * (such as `@warp-drive/core@5.6.0-alpha.1`) or by installing the latest dist-tag\n * published to the `canary` channel.\n *\n * Because ***Warp*Drive** packages operate on a strict lockstep policy with each other,\n * you must install the matching canary version of all ***Warp*Drive** packages.\n *\n * Below is an example of installing the latest canary version of all the core\n * packages that are part of the ***Warp*Drive** project when using EmberJS.\n *\n * Add/remove packages from this list to match your project.\n *\n * ::: code-group\n *\n * ```sh [pnpm]\n * pnpm add -E @warp-drive/core@canary \\\n *   @warp-drive/json-api@canary \\\n *   @warp-drive/ember@canary;\n * ```\n *\n * ```sh [npm]\n * npm add -E @warp-drive/core@canary \\\n *   @warp-drive/json-api@canary \\\n *   @warp-drive/ember@canary;\n * ```\n *\n * ```sh [yarn]\n * yarn add -E @warp-drive/core@canary \\\n *   @warp-drive/json-api@canary \\\n *   @warp-drive/ember@canary;\n * ```\n *\n * ```sh [bun]\n * bun add --exact @warp-drive/core@canary \\\n *   @warp-drive/json-api@canary \\\n *   @warp-drive/ember@canary;\n * ```\n *\n * :::\n *\n * ### Activating a Feature\n *\n * Once you have installed canary, feature-flags can be activated at build-time\n *\n * ```ts\n * setConfig(app, __dirname, {\n *   features: {\n *     FEATURE_A: false, // utilize existing behavior\n *     FEATURE_B: true // utilize the new behavior\n *   }\n * })\n * ```\n *\n * by setting an environment variable:\n *\n * ```sh\n * # Activate a single flag\n * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG;\n *\n * # Activate multiple flags by separating with commas\n * export WARP_DRIVE_FEATURE_OVERRIDE=SOME_FLAG,OTHER_FLAG;\n *\n * # Activate all flags\n * export WARP_DRIVE_FEATURE_OVERRIDE=ENABLE_ALL_OPTIONAL;\n * ```\n *\n * ::: warning To test a feature guarded behind a flag, you MUST be running a development build.\n * :::\n *\n *\n * ### Preparing a Project to use a Canary Feature\n *\n * For most projects and features, simple version detection should be enough.\n *\n * Using the provided version compatibility helpers from [embroider-macros](https://github.com/embroider-build/embroider/tree/main/packages/macros#readme)\n * the following can be done:\n *\n * ```js\n * if (macroCondition(dependencySatisfies('@warp-drive/core', '5.6'))) {\n *   // do thing\n * }\n * ```\n *\n * For more complex projects and migrations, configure [@warp-drive/build-config/babel-macros](./babel-macros)\n *\n * The current list of features used at build time for canary releases is defined below.\n *\n * ::: tip 💡 If empty there are no features currently gated by feature flags.\n * :::\n *\n * The valid values are:\n *\n *  - `true` | The feature is **enabled** at all times, and cannot be disabled.\n *  - `false` | The feature is **disabled** at all times, and cannot be enabled.\n *  - `null` | The feature is **disabled by default**, but can be enabled via configuration.\n *\n * @module\n * @public\n */\n\n/**\n * We use this for some tests etc.\n *\n * @internal\n */\nexport const SAMPLE_FEATURE_FLAG: boolean | null = null;\n\n/**\n * This upcoming feature adds a validation step to payloads received\n * by the JSONAPICache implementation.\n *\n * When a request completes and the result is given to the cache via\n * `cache.put`, the cache will validate the payload against registered\n * schemas as well as the JSON:API spec.\n *\n * @since 5.4\n * @public\n */\nexport const JSON_API_CACHE_VALIDATION_ERRORS: boolean | null = false;\n"],"names":["SAMPLE_FEATURE_FLAG","JSON_API_CACHE_VALIDATION_ERRORS"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACO,MAAMA,mBAAmC,GAAG;;AAEnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,gCAAgD,GAAG;;;;;;;;;;"}

package/dist/canary-features.js

@@ -1,2 +1,2 @@
-export { J as JSON_API_CACHE_VALIDATION_ERRORS, S as SAMPLE_FEATURE_FLAG } from './canary-features-D1wplYmb.js';
+export { J as JSON_API_CACHE_VALIDATION_ERRORS, S as SAMPLE_FEATURE_FLAG } from './canary-features-CuKgaVtX.js';
 //# sourceMappingURL=canary-features.js.map