ember-data-model-fragments 5.0.0-beta.8 → 5.0.0

package/CHANGELOG.md

@@ -6,6 +6,36 @@
 
 
 
+
+
+## v5.0.0 (2023-02-02)
+
+#### :bug: Bug Fix
+* [#455](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/455) Remove string index from fragment registry ([@charlesfries](https://github.com/charlesfries))
+
+#### Committers: 1
+- Charles Fries ([@charlesfries](https://github.com/charlesfries))
+
+## v5.0.0-beta.9 (2023-01-16)
+
+#### :rocket: Enhancement
+* [#445](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/445) chore: fix typescript declarations ([@charlesfries](https://github.com/charlesfries))
+* [#443](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/443) chore: add typescript definitions files ([@VincentMolinie](https://github.com/VincentMolinie))
+
+#### :bug: Bug Fix
+* [#447](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/447) Handle null record in isStateInitializing ([@richgt](https://github.com/richgt))
+
+#### :house: Internal
+* [#442](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/442) Bump terser from 4.8.0 to 4.8.1 ([@dependabot[bot]](https://github.com/apps/dependabot))
+* [#440](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/440) Bump shell-quote from 1.7.2 to 1.7.3 ([@dependabot[bot]](https://github.com/apps/dependabot))
+* [#410](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/410) Bump y18n from 4.0.0 to 4.0.3 ([@dependabot[bot]](https://github.com/apps/dependabot))
+* [#426](https://github.com/adopted-ember-addons/ember-data-model-fragments/pull/426) Bump follow-redirects from 1.14.7 to 1.14.8 ([@dependabot[bot]](https://github.com/apps/dependabot))
+
+#### Committers: 3
+- Charles Fries ([@charlesfries](https://github.com/charlesfries))
+- Rich Glazerman ([@richgt](https://github.com/richgt))
+- Vincent Molinié ([@VincentMolinie](https://github.com/VincentMolinie))
+
 ## v5.0.0-beta.8 (2022-06-07)
 
 #### :bug: Bug Fix

package/README.md

@@ -580,6 +580,36 @@ import AnimalSerializer from './animal';
 export default AnimalSerializer;
 ```
 
+## TypeScript
+
+TypeScript declarations are included out of the box. For additional type safety for `createFragment`, `push`, etc. you can index your fragment classes in the `FragmentRegistry`:
+
+```typescript
+// app/models/address.ts
+import Fragment from 'ember-data-model-fragments/fragment';
+import { attr } from '@ember-data/model';
+
+export default class AddressFragment extends Fragment {
+  @attr('string')
+  declare street: string;
+
+  @attr('string')
+  declare city: string;
+
+  @attr('string')
+  declare region: string;
+
+  @attr('string')
+  declare country: string;
+}
+
+declare module 'ember-data-model-fragments/types/registries/fragment' {
+  export default interface FragmentRegistry {
+    address: AddressFragment;
+  }
+}
+```
+
 ## Limitations
 
 ### Conflict Resolution

package/addon/record-data.js

@@ -238,7 +238,7 @@ export default class FragmentRecordData extends RecordData {
   }
 
   isStateInitializing() {
-    return gte('ember-data', '3.28.0') && !this._record.___recordState;
+    return gte('ember-data', '3.28.0') && !this._record?.___recordState;
   }
 
   // PUBLIC API

package/attributes.d.ts

@@ -0,0 +1,35 @@
+import Model from '@ember-data/model';
+import EmberArray from '@ember/array';
+import ComputedProperty from '@ember/object/computed';
+import Fragment from 'ember-data-model-fragments/fragment';
+import FragmentRegistry from 'ember-data-model-fragments/types/registries/fragment';
+// eslint-disable-next-line ember/use-ember-data-rfc-395-imports
+import TransformRegistry from 'ember-data/types/registries/transform';
+
+interface FragmentArray<T extends Fragment> extends EmberArray<T> {
+  addFragment(fragment: T): T;
+  removeFragment(fragment: T): T;
+  createFragment(attributes?: Partial<T>): T;
+}
+
+interface FragmentOptions<K extends keyof FragmentRegistry> {
+  polymorphic?: boolean;
+  typeKey?: string | ((data: FragmentRegistry[K], owner: Model) => string);
+  defaultValue?: Partial<FragmentRegistry[K]> | (() => Partial<FragmentRegistry[K]>);
+}
+
+type TransformType<K extends keyof TransformRegistry> = ReturnType<
+  TransformRegistry[K]['deserialize']
+>;
+
+export function fragment<K extends keyof FragmentRegistry>(
+  type: K,
+  options?: FragmentOptions<K>,
+): ComputedProperty<FragmentRegistry[K]>;
+export function fragmentArray<K extends keyof FragmentRegistry>(
+  type: K,
+  options?: FragmentOptions<K>,
+): ComputedProperty<FragmentArray<FragmentRegistry[K]>>;
+export function array<T extends keyof TransformRegistry>(): ComputedProperty<TransformRegistry[T]>;
+
+export function fragmentOwner(): ComputedProperty<Model>;

package/ext.d.ts

@@ -0,0 +1,9 @@
+import FragmentRegistry from 'ember-data-model-fragments/types/registries/fragment';	
+import EmberStore from '@ember-data/store';
+
+export class Store extends EmberStore {
+  createFragment<K extends keyof FragmentRegistry>(	
+    type: K,	
+    attributes?: Partial<FragmentRegistry[K]>,	
+  ): FragmentRegistry[K];
+}

package/fragment.d.ts

@@ -0,0 +1,5 @@
+import Model from '@ember-data/model';
+
+export default class Fragment extends Model {
+  _isFragment: true;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-data-model-fragments",
-  "version": "5.0.0-beta.8",
+  "version": "5.0.0",
   "description": "Ember Data addon to support nested JSON documents",
   "keywords": [
     "ember-addon",

package/record-data.d.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line ember/use-ember-data-rfc-395-imports
+import { RecordData } from 'ember-data/-private';
+
+export default class FragmentRecordData extends RecordData {}

package/types/registries/fragment.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Define all the models here.
+ */
+export default interface FragmentRegistry {}