@warp-drive/build-config 0.0.0-alpha.7

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@warp-drive/build-config",
+  "version": "0.0.0-alpha.7",
+  "description": "Provides Build Configuration for projects using WarpDrive or EmberData",
+  "keywords": [
+    "ember-data",
+    "warp-drive"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:emberjs/data.git",
+    "directory": "packages/build-config"
+  },
+  "license": "MIT",
+  "author": "Chris Thoburn <runspired@users.noreply.github.com>",
+  "scripts": {
+    "build:infra": "vite build; vite build -c ./vite.config-cjs.mjs;"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "unstable-preview-types",
+    "CHANGELOG.md",
+    "README.md",
+    "LICENSE.md",
+    "NCC-1701-a.svg",
+    "NCC-1701-a-blue.svg"
+  ],
+  "exports": {
+    ".": {
+      "default": "./dist/index.js"
+    },
+    "./*.cjs": {
+      "default": "./dist/*.cjs"
+    },
+    "./*": {
+      "default": "./dist/*.js"
+    }
+  },
+  "dependencies": {
+    "@embroider/macros": "^1.16.1",
+    "@embroider/addon-shim": "^1.8.8",
+    "babel-import-util": "^2.1.1",
+    "broccoli-funnel": "^3.0.8",
+    "semver": "^7.6.2"
+  },
+  "devDependencies": {
+    "@warp-drive/internal-config": "5.4.0-alpha.70",
+    "@types/babel__core": "^7.20.5",
+    "@types/node": "^20.12.12",
+    "@babel/plugin-transform-typescript": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
+    "@babel/core": "^7.24.5",
+    "pnpm-sync-dependencies-meta-injected": "0.0.14",
+    "typescript": "^5.4.5",
+    "bun-types": "^1.1.8",
+    "vite": "^5.2.11"
+  },
+  "engines": {
+    "node": ">= 22.1.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "packageManager": "pnpm@8.15.8"
+}

package/unstable-preview-types/-private/utils/deprecations.d.ts

@@ -0,0 +1,10 @@
+declare module '@warp-drive/build-config/-private/utils/deprecations' {
+  import * as CURRENT_DEPRECATIONS from '@warp-drive/build-config/deprecation-versions.ts';
+  type MajorMinor = `${number}.${number}`;
+  type DeprecationFlag = keyof typeof CURRENT_DEPRECATIONS;
+  export function getDeprecations(compatVersion: MajorMinor | null | undefined): {
+      [key in DeprecationFlag]: boolean;
+  };
+  export {};
+}
+//# sourceMappingURL=deprecations.d.ts.map

package/unstable-preview-types/-private/utils/deprecations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecations.d.ts","sourceRoot":"","sources":["../../../src/-private/utils/deprecations.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,oBAAoB,MAAM,+BAA+B,CAAC;AACtE,KAAK,UAAU,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AACxC,KAAK,eAAe,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAMzD,wBAAgB,eAAe,CAAC,aAAa,EAAE,UAAU,GAAG,IAAI,GAAG,SAAS,GAAG;KAAG,GAAG,IAAI,eAAe,GAAG,OAAO;CAAE,CA4BnH"}

package/unstable-preview-types/-private/utils/features.d.ts

@@ -0,0 +1,9 @@
+declare module '@warp-drive/build-config/-private/utils/features' {
+  import * as CURRENT_FEATURES from '@warp-drive/build-config/canary-features.ts';
+  type FEATURE = keyof typeof CURRENT_FEATURES;
+  export function getFeatures(isProd: boolean): {
+      [key in FEATURE]: boolean;
+  };
+  export {};
+}
+//# sourceMappingURL=features.d.ts.map

package/unstable-preview-types/-private/utils/features.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../../../src/-private/utils/features.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,gBAAgB,MAAM,0BAA0B,CAAC;AAC7D,KAAK,OAAO,GAAG,MAAM,OAAO,gBAAgB,CAAC;AAK7C,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG;KAAG,GAAG,IAAI,OAAO,GAAG,OAAO;CAAE,CA0D1E"}

package/unstable-preview-types/-private/utils/get-env.d.ts

@@ -0,0 +1,8 @@
+declare module '@warp-drive/build-config/-private/utils/get-env' {
+  export function getEnv(): {
+      TESTING: boolean;
+      PRODUCTION: boolean;
+      DEBUG: boolean;
+  };
+}
+//# sourceMappingURL=get-env.d.ts.map

package/unstable-preview-types/-private/utils/get-env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-env.d.ts","sourceRoot":"","sources":["../../../src/-private/utils/get-env.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM;;;;EAWrB"}

package/unstable-preview-types/babel-macros.d.ts

@@ -0,0 +1,24 @@
+declare module '@warp-drive/build-config/babel-macros' {
+  import * as LOGGING from '@warp-drive/build-config/debugging.ts';
+  import * as CURRENT_DEPRECATIONS from '@warp-drive/build-config/deprecations.ts';
+  export function macros(): ({}[] | (string | {
+      source: string;
+      flags: Record<"SAMPLE_FEATURE_FLAG", boolean>;
+  })[] | (string | {
+      source: string;
+      flags: typeof CURRENT_DEPRECATIONS;
+  })[] | (string | {
+      source: string;
+      configKey: string;
+      flags: typeof LOGGING;
+  })[] | (string | {
+      source: string;
+      configKey: string;
+      flags: {
+          TESTING: boolean;
+          PRODUCTION: boolean;
+          DEBUG: boolean;
+      };
+  })[])[];
+}
+//# sourceMappingURL=babel-macros.d.ts.map

package/unstable-preview-types/babel-macros.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"babel-macros.d.ts","sourceRoot":"","sources":["../src/babel-macros.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAE1C,OAAO,KAAK,oBAAoB,MAAM,mBAAmB,CAAC;AAkB1D,wBAAgB,MAAM;;;;;;;;;;;;;;;;;;QAiDrB"}

package/unstable-preview-types/canary-features.d.ts

@@ -0,0 +1,92 @@
+declare module '@warp-drive/build-config/canary-features' {
+  /**
+   * ## Canary Features
+   *
+   * EmberData allows users to test features that are implemented but not yet
+   * available even in canary.
+   *
+   * Typically these features represent work that might introduce a new concept,
+   * new API, change an API, or risk an unintended change in behavior to consuming
+   * applications.
+   *
+   * 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.
+   *
+   * ### Installing Canary
+   *
+   * To test a feature you MUST be using a canary build. Canary builds are published
+   * to `npm` and can be installed using a precise tag (such as `ember-data@3.16.0-alpha.1`)
+   * or by installing the latest dist-tag published to the `canary` channel using your javascript
+   * package manager of choice. For instance with [pnpm](https://pnpm.io/)
+  
+    ```cli
+    pnpm add ember-data@canary
+    ```
+   *
+   * ### Activating a Canary Feature
+   *
+   * Once you have installed canary, feature-flags can be activated at build-time
+   *
+   * by setting an environment variable:
+   *
+   * ```cli
+   * # Activate a single flag
+   * EMBER_DATA_FEATURE_OVERRIDE=SOME_FLAG ember build
+   *
+   * # Activate multiple flags by separating with commas
+   * EMBER_DATA_FEATURE_OVERRIDE=SOME_FLAG,OTHER_FLAG ember build
+   *
+   * # Activate all flags
+   * EMBER_DATA_FEATURE_OVERRIDE=ENABLE_ALL_OPTIONAL ember build
+   * ```
+   *
+   * or by setting the appropriate flag in your `ember-cli-build` file:
+   *
+   * ```ts
+   * let app = new EmberApp(defaults, {
+   *   emberData: {
+   *     features: {
+   *       SAMPLE_FEATURE_FLAG: false // utliize existing behavior, strip code for the new feature
+   *       OTHER_FEATURE_FLAG: true // utilize this new feature, strip code for the older behavior
+   *     }
+   *   }
+   * })
+   * ```
+   *
+   * **The "off" branch of feature-flagged code is always stripped from production builds.**
+   *
+   * The list of available feature-flags is located [here](https://github.com/emberjs/data/tree/main/packages/build-config/src/virtual/canary-features.ts "List of EmberData FeatureFlags")
+   *
+   *
+   * ### Preparing a Project to use a Canary Feature
+   *
+   * For most projects, 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('@ember-data/store', '5.0'))) {
+   *   // do thing
+   * }
+   * ```
+   *
+     @module @warp-drive/build-config/canary-features
+     @main @warp-drive/build-config/canary-features
+   */
+  /**
+    This is the current list of features used at build time for canary releases.
+    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.
+  
+    @class CanaryFeatureFlags
+    @public
+  */
+  export const SAMPLE_FEATURE_FLAG: boolean | null;
+}
+//# sourceMappingURL=canary-features.d.ts.map

