@trackunit/iris-app-api 0.0.131 → 0.0.132

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.0.132](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.131...iris-app-api/0.0.132) (2023-11-15)
+
 ## [0.0.131](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.130...iris-app-api/0.0.131) (2023-11-14)
 
 ## [0.0.130](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.129...iris-app-api/0.0.130) (2023-11-13)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-api",
-  "version": "0.0.131",
+  "version": "0.0.132",
   "license": "SEE LICENSE IN LICENSE.txt",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {

package/src/types/irisAppCustomFields.d.ts

@@ -57,56 +57,58 @@ export interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {
      */
     valueReplacements?: Record<string, string>;
 }
-export declare enum UnitUs {
-    acre = "acre",
-    foot = "foot",
-    square_foot = "square_foot",
-    cubic_foot = "cubic_foot",
-    gallon_liquid = "gallon_liquid",
-    inch = "inch",
-    pound = "pound",
-    pound_per_hour = "pound_per_hour",
-    pound_per_second = "pound_per_second",
-    mile = "mile",
-    mile_per_hour = "mile_per_hour",
-    ounce = "ounce",
-    ton_us = "ton_us",
-    yard = "yard",
-    pound_per_square_inch = "pound_per_square_inch"
-}
-export declare enum UnitSi {
-    newton = "newton",
-    pascal = "pascal",
-    kilopascal = "kilopascal",
-    watt = "watt",
-    bar = "bar",
-    centimetre = "centimetre",
-    millimetre = "millimetre",
-    metre = "metre",
-    kilometre = "kilometre",
-    gram = "gram",
-    kilogram = "kilogram",
-    kilowatt = "kilowatt",
-    kilowatthour = "kilowatthour",
-    kilogram_per_hour = "kilogram_per_hour",
-    kilogram_per_second = "kilogram_per_second",
-    square_kilometre = "square_kilometre",
-    kilometre_per_hour = "kilometre_per_hour",
-    litre = "litre",
-    square_metre = "square_metre",
-    cubic_metre = "cubic_metre",
-    metre_per_second = "metre_per_second",
-    metre_per_second_squared = "metre_per_second_squared",
-    ton = "ton",
-    hectare = "hectare",
-    hour = "hour"
-}
+export declare const UnitUs: {
+    readonly acre: "acre";
+    readonly foot: "foot";
+    readonly square_foot: "square_foot";
+    readonly cubic_foot: "cubic_foot";
+    readonly gallon_liquid: "gallon_liquid";
+    readonly inch: "inch";
+    readonly pound: "pound";
+    readonly pound_per_hour: "pound_per_hour";
+    readonly pound_per_second: "pound_per_second";
+    readonly mile: "mile";
+    readonly mile_per_hour: "mile_per_hour";
+    readonly ounce: "ounce";
+    readonly ton_us: "ton_us";
+    readonly yard: "yard";
+    readonly pound_per_square_inch: "pound_per_square_inch";
+};
+export type UnitUsType = (typeof UnitUs)[keyof typeof UnitUs];
+export declare const UnitSi: {
+    readonly newton: "newton";
+    readonly pascal: "pascal";
+    readonly kilopascal: "kilopascal";
+    readonly watt: "watt";
+    readonly bar: "bar";
+    readonly centimetre: "centimetre";
+    readonly millimetre: "millimetre";
+    readonly metre: "metre";
+    readonly kilometre: "kilometre";
+    readonly gram: "gram";
+    readonly kilogram: "kilogram";
+    readonly kilowatt: "kilowatt";
+    readonly kilowatthour: "kilowatthour";
+    readonly kilogram_per_hour: "kilogram_per_hour";
+    readonly kilogram_per_second: "kilogram_per_second";
+    readonly square_kilometre: "square_kilometre";
+    readonly kilometre_per_hour: "kilometre_per_hour";
+    readonly litre: "litre";
+    readonly square_metre: "square_metre";
+    readonly cubic_metre: "cubic_metre";
+    readonly metre_per_second: "metre_per_second";
+    readonly metre_per_second_squared: "metre_per_second_squared";
+    readonly ton: "ton";
+    readonly hectare: "hectare";
+    readonly hour: "hour";
+};
+export type UnitSiType = (typeof UnitSi)[keyof typeof UnitSi];
 export interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {
     type: "NUMBER";
     minimum?: number;
     maximum?: number;
-    unitSi?: UnitSi;
-    unitUs?: UnitUs;
+    unitSi?: UnitSiType;
+    unitUs?: UnitUsType;
     isInteger: false;
 }
 export interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {

package/src/types/irisAppCustomFields.js

@@ -1,50 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnitSi = exports.UnitUs = void 0;
-var UnitUs;
-(function (UnitUs) {
-    UnitUs["acre"] = "acre";
-    UnitUs["foot"] = "foot";
-    UnitUs["square_foot"] = "square_foot";
-    UnitUs["cubic_foot"] = "cubic_foot";
-    UnitUs["gallon_liquid"] = "gallon_liquid";
-    UnitUs["inch"] = "inch";
-    UnitUs["pound"] = "pound";
-    UnitUs["pound_per_hour"] = "pound_per_hour";
-    UnitUs["pound_per_second"] = "pound_per_second";
-    UnitUs["mile"] = "mile";
-    UnitUs["mile_per_hour"] = "mile_per_hour";
-    UnitUs["ounce"] = "ounce";
-    UnitUs["ton_us"] = "ton_us";
-    UnitUs["yard"] = "yard";
-    UnitUs["pound_per_square_inch"] = "pound_per_square_inch";
-})(UnitUs || (exports.UnitUs = UnitUs = {}));
-var UnitSi;
-(function (UnitSi) {
-    UnitSi["newton"] = "newton";
-    UnitSi["pascal"] = "pascal";
-    UnitSi["kilopascal"] = "kilopascal";
-    UnitSi["watt"] = "watt";
-    UnitSi["bar"] = "bar";
-    UnitSi["centimetre"] = "centimetre";
-    UnitSi["millimetre"] = "millimetre";
-    UnitSi["metre"] = "metre";
-    UnitSi["kilometre"] = "kilometre";
-    UnitSi["gram"] = "gram";
-    UnitSi["kilogram"] = "kilogram";
-    UnitSi["kilowatt"] = "kilowatt";
-    UnitSi["kilowatthour"] = "kilowatthour";
-    UnitSi["kilogram_per_hour"] = "kilogram_per_hour";
-    UnitSi["kilogram_per_second"] = "kilogram_per_second";
-    UnitSi["square_kilometre"] = "square_kilometre";
-    UnitSi["kilometre_per_hour"] = "kilometre_per_hour";
-    UnitSi["litre"] = "litre";
-    UnitSi["square_metre"] = "square_metre";
-    UnitSi["cubic_metre"] = "cubic_metre";
-    UnitSi["metre_per_second"] = "metre_per_second";
-    UnitSi["metre_per_second_squared"] = "metre_per_second_squared";
-    UnitSi["ton"] = "ton";
-    UnitSi["hectare"] = "hectare";
-    UnitSi["hour"] = "hour";
-})(UnitSi || (exports.UnitSi = UnitSi = {}));
+exports.UnitUs = {
+    acre: "acre",
+    foot: "foot",
+    square_foot: "square_foot",
+    cubic_foot: "cubic_foot",
+    gallon_liquid: "gallon_liquid",
+    inch: "inch",
+    pound: "pound",
+    pound_per_hour: "pound_per_hour",
+    pound_per_second: "pound_per_second",
+    mile: "mile",
+    mile_per_hour: "mile_per_hour",
+    ounce: "ounce",
+    ton_us: "ton_us",
+    yard: "yard",
+    pound_per_square_inch: "pound_per_square_inch",
+};
+exports.UnitSi = {
+    newton: "newton",
+    pascal: "pascal",
+    kilopascal: "kilopascal",
+    watt: "watt",
+    bar: "bar",
+    centimetre: "centimetre",
+    millimetre: "millimetre",
+    metre: "metre",
+    kilometre: "kilometre",
+    gram: "gram",
+    kilogram: "kilogram",
+    kilowatt: "kilowatt",
+    kilowatthour: "kilowatthour",
+    kilogram_per_hour: "kilogram_per_hour",
+    kilogram_per_second: "kilogram_per_second",
+    square_kilometre: "square_kilometre",
+    kilometre_per_hour: "kilometre_per_hour",
+    litre: "litre",
+    square_metre: "square_metre",
+    cubic_metre: "cubic_metre",
+    metre_per_second: "metre_per_second",
+    metre_per_second_squared: "metre_per_second_squared",
+    ton: "ton",
+    hectare: "hectare",
+    hour: "hour",
+};
 //# sourceMappingURL=irisAppCustomFields.js.map

package/src/types/irisAppCustomFields.js.map

@@ -1 +1 @@
-{"version":3,"file":"irisAppCustomFields.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppCustomFields.ts"],"names":[],"mappings":";;;AAmFA,IAAY,MAgBX;AAhBD,WAAY,MAAM;IAChB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yCAA+B,CAAA;IAC/B,uBAAa,CAAA;IACb,yBAAe,CAAA;IACf,2CAAiC,CAAA;IACjC,+CAAqC,CAAA;IACrC,uBAAa,CAAA;IACb,yCAA+B,CAAA;IAC/B,yBAAe,CAAA;IACf,2BAAiB,CAAA;IACjB,uBAAa,CAAA;IACb,yDAA+C,CAAA;AACjD,CAAC,EAhBW,MAAM,sBAAN,MAAM,QAgBjB;AAED,IAAY,MA0BX;AA1BD,WAAY,MAAM;IAChB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,mCAAyB,CAAA;IACzB,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,mCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,yBAAe,CAAA;IACf,iCAAuB,CAAA;IACvB,uBAAa,CAAA;IACb,+BAAqB,CAAA;IACrB,+BAAqB,CAAA;IACrB,uCAA6B,CAAA;IAC7B,iDAAuC,CAAA;IACvC,qDAA2C,CAAA;IAC3C,+CAAqC,CAAA;IACrC,mDAAyC,CAAA;IACzC,yBAAe,CAAA;IACf,uCAA6B,CAAA;IAC7B,qCAA2B,CAAA;IAC3B,+CAAqC,CAAA;IACrC,+DAAqD,CAAA;IACrD,qBAAW,CAAA;IACX,6BAAmB,CAAA;IACnB,uBAAa,CAAA;AACf,CAAC,EA1BW,MAAM,sBAAN,MAAM,QA0BjB","sourcesContent":["export declare type CustomFieldDefinitionType =\n  | \"STRING\"\n  | \"NUMBER\"\n  | \"DATE\"\n  | \"BOOLEAN\"\n  | \"DROPDOWN\"\n  | \"EMAIL\"\n  | \"PHONE_NUMBER\"\n  | \"WEB_ADDRESS\"\n  | \"JSON\"\n  | \"MONETARY\";\n\nexport declare type EntityType = \"ASSET\" | \"ACCOUNT\" | \"SITE\" | \"GROUP\";\n\nexport interface AbstractCustomFieldDefinition {\n  /**\n   * The key is the name you use to get the custom field.\n   */\n  key: string;\n\n  /**\n   * The type of the entity to attach this custom field on.\n   */\n  entityType: EntityType;\n\n  /**\n   * The human readable translation of the key. So what the end customer will see.\n   */\n  title: string;\n\n  /**\n   * Should this be visible in the generic UI in Manager.\n   */\n  uiVisible?: boolean;\n\n  /**\n   * Should this be editable in the generic UI in Manager. This does not mean you cannot change it inside a app.\n   */\n  uiEditable?: boolean;\n\n  /**\n   * The type of this custom field definition\n   */\n  type: CustomFieldDefinitionType;\n}\n\nexport interface StringFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"STRING\";\n  minimumLength?: number;\n  maximumLength?: number;\n  pattern?: string;\n}\n\nexport interface EmailFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"EMAIL\";\n}\n\nexport interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"WEB_ADDRESS\";\n}\n\nexport interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"PHONE_NUMBER\";\n}\nexport interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"BOOLEAN\";\n}\n\nexport interface DateFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DATE\";\n}\n\nexport interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DROPDOWN\";\n  multiSelect?: boolean;\n  allValues?: string[];\n  /**\n   * Map from old values not in the allValues to new values. Used for updating existing data when changing\n   * the drop down options.\n   */\n  valueReplacements?: Record<string, string>;\n}\n\nexport enum UnitUs {\n  acre = \"acre\",\n  foot = \"foot\",\n  square_foot = \"square_foot\",\n  cubic_foot = \"cubic_foot\",\n  gallon_liquid = \"gallon_liquid\",\n  inch = \"inch\",\n  pound = \"pound\",\n  pound_per_hour = \"pound_per_hour\",\n  pound_per_second = \"pound_per_second\",\n  mile = \"mile\",\n  mile_per_hour = \"mile_per_hour\",\n  ounce = \"ounce\",\n  ton_us = \"ton_us\",\n  yard = \"yard\",\n  pound_per_square_inch = \"pound_per_square_inch\",\n}\n\nexport enum UnitSi {\n  newton = \"newton\",\n  pascal = \"pascal\",\n  kilopascal = \"kilopascal\",\n  watt = \"watt\",\n  bar = \"bar\",\n  centimetre = \"centimetre\",\n  millimetre = \"millimetre\",\n  metre = \"metre\",\n  kilometre = \"kilometre\",\n  gram = \"gram\",\n  kilogram = \"kilogram\",\n  kilowatt = \"kilowatt\",\n  kilowatthour = \"kilowatthour\",\n  kilogram_per_hour = \"kilogram_per_hour\",\n  kilogram_per_second = \"kilogram_per_second\",\n  square_kilometre = \"square_kilometre\",\n  kilometre_per_hour = \"kilometre_per_hour\",\n  litre = \"litre\",\n  square_metre = \"square_metre\",\n  cubic_metre = \"cubic_metre\",\n  metre_per_second = \"metre_per_second\",\n  metre_per_second_squared = \"metre_per_second_squared\",\n  ton = \"ton\",\n  hectare = \"hectare\",\n  hour = \"hour\",\n}\n\nexport interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n\n  minimum?: number;\n  maximum?: number;\n\n  unitSi?: UnitSi;\n  unitUs?: UnitUs;\n\n  isInteger: false;\n}\n\nexport interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n\n  minimum?: number;\n  maximum?: number;\n\n  isInteger: true;\n}\n\nexport type JSONValue = string | number | boolean | null | { [x: string]: JSONValue } | JSONValue[];\n\nexport interface JsonFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"JSON\";\n}\n\nexport interface MonetaryFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"MONETARY\";\n  /**\n   * The currency of the monetary field definition - ISO 4217 compliant.\n   */\n  currency: string;\n}\n"]}
+{"version":3,"file":"irisAppCustomFields.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppCustomFields.ts"],"names":[],"mappings":";;;AAmFa,QAAA,MAAM,GAAG;IACpB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,gBAAgB;IAChC,gBAAgB,EAAE,kBAAkB;IACpC,IAAI,EAAE,MAAM;IACZ,aAAa,EAAE,eAAe;IAC9B,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAGE,QAAA,MAAM,GAAG;IACpB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;IACxB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,mBAAmB,EAAE,qBAAqB;IAC1C,gBAAgB,EAAE,kBAAkB;IACpC,kBAAkB,EAAE,oBAAoB;IACxC,KAAK,EAAE,OAAO;IACd,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,gBAAgB,EAAE,kBAAkB;IACpC,wBAAwB,EAAE,0BAA0B;IACpD,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;CACJ,CAAC","sourcesContent":["export declare type CustomFieldDefinitionType =\n  | \"STRING\"\n  | \"NUMBER\"\n  | \"DATE\"\n  | \"BOOLEAN\"\n  | \"DROPDOWN\"\n  | \"EMAIL\"\n  | \"PHONE_NUMBER\"\n  | \"WEB_ADDRESS\"\n  | \"JSON\"\n  | \"MONETARY\";\n\nexport declare type EntityType = \"ASSET\" | \"ACCOUNT\" | \"SITE\" | \"GROUP\";\n\nexport interface AbstractCustomFieldDefinition {\n  /**\n   * The key is the name you use to get the custom field.\n   */\n  key: string;\n\n  /**\n   * The type of the entity to attach this custom field on.\n   */\n  entityType: EntityType;\n\n  /**\n   * The human readable translation of the key. So what the end customer will see.\n   */\n  title: string;\n\n  /**\n   * Should this be visible in the generic UI in Manager.\n   */\n  uiVisible?: boolean;\n\n  /**\n   * Should this be editable in the generic UI in Manager. This does not mean you cannot change it inside a app.\n   */\n  uiEditable?: boolean;\n\n  /**\n   * The type of this custom field definition\n   */\n  type: CustomFieldDefinitionType;\n}\n\nexport interface StringFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"STRING\";\n  minimumLength?: number;\n  maximumLength?: number;\n  pattern?: string;\n}\n\nexport interface EmailFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"EMAIL\";\n}\n\nexport interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"WEB_ADDRESS\";\n}\n\nexport interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"PHONE_NUMBER\";\n}\nexport interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"BOOLEAN\";\n}\n\nexport interface DateFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DATE\";\n}\n\nexport interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DROPDOWN\";\n  multiSelect?: boolean;\n  allValues?: string[];\n  /**\n   * Map from old values not in the allValues to new values. Used for updating existing data when changing\n   * the drop down options.\n   */\n  valueReplacements?: Record<string, string>;\n}\n\nexport const UnitUs = {\n  acre: \"acre\",\n  foot: \"foot\",\n  square_foot: \"square_foot\",\n  cubic_foot: \"cubic_foot\",\n  gallon_liquid: \"gallon_liquid\",\n  inch: \"inch\",\n  pound: \"pound\",\n  pound_per_hour: \"pound_per_hour\",\n  pound_per_second: \"pound_per_second\",\n  mile: \"mile\",\n  mile_per_hour: \"mile_per_hour\",\n  ounce: \"ounce\",\n  ton_us: \"ton_us\",\n  yard: \"yard\",\n  pound_per_square_inch: \"pound_per_square_inch\",\n} as const;\nexport type UnitUsType = (typeof UnitUs)[keyof typeof UnitUs];\n\nexport const UnitSi = {\n  newton: \"newton\",\n  pascal: \"pascal\",\n  kilopascal: \"kilopascal\",\n  watt: \"watt\",\n  bar: \"bar\",\n  centimetre: \"centimetre\",\n  millimetre: \"millimetre\",\n  metre: \"metre\",\n  kilometre: \"kilometre\",\n  gram: \"gram\",\n  kilogram: \"kilogram\",\n  kilowatt: \"kilowatt\",\n  kilowatthour: \"kilowatthour\",\n  kilogram_per_hour: \"kilogram_per_hour\",\n  kilogram_per_second: \"kilogram_per_second\",\n  square_kilometre: \"square_kilometre\",\n  kilometre_per_hour: \"kilometre_per_hour\",\n  litre: \"litre\",\n  square_metre: \"square_metre\",\n  cubic_metre: \"cubic_metre\",\n  metre_per_second: \"metre_per_second\",\n  metre_per_second_squared: \"metre_per_second_squared\",\n  ton: \"ton\",\n  hectare: \"hectare\",\n  hour: \"hour\",\n} as const;\nexport type UnitSiType = (typeof UnitSi)[keyof typeof UnitSi];\n\nexport interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n\n  minimum?: number;\n  maximum?: number;\n\n  unitSi?: UnitSiType;\n  unitUs?: UnitUsType;\n\n  isInteger: false;\n}\n\nexport interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n\n  minimum?: number;\n  maximum?: number;\n\n  isInteger: true;\n}\n\nexport type JSONValue = string | number | boolean | null | { [x: string]: JSONValue } | JSONValue[];\n\nexport interface JsonFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"JSON\";\n}\n\nexport interface MonetaryFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"MONETARY\";\n  /**\n   * The currency of the monetary field definition - ISO 4217 compliant.\n   */\n  currency: string;\n}\n"]}