@malloydata/render 0.0.56-dev230710183220 → 0.0.56-dev230710205111

package/dist/data_styles.d.ts

@@ -104,6 +104,18 @@ export declare enum DataVolumeUnit {
 export interface DataVolumeRenderOptions extends TextRenderOptions {
     data_volume_unit?: DataVolumeUnit;
 }
+export declare enum DurationUnit {
+    Nanoseconds = "nanoseconds",
+    Microseconds = "microseconds",
+    Milliseconds = "milliseconds",
+    Seconds = "seconds",
+    Minutes = "minutes",
+    Hours = "hours",
+    Days = "days"
+}
+export interface DurationRenderOptions extends TextRenderOptions {
+    duration_unit?: DurationUnit;
+}
 export interface ImageRenderOptions extends TextRenderOptions {
     border?: boolean;
 }

package/dist/data_styles.js

@@ -22,7 +22,7 @@
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataVolumeUnit = exports.Currency = void 0;
+exports.DurationUnit = exports.DataVolumeUnit = exports.Currency = void 0;
 var Currency;
 (function (Currency) {
     Currency["Dollars"] = "usd";
@@ -37,4 +37,14 @@ var DataVolumeUnit;
     DataVolumeUnit["Gigabytes"] = "gb";
     DataVolumeUnit["Terabytes"] = "tb";
 })(DataVolumeUnit = exports.DataVolumeUnit || (exports.DataVolumeUnit = {}));
+var DurationUnit;
+(function (DurationUnit) {
+    DurationUnit["Nanoseconds"] = "nanoseconds";
+    DurationUnit["Microseconds"] = "microseconds";
+    DurationUnit["Milliseconds"] = "milliseconds";
+    DurationUnit["Seconds"] = "seconds";
+    DurationUnit["Minutes"] = "minutes";
+    DurationUnit["Hours"] = "hours";
+    DurationUnit["Days"] = "days";
+})(DurationUnit = exports.DurationUnit || (exports.DurationUnit = {}));
 //# sourceMappingURL=data_styles.js.map

package/dist/html/duration.d.ts

@@ -0,0 +1,19 @@
+import { DataColumn, Explore, Field } from '@malloydata/malloy';
+import { HTMLTextRenderer } from './text';
+import { DurationRenderOptions, DurationUnit, StyleDefaults } from '../data_styles';
+import { RendererOptions } from '../renderer_types';
+import { Renderer } from '../renderer';
+import { RendererFactory } from '../renderer_factory';
+export declare class HTMLDurationRenderer extends HTMLTextRenderer {
+    readonly options: DurationRenderOptions;
+    constructor(document: Document, options: DurationRenderOptions);
+    static multiplierMap: Map<DurationUnit, number>;
+    getText(data: DataColumn): string | null;
+    formatTimeUnit(value: number, unit: DurationUnit): string;
+}
+export declare class DurationRendererFactory extends RendererFactory<DurationRenderOptions> {
+    static readonly instance: DurationRendererFactory;
+    constructor();
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: DurationRenderOptions): Renderer;
+    get rendererName(): string;
+}

package/dist/html/duration.js

@@ -0,0 +1,107 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DurationRendererFactory = exports.HTMLDurationRenderer = void 0;
+const text_1 = require("./text");
+const data_styles_1 = require("../data_styles");
+const renderer_factory_1 = require("../renderer_factory");
+class HTMLDurationRenderer extends text_1.HTMLTextRenderer {
+    constructor(document, options) {
+        super(document);
+        this.options = options;
+    }
+    getText(data) {
+        var _a;
+        if (data.isNull()) {
+            return null;
+        }
+        if (!data.isNumber()) {
+            throw new Error(`Cannot format field ${data.field.name} as a duration unit since its not a number`);
+        }
+        const targetUnit = (_a = this.options.duration_unit) !== null && _a !== void 0 ? _a : data_styles_1.DurationUnit.Seconds;
+        let currentDuration = data.number.value;
+        let currentUnitValue = 0;
+        let durationParts = [];
+        let foundUnit = false;
+        for (const [unit, multiplier] of HTMLDurationRenderer.multiplierMap) {
+            if (unit === targetUnit) {
+                foundUnit = true;
+            }
+            if (!foundUnit) {
+                continue;
+            }
+            currentUnitValue = currentDuration % multiplier;
+            currentDuration = Math.floor((currentDuration /= multiplier));
+            if (currentUnitValue > 0) {
+                durationParts = [
+                    this.formatTimeUnit(currentUnitValue, unit),
+                    ...durationParts,
+                ];
+            }
+            if (currentDuration === 0) {
+                break;
+            }
+        }
+        if (durationParts.length > 0) {
+            return durationParts.slice(0, 2).join(' ');
+        }
+        return this.formatTimeUnit(0, targetUnit);
+    }
+    formatTimeUnit(value, unit) {
+        let unitString = unit.toString();
+        if (value === 1) {
+            unitString = unitString.substring(0, unitString.length - 1);
+        }
+        return `${value} ${unitString}`;
+    }
+}
+exports.HTMLDurationRenderer = HTMLDurationRenderer;
+// Map of unit to how many units of the make up the following time unit.
+HTMLDurationRenderer.multiplierMap = new Map([
+    [data_styles_1.DurationUnit.Nanoseconds, 1000],
+    [data_styles_1.DurationUnit.Microseconds, 1000],
+    [data_styles_1.DurationUnit.Milliseconds, 1000],
+    [data_styles_1.DurationUnit.Seconds, 60],
+    [data_styles_1.DurationUnit.Minutes, 60],
+    [data_styles_1.DurationUnit.Hours, 24],
+    [data_styles_1.DurationUnit.Days, Number.MAX_VALUE],
+]);
+class DurationRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            var _a;
+            options.duration_unit = (_a = value) !== null && _a !== void 0 ? _a : data_styles_1.DurationUnit.Seconds;
+        }, this.rendererName);
+    }
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLDurationRenderer(document, options);
+    }
+    get rendererName() {
+        return 'duration';
+    }
+}
+exports.DurationRendererFactory = DurationRendererFactory;
+DurationRendererFactory.instance = new DurationRendererFactory();
+//# sourceMappingURL=duration.js.map

