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

package/dist/plugin/example/plugin-demo.json

@@ -2,48 +2,43 @@
   "$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",
@@ -56,97 +51,25 @@
       "name": "section",
       "props": {
         "meta": {
-          "title": "Sales Data"
-        }
-      },
-      "children": [
-        {
-          "name": "heading",
-          "props": {
-            "text": "Sales Data",
-            "level": 1,
-            "spacing": {
-              "before": 0,
-              "after": 0
-            }
-          }
-        },
-        {
-          "name": "paragraph",
-          "props": {
-            "content": "Recent sales performance:"
-          }
-        },
-        {
-          "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"
+          "title": "The week ahead"
         }
       },
       "children": [
         {
           "name": "heading",
           "props": {
-            "text": "Quick Links",
+            "text": "The week ahead",
             "level": 1,
-            "spacing": {
-              "before": 0,
-              "after": 0
-            }
+            "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
           }
         }
       ]

package/dist/plugin/example/weather.component.d.ts

@@ -1,26 +1,90 @@
 import type { ComponentDefinition } from '@json-to-office/shared-docx';
 /**
- * Weather component that fetches and displays weather information
+ * The reference example for a plugin that calls a real API.
+ *
+ * Weather comes from Open-Meteo (https://open-meteo.com) — free, no key, no
+ * attribution requirement — over two endpoints: a geocoding search that turns
+ * a city name into coordinates, then the forecast itself. Everything it needs
+ * is in the two hosts below, which is the point of the example: a plugin
+ * should be able to name what it talks to.
+ *
+ * In the playground this runs inside the browser sandbox, so both hosts have
+ * to be listed against the plugin's Network switch before either call is
+ * allowed. On disk it runs in Node, where `fetch` is global from 18 on.
+ */
+/** The hosts this component calls. Paste these into its Network allowlist. */
+export declare const WEATHER_API_HOSTS: readonly ["https://geocoding-api.open-meteo.com", "https://api.open-meteo.com"];
+export declare class WeatherLookupError extends Error {
+    constructor(message: string);
+}
+export interface CurrentWeather {
+    temperature: number;
+    apparent: number;
+    conditions: string;
+    humidity: number;
+    windSpeed: number;
+    pressure: number;
+    observedAt: string;
+}
+export interface ForecastDay {
+    date: string;
+    high: number;
+    low: number;
+    conditions: string;
+    precipitation: number;
+}
+/**
+ * Live weather, from Open-Meteo.
  *
  * @example
  * ```json
  * {
  *   "name": "weather",
- *   "props": {
- *     "city": "London",
- *     "units": "metric",
- *     "showDetails": true
- *   }
+ *   "props": { "city": "Milan", "units": "metric", "showDetails": true }
  * }
  * ```
  */
-export declare const weatherComponent: import("../createComponent").CustomComponent<ComponentDefinition, {
-    '1.0.0': import("../createComponent").ComponentVersion<ComponentDefinition, import("@sinclair/typebox").TObject<{
+export declare const weatherComponent: import("@json-to-office/core-docx").CustomComponent<ComponentDefinition, {
+    '1.0.0': import("@json-to-office/core-docx").ComponentVersion<ComponentDefinition, import("@sinclair/typebox").TObject<{
         city: import("@sinclair/typebox").TString;
         units: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"metric">, import("@sinclair/typebox").TLiteral<"imperial">]>>;
         showDetails: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
     }>>;
-    '2.0.0': import("../createComponent").ComponentVersion<ComponentDefinition, import("@sinclair/typebox").TObject<{
+    '2.0.0': import("@json-to-office/core-docx").ComponentVersion<{
+        name: "heading";
+        props: {
+            level: 3;
+            text: string;
+            columns?: undefined;
+            font?: undefined;
+        };
+    } | {
+        name: "table";
+        props: {
+            columns: {
+                header: {
+                    content: string;
+                };
+                cells: {
+                    content: string;
+                }[];
+            }[];
+            level?: undefined;
+            text?: undefined;
+            font?: undefined;
+        };
+    } | {
+        name: "paragraph";
+        props: {
+            text: string;
+            font: {
+                size: number;
+                italic: true;
+            };
+            level?: undefined;
+            columns?: undefined;
+        };
+    }, import("@sinclair/typebox").TObject<{
         city: import("@sinclair/typebox").TString;
         units: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"metric">, import("@sinclair/typebox").TLiteral<"imperial">]>>;
         days: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;

package/dist/plugin/example/weather.component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"weather.component.d.ts","sourceRoot":"","sources":["../../../src/plugin/example/weather.component.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAoIvE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;aAgG3B,CAAC"}
+{"version":3,"file":"weather.component.d.ts","sourceRoot":"","sources":["../../../src/plugin/example/weather.component.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAEvE;;;;;;;;;;;;GAYG;AAEH,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,iFAGpB,CAAC;AA6FX,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAsED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAmCD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACvB;AAiDD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA+H3B,CAAC"}