Reference — Changelog

3.2.0 (2023-12-05)

Update

• Add new light plugin button component
• Add getVideoData method to Waymark class
• Improvements to ensure videoCompleted events have the most recent render data
• Make editorOpened events include video data for the video which was opened

3.1.0 (2023-07-17)

Update

• Add support for new Waymark URL-based brand search

3.0.0 (2023-06-08)

Breaking

• Convert the SDK to TypeScript
• Remove deprecated methods

Build

• Add working esbuild build config

Chore

• Bump node version to 16 for release step, fix doc builds
• Convert jest tests to vitest, get all passing
• Ensure staged TypeScript files trigger lint-staged
• Make beta the official prerelease branch
• Remove CDN deploy step from CircleCI config
• Remove e2e testcafe tests
• Upgrade off of deprecated node-browsers docker image

Docs

• add example for using externalID to login.
• Improve documentation for kicking off business searches from openEditorForTemplate
• Remove docs for deprecated editor options, minor copy cleanup
• Remove unwanted internal method documentation from doc site
• Update docs

Fix

• Bug fixes
• Ensure either an accountID or externalID is present when validating loginAccount payload

New

• Add openWaymark method

Update

• Add error event
• Bump node version in circleci config, minor cleanup
• Enable passing businessName and businessCity options to openWaymark
• Final cleanup and fixes for PR
• Improve TypeScript typings for callbacks and events
• Replace eventemitter3, restore removed methods, get a portion of unit tests passing

3.0.0-beta.4 (2023-06-05)

Chore

• Upgrade off of deprecated node-browsers docker image

Docs

• add example for using externalID to login.
• Remove docs for deprecated editor options, minor copy cleanup
• Remove unwanted internal method documentation from doc site

Update

• Enable passing businessName and businessCity options to openWaymark

2.8.0 (2022-08-17)

Chore

• fix CI failing trying to checkout a dead branch
• Fix file path npm installs of SDK package in CI
• Fix semantic-release branch config
• Update example site e2e tests so they work with our newer example site
• Update test harness tests for kicking off a business search when opening a template

Fix

• remove problematic usage of optional chaining

New

• Add support for kicking off a business search immediately when opening a template

2.7.0 (2021-08-26)

Docs

• Add a page for Events and perform some minor cleanup

New

• Add the videoSaved event

2.6.0 (2021-06-11)

Chore

• Fix CircleCI not installing the local SDK version correctly

Docs

• Update docs to reflect that duration on template objects is a number, not a string
• Update documentation to include isPurchased flag on videos

New

• Add support for filter param on getTemplatesForCollection

2.5.0 (2021-05-13)

Update

• remove requirement for email address in account creation.

2.4.0 (2021-04-22)

Docs

• Add some link targets for publishing deep links into the documentation.

New

• Add an option for instrumenting the SDK with debug logging.

2.3.0 (2021-04-16)

New

• add customizable background color to editor options.

2.2.0 (2021-04-02)

Chore

• Add end-to-end test for purchasing with the complete video modal

Update

• add externalID to baseAccountInfoProperties.

2.1.0 (2021-03-26)

Update

• Add support for configuring editor complete confirmation modal

2.0.0 (2021-03-24)

Breaking

• add waymark-sdk-tool to circleci config and delete tool.

Chore

• Upgrade to husky 5, add commitlint

Update

• PR cleanup.
• test editor options menu.
• test unsaved changes modal.
• write test for example site navigation.
• write test for full purchase flow.
• write test to ensure account info persists.

1.15.0 (2021-03-23)

Docs

• Add more links to documentation and other cleanup

Update

• Add off method

1.14.0 (2021-03-22)

Docs

• Fix documentation for personalization.isDefault
• Publish changelog as part of the documentation.

Update

• switch local host environment to https.

1.13.0 (2021-03-19)

Update

• Add support for panelButtons.shouldUseAdvancedDropdown option

1.12.0 (2021-03-17)

Docs

• Clarify where the template ID in openEditorForTemplate comes from.
• Correct video render data type for in_progress renders.
• loginAccount now resolves with the Account information.

Fix

• increase getCollections test wait time.

Update

• add hideSaveButton editor option.

1.11.3 (2021-03-11)

Fix

• allow for empty state values in createAccount payload.

1.11.2 (2021-03-11)

Fix

• Enable opening the renderer in full screen from inside the iframe

1.11.1 (2021-03-10)

Fix

• Fix problem with detecting logged-in account.

1.11.0 (2021-03-09)

Docs

• Update Account data type documentation.

Update

• Logout existing accounts when cleaning up the SDK.

1.10.0 (2021-03-05)

Update

• Add ExistingLoginError to SDK error classes.

1.9.2 (2021-03-05)

Fix

• Replace test harness video URLs with real videos

1.9.1 (2021-03-05)

Fix

• Clean up FrameCommunicator when SDK.cleanup is called.
• Log out existing user when createAccount or loginAccount is called.
• Send token with createAccount and loginAccount

1.9.0 (2021-03-04)

Update

• pass partnerID into createAccount and login calls.

1.8.2 (2021-03-04)

Fix

• Inject iframe styling for responsiveness upon element creation.

1.8.1 (2021-03-04)

Fix

• Add partner ID to initial SDK URL

1.8.0 (2021-03-04)

New

• Add validator support and documentation for unsavedChangesConfirmation

1.7.0 (2021-03-02)

Update

• add customHost field to Waymark options.
• combine customHost and environment options.
• ensure host is null for TestModeWaymark instances.

