Synapse Release Modal

Simple plugin that will show users Synapse release notes for all changes since their last version.

Installation

npm install @buckhamduffy/synapse-release-modal

Usage

import SynapsePlugin from '@buckhamduffy/synapse-release-modal'
import '@buckhamduffy/synapse-release-modal/dist/style.css';

Vue.use(SynapsePlugin, {
    // base URL for Synapse API
    baseUrl: import.meta.env.VITE_SYNAPSE_BASE_URL || 'https://synapse.buckhamduffy.com',
    // project UUID
    projectKey: import.meta.env.VITE_SYNAPSE_PROJECT_KEY,
    currentVersion: '1.0.0',
});

Set the current user to tack acknowledgments against

SynapsePlugin.setUser({
    identifier: CryptoJS.MD5(user.email).toString(),
});