@magemetrics/core 0.11.5 → 0.11.6

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Client } from 'openapi-fetch';
+import { default as default_2 } from 'zod';
 import { DefaultChatTransport } from 'ai';
 import { GoTrueClient } from '@supabase/auth-js';
 import { GoTrueClientOptions } from '@supabase/auth-js';
@@ -483,11 +484,27 @@ declare const CreateCanvasSchema: z.ZodObject<{
     flow_id: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 
+/**
+ * A file attachment to include in the first message of a flow.
+ *
+ * Structurally compatible with the AI SDK's `FileUIPart`, so the output of
+ * `useFileUpload().getFileParts()` can be passed directly — no mapping needed.
+ */
+declare type CreateFlowFile = default_2.infer<typeof CreateFlowFileSchema>;
+
+declare const CreateFlowFileSchema: z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    mediaType: z.ZodString;
+    filename: z.ZodOptional<z.ZodString>;
+    url: z.ZodString;
+}, z.core.$strip>;
+
 /**
  * Parameters for starting a flow
  */
 export declare type CreateFlowParam = {
     query: string;
+    files?: CreateFlowFile[];
 } | {
     triggerId: string;
     variables: Record<string, string>;
@@ -667,7 +684,7 @@ declare const inputSchema_8: z.ZodObject<{
 declare const inputSchema_9: z.ZodObject<{
     questions: z.ZodArray<z.ZodObject<{
         question: z.ZodString;
-        header: z.ZodString;
+        header: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
         multiSelect: z.ZodBoolean;
         options: z.ZodArray<z.ZodObject<{
             label: z.ZodString;
@@ -899,6 +916,11 @@ export declare class MageMetricsClient {
                 [x: string]: unknown;
             }[]>;
         }>;
+        getRecommendations: (count: number) => Promise<{
+            starter: string;
+            explanation: string;
+            type: string;
+        }[]>;
     };
     client(): PublicApiClient;
     private createSupabaseHeaderMiddleware;
@@ -1689,13 +1711,13 @@ declare interface operations {
                                 }[];
                             };
                         } | null;
-                        confidence_score: number;
-                        confidence_score_reason: string;
+                        confidence_score?: number;
+                        confidence_score_reason?: string;
                         assumptions_score?: number;
                         assumptions_score_reason?: string;
+                        flow_data_id: number;
                         friendliness_score?: number;
                         friendliness_score_reason?: string;
-                        flow_data_id: number;
                         output_dataset?: string;
                         sql?: string;
                     };
@@ -2144,6 +2166,13 @@ declare interface operations {
                 "application/json": {
                     userQuery: string;
                     applicationName?: string;
+                    files?: {
+                        /** @enum {string} */
+                        type: "file";
+                        mediaType: string;
+                        filename?: string;
+                        url: string;
+                    }[];
                 };
             };
         };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { sha256 } from '@noble/hashes/sha2.js';
-import z6, { z } from 'zod';
+import z7, { z } from 'zod';
 import { GoTrueClient } from '@supabase/auth-js';
 import createApiClient2 from 'openapi-fetch';
 import dayjs from 'dayjs';
@@ -58,7 +58,7 @@ var addApiKeyHeader = (apiKey) => {
 
 // package.json
 var package_default = {
-  version: "0.11.5"};
+  version: "0.11.6"};
 
 // src/core/MageMetricsEventEmitter.ts
 var MageMetricsEventEmitter = class {
@@ -482,7 +482,7 @@ function getOpenApiConfiguration(refOrOpenapi, metadataOrOptions, options) {
   };
 }
 
