@transcend-io/airgap.js-types 10.7.8 → 10.8.0

package/build-esm/ui.js

@@ -0,0 +1,101 @@
+// external
+import * as t from 'io-ts';
+// main
+import { applyEnum, valuesOf } from '@transcend-io/type-utils';
+// local
+import { InitialTranscendViewState, InitialViewState, PrivacyRegimeEnum, DismissedViewState, } from './enums';
+/**
+ * Customer theming
+ */
+export const ConsentManagerTheme = t.type({
+    /** Primary color */
+    primaryColor: t.string,
+    /** Font color */
+    fontColor: t.string,
+});
+/**
+ * Mobile-first responsive breakpoints
+ * No media query for mobile, which is the default
+ */
+export const ConsentManagerBreakpoints = t.type({
+    /** In px, at or above this width is tablet */
+    tablet: t.string,
+    /** In px, at or above this width is desktop */
+    desktop: t.string,
+});
+/**
+ * TODO: https://transcend.height.app/T-19149 - remove
+ *
+ * @deprecated
+ */
+export const PrivacyRegimeToInitialViewStateInput = t.partial(applyEnum(PrivacyRegimeEnum, () => valuesOf(InitialTranscendViewState)));
+/**
+ * TODO: https://transcend.height.app/T-19149 - remove
+ *
+ * @deprecated
+ */
+export const PrivacyRegimeToInitialViewState = t.record(valuesOf(PrivacyRegimeEnum), valuesOf(InitialTranscendViewState));
+export const ExperienceToInitialViewState = t.record(t.string, valuesOf(InitialViewState));
+export const RequiredConsentManagerConfig = t.type({
+    /** Customer theming */
+    theme: ConsentManagerTheme,
+    /** A set of responsive breakpoints */
+    breakpoints: ConsentManagerBreakpoints,
+    /** The privacy policy URL to redirect to */
+    privacyPolicy: t.string,
+    /** The secondary policy URL to redirect to */
+    secondaryPolicy: t.string,
+    /** Custom CSS stylesheet */
+    css: t.string,
+    /** Path to localizations directory */
+    messages: t.string,
+    /** What state the consent manager should launch in */
+    initialViewStateByPrivacyRegime: ExperienceToInitialViewState,
+    /** What state the consent manager should go to when dismissed */
+    dismissedViewState: valuesOf(DismissedViewState),
+});
+export const OptionalConsentManagerConfig = t.partial({
+    /** The set of enabled languages - CSV of ConsentManagerLanguageKey */
+    languages: t.string,
+    /** The override value for the consent banner z-index */
+    uiZIndex: t.string,
+});
+/** Consent manager UI configuration */
+export const ConsentManagerConfig = t.intersection([
+    RequiredConsentManagerConfig,
+    OptionalConsentManagerConfig,
+]);
+/** Input for Consent manager UI configuration */
+export const ConsentManagerConfigInput = t.partial({
+    ...OptionalConsentManagerConfig.props,
+    ...RequiredConsentManagerConfig.props,
+});
+export const TCFConfig = t.type({
+    /** Path to vendor-list.json */
+    vendorList: t.string,
+    /** Custom CSS stylesheet */
+    css: t.string,
+    /** Path to localizations directory */
+    messages: t.string,
+});
+/** Input for Consent manager UI configuration */
+export const TCFConfigInput = t.partial(TCFConfig.props);
+export const DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME = {
+    // EU
+    GDPR: InitialViewState.QuickOptions,
+    // Brazil
+    LGPD: InitialViewState.QuickOptions,
+    // Switzerland
+    nFADP: InitialViewState.QuickOptions,
+    // US: California
+    CPRA: InitialViewState.Hidden,
+    // US: Virginia
+    CDPA: InitialViewState.Hidden,
+    // US: Colorado
+    CPA: InitialViewState.Hidden,
+    // US: Nevada
+    NEVADA_SB220: InitialViewState.Hidden,
+    // Other
+    Unknown: InitialViewState.Hidden,
+};
+//# sourceMappingURL=ui.js.map

