@gokiteam/goki-dev-client 0.2.2

package/dist/client.js

@@ -0,0 +1,557 @@
+"use strict";
+/**
+ * @gokiteam/goki-dev-client - Main Client
+ *
+ * HTTP client for Goki Developer Tools
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevToolsClient = exports.HttpTrafficClient = exports.SchedulerClient = exports.PlatformClient = exports.DockerClient = exports.MqttClient = exports.FirestoreClient = exports.RedisClient = exports.PostgresClient = exports.LoggingClient = exports.PubSubClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+// ============================================================================
+// PubSub Client
+// ============================================================================
+class PubSubClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    /**
+     * Extract short topic name from a full path like 'projects/X/topics/Y' -> 'Y'
+     */
+    extractTopicName(topic) {
+        const match = topic.match(/^projects\/[^/]+\/topics\/(.+)$/);
+        return match ? match[1] : topic;
+    }
+    async publish(params) {
+        const result = await this.call('/v1/pubsub/messages/publish', {
+            topicName: this.extractTopicName(params.topic),
+            message: params.message,
+            attributes: params.attributes,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async waitForMessage(params) {
+        const result = await this.call('/v1/pubsub/messages/wait-for', params);
+        return result.data;
+    }
+    async assertMessagePublished(params) {
+        const result = await this.call('/v1/pubsub/messages/assert-published', params);
+        return result.data;
+    }
+    async getMessages(params = {}) {
+        const result = await this.call('/v1/pubsub/messages/history', {
+            filter: params.filter,
+            page: params.page,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async searchMessages(params) {
+        const result = await this.call('/v1/pubsub/messages/search', {
+            query: params.query,
+            searchIn: ['data', 'attributes'],
+            filter: params.filter,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async listTopics(params = {}) {
+        const result = await this.call('/v1/pubsub/topics/list', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async createTopic(params) {
+        const result = await this.call('/v1/pubsub/topics/create', {
+            topicName: this.extractTopicName(params.topic),
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async deleteTopic(params) {
+        await this.call('/v1/pubsub/topics/delete', {
+            topicName: this.extractTopicName(params.topic),
+            traceId: params.traceId
+        });
+    }
+}
+exports.PubSubClient = PubSubClient;
+// ============================================================================
+// Logging Client
+// ============================================================================
+class LoggingClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async getByTrace(params) {
+        const result = await this.call(`/v1/logging/trace/${params.traceId}`, { traceId: params.queryTraceId || `query-${params.traceId}` });
+        return result.data.trace;
+    }
+    async list(params = {}) {
+        const result = await this.call('/v1/logging/entries/list', {
+            filter: params.filter,
+            page: params.page,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async clear(params = {}) {
+        const result = await this.call('/v1/logging/entries/clear', {
+            service: params.service,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async waitForLog(params) {
+        const result = await this.call('/v1/logging/entries/wait-for', params);
+        return result.data;
+    }
+    async assertNoErrors(params) {
+        const result = await this.call('/v1/logging/entries/assert-no-errors', params);
+        return result.data;
+    }
+}
+exports.LoggingClient = LoggingClient;
+// ============================================================================
+// PostgreSQL Client
+// ============================================================================
+class PostgresClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async query(params) {
+        const result = await this.call('/v1/postgres/query/execute', params);
+        return result.data;
+    }
+    async listTables(params) {
+        const result = await this.call('/v1/postgres/tables/list', {
+            database: params.database,
+            schema: params.schema || 'public',
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async listRows(params) {
+        const result = await this.call('/v1/postgres/rows/list', {
+            database: params.database,
+            schema: params.schema,
+            table: params.table,
+            page: params.page,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async waitForCondition(params) {
+        const result = await this.call('/v1/postgres/rows/wait-for', params);
+        return result.data;
+    }
+}
+exports.PostgresClient = PostgresClient;
+// ============================================================================
+// Redis Client
+// ============================================================================
+class RedisClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async get(params) {
+        const result = await this.call('/v1/redis/keys/get', {
+            key: params.key,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async scan(params) {
+        const result = await this.call('/v1/redis/keys/scan', {
+            pattern: params.pattern,
+            count: params.count || 100,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async delete(params) {
+        const result = await this.call('/v1/redis/keys/delete', {
+            key: params.key,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async deletePattern(params) {
+        const result = await this.call('/v1/redis/keys/delete-all', {
+            pattern: params.pattern,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async waitForCondition(params) {
+        const result = await this.call('/v1/redis/keys/wait-for', params);
+        return result.data;
+    }
+}
+exports.RedisClient = RedisClient;
+// ============================================================================
+// Firestore Client
+// ============================================================================
+class FirestoreClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    /**
+     * Parses a Firestore REST API typed value into a plain JS value.
+     */
+    parseFirestoreValue(value) {
+        if (!value || typeof value !== 'object')
+            return value;
+        if (value.stringValue !== undefined)
+            return value.stringValue;
+        if (value.integerValue !== undefined)
+            return Number(value.integerValue);
+        if (value.doubleValue !== undefined)
+            return value.doubleValue;
+        if (value.booleanValue !== undefined)
+            return value.booleanValue;
+        if (value.nullValue !== undefined)
+            return null;
+        if (value.timestampValue !== undefined)
+            return value.timestampValue;
+        if (value.mapValue)
+            return this.parseFirestoreFields(value.mapValue.fields || {});
+        if (value.arrayValue)
+            return (value.arrayValue.values || []).map((v) => this.parseFirestoreValue(v));
+        if (value.geoPointValue)
+            return value.geoPointValue;
+        if (value.referenceValue !== undefined)
+            return value.referenceValue;
+        if (value.bytesValue !== undefined)
+            return value.bytesValue;
+        return value;
+    }
+    /**
+     * Parses Firestore REST API fields object into a plain JS object.
+     */
+    parseFirestoreFields(fields) {
+        const result = {};
+        for (const [key, value] of Object.entries(fields)) {
+            result[key] = this.parseFirestoreValue(value);
+        }
+        return result;
+    }
+    /**
+     * Converts a raw Firestore REST API document to a clean FirestoreDocument.
+     * Raw format: { name: "projects/.../documents/collection/id", fields: { key: { stringValue: "..." } }, ... }
+     * Clean format: { id: "docId", data: { key: "..." } }
+     */
+    parseRawDocument(rawDoc) {
+        const name = rawDoc?.name || '';
+        const id = name.split('/').pop() || '';
+        const data = rawDoc?.fields ? this.parseFirestoreFields(rawDoc.fields) : {};
+        return { id, data };
+    }
+    async getDocument(params) {
+        const result = await this.call('/v1/firestore/documents/get', {
+            collectionPath: params.collection,
+            documentId: params.documentId,
+            traceId: params.traceId
+        });
+        const rawDocument = result.data.document;
+        return { document: this.parseRawDocument(rawDocument) };
+    }
+    async query(params) {
+        const result = await this.call('/v1/firestore/query/execute', {
+            collectionPath: params.collection,
+            where: params.where,
+            traceId: params.traceId
+        });
+        const documents = (result.data.documents || []).map((doc) => this.parseRawDocument(doc));
+        return { documents };
+    }
+    async listDocuments(params) {
+        const result = await this.call('/v1/firestore/documents/list', {
+            collectionPath: params.collection,
+            page: params.page,
+            traceId: params.traceId
+        });
+        const documents = (result.data.documents || []).map((doc) => this.parseRawDocument(doc));
+        return { documents, total: result.data.total };
+    }
+    async deleteByQuery(params) {
+        const result = await this.call('/v1/firestore/documents/delete-by-query', {
+            collectionPath: params.collection,
+            where: params.where,
+            traceId: params.traceId
+        });
+        return { deletedCount: result.data.deletedCount, traceId: result.data.traceId };
+    }
+    async deleteByPrefix(params) {
+        const result = await this.call('/v1/firestore/documents/delete-by-prefix', {
+            collectionPath: params.collection,
+            prefix: params.prefix,
+            traceId: params.traceId
+        });
+        return { deletedCount: result.data.deletedCount, traceId: result.data.traceId };
+    }
+    async deleteBatch(params) {
+        const result = await this.call('/v1/firestore/documents/delete-batch', {
+            collectionPath: params.collection,
+            documentIds: params.documentIds,
+            traceId: params.traceId
+        });
+        return {
+            deletedCount: result.data.deletedCount,
+            failedIds: result.data.failedIds,
+            traceId: result.data.traceId
+        };
+    }
+    async waitForCondition(params) {
+        const result = await this.call('/v1/firestore/documents/wait-for', params);
+        return result.data;
+    }
+}
+exports.FirestoreClient = FirestoreClient;
+// ============================================================================
+// MQTT Client
+// ============================================================================
+class MqttClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async listClients(params = {}) {
+        const result = await this.call('/v1/mqtt/clients/list', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async getMessages(params = {}) {
+        const result = await this.call('/v1/mqtt/messages/list', {
+            filter: params.filter,
+            page: params.page,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+}
+exports.MqttClient = MqttClient;
+// ============================================================================
+// Docker Client
+// ============================================================================
+class DockerClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async list(params = {}) {
+        const result = await this.call('/v1/docker/containers/list', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async start(params) {
+        await this.call('/v1/docker/containers/start', {
+            containerName: params.containerName,
+            traceId: params.traceId
+        });
+    }
+    async stop(params) {
+        await this.call('/v1/docker/containers/stop', {
+            containerName: params.containerName,
+            traceId: params.traceId
+        });
+    }
+    async restart(params) {
+        await this.call('/v1/docker/containers/restart', {
+            containerName: params.containerName,
+            traceId: params.traceId
+        });
+    }
+    async logs(params) {
+        const result = await this.call('/v1/docker/containers/logs', {
+            containerName: params.containerName,
+            lines: params.lines || 100,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+}
+exports.DockerClient = DockerClient;
+// ============================================================================
+// Platform Client
+// ============================================================================
+class PlatformClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async getStats(params = {}) {
+        const result = await this.call('/v1/dashboard/stats', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async clearAll(params = {}) {
+        const result = await this.call('/v1/data/clear', {
+            confirm: true,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async clearServices(params) {
+        const result = await this.call('/v1/data/clear-services', params);
+        return result.data;
+    }
+    async export(params = {}) {
+        const result = await this.call('/v1/data/export', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+}
+exports.PlatformClient = PlatformClient;
+// ============================================================================
+// Scheduler Client
+// ============================================================================
+class SchedulerClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async triggerTick(params = {}) {
+        const result = await this.call('/v1/scheduler/tick/trigger', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+}
+exports.SchedulerClient = SchedulerClient;
+// ============================================================================
+// HTTP Traffic Client
+// ============================================================================
+class HttpTrafficClient {
+    constructor(client) {
+        this.client = client;
+    }
+    async call(endpoint, data = {}) {
+        const response = await this.client.post(endpoint, data);
+        return response.data;
+    }
+    async list(params = {}) {
+        const result = await this.call('/v1/http-traffic/list', {
+            filter: params.filter,
+            limit: params.limit,
+            offset: params.offset,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async getDetails(params) {
+        const result = await this.call('/v1/http-traffic/details', {
+            id: params.id,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async clear(params = {}) {
+        const result = await this.call('/v1/http-traffic/clear', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async waitFor(params) {
+        const result = await this.call('/v1/http-traffic/wait-for', {
+            filter: params.filter,
+            timeout: params.timeout,
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+    async stats(params = {}) {
+        const result = await this.call('/v1/http-traffic/stats', {
+            traceId: params.traceId
+        });
+        return result.data;
+    }
+}
+exports.HttpTrafficClient = HttpTrafficClient;
+// ============================================================================
+// Main DevTools Client
+// ============================================================================
+class DevToolsClient {
+    constructor(config = {}) {
+        this.baseUrl = config.baseUrl || process.env.DEV_TOOLS_BASE || 'http://localhost:9000';
+        this.client = axios_1.default.create({
+            baseURL: this.baseUrl,
+            timeout: config.timeout || 30000,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+        this.pubsub = new PubSubClient(this.client);
+        this.logging = new LoggingClient(this.client);
+        this.postgres = new PostgresClient(this.client);
+        this.redis = new RedisClient(this.client);
+        this.firestore = new FirestoreClient(this.client);
+        this.mqtt = new MqttClient(this.client);
+        this.docker = new DockerClient(this.client);
+        this.platform = new PlatformClient(this.client);
+        this.scheduler = new SchedulerClient(this.client);
+        this.httpTraffic = new HttpTrafficClient(this.client);
+    }
+    // ============================================================================
+    // Utility Methods
+    // ============================================================================
+    generateTraceId(prefix = 'e2e') {
+        return `${prefix}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+    }
+}
+exports.DevToolsClient = DevToolsClient;
+// Export types
+__exportStar(require("./types"), exports);

package/dist/helpers.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @gokiteam/goki-dev - Helper Utilities
+ *
+ * Common test helpers and utilities
+ */
+import { DevToolsClient } from './client';
+import type * as Types from './types';
+/**
+ * Wait for async operation with custom polling
+ */
+export declare function waitFor<T>(predicate: () => Promise<T | null>, options?: {
+    timeout?: number;
+    interval?: number;
+    timeoutMessage?: string;
+}): Promise<T>;
+/**
+ * Sleep for specified milliseconds
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Verify multi-system state helper
+ */
+export interface VerifyAcrossServicesOptions {
+    database?: {
+        database: string;
+        query: string;
+        params?: any[];
+    };
+    redis?: {
+        key: string;
+    };
+    pubsub?: {
+        filter: Types.PubSubHistoryFilter;
+    };
+    firestore?: {
+        collection: string;
+        documentId: string;
+    };
+    logging?: boolean;
+}
+export interface VerifyAcrossServicesResults {
+    database?: any[];
+    redis?: any;
+    pubsub?: Types.PubSubMessage[];
+    firestore?: Types.FirestoreDocument;
+    logs?: Types.LogEntry[];
+}
+export declare function verifyAcrossServices(client: DevToolsClient, traceId: string, expectations: VerifyAcrossServicesOptions): Promise<VerifyAcrossServicesResults>;
+/**
+ * Find error logs in a trace
+ */
+export declare function findErrorLogs(client: DevToolsClient, traceId: string): Promise<Types.LogEntry[]>;
+/**
+ * Test suite builder
+ */
+export interface TestContext {
+    client: DevToolsClient;
+    traceId: string;
+    cleanup: Array<() => Promise<void>>;
+}
+export declare function createTestContext(clientConfig?: import('./client').DevToolsClientConfig): Promise<TestContext>;
+export declare function runTest(name: string, testFn: (ctx: TestContext) => Promise<void>, clientConfig?: import('./client').DevToolsClientConfig): Promise<void>;