@trackunit/iris-app-api 1.14.7 → 1.14.8

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.14.8 (2026-01-27)
+
+This was a version bump only for iris-app-api to align it with other projects, there were no code changes.
+
 ## 1.14.7 (2026-01-27)
 
 This was a version bump only for iris-app-api to align it with other projects, there were no code changes.

package/package.json

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

package/src/types/irisAppInstallationConfig.d.ts

@@ -56,7 +56,7 @@ interface InstallationConfigBase {
      *
      */
     pricingPlanPolicy: ({
-        [key in SubscriptionPackage]?: InstallationPolicy;
+        [KeySubscriptionPackage in SubscriptionPackage]?: InstallationPolicy;
     } & {
         ALL_PLANS?: never;
     }) | {

package/src/types/irisAppInstallationConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"irisAppInstallationConfig.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppInstallationConfig.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAChC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,2BAA2B,EAAE,6BAA6B;IAC1D,8BAA8B,EAAE,gCAAgC;CACxD,CAAC","sourcesContent":["import { SubscriptionPackage } from \"./subscriptionPackages\";\n\nexport const installationPolicy = {\n  PERMANENT: \"PERMANENT\",\n  PREINSTALLED: \"PREINSTALLED\",\n  ON_DEMAND: \"ON_DEMAND\",\n  ON_DEMAND_REQUIRES_APPROVAL: \"ON_DEMAND_REQUIRES_APPROVAL\",\n  PREINSTALLED_REQUIRES_APPROVAL: \"PREINSTALLED_REQUIRES_APPROVAL\",\n} as const;\nexport type InstallationPolicy = (typeof installationPolicy)[keyof typeof installationPolicy];\n\n/**\n * @deprecated Use `InstallationConfig` instead.\n */\nexport interface InstallationConfigLegacy {\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 `pricingPlans`.\n   *\n   * @deprecated Use `pricingPlanPolicy` instead.\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\" | Array<string>;\n  /**\n   * List of pricing plans the Iris App is available at or `\"ALL_PLANS\"` if available in all plans.\n   *\n   * @deprecated Use `pricingPlanPolicy` instead.\n   */\n  pricingPlans: \"ALL_PLANS\" | Array<SubscriptionPackage>;\n  /**\n   * Ensure that both cannot be set at the same time.\n   */\n  pricingPlanPolicy?: never;\n}\n\ninterface InstallationConfigBase {\n  /**\n   * Installation policy for the app per pricing plan.\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 also filter by `accountIds` if specified.\n   *\n   * If a pricing plan is not specified it means it will not be available for that plan.\n   *\n   */\n  pricingPlanPolicy:\n    | ({ [key in SubscriptionPackage]?: InstallationPolicy } & { ALL_PLANS?: never })\n    | { ALL_PLANS: InstallationPolicy };\n\n  /**\n   * This field is optional and can be used to specify the identifiers of other Iris apps that are included within this bundle.\n   * It helps in managing and organizing multiple apps that are packaged together.\n   */\n  irisAppsInsideBundle?: Array<string>;\n}\n\nexport interface InstallationConfig extends InstallationConfigBase {\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, ...Array<string>];\n}\n\nexport interface InstallationConfigExcludeAccountIds extends InstallationConfigBase {\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\";\n  /**\n   * List of account IDs that can't install this Iris App. Available if accountIds is set to `\"ALL_ACCOUNTS\"`.\n   */\n  excludeAccountIds?: Array<string>;\n}\n\nexport interface InstallationConfigAllowOrganizationIds extends InstallationConfigBase {\n  /**\n   * List of organization IDs that are allowed to install this Iris App.\n   */\n  allowOrganizationIds: Array<string>;\n}"]}
+{"version":3,"file":"irisAppInstallationConfig.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppInstallationConfig.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAChC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,2BAA2B,EAAE,6BAA6B;IAC1D,8BAA8B,EAAE,gCAAgC;CACxD,CAAC","sourcesContent":["import { SubscriptionPackage } from \"./subscriptionPackages\";\n\nexport const installationPolicy = {\n  PERMANENT: \"PERMANENT\",\n  PREINSTALLED: \"PREINSTALLED\",\n  ON_DEMAND: \"ON_DEMAND\",\n  ON_DEMAND_REQUIRES_APPROVAL: \"ON_DEMAND_REQUIRES_APPROVAL\",\n  PREINSTALLED_REQUIRES_APPROVAL: \"PREINSTALLED_REQUIRES_APPROVAL\",\n} as const;\nexport type InstallationPolicy = (typeof installationPolicy)[keyof typeof installationPolicy];\n\n/**\n * @deprecated Use `InstallationConfig` instead.\n */\nexport interface InstallationConfigLegacy {\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 `pricingPlans`.\n   *\n   * @deprecated Use `pricingPlanPolicy` instead.\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\" | Array<string>;\n  /**\n   * List of pricing plans the Iris App is available at or `\"ALL_PLANS\"` if available in all plans.\n   *\n   * @deprecated Use `pricingPlanPolicy` instead.\n   */\n  pricingPlans: \"ALL_PLANS\" | Array<SubscriptionPackage>;\n  /**\n   * Ensure that both cannot be set at the same time.\n   */\n  pricingPlanPolicy?: never;\n}\n\ninterface InstallationConfigBase {\n  /**\n   * Installation policy for the app per pricing plan.\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 also filter by `accountIds` if specified.\n   *\n   * If a pricing plan is not specified it means it will not be available for that plan.\n   *\n   */\n  pricingPlanPolicy:\n    | ({ [KeySubscriptionPackage in SubscriptionPackage]?: InstallationPolicy } & { ALL_PLANS?: never })\n    | { ALL_PLANS: InstallationPolicy };\n\n  /**\n   * This field is optional and can be used to specify the identifiers of other Iris apps that are included within this bundle.\n   * It helps in managing and organizing multiple apps that are packaged together.\n   */\n  irisAppsInsideBundle?: Array<string>;\n}\n\nexport interface InstallationConfig extends InstallationConfigBase {\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, ...Array<string>];\n}\n\nexport interface InstallationConfigExcludeAccountIds extends InstallationConfigBase {\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\";\n  /**\n   * List of account IDs that can't install this Iris App. Available if accountIds is set to `\"ALL_ACCOUNTS\"`.\n   */\n  excludeAccountIds?: Array<string>;\n}\n\nexport interface InstallationConfigAllowOrganizationIds extends InstallationConfigBase {\n  /**\n   * List of organization IDs that are allowed to install this Iris App.\n   */\n  allowOrganizationIds: Array<string>;\n}"]}

package/src/types/irisAppManifest.d.ts

@@ -13,10 +13,10 @@ import { SiteHomeExtensionManifest } from "./extensions/siteHomeExtensionManifes
 import { WidgetExtensionManifest } from "./extensions/widgetExtensionManifest";
 import { BooleanFieldDefinition, DateFieldDefinition, DecimalNumberFieldDefinition, DropDownFieldDefinition, EmailFieldDefinition, IntegerNumberFieldDefinition, JsonFieldDefinition, MonetaryFieldDefinition, PhoneNumberFieldDefinition, StringFieldDefinition, StringListFieldDefinition, WebAddressFieldDefinition } from "./irisAppCustomFields";
 import { InstallationConfig, InstallationConfigAllowOrganizationIds, InstallationConfigExcludeAccountIds, InstallationConfigLegacy } from "./irisAppInstallationConfig";
-import { Marketplace, Marketplace_1_0 } from "./irisAppMarketplace";
+import { Marketplace, MarketplaceOneZero } from "./irisAppMarketplace";
 import { PermissionsPolicy } from "./permissionsPolicy";
 import { Scope } from "./scopes";
-export interface IrisAppManifest extends Omit<IrisAppManifest_1_0, "specVersion" | "activationMode" | "marketplace" | "validForAccountIds" | "consentConfig"> {
+export interface IrisAppManifest extends Omit<IrisAppManifestVersionOneZero, "specVersion" | "activationMode" | "marketplace" | "validForAccountIds" | "consentConfig"> {
     /**
      * A spec version for the manifest.
      * This should not be changed manually.
@@ -119,7 +119,7 @@ export type PublicIrisAppManifest = Omit<IrisAppManifest, "dependencies" | "devD
 /**
  * @deprecated
  */
-export interface IrisAppManifest_1_0 {
+export interface IrisAppManifestVersionOneZero {
     /**
      * A spec version for the manifest.
      * This should not be changed manually.
@@ -148,7 +148,7 @@ export interface IrisAppManifest_1_0 {
      * - CONTROLLED_MANUAL_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, not activating the app.
      * - CONTROLLED_AUTOMATIC_INSTALLATION then it will be controlled by the team that activates the subscription package for the customer, also adding.
      *
-     * All modes will take into consideration both { IrisAppManifest_1_0.validForAccountIds} and { IrisAppManifest_1_0.marketplace}.allowForPackage
+     * All modes will take into consideration both { IrisAppManifestVersionOneZero.validForAccountIds} and { IrisAppManifestVersionOneZero.marketplace}.allowForPackage
      *
      * @deprecated Use `installation.policy` instead.
      */
@@ -171,7 +171,7 @@ export interface IrisAppManifest_1_0 {
      * A configuration object for the Marketplace entry.
      * Holds all the settings associated with your apps listing on the marketplace.
      */
-    marketplace: Marketplace_1_0;
+    marketplace: MarketplaceOneZero;
     /**
      * A full list of runtime dependencies for the App.
      * Used for performance optimization and security scans.

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":"","sourcesContent":["import { CSPDirectives } from \"./cspDirectives\";\nimport { AdminExtensionManifest } from \"./extensions/adminExtensionManifest\";\nimport { AiAgentExtensionManifest } from \"./extensions/aiAgentExtensionManifest\";\nimport { AssetEventsActionsExtensionManifest } from \"./extensions/assetEventsActionsExtensionManifest\";\nimport { AssetHomeExtensionManifest } from \"./extensions/assetHomeExtensionManifest\";\nimport { CustomerHomeExtensionManifest } from \"./extensions/customerHomeExtensionManifest\";\nimport { FleetExtensionManifest } from \"./extensions/fleetExtensionManifest\";\nimport { IrisAppSettingsExtensionManifest } from \"./extensions/irisAppSettingsExtensionManifest\";\nimport { LifecycleExtensionManifest } from \"./extensions/lifecycleExtensionManifest\";\nimport { ReportExtensionManifest } from \"./extensions/reportExtensionManifest\";\nimport { ServerlessFunctionExtensionManifest } from \"./extensions/serverlessFunctionExtensionManifest\";\nimport { SiteHomeExtensionManifest } from \"./extensions/siteHomeExtensionManifest\";\nimport { WidgetExtensionManifest } from \"./extensions/widgetExtensionManifest\";\nimport {\n  BooleanFieldDefinition,\n  DateFieldDefinition,\n  DecimalNumberFieldDefinition,\n  DropDownFieldDefinition,\n  EmailFieldDefinition,\n  IntegerNumberFieldDefinition,\n  JsonFieldDefinition,\n  MonetaryFieldDefinition,\n  PhoneNumberFieldDefinition,\n  StringFieldDefinition,\n  StringListFieldDefinition,\n  WebAddressFieldDefinition,\n} from \"./irisAppCustomFields\";\nimport {\n  InstallationConfig,\n  InstallationConfigAllowOrganizationIds,\n  InstallationConfigExcludeAccountIds,\n  InstallationConfigLegacy,\n} from \"./irisAppInstallationConfig\";\nimport { Marketplace, Marketplace_1_0 } from \"./irisAppMarketplace\";\nimport { PermissionsPolicy } from \"./permissionsPolicy\";\nimport { Scope } from \"./scopes\";\n\nexport interface IrisAppManifest\n  extends Omit<\n    IrisAppManifest_1_0,\n    \"specVersion\" | \"activationMode\" | \"marketplace\" | \"validForAccountIds\" | \"consentConfig\"\n  > {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.1\";\n\n  /**\n   * Which module format the app is built with.\n   * If not set, it is assumed to be \"cjs\".\n   */\n  moduleFormat?: \"esm\" | \"cjs\";\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:\n    | InstallationConfig\n    | InstallationConfigExcludeAccountIds\n    | InstallationConfigAllowOrganizationIds\n    | InstallationConfigLegacy;\n\n  /**\n   * A configuration object for the Marketplace entry\n   */\n  marketplace: Marketplace;\n\n  /**\n   * Scopes needed in app tokens, these scopes are used from the token - when contacting Trackunits backend.\n   */\n  scopes?: RequiredOrOptionalScope | Array<RequiredOrOptionalScope>;\n\n  /**\n   * Configuration of callback to get credentials to call the API after app installation.\n   */\n  tokenCallback?: {\n    url: string;\n  };\n\n  /**\n   * Configuration of the Content Security Policy (CSP) header for the app.\n   *\n   * **Sandbox behavior**: Values specified in the `sandbox` property are merged with the following defaults:\n   * `[\"allow-scripts\", \"allow-downloads\", \"allow-same-origin\", \"allow-forms\", \"allow-popups\"]`\n   *\n   * We support a subset of the CSP directives. The supported directives are:\n   * - [child-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/child-src)\n   * - [connect-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src)\n   * - [font-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src)\n   * - [form-action](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/form-action)\n   * - [frame-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-src)\n   * - [img-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src)\n   * - [media-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/media-src)\n   * - [script-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src)\n   * - [script-src-attr](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src-attr)\n   * - [script-src-elem](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src-elem)\n   * - [style-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src)\n   * - [style-src-attr](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src-attr)\n   * - [style-src-elem](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src-elem)\n   * - [worker-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/worker-src)\n   * - [default-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src)\n   *\n   * More information about CSP can be found [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).\n   */\n  cspHeader?: Partial<CSPDirectives>;\n\n  /**\n   * Configuration of the Permissions policy of the app\n   *\n   * More information about Permissions policies can be found [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy).\n   */\n  permissionsPolicy?: PermissionsPolicy;\n}\n\nexport type RequiredOrOptionalScope = { scope: Scope; optional?: boolean };\n\nexport declare type IrisAppExtension =\n  | AssetHomeExtensionManifest\n  | IrisAppSettingsExtensionManifest\n  | AdminExtensionManifest\n  | FleetExtensionManifest\n  | SiteHomeExtensionManifest\n  | WidgetExtensionManifest\n  | ReportExtensionManifest\n  | CustomerHomeExtensionManifest\n  | AssetEventsActionsExtensionManifest\n  | LifecycleExtensionManifest\n  | ServerlessFunctionExtensionManifest\n  | AiAgentExtensionManifest;\n\nexport declare type CustomFieldDefinition =\n  | BooleanFieldDefinition\n  | DecimalNumberFieldDefinition\n  | IntegerNumberFieldDefinition\n  | DateFieldDefinition\n  | DropDownFieldDefinition\n  | StringFieldDefinition\n  | StringListFieldDefinition\n  | EmailFieldDefinition\n  | PhoneNumberFieldDefinition\n  | WebAddressFieldDefinition\n  | JsonFieldDefinition\n  | MonetaryFieldDefinition;\n\n/**\n * @deprecated\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: Array<string>;\n  /**\n   * List of redirect URIs to be used when returning an authorization code.\n   */\n  redirectUris?: Array<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\"> | Omit<InstallationConfigLegacy, \"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  /**\n   * A configuration object for handling scoped token acquisition.\n   *\n   * @deprecated Use `scopes` instead.\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 { IrisAppManifest_1_0.validForAccountIds} and { IrisAppManifest_1_0.marketplace}.allowForPackage\n   *\n   * @deprecated Use `installation.policy` instead.\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   * @deprecated Use `cspHeader` instead\n   */\n  validDomains?: Array<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\" | Array<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: Array<IrisAppExtension>;\n\n  /**\n   * A list of custom field definitions.\n   */\n  customFieldDefinitions?: Array<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"]}
+{"version":3,"file":"irisAppManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { CSPDirectives } from \"./cspDirectives\";\nimport { AdminExtensionManifest } from \"./extensions/adminExtensionManifest\";\nimport { AiAgentExtensionManifest } from \"./extensions/aiAgentExtensionManifest\";\nimport { AssetEventsActionsExtensionManifest } from \"./extensions/assetEventsActionsExtensionManifest\";\nimport { AssetHomeExtensionManifest } from \"./extensions/assetHomeExtensionManifest\";\nimport { CustomerHomeExtensionManifest } from \"./extensions/customerHomeExtensionManifest\";\nimport { FleetExtensionManifest } from \"./extensions/fleetExtensionManifest\";\nimport { IrisAppSettingsExtensionManifest } from \"./extensions/irisAppSettingsExtensionManifest\";\nimport { LifecycleExtensionManifest } from \"./extensions/lifecycleExtensionManifest\";\nimport { ReportExtensionManifest } from \"./extensions/reportExtensionManifest\";\nimport { ServerlessFunctionExtensionManifest } from \"./extensions/serverlessFunctionExtensionManifest\";\nimport { SiteHomeExtensionManifest } from \"./extensions/siteHomeExtensionManifest\";\nimport { WidgetExtensionManifest } from \"./extensions/widgetExtensionManifest\";\nimport {\n  BooleanFieldDefinition,\n  DateFieldDefinition,\n  DecimalNumberFieldDefinition,\n  DropDownFieldDefinition,\n  EmailFieldDefinition,\n  IntegerNumberFieldDefinition,\n  JsonFieldDefinition,\n  MonetaryFieldDefinition,\n  PhoneNumberFieldDefinition,\n  StringFieldDefinition,\n  StringListFieldDefinition,\n  WebAddressFieldDefinition,\n} from \"./irisAppCustomFields\";\nimport {\n  InstallationConfig,\n  InstallationConfigAllowOrganizationIds,\n  InstallationConfigExcludeAccountIds,\n  InstallationConfigLegacy,\n} from \"./irisAppInstallationConfig\";\nimport { Marketplace, MarketplaceOneZero } from \"./irisAppMarketplace\";\nimport { PermissionsPolicy } from \"./permissionsPolicy\";\nimport { Scope } from \"./scopes\";\n\nexport interface IrisAppManifest\n  extends Omit<\n    IrisAppManifestVersionOneZero,\n    \"specVersion\" | \"activationMode\" | \"marketplace\" | \"validForAccountIds\" | \"consentConfig\"\n  > {\n  /**\n   * A spec version for the manifest.\n   * This should not be changed manually.\n   */\n  specVersion: \"1.1\";\n\n  /**\n   * Which module format the app is built with.\n   * If not set, it is assumed to be \"cjs\".\n   */\n  moduleFormat?: \"esm\" | \"cjs\";\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:\n    | InstallationConfig\n    | InstallationConfigExcludeAccountIds\n    | InstallationConfigAllowOrganizationIds\n    | InstallationConfigLegacy;\n\n  /**\n   * A configuration object for the Marketplace entry\n   */\n  marketplace: Marketplace;\n\n  /**\n   * Scopes needed in app tokens, these scopes are used from the token - when contacting Trackunits backend.\n   */\n  scopes?: RequiredOrOptionalScope | Array<RequiredOrOptionalScope>;\n\n  /**\n   * Configuration of callback to get credentials to call the API after app installation.\n   */\n  tokenCallback?: {\n    url: string;\n  };\n\n  /**\n   * Configuration of the Content Security Policy (CSP) header for the app.\n   *\n   * **Sandbox behavior**: Values specified in the `sandbox` property are merged with the following defaults:\n   * `[\"allow-scripts\", \"allow-downloads\", \"allow-same-origin\", \"allow-forms\", \"allow-popups\"]`\n   *\n   * We support a subset of the CSP directives. The supported directives are:\n   * - [child-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/child-src)\n   * - [connect-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src)\n   * - [font-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src)\n   * - [form-action](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/form-action)\n   * - [frame-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-src)\n   * - [img-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src)\n   * - [media-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/media-src)\n   * - [script-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src)\n   * - [script-src-attr](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src-attr)\n   * - [script-src-elem](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src-elem)\n   * - [style-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src)\n   * - [style-src-attr](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src-attr)\n   * - [style-src-elem](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src-elem)\n   * - [worker-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/worker-src)\n   * - [default-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src)\n   *\n   * More information about CSP can be found [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).\n   */\n  cspHeader?: Partial<CSPDirectives>;\n\n  /**\n   * Configuration of the Permissions policy of the app\n   *\n   * More information about Permissions policies can be found [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy).\n   */\n  permissionsPolicy?: PermissionsPolicy;\n}\n\nexport type RequiredOrOptionalScope = { scope: Scope; optional?: boolean };\n\nexport declare type IrisAppExtension =\n  | AssetHomeExtensionManifest\n  | IrisAppSettingsExtensionManifest\n  | AdminExtensionManifest\n  | FleetExtensionManifest\n  | SiteHomeExtensionManifest\n  | WidgetExtensionManifest\n  | ReportExtensionManifest\n  | CustomerHomeExtensionManifest\n  | AssetEventsActionsExtensionManifest\n  | LifecycleExtensionManifest\n  | ServerlessFunctionExtensionManifest\n  | AiAgentExtensionManifest;\n\nexport declare type CustomFieldDefinition =\n  | BooleanFieldDefinition\n  | DecimalNumberFieldDefinition\n  | IntegerNumberFieldDefinition\n  | DateFieldDefinition\n  | DropDownFieldDefinition\n  | StringFieldDefinition\n  | StringListFieldDefinition\n  | EmailFieldDefinition\n  | PhoneNumberFieldDefinition\n  | WebAddressFieldDefinition\n  | JsonFieldDefinition\n  | MonetaryFieldDefinition;\n\n/**\n * @deprecated\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: Array<string>;\n  /**\n   * List of redirect URIs to be used when returning an authorization code.\n   */\n  redirectUris?: Array<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\"> | Omit<InstallationConfigLegacy, \"accountIds\">;\n};\n\n/**\n * @deprecated\n */\nexport interface IrisAppManifestVersionOneZero {\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  /**\n   * A configuration object for handling scoped token acquisition.\n   *\n   * @deprecated Use `scopes` instead.\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 { IrisAppManifestVersionOneZero.validForAccountIds} and { IrisAppManifestVersionOneZero.marketplace}.allowForPackage\n   *\n   * @deprecated Use `installation.policy` instead.\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   * @deprecated Use `cspHeader` instead\n   */\n  validDomains?: Array<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\" | Array<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: MarketplaceOneZero;\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: Array<IrisAppExtension>;\n\n  /**\n   * A list of custom field definitions.\n   */\n  customFieldDefinitions?: Array<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

@@ -33,7 +33,7 @@ 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"> {
+export interface Marketplace extends Omit<MarketplaceOneZero, "allowForPackage"> {
     /**
      * Indicate if the app should be shown in the Trackunit Marketplace.
      */
@@ -44,7 +44,7 @@ export interface Marketplace extends Omit<Marketplace_1_0, "allowForPackage"> {
  *
  * @deprecated
  */
-export interface Marketplace_1_0 {
+export interface MarketplaceOneZero {
     /**
      * Name used for the marketplace.
      */

package/src/types/irisAppMarketplace.js.map

@@ -1 +1 @@
-{"version":3,"file":"irisAppMarketplace.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppMarketplace.ts"],"names":[],"mappings":";;;AAyGa,QAAA,cAAc,GAAG;IAC5B,kBAAkB;IAClB,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,eAAe;IACf,sBAAsB;IACtB,sBAAsB;IACtB,uBAAuB;IACvB,mBAAmB;IACnB,mBAAmB;IACnB,yBAAyB;IACzB,gBAAgB;CACR,CAAC","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   * Indicate if the app should be shown in the Trackunit Marketplace.\n   */\n  showInMarketplace: boolean;\n}\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?: Array<string>;\n  /**\n   * Categories used for the app in the marketplace.\n   */\n  categories?: Array<Category>;\n  /**\n   * Assets (images and videos) used for the marketplace.\n   */\n  assets?: Array<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\" | Array<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 const CategoryValues = [\n  \"ASSET_MANAGEMENT\",\n  \"COMPLIANCE\",\n  \"CONSULTANTS\",\n  \"DATA_FEEDS\",\n  \"DOCUMENTATION\",\n  \"EFFECTIVE_OPERATIONS\",\n  \"EQUIPMENT_PROTECTION\",\n  \"OEM_PARTNER_SOLUTIONS\",\n  \"OPTIMIZE_BUSINESS\",\n  \"RENTAL_MANAGEMENT\",\n  \"SERVICE_AND_MAINTENANCE\",\n  \"SUSTAINABILITY\",\n] as const;\n\nexport declare type Category = (typeof CategoryValues)[number];\n"]}
+{"version":3,"file":"irisAppMarketplace.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-api/src/types/irisAppMarketplace.ts"],"names":[],"mappings":";;;AAyGa,QAAA,cAAc,GAAG;IAC5B,kBAAkB;IAClB,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,eAAe;IACf,sBAAsB;IACtB,sBAAsB;IACtB,uBAAuB;IACvB,mBAAmB;IACnB,mBAAmB;IACnB,yBAAyB;IACzB,gBAAgB;CACR,CAAC","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<MarketplaceOneZero, \"allowForPackage\"> {\n  /**\n   * Indicate if the app should be shown in the Trackunit Marketplace.\n   */\n  showInMarketplace: boolean;\n}\n\n/**\n * An object of data used when the app is displayed in the marketplace\n *\n * @deprecated\n */\nexport interface MarketplaceOneZero {\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?: Array<string>;\n  /**\n   * Categories used for the app in the marketplace.\n   */\n  categories?: Array<Category>;\n  /**\n   * Assets (images and videos) used for the marketplace.\n   */\n  assets?: Array<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\" | Array<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 const CategoryValues = [\n  \"ASSET_MANAGEMENT\",\n  \"COMPLIANCE\",\n  \"CONSULTANTS\",\n  \"DATA_FEEDS\",\n  \"DOCUMENTATION\",\n  \"EFFECTIVE_OPERATIONS\",\n  \"EQUIPMENT_PROTECTION\",\n  \"OEM_PARTNER_SOLUTIONS\",\n  \"OPTIMIZE_BUSINESS\",\n  \"RENTAL_MANAGEMENT\",\n  \"SERVICE_AND_MAINTENANCE\",\n  \"SUSTAINABILITY\",\n] as const;\n\nexport declare type Category = (typeof CategoryValues)[number];\n"]}