Skip to content
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.

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

Fix event target compatibilty in Safari < 14 #155

Merged
merged 4 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/transcend-io/consent-manager-ui.git"
},
"homepage": "https://github.com/transcend-io/consent-manager-ui",
"version": "4.12.0",
"version": "4.13.0",
"license": "MIT",
"main": "build/ui",
"files": [
Expand Down
87 changes: 61 additions & 26 deletions src/event-target.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,64 @@
/**
* Extend EventTarget to include the Transcend toStringTag
*/
export class TranscendEventTarget extends EventTarget {
#stringTag = 'Transcend';
/* eslint-disable max-classes-per-file */

export const { userAgent } = navigator as {
/** user agent information */
userAgent: string;
};
export const IS_EDGEHTML = userAgent.includes('Edge/');
export const SAFARI_VERSION =
userAgent.includes('Safari/') &&
!userAgent.includes('Chrome/') &&
userAgent.match(/Version\/(\d+)/)?.[1];

/**
* Add Transcend to the string tag
*
* @returns string
*/
get [Symbol.toStringTag](): string {
return this.#stringTag;
}
export const brand = <T>(object: T, brand: string): T =>
Object.defineProperty(object, Symbol.toStringTag, {
value: brand,
enumerable: true,
configurable: false,
writable: false,
});

/**
* Allow airgap.js code to overwrite [Symbol.toStringTag]
*/
set [Symbol.toStringTag](updatedStringTag: string) {
this.#stringTag = updatedStringTag;
}
const TO_STRING_TAG = 'Transcend';

/**
* @param args - EventTarget constructor parameters
*/
constructor(...args: ConstructorParameters<typeof EventTarget>) {
super(...args);
}
}
/**
* EventTarget shim
*/
export const TranscendEventTarget = Object.freeze(
IS_EDGEHTML || (SAFARI_VERSION && +SAFARI_VERSION < 14)
? /**
* EventTarget shim for EdgeHTML and Safari <14
*
* Note that this shim performs worse than a full polyfill,
* but it results in a much smaller build size and maintains
* native compatibility with EventTarget.prototype.
*/
class {
/**
* EventTarget constructor shim
*/
constructor() {
// This is one of the lightest real-EventTarget-inheriting
// structures instantiable in EdgeHTML and Safari <14.
// const target = call(nativeCreateDocument, domImplementation, '', '');
const target = document.implementation.createDocument('', '');
// eslint-disable-next-line no-constructor-return
return brand(target, TO_STRING_TAG);
}
}
: /**
* airgap.js-branded native EventTarget subclass
*/
class extends EventTarget {
/**
* Branding applicator constructor
*
* @param args - EventTarget constructor arguments
*/
constructor(...args: ConstructorParameters<typeof EventTarget>) {
super(...args);
brand(this, TO_STRING_TAG);
}
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
) as any as typeof EventTarget;
/* eslint-enable max-classes-per-file */
Loading