package/unstable-preview-types/canary-features.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"canary-features.d.ts","sourceRoot":"","sources":["../src/canary-features.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH;;;;;;;;;;;;EAYE;AACF,eAAO,MAAM,mBAAmB,EAAE,OAAO,GAAG,IAAW,CAAC"}

package/unstable-preview-types/debugging.d.ts

@@ -0,0 +1,108 @@
+declare module '@warp-drive/build-config/debugging' {
+  /**
+   * ## Debugging
+   *
+   * Many portions of the internals are helpfully instrumented with logging that can be activated
+   * at build time. This instrumentation is always removed from production builds or any builds
+   * that has not explicitly activated it. To activate it set the appropriate flag to `true`.
+   *
+    @module @warp-drive/build-config/debugging
+    @main @warp-drive/build-config/debugging
+   */
+  /**
+   *
+   * Many portions of the internals are helpfully instrumented with logging that can be activated
+  at build time. This instrumentation is always removed from production builds or any builds
+  that has not explicitly activated it. To activate it set the appropriate flag to `true`.
+  
+  ```ts
+    let app = new EmberApp(defaults, {
+      emberData: {
+        debug: {
+            LOG_PAYLOADS: false, // data store received to update cache with
+            LOG_OPERATIONS: false, // updates to cache remote state
+            LOG_MUTATIONS: false, // updates to cache local state
+            LOG_NOTIFICATIONS: false,
+            LOG_REQUESTS: false,
+            LOG_REQUEST_STATUS: false,
+            LOG_IDENTIFIERS: false,
+            LOG_GRAPH: false,
+            LOG_INSTANCE_CACHE: false,
+        }
+      }
+    });
+    ```
+  
+    @class DebugLogging
+    @public
+   */
+  /**
+   * log payloads received by the store
+   * via `push` or returned from a delete/update/create
+   * operation.
+   *
+   * @property {boolean} LOG_PAYLOADS
+   * @public
+   */
+  export const LOG_PAYLOADS: boolean;
+  /**
+   * log remote-state updates to the cache
+   *
+   * @property {boolean} LOG_OPERATIONS
+   * @public
+   */
+  export const LOG_OPERATIONS: boolean;
+  /**
+   * log local-state updates to the cache
+   *
+   * @property {boolean} LOG_MUTATIONS
+   * @public
+   */
+  export const LOG_MUTATIONS: boolean;
+  /**
+   * log notifications received by the NotificationManager
+   *
+   * @property {boolean} LOG_NOTIFICATIONS
+   * @public
+   */
+  export const LOG_NOTIFICATIONS: boolean;
+  /**
+   * log requests issued by the RequestManager
+   *
+   * @property {boolean} LOG_REQUESTS
+   * @public
+   */
+  export const LOG_REQUESTS: boolean;
+  /**
+   * log updates to requests the store has issued to
+   * the network (adapter) to fulfill.
+   *
+   * @property {boolean} LOG_REQUEST_STATUS
+   * @public
+   */
+  export const LOG_REQUEST_STATUS: boolean;
+  /**
+   * log peek, generation and updates to
+   * Record Identifiers.
+   *
+   * @property {boolean} LOG_IDENTIFIERS
+   * @public
+   */
+  export const LOG_IDENTIFIERS: boolean;
+  /**
+   * log updates received by the graph (relationship pointer storage)
+   *
+   * @property {boolean} LOG_GRAPH
+   * @public
+   */
+  export const LOG_GRAPH: boolean;
+  /**
+   * log creation/removal of RecordData and Record
+   * instances.
+   *
+   * @property {boolean} LOG_INSTANCE_CACHE
+   * @public
+   */
+  export const LOG_INSTANCE_CACHE: boolean;
+}
+//# sourceMappingURL=debugging.d.ts.map

package/unstable-preview-types/debugging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debugging.d.ts","sourceRoot":"","sources":["../src/debugging.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,OAAe,CAAC;AAC3C;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,OAAe,CAAC;AAC7C;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,OAAe,CAAC;AAC5C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAe,CAAC;AAChD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,OAAe,CAAC;AAC3C;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAe,CAAC;AACjD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,OAAe,CAAC;AAC9C;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,OAAe,CAAC;AACxC;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAe,CAAC"}