Product Protobuf Definitions

This package provides TypeScript/JavaScript generated code for Product service protobuf definitions.

Installation

npm install @crunchydeer30/protobuf-test

Peer Dependencies

This package requires the following peer dependencies:

• @grpc/grpc-js
• google-protobuf

Make sure to install them in your project:

npm install @grpc/grpc-js google-protobuf

Usage

TypeScript/JavaScript

import { Product, ProductServiceClient } from '@crunchydeer30/protobuf-test';

// Create a client
const client = new ProductServiceClient('your-service-address:port');

// Example: Create a product
const createProduct = async () => {
  const request = {
    name: 'Example Product',
    description: 'This is an example product',
    image: 'https://example.com/product.jpg',
    tags: ['example', 'test']
  };
  
  const response = await client.createProduct(request);
  console.log('Created product:', response.product);
};

Available Services and Messages

• ProductService
  • createProduct(CreateProductRequest): CreateProductResponse
  • getProduct(GetProductRequest): GetProductResponse
  • listProducts(ListProductsRequest): ListProductsResponse

Development

Prerequisites

• Node.js (v14 or later)
• npm (v6 or later)
• Protocol Buffers compiler (protoc)

Building

1. Install dependencies:

   npm install

2. Generate TypeScript code from .proto files:

   npm run generate

3. Build the project:

   npm run build

Publishing

1. Update the version in package.json
2. Commit and tag the changes
3. Run npm publish --access public

License

ISC