@antelopejs/interface-dms 0.3.5 → 0.4.0

package/dist/base/chart-card.js

@@ -6,10 +6,14 @@ const component_1 = require("../component");
 const zod_1 = require("zod");
 const block_registry_1 = require("./block-registry");
 const chart_1 = require("./chart");
-const chart_schemas_1 = require("./chart-schemas");
+const chart_schemas_1 = require("./internal/chart-schemas");
 const http_1 = require("./types/http");
 const CHART_CARD_COMPONENT_NAME = "dms-chart-card";
 const NESTED_CHART_ID = "chart";
+/**
+ * What a chart inside a card never reads of its own: the card fetches the
+ * series it draws, heads it, and keeps its legend.
+ */
 const CARD_SUPPLIED_CHART_OPTIONS = [
     "title",
     "description",
@@ -19,6 +23,12 @@ const CARD_SUPPLIED_CHART_OPTIONS = [
     "periodScope",
     "realtimeTopic",
 ];
+/**
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `ChartCard()`. A page under construction has to compile — it is typechecked
+ * on every edit — so a block with nothing set yet has to be a legal call.
+ */
 function ChartCard(options) {
     const { chart, ...rest } = options ?? {};
     const builder = new component_1.ComponentBuilder(CHART_CARD_COMPONENT_NAME)
@@ -29,6 +39,7 @@ function ChartCard(options) {
     });
     return chart ? builder.child(NESTED_CHART_ID, chart) : builder;
 }
+/** The options `ChartCard` accepts, including the chart it wraps. */
 exports.ChartCardSchema = zod_1.z.object({
     title: (0, block_registry_1.ui)(zod_1.z.string().describe("Card heading."), {
         label: "Title",
@@ -76,6 +87,8 @@ exports.ChartCardSchema = zod_1.z.object({
         label: "Currency",
         group: "appearance",
     }),
+    // The card draws its variation and its legend unless they are turned off:
+    // declared, so an editor's switch does not show them off while they show.
     showDelta: (0, block_registry_1.ui)(zod_1.z.boolean().default(true), {
         label: "Show variation",
         group: "appearance",

package/dist/base/chart-card.js.map

@@ -1 +1 @@
-{"version":3,"file":"chart-card.js","sourceRoot":"","sources":["../../src/base/chart-card.ts"],"names":[],"mappings":";;;AAuDA,8BAaC;AApED,4CAAgE;AAChE,6BAAwB;AACxB,qDAK0B;AAC1B,mCAA+E;AAC/E,mDAAoD;AAEpD,uCAA0C;AAsB1C,MAAM,yBAAyB,GAAG,gBAAgB,CAAC;AACnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAKhC,MAAM,2BAA2B,GAAG;IAClC,OAAO;IACP,aAAa;IACb,YAAY;IACZ,UAAU;IACV,gBAAgB;IAChB,aAAa;IACb,eAAe;CAChB,CAAC;AAQF,SAAgB,SAAS,CACvB,OAAiC;IAEjC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,IAAK,EAA8B,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAClC,yBAAyB,CAC1B;SACE,OAAO,CAAC,IAAsB,CAAC;SAC/B,IAAI,CAAC;QACJ,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,YAAY;QAChC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,iBAAiB;KACrC,CAAC,CAAC;IACL,OAAO,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACjE,CAAC;AAGY,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC9C,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC9B,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EACP,IAAA,qCAAoB,GAAa,CAAC,QAAQ,CACxC,iCAAiC,CAClC,EACD;QACE,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,iCAAiB;QAC7B,QAAQ,EAAE,2BAA2B;KACtC,CACF;IACD,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,MAAM;QACrB,YAAY,EAAE,aAAa;KAC5B,CAAC;IACF,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,UAAU;KAClB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,qBAAa,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,YAAY;KACpB,CAAC;IAGF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACzC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,SAAS;KACjB,CAAC;CACH,CAAoD,CAAC;AAEtD,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,yBAAyB;IACxC,MAAM,EAAE,uBAAe;IACvB,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,sDAAsD;QACnE,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}
+{"version":3,"file":"chart-card.js","sourceRoot":"","sources":["../../src/base/chart-card.ts"],"names":[],"mappings":";;;AAuDA,8BAaC;AApED,4CAAgE;AAChE,6BAAwB;AACxB,qDAK0B;AAC1B,mCAA+E;AAC/E,4DAA6D;AAE7D,uCAA0C;AAsB1C,MAAM,yBAAyB,GAAG,gBAAgB,CAAC;AACnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC;;;GAGG;AACH,MAAM,2BAA2B,GAAG;IAClC,OAAO;IACP,aAAa;IACb,YAAY;IACZ,UAAU;IACV,gBAAgB;IAChB,aAAa;IACb,eAAe;CAChB,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,SAAS,CACvB,OAAiC;IAEjC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,IAAK,EAA8B,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAClC,yBAAyB,CAC1B;SACE,OAAO,CAAC,IAAsB,CAAC;SAC/B,IAAI,CAAC;QACJ,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,YAAY;QAChC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,iBAAiB;KACrC,CAAC,CAAC;IACL,OAAO,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACjE,CAAC;AAED,qEAAqE;AACxD,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC9C,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC9B,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EACP,IAAA,qCAAoB,GAAa,CAAC,QAAQ,CACxC,iCAAiC,CAClC,EACD;QACE,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,iCAAiB;QAC7B,QAAQ,EAAE,2BAA2B;KACtC,CACF;IACD,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,MAAM;QACrB,YAAY,EAAE,aAAa;KAC5B,CAAC;IACF,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,UAAU;KAClB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,qBAAa,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,0EAA0E;IAC1E,0EAA0E;IAC1E,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACzC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,SAAS;KACjB,CAAC;CACH,CAAoD,CAAC;AAEtD,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,yBAAyB;IACxC,MAAM,EAAE,uBAAe;IACvB,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,sDAAsD;QACnE,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}