package/build-esm/ui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.js","sourceRoot":"","sources":["../src/ui.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO;AACP,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAG/D,QAAQ;AACR,OAAO,EAEL,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAsEjB;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC;IACxC,oBAAoB;IACpB,YAAY,EAAE,CAAC,CAAC,MAAM;IACtB,iBAAiB;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM;CACpB,CAAC,CAAC;AAKH;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9C,8CAA8C;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,+CAA+C;IAC/C,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,OAAO,CAC3D,SAAS,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CACxE,CAAC;AAWF;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CACrD,QAAQ,CAAC,iBAAiB,CAAC,EAC3B,QAAQ,CAAC,yBAAyB,CAAC,CACpC,CAAC;AAWF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAClD,CAAC,CAAC,MAAM,EACR,QAAQ,CAAC,gBAAgB,CAAC,CAC3B,CAAC;AAOF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,IAAI,CAAC;IACjD,uBAAuB;IACvB,KAAK,EAAE,mBAAmB;IAC1B,sCAAsC;IACtC,WAAW,EAAE,yBAAyB;IACtC,4CAA4C;IAC5C,aAAa,EAAE,CAAC,CAAC,MAAM;IACvB,8CAA8C;IAC9C,eAAe,EAAE,CAAC,CAAC,MAAM;IACzB,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM;IACb,sCAAsC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,sDAAsD;IACtD,+BAA+B,EAAE,4BAA4B;IAC7D,iEAAiE;IACjE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;CACjD,CAAC,CAAC;AAOH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,OAAO,CAAC;IACpD,sEAAsE;IACtE,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,wDAAwD;IACxD,QAAQ,EAAE,CAAC,CAAC,MAAM;CACnB,CAAC,CAAC;AAOH,uCAAuC;AACvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,4BAA4B;IAC5B,4BAA4B;CAC7B,CAAC,CAAC;AAKH,iDAAiD;AACjD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,OAAO,CAAC;IACjD,GAAG,4BAA4B,CAAC,KAAK;IACrC,GAAG,4BAA4B,CAAC,KAAK;CACtC,CAAC,CAAC;AAOH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9B,+BAA+B;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM;IACpB,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM;IACb,sCAAsC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM;CACnB,CAAC,CAAC;AAKH,iDAAiD;AACjD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAazD,MAAM,CAAC,MAAM,oCAAoC,GAC/C;IACE,KAAK;IACL,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,SAAS;IACT,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,cAAc;IACd,KAAK,EAAE,gBAAgB,CAAC,YAAY;IACpC,iBAAiB;IACjB,IAAI,EAAE,gBAAgB,CAAC,MAAM;IAC7B,eAAe;IACf,IAAI,EAAE,gBAAgB,CAAC,MAAM;IAC7B,eAAe;IACf,GAAG,EAAE,gBAAgB,CAAC,MAAM;IAC5B,aAAa;IACb,YAAY,EAAE,gBAAgB,CAAC,MAAM;IACrC,QAAQ;IACR,OAAO,EAAE,gBAAgB,CAAC,MAAM;CACjC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "author": "Transcend Inc.",
   "name": "@transcend-io/airgap.js-types",
   "description": "TypeScript types for airgap.js interoperability with custom consent UIs",
-  "version": "10.7.8",
+  "version": "10.8.0",
   "homepage": "https://github.com/transcend-io/airgap.js-types",
   "repository": {
     "type": "git",
@@ -12,13 +12,14 @@
   "main": "build/index",
   "files": [
     "build/**/*",
+    "build-esm/**/*",
     "package.json"
   ],
   "scripts": {
     "update:sdks": "yarn set version from sources && yarn sdks base",
     "update:deps": "yarn upgrade-interactive && yarn update:sdks",
-    "build": "yarn pnpify tsc --build",
-    "clean": "yarn pnpify tsc --build --clean",
+    "build": "yarn pnpify tsc --build && yarn pnpify tsc --module es2022 --outDir build-esm",
+    "clean": "yarn pnpify tsc --build --clean && rm -rf build && rm -rf build-esm",
     "lint": "yarn pnpify eslint src --ext .ts",
     "prepublish": "yarn build",
     "test": "echo 'no tests'"