@trackunit/iris-app-api 0.0.102 → 0.0.104

package/src/types/irisAppManifest.d.ts

@@ -1,3 +1,7 @@
+import { AdminExtensionManifest, AssetHomeExtensionManifest, FleetExtensionManifest, IrisAppSettingsExtensionManifest, ReportExtensionManifest, SiteHomeExtensionManifest } from "./extensions";
+import { BooleanFieldDefinition, DateFieldDefinition, DecimalNumberFieldDefinition, DropDownFieldDefinition, EmailFieldDefinition, IntegerNumberFieldDefinition, PhoneNumberFieldDefinition, StringFieldDefinition, WebAddressFieldDefinition } from "./irisAppCustomFields";
+import { InstallationConfig } from "./irisAppInstallationConfig";
+import { Marketplace, Marketplace_1_0 } from "./irisAppMarketplace";
 export interface IrisAppManifest extends Omit<IrisAppManifest_1_0, "specVersion" | "activationMode" | "marketplace" | "validForAccountIds"> {
     /**
      * A spec version for the manifest.
@@ -16,28 +20,34 @@ export interface IrisAppManifest extends Omit<IrisAppManifest_1_0, "specVersion"
      */
     marketplace: Marketplace;
 }
-interface InstallationConfig {
+export declare type IrisAppExtension = AssetHomeExtensionManifest | IrisAppSettingsExtensionManifest | AdminExtensionManifest | FleetExtensionManifest | SiteHomeExtensionManifest | ReportExtensionManifest;
+export declare type CustomFieldDefinition = BooleanFieldDefinition | DecimalNumberFieldDefinition | IntegerNumberFieldDefinition | DateFieldDefinition | DropDownFieldDefinition | StringFieldDefinition | EmailFieldDefinition | PhoneNumberFieldDefinition | WebAddressFieldDefinition;
+export interface ConsentConfig {
     /**
-     * Installation policy for the app.
-     *
-     * - `PERMANENT`: Always installed and cannot be removed by the end customer.
-     * - `PREINSTALLED`: Initially installed and can be removed by the end customer.
-     * - `ON_DEMAND`: Available to be installed and removed by the end customer.
-     * - `ON_DEMAND_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team before the end customer can install it. Behaves like 'ON_DEMAND' after receiving approval.
-     * - `PREINSTALLED_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team and installs automatically once approved. Behaves like 'PREINSTALLED' after receiving approval.
-     *
-     * All policies will take into consideration both `accountIds` and `subscriptionPlan`.
+     * The application type. Should be one of WEB or BROWSER.
      */
-    policy: InstallationPolicy;
+    applicationType: "WEB" | "BROWSER";
     /**
-     * List of account IDs that can install this Iris App or `"ALL_ACCOUNTS"` if available for all customers.
+     * List of scopes required by the application.
      */
-    accountIds: "ALL_ACCOUNTS" | string[];
+    scopes: string[];
     /**
-     * List of pricing plans the Iris App is available at or `"ALL_PLANS"` if available in all plans.
+     * List of redirect URIs to be used when returning an authorization code.
      */
-    pricingPlans: "ALL_PLANS" | SubscriptionPackage[];
+    redirectUris?: string[];
 }
+export interface Dependencies {
+    [packageName: string]: string;
+}
+export type PublicIrisAppManifest = Omit<IrisAppManifest, "dependencies" | "devDependencies" | "installation"> & {
+    /**
+     * Relative path for this iris app.
+     *
+     * @returns {string} the path to the iris app
+     */
+    irisAppPath: string;
+    installation: Omit<InstallationConfig, "accountIds">;
+};
 /**
  * @deprecated
  */
@@ -111,364 +121,7 @@ export interface IrisAppManifest_1_0 {
      */
     customFieldDefinitions?: CustomFieldDefinition[];
 }
-export type PublicIrisAppManifest = Omit<IrisAppManifest, "dependencies" | "devDependencies" | "installation"> & {
-    /**
-     * Relative path for this iris app.
-     *
-     * @returns {string} the path to the iris app
-     */
-    irisAppPath: string;
-    installation: Omit<InstallationConfig, "accountIds">;
-};
-export type ActivationMode = "FORCE_ENABLE" | "DEFAULT_ENABLE" | "ALWAYS_VISIBLE" | "CONTROLLED_MANUAL_INSTALLATION" | "CONTROLLED_AUTOMATIC_INSTALLATION";
-export type InstallationPolicy = "PERMANENT" | "PREINSTALLED" | "ON_DEMAND" | "ON_DEMAND_REQUIRES_APPROVAL" | "PREINSTALLED_REQUIRES_APPROVAL";
-export interface Translations {
-    en: string;
-    da?: string;
-    de?: string;
-    cs?: string;
-    nl?: string;
-    fr?: string;
-    fi?: string;
-    hu?: string;
-    it?: string;
-    nb?: string;
-    pl?: string;
-    pt?: string;
-    ru?: string;
-    ro?: string;
-    es?: string;
-    sv?: string;
-    ja?: string;
-    th?: string;
-}
-export declare const languageKeys: readonly ["en", "da", "de", "cs", "nl", "fr", "fi", "hu", "it", "nb", "pl", "pt", "ru", "ro", "es", "sv", "ja", "th"];
-export type TranslationLanguageKeys = typeof languageKeys[number];
-export interface TranslationKey {
-    key: string;
-}
-export interface AbstractExtensionManifest {
-    /** The id of the app extension, will be part of the URL in the manager */
-    id: string;
-    /**
-     * The path to the main entry point for the extension.
-     *
-     * @default "index.tsx"
-     */
-    main?: string;
-    /**
-     * The relative path from the NX workspace to this projects source Root.
-     */
-    sourceRoot: string;
-    /** The type of the app extension */
-    type: IrisAppExtensionType;
-}
-export declare type CustomFieldDefinitionType = "STRING" | "NUMBER" | "DATE" | "BOOLEAN" | "DROPDOWN" | "EMAIL" | "PHONE_NUMBER" | "WEB_ADDRESS";
-export declare type EntityType = "ASSET" | "ACCOUNT" | "SITE" | "GROUP";
-export interface AbstractCustomFieldDefinition {
-    /**
-     * The key is the name you use to get the custom field.
-     */
-    key: string;
-    /**
-     * The type of the entity to attach this custom field on.
-     */
-    entityType: EntityType;
-    /**
-     * The human readable translation of the key. So what the end customer will see.
-     */
-    title: string;
-    /**
-     * Should this be visible in the generic UI in Manager.
-     */
-    uiVisible?: boolean;
-    /**
-     * Should this be editable in the generic UI in Manager. This does not mean you cannot change it inside a app.
-     */
-    uiEditable?: boolean;
-    /**
-     * The type of this custom field definition
-     */
-    type: CustomFieldDefinitionType;
-}
-export interface StringFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "STRING";
-    minimumLength?: number;
-    maximumLength?: number;
-    pattern?: string;
-    defaultStringValue?: string;
-}
-export interface EmailFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "EMAIL";
-    defaultStringValue?: string;
-}
-export interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "WEB_ADDRESS";
-    defaultStringValue?: string;
-}
-export interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "PHONE_NUMBER";
-    defaultStringValue?: string;
-}
-export interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "BOOLEAN";
-    defaultBooleanValue?: boolean;
-}
-export interface DateFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "DATE";
-    defaultDateValue?: string;
-}
-export interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "DROPDOWN";
-    defaultStringArrayValue?: string[];
-    multiSelect?: boolean;
-    allValues?: string[];
-    /**
-     * Map from old values not in {@link allValues} to new values. Used for updating existing data when changing
-     * the drop down options.
-     */
-    valueReplacements?: Record<string, string>;
-}
-export declare enum UnitUs {
-    "mi" = "mi",
-    "yd" = "yd",
-    "ft" = "ft",
-    "in" = "in",
-    "ac" = "ac",
-    "ha" = "ha",
-    "ft_2" = "ft\u00B2",
-    "gal" = "gal",
-    "ft_3" = "ft\u00B3",
-    "ton_us" = "ton_us",
-    "lb" = "lb",
-    "oz" = "oz",
-    "mph" = "mph",
-    "lb_h" = "lb/h",
-    "lb_s" = "lb/s"
-}
-export declare enum UnitSi {
-    "km" = "km",
-    "m" = "m",
-    "cm" = "cm",
-    "mm" = "mm",
-    "l" = "l",
-    "kg" = "kg",
-    "g" = "g",
-    "ton" = "ton",
-    "N" = "N",
-    "kW" = "kW",
-    "W" = "W",
-    "kWh" = "kWh",
-    "kPa" = "kPa",
-    "Pa" = "Pa",
-    "bar" = "bar",
-    "m_s" = "m/s",
-    "kg_h" = "kg/h",
-    "kg_s" = "kg/s",
-    "km_h" = "km/h",
-    "km_2" = "km\u00B2",
-    "m_2" = "m\u00B2",
-    "m_3" = "m\u00B3",
-    "m_s_2" = "m/s\u00B2",
-    "h" = "h"
-}
-export interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "NUMBER";
-    defaultNumberValue?: number;
-    minimum?: number;
-    maximum?: number;
-    unitSi?: UnitSi;
-    unitUs?: UnitUs;
-    isInteger: false;
-}
-export interface IntegerNumberFieldDefinition extends AbstractCustomFieldDefinition {
-    type: "NUMBER";
-    defaultNumberValue?: number;
-    minimum?: number;
-    maximum?: number;
-    isInteger: true;
-}
-export declare type CustomFieldDefinition = BooleanFieldDefinition | DecimalNumberFieldDefinition | IntegerNumberFieldDefinition | DateFieldDefinition | DropDownFieldDefinition | StringFieldDefinition | EmailFieldDefinition | PhoneNumberFieldDefinition | WebAddressFieldDefinition;
-export interface AssetHomeExtensionManifest extends AbstractExtensionManifest {
-    type: "ASSET_HOME_EXTENSION";
-    /**
-     * Conditions for the asset home app to be shown.
-     * It is case insensitive so does not matter how you write the brand.
-     *  brand: "trackunit" and brand: "Trackunit" will be the same.
-     *
-     * If both model and brand are used/filled out then asset needs to match both model and brand.
-     * If only brand or model is used/filled out then the asset needs to match the filled out property.
-     */
-    conditions?: {
-        model?: string[] | string;
-        brand?: string[] | string;
-    };
-    menuItem: {
-        name: string | Translations | TranslationKey;
-    };
-}
-export interface SiteHomeExtensionManifest extends AbstractExtensionManifest {
-    type: "SITE_HOME_EXTENSION";
-    menuItem: {
-        name: string | Translations | TranslationKey;
-    };
-}
-export interface FleetExtensionManifest extends AbstractExtensionManifest {
-    type: "FLEET_EXTENSION";
-    /**
-     * Conditions for the asset home app to be shown.
-     * It is case insensitive so does not matter how you write the brand.
-     *  brand: "trackunit" and brand: "Trackunit" will be the same.
-     *
-     * If both model and brand are used/filled out then asset needs to match both model and brand.
-     * If only brand or model is used/filled out then the asset needs to match the filled out property.
-     */
-    conditions?: {
-        model?: string[] | string;
-        brand?: string[] | string;
-    };
-    menuItem: {
-        name: string | Translations | TranslationKey;
-        icon: string;
-    };
-}
-export interface AdminExtensionManifest extends AbstractExtensionManifest {
-    type: "ADMIN_EXTENSION";
-    menuItem: {
-        name: string | Translations | TranslationKey;
-    };
-}
-export interface IrisAppSettingsExtensionManifest extends AbstractExtensionManifest {
-    type: "IRIS_APP_SETTINGS_EXTENSION";
-}
-export interface ReportExtensionManifest extends AbstractExtensionManifest {
-    type: "REPORT_EXTENSION";
-    menuItem: {
-        /**
-         * Title of the card in manager
-         */
-        name: string | Translations | TranslationKey;
-        /**
-         * Subtitle of the card in manager
-         */
-        description: string | Translations | TranslationKey;
-        /**
-         * Icon of the card in manager, must use icons from:
-         * https://apps.dev.iris.trackunit.com/storybook/?path=/docs/components-icon--default
-         */
-        icon: string;
-    };
-}
-export declare type IrisAppExtension = AssetHomeExtensionManifest | IrisAppSettingsExtensionManifest | AdminExtensionManifest | FleetExtensionManifest | SiteHomeExtensionManifest | ReportExtensionManifest;
-export interface ConsentConfig {
-    /**
-     * The application type. Should be one of WEB or BROWSER.
-     */
-    applicationType: "WEB" | "BROWSER";
-    /**
-     * List of scopes required by the application.
-     */
-    scopes: string[];
-    /**
-     * List of redirect URIs to be used when returning an authorization code.
-     */
-    redirectUris?: string[];
-}
-/**
- * An image that should be shown in the marketplace for this app.
- */
-export interface MarketplaceAssetImage {
-    /**
-     * The type of the Asset
-     */
-    type: "IMAGE";
-    /**
-     * A Path to an image in the assets folder of the app.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
-     */
-    path: string;
-}
-/**
- * A video that should be shown in the marketplace for this app.
- */
-export interface MarketplaceAssetVideo {
-    /**
-     * The type of the Asset
-     */
-    type: "VIDEO";
-    /**
-     * An url for a youtube video.
-     */
-    url: string;
-}
 /**
- * A video or image that should be shown in the marketplace for this app.
- */
-export type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;
-/**
- * An object of data used when the app is displayed in the marketplace
- */
-export interface Marketplace extends Omit<Marketplace_1_0, "allowForPackage"> {
-}
-/**
- * An object of data used when the app is displayed in the marketplace
- *
  * @deprecated
  */
