@ember-data/tracking 5.6.0-beta.0 → 5.6.0-beta.1

package/addon-main.cjs

@@ -1,5 +1,5 @@
 'use strict';
 
-const { addonShim } = require('@warp-drive/build-config/addon-shim.cjs');
+const { addonShim } = require('@warp-drive/core/addon-shim.cjs');
 
 module.exports = addonShim(__dirname);

package/dist/index.js

@@ -1,8 +1,85 @@
 import { tagForProperty } from '@ember/-internals/metal';
 import { _backburner } from '@ember/runloop';
 import { createCache, track, updateTag, consumeTag, getValue, dirtyTag } from '@glimmer/validator';
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { macroCondition, getGlobalConfig, importSync } from '@embroider/macros';
+
+/**
+ * # ~~@ember-data/tracking~~ <Badge type="warning" text="deprecated v5.5" />
+ *
+ * Using ***Warp*Drive** with EmberJS requires configuring it to use Ember's reactivity system.
+ *
+ * ::: warning
+ * The use of the package **@ember-data/tracking** is now deprecated. It
+ * historically provided the bindings into Ember's reactivity system.
+ *
+ * This package is no longer needed as the configuration is now
+ * provided by the package [@warp-drive/ember](../../@warp-drive/ember).
+ * :::
+ *
+ * To resolve this deprecation, follow these steps:
+ *
+ * ## 1. Remove @ember-data/tracking
+ *
+ * - Remove `@ember-data/tracking` from package.json (if using `ember-data` this may not be present)
+ * - Remove type imports for `@ember-data/tracking` from tsconfig.json
+ * - If using `untracked`, change to using `untrack` from `@glimmer/validator`
+ *
+ * ## 2. Add @warp-drive/ember
+ *
+ * - Add `@warp-drive/ember` to package.json - the version to install should match the version of `ember-data` or `@ember-data/store`
+ * - Do NOT add `@warp-drive/ember` to tsconfig.json - the types in this package install automatically, you can remove any entry for this if it is there
+ * - Add `import '@warp-drive/ember/install';` to the top of your `app.js` or `app.ts` file
+ *
+ * ## 3. Clear the deprecation
+ *
+ * Once the above steps are complete, the deprecation can be silenced and the automatic fallback
+ * registration of reactivity from `@ember-data/tracking` can be removed by updating your [WarpDrive
+ * build config](../../@warp-drive/build-config) in your `ember-cli-build` file.
+ *
+ * ```js [ember-cli-build.js]
+ * 'use strict';
+ * const EmberApp = require('ember-cli/lib/broccoli/ember-app');
+ * const { compatBuild } = require('@embroider/compat');
+ *
+ * module.exports = async function (defaults) {
+ *   const { setConfig } = await import('@warp-drive/build-config'); // [!code focus]
+ *   const { buildOnce } = await import('@embroider/vite');
+ *   const app = new EmberApp(defaults, {});
+ *
+ *   setConfig(app, __dirname, { // [!code focus:9]
+ *     // this should be the most recent <major>.<minor> version for
+ *     // which all deprecations have been fully resolved
+ *     // and should be updated when that changes
+ *     compatWith: '4.12'
+ *     deprecations: {
+ *       // ... list individual deprecations that have been resolved here
+ *       DEPRECATE_TRACKING_PACKAGE: false // [!code highlight]
+ *     }
+ *   });
+ *
+ *   return compatBuild(app, buildOnce);
+ * };
+ *```
+ *
+ * @deprecated in version 5.5.0
+ * @module
+ */
 const emberDirtyTag = dirtyTag;
