@ketch-sdk/ketch-types 1.1.0 → 1.1.2

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
@@ -28,10 +28,20 @@ export declare const ALL_TABS: readonly ["overviewTab", "rightsTab", "consentsTa
28
28
  declare type TabTuple = typeof ALL_TABS;
29
29
  export declare type Tab = TabTuple[number];
30
30
  export declare function isTab(value: string): value is Tab;
31
+ /**
32
+ * Plugin class
33
+ */
34
+ export interface PluginClass {
35
+ init(host: Ketch, config: Configuration): void;
36
+ }
31
37
  /**
32
38
  * Plugin factory function signature
33
39
  */
34
- export declare type Plugin = (host: Ketch, config?: any) => Promise<void>;
40
+ export declare type PluginFunction = (host: Ketch, config?: any) => Promise<void>;
41
+ /**
42
+ * Plugin
43
+ */
44
+ export declare type Plugin = PluginClass | PluginFunction;
35
45
  /**
36
46
  * Ketch host
37
47
  */
@@ -44,7 +54,6 @@ export interface Ketch {
44
54
  setProvisionalConsent(c: Consent): Promise<void>;
45
55
  onConsent(callback: Callback): Promise<void>;
46
56
  setShowConsentExperience(): Promise<void>;
47
- shouldShowConsent(c: Consent): boolean;
48
57
  showConsentExperience(): Promise<Consent>;
49
58
  onShowConsentExperience(callback: ShowConsentExperience): Promise<void>;
50
59
  showPreferenceExperience(params: ShowPreferenceOptions): Promise<Consent>;
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name": "@ketch-sdk/ketch-types", "version": "1.1.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.42.0", "@typescript-eslint/parser": "^5.42.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"}}
1
+ {"name": "@ketch-sdk/ketch-types", "version": "1.1.2", "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.3.1", "@types/jest": "^29.2.2", "@typescript-eslint/eslint-plugin": "^5.42.1", "@typescript-eslint/parser": "^5.42.1", "@vercel/ncc": "^0.34.0", "eslint": "^8.27.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.1.5", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-junit": "^14.0.1", "prettier": "^2.7.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.20", "typescript": "^4.8.4"}}
@@ -1,6 +1,6 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <coverage generated="1667556973238" clover="3.2.0">
3
- <project timestamp="1667556973238" name="All files">
2
+ <coverage generated="1668214336240" clover="3.2.0">
3
+ <project timestamp="1668214336240" 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-11-04T10:16:13.234Z
89
+ at 2022-11-12T00:52:16.235Z
90
90
  </div>
91
91
  <script src="prettify.js"></script>
92
92
  <script>