@trackunit/iris-app-api 0.0.153 → 0.0.155
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
|
|
4
4
|
|
|
5
|
+
## [0.0.155](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.154...iris-app-api/0.0.155) (2024-02-29)
|
|
6
|
+
|
|
7
|
+
## [0.0.154](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.153...iris-app-api/0.0.154) (2024-02-26)
|
|
8
|
+
|
|
5
9
|
## [0.0.153](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.152...iris-app-api/0.0.153) (2024-02-20)
|
|
6
10
|
|
|
7
11
|
## [0.0.152](https://github.com/Trackunit/manager/compare/iris-app-api/0.0.151...iris-app-api/0.0.152) (2024-02-15)
|
package/package.json
CHANGED
|
@@ -127,9 +127,11 @@ export declare const UnitUs: {
|
|
|
127
127
|
};
|
|
128
128
|
export type UnitUsType = (typeof UnitUs)[keyof typeof UnitUs];
|
|
129
129
|
export declare const UnitSi: {
|
|
130
|
+
readonly amperehour: "amperehour";
|
|
130
131
|
readonly newton: "newton";
|
|
131
132
|
readonly pascal: "pascal";
|
|
132
133
|
readonly kilopascal: "kilopascal";
|
|
134
|
+
readonly volt: "volt";
|
|
133
135
|
readonly watt: "watt";
|
|
134
136
|
readonly bar: "bar";
|
|
135
137
|
readonly centimetre: "centimetre";
|
|
@@ -40,9 +40,11 @@ exports.UnitUs = {
|
|
|
40
40
|
pound_per_square_inch: "pound_per_square_inch",
|
|
41
41
|
};
|
|
42
42
|
exports.UnitSi = {
|
|
43
|
+
amperehour: "amperehour",
|
|
43
44
|
newton: "newton",
|
|
44
45
|
pascal: "pascal",
|
|
45
46
|
kilopascal: "kilopascal",
|
|
47
|
+
volt: "volt",
|
|
46
48
|
watt: "watt",
|
|
47
49
|
bar: "bar",
|
|
48
50
|
centimetre: "centimetre",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"irisAppCustomFields.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppCustomFields.ts"],"names":[],"mappings":";;;AAgBa,QAAA,SAAS,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,SAAS;IAClB;;OAEG;IACH,yBAAyB,EAAE,2BAA2B;IACtD;;OAEG;IACH,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAC3C,MAA6F,EACtD,EAAE;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AAJW,QAAA,6BAA6B,iCAIxC;AAgGW,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":["import { TranslationKey, TranslationLanguageKeys } from \"./irisAppExtensionManifest\";\n\nexport 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 const ScopeType = {\n /**\n * Values with account scope will be shared within a single account\n */\n ACCOUNT: \"ACCOUNT\",\n /**\n * Values will be shared within a single account (write) and visible to all accounts (read)\n */\n ACCOUNT_WRITE_GLOBAL_READ: \"ACCOUNT_WRITE_GLOBAL_READ\",\n /**\n * Values with global scope will be shared between all accounts with access to the entity.\n */\n GLOBAL: \"GLOBAL\",\n} as const;\nexport type ScopeTypeType = (typeof ScopeType)[keyof typeof ScopeType];\n\n/**\n * Test if the object is a CustomFieldTranslation array.\n */\nexport const isCustomFieldTranslationArray = (\n object: CustomFieldTranslationArray | { title: TranslationKey; description?: TranslationKey }\n): object is CustomFieldTranslationArray => {\n return Array.isArray(object);\n};\n\nexport interface CustomFieldTranslation {\n language: TranslationLanguageKeys;\n title: string;\n description?: string;\n}\n\nexport interface CustomFieldTranslationWithoutEnglish {\n language: Exclude<TranslationLanguageKeys, \"en\">;\n title: string;\n description?: string;\n}\n\nexport type CustomFieldTranslationArray = [\n { language: \"en\"; title: string; description?: string },\n ...CustomFieldTranslationWithoutEnglish[],\n];\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 * Who can access the field value. Default is only within the users account.\n */\n scopeType?: ScopeTypeType;\n\n /**\n * The translations for the custom field definition.\n * For Arrays of translations, the list must contain the language \"en\" as the default.\n * Either a list of translations or a single translation object with\n * translation keys it will look for all available languages in src/locales/<languagecode>/translation.json\n */\n translations: CustomFieldTranslationArray | { title: TranslationKey; description?: TranslationKey };\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"]}
|
|
1
|
+
{"version":3,"file":"irisAppCustomFields.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppCustomFields.ts"],"names":[],"mappings":";;;AAgBa,QAAA,SAAS,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,SAAS;IAClB;;OAEG;IACH,yBAAyB,EAAE,2BAA2B;IACtD;;OAEG;IACH,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAC3C,MAA6F,EACtD,EAAE;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AAJW,QAAA,6BAA6B,iCAIxC;AAgGW,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,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,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":["import { TranslationKey, TranslationLanguageKeys } from \"./irisAppExtensionManifest\";\n\nexport 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 const ScopeType = {\n /**\n * Values with account scope will be shared within a single account\n */\n ACCOUNT: \"ACCOUNT\",\n /**\n * Values will be shared within a single account (write) and visible to all accounts (read)\n */\n ACCOUNT_WRITE_GLOBAL_READ: \"ACCOUNT_WRITE_GLOBAL_READ\",\n /**\n * Values with global scope will be shared between all accounts with access to the entity.\n */\n GLOBAL: \"GLOBAL\",\n} as const;\nexport type ScopeTypeType = (typeof ScopeType)[keyof typeof ScopeType];\n\n/**\n * Test if the object is a CustomFieldTranslation array.\n */\nexport const isCustomFieldTranslationArray = (\n object: CustomFieldTranslationArray | { title: TranslationKey; description?: TranslationKey }\n): object is CustomFieldTranslationArray => {\n return Array.isArray(object);\n};\n\nexport interface CustomFieldTranslation {\n language: TranslationLanguageKeys;\n title: string;\n description?: string;\n}\n\nexport interface CustomFieldTranslationWithoutEnglish {\n language: Exclude<TranslationLanguageKeys, \"en\">;\n title: string;\n description?: string;\n}\n\nexport type CustomFieldTranslationArray = [\n { language: \"en\"; title: string; description?: string },\n ...CustomFieldTranslationWithoutEnglish[],\n];\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 * Who can access the field value. Default is only within the users account.\n */\n scopeType?: ScopeTypeType;\n\n /**\n * The translations for the custom field definition.\n * For Arrays of translations, the list must contain the language \"en\" as the default.\n * Either a list of translations or a single translation object with\n * translation keys it will look for all available languages in src/locales/<languagecode>/translation.json\n */\n translations: CustomFieldTranslationArray | { title: TranslationKey; description?: TranslationKey };\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 amperehour: \"amperehour\",\n newton: \"newton\",\n pascal: \"pascal\",\n kilopascal: \"kilopascal\",\n volt: \"volt\",\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"]}
|
|
@@ -90,4 +90,4 @@ export interface Marketplace_1_0 {
|
|
|
90
90
|
*/
|
|
91
91
|
supportUrl?: string;
|
|
92
92
|
}
|
|
93
|
-
export declare type Category = "DATA_FEEDS" | "SERVICE_AND_MAINTENANCE" | "CONSULTANTS" | "
|
|
93
|
+
export declare type Category = "DATA_FEEDS" | "SERVICE_AND_MAINTENANCE" | "CONSULTANTS" | "EQUIPMENT_PROTECTION" | "ASSET_MANAGEMENT" | "RENTAL_MANAGEMENT" | "OPTIMIZE_BUSINESS" | "EFFECTIVE_OPERATIONS" | "SUSTAINABILITY" | "DOCUMENTATION" | "COMPLIANCE";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"irisAppMarketplace.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppMarketplace.ts"],"names":[],"mappings":"","sourcesContent":["import { SubscriptionPackage } from \"./subscriptionPackages\";\n\n/**\n * An image that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetImage {\n /**\n * The type of the Asset\n */\n type: \"IMAGE\";\n /**\n * A Path to an image in the assets folder of the app.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n path: string;\n}\n\n/**\n * A video that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetVideo {\n /**\n * The type of the Asset\n */\n type: \"VIDEO\";\n /**\n * An url for a youtube video.\n */\n url: string;\n}\n\n/**\n * A video or image that should be shown in the marketplace for this app.\n */\nexport type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;\n\n/**\n * An object of data used when the app is displayed in the marketplace\n */\nexport interface Marketplace extends Omit<Marketplace_1_0, \"allowForPackage\"> {}\n\n/**\n * An object of data used when the app is displayed in the marketplace\n *\n * @deprecated\n */\nexport interface Marketplace_1_0 {\n /**\n * Name used for the marketplace.\n */\n name: string;\n\n /**\n * A short summary used for the card on marketplace.\n * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.\n */\n description: string;\n\n /**\n * The path to a markdown file that explains your app in more detail.\n * The file must be stored in the assets folder within the app directory to work.\n * The path is relative to that directory.\n * For a file apps/my-app/assets/description.md, this parameter should be: description.md\n */\n fullDescriptionPath: string;\n\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown in the marketplace.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n logoPath?: string;\n /**\n * A list of relevant tags to make your app easier to find.\n */\n tags?: string[];\n /**\n * Categories used for the app in the marketplace.\n */\n categories?: Category[];\n /**\n * Assets (images and videos) used for the marketplace.\n */\n assets?: MarketplaceAsset[];\n /**\n * Defines with which subscription packages your app is compatible.\n * Take great care when entering this, as your app might bug out (if it went through the approval phase in the first place)\n * if what is stated here does not match reality.\n */\n allowForPackage: \"ALL_PACKAGES\" | SubscriptionPackage[];\n /**\n * Homepage of the company building the app for the marketplace.\n */\n homePageUrl?: string;\n /**\n * The direct support page for this app.\n */\n supportUrl?: string;\n}\n\nexport declare type Category =\n | \"DATA_FEEDS\"\n | \"SERVICE_AND_MAINTENANCE\"\n | \"CONSULTANTS\"\n | \"
|
|
1
|
+
{"version":3,"file":"irisAppMarketplace.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppMarketplace.ts"],"names":[],"mappings":"","sourcesContent":["import { SubscriptionPackage } from \"./subscriptionPackages\";\n\n/**\n * An image that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetImage {\n /**\n * The type of the Asset\n */\n type: \"IMAGE\";\n /**\n * A Path to an image in the assets folder of the app.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n path: string;\n}\n\n/**\n * A video that should be shown in the marketplace for this app.\n */\nexport interface MarketplaceAssetVideo {\n /**\n * The type of the Asset\n */\n type: \"VIDEO\";\n /**\n * An url for a youtube video.\n */\n url: string;\n}\n\n/**\n * A video or image that should be shown in the marketplace for this app.\n */\nexport type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;\n\n/**\n * An object of data used when the app is displayed in the marketplace\n */\nexport interface Marketplace extends Omit<Marketplace_1_0, \"allowForPackage\"> {}\n\n/**\n * An object of data used when the app is displayed in the marketplace\n *\n * @deprecated\n */\nexport interface Marketplace_1_0 {\n /**\n * Name used for the marketplace.\n */\n name: string;\n\n /**\n * A short summary used for the card on marketplace.\n * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.\n */\n description: string;\n\n /**\n * The path to a markdown file that explains your app in more detail.\n * The file must be stored in the assets folder within the app directory to work.\n * The path is relative to that directory.\n * For a file apps/my-app/assets/description.md, this parameter should be: description.md\n */\n fullDescriptionPath: string;\n\n /**\n * Path to an image in the assets folder of the app.\n * The image will be shown in the marketplace.\n * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n */\n logoPath?: string;\n /**\n * A list of relevant tags to make your app easier to find.\n */\n tags?: string[];\n /**\n * Categories used for the app in the marketplace.\n */\n categories?: Category[];\n /**\n * Assets (images and videos) used for the marketplace.\n */\n assets?: MarketplaceAsset[];\n /**\n * Defines with which subscription packages your app is compatible.\n * Take great care when entering this, as your app might bug out (if it went through the approval phase in the first place)\n * if what is stated here does not match reality.\n */\n allowForPackage: \"ALL_PACKAGES\" | SubscriptionPackage[];\n /**\n * Homepage of the company building the app for the marketplace.\n */\n homePageUrl?: string;\n /**\n * The direct support page for this app.\n */\n supportUrl?: string;\n}\n\nexport declare type Category =\n | \"DATA_FEEDS\"\n | \"SERVICE_AND_MAINTENANCE\"\n | \"CONSULTANTS\"\n | \"EQUIPMENT_PROTECTION\"\n | \"ASSET_MANAGEMENT\"\n | \"RENTAL_MANAGEMENT\"\n | \"OPTIMIZE_BUSINESS\"\n | \"EFFECTIVE_OPERATIONS\"\n | \"SUSTAINABILITY\"\n | \"DOCUMENTATION\"\n | \"COMPLIANCE\";\n"]}
|