{"id":13343926,"url":"https://github.com/zeplin/javascript-sdk","last_synced_at":"2025-12-24T11:40:43.975Z","repository":{"id":46245552,"uuid":"366344448","full_name":"zeplin/javascript-sdk","owner":"zeplin","description":"Zeplin API client for JavaScript","archived":false,"fork":false,"pushed_at":"2025-06-12T11:22:09.000Z","size":372,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-06-12T11:26:18.147Z","etag":null,"topics":["javascript-sdk","typescript-sdk","zeplin","zeplin-api","zeplin-client","zeplin-sdk"],"latest_commit_sha":null,"homepage":"https://docs.zeplin.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeplin.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2021-05-11T10:35:27.000Z","updated_at":"2025-06-12T11:22:11.000Z","dependencies_parsed_at":"2024-05-10T12:42:42.558Z","dependency_job_id":"a12e56e6-3f11-411e-bca8-d8feb8a19f9a","html_url":"https://github.com/zeplin/javascript-sdk","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/zeplin/javascript-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fjavascript-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fjavascript-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fjavascript-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fjavascript-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeplin","download_url":"https://codeload.github.com/zeplin/javascript-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fjavascript-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264535988,"owners_count":23624404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["javascript-sdk","typescript-sdk","zeplin","zeplin-api","zeplin-client","zeplin-sdk"],"created_at":"2024-07-29T19:32:05.448Z","updated_at":"2025-12-24T11:40:43.932Z","avatar_url":"https://github.com/zeplin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zeplin JavaScript SDK\n[![@latest](https://img.shields.io/npm/v/@zeplin/sdk.svg)](https://www.npmjs.com/package/@zeplin/sdk)\n[![@latest](https://img.shields.io/npm/l/@zeplin/sdk.svg)](https://www.npmjs.com/package/@zeplin/sdk)\n\nOfficial JavaScript interface to the [Zeplin API](https://docs.zeplin.dev). It works in both Node.js and web browser environments.\n\n## Installation\n\n```\nnpm install @zeplin/sdk\n```\n\nor\n\n```\nyarn add @zeplin/sdk\n```\n\n## Getting started\n\nTo get started with the SDK, you can create a personal access token from the web app under [Developer](https://app.zeplin.io/profile/developer) tab in your profile page.\n\nYou can use this token to make API calls for your own Zeplin account.\n\n```js\nimport { ZeplinApi, Configuration } from \"@zeplin/sdk\";\n\nconst zeplinClient = new ZeplinApi(new Configuration({ accessToken: \"ACCESS_TOKEN\" }));\n\nconst me = await zeplinClient.getCurrentUser();\n\n```\n\n### OAuth\nIf you want to build an application for other Zeplin users, you can also create a Zeplin app the [profile page](https://app.zeplin.io/profile/developer).\n\n\nCheck out this [example](./examples/oauth-app) to see how you can implement an OAuth flow using the SDK.\n\n## Usage\n\nThe SDK exposes Zeplin API endpoints as methods. These methods are grouped into namespace objects by the type of object they interact with.\n\nFor example:\n```js\nimport { ZeplinApi, Configuration, ScreenNoteColorNameEnum } from \"@zeplin/sdk\";\n\nconst zeplinClient = new ZeplinApi(new Configuration({ accessToken: \"ACCESS_TOKEN\" }));\n\n// Get colors in the styleguide\nzeplinClient.colors.getStyleguideColors(\"STYLEGUIDE_ID\");\n\n// Add a note on the screen\nzeplinClient.screens.createScreenNote(\"PROJECT_ID\", \"SCREEN_ID\", {\n    content: \"Çaylar filiz! :turkish_tea:\",\n    position: { x: 0.1, y: 0.1 },\n    color: ScreenNoteColorNameEnum.DEEP_PURPLE\n});\n\n// Invite a member to the workspace\nzeplinClient.organizations.inviteOrganizationMember(\"ORGANIZATION_ID\", {\n    handle: \"rooolan\",\n    role: \"editor\"\n});\n```\n\nCheck out the [API documentation](https://docs.zeplin.dev/reference) for complete list of endpoints and groups.\n\n## Examples\n\n- [Command-line app using personal access token](./examples/cli-with-personal-access-token)\n- [Simple OAuth application](./examples/oauth-app)\n- [Publishing screens and screen versions](./examples/publishing-screens)\n\n## License\n\nThe project is available as open source under the terms of the [MIT License](LICENSE).\n\n## Need help?\n\nPing us at dx@zeplin.io for any feedback or questions. You can also find us in the [Zeplin Developer Slack](https://zpl.io/zeplin-dev-slack) group!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fjavascript-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeplin%2Fjavascript-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fjavascript-sdk/lists"}