Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 8 additions & 6 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ on:
types: [published]
workflow_dispatch:

permissions:
id-token: write
contents: read

jobs:
publish:
runs-on: ubuntu-latest
Expand All @@ -16,7 +20,7 @@ jobs:
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
node-version: '22'
registry-url: 'https://registry.npmjs.org'

# Determine release tag based on the tag name
Expand All @@ -29,14 +33,12 @@ jobs:
echo "tag=latest" >> "$GITHUB_OUTPUT"
fi

# Install dependencies (if any) and build your project (if necessary)
# Install dependencies and build
- name: Install dependencies and build
run: |
npm install
npm ci
npm run build

# Publish to NPM with the appropriate tag
- name: Publish
run: npm publish --tag ${{ steps.release_tag.outputs.tag }}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_NO_ORG }}
run: npm publish --provenance --access public --tag ${{ steps.release_tag.outputs.tag }}
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## 2.0.0

* Update SDK examples to use object-based parameters instead of positional arguments
* Align all service method usage with the new API signature style
* Update publish workflow to use trusted publishing mechanism

## 1.10.0

* Fix autocompletion not working for `Document` model even when generic is passed
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Appwrite Console SDK

![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.0-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)

**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**

Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

Expand All @@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:

```html
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.10.0"></script>
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@2.0.0"></script>
```


Expand Down
16 changes: 8 additions & 8 deletions docs/examples/account/create-billing-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ const client = new Client()

const account = new Account(client);

const result = await account.createBillingAddress(
'<COUNTRY>', // country
'<STREET_ADDRESS>', // streetAddress
'<CITY>', // city
'<STATE>', // state
'<POSTAL_CODE>', // postalCode (optional)
'<ADDRESS_LINE2>' // addressLine2 (optional)
);
const result = await account.createBillingAddress({
country: '<COUNTRY>',
city: '<CITY>',
streetAddress: '<STREET_ADDRESS>',
addressLine2: '<ADDRESS_LINE2>', // optional
state: '<STATE>', // optional
postalCode: '<POSTAL_CODE>' // optional
});

console.log(result);
8 changes: 4 additions & 4 deletions docs/examples/account/create-email-password-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ const client = new Client()

const account = new Account(client);

const result = await account.createEmailPasswordSession(
'email@example.com', // email
'password' // password
);
const result = await account.createEmailPasswordSession({
email: 'email@example.com',
password: 'password'
});

console.log(result);
10 changes: 5 additions & 5 deletions docs/examples/account/create-email-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ const client = new Client()

const account = new Account(client);

const result = await account.createEmailToken(
'<USER_ID>', // userId
'email@example.com', // email
false // phrase (optional)
);
const result = await account.createEmailToken({
userId: '<USER_ID>',
email: 'email@example.com',
phrase: false // optional
});

console.log(result);
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.updateMagicURLSession(
'<USER_ID>', // userId
'<SECRET>' // secret
);
const result = await account.createEmailVerification({
url: 'https://example.com'
});

console.log(result);
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.updateMFA(
false // mfa
);
const result = await account.createJWT({
duration: 0 // optional
});

console.log(result);
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ const client = new Client()

const account = new Account(client);

