@superblocksteam/sdk-api 0.0.5 → 0.0.7

package/src/integrations/openai_v2/types.ts

@@ -3,16 +3,12 @@
  */
 
 import type { BaseIntegrationClient } from "../../types.js";
-import type {
-  SupportsApiRequest,
-  SupportsStreamingApiRequest,
-} from "../base/index.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * OpenAI client for AI model interactions.
  *
- * Provides the generic apiRequest() method for any OpenAI API endpoint,
- * and streamApiRequest() for streaming responses.
+ * Provides the generic apiRequest() method for any OpenAI API endpoint.
  * Use this to interact with OpenAI's chat completions, embeddings, and other endpoints.
  *
  * @example
@@ -45,7 +41,7 @@ import type {
  * const completion = await ctx.integrations.ai.apiRequest(
  *   {
  *     method: 'POST',
- *     path: '/v1/chat/completions',
+ *     path: '/chat/completions',
  *     body: {
  *       model: 'gpt-4',
  *       messages: [{ role: 'user', content: 'Hello!' }],
@@ -57,30 +53,9 @@ import type {
  *   }
  * );
  *
- * // Or use streaming for real-time responses
- * const stream = openai.streamApiRequest(
- *   {
- *     method: 'POST',
- *     path: '/v1/chat/completions',
- *     body: {
- *       model: 'gpt-4',
- *       stream: true,
- *       messages: [{ role: 'user', content: 'Hello!' }],
- *     },
- *   },
- *   { chunk: StreamChunkSchema }
- * );
- *
- * for await (const chunk of stream) {
- *   // Handle streaming chunks
- * }
  * ```
  */
 export interface OpenAIClient
-  extends
-    BaseIntegrationClient,
-    SupportsApiRequest,
-    SupportsStreamingApiRequest {
+  extends BaseIntegrationClient, SupportsApiRequest {
   // apiRequest() method inherited from SupportsApiRequest
-  // streamApiRequest() method inherited from SupportsStreamingApiRequest
 }

package/src/integrations/oracledb/README.md

@@ -39,7 +39,7 @@ export default api({
   }),
   async run(ctx, { status }) {
     const users = await ctx.integrations.oracledb.query(
-      "SELECT ID, NAME, EMAIL, CREATED_AT FROM USERS WHERE STATUS = $1",
+      "SELECT ID, NAME, EMAIL, CREATED_AT FROM USERS WHERE STATUS = :1",
       UserSchema,
       [status],
     );
@@ -54,13 +54,13 @@ export default api({
 ```typescript
 // INSERT
 await ctx.integrations.oracledb.execute(
-  "INSERT INTO USERS (NAME, EMAIL) VALUES ($1, $2)",
+  "INSERT INTO USERS (NAME, EMAIL) VALUES (:1, :2)",
   ["John Doe", "john@example.com"],
 );
 
 // UPDATE
 const updateResult = await ctx.integrations.oracledb.execute(
-  "UPDATE USERS SET LAST_LOGIN = SYSDATE WHERE ID = $1",
+  "UPDATE USERS SET LAST_LOGIN = SYSDATE WHERE ID = :1",
   [userId],
 );
 console.log(`Updated ${updateResult.rowCount} rows`);

package/src/integrations/oracledb/client.ts

@@ -5,13 +5,15 @@
  * runtime validation using Zod schemas.
  */
 
-import type { z } from "zod";
 import type { PartialMessage } from "@bufbuild/protobuf";
+import type { z } from "zod";
+
 import type { Plugin as OracleDBPlugin } from "@superblocksteam/types/dist/src/plugins/oracledb/v1/plugin_pb";
-import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
-import type { QueryExecutor, TraceMetadata } from "../registry.js";
+
 import { QueryValidationError } from "../../errors.js";
 import { IntegrationError } from "../../runtime/errors.js";
+import type { QueryExecutor, TraceMetadata } from "../registry.js";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
 import { describeType } from "../utils.js";
 import type { OracleDBClient } from "./types.js";
 

package/src/integrations/oracledb/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "oracledb",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/oracledb/types.ts

@@ -5,6 +5,7 @@
  */
 
 import type { z } from "zod";
+
 import type { BaseIntegrationClient } from "../../types.js";
 import type { TraceMetadata } from "../registry.js";
 
@@ -24,7 +25,7 @@ import type { TraceMetadata } from "../registry.js";
  * });
  *
  * const users = await oracledb.query(
- *   'SELECT * FROM users WHERE status = $1',
+ *   'SELECT * FROM users WHERE status = :1',
  *   UserSchema,
  *   ['active']
  * );
@@ -34,7 +35,7 @@ export interface OracleDBClient extends BaseIntegrationClient {
   /**
    * Execute a SQL query and validate results against a Zod schema.
    *
-   * @param sql - SQL query string (use $1, $2, etc. for parameters)
+   * @param sql - SQL query string (use :1, :2, etc. for parameters)
    * @param schema - Zod schema to validate the query results
    * @param params - Optional query parameters
    * @returns Promise resolving to validated query results

package/src/integrations/pagerduty/README.md

@@ -13,7 +13,7 @@ Create incidents, manage services, and interact with PagerDuty's incident manage
 ### Create an Incident
 
 ```typescript
-import { api, z, pagerduty } 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";
@@ -52,7 +52,7 @@ const CreateIncidentResponseSchema = z.object({
 
 export default api({
   integrations: {
-    pagerduty: pagerduty(PROD_PAGERDUTY),
+    pagerduty: pagerDuty(PROD_PAGERDUTY),
   },
   name: "PagerDutyExample",
   input: z.object({

package/src/integrations/pagerduty/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "pagerduty",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/perplexity/README.md

@@ -58,7 +58,7 @@ export default api({
         method: "POST",
         path: "/chat/completions",
         body: {
-          model: "llama-3.1-sonar-large-128k-online",
+          model: "sonar-pro",
           messages: [
             {
               role: "system",
@@ -82,40 +82,40 @@ export default api({
 ### Using Different Models
 
 ```typescript
-// Online models - With real-time search
-const onlineResult = await ctx.integrations.perplexity.apiRequest(
+// Standard search model - Fast, lightweight
+const result = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-online", // Real-time search
+      model: "sonar", // Fast search
       messages: [{ role: "user", content: "What's the latest news about AI?" }],
     },
   },
   { response: ChatCompletionResponseSchema },
 );
 
-// Chat models - Without search, faster
-const chatResult = await ctx.integrations.perplexity.apiRequest(
+// Pro search model - Deeper content understanding
+const proResult = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-chat", // No search
+      model: "sonar-pro", // Advanced search
       messages: [{ role: "user", content: "Explain quantum computing" }],
     },
   },
   { response: ChatCompletionResponseSchema },
 );
 
-// Small models - Faster, lower cost
-const smallResult = await ctx.integrations.perplexity.apiRequest(
+// Reasoning model - Multi-step Chain-of-Thought
+const reasoningResult = await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-small-128k-online",
-      messages: [{ role: "user", content: "Quick fact check..." }],
+      model: "sonar-reasoning-pro",
+      messages: [{ role: "user", content: "Analyze the pros and cons of..." }],
     },
   },
   { response: ChatCompletionResponseSchema },
@@ -130,7 +130,7 @@ const result = await ctx.integrations.perplexity.apiRequest(
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-online",
+      model: "sonar-pro",
       messages: [
         {
           role: "user",
@@ -152,7 +152,7 @@ const result = await ctx.integrations.perplexity.apiRequest(
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-online",
+      model: "sonar-pro",
       messages: [
         { role: "user", content: "Recent developments in electric vehicles" },
       ],
@@ -171,7 +171,7 @@ const result = await ctx.integrations.perplexity.apiRequest(
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-online",
+      model: "sonar",
       messages: [
         { role: "user", content: "What is the capital of France?" },
         { role: "assistant", content: "The capital of France is Paris." },
@@ -203,16 +203,22 @@ await ctx.integrations.perplexity.apiRequest(
 );
 ```
 
-### Online vs Chat Models
+### Model Selection
 
-Online models perform real-time search, chat models don't:
+Choose the right model for your use case:
 
 ```typescript
-// For questions requiring current information
-const model = "llama-3.1-sonar-large-128k-online";
+// For quick answers with web search
+const model = "sonar";
+
+// For complex queries requiring deeper understanding
+const model = "sonar-pro";
 
-// For general knowledge (faster, no search)
-const model = "llama-3.1-sonar-large-128k-chat";
+// For multi-step reasoning tasks
+const model = "sonar-reasoning-pro";
+
+// For in-depth research
+const model = "sonar-deep-research";
 ```
 
 ### Citations May Be Empty
@@ -229,46 +235,32 @@ if (sources.length === 0) {
 }
 ```
 
-### Model Naming Convention
+### Available Models
 
-Perplexity models follow a specific naming pattern:
+Perplexity offers the following Sonar models. Check the [Perplexity models page](https://docs.perplexity.ai/docs/sonar/models) for the latest options:
 
 ```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
+  "sonar", // Fast, lightweight search
+  "sonar-pro", // Advanced search with deeper understanding
+  "sonar-reasoning-pro", // Multi-step Chain-of-Thought reasoning
+  "sonar-deep-research", // In-depth research for complex queries
 ];
 ```
 
-### Search Parameters Only Work with Online Models
+### Search Parameters
 
-```typescript
-// WRONG - search_domain_filter with chat model
-await ctx.integrations.perplexity.apiRequest(
-  {
-    method: "POST",
-    path: "/chat/completions",
-    body: {
-      model: "llama-3.1-sonar-large-128k-chat", // Chat model
-      messages: [...],
-      search_domain_filter: ["example.com"], // Ignored!
-    },
-  },
-  { response: schema }
-);
+All Sonar models support search by default. You can use search filters to refine results:
 
-// CORRECT - search_domain_filter with online model
+```typescript
 await ctx.integrations.perplexity.apiRequest(
   {
     method: "POST",
     path: "/chat/completions",
     body: {
-      model: "llama-3.1-sonar-large-128k-online", // Online model
+      model: "sonar-pro",
       messages: [...],
-      search_domain_filter: ["example.com"], // Works!
+      search_domain_filter: ["example.com"], // Limit search to specific domains
     },
   },
   { response: schema }
@@ -295,5 +287,5 @@ try {
 ## API Reference
 
 - [Perplexity API Documentation](https://docs.perplexity.ai/)
-- [Chat Completions](https://docs.perplexity.ai/reference/post_chat_completions)
-- [Models](https://docs.perplexity.ai/docs/model-cards)
+- [Sonar API](https://docs.perplexity.ai/api-reference/sonar-post)
+- [Models](https://docs.perplexity.ai/docs/sonar/models)

package/src/integrations/perplexity/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "perplexity",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/postgres/client.ts

@@ -5,15 +5,17 @@
  * for type-safe request building.
  */
 
-import type { z } from "zod";
 import type { PartialMessage } from "@bufbuild/protobuf";
+import type { z } from "zod";
+
 import type { Plugin as PostgresPlugin } from "@superblocksteam/types/dist/src/plugins/postgresql/v1/plugin_pb";
-import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
-import type { QueryExecutor, TraceMetadata } from "../registry.js";
-import type { PostgresClient } from "./types.js";
+
 import { QueryValidationError } from "../../errors.js";
 import { IntegrationError } from "../../runtime/errors.js";
+import type { QueryExecutor, TraceMetadata } from "../registry.js";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
 import { describeType } from "../utils.js";
+import type { PostgresClient } from "./types.js";
 /**
  * PostgreSQL request type derived from proto definition.
  * Using PartialMessage allows optional fields.

package/src/integrations/postgres/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "postgres",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/postgres/types.ts

@@ -3,6 +3,7 @@
  */
 
 import type { z } from "zod";
+
 import type { BaseIntegrationClient } from "../../types.js";
 import type { TraceMetadata } from "../registry.js";
 

package/src/integrations/redshift/client.ts

@@ -5,13 +5,15 @@
  * runtime validation using Zod schemas.
  */
 
-import type { z } from "zod";
 import type { PartialMessage } from "@bufbuild/protobuf";
+import type { z } from "zod";
+
 import type { Plugin as RedshiftPlugin } from "@superblocksteam/types/dist/src/plugins/redshift/v1/plugin_pb";
-import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
-import type { QueryExecutor, TraceMetadata } from "../registry.js";
+
 import { QueryValidationError } from "../../errors.js";
 import { IntegrationError } from "../../runtime/errors.js";
+import type { QueryExecutor, TraceMetadata } from "../registry.js";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
 import { describeType } from "../utils.js";
 import type { RedshiftClient } from "./types.js";
 

package/src/integrations/redshift/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "redshift",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/redshift/types.ts

@@ -5,6 +5,7 @@
  */
 
 import type { z } from "zod";
+
 import type { BaseIntegrationClient } from "../../types.js";
 import type { TraceMetadata } from "../registry.js";
 

package/src/integrations/registry.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it, vi } from "vitest";
+
 import {
   createClient,
   isPluginSupported,
@@ -12,9 +13,8 @@ describe("integration registry", () => {
     expect(isPluginSupported(SUPPORTED_PLUGINS.snowflakecortex)).toBe(true);
   });
 
-  it("creates a SnowflakeCortex client with streaming support", () => {
+  it("creates a SnowflakeCortex client", () => {
     const executeQuery = vi.fn();
-    const executeStreamingQuery = vi.fn();
 
     const client = createClient({
       config: {
@@ -24,7 +24,6 @@ describe("integration registry", () => {
         configuration: {},
       },
       executeQuery,
-      executeStreamingQuery,
     });
 
     expect(client).toBeInstanceOf(SnowflakeCortexClientImpl);