@ketch-sdk/ketch-types 0.2.4 → 0.4.0

package/dist/index.d.ts

@@ -29,62 +29,53 @@ export declare type PreferenceExperienceParams = {
     dataSubjectTypeCodes?: string[];
 };
 /**
- * Plugin
- */
-export interface Plugin {
-    init: (host: Ketch, config: Configuration) => void;
-    environmentLoaded?: (host: Ketch, config: Configuration, env: Environment) => void;
-    geoIPLoaded?: (host: Ketch, config: Configuration, ipInfo: IPInfo) => void;
-    identitiesLoaded?: (host: Ketch, config: Configuration, identities: Identities) => void;
-    jurisdictionLoaded?: (host: Ketch, config: Configuration, policyScope: string) => void;
-    regionInfoLoaded?: (host: Ketch, config: Configuration, region: string) => void;
-    consentChanged?: (host: Ketch, config: Configuration, consent: Consent) => void;
-    rightInvoked?: (host: Ketch, config: Configuration, request: InvokeRightRequest) => void;
-    showConsentExperience?: ShowConsentExperience;
-    showPreferenceExperience?: ShowPreferenceExperience;
-    willShowExperience?: (host: Ketch, config: Configuration) => void;
-    experienceHidden?: (host: Ketch, config: Configuration, reason?: string) => void;
-}
+ * Plugin factory function signature
+ */
+export declare type Plugin = (host: Ketch, config?: any) => Promise<void>;
 /**
  * Ketch host
  */
 export interface Ketch {
     getConfig(): Promise<Configuration>;
-    registerPlugin(plugin: Plugin): Promise<void>;
-    getProperty(p: string): string | null;
+    registerPlugin(plugin: Plugin, config?: any): Promise<void>;
     hasConsent(): boolean;
     getConsent(): Promise<Consent>;
     setConsent(c: Consent): Promise<Consent>;
     changeConsent(consent: Consent): Promise<void>;
     setProvisionalConsent(c: Consent): Promise<void>;
     onConsent(callback: Callback): Promise<void>;
-    invokeRight(eventData: InvokeRightsEvent): Promise<void>;
-    onInvokeRight(callback: Callback): Promise<void>;
-    shouldShowConsent(c: Consent): boolean;
     setShowConsentExperience(): Promise<void>;
+    shouldShowConsent(c: Consent): boolean;
     showConsentExperience(): Promise<Consent>;
     onShowConsentExperience(callback: ShowConsentExperience): Promise<void>;
     showPreferenceExperience(params: PreferenceExperienceParams): Promise<Consent>;
     onShowPreferenceExperience(callback: ShowPreferenceExperience): Promise<void>;
-    experienceClosed(reason: string): Promise<Consent>;
+    experienceClosed(reason: ExperienceClosedReason): Promise<Consent>;
     onHideExperience(callback: Callback): Promise<void>;
     onWillShowExperience(callback: Callback): Promise<void>;
-    getEnvironment(): Promise<Environment>;
+    invokeRight(eventData: InvokeRightsEvent): Promise<void>;
+    onInvokeRight(callback: Callback): Promise<void>;
     setEnvironment(env: Environment): Promise<Environment>;
+    getEnvironment(): Promise<Environment>;
     onEnvironment(callback: Callback): Promise<void>;
-    getGeoIP(): Promise<IPInfo>;
     setGeoIP(g: IPInfo): Promise<IPInfo>;
+    getGeoIP(): Promise<IPInfo>;
     onGeoIP(callback: Callback): Promise<void>;
-    getIdentities(): Promise<Identities>;
     setIdentities(id: Identities): Promise<Identities>;
+    getIdentities(): Promise<Identities>;
     onIdentities(callback: Callback): Promise<void>;
-    getJurisdiction(): Promise<string>;
     setJurisdiction(ps: string): Promise<string>;
+    getJurisdiction(): Promise<string>;
     onJurisdiction(callback: Callback): Promise<void>;
+    setRegionInfo(info: string): Promise<string>;
     getRegionInfo(): Promise<string>;
     onRegionInfo(callback: Callback): Promise<void>;
-    setRegionInfo(info: string): Promise<string>;
-    fireNativeEvent(name: string, args: any): Promise<void>;
+    emit(eventName: string | symbol, ...args: any[]): boolean;
+    addListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
+    removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
+    on(eventName: string | symbol, listener: (...args: any[]) => void): this;
+    once(eventName: string | symbol, listener: (...args: any[]) => void): this;
+    off(eventName: string | symbol, listener: (...args: any[]) => void): this;
 }
 /**
  * ShowPreferenceExperience
@@ -138,6 +129,14 @@ 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
+ */
+export declare type ExperienceClosedReason = 'setConsent' | 'invokeRight' | 'close';
 /**
  * ExperienceDefault
  */
@@ -906,45 +905,136 @@ export interface Stack {
  * Configuration
  */
 export interface Configuration {
-    language?: string;
+    /**
+     * Organization this configuration belongs to
+     */
     organization: Organization;
+    /**
+     * Property this configuration belongs to
+     */
     property?: Property;
+    /**
+     * Language for all text
+     */
+    language?: string;
+    /**
+     * Available environments. Only available in the "boot" configuration.
+     */
     environments?: Environment[];
+    /**
+     * Environment for this configuration. Only available in the "full" configuration.
+     */
     environment?: Environment;
+    /**
+     * Applicable jurisdiction.
+     */
     jurisdiction?: JurisdictionInfo;
+    /**
+     * Identity spaces defined for this property
+     */
     identities?: {
         [key: string]: Identity;
     };
+    /**
+     * Deployment information. Only available in the "full" configuration.
+     */
     deployment?: Deployment;
+    /**
+     * Regulations enabled for this jurisdiction.
+     */
     regulations?: string[];
+    /**
+     * Rights available in this jurisdiction.
+     */
     rights?: Right[];
+    /**
+     * Purposes in this jurisdiction.
+     */
     purposes?: Purpose[];
+    /**
+     * Mapping of purposes to canonical purposes.
+     *
+     * @deprecated
+     */
     canonicalPurposes?: {
         [key: string]: CanonicalPurpose;
     };
+    /**
+     * Privacy policy document
+     */
+    privacyPolicy?: PolicyDocument;
+    /**
+     * Terms of Service (ToS) policy document
+     */
+    termsOfService?: PolicyDocument;
+    /**
+     * Theme
+     */
+    theme?: Theme;
+    /**
+     * Experience definitions
+     */
     experiences?: Experience;
+    /**
+     * Services
+     */
     services?: {
         [key: string]: string;
     };
+    /**
+     * Flexible options
+     */
     options?: {
         [key: string]: string;
     };
-    privacyPolicy?: PolicyDocument;
-    termsOfService?: PolicyDocument;
-    theme?: Theme;
+    /**
+     * Scripts to load
+     */
     scripts?: string[];
+    /**
+     * Plugins configured for the 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[];
 }
-export declare type Pusher = {
+/**
+ * Pusher interface defines a type that has a push function like an array
+ */
+export interface Pusher {
+    /**
+     * Pushes the given arguments.
+     *
+     * @param args The arguments to push.
+     */
     push(args: any[]): void;
-};
-export declare type Loaded = {
-    loaded?: boolean;
-};
+}
+/**
+ * Loaded interface defines a type that has a loaded boolean property
+ */
+export interface Loaded {
+    /**
+     * Loaded is set to true if the object has fully loaded
+     */
+    loaded: boolean;
+}
 declare global {
     interface Window {
+        /**
+         * Semaphore is the main entrypoint.
+         */
         semaphore: Pusher & Loaded;
     }
 }

package/package.json

@@ -1 +1 @@
-{"name": "@ketch-sdk/ketch-types", "version": "0.2.4", "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.1", "@types/jest": "^29.2.0", "@typescript-eslint/eslint-plugin": "^5.40.1", "@typescript-eslint/parser": "^5.40.1", "@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.1", "jest-environment-jsdom": "^29.2.1", "jest-junit": "^14.0.1", "prettier": "^2.7.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.17", "typescript": "^4.8.4"}}
+{"name": "@ketch-sdk/ketch-types", "version": "0.4.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.41.0", "@typescript-eslint/parser": "^5.41.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="1666569121799" clover="3.2.0">
-  <project timestamp="1666569121799" name="All files">
+<coverage generated="1667182055910" clover="3.2.0">
+  <project timestamp="1667182055910" 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-23T23:52:01.796Z
+                at 2022-10-31T02:07:35.907Z
             </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>