Add AirgapAPI['getModules']

Author: marcinkostecki

package.json

@@ -2,7 +2,7 @@
   "author": "Transcend Inc.",
   "name": "@transcend-io/airgap.js-types",
   "description": "TypeScript types for airgap.js interoperability with custom consent UIs",
-  "version": "12.15.3",
+  "version": "12.16.0",
   "homepage": "https://github.com/transcend-io/airgap.js-types",
   "repository": {
     "type": "git",

src/core.ts

@@ -225,6 +225,30 @@ export type CookieWatcher = (event: IPendingCookieMutation) => void;
 /** Event types (for purpose resolution) */
 export type TrackingEventType = 'request' | 'cookie';
 
+/**
+ * Module type
+ */
+type ModuleKind = 'ui' | 'plugin' | 'policies';
+
+/** JS module descriptor */
+interface ModuleDescriptor {
+  /** Module URL */
+  url: string;
+  /** Module ID (defaults to URI if not provided) */
+  id?: string;
+  /** Module name */
+  name?: string;
+  /** Module kind (default: plugin) */
+  kind?: ModuleKind;
+  /** Module media type (default: application/ecmascript) */
+  type?:
+    | 'module' // ES module
+    | 'application/ecmascript' // default for kind={plugin, ui}
+    | 'application/vnd.transcend.governance-policies+json'; // default for kind=policies
+  /** Should module be loaded synchronously? (default: false) */
+  sync?: boolean;
+}
+
 /** airgap.js API */
 export type AirgapAPI = Readonly<{
   /** Embedded request watchers */
@@ -356,6 +380,8 @@ export type AirgapAPI = Readonly<{
   export(options?: AirgapExportOptions): AirgapQueues;
   /** Get a list of legal regimes that are potentially applicable to the user */
   getRegimes(): Set<PrivacyRegime>;
+  /** Get a list of active modules */
+  getModules(): ModuleDescriptor[];
   /** Get a list of detected active user agent privacy signals */
   getPrivacySignals(): Set<UserPrivacySignal>;
   /** Toggle all airgap.js protections. Auth must be a pre-airgap.js or airgap.js script 'load' event. Returns success status */