@centrali-io/centrali-sdk 2.4.0 → 2.4.3

package/README.md

@@ -4,6 +4,8 @@ Official Node.js SDK for Centrali - Build modern web applications without managi
 
 [![npm version](https://badge.fury.io/js/%40centrali-io%2Fcentrali-sdk.svg)](https://www.npmjs.com/package/@centrali-io/centrali-sdk)
 
+> **Try it now!** Explore the SDK in our [Live Playground on StackBlitz](https://stackblitz.com/~/github.com/centrali-demo/sdk-playground) - no setup required.
+
 ## Installation
 
 ```bash

package/dist/index.js

@@ -183,6 +183,16 @@ class RealtimeManager {
                 if (options.filter) {
                     url.searchParams.set('filter', options.filter);
                 }
+                // Add compute function filters
+                if (options.jobId) {
+                    url.searchParams.set('jobId', options.jobId);
+                }
+                if (options.triggerType) {
+                    url.searchParams.set('triggerType', options.triggerType);
+                }
+                if (options.functionId) {
+                    url.searchParams.set('functionId', options.functionId);
+                }
                 // Create EventSource (uses polyfill in Node.js)
                 eventSource = new EventSourceImpl(url.toString());
                 // Handle connection open
@@ -1467,6 +1477,52 @@ class CentraliSDK {
         const path = getRecordApiPath(this.options.workspaceId, recordSlug, id) + '/restore';
         return this.request('POST', path);
     }
+    // ------------------ Secrets API Methods ------------------
+    /**
+     * Reveal plaintext values of secret fields for a record.
+     * Requires secrets:reveal permission.
+     *
+     * @param recordSlug - The structure's record slug
+     * @param id - The record ID
+     * @param fields - Optional array of specific secret field names to reveal
+     * @returns Object with field names as keys and plaintext secret values
+     *
+     * @example
+     * ```ts
+     * // Reveal all secrets
+     * const result = await client.revealSecrets('users', 'record-123');
+     * console.log(result.data.revealed.apiKey); // "sk_live_..."
+     *
+     * // Reveal specific fields
+     * const result = await client.revealSecrets('users', 'record-123', ['apiKey']);
+     * ```
+     */
+    revealSecrets(recordSlug, id, fields) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id) + '/secrets/reveal';
+        return this.request('POST', path, fields ? { fields } : {});
+    }
+    /**
+     * Compare a candidate value against a secret field without revealing the stored secret.
+     * Requires secrets:compare permission.
+     *
+     * @param recordSlug - The structure's record slug
+     * @param id - The record ID
+     * @param field - The secret field name to compare against
+     * @param value - The candidate value to compare
+     * @returns Boolean indicating if the values match
+     *
+     * @example
+     * ```ts
+     * const result = await client.compareSecret('users', 'record-123', 'apiKey', 'sk_live_test');
+     * if (result.data.matches) {
+     *   console.log('API key is valid');
+     * }
+     * ```
+     */
+    compareSecret(recordSlug, id, field, value) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id) + '/secrets/compare';
+        return this.request('POST', path, { field, value });
+    }
     // ------------------ Storage API Methods ------------------
     /** Upload a file to the storage service. */
     uploadFile(file_1, location_1) {

package/index.ts

@@ -33,11 +33,16 @@ export type ValidationEventType = 'validation_suggestion_created' | 'validation_
  */
 export type AnomalyEventType = 'anomaly_insight_created' | 'anomaly_detection_completed';
 
+/**
+ * Compute function event types emitted by the realtime service.
+ */
+export type ComputeEventType = 'function_run_completed' | 'function_run_failed';
+
 /**
  * All event types emitted by the realtime service.
  * Matches: services/backend/realtime/internal/redis/message.go
  */
-export type RealtimeEventType = RecordEventType | ValidationEventType | AnomalyEventType;
+export type RealtimeEventType = RecordEventType | ValidationEventType | AnomalyEventType | ComputeEventType;
 
 /**
  * Record event payload from the realtime service.
@@ -242,6 +247,63 @@ export interface RealtimeAnomalyDetectionEvent {
     data: AnomalyDetectionData;
 }
 
+/**
+ * Function run error details.
+ */
+export interface FunctionRunError {
+    /** Error message */
+    message: string;
+    /** Error code */
+    code?: string;
+    /** Stack trace */
+    stack?: string;
+}
+
+/**
+ * Memory usage metrics from function execution.
+ */
+export interface FunctionMemoryUsage {
+    /** Heap memory used in bytes */
+    heapUsed: number;
+    /** Resident set size in bytes */
+    rss: number;
+}
+
+/**
+ * Compute function run event payload.
+ * Matches the format published by handle_function_run_events.ts
+ */
+export interface RealtimeFunctionRunEvent {
+    /** Event type */
+    event: ComputeEventType;
+    /** Workspace slug */
+    workspaceSlug: string;
+    /** Unique job identifier (returned from execute call) */
+    jobId: string;
+    /** Function run record ID */
+    runId: string;
+    /** Trigger that initiated the run */
+    triggerId: string;
+    /** Function that was executed */
+    functionId: string;
+    /** Trigger type: on-demand, event-driven, scheduled, http-trigger */
+    triggerType: 'on-demand' | 'event-driven' | 'scheduled' | 'http-trigger';
+    /** Execution status */
+    status: 'completed' | 'failure';
+    /** Function return value (if completed) */
+    outputs?: unknown;
+    /** Error details (if failed) */
+    error?: FunctionRunError;
+    /** Execution time in milliseconds */
+    duration: number;
+    /** Memory usage metrics */
+    memoryUsage?: FunctionMemoryUsage;
+    /** User who triggered the run */
+    userId: string;
+    /** ISO timestamp when the function completed */
+    timestamp: string;
+}
+
 /**
  * Close event payload from the realtime service.
  */
@@ -255,7 +317,7 @@ export interface RealtimeCloseEvent {
 /**
  * Union type of all realtime events.
  */
-export type RealtimeEvent = RealtimeRecordEvent | RealtimeValidationSuggestionEvent | RealtimeValidationBatchEvent | RealtimeAnomalyInsightEvent | RealtimeAnomalyDetectionEvent;
+export type RealtimeEvent = RealtimeRecordEvent | RealtimeValidationSuggestionEvent | RealtimeValidationBatchEvent | RealtimeAnomalyInsightEvent | RealtimeAnomalyDetectionEvent | RealtimeFunctionRunEvent;
 
 /**
  * Error object for realtime connection errors.
@@ -279,6 +341,12 @@ export interface RealtimeSubscribeOptions {
     events?: RealtimeEventType[];
     /** CFL (Centrali Filter Language) expression for data filtering (e.g., "status = 'active'") */
     filter?: string;
+    /** Filter compute events to a specific job ID (only affects function_run_* events) */
+    jobId?: string;
+    /** Filter compute events by trigger type: on-demand, event-driven, scheduled, http-trigger */
+    triggerType?: 'on-demand' | 'event-driven' | 'scheduled' | 'http-trigger';
+    /** Filter compute events to a specific function ID */
+    functionId?: string;
     /** Callback for record events */
     onEvent: (event: RealtimeEvent) => void;
     /** Callback for errors */
@@ -1000,6 +1068,17 @@ export class RealtimeManager {
                     url.searchParams.set('filter', options.filter);
                 }
 
+                // Add compute function filters
+                if (options.jobId) {
+                    url.searchParams.set('jobId', options.jobId);
+                }
+                if (options.triggerType) {
+                    url.searchParams.set('triggerType', options.triggerType);
+                }
+                if (options.functionId) {
+                    url.searchParams.set('functionId', options.functionId);
+                }
+
                 // Create EventSource (uses polyfill in Node.js)
                 eventSource = new EventSourceImpl(url.toString());
 
@@ -2504,7 +2583,63 @@ export class CentraliSDK {
         return this.request('POST', path);
     }
 
+    // ------------------ Secrets API Methods ------------------
+
+    /**
+     * Reveal plaintext values of secret fields for a record.
+     * Requires secrets:reveal permission.
+     *
+     * @param recordSlug - The structure's record slug
+     * @param id - The record ID
+     * @param fields - Optional array of specific secret field names to reveal
+     * @returns Object with field names as keys and plaintext secret values
+     *
+     * @example
+     * ```ts
+     * // Reveal all secrets
+     * const result = await client.revealSecrets('users', 'record-123');
+     * console.log(result.data.revealed.apiKey); // "sk_live_..."
+     *
+     * // Reveal specific fields
+     * const result = await client.revealSecrets('users', 'record-123', ['apiKey']);
+     * ```
+     */
+    public revealSecrets(
+        recordSlug: string,
+        id: string,
+        fields?: string[]
+    ): Promise<ApiResponse<{ revealed: Record<string, any> }>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id) + '/secrets/reveal';
+        return this.request('POST', path, fields ? { fields } : {});
+    }
 
+    /**
+     * Compare a candidate value against a secret field without revealing the stored secret.
+     * Requires secrets:compare permission.
+     *
+     * @param recordSlug - The structure's record slug
+     * @param id - The record ID
+     * @param field - The secret field name to compare against
+     * @param value - The candidate value to compare
+     * @returns Boolean indicating if the values match
+     *
+     * @example
+     * ```ts
+     * const result = await client.compareSecret('users', 'record-123', 'apiKey', 'sk_live_test');
+     * if (result.data.matches) {
+     *   console.log('API key is valid');
+     * }
+     * ```
+     */
+    public compareSecret(
+        recordSlug: string,
+        id: string,
+        field: string,
+        value: string
+    ): Promise<ApiResponse<{ matches: boolean }>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id) + '/secrets/compare';
+        return this.request('POST', path, { field, value });
+    }
 
     // ------------------ Storage API Methods ------------------
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centrali-io/centrali-sdk",
-  "version": "2.4.0",
+  "version": "2.4.3",
   "description": "Centrali Node SDK",
   "main": "dist/index.js",
   "type": "commonjs",