Merge pull request #9 from klerick/new-sdk-version

feat(json-api-nestjs-sdk): new version sdk

Author: klerick

apps/example-react-client/src/app/app.tsx

@@ -1,6 +1,6 @@
 import styles from './app.module.css';
 import NxWelcome from './nx-welcome';
-import { getInstance } from 'json-api-nestjs-sdk';
+import { getInstance, getInstancePromise } from 'json-api-nestjs-sdk';
 import { BookList, Users, Roles, Comments, Addresses } from 'database/entity';
 
 const service = getInstance(
@@ -17,8 +17,16 @@ const service = getInstance(
   }
 );
 
+const servicePromise = getInstancePromise();
+
 export function App() {
-  service.getOne<Users>(Users, 17).subscribe((r) => console.log(r));
+  service
+    .getOne<Users>(Users, 17, { include: ['addresses'] })
+    .subscribe((r) => console.log(r));
+
+  servicePromise
+    .getOne<Users>(Users, 17, { include: ['addresses'] })
+    .then((r) => console.log(r));
   return (
     <>
       <NxWelcome title="example-react-client" />

babel.config.json

@@ -0,0 +1,4 @@
+{
+  "presets": [],
+  "babelrcRoots": ["*"]
+}

libs/json-api-nestjs-sdk/README.md

@@ -92,7 +92,10 @@ You can find more example [here](https://github.com/klerick/nestjs-json-api/blob
 ## Using with react, etc
 
 ```typescript
-import { getInstance } from 'json-api-nestjs-sdk';
+import { 
+    getInstance, 
+    getInstancePromise // If you want Promise as result 
+} from 'json-api-nestjs-sdk';
 import { Users } from 'database';
 
 const service = getInstance(
@@ -105,6 +108,4 @@ const service = getInstance(
   }
 );
 ```
-
-You should add [linker plugin](https://angular.io/guide/creating-libraries#consuming-partial-ivy-code-outside-the-angular-cli) in your webpack config
-You can find example webpack config [here](https://github.com/klerick/nestjs-json-api/blob/master/apps/example-react-client/webpack.config.ts)
+You should add [linker plugin](https://angular.io/guide/creating-libraries#consuming-partial-ivy-code-outside-the-angular-cli) in your webpack config. You can find example webpack config [here](https://github.com/klerick/nestjs-json-api/blob/master/apps/example-react-client/webpack.config.ts)

libs/json-api-nestjs-sdk/src/lib/init.ts

@@ -1,19 +1,21 @@
 import {
-  ENVIRONMENT_INITIALIZER,
   EnvironmentInjector,
   NgZone,
   StaticProvider,
   ɵcreateInjector as createInjector,
 } from '@angular/core';
 import { BrowserModule, platformBrowser } from '@angular/platform-browser';
+import { firstValueFrom, Observable } from 'rxjs';
 
 import { JsonApiSdkConfig, ListEntities } from './token/json-api-sdk';
 import { JsonApiSdkService } from './service/json-api-sdk/json-api-sdk.service';
 import { JsonApiUtilsService } from './service/json-api-utils/json-api-utils.service';
 import { JsonApiNestjsSdkModule } from './json-api-nestjs-sdk.module';
 import { NoopNgZone } from './utils/noop-ng-zone';
+import { JsonApiSdkServicePromise } from './types';
 
 let JsonApiSdkServiceLink: JsonApiSdkService;
+let JsonApiSdkServiceLinkPromise: JsonApiSdkServicePromise;
 
 export function getInstance(
   config: JsonApiSdkConfig,
@@ -62,3 +64,37 @@ export function getInstance(...arg: any[]): JsonApiSdkService {
     contextInjector.get<JsonApiSdkService>(JsonApiSdkService);
   return JsonApiSdkServiceLink;
 }
+
+export function getInstancePromise(
+  config: JsonApiSdkConfig,
+  entities: ListEntities
+): JsonApiSdkServicePromise;
+export function getInstancePromise(): JsonApiSdkServicePromise;
+export function getInstancePromise(...arg: any[]): JsonApiSdkServicePromise {
+  if (JsonApiSdkServiceLinkPromise) {
+    return JsonApiSdkServiceLinkPromise;
+  }
+
+  const instService = getInstance(arg[0], arg[1]);
+
+  JsonApiSdkServiceLinkPromise = new Proxy<JsonApiSdkServicePromise>(
+    instService as any,
+    {
+      get(
+        target: JsonApiSdkServicePromise,
+        p: string | symbol,
+        receiver: any
+      ): any {
+        const value = Reflect.get(target, p);
+        if (typeof value === 'function') {
+          return (...args: typeof value.arguments) =>
+            firstValueFrom(value.bind(target)(...args));
+        } else {
+          return value;
+        }
+      },
+    }
+  );
+
+  return JsonApiSdkServiceLinkPromise;
+}

libs/json-api-nestjs-sdk/src/lib/types/index.ts

@@ -9,8 +9,13 @@ import {
   OperandsRelation,
   EntityRelation,
   ElementType,
+  Meta,
 } from 'json-api-nestjs';
 
+import { ObjectLiteral, ObjectType } from 'typeorm/browser';
+import { Observable } from 'rxjs';
+import { EntityArray } from '../utils';
+
 export declare type Filter<T> = {
   target?: Partial<
     {
@@ -38,3 +43,84 @@ export type QueryParamsForOneItem<T> = Pick<
   QueryParams<T>,
   QueryField.include | QueryField.filter | QueryField.fields
 >;
+
+export interface JsonApiSdkServicePromise {
+  getAll<Entity extends ObjectLiteral>(
+    resource: ObjectType<Entity>,
+    params: QueryParams<Entity>,
+    forAllPage: boolean
+  ): Promise<EntityArray<Entity>>;
+
+  getOne<Entity extends ObjectLiteral>(
+    resource: ObjectType<Entity>,
+    id: string | number
+  ): Promise<Entity>;
+  getOne<Entity extends ObjectLiteral, MetaData extends Meta>(
+    resource: ObjectType<Entity>,
+    id: string | number,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: MetaData }>;
+  getOne<Entity extends ObjectLiteral>(
+    entity: ObjectType<Entity>,
+    id: string | number,
+    params: QueryParamsForOneItem<Entity>
+  ): Promise<Entity>;
+  getOne<Entity extends ObjectLiteral>(
+    resource: ObjectType<Entity>,
+    id: string | number,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: Meta }>;
+  getOne<Entity extends ObjectLiteral, MetaData extends Meta>(
+    entity: ObjectType<Entity>,
+    id: string | number,
+    params: QueryParamsForOneItem<Entity>,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: MetaData }>;
+  getOne<Entity extends ObjectLiteral>(
+    entity: ObjectType<Entity>,
+    id: string | number,
+    params: QueryParamsForOneItem<Entity>,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: Meta }>;
+
+  postOne<Entity extends ObjectLiteral>(entity: Entity): Promise<Entity>;
+  postOne<Entity extends ObjectLiteral>(
+    entity: Entity,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: Meta }>;
+  postOne<Entity extends ObjectLiteral, MetaData extends Meta>(
+    entity: Entity,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: MetaData }>;
+  patchOne<Entity extends ObjectLiteral>(entity: Entity): Promise<Entity>;
+  patchOne<Entity extends ObjectLiteral, MetaData extends Meta>(
+    entity: Entity,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: MetaData }>;
+  patchOne<Entity extends ObjectLiteral>(
+    entity: Entity,
+    returnMeta: boolean
+  ): Promise<{ entity: Entity; meta: any }>;
+
+  deleteOne<Entity extends ObjectLiteral>(entity: Entity): Promise<void>;
+
+  getRelationships<Entity extends ObjectLiteral>(
+    entity: Entity,
+    relationType: EntityRelation<Entity>
+  ): Promise<string[] | string>;
+
+  patchRelationships<Entity extends ObjectLiteral>(
+    entity: Entity,
+    relationType: EntityRelation<Entity>
+  ): Promise<string[] | string>;
+
+  postRelationships<Entity extends ObjectLiteral>(
+    entity: Entity,
+    relationType: EntityRelation<Entity>
+  ): Promise<string[] | string>;
+
+  deleteRelationships<Entity extends ObjectLiteral>(
+    entity: Entity,
+    relationType: EntityRelation<Entity>
+  ): Promise<void>;
+}