@malloydata/render 0.0.51-dev230705184641 → 0.0.51-dev230705224132

package/dist/data_styles.d.ts

@@ -92,7 +92,17 @@ export interface TimeRenderOptions extends TextRenderOptions {
     time?: Record<string, unknown>;
 }
 export interface NumberRenderOptions extends TextRenderOptions {
-    number?: Record<string, unknown>;
+    value_format?: string;
+}
+export declare enum DataVolumeUnit {
+    Bytes = "bytes",
+    Kilobytes = "kb",
+    Megabytes = "mb",
+    Gigabytes = "gb",
+    Terabytes = "tb"
+}
+export interface DataVolumeRenderOptions extends TextRenderOptions {
+    data_volume_unit?: DataVolumeUnit;
 }
 export interface ImageRenderOptions extends TextRenderOptions {
     border?: boolean;

package/dist/data_styles.js

@@ -22,11 +22,19 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Currency = void 0;
+exports.DataVolumeUnit = exports.Currency = void 0;
 var Currency;
 (function (Currency) {
     Currency["Dollars"] = "usd";
     Currency["Euros"] = "euro";
     Currency["Pounds"] = "pound";
 })(Currency = exports.Currency || (exports.Currency = {}));
+var DataVolumeUnit;
+(function (DataVolumeUnit) {
+    DataVolumeUnit["Bytes"] = "bytes";
+    DataVolumeUnit["Kilobytes"] = "kb";
+    DataVolumeUnit["Megabytes"] = "mb";
+    DataVolumeUnit["Gigabytes"] = "gb";
+    DataVolumeUnit["Terabytes"] = "tb";
+})(DataVolumeUnit = exports.DataVolumeUnit || (exports.DataVolumeUnit = {}));
 //# sourceMappingURL=data_styles.js.map

package/dist/html/currency.d.ts

@@ -1,4 +1,4 @@
-import { DataColumn, Explore, Field, MalloyTagProperties } from '@malloydata/malloy';
+import { DataColumn, Explore, Field } from '@malloydata/malloy';
 import { HTMLTextRenderer } from './text';
 import { RendererFactory } from '../renderer_factory';
 import { CurrencyRenderOptions, StyleDefaults } from '../data_styles';
@@ -11,7 +11,7 @@ export declare class HTMLCurrencyRenderer extends HTMLTextRenderer {
 }
 export declare class CurrencyRendererFactory extends RendererFactory<CurrencyRenderOptions> {
     static readonly instance: CurrencyRendererFactory;
+    constructor();
     create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: CurrencyRenderOptions): Renderer;
-    parseTagParameters(tags: MalloyTagProperties): CurrencyRenderOptions | undefined;
     get rendererName(): string;
 }

package/dist/html/currency.js

@@ -56,15 +56,16 @@ class HTMLCurrencyRenderer extends text_1.HTMLTextRenderer {
 }
 exports.HTMLCurrencyRenderer = HTMLCurrencyRenderer;
 class CurrencyRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            var _a;
+            options.currency = (_a = value) !== null && _a !== void 0 ? _a : data_styles_1.Currency.Dollars;
+        }, this.rendererName);
+    }
     create(document, _styleDefaults, _rendererOptions, _field, options) {
         return new HTMLCurrencyRenderer(document, options);
     }
-    parseTagParameters(tags) {
-        var _a;
-        return {
-            currency: (_a = tags[this.rendererName]) !== null && _a !== void 0 ? _a : data_styles_1.Currency.Dollars,
-        };
-    }
     get rendererName() {
         return 'currency';
     }

package/dist/html/data_volume.d.ts

@@ -0,0 +1,21 @@
+import { DataColumn, Explore, Field } from '@malloydata/malloy';
+import { HTMLTextRenderer } from './text';
+import { DataVolumeRenderOptions, NumberRenderOptions, StyleDefaults } from '../data_styles';
+import { RendererOptions } from '../renderer_types';
+import { Renderer } from '../renderer';
+import { RendererFactory } from '../renderer_factory';
+export declare class HTMLDataVolumeRenderer extends HTMLTextRenderer {
+    readonly options: DataVolumeRenderOptions;
+    constructor(document: Document, options: DataVolumeRenderOptions);
+    private static kbMultiplier;
+    private static mbMultiplier;
+    private static gbMultiplier;
+    private static tbMultiplier;
+    getText(data: DataColumn): string | null;
+}
+export declare class DataVolumeRendererFactory extends RendererFactory<DataVolumeRenderOptions> {
+    static readonly instance: DataVolumeRendererFactory;
+    constructor();
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: NumberRenderOptions): Renderer;
+    get rendererName(): string;
+}

