@ketch-sdk/ketch-types 1.1.10 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -321,6 +321,7 @@ export interface GetLocationResponse {
321
321
  * PurposeLegalBasis
322
322
  */
323
323
  export interface PurposeLegalBasis {
324
+ allowed?: string;
324
325
  legalBasisCode: string;
325
326
  }
326
327
  /**
@@ -328,6 +329,7 @@ export interface PurposeLegalBasis {
328
329
  */
329
330
  export interface PurposeAllowed {
330
331
  allowed: string;
332
+ legalBasisCode?: string;
331
333
  }
332
334
  /**
333
335
  * PurposeAllowedLegalBasis
@@ -351,11 +353,21 @@ export interface GetConsentRequest {
351
353
  purposes: {
352
354
  [key: string]: PurposeLegalBasis;
353
355
  };
356
+ vendors?: string[];
357
+ collectedAt?: number;
354
358
  }
355
359
  /**
356
360
  * GetConsentResponse
357
361
  */
358
362
  export interface GetConsentResponse {
363
+ organizationCode: string;
364
+ controllerCode?: string;
365
+ propertyCode: string;
366
+ environmentCode: string;
367
+ jurisdictionCode: string;
368
+ identities: {
369
+ [key: string]: string;
370
+ };
359
371
  purposes: {
360
372
  [key: string]: PurposeAllowed | string;
361
373
  };
@@ -363,6 +375,7 @@ export interface GetConsentResponse {
363
375
  * list of vendor ids for which the user has opted out
364
376
  */
365
377
  vendors?: string[];
378
+ collectedAt?: number;
366
379
  }
367
380
  /**
368
381
  * SetConsentRequest
@@ -372,25 +385,16 @@ export interface SetConsentRequest {
372
385
  controllerCode?: string;
373
386
  propertyCode: string;
374
387
  environmentCode: string;
388
+ jurisdictionCode: string;
375
389
  identities: {
376
390
  [key: string]: string;
377
391
  };
378
392
  collectedAt?: number;
379
- jurisdictionCode: string;
380
393
  migrationOption?: MigrationOption;
381
394
  purposes: {
382
395
  [key: string]: PurposeAllowedLegalBasis;
383
396
  };
384
397
  vendors?: string[];
385
- /**
386
- * identityPriority is a map from the identity space code to the priority that should be used to resolve consent
387
- * conflict
388
- * lower values take top priority
389
- * if an identity space codes is not in the identityPriority map then it is the last priority
390
- */
391
- identityPriority?: {
392
- [key: string]: number;
393
- };
394
398
  }
395
399
  /**
396
400
  * DataSubject
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- (()=>{"use strict";var T={};(()=>{T.d=(E,e)=>{for(var _ in e){if(T.o(e,_)&&!T.o(E,_)){Object.defineProperty(E,_,{enumerable:true,get:e[_]})}}}})();(()=>{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:()=>e,isTab:()=>isTab,ExperienceType:()=>_,ConsentExperienceType:()=>n,ExperienceClosedReason:()=>o,ExperienceDefault:()=>R,ExperienceButtonDestination:()=>I,ExperiencePrimaryButtonAction:()=>t,MigrationOption:()=>i,CookieDuration:()=>r,CookieProvenance:()=>A,CookieCategory:()=>N,IdentityType:()=>O,IdentityFormat:()=>S,SwitchTextRenderLogic:()=>a,BannerPosition:()=>L,ModalPosition:()=>c});const e=["overviewTab","rightsTab","consentsTab"];function isTab(T){return e.includes(T)}var _;(function(T){T["Consent"]="experiences.consent";T["Preference"]="experiences.preference"})(_||(_={}));var n;(function(T){T["Banner"]="experiences.consent.banner";T["Modal"]="experiences.consent.modal";T["JIT"]="experiences.consent.jit"})(n||(n={}));var o;(function(T){T["SET_CONSENT"]="setConsent";T["INVOKE_RIGHT"]="invokeRight";T["CLOSE"]="close";T["WILL_NOT_SHOW"]="willNotShow"})(o||(o={}));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 t;(function(T){T[T["SAVE_CURRENT_STATE"]=1]="SAVE_CURRENT_STATE";T[T["ACCEPT_ALL"]=2]="ACCEPT_ALL"})(t||(t={}));var i;(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"})(i||(i={}));var r;(function(T){T[T["SESSION"]=1]="SESSION";T[T["PERSISTENT"]=2]="PERSISTENT"})(r||(r={}));var A;(function(T){T[T["FIRST_PARTY"]=1]="FIRST_PARTY";T[T["THIRD_PARTY"]=2]="THIRD_PARTY"})(A||(A={}));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 O;(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"})(O||(O={}));var S;(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"})(S||(S={}));var a;(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"})(a||(a={}));var L;(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"})(L||(L={}));var c;(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"})(c||(c={}));module.exports=E})();
1
+ (()=>{"use strict";var T={};(()=>{T.d=(E,e)=>{for(var _ in e){if(T.o(e,_)&&!T.o(E,_)){Object.defineProperty(E,_,{enumerable:true,get:e[_]})}}}})();(()=>{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:()=>e,BannerPosition:()=>L,ConsentExperienceType:()=>n,CookieCategory:()=>N,CookieDuration:()=>r,CookieProvenance:()=>A,ExperienceButtonDestination:()=>I,ExperienceClosedReason:()=>o,ExperienceDefault:()=>R,ExperiencePrimaryButtonAction:()=>t,ExperienceType:()=>_,IdentityFormat:()=>S,IdentityType:()=>O,MigrationOption:()=>i,ModalPosition:()=>c,SwitchTextRenderLogic:()=>a,isTab:()=>isTab});const e=["overviewTab","rightsTab","consentsTab"];function isTab(T){return e.includes(T)}var _;(function(T){T["Consent"]="experiences.consent";T["Preference"]="experiences.preference"})(_||(_={}));var n;(function(T){T["Banner"]="experiences.consent.banner";T["Modal"]="experiences.consent.modal";T["JIT"]="experiences.consent.jit"})(n||(n={}));var o;(function(T){T["SET_CONSENT"]="setConsent";T["INVOKE_RIGHT"]="invokeRight";T["CLOSE"]="close";T["WILL_NOT_SHOW"]="willNotShow"})(o||(o={}));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 t;(function(T){T[T["SAVE_CURRENT_STATE"]=1]="SAVE_CURRENT_STATE";T[T["ACCEPT_ALL"]=2]="ACCEPT_ALL"})(t||(t={}));var i;(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"})(i||(i={}));var r;(function(T){T[T["SESSION"]=1]="SESSION";T[T["PERSISTENT"]=2]="PERSISTENT"})(r||(r={}));var A;(function(T){T[T["FIRST_PARTY"]=1]="FIRST_PARTY";T[T["THIRD_PARTY"]=2]="THIRD_PARTY"})(A||(A={}));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 O;(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"})(O||(O={}));var S;(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"})(S||(S={}));var a;(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"})(a||(a={}));var L;(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"})(L||(L={}));var c;(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"})(c||(c={}));module.exports=E})();
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name": "@ketch-sdk/ketch-types", "version": "1.1.10", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": {"all": "npm run lint && npm run format-check && npm run test && npm run build && npm run docs", "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.3.1", "@types/jest": "^29.2.3", "@typescript-eslint/eslint-plugin": "^5.45.0", "@typescript-eslint/parser": "^5.45.0", "@vercel/ncc": "^0.34.0", "eslint": "^8.28.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.1.6", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-junit": "^15.0.0", "prettier": "^2.8.0", "ts-jest": "^29.0.3", "typedoc": "^0.23.21", "typescript": "^4.9.3"}}
1
+ {"name": "@ketch-sdk/ketch-types", "version": "1.3.0", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": {"all": "npm run lint && npm run format-check && npm run test && npm run build && npm run docs", "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.3.1", "@types/jest": "^29.2.4", "@typescript-eslint/eslint-plugin": "^5.47.0", "@typescript-eslint/parser": "^5.47.0", "@vercel/ncc": "^0.36.0", "eslint": "^8.30.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.1.7", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-junit": "^15.0.0", "prettier": "^2.8.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.23", "typescript": "^4.9.4"}}
@@ -1,6 +1,6 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <coverage generated="1671575068185" clover="3.2.0">
3
- <project timestamp="1671575068185" name="All files">
2
+ <coverage generated="1671958447578" clover="3.2.0">
3
+ <project timestamp="1671958447578" name="All files">
4
4
  <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"/>
5
5
  </project>
6
6
  </coverage>
@@ -86,7 +86,7 @@
86
86
  <div class='footer quiet pad2 space-top1 center small'>
87
87
  Code coverage generated by
88
88
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
89
- at 2022-12-20T22:24:28.180Z
89
+ at 2022-12-25T08:54:07.575Z
90
90
  </div>
91
91
  <script src="prettify.js"></script>
92
92
  <script>
@@ -1,3 +1,3 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <testsuites name="jest tests" tests="0" failures="0" errors="0" time="0.002">
2
+ <testsuites name="jest tests" tests="0" failures="0" errors="0" time="0.003">
3
3
  </testsuites>