@ember-data-mirror/serializer 5.3.4

package/LICENSE.md

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+
+Copyright (C) 2017-2023 Ember.js contributors
+Portions Copyright (C) 2011-2017 Tilde, Inc. and contributors.
+Portions Copyright (C) 2011 LivingSocial Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+<p align="center">
+  <img
+    class="project-logo"
+    src="./ember-data-logo-dark.svg#gh-dark-mode-only"
+    alt="EmberData Serializer"
+    width="240px"
+    title="EmberData Serializer"
+    />
+  <img
+    class="project-logo"
+    src="./ember-data-logo-light.svg#gh-light-mode-only"
+    alt="EmberData Serializer"
+    width="240px"
+    title="EmberData Serializer"
+    />
+</p>
+
+<p align="center">Provides JSON, REST and JSON:API Implementations of the legacy <a href="https://api.emberjs.com/ember-data/release/classes/%3CInterface%3E%20Serializer">Serializer Interface</a></p>
+
+> **Caution** ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
+> If starting a new app or thinking of implementing a new serializer, consider writing a [Handler](https://api.emberjs.com/ember-data/release/classes/%3CInterface%3E%20Handler)
+> instead to be used with the [RequestManager](https://github.com/emberjs/data/tree/main/packages/request#readme)
+
+## Installation
+
+This package is currently installed when installing `ember-data`.
+
+If installing `@ember-data/` packages individually install using your javascript package manager of choice. For instance with [pnpm](https://pnpm.io/)
+
+```no-highlight
+pnpm add @ember-data-mirror/serializer
+```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/serializer/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/serializer/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/serializer/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/serializer/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/serializer/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
+## 🚀 Setup
+
+If using `ember-data` no additional setup is necesssary.
+
+> **Note**
+> When using [ember-data](https://github.com/emberjs/data/blob/main/packages/-ember-data) the below
+> configuration is handled for you automatically.
+
+To use legacy serializers you will need to have installed and configured the LegacyNetworkHandler from [@ember-data-mirror/legacy-compat](https://github.com/emberjs/data/blob/main/packages/-ember-data)
+
+```no-highlight
+pnpm add @ember-data-mirror/legacy-compat
+```
+
+```ts
+import Store, { CacheHandler } from '@ember-data-mirror/store';
+import RequestManager from '@ember-data-mirror/request';
+import { LegacyNetworkHandler } from '@ember-data-mirror/legacy-compat';
+
+export default class extends Store {
+  requestManager = new RequestManager();
+
+  constructor(args) {
+    super(args);
+    this.requestManager.use([LegacyNetworkHandler]);
+    this.requestManager.useCache(CacheHandler);
+  }
+}
+```
+
+
+## Usage
+
+To use as either a per-type or application serializer, export one of the
+implementations within the `serializers/` directory of your app as appropriate.
+
+For instance, to configure an application serializer to use `JSON:API`
+
+
+*app/serializers/application.ts*
+```ts
+export { default } from '@ember-data-mirror/serializer/json-api';
+```
+
+By default serializers are resolved by looking for a serializer with the same name in the `serializers/` folder as the `type` given to `store.serializerFor(<type>)`, falling back to looking for a serializer named `application`.
+
+**Overriding Resolution**
+
+If you would like to avoid using resolver semantics and your application has only one or a few serializers, you may ovveride the `serializerFor` hook on the store.
+
+```ts
+import Store from '@ember-data-mirror/store';
+import Serializer from '@ember-data-mirror/serializer/json-api';
+
+class extends Store {
+  #serializer = new Serializer();
+
+  serializerFor() {
+    return this.#serializer;
+  }
+}
+```
+
+
+For the full list of APIs available read the code documentation for [@ember-data-mirror/serializer](https://api.emberjs.com/ember-data/release/modules/@ember-data%2Fserializer). You may also be interested in learning more about *Ember***Data**'s [Serializer Interface](https://api.emberjs.com/ember-data/release/classes/%3CInterface%3E%20Serializer).

package/addon-main.cjs

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

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

@@ -0,0 +1,4 @@
+<%= importStatement %>
+
+export default <%= baseClass %>.extend({
+});

package/blueprints/serializer/index.js

@@ -0,0 +1,80 @@
+const path = require('path');
+const fs = require('fs');
+
+const stringUtil = require('ember-cli-string-utils');
+const pathUtil = require('ember-cli-path-utils');
+
+const { has } = require('@ember/edition-utils');
+
+module.exports = {
+  description: 'Generates an ember-data Serializer.',
+
+  availableOptions: [{ name: 'base-class', type: String }],
+
+  root: __dirname,
+
+  filesPath() {
+    let hasOctane = has('octane');
+    if (hasOctane && process.env.EMBER_EDITION === 'classic') {
+      hasOctane = false; //forcible override
+    }
+    let rootPath = hasOctane ? 'native-files' : 'files';
+    return path.join(__dirname, rootPath);
+  },
+
+  locals(options) {
+    return extendFromApplicationEntity('serializer', 'JSONAPISerializer', options);
+  },
+};
+
+function extendFromApplicationEntity(type, baseClass, options) {
+  let isAddon = options.inRepoAddon || options.project.isEmberCLIAddon();
+
+  let entityName = options.entity.name;
+  let relativePath = pathUtil.getRelativePath(options.entity.name);
+
+  if (options.pod && options.podPath) {
+    relativePath = pathUtil.getRelativePath(options.podPath + options.entity.name);
+  }
+
+  let applicationEntityPath = path.join(options.project.root, 'app', `${type}s`, 'application.js');
+
+  let hasApplicationEntity = fs.existsSync(applicationEntityPath);
+  if (!isAddon && !options.baseClass && entityName !== 'application' && hasApplicationEntity) {
+    options.baseClass = 'application';
+  }
+
+  if (options.baseClass === entityName) {
+    throw new Error(
+      stringUtil.classify(type) +
+        's cannot extend from themself. To resolve this, remove the `--base-class` option or change to a different base-class.'
+    );
+  }
+
+  let importStatement;
+
+  if (options.baseClass) {
+    let baseClassPath = options.baseClass;
+    baseClass = stringUtil.classify(baseClassPath.replace('/', '-'));
+    baseClass = baseClass + stringUtil.classify(type);
+
+    importStatement = `import ${baseClass} from '${relativePath}${baseClassPath}';`;
+  } else {
+    let baseClassPath = `@ember-data/${type}`;
+
+    if (baseClass.startsWith('JSONAPI')) {
+      baseClassPath += '/json-api';
+    }
+
+    if (baseClass.startsWith('REST')) {
+      baseClassPath += '/rest';
+    }
+
+    importStatement = `import ${baseClass} from '${baseClassPath}';`;
+  }
+
+  return {
+    importStatement,
+    baseClass,
+  };
+}

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

@@ -0,0 +1,4 @@
+<%= importStatement %>
+
+export default class <%= classifiedModuleName %>Serializer extends <%= baseClass %> {
+}

package/blueprints/serializer-test/index.js

@@ -0,0 +1,35 @@
+const path = require('path');
+
+const testInfo = require('ember-cli-test-info');
+const { dasherize } = require('ember-cli-string-utils');
+
+module.exports = {
+  description: 'Generates an EmberData Serializer unit test',
+  supportsAddon() { return false; },
+
+  root: __dirname,
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'serializers');
+      },
+    };
+  },
+
+  locals(options) {
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+    return {
+      friendlyTestDescription: testInfo.description(options.entity.name, 'Unit', 'Serializer'),
+      modulePrefix,
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files')
+  }
+};
+

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

@@ -0,0 +1,23 @@
+import { setupTest } from '<%= modulePrefix %>/tests/helpers';
+import { module, test } from 'qunit';
+
+module('<%= friendlyTestDescription %>', function (hooks) {
+  setupTest(hooks);
+
+  // Replace this with your real tests.
+  test('it exists', function (assert) {
+    const store = this.owner.lookup('service:store');
+    const serializer = store.serializerFor('<%= dasherizedModuleName %>');
+
+    assert.ok(serializer, 'serializer exists');
+  });
+
+  test('it serializes records', function (assert) {
+    const store = this.owner.lookup('service:store');
+    const record = store.createRecord('<%= dasherizedModuleName %>', {});
+
+    const serializedRecord = record.serialize();
+
+    assert.ok(serializedRecord, 'it serializes records');
+  });
+});

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

@@ -0,0 +1,13 @@
+export default class <%= classifiedModuleName %>Transform {
+  deserialize(serialized) {
+    return serialized;
+  }
+
+  serialize(deserialized) {
+    return deserialized;
+  }
+
+  static create() {
+    return new this();
+  }
+}

package/blueprints/transform/index.js

@@ -0,0 +1,17 @@
+const path = require('path');
+
+const { has } = require('@ember/edition-utils');
+
+module.exports = {
+  description: 'Generates an ember-data Transform.',
+  root: __dirname,
+
+  filesPath() {
+    let hasOctane = has('octane');
+    if (hasOctane && process.env.EMBER_EDITION === 'classic') {
+      hasOctane = false; //forcible override
+    }
+    let rootPath = hasOctane ? 'native-files' : 'files';
+    return path.join(__dirname, rootPath);
+  },
+};

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

@@ -0,0 +1,13 @@
+export default class <%= classifiedModuleName %>Transform {
+  deserialize(serialized) {
+    return serialized;
+  }
+
+  serialize(deserialized) {
+    return deserialized;
+  }
+
+  static create() {
+    return new this();
+  }
+}

package/blueprints/transform-test/index.js

@@ -0,0 +1,35 @@
+const path = require('path');
+
+const testInfo = require('ember-cli-test-info');
+const { dasherize } = require('ember-cli-string-utils');
+
+module.exports = {
+  description: 'Generates an EmberData Transform unit test',
+  supportsAddon() { return false; },
+
+  root: __dirname,
+
+  fileMapTokens() {
+    return {
+      __root__() {
+        return 'tests';
+      },
+      __path__() {
+        return path.join('unit', 'transforms');
+      },
+    };
+  },
+
+  locals(options) {
+    const modulePrefix = dasherize(options.project.config().modulePrefix);
+    return {
+      friendlyTestDescription: testInfo.description(options.entity.name, 'Unit', 'Transform'),
+      modulePrefix,
+    };
+  },
+
+  filesPath() {
+    return path.join(__dirname, 'qunit-files')
+  }
+};
+

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

@@ -0,0 +1,12 @@
+import { setupTest } from '<%= modulePrefix %>/tests/helpers';
+import { module, test } from 'qunit';
+
+module('<%= friendlyTestDescription %>', function (hooks) {
+  setupTest(hooks);
+
+  // Replace this with your real tests.
+  test('it exists', function (assert) {
+    const transform = this.owner.lookup('transform:<%= dasherizedModuleName %>');
+    assert.ok(transform, 'transform exists');
+  });
+});