package/dist/html/number.d.ts

@@ -7,7 +7,6 @@ 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> {

package/dist/html/number.js

@@ -35,7 +35,7 @@ class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
         super(document);
         this.options = options;
     }
-    getNumber(data) {
+    getText(data) {
         if (data.isNull()) {
             return null;
         }
@@ -45,14 +45,10 @@ class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
             }
             catch {
                 // TODO: explore surfacing invalid format error, ignoring it for now.
-                return data.number.value;
+                throw new Error(`Invalid value format: ${this.options.value_format}`);
             }
         }
-        return data.number.value;
-    }
-    getText(data) {
-        const num = this.getNumber(data);
-        return num === null ? num : num.toLocaleString();
+        return data.number.value.toLocaleString();
     }
 }
 exports.HTMLNumberRenderer = HTMLNumberRenderer;

package/dist/html/percent.js

@@ -27,7 +27,10 @@ const number_1 = require("./number");
 const renderer_factory_1 = require("../renderer_factory");
 class HTMLPercentRenderer extends number_1.HTMLNumberRenderer {
     getText(data) {
-        const num = this.getNumber(data);
+        if (data.isNull()) {
+            return null;
+        }
+        const num = data.number.value;
         return num === null
             ? num
             : (num * 100).toLocaleString('en', { maximumFractionDigits: 2 }) + '%';

package/dist/html/text.js

@@ -38,7 +38,7 @@ class HTMLTextRenderer {
             text = this.getText(data);
         }
         catch (e) {
-            (0, utils_1.createErrorElement)(this.document, e);
+            return (0, utils_1.createErrorElement)(this.document, e);
         }
         if (text === null) {
             return (0, utils_1.createNullElement)(this.document);

package/dist/main_renderer_factory.d.ts

@@ -26,8 +26,9 @@ import { LinkRendererFactory } from './html/link';
 import { UnsupportedRendererFactory } from './html/unsupported';
 import { TextRendererFactory } from './html/text';
 import { DataVolumeRendererFactory } from './html/data_volume';
+import { DurationRendererFactory } from './html/duration';
 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 | DataVolumeRendererFactory)[];
+    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 | DurationRendererFactory)[];
     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

@@ -24,6 +24,7 @@ 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");
+const duration_1 = require("./html/duration");
 class MainRendererFactory {
     create(renderDef, tags, document, styleDefaults, rendererOptions, field, timezone) {
         var _a;
@@ -72,6 +73,7 @@ MainRendererFactory.renderFactories = [
     data_volume_1.DataVolumeRendererFactory.instance,
     bytes_1.BytesRendererFactory.instance,
     link_1.LinkRendererFactory.instance,
+    duration_1.DurationRendererFactory.instance,
     boolean_1.BooleanRendererFactory.instance,
     number_1.NumberRendererFactory.instance,
     unsupported_1.UnsupportedRendererFactory.instance,

package/dist/renderer_factory.d.ts

@@ -2,7 +2,7 @@ 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;
+declare type TagPropertyExtractor<T extends DataRenderOptions> = (options: T, extractedValue: string | undefined) => void;
 export declare abstract class RendererFactory<T extends DataRenderOptions> {
     readonly tagOptionExtractors: Record<string, TagPropertyExtractor<T>>;
     protected addExtractor(extractor: TagPropertyExtractor<T>, ...tags: string[]): void;

package/dist/renderer_factory.js

@@ -23,9 +23,13 @@ class RendererFactory {
     parseTagParameters(tagProperties) {
         const options = {};
         for (const tag in this.tagOptionExtractors) {
-            if (tagProperties[tag] !== undefined &&
-                typeof tagProperties[tag] === 'string')
-                this.tagOptionExtractors[tag](options, tagProperties[tag]);
+            let tagValue = undefined;
+            if (tagProperties[tag]) {
+                if (typeof tagProperties[tag] === 'string') {
+                    tagValue = tagProperties[tag];
+                }
+                this.tagOptionExtractors[tag](options, tagValue);
+            }
         }
         return options;
     }

package/package.json

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