+
+/**
+ * <Badge type="warning" text="deprecated" />
+ *
+ * Creates a signal configuration object for WarpDrive that integrates with Ember's
+ * reactivity system. This will be automatically imported and registered by
+ * `@ember-data/store` if the deprecation has not been resolved.
+ *
+ * This function should not be called directly in your application code
+ * and this package is deprecated entirely, see the [package overview](../../)
+ * for more details.
+ *
+ * @deprecated
+ * @public
+ */
 function buildSignalConfig(options) {
   const ARRAY_SIGNAL = options.wellknown.Array;
   return {
@@ -58,7 +135,17 @@ function buildSignalConfig(options) {
     willSyncFlushWatchers: () => {
       //@ts-expect-error
       return !!_backburner.currentInstance && _backburner._autorun !== true;
+    },
+    waitFor: async promise => {
+      if (macroCondition(getGlobalConfig().WarpDrive.env.TESTING)) {
+        const {
+          waitForPromise
+        } = importSync('@ember/test-waiters');
+        return waitForPromise(promise);
+      }
+      return promise;
     }
   };
 }
-export { buildSignalConfig };
+
+export { buildSignalConfig };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ember-data/tracking",
   "description": "DEPRECATED - Use @warp-drive/ember",
-  "version": "5.6.0-beta.0",
+  "version": "5.6.0-beta.1",
   "deprecated": "Use @warp-drive/ember",
   "private": false,
   "license": "MIT",
@@ -21,11 +21,10 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12",
-    "@warp-drive/build-config": "5.6.0-beta.0"
+    "@warp-drive/core": "5.6.0-beta.0"
   },
   "peerDependencies": {
-    "ember-source": "3.28.12 || ^4.0.4 || ^5.0.0 || ^6.0.0",
-    "@warp-drive/core-types": "5.6.0-beta.0"
+    "@ember/test-waiters": "^3.1.0 || ^4.0.0"
   },
   "files": [
     "unstable-preview-types",
@@ -57,13 +56,11 @@
     "@babel/plugin-transform-typescript": "^7.27.0",
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-typescript": "^7.27.0",
-    "@glimmer/component": "^2.0.0",
-    "@glimmer/validator": "^0.94.8",
-    "@warp-drive/core-types": "5.6.0-beta.0",
-    "@warp-drive/internal-config": "5.6.0-beta.0",
+    "@ember/test-waiters": "^4.1.0",
+    "@warp-drive/internal-config": "5.6.0-beta.1",
     "ember-source": "~6.3.0",
     "typescript": "^5.8.3",
-    "vite": "^5.4.15"
+    "vite": "^7.0.0"
   },
   "ember": {
     "edition": "octane"

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

@@ -1,18 +1,94 @@
 
 declare module '@ember-data/tracking' {
-  import { tagForProperty } from '@ember/-internals/metal';
+  /**
+  * # ~~@ember-data/tracking~~ <Badge type="warning" text="deprecated v5.5" />
+  *
+  * Using ***Warp*Drive** with EmberJS requires configuring it to use Ember's reactivity system.
+  *
+  * ::: warning
+  * The use of the package **@ember-data/tracking** is now deprecated. It
+  * historically provided the bindings into Ember's reactivity system.
+  *
+  * This package is no longer needed as the configuration is now
+  * provided by the package [@warp-drive/ember](../../@warp-drive/ember).
+  * :::
+  *
+  * To resolve this deprecation, follow these steps:
+  *
+  * ## 1. Remove @ember-data/tracking
+  *
+  * - Remove `@ember-data/tracking` from package.json (if using `ember-data` this may not be present)
+  * - Remove type imports for `@ember-data/tracking` from tsconfig.json
+  * - If using `untracked`, change to using `untrack` from `@glimmer/validator`
+  *
+  * ## 2. Add @warp-drive/ember
+  *
+  * - Add `@warp-drive/ember` to package.json - the version to install should match the version of `ember-data` or `@ember-data/store`
+  * - Do NOT add `@warp-drive/ember` to tsconfig.json - the types in this package install automatically, you can remove any entry for this if it is there
+  * - Add `import '@warp-drive/ember/install';` to the top of your `app.js` or `app.ts` file
+  *
+  * ## 3. Clear the deprecation
+  *
+  * Once the above steps are complete, the deprecation can be silenced and the automatic fallback
+  * registration of reactivity from `@ember-data/tracking` can be removed by updating your [WarpDrive
+  * build config](../../@warp-drive/build-config) in your `ember-cli-build` file.
+  *
+  * ```js [ember-cli-build.js]
+  * 'use strict';
+  * const EmberApp = require('ember-cli/lib/broccoli/ember-app');
+  * const { compatBuild } = require('@embroider/compat');
+  *
+  * module.exports = async function (defaults) {
+  *   const { setConfig } = await import('@warp-drive/build-config'); // [!code focus]
+  *   const { buildOnce } = await import('@embroider/vite');
+  *   const app = new EmberApp(defaults, {});
+  *
+  *   setConfig(app, __dirname, { // [!code focus:9]
+  *     // this should be the most recent <major>.<minor> version for
+  *     // which all deprecations have been fully resolved
+  *     // and should be updated when that changes
+  *     compatWith: '4.12'
+  *     deprecations: {
+  *       // ... list individual deprecations that have been resolved here
+  *       DEPRECATE_TRACKING_PACKAGE: false // [!code highlight]
+  *     }
+  *   });
+  *
+  *   return compatBuild(app, buildOnce);
+  * };
+  *```
+  *
+  * @deprecated in version 5.5.0
+  * @module
+  */
+  import { tagForProperty } from "@ember/-internals/metal";
   type Tag = ReturnType<typeof tagForProperty>;
+  /**
+  * <Badge type="warning" text="deprecated" />
+  *
+  * Creates a signal configuration object for WarpDrive that integrates with Ember's
+  * reactivity system. This will be automatically imported and registered by
+  * `@ember-data/store` if the deprecation has not been resolved.
+  *
+  * This function should not be called directly in your application code
+  * and this package is deprecated entirely, see the [package overview](../../)
+  * for more details.
+  *
+  * @deprecated
+  * @public
+  */
   export function buildSignalConfig(options: {
-      wellknown: {
-          Array: symbol | string;
-      };
+  	wellknown: {
+  		Array: symbol | string;
+  	};
   }): {
-      createSignal(obj: object, key: string | symbol): import("@glimmer/validator").Tag | readonly [import("@glimmer/validator").Tag, import("@glimmer/validator").Tag, import("@glimmer/validator").Tag];
-      consumeSignal(signal: Tag | [Tag, Tag, Tag]): void;
-      notifySignal(signal: Tag | [Tag, Tag, Tag]): void;
-      createMemo: <F>(object: object, key: string | symbol, fn: () => F) => (() => F);
-      willSyncFlushWatchers: () => boolean;
+  	createSignal(obj: object, key: string | symbol): Tag | [Tag, Tag, Tag];
+  	consumeSignal(signal: Tag | [Tag, Tag, Tag]): void;
+  	notifySignal(signal: Tag | [Tag, Tag, Tag]): void;
+  	createMemo: <F>(object: object, key: string | symbol, fn: () => F) => (() => F);
+  	willSyncFlushWatchers: () => boolean;
+  	waitFor: <K>(promise: Promise<K>) => Promise<K>;
   };
   export {};
-}
-//# sourceMappingURL=index.d.ts.map
+  
+}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { tagForProperty } from '@ember/-internals/metal';\nimport { _backburner } from '@ember/runloop';\nimport { consumeTag, createCache, dirtyTag, getValue, track, type UpdatableTag, updateTag } from '@glimmer/validator';\n\n// import { createCache, getValue } from '@glimmer/tracking/primitives/cache';\nimport { DEPRECATE_COMPUTED_CHAINS } from '@warp-drive/build-config/deprecations';\n\ntype Tag = ReturnType<typeof tagForProperty>;\nconst emberDirtyTag = dirtyTag as unknown as (tag: Tag) => void;\n\nexport function buildSignalConfig(options: {\n  wellknown: {\n    Array: symbol | string;\n  };\n}) {\n  const ARRAY_SIGNAL = options.wellknown.Array;\n\n  return {\n    createSignal(obj: object, key: string | symbol) {\n      if (DEPRECATE_COMPUTED_CHAINS) {\n        if (key === ARRAY_SIGNAL) {\n          return [tagForProperty(obj, key), tagForProperty(obj, 'length'), tagForProperty(obj, '[]')] as const;\n        }\n      }\n      return tagForProperty(obj, key);\n    },\n    consumeSignal(signal: Tag | [Tag, Tag, Tag]) {\n      if (DEPRECATE_COMPUTED_CHAINS) {\n        if (Array.isArray(signal)) {\n          consumeTag(signal[0]);\n          consumeTag(signal[1]);\n          consumeTag(signal[2]);\n          return;\n        }\n      }\n      consumeTag(signal as Tag);\n    },\n    notifySignal(signal: Tag | [Tag, Tag, Tag]) {\n      if (DEPRECATE_COMPUTED_CHAINS) {\n        if (Array.isArray(signal)) {\n          emberDirtyTag(signal[0]);\n          emberDirtyTag(signal[1]);\n          emberDirtyTag(signal[2]);\n          return;\n        }\n      }\n\n      emberDirtyTag(signal as Tag);\n    },\n    createMemo: <F>(object: object, key: string | symbol, fn: () => F): (() => F) => {\n      if (DEPRECATE_COMPUTED_CHAINS) {\n        const propertyTag = tagForProperty(object, key) as UpdatableTag;\n        const memo = createCache(fn);\n        let ret: F | undefined;\n        const wrappedFn = () => {\n          ret = getValue(memo) as F;\n        };\n        return () => {\n          const tag = track(wrappedFn);\n          updateTag(propertyTag, tag);\n          consumeTag(tag);\n          return ret!;\n        };\n      } else {\n        const memo = createCache(fn);\n        return () => getValue(memo) as F;\n      }\n    },\n    willSyncFlushWatchers: () => {\n      //@ts-expect-error\n      return !!_backburner.currentInstance && _backburner._autorun !== true;\n    },\n  };\n}\n"],"names":["emberDirtyTag","dirtyTag","buildSignalConfig","options","ARRAY_SIGNAL","wellknown","Array","createSignal","obj","key","macroCondition","getGlobalConfig","WarpDrive","deprecations","DEPRECATE_COMPUTED_CHAINS","tagForProperty","consumeSignal","signal","isArray","consumeTag","notifySignal","createMemo","object","fn","propertyTag","memo","createCache","ret","wrappedFn","getValue","tag","track","updateTag","willSyncFlushWatchers","_backburner","currentInstance","_autorun"],"mappings":";;;;;AAQA,MAAMA,aAAa,GAAGC,QAAyC;AAExD,SAASC,iBAAiBA,CAACC,OAIjC,EAAE;AACD,EAAA,MAAMC,YAAY,GAAGD,OAAO,CAACE,SAAS,CAACC,KAAK;EAE5C,OAAO;AACLC,IAAAA,YAAYA,CAACC,GAAW,EAAEC,GAAoB,EAAE;MAC9C,IAAAC,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,YAAA,CAAAC,yBAAA,CAA+B,EAAA;QAC7B,IAAIL,GAAG,KAAKL,YAAY,EAAE;UACxB,OAAO,CAACW,cAAc,CAACP,GAAG,EAAEC,GAAG,CAAC,EAAEM,cAAc,CAACP,GAAG,EAAE,QAAQ,CAAC,EAAEO,cAAc,CAACP,GAAG,EAAE,IAAI,CAAC,CAAC;AAC7F;AACF;AACA,MAAA,OAAOO,cAAc,CAACP,GAAG,EAAEC,GAAG,CAAC;KAChC;IACDO,aAAaA,CAACC,MAA6B,EAAE;MAC3C,IAAAP,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,YAAA,CAAAC,yBAAA,CAA+B,EAAA;AAC7B,QAAA,IAAIR,KAAK,CAACY,OAAO,CAACD,MAAM,CAAC,EAAE;AACzBE,UAAAA,UAAU,CAACF,MAAM,CAAC,CAAC,CAAC,CAAC;AACrBE,UAAAA,UAAU,CAACF,MAAM,CAAC,CAAC,CAAC,CAAC;AACrBE,UAAAA,UAAU,CAACF,MAAM,CAAC,CAAC,CAAC,CAAC;AACrB,UAAA;AACF;AACF;MACAE,UAAU,CAACF,MAAa,CAAC;KAC1B;IACDG,YAAYA,CAACH,MAA6B,EAAE;MAC1C,IAAAP,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,YAAA,CAAAC,yBAAA,CAA+B,EAAA;AAC7B,QAAA,IAAIR,KAAK,CAACY,OAAO,CAACD,MAAM,CAAC,EAAE;AACzBjB,UAAAA,aAAa,CAACiB,MAAM,CAAC,CAAC,CAAC,CAAC;AACxBjB,UAAAA,aAAa,CAACiB,MAAM,CAAC,CAAC,CAAC,CAAC;AACxBjB,UAAAA,aAAa,CAACiB,MAAM,CAAC,CAAC,CAAC,CAAC;AACxB,UAAA;AACF;AACF;MAEAjB,aAAa,CAACiB,MAAa,CAAC;KAC7B;AACDI,IAAAA,UAAU,EAAEA,CAAIC,MAAc,EAAEb,GAAoB,EAAEc,EAAW,KAAgB;MAC/E,IAAAb,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,YAAA,CAAAC,yBAAA,CAA+B,EAAA;AAC7B,QAAA,MAAMU,WAAW,GAAGT,cAAc,CAACO,MAAM,EAAEb,GAAG,CAAiB;AAC/D,QAAA,MAAMgB,IAAI,GAAGC,WAAW,CAACH,EAAE,CAAC;AAC5B,QAAA,IAAII,GAAkB;QACtB,MAAMC,SAAS,GAAGA,MAAM;AACtBD,UAAAA,GAAG,GAAGE,QAAQ,CAACJ,IAAI,CAAM;SAC1B;AACD,QAAA,OAAO,MAAM;AACX,UAAA,MAAMK,GAAG,GAAGC,KAAK,CAACH,SAAS,CAAC;AAC5BI,UAAAA,SAAS,CAACR,WAAW,EAAEM,GAAG,CAAC;UAC3BX,UAAU,CAACW,GAAG,CAAC;AACf,UAAA,OAAOH,GAAG;SACX;AACH,OAAC,MAAM;AACL,QAAA,MAAMF,IAAI,GAAGC,WAAW,CAACH,EAAE,CAAC;AAC5B,QAAA,OAAO,MAAMM,QAAQ,CAACJ,IAAI,CAAM;AAClC;KACD;IACDQ,qBAAqB,EAAEA,MAAM;AAC3B;MACA,OAAO,CAAC,CAACC,WAAW,CAACC,eAAe,IAAID,WAAW,CAACE,QAAQ,KAAK,IAAI;AACvE;GACD;AACH;;;;"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAOzD,KAAK,GAAG,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAG7C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE;IACzC,SAAS,EAAE;QACT,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;CACH;sBAIqB,MAAM,OAAO,MAAM,GAAG,MAAM;0BAQxB,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;yBAWtB,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;iBAY7B,CAAC,UAAU,MAAM,OAAO,MAAM,GAAG,MAAM,MAAM,MAAM,CAAC,KAAG,CAAC,MAAM,CAAC,CAAC;;EAwBhF"}