Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@proca/api

Package Overview
Dependencies
Maintainers
3
Versions
58
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@proca/api

Client library for Proca API

  • 2.3.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
decreased by-33.33%
Maintainers
3
Weekly downloads
 
Created
Source

Generate Sdk matching GraphQL schema and operations

  1. Run mix absinthe.schema.sdl --schema ProcaWeb.Schema in proca-backend repository
  2. Move schema.graphql to schema/
  3. Run npm run generate

Usage

Package exports two SDK's, dedicated to:

  • proca widget - contains functions to fetch action page data, relevant campaign statistics, store contact and action data.
  • proca admin panel or CLI - contains functions for organisation, user, campaign, acton page management, as well as contact and action data export.

Simple example:

  import {client, getWidgetSdk, getAdminSdk} from '@proca/api'

  // create a new GraphQL client
  const client = new client("https://api-stg.proca.app/api")

  const sdk = widgetSdk(client)
  
  try {
    const actionPage = await sdk.GetActionPage({"name": "tttp.eu/campaign-non-commercial"})
    // process
  } except (error) {
    const error = errror.response.errors[0]

    const error_code = error.extensions.code
    const error_message = error.message
    const error_path = error.path
    // handle error
  }

To use authenticated API, use authBasic or authToken:

import {authBasic} from '@proca/api'

client = authBasic(client, "user@domain.com", "password123")
sdk = adminSdk(client)

Operations in SDK

The sdk's contain operations defined in schema directory, in widget.graphql and admin.graphql. You can create queries in GraphiQL UI.

FAQs

Package last updated on 21 Apr 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc