unbounce-smart-builder-sdk-types v1.0.43

smart-builder-sdk-types (Deprecated!)

This library is now deprecated. It is no longer used within the SDK or the CCE but it is still used by legacy apps that have not been migrated to just use the SDK for types.

Provides types for the smart-builder-sdk

The intended usage for these types is to provide types to entities used from Smart Builder SDK when building apps or other extensions.

The Smart Builder SDK relies on internal libraries and as such is provided at run time by the Smart Builder web app. This is exposed on the window object.

The intended pattern for the two repos will be to import the SDK functionality from the window object and add this (smart-builder-sdk-types) repo as a dev dependency to any app that requires types.

Development

Yalc:

1. First run npm run dev:publish
2. For any further updates run: npm run dev:push

Release and Publish

Auto-generated by the smart-builder-sdk-types Jenkins Release Pipeline

This repository uses Jenkins for its CD pipeline. All branch pushes trigger the Jenkins pipeline automatically. Upon a main branch push, it triggers the release step auto bumps the version by 0.0.01 from what is defined in /package.json, creates a tag on GitHub, and publishes to NPM.

Good To Knows

This repo contains TypeScript declaration files that were manually created, rather than generated by the TypeScript compiler. As such, we don't need to run any tsc commands for a check types command. We have a prettier and eslint configuration, along with a husky pre-commit hook to enforce the configurations.