chore: fix typescript declarations (adopted-ember-addons#445)

* chore: fix typescript declarations

* fix

* remove attributes registry

* fix typo

Author: charlesfries

README.md

@@ -580,65 +580,33 @@ import AnimalSerializer from './animal';
 export default AnimalSerializer;
 ```
 
-## Typescript
+## TypeScript
 
-To use with typescript, define the following files in your project:
+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
-// types/ember-data-model-fragments/types/registries/fragment.d.ts
+// app/models/address.ts
 import Fragment from 'ember-data-model-fragments/fragment';
-
-import Product from '<your-app-name>/models/product';
-
-/**
- * Define all your fragments here.
- */
-export default interface FragmentRegistry {
-  [key: string]: Fragment;
-  'product': Product;
-}
-```
-
-And the following one which will help you validate entries when doing a `createFragment`, `push` on a fragmentArray, etc...
-
-```typescript
-// types/ember-data-model-fragments/types/registries/fragment-attributes.d.ts
-import Fragment from 'ember-data-model-fragments/fragment';
-
-import { ProductAttributes } from '<your-app-name>/models/product';
-
-/**
- * Define all your fragments attributes here.
- */
-export default interface FragmentRegistry {
-  [key: string]: Record<string, any>;
-  'product': ProductAttributes;
-}
-```
-
-Those attributes can be implemented like so:
-
-```typescript
-// app/models/product.ts
 import { attr } from '@ember-data/model';
-import Fragment from 'ember-data-model-fragments/fragment';
 
-import Order from './order';
+export default class AddressFragment extends Fragment {
+  @attr('string')
+  declare street: string;
 
-export interface ProductAttributes {
-  name: string;
-  orders: Array<Order>;
-}
+  @attr('string')
+  declare city: string;
+
+  @attr('string')
+  declare region: string;
 
-export default class Product
-  extends Fragment
-  implements ProductAttributes
-{
   @attr('string')
-  declare name: string;
+  declare country: string;
+}
 
-  @fragmentArray('order')
-  declare smartActions: Array<Order>;
+declare module 'ember-data-model-fragments/types/registries/fragment' {
+  export default interface FragmentRegistry {
+    address: AddressFragment;
+  }
 }
 ```
 

attributes.d.ts

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

ext.d.ts

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