-// ../../node_modules/.pnpm/hono@4.12.7/node_modules/hono/dist/router/reg-exp-router/node.js
+// ../../node_modules/.pnpm/hono@4.12.8/node_modules/hono/dist/router/reg-exp-router/node.js
 new Set(".\\+*[^]$()");
 var createRoute = (routeConfig) => {
   const route = {
@@ -1022,10 +1022,8 @@ var ReportExplainabilitySchema = z.object({
   columns_lineage: LLMColumnsLineageResponse.nullish(),
   confidence_score: z.number(),
   confidence_score_reason: z.string(),
-  assumptions_score: z.number().optional(),
-  assumptions_score_reason: z.string().optional(),
-  friendliness_score: z.number().optional(),
-  friendliness_score_reason: z.string().optional(),
+  assumptions_score: z.number().nullish(),
+  assumptions_score_reason: z.string().nullish(),
   id: z.number(),
   flow_data_id: z.number(),
   created_at: z.string()
@@ -1034,6 +1032,15 @@ var FrontendReportExplainabilitySchema = ReportExplainabilitySchema.omit({
   id: true,
   created_at: true
 }).extend({
+  // All scores are optional in the frontend schema so that clients
+  // are forward-compatible when the DB columns become nullable.
+  // The API endpoint coerces null → undefined before parsing.
+  confidence_score: z.number().optional(),
+  confidence_score_reason: z.string().optional(),
+  assumptions_score: z.number().optional(),
+  assumptions_score_reason: z.string().optional(),
+  friendliness_score: z.number().optional(),
+  friendliness_score_reason: z.string().optional(),
   output_dataset: z.string().optional(),
   sql: z.string().optional()
 });
@@ -1186,12 +1193,21 @@ var columnsQueryParams = z.string().transform((str) => {
   },
   type: "string"
 });
+var CHAT_MAX_FILE_COUNT = 10;
+var CHAT_ALLOWED_FILE_MEDIA_TYPES = /* @__PURE__ */ new Set(["application/pdf"]);
+[...CHAT_ALLOWED_FILE_MEDIA_TYPES].join(",");
 
 // ../shared/dist/src/endpoints/companion/flows.routes.js
 var FlowIdParam = z.object({ flowId: z.uuid() }).openapi("FlowId", { type: "string" });
 var FlowDataIdParam = z.object({ flowDataId: z.string().pipe(z.coerce.number()) }).openapi("FlowDataId", { type: "integer" });
 var ReportId = z.string().pipe(z.coerce.number());
 var ReportIdParam = z.object({ report_id: ReportId }).openapi("ReportId", { type: "integer" });
+var CreateFlowFileSchema = z.object({
+  type: z.literal("file"),
+  mediaType: z.string(),
+  filename: z.string().optional(),
+  url: z.string()
+});
 var RetrieveFlowDataReports = createRoute({
   method: "get",
   path: "/api/v1/flows/{flowId}/data-reports",
@@ -1865,7 +1881,8 @@ var CreateFlow = createRoute({
         "application/json": {
           schema: z.object({
             userQuery: z.string(),
-            applicationName: z.string().optional()
+            applicationName: z.string().optional(),
+            files: z.array(CreateFlowFileSchema).max(CHAT_MAX_FILE_COUNT).optional()
           })
         }
       }
@@ -1905,6 +1922,47 @@ var CreateFlow = createRoute({
     }
   }
 });
+var FrontendRecommendationsSchema = z.object({
+  starter: z.string(),
+  explanation: z.string(),
+  type: z.string()
+}).describe("Starter recommendations").openapi("StarterRecommendation");
+
+// ../shared/dist/src/endpoints/companion/recommendations.routes.js
+var GetStarterRecommendations = createRoute({
+  method: "get",
+  path: "/api/v1/recommendations",
+  operationId: "getStarterRecommendations",
+  tags: ["public"],
+  request: {
+    headers: SupabaseHeaderSchema,
+    query: z.object({
+      count: z.string().pipe(z.coerce.number()).optional().openapi({ type: "number" })
+    })
+  },
+  responses: {
+    200: {
+      content: {
+        "application/json": {
+          schema: z.object({
+            recommendations: FrontendRecommendationsSchema.array()
+          })
+        }
+      },
+      description: "Get starter recommendations"
+    },
+    500: {
+      description: "Something wrong happened",
+      content: {
+        "application/json": {
+          schema: z.object({
+            error: z.string()
+          })
+        }
+      }
+    }
+  }
+});
 
 // ../shared/dist/src/endpoints/companion/speech.routes.js
 var SpeechTokenResponseSchema = z.object({
@@ -1940,20 +1998,20 @@ var CreateSpeechToken = createRoute({
     }
   }
 });
-z6.discriminatedUnion("status", [
-  z6.object({
-    status: z6.literal("error"),
-    error: z6.string()
+z7.discriminatedUnion("status", [
+  z7.object({
+    status: z7.literal("error"),
+    error: z7.string()
   }),
-  z6.object({
-    status: z6.literal("success"),
-    flowId: z6.string()
+  z7.object({
+    status: z7.literal("success"),
+    flowId: z7.string()
   })
 ]);
-var TriggerFlowBody = z6.object({
-  triggerId: z6.string(),
-  variables: z6.record(z6.string(), z6.string()),
-  applicationName: z6.string().optional()
+var TriggerFlowBody = z7.object({
+  triggerId: z7.string(),
+  variables: z7.record(z7.string(), z7.string()),
+  applicationName: z7.string().optional()
 });
 var TriggerFlow = createRoute({
   method: "post",
@@ -1977,9 +2035,9 @@ var TriggerFlow = createRoute({
       description: "Flow id",
       content: {
         "application/json": {
-          schema: z6.object({
-            status: z6.literal("success"),
-            flowId: z6.string()
+          schema: z7.object({
+            status: z7.literal("success"),
+            flowId: z7.string()
           })
         }
       }
@@ -1987,8 +2045,8 @@ var TriggerFlow = createRoute({
     400: {
       content: {
         "application/json": {
-          schema: z6.object({
-            error: z6.string()
+          schema: z7.object({
+            error: z7.string()
           })
         }
       },
@@ -1997,7 +2055,7 @@ var TriggerFlow = createRoute({
     404: {
       content: {
         "application/json": {
-          schema: z6.object({ error: z6.string() })
+          schema: z7.object({ error: z7.string() })
         }
       },
       description: "Unable to retrieve trigger with this id"
@@ -2006,8 +2064,8 @@ var TriggerFlow = createRoute({
       description: "Something wrong happened",
       content: {
         "application/json": {
-          schema: z6.object({
-            error: z6.string()
+          schema: z7.object({
+            error: z7.string()
           })
         }
       }
@@ -2037,9 +2095,9 @@ createRoute({
       description: "Flow id",
       content: {
         "application/json": {
-          schema: z6.object({
-            status: z6.literal("success"),
-            flowId: z6.string()
+          schema: z7.object({
+            status: z7.literal("success"),
+            flowId: z7.string()
           })
         }
       }
@@ -2047,8 +2105,8 @@ createRoute({
     400: {
       content: {
         "application/json": {
-          schema: z6.object({
-            error: z6.string()
+          schema: z7.object({
+            error: z7.string()
           })
         }
       },
@@ -2057,7 +2115,7 @@ createRoute({
     404: {
       content: {
         "application/json": {
-          schema: z6.object({ error: z6.string() })
+          schema: z7.object({ error: z7.string() })
         }
       },
       description: "Unable to retrieve trigger with this id"
@@ -2066,8 +2124,8 @@ createRoute({
       description: "Something wrong happened",
       content: {
         "application/json": {
-          schema: z6.object({
-            error: z6.string()
+          schema: z7.object({
+            error: z7.string()
           })
         }
       }
@@ -3175,7 +3233,8 @@ var MageMetricsClient = class {
           {
             body: {
               userQuery: request.query,
-              applicationName: this.config.applicationName
+              applicationName: this.config.applicationName,
+              files: request.files
             }
           }
         );
@@ -3475,6 +3534,22 @@ var MageMetricsClient = class {
         rowCount,
         data: this.api.fetchReportData
       };
+    },
+    getRecommendations: async (count) => {
+      await this.waitForAuth();
+      const { data, error, response } = await this.internalApiClient.GET(
+        GetStarterRecommendations.path,
+        { params: { query: { count } } }
+      );
+      if (error) {
+        throw new ApiError(error.error, response, {
+          status: response.status,
+          statusText: response.statusText,
+          url: response.url,
+          method: "GET"
+        });
+      }
+      return data.recommendations;
     }
   };
   client() {