package/dist/html/data_volume.js

@@ -0,0 +1,96 @@
+"use strict";
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataVolumeRendererFactory = exports.HTMLDataVolumeRenderer = void 0;
+const text_1 = require("./text");
+const data_styles_1 = require("../data_styles");
+const renderer_factory_1 = require("../renderer_factory");
+class HTMLDataVolumeRenderer extends text_1.HTMLTextRenderer {
+    constructor(document, options) {
+        super(document);
+        this.options = options;
+    }
+    getText(data) {
+        if (data.isNull()) {
+            return null;
+        }
+        if (!data.isNumber()) {
+            // TODO: check if this is proper way to throw.
+            throw new Error('');
+        }
+        let data_volume = data.number.value;
+        let unit = 'Bytes';
+        switch (this.options.data_volume_unit) {
+            case data_styles_1.DataVolumeUnit.Bytes:
+                // Do nothing.
+                break;
+            case data_styles_1.DataVolumeUnit.Kilobytes:
+                data_volume = data_volume / HTMLDataVolumeRenderer.kbMultiplier;
+                unit = 'KB';
+                break;
+            case data_styles_1.DataVolumeUnit.Megabytes:
+                data_volume = data_volume / HTMLDataVolumeRenderer.mbMultiplier;
+                unit = 'MB';
+                break;
+            case data_styles_1.DataVolumeUnit.Gigabytes:
+                data_volume = data_volume / HTMLDataVolumeRenderer.gbMultiplier;
+                unit = 'GB';
+                break;
+            case data_styles_1.DataVolumeUnit.Terabytes:
+                data_volume = data_volume / HTMLDataVolumeRenderer.tbMultiplier;
+                unit = 'TB';
+                break;
+        }
+        return data_volume === null
+            ? data_volume
+            : `${data_volume.toLocaleString()} ${unit}`;
+    }
+}
+exports.HTMLDataVolumeRenderer = HTMLDataVolumeRenderer;
+_a = HTMLDataVolumeRenderer;
+HTMLDataVolumeRenderer.kbMultiplier = 1024;
+HTMLDataVolumeRenderer.mbMultiplier = _a.kbMultiplier * _a.kbMultiplier;
+HTMLDataVolumeRenderer.gbMultiplier = _a.mbMultiplier * _a.kbMultiplier;
+HTMLDataVolumeRenderer.tbMultiplier = _a.gbMultiplier * _a.kbMultiplier;
+class DataVolumeRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            var _b;
+            throw new Error(`----a> ${options.data_volume_unit}`);
+            options.data_volume_unit =
+                (_b = value) !== null && _b !== void 0 ? _b : data_styles_1.DataVolumeUnit.Bytes;
+        }, this.rendererName);
+    }
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLDataVolumeRenderer(document, options);
+    }
+    get rendererName() {
+        return 'data_volume';
+    }
+}
+exports.DataVolumeRendererFactory = DataVolumeRendererFactory;
+DataVolumeRendererFactory.instance = new DataVolumeRendererFactory();
+//# sourceMappingURL=data_volume.js.map

package/dist/html/number.d.ts

@@ -5,12 +5,15 @@ import { RendererOptions } from '../renderer_types';
 import { Renderer } from '../renderer';
 import { RendererFactory } from '../renderer_factory';
 export declare class HTMLNumberRenderer extends HTMLTextRenderer {
+    readonly options: NumberRenderOptions;
+    constructor(document: Document, options: NumberRenderOptions);
     getNumber(data: DataColumn): number | null;
     getText(data: DataColumn): string | null;
 }
 export declare class NumberRendererFactory extends RendererFactory<NumberRenderOptions> {
     static readonly instance: NumberRendererFactory;
+    constructor();
     activates(field: Field | Explore): boolean;
-    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, _options: NumberRenderOptions): Renderer;
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: NumberRenderOptions): Renderer;
     get rendererName(): string;
 }

package/dist/html/number.js