-export interface Marketplace_1_0 {
-    /**
-     * Name used for the marketplace.
-     */
-    name: string;
-    /**
-     * A short summary used for the card on marketplace.
-     * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.
-     */
-    description: string;
-    /**
-     * The path to a markdown file that explains your app in more detail.
-     * The file must be stored in the assets folder within the app directory to work.
-     * The path is relative to that directory.
-     * For a file apps/my-app/assets/description.md, this parameter should be: description.md
-     */
-    fullDescriptionPath: string;
-    /**
-     * Path to an image in the assets folder of the app.
-     * The image will be shown in the marketplace.
-     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
-     */
-    logoPath?: string;
-    /**
-     * A list of relevant tags to make your app easier to find.
-     */
-    tags?: string[];
-    /**
-     * Categories used for the app in the marketplace.
-     */
-    categories?: Category[];
-    /**
-     * Assets (images and videos) used for the marketplace.
-     */
-    assets?: MarketplaceAsset[];
-    /**
-     * Defines with which subscription packages your app is compatible.
-     * Take great care when entering this, as your app might bug out (if it went through the approval phase in the first place)
-     * if what is stated here does not match reality.
-     */
-    allowForPackage: "ALL_PACKAGES" | SubscriptionPackage[];
-    /**
-     * Homepage of the company building the app for the marketplace.
-     */
-    homePageUrl?: string;
-    /**
-     * The direct support page for this app.
-     */
-    supportUrl?: string;
-}
-export declare type Category = "ANALYTICS" | "DATA_FEEDS" | "ENGINES_AND_HYDRAULICS" | "SERVICE_AND_MAINTENANCE" | "CONSULTANTS" | "CONNECTIVITY_AND_NETWORK" | "REPORTS" | "FAULT_CODES_AND_REMOTE_DIAGNOSTICS" | "SAFETY_AND_QUALITY";
-export declare type SubscriptionPackage = "VIEW" | "COLLECT" | "INSIGHT" | "EXPLORE_FLEET_OWNER" | "EVOLVE_FLEET_OWNER" | "EXPAND_FLEET_OWNER" | "EXPLORE_OEM" | "EVOLVE_OEM" | "EXPAND_OEM";
-export declare type IrisAppExtensionType = "REPORT_EXTENSION" | "IRIS_APP_SETTINGS_EXTENSION" | "ADMIN_EXTENSION" | "FLEET_EXTENSION" | "ASSET_HOME_EXTENSION" | "SITE_HOME_EXTENSION";
-interface Dependencies {
-    [packageName: string]: string;
-}
-export {};
+export type ActivationMode = "FORCE_ENABLE" | "DEFAULT_ENABLE" | "ALWAYS_VISIBLE" | "CONTROLLED_MANUAL_INSTALLATION" | "CONTROLLED_AUTOMATIC_INSTALLATION";

