❤
npm
Sign UpSign In

submarine-js

0.5.5 • Public • Published

Submarine.js

Submarine.js is a Javascript library that targets the browser.

It's designed to make it easy for developers to integrate Shopify Plus stores with Submarine, a platform for designing bespoke tokenised payment experiences like subscriptions, presales, and one-click upsells. The platform (and this repository) is built and maintained by Disco Labs, a Shopify Plus partner agency.

Table of Contents

Usage

Depending on how you're building your Shopify theme, you can integrate Submarine.js in a couple of different ways.

The first (and simplest) is to import the client library on the pages you want to interact with Submarine via a <script> tag, for example:

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/submarine-js@0.4.0-beta.2/dist/submarine.js"></script>

Alternatively, if you're using your own build process for your theme via Webpacker or similar, you can add Submarine.js as a dependency to your project and import it:

npm install @discolabs/submarine-js

or

yarn add @discolabs/submarine-js

and then:

// assuming you're using ES modules
import { Submarine } from 'submarine-js';

Initialisation

The Submarine.js library provides a Submarine class, which should be initialised with environmental context so that API calls can successfully be made:

const submarine = new Submarine.Submarine({
  environment: "staging",
  authentication: {
    customer_id: "6211133636859",
    shop: "submarine-js.myshopify.com"
  }
});

The environment initialisation option tells the client which API endpoint to make requests against.

The authentication initialisation options provides the customer_id and the corresponding shop which will later be used in the authentication flow.

Authentication

submarine.js uses JSON Web Tokens (JWTs) for authenticating client side requests, and returning sensitive customer information via the JWTs encoded tokens.

This allows for the exchange of customer and shop information with the client.

Here's an example of how you can initialise the Submarine client library within a Liquid template in your Shopify theme:

    <script src="{{'https://cdn.jsdelivr.net/npm/submarine-js@0.4.0-beta.2/dist/submarine.js)' | asset_url }}"></script>

    <script>
      window.submarine = new window.Submarine.Submarine({
        environment: "dev",
        authentication: {
          shop: "{{ shop.permanent_domain }}",
          customer_id: "{{ customer.id }}"
        }
      });
     </script>

Once past this step you will be able to access your subscriptions via the console.

  window.submarine.api.getSubscriptions(sub => console.log(sub));

Above will give you a list of your existing subscriptions attached to your initialised shop.

Making API Calls

Once you have an initialised client, making API calls is pretty simple:

const submarine = new Submarine({ ...config });

submarine.api.getSubscriptions((subscriptions, errors) => {
  if(errors) {
    // handle errors here
    return;
  }

  // handle success here
  console.log(subscriptions);
});

All API calls take a callback function argument with a (result, errors) signature. Your callback function should check for the presence of errors, handle it as needed, and otherwise process the result.

Reference

This section describes each of the API methods available via the client, their method signature, and an example usage. Full details of all request/response parameters are available on the Submarine Hub.

Payment methods

Get payment methods

Get a list of payment methods for the currently authenticated customer.

submarine.api.getPaymentMethods((paymentMethods, errors) => {
  // paymentMethods is an array of stored payment methods
});

Create a payment method

Create a new payment method for the currently authenticated customer.

submarine.api.createPaymentMethod({
  payment_token: "abc123",
  payment_method_type: "credit-card",
  payment_processor: "stripe",
  status: "active"
}, (createdPaymentMethod, errors) => {
  // createdPaymentMethod is the newly stored payment method
});

Learn more about the attributes used to create a new payment method here.

Get a payment method

Get the specified payment method for the currently authenticated customer.

submarine.api.getPaymentMethod(1750, (paymentMethod, errors) => {
  // paymentMethod is the specified stored payment method
});

Update a payment method

Update the specified payment method for the currently authenticated customer.

submarine.api.updatePaymentMethod(1750, {
    default: false,
    status: "disabled"
  },
  (paymentMethod, errors) => {
    // paymentMethod is the updated payment method
  }
);

Remove a payment method

Remove the specified payment method for the currently authenticated customer.

submarine.api.removePaymentMethod(1750,
  (paymentMethod, errors) => {
    // paymentMethod is the removed payment method
  }
);

Subscriptions

Get subscriptions

Get a list of subscriptions for the currently authenticated customer.

submarine.api.getSubscriptions((subscriptions, errors) => {
  // subscriptions is an array of subscriptions
});

Bulk update subscriptions

Update multiple subscriptions at once for the currently authenticated customer.

submarine.api.bulkUpdateSubscriptions([1212, 1245], {
    payment_method_id: 345
  },
  (results, errors) => {
    // results is an object with two array attributes, `successes` and `failures`
  }
);

Get a subscription

Get a specific subscription for the currently authenticated customer.

submarine.api.getSubscription(1212, (subscription, errors) => {
  // subscription is the specified subscription
});

Update a subscription

Update the specified subscription for the currently authenticated customer.

submarine.api.updateSubscription(1212, {
    status: "paused"
  },
  (subscription, errors) => {
    // subscription is the updated subscription
  }
);

Learn more about the attributes used to update subscriptions here.

Duplicate a subscription

Duplicate the specified subscription for the currently authenticated customer.

submarine.api.duplicateSubscription(1212,
  (subscription, errors) => {
    // subscription is the newly duplicated subscription
  }
);

Upsells

Create an upsell

Create an upsell for the specified order.

submarine.api.createUpsell(394573949234, {
    variant_id: 2384723942,
    quantity: 2,
    notify_customer: false
  },
  (subscription, errors) => {
    // subscription is the newly duplicated subscription
  }
);

Other

Generate a payment processor client token

Generate a client token for the specified payment processor.

submarine.api.generatePaymentProcessorClientToken('braintree',
  (clientToken, errors) => {
    // clientToken is a client-side token
  }
);

Development

Dependencies for this project are listed in the package.json. Before you start developing, ensure you have NPM and Yarn installed, then:

git clone https://github.com/discolabs/submarine-js.git
cd submarine-js
yarn

The library uses Vite to provide a streamlined development experience with hot module reloading, alongside distribution building.

Running yarn dev from the command line will spin up a local development page that can be accessed from the browser. This page also generates a set of development credentials that can be used to make real requests against the Submarine API from the browser.

Licence

The Submarine JavaScript API Client is an open-sourced software licensed under the MIT license.

Readme

Keywords

Package Sidebar

Install

npm i submarine-js

Repository

github.com/discolabs/submarine-js

Homepage

github.com/discolabs/submarine-js#readme

Weekly Downloads

1

Version

0.5.5

License

none

Unpacked Size

39.9 kB

Total Files

6

Last publish

Collaborators

  • gavinballard
Try on RunKit
Report malware