Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

zipy-staging-nextjs

zipyai371ISC1.7.55TypeScript support: included

SDK for zipy

Zipy, sdk, for, recording, sessions

readme

ZIPY SDK

The Javascript SDK for Zipy

Installation

npm i zipy-staging-nextjs

Usage

import zipy from "zipy-staging-nextjs";
zipy.init("<app-id>");

Replace streamUrl with - "https://devcollector.zipy.ai"

Changes need to do for staging build -

Changes in config.json

  1. Replace streamMgrUrl with - "https://servicesqa.zipy.ai/sdk-session-manager/v2/enduser-info",
  2. Replace registerSessionUrl with - "https://servicesqa.zipy.ai/sdk-session-manager/v1/register-sdk-session"
  3. Replace sessionLinkUrl with - "https://appqa.zipy.ai"
  4. Replace ignoreEmptyErros with - false

Changes in sdk-config.json

  1. Replace streamUrl with - "https://qacollector.zipy.ai"

How to publish sdk in GCP Bucket -

Note: 1. Make sure you have install brotli, we are using it compress the build files

  2. While releasing npm package, make sure you change `isNPM` to `true` in config.json
  1. Run npm run build
  2. brotli -k dist/zipy.min.umd.js
  3. cp dist/zipy.min.umd.js.br dist/zipy.min.umd.js
  4. Open bucket in which we have to upload SDK (create version folder first if not exist)
  5. Create changelog.txt, update the file with release changes and upload to a bucket.
  6. Upload SDK and map file in buckets (newly generated in the root folder: ./zipy.min.umd.js)
  7. Change edit metadata of SDK, enter content-encoding to br
  8. Change edit metadata of SDK, enter cache-control to public, max-age=3600