Skip to content

GoodVision TypeScript SDK ​

After installing the SDK from npm as described in quick start, call the same operation ID:

typescript
import { GoodVisionClient, discoverOperations } from "@goodvision/sdk";
import { readFile } from "node:fs/promises";

const operations = discoverOperations("user context");
const client = new GoodVisionClient({
  apiBase: process.env.GOODVISION_API_BASE!,
  getToken: async () => (await readFile(process.env.GOODVISION_TOKEN_FILE!, "utf8")).trim(),
});
const result = await client.call("resolveCustomerUserContext", { body: {} });
console.log(result.data);

The integrator keeps the Token file private. discoverOperations searches only the generated local catalog. Owner contracts define types, parameters, responses and Scopes; APIs enforce authorization. consumeEvents ACKs only after durable, idempotent processing completes, and never ACKs a failed callback.

Global capabilities ​

typescript
import { capabilityOverview, discoverOperations } from "@goodvision/sdk";
const overview = capabilityOverview();
console.log(overview.products);
const operations = discoverOperations("user context");

capabilityOverview includes product versions, counts, identity types, Scopes and bilingual guides from the local public contracts. Live availability and authorization remain unevaluated.

Developer documentation. Internal operations access is not required.