@warp-drive/legacy 5.10.0-alpha.2 → 5.10.0-alpha.20

package/README.md

@@ -8,13 +8,11 @@
     />
 </p>
 
-![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=fdb155)
-![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=fdb155)
+![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive%2Flegacy/latest?label=version&style=flat&color=fdb155)
+![NPM Downloads](https://img.shields.io/npm/dm/%40warp-drive%2Flegacy.svg?style=flat&color=fdb155)
 ![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=fdb155)
-[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS
-)
-[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S
-)
+[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS)
+[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S)
 
 # @warp-drive/legacy
 
@@ -28,14 +26,39 @@ Decommissioned Features from <em>Warp</em><strong>Drive</strong> that your App m
 
 > [!WARNING]
 > This package provides support for older ***Warp*Drive** features that have been
-> deprecated and removed from [@warp-drive/core](https://canary.warp-drive.io/api/@warp-drive/core/).
+> deprecated and removed from [@warp-drive/core](https://warp-drive.io/api/@warp-drive/core/).
 >
 > **Projects using these features should refactor away from them with urgency**
 
+## Usage
+
+`useLegacyStore` produces a Store class with the legacy features switched on:
+
+```ts
+import { useLegacyStore } from '@warp-drive/legacy';
+import { JSONAPICache } from '@warp-drive/json-api';
+
+export default useLegacyStore({
+  // false: relationships still resolve via adapters, not links
+  linksMode: false,
+  // true: keep the legacy request methods and adapter/serializer infrastructure
+  legacyRequests: true,
+  cache: JSONAPICache,
+  schemas: [],
+});
+```
+
 ## Documentation
 
-*Get Started* → [Guides](https://docs.warp-drive.io)
+*Get Started* → [Guides](https://warp-drive.io/guides/)
+
+API docs for this package → [@warp-drive/legacy](https://warp-drive.io/api/@warp-drive/legacy/)
 
+- [Setup](https://warp-drive.io/guides/configuration/#configure-the-store): create a Store with `useLegacyStore` in the LegacyMode tab.
+- [Legacy Feature Setup for Ember Apps](https://warp-drive.io/guides/configuration/ember): which legacy features `@warp-drive/legacy` restores, and when you still need the `LegacyNetworkHandler`.
+- [LegacyMode](https://warp-drive.io/guides/the-manual/schemas/resources/legacy-mode): emulate `Model` with a schema, using `withDefaults` and `registerDerivations` from this package.
+- [Relationships](https://warp-drive.io/guides/the-manual/relational-data/): the relationship configuration pages show each relationship defined with `@warp-drive/legacy/model` as well as with schemas.
+- [Typing Models & Transforms](https://warp-drive.io/guides/the-manual/typescript/typing-models): type `Model` classes, their fields and their transforms.
 
 <br>
 
@@ -48,3 +71,63 @@ Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blo
 ### License
 
 This project is licensed under the [MIT License](LICENSE.md).
+
+### ♥️ Credits
+
+ <details>
+   <summary>Brought to you with ♥️ love by <a href="https://emberjs.com" title="EmberJS">🐹 Ember</a></summary>
+
+  <style type="text/css">
+    img.project-logo {
+       padding: 0 5em 1em 5em;
+       width: 100px;
+       border-bottom: 2px solid #bbb;
+       margin: 0 auto;
+       display: block;
+     }
+    details > summary {
+      font-size: 1.1rem;
+      line-height: 1rem;
+      margin-bottom: 1rem;
+    }
+    details {
+      font-size: 1rem;
+    }
+    details > summary strong {
+      display: inline-block;
+      padding: .2rem 0;
+      color: #000;
+      border-bottom: 3px solid #bbb;
+    }
+
+    details > details {
+      margin-left: 2rem;
+    }
+    details > details > summary {
+      font-size: 1rem;
+      line-height: 1rem;
+      margin-bottom: 1rem;
+    }
+    details > details > summary strong {
+      display: inline-block;
+      padding: .2rem 0;
+      color: #555;
+      border-bottom: 2px solid #555;
+    }
+    details > details {
+      font-size: .85rem;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      details > summary strong {
+        color: #fff;
+      }
+    }
+    @media (prefers-color-scheme: dark) {
+      details > details > summary strong {
+        color: #afaba0;
+      border-bottom: 2px solid #afaba0;
+      }
+    }
+  </style>
+</details>

package/blueprints/adapter/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/adapter/index.js

@@ -0,0 +1,27 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an ember-data Adapter.',
+
+  availableOptions: [{ name: 'base-class', type: String }],
+
+  async locals(options) {
+    const { generateAdapterSource } = await import('warp-drive/generators/adapter');
+
+    const isAddon = options.inRepoAddon || options.project.isEmberCLIAddon();
+
+    return {
+      content: generateAdapterSource(options.entity.name, {
+        cwd: options.project.root,
+        isAddon,
+        baseClass: options.baseClass,
+        packageName: this.packageName ?? '@warp-drive/legacy/adapter',
+        importStyle: this.importStyle ?? 'named',
+      }),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'files');
+  },
+};

package/blueprints/adapter-test/index.js

@@ -0,0 +1,33 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an EmberData adapter unit test',
+  supportsAddon() {
+    return false;
+  },
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'adapters');
+      },
+    };
+  },
+
+  async locals(options) {
+    const { generateUnitTestSource } = await import('warp-drive/generators/tests');
+    const { dasherize } = await import('warp-drive/generators/strings');
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+
+    return {
+      content: generateUnitTestSource('Adapter', options.entity.name, modulePrefix),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files');
+  },
+};

package/blueprints/adapter-test/qunit-files/__root__/__path__/__test__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/model/HELP.md

@@ -0,0 +1,26 @@
+<grey>You may generate models with as many attrs as you would like to pass. The following attribute types are supported:</grey>
+<yellow><attr-name></yellow>
+<yellow><attr-name></yellow>:array
+<yellow><attr-name></yellow>:boolean
+<yellow><attr-name></yellow>:date
+<yellow><attr-name></yellow>:object
+<yellow><attr-name></yellow>:number
+<yellow><attr-name></yellow>:string
+<yellow><attr-name></yellow>:your-custom-transform
+<yellow><attr-name></yellow>:belongs-to:<yellow><model-name></yellow>
+<yellow><attr-name></yellow>:has-many:<yellow><model-name></yellow>
+
+For instance: <green>\`ember generate model taco filling:belongs-to:protein toppings:has-many:toppings name:string price:number misc\`</green>
+would result in the following model:
+
+```js
+import Model, { belongsTo, hasMany, attr } from '@ember-data/model';
+
+export default class TacoModel extends Model {
+  @belongsTo('protein', { async: false, inverse: null }) filling;
+  @hasMany('topping', { async: false, inverse: null }) toppings;
+  @attr('string') name;
+  @attr('number') price;
+  @attr misc;
+}
+```

package/blueprints/model/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/model/index.js

@@ -0,0 +1,27 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an ember-data Model.',
+
+  anonymousOptions: ['name', 'attr:type'],
+
+  async locals(options) {
+    const { generateModelSource } = await import('warp-drive/generators/model');
+
+    const entityOptions = options.entity.options;
+    const rawAttrs = Object.keys(entityOptions).map((name) => {
+      const type = entityOptions[name];
+      return type ? `${name}:${type}` : name;
+    });
+
+    return {
+      content: generateModelSource(options.entity.name, rawAttrs, {
+        packageName: this.packageName ?? '@warp-drive/legacy/model',
+      }),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'files');
+  },
+};

package/blueprints/model-test/index.js

@@ -0,0 +1,33 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an EmberData Model unit test',
+  supportsAddon() {
+    return false;
+  },
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'models');
+      },
+    };
+  },
+
+  async locals(options) {
+    const { generateUnitTestSource } = await import('warp-drive/generators/tests');
+    const { dasherize } = await import('warp-drive/generators/strings');
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+
+    return {
+      content: generateUnitTestSource('Model', options.entity.name, modulePrefix),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files');
+  },
+};

package/blueprints/model-test/qunit-files/__root__/__path__/__test__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/serializer/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/serializer/index.js

@@ -0,0 +1,27 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an ember-data Serializer.',
+
+  availableOptions: [{ name: 'base-class', type: String }],
+
+  async locals(options) {
+    const { generateSerializerSource } = await import('warp-drive/generators/serializer');
+
+    const isAddon = options.inRepoAddon || options.project.isEmberCLIAddon();
+
+    return {
+      content: generateSerializerSource(options.entity.name, {
+        cwd: options.project.root,
+        isAddon,
+        baseClass: options.baseClass,
+        packageName: this.packageName ?? '@warp-drive/legacy/serializer',
+        importStyle: this.importStyle ?? 'named',
+      }),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'files');
+  },
+};

package/blueprints/serializer-test/index.js

@@ -0,0 +1,33 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an EmberData Serializer unit test',
+  supportsAddon() {
+    return false;
+  },
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'serializers');
+      },
+    };
+  },
+
+  async locals(options) {
+    const { generateUnitTestSource } = await import('warp-drive/generators/tests');
+    const { dasherize } = await import('warp-drive/generators/strings');
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+
+    return {
+      content: generateUnitTestSource('Serializer', options.entity.name, modulePrefix),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files');
+  },
+};

package/blueprints/serializer-test/qunit-files/__root__/__path__/__test__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/transform/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+<%= content %>

package/blueprints/transform/index.js

@@ -0,0 +1,17 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an ember-data Transform.',
+
+  async locals(options) {
+    const { generateTransformSource } = await import('warp-drive/generators/transform');
+
+    return {
+      content: generateTransformSource(options.entity.name),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'files');
+  },
+};

package/blueprints/transform-test/index.js

@@ -0,0 +1,33 @@
+const path = require('path');
+
+module.exports = {
+  description: 'Generates an EmberData Transform unit test',
+  supportsAddon() {
+    return false;
+  },
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'transforms');
+      },
+    };
+  },
+
+  async locals(options) {
+    const { generateUnitTestSource } = await import('warp-drive/generators/tests');
+    const { dasherize } = await import('warp-drive/generators/strings');
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+
+    return {
+      content: generateUnitTestSource('Transform', options.entity.name, modulePrefix),
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files');
+  },
+};

package/blueprints/transform-test/qunit-files/__root__/__path__/__test__.js

@@ -0,0 +1 @@
+<%= content %>

package/dist/{-private-DccRZQsm.js → -private-0_Oc-M3x.js}

@@ -6,7 +6,7 @@ import { waitFor } from "@warp-drive/core/signals/-leaked";
 import { getOrSetGlobal } from "@warp-drive/core/types/-private";
 import { getGlobalConfig, macroCondition } from "@embroider/macros";
 
-//#region src/compat/legacy-network-handler/snapshot-record-array.ts
+// src/compat/legacy-network-handler/snapshot-record-array.ts
 /**
 SnapshotRecordArray is not directly instantiable.
 Instances are provided to consuming application's
@@ -125,16 +125,14 @@ var SnapshotRecordArray = class {
 	}
 };
 
-//#endregion
-//#region src/compat/legacy-network-handler/identifier-has-id.ts
+// src/compat/legacy-network-handler/identifier-has-id.ts
 function assertIdentifierHasId(identifier) {
 	macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
 		if (!test) throw new Error(`Attempted to schedule a fetch for a record without an id.`);
 	})(identifier && identifier.id !== null);
 }
 
-//#endregion
-//#region src/compat/legacy-network-handler/legacy-data-utils.ts
+// src/compat/legacy-network-handler/legacy-data-utils.ts
 function iterateData(data, fn) {
 	if (Array.isArray(data)) return data.map(fn);
 	else return fn(data, 0);
@@ -144,8 +142,7 @@ function payloadIsNotBlank(adapterPayload) {
 	else return Object.keys(adapterPayload || {}).length !== 0;
 }
 
-//#endregion
-//#region src/compat/legacy-network-handler/serializer-response.ts
+// src/compat/legacy-network-handler/serializer-response.ts
 /**
 This is a helper method that validates a JSON API top-level document
 
@@ -191,8 +188,7 @@ function normalizeResponseHelper(serializer, store, modelClass, payload, id, req
 	return normalizedResponse;
 }
 
-//#endregion
-//#region src/compat/legacy-network-handler/snapshot.ts
+// src/compat/legacy-network-handler/snapshot.ts
 /**
 Snapshot is not directly instantiable.
 Instances are provided to a consuming application's
@@ -541,8 +537,7 @@ var Snapshot = class {
 	}
 };
 
-//#endregion
-//#region src/compat/legacy-network-handler/fetch-manager.ts
+// src/compat/legacy-network-handler/fetch-manager.ts
 const SaveOp = getOrSetGlobal("SaveOp", Symbol("SaveOp"));
 /**
 * @private
@@ -715,8 +710,8 @@ function _isLoading(cache, identifier) {
 function includesSatisfies(current, existing) {
 	if (!current?.length) return true;
 	if (!existing?.length) return false;
-	const arrCurrent = (Array.isArray(current) ? current : current.split(",")).sort();
-	const arrExisting = (Array.isArray(existing) ? existing : existing.split(",")).sort();
+	const arrCurrent = Array.isArray(current) ? current.toSorted() : current.split(",").sort();
+	const arrExisting = Array.isArray(existing) ? existing.toSorted() : existing.split(",").sort();
 	if (arrCurrent.join(",") === arrExisting.join(",")) return true;
 	for (let i = 0; i < arrCurrent.length; i++) if (!arrExisting.includes(arrCurrent[i])) return false;
 	return true;
@@ -895,10 +890,8 @@ function _flushPendingSave(store, pending) {
 	resolver.resolve(promise);
 }
 
-//#endregion
-//#region src/compat/-private.ts
+// src/compat/-private.ts
 function upgradeStore(store) {}
 
-//#endregion
 export { normalizeResponseHelper as a, assertIdentifierHasId as c, Snapshot as i, SnapshotRecordArray as l, FetchManager as n, iterateData as o, SaveOp as r, payloadIsNotBlank as s, upgradeStore as t };
-//# sourceMappingURL=-private-DccRZQsm.js.map
+//# sourceMappingURL=-private-0_Oc-M3x.js.map