@forwardimpact/librpc 0.1.109 → 0.1.110

package/README.md

@@ -12,3 +12,12 @@ transport.
 ```js
 import { Server, Client, createClient, createTracer } from '@forwardimpact/librpc';
 ```
+
+## Documentation
+
+- [Ship a Service Endpoint](https://www.forwardimpact.team/docs/libraries/typed-contracts/ship-endpoint/index.md)
+  — ship and consume a gRPC service with typed contracts, authentication,
+  retries, and health checks; `fit-unary` is the command-line client for it.
+- [Keep Types Synced with Proto Definitions](https://www.forwardimpact.team/docs/libraries/typed-contracts/index.md)
+  — the full workflow for defining proto contracts and generating typed base
+  classes and clients.

package/bin/fit-unary.js

@@ -18,6 +18,20 @@ const definition = {
     json: { type: "boolean", description: "Output help as JSON" },
   },
   examples: ['fit-unary memory GetWindow \'{"resource_id":"..."}\''],
+  documentation: [
+    {
+      title: "Ship a Service Endpoint",
+      url: "https://www.forwardimpact.team/docs/libraries/typed-contracts/ship-endpoint/index.md",
+      description:
+        "Ship and consume a gRPC service with typed contracts, authentication, retries, and health checks; fit-unary is the command-line client for it.",
+    },
+    {
+      title: "Keep Types Synced with Proto Definitions",
+      url: "https://www.forwardimpact.team/docs/libraries/typed-contracts/index.md",
+      description:
+        "The full workflow for defining proto contracts and generating typed base classes and clients.",
+    },
+  ],
 };
 
 const cli = createCli(definition, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forwardimpact/librpc",
-  "version": "0.1.109",
+  "version": "0.1.110",
   "description": "gRPC server and client framework — ship service endpoints without reimplementing transport.",
   "keywords": [
     "grpc",

package/src/generated/types/metadata.js

@@ -624,7 +624,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Discipline id to filter by (e.g. 'software_engineering')"
+          "description": "Discipline id to filter by (e.g. 'software-engineering')"
         }
       }
     },
@@ -635,7 +635,7 @@ export const metadata = {
           "type": "string",
           "optional": false,
           "repeated": false,
-          "description": "Discipline id (e.g. 'software_engineering')"
+          "description": "Discipline id (e.g. 'software-engineering')"
         },
         "level": {
           "type": "string",
@@ -647,7 +647,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Track id for specialization modifier (e.g. 'forward_deployed')"
+          "description": "Track id for specialization modifier (e.g. 'forward-deployed')"
         }
       }
     },
@@ -658,7 +658,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Discipline id to filter by (e.g. 'software_engineering')"
+          "description": "Discipline id to filter by (e.g. 'software-engineering')"
         }
       }
     },
@@ -669,7 +669,7 @@ export const metadata = {
           "type": "string",
           "optional": false,
           "repeated": false,
-          "description": "Discipline id (e.g. 'software_engineering')"
+          "description": "Discipline id (e.g. 'software-engineering')"
         },
         "track": {
           "type": "string",
@@ -686,7 +686,7 @@ export const metadata = {
           "type": "string",
           "optional": false,
           "repeated": false,
-          "description": "Discipline id (e.g. 'software_engineering')"
+          "description": "Discipline id (e.g. 'software-engineering')"
         },
         "from_level": {
           "type": "string",
@@ -704,7 +704,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Track id for specialization modifier (e.g. 'forward_deployed')"
+          "description": "Track id for specialization modifier (e.g. 'forward-deployed')"
         }
       }
     },
@@ -715,7 +715,7 @@ export const metadata = {
           "type": "string",
           "optional": false,
           "repeated": false,
-          "description": "Discipline id (e.g. 'software_engineering')"
+          "description": "Discipline id (e.g. 'software-engineering')"
         },
         "level": {
           "type": "string",
@@ -727,7 +727,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Track id for specialization modifier (e.g. 'forward_deployed')"
+          "description": "Track id for specialization modifier (e.g. 'forward-deployed')"
         }
       }
     },
@@ -738,7 +738,7 @@ export const metadata = {
           "type": "string",
           "optional": false,
           "repeated": false,
-          "description": "Discipline id (e.g. 'software_engineering')"
+          "description": "Discipline id (e.g. 'software-engineering')"
         },
         "level": {
           "type": "string",
@@ -750,7 +750,7 @@ export const metadata = {
           "type": "string",
           "optional": true,
           "repeated": false,
-          "description": "Track id for specialization modifier (e.g. 'forward_deployed')"
+          "description": "Track id for specialization modifier (e.g. 'forward-deployed')"
         }
       }
     }