package/src/types/irisAppManifest.js

@@ -1,69 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnitSi = exports.UnitUs = exports.languageKeys = void 0;
-exports.languageKeys = [
-    "en",
-    "da",
-    "de",
-    "cs",
-    "nl",
-    "fr",
-    "fi",
-    "hu",
-    "it",
-    "nb",
-    "pl",
-    "pt",
-    "ru",
-    "ro",
-    "es",
-    "sv",
-    "ja",
-    "th",
-];
-var UnitUs;
-(function (UnitUs) {
-    UnitUs["mi"] = "mi";
-    UnitUs["yd"] = "yd";
-    UnitUs["ft"] = "ft";
-    UnitUs["in"] = "in";
-    UnitUs["ac"] = "ac";
-    UnitUs["ha"] = "ha";
-    UnitUs["ft_2"] = "ft\u00B2";
-    UnitUs["gal"] = "gal";
-    UnitUs["ft_3"] = "ft\u00B3";
-    UnitUs["ton_us"] = "ton_us";
-    UnitUs["lb"] = "lb";
-    UnitUs["oz"] = "oz";
-    UnitUs["mph"] = "mph";
-    UnitUs["lb_h"] = "lb/h";
-    UnitUs["lb_s"] = "lb/s";
-})(UnitUs = exports.UnitUs || (exports.UnitUs = {}));
-var UnitSi;
-(function (UnitSi) {
-    UnitSi["km"] = "km";
-    UnitSi["m"] = "m";
-    UnitSi["cm"] = "cm";
-    UnitSi["mm"] = "mm";
-    UnitSi["l"] = "l";
-    UnitSi["kg"] = "kg";
-    UnitSi["g"] = "g";
-    UnitSi["ton"] = "ton";
-    UnitSi["N"] = "N";
-    UnitSi["kW"] = "kW";
-    UnitSi["W"] = "W";
-    UnitSi["kWh"] = "kWh";
-    UnitSi["kPa"] = "kPa";
-    UnitSi["Pa"] = "Pa";
-    UnitSi["bar"] = "bar";
-    UnitSi["m_s"] = "m/s";
-    UnitSi["kg_h"] = "kg/h";
-    UnitSi["kg_s"] = "kg/s";
-    UnitSi["km_h"] = "km/h";
-    UnitSi["km_2"] = "km\u00B2";
-    UnitSi["m_2"] = "m\u00B2";
-    UnitSi["m_3"] = "m\u00B3";
-    UnitSi["m_s_2"] = "m/s\u00B2";
-    UnitSi["h"] = "h";
-})(UnitSi = exports.UnitSi || (exports.UnitSi = {}));
 //# sourceMappingURL=irisAppManifest.js.map

