@ketch-sdk/ketch-types 1.8.1 → 1.9.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 +173 -1
- package/dist/index.js +7 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -653,6 +653,51 @@ export interface ConsentsTab {
|
|
|
653
653
|
[key: string]: string;
|
|
654
654
|
};
|
|
655
655
|
}
|
|
656
|
+
/**
|
|
657
|
+
* SubscriptionsTab
|
|
658
|
+
*/
|
|
659
|
+
export interface SubscriptionsTab {
|
|
660
|
+
/**
|
|
661
|
+
* Name of the tab
|
|
662
|
+
*/
|
|
663
|
+
tabName: string;
|
|
664
|
+
/**
|
|
665
|
+
* Title of the Subscriptions list
|
|
666
|
+
*/
|
|
667
|
+
title: string;
|
|
668
|
+
/**
|
|
669
|
+
* Body title
|
|
670
|
+
*/
|
|
671
|
+
bodyTitle?: string;
|
|
672
|
+
/**
|
|
673
|
+
* Body description
|
|
674
|
+
*/
|
|
675
|
+
bodyDescription: string;
|
|
676
|
+
/**
|
|
677
|
+
* List of topics/controls codes
|
|
678
|
+
*/
|
|
679
|
+
subscriptions: string[];
|
|
680
|
+
/**
|
|
681
|
+
* switchOnText overrides the standard text for a consent switch in the on state
|
|
682
|
+
*/
|
|
683
|
+
switchOnText?: string;
|
|
684
|
+
/**
|
|
685
|
+
* switchOffText overrides the standard text for a consent switch in the off state
|
|
686
|
+
*/
|
|
687
|
+
switchOffText?: string;
|
|
688
|
+
/**
|
|
689
|
+
* switchTextRenderLogic determines the logic for showing the switch text
|
|
690
|
+
*/
|
|
691
|
+
switchTextRenderLogic?: SwitchTextRenderLogic;
|
|
692
|
+
/**
|
|
693
|
+
* Primary button text
|
|
694
|
+
*/
|
|
695
|
+
primaryButtonText: string;
|
|
696
|
+
/**
|
|
697
|
+
* Secondary button text
|
|
698
|
+
*/
|
|
699
|
+
secondaryButtonText?: string;
|
|
700
|
+
}
|
|
656
701
|
/**
|
|
657
702
|
* OverviewTab
|
|
658
703
|
*/
|
|
@@ -691,9 +736,10 @@ export interface PreferenceExperience {
|
|
|
691
736
|
code: string;
|
|
692
737
|
version: number;
|
|
693
738
|
title: string;
|
|
739
|
+
overview: OverviewTab;
|
|
694
740
|
rights?: RightsTab;
|
|
695
741
|
consents?: ConsentsTab;
|
|
696
|
-
|
|
742
|
+
subscriptions?: SubscriptionsTab;
|
|
697
743
|
/**
|
|
698
744
|
* additional extensions
|
|
699
745
|
*/
|
|
@@ -1702,3 +1748,129 @@ declare global {
|
|
|
1702
1748
|
ketch(action: string, ...args: any[]): void;
|
|
1703
1749
|
}
|
|
1704
1750
|
}
|
|
1751
|
+
export interface SubscriptionControlSetting {
|
|
1752
|
+
status: SubscriptionStatus;
|
|
1753
|
+
}
|
|
1754
|
+
export interface SubscriptionTopicSetting {
|
|
1755
|
+
status: SubscriptionStatus;
|
|
1756
|
+
contactMethods: string[];
|
|
1757
|
+
}
|
|
1758
|
+
export declare enum SubscriptionStatus {
|
|
1759
|
+
Denied = "denied",
|
|
1760
|
+
Granted = "granted"
|
|
1761
|
+
}
|
|
1762
|
+
export interface SubscriptionControl {
|
|
1763
|
+
/**
|
|
1764
|
+
* The code of the Subscription Control
|
|
1765
|
+
*/
|
|
1766
|
+
code: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* The name of the Subscription Control
|
|
1769
|
+
*/
|
|
1770
|
+
name: string;
|
|
1771
|
+
/**
|
|
1772
|
+
* The display description of the Subscription Control
|
|
1773
|
+
*/
|
|
1774
|
+
description: string;
|
|
1775
|
+
}
|
|
1776
|
+
export interface SubscriptionTopic {
|
|
1777
|
+
/**
|
|
1778
|
+
* The code of the Subscription Topic
|
|
1779
|
+
*/
|
|
1780
|
+
code: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* The name of the Subscription Topic
|
|
1783
|
+
*/
|
|
1784
|
+
name: string;
|
|
1785
|
+
/**
|
|
1786
|
+
* The display description of the Subscription Topic
|
|
1787
|
+
*/
|
|
1788
|
+
description: string;
|
|
1789
|
+
/**
|
|
1790
|
+
* The legal basis code (e.g., consent_optin).
|
|
1791
|
+
*/
|
|
1792
|
+
legalBasis: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* An array of the contact method codes ('email', 'sms', etc).
|
|
1795
|
+
*/
|
|
1796
|
+
contactMethods: string[];
|
|
1797
|
+
}
|
|
1798
|
+
/**
|
|
1799
|
+
* GetSubscriptionRequest
|
|
1800
|
+
*/
|
|
1801
|
+
export interface GetSubscriptionsRequest {
|
|
1802
|
+
organizationCode: string;
|
|
1803
|
+
controllerCode?: string;
|
|
1804
|
+
propertyCode?: string;
|
|
1805
|
+
environmentCode?: string;
|
|
1806
|
+
identities?: {
|
|
1807
|
+
[key: string]: string;
|
|
1808
|
+
};
|
|
1809
|
+
topics?: {
|
|
1810
|
+
[key: string]: SubscriptionTopicSetting;
|
|
1811
|
+
};
|
|
1812
|
+
controls?: {
|
|
1813
|
+
[key: string]: SubscriptionControlSetting;
|
|
1814
|
+
};
|
|
1815
|
+
collectedAt?: number;
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* GetSubscriptionResponse
|
|
1819
|
+
*/
|
|
1820
|
+
export interface GetSubscriptionsResponse {
|
|
1821
|
+
organizationCode: string;
|
|
1822
|
+
controllerCode?: string;
|
|
1823
|
+
propertyCode?: string;
|
|
1824
|
+
environmentCode?: string;
|
|
1825
|
+
identities?: {
|
|
1826
|
+
[key: string]: string;
|
|
1827
|
+
};
|
|
1828
|
+
topics?: {
|
|
1829
|
+
[key: string]: SubscriptionTopicSetting;
|
|
1830
|
+
};
|
|
1831
|
+
controls?: {
|
|
1832
|
+
[key: string]: SubscriptionControlSetting;
|
|
1833
|
+
};
|
|
1834
|
+
collectedAt?: number;
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* SetSubscriptionRequest
|
|
1838
|
+
*/
|
|
1839
|
+
export interface SetSubscriptionsRequest {
|
|
1840
|
+
organizationCode: string;
|
|
1841
|
+
controllerCode?: string;
|
|
1842
|
+
propertyCode?: string;
|
|
1843
|
+
environmentCode?: string;
|
|
1844
|
+
identities?: {
|
|
1845
|
+
[key: string]: string;
|
|
1846
|
+
};
|
|
1847
|
+
topics?: {
|
|
1848
|
+
[key: string]: SubscriptionTopicSetting;
|
|
1849
|
+
};
|
|
1850
|
+
controls?: {
|
|
1851
|
+
[key: string]: SubscriptionControlSetting;
|
|
1852
|
+
};
|
|
1853
|
+
collectedAt?: number;
|
|
1854
|
+
}
|
|
1855
|
+
/**
|
|
1856
|
+
* GetSubscriptionConfigurationRequest
|
|
1857
|
+
*/
|
|
1858
|
+
export interface GetSubscriptionConfigurationRequest {
|
|
1859
|
+
language: string;
|
|
1860
|
+
organizationCode: string;
|
|
1861
|
+
propertyCode: string;
|
|
1862
|
+
languageCode: string;
|
|
1863
|
+
}
|
|
1864
|
+
/**
|
|
1865
|
+
* GetSubscriptionConfigurationResponse
|
|
1866
|
+
*/
|
|
1867
|
+
export interface GetSubscriptionConfigurationResponse {
|
|
1868
|
+
language: string;
|
|
1869
|
+
organization: Organization;
|
|
1870
|
+
property: Property;
|
|
1871
|
+
identities: {
|
|
1872
|
+
[key: string]: Identity;
|
|
1873
|
+
};
|
|
1874
|
+
controls: SubscriptionControl[];
|
|
1875
|
+
topics: SubscriptionTopic[];
|
|
1876
|
+
}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
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.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
|
*
|
|
@@ -261,4 +261,9 @@ var StorageOriginPolicy;
|
|
|
261
261
|
*/
|
|
262
262
|
StorageOriginPolicy["SameOrigin"] = "same-origin,";
|
|
263
263
|
})(StorageOriginPolicy = exports.StorageOriginPolicy || (exports.StorageOriginPolicy = {}));
|
|
264
|
-
|
|
264
|
+
var SubscriptionStatus;
|
|
265
|
+
(function (SubscriptionStatus) {
|
|
266
|
+
SubscriptionStatus["Denied"] = "denied";
|
|
267
|
+
SubscriptionStatus["Granted"] = "granted";
|
|
268
|
+
})(SubscriptionStatus = exports.SubscriptionStatus || (exports.SubscriptionStatus = {}));
|
|
269
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7R0FJRztBQUNILElBQVksR0FJWDtBQUpELFdBQVksR0FBRztJQUNiLCtCQUF3QixDQUFBO0lBQ3hCLDJCQUFvQixDQUFBO0lBQ3BCLCtCQUF3QixDQUFBO0FBQzFCLENBQUMsRUFKVyxHQUFHLEdBQUgsV0FBRyxLQUFILFdBQUcsUUFJZDtBQUVEOztHQUVHO0FBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQTtBQUUxRDs7Ozs7R0FLRztBQUNILFNBQWdCLEtBQUssQ0FBQyxLQUFhO0lBQ2pDLE9BQU8sUUFBUSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQTtBQUNqQyxDQUFDO0FBRkQsc0JBRUM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLGlEQUErQixDQUFBO0lBQy9CLHVEQUFxQyxDQUFBO0FBQ3ZDLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLHFCQUlYO0FBSkQsV0FBWSxxQkFBcUI7SUFDL0IsOERBQXFDLENBQUE7SUFDckMsNERBQW1DLENBQUE7SUFDbkMsd0RBQStCLENBQUE7QUFDakMsQ0FBQyxFQUpXLHFCQUFxQixHQUFyQiw2QkFBcUIsS0FBckIsNkJBQXFCLFFBSWhDO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsSUFBWSxzQkFLWDtBQUxELFdBQVksc0JBQXNCO0lBQ2hDLG9EQUEwQixDQUFBO0lBQzFCLHNEQUE0QixDQUFBO0lBQzVCLHlDQUFlLENBQUE7SUFDZix1REFBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsc0JBQXNCLEdBQXRCLDhCQUFzQixLQUF0Qiw4QkFBc0IsUUFLakM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxpQkFHWDtBQUhELFdBQVksaUJBQWlCO0lBQzNCLDZEQUFVLENBQUE7SUFDViwyREFBUyxDQUFBO0FBQ1gsQ0FBQyxFQUhXLGlCQUFpQixHQUFqQix5QkFBaUIsS0FBakIseUJBQWlCLFFBRzVCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksMkJBSVg7QUFKRCxXQUFZLDJCQUEyQjtJQUNyQyx5RkFBYyxDQUFBO0lBQ2QsbUdBQW1CLENBQUE7SUFDbkIseUZBQWMsQ0FBQTtBQUNoQixDQUFDLEVBSlcsMkJBQTJCLEdBQTNCLG1DQUEyQixLQUEzQixtQ0FBMkIsUUFJdEM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSw2QkFHWDtBQUhELFdBQVksNkJBQTZCO0lBQ3ZDLDZHQUFzQixDQUFBO0lBQ3RCLDZGQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUhXLDZCQUE2QixHQUE3QixxQ0FBNkIsS0FBN0IscUNBQTZCLFFBR3hDO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksZUFNWDtBQU5ELFdBQVksZUFBZTtJQUN6QiwyRUFBbUIsQ0FBQTtJQUNuQix1RUFBaUIsQ0FBQTtJQUNqQixpRkFBc0IsQ0FBQTtJQUN0QiwrRUFBcUIsQ0FBQTtJQUNyQix5RUFBa0IsQ0FBQTtBQUNwQixDQUFDLEVBTlcsZUFBZSxHQUFmLHVCQUFlLEtBQWYsdUJBQWUsUUFNMUI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLHlEQUFXLENBQUE7SUFDWCwrREFBYyxDQUFBO0FBQ2hCLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDMUIscUVBQWUsQ0FBQTtJQUNmLHFFQUFlLENBQUE7QUFDakIsQ0FBQyxFQUhXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBRzNCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksY0FLWDtBQUxELFdBQVksY0FBYztJQUN4QiwrRUFBc0IsQ0FBQTtJQUN0QiwrREFBYyxDQUFBO0lBQ2QsaUVBQWUsQ0FBQTtJQUNmLDZEQUFhLENBQUE7QUFDZixDQUFDLEVBTFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFLekI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxZQVNYO0FBVEQsV0FBWSxZQUFZO0lBQ3RCLDRDQUE0QixDQUFBO0lBQzVCLHNEQUFzQyxDQUFBO0lBQ3RDLCtDQUErQixDQUFBO0lBQy9CLCtDQUErQixDQUFBO0lBQy9CLHVEQUF1QyxDQUFBO0lBQ3ZDLDREQUE0QyxDQUFBO0lBQzVDLGdFQUFnRCxDQUFBO0lBQ2hELDBEQUEwQyxDQUFBO0FBQzVDLENBQUMsRUFUVyxZQUFZLEdBQVosb0JBQVksS0FBWixvQkFBWSxRQVN2QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGNBT1g7QUFQRCxXQUFZLGNBQWM7SUFDeEIsZ0RBQThCLENBQUE7SUFDOUIsbURBQWlDLENBQUE7SUFDakMsK0NBQTZCLENBQUE7SUFDN0IsNkNBQTJCLENBQUE7SUFDM0IsaURBQStCLENBQUE7SUFDL0IseURBQXVDLENBQUE7QUFDekMsQ0FBQyxFQVBXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBT3pCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVkscUJBaUJYO0FBakJELFdBQVkscUJBQXFCO0lBQy9COztPQUVHO0lBQ0gscUdBQTBCLENBQUE7SUFDMUI7O09BRUc7SUFDSCxxSEFBa0MsQ0FBQTtJQUNsQzs7T0FFRztJQUNILDJHQUE2QixDQUFBO0lBQzdCOztPQUVHO0lBQ0gseUdBQTRCLENBQUE7QUFDOUIsQ0FBQyxFQWpCVyxxQkFBcUIsR0FBckIsNkJBQXFCLEtBQXJCLDZCQUFxQixRQWlCaEM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUtYO0FBTEQsV0FBWSxjQUFjO0lBQ3hCLHVEQUFVLENBQUE7SUFDVixpREFBTyxDQUFBO0lBQ1AsaUVBQWUsQ0FBQTtJQUNmLG1FQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFMVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUt6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGFBSVg7QUFKRCxXQUFZLGFBQWE7SUFDdkIscURBQVUsQ0FBQTtJQUNWLHlFQUFvQixDQUFBO0lBQ3BCLDJFQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUFKVyxhQUFhLEdBQWIscUJBQWEsS0FBYixxQkFBYSxRQUl4QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLG9CQXFCWDtBQXJCRCxXQUFZLG9CQUFvQjtJQUM5Qjs7T0FFRztJQUNILG1GQUFjLENBQUE7SUFDZDs7T0FFRztJQUNILG1GQUFjLENBQUE7SUFDZDs7T0FFRztJQUNILDJFQUFVLENBQUE7SUFDVjs7T0FFRztJQUNILHFGQUFlLENBQUE7SUFDZjs7T0FFRztJQUNILDZFQUFXLENBQUE7QUFDYixDQUFDLEVBckJXLG9CQUFvQixHQUFwQiw0QkFBb0IsS0FBcEIsNEJBQW9CLFFBcUIvQjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLG1CQVVYO0FBVkQsV0FBWSxtQkFBbUI7SUFDN0I7O09BRUc7SUFDSCxtREFBNEIsQ0FBQTtJQUU1Qjs7T0FFRztJQUNILGtEQUEyQixDQUFBO0FBQzdCLENBQUMsRUFWVyxtQkFBbUIsR0FBbkIsMkJBQW1CLEtBQW5CLDJCQUFtQixRQVU5QjtBQXFyREQsSUFBWSxrQkFHWDtBQUhELFdBQVksa0JBQWtCO0lBQzVCLHVDQUFpQixDQUFBO0lBQ2pCLHlDQUFtQixDQUFBO0FBQ3JCLENBQUMsRUFIVyxrQkFBa0IsR0FBbEIsMEJBQWtCLEtBQWxCLDBCQUFrQixRQUc3QiJ9
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name": "@ketch-sdk/ketch-types", "version": "1.
|
|
1
|
+
{"name": "@ketch-sdk/ketch-types", "version": "1.9.0", "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"]}
|