https://github.com/softmarshmallow/multipass-js

a pure typescript based shopify multipass login url generator with custom features
https://github.com/softmarshmallow/multipass-js

multipass shopify shopify-multipass ts

Last synced: 24 days ago
JSON representation

a pure typescript based shopify multipass login url generator with custom features

• Host: GitHub
• URL: https://github.com/softmarshmallow/multipass-js
• Owner: softmarshmallow
• License: mit
• Created: 2020-07-29T03:52:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-05T09:24:05.000Z (over 1 year ago)
• Last Synced: 2024-10-12T22:45:36.341Z (about 1 month ago)
• Topics: multipass, shopify, shopify-multipass, ts
• Language: TypeScript
• Homepage:
• Size: 21.5 KB
• Stars: 22
• Watchers: 2
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# multipass-js

a typesafe shopify multipass token generator, written in 100 pure typescript

> [Shopify](http://shopify.com) provides a mechanism for single sign-on known as Multipass.  Multipass uses an AES encrypted JSON hash and multipassify provides functions for generating tokens

> More details on Multipass with Shopify can be found [here](http://docs.shopify.com/api/tutorials/multipass-login).

## installation

```shell

# isntall with yarn

yarn add multipass-js

# install with npm

npm install multipass-js

```

## usages

``` typescript

import { Multipass } from "multipass-js"

const multipass = new Multipass(SHOPIFY_STORE_MULTIPASS_SECRET);

// Create your customer data hash

const email = `[email protected]`

const customerData = {

    email: email,

    user: "your database user id",

    customer: "any custom data you want"

    // ...

};

const url = multipass

    .withCustomerData(customerData)

    .withDomain("mystore.shopify.com")

    .withRedirect("products/primary").url();

// client may access shopify with `url`

// will give you URL like:  https://store.myshopify.com/account/login/multipass/

// with optional redirection

// Generate token

const token = multipass.withCustomerData(customerData).token();

```

## Shopify docs

https://shopify.dev/docs/admin-api/rest/reference/plus/multipass

## Todo

- [support webpack5](https://github.com/softmarshmallow/multipass-js/issues/5)