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

@apolitical/sdk

v10.5.2

Published

Browser library to interact with Apolitical's APIs

Downloads

6,601

Readme

Apolitical SDK

Browser library to interact with Apolitical's APIs

Requirements

Requires the following to run:

Installation

Install with yarn:

yarn add @apolitical/sdk

Available Scripts

In the project directory, you can run:

yarn test

Runs the test (and the interactive mode can be enabled with --watchAll).

yarn build

Builds the library for production to the build folder. It correctly bundles the code on production mode and optimizes the build for the best performance.

Usage

The recommended way to use @apolitical/sdk is to load the SDK first:

const loadSdk = require('@apolitical/sdk');

const sdk = loadSdk({
  origin: window.origin || window.location.origin,
  errorsContext: {
    apiKey: decodeBase64(process.env.REACT_APP_GCP_ERRORS_API_KEY),
    serviceName: 'some-service',
  },
});

And then, you can use all the functionality provided by the SDK. For example:

sdk.people.users.read('me').then((result) => {
  console.info('User:', result);
});

Folders & files structure

Here's the library's folders structure:

/lib
  /apis
    /api-1
      /resources
      /handlers
  /contentful
    /content-type-1
  /helpers
  /solvers

APIs folder

Under /lib/apis/ we implement functionality to directly interact with the Apolitical APIs.

Each API will have its own folder, for example, /lib/apis/people/ for People API.

Inside the API folder itself, there are two other folders

  • /lib/apis/people/resources: The resources folder holds each RESTful resource on the API and implements CRUD operations
  • /lib/apis/people/handlers: The handlers folder holds functions that require calling the same API more than one time (or in some particular way that cannot be done by using the CRUD operations)

Contentful folder

Under /lib/contentful/ we implement functionality to interact with Contentful Delivery (and Preview) API.

Each content type will have it's own folder, for example, /lib/contentful/questions/ for the Q&A Question content type.

Internally, the functionality will be implemented with the help of the @apolitical/content module.

Helpers folder

Under /lib/helpers/ we implement reusable functionality that helps implementing internal logic within the SDK.

Solvers folder

Under /lib/solvers/ we implement high level functionality based on the functionality provided by internal APIs and Contentful.

For example, the buildQuestion.js is a function that reads a question from Contentful, and then, read the author data from the People API.