Skip to content

LiveObjects integration branch fixes #2017

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 29, 2025
Merged

Conversation

VeskeR
Copy link
Contributor

@VeskeR VeskeR commented Apr 28, 2025

Minor fixes/changes based on the review from #2007.

Changes can be easily reviewed on a per-commit basis.

Summary by CodeRabbit

  • Documentation

    • Updated documentation and code examples to rename the global interface from ObjectsTypes to AblyObjectsTypes and clarified the scope of TypeScript typings.
    • Improved JSDoc comments for utility functions.
    • Updated TypeDoc configuration to reflect the new interface name.
    • Minor wording and punctuation refinements in documentation comments.
  • Tests

    • Enhanced test coverage for channel serial handling, including more realistic scenarios and new protocol message types.
    • Updated global typings and declarations in test files to use AblyObjectsTypes.
    • Added global declarations to fix TypeScript errors in test templates.
    • Broadened TypeScript strictness settings in test configurations.
    • Removed obsolete type declaration files and replaced imports with inline type definitions.
  • Chores

    • Added new private API identifiers for recording internal property usage.

Copy link

coderabbitai bot commented Apr 28, 2025

Walkthrough

This set of changes updates the global TypeScript interface for LiveObjects typings from ObjectsTypes to AblyObjectsTypes throughout the codebase and documentation. All relevant type declarations, code examples, comments, and TypeDoc configuration are revised to reflect the new interface name. Test files and templates are updated to declare or reference AblyObjectsTypes accordingly, and related global type declarations are adjusted. Additional minor updates include improved documentation comments, stricter TypeScript configuration in test templates, and enhanced test logic for channel serial handling in real-time messaging.

Changes

File(s) Change Summary
README.md, ably.d.ts, typedoc.json Renamed the global interface for LiveObjects typings from ObjectsTypes to AblyObjectsTypes in documentation, type declarations, and TypeDoc config. Updated all code examples, comments, and type parameter defaults to use the new name. Clarified documentation about the purpose and limitations of these typings.
src/common/lib/util/utils.ts Replaced a single-line comment with a detailed JSDoc comment for the dataSizeBytes function, documenting input types and byte size calculation rules.
test/common/modules/private_api_recorder.js Added two new private API identifiers to the list of recognized usages for recording: 'read.ProtocolMessage.channelSerial' and 'read.channel.properties.channelSerial'.
test/package/browser/template/src/ably.config.d.ts Deleted the file that defined the CustomRoot type and the ObjectsTypes global interface for browser package test templates.
test/package/browser/template/src/index-default.ts, test/package/browser/template/src/index-modular.ts, test/package/browser/template/src/index-objects.ts Added TypeScript global declaration merging to declare a global testAblyPackage: () => Promise<void> function in globalThis to address an index signature error. In index-objects.ts, also inlined the CustomRoot type, added the AblyObjectsTypes global interface, and updated references from ObjectsTypes to AblyObjectsTypes.
test/package/browser/template/src/index-objects.ts Removed import of CustomRoot from config, declared it inline, added AblyObjectsTypes interface, updated comments and typings to use the new interface, and included global declaration for testAblyPackage.
test/package/browser/template/src/tsconfig.json Changed TypeScript compiler option from "strictNullChecks": true to "strict": true to enable all strict type-checking options.
test/realtime/channel.test.js Revised the test for channelSerial on ATTACH ProtocolMessages to use a real publish and reconnect flow instead of a hardcoded value. Extended the test for updating channelSerial to include ANNOTATION protocol messages. Added calls to record private API usage when reading channelSerial.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Test as Test Code
    participant Channel as Channel
    participant Transport as Transport

    User->>Test: Initiate test for channelSerial on ATTACH
    Test->>Channel: Publish message
    Channel->>Transport: Send MESSAGE ProtocolMessage
    Transport-->>Channel: Receive MESSAGE, capture channelSerial
    Test->>Transport: Disconnect transport
    Transport-->>Test: Triggers reconnect
    Test->>Transport: Spy on send (for ATTACH)
    Channel->>Transport: Send ATTACH ProtocolMessage (with channelSerial)
    Test->>Transport: Assert ATTACH includes correct channelSerial
