@ketch-sdk/ketch-types 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -22,12 +22,12 @@ export declare type Identities = {
     [key: string]: string;
 };
 /**
- * PreferenceExperienceParams
+ * Tabs
  */
-export declare type PreferenceExperienceParams = {
-    showRightsTab?: boolean;
-    dataSubjectTypeCodes?: string[];
-};
+export declare const ALL_TABS: readonly ["overviewTab", "rightsTab", "consentsTab"];
+declare type TabTuple = typeof ALL_TABS;
+export declare type Tab = TabTuple[number];
+export declare function isTab(value: string): value is Tab;
 /**
  * Plugin factory function signature
  */
@@ -48,12 +48,12 @@ export interface Ketch {
     shouldShowConsent(c: Consent): boolean;
     showConsentExperience(): Promise<Consent>;
     onShowConsentExperience(callback: ShowConsentExperience): Promise<void>;
-    showPreferenceExperience(params: PreferenceExperienceParams): Promise<Consent>;
+    showPreferenceExperience(params: ShowPreferenceOptions): Promise<Consent>;
     onShowPreferenceExperience(callback: ShowPreferenceExperience): Promise<void>;
     experienceClosed(reason: ExperienceClosedReason): Promise<Consent>;
     onHideExperience(callback: Callback): Promise<void>;
     onWillShowExperience(callback: Callback): Promise<void>;
-    invokeRight(eventData: InvokeRightsEvent): Promise<void>;
+    invokeRight(eventData: InvokeRightEvent): Promise<void>;
     onInvokeRight(callback: Callback): Promise<void>;
     setEnvironment(env: Environment): Promise<Environment>;
     getEnvironment(): Promise<Environment>;
@@ -89,7 +89,7 @@ export declare type ShowConsentExperience = (host: Ketch, config: Configuration,
  * ShowPreferenceOptions
  */
 export declare type ShowPreferenceOptions = {
-    tab?: 'overviewTab' | 'rightsTab' | 'consentsTab';
+    tab?: Tab;
     /**
      * dataSubjectTypeCodes is the list of data subjects to display. If undefined, all data subjects are displayed.
      */
@@ -98,6 +98,10 @@ export declare type ShowPreferenceOptions = {
      * showRightsTab determines whether the rights tab will show. If undefined, the rights tab is displayed.
      */
     showRightsTab?: boolean;
+    /**
+     * supportedCountries is the list of supported ISO 3166 ALPHA-2 country codes to show in the rights form
+     */
+    supportedCountries?: string[];
 };
 /**
  * ShowConsentOptions
@@ -107,20 +111,11 @@ export declare type ShowConsentOptions = {
     purposes?: string[];
 };
 /**
- * InvokeRightsEvent
+ * InvokeRightEvent
  */
-export declare type InvokeRightsEvent = {
-    addressLine1?: string;
-    addressLine2?: string;
-    country?: string;
-    details?: string;
-    firstName: string;
-    lastName: string;
-    phoneNumber?: string;
-    postalCode?: string;
+export declare type InvokeRightEvent = {
     right: string;
-    rightsEmail: string;
-    stateRegion?: string;
+    subject: DataSubject;
 };
 /**
  * AppDiv
@@ -303,7 +298,7 @@ export interface SetConsentRequest {
     };
     collectedAt?: number;
     jurisdictionCode: string;
-    migrationOption: MigrationOption;
+    migrationOption?: MigrationOption;
     purposes: {
         [key: string]: PurposeAllowedLegalBasis;
     };
@@ -323,8 +318,8 @@ export interface SetConsentRequest {
  */
 export interface DataSubject {
     email: string;
-    first: string;
-    last: string;
+    firstName: string;
+    lastName: string;
     country?: string;
     stateRegion?: string;
     description?: string;
@@ -608,6 +603,7 @@ export interface Modal {
     title: string;
     bodyTitle?: string;
     bodyDescription?: string;
+    footerDescription?: string;
     buttonText: string;
     /**
      * consentTitle is the heading that goes above the list of purposes this optionally overrides the standard title
@@ -809,8 +805,12 @@ export declare enum ModalPosition {
  * Theme
  */
 export interface Theme {
+    code?: string;
+    name?: string;
+    description?: string;
     watermark?: boolean;
     buttonBorderRadius: number;
+    font?: string;
     bannerBackgroundColor: string;
     bannerContentColor?: string;
     bannerButtonColor: string;
@@ -874,7 +874,6 @@ export interface Vendor {
     policyUrl?: string;
     cookieMaxAgeSeconds?: number;
     usesCookies?: boolean;
-    UsesNonCookieAccess?: boolean;
     usesNonCookieAccess?: boolean;
 }
 /**
@@ -953,8 +952,6 @@ export interface Configuration {
     purposes?: Purpose[];
     /**
      * Mapping of purposes to canonical purposes.
-     *
-     * @deprecated
      */
     canonicalPurposes?: {
         [key: string]: CanonicalPurpose;
@@ -975,6 +972,18 @@ export interface Configuration {
      * Experience definitions
      */
     experiences?: Experience;
+    /**
+     * Vendors (TCF)
+     */
+    vendors?: Vendor[];
+    /**
+     * Data subject types relevant for this configuration
+     */
+    dataSubjectTypes?: DataSubjectType[];
+    /**
+     * Stacks to be displayed in an experience
+     */
+    stacks?: Stack[];
     /**
      * Services
      */
@@ -997,18 +1006,6 @@ export interface Configuration {
     plugins?: {
         [key: string]: any;
     };
-    /**
-     * Vendors (TCF)
-     */
-    vendors?: Vendor[];
-    /**
-     * Data subject types relevant for this configuration
-     */
-    dataSubjectTypes?: DataSubjectType[];
-    /**
-     * Stacks to be displayed in an experience
-     */
-    stacks?: Stack[];
 }
 /**
  * Pusher interface defines a type that has a push function like an array
@@ -1038,3 +1035,4 @@ declare global {
         semaphore: Pusher & Loaded;
     }
 }
+export {};

package/dist/index.js

@@ -1 +1 @@
-(()=>{"use strict";var T={};(()=>{T.d=(E,_)=>{for(var R in _){if(T.o(_,R)&&!T.o(E,R)){Object.defineProperty(E,R,{enumerable:true,get:_[R]})}}}})();(()=>{T.o=(T,E)=>Object.prototype.hasOwnProperty.call(T,E)})();(()=>{T.r=T=>{if(typeof Symbol!=="undefined"&&Symbol.toStringTag){Object.defineProperty(T,Symbol.toStringTag,{value:"Module"})}Object.defineProperty(T,"__esModule",{value:true})}})();if(typeof T!=="undefined")T.ab=__dirname+"/";var E={};T.r(E);T.d(E,{ExperienceDefault:()=>_,ExperienceButtonDestination:()=>R,ExperiencePrimaryButtonAction:()=>I,MigrationOption:()=>e,CookieDuration:()=>A,CookieProvenance:()=>o,CookieCategory:()=>N,IdentityType:()=>n,IdentityFormat:()=>t,SwitchTextRenderLogic:()=>O,BannerPosition:()=>i,ModalPosition:()=>r});var _;(function(T){T[T["BANNER"]=1]="BANNER";T[T["MODAL"]=2]="MODAL"})(_||(_={}));var R;(function(T){T[T["GOTO_MODAL"]=1]="GOTO_MODAL";T[T["GOTO_PREFERENCE"]=2]="GOTO_PREFERENCE";T[T["REJECT_ALL"]=3]="REJECT_ALL"})(R||(R={}));var I;(function(T){T[T["SAVE_CURRENT_STATE"]=1]="SAVE_CURRENT_STATE";T[T["ACCEPT_ALL"]=2]="ACCEPT_ALL"})(I||(I={}));var e;(function(T){T[T["MIGRATE_DEFAULT"]=0]="MIGRATE_DEFAULT";T[T["MIGRATE_NEVER"]=1]="MIGRATE_NEVER";T[T["MIGRATE_FROM_ALLOW"]=2]="MIGRATE_FROM_ALLOW";T[T["MIGRATE_FROM_DENY"]=3]="MIGRATE_FROM_DENY";T[T["MIGRATE_ALWAYS"]=4]="MIGRATE_ALWAYS"})(e||(e={}));var A;(function(T){T[T["SESSION"]=1]="SESSION";T[T["PERSISTENT"]=2]="PERSISTENT"})(A||(A={}));var o;(function(T){T[T["FIRST_PARTY"]=1]="FIRST_PARTY";T[T["THIRD_PARTY"]=2]="THIRD_PARTY"})(o||(o={}));var N;(function(T){T[T["STRICTLY_NECESSARY"]=1]="STRICTLY_NECESSARY";T[T["FUNCTIONAL"]=2]="FUNCTIONAL";T[T["PERFORMANCE"]=3]="PERFORMANCE";T[T["MARKETING"]=4]="MARKETING"})(N||(N={}));var n;(function(T){T["IDENTITY_TYPE_UNDEFINED"]="";T["IDENTITY_TYPE_DATA_LAYER"]="dataLayer";T["IDENTITY_TYPE_WINDOW"]="window";T["IDENTITY_TYPE_COOKIE"]="cookie";T["IDENTITY_TYPE_MANAGED"]="managedCookie";T["IDENTITY_TYPE_LOCAL_STORAGE"]="localStorage";T["IDENTITY_TYPE_SESSION_STORAGE"]="sessionStorage";T["IDENTITY_TYPE_QUERY_STRING"]="queryString"})(n||(n={}));var t;(function(T){T["IDENTITY_FORMAT_UNDEFINED"]="";T["IDENTITY_FORMAT_STRING"]="string";T["IDENTITY_FORMAT_JSON"]="json";T["IDENTITY_FORMAT_JWT"]="jwt";T["IDENTITY_FORMAT_QUERY"]="query";T["IDENTITY_FORMAT_SEMICOLON"]="semicolon"})(t||(t={}));var O;(function(T){T[T["SWITCH_TEXT_RENDER_ALL"]=1]="SWITCH_TEXT_RENDER_ALL";T[T["SWITCH_TEXT_RENDER_LEGAL_BASIS"]=2]="SWITCH_TEXT_RENDER_LEGAL_BASIS";T[T["SWITCH_TEXT_RENDER_CHANGE"]=3]="SWITCH_TEXT_RENDER_CHANGE";T[T["SWITCH_TEXT_RENDER_NEVER"]=4]="SWITCH_TEXT_RENDER_NEVER"})(O||(O={}));var i;(function(T){T[T["BOTTOM"]=1]="BOTTOM";T[T["TOP"]=2]="TOP";T[T["BOTTOM_LEFT"]=3]="BOTTOM_LEFT";T[T["BOTTOM_RIGHT"]=4]="BOTTOM_RIGHT"})(i||(i={}));var r;(function(T){T[T["CENTER"]=1]="CENTER";T[T["LEFT_FULL_HEIGHT"]=2]="LEFT_FULL_HEIGHT";T[T["RIGHT_FULL_HEIGHT"]=3]="RIGHT_FULL_HEIGHT"})(r||(r={}));module.exports=E})();
+(()=>{"use strict";var T={};(()=>{T.d=(E,_)=>{for(var R in _){if(T.o(_,R)&&!T.o(E,R)){Object.defineProperty(E,R,{enumerable:true,get:_[R]})}}}})();(()=>{T.o=(T,E)=>Object.prototype.hasOwnProperty.call(T,E)})();(()=>{T.r=T=>{if(typeof Symbol!=="undefined"&&Symbol.toStringTag){Object.defineProperty(T,Symbol.toStringTag,{value:"Module"})}Object.defineProperty(T,"__esModule",{value:true})}})();if(typeof T!=="undefined")T.ab=__dirname+"/";var E={};T.r(E);T.d(E,{ALL_TABS:()=>_,isTab:()=>isTab,ExperienceDefault:()=>R,ExperienceButtonDestination:()=>I,ExperiencePrimaryButtonAction:()=>e,MigrationOption:()=>n,CookieDuration:()=>o,CookieProvenance:()=>A,CookieCategory:()=>t,IdentityType:()=>N,IdentityFormat:()=>i,SwitchTextRenderLogic:()=>O,BannerPosition:()=>r,ModalPosition:()=>S});const _=["overviewTab","rightsTab","consentsTab"];function isTab(T){return _.includes(T)}var R;(function(T){T[T["BANNER"]=1]="BANNER";T[T["MODAL"]=2]="MODAL"})(R||(R={}));var I;(function(T){T[T["GOTO_MODAL"]=1]="GOTO_MODAL";T[T["GOTO_PREFERENCE"]=2]="GOTO_PREFERENCE";T[T["REJECT_ALL"]=3]="REJECT_ALL"})(I||(I={}));var e;(function(T){T[T["SAVE_CURRENT_STATE"]=1]="SAVE_CURRENT_STATE";T[T["ACCEPT_ALL"]=2]="ACCEPT_ALL"})(e||(e={}));var n;(function(T){T[T["MIGRATE_DEFAULT"]=0]="MIGRATE_DEFAULT";T[T["MIGRATE_NEVER"]=1]="MIGRATE_NEVER";T[T["MIGRATE_FROM_ALLOW"]=2]="MIGRATE_FROM_ALLOW";T[T["MIGRATE_FROM_DENY"]=3]="MIGRATE_FROM_DENY";T[T["MIGRATE_ALWAYS"]=4]="MIGRATE_ALWAYS"})(n||(n={}));var o;(function(T){T[T["SESSION"]=1]="SESSION";T[T["PERSISTENT"]=2]="PERSISTENT"})(o||(o={}));var A;(function(T){T[T["FIRST_PARTY"]=1]="FIRST_PARTY";T[T["THIRD_PARTY"]=2]="THIRD_PARTY"})(A||(A={}));var t;(function(T){T[T["STRICTLY_NECESSARY"]=1]="STRICTLY_NECESSARY";T[T["FUNCTIONAL"]=2]="FUNCTIONAL";T[T["PERFORMANCE"]=3]="PERFORMANCE";T[T["MARKETING"]=4]="MARKETING"})(t||(t={}));var N;(function(T){T["IDENTITY_TYPE_UNDEFINED"]="";T["IDENTITY_TYPE_DATA_LAYER"]="dataLayer";T["IDENTITY_TYPE_WINDOW"]="window";T["IDENTITY_TYPE_COOKIE"]="cookie";T["IDENTITY_TYPE_MANAGED"]="managedCookie";T["IDENTITY_TYPE_LOCAL_STORAGE"]="localStorage";T["IDENTITY_TYPE_SESSION_STORAGE"]="sessionStorage";T["IDENTITY_TYPE_QUERY_STRING"]="queryString"})(N||(N={}));var i;(function(T){T["IDENTITY_FORMAT_UNDEFINED"]="";T["IDENTITY_FORMAT_STRING"]="string";T["IDENTITY_FORMAT_JSON"]="json";T["IDENTITY_FORMAT_JWT"]="jwt";T["IDENTITY_FORMAT_QUERY"]="query";T["IDENTITY_FORMAT_SEMICOLON"]="semicolon"})(i||(i={}));var O;(function(T){T[T["SWITCH_TEXT_RENDER_ALL"]=1]="SWITCH_TEXT_RENDER_ALL";T[T["SWITCH_TEXT_RENDER_LEGAL_BASIS"]=2]="SWITCH_TEXT_RENDER_LEGAL_BASIS";T[T["SWITCH_TEXT_RENDER_CHANGE"]=3]="SWITCH_TEXT_RENDER_CHANGE";T[T["SWITCH_TEXT_RENDER_NEVER"]=4]="SWITCH_TEXT_RENDER_NEVER"})(O||(O={}));var r;(function(T){T[T["BOTTOM"]=1]="BOTTOM";T[T["TOP"]=2]="TOP";T[T["BOTTOM_LEFT"]=3]="BOTTOM_LEFT";T[T["BOTTOM_RIGHT"]=4]="BOTTOM_RIGHT"})(r||(r={}));var S;(function(T){T[T["CENTER"]=1]="CENTER";T[T["LEFT_FULL_HEIGHT"]=2]="LEFT_FULL_HEIGHT";T[T["RIGHT_FULL_HEIGHT"]=3]="RIGHT_FULL_HEIGHT"})(S||(S={}));module.exports=E})();

package/package.json

@@ -1 +1 @@
-{"name": "@ketch-sdk/ketch-types", "version": "0.4.0", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": {"build": "ncc build --minify --license licenses.txt src/index.ts", "lint": "eslint src/**/*.ts", "test": "jest --runInBand --passWithNoTests", "format": "prettier --write \"**/*.{ts,tsx,yml,yaml}\"", "format-check": "prettier --check '**/*.ts'", "docs": "typedoc --githubPages true --excludeInternal src/index.ts"}, "repository": {"type": "git", "url": "git+https://github.com/ketch-sdk/ketch-types.git"}, "author": "Ketch Kloud, Inc. (https://www.ketch.com/)", "license": "MIT", "homepage": "https://github.com/ketch-sdk/ketch-types", "bugs": {"url": "https://github.com/ketch-sdk/ketch-types/issues"}, "devDependencies": {"@jest/globals": "^29.2.2", "@types/jest": "^29.2.0", "@typescript-eslint/eslint-plugin": "^5.41.0", "@typescript-eslint/parser": "^5.41.0", "@vercel/ncc": "^0.34.0", "eslint": "^8.26.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.1.3", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.2.2", "jest-environment-jsdom": "^29.2.2", "jest-junit": "^14.0.1", "prettier": "^2.7.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.19", "typescript": "^4.8.4"}}
+{"name": "@ketch-sdk/ketch-types", "version": "0.4.2", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": {"build": "ncc build --minify --license licenses.txt src/index.ts", "lint": "eslint src/**/*.ts", "test": "jest --runInBand --passWithNoTests", "format": "prettier --write \"**/*.{ts,tsx,yml,yaml}\"", "format-check": "prettier --check '**/*.ts'", "docs": "typedoc --githubPages true --excludeInternal src/index.ts"}, "repository": {"type": "git", "url": "git+https://github.com/ketch-sdk/ketch-types.git"}, "author": "Ketch Kloud, Inc. (https://www.ketch.com/)", "license": "MIT", "homepage": "https://github.com/ketch-sdk/ketch-types", "bugs": {"url": "https://github.com/ketch-sdk/ketch-types/issues"}, "devDependencies": {"@jest/globals": "^29.2.2", "@types/jest": "^29.2.0", "@typescript-eslint/eslint-plugin": "^5.42.0", "@typescript-eslint/parser": "^5.42.0", "@vercel/ncc": "^0.34.0", "eslint": "^8.26.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.1.3", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.2.2", "jest-environment-jsdom": "^29.2.2", "jest-junit": "^14.0.1", "prettier": "^2.7.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.19", "typescript": "^4.8.4"}}

package/test-reports/coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1667182055910" clover="3.2.0">
-  <project timestamp="1667182055910" name="All files">
+<coverage generated="1667261557722" clover="3.2.0">
+  <project timestamp="1667261557722" name="All files">
     <metrics statements="0" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0" elements="0" coveredelements="0" complexity="0" loc="0" ncloc="0" packages="0" files="0" classes="0"/>
   </project>
 </coverage>

package/test-reports/coverage/lcov-report/index.html

@@ -86,7 +86,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2022-10-31T02:07:35.907Z
+                at 2022-11-01T00:12:37.718Z
             </div>
         <script src="prettify.js"></script>
         <script>