@ketch-sdk/ketch-types 1.5.0 → 1.6.0

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-/**
- * Callback
- */
-export declare type Callback = (arg0: any) => void;
 /**
  * Status
  */
@@ -23,14 +19,20 @@ export type Identities = {
 };
 /**
  * All Tabs
+ *
+ * @deprecated Future version will become a TypeScript enum
  */
 export declare const ALL_TABS: readonly ["overviewTab", "rightsTab", "consentsTab"];
 /**
  * TabTuple
+ *
+ * @deprecated Future version will become a TypeScript enum
  */
 export type TabTuple = typeof ALL_TABS;
 /**
  * Tab
+ *
+ * @deprecated Future version will become a TypeScript enum
  */
 export type Tab = TabTuple[number];
 /**
@@ -41,23 +43,114 @@ export type Tab = TabTuple[number];
 export declare function isTab(value: string): value is Tab;
 /**
  * Plugin class
+ *
+ * @deprecated New plugins should be functional plugins.
+ * @see PluginFunction
  */
 export interface PluginClass {
+    /**
+     * Initialize the plugin
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     */
     init?: (host: Ketch, config: Configuration) => void;
+    /**
+     * Equivalent of on('environment')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param env The environment
+     */
     environmentLoaded?: (host: Ketch, config: Configuration, env: Environment) => void;
+    /**
+     * Equivalent of on('geoip')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param ipInfo The IP information
+     */
     geoIPLoaded?: (host: Ketch, config: Configuration, ipInfo: IPInfo) => void;
+    /**
+     * Equivalent of on('identities')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param identities The identities
+     */
     identitiesLoaded?: (host: Ketch, config: Configuration, identities: Identities) => void;
+    /**
+     * Equivalent of on('jurisdiction')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param jurisdiction The jurisdiction
+     */
     jurisdictionLoaded?: (host: Ketch, config: Configuration, policyScope: string) => void;
+    /**
+     * Equivalent of on('regionInfo')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param regionInfo The region info
+     */
     regionInfoLoaded?: (host: Ketch, config: Configuration, region: string) => void;
+    /**
+     * Equivalent of on('consent')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consent The consent
+     */
     consentChanged?: (host: Ketch, config: Configuration, consent: Consent) => void;
+    /**
+     * Equivalent of on('rightInvoked')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param request The right invocation request
+     */
     rightInvoked?: (host: Ketch, config: Configuration, request: InvokeRightRequest) => void;
+    /**
+     * Equivalent of on('showConsentExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consents The current consents
+     * @param options The options for the experience
+     */
     showConsentExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowConsentOptions) => void;
+    /**
+     * Equivalent of on('showPreferenceExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consents The current consents
+     * @param options The options for the experience
+     */
     showPreferenceExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowPreferenceOptions) => void;
+    /**
+     * Equivalent of on('willShowExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param type The type of the experience
+     */
     willShowExperience?: (host: Ketch, config: Configuration, type: string) => void;
+    /**
+     * Equivalent of on('experienceHidden')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param reason The reason the experience was hidden
+     */
     experienceHidden?: (host: Ketch, config: Configuration, reason: string) => void;
 }
 /**
  * Plugin factory function signature
+ *
+ * @param host The Ketch instance
+ * @param config The plugin configuration
  */
 export type PluginFunction = (host: Ketch, config?: any) => Promise<void>;
 /**
@@ -75,20 +168,20 @@ export interface StorageProvider {
     /**
      * Get an item with the given key
      *
-     * @param key
+     * @param key The item key
      */
     getItem(key: string): Promise<string | null>;
     /**
      * Sets the value for the given key
      *
-     * @param key
-     * @param value
+     * @param key The item key
+     * @param value The item value
      */
     setItem(key: string, value: string): Promise<void>;
     /**
-     * Removes the given key
+     * Removes the given item
      *
-     * @param key
+     * @param key The item key
      */
     removeItem(key: string): Promise<void>;
 }
