@json-to-office/core-docx 2.0.0 → 2.1.0

package/dist/plugin/example/index.js

@@ -12452,167 +12452,262 @@ function createDocumentGenerator(options) {
 
 // src/plugin/example/weather.component.ts
 import { Type as Type2 } from "@sinclair/typebox";
-
-// src/plugin/createComponent.ts
-import {
-  createVersion as sharedCreateVersion,
-  createComponent as sharedCreateComponent
-} from "@json-to-office/shared/plugin";
-function createVersion(version) {
-  return sharedCreateVersion(version);
-}
-function createComponent(component) {
-  return sharedCreateComponent(component);
-}
-
-// src/plugin/example/weather.component.ts
+import { createComponent, createVersion } from "@json-to-office/core-docx";
+var WEATHER_API_HOSTS = [
+  "https://geocoding-api.open-meteo.com",
+  "https://api.open-meteo.com"
+];
+var GEOCODING_URL = "https://geocoding-api.open-meteo.com/v1/search";
+var FORECAST_URL = "https://api.open-meteo.com/v1/forecast";
+var REQUEST_TIMEOUT_MS = 8e3;
+var UnitsSchema = Type2.Optional(
+  Type2.Union([Type2.Literal("metric"), Type2.Literal("imperial")], {
+    default: "metric",
+    description: "metric = \xB0C and km/h, imperial = \xB0F and mph"
+  })
+);
 var WeatherV1PropsSchema = Type2.Object(
   {
     city: Type2.String({
-      description: "City name for weather data"
+      minLength: 1,
+      description: 'City to look up, e.g. "Milan" or "Milan, Italy"'
     }),
-    units: Type2.Optional(
-      Type2.Union([Type2.Literal("metric"), Type2.Literal("imperial")], {
-        default: "metric",
-        description: "Temperature units"
-      })
-    ),
+    units: UnitsSchema,
     showDetails: Type2.Optional(
       Type2.Boolean({
         default: true,
-        description: "Show detailed weather information"
+        description: "Show humidity, wind and pressure under the reading"
       })
     )
   },
-  {
-    additionalProperties: false
-  }
+  { additionalProperties: false }
 );
 var WeatherV2PropsSchema = Type2.Object(
   {
     city: Type2.String({
-      description: "City name for weather data"
+      minLength: 1,
+      description: 'City to look up, e.g. "Milan" or "Milan, Italy"'
     }),
-    units: Type2.Optional(
-      Type2.Union([Type2.Literal("metric"), Type2.Literal("imperial")], {
-        default: "metric",
-        description: "Temperature units"
-      })
-    ),
+    units: UnitsSchema,
     days: Type2.Optional(
       Type2.Number({
-        default: 1,
+        default: 3,
         minimum: 1,
-        maximum: 5,
-        description: "Number of forecast days (1-5)"
+        maximum: 7,
+        description: "Number of forecast days (1-7)"
       })
     )
   },
-  {
-    additionalProperties: false
-  }
+  { additionalProperties: false }
 );
-async function fetchWeather(city, units) {
-  await new Promise((resolve2) => setTimeout(resolve2, 100));
-  const mockData = {
-    London: {
-      temperature: units === "imperial" ? 59 : 15,
-      description: "Partly cloudy",
-      humidity: 65,
-      windSpeed: units === "imperial" ? 10 : 16,
-      pressure: 1013
-    },
-    "New York": {
-      temperature: units === "imperial" ? 72 : 22,
-      description: "Sunny",
-      humidity: 45,
-      windSpeed: units === "imperial" ? 8 : 13,
-      pressure: 1015
-    },
-    Tokyo: {
-      temperature: units === "imperial" ? 68 : 20,
-      description: "Clear",
-      humidity: 55,
-      windSpeed: units === "imperial" ? 5 : 8,
-      pressure: 1012
-    }
-  };
-  return mockData[city] || {
-    temperature: units === "imperial" ? 70 : 21,
-    description: "Clear",
-    humidity: 50,
-    windSpeed: units === "imperial" ? 7 : 11,
-    pressure: 1013
-  };
-}
-async function fetchForecast(city, units, days) {
-  await new Promise((resolve2) => setTimeout(resolve2, 50));
-  const dayNames = ["Mon", "Tue", "Wed", "Thu", "Fri"];
-  const base = units === "imperial" ? 65 : 18;
-  return dayNames.slice(0, days).map((day, i) => ({
-    day,
-    high: base + (5 - i) * (units === "imperial" ? 2 : 1),
-    low: base - (3 + i) * (units === "imperial" ? 2 : 1),
-    description: ["Sunny", "Partly cloudy", "Cloudy", "Showers", "Clear"][i]
+var WEATHER_CODES = {
+  0: "Clear sky",
+  1: "Mainly clear",
+  2: "Partly cloudy",
+  3: "Overcast",
+  45: "Fog",
+  48: "Depositing rime fog",
+  51: "Light drizzle",
+  53: "Moderate drizzle",
+  55: "Dense drizzle",
+  56: "Light freezing drizzle",
+  57: "Dense freezing drizzle",
+  61: "Slight rain",
+  63: "Moderate rain",
+  65: "Heavy rain",
+  66: "Light freezing rain",
+  67: "Heavy freezing rain",
+  71: "Slight snow",
+  73: "Moderate snow",
+  75: "Heavy snow",
+  77: "Snow grains",
+  80: "Slight rain showers",
+  81: "Moderate rain showers",
+  82: "Violent rain showers",
+  85: "Slight snow showers",
+  86: "Heavy snow showers",
+  95: "Thunderstorm",
+  96: "Thunderstorm with slight hail",
+  99: "Thunderstorm with heavy hail"
+};
+function describeCode(code) {
+  return typeof code === "number" && WEATHER_CODES[code] ? WEATHER_CODES[code] : "Unknown conditions";
+}
+var WeatherLookupError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "WeatherLookupError";
+  }
+};
+async function getJson(url, what) {
+  let response;
+  try {
+    response = await fetch(url, {
+      signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS),
+      headers: { accept: "application/json" }
+    });
+  } catch (error) {
+    const reason = error instanceof Error ? error.message : String(error);
+    throw new WeatherLookupError(
+      `Could not reach Open-Meteo for ${what}: ${reason}. In the playground, list ${WEATHER_API_HOSTS.join(" and ")} under this plugin's Network switch.`
+    );
+  }
+  if (!response.ok) {
+    throw new WeatherLookupError(
+      `Open-Meteo answered ${response.status} for ${what}.`
+    );
+  }
+  return response.json();
+}
+async function geocode(city) {
+  const url = `${GEOCODING_URL}?name=${encodeURIComponent(city)}&count=1&language=en&format=json`;
+  const body = await getJson(url, `"${city}"`);
+  const first = body.results?.[0];
+  if (!first || typeof first.latitude !== "number") {
+    throw new WeatherLookupError(
+      `Open-Meteo has no place called "${city}". Try adding a country, e.g. "${city}, Italy".`
+    );
+  }
+  return {
+    name: String(first.name ?? city),
+    country: typeof first.country === "string" ? first.country : void 0,
+    admin1: typeof first.admin1 === "string" ? first.admin1 : void 0,
+    latitude: first.latitude,
+    longitude: first.longitude,
+    timezone: typeof first.timezone === "string" ? first.timezone : void 0
+  };
+}
+function placeLabel(place) {
+  return [place.name, place.admin1, place.country].filter(Boolean).join(", ");
+}
+function unitParams(units) {
+  return units === "imperial" ? "&temperature_unit=fahrenheit&wind_speed_unit=mph&precipitation_unit=inch" : "";
+}
+async function fetchCurrent(place, units) {
+  const url = `${FORECAST_URL}?latitude=${place.latitude}&longitude=${place.longitude}&current=temperature_2m,apparent_temperature,relative_humidity_2m,wind_speed_10m,surface_pressure,weather_code&timezone=auto${unitParams(units)}`;
+  const body = await getJson(url, `weather in ${place.name}`);
+  const current = body.current;
+  if (!current || typeof current.temperature_2m !== "number") {
+    throw new WeatherLookupError(
+      `Open-Meteo returned no current reading for ${place.name}.`
+    );
+  }
+  const round = (value, fallback = 0) => typeof value === "number" ? Math.round(value) : fallback;
+  return {
+    temperature: Math.round(current.temperature_2m),
+    apparent: round(
+      current.apparent_temperature,
+      Math.round(current.temperature_2m)
+    ),
+    conditions: describeCode(current.weather_code),
+    humidity: round(current.relative_humidity_2m),
+    windSpeed: round(current.wind_speed_10m),
+    pressure: round(current.surface_pressure),
+    observedAt: typeof current.time === "string" ? current.time : ""
+  };
+}
+async function fetchForecast(place, units, days) {
+  const url = `${FORECAST_URL}?latitude=${place.latitude}&longitude=${place.longitude}&daily=weather_code,temperature_2m_max,temperature_2m_min,precipitation_probability_max&forecast_days=${days}&timezone=auto${unitParams(units)}`;
+  const body = await getJson(url, `the forecast for ${place.name}`);
+  const daily = body.daily;
+  const dates = daily?.time;
+  if (!Array.isArray(dates) || dates.length === 0) {
+    throw new WeatherLookupError(
+      `Open-Meteo returned no forecast for ${place.name}.`
+    );
+  }
+  const at = (key, i) => daily?.[key]?.[i];
+  return dates.slice(0, days).map((date, i) => ({
+    date: String(date),
+    high: Math.round(Number(at("temperature_2m_max", i) ?? 0)),
+    low: Math.round(Number(at("temperature_2m_min", i) ?? 0)),
+    conditions: describeCode(at("weather_code", i)),
+    precipitation: Math.round(
+      Number(at("precipitation_probability_max", i) ?? 0)
+    )
   }));
 }
+function formatDay(iso) {
+  const date = /* @__PURE__ */ new Date(`${iso}T00:00:00Z`);
+  if (Number.isNaN(date.getTime())) return iso;
+  return date.toLocaleDateString("en-GB", {
+    weekday: "short",
+    day: "numeric",
+    month: "short",
+    timeZone: "UTC"
+  });
+}
 var weatherComponent = createComponent({
   name: "weather",
   versions: {
     "1.0.0": createVersion({
       propsSchema: WeatherV1PropsSchema,
-      description: "Displays current weather information for a city",
+      description: "Current weather for a city, fetched live from Open-Meteo (needs network access to api.open-meteo.com and geocoding-api.open-meteo.com)",
       render: async ({ props, addWarning }) => {
-        const weather = await fetchWeather(props.city, props.units || "metric");
-        addWarning("Fetched weather data", { city: props.city });
-        const tempUnit = props.units === "imperial" ? "\xB0F" : "\xB0C";
-        const speedUnit = props.units === "imperial" ? "mph" : "km/h";
+        const units = props.units ?? "metric";
+        const place = await geocode(props.city);
+        const weather = await fetchCurrent(place, units);
+        addWarning(`Fetched live weather from Open-Meteo`, {
+          place: placeLabel(place),
+          observedAt: weather.observedAt
+        });
+        const degrees = units === "imperial" ? "\xB0F" : "\xB0C";
+        const speed = units === "imperial" ? "mph" : "km/h";
         const components = [
           {
             name: "heading",
-            props: {
-              level: 3,
-              text: `Weather in ${props.city}`
-            }
+            props: { level: 3, text: `Weather in ${placeLabel(place)}` }
           },
           {
             name: "paragraph",
             props: {
-              text: `${weather.temperature}${tempUnit} - ${weather.description}`,
+              text: `${weather.temperature}${degrees} \u2014 ${weather.conditions}`,
               font: { bold: true, size: 14 }
             }
           }
         ];
-        if (props.showDetails) {
+        if (props.showDetails ?? true) {
           components.push({
             name: "list",
             props: {
               items: [
+                `Feels like: ${weather.apparent}${degrees}`,
                 `Humidity: ${weather.humidity}%`,
-                `Wind Speed: ${weather.windSpeed} ${speedUnit}`,
+                `Wind: ${weather.windSpeed} ${speed}`,
                 `Pressure: ${weather.pressure} hPa`
               ]
             }
           });
         }
+        components.push({
+          name: "paragraph",
+          props: {
+            text: `Source: Open-Meteo${weather.observedAt ? `, observed ${weather.observedAt.replace("T", " ")}` : ""}`,
+            font: { size: 8, italic: true }
+          }
+        });
         return components;
       }
     }),
     "2.0.0": createVersion({
       propsSchema: WeatherV2PropsSchema,
-      description: "Multi-day forecast displayed as a table",
+      description: "Multi-day forecast table for a city, fetched live from Open-Meteo",
       render: async ({ props, addWarning }) => {
-        const units = props.units || "metric";
-        const days = props.days || 3;
-        const tempUnit = units === "imperial" ? "\xB0F" : "\xB0C";
-        const forecast = await fetchForecast(props.city, units, days);
-        addWarning("Fetched forecast data", { city: props.city, days });
-        const components = [
+        const units = props.units ?? "metric";
+        const days = props.days ?? 3;
+        const place = await geocode(props.city);
+        const forecast = await fetchForecast(place, units, days);
+        addWarning("Fetched live forecast from Open-Meteo", {
+          place: placeLabel(place),
+          days: forecast.length
+        });
+        const degrees = units === "imperial" ? "\xB0F" : "\xB0C";
+        return [
           {
             name: "heading",
             props: {
               level: 3,
-              text: `${days}-Day Forecast for ${props.city}`
+              text: `${forecast.length}-day forecast for ${placeLabel(place)}`
             }
           },
           {
@@ -12621,53 +12716,37 @@ var weatherComponent = createComponent({
               columns: [
                 {
                   header: { content: "Day" },
-                  cells: forecast.map((f) => ({ content: f.day }))
+                  cells: forecast.map((day) => ({
+                    content: formatDay(day.date)
+                  }))
+                },
+                {
+                  header: { content: `High (${degrees})` },
+                  cells: forecast.map((day) => ({ content: String(day.high) }))
                 },
                 {
-                  header: { content: `High (${tempUnit})` },
-                  cells: forecast.map((f) => ({ content: String(f.high) }))
+                  header: { content: `Low (${degrees})` },
+                  cells: forecast.map((day) => ({ content: String(day.low) }))
                 },
                 {
-                  header: { content: `Low (${tempUnit})` },
-                  cells: forecast.map((f) => ({ content: String(f.low) }))
+                  header: { content: "Rain" },
+                  cells: forecast.map((day) => ({
+                    content: `${day.precipitation}%`
+                  }))
                 },
                 {
                   header: { content: "Conditions" },
-                  cells: forecast.map((f) => ({ content: f.description }))
+                  cells: forecast.map((day) => ({ content: day.conditions }))
                 }
               ]
             }
-          }
-        ];
-        return components;
-      }
-    })
-  }
-});
-
-// src/plugin/example/columns-layout.component.ts
-import { Type as Type3 } from "@sinclair/typebox";
-var ColumnsLayoutPropsSchema = Type3.Object(
-  {},
-  {
-    additionalProperties: false
-  }
-);
-var columnsLayoutComponent = createComponent({
-  name: "columnsLayout",
-  versions: {
-    "1.0.0": createVersion({
-      propsSchema: ColumnsLayoutPropsSchema,
-      hasChildren: true,
-      description: "Renders a list of components in a 2-column layout",
-      render: async ({ children }) => {
-        return [
+          },
           {
-            name: "columns",
+            name: "paragraph",
             props: {
-              columns: 2
-            },
-            children: children || []
+              text: "Source: Open-Meteo",
+              font: { size: 8, italic: true }
+            }
           }
         ];
       }
@@ -12675,91 +12754,6 @@ var columnsLayoutComponent = createComponent({
   }
 });
 
-// src/plugin/example/nested-section.component.ts
-import { Type as Type4 } from "@sinclair/typebox";
-var NestedSectionsSchema = Type4.Object(
-  {},
-  {
-    additionalProperties: false
-  }
-);
-var nestedSectionsComponent = createComponent({
-  name: "nestedSections",
-  versions: {
-    "1.0.0": createVersion({
-      propsSchema: NestedSectionsSchema,
-      description: "Generates nested sections for embedding in documents",
-      render: async () => {
-        const components = [];
-        components.push({
-          name: "section",
-          props: {
-            meta: { title: "First level 1 section" }
-          },
-          children: [
-            {
-              name: "heading",
-              props: { text: "First level 1 section", level: 1 }
-            },
-            {
-              name: "heading",
-              props: {
-                text: "Level 2 heading of first level 1 section",
-                level: 2
-              }
-            },
-            {
-              name: "paragraph",
-              props: {
-                text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
-              }
-            },
-            {
-              name: "heading",
-              props: {
-                text: "Level 2 heading of first level 1 section",
-                level: 2
-              }
-            },
-            {
-              name: "paragraph",
-              props: {
-                text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
-              }
-            }
-          ]
-        });
-        components.push({
-          name: "section",
-          props: {
-            meta: { title: "Second level 1 section" }
-          },
-          children: [
-            {
-              name: "heading",
-              props: { text: "Second level 1 section", level: 1 }
-            },
-            {
-              name: "heading",
-              props: {
-                text: "Level 2 heading of second level 1 section",
-                level: 2
-              }
-            },
-            {
-              name: "paragraph",
-              props: {
-                text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
-              }
-            }
-          ]
-        });
-        return components;
-      }
-    })
-  }
-});
-
 // src/plugin/example/index.ts
 init_themes();
 import * as fs3 from "fs/promises";
@@ -12772,48 +12766,43 @@ var plugin_demo_default = {
   $schema: "../../../../../output/examples/plugin-demo-schema.json",
   name: "docx",
   props: {
-    title: "Plugin Demo"
+    title: "Weather Plugin Demo"
   },
   children: [
-    {
-      name: "nestedSections",
-      props: {}
-    },
     {
       name: "section",
       props: {
         meta: {
-          title: "Weather Information"
+          title: "Today"
         }
       },
       children: [
         {
           name: "heading",
           props: {
-            text: "Weather Information",
+            text: "Today",
             level: 1,
-            spacing: {
-              before: 0,
-              after: 0
-            }
+            spacing: { before: 0, after: 0 }
           }
         },
         {
           name: "paragraph",
           props: {
-            content: "Here's the current weather for major cities:"
+            content: "Each block below is rendered by the weather plugin, which calls Open-Meteo while the document is generated."
           }
         },
         {
           name: "weather",
+          version: "1.0.0",
           props: {
-            city: "London",
+            city: "Milan",
             units: "metric",
             showDetails: true
           }
         },
         {
           name: "weather",
+          version: "1.0.0",
           props: {
             city: "New York",
             units: "imperial",
@@ -12826,97 +12815,25 @@ var plugin_demo_default = {
       name: "section",
       props: {
         meta: {
-          title: "Sales Data"
+          title: "The week ahead"
         }
       },
       children: [
         {
           name: "heading",
           props: {
-            text: "Sales Data",
+            text: "The week ahead",
             level: 1,
-            spacing: {
-              before: 0,
-              after: 0
-            }
-          }
-        },
-        {
-          name: "paragraph",
-          props: {
-            content: "Recent sales performance:"
+            spacing: { before: 0, after: 0 }
           }
         },
         {
-          name: "dataTable",
-          props: {
-            query: "SELECT * FROM sales ORDER BY date DESC",
-            title: "Q1 Sales Report",
-            showRowNumbers: true,
-            maxRows: 10
-          }
-        }
-      ]
-    },
-    {
-      name: "section",
-      props: {
-        meta: {
-          title: "Quick Links"
-        }
-      },
-      children: [
-        {
-          name: "heading",
-          props: {
-            text: "Quick Links",
-            level: 1,
-            spacing: {
-              before: 0,
-              after: 0
-            }
-          }
-        },
-        {
-          name: "paragraph",
-          props: {
-            content: "Scan these QR codes to access our resources:"
-          }
-        }
-      ]
-    },
-    {
-      name: "section",
-      props: {
-        meta: {
-          title: "More Data Examples"
-        }
-      },
-      children: [
-        {
-          name: "heading",
-          props: {
-            text: "More Data Examples",
-            level: 1,
-            spacing: {
-              before: 0,
-              after: 0
-            }
-          }
-        },
-        {
-          name: "dataTable",
-          props: {
-            query: 'SELECT * FROM users WHERE role = "Admin"',
-            title: "System Administrators"
-          }
-        },
-        {
-          name: "dataTable",
+          name: "weather",
+          version: "2.0.0",
           props: {
-            query: "SELECT * FROM inventory WHERE stock < 50",
-            title: "Low Stock Items",
-            showRowNumbers: false
+            city: "Tokyo",
+            units: "metric",
+            days: 5
           }
         }
       ]
@@ -12934,7 +12851,7 @@ async function runPluginDemo() {
     theme: minimalTheme,
     debug: true
     // Enable debug logging
-  }).addComponent(weatherComponent).addComponent(columnsLayoutComponent).addComponent(nestedSectionsComponent);
+  }).addComponent(weatherComponent);
   console.log(
     "\u2705 Registered components:",
     generator.getComponentNames().join(", ")
@@ -12982,10 +12899,7 @@ async function runPluginDemo() {
     await fs3.writeFile(outputPath, new Uint8Array(result.buffer));
     console.log(`\u2705 Document saved to: ${outputPath}`);
     const schemaPath = path2.join(outputDir, "plugin-demo-schema.json");
-    await exportPluginSchema(
-      [weatherComponent, columnsLayoutComponent, nestedSectionsComponent],
-      schemaPath
-    );
+    await exportPluginSchema([weatherComponent], schemaPath);
     console.log(`\u2705 Schema saved to: ${schemaPath}`);
   } catch (error) {
     console.error("\u274C Error generating document:", error);