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

tapcart-codeblocks-sdk

v1.1.0

Published

Tapcart Codeblocks™ SDK allows merchant developed codeblocks to interact with the native iOS/Android Apps.

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

chinapalacechinapalace

Keywords

Readme

Tapcart Codeblocks SDK

Tapcart Codeblocks™ SDK allows merchant developed codeblocks to interact with the native iOS/Android Apps.

Installation

All dependencies are already added into package.json. Install them using yarn.

yarn install

Building

Webpack and Babel are used to build both the vanilla and react versions of the SDK. Run the following command to build after editing src.

yarn build

The final build files are put in the dist folder.

Examples

All sample projects which use the SDK are located in the examples folder. These can be used for testing the SDK locally during development.

Vanilla

A sample server has been setup to serve the vanillaJS SDK. Once the SDK source files have been edited, run the following commands from root of the project.

yarn build
yarn serve-local

The server is setup with hot reloading so any updates to the SDK will be reflected automatically after running yarn build.

Example Usage

<!-- index.html -->

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <title>SDK Test HTML</title>
        <script type="text/javascript" defer src="http://localhost:3000/tapcart.js"></script>
        <script type="text/javascript" defer src="script.js"></script>
    </head>
    <body id="body" style="height: 100vh;">
        <div id="root"></div>
    </body>
</html>
// script.js

(function () {
	let merchantFunc = Function(`Tapcart.registerEventHandler("cart/updated",function(eventName,eventData){ console.log("Event Handler:", eventName  ,eventData); })`);
	Tapcart.registerMerchantJavascript(merchantFunc);
})()

// Test script - Simulates what app can/needs to do after loading codeblock/webview
setTimeout(function () {
	Tapcart.init({ variables: { firstName: "Gopi" } });
	Tapcart.triggerEvent("cart/updated",{"total": "10.00",currency: "USD"})
},3000);

React

To test the react SDK, yalc is used to facilitate local npm package linking.

1.) First, install yalc globally

npm i -g yalc

2.) Build/Publish to local yalc repo. Run following from project root

yarn build
yarn publish-local

3.) Run example react app from /examples/react/react-app directory

yarn codeblocks/add
yarn install
yarn start

4.) To reflect changes made to SDK in the example React App

  • Build & Publish from project root
yarn build
yarn publish-local
  • Update tapcart-codeblocks-react package in /examples/react/react-app directory
yarn codeblocks/update

Example Usage

// App.js

import {TapcartProvider,createClient} from "tapcart-codeblocks-react";
import InnerComponent from "./InnerComponent";

function App() {

  const tapcartClient = createClient({test: false});

  return (
    <div className="App">
      <TapcartProvider client={tapcartClient}>
         <InnerComponent/>
         ...
      </TapcartProvider>
    </div>

  );
}

export default App;

// InnerComponent.js

import {useActions} from "tapcart-codeblocks-react";

function InnerComponent(props) {
    let {openProduct,openCollection,openCart} = useActions();
    return <button onClick={() => openProduct("1232242232132")}>Inner Component</button>
}

export default InnerComponent;

Docs

The SDK acts as a communication bridge between the native iOS/Android Webviews and the Web Apps built by the merchants. This two way communication is powered by events and actions.

Actions allow the SDK users to interact with native app functionality via JS. The following actions are supported currently:

Tapcart.addToCart Tapcart.openProduct Tapcart.openCollection Tapcart.openCart Tapcart.applyDiscount Tapcart.applyGiftCard Tapcart.getCustomerIdentity

Events allow SDK users to respond to changes in the native apps; The following events are supported currently:

cart/updated discount/applied giftcard/applied product/opened collection/opened