@@ -21,16 +21,33 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumberRendererFactory = exports.HTMLNumberRenderer = void 0;
 const malloy_1 = require("@malloydata/malloy");
 const text_1 = require("./text");
 const renderer_factory_1 = require("../renderer_factory");
+const numfmt_1 = __importDefault(require("numfmt"));
 class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
+    constructor(document, options) {
+        super(document);
+        this.options = options;
+    }
     getNumber(data) {
         if (data.isNull()) {
             return null;
         }
+        if (this.options.value_format) {
+            try {
+                return numfmt_1.default.format(this.options.value_format, data.number.value);
+            }
+            catch {
+                // TODO: explore surfacing invalid format error, ignoring it for now.
+                return data.number.value;
+            }
+        }
         return data.number.value;
     }
     getText(data) {
@@ -40,13 +57,19 @@ class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
 }
 exports.HTMLNumberRenderer = HTMLNumberRenderer;
 class NumberRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            options.value_format = value;
+        }, this.rendererName, 'value_format');
+    }
     activates(field) {
         return (field.hasParentExplore() &&
             field.isAtomicField() &&
             field.type === malloy_1.AtomicFieldType.Number);
     }
-    create(document, _styleDefaults, _rendererOptions, _field, _options) {
-        return new HTMLNumberRenderer(document);
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLNumberRenderer(document, options);
     }
     get rendererName() {
         return 'number';

package/dist/html/percent.d.ts

@@ -9,6 +9,6 @@ export declare class HTMLPercentRenderer extends HTMLNumberRenderer {
 }
 export declare class PercentRendererFactory extends RendererFactory<PercentRenderOptions> {
     static readonly instance: PercentRendererFactory;
-    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, _options: PercentRenderOptions): Renderer;
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: PercentRenderOptions): Renderer;
     get rendererName(): string;
 }

package/dist/html/percent.js

