@trakit/objects 0.0.6 → 0.0.7

package/_publish/objects/Hosting/Fields/FormFieldBase.d.ts

@@ -1,56 +0,0 @@
-import { IIdUlong } from '../../API/Interfaces/IIdUlong';
-import { INamed } from '../../API/Interfaces/INamed';
-import { ISerializable } from '../../API/Interfaces/ISerializable';
-import { JsonObject, nothing, ulong } from '../../API/Types';
-import { FormFieldType } from '../FormFieldType';
-/**
- * A base class for the common form field UI members.
- */
-export declare abstract class FormFieldBase implements IIdUlong, INamed, ISerializable {
-    /**
-     * Instantiates a form field subclass based on the `kind` property in the JSON.
-     * Implementation is in {@link FormFieldBase_fromJSON.ts}
-     * @param json	The JSON to parse.
-     * @returns		An instance of a form field subclass, or null if the JSON is null or does not contain a recognized "kind" property.
-     */
-    static fromJSON: (json: JsonObject) => FormFieldBase;
-    /**
-     * A list of supported {@link FormFieldType}s that this class supports.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The type of interface control that should be presented to the user.
-     */
-    kind: FormFieldType;
-    /**
-     * Identifier for this field.
-     * This value is unique per {@link FormTemplate}, but is not unique system-wide.
-     */
-    id: ulong;
-    /**
-     * Name of the field.
-     */
-    name: string;
-    /**
-     * Notes or special instructions for this control.
-     */
-    notes: string;
-    /**
-     * When true, a valid value must be given for this field.
-     */
-    required: boolean;
-    /**
-     * The default value for the field in the template.
-     */
-    value: string | null;
-    /**
-     * When false, this field's value is treated as read-only.
-     */
-    editable: boolean;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): JsonObject;
-    /**
-     * Returns true if the value can be parsed by the field type.
-     */
-    abstract isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldBase_fromJSON.d.ts

@@ -1 +0,0 @@
-export {};

package/_publish/objects/Hosting/Fields/FormFieldBoolean.d.ts

