@stina/extension-api 0.52.0 → 0.53.1

package/dist/schemas/index.js

@@ -393,6 +393,146 @@ var ListPropsSchema = z2.object({
   children: ExtensionComponentChildrenSchema.describe("Child components rendered as list items"),
   style: ExtensionComponentStyleSchema.optional()
 }).passthrough().describe("List component");
+var WeatherConditionSchema = z2.enum([
+  "clear",
+  "partly-cloudy",
+  "cloudy",
+  "overcast",
+  "fog",
+  "light-rain",
+  "rain",
+  "heavy-rain",
+  "sleet",
+  "light-snow",
+  "snow",
+  "heavy-snow",
+  "thunderstorm",
+  "hail",
+  "windy"
+]).describe("Weather condition");
+var WeatherWindSchema = z2.object({
+  speed: z2.number().describe("Sustained wind speed"),
+  unit: z2.string().optional().describe("Unit written after the speed. Defaults to m/s"),
+  direction: z2.string().optional().describe("Compass direction, in the caller's own words"),
+  gust: z2.number().optional().describe("Gust speed, in the same unit")
+}).passthrough().describe("Wind reading");
+var WeatherNowPropsSchema = z2.object({
+  component: z2.literal("WeatherNow"),
+  place: z2.string().describe("Where the reading is from"),
+  condition: WeatherConditionSchema,
+  conditionLabel: z2.string().optional().describe("The condition in the user's own language"),
+  temperature: z2.number().describe("Current temperature"),
+  feelsLike: z2.number().optional().describe("Apparent temperature"),
+  unit: z2.string().optional().describe("Written after every temperature. Defaults to \xB0"),
+  wind: WeatherWindSchema.optional(),
+  night: z2.boolean().optional().describe("Draw the night variant of the icon"),
+  summary: z2.string().optional().describe("One line of context under the numbers"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Current weather component");
+var WeatherForecastStepSchema = z2.object({
+  label: z2.string().describe("Short step label, e.g. 14 or Tors"),
+  condition: WeatherConditionSchema,
+  conditionLabel: z2.string().optional(),
+  high: z2.number().describe("The warmer temperature, or the only one"),
+  low: z2.number().optional().describe("The colder temperature"),
+  night: z2.boolean().optional(),
+  precipitation: z2.number().min(0).max(100).optional().describe("Chance of precipitation, 0-100"),
+  current: z2.boolean().optional().describe("The step the reader is at; drawn larger")
+}).passthrough().describe("One forecast step");
+var WeatherForecastPropsSchema = z2.object({
+  component: z2.literal("WeatherForecast"),
+  title: z2.string().optional().describe("Heading above the row"),
+  icon: z2.string().optional().describe("Icon shown to the left of the title"),
+  unit: z2.string().optional().describe("Written after every temperature. Defaults to \xB0"),
+  steps: z2.array(WeatherForecastStepSchema).min(1).describe("Steps, hourly or daily"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Weather forecast component");
+var ChartKindSchema = z2.enum(["line", "bar", "area"]).describe("How the chart draws");
+var ChartSeriesSchema = z2.object({
+  name: z2.string().optional().describe("Named in the legend"),
+  points: z2.array(z2.number().nullable()).describe("One value per label. null is a gap, drawn as one")
+}).passthrough().describe("One chart series");
+var ChartPropsSchema = z2.object({
+  component: z2.literal("Chart"),
+  chart: ChartKindSchema.optional().describe("Defaults to line"),
+  series: z2.array(ChartSeriesSchema).min(1).max(8).describe("At most eight series"),
+  labels: z2.array(z2.string()).optional().describe("One per point, along the horizontal axis"),
+  title: z2.string().optional().describe("Heading above the plot"),
+  icon: z2.string().optional().describe("Icon shown to the left of the title"),
+  unit: z2.string().optional().describe("Written after every value"),
+  zeroBaseline: z2.boolean().optional().describe("Force the value axis to include zero"),
+  height: z2.number().min(4).max(24).optional().describe("Plot height in rem. Defaults to 9"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Chart component");
+var StatTrendSchema = z2.enum(["up", "down", "flat"]).describe("Direction of change");
+var StatTilePropsSchema = z2.object({
+  component: z2.literal("StatTile"),
+  label: z2.string().describe("What the number is"),
+  value: z2.union([z2.string(), z2.number()]).describe("The number itself"),
+  unit: z2.string().optional().describe("Written after the value in smaller type"),
+  caption: z2.string().optional().describe("One quiet line under the number"),
+  icon: z2.string().optional().describe("Icon name"),
+  trend: StatTrendSchema.optional(),
+  trendLabel: z2.string().optional().describe("The change in words"),
+  trendIsGood: z2.boolean().optional().describe("Whether up is the good direction. Defaults to true"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Single-number stat tile component");
+var KeyValueRowSchema = z2.object({
+  label: z2.string(),
+  value: z2.string(),
+  icon: z2.string().optional().describe("Icon name")
+}).passthrough().describe("One key/value row");
+var KeyValueListPropsSchema = z2.object({
+  component: z2.literal("KeyValueList"),
+  rows: z2.array(KeyValueRowSchema).min(1).describe("Facts in two aligned columns"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Key/value list component");
+var TimelineVariantSchema = z2.enum(["default", "accent", "success", "warning", "danger"]).describe("How much a timeline entry stands out");
+var TimelineEntrySchema = z2.object({
+  time: z2.string().describe("When it happens, worded as it should be read"),
+  title: z2.string(),
+  description: z2.string().optional().describe("A line under the title"),
+  icon: z2.string().optional().describe("Icon name"),
+  duration: z2.string().optional().describe("How long it lasts, in words"),
+  badge: z2.string().optional().describe("Trailing badge"),
+  current: z2.boolean().optional().describe("The entry the reader is at"),
+  past: z2.boolean().optional().describe("Already behind us; drawn recessive"),
+  variant: TimelineVariantSchema.optional()
+}).passthrough().describe("One timeline entry");
+var TimelinePropsSchema = z2.object({
+  component: z2.literal("Timeline"),
+  title: z2.string().optional().describe("Heading above the rail"),
+  icon: z2.string().optional().describe("Icon shown to the left of the title"),
+  entries: z2.array(TimelineEntrySchema).min(1).describe("Entries, in the order they happen"),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Vertical timeline component");
+var NoteVariantSchema = z2.enum(["default", "accent", "success", "warning", "danger"]).describe("How much a note stands out");
+var NotePropsSchema = z2.object({
+  component: z2.literal("Note"),
+  title: z2.string().optional(),
+  icon: z2.string().optional().describe("Icon shown to the left of the title"),
+  badge: z2.string().optional().describe("Trailing badge next to the title"),
+  content: z2.string().describe("The body, as markdown"),
+  footer: z2.string().optional().describe("One quiet line at the bottom"),
+  variant: NoteVariantSchema.optional(),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Titled block of prose component");
+var CalendarEventStatusSchema = z2.enum(["confirmed", "tentative", "cancelled"]).describe("Whether an event is going ahead");
+var CalendarEventPropsSchema = z2.object({
+  component: z2.literal("CalendarEvent"),
+  title: z2.string(),
+  start: z2.string().describe("ISO 8601 with an offset"),
+  end: z2.string().optional().describe("ISO 8601 with an offset"),
+  allDay: z2.boolean().optional(),
+  location: z2.string().optional(),
+  organizer: z2.string().optional(),
+  attendees: z2.array(z2.string()).optional(),
+  calendar: z2.string().optional().describe("Which calendar it sits in; shown as a badge"),
+  status: CalendarEventStatusSchema.optional(),
+  recurrence: z2.string().optional().describe("How it repeats, in words"),
+  notes: z2.string().optional(),
+  style: ExtensionComponentStyleSchema.optional()
+}).passthrough().describe("Single calendar event component");
 
 // src/schemas/contributions.schema.ts
 var LocalizedStringSchema = z3.union([z3.string(), z3.record(z3.string())]).describe("String or localized string map");
@@ -540,11 +680,374 @@ var ExtensionManifestSchema = z4.object({
   permissions: z4.array(PermissionSchema).describe("Required permissions"),
   contributes: ExtensionContributionsSchema.optional().describe("What the extension contributes")
 }).describe("Extension manifest format");
+
+// src/schemas/card.schema.ts
+import { z as z5 } from "zod";
+var style = ExtensionComponentStyleSchema.optional();
+var children = z5.lazy(
+  () => z5.array(ChatCardComponentSchema).max(40)
+);
+var VerticalStackCardSchema = z5.object({
+  component: z5.literal("VerticalStack"),
+  gap: z5.number().min(0).max(8).optional(),
+  children,
+  style
+}).strict();
+var HorizontalStackCardSchema = z5.object({
+  component: z5.literal("HorizontalStack"),
+  gap: z5.number().min(0).max(8).optional(),
+  children,
+  style
+}).strict();
+var GridCardSchema = z5.object({
+  component: z5.literal("Grid"),
+  columns: z5.number().min(1).max(6),
+  gap: z5.number().min(0).max(8).optional(),
+  children,
+  style
+}).strict();
+var FrameCardSchema = z5.object({
+  component: z5.literal("Frame"),
+  // Only the string form: the components form of a title is for panels that
+  // put controls in their header, which a card has no business doing.
+  title: z5.string().optional(),
+  collapsible: z5.boolean().optional(),
+  defaultExpanded: z5.boolean().optional(),
+  variant: FrameVariantSchema.optional(),
+  children,
+  style
+}).strict();
+var ListCardSchema = z5.object({ component: z5.literal("List"), children, style }).strict();
+var DividerCardSchema = z5.object({ component: z5.literal("Divider"), style }).strict();
+var HeaderCardSchema = z5.object({
+  component: z5.literal("Header"),
+  level: z5.number().min(1).max(6),
+  title: z5.string(),
+  description: z5.union([z5.string(), z5.array(z5.string())]).optional(),
+  icon: z5.string().optional(),
+  style
+}).strict();
+var LabelCardSchema = z5.object({ component: z5.literal("Label"), text: z5.string(), style }).strict();
+var ParagraphCardSchema = z5.object({ component: z5.literal("Paragraph"), text: z5.string(), style }).strict();
+var MarkdownCardSchema = z5.object({ component: z5.literal("Markdown"), content: z5.string(), style }).strict();
+var IconCardSchema = z5.object({
+  component: z5.literal("Icon"),
+  name: z5.string(),
+  title: z5.string().optional(),
+  style
+}).strict();
+var PillCardSchema = z5.object({
+  component: z5.literal("Pill"),
+  text: z5.string(),
+  icon: z5.string().optional(),
+  variant: PillVariantSchema.optional(),
+  style
+}).strict();
+var WeatherNowCardSchema = z5.object({
+  component: z5.literal("WeatherNow"),
+  place: z5.string(),
+  condition: WeatherConditionSchema,
+  conditionLabel: z5.string().optional(),
+  temperature: z5.number(),
+  feelsLike: z5.number().optional(),
+  unit: z5.string().optional(),
+  wind: WeatherWindSchema.optional(),
+  night: z5.boolean().optional(),
+  summary: z5.string().optional(),
+  style
+}).strict();
+var WeatherForecastCardSchema = z5.object({
+  component: z5.literal("WeatherForecast"),
+  title: z5.string().optional(),
+  icon: z5.string().optional(),
+  unit: z5.string().optional(),
+  steps: z5.array(
+    z5.object({
+      label: z5.string(),
+      condition: WeatherConditionSchema,
+      conditionLabel: z5.string().optional(),
+      high: z5.number(),
+      low: z5.number().optional(),
+      night: z5.boolean().optional(),
+      precipitation: z5.number().min(0).max(100).optional(),
+      current: z5.boolean().optional()
+    }).strict()
+  ).min(1).max(24),
+  style
+}).strict();
+var ChartCardSchema = z5.object({
+  component: z5.literal("Chart"),
+  chart: ChartKindSchema.optional(),
+  series: z5.array(
+    z5.object({
+      name: z5.string().optional(),
+      points: z5.array(z5.number().nullable()).min(1).max(200)
+    }).strict()
+  ).min(1).max(8),
+  labels: z5.array(z5.string()).max(200).optional(),
+  title: z5.string().optional(),
+  icon: z5.string().optional(),
+  unit: z5.string().optional(),
+  zeroBaseline: z5.boolean().optional(),
+  height: z5.number().min(4).max(24).optional(),
+  style
+}).strict();
+var StatTileCardSchema = z5.object({
+  component: z5.literal("StatTile"),
+  label: z5.string(),
+  value: z5.union([z5.string(), z5.number()]),
+  unit: z5.string().optional(),
+  caption: z5.string().optional(),
+  icon: z5.string().optional(),
+  trend: StatTrendSchema.optional(),
+  trendLabel: z5.string().optional(),
+  trendIsGood: z5.boolean().optional(),
+  style
+}).strict();
+var KeyValueListCardSchema = z5.object({
+  component: z5.literal("KeyValueList"),
+  rows: z5.array(
+    z5.object({ label: z5.string(), value: z5.string(), icon: z5.string().optional() }).strict()
+  ).min(1).max(40),
+  style
+}).strict();
+var TimelineCardSchema = z5.object({
+  component: z5.literal("Timeline"),
+  title: z5.string().optional(),
+  icon: z5.string().optional(),
+  entries: z5.array(
+    z5.object({
+      time: z5.string(),
+      title: z5.string(),
+      description: z5.string().optional(),
+      icon: z5.string().optional(),
+      duration: z5.string().optional(),
+      badge: z5.string().optional(),
+      current: z5.boolean().optional(),
+      past: z5.boolean().optional(),
+      variant: TimelineVariantSchema.optional()
+    }).strict()
+  ).min(1).max(40),
+  style
+}).strict();
+var NoteCardSchema = z5.object({
+  component: z5.literal("Note"),
+  title: z5.string().optional(),
+  icon: z5.string().optional(),
+  badge: z5.string().optional(),
+  content: z5.string(),
+  footer: z5.string().optional(),
+  variant: NoteVariantSchema.optional(),
+  style
+}).strict();
+var CalendarEventCardSchema = z5.object({
+  component: z5.literal("CalendarEvent"),
+  title: z5.string(),
+  start: z5.string(),
+  end: z5.string().optional(),
+  allDay: z5.boolean().optional(),
+  location: z5.string().optional(),
+  organizer: z5.string().optional(),
+  attendees: z5.array(z5.string()).max(40).optional(),
+  calendar: z5.string().optional(),
+  status: CalendarEventStatusSchema.optional(),
+  recurrence: z5.string().optional(),
+  notes: z5.string().optional(),
+  style
+}).strict();
+var CHAT_CARD_COMPONENTS = [
+  "VerticalStack",
+  "HorizontalStack",
+  "Grid",
+  "Frame",
+  "List",
+  "Divider",
+  "Header",
+  "Label",
+  "Paragraph",
+  "Markdown",
+  "Icon",
+  "Pill",
+  "WeatherNow",
+  "WeatherForecast",
+  "Chart",
+  "StatTile",
+  "KeyValueList",
+  "Timeline",
+  "Note",
+  "CalendarEvent"
+];
+var CARD_MEMBERS = [
+  VerticalStackCardSchema,
+  HorizontalStackCardSchema,
+  GridCardSchema,
+  FrameCardSchema,
+  ListCardSchema,
+  DividerCardSchema,
+  HeaderCardSchema,
+  LabelCardSchema,
+  ParagraphCardSchema,
+  MarkdownCardSchema,
+  IconCardSchema,
+  PillCardSchema,
+  WeatherNowCardSchema,
+  WeatherForecastCardSchema,
+  ChartCardSchema,
+  StatTileCardSchema,
+  KeyValueListCardSchema,
+  TimelineCardSchema,
+  NoteCardSchema,
+  CalendarEventCardSchema
+];
+var ChatCardComponentSchema = z5.lazy(
+  () => z5.discriminatedUnion(
+    "component",
+    CARD_MEMBERS
+  )
+);
+var ChatCardSchema = ChatCardComponentSchema;
+var MAX_CARD_DEPTH = 8;
+function findScopeReference(value, path) {
+  if (typeof value === "string") {
+    return value.startsWith("$") ? path : null;
+  }
+  if (Array.isArray(value)) {
+    for (let i = 0; i < value.length; i++) {
+      const found = findScopeReference(value[i], `${path}[${i}]`);
+      if (found) return found;
+    }
+    return null;
+  }
+  if (value && typeof value === "object") {
+    for (const [key, child] of Object.entries(value)) {
+      const found = findScopeReference(child, path ? `${path}.${key}` : key);
+      if (found) return found;
+    }
+  }
+  return null;
+}
+function cardDepth(value) {
+  if (!value || typeof value !== "object") return 0;
+  const kids = value.children;
+  if (!Array.isArray(kids) || kids.length === 0) return 1;
+  let deepest = 0;
+  for (const child of kids) {
+    const depth = cardDepth(child);
+    if (depth > deepest) deepest = depth;
+  }
+  return deepest + 1;
+}
+function findMisalignedChart(value) {
+  if (!value || typeof value !== "object") return null;
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      const found = findMisalignedChart(item);
+      if (found) return found;
+    }
+    return null;
+  }
+  const node = value;
+  if (node.component === "Chart" && Array.isArray(node.labels) && Array.isArray(node.series)) {
+    const expected = node.labels.length;
+    for (let i = 0; i < node.series.length; i++) {
+      const points = node.series[i]?.points;
+      if (Array.isArray(points) && points.length !== expected) {
+        return `Chart series ${i} has ${points.length} points but there are ${expected} labels. Points line up with labels by position \u2014 use null for a reading you do not have.`;
+      }
+    }
+  }
+  for (const child of Object.values(node)) {
+    const found = findMisalignedChart(child);
+    if (found) return found;
+  }
+  return null;
+}
+function validateChatCard(card) {
+  const parsed = ChatCardSchema.safeParse(card);
+  if (!parsed.success) {
+    const issue = parsed.error.issues[0];
+    const where = issue?.path.length ? ` at ${issue.path.join(".")}` : "";
+    return { ok: false, error: `${issue?.message ?? "Invalid card"}${where}` };
+  }
+  const depth = cardDepth(parsed.data);
+  if (depth > MAX_CARD_DEPTH) {
+    return {
+      ok: false,
+      error: `Card nests ${depth} levels deep; at most ${MAX_CARD_DEPTH} are allowed. Flatten it.`
+    };
+  }
+  const misaligned = findMisalignedChart(parsed.data);
+  if (misaligned) {
+    return { ok: false, error: misaligned };
+  }
+  const reference = findScopeReference(parsed.data, "");
+  if (reference) {
+    return {
+      ok: false,
+      error: `The value at ${reference} starts with "$", which the component system reads as a reference to data that a card does not have, so it would render as nothing. Write the value without the leading "$".`
+    };
+  }
+  return { ok: true, card: parsed.data };
+}
+function describeType(schema) {
+  const def = schema._def;
+  switch (def.typeName) {
+    case "ZodOptional":
+    case "ZodNullable":
+    case "ZodDefault":
+      return describeType(schema.unwrap());
+    case "ZodLazy":
+      return "component[]";
+    case "ZodArray": {
+      const inner = describeType(def.type);
+      return `${inner}[]`;
+    }
+    case "ZodObject": {
+      const shape = schema.shape;
+      const fields = Object.entries(shape).map(
+        ([key, value]) => `${key}${value.isOptional() ? "?" : ""}`
+      );
+      return `{${fields.join(", ")}}`;
+    }
+    case "ZodEnum":
+      return (def.values ?? []).join("|");
+    case "ZodUnion":
+      return (def.options ?? []).map(describeType).join("|");
+    case "ZodLiteral":
+      return String(def.value);
+    case "ZodString":
+      return "string";
+    case "ZodNumber":
+      return "number";
+    case "ZodBoolean":
+      return "boolean";
+    case "ZodRecord":
+      return "object";
+    default:
+      return "value";
+  }
+}
+function describeChatCardProfile() {
+  return CARD_MEMBERS.map((member) => {
+    const shape = member.shape;
+    const name = shape["component"]._def.value;
+    const fields = Object.entries(shape).filter(([key]) => key !== "component" && key !== "style").map(([key, value]) => `${key}${value.isOptional() ? "?" : ""}: ${describeType(value)}`);
+    return fields.length ? `${name} \u2014 ${fields.join("; ")}` : name;
+  }).join("\n");
+}
 export {
   AllowedCSSPropertySchema,
   AuthorSchema,
   ButtonPropsSchema,
+  CHAT_CARD_COMPONENTS,
+  CalendarEventPropsSchema,
+  CalendarEventStatusSchema,
   CapabilityPermissionSchema,
+  ChartKindSchema,
+  ChartPropsSchema,
+  ChartSeriesSchema,
+  ChatCardComponentSchema,
+  ChatCardSchema,
   CheckboxPropsSchema,
   CollapsiblePropsSchema,
   CommandDefinitionSchema,
@@ -570,12 +1073,16 @@ export {
   IconButtonTypeSchema,
   IconPickerPropsSchema,
   IconPropsSchema,
+  KeyValueListPropsSchema,
+  KeyValueRowSchema,
   LabelPropsSchema,
   ListPropsSchema,
   LocalizedStringSchema,
   MarkdownPropsSchema,
   ModalPropsSchema,
   NetworkPermissionSchema,
+  NotePropsSchema,
+  NoteVariantSchema,
   PERMISSION_PATTERNS,
   PanelActionDataSourceSchema,
   PanelActionSchema,
@@ -594,10 +1101,15 @@ export {
   ProviderConfigViewSchema,
   ProviderDefinitionSchema,
   SelectPropsSchema,
+  StatTilePropsSchema,
+  StatTrendSchema,
   StoragePermissionSchema,
   SystemPermissionSchema,
   TextInputPropsSchema,
   TextPreviewPropsSchema,
+  TimelineEntrySchema,
+  TimelinePropsSchema,
+  TimelineVariantSchema,
   TogglePropsSchema,
   ToolDefinitionSchema,
   ToolSettingsActionDataSourceSchema,
@@ -610,6 +1122,13 @@ export {
   UserDataPermissionSchema,
   VALID_PERMISSIONS,
   VerticalStackPropsSchema,
-  isValidPermission
+  WeatherConditionSchema,
+  WeatherForecastPropsSchema,
+  WeatherForecastStepSchema,
+  WeatherNowPropsSchema,
+  WeatherWindSchema,
+  describeChatCardProfile,
+  isValidPermission,
+  validateChatCard
 };
 //# sourceMappingURL=index.js.map