feat: added examples and execution instructions

Author: jcabrero

README.md

@@ -61,6 +61,13 @@ const response = await client.chat.completions.create({
 console.log(response.choices[0].message.content);
 ```
 
+
+To execute it:
+```
+pnpm i
+pnpm exec tsx examples/0-api-key.ts
+```
+
 ### 2. Delegation Token Mode (Advanced)
 
 For more secure, distributed access where you want to separate server credentials from client usage.
@@ -107,6 +114,13 @@ const response = await client.chat.completions.create({
 console.log(response.choices[0].message.content);
 ```
 
+
+To execute it:
+```
+pnpm i
+pnpm exec tsx examples/1-delegation-token.ts
+```
+
 ### 3. Environment Configuration
 
 Create a `.env` file for your credentials:

examples/0-api-key.ts

@@ -0,0 +1,34 @@
+import "dotenv/config";
+import { NilaiOpenAIClient, NilAuthInstance } from "@nillion/nilai-ts";
+
+// To obtain an API key, navigate to https://nilpay.vercel.app/
+// and create a new subscription.
+// The API key will be displayed in the subscription details.
+// The NilaiOpenAIClient class automatically handles the NUC token creation and management.
+
+const API_KEY = process.env.NILLION_API_KEY;
+
+async function main() {
+  // Initialize the client in API key mode
+  // For sandbox, use the following:
+  const client = new NilaiOpenAIClient({
+    baseURL: "https://nilai-a779.nillion.network/nuc/v1/",
+    apiKey: API_KEY,
+    nilauthInstance: NilAuthInstance.SANDBOX,
+    // For production, use the following:
+    // nilauthInstance: NilAuthInstance.PRODUCTION,
+  });
+
+  // Make a request to the Nilai API
+  const response = await client.chat.completions.create({
+    model: "meta-llama/Llama-3.2-3B-Instruct",
+    messages: [
+      { role: "user", content: "Hello! Can you help me with something?" }
+    ],
+  });
+
+  console.log(`Response: ${response.choices[0].message.content}`);
+}
+
+// Run the example
+main().catch(console.error);

examples/1-delegation-token.ts

@@ -0,0 +1,69 @@
+import "dotenv/config";
+import {
+  NilaiOpenAIClient,
+  DelegationTokenServer,
+  AuthType,
+  type DelegationTokenRequest,
+  type DelegationTokenResponse,
+  NilAuthInstance,
+} from "@nillion/nilai-ts";
+
+// To obtain an API key, navigate to https://nilpay.vercel.app/
+// and create a new subscription.
+// The API key will be displayed in the subscription details.
+
+const API_KEY = process.env.NILLION_API_KEY;
+
+async function main() {
+  if (!API_KEY) {
+    throw new Error("NILLION_API_KEY environment variable is required");
+  }
+
+  // >>> Server initializes a delegation token server
+  // The server is responsible for creating delegation tokens
+  // and managing their expiration and usage.
+  const server = new DelegationTokenServer(
+    API_KEY,
+    {
+      nilauthInstance: NilAuthInstance.SANDBOX,
+      expirationTime: 10, // 10 seconds validity of delegation tokens
+      tokenMaxUses: 1,    // 1 use of a delegation token
+    },
+    // For production instances, use the following:
+    // NilAuthInstance.PRODUCTION,
+  );
+
+  // >>> Client initializes a client
+  // The client is responsible for making requests to the Nilai API.
+  // We do not provide an API key but we set the auth type to DELEGATION_TOKEN
+  const client = new NilaiOpenAIClient({
+    baseURL: "https://nilai-a779.nillion.network/nuc/v1/",
+    authType: AuthType.DELEGATION_TOKEN,
+    // For production instances, use the following:
+    // nilauthInstance: NilAuthInstance.PRODUCTION,
+  });
+
+  // >>> Client produces a delegation request
+  const delegationRequest: DelegationTokenRequest = client.getDelegationRequest();
+
+  // <<< Server creates a delegation token
+  const delegationToken: DelegationTokenResponse = await server.createDelegationToken(
+    delegationRequest
+  );
+
+  // >>> Client sets internally the delegation token
+  client.updateDelegation(delegationToken);
+
+  // >>> Client uses the delegation token to make a request
+  const response = await client.chat.completions.create({
+    model: "meta-llama/Llama-3.2-3B-Instruct",
+    messages: [
+      { role: "user", content: "Hello! Can you help me with something?" }
+    ],
+  });
+
+  console.log(`Response: ${response.choices[0].message.content}`);
+}
+
+// Run the example
+main().catch(console.error);

package.json

@@ -23,7 +23,9 @@
     "lint": "biome lint .",
     "lint:fix": "biome lint --write .",
     "ci": "biome check .",
-    "prepublishOnly": "pnpm run build"
+    "prepublishOnly": "pnpm run build",
+    "example:api-key": "tsx examples/0-api-key.ts",
+    "example:delegation-token": "tsx examples/1-delegation-token.ts"
   },
   "keywords": [
     "openai",
@@ -52,6 +54,7 @@
     "dotenv": "^16.5.0",
     "eslint": "^9.29.0",
     "tsup": "^8.5.0",
+    "tsx": "^4.20.3",
     "typescript": "^5.8.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^2.1.9"

pnpm-lock.yaml

@@ -1,5 +1,5 @@
 export { NilaiOpenAIClient } from "./client";
-//export { DelegationTokenServer } from './server';
+export { DelegationTokenServer } from './server';
 export {
   AuthType,
   NilAuthInstance,

src/index.ts

@@ -25,8 +25,9 @@
 
     "baseUrl": ".",
     "paths": {
-      "#/*": ["src/*"]
+      "#/*": ["src/*"],
+      "@nillion/nilai-ts": ["src/index.ts"]
     }
   },
-  "include": ["./src/**/*.ts", "./tests/**/*.ts"]
+  "include": ["./src/**/*.ts", "./tests/**/*.ts", "./examples/**/*.ts"]
 }