@@ -1,38 +0,0 @@
-import { nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A true/false (or either-or) input control.
- * @tutorial
- * For choices, the field definition will be an array of three values.
- * The first value is the "true", second is the "false", and third is "indeterminate".
- * For example:
- * - "true", "false", ""
- * - "on", "off", "unknown"
- * - "yes", "no", "maybe"
- */
-export declare class FormFieldBoolean extends FormFieldBase {
-    /**
-     * If no choices are given, then these choices are used.
-     */
-    static readonly DEFAULT_CHOICES: [string, string, string];
-    /**
-     * Returns an array of 3 strings representing the checked, unchecked, and indeterminate values.
-     * @param choices
-     */
-    static normalize(choices?: (string | nothing)[] | nothing): [string, string, string];
-    /**
-     * These are the boolean control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * These three values are the values of the choices presented.
-     * The first value is the "checked" value, second is the "unchecked" value, and third is "indeterminate" value.
-     */
-    choices: [string, string, string];
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: (string | nothing)[] | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        choices: string[];
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldChoice.d.ts

@@ -1,46 +0,0 @@
-import { byte, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A single- or multiple-choice input control.
- */
-export declare class FormFieldChoice extends FormFieldBase {
-    /**
-     * Splits the given value using commas (so long as the comma did not get escaped).
-     * @param values
-     */
-    static split(values: string): string[];
-    /**
-     * Replaces all the commas in a given value with backslash-comma.
-     * @param value
-     */
-    static escape(value: string): string;
-    /**
-     * Replaces all the commas in a given value with backslash-comma.
-     * @param value
-     */
-    static unescape(value: string): string;
-    /**
-     * Just {@link FormFieldType.choice} control type.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The list of choices available and their values.
-     */
-    choices: Map<string, string>;
-    /**
-     * Minimum number of choices that must be selected.
-     */
-    minimum: byte;
-    /**
-     * Maximum number of choices that must be selected.
-     */
-    maximum: byte;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: Map<string, string> | nothing, minimum?: byte | nothing, maximum?: byte | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        choices: import("../../..").JsonObject;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldDate.d.ts

@@ -1,26 +0,0 @@
-import { datetime, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A control to choose a date and (optionally) a time.
- */
-export declare class FormFieldDate extends FormFieldBase {
-    /**
-     * These are the calendar control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The earliest date or date/time.
-     */
-    minimum: Date;
-    /**
-     * The latest date or date/time.
-     */
-    maximum: Date;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: Date | number | datetime | nothing, maximum?: Date | number | datetime | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        minimum: string | null;
-        maximum: string | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldNumeric.d.ts

@@ -1,54 +0,0 @@
-import { byte, double, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-import { FormFieldNumericSize } from "./FormFieldNumericSize";
-/**
- * A numeric value input control with multiple contexts available.
- * @tutorial
- * For this field, the {@link FormFieldBase.kind} is just a helper for the UI, and does not affect input validation.
- */
-export declare class FormFieldNumeric extends FormFieldBase {
-    /**
-     * These are the numeric control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * A context hint for the kind of numeric size for this field.
-     * Used only for {@link FormFieldType.distance}, {@link FormFieldType.weight}, {@link FormFieldType.volume},
-     * and {@link FormFieldType.speed}.
-     */
-    size: FormFieldNumericSize;
-    /**
-     * Number of decimal places of accuracy are required.
-     */
-    precision: byte;
-    /**
-     * The numeric value increments by this amount.
-     */
-    step: double;
-    /**
-     * An optional suffix for this numeric value, like "%" or "ppm".
-     * This value is ignored for {@link FormFieldType.distance}, {@link FormFieldType.weight},
-     *  {@link FormFieldType.volume}, {@link FormFieldType.speed}, and {@link FormFieldType.area} field types.
-     * And for {@link FormFieldType.currency} fields it acts as a prefix, like "$" or "USD".
-     */
-    units: string;
-    /**
-     * The (optional) minimum value.
-     */
-    minimum: double;
-    /**
-     * The (optional) maximum value.
-     */
-    maximum: double;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, size?: FormFieldNumericSize | nothing, precision?: byte | nothing, step?: double | nothing, units?: string | nothing, minimum?: double | nothing, maximum?: double | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        size: FormFieldNumericSize;
-        precision: number | null;
-        step: number | null;
-        units: string;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldNumericSize.d.ts

@@ -1,32 +0,0 @@
-/**
- * A context hint for the size of a measurements.
- */
-export declare enum FormFieldNumericSize {
-    /**
-     * A small measurement.
-     * For {@link FormFieldType.distance}: {@link Units.CENTIMETER}/{@link Units.INCH}
-     * For {@link FormFieldType.weight}: {@link Units.GRAM}/{@link Units.OUNCE}
-     * For {@link FormFieldType.volume}: {@link Units.MILLILITER}/{@link Units.OUNCE}
-     * For {@link FormFieldType.speed}: {@link Units.CENTIMETER_PER_SECOND}/{@link Units.INCH_PER_SECOND}
-     * For {@link FormFieldType.area}: {@link Units.SQUARE_METRE}/{@link Units.SQUARE_FOOT}
-     */
-    small = "small",
-    /**
-     * A medium measurement.
-     * For {@link FormFieldType.distance}: {@link Units.METER}/{@link Units.FOOT}
-     * For {@link FormFieldType.weight}: {@link Units.KILOGRAM}/{@link Units.POUND}
-     * For {@link FormFieldType.volume}: same as {@link FormFieldNumericSize.small}
-     * For {@link FormFieldType.speed}: {@link Units.METER_PER_SECOND}/{@link Units.FOOT_PER_SECOND}
-     * For {@link FormFieldType.area}: {@link Units.SQUARE_KILOMETRE}/{@link Units.SQUARE_MILE}
-     */
-    medium = "medium",
-    /**
-     * A large measurement.
-     * For {@link FormFieldType.distance}: {@link Units.KILOMETER}/{@link Units.MILE}
-     * For {@link FormFieldType.weight}: {@link Units.TONNE}/{@link Units.TON}
-     * For {@link FormFieldType.volume}: {@link Units.LITER}/{@link Units.GALLON}
-     * For {@link FormFieldType.speed}: {@link Units.KILOMETER_PER_HOUR}/{@link Units.MILE_PER_HOUR}
-     * For {@link FormFieldType.area}: {@link Units.HECTARE}/{@link Units.ACRE}
-     */
-    large = "large"
-}

package/_publish/objects/Hosting/Fields/FormFieldSignature.d.ts

@@ -1,17 +0,0 @@
-import { nothing, ulong } from '../../API/Types';
-import { FormFieldType } from '../FormFieldType';
-import { FormFieldBase } from './FormFieldBase';
-/**
- * A control to capture a signature from the user.
- * @tutorial
- * The device making the capture must save the image to the server some other way.
- * When submitting the {@link FormResult}, the value must be a path to the signature file.
- */
-export declare class FormFieldSignature extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.signature} control type.
-     */
-    protected get supported(): FormFieldType[];
-    constructor(id?: ulong | nothing, name?: string | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldText.d.ts

@@ -1,32 +0,0 @@
-import { byte, nothing, ulong, ushort } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A text input control.
- */
-export declare class FormFieldText extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.text} control type.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The number of rows of text to display.
-     * @tutorial The control should grow to display all entered text even if the UI must add more rows.
-     */
-    rows: byte;
-    /**
-     * Minimum length of entered text to make it a valid entry.
-     */
-    minimum: ushort;
-    /**
-     * Maximum length of entered text to make it a valid entry.
-     */
-    maximum: ushort;
-    constructor(id?: ulong | nothing, name?: string | nothing, rows?: byte | nothing, minimum?: ushort | nothing, maximum?: ushort | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        rows: number | null;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldTime.d.ts

@@ -1,37 +0,0 @@
-import { TimeSpan } from "../../API/TimeSpan";
-import { nothing, timespan, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A control to choose a time or duration longer than 24 hours.
- */
-export declare class FormFieldTime extends FormFieldBase {
-    /**
-     * For a 24 hour day, anything negative span would be considered invalid.
-     * As such, the minimum time for a {@link FormFieldType.time} is midnight (zero).
-     */
-    static readonly MINIMUM_TIME_OF_DAY: TimeSpan;
-    /**
-     * For a 24 hour day, anything over a 24 hour span would be considered invalid.
-     * As such, the maximum time for a {@link FormFieldType.time} is midnight the next day.
-     */
-    static readonly MAXIMUM_TIME_OF_DAY: TimeSpan;
-    /**
-     * These are the clock control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The minimum duration or earliest time-of-day.
-     */
-    minimum: TimeSpan | null;
-    /**
-     * The maximum duration or latest time-of-day.
-     */
-    maximum: TimeSpan | null;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: TimeSpan | timespan | number | nothing, maximum?: TimeSpan | timespan | number | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        minimum: string | null;
-        maximum: string | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldTimezone.d.ts

@@ -1,14 +0,0 @@
-import { nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A {@link Timezone} selection control.
- */
-export declare class FormFieldTimezone extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.timezone} control type.
-     */
-    protected get supported(): FormFieldType[];
-    constructor(id?: ulong | nothing, name?: string | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/FormFieldType.d.ts

@@ -1,127 +0,0 @@
-/**
- * The supported types of user interface modules for a {@link FormTemplate}.
- */
-export declare enum FormFieldType {
-    /**
-     * Any text input.
-     * {@link FormFieldText}
-     */
-    text = "text",
-    /**
-     * A choice of one (or more) values defined.
-     * {@link FormFieldChoice}
-     */
-    choice = "choice",
-    /**
-     * A drop-down or fly-out UI for choosing a single value.
-     * Works better than {@link choice} when there are a lot of values. ie; country or province list.
-     * {@link FormFieldChoice}
-     */
-    dropdown = "dropdown",
-    /**
-     * A check mark to represent a boolean value.
-     * {@link FormFieldBoolean}
-     */
-    checkbox = "checkbox",
-    /**
-     * A toggle box to represent one of two possible values (optionally defined).
-     * {@link FormFieldBoolean}
-     */
-    toggle = "toggle",
-    /**
-     * Numeric (optionally decimal) input.
-     * {@link FormFieldNumeric}
-     */
-    numeric = "numeric",
-    /**
-     * A slider bar to choose a numeric value between a given high and low value.
-     * {@link FormFieldNumeric}
-     */
-    range = "range",
-    /**
-     * A numeric value of distance (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    distance = "distance",
-    /**
-     * A numeric value of area (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    area = "area",
-    /**
-     * A numeric value of temperature (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    temperature = "temperature",
-    /**
-     * A numeric value of weight (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    weight = "weight",
-    /**
-     * A numeric value of volume (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    volume = "volume",
-    /**
-     * A numeric value of pressure (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    pressure = "pressure",
-    /**
-     * A numeric value of speed (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    speed = "speed",
-    /**
-     * A numeric value of fuel economy (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    fuelEconomy = "fuelEconomy",
-    /**
-     * A numeric value representing an amount of money.
-     * {@link FormFieldNumeric}
-     */
-    currency = "currency",
-    /**
-     * A date and time picker.
-     * {@link FormFieldDate}
-     */
-    datetime = "datetime",
-    /**
-     * A calendar/date picker.
-     * {@link FormFieldDate}
-     */
-    date = "date",
-    /**
-     * A clock/time picker.
-     * {@link FormFieldTime}
-     */
-    time = "time",
-    /**
-     * A duration picker.
-     * Different than {@link time} because a duration can be negative, or longer than 24 hours.
-     * {@link FormFieldTime}
-     */
-    duration = "duration",
-    /**
-     * Area to capture a signature bitmap.
-     * {@link FormFieldSignature}
-     */
-    signature = "signature",
-    /**
-     * A browser of {@link Picture}s that can be attached.
-     * {@link FormFieldAttachments}
-     */
-    pictures = "pictures",
-    /**
-     * A browser of {@link Document}s that can be attached.
-     * {@link FormFieldAttachments}
-     */
-    files = "files",
-    /**
-     * A list of {@link Timezone}s.
-     * {@link FormFieldTimezone}
-     */
-    timezone = "timezone"
-}

package/_publish/objects/Hosting/FormResult.d.ts

@@ -1,95 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { LatLng } from "../API/Geography/LatLng";
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { ILabelled } from "../API/Interfaces/ILabelled";
-import { INamed } from "../API/Interfaces/INamed";
-import { codified, ulong, JsonObject } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { FormTemplate } from "./FormTemplate";
-/**
- * A completed form submitted by a {@link User} or {@link Asset}.
- */
-export declare class FormResult extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, ILabelled {
-    /**
-     * Unique identifier of this form.
-     */
-    id: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     */
-    get company(): Company;
-    /**
-     * The {@link FormTemplate} to which this form belongs.
-     */
-    templateId: ulong;
-    /**
-     * The {@link FormTemplate} to which this form belongs.
-     */
-    get template(): FormTemplate;
-    set template(value: FormTemplate);
-    /**
-     * The {@link Asset} to which this form belongs.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The {@link Asset} to which this form belongs.
-     */
-    get asset(): Asset;
-    /**
-     * Name of this form.
-     */
-    name: string;
-    /**
-     * Notes about this form.
-     */
-    notes: string;
-    /**
-     * Codified label names used to relate forms to {@link Asset}s.
-     */
-    labels: codified[];
-    /**
-     * All the values for fillable fields by index.
-     */
-    fields: Map<ulong, string>;
-    /**
-     * A timestamp from when this form was completed by a {@link User} or {@link Asset}.
-     */
-    completed: Date;
-    /**
-     * The coordinates of the {@link User} or {@link Asset} from when the form was completed.
-     */
-    latlng: LatLng | null;
-    /**
-     * Clocked-in driver name who made the update.
-     * Null if not clocked-in, or no changes have been made.
-     */
-    driver: string;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-    toJSON(): {
-        id: number;
-        company: number;
-        v: number[];
-        template: number | null;
-        asset: number | null;
-        name: string;
-        notes: string;
-        labels: string[];
-        fields: JsonObject;
-        completed: string | null;
-        latlng: import("../API/Geography/Interfaces").ILatLng | null;
-        driver: string | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Hosting/FormTemplate.d.ts

@@ -1,80 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { ILabelled } from "../API/Interfaces/ILabelled";
-import { INamed } from "../API/Interfaces/INamed";
-import { IVisual } from "../API/Interfaces/IVisual";
-import { codified, colour, ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { FormFieldAttachments } from './Fields/FormFieldAttachments';
-import { FormFieldBoolean } from './Fields/FormFieldBoolean';
-import { FormFieldChoice } from './Fields/FormFieldChoice';
-import { FormFieldDate } from './Fields/FormFieldDate';
-import { FormFieldNumeric } from './Fields/FormFieldNumeric';
-import { FormFieldSignature } from './Fields/FormFieldSignature';
-import { FormFieldText } from './Fields/FormFieldText';
-import { FormFieldTime } from './Fields/FormFieldTime';
-import { FormFieldTimezone } from './Fields/FormFieldTimezone';
-/**
- * The full definition of a form that needs to be filled out.
- */
-export declare class FormTemplate extends BaseComponent implements IIdUlong, INamed, IBelongCompany, ILabelled, IVisual {
-    /**
-     * Unique identifier of this form.
-     */
-    id: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     */
-    get company(): Company;
-    /**
-     * Name of this form.
-     */
-    name: string;
-    /**
-     * Notes about this form.
-     */
-    notes: string;
-    /**
-     * Codified label names used to relate forms to {@link Asset}s.
-     */
-    labels: codified[];
-    /**
-     * The fill/background colour of the icon.
-     */
-    fill: colour;
-    /**
-     * Outline and graphic colour.
-     */
-    stroke: colour;
-    /**
-     * The name of the symbol for this template.
-     */
-    graphic: codified;
-    /**
-     * All the user fillable fields by name.
-     */
-    fields: (FormFieldText | FormFieldChoice | FormFieldBoolean | FormFieldNumeric | FormFieldDate | FormFieldTime | FormFieldSignature | FormFieldAttachments | FormFieldTimezone)[];
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-    toJSON(): {
-        id: number | null;
-        company: number | null;
-        v: number[];
-        name: string;
-        notes: string;
-        labels: string[];
-        fields: any[];
-        fill: string;
-        stroke: string;
-        graphic: string;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}