@superblocksteam/sdk-api 2.0.89-next.0

package/src/integrations/launchdarkly/README.md

@@ -0,0 +1,433 @@
+# LaunchDarkly Client
+
+Manage feature flags, get flag evaluations, and interact with LaunchDarkly's feature management platform.
+
+## Methods
+
+| Method | Description |
+| ------ | ----------- |
+| `apiRequest(options, schema)` | Make any LaunchDarkly API request with schema validation |
+
+## Usage
+
+### Get Feature Flag
+
+```typescript
+import { api, z } from "@superblocksteam/sdk-api";
+
+// Integration ID from the integrations panel
+const PROD_LAUNCHDARKLY = "a1b2c3d4-5678-90ab-cdef-launchda0001";
+
+const FlagSchema = z.object({
+  key: z.string(),
+  name: z.string(),
+  description: z.string(),
+  kind: z.string(), // boolean, multivariate
+  creationDate: z.number(),
+  variations: z.array(
+    z.object({
+      value: z.unknown(),
+      name: z.string().optional(),
+      description: z.string().optional(),
+    })
+  ),
+  temporary: z.boolean(),
+  tags: z.array(z.string()),
+  environments: z.record(
+    z.object({
+      on: z.boolean(),
+      archived: z.boolean(),
+      lastModified: z.number(),
+    })
+  ),
+});
+
+export default api({
+  name: "LaunchDarklyExample",
+  input: z.object({
+    projectKey: z.string(),
+    flagKey: z.string(),
+  }),
+  output: z.object({
+    flagKey: z.string(),
+    name: z.string(),
+    isEnabled: z.boolean(),
+  }),
+  async run(ctx, { projectKey, flagKey }) {
+    const launchdarkly = ctx.launchdarkly(PROD_LAUNCHDARKLY);
+
+    const result = await launchdarkly.apiRequest(
+      {
+        method: "GET",
+        path: `/api/v2/flags/${projectKey}/${flagKey}`,
+      },
+      { response: FlagSchema }
+    );
+
+    return {
+      flagKey: result.key,
+      name: result.name,
+      isEnabled: result.environments.production?.on ?? false,
+    };
+  },
+});
+```
+
+### List Feature Flags
+
+```typescript
+const ListFlagsResponseSchema = z.object({
+  items: z.array(FlagSchema),
+  totalCount: z.number(),
+  _links: z.object({
+    self: z.object({ href: z.string() }),
+    next: z.object({ href: z.string() }).optional(),
+  }),
+});
+
+const result = await launchdarkly.apiRequest(
+  {
+    method: "GET",
+    path: `/api/v2/flags/${projectKey}`,
+    params: {
+      limit: 20,
+      filter: "query:new-feature", // Search by name/key
+      tag: "release", // Filter by tag
+    },
+  },
+  { response: ListFlagsResponseSchema }
+);
+
+result.items.forEach((flag) => {
+  console.log(`${flag.key}: ${flag.name}`);
+});
+```
+
+### Create Feature Flag
+
+```typescript
+const result = await launchdarkly.apiRequest(
+  {
+    method: "POST",
+    path: `/api/v2/flags/${projectKey}`,
+    body: {
+      key: "new-checkout-flow",
+      name: "New Checkout Flow",
+      description: "Enables the redesigned checkout experience",
+      tags: ["checkout", "experiment"],
+      variations: [
+        { value: true, name: "Enabled" },
+        { value: false, name: "Disabled" },
+      ],
+      defaults: {
+        onVariation: 0,
+        offVariation: 1,
+      },
+      temporary: true,
+    },
+  },
+  { response: FlagSchema }
+);
+```
+
+### Toggle Flag On/Off
+
+```typescript
+const PatchResponseSchema = z.object({
+  key: z.string(),
+  environments: z.record(z.object({ on: z.boolean() })),
+});
+
+// Turn flag ON in production
+await launchdarkly.apiRequest(
+  {
+    method: "PATCH",
+    path: `/api/v2/flags/${projectKey}/${flagKey}`,
+    body: {
+      patch: [
+        {
+          op: "replace",
+          path: "/environments/production/on",
+          value: true,
+        },
+      ],
+    },
+  },
+  { response: PatchResponseSchema }
+);
+```
+
+### Update Flag Targeting
+
+```typescript
+// Add a user target
+await launchdarkly.apiRequest(
+  {
+    method: "PATCH",
+    path: `/api/v2/flags/${projectKey}/${flagKey}`,
+    body: {
+      patch: [
+        {
+          op: "add",
+          path: "/environments/production/targets/0/values/-",
+          value: "user-123", // Add user to variation 0 targets
+        },
+      ],
+    },
+  },
+  { response: PatchResponseSchema }
+);
+
+// Add a targeting rule
+await launchdarkly.apiRequest(
+  {
+    method: "PATCH",
+    path: `/api/v2/flags/${projectKey}/${flagKey}`,
+    body: {
+      patch: [
+        {
+          op: "add",
+          path: "/environments/production/rules/-",
+          value: {
+            clauses: [
+              {
+                attribute: "country",
+                op: "in",
+                values: ["US", "CA"],
+                negate: false,
+              },
+            ],
+            variation: 0,
+          },
+        },
+      ],
+    },
+  },
+  { response: PatchResponseSchema }
+);
+```
+
+### Get Flag Evaluation
+
+```typescript
+const EvaluationSchema = z.object({
+  value: z.unknown(),
+  variationIndex: z.number(),
+  reason: z.object({
+    kind: z.string(),
+    ruleIndex: z.number().optional(),
+    ruleId: z.string().optional(),
+  }).optional(),
+});
+
+// Note: This typically uses the client-side SDK or server SDK
+// The REST API is mainly for flag management
+const result = await launchdarkly.apiRequest(
+  {
+    method: "POST",
+    path: `/api/v2/flags/${projectKey}/${flagKey}/eval`,
+    body: {
+      environmentKey: "production",
+      user: {
+        key: "user-123",
+        email: "user@example.com",
+        custom: {
+          plan: "enterprise",
+          country: "US",
+        },
+      },
+    },
+  },
+  { response: EvaluationSchema }
+);
+
+console.log(`Flag value: ${result.value}`);
+```
+
+### List Projects
+
+```typescript
+const ProjectSchema = z.object({
+  key: z.string(),
+  name: z.string(),
+  tags: z.array(z.string()),
+  environments: z.array(
+    z.object({
+      key: z.string(),
+      name: z.string(),
+      color: z.string(),
+    })
+  ),
+});
+
+const ListProjectsResponseSchema = z.object({
+  items: z.array(ProjectSchema),
+});
+
+const result = await launchdarkly.apiRequest(
+  {
+    method: "GET",
+    path: "/api/v2/projects",
+  },
+  { response: ListProjectsResponseSchema }
+);
+```
+
+### Get Environments
+
+```typescript
+const EnvironmentSchema = z.object({
+  key: z.string(),
+  name: z.string(),
+  color: z.string(),
+  defaultTtl: z.number(),
+  secureMode: z.boolean(),
+});
+
+const result = await launchdarkly.apiRequest(
+  {
+    method: "GET",
+    path: `/api/v2/projects/${projectKey}/environments`,
+  },
+  { response: z.object({ items: z.array(EnvironmentSchema) }) }
+);
+```
+
+## Common Pitfalls
+
+### No Specialized Methods
+
+```typescript
+// WRONG - These methods do not exist
+await launchdarkly.getFlag({ ... });
+await launchdarkly.evaluateFlag({ ... });
+
+// CORRECT - Use apiRequest
+await launchdarkly.apiRequest(
+  { method: "GET", path: `/api/v2/flags/${project}/${flag}` },
+  { response: FlagSchema }
+);
+```
+
+### JSON Patch for Updates
+
+LaunchDarkly uses JSON Patch format for updates:
+
+```typescript
+// WRONG - Simple body
+const body = {
+  on: true,
+};
+
+// CORRECT - JSON Patch operations
+const body = {
+  patch: [
+    { op: "replace", path: "/environments/production/on", value: true },
+  ],
+};
+
+// Common operations:
+// "add" - Add a value
+// "replace" - Replace a value
+// "remove" - Remove a value
+// "move" - Move a value
+// "copy" - Copy a value
+```
+
+### Environment-Specific Paths
+
+Flag settings are per-environment:
+
+```typescript
+// Path to environment-specific setting
+const path = "/environments/production/on";
+const path = "/environments/staging/targets";
+
+// NOT just
+const wrongPath = "/on"; // Missing environment
+```
+
+### API Version in Path
+
+Always include `/api/v2/`:
+
+```typescript
+// WRONG
+const path = `/flags/${project}/${flag}`;
+
+// CORRECT
+const path = `/api/v2/flags/${project}/${flag}`;
+```
+
+### Variation Indices
+
+Variations are referenced by index (0-based):
+
+```typescript
+// variations: [{ value: true }, { value: false }]
+// Index 0 = true, Index 1 = false
+
+const body = {
+  patch: [
+    {
+      op: "replace",
+      path: "/environments/production/fallthrough/variation",
+      value: 0, // Serve variation index 0 (true)
+    },
+  ],
+};
+```
+
+### User Context Format
+
+When evaluating flags, users have specific format:
+
+```typescript
+const user = {
+  key: "user-unique-id", // Required
+  email: "user@example.com",
+  name: "John Doe",
+  firstName: "John",
+  lastName: "Doe",
+  ip: "1.2.3.4",
+  country: "US",
+  custom: {
+    // Custom attributes
+    plan: "enterprise",
+    team: "engineering",
+  },
+};
+```
+
+### Rate Limits
+
+LaunchDarkly has rate limits (varies by endpoint):
+
+```typescript
+// Check X-Ratelimit-* headers
+// Typical limit: 10 requests/second for read, lower for write
+```
+
+## Error Handling
+
+```typescript
+import { RestApiValidationError } from "@superblocksteam/sdk-api";
+
+try {
+  const result = await launchdarkly.apiRequest(
+    { method: "GET", path: `/api/v2/flags/${project}/${flag}` },
+    { response: FlagSchema }
+  );
+} catch (error) {
+  if (error instanceof RestApiValidationError) {
+    console.error("Validation failed:", error.details.zodError);
+  }
+}
+```
+
+## API Reference
+
+- [LaunchDarkly API Documentation](https://apidocs.launchdarkly.com/)
+- [Feature Flags](https://apidocs.launchdarkly.com/tag/Feature-flags)
+- [Projects](https://apidocs.launchdarkly.com/tag/Projects)
+- [Environments](https://apidocs.launchdarkly.com/tag/Environments)

package/src/integrations/launchdarkly/client.ts

@@ -0,0 +1,21 @@
+/**
+ * LaunchDarkly client implementation.
+ *
+ * Uses the proto-generated REST API Integration Plugin type from @superblocksteam/types.
+ * LaunchDarkly integrations use the REST API Integration plugin under the hood.
+ */
+
+import { RestApiIntegrationClient } from '../base/index.js';
+import type { LaunchDarklyClient } from './types.js';
+
+/**
+ * Internal implementation of LaunchDarklyClient.
+ *
+ * Extends RestApiIntegrationClient to inherit the generic apiRequest() method.
+ * This implementation communicates with the orchestrator to execute
+ * LaunchDarkly API calls. At runtime, the orchestrator handles authentication
+ * and API request execution.
+ */
+export class LaunchDarklyClientImpl extends RestApiIntegrationClient implements LaunchDarklyClient {
+  // Inherits: name, pluginId, config, executeQuery, apiRequest()
+}

package/src/integrations/launchdarkly/index.ts

@@ -0,0 +1,2 @@
+export { LaunchDarklyClientImpl } from './client.js';
+export type { LaunchDarklyClient } from './types.js';

package/src/integrations/launchdarkly/types.ts

@@ -0,0 +1,34 @@
+/**
+ * LaunchDarkly client types.
+ */
+
+import type { BaseIntegrationClient } from '../../types.js';
+import type { SupportsApiRequest } from '../base/index.js';
+
+/**
+ * LaunchDarkly client for API interactions.
+ *
+ * Provides generic API request method for interacting with LaunchDarkly's API.
+ * Use apiRequest() to make calls to any LaunchDarkly API endpoint.
+ *
+ * @example
+ * ```typescript
+ * const launchdarkly = ctx.launchDarkly('My LaunchDarkly');
+ *
+ * // Make API requests
+ * const ResponseSchema = z.object({
+ *   // Define your response schema
+ * });
+ *
+ * const result = await launchdarkly.apiRequest(
+ *   {
+ *     method: 'GET',
+ *     path: '/api/v2/flags',
+ *   },
+ *   { response: ResponseSchema }
+ * );
+ * ```
+ */
+export interface LaunchDarklyClient extends BaseIntegrationClient, SupportsApiRequest {
+  // apiRequest() method inherited from SupportsApiRequest
+}

package/src/integrations/mariadb/README.md

@@ -0,0 +1,123 @@
+# MariaDB Client
+
+Execute SQL queries and statements against MariaDB databases with full type safety and runtime validation.
+
+## Methods
+
+| Method | Description |
+| ------ | ----------- |
+| `query<T>(sql, schema, params?)` | Execute a SELECT query and return validated, typed results |
+| `execute(sql, params?)` | Execute a statement (INSERT, UPDATE, DELETE) and return affected row count |
+
+## Usage
+
+### Basic Query with Schema Validation
+
+```typescript
+import { api, z } from "@superblocksteam/sdk-api";
+
+// Integration ID from the integrations panel
+const PROD_MARIADB = "a1b2c3d4-5678-90ab-cdef-mariadb00001";
+
+const UserSchema = z.object({
+  id: z.number(),
+  name: z.string(),
+  email: z.string().email(),
+  created_at: z.string(),
+});
+
+export default api({
+  name: "MariaDBExample",
+  input: z.object({
+    status: z.string(),
+  }),
+  output: z.object({
+    users: z.array(UserSchema),
+  }),
+  async run(ctx, { status }) {
+    const mariadb = ctx.mariadb(PROD_MARIADB);
+
+    const users = await mariadb.query(
+      "SELECT id, name, email, created_at FROM users WHERE status = $1",
+      UserSchema,
+      [status]
+    );
+
+    return { users };
+  },
+});
+```
+
+### Executing INSERT, UPDATE, DELETE Statements
+
+```typescript
+const mariadb = ctx.mariadb(PROD_MARIADB);
+
+// INSERT
+await mariadb.execute(
+  "INSERT INTO users (name, email) VALUES ($1, $2)",
+  ["John Doe", "john@example.com"]
+);
+
+// UPDATE
+const updateResult = await mariadb.execute(
+  "UPDATE users SET last_login = NOW() WHERE id = $1",
+  [userId]
+);
+console.log(`Updated ${updateResult.rowCount} rows`);
+
+// DELETE
+const deleteResult = await mariadb.execute(
+  "DELETE FROM sessions WHERE expires_at < NOW()"
+);
+console.log(`Deleted ${deleteResult.rowCount} expired sessions`);
+```
+
+## Common Pitfalls
+
+### BIGINT Values Returned as Strings
+
+MariaDB `BIGINT` columns may be returned as strings:
+
+```typescript
+const schema = z.object({
+  id: z.coerce.number(),
+  count: z.coerce.number(),
+});
+```
+
+### Schema Parameter is Required
+
+```typescript
+// CORRECT - Schema is required
+const users = await mariadb.query("SELECT * FROM users", UserSchema);
+```
+
+### NULL Handling
+
+```typescript
+const schema = z.object({
+  name: z.string(),
+  bio: z.string().nullable(),
+});
+```
+
+## Error Handling
+
+```typescript
+import { QueryValidationError } from "@superblocksteam/sdk-api";
+
+try {
+  const users = await mariadb.query("SELECT * FROM users", UserSchema);
+} catch (error) {
+  if (error instanceof QueryValidationError) {
+    console.error("Row index:", error.details.rowIndex);
+    console.error("Validation errors:", error.details.errors);
+  }
+}
+```
+
+## API Reference
+
+- [MariaDB Documentation](https://mariadb.com/kb/en/documentation/)
+- [MariaDB Data Types](https://mariadb.com/kb/en/data-types/)