@superatomai/sdk-web 0.0.29 → 0.0.30

package/dist/index.js

@@ -998,6 +998,69 @@ var MenusResponseMessageSchema = z.object({
   to: MessageParticipantSchema.optional(),
   payload: MenusResponsePayloadSchema
 });
+var SchemaColumnStatisticsSchema = z.object({
+  distinct: z.number().optional(),
+  min: z.number().optional(),
+  max: z.number().optional()
+});
+var SchemaColumnSchema = z.object({
+  name: z.string(),
+  type: z.string(),
+  nativeType: z.string(),
+  nullable: z.boolean(),
+  description: z.string(),
+  statistics: SchemaColumnStatisticsSchema.optional(),
+  cardinality: z.enum(["unique", "high", "medium", "low"]).optional(),
+  sampleValues: z.array(z.string()).optional()
+});
+var SchemaTableSchema = z.object({
+  name: z.string(),
+  fullName: z.string(),
+  rowCount: z.number(),
+  description: z.string(),
+  columns: z.array(SchemaColumnSchema)
+});
+var SchemaRelationshipSchema = z.object({
+  from: z.string(),
+  to: z.string(),
+  type: z.string(),
+  keys: z.array(z.string())
+});
+var DatabaseSchemaSchema = z.object({
+  database: z.string(),
+  databaseType: z.string().optional(),
+  schema: z.string(),
+  description: z.string(),
+  tables: z.array(SchemaTableSchema),
+  relationships: z.array(SchemaRelationshipSchema).optional()
+});
+var SchemaRequestPayloadSchema = z.object({
+  /** If true, returns the formatted documentation string in addition to raw JSON */
+  formatted: z.boolean().optional()
+});
+var SchemaRequestMessageSchema = z.object({
+  id: z.string(),
+  type: z.literal("SCHEMA_REQ"),
+  from: MessageParticipantSchema,
+  to: MessageParticipantSchema.optional(),
+  payload: SchemaRequestPayloadSchema
+});
+var SchemaResponsePayloadSchema = z.object({
+  success: z.boolean(),
+  error: z.string().optional(),
+  data: z.object({
+    schema: DatabaseSchemaSchema,
+    /** Formatted schema documentation (only if formatted: true was requested) */
+    formatted: z.string().optional()
+  }).optional()
+});
+z.object({
+  id: z.string(),
+  type: z.literal("SCHEMA_RES"),
+  from: MessageParticipantSchema,
+  to: MessageParticipantSchema.optional(),
+  payload: SchemaResponsePayloadSchema
+});
 var ClientConfigSchema = z.object({
   userId: z.string(),
   projectId: z.string(),
@@ -1060,6 +1123,7 @@ __export(services_exports, {
   getMenusHierarchy: () => getMenusHierarchy,
   getReport: () => getReport,
   getRootMenus: () => getRootMenus,
+  getSchema: () => getSchema,
   getUI: () => getUI,
   getUser: () => getUser,
   queryArtifacts: () => queryArtifacts,
@@ -2872,6 +2936,27 @@ async function reorderMenus(client, items, timeout) {
   };
 }
 
+// src/services/schema.ts
+async function getSchema(client, options = {}) {
+  const messageId = `msg_${Date.now()}_${Math.random().toString(36).substring(7)}`;
+  const message = SchemaRequestMessageSchema.parse({
+    id: messageId,
+    type: "SCHEMA_REQ",
+    from: { type: client.type },
+    to: { type: "data-agent" },
+    payload: {
+      formatted: options.formatted ?? false
+    }
+  });
+  const response = await client.sendWithResponse(message, options.timeout);
+  const payload = response.payload;
+  return {
+    success: payload.success,
+    error: payload.error,
+    data: payload.data
+  };
+}
+
 // src/client.ts
 var SuperatomClient = class {
   constructor(config) {
@@ -3700,6 +3785,15 @@ var SuperatomClient = class {
     this.log("info", "Reordering", items.length, "menus");
     return reorderMenus(this, items, timeout);
   }
+  // ==================== Schema Methods ====================
+  /**
+   * Get the database schema
+   * Retrieves the schema.json containing table definitions, columns, and relationships
+   */
+  async getSchema(options) {
+    this.log("info", "Fetching database schema");
+    return getSchema(this, options);
+  }
   /**
    * Internal logging
    */