npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@zeplin/sdk

v1.25.0

Published

Zeplin API client for JavaScript

Downloads

67,229

Readme

Zeplin JavaScript SDK

@latest @latest

Official JavaScript interface to the Zeplin API. It works in both Node.js and web browser environments.

Installation

npm install @zeplin/sdk

or

yarn add @zeplin/sdk

Getting started

To get started with the SDK, you can create a personal access token from the web app under Developer tab in your profile page.

You can use this token to make API calls for your own Zeplin account.

import { ZeplinApi, Configuration } from "@zeplin/sdk";

const zeplinClient = new ZeplinApi(new Configuration({ accessToken: "ACCESS_TOKEN" }));

const me = await zeplinClient.getCurrentUser();

OAuth

If you want to build an application for other Zeplin users, you can also create a Zeplin app the profile page.

Check out this example to see how you can implement an OAuth flow using the SDK.

Usage

The SDK exposes Zeplin API endpoints as methods. These methods are grouped into namespace objects by the type of object they interact with.

For example:

import { ZeplinApi, Configuration, ScreenNoteColorNameEnum } from "@zeplin/sdk";

const zeplinClient = new ZeplinApi(new Configuration({ accessToken: "ACCESS_TOKEN" }));

// Get colors in the styleguide
zeplinClient.colors.getStyleguideColors("STYLEGUIDE_ID");

// Add a note on the screen
zeplinClient.screens.createScreenNote("PROJECT_ID", "SCREEN_ID", {
    content: "Çaylar filiz! :turkish_tea:",
    position: { x: 0.1, y: 0.1 },
    color: ScreenNoteColorNameEnum.DEEP_PURPLE
});

// Invite a member to the workspace
zeplinClient.organizations.inviteOrganizationMember("ORGANIZATION_ID", {
    handle: "rooolan",
    role: "editor"
});

Check out the API documentation for complete list of endpoints and groups.

Examples

License

The project is available as open source under the terms of the MIT License.

Need help?

Ping us at [email protected] for any feedback or questions. You can also find us in the Zeplin Developer Slack group!