1.6.0 (2021-02-26)

Docs

• Add editor.personalization to documentation

Update

• change 'is_default' to 'isDefault'

1.5.1 (2021-02-25)

Build

• Do not run the documentation deploy if semantic-release didn't create a new version.

Docs

• Update the webhook documentation with content types.

Fix

• Build the documentation with the proper version number.

1.5.0 (2021-02-24)

Update

• Remove videoName editor label

1.4.1 (2021-02-23)

Build

• Run the documentation generation from within semantic release.

Docs

• Incorporate the new version number in the documentation.

Fix

• Update the release version for the scripts to use even if there is no release.

1.4.0 (2021-02-22)

Chore

• Update date formats in documentation and unit tests.

Docs

• Remove some internal functions from the public documentation and change the order.

New

• Add the video render status to videoRendered events and video.rendered webhooks.

1.3.0 (2021-02-18)

Build

• Add Prettier JavaScript formatting at commit time
• Use fully specified repository entry in package.json

Chore

• Add unit tests for FrameTranslator

Docs

• Add signed webhook documentation section and update date formats in examples
• Added "Testing" section
• Update webhook signature documentation

Update

• Add FrameTranslator
• Build and release documentation with npm module.
• Export custom error classes so they can be used in the child frame
• Make iframe src use 'mode=embed' query param
• Replace penpal event callback methods with sendEvent
• toggle iframe visibility in test harness.

1.2.4 (2021-02-08)

Fix

• Make npm package access public.

1.2.3 (2021-02-08)

Fix

• Only commit changed assets for semantic release

1.2.2 (2021-02-08)

Fix

• Correct use of assets in semantic-release git plugin

1.2.1 (2021-02-08)

Fix

• Change build order for npm publish

1.2.0 (2021-02-08)

Build

• Add circleci build script
• Add test:release and rename npm test commands from 'tests:' to 'test:'
• Add TestCafe and TestCafe linter plugin
• Ensure latest SDK is installed for developer tool during tests
• Install canvas npm package for running Jest DOM tests
• Make circleci aware of test results
• Release and documentation build and deploy scripts
• Run the proper release tests
• Skip developer tool tests for now
• Start background HTTP server for end-to-end tests

Chore

• Add coverage to gitignore
• Add unit tests covering a majority of the SDK as it currently exists
• Add npm run tests:release for automated SDK tests
• Add ability to destroy embedded iframe in developer tool
• Add CSS selector targeting to developer tool
• Add end-to-end tests for opening the test harness editor
• Add hide/show performance stats button
• Add visual status for initialized SDK in developer tool
• Don't load the GPU task app until it's called for.
• getCollections and getTemplatesForCollections test harness tests
• Increase collection tests wait for response
• Move the frame to the top of the page for easier use.
• Rename General end-to-end tests to Editor

Docs

• Add notes to example automated test

Fix

• Add YAML converter to rollup config.

New

• Add cleanup functionality to SDK instances
• Environment configurations.

Update

• Minor validation cleanup, add initial unit tests for SDK constructor
• Various fixes and improvements to the SDK from unit test fallout

1.2.0 (2021-02-08)

Build

• Add circleci build script
• Add test:release and rename npm test commands from 'tests:' to 'test:'
• Add TestCafe and TestCafe linter plugin
• Ensure latest SDK is installed for developer tool during tests
• Install canvas npm package for running Jest DOM tests
• Make circleci aware of test results
• Release and documentation build and deploy scripts
• Run the proper release tests
• Skip developer tool tests for now
• Start background HTTP server for end-to-end tests

chore

• add coverage to gitignore
• Add unit tests covering a majority of the SDK as it currently exists

Chore

• Add npm run tests:release for automated SDK tests
• Add ability to destroy embedded iframe in developer tool
• Add CSS selector targeting to developer tool
• Add end-to-end tests for opening the test harness editor
• Add hide/show performance stats button
• Add visual status for initialized SDK in developer tool
• Don't load the GPU task app until it's called for.
• getCollections and getTemplatesForCollections test harness tests
• Increase collection tests wait for response
• Move the frame to the top of the page for easier use.
• Rename General end-to-end tests to Editor

Docs

• Add notes to example automated test

Fix

• Add YAML converter to rollup config.

New

• Add cleanup functionality to SDK instances
• environment configurations.

update

• minor validation cleanup, add initial unit tests for SDK constructor
• Various fixes and improvements to the SDK from unit test fallout

1.1.0 (2021-02-03)

Build

• Add a developer test harness tool
• add autoExternal and transform-runtime to Rollup
• Check licenses for Waymark SDK compatibility (resolves: CU-hgv6g2)
• Exclude documentation and package*.json from npm module.
• move package files to sdk subdirectory
• Remove duplicate .gitignore and ignore .eslintcache
• Update package-lock.json for a rebase after move

Docs

• Add data type docs and editor.personalization.is_default option.
• Add new editor events to documentation and make validation methods private

Fix

• Allow automated tests to maniplate the iframe
• Carry event name changes through to test harness HTML
• ensure errors bubble up through penpal correctly

New

• implement onWaymarkInit hook.

Update

• Add full coverage for basic param validation
• Add pixiJS to developer tool packages
• add test harness support for getAccountInfo, updateAccountInfo, getVideos, openSavedVideos, and close
• Normalize the event naming scheme

1.0.0 (2021-01-13)

Build

• adds rollup and semantic versioning configuration

New

• Adds jest for testing
• Semantic release