package/src/types/irisAppManifest.js.map

@@ -1 +1 @@
-{"version":3,"file":"irisAppManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppManifest.ts"],"names":[],"mappings":";;;AA0Ka,QAAA,YAAY,GAAG;IAC1B,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACI,CAAC;AAmHX,IAAY,MAgBX;AAhBD,WAAY,MAAM;IAChB,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,2BAAc,CAAA;IACd,qBAAa,CAAA;IACb,2BAAc,CAAA;IACd,2BAAmB,CAAA;IACnB,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,qBAAa,CAAA;IACb,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAhBW,MAAM,GAAN,cAAM,KAAN,cAAM,QAgBjB;AAED,IAAY,MAyBX;AAzBD,WAAY,MAAM;IAChB,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,qBAAa,CAAA;IACb,iBAAS,CAAA;IACT,mBAAW,CAAA;IACX,iBAAS,CAAA;IACT,qBAAa,CAAA;IACb,qBAAa,CAAA;IACb,mBAAW,CAAA;IACX,qBAAa,CAAA;IACb,qBAAa,CAAA;IACb,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,2BAAc,CAAA;IACd,yBAAY,CAAA;IACZ,yBAAY,CAAA;IACZ,6BAAgB,CAAA;IAChB,iBAAS,CAAA;AACX,CAAC,EAzBW,MAAM,GAAN,cAAM,KAAN,cAAM,QAyBjB","sourcesContent":["export interface IrisAppManifest\n  extends Omit<IrisAppManifest_1_0, \"specVersion\" | \"activationMode\" | \"marketplace\" | \"validForAccountIds\"> {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.1\";\n\n  /**\n   * Configuration for the installation of the app.\n   *\n   * Each parameter can be combined to create rules to target specific customers.\n   * Each parameter works as a filter to decide if an app is available to a specific customer.\n   */\n  installation: InstallationConfig;\n\n  /**\n   * A configuration object for the Marketplace entry\n   */\n  marketplace: Marketplace;\n}\n\ninterface InstallationConfig {\n  /**\n   * Installation policy for the app.\n   *\n   * - `PERMANENT`: Always installed and cannot be removed by the end customer.\n   * - `PREINSTALLED`: Initially installed and can be removed by the end customer.\n   * - `ON_DEMAND`: Available to be installed and removed by the end customer.\n   * - `ON_DEMAND_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team before the end customer can install it. Behaves like 'ON_DEMAND' after receiving approval.\n   * - `PREINSTALLED_REQUIRES_APPROVAL`: Requires approval by the Trackunit billing team and installs automatically once approved. Behaves like 'PREINSTALLED' after receiving approval.\n   *\n   * All policies will take into consideration both `accountIds` and `subscriptionPlan`.\n   */\n  policy: InstallationPolicy;\n  /**\n   * List of account IDs that can install this Iris App or `\"ALL_ACCOUNTS\"` if available for all customers.\n   */\n  accountIds: \"ALL_ACCOUNTS\" | string[];\n  /**\n   * List of pricing plans the Iris App is available at or `\"ALL_PLANS\"` if available in all plans.\n   */\n  pricingPlans: \"ALL_PLANS\" | SubscriptionPackage[];\n}\n\n/**\n * @deprecated\n */\nexport interface IrisAppManifest_1_0 {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.0\";\n  /**\n   * The name of the exposed module from module federation build into the remoteEntry.js.\n   * Basically the name of your app including workspace name, automatically parsed from your app-specific package.json.\n   */\n  moduleFederationName: string;\n  /**\n   * A configuration object for handling scoped token acquisition.\n   */\n  consentConfig?: ConsentConfig | \"inherit\";\n\n  /**\n   * Controls the visibility of your app and how it is installed.\n   * The different modes are:\n   * - Enabled means its enabled on the subscription when this Iris app is approved.\n   * - Visible means it will be visible to the customer to choose for them selves to enable/disable it.\n   *\n   * - FORCE_ENABLE then it can not be removed by the end customer, and will be installed based on the selected subscription package.\n   * - DEFAULT_ENABLE means it will be enabled when a customer activates a new subscription package.\n   * - ALWAYS_VISIBLE then it will always be visible for all customers.\n   * - CONTROLLED_MANUAL_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, not activating the app.\n   * - CONTROLLED_AUTOMATIC_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, also adding.\n   *\n   * All modes will take into consideration both {@link validForAccountIds} and {@link marketplace}.allowForPackage\n   */\n  activationMode: ActivationMode;\n\n  /**\n   * A list of any external domains that the app needs to communicate with.\n   * The list is audited in the approval step of the app and every external API call\n   * must be listed here to get through the verification process.\n   * Even if it goes through without being listed, your app will fail to call the endpoint.\n   */\n  validDomains: string[];\n  /**\n   * Put `ALL_ACCOUNTS` in if your app is available to all users.\n   * If you want to only make it available to certain users, provide a list of account ID's as strings.\n   */\n  validForAccountIds: \"ALL_ACCOUNTS\" | string[];\n  /**\n   * A configuration object for the Marketplace entry.\n   * Holds all the settings associated with your apps listing on the marketplace.\n   */\n  marketplace: Marketplace_1_0;\n  /**\n   * A full list of runtime dependencies for the App.\n   * Used for performance optimization and security scans.\n   * It is automatically parsed from the package.json in root.\n   */\n  dependencies: Dependencies;\n\n  /**\n   * A full list of dev dependencies for the App.\n   * Used for security scans.\n   */\n  devDependencies: Dependencies;\n\n  /**\n   * A list of extensions to the UI that this app manifest exposes.\n   * Extensions are automatically added when a new extension is generated.\n   * The array contains an import of the extension manifest within the extension.\n   * If an extension is required in multiple apps, the you must manually add it to the arrays of those apps.\n   */\n  extensions: IrisAppExtension[];\n\n  /**\n   * A list of custom field definitions.\n   */\n  customFieldDefinitions?: CustomFieldDefinition[];\n}\n\nexport type PublicIrisAppManifest = Omit<IrisAppManifest, \"dependencies\" | \"devDependencies\" | \"installation\"> & {\n  /**\n   * Relative path for this iris app.\n   *\n   * @returns {string} the path to the iris app\n   */\n  irisAppPath: string;\n\n  installation: Omit<InstallationConfig, \"accountIds\">;\n};\n\nexport type ActivationMode =\n  | \"FORCE_ENABLE\"\n  | \"DEFAULT_ENABLE\"\n  | \"ALWAYS_VISIBLE\"\n  | \"CONTROLLED_MANUAL_INSTALLATION\"\n  | \"CONTROLLED_AUTOMATIC_INSTALLATION\";\n\nexport type InstallationPolicy =\n  | \"PERMANENT\"\n  | \"PREINSTALLED\"\n  | \"ON_DEMAND\"\n  | \"ON_DEMAND_REQUIRES_APPROVAL\"\n  | \"PREINSTALLED_REQUIRES_APPROVAL\";\n\nexport interface Translations {\n  en: string;\n  da?: string;\n  de?: string;\n  cs?: string;\n  nl?: string;\n  fr?: string;\n  fi?: string;\n  hu?: string;\n  it?: string;\n  nb?: string;\n  pl?: string;\n  pt?: string;\n  ru?: string;\n  ro?: string;\n  es?: string;\n  sv?: string;\n  ja?: string;\n  th?: string;\n}\n\nexport const languageKeys = [\n  \"en\",\n  \"da\",\n  \"de\",\n  \"cs\",\n  \"nl\",\n  \"fr\",\n  \"fi\",\n  \"hu\",\n  \"it\",\n  \"nb\",\n  \"pl\",\n  \"pt\",\n  \"ru\",\n  \"ro\",\n  \"es\",\n  \"sv\",\n  \"ja\",\n  \"th\",\n] as const;\n\nexport type TranslationLanguageKeys = typeof languageKeys[number];\n\nexport interface TranslationKey {\n  key: string;\n}\nexport interface AbstractExtensionManifest {\n  /** The id of the app extension, will be part of the URL in the manager */\n  id: string;\n\n  /**\n   * The path to the main entry point for the extension.\n   *\n   * @default \"index.tsx\"\n   */\n  main?: string;\n\n  /**\n   * The relative path from the NX workspace to this projects source Root.\n   */\n  sourceRoot: string;\n\n  /** The type of the app extension */\n  type: IrisAppExtensionType;\n}\n\nexport declare type CustomFieldDefinitionType =\n  | \"STRING\"\n  | \"NUMBER\"\n  | \"DATE\"\n  | \"BOOLEAN\"\n  | \"DROPDOWN\"\n  | \"EMAIL\"\n  | \"PHONE_NUMBER\"\n  | \"WEB_ADDRESS\";\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  defaultStringValue?: string;\n}\n\nexport interface EmailFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"EMAIL\";\n  defaultStringValue?: string;\n}\n\nexport interface WebAddressFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"WEB_ADDRESS\";\n  defaultStringValue?: string;\n}\n\nexport interface PhoneNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"PHONE_NUMBER\";\n  defaultStringValue?: string;\n}\nexport interface BooleanFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"BOOLEAN\";\n  defaultBooleanValue?: boolean;\n}\n\nexport interface DateFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DATE\";\n  defaultDateValue?: string;\n}\n\nexport interface DropDownFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"DROPDOWN\";\n  defaultStringArrayValue?: string[];\n  multiSelect?: boolean;\n  allValues?: string[];\n  /**\n   * Map from old values not in {@link 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  \"mi\" = \"mi\",\n  \"yd\" = \"yd\",\n  \"ft\" = \"ft\",\n  \"in\" = \"in\",\n  \"ac\" = \"ac\",\n  \"ha\" = \"ha\",\n  \"ft_2\" = \"ft²\",\n  \"gal\" = \"gal\",\n  \"ft_3\" = \"ft³\",\n  \"ton_us\" = \"ton_us\",\n  \"lb\" = \"lb\",\n  \"oz\" = \"oz\",\n  \"mph\" = \"mph\",\n  \"lb_h\" = \"lb/h\",\n  \"lb_s\" = \"lb/s\",\n}\n\nexport enum UnitSi {\n  \"km\" = \"km\",\n  \"m\" = \"m\",\n  \"cm\" = \"cm\",\n  \"mm\" = \"mm\",\n  \"l\" = \"l\",\n  \"kg\" = \"kg\",\n  \"g\" = \"g\",\n  \"ton\" = \"ton\",\n  \"N\" = \"N\",\n  \"kW\" = \"kW\",\n  \"W\" = \"W\",\n  \"kWh\" = \"kWh\",\n  \"kPa\" = \"kPa\",\n  \"Pa\" = \"Pa\",\n  \"bar\" = \"bar\",\n  \"m_s\" = \"m/s\",\n  \"kg_h\" = \"kg/h\",\n  \"kg_s\" = \"kg/s\",\n  \"km_h\" = \"km/h\",\n  \"km_2\" = \"km²\",\n  \"m_2\" = \"m²\",\n  \"m_3\" = \"m³\",\n  \"m_s_2\" = \"m/s²\",\n  \"h\" = \"h\",\n}\nexport interface DecimalNumberFieldDefinition extends AbstractCustomFieldDefinition {\n  type: \"NUMBER\";\n  defaultNumberValue?: 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  defaultNumberValue?: number;\n\n  minimum?: number;\n  maximum?: number;\n\n  isInteger: true;\n}\n\nexport declare type CustomFieldDefinition =\n  | BooleanFieldDefinition\n  | DecimalNumberFieldDefinition\n  | IntegerNumberFieldDefinition\n  | DateFieldDefinition\n  | DropDownFieldDefinition\n  | StringFieldDefinition\n  | EmailFieldDefinition\n  | PhoneNumberFieldDefinition\n  | WebAddressFieldDefinition;\n\nexport interface AssetHomeExtensionManifest extends AbstractExtensionManifest {\n  type: \"ASSET_HOME_EXTENSION\";\n  /**\n   * Conditions for the asset home app to be shown.\n   * It is case insensitive so does not matter how you write the brand.\n   *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n   *\n   * If both model and brand are used/filled out then asset needs to match both model and brand.\n   * If only brand or model is used/filled out then the asset needs to match the filled out property.\n   */\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\n\nexport interface SiteHomeExtensionManifest extends AbstractExtensionManifest {\n  type: \"SITE_HOME_EXTENSION\";\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\nexport interface FleetExtensionManifest extends AbstractExtensionManifest {\n  type: \"FLEET_EXTENSION\";\n\n  /**\n   * Conditions for the asset home app to be shown.\n   * It is case insensitive so does not matter how you write the brand.\n   *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n   *\n   * If both model and brand are used/filled out then asset needs to match both model and brand.\n   * If only brand or model is used/filled out then the asset needs to match the filled out property.\n   */\n  conditions?: {\n    model?: string[] | string;\n    brand?: string[] | string;\n  };\n  menuItem: {\n    name: string | Translations | TranslationKey;\n    icon: string;\n  };\n}\n\nexport interface AdminExtensionManifest extends AbstractExtensionManifest {\n  type: \"ADMIN_EXTENSION\";\n\n  menuItem: {\n    name: string | Translations | TranslationKey;\n  };\n}\n\nexport interface IrisAppSettingsExtensionManifest extends AbstractExtensionManifest {\n  type: \"IRIS_APP_SETTINGS_EXTENSION\";\n}\n\nexport interface ReportExtensionManifest extends AbstractExtensionManifest {\n  type: \"REPORT_EXTENSION\";\n\n  menuItem: {\n    /**\n     * Title of the card in manager\n     */\n    name: string | Translations | TranslationKey;\n\n    /**\n     * Subtitle of the card in manager\n     */\n    description: string | Translations | TranslationKey;\n\n    /**\n     * Icon of the card in manager, must use icons from:\n     * https://apps.dev.iris.trackunit.com/storybook/?path=/docs/components-icon--default\n     */\n    icon: string;\n  };\n}\nexport declare type IrisAppExtension =\n  | AssetHomeExtensionManifest\n  | IrisAppSettingsExtensionManifest\n  | AdminExtensionManifest\n  | FleetExtensionManifest\n  | SiteHomeExtensionManifest\n  | ReportExtensionManifest;\nexport interface ConsentConfig {\n  /**\n   * The application type. Should be one of WEB or BROWSER.\n   */\n  applicationType: \"WEB\" | \"BROWSER\";\n  /**\n   * List of scopes required by the application.\n   */\n  scopes: string[];\n  /**\n   * List of redirect URIs to be used when returning an authorization code.\n   */\n  redirectUris?: string[];\n}\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  | \"ANALYTICS\"\n  | \"DATA_FEEDS\"\n  | \"ENGINES_AND_HYDRAULICS\"\n  | \"SERVICE_AND_MAINTENANCE\"\n  | \"CONSULTANTS\"\n  | \"CONNECTIVITY_AND_NETWORK\"\n  | \"REPORTS\"\n  | \"FAULT_CODES_AND_REMOTE_DIAGNOSTICS\"\n  | \"SAFETY_AND_QUALITY\";\n\nexport declare type SubscriptionPackage =\n  | \"VIEW\"\n  | \"COLLECT\"\n  | \"INSIGHT\"\n  | \"EXPLORE_FLEET_OWNER\"\n  | \"EVOLVE_FLEET_OWNER\"\n  | \"EXPAND_FLEET_OWNER\"\n  | \"EXPLORE_OEM\"\n  | \"EVOLVE_OEM\"\n  | \"EXPAND_OEM\";\n\nexport declare type IrisAppExtensionType =\n  | \"REPORT_EXTENSION\"\n  | \"IRIS_APP_SETTINGS_EXTENSION\"\n  | \"ADMIN_EXTENSION\"\n  | \"FLEET_EXTENSION\"\n  | \"ASSET_HOME_EXTENSION\"\n  | \"SITE_HOME_EXTENSION\";\ninterface Dependencies {\n  [packageName: string]: string;\n}\nexport {};\n"]}
+{"version":3,"file":"irisAppManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppManifest.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  AdminExtensionManifest,\n  AssetHomeExtensionManifest,\n  FleetExtensionManifest,\n  IrisAppSettingsExtensionManifest,\n  ReportExtensionManifest,\n  SiteHomeExtensionManifest,\n} from \"./extensions\";\nimport {\n  BooleanFieldDefinition,\n  DateFieldDefinition,\n  DecimalNumberFieldDefinition,\n  DropDownFieldDefinition,\n  EmailFieldDefinition,\n  IntegerNumberFieldDefinition,\n  PhoneNumberFieldDefinition,\n  StringFieldDefinition,\n  WebAddressFieldDefinition,\n} from \"./irisAppCustomFields\";\nimport { InstallationConfig } from \"./irisAppInstallationConfig\";\nimport { Marketplace, Marketplace_1_0 } from \"./irisAppMarketplace\";\n\nexport interface IrisAppManifest\n  extends Omit<IrisAppManifest_1_0, \"specVersion\" | \"activationMode\" | \"marketplace\" | \"validForAccountIds\"> {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.1\";\n\n  /**\n   * Configuration for the installation of the app.\n   *\n   * Each parameter can be combined to create rules to target specific customers.\n   * Each parameter works as a filter to decide if an app is available to a specific customer.\n   */\n  installation: InstallationConfig;\n\n  /**\n   * A configuration object for the Marketplace entry\n   */\n  marketplace: Marketplace;\n}\n\nexport declare type IrisAppExtension =\n  | AssetHomeExtensionManifest\n  | IrisAppSettingsExtensionManifest\n  | AdminExtensionManifest\n  | FleetExtensionManifest\n  | SiteHomeExtensionManifest\n  | ReportExtensionManifest;\n\nexport declare type CustomFieldDefinition =\n  | BooleanFieldDefinition\n  | DecimalNumberFieldDefinition\n  | IntegerNumberFieldDefinition\n  | DateFieldDefinition\n  | DropDownFieldDefinition\n  | StringFieldDefinition\n  | EmailFieldDefinition\n  | PhoneNumberFieldDefinition\n  | WebAddressFieldDefinition;\n\nexport interface ConsentConfig {\n  /**\n   * The application type. Should be one of WEB or BROWSER.\n   */\n  applicationType: \"WEB\" | \"BROWSER\";\n  /**\n   * List of scopes required by the application.\n   */\n  scopes: string[];\n  /**\n   * List of redirect URIs to be used when returning an authorization code.\n   */\n  redirectUris?: string[];\n}\n\nexport interface Dependencies {\n  [packageName: string]: string;\n}\n\nexport type PublicIrisAppManifest = Omit<IrisAppManifest, \"dependencies\" | \"devDependencies\" | \"installation\"> & {\n  /**\n   * Relative path for this iris app.\n   *\n   * @returns {string} the path to the iris app\n   */\n  irisAppPath: string;\n\n  installation: Omit<InstallationConfig, \"accountIds\">;\n};\n\n/**\n * @deprecated\n */\nexport interface IrisAppManifest_1_0 {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.0\";\n  /**\n   * The name of the exposed module from module federation build into the remoteEntry.js.\n   * Basically the name of your app including workspace name, automatically parsed from your app-specific package.json.\n   */\n  moduleFederationName: string;\n  /**\n   * A configuration object for handling scoped token acquisition.\n   */\n  consentConfig?: ConsentConfig | \"inherit\";\n\n  /**\n   * Controls the visibility of your app and how it is installed.\n   * The different modes are:\n   * - Enabled means its enabled on the subscription when this Iris app is approved.\n   * - Visible means it will be visible to the customer to choose for them selves to enable/disable it.\n   *\n   * - FORCE_ENABLE then it can not be removed by the end customer, and will be installed based on the selected subscription package.\n   * - DEFAULT_ENABLE means it will be enabled when a customer activates a new subscription package.\n   * - ALWAYS_VISIBLE then it will always be visible for all customers.\n   * - CONTROLLED_MANUAL_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, not activating the app.\n   * - CONTROLLED_AUTOMATIC_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, also adding.\n   *\n   * All modes will take into consideration both {@link validForAccountIds} and {@link marketplace}.allowForPackage\n   */\n  activationMode: ActivationMode;\n\n  /**\n   * A list of any external domains that the app needs to communicate with.\n   * The list is audited in the approval step of the app and every external API call\n   * must be listed here to get through the verification process.\n   * Even if it goes through without being listed, your app will fail to call the endpoint.\n   */\n  validDomains: string[];\n  /**\n   * Put `ALL_ACCOUNTS` in if your app is available to all users.\n   * If you want to only make it available to certain users, provide a list of account ID's as strings.\n   */\n  validForAccountIds: \"ALL_ACCOUNTS\" | string[];\n  /**\n   * A configuration object for the Marketplace entry.\n   * Holds all the settings associated with your apps listing on the marketplace.\n   */\n  marketplace: Marketplace_1_0;\n  /**\n   * A full list of runtime dependencies for the App.\n   * Used for performance optimization and security scans.\n   * It is automatically parsed from the package.json in root.\n   */\n  dependencies: Dependencies;\n\n  /**\n   * A full list of dev dependencies for the App.\n   * Used for security scans.\n   */\n  devDependencies: Dependencies;\n\n  /**\n   * A list of extensions to the UI that this app manifest exposes.\n   * Extensions are automatically added when a new extension is generated.\n   * The array contains an import of the extension manifest within the extension.\n   * If an extension is required in multiple apps, the you must manually add it to the arrays of those apps.\n   */\n  extensions: IrisAppExtension[];\n\n  /**\n   * A list of custom field definitions.\n   */\n  customFieldDefinitions?: CustomFieldDefinition[];\n}\n\n/**\n * @deprecated\n */\nexport type ActivationMode =\n  | \"FORCE_ENABLE\"\n  | \"DEFAULT_ENABLE\"\n  | \"ALWAYS_VISIBLE\"\n  | \"CONTROLLED_MANUAL_INSTALLATION\"\n  | \"CONTROLLED_AUTOMATIC_INSTALLATION\";\n"]}

