@ketch-sdk/ketch-types 0.4.1 → 1.0.0

package/dist/index.d.ts

@@ -53,7 +53,7 @@ export interface Ketch {
     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>;
@@ -111,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
@@ -307,7 +298,7 @@ export interface SetConsentRequest {
     };
     collectedAt?: number;
     jurisdictionCode: string;
-    migrationOption: MigrationOption;
+    migrationOption?: MigrationOption;
     purposes: {
         [key: string]: PurposeAllowedLegalBasis;
     };
@@ -327,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;
@@ -440,6 +431,7 @@ export interface Environment {
     code: string;
     pattern?: string;
     hash?: string;
+    domain?: string;
 }
 /**
  * Deployment
@@ -612,6 +604,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
@@ -813,8 +806,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;
@@ -878,7 +875,6 @@ export interface Vendor {
     policyUrl?: string;
     cookieMaxAgeSeconds?: number;
     usesCookies?: boolean;
-    UsesNonCookieAccess?: boolean;
     usesNonCookieAccess?: boolean;
 }
 /**
@@ -957,8 +953,6 @@ export interface Configuration {
     purposes?: Purpose[];
     /**
      * Mapping of purposes to canonical purposes.
-     *
-     * @deprecated
      */
     canonicalPurposes?: {
         [key: string]: CanonicalPurpose;
@@ -979,6 +973,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
      */
@@ -1001,18 +1007,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

package/package.json

@@ -1 +1 @@
-{"name": "@ketch-sdk/ketch-types", "version": "0.4.1", "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"}}
+{"name": "@ketch-sdk/ketch-types", "version": "1.0.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.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="1667246176709" clover="3.2.0">
-  <project timestamp="1667246176709" name="All files">
+<coverage generated="1667262137250" clover="3.2.0">
+  <project timestamp="1667262137250" 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-31T19:56:16.706Z
+                at 2022-11-01T00:22:17.246Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/test-reports/junit/junit.xml

@@ -1,3 +1,3 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<testsuites name="jest tests" tests="0" failures="0" errors="0" time="0.002">
+<testsuites name="jest tests" tests="0" failures="0" errors="0" time="0.003">
 </testsuites>