Release candidate for 1.5.x

appwrite · Feb 24, 2024 · 9a9657d · 9a9657d
1 parent 2a69c35
commit 9a9657d
Show file tree

Hide file tree

Showing 307 changed files with 782 additions and 683 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,32 @@
+language: node_js
+node_js:
+  - "14.16"
+
+jobs:
+  include:
+    - stage: NPM RC Release
+      if: tag == *-rc*
+      node_js: "14.16"
+      script:
+        - npm install
+        - npm run build
+        - echo "Deploying RC to NPM..."
+      deploy:
+        provider: npm
+        email: $NPM_EMAIL
+        api_key: $NPM_API_KEY
+        tag: next
+    - stage: NPM Release
+      if: tag != *-rc*
+      node_js: "14.16"
+      script:
+        - npm install
+        - npm run build
+        - echo "Deploying to NPM..."
+      deploy:
+        provider: npm
+        email: $NPM_EMAIL
+        api_key: $NPM_API_KEY
+        skip_cleanup: true
+        on:
+          tags: true
diff --git a/README.md b/README.md
@@ -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/[email protected].12"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/[email protected].13"></script>
 ```
 
 
@@ -64,7 +64,7 @@ Once your SDK object is set, access any of the Appwrite services and choose any
 const account = new Account(client);
 
 // Register User
-account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
+account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien")
     .then(function (response) {
         console.log(response);
     }, function (error) {
@@ -86,7 +86,7 @@ client
 const account = new Account(client);
 
 // Register User
-account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
+account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien")
     .then(function (response) {
         console.log(response);
     }, function (error) {

diff --git a/.../examples/account/create2f-a-challenge.md → docs/examples/account/create-challenge.md b/.../examples/account/create2f-a-challenge.md → docs/examples/account/create-challenge.md
@@ -6,7 +6,7 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.create2FAChallenge(
+const result = await account.createChallenge(
     AuthenticationFactor.Totp // factor
 );
 

diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createEmailToken(
-    '[USER_ID]', // userId
+    '<USER_ID>', // userId
     '[email protected]', // email
     false // phrase (optional)
 );

diff --git a/docs/examples/account/create-magic-u-r-l-token.md b/docs/examples/account/create-magic-u-r-l-token.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createMagicURLToken(
-    '[USER_ID]', // userId
+    '<USER_ID>', // userId
     '[email protected]', // email
     'https://example.com', // url (optional)
     false // phrase (optional)

diff --git a/docs/examples/account/create-o-auth2session.md b/docs/examples/account/create-o-auth2session.md
@@ -10,7 +10,6 @@ account.createOAuth2Session(
     OAuthProvider.Amazon, // provider
     'https://example.com', // success (optional)
     'https://example.com', // failure (optional)
-    false, // token (optional)
     [] // scopes (optional)
 );
 
diff --git a/docs/examples/account/create-o-auth2token.md b/docs/examples/account/create-o-auth2token.md
@@ -0,0 +1,15 @@
+import { Client, Account, OAuthProvider } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+account.createOAuth2Token(
+    OAuthProvider.Amazon, // provider
+    'https://example.com', // success (optional)
+    'https://example.com', // failure (optional)
+    [] // scopes (optional)
+);
+
diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createPhoneToken(
-    '[USER_ID]', // userId
+    '<USER_ID>', // userId
     '+12065550100' // phone
 );
 

diff --git a/docs/examples/account/create-push-target.md b/docs/examples/account/create-push-target.md
@@ -7,9 +7,9 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createPushTarget(
-    '[TARGET_ID]', // targetId
-    '[IDENTIFIER]', // identifier
-    '[PROVIDER_ID]' // providerId (optional)
+    '<TARGET_ID>', // targetId
+    '<IDENTIFIER>', // identifier
+    '<PROVIDER_ID>' // providerId (optional)
 );
 
 console.log(response);
diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createSession(
-    '[USER_ID]', // userId
-    '[SECRET]' // secret
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
 );
 
 console.log(response);
diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md
@@ -7,10 +7,10 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.create(
-    '[USER_ID]', // userId
+    '<USER_ID>', // userId
     '[email protected]', // email
     '', // password
-    '[NAME]' // name (optional)
+    '<NAME>' // name (optional)
 );
 
 console.log(response);
diff --git a/docs/examples/account/delete-authenticator.md b/docs/examples/account/delete-authenticator.md
@@ -8,7 +8,7 @@ const account = new Account(client);
 
 const result = await account.deleteAuthenticator(
     AuthenticatorType.Totp, // type
-    '[OTP]' // otp
+    '<OTP>' // otp
 );
 
 console.log(response);
diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deleteIdentity(
-    '[IDENTITY_ID]' // identityId
+    '<IDENTITY_ID>' // identityId
 );
 
 console.log(response);
diff --git a/docs/examples/account/delete-push-target.md b/docs/examples/account/delete-push-target.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deletePushTarget(
-    '[TARGET_ID]' // targetId
+    '<TARGET_ID>' // targetId
 );
 
 console.log(response);
diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deleteSession(
-    '[SESSION_ID]' // sessionId
+    '<SESSION_ID>' // sessionId
 );
 
 console.log(response);
diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.getSession(
-    '[SESSION_ID]' // sessionId
+    '<SESSION_ID>' // sessionId
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-challenge.md b/docs/examples/account/update-challenge.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateChallenge(
-    '[CHALLENGE_ID]', // challengeId
-    '[OTP]' // otp
+    '<CHALLENGE_ID>', // challengeId
+    '<OTP>' // otp
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-magic-u-r-l-session.md b/docs/examples/account/update-magic-u-r-l-session.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateMagicURLSession(
-    '[USER_ID]', // userId
-    '[SECRET]' // secret
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateName(
-    '[NAME]' // name
+    '<NAME>' // name
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updatePhoneVerification(
-    '[USER_ID]', // userId
-    '[SECRET]' // secret
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-push-target.md b/docs/examples/account/update-push-target.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updatePushTarget(
-    '[TARGET_ID]', // targetId
-    '[IDENTIFIER]' // identifier
+    '<TARGET_ID>', // targetId
+    '<IDENTIFIER>' // identifier
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateRecovery(
-    '[USER_ID]', // userId
-    '[SECRET]', // secret
+    '<USER_ID>', // userId
+    '<SECRET>', // secret
     '' // password
 );
 

diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateSession(
-    '[SESSION_ID]' // sessionId
+    '<SESSION_ID>' // sessionId
 );
 
 console.log(response);
diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md
@@ -7,8 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateVerification(
-    '[USER_ID]', // userId
-    '[SECRET]' // secret
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
 );
 
 console.log(response);
diff --git a/docs/examples/account/verify-authenticator.md b/docs/examples/account/verify-authenticator.md
@@ -8,7 +8,7 @@ const account = new Account(client);
 
 const result = await account.verifyAuthenticator(
     AuthenticatorType.Totp, // type
-    '[OTP]' // otp
+    '<OTP>' // otp
 );
 
 console.log(response);
diff --git a/docs/examples/assistant/chat.md b/docs/examples/assistant/chat.md
@@ -7,7 +7,7 @@ const client = new Client()
 const assistant = new Assistant(client);
 
 const result = await assistant.chat(
-    '[PROMPT]' // prompt
+    '<PROMPT>' // prompt
 );
 
 console.log(response);
diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md
@@ -7,7 +7,7 @@ const client = new Client()
 const avatars = new Avatars(client);
 
 const result = avatars.getInitials(
-    '[NAME]', // name (optional)
+    '<NAME>', // name (optional)
     0, // width (optional)
     0, // height (optional)
     '' // background (optional)

diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md
@@ -7,7 +7,7 @@ const client = new Client()
 const avatars = new Avatars(client);
 
 const result = avatars.getQR(
-    '[TEXT]', // text
+    '<TEXT>', // text
     1, // size (optional)
     0, // margin (optional)
     false // download (optional)

diff --git a/docs/examples/databases/create-boolean-attribute.md b/docs/examples/databases/create-boolean-attribute.md
@@ -7,8 +7,8 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createBooleanAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     false, // default (optional)

diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md
@@ -7,9 +7,9 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createCollection(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[NAME]', // name
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<NAME>', // name
     ["read("any")"], // permissions (optional)
     false, // documentSecurity (optional)
     false // enabled (optional)

diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md
@@ -7,8 +7,8 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createDatetimeAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     '', // default (optional)

diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -7,9 +7,9 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createDocument(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
-    '[DOCUMENT_ID]', // documentId
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>', // documentId
     {}, // data
     ["read("any")"] // permissions (optional)
 );

diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md
@@ -7,8 +7,8 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createEmailAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     false, // required
     '[email protected]', // default (optional)

diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md
@@ -7,12 +7,12 @@ const client = new Client()
 const databases = new Databases(client);
 
 const result = await databases.createEnumAttribute(
-    '[DATABASE_ID]', // databaseId
-    '[COLLECTION_ID]', // collectionId
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
     '', // key
     [], // elements
     false, // required
-    '[DEFAULT]', // default (optional)
+    '<DEFAULT>', // default (optional)
     false // array (optional)
 );