@@ -35,8 +35,8 @@ class HTMLPercentRenderer extends number_1.HTMLNumberRenderer {
 }
 exports.HTMLPercentRenderer = HTMLPercentRenderer;
 class PercentRendererFactory extends renderer_factory_1.RendererFactory {
-    create(document, _styleDefaults, _rendererOptions, _field, _options) {
-        return new HTMLPercentRenderer(document);
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLPercentRenderer(document, options);
     }
     get rendererName() {
         return 'percent';

package/dist/main_renderer_factory.d.ts

@@ -25,8 +25,9 @@ import { BooleanRendererFactory } from './html/boolean';
 import { LinkRendererFactory } from './html/link';
 import { UnsupportedRendererFactory } from './html/unsupported';
 import { TextRendererFactory } from './html/text';
+import { DataVolumeRendererFactory } from './html/data_volume';
 export declare class MainRendererFactory {
-    static renderFactories: (JSONRendererFactory | TextRendererFactory | NumberRendererFactory | ShapeMapRendererFactory | PointMapRendererFactory | ImageRendererFactory | SegmentMapRendererFactory | VegaRendererFactory | LineChartRendererFactory | SparkLineRendererFactory | BarChartRendererFactory | BarSparkLineRendererFactory | AreaSparkLineRendererFactory | ColumnSparkLineRendererFactory | ScatterChartRendererFactory | DateRendererFactory | CurrencyRendererFactory | PercentRendererFactory | BytesRendererFactory | BooleanRendererFactory | LinkRendererFactory | UnsupportedRendererFactory)[];
+    static renderFactories: (JSONRendererFactory | TextRendererFactory | NumberRendererFactory | ShapeMapRendererFactory | PointMapRendererFactory | ImageRendererFactory | SegmentMapRendererFactory | VegaRendererFactory | LineChartRendererFactory | SparkLineRendererFactory | BarChartRendererFactory | BarSparkLineRendererFactory | AreaSparkLineRendererFactory | ColumnSparkLineRendererFactory | ScatterChartRendererFactory | DateRendererFactory | CurrencyRendererFactory | PercentRendererFactory | BytesRendererFactory | BooleanRendererFactory | LinkRendererFactory | UnsupportedRendererFactory | DataVolumeRendererFactory)[];
     create(renderDef: RenderDef | undefined, tags: MalloyTags | undefined, document: Document, styleDefaults: StyleDefaults, rendererOptions: RendererOptions, field: Field | Explore, timezone?: string | undefined): Renderer | undefined;
     matchesRenderDef(renderDef: RenderDef | undefined, factory: RendererFactory<DataRenderOptions>): boolean | "" | undefined;
     matchesTag(properties: MalloyTagProperties, factory: RendererFactory<DataRenderOptions>): string | boolean | undefined;

package/dist/main_renderer_factory.js

@@ -23,6 +23,7 @@ const boolean_1 = require("./html/boolean");
 const link_1 = require("./html/link");
 const unsupported_1 = require("./html/unsupported");
 const text_1 = require("./html/text");
+const data_volume_1 = require("./html/data_volume");
 class MainRendererFactory {
     create(renderDef, tags, document, styleDefaults, rendererOptions, field, timezone) {
         var _a;
@@ -68,11 +69,12 @@ MainRendererFactory.renderFactories = [
     date_1.DateRendererFactory.instance,
     currency_1.CurrencyRendererFactory.instance,
     percent_1.PercentRendererFactory.instance,
-    number_1.NumberRendererFactory.instance,
+    data_volume_1.DataVolumeRendererFactory.instance,
     bytes_1.BytesRendererFactory.instance,
-    boolean_1.BooleanRendererFactory.instance,
     link_1.LinkRendererFactory.instance,
     unsupported_1.UnsupportedRendererFactory.instance,
+    boolean_1.BooleanRendererFactory.instance,
+    number_1.NumberRendererFactory.instance,
     text_1.TextRendererFactory.instance,
 ];
 //# sourceMappingURL=main_renderer_factory.js.map

package/dist/renderer_factory.d.ts

@@ -2,11 +2,15 @@ import { Explore, Field, MalloyTagProperties } from '@malloydata/malloy';
 import { Renderer } from './renderer';
 import { DataRenderOptions, RenderDef, StyleDefaults } from './data_styles';
 import { RendererOptions } from './renderer_types';
+declare type TagPropertyExtractor<T extends DataRenderOptions> = (options: T, extractedValue: string) => void;
 export declare abstract class RendererFactory<T extends DataRenderOptions> {
+    readonly tagOptionExtractors: Record<string, TagPropertyExtractor<T>>;
+    protected addExtractor(extractor: TagPropertyExtractor<T>, ...tags: string[]): void;
     activates(_field: Field | Explore): boolean;
     isValidMatch(_field: Field | Explore): boolean;
     matches(renderDef: RenderDef): boolean;
-    parseTagParameters(_tags: MalloyTagProperties): T | undefined;
+    parseTagParameters(tagProperties: MalloyTagProperties): T;
     abstract get rendererName(): string | undefined;
     abstract create(document: Document, styleDefaults: StyleDefaults, rendererOptions: RendererOptions, field: Field | Explore, renderOptions: T, timezone?: string): Renderer;
 }
+export {};

package/dist/renderer_factory.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RendererFactory = void 0;
 class RendererFactory {
+    constructor() {
+        this.tagOptionExtractors = {};
+    }
+    addExtractor(extractor, ...tags) {
+        for (const tag in tags) {
+            if (tag) {
+                this.tagOptionExtractors[tag] = extractor;
+            }
+        }
+    }
     activates(_field) {
         // Does not activate by default.
         return false;
@@ -12,8 +22,14 @@ class RendererFactory {
     matches(renderDef) {
         return renderDef.renderer === this.rendererName;
     }
-    parseTagParameters(_tags) {
-        return undefined;
+    parseTagParameters(tagProperties) {
+        const options = {};
+        for (const tag in this.tagOptionExtractors) {
+            if (tagProperties[tag] !== undefined &&
+                typeof tagProperties[tag] === 'string')
+                this.tagOptionExtractors[tag](options, tagProperties[tag]);
+        }
+        return options;
     }
 }
 exports.RendererFactory = RendererFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/render",
-  "version": "0.0.51-dev230705184641",
+  "version": "0.0.51-dev230705224132",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,10 +18,11 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@malloydata/malloy": "^0.0.51-dev230705184641",
+    "@malloydata/malloy": "^0.0.51-dev230705224132",
     "@types/luxon": "^2.4.0",
     "lodash": "^4.17.20",
     "luxon": "^2.4.0",
+    "numfmt": "^2.5.1",
     "us-atlas": "^3.0.0",
     "vega": "^5.21.0",
     "vega-lite": "^5.2.0"