@warp-drive/legacy 5.10.0-alpha.10 → 5.10.0-alpha.13

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

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

package/blueprints/adapter/index.js

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

package/blueprints/adapter-test/index.js

@@ -6,8 +6,6 @@ module.exports = {
     return false;
   },
 
-  root: __dirname,
-
   fileMapTokens() {
     return {
       __root__() {

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

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

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

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

package/blueprints/model/index.js

@@ -1,10 +1,10 @@
+const path = require('path');
+
 module.exports = {
   description: 'Generates an ember-data Model.',
 
   anonymousOptions: ['name', 'attr:type'],
 
-  root: __dirname,
-
   async locals(options) {
     const { generateModelSource } = await import('warp-drive/generators/model');
 
@@ -15,7 +15,13 @@ module.exports = {
     });
 
     return {
-      content: generateModelSource(options.entity.name, rawAttrs, { packageName: '@warp-drive/legacy/model' }),
+      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

@@ -6,8 +6,6 @@ module.exports = {
     return false;
   },
 
-  root: __dirname,
-
   fileMapTokens() {
     return {
       __root__() {

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

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

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

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

package/blueprints/serializer/index.js

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

package/blueprints/serializer-test/index.js

@@ -6,8 +6,6 @@ module.exports = {
     return false;
   },
 
-  root: __dirname,
-
   fileMapTokens() {
     return {
       __root__() {

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

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

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

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

package/blueprints/transform/index.js

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

package/blueprints/transform-test/index.js

@@ -6,8 +6,6 @@ module.exports = {
     return false;
   },
 
-  root: __dirname,
-
   fileMapTokens() {
     return {
       __root__() {

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

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