@superblocksteam/sdk-api 2.0.93-next.7 → 2.0.94-next.0

package/src/integrations/pagerduty/README.md

@@ -4,8 +4,8 @@ Create incidents, manage services, and interact with PagerDuty's incident manage
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                           |
+| ----------------------------- | ----------------------------------------------------- |
 | `apiRequest(options, schema)` | Make any PagerDuty API request with schema validation |
 
 ## Usage
@@ -13,7 +13,7 @@ Create incidents, manage services, and interact with PagerDuty's incident manage
 ### Create an Incident
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, pagerduty } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_PAGERDUTY = "a1b2c3d4-5678-90ab-cdef-pagerdu00001";
@@ -34,14 +34,16 @@ const IncidentSchema = z.object({
     type: z.string(),
     summary: z.string(),
   }),
-  assignments: z.array(z.object({
-    at: z.string(),
-    assignee: z.object({
-      id: z.string(),
-      type: z.string(),
-      summary: z.string(),
+  assignments: z.array(
+    z.object({
+      at: z.string(),
+      assignee: z.object({
+        id: z.string(),
+        type: z.string(),
+        summary: z.string(),
+      }),
     }),
-  })),
+  ),
 });
 
 const CreateIncidentResponseSchema = z.object({
@@ -49,6 +51,9 @@ const CreateIncidentResponseSchema = z.object({
 });
 
 export default api({
+  integrations: {
+    pagerduty: pagerduty(PROD_PAGERDUTY),
+  },
   name: "PagerDutyExample",
   input: z.object({
     title: z.string(),
@@ -60,9 +65,7 @@ export default api({
     incidentNumber: z.number(),
   }),
   async run(ctx, { title, serviceId, urgency }) {
-    const pagerduty = ctx.pagerduty(PROD_PAGERDUTY);
-
-    const result = await pagerduty.apiRequest(
+    const result = await ctx.integrations.pagerduty.apiRequest(
       {
         method: "POST",
         path: "/incidents",
@@ -82,7 +85,7 @@ export default api({
           },
         },
       },
-      { response: CreateIncidentResponseSchema }
+      { response: CreateIncidentResponseSchema },
     );
 
     return {
@@ -104,7 +107,7 @@ const ListIncidentsResponseSchema = z.object({
   more: z.boolean(),
 });
 
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "GET",
     path: "/incidents",
@@ -115,30 +118,32 @@ const result = await pagerduty.apiRequest(
       sort_by: "created_at:desc",
     },
   },
-  { response: ListIncidentsResponseSchema }
+  { response: ListIncidentsResponseSchema },
 );
 
 result.incidents.forEach((incident) => {
-  console.log(`#${incident.incident_number}: ${incident.title} (${incident.status})`);
+  console.log(
+    `#${incident.incident_number}: ${incident.title} (${incident.status})`,
+  );
 });
 ```
 
 ### Get an Incident
 
 ```typescript
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "GET",
     path: `/incidents/${incidentId}`,
   },
-  { response: z.object({ incident: IncidentSchema }) }
+  { response: z.object({ incident: IncidentSchema }) },
 );
 ```
 
 ### Update Incident Status
 
 ```typescript
-await pagerduty.apiRequest(
+await ctx.integrations.pagerduty.apiRequest(
   {
     method: "PUT",
     path: `/incidents/${incidentId}`,
@@ -149,7 +154,7 @@ await pagerduty.apiRequest(
       },
     },
   },
-  { response: z.object({ incident: IncidentSchema }) }
+  { response: z.object({ incident: IncidentSchema }) },
 );
 ```
 
@@ -166,7 +171,7 @@ const NoteSchema = z.object({
   }),
 });
 
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "POST",
     path: `/incidents/${incidentId}/notes`,
@@ -176,7 +181,7 @@ const result = await pagerduty.apiRequest(
       },
     },
   },
-  { response: z.object({ note: NoteSchema }) }
+  { response: z.object({ note: NoteSchema }) },
 );
 ```
 
@@ -201,7 +206,7 @@ const ListServicesResponseSchema = z.object({
   more: z.boolean(),
 });
 
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "GET",
     path: "/services",
@@ -210,7 +215,7 @@ const result = await pagerduty.apiRequest(
       sort_by: "name",
     },
   },
-  { response: ListServicesResponseSchema }
+  { response: ListServicesResponseSchema },
 );
 ```
 
@@ -223,10 +228,12 @@ const OnCallSchema = z.object({
     summary: z.string(),
   }),
   escalation_level: z.number(),
-  schedule: z.object({
-    id: z.string(),
-    summary: z.string(),
-  }).nullable(),
+  schedule: z
+    .object({
+      id: z.string(),
+      summary: z.string(),
+    })
+    .nullable(),
   user: z.object({
     id: z.string(),
     summary: z.string(),
@@ -240,7 +247,7 @@ const ListOnCallsResponseSchema = z.object({
   oncalls: z.array(OnCallSchema),
 });
 
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "GET",
     path: "/oncalls",
@@ -249,7 +256,7 @@ const result = await pagerduty.apiRequest(
       include: "users",
     },
   },
-  { response: ListOnCallsResponseSchema }
+  { response: ListOnCallsResponseSchema },
 );
 
 result.oncalls.forEach((oncall) => {
@@ -267,7 +274,7 @@ const EventResponseSchema = z.object({
 });
 
 // Note: Events API uses different base URL
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "POST",
     path: "/v2/enqueue",
@@ -287,14 +294,14 @@ const result = await pagerduty.apiRequest(
       },
     },
   },
-  { response: EventResponseSchema }
+  { response: EventResponseSchema },
 );
 ```
 
 ### Resolve via Events API
 
 ```typescript
-await pagerduty.apiRequest(
+await ctx.integrations.pagerduty.apiRequest(
   {
     method: "POST",
     path: "/v2/enqueue",
@@ -304,7 +311,7 @@ await pagerduty.apiRequest(
       dedup_key: "unique-incident-key", // Same as trigger
     },
   },
-  { response: EventResponseSchema }
+  { response: EventResponseSchema },
 );
 ```
 
@@ -318,7 +325,7 @@ await pagerduty.createIncident({ ... });
 await pagerduty.listServices();
 
 // CORRECT - Use apiRequest
-await pagerduty.apiRequest(
+await ctx.integrations.pagerduty.apiRequest(
   { method: "POST", path: "/incidents", body: { incident: { ... } } },
   { response: CreateIncidentResponseSchema }
 );
@@ -356,7 +363,7 @@ const body = {
     title: "Server down",
     service: {
       id: "P123ABC",
-      type: "service_reference",  // Not "service"
+      type: "service_reference", // Not "service"
     },
     escalation_policy: {
       id: "P456DEF",
@@ -400,7 +407,7 @@ const path = "/v2/enqueue";
 Some endpoints require a `From` header with user email:
 
 ```typescript
-const result = await pagerduty.apiRequest(
+const result = await ctx.integrations.pagerduty.apiRequest(
   {
     method: "POST",
     path: "/incidents",
@@ -424,13 +431,13 @@ async function getAllIncidents(pagerduty: PagerDutyClient) {
   const limit = 100;
 
   while (true) {
-    const result = await pagerduty.apiRequest(
+    const result = await ctx.integrations.pagerduty.apiRequest(
       {
         method: "GET",
         path: "/incidents",
         params: { limit, offset },
       },
-      { response: ListIncidentsResponseSchema }
+      { response: ListIncidentsResponseSchema },
     );
 
     allIncidents.push(...result.incidents);
@@ -448,7 +455,7 @@ async function getAllIncidents(pagerduty: PagerDutyClient) {
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await pagerduty.apiRequest(
+  const result = await ctx.integrations.pagerduty.apiRequest(
     { method: "POST", path: "/incidents", body: { ... } },
     { response: CreateIncidentResponseSchema }
   );

package/src/integrations/pagerduty/client.ts

@@ -5,8 +5,8 @@
  * PagerDuty integrations use the REST API Integration plugin under the hood.
  */
 
-import { RestApiIntegrationClient } from '../base/index.js';
-import type { PagerDutyClient } from './types.js';
+import { RestApiIntegrationClient } from "../base/index.js";
+import type { PagerDutyClient } from "./types.js";
 
 /**
  * Internal implementation of PagerDutyClient.
@@ -16,6 +16,8 @@ import type { PagerDutyClient } from './types.js';
  * PagerDuty API calls. At runtime, the orchestrator handles authentication
  * and API request execution.
  */
-export class PagerDutyClientImpl extends RestApiIntegrationClient implements PagerDutyClient {
+export class PagerDutyClientImpl
+  extends RestApiIntegrationClient
+  implements PagerDutyClient {
   // Inherits: name, pluginId, config, executeQuery, apiRequest()
 }

package/src/integrations/pagerduty/index.ts

@@ -1,2 +1,2 @@
-export { PagerDutyClientImpl } from './client.js';
-export type { PagerDutyClient } from './types.js';
+export { PagerDutyClientImpl } from "./client.js";
+export type { PagerDutyClient } from "./types.js";

package/src/integrations/pagerduty/types.ts

@@ -2,8 +2,8 @@
  * PagerDuty client types.
  */
 
-import type { BaseIntegrationClient } from '../../types.js';
-import type { SupportsApiRequest } from '../base/index.js';
+import type { BaseIntegrationClient } from "../../types.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * PagerDuty client for API interactions.
@@ -13,7 +13,8 @@ import type { SupportsApiRequest } from '../base/index.js';
  *
  * @example
  * ```typescript
- * const pagerduty = ctx.pagerDuty('My PagerDuty');
+ * // Declare in api(): integrations: { pagerduty: pagerduty(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.pagerduty
  *
  * // Make API requests
  * const ResponseSchema = z.object({
@@ -29,6 +30,7 @@ import type { SupportsApiRequest } from '../base/index.js';
  * );
  * ```
  */
-export interface PagerDutyClient extends BaseIntegrationClient, SupportsApiRequest {
+export interface PagerDutyClient
+  extends BaseIntegrationClient, SupportsApiRequest {
   // apiRequest() method inherited from SupportsApiRequest
 }

package/src/integrations/perplexity/README.md

@@ -4,8 +4,8 @@ Interact with Perplexity's search-augmented AI for real-time information retriev
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                            |
+| ----------------------------- | ------------------------------------------------------ |
 | `apiRequest(options, schema)` | Make any Perplexity API request with schema validation |
 
 ## Usage
@@ -13,7 +13,7 @@ Interact with Perplexity's search-augmented AI for real-time information retriev
 ### Chat Completion with Search
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, perplexity } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_PERPLEXITY = "a1b2c3d4-5678-90ab-cdef-perplexi0001";
@@ -30,7 +30,7 @@ const ChatCompletionResponseSchema = z.object({
         content: z.string(),
       }),
       finish_reason: z.string(),
-    })
+    }),
   ),
   usage: z.object({
     prompt_tokens: z.number(),
@@ -41,6 +41,9 @@ const ChatCompletionResponseSchema = z.object({
 });
 
 export default api({
+  integrations: {
+    perplexity: perplexity(PROD_PERPLEXITY),
+  },
   name: "PerplexityExample",
   input: z.object({
     question: z.string(),
@@ -50,9 +53,7 @@ export default api({
     sources: z.array(z.string()),
   }),
   async run(ctx, { question }) {
-    const perplexity = ctx.perplexity(PROD_PERPLEXITY);
-
-    const result = await perplexity.apiRequest(
+    const result = await ctx.integrations.perplexity.apiRequest(
       {
         method: "POST",
         path: "/chat/completions",
@@ -67,7 +68,7 @@ export default api({
           ],
         },
       },
-      { response: ChatCompletionResponseSchema }
+      { response: ChatCompletionResponseSchema },
     );
 
     return {
@@ -82,22 +83,20 @@ export default api({
 
 ```typescript
 // Online models - With real-time search
-const onlineResult = await perplexity.apiRequest(
+const onlineResult = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
     body: {
       model: "llama-3.1-sonar-large-128k-online", // Real-time search
-      messages: [
-        { role: "user", content: "What's the latest news about AI?" },
-      ],
+      messages: [{ role: "user", content: "What's the latest news about AI?" }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 // Chat models - Without search, faster
-const chatResult = await perplexity.apiRequest(
+const chatResult = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -106,11 +105,11 @@ const chatResult = await perplexity.apiRequest(
       messages: [{ role: "user", content: "Explain quantum computing" }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 // Small models - Faster, lower cost
-const smallResult = await perplexity.apiRequest(
+const smallResult = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -119,14 +118,14 @@ const smallResult = await perplexity.apiRequest(
       messages: [{ role: "user", content: "Quick fact check..." }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
 ### Search with Domain Filtering
 
 ```typescript
-const result = await perplexity.apiRequest(
+const result = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -141,14 +140,14 @@ const result = await perplexity.apiRequest(
       search_domain_filter: ["python.org", "docs.python.org"], // Only search these domains
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
 ### Recency Filtering
 
 ```typescript
-const result = await perplexity.apiRequest(
+const result = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -160,14 +159,14 @@ const result = await perplexity.apiRequest(
       search_recency_filter: "week", // Only recent results: "day", "week", "month", "year"
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
 ### Multi-turn Conversation
 
 ```typescript
-const result = await perplexity.apiRequest(
+const result = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -180,7 +179,7 @@ const result = await perplexity.apiRequest(
       ],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
@@ -194,7 +193,7 @@ await perplexity.search({ ... });
 await perplexity.chat({ ... });
 
 // CORRECT - Use apiRequest
-await perplexity.apiRequest(
+await ctx.integrations.perplexity.apiRequest(
   { method: "POST", path: "/chat/completions", body: { ... } },
   { response: ChatCompletionResponseSchema }
 );
@@ -217,7 +216,7 @@ const model = "llama-3.1-sonar-large-128k-chat";
 Not all responses include citations:
 
 ```typescript
-const result = await perplexity.apiRequest(...);
+const result = await ctx.integrations.perplexity.apiRequest(...);
 
 // Handle missing citations
 const sources = result.citations ?? [];
@@ -233,10 +232,10 @@ Perplexity models follow a specific naming pattern:
 ```typescript
 // Pattern: llama-3.1-sonar-{size}-{context}-{type}
 const models = [
-  "llama-3.1-sonar-small-128k-online",  // Small, online search
-  "llama-3.1-sonar-small-128k-chat",    // Small, no search
-  "llama-3.1-sonar-large-128k-online",  // Large, online search
-  "llama-3.1-sonar-large-128k-chat",    // Large, no search
+  "llama-3.1-sonar-small-128k-online", // Small, online search
+  "llama-3.1-sonar-small-128k-chat", // Small, no search
+  "llama-3.1-sonar-large-128k-online", // Large, online search
+  "llama-3.1-sonar-large-128k-chat", // Large, no search
 ];
 ```
 
@@ -244,7 +243,7 @@ const models = [
 
 ```typescript
 // WRONG - search_domain_filter with chat model
-await perplexity.apiRequest(
+await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -258,7 +257,7 @@ await perplexity.apiRequest(
 );
 
 // CORRECT - search_domain_filter with online model
-await perplexity.apiRequest(
+await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
@@ -278,7 +277,7 @@ await perplexity.apiRequest(
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await perplexity.apiRequest(
+  const result = await ctx.integrations.perplexity.apiRequest(
     { method: "POST", path: "/chat/completions", body: { ... } },
     { response: ChatCompletionResponseSchema }
   );

package/src/integrations/perplexity/client.ts

@@ -5,8 +5,8 @@
  * Perplexity integrations use the REST API Integration plugin under the hood.
  */
 
-import { RestApiIntegrationClient } from '../base/index.js';
-import type { PerplexityClient } from './types.js';
+import { RestApiIntegrationClient } from "../base/index.js";
+import type { PerplexityClient } from "./types.js";
 
 /**
  * Internal implementation of PerplexityClient.
@@ -16,6 +16,8 @@ import type { PerplexityClient } from './types.js';
  * Perplexity API calls. At runtime, the orchestrator handles authentication
  * and API request execution.
  */
-export class PerplexityClientImpl extends RestApiIntegrationClient implements PerplexityClient {
+export class PerplexityClientImpl
+  extends RestApiIntegrationClient
+  implements PerplexityClient {
   // Inherits: name, pluginId, config, executeQuery, apiRequest()
 }

package/src/integrations/perplexity/index.ts

@@ -1,2 +1,2 @@
-export { PerplexityClientImpl } from './client.js';
-export type { PerplexityClient } from './types.js';
+export { PerplexityClientImpl } from "./client.js";
+export type { PerplexityClient } from "./types.js";

package/src/integrations/perplexity/types.ts

@@ -2,8 +2,8 @@
  * Perplexity client types.
  */
 
-import type { BaseIntegrationClient } from '../../types.js';
-import type { SupportsApiRequest } from '../base/index.js';
+import type { BaseIntegrationClient } from "../../types.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * Perplexity client for API interactions.
@@ -13,7 +13,8 @@ import type { SupportsApiRequest } from '../base/index.js';
  *
  * @example
  * ```typescript
- * const perplexity = ctx.perplexity('My Perplexity');
+ * // Declare in api(): integrations: { perplexity: perplexity(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.perplexity
  *
  * // Make API requests
  * const ResponseSchema = z.object({
@@ -29,6 +30,7 @@ import type { SupportsApiRequest } from '../base/index.js';
  * );
  * ```
  */
-export interface PerplexityClient extends BaseIntegrationClient, SupportsApiRequest {
+export interface PerplexityClient
+  extends BaseIntegrationClient, SupportsApiRequest {
   // apiRequest() method inherited from SupportsApiRequest
 }