{"id":13447687,"url":"https://github.com/appwrite/sdk-for-web","last_synced_at":"2026-02-23T08:06:57.664Z","repository":{"id":38399566,"uuid":"174654219","full_name":"appwrite/sdk-for-web","owner":"appwrite","description":"[READ-ONLY] Official Appwrite Web SDK 🧡","archived":false,"fork":false,"pushed_at":"2026-02-19T12:46:59.000Z","size":14831,"stargazers_count":331,"open_issues_count":2,"forks_count":62,"subscribers_count":15,"default_branch":"main","last_synced_at":"2026-02-21T12:11:43.410Z","etag":null,"topics":["angular","appwrite","baas","hacktoberfest","javascript","js","mbaas","reactjs","typescript","vue","vuejs","web"],"latest_commit_sha":null,"homepage":"https://appwrite.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appwrite.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-03-09T05:50:28.000Z","updated_at":"2026-02-19T12:24:03.000Z","dependencies_parsed_at":"2024-01-04T03:25:56.789Z","dependency_job_id":"4eff4231-1495-4678-b6bd-fda65ed9755a","html_url":"https://github.com/appwrite/sdk-for-web","commit_stats":{"total_commits":187,"total_committers":12,"mean_commits":"15.583333333333334","dds":"0.47058823529411764","last_synced_commit":"3457d79ed8bccfdf65d106f3745533479e4ab2f4"},"previous_names":["appwrite/sdk-for-js"],"tags_count":64,"template":false,"template_full_name":null,"purl":"pkg:github/appwrite/sdk-for-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appwrite","download_url":"https://codeload.github.com/appwrite/sdk-for-web/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-web/sbom","scorecard":{"id":204241,"data":{"date":"2025-08-11","repo":{"name":"github.com/appwrite/sdk-for-web","commit":"f7316fddd9d294045f80b08c1770ffc5b6ee0aee"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.7,"checks":[{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"22 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/autoclose.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/autoclose.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/appwrite/sdk-for-web/autoclose.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/appwrite/sdk-for-web/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/appwrite/sdk-for-web/publish.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:35","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":9,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/appwrite/.github/SECURITY.md:1","Info: Found linked content: github.com/appwrite/.github/SECURITY.md:1","Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy","Info: Found text in security policy: github.com/appwrite/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:9"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T23:21:30.660Z","repository_id":38399566,"created_at":"2025-08-16T23:21:30.660Z","updated_at":"2025-08-16T23:21:30.660Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29739806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","appwrite","baas","hacktoberfest","javascript","js","mbaas","reactjs","typescript","vue","vuejs","web"],"created_at":"2024-07-31T05:01:24.393Z","updated_at":"2026-02-23T08:06:57.654Z","avatar_url":"https://github.com/appwrite.png","language":"TypeScript","readme":"# Appwrite Web SDK\n\n![License](https://img.shields.io/github/license/appwrite/sdk-for-web.svg?style=flat-square)\n![Version](https://img.shields.io/badge/api%20version-1.8.1-blue.svg?style=flat-square)\n[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)\n[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee\u0026label=twitter\u0026style=flat-square)](https://twitter.com/appwrite)\n[![Discord](https://img.shields.io/discord/564160730845151244?label=discord\u0026style=flat-square)](https://appwrite.io/discord)\n\n**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/releases).**\n\nAppwrite 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 Web 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)\n\n![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)\n\n## Installation\n\n### NPM\n\nTo install via [NPM](https://www.npmjs.com/):\n\n```bash\nnpm install appwrite --save\n```\n\nIf you're using a bundler (like [Rollup](https://rollupjs.org/) or [webpack](https://webpack.js.org/)), you can import the Appwrite module when you need it:\n\n```js\nimport { Client, Account } from \"appwrite\";\n```\n\n### CDN\n\nTo install with a CDN (content delivery network) add the following scripts to the bottom of your \u003cbody\u003e tag, but before you use any Appwrite services:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/appwrite@22.4.1\"\u003e\u003c/script\u003e\n```\n\n\n## Getting Started\n\n### Add your Web Platform\n\nFor you to init your SDK and interact with Appwrite services you need to add a web platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before and click the 'Add Platform' button.\n\nFrom the options, choose to add a **Web** platform and add your client app hostname. By adding your hostname to your project platform you are allowing cross-domain communication between your project and the Appwrite API.\n\n### Init your SDK\n\nInitialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.\n\n```js\n// Init your Web SDK\nconst client = new Client();\n\nclient\n    .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint\n    .setProject('455x34dfkj') // Your project ID\n;\n```\n\n### Make Your First Request\n\nOnce your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.\n\n```js\nconst account = new Account(client);\n\n// Register User\naccount.create(ID.unique(), \"email@example.com\", \"password\", \"Walter O'Brien\")\n    .then(function (response) {\n        console.log(response);\n    }, function (error) {\n        console.log(error);\n    });\n\n```\n\n### Full Example\n\n```js\n// Init your Web SDK\nconst client = new Client();\n\nclient\n    .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint\n    .setProject('455x34dfkj')\n;\n\nconst account = new Account(client);\n\n// Register User\naccount.create(ID.unique(), \"email@example.com\", \"password\", \"Walter O'Brien\")\n    .then(function (response) {\n        console.log(response);\n    }, function (error) {\n        console.log(error);\n    });\n```\n\n### Type Safety with Models\n\nThe Appwrite Web SDK provides type safety when working with database documents through generic methods. Methods like `listDocuments`, `getDocument`, and others accept a generic type parameter that allows you to specify your custom model type for full type safety.\n\n**TypeScript:**\n```typescript\ninterface Book {\n    name: string;\n    author: string;\n    releaseYear?: string;\n    category?: string;\n    genre?: string[];\n    isCheckedOut: boolean;\n}\n\nconst databases = new Databases(client);\n\ntry {\n    const documents = await databases.listDocuments\u003cBook\u003e(\n        'your-database-id',\n        'your-collection-id'\n    );\n    \n    documents.documents.forEach(book =\u003e {\n        console.log(`Book: ${book.name} by ${book.author}`); // Now you have full type safety\n    });\n} catch (error) {\n    console.error('Appwrite error:', error);\n}\n```\n\n**JavaScript (with JSDoc for type hints):**\n```javascript\n/**\n * @typedef {Object} Book\n * @property {string} name\n * @property {string} author\n * @property {string} [releaseYear]\n * @property {string} [category]\n * @property {string[]} [genre]\n * @property {boolean} isCheckedOut\n */\n\nconst databases = new Databases(client);\n\ntry {\n    /** @type {Models.DocumentList\u003cBook\u003e} */\n    const documents = await databases.listDocuments(\n        'your-database-id',\n        'your-collection-id'\n    );\n    \n    documents.documents.forEach(book =\u003e {\n        console.log(`Book: ${book.name} by ${book.author}`); // Type hints available in IDE\n    });\n} catch (error) {\n    console.error('Appwrite error:', error);\n}\n```\n\n**Tip**: You can use the `appwrite types` command to automatically generate TypeScript interfaces based on your Appwrite database schema. Learn more about [type generation](https://appwrite.io/docs/products/databases/type-generation).\n\n### Error Handling\n\nThe Appwrite Web SDK raises an `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching the exception and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.\n\n```javascript\ntry {\n    const user = await account.create(ID.unique(), \"email@example.com\", \"password\", \"Walter O'Brien\");\n    console.log('User created:', user);\n} catch (error) {\n    console.error('Appwrite error:', error.message);\n}\n```\n\n### Learn more\n\nYou can use the following resources to learn more and get help\n- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-web)\n- 📜 [Appwrite Docs](https://appwrite.io/docs)\n- 💬 [Discord Community](https://appwrite.io/discord)\n- 🚂 [Appwrite Web Playground](https://github.com/appwrite/playground-for-web)\n\n\n## Contribution\n\nThis library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.\n\n## License\n\nPlease see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.","funding_links":[],"categories":["JavaScript","SDK","TypeScript"],"sub_categories":["Official Appwrite SDKs"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappwrite%2Fsdk-for-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-web/lists"}