diff --git a/pr-preview/pr-252/api/KeySystems.html b/pr-preview/pr-252/api/KeySystems.html
deleted file mode 100644
index d7af0002..00000000
--- a/pr-preview/pr-252/api/KeySystems.html
+++ /dev/null
@@ -1,3 +0,0 @@
-Interface: KeySystems Represents the result of building key systems.
Members :object A mapping of DRM types to their corresponding key systems information. For "FAIRPLAY" type, it includes a structure with certificate and license URIs; for other types, it's a string representing the license URL.
Properties Name Type Description x:object | string string
x:string string.certificateUri
x:string string.licenseUri
Interface: MainResourceWithKeySystems MainResourceWithKeySystems Class: MediaComposition Represents the composition of media content.
Properties Name Type Description chapterUrnstring URN (Uniform Resource Name) of the associated chapter.
segmentUrnstring URN of the associated segment.
episodeEpisode Associated episode.
showShow Associated show.
channelChannel Associated channel.
chapterListArray.<Chapter > List of associated chapters.
topicListArray.<Topic > List of associated topics.
analyticsDataObject.<String, String> Analytics data associated with the media composition.
analyticsMetadataObject.<String, String> Metadata associated with analytics for the media composition.
Methods (urn) → {Chapter } Find a chapter by its URN.
Parameters: Name Type Description urnString
() → {Segment |undefined} Return a segment from main chapter following segmentUrn in mediaComposition.
(urn) → {Array.<Resource >|undefined} Find resource list by URN.
Parameters: Name Type Description urnString
Returns: Type: Array.<Resource > | undefined () → {Array.<Chapter >} () → {Array.<Subtitle >} Filter external text tracks that are already available internally.
Rules:
TTML format is filtered
If both are empty that means only internal text tracks will be displayed to the user as they are automatically loaded by the player.
If subtitleInformationList is missing from the MediaComposition and subtitleList is available but the media contains internal text tracks that are also available internally. It will result on a duplication client side.
If subtitleList and subtitleInformationList a merge between both will be operated, removing the external text tracks already available internally.
() → {string|undefined} Block reason for main chapter. This also uses current date for STARTDATE.
Returns: undefined if main chapter is not blocked
Type: string | undefined () → {Array.<Segment >} Get blocked segments from the main chapter.
() → {Chapter } Get the mediaComposition's main chapter.
() → {String|undefined} Get the main chapter's image URL decorated with default width and format.
Returns: Type: String | undefined () → {Array.<MainResource >} () → {Array.<Segment >} Get segments of the main chapter ordered by markIn.
() → {Array.<TimeInterval >} Retrieves an array of time intervals associated with the main chapter.
Returns: An array of time intervals.
Type: Array.<TimeInterval > () → {Date} Compute a date from which this content is valid. Always return a date object.
Returns: date specified in media composition or EPOCH when no date present.
Type: Date (analyticsData) → {Object.<string, string>} Get merged analytics data.
Parameters: Name Type Description analyticsDataObject.<string, string>
Returns: Type: Object.<string, string> Get merged analytics metadata.
Parameters: Name Type Description analyticsMetadataObject.<string, string>
Returns: Merged analytics metadata.
Type: Object.<string, string> () → {Array.<Resource >} Get the chapter's resource list
Class: Player () This class extends the video.js Player.
Methods (trackSelectoropt ) → {module:video.js/dist/types/tracks/audio-track~default|undefined} A getter/setter for the media's audio track. Activates the audio track according to the language and kind properties. Falls back on the first audio track found if the kind property is not satisfied.
Parameters: Name Type Attributes Description trackSelectorTrackSelector <optional>
Returns: Type: module:video.js/dist/types/tracks/audio-track~default | undefined Examples // Get the current audio track
-player.audioTrack();// Activate an audio track based on language and kind properties
-player.audioTrack({language:'en', kind:'description'});// Activate first audio track found corresponding to language
-player.audioTrack({language:'fr'});() → {Array.<{start: number, end: number}>} Calculates an array of ranges based on the buffered() data.
Returns: An array of objects representing start and end points of buffered ranges.
Type: Array.<{start: number, end: number}> () → {number} Get the percent (as a decimal) of the media that's been played. This method is not a part of the native HTML video API.
Live streams with DVR are not currently supported.
Returns: A decimal between 0 and 1 representing the percent that is played 0 being 0% and 1 being 100%
Type: number () → {Array.<{start: number, end: number}>} Get an array of ranges based on the played data.
Returns: An array of objects representing start and end points of played ranges.
Type: Array.<{start: number, end: number}> () → {Array.<{start: number, end: number}>} Calculates an array of ranges based on the seekable() data.
Returns: An array of objects representing start and end points of seekable ranges.
Type: Array.<{start: number, end: number}> (trackSelectoropt ) → {module:video.js/dist/types/tracks/text-track~default|undefined} A getter/setter for the media's text track. Activates the text track according to the language and kind properties. Falls back on the first text track found if the kind property is not satisfied. Disables all subtitle tracks that are showing if the trackSelector is truthy but does not satisfy any condition.
Parameters: Name Type Attributes Description trackSelectorTrackSelector <optional>
Returns: Type: module:video.js/dist/types/tracks/text-track~default | undefined Examples // Get the current text track
-player.textTrack();// Disable all text tracks has a side effect
-player.textTrack('off');
-player.textTrack({});// Activate an text track based on language and kind properties
-player.textTrack({language:'en', kind:'captions'});// Activate first text track found corresponding to language
-player.textTrack({language:'fr'});Class: SrgSsr Methods (static) addBlockedSegments(player, segmentsopt ) Adds blocked segments to the player.
Parameters: Name Type Attributes Default Description playermodule:video.js/dist/types/player~default segmentsArray.<Segment > <optional> []
(static) addChapters(player, chapterUrn, chaptersopt ) Adds chapters to the player.
Parameters: Name Type Attributes Default Description playermodule:video.js/dist/types/player~default chapterUrnstring The URN of the main chapter.
chaptersArray.<Chapter > <optional> []
(static) addIntervals(player, intervalsopt ) Adds intervals to the player.
Parameters: Name Type Attributes Default Description playermodule:video.js/dist/types/player~default intervalsArray.<TimeInterval > <optional> []
(static) addRemoteTextTracks(player, subtitlesopt ) Adds remote text tracks from an array of subtitles.
Parameters: Name Type Attributes Default Description playermodule:video.js/dist/types/player~default subtitlesArray.<Subtitle > <optional> []
(static) addTextTrackCue(textTrack, data) Add a new cue to a text track with the given data.
(static) addTextTracks(player, srcMediaObj) Add multiple text tracks to the player.
(static) blockingReason(player, srcMediaObj) → {undefined|Boolean} Set a blocking reason according to the block reason returned by mediaData.
Returns: Type: undefined | Boolean (async, static) composeAkamaiResources(resources) → {Promise.<Array.<MainResourceWithKeySystems >>} Add the Akamai token to all resources if at least one of them has tokenType set to Akamai.
(static) composeKeySystemsResources(resources) → {Array.<MainResourceWithKeySystems >} Add the keySystems property to all resources if at least one of them has DRM.
(static) composeMainResources(mediaComposition) → {Promise.<Array.<MainResourceWithKeySystems >>} Get the main resources from a mediaComposition. May add an Akamai token or key systems if required by the resource.
Compose source options with media data. MediaData properties from source options overwrite mediaData from IL.
Parameters: Name Type Description srcObjany Properties Name Type Description mediaDataany overrides or adds metadata to the composed mediaData.
disableTrackersboolean
resourceMainResourceWithKeySystems
(static) createTextTrack(player, trackId) → {Promise.<TextTrack>} Create a new metadata text track.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default trackIdString Text track unique ID
Returns: Type: Promise.<TextTrack> (static) cuechangeEventProxy(player) Proxy SRG SSR chapters and intervals cuechange events at player level.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
(static) dataProvider(player) → {DataProvider} SRG SSR data provider singleton.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
Returns: Type: DataProvider (static) dataProviderError(player, error) → {undefined|true} Set an error if something goes wrong with the data provider.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default errorObject
Returns: Type: undefined | true (static) error(player, error) Parameters: Name Type Description playermodule:video.js/dist/types/player~default errorObject
(static) filterIncompatibleResources(resources) → {Array.<MainResource >} Filter out incompatible resources such as RTMP and HDS.
Parameters: Name Type Description resourcesArray.<MainResource > Resources to filter
(static) getBlockedSegment(player) → {VTTCue|undefined} Get the current blocked segment from the player.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
Returns: The blocked segment cue object, or undefined
Type: VTTCue | undefined (static) getBlockedSegmentByTime(player, currentTime) → {VTTCue|undefined} Get the VTT cue of a blocked segment.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default currentTimeNumber
Returns: The VTT cue of a blocked segment, or undefined
Type: VTTCue | undefined Get mediaComposition from an URN.
Parameters: Name Type Description urnString requestHandlerfunction
Get the mediaData most likely to be compatible depending on the browser.
Get the source media object.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default srcObjany
(static) handleCurrentTime(player, currentTime) → {number} Handles the middleware's currentTime function.
If the current time is between the start and end of a blocked segment, the blocked portion will be skipped. Note : This function should disappear as soon as this behavior is supported on the packaging side.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default currentTimenumber
(static) handleSetCurrentTime(player, currentTime) → {number} Handles the middleware's setCurrentTime function.
Modify the current time if the value is between the start and end of a blocked segment. Note : This function should disappear as soon as this behavior is supported on the packaging side.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default currentTimenumber
(async, static) handleSetSource(player, srcObj, next) → {Promise.<any>} Handles the middleware's setSource function.
This function allows to:
resolve a URN into media that can be played by the player initialize media playback tracking update the title bar handle blocking reasons add remote subtitles Parameters: Name Type Description playermodule:video.js/dist/types/player~default srcObjany nextfunction
Returns: Type: Promise.<any> (static) middleware(player) → {Object} Middleware to resolve SRG SSR URNs into playable media.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
(static) pillarboxMonitoring(player) → {PillarboxMonitoring} PillarboxMonitoring monitoring singleton.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
Returns: instance of PillarboxMonitoring
Type: PillarboxMonitoring (static) srgAnalytics(player) SRG SSR analytics singleton.
Parameters: Name Type Description playermodule:video.js/dist/types/player~default
(static) updatePoster(player, srcMediaObj, imageService) Parameters: Name Type Description playermodule:video.js/dist/types/player~default srcMediaObjComposedSrcMediaData imageServiceImage
(static) updateTitleBar(player, srcMediaObj) Update player titleBar with title and description.
Source: components/player.js import videojs from 'video.js';
-import 'videojs-contrib-eme';
-
-/**
- * @ignore
- * @type {typeof import('video.js/dist/types/player').default}
- */
-const vjsPlayer = videojs.getComponent('player');
-
-/**
- * This class extends the video.js Player.
- *
- * @class Player
- * @see https://docs.videojs.com/player
- */
-class Player extends vjsPlayer {
- constructor(tag, options, ready) {
- /**
- * Configuration for plugins.
- *
- * @see [Video.js Plugins Option]{@link https://videojs.com/guides/options/#plugins}
- * @type {Object}
- * @property {boolean} eme - Enable the EME (Encrypted Media Extensions) plugin.
- */
- options = videojs.obj.merge(options, { plugins: { eme: true }});
- super(tag, options, ready);
- }
-
- /**
- * A getter/setter for the media's audio track.
- * Activates the audio track according to the language and kind properties.
- * Falls back on the first audio track found if the kind property is not satisfied.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/kind
- * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/language
- *
- * @param {import('./typedef').TrackSelector} [trackSelector]
- *
- * @example
- * // Get the current audio track
- * player.audioTrack();
- *
- * @example
- * // Activate an audio track based on language and kind properties
- * player.audioTrack({language:'en', kind:'description'});
- *
- * @example
- * // Activate first audio track found corresponding to language
- * player.audioTrack({language:'fr'});
- *
- * @return {import('video.js/dist/types/tracks/audio-track').default | undefined} The
- * currently enabled audio track. See {@link https://docs.videojs.com/audiotrack}.
- */
- audioTrack(trackSelector) {
- const audioTracks = Array.from(this.player().audioTracks());
-
- if (!trackSelector) {
- return audioTracks.find((audioTrack) => audioTrack.enabled);
- }
-
- const { kind, language } = trackSelector;
- const audioTrack =
- audioTracks.find(
- (audioTrack) =>
- audioTrack.language === language && audioTrack.kind === kind
- ) || audioTracks.find((audioTrack) => audioTrack.language === language);
-
- if (audioTrack) {
- audioTrack.enabled = true;
- }
-
- return audioTrack;
- }
-
- /**
- * Calculates an array of ranges based on the `buffered()` data.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered
- *
- * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of buffered ranges.
- */
- bufferedRanges() {
- const ranges = [];
-
- for (let i = 0; i < this.buffered().length; i++) {
- const start = this.buffered().start(i);
- const end = this.buffered().end(i);
-
- ranges.push({ start, end });
- }
-
- return ranges;
- }
-
- /**
- * Get the percent (as a decimal) of the media that's been played.
- * This method is not a part of the native HTML video API.
- *
- * Live streams with DVR are not currently supported.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
- *
- * @return {number}
- * A decimal between 0 and 1 representing the percent
- * that is played 0 being 0% and 1 being 100%
- */
- playedPercent() {
- if (!Number.isFinite(this.duration())) return NaN;
-
- let timePlayed = 0;
-
- for (let i = 0; i != this.played().length; i++) {
- timePlayed += this.played().end(i) - this.played().start(i);
- }
-
- const percentPlayed = timePlayed / this.duration();
-
- return percentPlayed;
- }
-
- /**
- * Get an array of ranges based on the `played` data.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
- *
- * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of played ranges.
- */
- playedRanges() {
- const ranges = [];
-
- for (let i = 0; i < this.played().length; i++) {
- const start = this.played().start(i);
- const end = this.played().end(i);
-
- ranges.push({ start, end });
- }
-
- return ranges;
- }
-
- /**
- * Calculates an array of ranges based on the `seekable()` data.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable
- *
- * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of seekable ranges.
- */
- seekableRanges() {
- const ranges = [];
-
- for (let i = 0; i < this.seekable().length; i++) {
- const start = this.seekable().start(i);
- const end = this.seekable().end(i);
-
- ranges.push({ start, end });
- }
-
- return ranges;
- }
-
- /**
- * A getter/setter for the media's text track.
- * Activates the text track according to the language and kind properties.
- * Falls back on the first text track found if the kind property is not satisfied.
- * Disables all subtitle tracks that are `showing` if the `trackSelector` is truthy but does not satisfy any condition.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/kind
- * @see https://developer.mozilla.org/en-US/docs/Web/API/textTrack/language
- *
- * @param {import('./typedef').TrackSelector} [trackSelector]
- *
- * @example
- * // Get the current text track
- * player.textTrack();
- *
- * @example
- * // Disable all text tracks has a side effect
- * player.textTrack('off');
- * player.textTrack({});
- *
- * @example
- * // Activate an text track based on language and kind properties
- * player.textTrack({language:'en', kind:'captions'});
- *
- * @example
- * // Activate first text track found corresponding to language
- * player.textTrack({language:'fr'});
- *
- * @return {import('video.js/dist/types/tracks/text-track').default | undefined} The
- * currently enabled text track. See {@link https://docs.videojs.com/texttrack}.
- */
- textTrack(trackSelector) {
- const textTracks = Array.from(this.player().textTracks()).filter(
- (textTrack) => !['chapters', 'metadata'].includes(textTrack.kind)
- );
-
- if (!trackSelector) {
- return textTracks.find((textTrack) => textTrack.mode === 'showing');
- }
-
- textTracks.forEach((textTrack) => (textTrack.mode = 'disabled'));
-
- const { kind, language } = trackSelector;
- const textTrack =
- textTracks.find((textTrack) => {
- if (textTrack.language === language && textTrack.kind === kind) {
- textTrack.mode = 'showing';
- }
-
- return textTrack.mode === 'showing';
- }) ||
- textTracks.find((textTrack) => {
- if (textTrack.language === language) {
- textTrack.mode = 'showing';
- }
-
- return textTrack.mode === 'showing';
- });
-
- return textTrack;
- }
-}
-
-videojs.registerComponent('player', Player);
-
-export default Player;
-Source: components/typedef.ts /**
- * The track to select
- */
-export type TrackSelector = {
- /**
- * The track language
- */
- language: string;
- /**
- * The track kind
- */
- kind: string;
-};
-AudioTrack ","description":"Represents audio track information associated with a media resource.
"},{"title":"AudioType","link":"AudioType ","description":"Audio-only or includes video
"},{"title":"BlockReason","link":"BlockReason ","description":"Reasons for content blocking
"},{"title":"BroadcastInformation","link":"BroadcastInformation ","description":"Represents broadcast information.
"},{"title":"Channel","link":"Channel ","description":"Represents a channel.
"},{"title":"Chapter","link":"Chapter ","description":"Represents a chapter of media content.
"},{"title":"ComposedSrcMediaData","link":"ComposedSrcMediaData ","description":"Represents the result of composing source media data.
"},{"title":"Credit","link":"Credit ","description":"Represents credit information.
"},{"title":"DrmMetadata","link":"DrmMetadata ","description":"Represents Digital Rights Management (DRM) information associated with a media resource.
"},{"title":"Episode","link":"Episode ","description":"Represents an episode of media content.
"},{"title":"HbbtvProperties","link":"HbbtvProperties ","description":"Represents HbbTV properties associated with a chapter.
"},{"title":"Headline","link":"Headline ","description":"Represents headline information.
"},{"title":"KeySystems","link":"KeySystems ","description":"Represents the result of building key systems.
"},{"title":"KeySystems#keySystems","link":"keySystems ","description":"A mapping of DRM types to their corresponding key systems information.\nFor "FAIRPLAY" type, it includes a structure with certificate and license URIs;\nfor other types, it's a string representing the license URL.
"},{"title":"Language","link":"Language ","description":"Represents a language.
"},{"title":"Link","link":"Link ","description":"Represents a link.
"},{"title":"MainResource","link":"MainResource "},{"title":"MainResource","link":"MainResource ","description":"Represents the transformed format of a resource.
"},{"title":"MainResource#analyticsData","link":"analyticsData ","description":"Merged analytics data.
"},{"title":"MainResource#analyticsMetadata","link":"analyticsMetadata ","description":"Merged analytics metadata.
"},{"title":"MainResource#blockReason","link":"blockReason ","description":"Block reason from the main chapter.
"},{"title":"MainResource#blockedSegments","link":"blockedSegments ","description":"Blocked segments from the main chapter.
"},{"title":"MainResource#chapters","link":"chapters ","description":"Chapters from the main chapter.
"},{"title":"MainResource#drmList","link":"drmList ","description":"List of DRM information from the resource.
"},{"title":"MainResource#dvr","link":"dvr ","description":"DVR information from the resource.
"},{"title":"MainResource#eventData","link":"eventData ","description":"Event data from the main chapter.
"},{"title":"MainResource#id","link":"id ","description":"ID from the main chapter.
"},{"title":"MainResource#imageCopyright","link":"imageCopyright ","description":"The url of the copyright image copyright from the main chapter.
"},{"title":"MainResource#imageUrl","link":"imageUrl ","description":"The url of the image from the main chapter.
"},{"title":"MainResource#intervals","link":"intervals ","description":"Time intervals from the main chapter.
"},{"title":"MainResource#live","link":"live ","description":"Live status from the resource.
"},{"title":"MainResource#mediaType","link":"mediaType ","description":"Media type from the main chapter.
"},{"title":"MainResource#mimeType","link":"mimeType ","description":"MIME type from the resource.
"},{"title":"MainResource#presentation","link":"presentation ","description":"Presentation information from the resource.
"},{"title":"MainResource#quality","link":"quality ","description":"Quality information from the resource.
"},{"title":"MainResource#streamOffset","link":"streamOffset ","description":"Stream offset from the resource.
"},{"title":"MainResource#streaming","link":"streaming ","description":"Streaming information from the resource.
"},{"title":"MainResource#subtitles","link":"subtitles ","description":"Filtered external subtitles.
"},{"title":"MainResource#title","link":"title ","description":"The title of this resource.
"},{"title":"MainResource#tokenType","link":"tokenType ","description":"Token type from the resource.
"},{"title":"MainResource#url","link":"url ","description":"URL from the resource.
"},{"title":"MainResource#urn","link":"urn ","description":"Chapter URN.
"},{"title":"MainResource#vendor","link":"vendor ","description":"Vendor from the main chapter.
"},{"title":"MainResourceWithKeySystems","link":"MainResourceWithKeySystems ","description":"A {@link MainResource} that can contain {@link KeySystems} information.
"},{"title":"MediaComposition","link":"MediaComposition ","description":"Represents the composition of media content.
"},{"title":"MediaComposition#findChapterByUrn","link":"findChapterByUrn ","description":"Find a chapter by its URN.
"},{"title":"MediaComposition#findMainSegment","link":"findMainSegment ","description":"Return a segment from main chapter following segmentUrn in mediaComposition.
"},{"title":"MediaComposition#findResourceListByUrn","link":"findResourceListByUrn ","description":"Find resource list by URN.
"},{"title":"MediaComposition#getChapters","link":"getChapters ","description":"A list of chapters.
"},{"title":"MediaComposition#getFilteredExternalSubtitles","link":"getFilteredExternalSubtitles ","description":"Filter external text tracks that are already available internally.
\nRules:
\n\n\nTTML format is filtered
\n \n\nIf both are empty that means only internal text tracks will be displayed\nto the user as they are automatically loaded by the player.
\n \n\nIf subtitleInformationList is missing from the MediaComposition and subtitleList\nis available but the media contains internal text tracks that are also available internally.\nIt will result on a duplication client side.
\n \n\nIf subtitleList and subtitleInformationList a merge between both will be operated,\nremoving the external text tracks already available internally.
\n \n "},{"title":"MediaComposition#getMainBlockReason","link":"getMainBlockReason ","description":"Block reason for main chapter. This also uses current date for STARTDATE.
"},{"title":"MediaComposition#getMainBlockedSegments","link":"getMainBlockedSegments ","description":"Get blocked segments from the main chapter.
"},{"title":"MediaComposition#getMainChapter","link":"getMainChapter ","description":"Get the mediaComposition's main chapter.
"},{"title":"MediaComposition#getMainChapterImageUrl","link":"getMainChapterImageUrl ","description":"Get the main chapter's image URL decorated with default width and format.
"},{"title":"MediaComposition#getMainResources","link":"getMainResources ","description":"Get main resources.
"},{"title":"MediaComposition#getMainSegments","link":"getMainSegments ","description":"Get segments of the main chapter ordered by markIn.
"},{"title":"MediaComposition#getMainTimeIntervals","link":"getMainTimeIntervals ","description":"Retrieves an array of time intervals associated with the main chapter.
"},{"title":"MediaComposition#getMainValidFromDate","link":"getMainValidFromDate ","description":"Compute a date from which this content is valid. Always return a date object.
"},{"title":"MediaComposition#getMergedAnalyticsData","link":"getMergedAnalyticsData ","description":"Get merged analytics data.
"},{"title":"MediaComposition#getMergedAnalyticsMetadata","link":"getMergedAnalyticsMetadata ","description":"Get merged analytics metadata.
"},{"title":"MediaComposition#getResourceList","link":"getResourceList ","description":"Get the chapter's resource list
"},{"title":"Player","link":"Player ","description":"This class extends the video.js Player.
"},{"title":"Player#audioTrack","link":"audioTrack ","description":"A getter/setter for the media's audio track.\nActivates the audio track according to the language and kind properties.\nFalls back on the first audio track found if the kind property is not satisfied.
"},{"title":"Player#bufferedRanges","link":"bufferedRanges ","description":"Calculates an array of ranges based on the buffered() data.
"},{"title":"Player#playedPercent","link":"playedPercent ","description":"Get the percent (as a decimal) of the media that's been played.\nThis method is not a part of the native HTML video API.
\nLive streams with DVR are not currently supported.
"},{"title":"Player#playedRanges","link":"playedRanges ","description":"Get an array of ranges based on the played data.
"},{"title":"Player#seekableRanges","link":"seekableRanges ","description":"Calculates an array of ranges based on the seekable() data.
"},{"title":"Player#textTrack","link":"textTrack ","description":"A getter/setter for the media's text track.\nActivates the text track according to the language and kind properties.\nFalls back on the first text track found if the kind property is not satisfied.\nDisables all subtitle tracks that are showing if the trackSelector is truthy but does not satisfy any condition.
"},{"title":"PlayerProperty","link":"PlayerProperty ","description":"Represents a player property associated with a media segment.
"},{"title":"PresentationType","link":"PresentationType ","description":"Presentation format
"},{"title":"Presenter","link":"Presenter ","description":"Represents a presenter.
"},{"title":"Program","link":"Program ","description":"Represents a program.
"},{"title":"QualityType","link":"QualityType ","description":"Content quality
"},{"title":"RelatedContent","link":"RelatedContent ","description":"Represents related content associated with a media segment.
"},{"title":"Resource","link":"Resource ","description":"Represents a resource associated with a media segment.
"},{"title":"ScheduledBroadcast","link":"ScheduledBroadcast ","description":"Represents a scheduled broadcast.
"},{"title":"Segment","link":"Segment ","description":"Represents a media segment with detailed metadata.
"},{"title":"Show","link":"Show ","description":"Represents a show.
"},{"title":"SocialCountEntry","link":"SocialCountEntry ","description":"Represents a social media count entry associated with a media segment.
"},{"title":"SpriteSheet","link":"SpriteSheet ","description":"Represents a sprite sheet associated with a chapter.
"},{"title":"SrgOptions","link":"SrgOptions ","description":"Represents a set of options specific to the SRG SSR.
\nNote :
\n\nAll these options have a default value and can therefore be undefined. \nDataProvider options cannot be combined with each other. \n "},{"title":"SrgSsr","link":"SrgSsr "},{"title":"SrgSsr.addBlockedSegments","link":"addBlockedSegments ","description":"Adds blocked segments to the player.
"},{"title":"SrgSsr.addChapters","link":"addChapters ","description":"Adds chapters to the player.
"},{"title":"SrgSsr.addIntervals","link":"addIntervals ","description":"Adds intervals to the player.
"},{"title":"SrgSsr.addRemoteTextTracks","link":"addRemoteTextTracks ","description":"Adds remote text tracks from an array of subtitles.
"},{"title":"SrgSsr.addTextTrackCue","link":"addTextTrackCue ","description":"Add a new cue to a text track with the given data.
"},{"title":"SrgSsr.addTextTracks","link":"addTextTracks ","description":"Add multiple text tracks to the player.
"},{"title":"SrgSsr.blockingReason","link":"blockingReason ","description":"Set a blocking reason according to the block reason returned\nby mediaData.
"},{"title":"SrgSsr.composeAkamaiResources","link":"composeAkamaiResources ","description":"Add the Akamai token to all resources\nif at least one of them has tokenType\nset to Akamai.
"},{"title":"SrgSsr.composeKeySystemsResources","link":"composeKeySystemsResources ","description":"Add the keySystems property to all resources\nif at least one of them has DRM.
"},{"title":"SrgSsr.composeMainResources","link":"composeMainResources ","description":"Get the main resources from a mediaComposition.\nMay add an Akamai token or key systems if required by the resource.
"},{"title":"SrgSsr.composeSrcMediaData","link":"composeSrcMediaData ","description":"Compose source options with media data.\nMediaData properties from source options overwrite mediaData from IL.
"},{"title":"SrgSsr.createTextTrack","link":"createTextTrack ","description":"Create a new metadata text track.
"},{"title":"SrgSsr.cuechangeEventProxy","link":"cuechangeEventProxy ","description":"Proxy SRG SSR chapters and intervals cuechange events at player level.
"},{"title":"SrgSsr.dataProvider","link":"dataProvider ","description":"SRG SSR data provider singleton.
"},{"title":"SrgSsr.dataProviderError","link":"dataProviderError ","description":"Set an error if something goes wrong with the data provider.
"},{"title":"SrgSsr.error","link":"error ","description":"Set player error.
"},{"title":"SrgSsr.filterIncompatibleResources","link":"filterIncompatibleResources ","description":"Filter out incompatible resources such as RTMP and HDS.
"},{"title":"SrgSsr.getBlockedSegment","link":"getBlockedSegment ","description":"Get the current blocked segment from the player.
"},{"title":"SrgSsr.getBlockedSegmentByTime","link":"getBlockedSegmentByTime ","description":"Get the VTT cue of a blocked segment.
"},{"title":"SrgSsr.getMediaComposition","link":"getMediaComposition ","description":"Get mediaComposition from an URN.
"},{"title":"SrgSsr.getMediaData","link":"getMediaData ","description":"Get the mediaData most likely to be compatible depending on the browser.
"},{"title":"SrgSsr.getSrcMediaObj","link":"getSrcMediaObj ","description":"Get the source media object.
"},{"title":"SrgSsr.handleCurrentTime","link":"handleCurrentTime ","description":"Handles the middleware's currentTime function.
\n\nIf the current time is between the start and end of a blocked segment,\nthe blocked portion will be skipped. \n \nNote : This function should disappear as soon as this behavior is\nsupported on the packaging side.
"},{"title":"SrgSsr.handleSetCurrentTime","link":"handleSetCurrentTime ","description":"Handles the middleware's setCurrentTime function.
\n\nModify the current time if the value is between the start and end of a\nblocked segment. \n \nNote : This function should disappear as soon as this behavior is\nsupported on the packaging side.
"},{"title":"SrgSsr.handleSetSource","link":"handleSetSource ","description":"Handles the middleware's setSource function.
\nThis function allows to:
\n\nresolve a URN into media that can be played by the player \ninitialize media playback tracking \nupdate the title bar \nhandle blocking reasons \nadd remote subtitles \n "},{"title":"SrgSsr.middleware","link":"middleware ","description":"Middleware to resolve SRG SSR URNs into playable media.
"},{"title":"SrgSsr.pillarboxMonitoring","link":"pillarboxMonitoring ","description":"PillarboxMonitoring monitoring singleton.
"},{"title":"SrgSsr.srgAnalytics","link":"srgAnalytics ","description":"SRG SSR analytics singleton.
"},{"title":"SrgSsr.updatePoster","link":"updatePoster ","description":"Update player's poster.
"},{"title":"SrgSsr.updateTitleBar","link":"updateTitleBar ","description":"Update player titleBar with title and description.
"},{"title":"StreamingType","link":"StreamingType ","description":"Enumerates various streaming methods
"},{"title":"SubTopic","link":"SubTopic ","description":"Represents a subtopic.
"},{"title":"Subtitle","link":"Subtitle ","description":"Represents subtitle information for a media segment.
"},{"title":"SubtitleInformation","link":"SubtitleInformation ","description":"Represents subtitle information associated with a media resource.
"},{"title":"TimeInterval","link":"TimeInterval ","description":"Represents a time interval metadata used to mark the beginning and ending\nof opening or closing credits.
"},{"title":"TokenType","link":"TokenType ","description":"Represents different token types for authentication
"},{"title":"Topic","link":"Topic ","description":"Represents a topic.
"},{"title":"TrackSelector","link":"TrackSelector ","description":"The track to select
"},{"title":"TrackSourceType","link":"TrackSourceType ","description":"Source type for audio/video tracks
"},{"title":"TransmissionType","link":"TransmissionType ","description":"Medium of transmission
"},{"title":"VendorType","link":"VendorType ","description":"Broadcasting organizations
"},{"title":"pillarbox","link":"pillarbox ","description":"Pillarbox is an alias for the video.js namespace with additional options.
"},{"title":"pillarbox.options.enableSmoothSeeking","link":"enableSmoothSeeking ","description":"Enable smooth seeking for Pillarbox.
"},{"title":"pillarbox.options.fill","link":"fill ","description":"Enable fill mode for the video player, allowing it to expand to fill the container.
"},{"title":"pillarbox.options.html5","link":"html5 ","description":"Configuration options for HTML5 settings in Pillarbox.
"},{"title":"pillarbox.options.liveTracker","link":"liveTracker ","description":"Configuration for the live tracker.
"},{"title":"pillarbox.options.liveui","link":"liveui ","description":"Allows the player to use the live ui that includes:
\n\nA progress bar for seeking within the live window \nA button that can be clicked to seek to the live edge with a circle indicating if you are at the live edge or not. \n "},{"title":"pillarbox.options.playsinline","link":"playsinline ","description":"Indicates that the video is to be played "inline", that is within the element's playback area.
"},{"title":"pillarbox.options.responsive","link":"responsive ","description":"Enable responsive mode, this will cause the player to customize itself based on responsive breakpoints.
"},{"title":"pillarbox.options.trackers","link":"trackers ","description":"A placeholder for accessing trackers directly from the player.
"}]}
\ No newline at end of file
diff --git a/pr-preview/pr-252/api/dataProvider_model_MediaComposition.js.html b/pr-preview/pr-252/api/dataProvider_model_MediaComposition.js.html
deleted file mode 100644
index c7685d1d..00000000
--- a/pr-preview/pr-252/api/dataProvider_model_MediaComposition.js.html
+++ /dev/null
@@ -1,343 +0,0 @@
-Source: dataProvider/model/MediaComposition.js dataProvider_model_MediaComposition.js /**
- * Represents the composition of media content.
- *
- * @class MediaComposition
- * @property {string} chapterUrn URN (Uniform Resource Name) of the associated chapter.
- * @property {string} segmentUrn URN of the associated segment.
- * @property {Episode} episode Associated episode.
- * @property {Show} show Associated show.
- * @property {Channel} channel Associated channel.
- * @property {Array.<Chapter>} chapterList List of associated chapters.
- * @property {Array.<Topic>} topicList List of associated topics.
- * @property {Object.<String, String>} analyticsData Analytics data associated with the media composition.
- * @property {Object.<String, String>} analyticsMetadata Metadata associated with analytics for the media composition.
- */
-class MediaComposition {
- /**
- * Find a chapter by its URN.
- *
- * @param {String} urn
- *
- * @returns {Chapter} chapter
- */
- findChapterByUrn(urn) {
- if (this.chapterList) {
- const [chapter] = this.chapterList.filter(
- (element) => element.urn === urn
- );
-
- return chapter;
- }
-
- return undefined;
- }
-
- /**
- * Return a segment from main chapter following segmentUrn in mediaComposition.
- *
- * @returns {Segment|undefined} main segment
- */
- findMainSegment() {
- if (!this.segmentUrn) {
- return undefined;
- }
-
- const segmentList = this.getMainSegments();
- const [segment] = segmentList.filter(
- (element) => element.urn === this.segmentUrn
- );
-
- return segment;
- }
-
- /**
- * Find resource list by URN.
- *
- * @param {String} urn
- * @returns {Array.<Resource>|undefined} of resources
- */
- findResourceListByUrn(urn) {
- const chapterByUrn = this.findChapterByUrn(urn);
-
- if (chapterByUrn) {
- return chapterByUrn.resourceList || [];
- }
-
- return undefined;
- }
-
- /**
- * A list of chapters.
- *
- * @returns {Array.<Chapter>} of chapters
- */
- getChapters() {
- const AUDIO = 'AUDIO';
-
- if (this.getMainChapter().mediaType === AUDIO) return [];
-
- return this.chapterList.filter(({ mediaType }) => mediaType !== AUDIO);
- }
-
- /**
- * Filter external text tracks that are already available internally.
- *
- * __Rules:__
- * 1. TTML format is filtered
- *
- * 2. If both are empty that means only internal text tracks will be displayed
- * to the user as they are automatically loaded by the player.
- *
- * 3. If subtitleInformationList is missing from the MediaComposition and subtitleList
- * is available but the media contains internal text tracks that are also available internally.
- * It will result on a duplication client side.
- *
- * 4. If subtitleList and subtitleInformationList a merge between both will be operated,
- * removing the external text tracks already available internally.
- *
- *
- * @returns {Array.<Subtitle>} external text tracks
- */
- getFilteredExternalSubtitles() {
- const { subtitleList } = this.getMainChapter();
- const [{ subtitleInformationList } = {}] = this.getResourceList().filter(
- ({ subtitleInformationList }) => subtitleInformationList
- );
- const onlyHasExternalSubtitles = subtitleList && !subtitleInformationList;
-
- if (!subtitleList) {
- return [];
- }
-
- // TTML format is not supported
- const subtitles = subtitleList.filter(
- (subtitle) => subtitle.format !== 'TTML'
- );
-
- if (onlyHasExternalSubtitles) {
- return subtitles;
- }
-
- return subtitles.filter((subtitle) => {
- const addSubtitle = !subtitleInformationList.find(
- (subtitleInformation) =>
- subtitleInformation.locale === subtitle.locale &&
- subtitle.type === subtitleInformation.type
- );
-
- return addSubtitle;
- });
- }
-
- /**
- * Block reason for main chapter. This also uses current date for STARTDATE.
- *
- * @see BlockReason
- *
- * @returns {string | undefined} undefined if main chapter is not blocked
- */
- getMainBlockReason() {
- const mainChapter = this.getMainChapter();
-
- if (!mainChapter) {
- return undefined;
- }
-
- let { blockReason } = mainChapter;
-
- if (!blockReason && new Date() < this.getMainValidFromDate()) {
- blockReason = 'STARTDATE';
- }
-
- return blockReason;
- }
-
- /**
- * Get blocked segments from the main chapter.
- *
- * @returns {Array.<Segment>} of blocked segments
- */
- getMainBlockedSegments() {
- return this.getMainSegments().filter(segment => segment.blockReason);
- }
-
- /**
- * Get the mediaComposition's main chapter.
- *
- * @returns {Chapter}
- */
- getMainChapter() {
- if (!this.mainChapter) {
- this.mainChapter = this.findChapterByUrn(this.chapterUrn);
- }
-
- if (!this.mainChapter && this.chapterList && this.chapterList.length > 0) {
- [this.mainChapter] = this.chapterList;
- }
-
- return this.mainChapter;
- }
-
- /**
- * Get the main chapter's image URL decorated with default width and format.
- *
- * @returns {String|undefined} image URL
- */
- getMainChapterImageUrl() {
- const mainChapter = this.getMainChapter();
-
- if (!mainChapter || !mainChapter.imageUrl) {
- return undefined;
- }
-
- return mainChapter.imageUrl;
- }
-
- /**
- * Get main resources.
- *
- * @returns {Array.<MainResource>} array of sources.
- */
- // eslint-disable-next-line max-lines-per-function
- getMainResources() {
- const resourceList = this.getResourceList();
-
- if (!resourceList || !resourceList.length) {
- return undefined;
- }
-
- return resourceList.map((resource) => ({
- analyticsData: this.getMergedAnalyticsData(resource.analyticsData),
- analyticsMetadata: this.getMergedAnalyticsMetadata(
- resource.analyticsMetadata
- ),
- blockReason: this.getMainChapter().blockReason,
- blockedSegments: this.getMainBlockedSegments(),
- imageUrl: this.getMainChapterImageUrl(),
- chapters: this.getChapters(),
- drmList: resource.drmList,
- dvr: resource.dvr,
- eventData: this.getMainChapter().eventData,
- id: this.getMainChapter().id,
- imageCopyright: this.getMainChapter().imageCopyright,
- intervals: this.getMainTimeIntervals(),
- live: resource.live,
- mediaType: this.getMainChapter().mediaType,
- mimeType: resource.mimeType,
- presentation: resource.presentation,
- quality: resource.quality,
- streaming: resource.streaming,
- streamOffset: resource.streamOffset,
- subtitles: this.getFilteredExternalSubtitles(),
- title: this.getMainChapter().title,
- tokenType: resource.tokenType,
- url: resource.url,
- urn: this.chapterUrn,
- vendor: this.getMainChapter().vendor,
- }));
- }
-
- /**
- * Get segments of the main chapter ordered by markIn.
- *
- * @returns {Array.<Segment>} of segments
- */
- getMainSegments() {
- const mainChapter = this.getMainChapter();
-
- if (!this.mainSegments && mainChapter && mainChapter.segmentList) {
- this.mainSegments = mainChapter.segmentList;
- }
-
- return this.mainSegments || [];
- }
-
- /**
- * Retrieves an array of time intervals associated with the main chapter.
- *
- * @returns {Array.<TimeInterval>} An array of time intervals.
- */
- getMainTimeIntervals() {
- const {
- timeIntervalList = []
- } = this.getMainChapter() || {};
-
- return timeIntervalList;
- }
-
- /**
- * Compute a date from which this content is valid. Always return a date object.
- *
- * @returns {Date} date specified in media composition or EPOCH when no date present.
- */
- getMainValidFromDate() {
- const mainChapter = this.getMainChapter();
-
- if (!mainChapter) {
- return new Date(0);
- }
-
- const { validFrom } = mainChapter;
-
- if (validFrom) {
- return new Date(validFrom);
- }
- }
-
- /**
- * Get merged analytics data.
- *
- * @param {Object.<string, string>} analyticsData
- * @returns {Object.<string, string>} Merged analytics data.
- */
- getMergedAnalyticsData(analyticsData) {
- return {
- ...this.analyticsData,
- ...this.getMainChapter().analyticsData,
- ...analyticsData,
- };
- }
-
- /**
- * Get merged analytics metadata.
- *
- * @param {Object.<string, string>} analyticsMetadata
- * @returns {Object.<string, string>} Merged analytics metadata.
- */
- getMergedAnalyticsMetadata(analyticsMetadata) {
- return {
- ...this.analyticsMetadata,
- ...this.getMainChapter().analyticsMetadata,
- ...analyticsMetadata,
- };
- }
-
- /**
- * Get the chapter's resource list
- * @returns {Array.<Resource>} of resources
- */
- getResourceList() {
- const { resourceList } = this.getMainChapter();
-
- return resourceList || [];
- }
-}
-
-export default MediaComposition;
-
-
-/**
- * @typedef {import('./typedef').Channel} Channel
- * @typedef {import('./typedef').Chapter} Chapter
- * @typedef {import('./typedef').Episode} Episode
- * @typedef {import('./typedef').Resource} Resource
- * @typedef {import('./typedef').Segment} Segment
- * @typedef {import('./typedef').Show} Show
- * @typedef {import('./typedef').Subtitle} Subtitle
- * @typedef {import('./typedef').TimeInterval} TimeInterval
- * @typedef {import('./typedef').Topic} Topic
- * @typedef {import('./typedef').MainResource} MainResource
- */
-Source: dataProvider/model/typedef.ts dataProvider_model_typedef.ts /**
- * Represents a time interval metadata used to mark the beginning and ending
- * of opening or closing credits.
- */
-export type TimeInterval = {
- /**
- * The type of the time interval.
- */
- type: 'OPENING_CREDITS' | 'CLOSING_CREDITS';
- /**
- * An integer representing the mark in time.
- */
- markIn: number;
- /**
- * An integer representing the mark out time.
- */
- markOut: number;
-};
-/**
- * Represents a media segment with detailed metadata.
- */
-export type Segment = {
- /**
- * Unique identifier for the segment.
- */
- id: string;
- /**
- * Type of media.
- */
- mediaType: AudioType;
- /**
- * Vendor of the segment.
- */
- vendor: VendorType;
- /**
- * URN (Uniform Resource Name) specifying the segment details.
- */
- urn: string;
- /**
- * Title of the segment. Limited to 2000 characters.
- */
- title: string;
- /**
- * Lead information for the segment.
- */
- lead: string;
- /**
- * Description of the segment.
- */
- description: string;
- /**
- * Media description for the segment.
- */
- mediaDescription: string;
- /**
- * URL of the image associated with the segment.
- */
- imageUrl: string;
- /**
- * Title of the image associated with the segment. Limited to 2000 characters.
- */
- imageTitle: string;
- /**
- * Copyright information for the image.
- */
- imageCopyright: string;
- /**
- * Reason for blocking.
- */
- blockReason: BlockReason;
- /**
- * Youth protection color. Allowed values: 'YELLOW', 'RED'.
- */
- youthProtectionColor: 'YELLOW' | 'RED';
- /**
- * Type of the segment. Allowed values: 'EPISODE', 'EXTRACT', 'TRAILER', 'CLIP', 'LIVESTREAM', 'SCHEDULED_LIVESTREAM'.
- */
- type: 'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM';
- /**
- * Date and time information in ISO8601 format.
- */
- date: string;
- /**
- * Duration of the segment in seconds.
- */
- duration: number;
- /**
- * URL for the standard definition podcast.
- */
- podcastSdUrl: string;
- /**
- * URL for the high definition podcast.
- */
- podcastHdUrl: string;
- /**
- * Start date and time for the validity period in ISO8601 format.
- */
- validFrom: string;
- /**
- * End date and time for the validity period in ISO8601 format.
- */
- validTo: string;
- /**
- * Entity responsible for the assignment. Allowed values: 'EDITOR', 'TRENDING', 'RECOMMENDATION'.
- */
- assignedBy: 'EDITOR' | 'TRENDING' | 'RECOMMENDATION';
- /**
- * Indicates if the segment is playable abroad.
- */
- playableAbroad: boolean;
- /**
- * List of related content items.
- */
- relatedContentList: Array<RelatedContent>;
- /**
- * List of social count entries.
- */
- socialCountList: Array<SocialCountEntry>;
- /**
- * Indicates if the segment is displayable.
- */
- displayable: boolean;
- /**
- * Full-length URN specifying the segment details.
- */
- fullLengthUrn: string;
- /**
- * Position of the segment.
- */
- position: number;
- /**
- * Indicates if the segment should not be embedded.
- */
- noEmbed: boolean;
- /**
- * List of subtitle entries.
- */
- subtitleList: Array<Subtitle>;
- /**
- * Analytics data for the segment.
- */
- analyticsData: {
- [x: string]: string;
- };
- /**
- * Metadata for analytics purposes.
- */
- analyticsMetadata: {
- [x: string]: string;
- };
- /**
- * Event data associated with the segment.
- */
- eventData: string;
- /**
- * List of player properties.
- */
- playerProperties: Array<PlayerProperty>;
- /**
- * List of tags associated with the segment.
- */
- tagList: Array<string>;
- /**
- * Label for the segment.
- */
- label: string;
- /**
- * Integer representing the mark in time.
- */
- markIn: number;
- /**
- * Integer representing the mark out time.
- */
- markOut: number;
-};
-/**
- * Represents a chapter of media content.
- */
-export type Chapter = {
- /**
- * Unique identifier for the chapter.
- */
- id: string;
- /**
- * Type of media content (AUDIO or VIDEO).
- */
- mediaType: AudioType;
- /**
- * Vendor associated with the chapter.
- */
- vendor: VendorType;
- /**
- * URN (Uniform Resource Name) for the chapter.
- */
- urn: string;
- /**
- * Title of the chapter.
- */
- title: string;
- /**
- * Lead information for the chapter.
- */
- lead: string;
- /**
- * Description of the chapter.
- */
- description: string;
- /**
- * Media description of the chapter.
- */
- mediaDescription: string;
- /**
- * URL of the image associated with the chapter.
- */
- imageUrl: string;
- /**
- * Title of the image associated with the chapter.
- */
- imageTitle: string;
- /**
- * Copyright information for the image.
- */
- imageCopyright: string;
- /**
- * Reason for blocking the chapter.
- */
- blockReason: BlockReason;
- /**
- * Youth protection color code.
- */
- youthProtectionColor: 'YELLOW' | 'RED';
- /**
- * Type of the chapter.
- */
- type: 'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM';
- /**
- * Date and time information for the chapter.
- */
- date: string;
- /**
- * Duration of the chapter in seconds.
- */
- duration: number;
- /**
- * URL for the standard-definition podcast.
- */
- podcastSdUrl: string;
- /**
- * URL for the high-definition podcast.
- */
- podcastHdUrl: string;
- /**
- * Validity start date and time for the chapter.
- */
- validFrom: string;
- /**
- * Validity end date and time for the chapter.
- */
- validTo: string;
- /**
- * User who assigned the chapter.
- */
- assignedBy: 'EDITOR' | 'TRENDING' | 'RECOMMENDATION';
- /**
- * Indicates if the chapter is playable abroad.
- */
- playableAbroad: boolean;
- /**
- * List of related content for the chapter.
- */
- relatedContentList: Array<RelatedContent>;
- /**
- * List of social media counts for the chapter.
- */
- socialCountList: Array<SocialCountEntry>;
- /**
- * Indicates if the chapter is displayable.
- */
- displayable: boolean;
- /**
- * URN for the full-length version of the chapter.
- */
- fullLengthUrn: string;
- /**
- * Position of the chapter.
- */
- position: number;
- /**
- * Indicates if the chapter can be embedded.
- */
- noEmbed: boolean;
- /**
- * List of subtitles for the chapter.
- */
- subtitleList: Array<Subtitle>;
- /**
- * Analytics data for the chapter.
- */
- analyticsData: {
- [x: string]: string;
- };
- /**
- * Metadata for analytics associated with the chapter.
- */
- analyticsMetadata: {
- [x: string]: string;
- };
- /**
- * Event data associated with the chapter.
- */
- eventData: string;
- /**
- * List of player properties for the chapter.
- */
- playerProperties: Array<PlayerProperty>;
- /**
- * List of tags associated with the chapter.
- */
- tagList: Array<string>;
- /**
- * Label information for the chapter.
- */
- label: string;
- /**
- * Mark in time for the full-length version of the chapter.
- */
- fullLengthMarkIn: number;
- /**
- * Mark out time for the full-length version of the chapter.
- */
- fullLengthMarkOut: number;
- /**
- * List of resources associated with the chapter.
- */
- resourceList: Array<Resource>;
- /**
- * List of segments associated with the chapter.
- */
- segmentList: Array<Segment>;
- /**
- * Start time for the pre-trailer content.
- */
- preTrailerStart: string;
- /**
- * Stop time for the post-trailer content.
- */
- postTrailerStop: string;
- /**
- * CESIM (Content, Episode, Segment, Image, Module) identifier for the chapter.
- */
- cesimId: string;
- /**
- * List of HbbtvProperties for the chapter.
- */
- hbbtvProperties: Array<HbbtvProperties>;
- /**
- * Name of the creator of the chapter.
- */
- creatorName: string;
- /**
- * User associated with the creator of the chapter.
- */
- creatorUser: string;
- /**
- * Aspect ratio of the chapter.
- */
- aspectRatio: '1:1' | '4:5' | '4:3' | '9:16' | '16:9';
- /**
- * DVR reference date and time for the chapter.
- */
- dvrReferenceDate: string;
- /**
- * List of time intervals associated with the chapter.
- */
- timeIntervalList: Array<TimeInterval>;
- /**
- * Sprite sheet information for the chapter.
- */
- spriteSheet: SpriteSheet;
-};
-/**
- * Represents a resource associated with a media segment.
- */
-export type Resource = {
- /**
- * URL of the resource.
- */
- url: string;
- /**
- * List of Digital Rights Management (DRM) information for the resource.
- */
- drmList: Array<DrmMetadata>;
- /**
- * Quality of the resource.
- */
- quality: QualityType;
- /**
- * Protocol used for streaming the resource.
- */
- protocol: 'HLS' | 'HLS-DVR' | 'HDS' | 'HDS-DVR' | 'RTMP' | 'HTTP' | 'HTTPS' | 'HTTP-M3U' | 'HTTP-MP3-STREAM' | 'DASH' | 'DASH-DVR';
- /**
- * Encoding used for the resource.
- */
- encoding: 'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2';
- /**
- * MIME type of the resource.
- */
- mimeType: string;
- /**
- * Presentation mode of the resource.
- */
- presentation: PresentationType;
- /**
- * Streaming type of the resource.
- */
- streaming: StreamingType;
- /**
- * Indicates if the resource supports Digital Video Recorder (DVR).
- */
- dvr: boolean;
- /**
- * Indicates if the resource is a live stream.
- */
- live: boolean;
- /**
- * Media container type of the resource.
- */
- mediaContainer: 'MP4' | 'MKV' | 'MPEG2_TS' | 'FMP4' | 'NONE' | 'UNKNOWN';
- /**
- * Audio codec used for the resource.
- */
- audioCodec: 'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2' | 'UNKNOWN';
- /**
- * Video codec used for the resource.
- */
- videoCodec: 'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'NONE' | 'UNKNOWN';
- /**
- * Token type used for the resource.
- */
- tokenType: TokenType;
- /**
- * List of audio tracks associated with the resource.
- */
- audioTrackList: Array<AudioTrack>;
- /**
- * List of subtitle information associated with the resource.
- */
- subtitleInformationList: Array<SubtitleInformation>;
- /**
- * Analytics data for the resource.
- */
- analyticsData: {
- [x: string]: string;
- };
- /**
- * Metadata for analytics purposes.
- */
- analyticsMetadata: {
- [x: string]: string;
- };
- /**
- * Stream offset for the resource.
- */
- streamOffset: number;
-};
-/**
- * Represents related content associated with a media segment.
- */
-export type RelatedContent = {
- /**
- * Unique identifier for the related content.
- */
- id: string;
- /**
- * Title of the related content. Limited to 2000 characters.
- */
- title: string;
- /**
- * Lead information for the related content.
- */
- lead: string;
- /**
- * Description of the related content.
- */
- description: string;
- /**
- * URL of the related content.
- */
- url: string;
- /**
- * Type of content.
- */
- contentType: string;
- /**
- * Indicates if the related content is external.
- */
- isExternal: boolean;
-};
-/**
- * Represents subtitle information for a media segment.
- */
-export type Subtitle = {
- /**
- * Locale information for the subtitle.
- */
- locale: string;
- /**
- * Language of the subtitle.
- */
- language: string;
- /**
- * Source of the subtitle.
- */
- source: 'EXTERNAL' | TrackSourceType;
- /**
- * Type of the subtitle.
- */
- type: 'SDH';
- /**
- * URL of the subtitle.
- */
- url: string;
- /**
- * Format of the subtitle.
- */
- format: 'TTML' | 'VTT';
-};
-/**
- * Represents a social media count entry associated with a media segment.
- */
-export type SocialCountEntry = {
- /**
- * Key identifying the type of social media count.
- */
- key: 'srgView' | 'srgLike' | 'fbShare' | 'googleShare' | 'twitterShare' | 'whatsAppShare';
- /**
- * Count value for the social media entry.
- */
- value: number;
-};
-/**
- * Represents a player property associated with a media segment.
- */
-export type PlayerProperty = {
- /**
- * Key identifying the type of player property.
- */
- key: 'iFrameUrl' | 'playerUrl' | 'playerRelativeIconImageUrl' | 'playerWidth' | 'playerHeight';
- /**
- * Value of the player property.
- */
- value: string;
-};
-/**
- * Represents Digital Rights Management (DRM) information associated with a media resource.
- */
-export type DrmMetadata = {
- /**
- * Type of DRM used for the resource.
- */
- type: 'FAIRPLAY' | 'WIDEVINE' | 'PLAYREADY';
- /**
- * URL for the DRM license.
- */
- licenseUrl: string;
- /**
- * URL for the DRM certificate.
- */
- certificateUrl: string;
-};
-/**
- * Represents audio track information associated with a media resource.
- */
-export type AudioTrack = {
- /**
- * Locale information for the audio track.
- */
- locale: string;
- /**
- * Language of the audio track.
- */
- language: string;
- /**
- * Source of the audio track.
- */
- source: TrackSourceType;
- /**
- * Type of the audio track.
- */
- type: 'AUDIO_DESCRIPTION';
-};
-/**
- * Represents subtitle information associated with a media resource.
- */
-export type SubtitleInformation = {
- /**
- * Locale information for the subtitle.
- */
- locale: string;
- /**
- * Language of the subtitle.
- */
- language: string;
- /**
- * Source of the subtitle information.
- */
- source: 'EXTERNAL' | TrackSourceType;
- /**
- * Type of the subtitle information.
- */
- type: 'SDH';
-};
-/**
- * Represents HbbTV properties associated with a chapter.
- */
-export type HbbtvProperties = {
- /**
- * Indicates the availability of the red button feature.
- */
- redButton: boolean;
- /**
- * URL link associated with the image for HbbTV.
- */
- imageLink: string;
-};
-/**
- * Represents a sprite sheet associated with a chapter.
- */
-export type SpriteSheet = {
- /**
- * URN (Uniform Resource Name) for the sprite sheet.
- */
- urn: string;
- /**
- * Number of rows in the sprite sheet.
- */
- rows: number;
- /**
- * Number of columns in the sprite sheet.
- */
- columns: number;
- /**
- * Height of each thumbnail in the sprite sheet.
- */
- thumbnailHeight: number;
- /**
- * Width of each thumbnail in the sprite sheet.
- */
- thumbnailWidth: number;
- /**
- * Interval between frames in milliseconds.
- */
- interval: number;
- /**
- * URL link to the sprite sheet.
- */
- url: string;
-};
-/**
- * Represents an episode of media content.
- */
-export type Episode = {
- /**
- * Unique identifier for the episode.
- */
- id: string;
- /**
- * Title of the episode.
- */
- title: string;
- /**
- * Lead description of the episode.
- */
- lead: string;
- /**
- * Detailed description of the episode.
- */
- description: string;
- /**
- * Date and time when the episode was published.
- */
- publishedDate: string;
- /**
- * URL of the image associated with the episode.
- */
- imageUrl: string;
- /**
- * Title of the image associated with the episode.
- */
- imageTitle: string;
- /**
- * Copyright information for the episode image.
- */
- imageCopyright: string;
- /**
- * URN (Uniform Resource Name) for the full-length version of the episode.
- */
- fullLengthUrn: string;
- /**
- * Season number to which the episode belongs.
- */
- seasonNumber: number;
- /**
- * Episode number.
- */
- number: number;
- /**
- * Social count entry for the episode.
- */
- socialCount: SocialCountEntry;
-};
-/**
- * Represents a show.
- */
-export type Show = {
- /**
- * Unique identifier for the show.
- */
- id: string;
- /**
- * Vendor of the show.
- */
- vendor: VendorType;
- /**
- * Type of transmission for the show.
- */
- transmission: TransmissionType;
- /**
- * URN (Uniform Resource Name) for the show.
- */
- urn: string;
- /**
- * Title of the show.
- */
- title: string;
- /**
- * Lead description of the show.
- */
- lead: string;
- /**
- * Detailed description of the show.
- */
- description: string;
- /**
- * URL of the image associated with the show.
- */
- imageUrl: string;
- /**
- * Title of the image associated with the show.
- */
- imageTitle: string;
- /**
- * Copyright information for the show image.
- */
- imageCopyright: string;
- /**
- * URL of the banner image for the show.
- */
- bannerImageUrl: string;
- /**
- * URL of the poster image for the show.
- */
- posterImageUrl: string;
- /**
- * Indicates if the poster image is a fallback URL.
- */
- posterImageIsFallbackUrl: boolean;
- /**
- * URL of the podcast image for the show.
- */
- podcastImageUrl: string;
- /**
- * Indicates if the podcast image is a fallback URL.
- */
- podcastImageIsFallbackUrl: boolean;
- /**
- * URL of the show's homepage.
- */
- homepageUrl: string;
- /**
- * URL for podcast subscription.
- */
- podcastSubscriptionUrl: string;
- /**
- * URL for podcast feed (SD).
- */
- podcastFeedSdUrl: string;
- /**
- * URL for podcast feed (HD).
- */
- podcastFeedHdUrl: string;
- /**
- * URL for podcast on Deezer.
- */
- podcastDeezerUrl: string;
- /**
- * URL for podcast on Spotify.
- */
- podcastSpotifyUrl: string;
- /**
- * URL for the show's timetable.
- */
- timeTableUrl: string;
- /**
- * List of links associated with the show.
- */
- links: Array<Link>;
- /**
- * ID of the primary channel for the show.
- */
- primaryChannelId: string;
- /**
- * Number of times the show has been viewed.
- */
- viewedMedias: number;
- /**
- * Number of episodes available for the show.
- */
- numberOfEpisodes: number;
- /**
- * List of available audio languages for the show.
- */
- availableAudioLanguageList: Array<Language>;
- /**
- * List of available subtitle languages for the show.
- */
- availableSubtitleLanguageList: Array<Language>;
- /**
- * List of available video quality options for the show.
- */
- availableVideoQualityList: Array<QualityType>;
- /**
- * Indicates if audio description is available for the show.
- */
- audioDescriptionAvailable: boolean;
- /**
- * Indicates if subtitles are available for the show.
- */
- subtitlesAvailable: boolean;
- /**
- * Indicates if multiple audio languages are available for the show.
- */
- multiAudioLanguagesAvailable: boolean;
- /**
- * List of topics associated with the show.
- */
- topicList: Array<Topic>;
- /**
- * Information about the show's broadcast.
- */
- broadcastInformation: BroadcastInformation;
- /**
- * Indicates if the show is allowed to be indexed.
- */
- allowIndexing: boolean;
- /**
- * Information about the next scheduled broadcast for the show.
- */
- nextScheduledBroadcast: ScheduledBroadcast;
- /**
- * List of programs for the next scheduled broadcasts.
- */
- nextScheduledBroadcastList: Array<Program>;
- /**
- * URN of the primary channel for the show.
- */
- primaryChannelUrn: string;
-};
-/**
- * Represents a channel.
- */
-export type Channel = {
- /**
- * Unique identifier for the channel.
- */
- id: string;
- /**
- * Vendor of the channel.
- */
- vendor: VendorType;
- /**
- * Title of the channel.
- */
- title: string;
- /**
- * Lead description of the channel.
- */
- lead: string;
- /**
- * Detailed description of the channel.
- */
- description: string;
- /**
- * URL of the image associated with the channel.
- */
- imageUrl: string;
- /**
- * Raw URL of the image associated with the channel.
- */
- imageUrlRaw: string;
- /**
- * Title of the image associated with the channel.
- */
- imageTitle: string;
- /**
- * Copyright information for the channel image.
- */
- imageCopyright: string;
- /**
- * Type of transmission for the channel.
- */
- transmission: TransmissionType;
- /**
- * URL for the channel's timetable.
- */
- timeTableUrl: string;
- /**
- * Information about the presenter associated with the channel.
- */
- presenter: Presenter;
- /**
- * Information about the currently airing program on the channel.
- */
- now: Program;
- /**
- * Information about the next scheduled program on the channel.
- */
- next: Program;
- /**
- * URN (Uniform Resource Name) for the channel.
- */
- urn: string;
-};
-/**
- * Represents a topic.
- */
-export type Topic = {
- /**
- * Unique identifier for the topic.
- */
- id: string;
- /**
- * Vendor of the topic.
- */
- vendor: VendorType;
- /**
- * Type of transmission for the topic.
- */
- transmission: TransmissionType;
- /**
- * URN (Uniform Resource Name) for the topic.
- */
- urn: string;
- /**
- * Title of the topic.
- */
- title: string;
- /**
- * Lead description of the topic.
- */
- lead: string;
- /**
- * Detailed description of the topic.
- */
- description: string;
- /**
- * Number of viewed medias related to the topic.
- */
- viewedMedias: number;
- /**
- * URL of the image associated with the topic.
- */
- imageUrl: string;
- /**
- * Title of the image associated with the topic.
- */
- imageTitle: string;
- /**
- * Copyright information for the topic image.
- */
- imageCopyright: string;
- /**
- * List of subtopics associated with the main topic.
- */
- subTopicList: Array<SubTopic>;
-};
-/**
- * Represents a link.
- */
-export type Link = {
- /**
- * The title of the link.
- */
- title: string;
- /**
- * The URL link.
- */
- link: string;
-};
-/**
- * Represents a language.
- */
-export type Language = {
- /**
- * The locale of the language.
- */
- locale: string;
- /**
- * The language code.
- */
- language: string;
-};
-/**
- * Represents a subtopic.
- */
-export type SubTopic = {
- /**
- * The unique identifier for the subtopic.
- */
- id: string;
- /**
- * The vendor of the subtopic.
- */
- vendor: VendorType;
- /**
- * The transmission type of the subtopic.
- */
- transmission: TransmissionType;
- /**
- * The URN of the subtopic.
- */
- urn: string;
- /**
- * The title of the subtopic.
- */
- title: string;
- /**
- * The lead information for the subtopic.
- */
- lead: string;
- /**
- * The description of the subtopic.
- */
- description: string;
- /**
- * The number of viewed medias for the subtopic.
- */
- viewedMedias: number;
- /**
- * The URL of the image associated with the subtopic.
- */
- imageUrl: string;
- /**
- * The title of the image associated with the subtopic.
- */
- imageTitle: string;
- /**
- * The copyright information of the image associated with the subtopic.
- */
- imageCopyright: string;
-};
-/**
- * Represents a presenter.
- */
-export type Presenter = {
- /**
- * The name of the presenter.
- */
- name: string;
- /**
- * The URL associated with the presenter.
- */
- url: string;
- /**
- * The URL of the image associated with the presenter.
- */
- imageUrl: string;
- /**
- * The title of the image associated with the presenter.
- */
- imageTitle: string;
- /**
- * The copyright information of the image associated with the presenter.
- */
- imageCopyright: string;
-};
-/**
- * Represents broadcast information.
- */
-export type BroadcastInformation = {
- /**
- * The hint text associated with the broadcast.
- */
- hintText: string;
- /**
- * The URL associated with the broadcast.
- */
- url: string;
- /**
- * The start date and time of the broadcast in ISO 8601 format.
- */
- startDate: string;
- /**
- * The end date and time of the broadcast in ISO 8601 format.
- */
- endDate: string;
-};
-/**
- * Represents a scheduled broadcast.
- */
-export type ScheduledBroadcast = {
- /**
- * The title of the scheduled broadcast.
- */
- title: string;
- /**
- * The start time of the scheduled broadcast in ISO 8601 format.
- */
- startTime: string;
- /**
- * The end time of the scheduled broadcast in ISO 8601 format.
- */
- endTime: string;
- /**
- * The title of the channel associated with the scheduled broadcast.
- */
- channelTitle: string;
- /**
- * The URN (Uniform Resource Name) associated with the channel.
- */
- channelUrn: string;
-};
-/**
- * Represents a program.
- */
-export type Program = {
- /**
- * The title of the program.
- */
- title: string;
- /**
- * The start time of the program in ISO 8601 format.
- */
- startTime: string;
- /**
- * The end time of the program in ISO 8601 format.
- */
- endTime: string;
- /**
- * The lead information of the program.
- */
- lead: string;
- /**
- * The description of the program.
- */
- description: string;
- /**
- * The URL of the image associated with the program.
- */
- imageUrl: string;
- /**
- * Indicates whether the image is a fallback URL.
- */
- imageIsFallbackUrl: boolean;
- /**
- * The title of the image associated with the program.
- */
- imageTitle: string;
- /**
- * The copyright information of the image associated with the program.
- */
- imageCopyright: string;
- /**
- * The URL associated with the program.
- */
- url: string;
- /**
- * The show associated with the program.
- */
- show: Show;
- /**
- * The title of the program.
- */
- programTitle: string;
- /**
- * The URL associated with the program.
- */
- programUrl: string;
- /**
- * The title of the episode.
- */
- episodeTitle: string;
- /**
- * The URL associated with the episode.
- */
- episodeUrl: string;
- /**
- * The title of the image associated with the episode.
- */
- episodeImageTitle: string;
- /**
- * The URL of the image associated with the episode.
- */
- episodeImageUrl: string;
- /**
- * The URN (Uniform Resource Name) associated with the media.
- */
- mediaUrn: string;
- /**
- * The genre of the program.
- */
- genre: string;
- /**
- * The season number of the program.
- */
- seasonNumber: number;
- /**
- * The episode number of the program.
- */
- episodeNumber: number;
- /**
- * The total number of episodes.
- */
- episodesTotal: number;
- /**
- * The production year of the program.
- */
- productionYear: number;
- /**
- * The production country of the program.
- */
- productionCountry: string;
- /**
- * The color code for youth protection.
- */
- youthProtectionColor: string;
- /**
- * The subtitle information of the program.
- */
- subtitle: string;
- /**
- * The title of the block associated with the program.
- */
- blockTitle: string;
- /**
- * The original title of the program.
- */
- originalTitle: string;
- /**
- * The list of credits associated with the program.
- */
- creditList: Array<Credit>;
- /**
- * The list of sub-programs associated with the program.
- */
- subProgramList: Array<Program>;
- /**
- * Indicates whether subtitles are available.
- */
- subtitlesAvailable: boolean;
- /**
- * Indicates whether the program is live.
- */
- isLive: boolean;
- /**
- * Indicates whether the program has two languages.
- */
- hasTwoLanguages: boolean;
- /**
- * Indicates whether the program has sign language.
- */
- hasSignLanguage: boolean;
- /**
- * Indicates whether the program has visual description.
- */
- hasVisualDescription: boolean;
- /**
- * Indicates whether the program is a follow-up.
- */
- isFollowUp: boolean;
- /**
- * Indicates whether the program is in Dolby Digital.
- */
- isDolbyDigital: boolean;
- /**
- * Indicates whether the program is a repetition.
- */
- isRepetition: boolean;
- /**
- * The description of the repetition.
- */
- repetitionDescription: string;
- /**
- * The broadcast information associated with the program.
- */
- broadcastInfo: string;
- /**
- * The title of the channel associated with the program.
- */
- channelTitle: string;
- /**
- * The URN (Uniform Resource Name) associated with the channel.
- */
- channelUrn: string;
- /**
- * The list of headlines associated with the program.
- */
- headlineList: Array<Headline>;
-};
-/**
- * Represents credit information.
- */
-export type Credit = {
- /**
- * The real name associated with the credit.
- */
- realName: string;
- /**
- * The role of the individual associated with the credit.
- */
- role: string;
- /**
- * The name associated with the credit.
- */
- name: string;
-};
-/**
- * Represents headline information.
- */
-export type Headline = {
- /**
- * The title of the headline.
- */
- title: string;
- /**
- * The description of the headline.
- */
- description: string;
-};
-/**
- * Broadcasting organizations
- */
-export type VendorType = 'SRF' | 'RTR' | 'RTS' | 'RSI' | 'SWI' | 'SSATR';
-/**
- * Audio-only or includes video
- */
-export type AudioType = 'AUDIO' | 'VIDEO';
-/**
- * Reasons for content blocking
- */
-export type BlockReason =
- 'GEOBLOCK'
- | 'LEGAL'
- | 'COMMERCIAL'
- | 'AGERATING18'
- | 'AGERATING12'
- | 'STARTDATE'
- | 'ENDDATE'
- | 'UNKNOWN';
-/**
- * Medium of transmission
- */
-export type TransmissionType = 'TV' | 'RADIO' | 'ONLINE';
-/**
- * Content quality
- */
-export type QualityType = 'SD' | 'HD' | 'HQ';
-/**
- * Source type for audio/video tracks
- */
-export type TrackSourceType = 'HLS' | 'HDS' | 'DASH';
-/**
- * Presentation format
- */
-export type PresentationType = 'DEFAULT' | 'VIDEO_360';
-/**
- * Enumerates various streaming methods
- */
-export type StreamingType = 'PROGRESSIVE' | 'M3UPLAYLIST' | 'HLS' | 'HDS' | 'RTMP' | 'DASH' | 'UNKNOWN';
-/**
- * Represents different token types for authentication
- */
-export type TokenType = 'AKAMAI' | 'NONE';
-
-
-/**
- * Represents the transformed format of a resource.
- */
-export interface MainResource {
- /**
- * Merged analytics data.
- */
- analyticsData: {
- [x: string]: string;
- };
- /**
- * Merged analytics metadata.
- */
- analyticsMetadata: {
- [x: string]: string;
- };
- /**
- * Block reason from the main chapter.
- */
- blockReason: BlockReason;
- /**
- * Blocked segments from the main chapter.
- */
- blockedSegments: Array<Segment>;
- /**
- * Chapters from the main chapter.
- */
- chapters: Array<Chapter>;
- /**
- * Vendor from the main chapter.
- */
- vendor: VendorType;
- /**
- * List of DRM information from the resource.
- */
- drmList: Array<DrmMetadata>;
- /**
- * DVR information from the resource.
- */
- dvr: boolean;
- /**
- * Event data from the main chapter.
- */
- eventData: string;
- /**
- * ID from the main chapter.
- */
- id: string;
- /**
- * The url of the copyright image copyright from the main chapter.
- */
- imageCopyright: string;
- /**
- * The url of the image from the main chapter.
- */
- imageUrl: string;
- /**
- * Live status from the resource.
- */
- live: boolean;
- /**
- * Media type from the main chapter.
- */
- mediaType: AudioType;
- /**
- * MIME type from the resource.
- */
- mimeType: string;
- /**
- * Presentation information from the resource.
- */
- presentation: PresentationType;
- /**
- * Quality information from the resource.
- */
- quality: QualityType;
- /**
- * Streaming information from the resource.
- */
- streaming: StreamingType;
- /**
- * Stream offset from the resource.
- */
- streamOffset: number;
- /**
- * Filtered external subtitles.
- */
- subtitles: Array<Subtitle>;
- /**
- * The title of this resource.
- */
- title: string;
- /**
- * Time intervals from the main chapter.
- */
- intervals: Array<TimeInterval>;
- /**
- * Token type from the resource.
- */
- tokenType: TokenType;
- /**
- * URL from the resource.
- */
- url: string;
- /**
- * Chapter URN.
- */
- urn: string;
-}
-Global
Type Definitions AudioTrack Represents audio track information associated with a media resource.
Properties Name Type Description localestring Locale information for the audio track.
languagestring Language of the audio track.
sourceTrackSourceType Source of the audio track.
type'AUDIO_DESCRIPTION' Type of the audio track.
AudioType Audio-only or includes video
BlockReason Reasons for content blocking
Type: 'GEOBLOCK' | 'LEGAL' | 'COMMERCIAL' | 'AGERATING18' | 'AGERATING12' | 'STARTDATE' | 'ENDDATE' | 'UNKNOWN' Represents broadcast information.
Properties Name Type Description hintTextstring The hint text associated with the broadcast.
urlstring The URL associated with the broadcast.
startDatestring The start date and time of the broadcast in ISO 8601 format.
endDatestring The end date and time of the broadcast in ISO 8601 format.
Channel Properties Name Type Description idstring Unique identifier for the channel.
vendorVendorType Vendor of the channel.
titlestring Title of the channel.
leadstring Lead description of the channel.
descriptionstring Detailed description of the channel.
imageUrlstring URL of the image associated with the channel.
imageUrlRawstring Raw URL of the image associated with the channel.
imageTitlestring Title of the image associated with the channel.
imageCopyrightstring Copyright information for the channel image.
transmissionTransmissionType Type of transmission for the channel.
timeTableUrlstring URL for the channel's timetable.
presenterPresenter Information about the presenter associated with the channel.
nowProgram Information about the currently airing program on the channel.
nextProgram Information about the next scheduled program on the channel.
urnstring URN (Uniform Resource Name) for the channel.
Chapter Represents a chapter of media content.
Properties Name Type Description idstring Unique identifier for the chapter.
mediaTypeAudioType Type of media content (AUDIO or VIDEO).
vendorVendorType Vendor associated with the chapter.
urnstring URN (Uniform Resource Name) for the chapter.
titlestring Title of the chapter.
leadstring Lead information for the chapter.
descriptionstring Description of the chapter.
mediaDescriptionstring Media description of the chapter.
imageUrlstring URL of the image associated with the chapter.
imageTitlestring Title of the image associated with the chapter.
imageCopyrightstring Copyright information for the image.
blockReasonBlockReason Reason for blocking the chapter.
youthProtectionColor'YELLOW' | 'RED' Youth protection color code.
type'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM' Type of the chapter.
datestring Date and time information for the chapter.
durationnumber Duration of the chapter in seconds.
podcastSdUrlstring URL for the standard-definition podcast.
podcastHdUrlstring URL for the high-definition podcast.
validFromstring Validity start date and time for the chapter.
validTostring Validity end date and time for the chapter.
assignedBy'EDITOR' | 'TRENDING' | 'RECOMMENDATION' User who assigned the chapter.
playableAbroadboolean Indicates if the chapter is playable abroad.
relatedContentListArray.<RelatedContent > List of related content for the chapter.
socialCountListArray.<SocialCountEntry > List of social media counts for the chapter.
displayableboolean Indicates if the chapter is displayable.
fullLengthUrnstring URN for the full-length version of the chapter.
positionnumber Position of the chapter.
noEmbedboolean Indicates if the chapter can be embedded.
subtitleListArray.<Subtitle > List of subtitles for the chapter.
analyticsDataobject Analytics data for the chapter.
Properties Name Type Description x:string string
analyticsMetadataobject Metadata for analytics associated with the chapter.
Properties Name Type Description x:string string
eventDatastring Event data associated with the chapter.
playerPropertiesArray.<PlayerProperty > List of player properties for the chapter.
tagListArray.<string> List of tags associated with the chapter.
labelstring Label information for the chapter.
fullLengthMarkInnumber Mark in time for the full-length version of the chapter.
fullLengthMarkOutnumber Mark out time for the full-length version of the chapter.
resourceListArray.<Resource > List of resources associated with the chapter.
segmentListArray.<Segment > List of segments associated with the chapter.
preTrailerStartstring Start time for the pre-trailer content.
postTrailerStopstring Stop time for the post-trailer content.
cesimIdstring CESIM (Content, Episode, Segment, Image, Module) identifier for the chapter.
hbbtvPropertiesArray.<HbbtvProperties > List of HbbtvProperties for the chapter.
creatorNamestring Name of the creator of the chapter.
creatorUserstring User associated with the creator of the chapter.
aspectRatio'1:1' | '4:5' | '4:3' | '9:16' | '16:9' Aspect ratio of the chapter.
dvrReferenceDatestring DVR reference date and time for the chapter.
timeIntervalListArray.<TimeInterval > List of time intervals associated with the chapter.
spriteSheetSpriteSheet Sprite sheet information for the chapter.
Represents the result of composing source media data.
Properties Name Type Description srcstring The URL of the source media.
typestring The MIME type of the source media.
keySystemsKeySystems A mapping of DRM types to their corresponding key systems information.
disableTrackersboolean Indicates whether trackers are disabled for the source media.
mediaDataMainResource The merged media data from the source and additional media data.
Credit Represents credit information.
Properties Name Type Description realNamestring The real name associated with the credit.
rolestring The role of the individual associated with the credit.
namestring The name associated with the credit.
Represents Digital Rights Management (DRM) information associated with a media resource.
Properties Name Type Description type'FAIRPLAY' | 'WIDEVINE' | 'PLAYREADY' Type of DRM used for the resource.
licenseUrlstring URL for the DRM license.
certificateUrlstring URL for the DRM certificate.
Episode Represents an episode of media content.
Properties Name Type Description idstring Unique identifier for the episode.
titlestring Title of the episode.
leadstring Lead description of the episode.
descriptionstring Detailed description of the episode.
publishedDatestring Date and time when the episode was published.
imageUrlstring URL of the image associated with the episode.
imageTitlestring Title of the image associated with the episode.
imageCopyrightstring Copyright information for the episode image.
fullLengthUrnstring URN (Uniform Resource Name) for the full-length version of the episode.
seasonNumbernumber Season number to which the episode belongs.
numbernumber Episode number.
socialCountSocialCountEntry Social count entry for the episode.
HbbtvProperties Represents HbbTV properties associated with a chapter.
Properties Name Type Description redButtonboolean Indicates the availability of the red button feature.
imageLinkstring URL link associated with the image for HbbTV.
Headline Represents headline information.
Properties Name Type Description titlestring The title of the headline.
descriptionstring The description of the headline.
Language Properties Name Type Description localestring The locale of the language.
languagestring The language code.
Link Properties Name Type Description titlestring The title of the link.
linkstring The URL link.
MainResource PlayerProperty Represents a player property associated with a media segment.
Properties Name Type Description key'iFrameUrl' | 'playerUrl' | 'playerRelativeIconImageUrl' | 'playerWidth' | 'playerHeight' Key identifying the type of player property.
valuestring Value of the player property.
PresentationType Presenter Properties Name Type Description namestring The name of the presenter.
urlstring The URL associated with the presenter.
imageUrlstring The URL of the image associated with the presenter.
imageTitlestring The title of the image associated with the presenter.
imageCopyrightstring The copyright information of the image associated with the presenter.
Program Properties Name Type Description titlestring The title of the program.
startTimestring The start time of the program in ISO 8601 format.
endTimestring The end time of the program in ISO 8601 format.
leadstring The lead information of the program.
descriptionstring The description of the program.
imageUrlstring The URL of the image associated with the program.
imageIsFallbackUrlboolean Indicates whether the image is a fallback URL.
imageTitlestring The title of the image associated with the program.
imageCopyrightstring The copyright information of the image associated with the program.
urlstring The URL associated with the program.
showShow The show associated with the program.
programTitlestring The title of the program.
programUrlstring The URL associated with the program.
episodeTitlestring The title of the episode.
episodeUrlstring The URL associated with the episode.
episodeImageTitlestring The title of the image associated with the episode.
episodeImageUrlstring The URL of the image associated with the episode.
mediaUrnstring The URN (Uniform Resource Name) associated with the media.
genrestring The genre of the program.
seasonNumbernumber The season number of the program.
episodeNumbernumber The episode number of the program.
episodesTotalnumber The total number of episodes.
productionYearnumber The production year of the program.
productionCountrystring The production country of the program.
youthProtectionColorstring The color code for youth protection.
subtitlestring The subtitle information of the program.
blockTitlestring The title of the block associated with the program.
originalTitlestring The original title of the program.
creditListArray.<Credit > The list of credits associated with the program.
subProgramListArray.<Program > The list of sub-programs associated with the program.
subtitlesAvailableboolean Indicates whether subtitles are available.
isLiveboolean Indicates whether the program is live.
hasTwoLanguagesboolean Indicates whether the program has two languages.
hasSignLanguageboolean Indicates whether the program has sign language.
hasVisualDescriptionboolean Indicates whether the program has visual description.
isFollowUpboolean Indicates whether the program is a follow-up.
isDolbyDigitalboolean Indicates whether the program is in Dolby Digital.
isRepetitionboolean Indicates whether the program is a repetition.
repetitionDescriptionstring The description of the repetition.
broadcastInfostring The broadcast information associated with the program.
channelTitlestring The title of the channel associated with the program.
channelUrnstring The URN (Uniform Resource Name) associated with the channel.
headlineListArray.<Headline > The list of headlines associated with the program.
QualityType RelatedContent Represents related content associated with a media segment.
Properties Name Type Description idstring Unique identifier for the related content.
titlestring Title of the related content. Limited to 2000 characters.
leadstring Lead information for the related content.
descriptionstring Description of the related content.
urlstring URL of the related content.
contentTypestring Type of content.
isExternalboolean Indicates if the related content is external.
Resource Represents a resource associated with a media segment.
Properties Name Type Description urlstring URL of the resource.
drmListArray.<DrmMetadata > List of Digital Rights Management (DRM) information for the resource.
qualityQualityType Quality of the resource.
protocol'HLS' | 'HLS-DVR' | 'HDS' | 'HDS-DVR' | 'RTMP' | 'HTTP' | 'HTTPS' | 'HTTP-M3U' | 'HTTP-MP3-STREAM' | 'DASH' | 'DASH-DVR' Protocol used for streaming the resource.
encoding'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2' Encoding used for the resource.
mimeTypestring MIME type of the resource.
presentationPresentationType Presentation mode of the resource.
streamingStreamingType Streaming type of the resource.
dvrboolean Indicates if the resource supports Digital Video Recorder (DVR).
liveboolean Indicates if the resource is a live stream.
mediaContainer'MP4' | 'MKV' | 'MPEG2_TS' | 'FMP4' | 'NONE' | 'UNKNOWN' Media container type of the resource.
audioCodec'AAC' | 'AAC-HE' | 'MP3' | 'MP2' | 'WMAV2' | 'UNKNOWN' Audio codec used for the resource.
videoCodec'H264' | 'VP6F' | 'MPEG2' | 'WMV3' | 'NONE' | 'UNKNOWN' Video codec used for the resource.
tokenTypeTokenType Token type used for the resource.
audioTrackListArray.<AudioTrack > List of audio tracks associated with the resource.
subtitleInformationListArray.<SubtitleInformation > List of subtitle information associated with the resource.
analyticsDataobject Analytics data for the resource.
Properties Name Type Description x:string string
analyticsMetadataobject Metadata for analytics purposes.
Properties Name Type Description x:string string
streamOffsetnumber Stream offset for the resource.
ScheduledBroadcast Represents a scheduled broadcast.
Properties Name Type Description titlestring The title of the scheduled broadcast.
startTimestring The start time of the scheduled broadcast in ISO 8601 format.
endTimestring The end time of the scheduled broadcast in ISO 8601 format.
channelTitlestring The title of the channel associated with the scheduled broadcast.
channelUrnstring The URN (Uniform Resource Name) associated with the channel.
Segment Represents a media segment with detailed metadata.
Properties Name Type Description idstring Unique identifier for the segment.
mediaTypeAudioType Type of media.
vendorVendorType Vendor of the segment.
urnstring URN (Uniform Resource Name) specifying the segment details.
titlestring Title of the segment. Limited to 2000 characters.
leadstring Lead information for the segment.
descriptionstring Description of the segment.
mediaDescriptionstring Media description for the segment.
imageUrlstring URL of the image associated with the segment.
imageTitlestring Title of the image associated with the segment. Limited to 2000 characters.
imageCopyrightstring Copyright information for the image.
blockReasonBlockReason Reason for blocking.
youthProtectionColor'YELLOW' | 'RED' Youth protection color. Allowed values: 'YELLOW', 'RED'.
type'EPISODE' | 'EXTRACT' | 'TRAILER' | 'CLIP' | 'LIVESTREAM' | 'SCHEDULED_LIVESTREAM' Type of the segment. Allowed values: 'EPISODE', 'EXTRACT', 'TRAILER', 'CLIP', 'LIVESTREAM', 'SCHEDULED_LIVESTREAM'.
datestring Date and time information in ISO8601 format.
durationnumber Duration of the segment in seconds.
podcastSdUrlstring URL for the standard definition podcast.
podcastHdUrlstring URL for the high definition podcast.
validFromstring Start date and time for the validity period in ISO8601 format.
validTostring End date and time for the validity period in ISO8601 format.
assignedBy'EDITOR' | 'TRENDING' | 'RECOMMENDATION' Entity responsible for the assignment. Allowed values: 'EDITOR', 'TRENDING', 'RECOMMENDATION'.
playableAbroadboolean Indicates if the segment is playable abroad.
relatedContentListArray.<RelatedContent > List of related content items.
socialCountListArray.<SocialCountEntry > List of social count entries.
displayableboolean Indicates if the segment is displayable.
fullLengthUrnstring Full-length URN specifying the segment details.
positionnumber Position of the segment.
noEmbedboolean Indicates if the segment should not be embedded.
subtitleListArray.<Subtitle > List of subtitle entries.
analyticsDataobject Analytics data for the segment.
Properties Name Type Description x:string string
analyticsMetadataobject Metadata for analytics purposes.
Properties Name Type Description x:string string
eventDatastring Event data associated with the segment.
playerPropertiesArray.<PlayerProperty > List of player properties.
tagListArray.<string> List of tags associated with the segment.
labelstring Label for the segment.
markInnumber Integer representing the mark in time.
markOutnumber Integer representing the mark out time.
Show Properties Name Type Description idstring Unique identifier for the show.
vendorVendorType Vendor of the show.
transmissionTransmissionType Type of transmission for the show.
urnstring URN (Uniform Resource Name) for the show.
titlestring Title of the show.
leadstring Lead description of the show.
descriptionstring Detailed description of the show.
imageUrlstring URL of the image associated with the show.
imageTitlestring Title of the image associated with the show.
imageCopyrightstring Copyright information for the show image.
bannerImageUrlstring URL of the banner image for the show.
posterImageUrlstring URL of the poster image for the show.
posterImageIsFallbackUrlboolean Indicates if the poster image is a fallback URL.
podcastImageUrlstring URL of the podcast image for the show.
podcastImageIsFallbackUrlboolean Indicates if the podcast image is a fallback URL.
homepageUrlstring URL of the show's homepage.
podcastSubscriptionUrlstring URL for podcast subscription.
podcastFeedSdUrlstring URL for podcast feed (SD).
podcastFeedHdUrlstring URL for podcast feed (HD).
podcastDeezerUrlstring URL for podcast on Deezer.
podcastSpotifyUrlstring URL for podcast on Spotify.
timeTableUrlstring URL for the show's timetable.
linksArray.<Link > List of links associated with the show.
primaryChannelIdstring ID of the primary channel for the show.
viewedMediasnumber Number of times the show has been viewed.
numberOfEpisodesnumber Number of episodes available for the show.
availableAudioLanguageListArray.<Language > List of available audio languages for the show.
availableSubtitleLanguageListArray.<Language > List of available subtitle languages for the show.
availableVideoQualityListArray.<QualityType > List of available video quality options for the show.
audioDescriptionAvailableboolean Indicates if audio description is available for the show.
subtitlesAvailableboolean Indicates if subtitles are available for the show.
multiAudioLanguagesAvailableboolean Indicates if multiple audio languages are available for the show.
topicListArray.<Topic > List of topics associated with the show.
broadcastInformationBroadcastInformation Information about the show's broadcast.
allowIndexingboolean Indicates if the show is allowed to be indexed.
nextScheduledBroadcastScheduledBroadcast Information about the next scheduled broadcast for the show.
nextScheduledBroadcastListArray.<Program > List of programs for the next scheduled broadcasts.
primaryChannelUrnstring URN of the primary channel for the show.
SocialCountEntry Represents a social media count entry associated with a media segment.
Properties Name Type Description key'srgView' | 'srgLike' | 'fbShare' | 'googleShare' | 'twitterShare' | 'whatsAppShare' Key identifying the type of social media count.
valuenumber Count value for the social media entry.
SpriteSheet Represents a sprite sheet associated with a chapter.
Properties Name Type Description urnstring URN (Uniform Resource Name) for the sprite sheet.
rowsnumber Number of rows in the sprite sheet.
columnsnumber Number of columns in the sprite sheet.
thumbnailHeightnumber Height of each thumbnail in the sprite sheet.
thumbnailWidthnumber Width of each thumbnail in the sprite sheet.
intervalnumber Interval between frames in milliseconds.
urlstring URL link to the sprite sheet.
SrgOptions Represents a set of options specific to the SRG SSR.
Note :
All these options have a default value and can therefore be undefined. DataProvider options cannot be combined with each other. Properties Name Type Description dataProviderundefined | function A function returning an object representing a mediaComposition.
dataProviderHostundefined | string A specific host for a different IL environment.
dataProviderUrlHandlerundefined | function A function for handling a custom data source.
tagCommanderScriptURLundefined | string The URL of the TagCommander script.
StreamingType Enumerates various streaming methods
Type: 'PROGRESSIVE' | 'M3UPLAYLIST' | 'HLS' | 'HDS' | 'RTMP' | 'DASH' | 'UNKNOWN' SubTopic Properties Name Type Description idstring The unique identifier for the subtopic.
vendorVendorType The vendor of the subtopic.
transmissionTransmissionType The transmission type of the subtopic.
urnstring The URN of the subtopic.
titlestring The title of the subtopic.
leadstring The lead information for the subtopic.
descriptionstring The description of the subtopic.
viewedMediasnumber The number of viewed medias for the subtopic.
imageUrlstring The URL of the image associated with the subtopic.
imageTitlestring The title of the image associated with the subtopic.
imageCopyrightstring The copyright information of the image associated with the subtopic.
Subtitle Represents subtitle information for a media segment.
Properties Name Type Description localestring Locale information for the subtitle.
languagestring Language of the subtitle.
source'EXTERNAL' | TrackSourceType Source of the subtitle.
type'SDH' Type of the subtitle.
urlstring URL of the subtitle.
format'TTML' | 'VTT' Format of the subtitle.
Represents subtitle information associated with a media resource.
Properties Name Type Description localestring Locale information for the subtitle.
languagestring Language of the subtitle.
source'EXTERNAL' | TrackSourceType Source of the subtitle information.
type'SDH' Type of the subtitle information.
TimeInterval Represents a time interval metadata used to mark the beginning and ending of opening or closing credits.
Properties Name Type Description type'OPENING_CREDITS' | 'CLOSING_CREDITS' The type of the time interval.
markInnumber An integer representing the mark in time.
markOutnumber An integer representing the mark out time.
TokenType Represents different token types for authentication
Topic Properties Name Type Description idstring Unique identifier for the topic.
vendorVendorType Vendor of the topic.
transmissionTransmissionType Type of transmission for the topic.
urnstring URN (Uniform Resource Name) for the topic.
titlestring Title of the topic.
leadstring Lead description of the topic.
descriptionstring Detailed description of the topic.
viewedMediasnumber Number of viewed medias related to the topic.
imageUrlstring URL of the image associated with the topic.
imageTitlestring Title of the image associated with the topic.
imageCopyrightstring Copyright information for the topic image.
subTopicListArray.<SubTopic > List of subtopics associated with the main topic.
TrackSelector Properties Name Type Description languagestring The track language
kindstring The track kind
TrackSourceType Source type for audio/video tracks
TransmissionType Type: 'TV' | 'RADIO' | 'ONLINE' VendorType Broadcasting organizations
Type: 'SRF' | 'RTR' | 'RTS' | 'RSI' | 'SWI' | 'SSATR' Interface: MainResource Represents the transformed format of a resource.
Members :object Properties Name Type Description x:string string
Merged analytics metadata.
Properties Name Type Description x:string string
Block reason from the main chapter.
:Array.<Segment > Blocked segments from the main chapter.
:Array.<Chapter > Chapters from the main chapter.
List of DRM information from the resource.
:boolean DVR information from the resource.
:string Event data from the main chapter.
:string ID from the main chapter.
:string The url of the copyright image copyright from the main chapter.
:string The url of the image from the main chapter.
Time intervals from the main chapter.
:boolean Live status from the resource.
Media type from the main chapter.
:string MIME type from the resource.
Presentation information from the resource.
Quality information from the resource.
:number Stream offset from the resource.
Streaming information from the resource.
:Array.<Subtitle > Filtered external subtitles.
:string The title of this resource.
Token type from the resource.
:string :string Vendor from the main chapter.
pillarbox-web API Welcome to the documentation for the Pillarbox Web Player, a web-based video player built on top of Video.js.
Quick Guide To get started with Pillarbox, install it through the following command:
npm install --save @srgssr/pillarbox-web
-In your HTML file, add the following code to initialize Pillarbox:
<video-js id="my-player" class="pillarbox-js" controls></video-js>
-Import the CSS file in your HTML to apply Pillarbox default theme:
-<link rel="stylesheet" href="node_modules/@srgssr/pillarbox-web/dist/pillarbox.min.css"/>
-Finally, import Pillarbox and set up the player:
import Pillarbox from '@srgssr/pillarbox-web';
-
-const player = new Pillarbox('my-player', {/* options... */ });
-player.src({ src: 'urn:swi:video:48115940', type: 'srgssr/urn' });
-Player workflows For a comprehensive guide on player workflows, refer to the official Video.js Player Workflows Guide .
More showcases and examples ara available in the Pillarbox Demo Application .
Further Reading Pillarbox serves as a superset of video.js, making all the available API features from video.js accessible without any modification. The most useful doc tu start is the Player class.
To learn more about video.js, you can visit the Video.js Guides and the Video.js API docs .
To expand the features that Pillarbox offers out of the box, visit the Pillarbox Web Suite . You are welcome to contribute and share your own components there.
Keep track of our Known Issues section.
You can learn more about themes and create your own with the Pillarbox Theme Editor .
Source: middleware/srgssr.js import Pillarbox from '../../src/pillarbox.js';
-import DataProvider from '../dataProvider/services/DataProvider.js';
-import Image from '../utils/Image.js';
-import Drm from '../utils/Drm.js';
-import AkamaiTokenService from '../utils/AkamaiTokenService.js';
-import SRGAnalytics from '../trackers/SRGAnalytics.js';
-import PillarboxMonitoring from '../trackers/PillarboxMonitoring.js';
-import MediaComposition from '../dataProvider/model/MediaComposition.js';
-
-// Translations
-import '../lang/de.js';
-import '../lang/en.js';
-import '../lang/fr.js';
-import '../lang/it.js';
-import '../lang/rm.js';
-
-/**
- * @class SrgSsr
- */
-class SrgSsr {
- /**
- * Adds blocked segments to the player.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Array<import('../dataProvider/model/typedef').Segment>} [segments=[]]
- */
- static addBlockedSegments(player, segments = []) {
- const trackId = 'srgssr-blocked-segments';
- const removeTrack = player.textTracks().getTrackById(trackId);
-
- if (removeTrack) {
- player.textTracks().removeTrack(removeTrack);
- }
-
- if (!Array.isArray(segments) || !segments.length) return;
-
- const blockedSegments = segments.filter(segment => segment.blockReason);
-
- if (!blockedSegments.length) return;
-
- SrgSsr.createTextTrack(player, trackId).then(segmentTrack => {
- blockedSegments.forEach(segment => {
- SrgSsr.addTextTrackCue(segmentTrack, segment);
- });
-
- player.textTracks().addTrack(segmentTrack);
- });
- }
-
- /**
- * Adds remote text tracks from an array of subtitles.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Array<import('../dataProvider/model/typedef').Subtitle>} [subtitles=[]]
- */
- static addRemoteTextTracks(player, subtitles = []) {
- if (!Array.isArray(subtitles)) return;
-
- subtitles.forEach(({
- type,
- language: label,
- locale: language,
- url: src
- }) => {
- player.addRemoteTextTrack({
- kind: type === 'SDH' ? 'captions' : 'subtitles',
- label,
- language,
- src
- });
- });
- }
-
- /**
- * Add a new cue to a text track with the given data.
- *
- * @param {TextTrack} textTrack
- * @param {
- * import('../dataProvider/model/typedef').Segment |
- * import('../dataProvider/model/typedef').Chapter |
- * import('../dataProvider/model/typedef').TimeInterval
- * } data SRG SSR's cue-like representation
- */
- static addTextTrackCue(textTrack, data) {
- const startTime = (Number.isFinite(data.markIn)
- ? data.markIn : data.fullLengthMarkIn) / 1_000;
- const endTime = (Number.isFinite(data.markOut)
- ? data.markOut : data.fullLengthMarkOut) / 1_000;
-
- textTrack.addCue(new VTTCue(
- startTime,
- endTime,
- JSON.stringify(data)
- ));
- }
-
- /**
- * Add multiple text tracks to the player.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {import('./typedef').ComposedSrcMediaData} srcMediaObj
- */
- static addTextTracks(player, { mediaData }) {
- SrgSsr.addRemoteTextTracks(player, mediaData.subtitles);
- SrgSsr.addChapters(player, mediaData.urn, mediaData.chapters);
- SrgSsr.addBlockedSegments(player, mediaData.blockedSegments);
- SrgSsr.addIntervals(player, mediaData.intervals);
- }
-
- /**
- * Adds chapters to the player.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {string} chapterUrn The URN of the main chapter.
- * @param {Array.<import('../dataProvider/model/typedef').Chapter>} [chapters=[]]
- */
- static addChapters(player, chapterUrn, chapters = []) {
- const trackId = 'srgssr-chapters';
- const removeTrack = player.textTracks().getTrackById(trackId);
-
- if (removeTrack) {
- player.textTracks().removeTrack(removeTrack);
- }
-
- if (!Array.isArray(chapters) || !chapters.length) return;
-
- SrgSsr.createTextTrack(player, trackId).then(chapterTrack => {
- chapters.forEach(chapter => {
- if (chapterUrn !== chapter.fullLengthUrn) return;
-
- SrgSsr.addTextTrackCue(chapterTrack, chapter);
- });
-
- player.textTracks().addTrack(chapterTrack);
- });
- }
-
- /**
- * Adds intervals to the player.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Array.<import('../dataProvider/model/typedef').TimeInterval>} [intervals=[]]
- */
- static addIntervals(player, intervals = []) {
- const trackId = 'srgssr-intervals';
- const removeTrack = player.textTracks().getTrackById(trackId);
-
- if (removeTrack) {
- player.textTracks().removeTrack(removeTrack);
- }
-
- if (!Array.isArray(intervals) || !intervals.length) return;
-
- SrgSsr.createTextTrack(player, trackId).then(intervalTrack => {
- intervals.forEach(interval => {
- SrgSsr.addTextTrackCue(intervalTrack, interval);
- });
-
- player.textTracks().addTrack(intervalTrack);
- });
- }
-
- /**
- * Set a blocking reason according to the block reason returned
- * by mediaData.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {import('./typedef').ComposedSrcMediaData} srcMediaObj
- *
- * @returns {undefined|Boolean}
- */
- static blockingReason(player, srcMediaObj) {
- if (!srcMediaObj.mediaData.blockReason) return;
-
- const message = player.localize(srcMediaObj.mediaData.blockReason);
-
- SrgSsr.error(player, {
- code: MediaError.MEDIA_ERR_ABORTED,
- message,
- metadata: {
- errorType: srcMediaObj.mediaData.blockReason,
- src: srcMediaObj
- },
- });
-
- return true;
- }
-
- /**
- * Add the Akamai token to all resources
- * if at least one of them has tokenType
- * set to Akamai.
- *
- * @param {Array.<import('./typedef').MainResourceWithKeySystems>} resources
- *
- * @returns {Promise<Array.<import('./typedef').MainResourceWithKeySystems>>}
- */
- static async composeAkamaiResources(resources = []) {
- if (!AkamaiTokenService.hasToken(resources)) {
- return Promise.resolve(resources);
- }
-
- // TODO allow to modify the Akamai URL
- return AkamaiTokenService.tokenizeSources(resources);
- }
-
- /**
- * Add the keySystems property to all resources
- * if at least one of them has DRM.
- *
- * @param {Array.<import('../dataProvider/model/typedef').MainResource>} resources
- *
- * @returns {Array.<import('./typedef').MainResourceWithKeySystems>}
- */
- static composeKeySystemsResources(resources = []) {
- if (!Drm.hasDrm(resources)) return resources;
-
- const resourcesWithKeySystems = resources.map((resource) => ({
- ...resource,
- ...Drm.buildKeySystems(resource.drmList),
- }));
-
- return resourcesWithKeySystems;
- }
-
- /**
- * Get the main resources from a mediaComposition.
- * May add an Akamai token or key systems if required by the resource.
- *
- * @param {MediaComposition} mediaComposition
- *
- * @returns {Promise<Array.<import('./typedef').MainResourceWithKeySystems>>}
- */
- static composeMainResources(mediaComposition) {
- return SrgSsr.composeAkamaiResources(
- SrgSsr.composeKeySystemsResources(
- SrgSsr.filterIncompatibleResources(mediaComposition.getMainResources())
- )
- );
- }
-
- /**
- * Compose source options with media data.
- * MediaData properties from source options overwrite mediaData from IL.
- *
- * @param {any} srcObj
- * @param {any} srcObj.mediaData overrides or adds metadata to the composed mediaData.
- * @param {boolean} srcObj.disableTrackers
- * @param {import('./typedef').MainResourceWithKeySystems} resource
- *
- * @returns {import('./typedef').ComposedSrcMediaData}
- */
- static composeSrcMediaData(
- { mediaData: srcMediaData, disableTrackers },
- resource
- ) {
- const {
- url,
- mimeType,
- keySystems,
- ...mediaData
- } = Pillarbox.obj.merge(resource, srcMediaData);
-
- return {
- src: url,
- type: mimeType,
- keySystems,
- disableTrackers,
- mediaData,
- };
- }
-
- /**
- * Create a new metadata text track.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {String} trackId Text track unique ID
- *
- * @returns {Promise<TextTrack>}
- */
- static createTextTrack(player, trackId) {
- // See https://github.com/videojs/video.js/issues/8519
- return new Promise((resolve) => {
- setTimeout(() => {
- resolve(new Pillarbox.TextTrack({
- id: trackId,
- kind: 'metadata',
- label: trackId,
- tech: player.tech(true),
- }));
- }, 100);
- });
- }
-
- /**
- * Proxy SRG SSR chapters and intervals cuechange events at player level.
- *
- * @param {import('video.js/dist/types/player').default} player
- */
- static cuechangeEventProxy(player) {
- player.textTracks().on('addtrack', ({ track }) => {
- if (!['srgssr-chapters', 'srgssr-intervals'].includes(track.id)) return;
-
- track.on('cuechange', () => {
- const [cue] = Array.from(track.activeCues);
- const type = track.id.includes('srgssr-chapters') ? 'srgssr/chapter' : 'srgssr/interval';
-
- player.trigger({ type, data: cue });
- });
- });
- }
-
- /**
- * SRG SSR data provider singleton.
- *
- * @param {import('video.js/dist/types/player').default} player
- *
- * @returns {DataProvider}
- */
- static dataProvider(player) {
- if (!player.options().srgOptions.dataProvider) {
- const {
- dataProviderHost,
- dataProviderUrlHandler
- } = player.options().srgOptions;
- const dataProvider = new DataProvider(dataProviderHost);
- const requestHandler = dataProvider
- .handleRequest(dataProviderUrlHandler);
-
- player.options({
- srgOptions: {
- dataProvider: requestHandler,
- },
- });
- }
-
- return player.options().srgOptions.dataProvider;
- }
-
- /**
- * Set an error if something goes wrong with the data provider.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Object} error
- *
- * @returns {undefined|true}
- */
- static dataProviderError(player, error) {
- if (!error) return;
-
- const statusText = error.statusText ? error.statusText : error.message;
-
- SrgSsr.error(player, {
- code: 0,
- message: player.localize('UNKNOWN'),
- metadata: {
- errorType: 'UNKNOWN',
- urn: player.src(),
- status: error.status,
- statusText,
- url: error.url,
- },
- });
-
- return true;
- }
-
- /**
- * Set player error.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Object} error
- */
- static error(player, { code, message, metadata }) {
- player.error(null);
-
- player.error({
- code,
- message,
- metadata,
- });
- }
-
- /**
- * Filter out incompatible resources such as `RTMP` and `HDS`.
- *
- * @param {Array.<import('../dataProvider/model/typedef').MainResource>} resources Resources to filter
- *
- * @returns {Array.<import('../dataProvider/model/typedef').MainResource>} The filtered resources
- */
- static filterIncompatibleResources(resources = []) {
- return resources.filter(
- (resource) => !['RTMP', 'HDS'].includes(resource.streaming)
- );
- }
-
- /**
- * Get the current blocked segment from the player.
- *
- * @param {import('video.js/dist/types/player').default} player
- *
- * @returns {VTTCue|undefined} The blocked segment cue object, or undefined
- */
- static getBlockedSegment(player) {
- const trackId = 'srgssr-blocked-segments';
- const blockedSegmentsTrack = player.textTracks().getTrackById(trackId);
-
- if (!blockedSegmentsTrack) return;
-
- /** @type {VTTCue} */
- const [blockedCue] = Array.from(blockedSegmentsTrack.activeCues);
-
- return blockedCue;
- }
-
- /**
- * Get the VTT cue of a blocked segment.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {Number} currentTime
- *
- * @returns {VTTCue|undefined} The VTT cue of a blocked segment, or undefined
- */
- static getBlockedSegmentByTime(player, currentTime) {
- const blockedSegment = SrgSsr.getBlockedSegment(player);
-
- if (!blockedSegment) return;
-
- const isBlocked = currentTime >= blockedSegment.startTime &&
- currentTime < blockedSegment.endTime;
-
- return isBlocked ? blockedSegment : undefined;
- }
-
- /**
- * Get mediaComposition from an URN.
- *
- * @param {String} urn
- * @param {Function} requestHandler
- *
- * @returns {Promise<MediaComposition>}
- */
- static async getMediaComposition(
- urn,
- handleRequest = new DataProvider().handleRequest()
- ) {
- const data = await handleRequest(urn);
-
- return Object.assign(new MediaComposition(), data);
- }
-
- /**
- * Get the mediaData most likely to be compatible depending on the browser.
- *
- * @param {Array.<import('./typedef').MainResourceWithKeySystems>} resources
- *
- * @returns {import('./typedef').MainResourceWithKeySystems} By default, the first entry is used if none is compatible.
- */
- static getMediaData(resources = []) {
- if (AkamaiTokenService.hasToken(resources)) return resources[0];
-
- const type = Pillarbox.browser.IS_ANY_SAFARI ? 'HLS' : 'DASH';
- const resource = resources.find(({ streaming }) => streaming === type);
-
- return resource || resources[0];
- }
-
- /**
- * Get the source media object.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {any} srcObj
- *
- * @returns {Promise<import('./typedef').ComposedSrcMediaData>} - The composed source media data.
- */
- static async getSrcMediaObj(player, srcObj) {
- if (SrgSsr.pillarboxMonitoring(player)) {
- SrgSsr.pillarboxMonitoring(player).sessionStart();
- }
-
- const { src: urn, ...srcOptions } = srcObj;
- const mediaComposition = await SrgSsr.getMediaComposition(
- urn,
- SrgSsr.dataProvider(player)
- );
- const mainResources = await SrgSsr.composeMainResources(
- mediaComposition
- );
- const mediaData = SrgSsr.getMediaData(mainResources);
-
- return SrgSsr.composeSrcMediaData(srcOptions, mediaData);
- }
-
- /**
- * Handles the middleware's currentTime function.
- * - If the current time is between the start and end of a blocked segment,
- * the blocked portion will be skipped.
- *
- * _Note_: This function should disappear as soon as this behavior is
- * supported on the packaging side.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {number} currentTime
- *
- * @returns {number}
- */
- static handleCurrentTime(player, currentTime) {
- const blockedSegment = SrgSsr
- .getBlockedSegmentByTime(player, currentTime);
-
- if (!blockedSegment || !Number.isFinite(blockedSegment.endTime)) {
- return currentTime;
- }
-
- // as a workaround, add 0.1 seconds to avoid getting stuck on endTime on
- // some safaris.
- const endTimeWithTolerance = blockedSegment.endTime + 0.1;
-
- // proxy for handling cuechange events at the player level
- player.trigger({ type: 'srgssr/blocked-segment', data: blockedSegment });
- player.currentTime(endTimeWithTolerance);
-
- return endTimeWithTolerance;
- }
-
- /**
- * Handles the middleware's setCurrentTime function.
- * - Modify the current time if the value is between the start and end of a
- * blocked segment.
- *
- * _Note_: This function should disappear as soon as this behavior is
- * supported on the packaging side.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {number} currentTime
- *
- * @returns {number}
- */
- static handleSetCurrentTime(player, currentTime) {
- const { endTime: blockedSegmentEndTime } = SrgSsr
- .getBlockedSegmentByTime(player, currentTime) || {};
-
- return Number
- .isFinite(blockedSegmentEndTime) ? blockedSegmentEndTime : currentTime;
- }
-
- /**
- * Handles the middleware's setSource function.
- *
- * This function allows to:
- * - resolve a URN into media that can be played by the player
- * - initialize media playback tracking
- * - update the title bar
- * - handle blocking reasons
- * - add remote subtitles
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {any} srcObj
- * @param {function} next
- *
- * @returns {Promise<any>}
- */
- static async handleSetSource(player, srcObj, next) {
- try {
- const srcMediaObj = await SrgSsr.getSrcMediaObj(player, srcObj);
-
- SrgSsr.srgAnalytics(player);
- SrgSsr.updateTitleBar(player, srcMediaObj);
- SrgSsr.updatePoster(player, srcMediaObj);
-
- if (SrgSsr.blockingReason(player, srcMediaObj)) return;
-
- SrgSsr.addTextTracks(player, srcMediaObj);
-
- return next(null, srcMediaObj);
- } catch (error) {
- if (SrgSsr.dataProviderError(player, error)) return;
-
- return next(error);
- }
- }
-
- /**
- * SRG SSR analytics singleton.
- *
- * @param {import('video.js/dist/types/player').default} player
- */
- static srgAnalytics(player) {
- if (player.options().trackers.srgAnalytics === false) return;
-
- if (!player.options().trackers.srgAnalytics) {
- const srgAnalytics = new SRGAnalytics(player, {
- debug: player.debug(),
- playerVersion: Pillarbox.VERSION.pillarbox,
- tagCommanderScriptURL:
- player.options().srgOptions.tagCommanderScriptURL,
- });
-
- player.options({
- trackers: {
- srgAnalytics,
- },
- });
- }
- }
-
- /**
- * PillarboxMonitoring monitoring singleton.
- *
- * @param {import('video.js/dist/types/player').default} player
- *
- * @returns {PillarboxMonitoring} instance of PillarboxMonitoring
- */
- static pillarboxMonitoring(player) {
- if (player.options().trackers.pillarboxMonitoring === false) return;
-
- if (!player.options().trackers.pillarboxMonitoring) {
- const pillarboxMonitoring = new PillarboxMonitoring(player, {
- debug: player.debug(),
- playerVersion: Pillarbox.VERSION.pillarbox,
- playerName: 'Pillarbox',
- });
-
- player.options({
- trackers: {
- pillarboxMonitoring,
- },
- });
- }
-
- return player.options().trackers.pillarboxMonitoring;
- }
-
- /**
- * Update player's poster.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {import('./typedef').ComposedSrcMediaData} srcMediaObj
- * @param {Image} imageService
- */
- static updatePoster(player, srcMediaObj, imageService = Image) {
- player.poster(
- imageService.scale({
- url: srcMediaObj.mediaData.imageUrl,
- })
- );
- }
-
- /**
- * Update player titleBar with title and description.
- *
- * @param {import('video.js/dist/types/player').default} player
- * @param {import('./typedef').ComposedSrcMediaData} srcMediaObj
- */
- static updateTitleBar(player, srcMediaObj) {
- if (!player.titleBar) return;
-
- player.titleBar.update({
- title: srcMediaObj.mediaData.vendor,
- description: srcMediaObj.mediaData.title,
- });
- }
-
- /**
- * Middleware to resolve SRG SSR URNs into playable media.
- *
- * @param {import('video.js/dist/types/player').default} player
- *
- * @returns {Object}
- */
- static middleware(player) {
- SrgSsr.pillarboxMonitoring(player);
- SrgSsr.cuechangeEventProxy(player);
-
- return {
- currentTime: (currentTime) =>
- SrgSsr.handleCurrentTime(player, currentTime),
- setCurrentTime: (currentTime) =>
- SrgSsr.handleSetCurrentTime(player, currentTime),
- setSource: async (srcObj, next) =>
- SrgSsr.handleSetSource(player, srcObj, next),
- };
- }
-}
-
-Pillarbox.use('srgssr/urn', SrgSsr.middleware);
-
-// Add Middleware specific options
-Pillarbox.options.srgOptions = {
- dataProvider: undefined,
- dataProviderHost: undefined,
- dataProviderUrlHandler: undefined,
- tagCommanderScriptURL: undefined,
-};
-
-export default SrgSsr;
-Source: middleware/typedef.ts import { MainResource } from '../dataProvider/model/typedef';
-import { KeySystems } from '../utils/typedef';
-
-
-/**
- * A {@link MainResource} that can contain {@link KeySystems} information.
- */
-export interface MainResourceWithKeySystems extends MainResource, KeySystems {
-
-}
-
-/**
- * Represents the result of composing source media data.
- */
-export type ComposedSrcMediaData = {
- /**
- * The URL of the source media.
- */
- src: string;
- /**
- * The MIME type of the source media.
- */
- type: string;
- /**
- * A mapping of DRM types to their corresponding key systems information.
- */
- keySystems: KeySystems,
- /**
- * Indicates whether trackers are disabled for the source media.
- */
- disableTrackers: boolean;
- /**
- * The merged media data from the source and additional media data.
- */
- mediaData: MainResource;
-};
-
-/**
- * Represents a set of options specific to the SRG SSR.
- *
- * __Note__:
- *
- * - All these options have a default value and can therefore be undefined.
- * - DataProvider options cannot be combined with each other.
- */
-export type SrgOptions = {
- /**
- * A function returning an object representing a mediaComposition.
- *
- * @example
- * // Must match the following signature
- * (data: string) => any
- */
- dataProvider: undefined | Function;
- /**
- * A specific host for a different IL environment.
- */
- dataProviderHost: undefined | string;
- /**
- * A function for handling a custom data source.
- *
- * @example
- * // Must match the following signature
- * (contentId: string) => string
- */
- dataProviderUrlHandler: undefined | Function;
- /**
- * The URL of the TagCommander script.
- */
- tagCommanderScriptURL: undefined | string;
-}
-Namespace: pillarbox Pillarbox is an alias for the video.js namespace with additional options.
Source: pillarbox.js import { version } from '../package.json';
-import videojs from 'video.js';
-import './components/player.js';
-
-/**
- * Pillarbox is an alias for the video.js namespace with additional options.
- *
- * @namespace
- * @see https://docs.videojs.com/module-videojs-videojs
- * @type {videojs}
- */
-const pillarbox = videojs;
-
-pillarbox.VERSION = {
- pillarbox: version,
- videojs: videojs.VERSION,
- [videojs.VhsSourceHandler.name]: videojs.VhsSourceHandler.VERSION,
- eme: videojs.getPlugin('eme').VERSION,
-};
-
-/**
- * Enable smooth seeking for Pillarbox.
- *
- * @see [Video.js enableSmoothSeeking Option]{@link https://videojs.com/guides/options/#enablesmoothseeking}
- * @type {boolean}
- * @default true
- */
-pillarbox.options.enableSmoothSeeking = true;
-/**
- * Enable fill mode for the video player, allowing it to expand to fill the container.
- *
- * @see [Video.js Fill Option]{@link https://videojs.com/guides/layout/#fill-mode}
- * @type {boolean}
- * @default true
- */
-pillarbox.options.fill = true;
-/**
- * Configuration options for HTML5 settings in Pillarbox.
- *
- * @see [VHS useForcedSubtitles Option]{@link https://github.com/videojs/http-streaming/blob/main/README.md#useforcedsubtitles}
- * @type {Object}
- * @property {Object} vhs - Configuration for the Video.js HTTP Streaming.
- * @property {boolean} useForcedSubtitles - Enables the player to display forced subtitles by default.
- * Forced subtitles are pieces of information intended for display when no other text representation
- * is selected. They are used to clarify dialogue, provide alternate languages, display texted graphics,
- * or present location/person IDs that are not otherwise covered in the dubbed/localized audio.
- */
-pillarbox.options.html5 = {
- vhs: { useForcedSubtitles: true }
-};
-/**
- * Configuration for the live tracker.
- *
- * @see [Video.js liveTracker Option]{@link https://videojs.com/guides/options/#livetrackertrackingthreshold}
- * @type {Object}
- * @property {number} trackingThreshold - A threshold that controls when the liveui should be shown.
- * @property {number} liveTolerance - An option that controls how far from the seekable end should be considered live playback.
- */
-pillarbox.options.liveTracker = {
- trackingThreshold: 120,
- liveTolerance: 15,
-};
-/**
- * Allows the player to use the live ui that includes:
- *
- * - A progress bar for seeking within the live window
- * - A button that can be clicked to seek to the live edge with a circle indicating if you are at the live edge or not.
- *
- * @see [Video.js liveui Option]{@link https://videojs.com/guides/options/#liveui}
- * @type {boolean}
- */
-pillarbox.options.liveui = true;
-/**
- * Indicates that the video is to be played "inline", that is within the element's playback area.
- *
- * @see [Video element playsinline attribute]{@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline}
- * @type {boolean}
- */
-pillarbox.options.playsinline = true;
-/**
- * Enable responsive mode, this will cause the player to customize itself based on responsive breakpoints.
- *
- * @see [Video.js Responsive Option]{@link https://videojs.com/guides/options/#responsive}
- * @type {boolean}
- */
-pillarbox.options.responsive = true;
-/**
- * A placeholder for accessing trackers directly from the player.
- *
- * @type {Object}
- */
-pillarbox.options.trackers = {};
-
-export default pillarbox;
-Copied!
';
-
- // template of copy to clipboard icon container
- var copyToClipboard =
- '' +
- lang.toLocaleUpperCase() +
- '
' +
- langNameDiv +
- copyToClipboard +
- '
';
-
- return topBar;
-}
-
-function getPreDiv() {
- var divElement = document.createElement('div');
-
- divElement.classList.add('pre-div');
-
- return divElement;
-}
-
-function processAllPre() {
- var targets = document.querySelectorAll('pre');
- var footer = document.querySelector('#PeOAagUepe');
- var navbar = document.querySelector('#VuAckcnZhf');
-
- var navbarHeight = 0;
- var footerHeight = 0;
-
- if (footer) {
- footerHeight = footer.getBoundingClientRect().height;
- }
-
- if (navbar) {
- navbarHeight = navbar.getBoundingClientRect().height;
- }
-
- // eslint-disable-next-line no-undef
- var preMaxHeight = window.innerHeight - navbarHeight - footerHeight - 250;
-
- targets.forEach(function (pre, idx) {
- var parent = pre.parentNode;
-
- if (parent && parent.getAttribute('data-skip-pre-process') === 'true') {
- return;
- }
-
- var div = getPreDiv();
- var id = 'ScDloZOMdL' + idx;
-
- var lang = pre.getAttribute('data-lang') || 'code';
- var topBar = getPreTopBar(id, lang);
-
- div.innerHTML = topBar;
-
- pre.style.maxHeight = preMaxHeight + 'px';
- pre.id = id;
- pre.classList.add('prettyprint');
- pre.parentNode.insertBefore(div, pre);
- div.appendChild(pre);
- });
-}
-
-function highlightAndBringLineIntoView() {
- // eslint-disable-next-line no-undef
- var lineNumber = window.location.hash.replace('#line', '');
-
- try {
- var selector = '[data-line-number="' + lineNumber + '"';
-
- var element = document.querySelector(selector);
-
- element.scrollIntoView();
- element.parentNode.classList.add('selected');
- } catch (error) {
- console.error(error);
- }
-}
-
-function getFontSize() {
- var currentFontSize = 16;
-
- try {
- currentFontSize = Number.parseInt(
- html.style.fontSize.split('px')[0],
- 10
- );
- } catch (error) {
- console.log(error);
- }
-
- return currentFontSize;
-}
-
-function localUpdateFontSize(fontSize) {
- html.style.fontSize = fontSize + 'px';
-
- var fontSizeText = document.querySelector(
- '#b77a68a492f343baabea06fad81f651e'
- );
-
- if (fontSizeText) {
- fontSizeText.innerHTML = fontSize;
- }
-}
-
-function updateFontSize(fontSize) {
- localUpdateFontSize(fontSize);
- localStorage.setItem(fontSizeLocalStorageKey, fontSize);
-}
-
-(function () {
- var fontSize = getFontSize();
- var fontSizeInLocalStorage = localStorage.getItem(fontSizeLocalStorageKey);
-
- if (fontSizeInLocalStorage) {
- var n = Number.parseInt(fontSizeInLocalStorage, 10);
-
- if (n === fontSize) {
- return;
- }
- updateFontSize(n);
- } else {
- updateFontSize(fontSize);
- }
-})();
-
-// eslint-disable-next-line no-unused-vars
-function incrementFont(event) {
- var n = getFontSize();
-
- if (n < MAX_FONT_SIZE) {
- updateFontSize(n + 1);
- }
-}
-
-// eslint-disable-next-line no-unused-vars
-function decrementFont(event) {
- var n = getFontSize();
-
- if (n > MIN_FONT_SIZE) {
- updateFontSize(n - 1);
- }
-}
-
-function fontSizeTooltip() {
- var fontSize = getFontSize();
-
- return `
-
-
- `;
-}
-
-function initTooltip() {
- // add tooltip to navbar item
- // eslint-disable-next-line no-undef
- tippy('.theme-toggle', {
- content: 'Toggle Theme',
- delay: 500,
- });
-
- // eslint-disable-next-line no-undef
- tippy('.search-button', {
- content: 'Search',
- delay: 500,
- });
-
- // eslint-disable-next-line no-undef
- tippy('.font-size', {
- content: 'Change font size',
- delay: 500,
- });
-
- // eslint-disable-next-line no-undef
- tippy('.codepen-button', {
- content: 'Open code in CodePen',
- placement: 'left',
- });
-
- // eslint-disable-next-line no-undef
- tippy('.copy-code', {
- content: 'Copy this code',
- placement: 'left',
- });
-
- // eslint-disable-next-line no-undef
- tippy('.font-size', {
- content: fontSizeTooltip(),
- trigger: 'click',
- interactive: true,
- allowHTML: true,
- placement: 'left',
- });
-}
-
-function fixTable() {
- const tables = document.querySelectorAll('table');
-
- for (const table of tables) {
- if (table.classList.contains('hljs-ln')) {
- // don't want to wrap code blocks.
- return;
- }
-
- var div = document.createElement('div');
-
- div.classList.add('table-div');
- table.parentNode.insertBefore(div, table);
- div.appendChild(table);
- }
-}
-
-function hideMobileMenu() {
- var mobileMenuContainer = document.querySelector('#mobile-sidebar');
- var target = document.querySelector('#mobile-menu');
- var svgUse = target.querySelector('use');
-
- if (mobileMenuContainer) {
- mobileMenuContainer.classList.remove('show');
- }
- if (target) {
- target.setAttribute('data-isopen', 'false');
- }
- if (svgUse) {
- svgUse.setAttribute('xlink:href', '#menu-icon');
- }
-}
-
-function showMobileMenu() {
- var mobileMenuContainer = document.querySelector('#mobile-sidebar');
- var target = document.querySelector('#mobile-menu');
- var svgUse = target.querySelector('use');
-
- if (mobileMenuContainer) {
- mobileMenuContainer.classList.add('show');
- }
- if (target) {
- target.setAttribute('data-isopen', 'true');
- }
- if (svgUse) {
- svgUse.setAttribute('xlink:href', '#close-icon');
- }
-}
-
-function onMobileMenuClick() {
- var target = document.querySelector('#mobile-menu');
- var isOpen = target.getAttribute('data-isopen') === 'true';
-
- if (isOpen) {
- hideMobileMenu();
- } else {
- showMobileMenu();
- }
-}
-
-function initMobileMenu() {
- var menu = document.querySelector('#mobile-menu');
-
- if (menu) {
- menu.addEventListener('click', onMobileMenuClick);
- }
-}
-
-function addHrefToSidebarTitle() {
- var titles = document.querySelectorAll('.sidebar-title-anchor');
-
- titles.forEach(function (title) {
- // eslint-disable-next-line no-undef
- title.setAttribute('href', baseURL);
- });
-}
-
-function highlightActiveLinkInSidebar() {
- const list = document.location.href.split('/');
- const targetURL = list[list.length - 1];
- let element = document.querySelector(`.sidebar a[href*='${targetURL}']`);
-
- if (!element) {
- try {
- element = document.querySelector(
- `.sidebar a[href*='${targetURL.split('#')[0]}']`
- );
- } catch (e) {
- console.error(e);
-
- return;
- }
- }
-
- if (!element) return;
-
- element.parentElement.classList.add('active');
- element.scrollIntoView();
-}
-
-function onDomContentLoaded() {
- var themeButton = document.querySelectorAll('.theme-toggle');
-
- initMobileMenu();
-
- if (themeButton) {
- themeButton.forEach(function (button) {
- button.addEventListener('click', toggleTheme);
- });
- }
-
- // Highlighting code
-
- // eslint-disable-next-line no-undef
- hljs.addPlugin({
- 'after:highlightElement': function (obj) {
- // Replace 'code' with result.language when
- // we are able to cross-check the correctness of
- // result.
- obj.el.parentNode.setAttribute('data-lang', 'code');
- },
- });
- // eslint-disable-next-line no-undef
- hljs.highlightAll();
- // eslint-disable-next-line no-undef
- hljs.initLineNumbersOnLoad({
- singleLine: true,
- });
-
- // Highlight complete
-
- initAccordion();
- addAnchor();
- processAllPre();
- hideTocOnSourcePage();
- setTimeout(function () {
- bringIdToViewOnMount();
- if (isSourcePage()) {
- highlightAndBringLineIntoView();
- }
- }, 1000);
- initTooltip();
- fixTable();
- addHrefToSidebarTitle();
- highlightActiveLinkInSidebar();
-}
-
-// eslint-disable-next-line no-undef
-window.addEventListener('DOMContentLoaded', onDomContentLoaded);
-
-// eslint-disable-next-line no-undef
-window.addEventListener('hashchange', (event) => {
- const url = new URL(event.newURL);
-
- if (url.hash !== '') {
- bringIdToViewOnMount(url.hash);
- }
-});
-
-// eslint-disable-next-line no-undef
-window.addEventListener('storage', (event) => {
- if (event.newValue === 'undefined') return;
-
- initTooltip();
-
- if (event.key === themeLocalStorageKey) localUpdateTheme(event.newValue);
- if (event.key === fontSizeLocalStorageKey)
- localUpdateFontSize(event.newValue);
-});
diff --git a/pr-preview/pr-252/api/scripts/core.min.js b/pr-preview/pr-252/api/scripts/core.min.js
deleted file mode 100644
index 76e237d8..00000000
--- a/pr-preview/pr-252/api/scripts/core.min.js
+++ /dev/null
@@ -1,23 +0,0 @@
-var accordionLocalStorageKey="accordion-id",themeLocalStorageKey="theme",fontSizeLocalStorageKey="font-size",html=document.querySelector("html"),MAX_FONT_SIZE=30,MIN_FONT_SIZE=10,localStorage=window.localStorage;function getTheme(){var e=localStorage.getItem(themeLocalStorageKey);if(e)return e;switch(e=document.body.getAttribute("data-theme")){case"dark":case"light":return e;case"fallback-dark":return window.matchMedia("(prefers-color-scheme)").matches&&window.matchMedia("(prefers-color-scheme: light)").matches?"light":"dark";case"fallback-light":return window.matchMedia("(prefers-color-scheme)").matches&&window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light";default:return"dark"}}function localUpdateTheme(e){var t=document.body,o=document.querySelectorAll(".theme-svg-use"),n="dark"===e?"#light-theme-icon":"#dark-theme-icon";t.setAttribute("data-theme",e),t.classList.remove("dark","light"),t.classList.add(e),o.forEach(function(e){e.setAttribute("xlink:href",n)})}function updateTheme(e){localUpdateTheme(e),localStorage.setItem(themeLocalStorageKey,e)}function toggleTheme(){updateTheme("dark"===document.body.getAttribute("data-theme")?"light":"dark")}function setAccordionIdToLocalStorage(e){var t=JSON.parse(localStorage.getItem(accordionLocalStorageKey));t[e]=e,localStorage.setItem(accordionLocalStorageKey,JSON.stringify(t))}function removeAccordionIdFromLocalStorage(e){var t=JSON.parse(localStorage.getItem(accordionLocalStorageKey));delete t[e],localStorage.setItem(accordionLocalStorageKey,JSON.stringify(t))}function getAccordionIdsFromLocalStorage(){return JSON.parse(localStorage.getItem(accordionLocalStorageKey))||{}}function toggleAccordion(e){"false"===e.getAttribute("data-isopen")?(e.setAttribute("data-isopen","true"),setAccordionIdToLocalStorage(e.id)):(e.setAttribute("data-isopen","false"),removeAccordionIdFromLocalStorage(e.id))}function initAccordion(){void 0!==localStorage.getItem(accordionLocalStorageKey)&&null!==localStorage.getItem(accordionLocalStorageKey)||localStorage.setItem(accordionLocalStorageKey,"{}");var e=document.querySelectorAll(".sidebar-section-title"),t=getAccordionIdsFromLocalStorage();e.forEach(function(e){e.addEventListener("click",function(){toggleAccordion(e)}),e.id in t&&toggleAccordion(e)})}function isSourcePage(){return Boolean(document.querySelector("#source-page"))}function bringElementIntoView(e,t=!0){var o,n,i,c;e&&(tocbotInstance&&setTimeout(()=>tocbotInstance.updateTocListActiveElement(e),60),o=document.querySelector(".navbar-container"),n=document.querySelector(".main-content"),i=e.getBoundingClientRect().top,c=16,o&&(c+=o.scrollHeight),n&&n.scrollBy(0,i-c),t&&history.pushState(null,null,"#"+e.id))}function bringLinkToView(e){e.preventDefault(),e.stopPropagation();var e=e.currentTarget.getAttribute("href");!e||(e=document.getElementById(e.slice(1)))&&bringElementIntoView(e)}function bringIdToViewOnMount(){var e,t;isSourcePage()||""!==(e=window.location.hash)&&((t=document.getElementById(e.slice(1)))||(e=decodeURI(e),t=document.getElementById(e.slice(1))),t&&bringElementIntoView(t,!1))}function createAnchorElement(e){var t=document.createElement("a");return t.textContent="#",t.href="#"+e,t.classList.add("link-anchor"),t.onclick=bringLinkToView,t}function addAnchor(){var e=document.querySelector(".main-content").querySelector("section");[e.querySelectorAll("h1"),e.querySelectorAll("h2"),e.querySelectorAll("h3"),e.querySelectorAll("h4")].forEach(function(e){e.forEach(function(e){var t=createAnchorElement(e.id);e.classList.add("has-anchor"),e.append(t)})})}function copy(e){const t=document.createElement("textarea");t.value=e,document.body.appendChild(t),t.select(),document.execCommand("copy"),document.body.removeChild(t)}function showTooltip(e){var t=document.getElementById(e);t.classList.add("show-tooltip"),setTimeout(function(){t.classList.remove("show-tooltip")},3e3)}function copyFunction(e){var t=document.getElementById(e);copy((t.querySelector(".linenums")||t.querySelector("code")).innerText.trim().replace(/(^\t)/gm,"")),showTooltip("tooltip-"+e)}function hideTocOnSourcePage(){isSourcePage()&&(document.querySelector(".toc-container").style.display="none")}function getPreTopBar(e,t=""){e='Copied!
')+"'+('
'+t.toLocaleUpperCase()+"
")+e+"
-
-
-
-
-
- ${e}
-
-
-
-
-
-
-
-
-
-
-
- `}function initTooltip(){tippy(".theme-toggle",{content:"Toggle Theme",delay:500}),tippy(".search-button",{content:"Search",delay:500}),tippy(".font-size",{content:"Change font size",delay:500}),tippy(".codepen-button",{content:"Open code in CodePen",placement:"left"}),tippy(".copy-code",{content:"Copy this code",placement:"left"}),tippy(".font-size",{content:fontSizeTooltip(),trigger:"click",interactive:!0,allowHTML:!0,placement:"left"})}function fixTable(){for(const t of document.querySelectorAll("table")){if(t.classList.contains("hljs-ln"))return;var e=document.createElement("div");e.classList.add("table-div"),t.parentNode.insertBefore(e,t),e.appendChild(t)}}function hideMobileMenu(){var e=document.querySelector("#mobile-sidebar"),t=document.querySelector("#mobile-menu"),o=t.querySelector("use");e&&e.classList.remove("show"),t&&t.setAttribute("data-isopen","false"),o&&o.setAttribute("xlink:href","#menu-icon")}function showMobileMenu(){var e=document.querySelector("#mobile-sidebar"),t=document.querySelector("#mobile-menu"),o=t.querySelector("use");e&&e.classList.add("show"),t&&t.setAttribute("data-isopen","true"),o&&o.setAttribute("xlink:href","#close-icon")}function onMobileMenuClick(){("true"===document.querySelector("#mobile-menu").getAttribute("data-isopen")?hideMobileMenu:showMobileMenu)()}function initMobileMenu(){var e=document.querySelector("#mobile-menu");e&&e.addEventListener("click",onMobileMenuClick)}function addHrefToSidebarTitle(){document.querySelectorAll(".sidebar-title-anchor").forEach(function(e){e.setAttribute("href",baseURL)})}function highlightActiveLinkInSidebar(){var e=document.location.href.split("/");const t=e[e.length-1];let o=document.querySelector(`.sidebar a[href*='${t}']`);if(!o)try{o=document.querySelector(`.sidebar a[href*='${t.split("#")[0]}']`)}catch(e){return void console.error(e)}o&&(o.parentElement.classList.add("active"),o.scrollIntoView())}function onDomContentLoaded(){var e=document.querySelectorAll(".theme-toggle");initMobileMenu(),e&&e.forEach(function(e){e.addEventListener("click",toggleTheme)}),hljs.addPlugin({"after:highlightElement":function(e){e.el.parentNode.setAttribute("data-lang","code")}}),hljs.highlightAll(),hljs.initLineNumbersOnLoad({singleLine:!0}),initAccordion(),addAnchor(),processAllPre(),hideTocOnSourcePage(),setTimeout(function(){bringIdToViewOnMount(),isSourcePage()&&highlightAndBringLineIntoView()},1e3),initTooltip(),fixTable(),addHrefToSidebarTitle(),highlightActiveLinkInSidebar()}updateTheme(getTheme()),function(){var e=getFontSize(),t=localStorage.getItem(fontSizeLocalStorageKey);t?(t=Number.parseInt(t,10))!==e&&updateFontSize(t):updateFontSize(e)}(),window.addEventListener("DOMContentLoaded",onDomContentLoaded),window.addEventListener("hashchange",e=>{e=new URL(e.newURL);""!==e.hash&&bringIdToViewOnMount(e.hash)}),window.addEventListener("storage",e=>{"undefined"!==e.newValue&&(initTooltip(),e.key===themeLocalStorageKey&&localUpdateTheme(e.newValue),e.key===fontSizeLocalStorageKey&&localUpdateFontSize(e.newValue))});
\ No newline at end of file
diff --git a/pr-preview/pr-252/api/scripts/resize.js b/pr-preview/pr-252/api/scripts/resize.js
deleted file mode 100644
index d8e3a9cf..00000000
--- a/pr-preview/pr-252/api/scripts/resize.js
+++ /dev/null
@@ -1,90 +0,0 @@
-/* global document */
-// This file is @deprecated
-
-var NAVBAR_OPTIONS = {};
-
-(function() {
- var NAVBAR_RESIZE_LOCAL_STORAGE_KEY = 'NAVBAR_RESIZE_LOCAL_STORAGE_KEY';
-
- var navbar = document.querySelector('#navbar');
- var footer = document.querySelector('#footer');
- var mainSection = document.querySelector('#main');
- var localStorageResizeObject = JSON.parse(
- // eslint-disable-next-line no-undef
- localStorage.getItem(NAVBAR_RESIZE_LOCAL_STORAGE_KEY)
- );
-
- /**
- * Check whether we have any resize value in local storage or not.
- * If we have resize value then resize the navbar.
- **/
- if (localStorageResizeObject) {
- navbar.style.width = localStorageResizeObject.width;
- mainSection.style.marginLeft = localStorageResizeObject.width;
- footer.style.marginLeft = localStorageResizeObject.width;
- }
-
- var navbarSlider = document.querySelector('#navbar-resize');
-
- function resizeNavbar(event) {
- var pageX = event.pageX,
- pageXPlusPx = event.pageX + 'px',
- min = Number.parseInt(NAVBAR_OPTIONS.min, 10) || 300,
- max = Number.parseInt(NAVBAR_OPTIONS.max, 10) || 600;
-
- /**
- * Just to add some checks. If min is smaller than 10 then
- * user may accidentally end up reducing the size of navbar
- * less than 10. In that case user will not able to resize navbar
- * because navbar slider will be hidden.
- */
- if (min < 10) {
- min = 10;
- }
-
- /**
- * Only resize if pageX in range between min and max
- * allowed value.
- */
- if (min < pageX && pageX < max) {
- navbar.style.width = pageXPlusPx;
- mainSection.style.marginLeft = pageXPlusPx;
- footer.style.marginLeft = pageXPlusPx;
- }
- }
-
- function setupEventListeners() {
- // eslint-disable-next-line no-undef
- window.addEventListener('mousemove', resizeNavbar);
- // eslint-disable-next-line no-undef
- window.addEventListener('touchmove', resizeNavbar);
- }
-
- function afterRemovingEventListeners() {
- // eslint-disable-next-line no-undef
- localStorage.setItem(
- NAVBAR_RESIZE_LOCAL_STORAGE_KEY,
- JSON.stringify({
- width: navbar.style.width
- })
- );
- }
-
- function removeEventListeners() {
- // eslint-disable-next-line no-undef
- window.removeEventListener('mousemove', resizeNavbar);
- // eslint-disable-next-line no-undef
- window.removeEventListener('touchend', resizeNavbar);
- afterRemovingEventListeners();
- }
-
- navbarSlider.addEventListener('mousedown', setupEventListeners);
- navbarSlider.addEventListener('touchstart', setupEventListeners);
- // eslint-disable-next-line no-undef
- window.addEventListener('mouseup', removeEventListeners);
-})();
-
-// eslint-disable-next-line no-unused-vars
-function setupResizeOptions(options) {
- NAVBAR_OPTIONS = options;
-}
diff --git a/pr-preview/pr-252/api/scripts/search.js b/pr-preview/pr-252/api/scripts/search.js
deleted file mode 100644
index 415e1cf8..00000000
--- a/pr-preview/pr-252/api/scripts/search.js
+++ /dev/null
@@ -1,265 +0,0 @@
-/* global document */
-
-const searchId = 'LiBfqbJVcV';
-const searchHash = '#' + searchId;
-const searchContainer = document.querySelector('#PkfLWpAbet');
-const searchWrapper = document.querySelector('#iCxFxjkHbP');
-const searchCloseButton = document.querySelector('#VjLlGakifb');
-const searchInput = document.querySelector('#vpcKVYIppa');
-const resultBox = document.querySelector('#fWwVHRuDuN');
-
-function showResultText(text) {
- resultBox.innerHTML = `${text} `;
-}
-
-function hideSearch() {
- // eslint-disable-next-line no-undef
- if (window.location.hash === searchHash) {
- // eslint-disable-next-line no-undef
- history.go(-1);
- }
-
- // eslint-disable-next-line no-undef
- window.onhashchange = null;
-
- if (searchContainer) {
- searchContainer.style.display = 'none';
- }
-}
-
-function listenCloseKey(event) {
- if (event.key === 'Escape') {
- hideSearch();
- // eslint-disable-next-line no-undef
- window.removeEventListener('keyup', listenCloseKey);
- }
-}
-
-function showSearch() {
- try {
- // Closing mobile menu before opening
- // search box.
- // It is defined in core.js
- // eslint-disable-next-line no-undef
- hideMobileMenu();
- } catch (error) {
- console.error(error);
- }
-
- // eslint-disable-next-line no-undef
- window.onhashchange = hideSearch;
-
- // eslint-disable-next-line no-undef
- if (window.location.hash !== searchHash) {
- // eslint-disable-next-line no-undef
- history.pushState(null, null, searchHash);
- }
-
- if (searchContainer) {
- searchContainer.style.display = 'flex';
- // eslint-disable-next-line no-undef
- window.addEventListener('keyup', listenCloseKey);
- }
-
- if (searchInput) {
- searchInput.focus();
- }
-}
-
-async function fetchAllData() {
- // eslint-disable-next-line no-undef
- const { hostname, protocol, port } = location;
-
- // eslint-disable-next-line no-undef
- const base = protocol + '//' + hostname + (port !== '' ? ':' + port : '') + baseURL;
- // eslint-disable-next-line no-undef
- const url = new URL('data/search.json', base);
- const result = await fetch(url);
- const { list } = await result.json();
-
- return list;
-}
-
-// eslint-disable-next-line no-unused-vars
-function onClickSearchItem(event) {
- const target = event.currentTarget;
-
- if (target) {
- const href = target.getAttribute('href') || '';
- let elementId = href.split('#')[1] || '';
- let element = document.getElementById(elementId);
-
- if (!element) {
- elementId = decodeURI(elementId);
- element = document.getElementById(elementId);
- }
-
- if (element) {
- setTimeout(function() {
- // eslint-disable-next-line no-undef
- bringElementIntoView(element); // defined in core.js
- }, 100);
- }
- }
-}
-
-function buildSearchResult(result) {
- let output = '';
- const removeHTMLTagsRegExp = /(<([^>]+)>)/ig;
-
- for (const res of result) {
- const { title = '', description = '' } = res.item;
-
- const _link = res.item.link.replace('.*/, '');
- const _title = title.replace(removeHTMLTagsRegExp, "");
- const _description = description.replace(removeHTMLTagsRegExp, "");
-
- output += `
-
- ${_title}
- ${_description || 'No description available.'}
-
- `;
- }
-
- return output;
-}
-
-function getSearchResult(list, keys, searchKey) {
- const defaultOptions = {
- shouldSort: true,
- threshold: 0.4,
- location: 0,
- distance: 100,
- maxPatternLength: 32,
- minMatchCharLength: 1,
- keys: keys
- };
-
- const options = { ...defaultOptions };
-
- // eslint-disable-next-line no-undef
- const searchIndex = Fuse.createIndex(options.keys, list);
-
- // eslint-disable-next-line no-undef
- const fuse = new Fuse(list, options, searchIndex);
-
- const result = fuse.search(searchKey);
-
- if (result.length > 20) {
- return result.slice(0, 20);
- }
-
- return result;
-}
-
-function debounce(func, wait, immediate) {
- let timeout;
-
- return function() {
- const args = arguments;
-
- clearTimeout(timeout);
- timeout = setTimeout(() => {
- timeout = null;
- if (!immediate) {
- // eslint-disable-next-line consistent-this, no-invalid-this
- func.apply(this, args);
- }
- }, wait);
-
- if (immediate && !timeout) {
- // eslint-disable-next-line consistent-this, no-invalid-this
- func.apply(this, args);
- }
- };
-}
-
-let searchData;
-
-async function search(event) {
- const value = event.target.value;
- const keys = ['title', 'description'];
-
- if (!resultBox) {
- console.error('Search result container not found');
-
- return;
- }
-
- if (!value) {
- showResultText('Type anything to view search result');
-
- return;
- }
-
- if (!searchData) {
- showResultText('Loading...');
-
- try {
- // eslint-disable-next-line require-atomic-updates
- searchData = await fetchAllData();
- } catch (e) {
- console.log(e);
- showResultText('Failed to load result.');
-
- return;
- }
- }
-
- const result = getSearchResult(searchData, keys, value);
-
- if (!result.length) {
- showResultText('No result found! Try some different combination.');
-
- return;
- }
-
- // eslint-disable-next-line require-atomic-updates
- resultBox.innerHTML = buildSearchResult(result);
-}
-
-function onDomContentLoaded() {
- const searchButton = document.querySelectorAll('.search-button');
- const debouncedSearch = debounce(search, 300);
-
- if (searchCloseButton) {
- searchCloseButton.addEventListener('click', hideSearch);
- }
-
- if (searchButton) {
- searchButton.forEach(function(item) {
- item.addEventListener('click', showSearch);
- });
- }
-
- if (searchContainer) {
- searchContainer.addEventListener('click', hideSearch);
- }
-
- if (searchWrapper) {
- searchWrapper.addEventListener('click', function(event) {
- event.stopPropagation();
- });
- }
-
- if (searchInput) {
- searchInput.addEventListener('keyup', debouncedSearch);
- }
-
- // eslint-disable-next-line no-undef
- if (window.location.hash === searchHash) {
- showSearch();
- }
-}
-
-// eslint-disable-next-line no-undef
-window.addEventListener('DOMContentLoaded', onDomContentLoaded);
-
-// eslint-disable-next-line no-undef
-window.addEventListener('hashchange', function() {
- // eslint-disable-next-line no-undef
- if (window.location.hash === searchHash) {
- showSearch();
- }
-});
diff --git a/pr-preview/pr-252/api/scripts/search.min.js b/pr-preview/pr-252/api/scripts/search.min.js
deleted file mode 100644
index 5358bced..00000000
--- a/pr-preview/pr-252/api/scripts/search.min.js
+++ /dev/null
@@ -1,6 +0,0 @@
-const searchId="LiBfqbJVcV",searchHash="#"+searchId,searchContainer=document.querySelector("#PkfLWpAbet"),searchWrapper=document.querySelector("#iCxFxjkHbP"),searchCloseButton=document.querySelector("#VjLlGakifb"),searchInput=document.querySelector("#vpcKVYIppa"),resultBox=document.querySelector("#fWwVHRuDuN");function showResultText(e){resultBox.innerHTML=`${e} `}function hideSearch(){window.location.hash===searchHash&&history.go(-1),window.onhashchange=null,searchContainer&&(searchContainer.style.display="none")}function listenCloseKey(e){"Escape"===e.key&&(hideSearch(),window.removeEventListener("keyup",listenCloseKey))}function showSearch(){try{hideMobileMenu()}catch(e){console.error(e)}window.onhashchange=hideSearch,window.location.hash!==searchHash&&history.pushState(null,null,searchHash),searchContainer&&(searchContainer.style.display="flex",window.addEventListener("keyup",listenCloseKey)),searchInput&&searchInput.focus()}async function fetchAllData(){var{hostname:e,protocol:t,port:n}=location,t=t+"//"+e+(""!==n?":"+n:"")+baseURL,e=new URL("data/search.json",t);const a=await fetch(e);n=(await a.json()).list;return n}function onClickSearchItem(t){const n=t.currentTarget;if(n){const a=n.getAttribute("href")||"";t=a.split("#")[1]||"";let e=document.getElementById(t);e||(t=decodeURI(t),e=document.getElementById(t)),e&&setTimeout(function(){bringElementIntoView(e)},100)}}function buildSearchResult(e){let t="";var n=/(<([^>]+)>)/gi;for(const s of e){const{title:c="",description:i=""}=s.item;var a=s.item.link.replace('.*/,""),o=c.replace(n,""),r=i.replace(n,"");t+=`
-
- ${o}
- ${r||"No description available."}
-
- `}return t}function getSearchResult(e,t,n){var t={...{shouldSort:!0,threshold:.4,location:0,distance:100,maxPatternLength:32,minMatchCharLength:1,keys:t}},a=Fuse.createIndex(t.keys,e);const o=new Fuse(e,t,a),r=o.search(n);return 20{o=null,a||t.apply(this,e)},n),a&&!o&&t.apply(this,e)}}let searchData;async function search(e){e=e.target.value;if(resultBox)if(e){if(!searchData){showResultText("Loading...");try{searchData=await fetchAllData()}catch(e){return console.log(e),void showResultText("Failed to load result.")}}e=getSearchResult(searchData,["title","description"],e);e.length?resultBox.innerHTML=buildSearchResult(e):showResultText("No result found! Try some different combination.")}else showResultText("Type anything to view search result");else console.error("Search result container not found")}function onDomContentLoaded(){const e=document.querySelectorAll(".search-button");var t=debounce(search,300);searchCloseButton&&searchCloseButton.addEventListener("click",hideSearch),e&&e.forEach(function(e){e.addEventListener("click",showSearch)}),searchContainer&&searchContainer.addEventListener("click",hideSearch),searchWrapper&&searchWrapper.addEventListener("click",function(e){e.stopPropagation()}),searchInput&&searchInput.addEventListener("keyup",t),window.location.hash===searchHash&&showSearch()}window.addEventListener("DOMContentLoaded",onDomContentLoaded),window.addEventListener("hashchange",function(){window.location.hash===searchHash&&showSearch()});
\ No newline at end of file
diff --git a/pr-preview/pr-252/api/scripts/third-party/Apache-License-2.0.txt b/pr-preview/pr-252/api/scripts/third-party/Apache-License-2.0.txt
deleted file mode 100644
index 75b52484..00000000
--- a/pr-preview/pr-252/api/scripts/third-party/Apache-License-2.0.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/pr-preview/pr-252/api/scripts/third-party/fuse.js b/pr-preview/pr-252/api/scripts/third-party/fuse.js
deleted file mode 100644
index a55c5daa..00000000
--- a/pr-preview/pr-252/api/scripts/third-party/fuse.js
+++ /dev/null
@@ -1,9 +0,0 @@
-/**
- * Fuse.js v6.4.6 - Lightweight fuzzy-search (http://fusejs.io)
- *
- * Copyright (c) 2021 Kiro Risk (http://kiro.me)
- * All Rights Reserved. Apache Software License 2.0
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- */
-var e,t;e=this,t=function(){"use strict";function e(t){return(e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(t)}function t(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function n(e,t){for(var n=0;ne.length)&&(t=e.length);for(var n=0,r=new Array(t);n0&&void 0!==arguments[0]?arguments[0]:3,t=new Map,n=Math.pow(10,e);return{get:function(e){var r=e.match(I).length;if(t.has(r))return t.get(r);var i=1/Math.sqrt(r),o=parseFloat(Math.round(i*n)/n);return t.set(r,o),o},clear:function(){t.clear()}}}var E=function(){function e(){var n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},r=n.getFn,i=void 0===r?A.getFn:r;t(this,e),this.norm=C(3),this.getFn=i,this.isCreated=!1,this.setIndexRecords()}return r(e,[{key:"setSources",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.docs=e}},{key:"setIndexRecords",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.records=e}},{key:"setKeys",value:function(){var e=this,t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.keys=t,this._keysMap={},t.forEach((function(t,n){e._keysMap[t.id]=n}))}},{key:"create",value:function(){var e=this;!this.isCreated&&this.docs.length&&(this.isCreated=!0,g(this.docs[0])?this.docs.forEach((function(t,n){e._addString(t,n)})):this.docs.forEach((function(t,n){e._addObject(t,n)})),this.norm.clear())}},{key:"add",value:function(e){var t=this.size();g(e)?this._addString(e,t):this._addObject(e,t)}},{key:"removeAt",value:function(e){this.records.splice(e,1);for(var t=e,n=this.size();t2&&void 0!==arguments[2]?arguments[2]:{},r=n.getFn,i=void 0===r?A.getFn:r,o=new E({getFn:i});return o.setKeys(e.map(_)),o.setSources(t),o.create(),o}function R(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.errors,r=void 0===n?0:n,i=t.currentLocation,o=void 0===i?0:i,c=t.expectedLocation,a=void 0===c?0:c,s=t.distance,u=void 0===s?A.distance:s,h=t.ignoreLocation,f=void 0===h?A.ignoreLocation:h,l=r/e.length;if(f)return l;var d=Math.abs(a-o);return u?l+d/u:d?1:l}function F(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:A.minMatchCharLength,n=[],r=-1,i=-1,o=0,c=e.length;o=t&&n.push([r,i]),r=-1)}return e[o-1]&&o-r>=t&&n.push([r,o-1]),n}function P(e){for(var t={},n=0,r=e.length;n1&&void 0!==arguments[1]?arguments[1]:{},o=i.location,c=void 0===o?A.location:o,a=i.threshold,s=void 0===a?A.threshold:a,u=i.distance,h=void 0===u?A.distance:u,f=i.includeMatches,l=void 0===f?A.includeMatches:f,d=i.findAllMatches,v=void 0===d?A.findAllMatches:d,g=i.minMatchCharLength,y=void 0===g?A.minMatchCharLength:g,p=i.isCaseSensitive,m=void 0===p?A.isCaseSensitive:p,k=i.ignoreLocation,M=void 0===k?A.ignoreLocation:k;if(t(this,e),this.options={location:c,threshold:s,distance:h,includeMatches:l,findAllMatches:v,minMatchCharLength:y,isCaseSensitive:m,ignoreLocation:M},this.pattern=m?n:n.toLowerCase(),this.chunks=[],this.pattern.length){var b=function(e,t){r.chunks.push({pattern:e,alphabet:P(e),startIndex:t})},x=this.pattern.length;if(x>32){for(var L=0,S=x%32,w=x-S;L3&&void 0!==arguments[3]?arguments[3]:{},i=r.location,o=void 0===i?A.location:i,c=r.distance,a=void 0===c?A.distance:c,s=r.threshold,u=void 0===s?A.threshold:s,h=r.findAllMatches,f=void 0===h?A.findAllMatches:h,l=r.minMatchCharLength,d=void 0===l?A.minMatchCharLength:l,v=r.includeMatches,g=void 0===v?A.includeMatches:v,y=r.ignoreLocation,p=void 0===y?A.ignoreLocation:y;if(t.length>32)throw new Error(L(32));for(var m,k=t.length,M=e.length,b=Math.max(0,Math.min(o,M)),x=u,S=b,w=d>1||g,_=w?Array(M):[];(m=e.indexOf(t,S))>-1;){var O=R(t,{currentLocation:m,expectedLocation:b,distance:a,ignoreLocation:p});if(x=Math.min(O,x),S=m+k,w)for(var j=0;j=K;J-=1){var T=J-1,U=n[e.charAt(T)];if(w&&(_[T]=+!!U),W[J]=(W[J+1]<<1|1)&U,P&&(W[J]|=(I[J+1]|I[J])<<1|1|I[J+1]),W[J]&$&&(C=R(t,{errors:P,currentLocation:T,expectedLocation:b,distance:a,ignoreLocation:p}))<=x){if(x=C,(S=T)<=b)break;K=Math.max(1,2*b-S)}}var V=R(t,{errors:P+1,currentLocation:b,expectedLocation:b,distance:a,ignoreLocation:p});if(V>x)break;I=W}var B={isMatch:S>=0,score:Math.max(.001,C)};if(w){var G=F(_,d);G.length?g&&(B.indices=G):B.isMatch=!1}return B}(e,n,i,{location:c+o,distance:a,threshold:s,findAllMatches:u,minMatchCharLength:h,includeMatches:r,ignoreLocation:f}),p=y.isMatch,m=y.score,k=y.indices;p&&(g=!0),v+=m,p&&k&&(d=[].concat(l(d),l(k)))}));var y={isMatch:g,score:g?v/this.chunks.length:1};return g&&r&&(y.indices=d),y}}]),e}(),D=function(){function e(n){t(this,e),this.pattern=n}return r(e,[{key:"search",value:function(){}}],[{key:"isMultiMatch",value:function(e){return z(e,this.multiRegex)}},{key:"isSingleMatch",value:function(e){return z(e,this.singleRegex)}}]),e}();function z(e,t){var n=e.match(t);return n?n[1]:null}var K=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e===this.pattern;return{isMatch:t,score:t?0:1,indices:[0,this.pattern.length-1]}}}],[{key:"type",get:function(){return"exact"}},{key:"multiRegex",get:function(){return/^="(.*)"$/}},{key:"singleRegex",get:function(){return/^=(.*)$/}}]),i}(D),q=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=-1===e.indexOf(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-exact"}},{key:"multiRegex",get:function(){return/^!"(.*)"$/}},{key:"singleRegex",get:function(){return/^!(.*)$/}}]),i}(D),W=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e.startsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,this.pattern.length-1]}}}],[{key:"type",get:function(){return"prefix-exact"}},{key:"multiRegex",get:function(){return/^\^"(.*)"$/}},{key:"singleRegex",get:function(){return/^\^(.*)$/}}]),i}(D),J=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=!e.startsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-prefix-exact"}},{key:"multiRegex",get:function(){return/^!\^"(.*)"$/}},{key:"singleRegex",get:function(){return/^!\^(.*)$/}}]),i}(D),T=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e.endsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[e.length-this.pattern.length,e.length-1]}}}],[{key:"type",get:function(){return"suffix-exact"}},{key:"multiRegex",get:function(){return/^"(.*)"\$$/}},{key:"singleRegex",get:function(){return/^(.*)\$$/}}]),i}(D),U=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=!e.endsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-suffix-exact"}},{key:"multiRegex",get:function(){return/^!"(.*)"\$$/}},{key:"singleRegex",get:function(){return/^!(.*)\$$/}}]),i}(D),V=function(e){a(i,e);var n=f(i);function i(e){var r,o=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},c=o.location,a=void 0===c?A.location:c,s=o.threshold,u=void 0===s?A.threshold:s,h=o.distance,f=void 0===h?A.distance:h,l=o.includeMatches,d=void 0===l?A.includeMatches:l,v=o.findAllMatches,g=void 0===v?A.findAllMatches:v,y=o.minMatchCharLength,p=void 0===y?A.minMatchCharLength:y,m=o.isCaseSensitive,k=void 0===m?A.isCaseSensitive:m,M=o.ignoreLocation,b=void 0===M?A.ignoreLocation:M;return t(this,i),(r=n.call(this,e))._bitapSearch=new N(e,{location:a,threshold:u,distance:f,includeMatches:d,findAllMatches:g,minMatchCharLength:p,isCaseSensitive:k,ignoreLocation:b}),r}return r(i,[{key:"search",value:function(e){return this._bitapSearch.searchIn(e)}}],[{key:"type",get:function(){return"fuzzy"}},{key:"multiRegex",get:function(){return/^"(.*)"$/}},{key:"singleRegex",get:function(){return/^(.*)$/}}]),i}(D),B=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){for(var t,n=0,r=[],i=this.pattern.length;(t=e.indexOf(this.pattern,n))>-1;)n=t+i,r.push([t,n-1]);var o=!!r.length;return{isMatch:o,score:o?0:1,indices:r}}}],[{key:"type",get:function(){return"include"}},{key:"multiRegex",get:function(){return/^'"(.*)"$/}},{key:"singleRegex",get:function(){return/^'(.*)$/}}]),i}(D),G=[K,B,W,J,U,T,q,V],H=G.length,Q=/ +(?=([^\"]*\"[^\"]*\")*[^\"]*$)/;function X(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return e.split("|").map((function(e){for(var n=e.trim().split(Q).filter((function(e){return e&&!!e.trim()})),r=[],i=0,o=n.length;i1&&void 0!==arguments[1]?arguments[1]:{},i=r.isCaseSensitive,o=void 0===i?A.isCaseSensitive:i,c=r.includeMatches,a=void 0===c?A.includeMatches:c,s=r.minMatchCharLength,u=void 0===s?A.minMatchCharLength:s,h=r.ignoreLocation,f=void 0===h?A.ignoreLocation:h,l=r.findAllMatches,d=void 0===l?A.findAllMatches:l,v=r.location,g=void 0===v?A.location:v,y=r.threshold,p=void 0===y?A.threshold:y,m=r.distance,k=void 0===m?A.distance:m;t(this,e),this.query=null,this.options={isCaseSensitive:o,includeMatches:a,minMatchCharLength:u,findAllMatches:d,ignoreLocation:f,location:g,threshold:p,distance:k},this.pattern=o?n:n.toLowerCase(),this.query=X(this.pattern,this.options)}return r(e,[{key:"searchIn",value:function(e){var t=this.query;if(!t)return{isMatch:!1,score:1};var n=this.options,r=n.includeMatches;e=n.isCaseSensitive?e:e.toLowerCase();for(var i=0,o=[],c=0,a=0,s=t.length;a-1&&(n.refIndex=e.idx),t.matches.push(n)}}))}function le(e,t){t.score=e.score}function de(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=n.includeMatches,i=void 0===r?A.includeMatches:r,o=n.includeScore,c=void 0===o?A.includeScore:o,a=[];return i&&a.push(fe),c&&a.push(le),e.map((function(e){var n=e.idx,r={item:t[n],refIndex:n};return a.length&&a.forEach((function(t){t(e,r)})),r}))}var ve=function(){function e(n){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},i=arguments.length>2?arguments[2]:void 0;t(this,e),this.options=c({},A,{},r),this.options.useExtendedSearch,this._keyStore=new w(this.options.keys),this.setCollection(n,i)}return r(e,[{key:"setCollection",value:function(e,t){if(this._docs=e,t&&!(t instanceof E))throw new Error("Incorrect 'index' type");this._myIndex=t||$(this.options.keys,this._docs,{getFn:this.options.getFn})}},{key:"add",value:function(e){k(e)&&(this._docs.push(e),this._myIndex.add(e))}},{key:"remove",value:function(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:function(){return!1},t=[],n=0,r=this._docs.length;n1&&void 0!==arguments[1]?arguments[1]:{},n=t.limit,r=void 0===n?-1:n,i=this.options,o=i.includeMatches,c=i.includeScore,a=i.shouldSort,s=i.sortFn,u=i.ignoreFieldNorm,h=g(e)?g(this._docs[0])?this._searchStringList(e):this._searchObjectList(e):this._searchLogical(e);return he(h,{ignoreFieldNorm:u}),a&&h.sort(s),y(r)&&r>-1&&(h=h.slice(0,r)),de(h,this._docs,{includeMatches:o,includeScore:c})}},{key:"_searchStringList",value:function(e){var t=te(e,this.options),n=this._myIndex.records,r=[];return n.forEach((function(e){var n=e.v,i=e.i,o=e.n;if(k(n)){var c=t.searchIn(n),a=c.isMatch,s=c.score,u=c.indices;a&&r.push({item:n,idx:i,matches:[{score:s,value:n,norm:o,indices:u}]})}})),r}},{key:"_searchLogical",value:function(e){var t=this,n=function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=n.auto,i=void 0===r||r,o=function e(n){var r=Object.keys(n),o=ae(n);if(!o&&r.length>1&&!ce(n))return e(ue(n));if(se(n)){var c=o?n[ie]:r[0],a=o?n[oe]:n[c];if(!g(a))throw new Error(x(c));var s={keyId:j(c),pattern:a};return i&&(s.searcher=te(a,t)),s}var u={children:[],operator:r[0]};return r.forEach((function(t){var r=n[t];v(r)&&r.forEach((function(t){u.children.push(e(t))}))})),u};return ce(e)||(e=ue(e)),o(e)}(e,this.options),r=this._myIndex.records,i={},o=[];return r.forEach((function(e){var r=e.$,c=e.i;if(k(r)){var a=function e(n,r,i){if(!n.children){var o=n.keyId,c=n.searcher,a=t._findMatches({key:t._keyStore.get(o),value:t._myIndex.getValueForItemAtKeyId(r,o),searcher:c});return a&&a.length?[{idx:i,item:r,matches:a}]:[]}switch(n.operator){case ne:for(var s=[],u=0,h=n.children.length;u1&&void 0!==arguments[1]?arguments[1]:{},n=t.getFn,r=void 0===n?A.getFn:n,i=e.keys,o=e.records,c=new E({getFn:r});return c.setKeys(i),c.setIndexRecords(o),c},ve.config=A,function(){ee.push.apply(ee,arguments)}(Z),ve},"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e=e||self).Fuse=t();
\ No newline at end of file
diff --git a/pr-preview/pr-252/api/scripts/third-party/hljs-line-num-original.js b/pr-preview/pr-252/api/scripts/third-party/hljs-line-num-original.js
deleted file mode 100644
index 9b8e18f7..00000000
--- a/pr-preview/pr-252/api/scripts/third-party/hljs-line-num-original.js
+++ /dev/null
@@ -1,369 +0,0 @@
-// jshint multistr:true
-
-(function (w, d) {
- 'use strict';
-
- var TABLE_NAME = 'hljs-ln',
- LINE_NAME = 'hljs-ln-line',
- CODE_BLOCK_NAME = 'hljs-ln-code',
- NUMBERS_BLOCK_NAME = 'hljs-ln-numbers',
- NUMBER_LINE_NAME = 'hljs-ln-n',
- DATA_ATTR_NAME = 'data-line-number',
- BREAK_LINE_REGEXP = /\r\n|\r|\n/g;
-
- if (w.hljs) {
- w.hljs.initLineNumbersOnLoad = initLineNumbersOnLoad;
- w.hljs.lineNumbersBlock = lineNumbersBlock;
- w.hljs.lineNumbersValue = lineNumbersValue;
-
- addStyles();
- } else {
- w.console.error('highlight.js not detected!');
- }
-
- function isHljsLnCodeDescendant(domElt) {
- var curElt = domElt;
- while (curElt) {
- if (curElt.className && curElt.className.indexOf('hljs-ln-code') !== -1) {
- return true;
- }
- curElt = curElt.parentNode;
- }
- return false;
- }
-
- function getHljsLnTable(hljsLnDomElt) {
- var curElt = hljsLnDomElt;
- while (curElt.nodeName !== 'TABLE') {
- curElt = curElt.parentNode;
- }
- return curElt;
- }
-
- // Function to workaround a copy issue with Microsoft Edge.
- // Due to hljs-ln wrapping the lines of code inside a element,
- // itself wrapped inside a element, window.getSelection().toString()
- // does not contain any line breaks. So we need to get them back using the
- // rendered code in the DOM as reference.
- function edgeGetSelectedCodeLines(selection) {
- // current selected text without line breaks
- var selectionText = selection.toString();
-
- // get the element wrapping the first line of selected code
- var tdAnchor = selection.anchorNode;
- while (tdAnchor.nodeName !== 'TD') {
- tdAnchor = tdAnchor.parentNode;
- }
-
- // get the element wrapping the last line of selected code
- var tdFocus = selection.focusNode;
- while (tdFocus.nodeName !== 'TD') {
- tdFocus = tdFocus.parentNode;
- }
-
- // extract line numbers
- var firstLineNumber = parseInt(tdAnchor.dataset.lineNumber);
- var lastLineNumber = parseInt(tdFocus.dataset.lineNumber);
-
- // multi-lines copied case
- if (firstLineNumber != lastLineNumber) {
-
- var firstLineText = tdAnchor.textContent;
- var lastLineText = tdFocus.textContent;
-
- // if the selection was made backward, swap values
- if (firstLineNumber > lastLineNumber) {
- var tmp = firstLineNumber;
- firstLineNumber = lastLineNumber;
- lastLineNumber = tmp;
- tmp = firstLineText;
- firstLineText = lastLineText;
- lastLineText = tmp;
- }
-
- // discard not copied characters in first line
- while (selectionText.indexOf(firstLineText) !== 0) {
- firstLineText = firstLineText.slice(1);
- }
-
- // discard not copied characters in last line
- while (selectionText.lastIndexOf(lastLineText) === -1) {
- lastLineText = lastLineText.slice(0, -1);
- }
-
- // reconstruct and return the real copied text
- var selectedText = firstLineText;
- var hljsLnTable = getHljsLnTable(tdAnchor);
- for (var i = firstLineNumber + 1 ; i < lastLineNumber ; ++i) {
- var codeLineSel = format('.{0}[{1}="{2}"]', [CODE_BLOCK_NAME, DATA_ATTR_NAME, i]);
- var codeLineElt = hljsLnTable.querySelector(codeLineSel);
- selectedText += '\n' + codeLineElt.textContent;
- }
- selectedText += '\n' + lastLineText;
- return selectedText;
- // single copied line case
- } else {
- return selectionText;
- }
- }
-
- // ensure consistent code copy/paste behavior across all browsers
- // (see https://github.com/wcoder/highlightjs-line-numbers.js/issues/51)
- document.addEventListener('copy', function(e) {
- // get current selection
- var selection = window.getSelection();
- // override behavior when one wants to copy line of codes
- if (isHljsLnCodeDescendant(selection.anchorNode)) {
- var selectionText;
- // workaround an issue with Microsoft Edge as copied line breaks
- // are removed otherwise from the selection string
- if (window.navigator.userAgent.indexOf('Edge') !== -1) {
- selectionText = edgeGetSelectedCodeLines(selection);
- } else {
- // other browsers can directly use the selection string
- selectionText = selection.toString();
- }
- e.clipboardData.setData(
- 'text/plain',
- selectionText
- .replace(/(^\t)/gm, '')
- );
- e.preventDefault();
- }
- });
-
- function addStyles () {
- var css = d.createElement('style');
- css.type = 'text/css';
- css.innerHTML = format(
- '.{0}{border-collapse:collapse}' +
- '.{0} td{padding:0}' +
- '.{1}:before{content:attr({2})}',
- [
- TABLE_NAME,
- NUMBER_LINE_NAME,
- DATA_ATTR_NAME
- ]);
- d.getElementsByTagName('head')[0].appendChild(css);
- }
-
- function initLineNumbersOnLoad (options) {
- if (d.readyState === 'interactive' || d.readyState === 'complete') {
- documentReady(options);
- } else {
- w.addEventListener('DOMContentLoaded', function () {
- documentReady(options);
- });
- }
- }
-
- function documentReady (options) {
- try {
- var blocks = d.querySelectorAll('code.hljs,code.nohighlight');
-
- for (var i in blocks) {
- if (blocks.hasOwnProperty(i)) {
- if (!isPluginDisabledForBlock(blocks[i])) {
- lineNumbersBlock(blocks[i], options);
- }
- }
- }
- } catch (e) {
- w.console.error('LineNumbers error: ', e);
- }
- }
-
- function isPluginDisabledForBlock(element) {
- return element.classList.contains('nohljsln');
- }
-
- function lineNumbersBlock (element, options) {
- if (typeof element !== 'object') return;
-
- async(function () {
- element.innerHTML = lineNumbersInternal(element, options);
- });
- }
-
- function lineNumbersValue (value, options) {
- if (typeof value !== 'string') return;
-
- var element = document.createElement('code')
- element.innerHTML = value
-
- return lineNumbersInternal(element, options);
- }
-
- function lineNumbersInternal (element, options) {
-
- var internalOptions = mapOptions(element, options);
-
- duplicateMultilineNodes(element);
-
- return addLineNumbersBlockFor(element.innerHTML, internalOptions);
- }
-
- function addLineNumbersBlockFor (inputHtml, options) {
- var lines = getLines(inputHtml);
-
- // if last line contains only carriage return remove it
- if (lines[lines.length-1].trim() === '') {
- lines.pop();
- }
-
- if (lines.length > 1 || options.singleLine) {
- var html = '';
-
- for (var i = 0, l = lines.length; i < l; i++) {
- html += format(
- ' ' +
- '' +
- ' ' +
- '' +
- '{6}' +
- ' ' +
- ' ',
- [
- LINE_NAME,
- NUMBERS_BLOCK_NAME,
- NUMBER_LINE_NAME,
- DATA_ATTR_NAME,
- CODE_BLOCK_NAME,
- i + options.startFrom,
- lines[i].length > 0 ? lines[i] : ' '
- ]);
- }
-
- return format(' ', [ TABLE_NAME, html ]);
- }
-
- return inputHtml;
- }
-
- /**
- * @param {HTMLElement} element Code block.
- * @param {Object} options External API options.
- * @returns {Object} Internal API options.
- */
- function mapOptions (element, options) {
- options = options || {};
- return {
- singleLine: getSingleLineOption(options),
- startFrom: getStartFromOption(element, options)
- };
- }
-
- function getSingleLineOption (options) {
- var defaultValue = false;
- if (!!options.singleLine) {
- return options.singleLine;
- }
- return defaultValue;
- }
-
- function getStartFromOption (element, options) {
- var defaultValue = 1;
- var startFrom = defaultValue;
-
- if (isFinite(options.startFrom)) {
- startFrom = options.startFrom;
- }
-
- // can be overridden because local option is priority
- var value = getAttribute(element, 'data-ln-start-from');
- if (value !== null) {
- startFrom = toNumber(value, defaultValue);
- }
-
- return startFrom;
- }
-
- /**
- * Recursive method for fix multi-line elements implementation in highlight.js
- * Doing deep passage on child nodes.
- * @param {HTMLElement} element
- */
- function duplicateMultilineNodes (element) {
- var nodes = element.childNodes;
- for (var node in nodes) {
- if (nodes.hasOwnProperty(node)) {
- var child = nodes[node];
- if (getLinesCount(child.textContent) > 0) {
- if (child.childNodes.length > 0) {
- duplicateMultilineNodes(child);
- } else {
- duplicateMultilineNode(child.parentNode);
- }
- }
- }
- }
- }
-
- /**
- * Method for fix multi-line elements implementation in highlight.js
- * @param {HTMLElement} element
- */
- function duplicateMultilineNode (element) {
- var className = element.className;
-
- if ( ! /hljs-/.test(className)) return;
-
- var lines = getLines(element.innerHTML);
-
- for (var i = 0, result = ''; i < lines.length; i++) {
- var lineText = lines[i].length > 0 ? lines[i] : ' ';
- result += format('{1} \n', [ className, lineText ]);
- }
-
- element.innerHTML = result.trim();
- }
-
- function getLines (text) {
- if (text.length === 0) return [];
- return text.split(BREAK_LINE_REGEXP);
- }
-
- function getLinesCount (text) {
- return (text.trim().match(BREAK_LINE_REGEXP) || []).length;
- }
-
- ///
- /// HELPERS
- ///
-
- function async (func) {
- w.setTimeout(func, 0);
- }
-
- /**
- * {@link https://wcoder.github.io/notes/string-format-for-string-formating-in-javascript}
- * @param {string} format
- * @param {array} args
- */
- function format (format, args) {
- return format.replace(/\{(\d+)\}/g, function(m, n){
- return args[n] !== undefined ? args[n] : m;
- });
- }
-
- /**
- * @param {HTMLElement} element Code block.
- * @param {String} attrName Attribute name.
- * @returns {String} Attribute value or empty.
- */
- function getAttribute (element, attrName) {
- return element.hasAttribute(attrName) ? element.getAttribute(attrName) : null;
- }
-
- /**
- * @param {String} str Source string.
- * @param {Number} fallback Fallback value.
- * @returns Parsed number or fallback value.
- */
- function toNumber (str, fallback) {
- if (!str) return fallback;
- var number = Number(str);
- return isFinite(number) ? number : fallback;
- }
-
-}(window, document));
diff --git a/pr-preview/pr-252/api/scripts/third-party/hljs-line-num.js b/pr-preview/pr-252/api/scripts/third-party/hljs-line-num.js
deleted file mode 100644
index facdf6be..00000000
--- a/pr-preview/pr-252/api/scripts/third-party/hljs-line-num.js
+++ /dev/null
@@ -1 +0,0 @@
-!function(r,o){"use strict";var e,l="hljs-ln",s="hljs-ln-line",f="hljs-ln-code",c="hljs-ln-numbers",u="hljs-ln-n",h="data-line-number",n=/\r\n|\r|\n/g;function t(e){for(var n=e.toString(),t=e.anchorNode;"TD"!==t.nodeName;)t=t.parentNode;for(var r=e.focusNode;"TD"!==r.nodeName;)r=r.parentNode;var e=parseInt(t.dataset.lineNumber),o=parseInt(r.dataset.lineNumber);if(e==o)return n;var a,i=t.textContent,l=r.textContent;for(o{6} ',[s,c,u,h,f,a+t.startFrom,0{1}
',[l,o])}return e}function m(e){var n=e.className;if(/hljs-/.test(n)){for(var t=g(e.innerHTML),r=0,o="";r{1}\n',[n,0[]} objects
- * @returns {T} a single new object
- */
- function inherit$1(original, ...objects) {
- /** @type Record */
- const result = Object.create(null);
-
- for (const key in original) {
- result[key] = original[key];
- }
- objects.forEach(function (obj) {
- for (const key in obj) {
- result[key] = obj[key];
- }
- });
- return /** @type {T} */ (result);
- }
-
- /**
- * @typedef {object} Renderer
- * @property {(text: string) => void} addText
- * @property {(node: Node) => void} openNode
- * @property {(node: Node) => void} closeNode
- * @property {() => string} value
- */
-
- /** @typedef {{kind?: string, sublanguage?: boolean}} Node */
- /** @typedef {{walk: (r: Renderer) => void}} Tree */
- /** */
-
- const SPAN_CLOSE = '';
-
- /**
- * Determines if a node needs to be wrapped in
- *
- * @param {Node} node */
- const emitsWrappingTags = (node) => {
- return !!node.kind;
- };
-
- /**
- *
- * @param {string} name
- * @param {{prefix:string}} options
- */
- const expandScopeName = (name, { prefix }) => {
- if (name.includes(".")) {
- const pieces = name.split(".");
- return [
- `${prefix}${pieces.shift()}`,
- ...(pieces.map((x, i) => `${x}${"_".repeat(i + 1)}`))
- ].join(" ");
- }
- return `${prefix}${name}`;
- };
-
- /** @type {Renderer} */
- class HTMLRenderer {
- /**
- * Creates a new HTMLRenderer
- *
- * @param {Tree} parseTree - the parse tree (must support `walk` API)
- * @param {{classPrefix: string}} options
- */
- constructor(parseTree, options) {
- this.buffer = "";
- this.classPrefix = options.classPrefix;
- parseTree.walk(this);
- }
-
- /**
- * Adds texts to the output stream
- *
- * @param {string} text */
- addText(text) {
- this.buffer += escapeHTML(text);
- }
-
- /**
- * Adds a node open to the output stream (if needed)
- *
- * @param {Node} node */
- openNode(node) {
- if (!emitsWrappingTags(node)) return;
-
- let scope = node.kind;
- if (node.sublanguage) {
- scope = `language-${scope}`;
- } else {
- scope = expandScopeName(scope, { prefix: this.classPrefix });
- }
- this.span(scope);
- }
-
- /**
- * Adds a node close to the output stream (if needed)
- *
- * @param {Node} node */
- closeNode(node) {
- if (!emitsWrappingTags(node)) return;
-
- this.buffer += SPAN_CLOSE;
- }
-
- /**
- * returns the accumulated buffer
- */
- value() {
- return this.buffer;
- }
-
- // helpers
-
- /**
- * Builds a span element
- *
- * @param {string} className */
- span(className) {
- this.buffer += ``;
- }
- }
-
- /** @typedef {{kind?: string, sublanguage?: boolean, children: Node[]} | string} Node */
- /** @typedef {{kind?: string, sublanguage?: boolean, children: Node[]} } DataNode */
- /** @typedef {import('highlight.js').Emitter} Emitter */
- /** */
-
- class TokenTree {
- constructor() {
- /** @type DataNode */
- this.rootNode = { children: [] };
- this.stack = [this.rootNode];
- }
-
- get top() {
- return this.stack[this.stack.length - 1];
- }
-
- get root() { return this.rootNode; }
-
- /** @param {Node} node */
- add(node) {
- this.top.children.push(node);
- }
-
- /** @param {string} kind */
- openNode(kind) {
- /** @type Node */
- const node = { kind, children: [] };
- this.add(node);
- this.stack.push(node);
- }
-
- closeNode() {
- if (this.stack.length > 1) {
- return this.stack.pop();
- }
- // eslint-disable-next-line no-undefined
- return undefined;
- }
-
- closeAllNodes() {
- while (this.closeNode());
- }
-
- toJSON() {
- return JSON.stringify(this.rootNode, null, 4);
- }
-
- /**
- * @typedef { import("./html_renderer").Renderer } Renderer
- * @param {Renderer} builder
- */
- walk(builder) {
- // this does not
- return this.constructor._walk(builder, this.rootNode);
- // this works
- // return TokenTree._walk(builder, this.rootNode);
- }
-
- /**
- * @param {Renderer} builder
- * @param {Node} node
- */
- static _walk(builder, node) {
- if (typeof node === "string") {
- builder.addText(node);
- } else if (node.children) {
- builder.openNode(node);
- node.children.forEach((child) => this._walk(builder, child));
- builder.closeNode(node);
- }
- return builder;
- }
-
- /**
- * @param {Node} node
- */
- static _collapse(node) {
- if (typeof node === "string") return;
- if (!node.children) return;
-
- if (node.children.every(el => typeof el === "string")) {
- // node.text = node.children.join("");
- // delete node.children;
- node.children = [node.children.join("")];
- } else {
- node.children.forEach((child) => {
- TokenTree._collapse(child);
- });
- }
- }
- }
-
- /**
- Currently this is all private API, but this is the minimal API necessary
- that an Emitter must implement to fully support the parser.
-
- Minimal interface:
-
- - addKeyword(text, kind)
- - addText(text)
- - addSublanguage(emitter, subLanguageName)
- - finalize()
- - openNode(kind)
- - closeNode()
- - closeAllNodes()
- - toHTML()
-
- */
-
- /**
- * @implements {Emitter}
- */
- class TokenTreeEmitter extends TokenTree {
- /**
- * @param {*} options
- */
- constructor(options) {
- super();
- this.options = options;
- }
-
- /**
- * @param {string} text
- * @param {string} kind
- */
- addKeyword(text, kind) {
- if (text === "") { return; }
-
- this.openNode(kind);
- this.addText(text);
- this.closeNode();
- }
-
- /**
- * @param {string} text
- */
- addText(text) {
- if (text === "") { return; }
-
- this.add(text);
- }
-
- /**
- * @param {Emitter & {root: DataNode}} emitter
- * @param {string} name
- */
- addSublanguage(emitter, name) {
- /** @type DataNode */
- const node = emitter.root;
- node.kind = name;
- node.sublanguage = true;
- this.add(node);
- }
-
- toHTML() {
- const renderer = new HTMLRenderer(this, this.options);
- return renderer.value();
- }
-
- finalize() {
- return true;
- }
- }
-
- /**
- * @param {string} value
- * @returns {RegExp}
- * */
-
- /**
- * @param {RegExp | string } re
- * @returns {string}
- */
- function source(re) {
- if (!re) return null;
- if (typeof re === "string") return re;
-
- return re.source;
- }
-
- /**
- * @param {RegExp | string } re
- * @returns {string}
- */
- function lookahead(re) {
- return concat('(?=', re, ')');
- }
-
- /**
- * @param {RegExp | string } re
- * @returns {string}
- */
- function optional(re) {
- return concat('(?:', re, ')?');
- }
-
- /**
- * @param {...(RegExp | string) } args
- * @returns {string}
- */
- function concat(...args) {
- const joined = args.map((x) => source(x)).join("");
- return joined;
- }
-
- function stripOptionsFromArgs(args) {
- const opts = args[args.length - 1];
-
- if (typeof opts === 'object' && opts.constructor === Object) {
- args.splice(args.length - 1, 1);
- return opts;
- } else {
- return {};
- }
- }
-
- /**
- * Any of the passed expresssions may match
- *
- * Creates a huge this | this | that | that match
- * @param {(RegExp | string)[] } args
- * @returns {string}
- */
- function either(...args) {
- const opts = stripOptionsFromArgs(args);
- const joined = '(' +
- (opts.capture ? "" : "?:") +
- args.map((x) => source(x)).join("|") + ")";
- return joined;
- }
-
- /**
- * @param {RegExp} re
- * @returns {number}
- */
- function countMatchGroups(re) {
- return (new RegExp(re.toString() + '|')).exec('').length - 1;
- }
-
- /**
- * Does lexeme start with a regular expression match at the beginning
- * @param {RegExp} re
- * @param {string} lexeme
- */
- function startsWith(re, lexeme) {
- const match = re && re.exec(lexeme);
- return match && match.index === 0;
- }
-
- // BACKREF_RE matches an open parenthesis or backreference. To avoid
- // an incorrect parse, it additionally matches the following:
- // - [...] elements, where the meaning of parentheses and escapes change
- // - other escape sequences, so we do not misparse escape sequences as
- // interesting elements
- // - non-matching or lookahead parentheses, which do not capture. These
- // follow the '(' with a '?'.
- const BACKREF_RE = /\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./;
-
- // **INTERNAL** Not intended for outside usage
- // join logically computes regexps.join(separator), but fixes the
- // backreferences so they continue to match.
- // it also places each individual regular expression into it's own
- // match group, keeping track of the sequencing of those match groups
- // is currently an exercise for the caller. :-)
- /**
- * @param {(string | RegExp)[]} regexps
- * @param {{joinWith: string}} opts
- * @returns {string}
- */
- function _rewriteBackreferences(regexps, { joinWith }) {
- let numCaptures = 0;
-
- return regexps.map((regex) => {
- numCaptures += 1;
- const offset = numCaptures;
- let re = source(regex);
- let out = '';
-
- while (re.length > 0) {
- const match = BACKREF_RE.exec(re);
- if (!match) {
- out += re;
- break;
- }
- out += re.substring(0, match.index);
- re = re.substring(match.index + match[0].length);
- if (match[0][0] === '\\' && match[1]) {
- // Adjust the backreference.
- out += '\\' + String(Number(match[1]) + offset);
- } else {
- out += match[0];
- if (match[0] === '(') {
- numCaptures++;
- }
- }
- }
- return out;
- }).map(re => `(${re})`).join(joinWith);
- }
-
- /** @typedef {import('highlight.js').Mode} Mode */
- /** @typedef {import('highlight.js').ModeCallback} ModeCallback */
-
- // Common regexps
- const MATCH_NOTHING_RE = /\b\B/;
- const IDENT_RE$1 = '[a-zA-Z]\\w*';
- const UNDERSCORE_IDENT_RE = '[a-zA-Z_]\\w*';
- const NUMBER_RE = '\\b\\d+(\\.\\d+)?';
- const C_NUMBER_RE = '(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)'; // 0x..., 0..., decimal, float
- const BINARY_NUMBER_RE = '\\b(0b[01]+)'; // 0b...
- const RE_STARTERS_RE = '!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~';
-
- /**
- * @param { Partial & {binary?: string | RegExp} } opts
- */
- const SHEBANG = (opts = {}) => {
- const beginShebang = /^#![ ]*\//;
- if (opts.binary) {
- opts.begin = concat(
- beginShebang,
- /.*\b/,
- opts.binary,
- /\b.*/);
- }
- return inherit$1({
- scope: 'meta',
- begin: beginShebang,
- end: /$/,
- relevance: 0,
- /** @type {ModeCallback} */
- "on:begin": (m, resp) => {
- if (m.index !== 0) resp.ignoreMatch();
- }
- }, opts);
- };
-
- // Common modes
- const BACKSLASH_ESCAPE = {
- begin: '\\\\[\\s\\S]', relevance: 0
- };
- const APOS_STRING_MODE = {
- scope: 'string',
- begin: '\'',
- end: '\'',
- illegal: '\\n',
- contains: [BACKSLASH_ESCAPE]
- };
- const QUOTE_STRING_MODE = {
- scope: 'string',
- begin: '"',
- end: '"',
- illegal: '\\n',
- contains: [BACKSLASH_ESCAPE]
- };
- const PHRASAL_WORDS_MODE = {
- begin: /\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/
- };
- /**
- * Creates a comment mode
- *
- * @param {string | RegExp} begin
- * @param {string | RegExp} end
- * @param {Mode | {}} [modeOptions]
- * @returns {Partial}
- */
- const COMMENT = function (begin, end, modeOptions = {}) {
- const mode = inherit$1(
- {
- scope: 'comment',
- begin,
- end,
- contains: []
- },
- modeOptions
- );
- mode.contains.push({
- scope: 'doctag',
- // hack to avoid the space from being included. the space is necessary to
- // match here to prevent the plain text rule below from gobbling up doctags
- begin: '[ ]*(?=(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):)',
- end: /(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):/,
- excludeBegin: true,
- relevance: 0
- });
- const ENGLISH_WORD = either(
- // list of common 1 and 2 letter words in English
- "I",
- "a",
- "is",
- "so",
- "us",
- "to",
- "at",
- "if",
- "in",
- "it",
- "on",
- // note: this is not an exhaustive list of contractions, just popular ones
- /[A-Za-z]+['](d|ve|re|ll|t|s|n)/, // contractions - can't we'd they're let's, etc
- /[A-Za-z]+[-][a-z]+/, // `no-way`, etc.
- /[A-Za-z][a-z]{2,}/ // allow capitalized words at beginning of sentences
- );
- // looking like plain text, more likely to be a comment
- mode.contains.push(
- {
- // TODO: how to include ", (, ) without breaking grammars that use these for
- // comment delimiters?
- // begin: /[ ]+([()"]?([A-Za-z'-]{3,}|is|a|I|so|us|[tT][oO]|at|if|in|it|on)[.]?[()":]?([.][ ]|[ ]|\))){3}/
- // ---
-
- // this tries to find sequences of 3 english words in a row (without any
- // "programming" type syntax) this gives us a strong signal that we've
- // TRULY found a comment - vs perhaps scanning with the wrong language.
- // It's possible to find something that LOOKS like the start of the
- // comment - but then if there is no readable text - good chance it is a
- // false match and not a comment.
- //
- // for a visual example please see:
- // https://github.com/highlightjs/highlight.js/issues/2827
-
- begin: concat(
- /[ ]+/, // necessary to prevent us gobbling up doctags like /* @author Bob Mcgill */
- '(',
- ENGLISH_WORD,
- /[.]?[:]?([.][ ]|[ ])/,
- '){3}') // look for 3 words in a row
- }
- );
- return mode;
- };
- const C_LINE_COMMENT_MODE = COMMENT('//', '$');
- const C_BLOCK_COMMENT_MODE = COMMENT('/\\*', '\\*/');
- const HASH_COMMENT_MODE = COMMENT('#', '$');
- const NUMBER_MODE = {
- scope: 'number',
- begin: NUMBER_RE,
- relevance: 0
- };
- const C_NUMBER_MODE = {
- scope: 'number',
- begin: C_NUMBER_RE,
- relevance: 0
- };
- const BINARY_NUMBER_MODE = {
- scope: 'number',
- begin: BINARY_NUMBER_RE,
- relevance: 0
- };
- const REGEXP_MODE = {
- // this outer rule makes sure we actually have a WHOLE regex and not simply
- // an expression such as:
- //
- // 3 / something
- //
- // (which will then blow up when regex's `illegal` sees the newline)
- begin: /(?=\/[^/\n]*\/)/,
- contains: [{
- scope: 'regexp',
- begin: /\//,
- end: /\/[gimuy]*/,
- illegal: /\n/,
- contains: [
- BACKSLASH_ESCAPE,
- {
- begin: /\[/,
- end: /\]/,
- relevance: 0,
- contains: [BACKSLASH_ESCAPE]
- }
- ]
- }]
- };
- const TITLE_MODE = {
- scope: 'title',
- begin: IDENT_RE$1,
- relevance: 0
- };
- const UNDERSCORE_TITLE_MODE = {
- scope: 'title',
- begin: UNDERSCORE_IDENT_RE,
- relevance: 0
- };
- const METHOD_GUARD = {
- // excludes method names from keyword processing
- begin: '\\.\\s*' + UNDERSCORE_IDENT_RE,
- relevance: 0
- };
-
- /**
- * Adds end same as begin mechanics to a mode
- *
- * Your mode must include at least a single () match group as that first match
- * group is what is used for comparison
- * @param {Partial} mode
- */
- const END_SAME_AS_BEGIN = function (mode) {
- return Object.assign(mode,
- {
- /** @type {ModeCallback} */
- 'on:begin': (m, resp) => { resp.data._beginMatch = m[1]; },
- /** @type {ModeCallback} */
- 'on:end': (m, resp) => { if (resp.data._beginMatch !== m[1]) resp.ignoreMatch(); }
- });
- };
-
- var MODES$1 = /*#__PURE__*/Object.freeze({
- __proto__: null,
- MATCH_NOTHING_RE: MATCH_NOTHING_RE,
- IDENT_RE: IDENT_RE$1,
- UNDERSCORE_IDENT_RE: UNDERSCORE_IDENT_RE,
- NUMBER_RE: NUMBER_RE,
- C_NUMBER_RE: C_NUMBER_RE,
- BINARY_NUMBER_RE: BINARY_NUMBER_RE,
- RE_STARTERS_RE: RE_STARTERS_RE,
- SHEBANG: SHEBANG,
- BACKSLASH_ESCAPE: BACKSLASH_ESCAPE,
- APOS_STRING_MODE: APOS_STRING_MODE,
- QUOTE_STRING_MODE: QUOTE_STRING_MODE,
- PHRASAL_WORDS_MODE: PHRASAL_WORDS_MODE,
- COMMENT: COMMENT,
- C_LINE_COMMENT_MODE: C_LINE_COMMENT_MODE,
- C_BLOCK_COMMENT_MODE: C_BLOCK_COMMENT_MODE,
- HASH_COMMENT_MODE: HASH_COMMENT_MODE,
- NUMBER_MODE: NUMBER_MODE,
- C_NUMBER_MODE: C_NUMBER_MODE,
- BINARY_NUMBER_MODE: BINARY_NUMBER_MODE,
- REGEXP_MODE: REGEXP_MODE,
- TITLE_MODE: TITLE_MODE,
- UNDERSCORE_TITLE_MODE: UNDERSCORE_TITLE_MODE,
- METHOD_GUARD: METHOD_GUARD,
- END_SAME_AS_BEGIN: END_SAME_AS_BEGIN
- });
-
- /**
- @typedef {import('highlight.js').CallbackResponse} CallbackResponse
- @typedef {import('highlight.js').CompilerExt} CompilerExt
- */
-
- // Grammar extensions / plugins
- // See: https://github.com/highlightjs/highlight.js/issues/2833
-
- // Grammar extensions allow "syntactic sugar" to be added to the grammar modes
- // without requiring any underlying changes to the compiler internals.
-
- // `compileMatch` being the perfect small example of now allowing a grammar
- // author to write `match` when they desire to match a single expression rather
- // than being forced to use `begin`. The extension then just moves `match` into
- // `begin` when it runs. Ie, no features have been added, but we've just made
- // the experience of writing (and reading grammars) a little bit nicer.
-
- // ------
-
- // TODO: We need negative look-behind support to do this properly
- /**
- * Skip a match if it has a preceding dot
- *
- * This is used for `beginKeywords` to prevent matching expressions such as
- * `bob.keyword.do()`. The mode compiler automatically wires this up as a
- * special _internal_ 'on:begin' callback for modes with `beginKeywords`
- * @param {RegExpMatchArray} match
- * @param {CallbackResponse} response
- */
- function skipIfHasPrecedingDot(match, response) {
- const before = match.input[match.index - 1];
- if (before === ".") {
- response.ignoreMatch();
- }
- }
-
- /**
- *
- * @type {CompilerExt}
- */
- function scopeClassName(mode, _parent) {
- // eslint-disable-next-line no-undefined
- if (mode.className !== undefined) {
- mode.scope = mode.className;
- delete mode.className;
- }
- }
-
- /**
- * `beginKeywords` syntactic sugar
- * @type {CompilerExt}
- */
- function beginKeywords(mode, parent) {
- if (!parent) return;
- if (!mode.beginKeywords) return;
-
- // for languages with keywords that include non-word characters checking for
- // a word boundary is not sufficient, so instead we check for a word boundary
- // or whitespace - this does no harm in any case since our keyword engine
- // doesn't allow spaces in keywords anyways and we still check for the boundary
- // first
- mode.begin = '\\b(' + mode.beginKeywords.split(' ').join('|') + ')(?!\\.)(?=\\b|\\s)';
- mode.__beforeBegin = skipIfHasPrecedingDot;
- mode.keywords = mode.keywords || mode.beginKeywords;
- delete mode.beginKeywords;
-
- // prevents double relevance, the keywords themselves provide
- // relevance, the mode doesn't need to double it
- // eslint-disable-next-line no-undefined
- if (mode.relevance === undefined) mode.relevance = 0;
- }
-
- /**
- * Allow `illegal` to contain an array of illegal values
- * @type {CompilerExt}
- */
- function compileIllegal(mode, _parent) {
- if (!Array.isArray(mode.illegal)) return;
-
- mode.illegal = either(...mode.illegal);
- }
-
- /**
- * `match` to match a single expression for readability
- * @type {CompilerExt}
- */
- function compileMatch(mode, _parent) {
- if (!mode.match) return;
- if (mode.begin || mode.end) throw new Error("begin & end are not supported with match");
-
- mode.begin = mode.match;
- delete mode.match;
- }
-
- /**
- * provides the default 1 relevance to all modes
- * @type {CompilerExt}
- */
- function compileRelevance(mode, _parent) {
- // eslint-disable-next-line no-undefined
- if (mode.relevance === undefined) mode.relevance = 1;
- }
-
- // allow beforeMatch to act as a "qualifier" for the match
- // the full match begin must be [beforeMatch][begin]
- const beforeMatchExt = (mode, parent) => {
- if (!mode.beforeMatch) return;
- // starts conflicts with endsParent which we need to make sure the child
- // rule is not matched multiple times
- if (mode.starts) throw new Error("beforeMatch cannot be used with starts");
-
- const originalMode = Object.assign({}, mode);
- Object.keys(mode).forEach((key) => { delete mode[key]; });
-
- mode.keywords = originalMode.keywords;
- mode.begin = concat(originalMode.beforeMatch, lookahead(originalMode.begin));
- mode.starts = {
- relevance: 0,
- contains: [
- Object.assign(originalMode, { endsParent: true })
- ]
- };
- mode.relevance = 0;
-
- delete originalMode.beforeMatch;
- };
-
- // keywords that should have no default relevance value
- const COMMON_KEYWORDS = [
- 'of',
- 'and',
- 'for',
- 'in',
- 'not',
- 'or',
- 'if',
- 'then',
- 'parent', // common variable name
- 'list', // common variable name
- 'value' // common variable name
- ];
-
- const DEFAULT_KEYWORD_SCOPE = "keyword";
-
- /**
- * Given raw keywords from a language definition, compile them.
- *
- * @param {string | Record | Array} rawKeywords
- * @param {boolean} caseInsensitive
- */
- function compileKeywords(rawKeywords, caseInsensitive, scopeName = DEFAULT_KEYWORD_SCOPE) {
- /** @type KeywordDict */
- const compiledKeywords = Object.create(null);
-
- // input can be a string of keywords, an array of keywords, or a object with
- // named keys representing scopeName (which can then point to a string or array)
- if (typeof rawKeywords === 'string') {
- compileList(scopeName, rawKeywords.split(" "));
- } else if (Array.isArray(rawKeywords)) {
- compileList(scopeName, rawKeywords);
- } else {
- Object.keys(rawKeywords).forEach(function (scopeName) {
- // collapse all our objects back into the parent object
- Object.assign(
- compiledKeywords,
- compileKeywords(rawKeywords[scopeName], caseInsensitive, scopeName)
- );
- });
- }
- return compiledKeywords;
-
- // ---
-
- /**
- * Compiles an individual list of keywords
- *
- * Ex: "for if when while|5"
- *
- * @param {string} scopeName
- * @param {Array} keywordList
- */
- function compileList(scopeName, keywordList) {
- if (caseInsensitive) {
- keywordList = keywordList.map(x => x.toLowerCase());
- }
- keywordList.forEach(function (keyword) {
- const pair = keyword.split('|');
- compiledKeywords[pair[0]] = [scopeName, scoreForKeyword(pair[0], pair[1])];
- });
- }
- }
-
- /**
- * Returns the proper score for a given keyword
- *
- * Also takes into account comment keywords, which will be scored 0 UNLESS
- * another score has been manually assigned.
- * @param {string} keyword
- * @param {string} [providedScore]
- */
- function scoreForKeyword(keyword, providedScore) {
- // manual scores always win over common keywords
- // so you can force a score of 1 if you really insist
- if (providedScore) {
- return Number(providedScore);
- }
-
- return commonKeyword(keyword) ? 0 : 1;
- }
-
- /**
- * Determines if a given keyword is common or not
- *
- * @param {string} keyword */
- function commonKeyword(keyword) {
- return COMMON_KEYWORDS.includes(keyword.toLowerCase());
- }
-
- /*
-
- For the reasoning behind this please see:
- https://github.com/highlightjs/highlight.js/issues/2880#issuecomment-747275419
-
- */
-
- /**
- * @type {Record}
- */
- const seenDeprecations = {};
-
- /**
- * @param {string} message
- */
- const error = (message) => {
- console.error(message);
- };
-
- /**
- * @param {string} message
- * @param {any} args
- */
- const warn = (message, ...args) => {
- console.log(`WARN: ${message}`, ...args);
- };
-
- /**
- * @param {string} version
- * @param {string} message
- */
- const deprecated = (version, message) => {
- if (seenDeprecations[`${version}/${message}`]) return;
-
- console.log(`Deprecated as of ${version}. ${message}`);
- seenDeprecations[`${version}/${message}`] = true;
- };
-
- /* eslint-disable no-throw-literal */
-
- /**
- @typedef {import('highlight.js').CompiledMode} CompiledMode
- */
-
- const MultiClassError = new Error();
-
- /**
- * Renumbers labeled scope names to account for additional inner match
- * groups that otherwise would break everything.
- *
- * Lets say we 3 match scopes:
- *
- * { 1 => ..., 2 => ..., 3 => ... }
- *
- * So what we need is a clean match like this:
- *
- * (a)(b)(c) => [ "a", "b", "c" ]
- *
- * But this falls apart with inner match groups:
- *
- * (a)(((b)))(c) => ["a", "b", "b", "b", "c" ]
- *
- * Our scopes are now "out of alignment" and we're repeating `b` 3 times.
- * What needs to happen is the numbers are remapped:
- *
- * { 1 => ..., 2 => ..., 5 => ... }
- *
- * We also need to know that the ONLY groups that should be output
- * are 1, 2, and 5. This function handles this behavior.
- *
- * @param {CompiledMode} mode
- * @param {Array} regexes
- * @param {{key: "beginScope"|"endScope"}} opts
- */
- function remapScopeNames(mode, regexes, { key }) {
- let offset = 0;
- const scopeNames = mode[key];
- /** @type Record */
- const emit = {};
- /** @type Record */
- const positions = {};
-
- for (let i = 1; i <= regexes.length; i++) {
- positions[i + offset] = scopeNames[i];
- emit[i + offset] = true;
- offset += countMatchGroups(regexes[i - 1]);
- }
- // we use _emit to keep track of which match groups are "top-level" to avoid double
- // output from inside match groups
- mode[key] = positions;
- mode[key]._emit = emit;
- mode[key]._multi = true;
- }
-
- /**
- * @param {CompiledMode} mode
- */
- function beginMultiClass(mode) {
- if (!Array.isArray(mode.begin)) return;
-
- if (mode.skip || mode.excludeBegin || mode.returnBegin) {
- error("skip, excludeBegin, returnBegin not compatible with beginScope: {}");
- throw MultiClassError;
- }
-
- if (typeof mode.beginScope !== "object" || mode.beginScope === null) {
- error("beginScope must be object");
- throw MultiClassError;
- }
-
- remapScopeNames(mode, mode.begin, { key: "beginScope" });
- mode.begin = _rewriteBackreferences(mode.begin, { joinWith: "" });
- }
-
- /**
- * @param {CompiledMode} mode
- */
- function endMultiClass(mode) {
- if (!Array.isArray(mode.end)) return;
-
- if (mode.skip || mode.excludeEnd || mode.returnEnd) {
- error("skip, excludeEnd, returnEnd not compatible with endScope: {}");
- throw MultiClassError;
- }
-
- if (typeof mode.endScope !== "object" || mode.endScope === null) {
- error("endScope must be object");
- throw MultiClassError;
- }
-
- remapScopeNames(mode, mode.end, { key: "endScope" });
- mode.end = _rewriteBackreferences(mode.end, { joinWith: "" });
- }
-
- /**
- * this exists only to allow `scope: {}` to be used beside `match:`
- * Otherwise `beginScope` would necessary and that would look weird
-
- {
- match: [ /def/, /\w+/ ]
- scope: { 1: "keyword" , 2: "title" }
- }
-
- * @param {CompiledMode} mode
- */
- function scopeSugar(mode) {
- if (mode.scope && typeof mode.scope === "object" && mode.scope !== null) {
- mode.beginScope = mode.scope;
- delete mode.scope;
- }
- }
-
- /**
- * @param {CompiledMode} mode
- */
- function MultiClass(mode) {
- scopeSugar(mode);
-
- if (typeof mode.beginScope === "string") {
- mode.beginScope = { _wrap: mode.beginScope };
- }
- if (typeof mode.endScope === "string") {
- mode.endScope = { _wrap: mode.endScope };
- }
-
- beginMultiClass(mode);
- endMultiClass(mode);
- }
-
- /**
- @typedef {import('highlight.js').Mode} Mode
- @typedef {import('highlight.js').CompiledMode} CompiledMode
- @typedef {import('highlight.js').Language} Language
- @typedef {import('highlight.js').HLJSPlugin} HLJSPlugin
- @typedef {import('highlight.js').CompiledLanguage} CompiledLanguage
- */
-
- // compilation
-
- /**
- * Compiles a language definition result
- *
- * Given the raw result of a language definition (Language), compiles this so
- * that it is ready for highlighting code.
- * @param {Language} language
- * @returns {CompiledLanguage}
- */
- function compileLanguage(language) {
- /**
- * Builds a regex with the case sensitivity of the current language
- *
- * @param {RegExp | string} value
- * @param {boolean} [global]
- */
- function langRe(value, global) {
- return new RegExp(
- source(value),
- 'm' + (language.case_insensitive ? 'i' : '') + (global ? 'g' : '')
- );
- }
-
- /**
- Stores multiple regular expressions and allows you to quickly search for
- them all in a string simultaneously - returning the first match. It does
- this by creating a huge (a|b|c) regex - each individual item wrapped with ()
- and joined by `|` - using match groups to track position. When a match is
- found checking which position in the array has content allows us to figure
- out which of the original regexes / match groups triggered the match.
-
- The match object itself (the result of `Regex.exec`) is returned but also
- enhanced by merging in any meta-data that was registered with the regex.
- This is how we keep track of which mode matched, and what type of rule
- (`illegal`, `begin`, end, etc).
- */
- class MultiRegex {
- constructor() {
- this.matchIndexes = {};
- // @ts-ignore
- this.regexes = [];
- this.matchAt = 1;
- this.position = 0;
- }
-
- // @ts-ignore
- addRule(re, opts) {
- opts.position = this.position++;
- // @ts-ignore
- this.matchIndexes[this.matchAt] = opts;
- this.regexes.push([opts, re]);
- this.matchAt += countMatchGroups(re) + 1;
- }
-
- compile() {
- if (this.regexes.length === 0) {
- // avoids the need to check length every time exec is called
- // @ts-ignore
- this.exec = () => null;
- }
- const terminators = this.regexes.map(el => el[1]);
- this.matcherRe = langRe(_rewriteBackreferences(terminators, { joinWith: '|' }), true);
- this.lastIndex = 0;
- }
-
- /** @param {string} s */
- exec(s) {
- this.matcherRe.lastIndex = this.lastIndex;
- const match = this.matcherRe.exec(s);
- if (!match) { return null; }
-
- // eslint-disable-next-line no-undefined
- const i = match.findIndex((el, i) => i > 0 && el !== undefined);
- // @ts-ignore
- const matchData = this.matchIndexes[i];
- // trim off any earlier non-relevant match groups (ie, the other regex
- // match groups that make up the multi-matcher)
- match.splice(0, i);
-
- return Object.assign(match, matchData);
- }
- }
-
- /*
- Created to solve the key deficiently with MultiRegex - there is no way to
- test for multiple matches at a single location. Why would we need to do
- that? In the future a more dynamic engine will allow certain matches to be
- ignored. An example: if we matched say the 3rd regex in a large group but
- decided to ignore it - we'd need to started testing again at the 4th
- regex... but MultiRegex itself gives us no real way to do that.
-
- So what this class creates MultiRegexs on the fly for whatever search
- position they are needed.
-
- NOTE: These additional MultiRegex objects are created dynamically. For most
- grammars most of the time we will never actually need anything more than the
- first MultiRegex - so this shouldn't have too much overhead.
-
- Say this is our search group, and we match regex3, but wish to ignore it.
-
- regex1 | regex2 | regex3 | regex4 | regex5 ' ie, startAt = 0
-
- What we need is a new MultiRegex that only includes the remaining
- possibilities:
-
- regex4 | regex5 ' ie, startAt = 3
-
- This class wraps all that complexity up in a simple API... `startAt` decides
- where in the array of expressions to start doing the matching. It
- auto-increments, so if a match is found at position 2, then startAt will be
- set to 3. If the end is reached startAt will return to 0.
-
- MOST of the time the parser will be setting startAt manually to 0.
- */
- class ResumableMultiRegex {
- constructor() {
- // @ts-ignore
- this.rules = [];
- // @ts-ignore
- this.multiRegexes = [];
- this.count = 0;
-
- this.lastIndex = 0;
- this.regexIndex = 0;
- }
-
- // @ts-ignore
- getMatcher(index) {
- if (this.multiRegexes[index]) return this.multiRegexes[index];
-
- const matcher = new MultiRegex();
- this.rules.slice(index).forEach(([re, opts]) => matcher.addRule(re, opts));
- matcher.compile();
- this.multiRegexes[index] = matcher;
- return matcher;
- }
-
- resumingScanAtSamePosition() {
- return this.regexIndex !== 0;
- }
-
- considerAll() {
- this.regexIndex = 0;
- }
-
- // @ts-ignore
- addRule(re, opts) {
- this.rules.push([re, opts]);
- if (opts.type === "begin") this.count++;
- }
-
- /** @param {string} s */
- exec(s) {
- const m = this.getMatcher(this.regexIndex);
- m.lastIndex = this.lastIndex;
- let result = m.exec(s);
-
- // The following is because we have no easy way to say "resume scanning at the
- // existing position but also skip the current rule ONLY". What happens is
- // all prior rules are also skipped which can result in matching the wrong
- // thing. Example of matching "booger":
-
- // our matcher is [string, "booger", number]
- //
- // ....booger....
-
- // if "booger" is ignored then we'd really need a regex to scan from the
- // SAME position for only: [string, number] but ignoring "booger" (if it
- // was the first match), a simple resume would scan ahead who knows how
- // far looking only for "number", ignoring potential string matches (or
- // future "booger" matches that might be valid.)
-
- // So what we do: We execute two matchers, one resuming at the same
- // position, but the second full matcher starting at the position after:
-
- // /--- resume first regex match here (for [number])
- // |/---- full match here for [string, "booger", number]
- // vv
- // ....booger....
-
- // Which ever results in a match first is then used. So this 3-4 step
- // process essentially allows us to say "match at this position, excluding
- // a prior rule that was ignored".
- //
- // 1. Match "booger" first, ignore. Also proves that [string] does non match.
- // 2. Resume matching for [number]
- // 3. Match at index + 1 for [string, "booger", number]
- // 4. If #2 and #3 result in matches, which came first?
- if (this.resumingScanAtSamePosition()) {
- if (result && result.index === this.lastIndex); else { // use the second matcher result
- const m2 = this.getMatcher(0);
- m2.lastIndex = this.lastIndex + 1;
- result = m2.exec(s);
- }
- }
-
- if (result) {
- this.regexIndex += result.position + 1;
- if (this.regexIndex === this.count) {
- // wrap-around to considering all matches again
- this.considerAll();
- }
- }
-
- return result;
- }
- }
-
- /**
- * Given a mode, builds a huge ResumableMultiRegex that can be used to walk
- * the content and find matches.
- *
- * @param {CompiledMode} mode
- * @returns {ResumableMultiRegex}
- */
- function buildModeRegex(mode) {
- const mm = new ResumableMultiRegex();
-
- mode.contains.forEach(term => mm.addRule(term.begin, { rule: term, type: "begin" }));
-
- if (mode.terminatorEnd) {
- mm.addRule(mode.terminatorEnd, { type: "end" });
- }
- if (mode.illegal) {
- mm.addRule(mode.illegal, { type: "illegal" });
- }
-
- return mm;
- }
-
- /** skip vs abort vs ignore
- *
- * @skip - The mode is still entered and exited normally (and contains rules apply),
- * but all content is held and added to the parent buffer rather than being
- * output when the mode ends. Mostly used with `sublanguage` to build up
- * a single large buffer than can be parsed by sublanguage.
- *
- * - The mode begin ands ends normally.
- * - Content matched is added to the parent mode buffer.
- * - The parser cursor is moved forward normally.
- *
- * @abort - A hack placeholder until we have ignore. Aborts the mode (as if it
- * never matched) but DOES NOT continue to match subsequent `contains`
- * modes. Abort is bad/suboptimal because it can result in modes
- * farther down not getting applied because an earlier rule eats the
- * content but then aborts.
- *
- * - The mode does not begin.
- * - Content matched by `begin` is added to the mode buffer.
- * - The parser cursor is moved forward accordingly.
- *
- * @ignore - Ignores the mode (as if it never matched) and continues to match any
- * subsequent `contains` modes. Ignore isn't technically possible with
- * the current parser implementation.
- *
- * - The mode does not begin.
- * - Content matched by `begin` is ignored.
- * - The parser cursor is not moved forward.
- */
-
- /**
- * Compiles an individual mode
- *
- * This can raise an error if the mode contains certain detectable known logic
- * issues.
- * @param {Mode} mode
- * @param {CompiledMode | null} [parent]
- * @returns {CompiledMode | never}
- */
- function compileMode(mode, parent) {
- const cmode = /** @type CompiledMode */ (mode);
- if (mode.isCompiled) return cmode;
-
- [
- scopeClassName,
- // do this early so compiler extensions generally don't have to worry about
- // the distinction between match/begin
- compileMatch,
- MultiClass,
- beforeMatchExt
- ].forEach(ext => ext(mode, parent));
-
- language.compilerExtensions.forEach(ext => ext(mode, parent));
-
- // __beforeBegin is considered private API, internal use only
- mode.__beforeBegin = null;
-
- [
- beginKeywords,
- // do this later so compiler extensions that come earlier have access to the
- // raw array if they wanted to perhaps manipulate it, etc.
- compileIllegal,
- // default to 1 relevance if not specified
- compileRelevance
- ].forEach(ext => ext(mode, parent));
-
- mode.isCompiled = true;
-
- let keywordPattern = null;
- if (typeof mode.keywords === "object" && mode.keywords.$pattern) {
- // we need a copy because keywords might be compiled multiple times
- // so we can't go deleting $pattern from the original on the first
- // pass
- mode.keywords = Object.assign({}, mode.keywords);
- keywordPattern = mode.keywords.$pattern;
- delete mode.keywords.$pattern;
- }
- keywordPattern = keywordPattern || /\w+/;
-
- if (mode.keywords) {
- mode.keywords = compileKeywords(mode.keywords, language.case_insensitive);
- }
-
- cmode.keywordPatternRe = langRe(keywordPattern, true);
-
- if (parent) {
- if (!mode.begin) mode.begin = /\B|\b/;
- cmode.beginRe = langRe(mode.begin);
- if (!mode.end && !mode.endsWithParent) mode.end = /\B|\b/;
- if (mode.end) cmode.endRe = langRe(mode.end);
- cmode.terminatorEnd = source(mode.end) || '';
- if (mode.endsWithParent && parent.terminatorEnd) {
- cmode.terminatorEnd += (mode.end ? '|' : '') + parent.terminatorEnd;
- }
- }
- if (mode.illegal) cmode.illegalRe = langRe(/** @type {RegExp | string} */(mode.illegal));
- if (!mode.contains) mode.contains = [];
-
- mode.contains = [].concat(...mode.contains.map(function (c) {
- return expandOrCloneMode(c === 'self' ? mode : c);
- }));
- mode.contains.forEach(function (c) { compileMode(/** @type Mode */(c), cmode); });
-
- if (mode.starts) {
- compileMode(mode.starts, parent);
- }
-
- cmode.matcher = buildModeRegex(cmode);
- return cmode;
- }
-
- if (!language.compilerExtensions) language.compilerExtensions = [];
-
- // self is not valid at the top-level
- if (language.contains && language.contains.includes('self')) {
- throw new Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.");
- }
-
- // we need a null object, which inherit will guarantee
- language.classNameAliases = inherit$1(language.classNameAliases || {});
-
- return compileMode(/** @type Mode */(language));
- }
-
- /**
- * Determines if a mode has a dependency on it's parent or not
- *
- * If a mode does have a parent dependency then often we need to clone it if
- * it's used in multiple places so that each copy points to the correct parent,
- * where-as modes without a parent can often safely be re-used at the bottom of
- * a mode chain.
- *
- * @param {Mode | null} mode
- * @returns {boolean} - is there a dependency on the parent?
- * */
- function dependencyOnParent(mode) {
- if (!mode) return false;
-
- return mode.endsWithParent || dependencyOnParent(mode.starts);
- }
-
- /**
- * Expands a mode or clones it if necessary
- *
- * This is necessary for modes with parental dependenceis (see notes on
- * `dependencyOnParent`) and for nodes that have `variants` - which must then be
- * exploded into their own individual modes at compile time.
- *
- * @param {Mode} mode
- * @returns {Mode | Mode[]}
- * */
- function expandOrCloneMode(mode) {
- if (mode.variants && !mode.cachedVariants) {
- mode.cachedVariants = mode.variants.map(function (variant) {
- return inherit$1(mode, { variants: null }, variant);
- });
- }
-
- // EXPAND
- // if we have variants then essentially "replace" the mode with the variants
- // this happens in compileMode, where this function is called from
- if (mode.cachedVariants) {
- return mode.cachedVariants;
- }
-
- // CLONE
- // if we have dependencies on parents then we need a unique
- // instance of ourselves, so we can be reused with many
- // different parents without issue
- if (dependencyOnParent(mode)) {
- return inherit$1(mode, { starts: mode.starts ? inherit$1(mode.starts) : null });
- }
-
- if (Object.isFrozen(mode)) {
- return inherit$1(mode);
- }
-
- // no special dependency issues, just return ourselves
- return mode;
- }
-
- var version = "11.0.0-beta1";
-
- /*
- Syntax highlighting with language autodetection.
- https://highlightjs.org/
- */
-
- /**
- @typedef {import('highlight.js').Mode} Mode
- @typedef {import('highlight.js').CompiledMode} CompiledMode
- @typedef {import('highlight.js').Language} Language
- @typedef {import('highlight.js').HLJSApi} HLJSApi
- @typedef {import('highlight.js').HLJSPlugin} HLJSPlugin
- @typedef {import('highlight.js').PluginEvent} PluginEvent
- @typedef {import('highlight.js').HLJSOptions} HLJSOptions
- @typedef {import('highlight.js').LanguageFn} LanguageFn
- @typedef {import('highlight.js').HighlightedHTMLElement} HighlightedHTMLElement
- @typedef {import('highlight.js').BeforeHighlightContext} BeforeHighlightContext
- @typedef {import('highlight.js/private').MatchType} MatchType
- @typedef {import('highlight.js/private').KeywordData} KeywordData
- @typedef {import('highlight.js/private').EnhancedMatch} EnhancedMatch
- @typedef {import('highlight.js/private').AnnotatedError} AnnotatedError
- @typedef {import('highlight.js').AutoHighlightResult} AutoHighlightResult
- @typedef {import('highlight.js').HighlightOptions} HighlightOptions
- @typedef {import('highlight.js').HighlightResult} HighlightResult
- */
-
-
- const escape = escapeHTML;
- const inherit = inherit$1;
- const NO_MATCH = Symbol("nomatch");
- const MAX_KEYWORD_HITS = 7;
-
- /**
- * @param {any} hljs - object that is extended (legacy)
- * @returns {HLJSApi}
- */
- const HLJS = function (hljs) {
- // Global internal variables used within the highlight.js library.
- /** @type {Record} */
- const languages = Object.create(null);
- /** @type {Record} */
- const aliases = Object.create(null);
- /** @type {HLJSPlugin[]} */
- const plugins = [];
-
- // safe/production mode - swallows more errors, tries to keep running
- // even if a single syntax or parse hits a fatal error
- let SAFE_MODE = true;
- const LANGUAGE_NOT_FOUND = "Could not find the language '{}', did you forget to load/include a language module?";
- /** @type {Language} */
- const PLAINTEXT_LANGUAGE = { disableAutodetect: true, name: 'Plain text', contains: [] };
-
- // Global options used when within external APIs. This is modified when
- // calling the `hljs.configure` function.
- /** @type HLJSOptions */
- let options = {
- ignoreUnescapedHTML: false,
- noHighlightRe: /^(no-?highlight)$/i,
- languageDetectRe: /\blang(?:uage)?-([\w-]+)\b/i,
- classPrefix: 'hljs-',
- cssSelector: 'pre code',
- languages: null,
- // beta configuration options, subject to change, welcome to discuss
- // https://github.com/highlightjs/highlight.js/issues/1086
- __emitter: TokenTreeEmitter
- };
-
- /* Utility functions */
-
- /**
- * Tests a language name to see if highlighting should be skipped
- * @param {string} languageName
- */
- function shouldNotHighlight(languageName) {
- return options.noHighlightRe.test(languageName);
- }
-
- /**
- * @param {HighlightedHTMLElement} block - the HTML element to determine language for
- */
- function blockLanguage(block) {
- let classes = block.className + ' ';
-
- classes += block.parentNode ? block.parentNode.className : '';
-
- // language-* takes precedence over non-prefixed class names.
- const match = options.languageDetectRe.exec(classes);
- if (match) {
- const language = getLanguage(match[1]);
- if (!language) {
- warn(LANGUAGE_NOT_FOUND.replace("{}", match[1]));
- warn("Falling back to no-highlight mode for this block.", block);
- }
- return language ? match[1] : 'no-highlight';
- }
-
- return classes
- .split(/\s+/)
- .find((_class) => shouldNotHighlight(_class) || getLanguage(_class));
- }
-
- /**
- * Core highlighting function.
- *
- * OLD API
- * highlight(lang, code, ignoreIllegals, continuation)
- *
- * NEW API
- * highlight(code, {lang, ignoreIllegals})
- *
- * @param {string} codeOrLanguageName - the language to use for highlighting
- * @param {string | HighlightOptions} optionsOrCode - the code to highlight
- * @param {boolean} [ignoreIllegals] - whether to ignore illegal matches, default is to bail
- * @param {CompiledMode} [continuation] - current continuation mode, if any
- *
- * @returns {HighlightResult} Result - an object that represents the result
- * @property {string} language - the language name
- * @property {number} relevance - the relevance score
- * @property {string} value - the highlighted HTML code
- * @property {string} code - the original raw code
- * @property {CompiledMode} top - top of the current mode stack
- * @property {boolean} illegal - indicates whether any illegal matches were found
- */
- function highlight(codeOrLanguageName, optionsOrCode, ignoreIllegals, continuation) {
- let code = "";
- let languageName = "";
- if (typeof optionsOrCode === "object") {
- code = codeOrLanguageName;
- ignoreIllegals = optionsOrCode.ignoreIllegals;
- languageName = optionsOrCode.language;
- // continuation not supported at all via the new API
- // eslint-disable-next-line no-undefined
- continuation = undefined;
- } else {
- // old API
- deprecated("10.7.0", "highlight(lang, code, ...args) has been deprecated.");
- deprecated("10.7.0", "Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277");
- languageName = codeOrLanguageName;
- code = optionsOrCode;
- }
-
- // https://github.com/highlightjs/highlight.js/issues/3149
- // eslint-disable-next-line no-undefined
- if (ignoreIllegals === undefined) { ignoreIllegals = true; }
-
- /** @type {BeforeHighlightContext} */
- const context = {
- code,
- language: languageName
- };
- // the plugin can change the desired language or the code to be highlighted
- // just be changing the object it was passed
- fire("before:highlight", context);
-
- // a before plugin can usurp the result completely by providing it's own
- // in which case we don't even need to call highlight
- const result = context.result
- ? context.result
- : _highlight(context.language, context.code, ignoreIllegals, continuation);
-
- result.code = context.code;
- // the plugin can change anything in result to suite it
- fire("after:highlight", result);
-
- return result;
- }
-
- /**
- * private highlight that's used internally and does not fire callbacks
- *
- * @param {string} languageName - the language to use for highlighting
- * @param {string} codeToHighlight - the code to highlight
- * @param {boolean?} [ignoreIllegals] - whether to ignore illegal matches, default is to bail
- * @param {CompiledMode?} [continuation] - current continuation mode, if any
- * @returns {HighlightResult} - result of the highlight operation
- */
- function _highlight(languageName, codeToHighlight, ignoreIllegals, continuation) {
- const keywordHits = Object.create(null);
-
- /**
- * Return keyword data if a match is a keyword
- * @param {CompiledMode} mode - current mode
- * @param {string} matchText - the textual match
- * @returns {KeywordData | false}
- */
- function keywordData(mode, matchText) {
- return mode.keywords[matchText];
- }
-
- function processKeywords() {
- if (!top.keywords) {
- emitter.addText(modeBuffer);
- return;
- }
-
- let lastIndex = 0;
- top.keywordPatternRe.lastIndex = 0;
- let match = top.keywordPatternRe.exec(modeBuffer);
- let buf = "";
-
- while (match) {
- buf += modeBuffer.substring(lastIndex, match.index);
- const word = language.case_insensitive ? match[0].toLowerCase() : match[0];
- const data = keywordData(top, word);
- if (data) {
- const [kind, keywordRelevance] = data;
- emitter.addText(buf);
- buf = "";
-
- keywordHits[word] = (keywordHits[word] || 0) + 1;
- if (keywordHits[word] <= MAX_KEYWORD_HITS) relevance += keywordRelevance;
- if (kind.startsWith("_")) {
- // _ implied for relevance only, do not highlight
- // by applying a class name
- buf += match[0];
- } else {
- const cssClass = language.classNameAliases[kind] || kind;
- emitter.addKeyword(match[0], cssClass);
- }
- } else {
- buf += match[0];
- }
- lastIndex = top.keywordPatternRe.lastIndex;
- match = top.keywordPatternRe.exec(modeBuffer);
- }
- buf += modeBuffer.substr(lastIndex);
- emitter.addText(buf);
- }
-
- function processSubLanguage() {
- if (modeBuffer === "") return;
- /** @type HighlightResult */
- let result = null;
-
- if (typeof top.subLanguage === 'string') {
- if (!languages[top.subLanguage]) {
- emitter.addText(modeBuffer);
- return;
- }
- result = _highlight(top.subLanguage, modeBuffer, true, continuations[top.subLanguage]);
- continuations[top.subLanguage] = /** @type {CompiledMode} */ (result._top);
- } else {
- result = highlightAuto(modeBuffer, top.subLanguage.length ? top.subLanguage : null);
- }
-
- // Counting embedded language score towards the host language may be disabled
- // with zeroing the containing mode relevance. Use case in point is Markdown that
- // allows XML everywhere and makes every XML snippet to have a much larger Markdown
- // score.
- if (top.relevance > 0) {
- relevance += result.relevance;
- }
- emitter.addSublanguage(result._emitter, result.language);
- }
-
- function processBuffer() {
- if (top.subLanguage != null) {
- processSubLanguage();
- } else {
- processKeywords();
- }
- modeBuffer = '';
- }
-
- /**
- * @param {CompiledMode} mode
- * @param {RegExpMatchArray} match
- */
- function emitMultiClass(scope, match) {
- let i = 1;
- // eslint-disable-next-line no-undefined
- while (match[i] !== undefined) {
- if (!scope._emit[i]) { i++; continue; }
- const klass = language.classNameAliases[scope[i]] || scope[i];
- const text = match[i];
- if (klass) {
- emitter.addKeyword(text, klass);
- } else {
- modeBuffer = text;
- processKeywords();
- modeBuffer = "";
- }
- i++;
- }
- }
-
- /**
- * @param {CompiledMode} mode - new mode to start
- * @param {RegExpMatchArray} match
- */
- function startNewMode(mode, match) {
- if (mode.scope && typeof mode.scope === "string") {
- emitter.openNode(language.classNameAliases[mode.scope] || mode.scope);
- }
- if (mode.beginScope) {
- // beginScope just wraps the begin match itself in a scope
- if (mode.beginScope._wrap) {
- emitter.addKeyword(modeBuffer, language.classNameAliases[mode.beginScope._wrap] || mode.beginScope._wrap);
- modeBuffer = "";
- } else if (mode.beginScope._multi) {
- // at this point modeBuffer should just be the match
- emitMultiClass(mode.beginScope, match);
- modeBuffer = "";
- }
- }
-
- top = Object.create(mode, { parent: { value: top } });
- return top;
- }
-
- /**
- * @param {CompiledMode } mode - the mode to potentially end
- * @param {RegExpMatchArray} match - the latest match
- * @param {string} matchPlusRemainder - match plus remainder of content
- * @returns {CompiledMode | void} - the next mode, or if void continue on in current mode
- */
- function endOfMode(mode, match, matchPlusRemainder) {
- let matched = startsWith(mode.endRe, matchPlusRemainder);
-
- if (matched) {
- if (mode["on:end"]) {
- const resp = new Response(mode);
- mode["on:end"](match, resp);
- if (resp.isMatchIgnored) matched = false;
- }
-
- if (matched) {
- while (mode.endsParent && mode.parent) {
- mode = mode.parent;
- }
- return mode;
- }
- }
- // even if on:end fires an `ignore` it's still possible
- // that we might trigger the end node because of a parent mode
- if (mode.endsWithParent) {
- return endOfMode(mode.parent, match, matchPlusRemainder);
- }
- }
-
- /**
- * Handle matching but then ignoring a sequence of text
- *
- * @param {string} lexeme - string containing full match text
- */
- function doIgnore(lexeme) {
- if (top.matcher.regexIndex === 0) {
- // no more regexes to potentially match here, so we move the cursor forward one
- // space
- modeBuffer += lexeme[0];
- return 1;
- } else {
- // no need to move the cursor, we still have additional regexes to try and
- // match at this very spot
- resumeScanAtSamePosition = true;
- return 0;
- }
- }
-
- /**
- * Handle the start of a new potential mode match
- *
- * @param {EnhancedMatch} match - the current match
- * @returns {number} how far to advance the parse cursor
- */
- function doBeginMatch(match) {
- const lexeme = match[0];
- const newMode = match.rule;
-
- const resp = new Response(newMode);
- // first internal before callbacks, then the public ones
- const beforeCallbacks = [newMode.__beforeBegin, newMode["on:begin"]];
- for (const cb of beforeCallbacks) {
- if (!cb) continue;
- cb(match, resp);
- if (resp.isMatchIgnored) return doIgnore(lexeme);
- }
-
- if (newMode.skip) {
- modeBuffer += lexeme;
- } else {
- if (newMode.excludeBegin) {
- modeBuffer += lexeme;
- }
- processBuffer();
- if (!newMode.returnBegin && !newMode.excludeBegin) {
- modeBuffer = lexeme;
- }
- }
- startNewMode(newMode, match);
- return newMode.returnBegin ? 0 : lexeme.length;
- }
-
- /**
- * Handle the potential end of mode
- *
- * @param {RegExpMatchArray} match - the current match
- */
- function doEndMatch(match) {
- const lexeme = match[0];
- const matchPlusRemainder = codeToHighlight.substr(match.index);
-
- const endMode = endOfMode(top, match, matchPlusRemainder);
- if (!endMode) { return NO_MATCH; }
-
- const origin = top;
- if (top.endScope && top.endScope._wrap) {
- processBuffer();
- emitter.addKeyword(lexeme, top.endScope._wrap);
- } else if (top.endScope && top.endScope._multi) {
- processBuffer();
- emitMultiClass(top.endScope, match);
- } else if (origin.skip) {
- modeBuffer += lexeme;
- } else {
- if (!(origin.returnEnd || origin.excludeEnd)) {
- modeBuffer += lexeme;
- }
- processBuffer();
- if (origin.excludeEnd) {
- modeBuffer = lexeme;
- }
- }
- do {
- if (top.scope && !top.isMultiClass) {
- emitter.closeNode();
- }
- if (!top.skip && !top.subLanguage) {
- relevance += top.relevance;
- }
- top = top.parent;
- } while (top !== endMode.parent);
- if (endMode.starts) {
- startNewMode(endMode.starts, match);
- }
- return origin.returnEnd ? 0 : lexeme.length;
- }
-
- function processContinuations() {
- const list = [];
- for (let current = top; current !== language; current = current.parent) {
- if (current.scope) {
- list.unshift(current.scope);
- }
- }
- list.forEach(item => emitter.openNode(item));
- }
-
- /** @type {{type?: MatchType, index?: number, rule?: Mode}}} */
- let lastMatch = {};
-
- /**
- * Process an individual match
- *
- * @param {string} textBeforeMatch - text preceding the match (since the last match)
- * @param {EnhancedMatch} [match] - the match itself
- */
- function processLexeme(textBeforeMatch, match) {
- const lexeme = match && match[0];
-
- // add non-matched text to the current mode buffer
- modeBuffer += textBeforeMatch;
-
- if (lexeme == null) {
- processBuffer();
- return 0;
- }
-
- // we've found a 0 width match and we're stuck, so we need to advance
- // this happens when we have badly behaved rules that have optional matchers to the degree that
- // sometimes they can end up matching nothing at all
- // Ref: https://github.com/highlightjs/highlight.js/issues/2140
- if (lastMatch.type === "begin" && match.type === "end" && lastMatch.index === match.index && lexeme === "") {
- // spit the "skipped" character that our regex choked on back into the output sequence
- modeBuffer += codeToHighlight.slice(match.index, match.index + 1);
- if (!SAFE_MODE) {
- /** @type {AnnotatedError} */
- const err = new Error(`0 width match regex (${languageName})`);
- err.languageName = languageName;
- err.badRule = lastMatch.rule;
- throw err;
- }
- return 1;
- }
- lastMatch = match;
-
- if (match.type === "begin") {
- return doBeginMatch(match);
- } else if (match.type === "illegal" && !ignoreIllegals) {
- // illegal match, we do not continue processing
- /** @type {AnnotatedError} */
- const err = new Error('Illegal lexeme "' + lexeme + '" for mode "' + (top.scope || '') + '"');
- err.mode = top;
- throw err;
- } else if (match.type === "end") {
- const processed = doEndMatch(match);
- if (processed !== NO_MATCH) {
- return processed;
- }
- }
-
- // edge case for when illegal matches $ (end of line) which is technically
- // a 0 width match but not a begin/end match so it's not caught by the
- // first handler (when ignoreIllegals is true)
- if (match.type === "illegal" && lexeme === "") {
- // advance so we aren't stuck in an infinite loop
- return 1;
- }
-
- // infinite loops are BAD, this is a last ditch catch all. if we have a
- // decent number of iterations yet our index (cursor position in our
- // parsing) still 3x behind our index then something is very wrong
- // so we bail
- if (iterations > 100000 && iterations > match.index * 3) {
- const err = new Error('potential infinite loop, way more iterations than matches');
- throw err;
- }
-
- /*
- Why might be find ourselves here? An potential end match that was
- triggered but could not be completed. IE, `doEndMatch` returned NO_MATCH.
- (this could be because a callback requests the match be ignored, etc)
-
- This causes no real harm other than stopping a few times too many.
- */
-
- modeBuffer += lexeme;
- return lexeme.length;
- }
-
- const language = getLanguage(languageName);
- if (!language) {
- error(LANGUAGE_NOT_FOUND.replace("{}", languageName));
- throw new Error('Unknown language: "' + languageName + '"');
- }
-
- const md = compileLanguage(language);
- let result = '';
- /** @type {CompiledMode} */
- let top = continuation || md;
- /** @type Record */
- const continuations = {}; // keep continuations for sub-languages
- const emitter = new options.__emitter(options);
- processContinuations();
- let modeBuffer = '';
- let relevance = 0;
- let index = 0;
- let iterations = 0;
- let resumeScanAtSamePosition = false;
-
- try {
- top.matcher.considerAll();
-
- for (; ;) {
- iterations++;
- if (resumeScanAtSamePosition) {
- // only regexes not matched previously will now be
- // considered for a potential match
- resumeScanAtSamePosition = false;
- } else {
- top.matcher.considerAll();
- }
- top.matcher.lastIndex = index;
-
- const match = top.matcher.exec(codeToHighlight);
- // console.log("match", match[0], match.rule && match.rule.begin)
-
- if (!match) break;
-
- const beforeMatch = codeToHighlight.substring(index, match.index);
- const processedCount = processLexeme(beforeMatch, match);
- index = match.index + processedCount;
- }
- processLexeme(codeToHighlight.substr(index));
- emitter.closeAllNodes();
- emitter.finalize();
- result = emitter.toHTML();
-
- return {
- language: languageName,
- value: result,
- relevance: relevance,
- illegal: false,
- _emitter: emitter,
- _top: top
- };
- } catch (err) {
- if (err.message && err.message.includes('Illegal')) {
- return {
- language: languageName,
- value: escape(codeToHighlight),
- illegal: true,
- relevance: 0,
- _illegalBy: {
- message: err.message,
- index: index,
- context: codeToHighlight.slice(index - 100, index + 100),
- mode: err.mode,
- resultSoFar: result
- },
- _emitter: emitter
- };
- } else if (SAFE_MODE) {
- return {
- language: languageName,
- value: escape(codeToHighlight),
- illegal: false,
- relevance: 0,
- errorRaised: err,
- _emitter: emitter,
- _top: top
- };
- } else {
- throw err;
- }
- }
- }
-
- /**
- * returns a valid highlight result, without actually doing any actual work,
- * auto highlight starts with this and it's possible for small snippets that
- * auto-detection may not find a better match
- * @param {string} code
- * @returns {HighlightResult}
- */
- function justTextHighlightResult(code) {
- const result = {
- value: escape(code),
- illegal: false,
- relevance: 0,
- _top: PLAINTEXT_LANGUAGE,
- _emitter: new options.__emitter(options)
- };
- result._emitter.addText(code);
- return result;
- }
-
- /**
- Highlighting with language detection. Accepts a string with the code to
- highlight. Returns an object with the following properties:
-
- - language (detected language)
- - relevance (int)
- - value (an HTML string with highlighting markup)
- - secondBest (object with the same structure for second-best heuristically
- detected language, may be absent)
-
- @param {string} code
- @param {Array} [languageSubset]
- @returns {AutoHighlightResult}
- */
- function highlightAuto(code, languageSubset) {
- languageSubset = languageSubset || options.languages || Object.keys(languages);
- const plaintext = justTextHighlightResult(code);
-
- const results = languageSubset.filter(getLanguage).filter(autoDetection).map(name =>
- _highlight(name, code, false)
- );
- results.unshift(plaintext); // plaintext is always an option
-
- const sorted = results.sort((a, b) => {
- // sort base on relevance
- if (a.relevance !== b.relevance) return b.relevance - a.relevance;
-
- // always award the tie to the base language
- // ie if C++ and Arduino are tied, it's more likely to be C++
- if (a.language && b.language) {
- if (getLanguage(a.language).supersetOf === b.language) {
- return 1;
- } else if (getLanguage(b.language).supersetOf === a.language) {
- return -1;
- }
- }
-
- // otherwise say they are equal, which has the effect of sorting on
- // relevance while preserving the original ordering - which is how ties
- // have historically been settled, ie the language that comes first always
- // wins in the case of a tie
- return 0;
- });
-
- const [best, secondBest] = sorted;
-
- /** @type {AutoHighlightResult} */
- const result = best;
- result.secondBest = secondBest;
-
- return result;
- }
-
- /**
- * Builds new class name for block given the language name
- *
- * @param {HTMLElement} element
- * @param {string} [currentLang]
- * @param {string} [resultLang]
- */
- function updateClassName(element, currentLang, resultLang) {
- const language = (currentLang && aliases[currentLang]) || resultLang;
-
- element.classList.add("hljs");
- element.classList.add(`language-${language}`);
- }
-
- /**
- * Applies highlighting to a DOM node containing code.
- *
- * @param {HighlightedHTMLElement} element - the HTML element to highlight
- */
- function highlightElement(element) {
- /** @type HTMLElement */
- let node = null;
- const language = blockLanguage(element);
-
- if (shouldNotHighlight(language)) return;
-
- fire("before:highlightElement",
- { el: element, language: language });
-
- // we should be all text, no child nodes
- if (!options.ignoreUnescapedHTML && element.children.length > 0) {
- console.warn("One of your code blocks includes unescaped HTML. This is a potentially serious security risk.");
- console.warn("https://github.com/highlightjs/highlight.js/issues/2886");
- console.warn(element);
- }
-
- node = element;
- const text = node.textContent;
- const result = language ? highlight(text, { language, ignoreIllegals: true }) : highlightAuto(text);
-
- fire("after:highlightElement", { el: element, result, text });
-
- element.innerHTML = result.value;
- updateClassName(element, language, result.language);
- element.result = {
- language: result.language,
- // TODO: remove with version 11.0
- re: result.relevance,
- relevance: result.relevance
- };
- if (result.secondBest) {
- element.secondBest = {
- language: result.secondBest.language,
- relevance: result.secondBest.relevance
- };
- }
- }
-
- /**
- * Updates highlight.js global options with the passed options
- *
- * @param {Partial} userOptions
- */
- function configure(userOptions) {
- options = inherit(options, userOptions);
- }
-
- // TODO: remove v12, deprecated
- const initHighlighting = () => {
- highlightAll();
- deprecated("10.6.0", "initHighlighting() deprecated. Use highlightAll() now.");
- };
-
- // TODO: remove v12, deprecated
- function initHighlightingOnLoad() {
- highlightAll();
- deprecated("10.6.0", "initHighlightingOnLoad() deprecated. Use highlightAll() now.");
- }
-
- let wantsHighlight = false;
-
- /**
- * auto-highlights all pre>code elements on the page
- */
- function highlightAll() {
- // if we are called too early in the loading process
- if (document.readyState === "loading") {
- wantsHighlight = true;
- return;
- }
-
- const blocks = document.querySelectorAll(options.cssSelector);
- blocks.forEach(highlightElement);
- }
-
- function boot() {
- // if a highlight was requested before DOM was loaded, do now
- if (wantsHighlight) highlightAll();
- }
-
- // make sure we are in the browser environment
- if (typeof window !== 'undefined' && window.addEventListener) {
- window.addEventListener('DOMContentLoaded', boot, false);
- }
-
- /**
- * Register a language grammar module
- *
- * @param {string} languageName
- * @param {LanguageFn} languageDefinition
- */
- function registerLanguage(languageName, languageDefinition) {
- let lang = null;
- try {
- lang = languageDefinition(hljs);
- } catch (error$1) {
- error("Language definition for '{}' could not be registered.".replace("{}", languageName));
- // hard or soft error
- if (!SAFE_MODE) { throw error$1; } else { error(error$1); }
- // languages that have serious errors are replaced with essentially a
- // "plaintext" stand-in so that the code blocks will still get normal
- // css classes applied to them - and one bad language won't break the
- // entire highlighter
- lang = PLAINTEXT_LANGUAGE;
- }
- // give it a temporary name if it doesn't have one in the meta-data
- if (!lang.name) lang.name = languageName;
- languages[languageName] = lang;
- lang.rawDefinition = languageDefinition.bind(null, hljs);
-
- if (lang.aliases) {
- registerAliases(lang.aliases, { languageName });
- }
- }
-
- /**
- * Remove a language grammar module
- *
- * @param {string} languageName
- */
- function unregisterLanguage(languageName) {
- delete languages[languageName];
- for (const alias of Object.keys(aliases)) {
- if (aliases[alias] === languageName) {
- delete aliases[alias];
- }
- }
- }
-
- /**
- * @returns {string[]} List of language internal names
- */
- function listLanguages() {
- return Object.keys(languages);
- }
-
- /**
- * @param {string} name - name of the language to retrieve
- * @returns {Language | undefined}
- */
- function getLanguage(name) {
- name = (name || '').toLowerCase();
- return languages[name] || languages[aliases[name]];
- }
-
- /**
- *
- * @param {string|string[]} aliasList - single alias or list of aliases
- * @param {{languageName: string}} opts
- */
- function registerAliases(aliasList, { languageName }) {
- if (typeof aliasList === 'string') {
- aliasList = [aliasList];
- }
- aliasList.forEach(alias => { aliases[alias.toLowerCase()] = languageName; });
- }
-
- /**
- * Determines if a given language has auto-detection enabled
- * @param {string} name - name of the language
- */
- function autoDetection(name) {
- const lang = getLanguage(name);
- return lang && !lang.disableAutodetect;
- }
-
- /**
- * Upgrades the old highlightBlock plugins to the new
- * highlightElement API
- * @param {HLJSPlugin} plugin
- */
- function upgradePluginAPI(plugin) {
- // TODO: remove with v12
- if (plugin["before:highlightBlock"] && !plugin["before:highlightElement"]) {
- plugin["before:highlightElement"] = (data) => {
- plugin["before:highlightBlock"](
- Object.assign({ block: data.el }, data)
- );
- };
- }
- if (plugin["after:highlightBlock"] && !plugin["after:highlightElement"]) {
- plugin["after:highlightElement"] = (data) => {
- plugin["after:highlightBlock"](
- Object.assign({ block: data.el }, data)
- );
- };
- }
- }
-
- /**
- * @param {HLJSPlugin} plugin
- */
- function addPlugin(plugin) {
- upgradePluginAPI(plugin);
- plugins.push(plugin);
- }
-
- /**
- *
- * @param {PluginEvent} event
- * @param {any} args
- */
- function fire(event, args) {
- const cb = event;
- plugins.forEach(function (plugin) {
- if (plugin[cb]) {
- plugin[cb](args);
- }
- });
- }
-
- /**
- *
- * @param {HighlightedHTMLElement} el
- */
- function deprecateHighlightBlock(el) {
- deprecated("10.7.0", "highlightBlock will be removed entirely in v12.0");
- deprecated("10.7.0", "Please use highlightElement now.");
-
- return highlightElement(el);
- }
-
- /* Interface definition */
- Object.assign(hljs, {
- highlight,
- highlightAuto,
- highlightAll,
- highlightElement,
- // TODO: Remove with v12 API
- highlightBlock: deprecateHighlightBlock,
- configure,
- initHighlighting,
- initHighlightingOnLoad,
- registerLanguage,
- unregisterLanguage,
- listLanguages,
- getLanguage,
- registerAliases,
- autoDetection,
- inherit,
- addPlugin
- });
-
- hljs.debugMode = function () { SAFE_MODE = false; };
- hljs.safeMode = function () { SAFE_MODE = true; };
- hljs.versionString = version;
-
- for (const key in MODES$1) {
- // @ts-ignore
- if (typeof MODES$1[key] === "object") {
- // @ts-ignore
- deepFreeze$1(MODES$1[key]);
- }
- }
-
- // merge all the modes/regexes into our main object
- Object.assign(hljs, MODES$1);
-
- return hljs;
- };
-
- // export an "instance" of the highlighter
- var HighlightJS = HLJS({});
-
- /*
- Language: Bash
- Author: vah
- Contributrors: Benjamin Pannell
- Website: https://www.gnu.org/software/bash/
- Category: common
- */
-
- /** @type LanguageFn */
- function bash(hljs) {
- const VAR = {};
- const BRACED_VAR = {
- begin: /\$\{/,
- end: /\}/,
- contains: [
- "self",
- {
- begin: /:-/,
- contains: [VAR]
- } // default values
- ]
- };
- Object.assign(VAR, {
- className: 'variable',
- variants: [
- {
- begin: concat(/\$[\w\d#@][\w\d_]*/,
- // negative look-ahead tries to avoid matching patterns that are not
- // Perl at all like $ident$, @ident@, etc.
- `(?![\\w\\d])(?![$])`)
- },
- BRACED_VAR
- ]
- });
-
- const SUBST = {
- className: 'subst',
- begin: /\$\(/, end: /\)/,
- contains: [hljs.BACKSLASH_ESCAPE]
- };
- const HERE_DOC = {
- begin: /<<-?\s*(?=\w+)/,
- starts: {
- contains: [
- hljs.END_SAME_AS_BEGIN({
- begin: /(\w+)/,
- end: /(\w+)/,
- className: 'string'
- })
- ]
- }
- };
- const QUOTE_STRING = {
- className: 'string',
- begin: /"/, end: /"/,
- contains: [
- hljs.BACKSLASH_ESCAPE,
- VAR,
- SUBST
- ]
- };
- SUBST.contains.push(QUOTE_STRING);
- const ESCAPED_QUOTE = {
- className: '',
- begin: /\\"/
-
- };
- const APOS_STRING = {
- className: 'string',
- begin: /'/, end: /'/
- };
- const ARITHMETIC = {
- begin: /\$\(\(/,
- end: /\)\)/,
- contains: [
- { begin: /\d+#[0-9a-f]+/, className: "number" },
- hljs.NUMBER_MODE,
- VAR
- ]
- };
- const SH_LIKE_SHELLS = [
- "fish",
- "bash",
- "zsh",
- "sh",
- "csh",
- "ksh",
- "tcsh",
- "dash",
- "scsh",
- ];
- const KNOWN_SHEBANG = hljs.SHEBANG({
- binary: `(${SH_LIKE_SHELLS.join("|")})`,
- relevance: 10
- });
- const FUNCTION = {
- className: 'function',
- begin: /\w[\w\d_]*\s*\(\s*\)\s*\{/,
- returnBegin: true,
- contains: [hljs.inherit(hljs.TITLE_MODE, { begin: /\w[\w\d_]*/ })],
- relevance: 0
- };
-
- const KEYWORDS = [
- "if",
- "then",
- "else",
- "elif",
- "fi",
- "for",
- "while",
- "in",
- "do",
- "done",
- "case",
- "esac",
- "function"
- ];
-
- const LITERALS = [
- "true",
- "false"
- ];
-
- return {
- name: 'Bash',
- aliases: ['sh'],
- keywords: {
- $pattern: /\b[a-z._-]+\b/,
- keyword: KEYWORDS,
- literal: LITERALS,
- built_in:
- // Shell built-ins
- // http://www.gnu.org/software/bash/manual/html_node/Shell-Builtin-Commands.html
- 'break cd continue eval exec exit export getopts hash pwd readonly return shift test times ' +
- 'trap umask unset ' +
- // Bash built-ins
- 'alias bind builtin caller command declare echo enable help let local logout mapfile printf ' +
- 'read readarray source type typeset ulimit unalias ' +
- // Shell modifiers
- 'set shopt ' +
- // Zsh built-ins
- 'autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles ' +
- 'compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate ' +
- 'fc fg float functions getcap getln history integer jobs kill limit log noglob popd print ' +
- 'pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit ' +
- 'unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof ' +
- 'zpty zregexparse zsocket zstyle ztcp'
- },
- contains: [
- KNOWN_SHEBANG, // to catch known shells and boost relevancy
- hljs.SHEBANG(), // to catch unknown shells but still highlight the shebang
- FUNCTION,
- ARITHMETIC,
- hljs.HASH_COMMENT_MODE,
- HERE_DOC,
- QUOTE_STRING,
- ESCAPED_QUOTE,
- APOS_STRING,
- VAR
- ]
- };
- }
-
-
- const MODES = (hljs) => {
- return {
- IMPORTANT: {
- scope: 'meta',
- begin: '!important'
- },
- HEXCOLOR: {
- scope: 'number',
- begin: '#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})'
- },
- ATTRIBUTE_SELECTOR_MODE: {
- scope: 'selector-attr',
- begin: /\[/,
- end: /\]/,
- illegal: '$',
- contains: [
- hljs.APOS_STRING_MODE,
- hljs.QUOTE_STRING_MODE
- ]
- },
- CSS_NUMBER_MODE: {
- scope: 'number',
- begin: hljs.NUMBER_RE + '(' +
- '%|em|ex|ch|rem' +
- '|vw|vh|vmin|vmax' +
- '|cm|mm|in|pt|pc|px' +
- '|deg|grad|rad|turn' +
- '|s|ms' +
- '|Hz|kHz' +
- '|dpi|dpcm|dppx' +
- ')?',
- relevance: 0
- }
- };
- };
-
- const TAGS = [
- 'a',
- 'abbr',
- 'address',
- 'article',
- 'aside',
- 'audio',
- 'b',
- 'blockquote',
- 'body',
- 'button',
- 'canvas',
- 'caption',
- 'cite',
- 'code',
- 'dd',
- 'del',
- 'details',
- 'dfn',
- 'div',
- 'dl',
- 'dt',
- 'em',
- 'fieldset',
- 'figcaption',
- 'figure',
- 'footer',
- 'form',
- 'h1',
- 'h2',
- 'h3',
- 'h4',
- 'h5',
- 'h6',
- 'header',
- 'hgroup',
- 'html',
- 'i',
- 'iframe',
- 'img',
- 'input',
- 'ins',
- 'kbd',
- 'label',
- 'legend',
- 'li',
- 'main',
- 'mark',
- 'menu',
- 'nav',
- 'object',
- 'ol',
- 'p',
- 'q',
- 'quote',
- 'samp',
- 'section',
- 'span',
- 'strong',
- 'summary',
- 'sup',
- 'table',
- 'tbody',
- 'td',
- 'textarea',
- 'tfoot',
- 'th',
- 'thead',
- 'time',
- 'tr',
- 'ul',
- 'var',
- 'video'
- ];
-
- const MEDIA_FEATURES = [
- 'any-hover',
- 'any-pointer',
- 'aspect-ratio',
- 'color',
- 'color-gamut',
- 'color-index',
- 'device-aspect-ratio',
- 'device-height',
- 'device-width',
- 'display-mode',
- 'forced-colors',
- 'grid',
- 'height',
- 'hover',
- 'inverted-colors',
- 'monochrome',
- 'orientation',
- 'overflow-block',
- 'overflow-inline',
- 'pointer',
- 'prefers-color-scheme',
- 'prefers-contrast',
- 'prefers-reduced-motion',
- 'prefers-reduced-transparency',
- 'resolution',
- 'scan',
- 'scripting',
- 'update',
- 'width',
- // TODO: find a better solution?
- 'min-width',
- 'max-width',
- 'min-height',
- 'max-height'
- ];
-
- // https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes
- const PSEUDO_CLASSES = [
- 'active',
- 'any-link',
- 'blank',
- 'checked',
- 'current',
- 'default',
- 'defined',
- 'dir', // dir()
- 'disabled',
- 'drop',
- 'empty',
- 'enabled',
- 'first',
- 'first-child',
- 'first-of-type',
- 'fullscreen',
- 'future',
- 'focus',
- 'focus-visible',
- 'focus-within',
- 'has', // has()
- 'host', // host or host()
- 'host-context', // host-context()
- 'hover',
- 'indeterminate',
- 'in-range',
- 'invalid',
- 'is', // is()
- 'lang', // lang()
- 'last-child',
- 'last-of-type',
- 'left',
- 'link',
- 'local-link',
- 'not', // not()
- 'nth-child', // nth-child()
- 'nth-col', // nth-col()
- 'nth-last-child', // nth-last-child()
- 'nth-last-col', // nth-last-col()
- 'nth-last-of-type', //nth-last-of-type()
- 'nth-of-type', //nth-of-type()
- 'only-child',
- 'only-of-type',
- 'optional',
- 'out-of-range',
- 'past',
- 'placeholder-shown',
- 'read-only',
- 'read-write',
- 'required',
- 'right',
- 'root',
- 'scope',
- 'target',
- 'target-within',
- 'user-invalid',
- 'valid',
- 'visited',
- 'where' // where()
- ];
-
- // https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-elements
- const PSEUDO_ELEMENTS = [
- 'after',
- 'backdrop',
- 'before',
- 'cue',
- 'cue-region',
- 'first-letter',
- 'first-line',
- 'grammar-error',
- 'marker',
- 'part',
- 'placeholder',
- 'selection',
- 'slotted',
- 'spelling-error'
- ];
-
- const ATTRIBUTES = [
- 'align-content',
- 'align-items',
- 'align-self',
- 'animation',
- 'animation-delay',
- 'animation-direction',
- 'animation-duration',
- 'animation-fill-mode',
- 'animation-iteration-count',
- 'animation-name',
- 'animation-play-state',
- 'animation-timing-function',
- 'auto',
- 'backface-visibility',
- 'background',
- 'background-attachment',
- 'background-clip',
- 'background-color',
- 'background-image',
- 'background-origin',
- 'background-position',
- 'background-repeat',
- 'background-size',
- 'border',
- 'border-bottom',
- 'border-bottom-color',
- 'border-bottom-left-radius',
- 'border-bottom-right-radius',
- 'border-bottom-style',
- 'border-bottom-width',
- 'border-collapse',
- 'border-color',
- 'border-image',
- 'border-image-outset',
- 'border-image-repeat',
- 'border-image-slice',
- 'border-image-source',
- 'border-image-width',
- 'border-left',
- 'border-left-color',
- 'border-left-style',
- 'border-left-width',
- 'border-radius',
- 'border-right',
- 'border-right-color',
- 'border-right-style',
- 'border-right-width',
- 'border-spacing',
- 'border-style',
- 'border-top',
- 'border-top-color',
- 'border-top-left-radius',
- 'border-top-right-radius',
- 'border-top-style',
- 'border-top-width',
- 'border-width',
- 'bottom',
- 'box-decoration-break',
- 'box-shadow',
- 'box-sizing',
- 'break-after',
- 'break-before',
- 'break-inside',
- 'caption-side',
- 'clear',
- 'clip',
- 'clip-path',
- 'color',
- 'column-count',
- 'column-fill',
- 'column-gap',
- 'column-rule',
- 'column-rule-color',
- 'column-rule-style',
- 'column-rule-width',
- 'column-span',
- 'column-width',
- 'columns',
- 'content',
- 'counter-increment',
- 'counter-reset',
- 'cursor',
- 'direction',
- 'display',
- 'empty-cells',
- 'filter',
- 'flex',
- 'flex-basis',
- 'flex-direction',
- 'flex-flow',
- 'flex-grow',
- 'flex-shrink',
- 'flex-wrap',
- 'float',
- 'font',
- 'font-display',
- 'font-family',
- 'font-feature-settings',
- 'font-kerning',
- 'font-language-override',
- 'font-size',
- 'font-size-adjust',
- 'font-smoothing',
- 'font-stretch',
- 'font-style',
- 'font-variant',
- 'font-variant-ligatures',
- 'font-variation-settings',
- 'font-weight',
- 'height',
- 'hyphens',
- 'icon',
- 'image-orientation',
- 'image-rendering',
- 'image-resolution',
- 'ime-mode',
- 'inherit',
- 'initial',
- 'justify-content',
- 'left',
- 'letter-spacing',
- 'line-height',
- 'list-style',
- 'list-style-image',
- 'list-style-position',
- 'list-style-type',
- 'margin',
- 'margin-bottom',
- 'margin-left',
- 'margin-right',
- 'margin-top',
- 'marks',
- 'mask',
- 'max-height',
- 'max-width',
- 'min-height',
- 'min-width',
- 'nav-down',
- 'nav-index',
- 'nav-left',
- 'nav-right',
- 'nav-up',
- 'none',
- 'normal',
- 'object-fit',
- 'object-position',
- 'opacity',
- 'order',
- 'orphans',
- 'outline',
- 'outline-color',
- 'outline-offset',
- 'outline-style',
- 'outline-width',
- 'overflow',
- 'overflow-wrap',
- 'overflow-x',
- 'overflow-y',
- 'padding',
- 'padding-bottom',
- 'padding-left',
- 'padding-right',
- 'padding-top',
- 'page-break-after',
- 'page-break-before',
- 'page-break-inside',
- 'perspective',
- 'perspective-origin',
- 'pointer-events',
- 'position',
- 'quotes',
- 'resize',
- 'right',
- 'src', // @font-face
- 'tab-size',
- 'table-layout',
- 'text-align',
- 'text-align-last',
- 'text-decoration',
- 'text-decoration-color',
- 'text-decoration-line',
- 'text-decoration-style',
- 'text-indent',
- 'text-overflow',
- 'text-rendering',
- 'text-shadow',
- 'text-transform',
- 'text-underline-position',
- 'top',
- 'transform',
- 'transform-origin',
- 'transform-style',
- 'transition',
- 'transition-delay',
- 'transition-duration',
- 'transition-property',
- 'transition-timing-function',
- 'unicode-bidi',
- 'vertical-align',
- 'visibility',
- 'white-space',
- 'widows',
- 'width',
- 'word-break',
- 'word-spacing',
- 'word-wrap',
- 'z-index'
- // reverse makes sure longer attributes `font-weight` are matched fully
- // instead of getting false positives on say `font`
- ].reverse();
-
- // some grammars use them all as a single group
- const PSEUDO_SELECTORS = PSEUDO_CLASSES.concat(PSEUDO_ELEMENTS);
-
-
- // https://docs.oracle.com/javase/specs/jls/se15/html/jls-3.html#jls-3.10
- var decimalDigits = '[0-9](_*[0-9])*';
- var frac = `\\.(${decimalDigits})`;
- var hexDigits = '[0-9a-fA-F](_*[0-9a-fA-F])*';
- var NUMERIC = {
- className: 'number',
- variants: [
- // DecimalFloatingPointLiteral
- // including ExponentPart
- {
- begin: `(\\b(${decimalDigits})((${frac})|\\.)?|(${frac}))` +
- `[eE][+-]?(${decimalDigits})[fFdD]?\\b`
- },
- // excluding ExponentPart
- { begin: `\\b(${decimalDigits})((${frac})[fFdD]?\\b|\\.([fFdD]\\b)?)` },
- { begin: `(${frac})[fFdD]?\\b` },
- { begin: `\\b(${decimalDigits})[fFdD]\\b` },
-
- // HexadecimalFloatingPointLiteral
- {
- begin: `\\b0[xX]((${hexDigits})\\.?|(${hexDigits})?\\.(${hexDigits}))` +
- `[pP][+-]?(${decimalDigits})[fFdD]?\\b`
- },
-
- // DecimalIntegerLiteral
- { begin: '\\b(0|[1-9](_*[0-9])*)[lL]?\\b' },
-
- // HexIntegerLiteral
- { begin: `\\b0[xX](${hexDigits})[lL]?\\b` },
-
- // OctalIntegerLiteral
- { begin: '\\b0(_*[0-7])*[lL]?\\b' },
-
- // BinaryIntegerLiteral
- { begin: '\\b0[bB][01](_*[01])*[lL]?\\b' },
- ],
- relevance: 0
- };
-
-
- /**
- * Allows recursive regex expressions to a given depth
- *
- * ie: recurRegex("(abc~~~)", /~~~/g, 2) becomes:
- * (abc(abc(abc)))
- *
- * @param {string} re
- * @param {RegExp} substitution (should be a g mode regex)
- * @param {number} depth
- * @returns {string}``
- */
- function recurRegex(re, substitution, depth) {
- if (depth === -1) return "";
-
- return re.replace(substitution, _ => {
- return recurRegex(re, substitution, depth - 1);
- });
- }
-
- const IDENT_RE = '[A-Za-z$_][0-9A-Za-z$_]*';
- const KEYWORDS = [
- "as", // for exports
- "in",
- "of",
- "if",
- "for",
- "while",
- "finally",
- "var",
- "new",
- "function",
- "do",
- "return",
- "void",
- "else",
- "break",
- "catch",
- "instanceof",
- "with",
- "throw",
- "case",
- "default",
- "try",
- "switch",
- "continue",
- "typeof",
- "delete",
- "let",
- "yield",
- "const",
- "class",
- // JS handles these with a special rule
- // "get",
- // "set",
- "debugger",
- "async",
- "await",
- "static",
- "import",
- "from",
- "export",
- "extends"
- ];
- const LITERALS = [
- "true",
- "false",
- "null",
- "undefined",
- "NaN",
- "Infinity"
- ];
-
- const TYPES = [
- "Intl",
- "DataView",
- "Number",
- "Math",
- "Date",
- "String",
- "RegExp",
- "Object",
- "Function",
- "Boolean",
- "Error",
- "Symbol",
- "Set",
- "Map",
- "WeakSet",
- "WeakMap",
- "Proxy",
- "Reflect",
- "JSON",
- "Promise",
- "Float64Array",
- "Int16Array",
- "Int32Array",
- "Int8Array",
- "Uint16Array",
- "Uint32Array",
- "Float32Array",
- "Array",
- "Uint8Array",
- "Uint8ClampedArray",
- "ArrayBuffer",
- "BigInt64Array",
- "BigUint64Array",
- "BigInt"
- ];
-
- const ERROR_TYPES = [
- "EvalError",
- "InternalError",
- "RangeError",
- "ReferenceError",
- "SyntaxError",
- "TypeError",
- "URIError"
- ];
-
- const BUILT_IN_GLOBALS = [
- "setInterval",
- "setTimeout",
- "clearInterval",
- "clearTimeout",
-
- "require",
- "exports",
-
- "eval",
- "isFinite",
- "isNaN",
- "parseFloat",
- "parseInt",
- "decodeURI",
- "decodeURIComponent",
- "encodeURI",
- "encodeURIComponent",
- "escape",
- "unescape"
- ];
-
- const BUILT_IN_VARIABLES = [
- "arguments",
- "this",
- "super",
- "console",
- "window",
- "document",
- "localStorage",
- "module",
- "global" // Node.js
- ];
-
- const BUILT_INS = [].concat(
- BUILT_IN_GLOBALS,
- TYPES,
- ERROR_TYPES
- );
-
- /*
- Language: JavaScript
- Description: JavaScript (JS) is a lightweight, interpreted, or just-in-time compiled programming language with first-class functions.
- Category: common, scripting, web
- Website: https://developer.mozilla.org/en-US/docs/Web/JavaScript
- */
-
- /** @type LanguageFn */
- function javascript(hljs) {
- /**
- * Takes a string like " {
- const tag = "',
- end: ''
- };
- const XML_TAG = {
- begin: /<[A-Za-z0-9\\._:-]+/,
- end: /\/[A-Za-z0-9\\._:-]+>|\/>/,
- /**
- * @param {RegExpMatchArray} match
- * @param {CallbackResponse} response
- */
- isTrulyOpeningTag: (match, response) => {
- const afterMatchIndex = match[0].length + match.index;
- const nextChar = match.input[afterMatchIndex];
- // nested type?
- // HTML should not include another raw `<` inside a tag
- // But a type might: `>`, etc.
- if (nextChar === "<") {
- response.ignoreMatch();
- return;
- }
- //
- // This is now either a tag or a type.
- if (nextChar === ">") {
- // if we cannot find a matching closing tag, then we
- // will ignore it
- if (!hasClosingTag(match, { after: afterMatchIndex })) {
- response.ignoreMatch();
- }
- }
- }
- };
- const KEYWORDS$1 = {
- $pattern: IDENT_RE,
- keyword: KEYWORDS,
- literal: LITERALS,
- built_in: BUILT_INS,
- "variable.language": BUILT_IN_VARIABLES
- };
-
- // https://tc39.es/ecma262/#sec-literals-numeric-literals
- const decimalDigits = '[0-9](_?[0-9])*';
- const frac = `\\.(${decimalDigits})`;
- // DecimalIntegerLiteral, including Annex B NonOctalDecimalIntegerLiteral
- // https://tc39.es/ecma262/#sec-additional-syntax-numeric-literals
- const decimalInteger = `0|[1-9](_?[0-9])*|0[0-7]*[89][0-9]*`;
- const NUMBER = {
- className: 'number',
- variants: [
- // DecimalLiteral
- {
- begin: `(\\b(${decimalInteger})((${frac})|\\.)?|(${frac}))` +
- `[eE][+-]?(${decimalDigits})\\b`
- },
- { begin: `\\b(${decimalInteger})\\b((${frac})\\b|\\.)?|(${frac})\\b` },
-
- // DecimalBigIntegerLiteral
- { begin: `\\b(0|[1-9](_?[0-9])*)n\\b` },
-
- // NonDecimalIntegerLiteral
- { begin: "\\b0[xX][0-9a-fA-F](_?[0-9a-fA-F])*n?\\b" },
- { begin: "\\b0[bB][0-1](_?[0-1])*n?\\b" },
- { begin: "\\b0[oO][0-7](_?[0-7])*n?\\b" },
-
- // LegacyOctalIntegerLiteral (does not include underscore separators)
- // https://tc39.es/ecma262/#sec-additional-syntax-numeric-literals
- { begin: "\\b0[0-7]+n?\\b" },
- ],
- relevance: 0
- };
-
- const SUBST = {
- className: 'subst',
- begin: '\\$\\{',
- end: '\\}',
- keywords: KEYWORDS$1,
- contains: [] // defined later
- };
- const HTML_TEMPLATE = {
- begin: 'html`',
- end: '',
- starts: {
- end: '`',
- returnEnd: false,
- contains: [
- hljs.BACKSLASH_ESCAPE,
- SUBST
- ],
- subLanguage: 'xml'
- }
- };
- const CSS_TEMPLATE = {
- begin: 'css`',
- end: '',
- starts: {
- end: '`',
- returnEnd: false,
- contains: [
- hljs.BACKSLASH_ESCAPE,
- SUBST
- ],
- subLanguage: 'css'
- }
- };
- const TEMPLATE_STRING = {
- className: 'string',
- begin: '`',
- end: '`',
- contains: [
- hljs.BACKSLASH_ESCAPE,
- SUBST
- ]
- };
- const JSDOC_COMMENT = hljs.COMMENT(
- /\/\*\*(?!\/)/,
- '\\*/',
- {
- relevance: 0,
- contains: [
- {
- begin: '(?=@[A-Za-z]+)',
- relevance: 0,
- contains: [
- {
- className: 'doctag',
- begin: '@[A-Za-z]+'
- },
- {
- className: 'type',
- begin: '\\{',
- end: '\\}',
- excludeEnd: true,
- excludeBegin: true,
- relevance: 0
- },
- {
- className: 'variable',
- begin: IDENT_RE$1 + '(?=\\s*(-)|$)',
- endsParent: true,
- relevance: 0
- },
- // eat spaces (not newlines) so we can find
- // types or variables
- {
- begin: /(?=[^\n])\s/,
- relevance: 0
- }
- ]
- }
- ]
- }
- );
- const COMMENT = {
- className: "comment",
- variants: [
- JSDOC_COMMENT,
- hljs.C_BLOCK_COMMENT_MODE,
- hljs.C_LINE_COMMENT_MODE
- ]
- };
- const SUBST_INTERNALS = [
- hljs.APOS_STRING_MODE,
- hljs.QUOTE_STRING_MODE,
- HTML_TEMPLATE,
- CSS_TEMPLATE,
- TEMPLATE_STRING,
- NUMBER,
- hljs.REGEXP_MODE
- ];
- SUBST.contains = SUBST_INTERNALS
- .concat({
- // we need to pair up {} inside our subst to prevent
- // it from ending too early by matching another }
- begin: /\{/,
- end: /\}/,
- keywords: KEYWORDS$1,
- contains: [
- "self"
- ].concat(SUBST_INTERNALS)
- });
- const SUBST_AND_COMMENTS = [].concat(COMMENT, SUBST.contains);
- const PARAMS_CONTAINS = SUBST_AND_COMMENTS.concat([
- // eat recursive parens in sub expressions
- {
- begin: /\(/,
- end: /\)/,
- keywords: KEYWORDS$1,
- contains: ["self"].concat(SUBST_AND_COMMENTS)
- }
- ]);
- const PARAMS = {
- className: 'params',
- begin: /\(/,
- end: /\)/,
- excludeBegin: true,
- excludeEnd: true,
- keywords: KEYWORDS$1,
- contains: PARAMS_CONTAINS
- };
-
- // ES6 classes
- const CLASS_OR_EXTENDS = {
- variants: [
- {
- match: [
- /class/,
- /\s+/,
- IDENT_RE$1
- ],
- scope: {
- 1: "keyword",
- 3: "title.class"
- }
- },
- {
- match: [
- /extends/,
- /\s+/,
- concat(IDENT_RE$1, "(", concat(/\./, IDENT_RE$1), ")*")
- ],
- scope: {
- 1: "keyword",
- 3: "title.class.inherited"
- }
- }
- ]
- };
-
- const CLASS_REFERENCE = {
- relevance: 0,
- match: /\b[A-Z][a-z]+([A-Z][a-z]+)*/,
- className: "title.class",
- keywords: {
- _: [
- // se we still get relevance credit for JS library classes
- ...TYPES,
- ...ERROR_TYPES
- ]
- }
- };
-
- const USE_STRICT = {
- label: "use_strict",
- className: 'meta',
- relevance: 10,
- begin: /^\s*['"]use (strict|asm)['"]/
- };
-
- const FUNCTION_DEFINITION = {
- variants: [
- {
- match: [
- /function/,
- /\s+/,
- IDENT_RE$1,
- /(?=\s*\()/
- ]
- },
- // anonymous function
- {
- match: [
- /function/,
- /\s*(?=\()/
- ]
- }
- ],
- className: {
- 1: "keyword",
- 3: "title.function"
- },
- label: "func.def",
- contains: [PARAMS],
- illegal: /%/
- };
-
- const UPPER_CASE_CONSTANT = {
- relevance: 0,
- match: /\b[A-Z][A-Z_]+\b/,
- className: "variable.constant"
- };
-
- function noneOf(list) {
- return concat("(?!", list.join("|"), ")");
- }
-
- const FUNCTION_CALL = {
- match: concat(
- /\b/,
- noneOf([
- ...BUILT_IN_GLOBALS,
- "super"
- ]),
- IDENT_RE$1, lookahead(/\(/)),
- className: "title.function",
- relevance: 0
- };
-
- const PROPERTY_ACCESS = {
- begin: concat(/\./, lookahead(
- concat(IDENT_RE$1, /(?![0-9A-Za-z$_(])/)
- )),
- end: IDENT_RE$1,
- excludeBegin: true,
- keywords: "prototype",
- className: "property",
- relevance: 0
- };
-
- const GETTER_OR_SETTER = {
- match: [
- /get|set/,
- /\s+/,
- IDENT_RE$1,
- /(?=\()/
- ],
- className: {
- 1: "keyword",
- 3: "title.function"
- },
- contains: [
- { // eat to avoid empty params
- begin: /\(\)/
- },
- PARAMS
- ]
- };
-
- const FUNC_LEAD_IN_RE = '(\\(' +
- '[^()]*(\\(' +
- '[^()]*(\\(' +
- '[^()]*' +
- '\\)[^()]*)*' +
- '\\)[^()]*)*' +
- '\\)|' + hljs.UNDERSCORE_IDENT_RE + ')\\s*=>';
-
- const FUNCTION_VARIABLE = {
- match: [
- /const|var|let/, /\s+/,
- IDENT_RE$1, /\s*/,
- /=\s*/,
- lookahead(FUNC_LEAD_IN_RE)
- ],
- className: {
- 1: "keyword",
- 3: "title.function"
- },
- contains: [
- PARAMS
- ]
- };
-
- return {
- name: 'Javascript',
- aliases: ['js', 'jsx', 'mjs', 'cjs'],
- keywords: KEYWORDS$1,
- // this will be extended by TypeScript
- exports: { PARAMS_CONTAINS },
- illegal: /#(?![$_A-z])/,
- contains: [
- hljs.SHEBANG({
- label: "shebang",
- binary: "node",
- relevance: 5
- }),
- USE_STRICT,
- hljs.APOS_STRING_MODE,
- hljs.QUOTE_STRING_MODE,
- HTML_TEMPLATE,
- CSS_TEMPLATE,
- TEMPLATE_STRING,
- COMMENT,
- NUMBER,
- CLASS_REFERENCE,
- {
- className: 'attr',
- begin: IDENT_RE$1 + lookahead(':'),
- relevance: 0
- },
- FUNCTION_VARIABLE,
- { // "value" container
- begin: '(' + hljs.RE_STARTERS_RE + '|\\b(case|return|throw)\\b)\\s*',
- keywords: 'return throw case',
- relevance: 0,
- contains: [
- COMMENT,
- hljs.REGEXP_MODE,
- {
- className: 'function',
- // we have to count the parens to make sure we actually have the
- // correct bounding ( ) before the =>. There could be any number of
- // sub-expressions inside also surrounded by parens.
- begin: FUNC_LEAD_IN_RE,
- returnBegin: true,
- end: '\\s*=>',
- contains: [
- {
- className: 'params',
- variants: [
- {
- begin: hljs.UNDERSCORE_IDENT_RE,
- relevance: 0
- },
- {
- className: null,
- begin: /\(\s*\)/,
- skip: true
- },
- {
- begin: /\(/,
- end: /\)/,
- excludeBegin: true,
- excludeEnd: true,
- keywords: KEYWORDS$1,
- contains: PARAMS_CONTAINS
- }
- ]
- }
- ]
- },
- { // could be a comma delimited list of params to a function call
- begin: /,/,
- relevance: 0
- },
- {
- match: /\s+/,
- relevance: 0
- },
- { // JSX
- variants: [
- { begin: FRAGMENT.begin, end: FRAGMENT.end },
- {
- begin: XML_TAG.begin,
- // we carefully check the opening tag to see if it truly
- // is a tag and not a false positive
- 'on:begin': XML_TAG.isTrulyOpeningTag,
- end: XML_TAG.end
- }
- ],
- subLanguage: 'xml',
- contains: [
- {
- begin: XML_TAG.begin,
- end: XML_TAG.end,
- skip: true,
- contains: ['self']
- }
- ]
- }
- ],
- },
- FUNCTION_DEFINITION,
- {
- // prevent this from getting swallowed up by function
- // since they appear "function like"
- beginKeywords: "while if switch catch for"
- },
- {
- // we have to count the parens to make sure we actually have the correct
- // bounding ( ). There could be any number of sub-expressions inside
- // also surrounded by parens.
- begin: '\\b(?!function)' + hljs.UNDERSCORE_IDENT_RE +
- '\\(' + // first parens
- '[^()]*(\\(' +
- '[^()]*(\\(' +
- '[^()]*' +
- '\\)[^()]*)*' +
- '\\)[^()]*)*' +
- '\\)\\s*\\{', // end parens
- returnBegin: true,
- label: "func.def",
- contains: [
- PARAMS,
- hljs.inherit(hljs.TITLE_MODE, { begin: IDENT_RE$1, className: "title.function" })
- ]
- },
- // catch ... so it won't trigger the property rule below
- {
- match: /\.\.\./,
- relevance: 0
- },
- PROPERTY_ACCESS,
- // hack: prevents detection of keywords in some circumstances
- // .keyword()
- // $keyword = x
- {
- match: '\\$' + IDENT_RE$1,
- relevance: 0
- },
- {
- match: [/\bconstructor(?=\s*\()/],
- className: { 1: "title.function" },
- contains: [PARAMS]
- },
- FUNCTION_CALL,
- UPPER_CASE_CONSTANT,
- CLASS_OR_EXTENDS,
- GETTER_OR_SETTER,
- {
- match: /\$[(.]/ // relevance booster for a pattern common to JS libs: `$(something)` and `$.something`
- }
- ]
- };
- }
-
- /*
- Language: JSON
- Description: JSON (JavaScript Object Notation) is a lightweight data-interchange format.
- Author: Ivan Sagalaev
- Website: http://www.json.org
- Category: common, protocols, web
- */
-
- function json(hljs) {
- const ATTRIBUTE = {
- className: 'attr',
- begin: /"(\\.|[^\\"\r\n])*"(?=\s*:)/,
- relevance: 1.01
- };
- const PUNCTUATION = {
- match: /[{}[\],:]/,
- className: "punctuation",
- relevance: 0
- };
- // normally we would rely on `keywords` for this but using a mode here allows us
- // to use the very tight `illegal: \S` rule later to flag any other character
- // as illegal indicating that despite looking like JSON we do not truly have
- // JSON and thus improve false-positively greatly since JSON will try and claim
- // all sorts of JSON looking stuff
- const LITERALS = {
- beginKeywords: [
- "true",
- "false",
- "null"
- ].join(" ")
- };
-
- return {
- name: 'JSON',
- contains: [
- ATTRIBUTE,
- PUNCTUATION,
- hljs.QUOTE_STRING_MODE,
- LITERALS,
- hljs.C_NUMBER_MODE,
- hljs.C_LINE_COMMENT_MODE,
- hljs.C_BLOCK_COMMENT_MODE
- ],
- illegal: '\\S'
- };
- }
-
-
- /** @type LanguageFn */
- function xml(hljs) {
- // Element names can contain letters, digits, hyphens, underscores, and periods
- const TAG_NAME_RE = concat(/[A-Z_]/, optional(/[A-Z0-9_.-]*:/), /[A-Z0-9_.-]*/);
- const XML_IDENT_RE = /[A-Za-z0-9._:-]+/;
- const XML_ENTITIES = {
- className: 'symbol',
- begin: /&[a-z]+;|&#[0-9]+;|&#x[a-f0-9]+;/
- };
- const XML_META_KEYWORDS = {
- begin: /\s/,
- contains: [
- {
- className: 'keyword',
- begin: /#?[a-z_][a-z1-9_-]+/,
- illegal: /\n/
- }
- ]
- };
- const XML_META_PAR_KEYWORDS = hljs.inherit(XML_META_KEYWORDS, {
- begin: /\(/,
- end: /\)/
- });
- const APOS_META_STRING_MODE = hljs.inherit(hljs.APOS_STRING_MODE, {
- className: 'string'
- });
- const QUOTE_META_STRING_MODE = hljs.inherit(hljs.QUOTE_STRING_MODE, {
- className: 'string'
- });
- const TAG_INTERNALS = {
- endsWithParent: true,
- illegal: /`]+/
- }
- ]
- }
- ]
- }
- ]
- };
- return {
- name: 'HTML, XML',
- aliases: [
- 'html',
- 'xhtml',
- 'rss',
- 'atom',
- 'xjb',
- 'xsd',
- 'xsl',
- 'plist',
- 'wsf',
- 'svg'
- ],
- case_insensitive: true,
- contains: [
- {
- className: 'meta',
- begin: //,
- relevance: 10,
- contains: [
- XML_META_KEYWORDS,
- QUOTE_META_STRING_MODE,
- APOS_META_STRING_MODE,
- XML_META_PAR_KEYWORDS,
- {
- begin: /\[/,
- end: /\]/,
- contains: [
- {
- className: 'meta',
- begin: //,
- contains: [
- XML_META_KEYWORDS,
- XML_META_PAR_KEYWORDS,
- QUOTE_META_STRING_MODE,
- APOS_META_STRING_MODE
- ]
- }
- ]
- }
- ]
- },
- hljs.COMMENT(
- //,
- {
- relevance: 10
- }
- ),
- {
- begin: //,
- relevance: 10
- },
- XML_ENTITIES,
- {
- className: 'meta',
- begin: /<\?xml/,
- end: /\?>/,
- relevance: 10
- },
- {
- className: 'tag',
- /*
- The lookahead pattern (?=...) ensures that 'begin' only matches
- ')/,
- end: />/,
- keywords: {
- name: 'style'
- },
- contains: [TAG_INTERNALS],
- starts: {
- end: /<\/style>/,
- returnEnd: true,
- subLanguage: [
- 'css',
- 'xml'
- ]
- }
- },
- {
- className: 'tag',
- // See the comment in the
-
- 
pillarbox-web