Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@ngx-grpc/core
Advanced tools
@ngx-grpc/core - npm Package Compare versions
Comparing version 0.0.1 to 0.1.0
| { | ||
| "name": "@ngx-grpc/core", | ||
| "version": "0.0.1", | ||
| "version": "0.1.0", | ||
| "description": "Angular gRPC framework: core package", | ||
| "author": "smnbbrv", | ||
| "license": "MIT", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/ngx-grpc/core" | ||
| }, | ||
| "keywords": [ | ||
| "grpc", | ||
| "angular", | ||
| "ngx", | ||
| "grpc-web" | ||
| ], | ||
| "peerDependencies": { | ||
| "@angular/common": "^8.2.14", | ||
| "@angular/core": "^8.2.14" | ||
| "@angular/core": ">=8.0.0", | ||
| "google-protobuf": "^3.10.0", | ||
| "grpc-web": "^1.0.0", | ||
| "rxjs": "^6.0.0" | ||
| }, | ||
@@ -8,0 +23,0 @@ "main": "bundles/ngx-grpc-core.umd.js", |
114
README.md
@@ -1,117 +0,9 @@ | ||
| # ngrpc | ||
| # @ngx-grpc/core | ||
| gRPC Angular code generator based on [grpc-web](https://github.com/grpc/grpc-web). | ||
| gRPC Angular code generator. | ||
| **Work in progress: breaking changes possible.** | ||
| For documentation please refer [Github page](https://github.com/ngx-grpc/core) | ||
| ## Features | ||
| - two-way binding thanks to properties instead of Java-like setters / getters | ||
| - client services are bound to dependency injection | ||
| - rxjs first-class support | ||
| - typescript first-class support | ||
| - JSDoc comments incl. `@deprecated` option for properties and [rpc / methods](https://stackoverflow.com/a/43380742/1990451). [Example](test/proto/deprecated.proto) | ||
| - easy to install and update thanks to npm package | ||
| ## Installation | ||
| Installation consists of two parts | ||
| ### Globally | ||
| Step 1. Install the plugin | ||
| ```sh | ||
| npm i -g protoc-gen-ng | ||
| ``` | ||
| Step 2. Install `protoc` if you have none yet: [guide](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation). | ||
| ### In your Angular project | ||
| Install runtime dependencies: | ||
| ```sh | ||
| npm i -S google-protobuf grpc-web | ||
| npm i -D @types/google-protobuf | ||
| ``` | ||
| - `google-protobuf` is required to encode / decode messages | ||
| - `grpc-web` implements the transport | ||
| ### Configure your backend | ||
| Due to the browsers' limitations you would need to configure a special proxy in order to access your gRPC services. | ||
| Please configure your proxy according to [grpc-web docs](https://github.com/grpc/grpc-web#proxy-interoperability). | ||
| ## Usage | ||
| ### Generate code | ||
| Add to your `package.json` the following script: | ||
| ```json | ||
| "scripts": { | ||
| ... | ||
| "proto:generate": "protoc --plugin=protoc-gen-grpc_ng --ng_out=<OUTPUT_PATH> -I <PROTO_DIR_PATH> <PROTO_FILES>" | ||
| ... | ||
| } | ||
| ``` | ||
| Modify it as follows: | ||
| - `OUTPUT_PATH` - the path your code will be generated | ||
| - `PROTO_DIR_PATH` - the root path of your proto files | ||
| - `PROTO_FILES` - list of proto files to use | ||
| Example: | ||
| ```json | ||
| "scripts": { | ||
| ... | ||
| "proto:generate": "protoc --plugin=protoc-gen-grpc_ng --ng_out=./src/proto -I ../proto ../proto/*" | ||
| ... | ||
| } | ||
| ``` | ||
| ### Configure the clients | ||
| Every service has an injected configuration. You can create those services manually or use them as native Angular services. | ||
| To use them as Angular services, provide the configuration in your AppModule. | ||
| E.g. for a service `TestServiceClient` you need to provide the `GRPC_TEST_SERVICE_CLIENT_SETTINGS`: | ||
| ```ts | ||
| @NgModule({ | ||
| // ... | ||
| providers: [ | ||
| // ... | ||
| // the name of the token can be found in corresponding service constructor | ||
| { provide: GRPC_TEST_SERVICE_CLIENT_SETTINGS, useValue: { host: 'http://localhost:8080' } }, | ||
| // or use value from environment.ts | ||
| // { provide: GRPC_TEST_SERVICE_CLIENT_SETTINGS, useValue: { host: environment.host } }, | ||
| // ... | ||
| ], | ||
| // ... | ||
| }) | ||
| export class AppModule { | ||
| } | ||
| ``` | ||
| ## Not implemented (yet) | ||
| - [Imports](https://developers.google.com/protocol-buffers/docs/proto3#importing-definitions) | ||
| - [Oneof](https://developers.google.com/protocol-buffers/docs/proto3#oneof) | ||
| - [Any](https://developers.google.com/protocol-buffers/docs/proto3#any) | ||
| ## Related | ||
| [proto 3](https://developers.google.com/protocol-buffers/docs/proto3#simple) | ||
| [grpc-web](https://github.com/grpc/grpc-web) | ||
| [google-protobuf](https://github.com/protocolbuffers/protobuf) | ||
| ## License | ||
| MIT |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Improved metrics
- Number of low maintenance alerts
- decreased by-50%
1
- Number of low supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-2.41%
109028
- Dependency count
- increased by66.67%
5
- Number of lines in readme file
- decreased by-91.53%
10
No dependency changes