Merge pull request #10 from manudss/wip-update-ngx

Update to last version of angular 16 + add tests
-> Updates to Angular 16, and compile libs to ivy
-> change to nx workspace 
-> Add unit tests

Author: manudss

.eslintignore

@@ -0,0 +1 @@
+node_modules

.eslintrc.json

@@ -0,0 +1,42 @@
+{
+  "root": true,
+  "ignorePatterns": ["**/*"],
+  "plugins": ["@nx"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@nx/enforce-module-boundaries": [
+          "error",
+          {
+            "enforceBuildableLibDependency": true,
+            "allow": [],
+            "depConstraints": [
+              {
+                "sourceTag": "*",
+                "onlyDependOnLibsWithTags": ["*"]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": ["plugin:@nx/typescript"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "extends": ["plugin:@nx/javascript"],
+      "rules": {}
+    },
+    {
+      "files": ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
+      "env": {
+        "jest": true
+      },
+      "rules": {}
+    }
+  ]
+}

.github/workflows/npmpublish.yml

@@ -5,7 +5,7 @@ name: Node.js Package
 
 on:
   release:
-    types: [created]
+    types: [created,edited]
 
 jobs:
   build:
@@ -14,9 +14,9 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
-      - run: npm install
-      - run: npm run build
+          node-version: 16
+      - run: yarn
+      - run: yarn run build
 
   publish-npm:
     needs: build
@@ -25,11 +25,11 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
           registry-url: https://registry.npmjs.org/
-      - run: npm install
-      - run: npm run package
-      - run: npm run publish
+      - run: yarn
+      - run: yarn run package
+      - run: yarn run publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
 

.gitignore

@@ -6,7 +6,7 @@
 /out-tsc
 
 # dependencies
-/node_modules
+node_modules
 
 # IDEs and editors
 /.idea
@@ -25,6 +25,7 @@
 !.vscode/extensions.json
 
 # misc
+/.angular/cache
 /.sass-cache
 /connect.lock
 /coverage
@@ -37,5 +38,5 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
-/dist/
-/dist/ngx-http-annotations/
+
+.angular

.prettierignore

@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+/coverage

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "angular.ng-template",
+    "nrwl.angular-console",
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner",
+    "dbaeumer.vscode-eslint"
+  ]
+}

0.34.0

@@ -3,11 +3,11 @@
 This library allows to interact with rest api in your angular app.
 It contains:
 
-  - Annotations for http methods (@GET, @POST, @PUT, @DELETE, @OPTIONS, @HEAD, @PATCH)
-  - Annotations for adding headers, setting produces results and intercepting response
-  - Params annotations
-  
-  forked from : https://github.com/Mixalloff/ngx-http-rest 
+- Annotations for http methods (@GET, @POST, @PUT, @DELETE, @OPTIONS, @HEAD, @PATCH)
+- Annotations for adding headers, setting produces results and intercepting response
+- Params annotations
+
+forked from : https://github.com/Mixalloff/ngx-http-rest
 
 ### Installation
 
@@ -25,23 +25,23 @@ Example of using library.
 1) Plug the HttpRestModule into your AppModule
 
 ```typescript
-import { HttpRestModule } from 'ngx-http-annotations';
+import { NgxHttpAnnotationsModule } from 'ngx-http-annotations';
 import { NgModule } from '@angular/core';
 
 @NgModule({
   imports: [
-    HttpRestModule
+    NgxHttpAnnotationsModule
   ]
 })
 export class AppModule {
 }
 ```
 
