@ketch-sdk/ketch-types 1.9.1 → 1.9.3
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 +23 -2
- package/dist/index.js +12 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
export declare enum Tab {
|
|
7
7
|
Overview = "overviewTab",
|
|
8
8
|
Rights = "rightsTab",
|
|
9
|
-
Consents = "consentsTab"
|
|
9
|
+
Consents = "consentsTab",
|
|
10
|
+
Subscriptions = "subscriptionsTab"
|
|
10
11
|
}
|
|
11
12
|
/**
|
|
12
13
|
* Determines if the given value is a Tab
|
|
@@ -270,6 +271,11 @@ export type ShowPreferenceOptions = {
|
|
|
270
271
|
* the rights tab is displayed.
|
|
271
272
|
*/
|
|
272
273
|
showRightsTab?: boolean;
|
|
274
|
+
/**
|
|
275
|
+
* showSubscriptionsTab determines whether the subscriptions tab will show. If undefined,
|
|
276
|
+
* the subscriptions tab is displayed.
|
|
277
|
+
*/
|
|
278
|
+
showSubscriptionsTab?: boolean;
|
|
273
279
|
/**
|
|
274
280
|
* supportedCountries is the list of supported ISO 3166 ALPHA-2 country codes
|
|
275
281
|
* to show in the rights form
|
|
@@ -653,6 +659,21 @@ export interface ConsentsTab {
|
|
|
653
659
|
[key: string]: string;
|
|
654
660
|
};
|
|
655
661
|
}
|
|
662
|
+
/**
|
|
663
|
+
* SubscriptionExperienceItemType
|
|
664
|
+
*/
|
|
665
|
+
export declare enum SubscriptionExperienceItemType {
|
|
666
|
+
SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_UNKNOWN = 0,
|
|
667
|
+
SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_TOPIC = 1,
|
|
668
|
+
SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_CONTROL = 2
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* SubscriptionExperienceItem
|
|
672
|
+
*/
|
|
673
|
+
export interface SubscriptionExperienceItem {
|
|
674
|
+
type: SubscriptionExperienceItemType;
|
|
675
|
+
code: string;
|
|
676
|
+
}
|
|
656
677
|
/**
|
|
657
678
|
* SubscriptionsTab
|
|
658
679
|
*/
|
|
@@ -676,7 +697,7 @@ export interface SubscriptionsTab {
|
|
|
676
697
|
/**
|
|
677
698
|
* List of topics/controls codes
|
|
678
699
|
*/
|
|
679
|
-
|
|
700
|
+
items: SubscriptionExperienceItemType[];
|
|
680
701
|
/**
|
|
681
702
|
* switchOnText overrides the standard text for a consent switch in the on state
|
|
682
703
|
*/
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SubscriptionStatus = exports.StorageOriginPolicy = exports.ExperienceActionKind = exports.ModalPosition = exports.BannerPosition = exports.SwitchTextRenderLogic = exports.IdentityFormat = exports.IdentityType = exports.CookieCategory = exports.CookieProvenance = exports.CookieDuration = exports.MigrationOption = exports.ExperiencePrimaryButtonAction = exports.ExperienceButtonDestination = exports.ExperienceDefault = exports.ExperienceClosedReason = exports.ConsentExperienceType = exports.ExperienceType = exports.isTab = exports.Tab = void 0;
|
|
3
|
+
exports.SubscriptionStatus = exports.SubscriptionExperienceItemType = exports.StorageOriginPolicy = exports.ExperienceActionKind = exports.ModalPosition = exports.BannerPosition = exports.SwitchTextRenderLogic = exports.IdentityFormat = exports.IdentityType = exports.CookieCategory = exports.CookieProvenance = exports.CookieDuration = exports.MigrationOption = exports.ExperiencePrimaryButtonAction = exports.ExperienceButtonDestination = exports.ExperienceDefault = exports.ExperienceClosedReason = exports.ConsentExperienceType = exports.ExperienceType = exports.isTab = exports.Tab = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* Tab
|
|
6
6
|
*
|
|
@@ -11,6 +11,7 @@ var Tab;
|
|
|
11
11
|
Tab["Overview"] = "overviewTab";
|
|
12
12
|
Tab["Rights"] = "rightsTab";
|
|
13
13
|
Tab["Consents"] = "consentsTab";
|
|
14
|
+
Tab["Subscriptions"] = "subscriptionsTab";
|
|
14
15
|
})(Tab = exports.Tab || (exports.Tab = {}));
|
|
15
16
|
/**
|
|
16
17
|
* All tabs
|
|
@@ -261,9 +262,18 @@ var StorageOriginPolicy;
|
|
|
261
262
|
*/
|
|
262
263
|
StorageOriginPolicy["SameOrigin"] = "same-origin,";
|
|
263
264
|
})(StorageOriginPolicy = exports.StorageOriginPolicy || (exports.StorageOriginPolicy = {}));
|
|
265
|
+
/**
|
|
266
|
+
* SubscriptionExperienceItemType
|
|
267
|
+
*/
|
|
268
|
+
var SubscriptionExperienceItemType;
|
|
269
|
+
(function (SubscriptionExperienceItemType) {
|
|
270
|
+
SubscriptionExperienceItemType[SubscriptionExperienceItemType["SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_UNKNOWN"] = 0] = "SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_UNKNOWN";
|
|
271
|
+
SubscriptionExperienceItemType[SubscriptionExperienceItemType["SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_TOPIC"] = 1] = "SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_TOPIC";
|
|
272
|
+
SubscriptionExperienceItemType[SubscriptionExperienceItemType["SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_CONTROL"] = 2] = "SUBSCRIPTION_EXPERIENCE_ITEM_TYPE_CONTROL";
|
|
273
|
+
})(SubscriptionExperienceItemType = exports.SubscriptionExperienceItemType || (exports.SubscriptionExperienceItemType = {}));
|
|
264
274
|
var SubscriptionStatus;
|
|
265
275
|
(function (SubscriptionStatus) {
|
|
266
276
|
SubscriptionStatus["Denied"] = "denied";
|
|
267
277
|
SubscriptionStatus["Granted"] = "granted";
|
|
268
278
|
})(SubscriptionStatus = exports.SubscriptionStatus || (exports.SubscriptionStatus = {}));
|
|
269
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
279
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7R0FJRztBQUNILElBQVksR0FLWDtBQUxELFdBQVksR0FBRztJQUNiLCtCQUF3QixDQUFBO0lBQ3hCLDJCQUFvQixDQUFBO0lBQ3BCLCtCQUF3QixDQUFBO0lBQ3hCLHlDQUFrQyxDQUFBO0FBQ3BDLENBQUMsRUFMVyxHQUFHLEdBQUgsV0FBRyxLQUFILFdBQUcsUUFLZDtBQUVEOztHQUVHO0FBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQTtBQUUxRDs7Ozs7R0FLRztBQUNILFNBQWdCLEtBQUssQ0FBQyxLQUFhO0lBQ2pDLE9BQU8sUUFBUSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQTtBQUNqQyxDQUFDO0FBRkQsc0JBRUM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLGlEQUErQixDQUFBO0lBQy9CLHVEQUFxQyxDQUFBO0FBQ3ZDLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLHFCQUlYO0FBSkQsV0FBWSxxQkFBcUI7SUFDL0IsOERBQXFDLENBQUE7SUFDckMsNERBQW1DLENBQUE7SUFDbkMsd0RBQStCLENBQUE7QUFDakMsQ0FBQyxFQUpXLHFCQUFxQixHQUFyQiw2QkFBcUIsS0FBckIsNkJBQXFCLFFBSWhDO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsSUFBWSxzQkFLWDtBQUxELFdBQVksc0JBQXNCO0lBQ2hDLG9EQUEwQixDQUFBO0lBQzFCLHNEQUE0QixDQUFBO0lBQzVCLHlDQUFlLENBQUE7SUFDZix1REFBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsc0JBQXNCLEdBQXRCLDhCQUFzQixLQUF0Qiw4QkFBc0IsUUFLakM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxpQkFHWDtBQUhELFdBQVksaUJBQWlCO0lBQzNCLDZEQUFVLENBQUE7SUFDViwyREFBUyxDQUFBO0FBQ1gsQ0FBQyxFQUhXLGlCQUFpQixHQUFqQix5QkFBaUIsS0FBakIseUJBQWlCLFFBRzVCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksMkJBSVg7QUFKRCxXQUFZLDJCQUEyQjtJQUNyQyx5RkFBYyxDQUFBO0lBQ2QsbUdBQW1CLENBQUE7SUFDbkIseUZBQWMsQ0FBQTtBQUNoQixDQUFDLEVBSlcsMkJBQTJCLEdBQTNCLG1DQUEyQixLQUEzQixtQ0FBMkIsUUFJdEM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSw2QkFHWDtBQUhELFdBQVksNkJBQTZCO0lBQ3ZDLDZHQUFzQixDQUFBO0lBQ3RCLDZGQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUhXLDZCQUE2QixHQUE3QixxQ0FBNkIsS0FBN0IscUNBQTZCLFFBR3hDO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksZUFNWDtBQU5ELFdBQVksZUFBZTtJQUN6QiwyRUFBbUIsQ0FBQTtJQUNuQix1RUFBaUIsQ0FBQTtJQUNqQixpRkFBc0IsQ0FBQTtJQUN0QiwrRUFBcUIsQ0FBQTtJQUNyQix5RUFBa0IsQ0FBQTtBQUNwQixDQUFDLEVBTlcsZUFBZSxHQUFmLHVCQUFlLEtBQWYsdUJBQWUsUUFNMUI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLHlEQUFXLENBQUE7SUFDWCwrREFBYyxDQUFBO0FBQ2hCLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDMUIscUVBQWUsQ0FBQTtJQUNmLHFFQUFlLENBQUE7QUFDakIsQ0FBQyxFQUhXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBRzNCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksY0FLWDtBQUxELFdBQVksY0FBYztJQUN4QiwrRUFBc0IsQ0FBQTtJQUN0QiwrREFBYyxDQUFBO0lBQ2QsaUVBQWUsQ0FBQTtJQUNmLDZEQUFhLENBQUE7QUFDZixDQUFDLEVBTFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFLekI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxZQVNYO0FBVEQsV0FBWSxZQUFZO0lBQ3RCLDRDQUE0QixDQUFBO0lBQzVCLHNEQUFzQyxDQUFBO0lBQ3RDLCtDQUErQixDQUFBO0lBQy9CLCtDQUErQixDQUFBO0lBQy9CLHVEQUF1QyxDQUFBO0lBQ3ZDLDREQUE0QyxDQUFBO0lBQzVDLGdFQUFnRCxDQUFBO0lBQ2hELDBEQUEwQyxDQUFBO0FBQzVDLENBQUMsRUFUVyxZQUFZLEdBQVosb0JBQVksS0FBWixvQkFBWSxRQVN2QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGNBT1g7QUFQRCxXQUFZLGNBQWM7SUFDeEIsZ0RBQThCLENBQUE7SUFDOUIsbURBQWlDLENBQUE7SUFDakMsK0NBQTZCLENBQUE7SUFDN0IsNkNBQTJCLENBQUE7SUFDM0IsaURBQStCLENBQUE7SUFDL0IseURBQXVDLENBQUE7QUFDekMsQ0FBQyxFQVBXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBT3pCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVkscUJBaUJYO0FBakJELFdBQVkscUJBQXFCO0lBQy9COztPQUVHO0lBQ0gscUdBQTBCLENBQUE7SUFDMUI7O09BRUc7SUFDSCxxSEFBa0MsQ0FBQTtJQUNsQzs7T0FFRztJQUNILDJHQUE2QixDQUFBO0lBQzdCOztPQUVHO0lBQ0gseUdBQTRCLENBQUE7QUFDOUIsQ0FBQyxFQWpCVyxxQkFBcUIsR0FBckIsNkJBQXFCLEtBQXJCLDZCQUFxQixRQWlCaEM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUtYO0FBTEQsV0FBWSxjQUFjO0lBQ3hCLHVEQUFVLENBQUE7SUFDVixpREFBTyxDQUFBO0lBQ1AsaUVBQWUsQ0FBQTtJQUNmLG1FQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFMVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUt6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGFBSVg7QUFKRCxXQUFZLGFBQWE7SUFDdkIscURBQVUsQ0FBQTtJQUNWLHlFQUFvQixDQUFBO0lBQ3BCLDJFQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUFKVyxhQUFhLEdBQWIscUJBQWEsS0FBYixxQkFBYSxRQUl4QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLG9CQXFCWDtBQXJCRCxXQUFZLG9CQUFvQjtJQUM5Qjs7T0FFRztJQUNILG1GQUFjLENBQUE7SUFDZDs7T0FFRztJQUNILG1GQUFjLENBQUE7SUFDZDs7T0FFRztJQUNILDJFQUFVLENBQUE7SUFDVjs7T0FFRztJQUNILHFGQUFlLENBQUE7SUFDZjs7T0FFRztJQUNILDZFQUFXLENBQUE7QUFDYixDQUFDLEVBckJXLG9CQUFvQixHQUFwQiw0QkFBb0IsS0FBcEIsNEJBQW9CLFFBcUIvQjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLG1CQVVYO0FBVkQsV0FBWSxtQkFBbUI7SUFDN0I7O09BRUc7SUFDSCxtREFBNEIsQ0FBQTtJQUU1Qjs7T0FFRztJQUNILGtEQUEyQixDQUFBO0FBQzdCLENBQUMsRUFWVyxtQkFBbUIsR0FBbkIsMkJBQW1CLEtBQW5CLDJCQUFtQixRQVU5QjtBQXdkRDs7R0FFRztBQUNILElBQVksOEJBSVg7QUFKRCxXQUFZLDhCQUE4QjtJQUN4Qyw2SkFBNkMsQ0FBQTtJQUM3Qyx5SkFBMkMsQ0FBQTtJQUMzQyw2SkFBNkMsQ0FBQTtBQUMvQyxDQUFDLEVBSlcsOEJBQThCLEdBQTlCLHNDQUE4QixLQUE5QixzQ0FBOEIsUUFJekM7QUE2dUNELElBQVksa0JBR1g7QUFIRCxXQUFZLGtCQUFrQjtJQUM1Qix1Q0FBaUIsQ0FBQTtJQUNqQix5Q0FBbUIsQ0FBQTtBQUNyQixDQUFDLEVBSFcsa0JBQWtCLEdBQWxCLDBCQUFrQixLQUFsQiwwQkFBa0IsUUFHN0IifQ==
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name": "@ketch-sdk/ketch-types", "version": "1.9.
|
|
1
|
+
{"name": "@ketch-sdk/ketch-types", "version": "1.9.3", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "type": "commonjs", "scripts": {"all": "npm run lint && npm run format-check && npm run test && npm run build && npm run docs", "build": "tsc -p .", "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": {"@types/events": "^3.0.0", "@types/jest": "^29.4.0", "@typescript-eslint/eslint-plugin": "^5.54.0", "@typescript-eslint/parser": "^5.54.0", "eslint": "^8.35.0", "eslint-config-prettier": "^8.6.0", "eslint-plugin-import": "^2.27.5", "eslint-plugin-jest": "^27.2.1", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.4.3", "jest-environment-jsdom": "^29.4.3", "jest-junit": "^15.0.0", "prettier": "^2.8.4", "ts-jest": "^29.0.5", "typedoc": "^0.23.26", "typescript": "^4.9.5"}, "files": ["./dist"]}
|