@bonnard/sdk 0.3.0 → 0.4.0

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 /**
  * Bonnard SDK — Client for querying semantic layer
  */
-import type { BonnardConfig, QueryOptions, QueryResult, SqlResult, CubeQuery, ExploreMeta, ExploreOptions, DashboardResult, DashboardListResult } from './types.js';
+import type { BonnardConfig, QueryOptions, QueryResult, SqlResult, CubeQuery, ExploreMeta, ExploreOptions, DashboardResult, DashboardListResult, DocsOptions, DocsTopicListResult, DocsTopicResult } from './types.js';
 export declare function createClient(config: BonnardConfig): {
     /**
      * Execute a JSON query against the semantic layer.
@@ -30,4 +30,11 @@ export declare function createClient(config: BonnardConfig): {
      * List all dashboards for the current organization.
      */
     listDashboards(): Promise<DashboardListResult>;
+    /**
+     * Access Bonnard documentation.
+     * - `docs()` — list all topics
+     * - `docs({ category: 'dashboards' })` — list topics in a category
+     * - `docs({ topic: 'dashboards.components' })` — get full markdown content
+     */
+    docs(options?: DocsOptions): Promise<DocsTopicListResult | DocsTopicResult>;
 };

package/dist/client.js

@@ -122,5 +122,20 @@ export function createClient(config) {
         async listDashboards() {
             return requestGet('/api/dashboards');
         },
+        /**
+         * Access Bonnard documentation.
+         * - `docs()` — list all topics
+         * - `docs({ category: 'dashboards' })` — list topics in a category
+         * - `docs({ topic: 'dashboards.components' })` — get full markdown content
+         */
+        async docs(options) {
+            const params = new URLSearchParams();
+            if (options?.topic)
+                params.set('topic', options.topic);
+            else if (options?.category)
+                params.set('category', options.category);
+            const qs = params.toString();
+            return requestGet(`/api/docs${qs ? `?${qs}` : ''}`);
+        },
     };
 }

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { createClient } from './client.js';
 export { toCubeQuery } from './query.js';
-export type { BonnardConfig, QueryOptions, QueryResult, SqlResult, Filter, TimeDimension, InferQueryResult, CubeQuery, ExploreMeta, CubeMetaItem, CubeFieldMeta, CubeSegmentMeta, ExploreOptions, DashboardResult, DashboardListResult, } from './types.js';
+export type { BonnardConfig, QueryOptions, QueryResult, SqlResult, Filter, TimeDimension, InferQueryResult, CubeQuery, ExploreMeta, CubeMetaItem, CubeFieldMeta, CubeSegmentMeta, ExploreOptions, DashboardResult, DashboardListResult, DocsOptions, DocsTopicSummary, DocsTopicListResult, DocsTopicResult, } from './types.js';

package/dist/types.d.ts

@@ -114,3 +114,23 @@ export interface DashboardListResult {
         updated_at: string;
     }>;
 }
+export interface DocsOptions {
+    topic?: string;
+    category?: string;
+}
+export interface DocsTopicSummary {
+    id: string;
+    title: string;
+    description: string | null;
+    category: string;
+}
+export interface DocsTopicListResult {
+    topics: DocsTopicSummary[];
+}
+export interface DocsTopicResult {
+    topic: {
+        id: string;
+        title: string;
+        content: string;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonnard/sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Bonnard SDK - query your semantic layer from any JavaScript or TypeScript app",
   "type": "module",
   "main": "dist/index.js",