@nacelle/interphase-node

Interphase Node

Interphase is Node abstraction of the Shopify Admin App (Interphase). This utility can be used in one of scripts or other Javascript/Typescript projects.

Table of Contents

• Built With
• Installation
• Directory Structure
• Serverless and Plugins
• Test Suite
• Deployment

Built With

Hail Frequency makes use of the following technology:

• Node.js
• TypeScript
• Mocha

Installation

Pre-Requisites

• TypeScript with TSC version Version 3.5.3 or greater
• Node with Version 10.15.3 or greater

Installation

• npm install @nacelle/interphase-node --save

Usage

Init

import { Interphase } from '@nacelle/interphase-node'

const store = 'starship-furniture' // Shopify Store Name
const accessToken = 'xxxxxxxxxxxxxxxxxxxx'  // Shopify GraphQL Admin API

const interphase = new Interphase(store, accessToken)

Create

const response = interphase.create({
  input: {
    namespace: 'test_namespace',
    key: 'test_key',
    ownerType: 'PRODUCT'
  }
})

Get

const response = interphase.get()

Delete

const response = interphase.delete({
  id: node.id
})

Recharge (creates all recharge metafieldVisibilities)

const response = interphase.Recharge.createAll()

Development

• Clone repo
• Run npm install via terminal inside the project directory
• Run npm run start (will watch for changes in ./src)

Test Suite

This project uses Mocha and Chai. To run tests run npm run test in your terminal.

This project expects a TDD workflow.

Contributions

• Original Author - Caleb Bodtorf