Loading

Possibly related PRs

Suggested reviewers

  • mschristensen

Poem

In the warren of code, a change hops through,
From ObjectsTypes to AblyObjectsTypes, fresh and new.
TypeScript now knows just what to see,
For LiveObjects’ roots, as clear as can be.
With stricter checks and docs that delight,
This bunny’s proud—code’s never been so right!
🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot temporarily deployed to staging/pull/2017/bundle-report April 28, 2025 13:56 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/typedoc April 28, 2025 13:56 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/features April 28, 2025 13:56 Inactive
@VeskeR VeskeR force-pushed the liveobjects/fixes branch from 8b44d6d to 6a27d76 Compare April 28, 2025 13:58
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.

Actionable comments posted: 3

🧹 Nitpick comments (1)
src/common/lib/util/utils.ts (1)

282-290: Comprehensive JSDoc addition
The new comment clearly documents each branch of dataSizeBytes (TM6a, TM6c, OD3c, OD3d) and the expected input types. Consider adding a @throws tag to document the error thrown when an unsupported type is passed.

🛑 Comments failed to post (3)
test/package/browser/template/src/index-default.ts (1)

6-8: 🛠️ Refactor suggestion

Replace deprecated module with namespace
The Biome lint rule flags declare module globalThis {} as outdated. Use declare namespace globalThis {} to augment the global object:

