@malloydata/render 0.0.53 → 0.0.54-dev230706184155

package/dist/data_styles.d.ts

@@ -94,6 +94,16 @@ export interface TimeRenderOptions extends TextRenderOptions {
 export interface NumberRenderOptions extends TextRenderOptions {
     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/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,94 @@
+"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()) {
+            throw new Error(`Cannot format field ${data.field.name} as data volume since its not a number`);
+        }
+        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;
+            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/text.js

@@ -33,7 +33,13 @@ class HTMLTextRenderer {
         return data.value === null ? null : `${data.value}`;
     }
     async render(data) {
-        const text = this.getText(data);
+        let text = null;
+        try {
+            text = this.getText(data);
+        }
+        catch (e) {
+            (0, utils_1.createErrorElement)(this.document, e);
+        }
         if (text === null) {
             return (0, utils_1.createNullElement)(this.document);
         }

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,10 +69,11 @@ 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,
+    boolean_1.BooleanRendererFactory.instance,
+    number_1.NumberRendererFactory.instance,
     unsupported_1.UnsupportedRendererFactory.instance,
     text_1.TextRendererFactory.instance,
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/render",
-  "version": "0.0.53",
+  "version": "0.0.54-dev230706184155",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@malloydata/malloy": "^0.0.53",
+    "@malloydata/malloy": "^0.0.54-dev230706184155",
     "@types/luxon": "^2.4.0",
     "lodash": "^4.17.20",
     "luxon": "^2.4.0",