feat: Node.js SDK update for version 25.0.0

.github/workflows/publish.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
     - name: Use Node.js
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
       with:
         node-version: '24.14.1'
         registry-url: 'https://registry.npmjs.org'

.npmrc

@@ -0,0 +1 @@
+min-release-age=7

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 25.0.0
+
+* Breaking: Renamed `AuthMethod` enum to `ProjectAuthMethodId`
+* Breaking: Renamed `EmailTemplateType` to `ProjectEmailTemplateId` and `EmailTemplateLocale` to `ProjectEmailTemplateLocale`
+* Breaking: Renamed `ServiceId` to `ProjectServiceId`, `ProtocolId` to `ProjectProtocolId`, `Secure` to `ProjectSMTPSecure`, `ProjectPolicy` to `ProjectPolicyId`
+* Breaking: Replaced `Scopes` enum with `ProjectKeyScopes` for project key endpoints
+* Breaking: Removed `updateDenyCanonicalEmailPolicy`; replaced with `updateDenyAliasedEmailPolicy`, `updateDenyDisposableEmailPolicy`, and `updateDenyFreeEmailPolicy`
+* Breaking: Removed `AuthProvider` model; use new `ProjectOAuthProviderId` enum instead
+* Added: `Project.get` method to fetch current project details
+* Added: `Advisor`, `Presences`, and `Usage` services
+* Added: `Insight`, `Presence`, `Report`, `UsageEvent`, and `UsageGauge` models with list variants
+* Added: `ProjectAuthMethod`, `ProjectProtocol`, and `ProjectService` models
+* Added: `ProjectOAuthProviderId` and `ProjectOAuth2GooglePrompt` enums
+* Updated: `Project`, `Database`, and `OAuth2Google` model schemas
+* Updated: `X-Appwrite-Response-Format` header to `1.9.5`
+
 ## 24.1.0
 
 * Added: Introduced `bigint` create/update APIs for legacy Databases attributes

README.md

@@ -1,7 +1,7 @@
 # Appwrite Node.js SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.9.4-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.5-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

docs/examples/advisor/delete-report.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const advisor = new sdk.Advisor(client);
+
+const result = await advisor.deleteReport({
+    reportId: '<REPORT_ID>'
+});
+```

docs/examples/advisor/get-insight.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+const advisor = new sdk.Advisor(client);
+
+const result = await advisor.getInsight({
+    reportId: '<REPORT_ID>',
+    insightId: '<INSIGHT_ID>'
+});
+```

docs/examples/advisor/get-report.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+const advisor = new sdk.Advisor(client);
+
+const result = await advisor.getReport({
+    reportId: '<REPORT_ID>'
+});
+```

docs/examples/advisor/list-insights.md

@@ -0,0 +1,16 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+const advisor = new sdk.Advisor(client);
+
+const result = await advisor.listInsights({
+    reportId: '<REPORT_ID>',
+    queries: [], // optional
+    total: false // optional
+});
+```

docs/examples/advisor/list-reports.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+const advisor = new sdk.Advisor(client);
+
+const result = await advisor.listReports({
+    queries: [], // optional
+    total: false // optional
+});
+```

docs/examples/presences/delete.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.delete({
+    presenceId: '<PRESENCE_ID>'
+});
+```

docs/examples/presences/get.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.get({
+    presenceId: '<PRESENCE_ID>'
+});
+```

docs/examples/presences/list.md

@@ -0,0 +1,16 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.list({
+    queries: [], // optional
+    total: false, // optional
+    ttl: 0 // optional
+});
+```

docs/examples/presences/update-presence.md

@@ -0,0 +1,20 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.updatePresence({
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>', // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: {}, // optional
+    permissions: [sdk.Permission.read(sdk.Role.any())], // optional
+    purge: false // optional
+});
+```

docs/examples/presences/upsert.md

@@ -0,0 +1,19 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.upsert({
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>',
+    permissions: [sdk.Permission.read(sdk.Role.any())], // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: {} // optional
+});
+```

docs/examples/project/create-ephemeral-key.md

@@ -9,7 +9,7 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.createEphemeralKey({
-    scopes: [sdk.Scopes.ProjectRead],
+    scopes: [sdk.ProjectKeyScopes.ProjectRead],
     duration: 600
 });
 ```

docs/examples/project/create-key.md

@@ -11,7 +11,7 @@ const project = new sdk.Project(client);
 const result = await project.createKey({
     keyId: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [sdk.Scopes.ProjectRead],
+    scopes: [sdk.ProjectKeyScopes.ProjectRead],
     expire: '2020-10-15T06:38:00.000+00:00' // optional
 });
 ```

