@adempiere/grpc-api

5.1.0 • Public • Published 8 months ago

ADempiere gRPC-API library to Node.js

ADempiere node.js write in JavaScript for gRPC service, currently is used as library of proxy ADempiere service and is published as NPM

ADempiere-gRPC-Server, docker image erpya/adempiere-grpc-all-in-one.

Using it

# installing via NPM
npm install @adempiere/grpc-api --save

# installing via Yarn
yarn add @adempiere/grpc-api

A Example

Here a example for it using from Proxy of ADempiere API: https://github.com/adempiere/proxy-adempiere-api/blob/master/src/modules/adempiere-api/index.ts#L17

Recreate proto stub class (only for contribute to project)

For recreate stub class you must have follow:

protobuf
protoc
Also you can see it: gRPC-web
gRPC
gRPC-Node

Generate Proto Stub:

Generate with npm (Recommended):

Via npm:

# install dependecies and dev dependencies
npm ci

# generate all stub
npm run stub

Via yarn:

# install dependecies and dev dependencies
yarn ci

# generate all stub
yarn stub

Note to generate specific proto definition:

To base bank statement match: npm run stub:bank_statement_match
To base data type: npm run stub:base_data_type
To business: npm run stub:business
To business partner: npm run stub:business_partner
To core functionality: npm run stub:core_functionality
To dashboarding: npm run stub:dashboarding
To dictionary: npm run stub:dictionary
To enrollment: npm run stub:enrollment
To express movement: npm run stub:express_movement
To express receipt: npm run stub:express_receipt
To express shipment: npm run stub:express_shipment
To file management: npm run stub:file_management
To general ledger: npm run stub:general_ledger
To import file loader: npm run stub:import_file_loader
To in-out: npm run stub:in_out
To invoice: npm run stub:invoice
To issue management: npm run stub:issue_management
To logs: npm run stub:logs
To match po receipt invoice: npm run stub:match_po_receipt_invoice
To material management: npm run stub:material_management
To order: npm run stub:order
To payment: npm run stub:payment
To payment allocation: npm run stub:payment_allocation
To payment print export: npm run stub:payment_print_export
To payroll action notice: npm run stub:payroll_action_notice
To point of sales: npm run stub:point_of_sales
To product: npm run stub:product
To security: npm run stub:security
To time control: npm run stub:time_control
To time record: npm run stub:time_record
To user customization: npm run stub:user_customization
To workflow: npm run stub:workflow

Generate directly with grpc-tools:

Generate all stub:

grpc_tools_node_protoc \
    --js_out=import_style=commonjs,binary:src/grpc \
    --grpc_out=src/grpc \
    proto/access.proto proto/base_data_type.proto proto/business.proto proto/client.proto proto/core_functionality.proto proto/dictionary.proto proto/enrollment.proto proto/point_of_sales.proto
    # --grpc-web_out=import_style=commonjs,mode=grpcwebtext:$OUT_DIR

To access:

# Generate stub to access.proto file
grpc_tools_node_protoc \
    proto/access.proto \
    --js_out=import_style=commonjs,binary:src/grpc/ \
    --grpc_out=grpc_js:src/grpc/
    # --grpc-web_out=import_style=commonjs,mode=grpcwebtext:$OUT_DIR

To base data type:

# Generate stub to base_data_type.proto file
grpc_tools_node_protoc \
    proto/base_data_type.proto \
    --js_out=import_style=commonjs,binary:src/grpc/ \
    --grpc_out=grpc_js:src/grpc/
    # --grpc-web_out=import_style=commonjs,mode=grpcwebtext:$OUT_DIR

To dictionary:

# Generate stub to access.proto file
grpc_tools_node_protoc \
    proto/dictionary.proto \
    --js_out=import_style=commonjs,binary:src/grpc/ \
    --grpc_out=grpc_js:src/grpc/
    # --grpc-web_out=import_style=commonjs,mode=grpcwebtext:$OUT_DIR