-declare module globalThis {
+declare namespace globalThis {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 6-6: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

🤖 Prompt for AI Agents (early access)
In test/package/browser/template/src/index-default.ts around lines 6 to 8, replace the deprecated `declare module globalThis` with `declare namespace globalThis` to properly augment the global object and comply with the Biome lint rule.
test/package/browser/template/src/index-modular.ts (1)

7-9: 🛠️ Refactor suggestion

Use namespace for global augmentation
To avoid confusion with ECMAScript modules, replace declare module globalThis {} with:

-declare module globalThis {
+declare namespace globalThis {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

🤖 Prompt for AI Agents (early access)
In test/package/browser/template/src/index-modular.ts around lines 7 to 9, replace the use of `declare module globalThis {}` with `declare namespace globalThis {}` to properly augment the global scope and avoid confusion with ECMAScript modules. Change the declaration to use `namespace` for global augmentation.
test/package/browser/template/src/index-objects.ts (1)

5-9: 🛠️ Refactor suggestion

Use namespace instead of module for TypeScript declarations.

The declare module syntax is deprecated in TypeScript. Use namespace instead to avoid confusion with ECMAScript modules.

// Fix for "type 'typeof globalThis' has no index signature" error:
// https://stackoverflow.com/questions/68481686/type-typeof-globalthis-has-no-index-signature
-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

// Fix for "type 'typeof globalThis' has no index signature" error:
// https://stackoverflow.com/questions/68481686/type-typeof-globalthis-has-no-index-signature
declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

🤖 Prompt for AI Agents (early access)
In test/package/browser/template/src/index-objects.ts around lines 5 to 9, replace the deprecated `declare module globalThis` syntax with `declare namespace globalThis` to correctly declare the global augmentation and avoid confusion with ECMAScript modules.

@github-actions github-actions bot temporarily deployed to staging/pull/2017/bundle-report April 28, 2025 13:58 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/typedoc April 28, 2025 13:59 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/features April 28, 2025 13:59 Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
test/package/browser/template/src/index-default.ts (1)

4-8: Use namespace instead of module for TypeScript declaration merging

The declaration to fix the TypeScript error correctly adds the global variable to globalThis, but modern TypeScript best practices recommend using the namespace keyword rather than the outdated module keyword.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 6-6: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-modular.ts (1)

5-9: Use namespace instead of module for TypeScript declaration merging

The declaration to fix the TypeScript error correctly adds the global variable to globalThis, but modern TypeScript best practices recommend using the namespace keyword rather than the outdated module keyword.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-objects.ts (1)

5-9: Use namespace instead of module for TypeScript declaration merging

The declaration to fix the TypeScript error correctly adds the global variable to globalThis, but modern TypeScript best practices recommend using the namespace keyword rather than the outdated module keyword.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b44d6d and 6a27d76.

📒 Files selected for processing (11)
  • README.md (2 hunks)
  • ably.d.ts (6 hunks)
  • src/common/lib/util/utils.ts (1 hunks)
  • test/common/modules/private_api_recorder.js (1 hunks)
  • test/package/browser/template/src/ably.config.d.ts (0 hunks)
  • test/package/browser/template/src/index-default.ts (1 hunks)
  • test/package/browser/template/src/index-modular.ts (1 hunks)
  • test/package/browser/template/src/index-objects.ts (4 hunks)
  • test/package/browser/template/src/tsconfig.json (1 hunks)
  • test/realtime/channel.test.js (4 hunks)
  • typedoc.json (1 hunks)
💤 Files with no reviewable changes (1)
  • test/package/browser/template/src/ably.config.d.ts
✅ Files skipped from review due to trivial changes (2)
  • typedoc.json
  • test/common/modules/private_api_recorder.js
🚧 Files skipped from review as they are similar to previous changes (4)
  • test/package/browser/template/src/tsconfig.json
  • src/common/lib/util/utils.ts
  • test/realtime/channel.test.js
  • ably.d.ts
🧰 Additional context used
🧬 Code Graph Analysis (1)
test/package/browser/template/src/index-objects.ts (4)
src/plugins/objects/livemap.ts (2)
  • LiveMap (54-843)
  • size (289-303)
ably.d.ts (1)
  • AblyObjectsTypes (2370-2372)
test/realtime/objects.test.js (2)
  • root (148-148)
  • objects (144-144)
src/common/lib/client/realtimechannel.ts (1)
  • objects (157-162)
🪛 markdownlint-cli2 (0.17.2)
README.md

891-891: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)

🪛 Biome (1.9.4)
test/package/browser/template/src/index-default.ts

[error] 6-6: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-modular.ts

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-objects.ts

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test-node (20.x)
  • GitHub Check: test-browser (webkit)
  • GitHub Check: test-node (18.x)
  • GitHub Check: test-node (16.x)
  • GitHub Check: test-browser (firefox)
  • GitHub Check: test-browser (chromium)
🔇 Additional comments (2)
README.md (1)

869-870: LGTM: Interface renaming is consistent with type declaration changes

The renamed interface from ObjectsTypes to AblyObjectsTypes is consistently applied throughout the documentation, keeping it in sync with the actual implementation in the type declarations.

Also applies to: 883-883, 892-892

test/package/browser/template/src/index-objects.ts (1)

11-29: Good job renaming the interface and moving type definitions inline

Moving the CustomRoot type definition inline and renaming the global interface from ObjectsTypes to AblyObjectsTypes improves the organization of the code. All references to the interface have been correctly updated throughout the file, ensuring type safety and consistency.

Also applies to: 44-44, 51-51, 61-61, 92-92

@github-actions github-actions bot temporarily deployed to staging/pull/2017/features April 28, 2025 16:44 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/bundle-report April 28, 2025 16:44 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/2017/typedoc April 28, 2025 16:44 Inactive
VeskeR added 9 commits April 29, 2025 13:18
…ge tests"

This reverts commit d59e167.

The `moduleResolution` option should be `bundler`, just like it was set
in the original fecf2df commit.
The supposed TypeScript error "Option '--resolveJsonModule' cannot be
specified without 'node' module resolution strategy." is actually coming
from the root folder TypeScript installation, not the one used for the
`package` test folder. The `--moduleResolution bundler` option was added
in TypeScript 5.0 [1] and in the root we have TypeScript ^4.9 installed,
compared to TypeScript ^5.2 used for `package`` folder.

See PR review comment for more context [2].

[1] https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html#--moduleresolution-bundler
[2] #2007 (comment)
@VeskeR VeskeR merged commit c47738c into integration/liveobjects Apr 29, 2025
11 of 14 checks passed
@VeskeR VeskeR deleted the liveobjects/fixes branch April 29, 2025 12:20
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
test/package/browser/template/src/index-modular.ts (1)

5-9: Use namespace instead of module for TypeScript declarations.

The TypeScript declaration correctly adds a type for the global testAblyPackage function, fixing the "no index signature" error. However, the module keyword is deprecated in TypeScript declarations.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-default.ts (1)

4-8: Use namespace instead of module for TypeScript declarations.

The TypeScript declaration correctly adds a type for the global testAblyPackage function, fixing the "no index signature" error. However, the module keyword is deprecated in TypeScript declarations.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 6-6: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-objects.ts (1)

5-9: Use namespace instead of module for TypeScript declarations.

The TypeScript declaration correctly adds a type for the global testAblyPackage function, fixing the "no index signature" error. However, the module keyword is deprecated in TypeScript declarations.

-declare module globalThis {
+declare namespace globalThis {
  var testAblyPackage: () => Promise<void>;
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 020efdc and 5106329.

📒 Files selected for processing (11)
  • README.md (2 hunks)
  • ably.d.ts (6 hunks)
  • src/common/lib/util/utils.ts (1 hunks)
  • test/common/modules/private_api_recorder.js (1 hunks)
  • test/package/browser/template/src/ably.config.d.ts (0 hunks)
  • test/package/browser/template/src/index-default.ts (1 hunks)
  • test/package/browser/template/src/index-modular.ts (1 hunks)
  • test/package/browser/template/src/index-objects.ts (4 hunks)
  • test/package/browser/template/src/tsconfig.json (1 hunks)
  • test/realtime/channel.test.js (4 hunks)
  • typedoc.json (1 hunks)
💤 Files with no reviewable changes (1)
  • test/package/browser/template/src/ably.config.d.ts
✅ Files skipped from review due to trivial changes (1)
  • ably.d.ts
🚧 Files skipped from review as they are similar to previous changes (5)
  • typedoc.json
  • test/package/browser/template/src/tsconfig.json
  • test/common/modules/private_api_recorder.js
  • src/common/lib/util/utils.ts
  • test/realtime/channel.test.js
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

891-891: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)

🪛 Biome (1.9.4)
test/package/browser/template/src/index-default.ts

[error] 6-6: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-modular.ts

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

test/package/browser/template/src/index-objects.ts

[error] 7-7: Use the namespace keyword instead of the outdated module keyword.

The module keyword is deprecated to avoid any confusion with the ECMAScript modules which are often called modules.
Safe fix: Use namespace instead.

(lint/suspicious/useNamespaceKeyword)

⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: test-node (20.x)
  • GitHub Check: test-browser (webkit)
  • GitHub Check: test-browser (firefox)
  • GitHub Check: test-node (18.x)
  • GitHub Check: test-browser (chromium)
  • GitHub Check: test-npm-package
  • GitHub Check: test-node (16.x)
🔇 Additional comments (3)
README.md (1)

869-870: Interface renaming in documentation looks good.

The documentation has been properly updated to refer to the renamed interface AblyObjectsTypes instead of ObjectsTypes, maintaining consistency with the code changes.

Also applies to: 883-884, 892-893

test/package/browser/template/src/index-objects.ts (2)

11-29: Inline type definition looks good.

The inline definition of CustomRoot type and the global AblyObjectsTypes interface properly replaces the previous approach of importing from an external file. This change aligns with the interface renaming across the codebase.


44-45: Type references and comments are consistently updated.

All references to the previous interface name have been properly updated to use AblyObjectsTypes in both comments and code. This maintains consistency with the rest of the codebase.

Also applies to: 51-52, 61-61, 92-93

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants