@repobit/dex-launch 0.3.3 → 1.2.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.0](https://github.com/bitdefender/dex-core/compare/@repobit/dex-launch@0.3.3...@repobit/dex-launch@1.2.0) (2025-04-02)
+
+
+### Features
+
+* **DEX-21820:** added target tests ([6436b75](https://github.com/bitdefender/dex-core/commit/6436b75ad1937da0f9bd932c86c3fe8ba0bf3d54))
+* **DEX-22137:** added documentation ([7aa536f](https://github.com/bitdefender/dex-core/commit/7aa536fbfb44290a30f03819d1e84315310f1303))
+
+
+
+## [1.1.0](https://github.com/bitdefender/dex-core/compare/@repobit/dex-launch@0.3.3...@repobit/dex-launch@1.1.0) (2025-04-02)
+
+
+### Features
+
+* **DEX-21820:** added target tests ([6436b75](https://github.com/bitdefender/dex-core/commit/6436b75ad1937da0f9bd932c86c3fe8ba0bf3d54))
+* **DEX-22137:** added documentation ([7aa536f](https://github.com/bitdefender/dex-core/commit/7aa536fbfb44290a30f03819d1e84315310f1303))
+
+
+
 ## [0.3.3](https://github.com/bitdefender/dex-core/compare/@repobit/dex-launch@0.3.2...@repobit/dex-launch@0.3.3) (2025-03-26)
 
 

package/README.md

@@ -0,0 +1,80 @@
+# `@repobit/dex-launch`
+
+# Adobe Launch Loader
+
+Adobe Launch Loader is a lightweight utility that simplifies the process of dynamically loading Adobe Launch scripts based on a specified environment. It leverages constants and script-loading functions from the dex-utils package to construct the correct URL for the Adobe Launch script and then load it asynchronously into your application.
+
+---
+
+## Overview
+
+The Adobe Launch Loader provides a single abstract class with a static method to load the Adobe Launch script. By specifying an environment (such as `'prod'`, `'stage'`, or `'dev'`), the loader builds the script URL using predefined constants and loads the script into the document. This enables seamless integration with Adobe Launch without hardcoding script URLs in your code.
+
+---
+
+## Key Features
+
+- **Dynamic Script Loading:**  
+  Automatically builds and loads the Adobe Launch script URL based on the given environment.
+
+- **Environment Flexibility:**  
+  Supports multiple environments through a mapping of environment keys to script paths.
+
+- **Asynchronous Operation:**  
+  Uses asynchronous loading, ensuring that your application can continue operating while the script is being loaded.
+
+- **Easy Integration:**  
+  Requires minimal configuration and integrates seamlessly with your existing project using the dex-utils package.
+
+---
+
+## Installation
+
+This package relies on external dependencies:
+- @repobit/dex-utils
+
+```bash
+npm install @repobit/dex-launch
+```
+
+# Launch Class
+## Type: Abstract Class
+
+## Static Methods:
+- ### load(environment: string): Promise<void>
+  - Description:
+    Constructs the Adobe Launch script URL based on the provided environment and asynchronously loads the script using the loadScript utility from dex-utils.
+  - Parameters:
+    environment: string – The current environment (e.g., 'prod', 'stage', or 'dev').
+  - Return Type:
+    Returns a `Promise<void>` which resolves when the script has been successfully loaded.
+
+## Use Case:
+Call this method during your application initialization to dynamically load the Adobe Launch script appropriate for your environment. This approach helps keep your configuration dynamic and decoupled from your codebase.
+
+# Usage Example
+Below is an example of how to use the Adobe Launch Loader in your application:
+
+```typescript
+import Launch from '@repobit/dex-launch';
+
+// Load the Adobe Launch script for the production environment
+await Launch.load('prod');
+
+// After loading, the Adobe Launch script is available for use in your application.
+```
+
+If one wishes to use both Launch and Target in the same project, I recommend using a structure similar to the one below:
+
+```typescript
+import Launch from '@repobit/dex-launch';
+import Target from '@repobit/dex-target';
+
+try {
+  await Launch.load('prod');
+} catch (e) {
+  Target.abort();
+}
+```
+
+Since Target is dependent on Launch, it is better to Abort all Target operations when we are sure that Launch will not load.

package/dist/src/index.d.ts

@@ -1,3 +1,3 @@
 export default abstract class Launch {
-    static load(environment: string): Promise<void>;
+    static load(environment: 'dev' | 'stage' | 'prod'): Promise<void>;
 }

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAgB,MAAM;IAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAmB;QAC1C,MAAM,oBAAoB,GAAG,GAAG,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAE1G,MAAM,UAAU,CAAC,oBAAoB,CAAC,CAAC;IACzC,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAgB,MAAM;IAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAqC;QAC5D,MAAM,oBAAoB,GAAG,GAAG,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAE1G,MAAM,UAAU,CAAC,oBAAoB,CAAC,CAAC;IACzC,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repobit/dex-launch",
-  "version": "0.3.3",
+  "version": "1.2.0",
   "description": "Client for Adobe Launch",
   "author": "Constantin Ioan Mihai <iconstantin@bitdefender.com>",
   "homepage": "https://github.com/bitdefender/dex-core#readme",
@@ -35,5 +35,5 @@
   "volta": {
     "node": "22.14.0"
   },
-  "gitHead": "64dd7dca1e451796a1fafe016b7a8d361523754f"
+  "gitHead": "023c3635baa1d3b93ca2fa5876de81e383d34799"
 }