Skip to content

Commit

Permalink
deps: updated typedoc@0.26.10 + typescript@5.6.3 (#1116)
Browse files Browse the repository at this point in the history
Co-authored-by: Shane Osbourne <sosbourne@duckduckgo.com>
Co-authored-by: Jonathan Kingston <jkingston@duckduckgo.com>
  • Loading branch information
3 people authored and vkraucunas committed Oct 17, 2024
1 parent 2d67378 commit 4c41c0d
Show file tree
Hide file tree
Showing 40 changed files with 1,099 additions and 271 deletions.
1 change: 0 additions & 1 deletion injected/entry-points/android.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Android integration
* @category Content Scope Scripts Integrations
*/
import { load, init } from '../src/content-scope-features.js'
import { processConfig, isGloballyDisabled } from './../src/utils'
Expand Down
1 change: 0 additions & 1 deletion injected/entry-points/apple.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Apple integration
* @category Content Scope Scripts Integrations
*/
import { load, init } from '../src/content-scope-features.js'
import { processConfig, isGloballyDisabled } from './../src/utils'
Expand Down
1 change: 0 additions & 1 deletion injected/entry-points/chrome-mv3.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Chrome MV3 integration
* @category Content Scope Scripts Integrations
*/
import { load, init, update } from '../src/content-scope-features.js'
import { isTrackerOrigin } from '../src/trackers'
Expand Down
1 change: 0 additions & 1 deletion injected/entry-points/chrome.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Chrome integration
* @category Content Scope Scripts Integrations
*/
import { isTrackerOrigin } from '../src/trackers'
import { computeLimitedSiteObject } from '../src/utils'
Expand Down
1 change: 0 additions & 1 deletion injected/entry-points/mozilla.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Mozilla integration
* @category Content Scope Scripts Integrations
*/
import { load, init, update } from '../src/content-scope-features.js'
import { isTrackerOrigin } from '../src/trackers'
Expand Down
1 change: 0 additions & 1 deletion injected/entry-points/windows.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Windows integration
* @category Content Scope Scripts Integrations
*/
import { load, init } from '../src/content-scope-features.js'
import { processConfig, isGloballyDisabled, windowsSpecificFeatures } from './../src/utils'
Expand Down
7 changes: 2 additions & 5 deletions injected/src/features/duck-player.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* @module Duck Player Overlays
*
* @description
*
* Duck Player Overlays are either the small Dax icons that appear on top of video thumbnails
* when browsing YouTube. These icons allow users to open the video in Duck Player.
Expand Down Expand Up @@ -30,9 +27,9 @@
*
* For example, to enable the Duck Player Overlay on YouTube, the following config is used:
*
* ```json
* [[include:injected/integration-test/test-pages/duckplayer/config/overlays-live.json]]```
* [📝 JSON example](../../integration-test/test-pages/duckplayer/config/overlays-live.json)
*
* @module Duck Player Overlays
*/
import ContentFeature from '../content-feature.js'

Expand Down
5 changes: 1 addition & 4 deletions injected/src/features/duckplayer/thumbnails.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* @module Duck Player Thumbnails
*
* @description
*
* ## Decision flow for `mouseover` (appending Dax)
*
Expand Down Expand Up @@ -52,7 +49,7 @@
* - `eventTarget` matches a CSS selector in `[config] allowedEventTargets`
* - otherwise, do nothing
*
* [[include:injected/src/features/duckplayer/thumbnails.md]]
* @module Duck Player Thumbnails
*/

import { SideEffects, VideoParams } from './util.js'
Expand Down
2 changes: 0 additions & 2 deletions injected/src/features/duckplayer/video-overlay.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
/**
* @module Duck Player Video Overlay
*
* @description
*
* ## Decision flow for appending the Video Overlays
*
* We'll try to append the full video overlay (or small Dax icon) onto the main video player
Expand Down
9 changes: 3 additions & 6 deletions injected/src/features/harmful-apis.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
/**
* @module Harmful APIs protection
*
* @description
*
* This protection changes or disables some web APIs that are known to be harmful to privacy.
* When an API is not removed from the globals, its behaviour is changed to reduce the amount of information it can leak.
*
* ## Remote Config
* The behaviour can be controlled with a remote config. Example:
* ```json
* [[include:injected/integration-test/test-pages/harmful-apis/config/apis.json]]```
* The behaviour can be controlled with a remote config. [Example](../../integration-test/test-pages/harmful-apis/config/apis.json)
*
* @module Harmful APIs protection
*
*/
import ContentFeature from '../content-feature'
Expand Down
5 changes: 3 additions & 2 deletions injected/src/types/duckplayer-settings.d.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
/**
* @module Duckplayer Settings Schema
* @description
*
* These types are auto-generated from schema files.
* scripts/build-types.mjs is responsible for type generation.
* See the privacy-configuration repo for the schema files:
* https://github.com/duckduckgo/privacy-configuration
* **DO NOT** edit this file directly as your changes will be lost.
*
* @module Duckplayer Settings Schema
*/

export type State = "enabled" | "disabled";
Expand Down
5 changes: 2 additions & 3 deletions injected/src/types/web-compat.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
/**
* @module WebCompat Messages
* @description
*
* These types are auto-generated from schema files.
* scripts/build-types.mjs is responsible for type generation.
* **DO NOT** edit this file directly as your changes will be lost.
*
* @module WebCompat Messages
*/

/**
Expand Down
5 changes: 3 additions & 2 deletions injected/src/types/webcompat-settings.d.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
/**
* @module Webcompat Settings Schema
* @description
*
* These types are auto-generated from schema files.
* scripts/build-types.mjs is responsible for type generation.
* See the privacy-configuration repo for the schema files:
* https://github.com/duckduckgo/privacy-configuration
* **DO NOT** edit this file directly as your changes will be lost.
*
* @module Webcompat Settings Schema
*/

export type State = "enabled" | "disabled";
Expand Down
7 changes: 1 addition & 6 deletions messaging/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* @module Messaging
* @category Libraries
* @description
*
* An abstraction for communications between JavaScript and host platforms.
*
Expand All @@ -21,6 +18,7 @@
* - Schema: {@link "Messaging Schema"}
* - Implementation Guide: {@link "Messaging Implementation Guide"}
*
* @module Messaging
*/
import { WindowsMessagingConfig, WindowsMessagingTransport, WindowsInteropMethods, WindowsNotification, WindowsRequestMessage } from './lib/windows.js'
import { WebkitMessagingConfig, WebkitMessagingTransport } from './lib/webkit.js'
Expand Down Expand Up @@ -166,9 +164,6 @@ export class MessagingTransport {
* It's useful for debugging, and for enabling scripts to run in
* other environments - for example, testing in a browser without the need
* for a full integration
*
* ```js
* [[include:messaging/lib/examples/test.example.js]]```
*/
export class TestTransportConfig {
/**
Expand Down
8 changes: 1 addition & 7 deletions messaging/lib/android.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
/**
* @description
*
* A wrapper for messaging on Android.
*
* You must share a {@link AndroidMessagingConfig} instance between features
*
* @example
*
* ```javascript
* [[include:messaging/lib/examples/windows.example.js]]```
*
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import { MessagingTransport, MessageResponse, SubscriptionEvent } from '../index.js'
Expand Down Expand Up @@ -166,7 +160,7 @@ export class AndroidMessagingTransport {
* - `$messageSecret` matches {@link AndroidMessagingConfig.messageSecret}
* - `$message` is JSON string that represents one of {@link MessageResponse} or {@link SubscriptionEvent}
*
* ```kotlin
* ```
* object ReplyHandler {
* fun constructReply(message: String, messageCallback: String, messageSecret: String): String {
* return """
Expand Down
7 changes: 1 addition & 6 deletions messaging/lib/webkit.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/**
*
* @description
*
* A wrapper for messaging on WebKit platforms. It supports modern WebKit messageHandlers
* along with encryption for older versions (like macOS Catalina)
Expand Down Expand Up @@ -318,10 +316,7 @@ export class WebkitMessagingTransport {
*
* Please see {@link WebkitMessagingTransport} for details on how messages are sent/received
*
* @example Webkit Messaging
*
* ```javascript
* [[include:messaging/lib/examples/webkit.example.js]]```
* [Example](./examples/webkit.example.js)
*/
export class WebkitMessagingConfig {
/**
Expand Down
10 changes: 2 additions & 8 deletions messaging/lib/windows.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
/**
* @description
*
* A wrapper for messaging on Windows.
*
* This requires 3 methods to be available, see {@link WindowsMessagingConfig} for details
*
* @example
*
* ```javascript
* [[include:messaging/lib/examples/windows.example.js]]```
* @document messaging/lib/examples/windows.example.js
*
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
Expand Down Expand Up @@ -207,8 +202,7 @@ export class WindowsMessagingTransport {
* Depending on where the script is running, we may want to restrict access to those globals. On the native
* side those handlers `window.chrome.webview` handlers might be deleted and replaces with in-scope variables, such as:
*
* ```ts
* [[include:messaging/lib/examples/windows.example.js]]```
* [Example](./examples/windows.example.js)
*
*/
export class WindowsMessagingConfig {
Expand Down
6 changes: 2 additions & 4 deletions messaging/native.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
/**
* @module Messaging Implementation Guide
* @category Libraries
* @description
*
* Messages will be **sent** to native platforms in 2 formats - notifications and requests.
* Notifications do not require a response, but requests do. The following spec explains the difference and
* how to handle each.
Expand Down Expand Up @@ -219,4 +215,6 @@
* "params": { "hello": "world" }
* }
* ```
*
* @module Messaging Implementation Guide
*/
6 changes: 3 additions & 3 deletions messaging/schema.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
/**
* @module Messaging Schema
*
* @description
* These are all the shared data types used throughout. Transports receive these types and
* can choose how to deliver the message to their respective native platforms.
*
Expand All @@ -10,6 +7,9 @@
* - Subscriptions via {@link Subscription}
*
* Note: For backwards compatibility, some platforms may alter the data shape within the transport.
*
* @module Messaging Schema
*
*/

/**
Expand Down
Loading

0 comments on commit 4c41c0d

Please sign in to comment.