@katerai/sdk 0.10.0 → 0.11.0

package/resources/v1/compiler/combination.d.ts

@@ -0,0 +1,120 @@
+import { APIResource } from "../../../core/resource.js";
+import * as CompilerAPI from "./compiler.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Combination extends APIResource {
+    /**
+     * Preview a single combination: resolve, compile, execute, and build config.
+     *
+     * Chains existing services to provide a single-call preview for the query gallery.
+     * Returns data + WidgetConfig for immediate rendering.
+     *
+     * RLS: Filtered to current client (ClientRLSDB).
+     */
+    preview(params: CombinationPreviewParams, options?: RequestOptions): APIPromise<CombinationPreviewResponse>;
+}
+/**
+ * Response from combination preview with data + resolved config.
+ */
+export interface CombinationPreviewResponse {
+    /**
+     * Whether preview succeeded
+     */
+    success: boolean;
+    /**
+     * Auto-generated title
+     */
+    auto_title?: string | null;
+    /**
+     * Whether the result was served from cache
+     */
+    cache_hit?: boolean;
+    /**
+     * Enriched column metadata
+     */
+    column_map?: Array<CombinationPreviewResponse.ColumnMap>;
+    /**
+     * Resolved WidgetConfig (from config builder)
+     */
+    config?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Query result rows
+     */
+    data?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Compilation errors (if any)
+     */
+    errors?: Array<CompilerAPI.CompilerErrorItem>;
+    /**
+     * Total execution time in milliseconds
+     */
+    execution_time_ms?: number;
+    /**
+     * Resolved widget type (e.g. 'axis_metric_by_dimensiondate')
+     */
+    widget_type?: string | null;
+}
+export declare namespace CombinationPreviewResponse {
+    /**
+     * Maps a UUID column alias to its human-readable name and type.
+     */
+    interface ColumnMap {
+        /**
+         * Field type: dimension, measure, or calculation
+         */
+        field_type: string;
+        /**
+         * UUID string used as SQL column alias
+         */
+        kater_id: string;
+        /**
+         * Human-readable column name
+         */
+        name: string;
+        /**
+         * Aggregation type for measures: sum, count, min, max, avg, unknown. None for
+         * non-measures.
+         */
+        aggregation?: string | null;
+        /**
+         * Display label
+         */
+        label?: string | null;
+    }
+}
+export interface CombinationPreviewParams {
+    /**
+     * Body param: Comma-separated slot selections, same format as
+     * ResolveRequest.combination. Example:
+     * 'dimension=due_month,measure=compliance_rate'
+     */
+    combination: string;
+    /**
+     * Body param: Connection to preview against
+     */
+    connection_id: string;
+    /**
+     * Body param: Query template reference (e.g. 'q:compliance_trend.\_base')
+     */
+    query_ref: string;
+    /**
+     * Query param
+     */
+    source?: string | null;
+    /**
+     * Body param: Optional tenant key for multi-tenant execution
+     */
+    tenant_key?: string | null;
+    /**
+     * Header param
+     */
+    'X-Kater-CLI-ID'?: string;
+}
+export declare namespace Combination {
+    export { type CombinationPreviewResponse as CombinationPreviewResponse, type CombinationPreviewParams as CombinationPreviewParams, };
+}
+//# sourceMappingURL=combination.d.ts.map

package/resources/v1/compiler/combination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"combination.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/compiler/combination.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,OAAO,CACL,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAY1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,SAAS,CAAC,CAAC;IAEzD;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/v1/compiler/combination.js

@@ -0,0 +1,30 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Combination = void 0;
+const resource_1 = require("../../../core/resource.js");
+const headers_1 = require("../../../internal/headers.js");
+class Combination extends resource_1.APIResource {
+    /**
+     * Preview a single combination: resolve, compile, execute, and build config.
+     *
+     * Chains existing services to provide a single-call preview for the query gallery.
+     * Returns data + WidgetConfig for immediate rendering.
+     *
+     * RLS: Filtered to current client (ClientRLSDB).
+     */
+    preview(params, options) {
+        const { source, 'X-Kater-CLI-ID': xKaterCliID, ...body } = params;
+        return this._client.post('/api/v1/compiler/combination/preview', {
+            query: { source },
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xKaterCliID != null ? { 'X-Kater-CLI-ID': xKaterCliID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Combination = Combination;
+//# sourceMappingURL=combination.js.map

package/resources/v1/compiler/combination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"combination.js","sourceRoot":"","sources":["../../../src/resources/v1/compiler/combination.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAyD;AAGzD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;OAOG;IACH,OAAO,CACL,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC/D,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC5E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,kCAwBC"}

package/resources/v1/compiler/combination.mjs

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { buildHeaders } from "../../../internal/headers.mjs";
+export class Combination extends APIResource {
+    /**
+     * Preview a single combination: resolve, compile, execute, and build config.
+     *
+     * Chains existing services to provide a single-call preview for the query gallery.
+     * Returns data + WidgetConfig for immediate rendering.
+     *
+     * RLS: Filtered to current client (ClientRLSDB).
+     */
+    preview(params, options) {
+        const { source, 'X-Kater-CLI-ID': xKaterCliID, ...body } = params;
+        return this._client.post('/api/v1/compiler/combination/preview', {
+            query: { source },
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(xKaterCliID != null ? { 'X-Kater-CLI-ID': xKaterCliID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=combination.mjs.map

package/resources/v1/compiler/combination.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"combination.mjs","sourceRoot":"","sources":["../../../src/resources/v1/compiler/combination.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,OAAO,CACL,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC/D,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC5E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}