@superblocksteam/sdk-api 2.0.105-next.5 → 2.0.106-next.0

package/src/integrations/redis/types.ts

@@ -1,167 +0,0 @@
-/**
- * Redis client types.
- */
-
-import type { z } from "zod";
-
-import type { BaseIntegrationClient } from "../../types.js";
-import type { TraceMetadata } from "../registry.js";
-
-/**
- * Redis client for executing commands.
- *
- * Provides typed methods for common Redis operations as well as a
- * generic command() method for executing raw Redis commands.
- *
- * @example
- * ```typescript
- * // Declare in api(): integrations: { redis: redis(INTEGRATION_ID) }
- * // In run(), access via ctx.integrations.redis
- *
- * // Typed string operations
- * await redis.set('user:1', 'Alice');
- * const name = await redis.get('user:1');
- *
- * // Typed hash operations
- * await redis.hset('user:1', 'name', 'Alice');
- * const val = await redis.hget('user:1', 'name');
- * const all = await redis.hgetall('user:1');
- *
- * // Key operations
- * await redis.del('user:1');
- * const userKeys = await redis.keys('user:*');
- *
- * // Raw command for anything not covered by typed methods
- * const result = await redis.command(
- *   'LRANGE mylist 0 -1',
- *   z.array(z.string())
- * );
- * ```
- */
-export interface RedisClient extends BaseIntegrationClient {
-  /**
-   * Execute a raw Redis command.
-   *
-   * Use this for commands not covered by the typed methods.
-   *
-   * @param command - The Redis command string (e.g., "LRANGE mylist 0 -1")
-   * @param schema - Zod schema for validating the result
-   * @returns The validated result
-   */
-  command<T>(
-    command: string,
-    schema: z.ZodSchema<T>,
-    metadata?: TraceMetadata,
-  ): Promise<T>;
-
-  /**
-   * Get the value of a key.
-   *
-   * @param key - The key to get
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The value, or null if the key does not exist
-   */
-  get(key: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Set the value of a key.
-   *
-   * @param key - The key to set
-   * @param value - The value to set
-   * @param expirationMs - Optional expiration time in milliseconds
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The result (typically "OK")
-   */
-  set(
-    key: string,
-    value: string,
-    expirationMs?: number,
-    metadata?: TraceMetadata,
-  ): Promise<unknown>;
-
-  /**
-   * Delete a key.
-   *
-   * @param key - The key to delete
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The number of keys removed
-   */
-  del(key: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Find all keys matching a pattern.
-   *
-   * @param pattern - The glob-style pattern to match (e.g., "user:*")
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns Array of matching keys
-   */
-  keys(pattern: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Get the value of a hash field.
-   *
-   * @param key - The hash key
-   * @param field - The field name
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The field value, or null if the field does not exist
-   */
-  hget(key: string, field: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Set the value of a hash field.
-   *
-   * @param key - The hash key
-   * @param field - The field name
-   * @param value - The value to set
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The number of fields that were added
-   */
-  hset(
-    key: string,
-    field: string,
-    value: string,
-    metadata?: TraceMetadata,
-  ): Promise<unknown>;
-
-  /**
-   * Get all fields and values of a hash.
-   *
-   * @param key - The hash key
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns Object with all field-value pairs
-   */
-  hgetall(key: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Delete a hash field.
-   *
-   * @param key - The hash key
-   * @param field - The field to delete
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns The number of fields that were removed
-   */
-  hdel(key: string, field: string, metadata?: TraceMetadata): Promise<unknown>;
-
-  /**
-   * Set expiration on a key.
-   *
-   * @param key - The key to set expiration on
-   * @param seconds - Time to live in seconds
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns 1 if timeout was set, 0 if key does not exist
-   */
-  expire(
-    key: string,
-    seconds: number,
-    metadata?: TraceMetadata,
-  ): Promise<unknown>;
-
-  /**
-   * Get the remaining time to live of a key.
-   *
-   * @param key - The key to check
-   * @param metadata - Optional trace metadata for diagnostics
-   * @returns TTL in seconds, -2 if key does not exist, -1 if no expiration
-   */
-  ttl(key: string, metadata?: TraceMetadata): Promise<unknown>;
-}