feat: typed serializers

emberjs · Mar 11, 2024 · 69c9e08 · 69c9e08
1 parent 7127828
commit 69c9e08
Show file tree

Hide file tree

Showing 11 changed files with 531 additions and 359 deletions.
diff --git a/packages/model/src/-private/model.d.ts b/packages/model/src/-private/model.d.ts
@@ -71,7 +71,7 @@ class Model extends EmberObject {
  binding?: T
  ): void;
  static eachTransformedAttribute<K extends keyof this & string>(
- callback: (this: ModelSchema<this>, key: K, type: string | null) => void,
+ callback: (this: ModelSchema<this>, key: K, type: string) => void,
  binding?: T
  ): void;
 

diff --git a/packages/serializer/.eslintrc.cjs b/packages/serializer/.eslintrc.cjs
@@ -17,7 +17,7 @@ module.exports = {
  isolation.rules({
  allowedImports: [
  'ember-inflector',
- '@ember/application',
+ '@ember/owner',
  '@ember/service',
  '@ember/debug',
  '@ember/object',

diff --git a/packages/serializer/package.json b/packages/serializer/package.json
@@ -49,6 +49,7 @@
  "peerDependencies": {
  "@ember/string": "^3.1.1",
  "@warp-drive/core-types": "workspace:0.0.0-alpha.21",
+ "@ember-data/legacy-compat": "workspace:5.4.0-alpha.35",
  "ember-inflector": "^4.0.2"
  },
  "dependenciesMeta": {
@@ -72,6 +73,9 @@
  },
  "@ember-data/tracking": {
  "injected": true
+ },
+ "@ember-data/legacy-compat": {
+ "injected": true
  }
  },
  "dependencies": {
@@ -95,6 +99,7 @@
  "@ember-data/request": "workspace:5.4.0-alpha.35",
  "@ember-data/store": "workspace:5.4.0-alpha.35",
  "@ember-data/tracking": "workspace:5.4.0-alpha.35",
+ "@ember-data/legacy-compat": "workspace:5.4.0-alpha.35",
  "@ember/string": "^3.1.1",
  "@embroider/addon-dev": "^4.1.2",
  "@glimmer/component": "^1.1.2",

diff --git a/packages/serializer/src/-private/transforms/boolean.ts b/packages/serializer/src/-private/transforms/boolean.ts
@@ -2,6 +2,8 @@
  @module @ember-data/serializer
 */
 
+import { TransformName } from '@warp-drive/core-types/symbols';
+
 /**
  The `BooleanTransform` class is used to serialize and deserialize
  boolean attributes on Ember Data record objects. This transform is
@@ -62,6 +64,8 @@ export default class BooleanTransform {
  return Boolean(deserialized);
  }
 
+ [TransformName] = 'boolean' as const;
+
  static create() {
  return new this();
  }

diff --git a/packages/serializer/src/-private/transforms/date.ts b/packages/serializer/src/-private/transforms/date.ts
@@ -2,6 +2,8 @@
  @module @ember-data/serializer
 */
 
+import { TransformName } from '@warp-drive/core-types/symbols';
+
 /**
  The `DateTransform` class is used to serialize and deserialize
  date attributes on Ember Data record objects. This transform is used
@@ -53,6 +55,8 @@ export default class DateTransform {
  }
  }
 
+ [TransformName] = 'date' as const;
+
  static create() {
  return new this();
  }

diff --git a/packages/serializer/src/-private/transforms/number.ts b/packages/serializer/src/-private/transforms/number.ts
@@ -2,6 +2,8 @@
  @module @ember-data/serializer
 */
 
+import { TransformName } from '@warp-drive/core-types/symbols';
+
 function isNumber(value: number) {
  return value === value && value !== Infinity && value !== -Infinity;
 }
@@ -48,6 +50,8 @@ export default class NumberTransform {
  }
  }
 
+ [TransformName] = 'number' as const;
+
  static create() {
  return new this();
  }

diff --git a/packages/serializer/src/-private/transforms/string.ts b/packages/serializer/src/-private/transforms/string.ts
@@ -2,6 +2,8 @@
  @module @ember-data/serializer
 */
 
+import { TransformName } from '@warp-drive/core-types/symbols';
+
 /**
  The `StringTransform` class is used to serialize and deserialize
  string attributes on Ember Data record objects. This transform is
@@ -31,6 +33,8 @@ export default class StringTransform {
  return !deserialized && deserialized !== '' ? null : String(deserialized);
  }
 
+ [TransformName] = 'string' as const;
+
  static create() {
  return new this();
  }

diff --git a/packages/serializer/src/index.ts b/packages/serializer/src/index.ts
@@ -112,6 +112,7 @@ import { inject as service } from '@ember/service';
 
 import type Store from '@ember-data/store';
 import type { ModelSchema } from '@ember-data/store/-types/q/ds-model';
+import type { EmptyResourceDocument, SingleResourceDocument } from '@warp-drive/core-types/spec/raw';
 
 /**
  > ⚠️ CAUTION you likely want the docs for [<Interface> Serializer](/ember-data/release/classes/%3CInterface%3E%20Serializer)
@@ -265,7 +266,7 @@ export default class extends EmberObject {
  @param {Object} hash
  @return {Object}
  */
- normalize(_typeClass: ModelSchema, hash: Record<string, unknown>): Record<string, unknown> {
- return hash;
+ normalize(_typeClass: ModelSchema, hash: Record<string, unknown>): SingleResourceDocument | EmptyResourceDocument {
+ return hash as unknown as SingleResourceDocument;
  }
 }