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

@planningcenter/cc-api-client

v1.4.1

Published

A Church Center API client for the browser

Downloads

3,353

Readme

@planningcenter/cc-api-client

A Church Center API client for use in the browser.

The intended use is from a Church Center website.

  • http://subdomain.churchcenter.test
  • http://subdomain.churchcenter.com
  • http://subdomain.staging.churchcenter.com

Usage from any another origin is not supported.

Usage

Nine times out of 10 we'll get by using the pre-configured sessionApiClient.

import { sessionApiClient } from "@planningcenter/cc-api-client"

await sessionApiClient.get("/giving/v2/donations", { filter: "true" })
await sessionApiClient.post("/giving/v2/donations", { amount: 100 })

get and post use fetch behind the scenes. The resolved/rejected value is guaranteed to be an object, even for empty responses and errors! If the response is ok, the promise is resolved. If the response is not ok, the promise is rejected.

sessionApiClient has built in brains to manage authorization. It obtains an authorization token automatically. It refreshes the authorization token whenever it has gone stale.

PCO-API-Version support is baked in, with the default "2018-08-01". If we need a different API version, it can be changed at the client level, or per-request.

// Configure the client to use a different version
sessionApiClient.setGlobalConfiguration({ version: "2020-11-03" })

// Use a specific version on a single request using the third positional argument
await sessionApiClient.post(
  "/giving/v2/donations",
  { amount: 100 },
  { version: "2020-11-03" }
)

Advanced Usage

If we need a custom client, buildApiClient is available.

import { buildApiClient } from "@planningcenter/cc-api-client"

const client = buildClient({
  version: "2020-11-03",
  authorizationHeader: "advanced_usage_token",
})

// Same as the `sessionApiClient`, per-request configuration is possible
await client.get("/groups/v2", {}, { version: "2018-08-01" })

If you want to provide an authorization token manually, you can do so.

import { sessionApiClient } from "@planningcenter/cc-api-client"

const oauthToken = {"data":{"type":"Bearer",...}}
sessionApiClient.setAuthorizationToken(window.oauth_token)

Installation

Script tag on Rails

<script
  type="javascript"
  src="https://unpkg.com/@planningcenter/cc-api-client/dist/url.umd.js"
></script>
<!-- exposed as global `ChurchCenterApiClient` -->

Webpacker on Rails

yarn add @planningcenter/cc-api-client
import { sessionApiClient, buildApiClient } from "@planningcenter/cc-api-client"