feat: Node.js SDK update for version 23.0.0 by ChiragAgg5k · Pull Request #145 · appwrite/sdk-for-node

ChiragAgg5k · 2026-03-24T13:06:29Z

This PR contains updates to the Node.js SDK for version 23.0.0.

* Updated `DocumentsDB` docs and `DatabasesIndexType` usage; bumped API version badge to 1.9.0

coderabbitai · 2026-03-24T13:06:38Z

Warning

Rate limit exceeded

@ChiragAgg5k has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d0f3f440-a9b2-48cb-9ca9-3b28b89a2887

📥 Commits

Reviewing files that changed from the base of the PR and between 566f848 and b9a5684.

📒 Files selected for processing (1)

CHANGELOG.md

Walkthrough

This pull request bumps the SDK version from 22.1.3 to 23.0.0 and updates API version support from 1.8.x to 1.9.x. It introduces breaking changes including a type change for $sequence from int to string in Row and Document models, and reorganizes index type enums (IndexType → DatabasesIndexType for Databases, TablesDBIndexType for TablesDB). The specification parameter is replaced with separate buildSpecification, runtimeSpecification, and deploymentRetention fields in Functions and Sites services. Two new services are added: Project for managing project variables and Webhooks for managing webhooks. The Client is extended with impersonation methods (setImpersonateUserId, setImpersonateUserEmail, setImpersonateUserPhone). Five health queue-related methods are removed. Models are extended with new webhook types and additional fields for User, Site, and Function. A comprehensive Jest test suite is added covering all services.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately describes the main change: a Node.js SDK version bump to 23.0.0, which aligns with the extensive updates across version numbers, enums, services, and models throughout the changeset.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 11

🧹 Nitpick comments (21)

src/services/project.ts (1)

1-1: Remove unused import UploadProgress.

The UploadProgress type is imported but never used in this file.

🧹 Proposed fix

-import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
+import { AppwriteException, Client, type Payload } from '../client';

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/services/project.ts` at line 1, The import line in this module currently
includes an unused symbol UploadProgress; remove UploadProgress from the import
list (leaving AppwriteException, Client, and Payload) and verify there are no
remaining references to UploadProgress in this file so the import stays clean.

test/role.test.js (1)

10-13: Minor: Inconsistent semicolon usage.

Lines 10-13 are missing semicolons at the end of statements, while earlier lines (4-9) include them. Consider adding semicolons for consistency.

🔧 Proposed fix

-    test('team without role', () => expect(Role.team('custom')).toEqual('team:custom'))
-    test('team with role', () => expect(Role.team('custom', 'owner')).toEqual('team:custom/owner'))
-    test('member', () => expect(Role.member('custom')).toEqual('member:custom'))
-    test('label', () => expect(Role.label('admin')).toEqual('label:admin'))
+    test('team without role', () => expect(Role.team('custom')).toEqual('team:custom'));
+    test('team with role', () => expect(Role.team('custom', 'owner')).toEqual('team:custom/owner'));
+    test('member', () => expect(Role.member('custom')).toEqual('member:custom'));
+    test('label', () => expect(Role.label('admin')).toEqual('label:admin'));

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/role.test.js` around lines 10 - 13, Add missing semicolons to the test
statements using Role.team, Role.member, and Role.label to match the existing
style: terminate the calls in test('team without role'), test('team with role'),
test('member'), and test('label') with semicolons so all test lines consistently
end with semicolons.

package.json (1)

51-51: Consider using exact version for jest.

The jest dependency uses a caret range (^29.7.0) while other devDependencies use exact versions (e.g., "tsup": "7.2.0", "typescript": "5.4.2"). For consistent builds, consider pinning to an exact version.
🔧 Proposed fix
-    "jest": "^29.7.0"
+    "jest": "29.7.0"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@package.json` at line 51, The jest dependency in package.json is using a
caret range ("jest": "^29.7.0") while other devDependencies are pinned; update
the "jest" entry to an exact version (e.g., "jest": "29.7.0") to ensure
consistent installs and reproducible builds, keeping the rest of the
devDependencies (like "tsup" and "typescript") unchanged.

docs/examples/databases/upsert-documents.md (1)

7-7: Use a named placeholder instead of an empty session string.

At Line 7, consider setSession('<YOUR_SESSION_ID>') for consistency with other examples and to avoid implying empty-string is a valid value.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/examples/databases/upsert-documents.md` at line 7, The example uses an
empty string in the setSession call which implies an empty session is valid;
replace .setSession('') with a named placeholder like
.setSession('<YOUR_SESSION_ID>') in the snippet (locate the setSession call) so
examples are consistent and clearly indicate the developer must supply a session
ID.

test/services/webhooks.test.js (3)

45-50: Consider using a valid placeholder URL for the test.

The create() method is called with an empty string '' for the URL parameter (line 47), while other string parameters use descriptive placeholders like '<WEBHOOK_ID>' and '<NAME>'. Using a placeholder like 'https://example.com/webhook' would be more consistent with the mock response data and other test patterns.

Suggested fix

         const response = await webhooks.create(
             '<WEBHOOK_ID>',
-            '',
+            'https://example.com/webhook',
             '<NAME>',
             [],
         );

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/services/webhooks.test.js` around lines 45 - 50, The test calls
webhooks.create with an empty URL string; replace the second argument in the
webhooks.create call with a valid placeholder URL (e.g.,
"https://example.com/webhook") so the test input aligns with other descriptive
placeholders and the mock response data; update the webhooks.create invocation
in test/services/webhooks.test.js accordingly.

102-107: Consider using a valid placeholder URL for the update test as well.

Similar to the create() test, the update() method passes an empty string for the URL parameter.

Suggested fix

         const response = await webhooks.update(
             '<WEBHOOK_ID>',
             '<NAME>',
-            '',
+            'https://example.com/webhook',
             [],
         );

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/services/webhooks.test.js` around lines 102 - 107, The update test calls
webhooks.update('<WEBHOOK_ID>', '<NAME>', '', []) with an empty string for the
URL; change it to use a valid placeholder URL (e.g.
'https://example.com/webhook' or the same placeholder used in the create() test)
so webhooks.update receives a proper URL parameter and the test mirrors
create()'s behavior.

2-2: Unused import.

Same as project.test.js - InputFile is not used.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/services/webhooks.test.js` at line 2, Remove the unused require of
InputFile in webhooks.test.js: the symbol InputFile is imported via const {
InputFile } = require("../../dist/inputFile"); but never used, so either remove
that import line or replace it with the correct dependency actually needed by
the tests; ensure no other references to InputFile remain in the file (search
for InputFile) before committing the removal.

test/services/project.test.js (1)

1-6: Remove unused InputFile import.

InputFile is imported but not used in this test file. This pattern is repeated across all new test files in this PR.

Suggested fix

 const { Client } = require("../../dist/client");
-const { InputFile } = require("../../dist/inputFile");
 const { Project } = require("../../dist/services/project");

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/services/project.test.js` around lines 1 - 6, Remove the unused
InputFile import from the test file: delete the `const { InputFile } =
require("../../dist/inputFile");` line in test/services/project.test.js (and
similarly remove that import from the other new test files in this PR) so only
required symbols like `Client` and `Project` remain; ensure no other references
to InputFile exist before committing.

test/services/graphql.test.js (1)

2-2: Unused import.