@@ -96,39 +189,103 @@ export interface Ketch {
     /**
      * Register a plugin with the given configuration
      *
-     * @param plugin
-     * @param config
+     * @param plugin The plugin
+     * @param config The plugin configuration
      */
     registerPlugin(plugin: Plugin, config?: any): Promise<void>;
     /**
      * Register an identity provider for the given identity
      *
-     * @param name
-     * @param provider
+     * @param name The name of the identity
+     * @param provider The provider of the identity
      */
     registerIdentityProvider(name: string, provider: IdentityProvider): Promise<void>;
     /**
      * Register a storage provider
      *
-     * @param provider
+     * @param provider The provider implementation
      */
     registerStorageProvider(provider: StorageProvider): Promise<void>;
+    /**
+     * Determines if consent has already been resolved.
+     *
+     * @deprecated future versions will become asynchronous
+     */
     hasConsent(): boolean;
+    /**
+     * Returns the Consent
+     */
     getConsent(): Promise<Consent>;
-    setConsent(c: Consent): Promise<Consent>;
+    /**
+     * Sets the consent
+     *
+     * @param consent
+     * @deprecated Future versions will not return the Consent promise
+     */
+    setConsent(consent: Consent): Promise<Consent>;
+    /**
+     * Set a flag to show the consent experience
+     *
+     * @deprecated Will be removed in a future version
+     */
     setShowConsentExperience(): Promise<void>;
+    /**
+     * Show the consent experience
+     *
+     * @deprecated Future versions will not return Consent in the Promise
+     */
     showConsentExperience(): Promise<Consent>;
-    showPreferenceExperience(params: ShowPreferenceOptions): Promise<Consent>;
+    /**
+     * Show the preference experience
+     *
+     * @param params The parameters for the experience
+     * @deprecated Future versions will not return Consent in the Promise
+     */
+    showPreferenceExperience(params?: ShowPreferenceOptions): Promise<Consent>;
+    /**
+     * Notify that the experience was closed
+     *
+     * @param reason Reason the experience was closed
+     * @deprecated This method will be moved to an experience interface. Future
+     * versions will not return Consent in the Promise
+     */
     experienceClosed(reason: ExperienceClosedReason): Promise<Consent>;
+    /**
+     * Invokes a right
+     *
+     * @param eventData The definition of the right
+     */
     invokeRight(eventData: InvokeRightEvent): Promise<void>;
+    /**
+     * Get the Configuration.
+     */
     getConfig(): Promise<Configuration>;
+    /**
+     * Get the Environment
+     */
     getEnvironment(): Promise<Environment>;
+    /**
+     * Get the IP information
+     */
     getGeoIP(): Promise<IPInfo>;
+    /**
+     * Get the identities
+     */
     getIdentities(): Promise<Identities>;
+    /**
+     * Get the jurisdiction
+     */
     getJurisdiction(): Promise<string>;
+    /**
+     * Get the region information
+     */
     getRegionInfo(): Promise<string>;
     /**
      * Alias for `emitter.on(eventName, listener)`.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
+     * @deprecated Future versions will become asynchronous
      */
     addListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
     /**
@@ -146,6 +303,8 @@ export interface Ketch {
      *
      * @param eventName The name of the event.
      * @param listener The callback function
+     *
+     * @deprecated Future versions will become asynchronous
      */
     on(eventName: string | symbol, listener: (...args: any[]) => void): this;
     /**
@@ -158,6 +317,8 @@ export interface Ketch {
      *
      * @param eventName The name of the event.
      * @param listener The callback function
+     *
+     * @deprecated Future versions will become asynchronous
      */
     once(eventName: string | symbol, listener: (...args: any[]) => void): this;
     /**
@@ -183,11 +344,19 @@ export interface Ketch {
      *
      * When a single function has been added as a handler multiple times for a single
      * event (as in the example below), `removeListener()` will remove the most
-     * recently added instance. In the example the `once('ping')`listener is removed:
+     * recently added instance. In the example the `once('ping')` listener is removed
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
+     * @deprecated Future versions will become asynchronous
      */
     removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
     /**
      * Alias for `emitter.removeListener()`.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
+     * @deprecated Future versions will become asynchronous
      */
     off(eventName: string | symbol, listener: (...args: any[]) => void): this;
     /**
@@ -197,30 +366,20 @@ export interface Ketch {
      * particularly when the `EventEmitter` instance was created by some other
      * component or module (e.g. sockets or file streams).
      *
-     * Returns a reference to the `EventEmitter`, so that calls can be chained.
-     */
-    removeAllListeners(event?: string | symbol): this;
-    /**
-     * By default `EventEmitter`s will print a warning if more than `10` listeners are
-     * added for a particular event. This is a useful default that helps finding
-     * memory leaks. The `emitter.setMaxListeners()` method allows the limit to be
-     * modified for this specific `EventEmitter` instance. The value can be set to
-     * `Infinity` (or `0`) to indicate an unlimited number of listeners.
-     *
-     * Returns a reference to the `EventEmitter`, so that calls can be chained.
-     */
-    setMaxListeners(n: number): this;
-    /**
-     * Returns the current max listener value for the `EventEmitter` which is either
-     * set by `emitter.setMaxListeners(n)` or defaults to {@link defaultMaxListeners}.
+     * @param eventName The name of the event.
+     * @deprecated Future versions will become asynchronous
      */
-    getMaxListeners(): number;
+    removeAllListeners(eventName?: string | symbol): this;
     /**
      * Synchronously calls each of the listeners registered for the event named
      * `eventName`, in the order they were registered, passing the supplied arguments
      * to each.
      *
      * @returns `true` if the event had listeners, `false` otherwise.
+     *
+     * @param eventName The name of the event.
+     * @param args The arguments for the event.
+     * @deprecated Future versions will become asynchronous
      */
     emit(eventName: string | symbol, ...args: any[]): boolean;
 }
@@ -228,6 +387,9 @@ export interface Ketch {
  * ShowPreferenceOptions
  */
 export type ShowPreferenceOptions = {
+    /**
+     * The tab to display.
+     */
     tab?: Tab;
     /**
      * dataSubjectTypeCodes is the list of data subjects to display. If undefined,
@@ -284,19 +446,13 @@ export type InvokeRightEvent = {
     subject: DataSubject;
     recaptchaToken?: string;
 };
-/**
- * AppDiv
- */
-export interface AppDiv {
-    id: string;
-    zIndex: string;
-}
 /**
  * ExperienceClosedReason describes the reason the experience was closed.
  *
  * setConsent = consent was accepted/set
  * invokeRight = the right was invoked
  * close = the close/exit button was clicked
+ * willNotShow = the experience was skipped
  *
  * @enum
  */
@@ -462,6 +618,9 @@ export interface GetConsentRequest {
     purposes: {
         [key: string]: PurposeLegalBasis;
     };
+    /**
+     * list of vendor ids for which the user has opted out
+     */
     vendors?: string[];
     collectedAt?: number;
 }
@@ -502,6 +661,9 @@ export interface SetConsentRequest {
     purposes: {
         [key: string]: PurposeAllowedLegalBasis;
     };
+    /**
+     * list of vendor ids for which the user has opted out
+     */
     vendors?: string[];
 }
 /**
@@ -1246,8 +1408,16 @@ export interface Loaded {
 declare global {
     interface Window {
         /**
-         * Semaphore is the main entrypoint.
+         * Semaphore is the action queue (should not be accessed directly except by legacy code
+         * which should be migrated to the `ketch` function).
          */
         semaphore: Pusher & Loaded;
+        /**
+         * Ketch is the main entrypoint to the JS API.
+         *
+         * @param action The action to invoke
+         * @param args The arguments to the action
+         */
+        ketch(action: string, ...args: any[]): void;
     }
 }

package/dist/index.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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.ALL_TABS = void 0;
 /**
  * All Tabs
+ *
+ * @deprecated Future version will become a TypeScript enum
  */
 exports.ALL_TABS = ['overviewTab', 'rightsTab', 'consentsTab'];
 /**
@@ -41,6 +43,7 @@ var ConsentExperienceType;
  * setConsent = consent was accepted/set
  * invokeRight = the right was invoked
  * close = the close/exit button was clicked
+ * willNotShow = the experience was skipped
  *
  * @enum
  */
@@ -204,4 +207,4 @@ var ModalPosition;
     ModalPosition[ModalPosition["LEFT_FULL_HEIGHT"] = 2] = "LEFT_FULL_HEIGHT";
     ModalPosition[ModalPosition["RIGHT_FULL_HEIGHT"] = 3] = "RIGHT_FULL_HEIGHT";
 })(ModalPosition = exports.ModalPosition || (exports.ModalPosition = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBdUJBOztHQUVHO0FBQ1UsUUFBQSxRQUFRLEdBQUcsQ0FBQyxhQUFhLEVBQUUsV0FBVyxFQUFFLGFBQWEsQ0FBVSxDQUFBO0FBWTVFOzs7O0dBSUc7QUFDSCxTQUFnQixLQUFLLENBQUMsS0FBYTtJQUNqQyxPQUFPLGdCQUFRLENBQUMsUUFBUSxDQUFDLEtBQVksQ0FBQyxDQUFBO0FBQ3hDLENBQUM7QUFGRCxzQkFFQztBQTBQRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLGlEQUErQixDQUFBO0lBQy9CLHVEQUFxQyxDQUFBO0FBQ3ZDLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLHFCQUlYO0FBSkQsV0FBWSxxQkFBcUI7SUFDL0IsOERBQXFDLENBQUE7SUFDckMsNERBQW1DLENBQUE7SUFDbkMsd0RBQStCLENBQUE7QUFDakMsQ0FBQyxFQUpXLHFCQUFxQixHQUFyQiw2QkFBcUIsS0FBckIsNkJBQXFCLFFBSWhDO0FBMkJEOzs7Ozs7OztHQVFHO0FBQ0gsSUFBWSxzQkFLWDtBQUxELFdBQVksc0JBQXNCO0lBQ2hDLG9EQUEwQixDQUFBO0lBQzFCLHNEQUE0QixDQUFBO0lBQzVCLHlDQUFlLENBQUE7SUFDZix1REFBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsc0JBQXNCLEdBQXRCLDhCQUFzQixLQUF0Qiw4QkFBc0IsUUFLakM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxpQkFHWDtBQUhELFdBQVksaUJBQWlCO0lBQzNCLDZEQUFVLENBQUE7SUFDViwyREFBUyxDQUFBO0FBQ1gsQ0FBQyxFQUhXLGlCQUFpQixHQUFqQix5QkFBaUIsS0FBakIseUJBQWlCLFFBRzVCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksMkJBSVg7QUFKRCxXQUFZLDJCQUEyQjtJQUNyQyx5RkFBYyxDQUFBO0lBQ2QsbUdBQW1CLENBQUE7SUFDbkIseUZBQWMsQ0FBQTtBQUNoQixDQUFDLEVBSlcsMkJBQTJCLEdBQTNCLG1DQUEyQixLQUEzQixtQ0FBMkIsUUFJdEM7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSw2QkFHWDtBQUhELFdBQVksNkJBQTZCO0lBQ3ZDLDZHQUFzQixDQUFBO0lBQ3RCLDZGQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUhXLDZCQUE2QixHQUE3QixxQ0FBNkIsS0FBN0IscUNBQTZCLFFBR3hDO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksZUFNWDtBQU5ELFdBQVksZUFBZTtJQUN6QiwyRUFBbUIsQ0FBQTtJQUNuQix1RUFBaUIsQ0FBQTtJQUNqQixpRkFBc0IsQ0FBQTtJQUN0QiwrRUFBcUIsQ0FBQTtJQUNyQix5RUFBa0IsQ0FBQTtBQUNwQixDQUFDLEVBTlcsZUFBZSxHQUFmLHVCQUFlLEtBQWYsdUJBQWUsUUFNMUI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLHlEQUFXLENBQUE7SUFDWCwrREFBYyxDQUFBO0FBQ2hCLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDMUIscUVBQWUsQ0FBQTtJQUNmLHFFQUFlLENBQUE7QUFDakIsQ0FBQyxFQUhXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBRzNCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksY0FLWDtBQUxELFdBQVksY0FBYztJQUN4QiwrRUFBc0IsQ0FBQTtJQUN0QiwrREFBYyxDQUFBO0lBQ2QsaUVBQWUsQ0FBQTtJQUNmLDZEQUFhLENBQUE7QUFDZixDQUFDLEVBTFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFLekI7QUF1VUQ7Ozs7R0FJRztBQUNILElBQVksWUFTWDtBQVRELFdBQVksWUFBWTtJQUN0Qiw0Q0FBNEIsQ0FBQTtJQUM1QixzREFBc0MsQ0FBQTtJQUN0QywrQ0FBK0IsQ0FBQTtJQUMvQiwrQ0FBK0IsQ0FBQTtJQUMvQix1REFBdUMsQ0FBQTtJQUN2Qyw0REFBNEMsQ0FBQTtJQUM1QyxnRUFBZ0QsQ0FBQTtJQUNoRCwwREFBMEMsQ0FBQTtBQUM1QyxDQUFDLEVBVFcsWUFBWSxHQUFaLG9CQUFZLEtBQVosb0JBQVksUUFTdkI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxjQU9YO0FBUEQsV0FBWSxjQUFjO0lBQ3hCLGdEQUE4QixDQUFBO0lBQzlCLG1EQUFpQyxDQUFBO0lBQ2pDLCtDQUE2QixDQUFBO0lBQzdCLDZDQUEyQixDQUFBO0lBQzNCLGlEQUErQixDQUFBO0lBQy9CLHlEQUF1QyxDQUFBO0FBQ3pDLENBQUMsRUFQVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQU96QjtBQTBDRDs7OztHQUlHO0FBQ0gsSUFBWSxxQkFpQlg7QUFqQkQsV0FBWSxxQkFBcUI7SUFDL0I7O09BRUc7SUFDSCxxR0FBMEIsQ0FBQTtJQUMxQjs7T0FFRztJQUNILHFIQUFrQyxDQUFBO0lBQ2xDOztPQUVHO0lBQ0gsMkdBQTZCLENBQUE7SUFDN0I7O09BRUc7SUFDSCx5R0FBNEIsQ0FBQTtBQUM5QixDQUFDLEVBakJXLHFCQUFxQixHQUFyQiw2QkFBcUIsS0FBckIsNkJBQXFCLFFBaUJoQztBQXFPRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUtYO0FBTEQsV0FBWSxjQUFjO0lBQ3hCLHVEQUFVLENBQUE7SUFDVixpREFBTyxDQUFBO0lBQ1AsaUVBQWUsQ0FBQTtJQUNmLG1FQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFMVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUt6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGFBSVg7QUFKRCxXQUFZLGFBQWE7SUFDdkIscURBQVUsQ0FBQTtJQUNWLHlFQUFvQixDQUFBO0lBQ3BCLDJFQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUFKVyxhQUFhLEdBQWIscUJBQWEsS0FBYixxQkFBYSxRQUl4QiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBa0JBOzs7O0dBSUc7QUFDVSxRQUFBLFFBQVEsR0FBRyxDQUFDLGFBQWEsRUFBRSxXQUFXLEVBQUUsYUFBYSxDQUFVLENBQUE7QUFnQjVFOzs7O0dBSUc7QUFDSCxTQUFnQixLQUFLLENBQUMsS0FBYTtJQUNqQyxPQUFPLGdCQUFRLENBQUMsUUFBUSxDQUFDLEtBQVksQ0FBQyxDQUFBO0FBQ3hDLENBQUM7QUFGRCxzQkFFQztBQXlhRDs7OztHQUlHO0FBQ0gsSUFBWSxjQUdYO0FBSEQsV0FBWSxjQUFjO0lBQ3hCLGlEQUErQixDQUFBO0lBQy9CLHVEQUFxQyxDQUFBO0FBQ3ZDLENBQUMsRUFIVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQUd6QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLHFCQUlYO0FBSkQsV0FBWSxxQkFBcUI7SUFDL0IsOERBQXFDLENBQUE7SUFDckMsNERBQW1DLENBQUE7SUFDbkMsd0RBQStCLENBQUE7QUFDakMsQ0FBQyxFQUpXLHFCQUFxQixHQUFyQiw2QkFBcUIsS0FBckIsNkJBQXFCLFFBSWhDO0FBbUJEOzs7Ozs7Ozs7R0FTRztBQUNILElBQVksc0JBS1g7QUFMRCxXQUFZLHNCQUFzQjtJQUNoQyxvREFBMEIsQ0FBQTtJQUMxQixzREFBNEIsQ0FBQTtJQUM1Qix5Q0FBZSxDQUFBO0lBQ2YsdURBQTZCLENBQUE7QUFDL0IsQ0FBQyxFQUxXLHNCQUFzQixHQUF0Qiw4QkFBc0IsS0FBdEIsOEJBQXNCLFFBS2pDO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksaUJBR1g7QUFIRCxXQUFZLGlCQUFpQjtJQUMzQiw2REFBVSxDQUFBO0lBQ1YsMkRBQVMsQ0FBQTtBQUNYLENBQUMsRUFIVyxpQkFBaUIsR0FBakIseUJBQWlCLEtBQWpCLHlCQUFpQixRQUc1QjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLDJCQUlYO0FBSkQsV0FBWSwyQkFBMkI7SUFDckMseUZBQWMsQ0FBQTtJQUNkLG1HQUFtQixDQUFBO0lBQ25CLHlGQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUpXLDJCQUEyQixHQUEzQixtQ0FBMkIsS0FBM0IsbUNBQTJCLFFBSXRDO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksNkJBR1g7QUFIRCxXQUFZLDZCQUE2QjtJQUN2Qyw2R0FBc0IsQ0FBQTtJQUN0Qiw2RkFBYyxDQUFBO0FBQ2hCLENBQUMsRUFIVyw2QkFBNkIsR0FBN0IscUNBQTZCLEtBQTdCLHFDQUE2QixRQUd4QztBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGVBTVg7QUFORCxXQUFZLGVBQWU7SUFDekIsMkVBQW1CLENBQUE7SUFDbkIsdUVBQWlCLENBQUE7SUFDakIsaUZBQXNCLENBQUE7SUFDdEIsK0VBQXFCLENBQUE7SUFDckIseUVBQWtCLENBQUE7QUFDcEIsQ0FBQyxFQU5XLGVBQWUsR0FBZix1QkFBZSxLQUFmLHVCQUFlLFFBTTFCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksY0FHWDtBQUhELFdBQVksY0FBYztJQUN4Qix5REFBVyxDQUFBO0lBQ1gsK0RBQWMsQ0FBQTtBQUNoQixDQUFDLEVBSFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFHekI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxnQkFHWDtBQUhELFdBQVksZ0JBQWdCO0lBQzFCLHFFQUFlLENBQUE7SUFDZixxRUFBZSxDQUFBO0FBQ2pCLENBQUMsRUFIVyxnQkFBZ0IsR0FBaEIsd0JBQWdCLEtBQWhCLHdCQUFnQixRQUczQjtBQUVEOzs7O0dBSUc7QUFDSCxJQUFZLGNBS1g7QUFMRCxXQUFZLGNBQWM7SUFDeEIsK0VBQXNCLENBQUE7SUFDdEIsK0RBQWMsQ0FBQTtJQUNkLGlFQUFlLENBQUE7SUFDZiw2REFBYSxDQUFBO0FBQ2YsQ0FBQyxFQUxXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBS3pCO0FBNlVEOzs7O0dBSUc7QUFDSCxJQUFZLFlBU1g7QUFURCxXQUFZLFlBQVk7SUFDdEIsNENBQTRCLENBQUE7SUFDNUIsc0RBQXNDLENBQUE7SUFDdEMsK0NBQStCLENBQUE7SUFDL0IsK0NBQStCLENBQUE7SUFDL0IsdURBQXVDLENBQUE7SUFDdkMsNERBQTRDLENBQUE7SUFDNUMsZ0VBQWdELENBQUE7SUFDaEQsMERBQTBDLENBQUE7QUFDNUMsQ0FBQyxFQVRXLFlBQVksR0FBWixvQkFBWSxLQUFaLG9CQUFZLFFBU3ZCO0FBRUQ7Ozs7R0FJRztBQUNILElBQVksY0FPWDtBQVBELFdBQVksY0FBYztJQUN4QixnREFBOEIsQ0FBQTtJQUM5QixtREFBaUMsQ0FBQTtJQUNqQywrQ0FBNkIsQ0FBQTtJQUM3Qiw2Q0FBMkIsQ0FBQTtJQUMzQixpREFBK0IsQ0FBQTtJQUMvQix5REFBdUMsQ0FBQTtBQUN6QyxDQUFDLEVBUFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFPekI7QUEwQ0Q7Ozs7R0FJRztBQUNILElBQVkscUJBaUJYO0FBakJELFdBQVkscUJBQXFCO0lBQy9COztPQUVHO0lBQ0gscUdBQTBCLENBQUE7SUFDMUI7O09BRUc7SUFDSCxxSEFBa0MsQ0FBQTtJQUNsQzs7T0FFRztJQUNILDJHQUE2QixDQUFBO0lBQzdCOztPQUVHO0lBQ0gseUdBQTRCLENBQUE7QUFDOUIsQ0FBQyxFQWpCVyxxQkFBcUIsR0FBckIsNkJBQXFCLEtBQXJCLDZCQUFxQixRQWlCaEM7QUFxT0Q7Ozs7R0FJRztBQUNILElBQVksY0FLWDtBQUxELFdBQVksY0FBYztJQUN4Qix1REFBVSxDQUFBO0lBQ1YsaURBQU8sQ0FBQTtJQUNQLGlFQUFlLENBQUE7SUFDZixtRUFBZ0IsQ0FBQTtBQUNsQixDQUFDLEVBTFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFLekI7QUFFRDs7OztHQUlHO0FBQ0gsSUFBWSxhQUlYO0FBSkQsV0FBWSxhQUFhO0lBQ3ZCLHFEQUFVLENBQUE7SUFDVix5RUFBb0IsQ0FBQTtJQUNwQiwyRUFBcUIsQ0FBQTtBQUN2QixDQUFDLEVBSlcsYUFBYSxHQUFiLHFCQUFhLEtBQWIscUJBQWEsUUFJeEIifQ==

package/package.json

@@ -1 +1 @@
-{"name": "@ketch-sdk/ketch-types", "version": "1.5.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": {"@jest/globals": "^29.4.1", "@types/events": "^3.0.0", "@types/jest": "^29.4.0", "@typescript-eslint/eslint-plugin": "^5.49.0", "@typescript-eslint/parser": "^5.49.0", "eslint": "^8.33.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.1", "jest-environment-jsdom": "^29.4.1", "jest-junit": "^15.0.0", "prettier": "^2.8.3", "ts-jest": "^29.0.5", "typedoc": "^0.23.24", "typescript": "^4.9.4"}, "files": ["./dist"]}
+{"name": "@ketch-sdk/ketch-types", "version": "1.6.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.50.0", "@typescript-eslint/parser": "^5.50.0", "eslint": "^8.33.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.1", "jest-environment-jsdom": "^29.4.1", "jest-junit": "^15.0.0", "prettier": "^2.8.3", "ts-jest": "^29.0.5", "typedoc": "^0.23.24", "typescript": "^4.9.5"}, "files": ["./dist"]}