-2) Create a service to work with rest api. Inherit it from HttpRestService from 'ngx-http-rest'. Put annotations on the class, methods and params.
+2) Create a service to work with rest api. Put annotations on the class, methods and params.
 
 
 ```typescript
-import { HttpRestService, GET, POST, DELETE, Path, PathParam, Body, QueryParam, QueryParams, ResponseObservable } from 'ngx-http-annotations';
+import {  GET, POST, DELETE, Path, PathParam, Body, QueryParam, QueryParams, ResponseObservable } from 'ngx-http-annotations';
 import { Injectable } from '@angular/core';
 import RestConfig from 'app/core/configs/rest.config';
 
@@ -60,7 +60,7 @@ interface GoodsItem {
   'someHeader2': 'headerValue2'
 })
 @Path(`/test/goods`)
-export class SomeRestService extends HttpRestService {
+export class SomeRestService {
 
   @GET
   getGoods(@QueryParams /* Object with queryParams { [name: string]: [value: any] } */ queryObj?: any): any {}
@@ -126,24 +126,24 @@ export class TestComponent implements OnInit {
 ### Description
 Available annotations:
 1) Request methods
-@GET, @POST, @PUT, @DELETE, @OPTIONS, @HEAD, @PATCH - marks methods implementing the corresponding requests
+   @GET, @POST, @PUT, @DELETE, @OPTIONS, @HEAD, @PATCH - marks methods implementing the corresponding requests
 2) Added settings
- - @Path - set path of url for request. Combined class @Path annotation value and current method @Path. Path params passed with ":". For example @Path('/someurl/:someParam')
- - @Headers - set headers for request (if annotate class, then all class methods getting this headers. method Headers merge with class Headers)
- - @Produces - setting expected response type. By default Reponse transformed by .json() method
- - @Observes - setting http observes.
- 3) Parameters
- - @PathParam (or @Path) - pass current parameter by name to collected url. Example: someFunc(@PathParam('id') itemId: number) {}
- - @Body - pass body object into request. Ex.: someMethod(@Body bodyObject: any){}
- - @QueryParam - pass single query parameters into request. Ex.: someMethod(@QueryParam('a') a: any, @QueryParam('b') b: any) {}. someMethod(1, 2) -> ..requested_url..?a=1&b=2
- - @QueryParams - pass object with few query params. Ex.: someMethod(@QueryParams queryObj: any){}. someMethod({x: 1, y: 2, z: 3}) -> ..requested_url..?x=1&y=2&z=3
- - @ResponseObservable - specify in witch function params, the response observable will be added. Ex.: someMethod(@ResponseObservable res: Observable<any> = undefined){ /* transform request */ return res; }. need to initialise as undefined to pass compile error, and return a response. 
- 
- 
- #### Transform response with all rxjs function
- 
- By adding the parameters @ResponseObservable you can specify, where add the observable response, 
- 
+- @Path - set path of url for request. Combined class @Path annotation value and current method @Path. Path params passed with ":". For example @Path('/someurl/:someParam')
+- @Headers - set headers for request (if annotate class, then all class methods getting this headers. method Headers merge with class Headers)
+- @Produces - setting expected response type. By default Reponse transformed by .json() method
+- @Observes - setting http observes.
+3) Parameters
+- @PathParam (or @Path) - pass current parameter by name to collected url. Example: someFunc(@PathParam('id') itemId: number) {}
+- @Body - pass body object into request. Ex.: someMethod(@Body bodyObject: any){}
+- @QueryParam - pass single query parameters into request. Ex.: someMethod(@QueryParam('a') a: any, @QueryParam('b') b: any) {}. someMethod(1, 2) -> ..requested_url..?a=1&b=2
+- @QueryParams - pass object with few query params. Ex.: someMethod(@QueryParams queryObj: any){}. someMethod({x: 1, y: 2, z: 3}) -> ..requested_url..?x=1&y=2&z=3
+- @ResponseObservable - specify in witch function params, the response observable will be added. Ex.: someMethod(@ResponseObservable res: Observable<any> = undefined){ /* transform request */ return res; }. need to initialise as undefined to pass compile error, and return a response.
+
+
+#### Transform response with all rxjs function
+
+By adding the parameters @ResponseObservable you can specify, where add the observable response,
+
   ```typescript
 
     @GET
@@ -157,13 +157,13 @@ Available annotations:
   ```
 ### Mocks calls
 
-To have a feature to enable mocks api. When enabled, will call directly the function rather than call the http request. 
+To have a feature to enable mocks api. When enabled, will call directly the function rather than call the http request.
 
 To enable Mocks : in a module provider use this :
 ```typescript
 providers: [{ provide: HTTP_ANNOTATIONS_USE_MOCKS, useValue: true }]
 ```
-You can specify a boolean value, or have a specific function, that will be used to know if the apps will use mock. 
+You can specify a boolean value, or have a specific function, that will be used to know if the apps will use mock.
 This could help you to define mock only for specific call.
 
 
@@ -174,7 +174,7 @@ providers: [{ provide: HTTP_ANNOTATIONS_USE_MOCKS, useValue: (url, requestType,
     } }]
 ```
 
-define your mocks by return a fake observable, with your mock data. 
+define your mocks by return a fake observable, with your mock data.
 
 ```typescript
   @GET
@@ -184,25 +184,33 @@ define your mocks by return a fake observable, with your mock data.
   }
 ```
 
-### Change logs 
+### Change logs
 
 0.6.x
 
- -> updates to latest versions of Angular 
- -> Rename library to ngx-http-annotations
- -> add @ResponseObservable to transform response. 
- 
-0.6.2 et 0.6.3 
+-> updates to the latest versions of Angular
+-> Rename library to ngx-http-annotations
+-> add @ResponseObservable to transform response.
 
- -> update to build library with angular, to avoid error when build in --prod 
+0.6.2 et 0.6.3
 
-0.7.x 
+-> update to build the library with angular, to avoid error when build in --prod
 
- ->  Add a mock feature. 
- -> Update dependency to latest
- 
+0.7.x
 
-### Source and issues 
+-> Add a mock feature.
+-> Update dependency to latest
 
-Code are located in github : https://github.com/manudss/ngx-http-annotations
+0.7.3
+-> Add delay: Add a beta feature, to add a delay to all requests, or have a function that returns this delay. This could be useful, in the mock feature. By default, all mock, will have a default delay. But could be also added without mock, to simulate long request.
+-> Use all httpClient methods rather than use request method, use the corresponding method (get, put, delete ...). In order, to avoid issue with request method that throw a first empty error.
+-> Update dependencies: Update to version 13 of Angular.
+
+0.8.0
+-> Updates to Angular 16, and compile libs to ivy
+-> change to nx workspace 
+-> Add unit tests
 
+### Source and issues
+
+Code are located in github : https://github.com/manudss/ngx-http-annotations