package/src/types/irisAppMarketplace.d.ts

@@ -0,0 +1,93 @@
+import { SubscriptionPackage } from "./subscriptionPackages";
+/**
+ * An image that should be shown in the marketplace for this app.
+ */
+export interface MarketplaceAssetImage {
+    /**
+     * The type of the Asset
+     */
+    type: "IMAGE";
+    /**
+     * A Path to an image in the assets folder of the app.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    path: string;
+}
+/**
+ * A video that should be shown in the marketplace for this app.
+ */
+export interface MarketplaceAssetVideo {
+    /**
+     * The type of the Asset
+     */
+    type: "VIDEO";
+    /**
+     * An url for a youtube video.
+     */
+    url: string;
+}
+/**
+ * A video or image that should be shown in the marketplace for this app.
+ */
+export type MarketplaceAsset = MarketplaceAssetImage | MarketplaceAssetVideo;
+/**
+ * An object of data used when the app is displayed in the marketplace
+ */
+export interface Marketplace extends Omit<Marketplace_1_0, "allowForPackage"> {
+}
+/**
+ * An object of data used when the app is displayed in the marketplace
+ *
+ * @deprecated
+ */
+export interface Marketplace_1_0 {
+    /**
+     * Name used for the marketplace.
+     */
+    name: string;
+    /**
+     * A short summary used for the card on marketplace.
+     * For longer description add a description.md file in the /assets/ folder of the app, and set the fullDescriptionPath.
+     */
+    description: string;
+    /**
+     * The path to a markdown file that explains your app in more detail.
+     * The file must be stored in the assets folder within the app directory to work.
+     * The path is relative to that directory.
+     * For a file apps/my-app/assets/description.md, this parameter should be: description.md
+     */
+    fullDescriptionPath: string;
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown in the marketplace.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    logoPath?: string;
+    /**
+     * A list of relevant tags to make your app easier to find.
+     */
+    tags?: string[];
+    /**
+     * Categories used for the app in the marketplace.
+     */
+    categories?: Category[];
+    /**
+     * Assets (images and videos) used for the marketplace.
+     */
+    assets?: MarketplaceAsset[];
+    /**
+     * Defines with which subscription packages your app is compatible.
+     * Take great care when entering this, as your app might bug out (if it went through the approval phase in the first place)
+     * if what is stated here does not match reality.
+     */
+    allowForPackage: "ALL_PACKAGES" | SubscriptionPackage[];
+    /**
+     * Homepage of the company building the app for the marketplace.
+     */
+    homePageUrl?: string;
+    /**
+     * The direct support page for this app.
+     */
+    supportUrl?: string;
+}
+export declare type Category = "ANALYTICS" | "DATA_FEEDS" | "ENGINES_AND_HYDRAULICS" | "SERVICE_AND_MAINTENANCE" | "CONSULTANTS" | "CONNECTIVITY_AND_NETWORK" | "REPORTS" | "FAULT_CODES_AND_REMOTE_DIAGNOSTICS" | "SAFETY_AND_QUALITY";

package/src/types/irisAppMarketplace.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=irisAppMarketplace.js.map

package/src/types/irisAppMarketplace.js.map

@@ -0,0 +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  | \"ANALYTICS\"\n  | \"DATA_FEEDS\"\n  | \"ENGINES_AND_HYDRAULICS\"\n  | \"SERVICE_AND_MAINTENANCE\"\n  | \"CONSULTANTS\"\n  | \"CONNECTIVITY_AND_NETWORK\"\n  | \"REPORTS\"\n  | \"FAULT_CODES_AND_REMOTE_DIAGNOSTICS\"\n  | \"SAFETY_AND_QUALITY\";\n"]}

package/src/types/mocks.d.ts

@@ -1,2 +1,2 @@
-import { AdminExtensionManifest } from "./irisAppManifest";
+import { AdminExtensionManifest } from "./extensions/adminExtensionManifest";
 export declare const mockAdminExtension: AdminExtensionManifest;