Skip to content

Add AirgapAPI['getModules'] #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcinkostecki wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −1
Open

Add AirgapAPI['getModules'] #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
30 changes: 30 additions & 0 deletions src/core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,34 @@ 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;
}

Copy link
Copy Markdown
Member Author

@marcinkostecki marcinkostecki Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eligrey is it OK to add ModuleKind and ModuleDescriptor like this?

Copy link
Copy Markdown
Member Author

@marcinkostecki marcinkostecki Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now also ActiveModuleDescriptor?

Copy link
Copy Markdown
Member

@eligrey eligrey Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this lgtm! I missed this PR initially

/** Active JS module descriptor */
export type ActiveModuleDescriptor = Omit<ModuleDescriptor, 'id'> &
Required<Pick<ModuleDescriptor, 'id'>>;

/** airgap.js API */
export type AirgapAPI = Readonly<{
/** Embedded request watchers */
Expand Down Expand Up @@ -356,6 +384,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(): ActiveModuleDescriptor[];
/** 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 */
Expand Down