@magemetrics/core 0.12.0-rc1 → 0.12.1

package/dist/index.js

@@ -58,7 +58,7 @@ var addApiKeyHeader = (apiKey) => {
 
 // package.json
 var package_default = {
-  version: "0.12.0-rc1"};
+  version: "0.12.1"};
 
 // src/core/MageMetricsEventEmitter.ts
 var MageMetricsEventEmitter = class {
@@ -482,7 +482,7 @@ function getOpenApiConfiguration(refOrOpenapi, metadataOrOptions, options) {
   };
 }
 
-// ../../node_modules/.pnpm/hono@4.12.8/node_modules/hono/dist/router/reg-exp-router/node.js
+// ../../node_modules/.pnpm/hono@4.12.14/node_modules/hono/dist/router/reg-exp-router/node.js
 new Set(".\\+*[^]$()");
 var createRoute = (routeConfig) => {
   const route = {
@@ -856,6 +856,7 @@ var FEEDBACK_OPTIONS = [
 ];
 var FeedbackSchema = z.object({
   created_at: z.string(),
+  report_id: z.uuid(),
   flow_data_id: z.number(),
   helpfulness: z.enum(FEEDBACK_OPTIONS.map((option) => option.value)),
   id: z.number()
@@ -968,7 +969,11 @@ var MaterializationFieldsSchema = z.object({
 var ReportSchema = z.object({
   created_at: z.string(),
   flow_id: z.string(),
-  id: z.number(),
+  id: z.number().openapi({
+    description: "Deprecated: use uuid.",
+    deprecated: true
+  }),
+  uuid: z.string(),
   is_sample: z.boolean(),
   schema: z.string(),
   sql: z.string(),
@@ -1029,7 +1034,11 @@ var ReportExplainabilitySchema = z.object({
   assumptions_score: z.number().nullish(),
   assumptions_score_reason: z.string().nullish(),
   id: z.number(),
-  flow_data_id: z.number(),
+  report_id: z.uuid(),
+  flow_data_id: z.number().openapi({
+    description: "Deprecated: use report_id.",
+    deprecated: true
+  }),
   created_at: z.string()
 });
 var FrontendReportExplainabilitySchema = ReportExplainabilitySchema.omit({
@@ -1048,6 +1057,11 @@ var FrontendReportExplainabilitySchema = ReportExplainabilitySchema.omit({
   output_dataset: z.string().optional(),
   sql: z.string().optional()
 });
+var ReportNarrationSchema = z.object({
+  step_name: z.string(),
+  step_order: z.number(),
+  narration: z.string()
+});
 var FilterOperatorSchema = z.enum([
   // Text operators
   "eq",
@@ -1216,7 +1230,18 @@ var DeleteUploadedFilePath = "/api/v1/uploaded-files/{uploadedFileId}";
 // ../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 parseReportId = (val, ctx) => {
+  const num = Number(val);
+  if (Number.isInteger(num) && num > 0)
+    return num;
+  const uuidResult = z.uuid().safeParse(val);
+  if (uuidResult.success)
+    return val;
+  ctx.addIssue("report_id must be a positive integer or a valid UUID");
+  return z.NEVER;
+};
+var ReportId = z.string().transform((val, ctx) => parseReportId(val, ctx)).openapi({ type: "string", description: "Numeric legacy ID or UUID" });
+var ReportIdFromBody = z.union([z.string(), z.number()]).transform((val, ctx) => parseReportId(String(val), ctx));
 var ReportIdParam = z.object({ report_id: ReportId }).openapi("ReportId", { type: "integer" });
 var CreateFlowFileSchema = z.object({
   type: z.literal("file"),
@@ -1267,7 +1292,7 @@ createRoute({
   hide: true,
   path: "/api/v1/flows/{flowId}/data-reports/last/status",
   operationId: "retrieveLatestDataReportStatus",
-  tags: ["public"],
+  tags: ["internal"],
   request: {
     headers: SupabaseHeaderSchema,
     params: FlowIdParam
@@ -1536,7 +1561,7 @@ createRoute({
   method: "get",
   path: "/api/v1/data-reports/{report_id}/feedback",
   operationId: "getDataReportFeedback",
-  tags: ["public"],
+  tags: ["private"],
   request: {
     headers: SupabaseHeaderSchema,
     params: ReportIdParam
@@ -1574,7 +1599,7 @@ createRoute({
   method: "post",
   path: "/api/v1/data-reports/{report_id}/feedback",
   operationId: "upsertReportFeedback",
-  tags: ["public"],
+  tags: ["private"],
   request: {
     headers: SupabaseHeaderSchema,
     params: ReportIdParam,
@@ -1610,7 +1635,7 @@ createRoute({
   method: "delete",
   path: "/api/v1/data-reports/{report_id}/feedback",
   operationId: "deleteReportFeedback",
-  tags: ["public"],
+  tags: ["private"],
   request: {
     headers: SupabaseHeaderSchema,
     params: ReportIdParam
@@ -1677,6 +1702,45 @@ createRoute({
     }
   }
 });
+var ReportUuidParam = z.object({ report_id: z.uuid() }).openapi("ReportUuid");
+createRoute({
+  method: "get",
+  path: "/api/v1/data-reports/{report_id}/narrations",
+  operationId: "getDataReportNarrations",
+  tags: ["public"],
+  request: {
+    headers: SupabaseHeaderSchema,
+    params: ReportUuidParam
+  },
+  responses: {
+    200: {
+      description: "The narration steps for the report",
+      content: {
+        "application/json": {
+          schema: z.array(ReportNarrationSchema)
+        }
+      }
+    },
+    404: {
+      content: {
+        "application/json": {
+          schema: z.object({ error: z.string() })
+        }
+      },
+      description: "Unable to retrieve report with this id"
+    },
+    500: {
+      description: "Something wrong happened",
+      content: {
+        "application/json": {
+          schema: z.object({
+            error: z.string()
+          })
+        }
+      }
+    }
+  }
+});
 var ColumnLineageNodeSchema = z.object({
   id: z.string(),
   type: z.enum([
@@ -1713,7 +1777,7 @@ createRoute({
       content: {
         "application/json": {
           schema: z.object({
-            report_id: z.number().int().describe("The report id"),
+            report_id: z.union([z.number().int(), z.uuid()]).describe("The report identifier (UUID or legacy numeric ID)"),
             column_name: z.string().describe("The column name to get lineage for")
           })
         }
@@ -1799,7 +1863,7 @@ createRoute({
   method: "post",
   path: "/api/v1/flow_data/v1/materialized_views/refresh",
   operationId: "refreshMaterializedViews",
-  tags: ["public"],
+  tags: ["private"],
   request: {
     headers: SupabaseHeaderSchema,
     body: {
@@ -1807,7 +1871,8 @@ createRoute({
       content: {
         "application/json": {
           schema: z.object({
-            flow_data_ids: z.array(z.number().int()).min(1).describe("List of flow_data IDs to refresh")
+            report_ids: z.array(ReportIdFromBody).min(1).describe("Preferred over flow_data_ids. List of report IDs to refresh.").optional(),
+            flow_data_ids: z.array(ReportIdFromBody).min(1).describe("Deprecated: use report_ids.").optional()
           })
         }
       }
@@ -1852,20 +1917,24 @@ createRoute({
   method: "get",
   path: "/api/v1/flow_data/materialization-status",
   operationId: "getMaterializationStatus",
-  tags: ["public"],
+  tags: ["private"],
   request: {
     headers: SupabaseHeaderSchema,
     query: z.object({
-      ids: z.string().transform((s) => s.split(",").map(Number)).describe("Comma-separated list of flow_data IDs")
+      ids: z.string().transform((s) => s.split(",")).pipe(z.array(ReportId)).describe("Comma-separated list of reports IDs")
     })
   },
   responses: {
     200: {
-      description: "Materialization status for the requested flow_data IDs",
+      description: "Materialization status for the requested report IDs",
       content: {
         "application/json": {
           schema: z.array(z.object({
-            id: z.number(),
+            uuid: z.string().describe("The report UUID"),
+            id: z.number().openapi({
+              description: "Deprecated: use uuid. Legacy numeric ID.",
+              deprecated: true
+            }),
             materialized_status: MaterializationStatusSchema.nullable(),
             last_materialized_at: z.string().nullable()
           }))
@@ -2596,6 +2665,20 @@ dayjs.extend(timezone);
 var daysjs_default = dayjs;
 
 // ../shared/dist/src/data/FormattedData.js
+var numberFormatCache = /* @__PURE__ */ new Map();
+var getNumberFormatter = (minimumFractionDigits, maximumFractionDigits, useGrouping) => {
+  const key = `${minimumFractionDigits}:${maximumFractionDigits}:${useGrouping}`;
+  let formatter = numberFormatCache.get(key);
+  if (!formatter) {
+    formatter = new Intl.NumberFormat(void 0, {
+      minimumFractionDigits,
+      maximumFractionDigits,
+      useGrouping
+    });
+    numberFormatCache.set(key, formatter);
+  }
+  return formatter;
+};
 var formatWithAutoPrecision = (value, options = {}) => {
   const { minPrecision = 0, maxPrecision = 6, trimZeros = true, useGrouping = true } = options;
   if (typeof value !== "number" || isNaN(value)) {
@@ -2628,11 +2711,7 @@ var formatWithAutoPrecision = (value, options = {}) => {
     }
   }
   maximumFractionDigits = Math.max(maximumFractionDigits, minPrecision);
-  const formatter = new Intl.NumberFormat(void 0, {
-    minimumFractionDigits: trimZeros ? 0 : maximumFractionDigits,
-    maximumFractionDigits,
-    useGrouping
-  });
+  const formatter = getNumberFormatter(trimZeros ? 0 : maximumFractionDigits, maximumFractionDigits, useGrouping);
   return formatter.format(value);
 };
 var MIN_VALID_YEAR = 1900;
@@ -2861,14 +2940,26 @@ var VisualizationConfigurationSchema = z.discriminatedUnion("type", [
   })
 ]);
 var BaseVisualizationSchema = z.object({
-  id: z.number(),
-  flow_data_id: z.number(),
+  id: z.number().openapi({
+    description: "Deprecated: use uuid.",
+    deprecated: true
+  }),
+  uuid: z.string(),
+  report_uuid: z.string(),
+  flow_data_id: z.number().openapi({
+    description: "Deprecated: use report_uuid.",
+    deprecated: true
+  }),
   created_at: z.string(),
   sql: z.string(),
   data_sample: z.array(z.record(z.string(), z.unknown())),
   is_sample: z.boolean(),
   data_summary: z.record(z.string(), z.unknown()),
-  flow_data: MaterializationFieldsSchema.optional()
+  flow_data: MaterializationFieldsSchema.optional().openapi({
+    description: "Deprecated: use materialization.",
+    deprecated: true
+  }),
+  materialization: MaterializationFieldsSchema.optional()
 });
 var V1VisualizationSchema = z.object({
   ...BaseVisualizationSchema.shape,
@@ -3633,5 +3724,3 @@ var MageMetricsClient = class {
 };
 
 export { BrowserStorageAdapter, CHECK_KEY, DirectAuthProvider, ExternalAuthProvider, MageMetricsClient, MageMetricsEventEmitter, MemoryStorageAdapter, TOKEN_STORAGE_KEY, getPublicApiClient };
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magemetrics/core",
   "type": "module",
-  "version": "0.12.0-rc1",
+  "version": "0.12.1",
   "description": "MageMetrics client library",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -33,10 +33,10 @@
     "dist/"
   ],
   "dependencies": {
-    "@noble/hashes": "^2.0.1",
-    "@supabase/auth-js": "^2.97.0",
-    "@xyflow/system": "^0.0.75",
-    "ai": "6.0.137",
+    "@noble/hashes": "^2.2.0",
+    "@supabase/auth-js": "^2.103.0",
+    "@xyflow/system": "^0.0.76",
+    "ai": "6.0.159",
     "dayjs": "^1.11.20",
     "openapi-fetch": "^0.17.0",
     "type-fest": "^5.5.0",