const result = await account.createMagicURLToken(
'<USER_ID>', // userId
'email@example.com', // email
'https://example.com', // url (optional)
false // phrase (optional)
);
const result = await account.createMagicURLToken({
userId: '<USER_ID>',
email: 'email@example.com',
url: 'https://example.com', // optional
phrase: false // optional
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/create-mfa-authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.createMfaAuthenticator(
AuthenticatorType.Totp // type
);
const result = await account.createMFAAuthenticator({
type: AuthenticatorType.Totp
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/create-mfa-challenge.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.createMfaChallenge(
AuthenticationFactor.Email // factor
);
const result = await account.createMFAChallenge({
factor: AuthenticationFactor.Email
});

console.log(result);
2 changes: 1 addition & 1 deletion docs/examples/account/create-mfa-recovery-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ const client = new Client()

const account = new Account(client);

const result = await account.createMfaRecoveryCodes();
const result = await account.createMFARecoveryCodes();

console.log(result);
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ const client = new Client()

const account = new Account(client);

account.createOAuth2Token(
OAuthProvider.Amazon, // provider
'https://example.com', // success (optional)
'https://example.com', // failure (optional)
[] // scopes (optional)
);
account.createOAuth2Session({
provider: OAuthProvider.Amazon,
success: 'https://example.com', // optional
failure: 'https://example.com', // optional
scopes: [] // optional
});

Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ const client = new Client()

const account = new Account(client);

account.createOAuth2Session(
OAuthProvider.Amazon, // provider
'https://example.com', // success (optional)
'https://example.com', // failure (optional)
[] // scopes (optional)
);
account.createOAuth2Token({
provider: OAuthProvider.Amazon,
success: 'https://example.com', // optional
failure: 'https://example.com', // optional
scopes: [] // optional
});

8 changes: 4 additions & 4 deletions docs/examples/account/create-phone-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ const client = new Client()

const account = new Account(client);

const result = await account.createPhoneToken(
'<USER_ID>', // userId
'+12065550100' // phone
);
const result = await account.createPhoneToken({
userId: '<USER_ID>',
phone: '+12065550100'
});

console.log(result);
10 changes: 5 additions & 5 deletions docs/examples/account/create-push-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ const client = new Client()

const account = new Account(client);

const result = await account.createPushTarget(
'<TARGET_ID>', // targetId
'<IDENTIFIER>', // identifier
'<PROVIDER_ID>' // providerId (optional)
);
const result = await account.createPushTarget({
targetId: '<TARGET_ID>',
identifier: '<IDENTIFIER>',
providerId: '<PROVIDER_ID>' // optional
});

console.log(result);
8 changes: 4 additions & 4 deletions docs/examples/account/create-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ const client = new Client()

const account = new Account(client);

const result = await account.createRecovery(
'email@example.com', // email
'https://example.com' // url
);
const result = await account.createRecovery({
email: 'email@example.com',
url: 'https://example.com'
});

console.log(result);
8 changes: 4 additions & 4 deletions docs/examples/account/create-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ const client = new Client()

const account = new Account(client);

const result = await account.createSession(
'<USER_ID>', // userId
'<SECRET>' // secret
);
const result = await account.createSession({
userId: '<USER_ID>',
secret: '<SECRET>'
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/create-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.createVerification(
'https://example.com' // url
);
const result = await account.createVerification({
url: 'https://example.com'
});

console.log(result);
12 changes: 6 additions & 6 deletions docs/examples/account/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ const client = new Client()

const account = new Account(client);

const result = await account.create(
'<USER_ID>', // userId
'email@example.com', // email
'', // password
'<NAME>' // name (optional)
);
const result = await account.create({
userId: '<USER_ID>',
email: 'email@example.com',
password: '',
name: '<NAME>' // optional
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-billing-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deleteBillingAddress(
'<BILLING_ADDRESS_ID>' // billingAddressId
);
const result = await account.deleteBillingAddress({
billingAddressId: '<BILLING_ADDRESS_ID>'
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deleteIdentity(
'<IDENTITY_ID>' // identityId
);
const result = await account.deleteIdentity({
identityId: '<IDENTITY_ID>'
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-mfa-authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deleteMfaAuthenticator(
AuthenticatorType.Totp // type
);
const result = await account.deleteMFAAuthenticator({
type: AuthenticatorType.Totp
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-payment-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deletePaymentMethod(
'<PAYMENT_METHOD_ID>' // paymentMethodId
);
const result = await account.deletePaymentMethod({
paymentMethodId: '<PAYMENT_METHOD_ID>'
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-push-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deletePushTarget(
'<TARGET_ID>' // targetId
);
const result = await account.deletePushTarget({
targetId: '<TARGET_ID>'
});

console.log(result);
6 changes: 3 additions & 3 deletions docs/examples/account/delete-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const client = new Client()

const account = new Account(client);

const result = await account.deleteSession(
'<SESSION_ID>' // sessionId
);
const result = await account.deleteSession({
sessionId: '<SESSION_ID>'
});

console.log(result);
Loading