Jsonapi class detection (#1153)

* Remove the unused code

* Add jsonapi class detection

* Document the new util function

docs/jsonapi/jsonapi-utils.md

@@ -117,3 +117,11 @@ clearCacheByType(type: IType);
 ```
 
 Clear the network cache for the given model type.
+
+### isJsonApiClass
+
+```typescript
+function isJsonApiClass(type: typeof PureModel | typeof Collection | typeof View): boolean;
+```
+
+Check if the given type is a JSON API class (was decorated with `jsonapi()`).

packages/datx-jsonapi/src/consts.ts

@@ -9,3 +9,5 @@ export const MODEL_RELATED_FIELD = 'jsonapiRelated';
 
 // eslint-disable-next-line no-useless-escape
 export const URL_REGEX = /^((https?\:)?\/\/)/;
+
+export const DATX_JSONAPI_CLASS = Symbol('@datx/jsonapi class');

packages/datx-jsonapi/src/decorateCollection.ts

@@ -35,6 +35,7 @@ import { libFetch, read } from './NetworkUtils';
 import { Response } from './Response';
 import { CachingStrategy } from '@datx/network';
 import { IGetAllResponse } from './interfaces/IGetAllResponse';
+import { DATX_JSONAPI_CLASS } from './consts';
 
 type TSerialisedStore = IRawCollection & { cache?: Array<Omit<ICacheInternal, 'collection'>> };
 
@@ -66,6 +67,8 @@ export function decorateCollection(
   BaseClass: typeof PureCollection,
 ): ICollectionConstructor<PureCollection & IJsonapiCollection> {
   class JsonapiCollection extends BaseClass {
+    public static [DATX_JSONAPI_CLASS] = true;
+
     public static types =
       BaseClass.types && BaseClass.types.length
         ? BaseClass.types.concat(GenericModel)

packages/datx-jsonapi/src/decorateModel.ts

@@ -2,6 +2,7 @@ import { PureCollection, PureModel } from '@datx/core';
 import { IRawModel, META_FIELD, setMeta } from '@datx/utils';
 
 import {
+  DATX_JSONAPI_CLASS,
   MODEL_LINKS_FIELD,
   MODEL_META_FIELD,
   MODEL_PERSISTED_FIELD,
@@ -24,6 +25,8 @@ const HYDRATIZATION_KEYS = [
 
 export function decorateModel(BaseClass: typeof PureModel): typeof PureModel {
   class JsonapiModel extends BaseClass {
+    public static [DATX_JSONAPI_CLASS] = true;
+
     /**
      * Should the autogenerated ID be sent to the server when creating a record
      *

packages/datx-jsonapi/src/decorateView.ts

@@ -6,6 +6,7 @@ import {
   PureModel,
   View,
 } from '@datx/core';
+import { DATX_JSONAPI_CLASS } from './consts';
 import { getAllResponses } from './helpers/utils';
 import { IGetAllResponse } from './interfaces/IGetAllResponse';
 
@@ -20,6 +21,8 @@ export function decorateView<U>(
   BaseClass: typeof View,
 ): IViewConstructor<IJsonapiModel, U & IJsonapiView> {
   class JsonapiView<M extends IJsonapiModel = IJsonapiModel> extends BaseClass {
+    public static [DATX_JSONAPI_CLASS] = true;
+
     protected __collection: IJsonapiCollection & PureCollection;
 
     constructor(

packages/datx-jsonapi/src/helpers/utils.ts

@@ -1,5 +1,6 @@
-import { IFieldDefinition, IReferenceDefinition, PureModel } from '@datx/core';
+import { Collection, IFieldDefinition, IReferenceDefinition, PureModel, View } from '@datx/core';
 import { getMeta } from '@datx/utils';
+import { DATX_JSONAPI_CLASS } from '../consts';
 import { IGetAllResponse } from '../interfaces/IGetAllResponse';
 import { IJsonapiModel } from '../interfaces/IJsonapiModel';
 import { Response } from '../Response';
@@ -76,3 +77,7 @@ export async function getAllResponses<M extends IJsonapiModel = IJsonapiModel>(
     lastResponse,
   };
 }
+
+export function isJsonApiClass(type: typeof PureModel | typeof Collection | typeof View): boolean {
+  return DATX_JSONAPI_CLASS in type;
+}

packages/datx-jsonapi/src/index.ts

@@ -17,10 +17,8 @@ export {
   saveModel,
 } from './helpers/model';
 
-export {
-  prepareQuery,
-  buildUrl
-} from './helpers/url';
+export { prepareQuery, buildUrl } from './helpers/url';
+export { isJsonApiClass } from './helpers/utils';
 
 export { BaseJsonapiRequest } from './BaseRequest';
 
@@ -63,3 +61,11 @@ export {
   clearAllCache,
   clearCacheByType,
 } from '@datx/network';
+
+export {
+  MODEL_LINKS_FIELD,
+  MODEL_META_FIELD,
+  MODEL_PERSISTED_FIELD,
+  MODEL_REF_LINKS_FIELD,
+  MODEL_REF_META_FIELD,
+} from './consts';

packages/datx-jsonapi/test/general.test.ts

@@ -1,7 +1,7 @@
-import { Collection, getModelId, getModelType, Model } from '@datx/core';
+import { Collection, getModelId, getModelType, Model, PureModel, View } from '@datx/core';
 import { mobx } from '@datx/utils';
 
-import { getModelRefLinks, jsonapi, modelToJsonApi } from '../src';
+import { getModelRefLinks, isJsonApiClass, jsonapi, modelToJsonApi } from '../src';
 import { Event, Image, Photo, TestStore, User } from './utils/setup';
 
 describe('General', () => {
@@ -715,4 +715,20 @@ describe('General', () => {
       expect(data.relationships.image.data).toBeNull();
     }
   });
+
+  it('should detect jsonapi classes', () => {
+    class PlainModel extends Model {}
+    class JsonapiModel extends jsonapi(Model) {}
+    class PlainCollection extends Collection {}
+    class JsonapiCollection extends jsonapi(Collection) {}
+    class PlainView extends View {}
+    class JsonapiView extends jsonapi(View<PureModel>) {}
+
+    expect(isJsonApiClass(PlainModel)).toBe(false);
+    expect(isJsonApiClass(JsonapiModel)).toBe(true);
+    expect(isJsonApiClass(PlainCollection)).toBe(false);
+    expect(isJsonApiClass(JsonapiCollection)).toBe(true);
+    expect(isJsonApiClass(PlainView as typeof View)).toBe(false);
+    expect(isJsonApiClass(JsonapiView as typeof View)).toBe(true);
+  });
 });

packages/datx-jsonapi/test/issues.test.ts

@@ -6,7 +6,6 @@ import { getModelMeta, getModelRefMeta, jsonapi, modelToJsonApi, config } from '
 import { setupNetwork, setRequest, confirmNetwork } from './utils/api';
 import { Event, LineItem, TestStore } from './utils/setup';
 import { clearAllCache } from '../src/cache';
-import { flattenModel } from '../src/helpers/model';
 
 describe('Issues', () => {
   beforeEach(() => {
@@ -444,18 +443,6 @@ describe('Issues', () => {
 
     const newOrder1 = new Order({ created_at: new Date(), retrieveAt: new Date() });
     const newOrder2 = store.add({ created_at: new Date(), retrieveAt: new Date() }, Order);
-    console.log(
-      flattenModel(
-        {
-          [Order.type]: Order,
-        },
-        {
-          id: '123',
-          type: 'orders',
-          attributes: { created_at: new Date(), retrieve_at: new Date() },
-        },
-      ),
-    );
     const newOrder3 = store.sync({
       data: {
         id: '123',

website/versioned_docs/version-2.0.0/jsonapi/jsonapi-utils.md

@@ -118,3 +118,11 @@ clearCacheByType(type: IType);
 ```
 
 Clear the network cache for the given model type.
+
+### isJsonApiClass
+
+```typescript
+function isJsonApiClass(type: typeof PureModel | typeof Collection | typeof View): boolean;
+```
+
+Check if the given type is a JSON API class (was decorated with `jsonapi()`).