docs/examples/project/get-email-template.md

@@ -9,7 +9,7 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.getEmailTemplate({
-    templateId: sdk.EmailTemplateType.Verification,
-    locale: sdk.EmailTemplateLocale.Af // optional
+    templateId: sdk.ProjectEmailTemplateId.Verification,
+    locale: sdk.ProjectEmailTemplateLocale.Af // optional
 });
 ```

docs/examples/project/get-o-auth-2-provider.md

@@ -9,6 +9,6 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.getOAuth2Provider({
-    providerId: sdk.OAuthProvider.Amazon
+    providerId: sdk.ProjectOAuthProviderId.Amazon
 });
 ```

docs/examples/project/get-policy.md

@@ -9,6 +9,6 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.getPolicy({
-    policyId: sdk.ProjectPolicy.PasswordDictionary
+    policyId: sdk.ProjectPolicyId.PasswordDictionary
 });
 ```

docs/examples/project/get.md

@@ -0,0 +1,12 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.get();
+```

docs/examples/project/update-auth-method.md

@@ -9,7 +9,7 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.updateAuthMethod({
-    methodId: sdk.AuthMethod.EmailPassword,
+    methodId: sdk.ProjectAuthMethodId.EmailPassword,
     enabled: false
 });
 ```

docs/examples/project/update-deny-aliased-email-policy.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.updateDenyAliasedEmailPolicy({
+    enabled: false
+});
+```

docs/examples/project/update-deny-disposable-email-policy.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.updateDenyDisposableEmailPolicy({
+    enabled: false
+});
+```

docs/examples/project/update-deny-free-email-policy.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.updateDenyFreeEmailPolicy({
+    enabled: false
+});
+```

docs/examples/project/update-email-template.md

@@ -9,8 +9,8 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.updateEmailTemplate({
-    templateId: sdk.EmailTemplateType.Verification,
-    locale: sdk.EmailTemplateLocale.Af, // optional
+    templateId: sdk.ProjectEmailTemplateId.Verification,
+    locale: sdk.ProjectEmailTemplateLocale.Af, // optional
     subject: '<SUBJECT>', // optional
     message: '<MESSAGE>', // optional
     senderName: '<SENDER_NAME>', // optional

docs/examples/project/update-key.md

@@ -11,7 +11,7 @@ const project = new sdk.Project(client);
 const result = await project.updateKey({
     keyId: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [sdk.Scopes.ProjectRead],
+    scopes: [sdk.ProjectKeyScopes.ProjectRead],
     expire: '2020-10-15T06:38:00.000+00:00' // optional
 });
 ```

docs/examples/project/update-o-auth-2-google.md

@@ -11,6 +11,7 @@ const project = new sdk.Project(client);
 const result = await project.updateOAuth2Google({
     clientId: '<CLIENT_ID>', // optional
     clientSecret: '<CLIENT_SECRET>', // optional
+    prompt: [sdk.ProjectOAuth2GooglePrompt.None], // optional
     enabled: false // optional
 });
 ```

docs/examples/project/update-protocol.md

@@ -9,7 +9,7 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.updateProtocol({
-    protocolId: sdk.ProtocolId.Rest,
+    protocolId: sdk.ProjectProtocolId.Rest,
     enabled: false
 });
 ```

docs/examples/project/update-service.md

@@ -9,7 +9,7 @@ const client = new sdk.Client()
 const project = new sdk.Project(client);
 
 const result = await project.updateService({
-    serviceId: sdk.ServiceId.Account,
+    serviceId: sdk.ProjectServiceId.Account,
     enabled: false
 });
 ```

docs/examples/project/update-smtp.md

@@ -17,7 +17,7 @@ const result = await project.updateSMTP({
     senderName: '<SENDER_NAME>', // optional
     replyToEmail: 'email@example.com', // optional
     replyToName: '<REPLY_TO_NAME>', // optional
-    secure: sdk.Secure.Tls, // optional
+    secure: sdk.ProjectSMTPSecure.Tls, // optional
     enabled: false // optional
 });
 ```

docs/examples/usage/list-events.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const usage = new sdk.Usage(client);
+
+const result = await usage.listEvents({
+    queries: [], // optional
+    total: false // optional
+});
+```