@ketch-sdk/ketch-types 1.4.1 → 1.4.3

package/dist/index.js

@@ -0,0 +1,177 @@
+"use strict";
+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
+ */
+exports.ALL_TABS = ['overviewTab', 'rightsTab', 'consentsTab'];
+/**
+ * Determines if the Given value is a Tab
+ *
+ * @param value
+ */
+function isTab(value) {
+    return exports.ALL_TABS.includes(value);
+}
+exports.isTab = isTab;
+/**
+ * ExperienceType is the type of experience that will be shown
+ */
+var ExperienceType;
+(function (ExperienceType) {
+    ExperienceType["Consent"] = "experiences.consent";
+    ExperienceType["Preference"] = "experiences.preference";
+})(ExperienceType = exports.ExperienceType || (exports.ExperienceType = {}));
+/**
+ * ConsentExperienceType is the type of consent experience that will be shown
+ */
+var ConsentExperienceType;
+(function (ConsentExperienceType) {
+    ConsentExperienceType["Banner"] = "experiences.consent.banner";
+    ConsentExperienceType["Modal"] = "experiences.consent.modal";
+    ConsentExperienceType["JIT"] = "experiences.consent.jit";
+})(ConsentExperienceType = exports.ConsentExperienceType || (exports.ConsentExperienceType = {}));
+/**
+ * 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
+ */
+var ExperienceClosedReason;
+(function (ExperienceClosedReason) {
+    ExperienceClosedReason["SET_CONSENT"] = "setConsent";
+    ExperienceClosedReason["INVOKE_RIGHT"] = "invokeRight";
+    ExperienceClosedReason["CLOSE"] = "close";
+    ExperienceClosedReason["WILL_NOT_SHOW"] = "willNotShow";
+})(ExperienceClosedReason = exports.ExperienceClosedReason || (exports.ExperienceClosedReason = {}));
+/**
+ * ExperienceDefault
+ */
+var ExperienceDefault;
+(function (ExperienceDefault) {
+    ExperienceDefault[ExperienceDefault["BANNER"] = 1] = "BANNER";
+    ExperienceDefault[ExperienceDefault["MODAL"] = 2] = "MODAL";
+})(ExperienceDefault = exports.ExperienceDefault || (exports.ExperienceDefault = {}));
+/**
+ * ExperienceButtonDestination
+ */
+var ExperienceButtonDestination;
+(function (ExperienceButtonDestination) {
+    ExperienceButtonDestination[ExperienceButtonDestination["GOTO_MODAL"] = 1] = "GOTO_MODAL";
+    ExperienceButtonDestination[ExperienceButtonDestination["GOTO_PREFERENCE"] = 2] = "GOTO_PREFERENCE";
+    ExperienceButtonDestination[ExperienceButtonDestination["REJECT_ALL"] = 3] = "REJECT_ALL";
+})(ExperienceButtonDestination = exports.ExperienceButtonDestination || (exports.ExperienceButtonDestination = {}));
+/**
+ * ExperiencePrimaryButtonAction
+ */
+var ExperiencePrimaryButtonAction;
+(function (ExperiencePrimaryButtonAction) {
+    ExperiencePrimaryButtonAction[ExperiencePrimaryButtonAction["SAVE_CURRENT_STATE"] = 1] = "SAVE_CURRENT_STATE";
+    ExperiencePrimaryButtonAction[ExperiencePrimaryButtonAction["ACCEPT_ALL"] = 2] = "ACCEPT_ALL";
+})(ExperiencePrimaryButtonAction = exports.ExperiencePrimaryButtonAction || (exports.ExperiencePrimaryButtonAction = {}));
+/**
+ * MigrationOption
+ */
+var MigrationOption;
+(function (MigrationOption) {
+    MigrationOption[MigrationOption["MIGRATE_DEFAULT"] = 0] = "MIGRATE_DEFAULT";
+    MigrationOption[MigrationOption["MIGRATE_NEVER"] = 1] = "MIGRATE_NEVER";
+    MigrationOption[MigrationOption["MIGRATE_FROM_ALLOW"] = 2] = "MIGRATE_FROM_ALLOW";
+    MigrationOption[MigrationOption["MIGRATE_FROM_DENY"] = 3] = "MIGRATE_FROM_DENY";
+    MigrationOption[MigrationOption["MIGRATE_ALWAYS"] = 4] = "MIGRATE_ALWAYS";
+})(MigrationOption = exports.MigrationOption || (exports.MigrationOption = {}));
+/**
+ * CookieDuration
+ */
+var CookieDuration;
+(function (CookieDuration) {
+    CookieDuration[CookieDuration["SESSION"] = 1] = "SESSION";
+    CookieDuration[CookieDuration["PERSISTENT"] = 2] = "PERSISTENT";
+})(CookieDuration = exports.CookieDuration || (exports.CookieDuration = {}));
+/**
+ * CookieProvenance
+ */
+var CookieProvenance;
+(function (CookieProvenance) {
+    CookieProvenance[CookieProvenance["FIRST_PARTY"] = 1] = "FIRST_PARTY";
+    CookieProvenance[CookieProvenance["THIRD_PARTY"] = 2] = "THIRD_PARTY";
+})(CookieProvenance = exports.CookieProvenance || (exports.CookieProvenance = {}));
+/**
+ * CookieCategory
+ */
+var CookieCategory;
+(function (CookieCategory) {
+    CookieCategory[CookieCategory["STRICTLY_NECESSARY"] = 1] = "STRICTLY_NECESSARY";
+    CookieCategory[CookieCategory["FUNCTIONAL"] = 2] = "FUNCTIONAL";
+    CookieCategory[CookieCategory["PERFORMANCE"] = 3] = "PERFORMANCE";
+    CookieCategory[CookieCategory["MARKETING"] = 4] = "MARKETING";
+})(CookieCategory = exports.CookieCategory || (exports.CookieCategory = {}));
+/**
+ * IdentityLocation is the location on the page from which to retrieve identity information
+ */
+var IdentityType;
+(function (IdentityType) {
+    IdentityType["IDENTITY_TYPE_UNDEFINED"] = "";
+    IdentityType["IDENTITY_TYPE_DATA_LAYER"] = "dataLayer";
+    IdentityType["IDENTITY_TYPE_WINDOW"] = "window";
+    IdentityType["IDENTITY_TYPE_COOKIE"] = "cookie";
+    IdentityType["IDENTITY_TYPE_MANAGED"] = "managedCookie";
+    IdentityType["IDENTITY_TYPE_LOCAL_STORAGE"] = "localStorage";
+    IdentityType["IDENTITY_TYPE_SESSION_STORAGE"] = "sessionStorage";
+    IdentityType["IDENTITY_TYPE_QUERY_STRING"] = "queryString";
+})(IdentityType = exports.IdentityType || (exports.IdentityType = {}));
+/**
+ * IdentityFormat is the encoding of the string identity value
+ */
+var IdentityFormat;
+(function (IdentityFormat) {
+    IdentityFormat["IDENTITY_FORMAT_UNDEFINED"] = "";
+    IdentityFormat["IDENTITY_FORMAT_STRING"] = "string";
+    IdentityFormat["IDENTITY_FORMAT_JSON"] = "json";
+    IdentityFormat["IDENTITY_FORMAT_JWT"] = "jwt";
+    IdentityFormat["IDENTITY_FORMAT_QUERY"] = "query";
+    IdentityFormat["IDENTITY_FORMAT_SEMICOLON"] = "semicolon";
+})(IdentityFormat = exports.IdentityFormat || (exports.IdentityFormat = {}));
+/**
+ * SwitchTextRenderLogic
+ */
+var SwitchTextRenderLogic;
+(function (SwitchTextRenderLogic) {
+    /**
+     * SWITCH_TEXT_RENDER_ALL always renders the switch text regardless of state
+     */
+    SwitchTextRenderLogic[SwitchTextRenderLogic["SWITCH_TEXT_RENDER_ALL"] = 1] = "SWITCH_TEXT_RENDER_ALL";
+    /**
+     * SWITCH_TEXT_RENDER_LEGAL_BASIS renders the switch text only if different from the legal basis default
+     */
+    SwitchTextRenderLogic[SwitchTextRenderLogic["SWITCH_TEXT_RENDER_LEGAL_BASIS"] = 2] = "SWITCH_TEXT_RENDER_LEGAL_BASIS";
+    /**
+     * SWITCH_TEXT_RENDER_CHANGE renders the switch only if the user changes the state of the switch
+     */
+    SwitchTextRenderLogic[SwitchTextRenderLogic["SWITCH_TEXT_RENDER_CHANGE"] = 3] = "SWITCH_TEXT_RENDER_CHANGE";
+    /**
+     * SWITCH_TEXT_RENDER_NEVER never renders the switch text
+     */
+    SwitchTextRenderLogic[SwitchTextRenderLogic["SWITCH_TEXT_RENDER_NEVER"] = 4] = "SWITCH_TEXT_RENDER_NEVER";
+})(SwitchTextRenderLogic = exports.SwitchTextRenderLogic || (exports.SwitchTextRenderLogic = {}));
+/**
+ * BannerPosition
+ */
+var BannerPosition;
+(function (BannerPosition) {
+    BannerPosition[BannerPosition["BOTTOM"] = 1] = "BOTTOM";
+    BannerPosition[BannerPosition["TOP"] = 2] = "TOP";
+    BannerPosition[BannerPosition["BOTTOM_LEFT"] = 3] = "BOTTOM_LEFT";
+    BannerPosition[BannerPosition["BOTTOM_RIGHT"] = 4] = "BOTTOM_RIGHT";
+})(BannerPosition = exports.BannerPosition || (exports.BannerPosition = {}));
+/**
+ * ModalPosition
+ */
+var ModalPosition;
+(function (ModalPosition) {
+    ModalPosition[ModalPosition["CENTER"] = 1] = "CENTER";
+    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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBdUJBOztHQUVHO0FBQ1UsUUFBQSxRQUFRLEdBQUcsQ0FBQyxhQUFhLEVBQUUsV0FBVyxFQUFFLGFBQWEsQ0FBVSxDQUFBO0FBWTVFOzs7O0dBSUc7QUFDSCxTQUFnQixLQUFLLENBQUMsS0FBYTtJQUNqQyxPQUFPLGdCQUFRLENBQUMsUUFBUSxDQUFDLEtBQVksQ0FBQyxDQUFBO0FBQ3hDLENBQUM7QUFGRCxzQkFFQztBQTRPRDs7R0FFRztBQUNILElBQVksY0FHWDtBQUhELFdBQVksY0FBYztJQUN4QixpREFBK0IsQ0FBQTtJQUMvQix1REFBcUMsQ0FBQTtBQUN2QyxDQUFDLEVBSFcsY0FBYyxHQUFkLHNCQUFjLEtBQWQsc0JBQWMsUUFHekI7QUFFRDs7R0FFRztBQUNILElBQVkscUJBSVg7QUFKRCxXQUFZLHFCQUFxQjtJQUMvQiw4REFBcUMsQ0FBQTtJQUNyQyw0REFBbUMsQ0FBQTtJQUNuQyx3REFBK0IsQ0FBQTtBQUNqQyxDQUFDLEVBSlcscUJBQXFCLEdBQXJCLDZCQUFxQixLQUFyQiw2QkFBcUIsUUFJaEM7QUEyQkQ7Ozs7OztHQU1HO0FBQ0gsSUFBWSxzQkFLWDtBQUxELFdBQVksc0JBQXNCO0lBQ2hDLG9EQUEwQixDQUFBO0lBQzFCLHNEQUE0QixDQUFBO0lBQzVCLHlDQUFlLENBQUE7SUFDZix1REFBNkIsQ0FBQTtBQUMvQixDQUFDLEVBTFcsc0JBQXNCLEdBQXRCLDhCQUFzQixLQUF0Qiw4QkFBc0IsUUFLakM7QUFFRDs7R0FFRztBQUNILElBQVksaUJBR1g7QUFIRCxXQUFZLGlCQUFpQjtJQUMzQiw2REFBVSxDQUFBO0lBQ1YsMkRBQVMsQ0FBQTtBQUNYLENBQUMsRUFIVyxpQkFBaUIsR0FBakIseUJBQWlCLEtBQWpCLHlCQUFpQixRQUc1QjtBQUVEOztHQUVHO0FBQ0gsSUFBWSwyQkFJWDtBQUpELFdBQVksMkJBQTJCO0lBQ3JDLHlGQUFjLENBQUE7SUFDZCxtR0FBbUIsQ0FBQTtJQUNuQix5RkFBYyxDQUFBO0FBQ2hCLENBQUMsRUFKVywyQkFBMkIsR0FBM0IsbUNBQTJCLEtBQTNCLG1DQUEyQixRQUl0QztBQUVEOztHQUVHO0FBQ0gsSUFBWSw2QkFHWDtBQUhELFdBQVksNkJBQTZCO0lBQ3ZDLDZHQUFzQixDQUFBO0lBQ3RCLDZGQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUhXLDZCQUE2QixHQUE3QixxQ0FBNkIsS0FBN0IscUNBQTZCLFFBR3hDO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGVBTVg7QUFORCxXQUFZLGVBQWU7SUFDekIsMkVBQW1CLENBQUE7SUFDbkIsdUVBQWlCLENBQUE7SUFDakIsaUZBQXNCLENBQUE7SUFDdEIsK0VBQXFCLENBQUE7SUFDckIseUVBQWtCLENBQUE7QUFDcEIsQ0FBQyxFQU5XLGVBQWUsR0FBZix1QkFBZSxLQUFmLHVCQUFlLFFBTTFCO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGNBR1g7QUFIRCxXQUFZLGNBQWM7SUFDeEIseURBQVcsQ0FBQTtJQUNYLCtEQUFjLENBQUE7QUFDaEIsQ0FBQyxFQUhXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBR3pCO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDMUIscUVBQWUsQ0FBQTtJQUNmLHFFQUFlLENBQUE7QUFDakIsQ0FBQyxFQUhXLGdCQUFnQixHQUFoQix3QkFBZ0IsS0FBaEIsd0JBQWdCLFFBRzNCO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGNBS1g7QUFMRCxXQUFZLGNBQWM7SUFDeEIsK0VBQXNCLENBQUE7SUFDdEIsK0RBQWMsQ0FBQTtJQUNkLGlFQUFlLENBQUE7SUFDZiw2REFBYSxDQUFBO0FBQ2YsQ0FBQyxFQUxXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBS3pCO0FBd1VEOztHQUVHO0FBQ0gsSUFBWSxZQVNYO0FBVEQsV0FBWSxZQUFZO0lBQ3RCLDRDQUE0QixDQUFBO0lBQzVCLHNEQUFzQyxDQUFBO0lBQ3RDLCtDQUErQixDQUFBO0lBQy9CLCtDQUErQixDQUFBO0lBQy9CLHVEQUF1QyxDQUFBO0lBQ3ZDLDREQUE0QyxDQUFBO0lBQzVDLGdFQUFnRCxDQUFBO0lBQ2hELDBEQUEwQyxDQUFBO0FBQzVDLENBQUMsRUFUVyxZQUFZLEdBQVosb0JBQVksS0FBWixvQkFBWSxRQVN2QjtBQUVEOztHQUVHO0FBQ0gsSUFBWSxjQU9YO0FBUEQsV0FBWSxjQUFjO0lBQ3hCLGdEQUE4QixDQUFBO0lBQzlCLG1EQUFpQyxDQUFBO0lBQ2pDLCtDQUE2QixDQUFBO0lBQzdCLDZDQUEyQixDQUFBO0lBQzNCLGlEQUErQixDQUFBO0lBQy9CLHlEQUF1QyxDQUFBO0FBQ3pDLENBQUMsRUFQVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQU96QjtBQTBDRDs7R0FFRztBQUNILElBQVkscUJBaUJYO0FBakJELFdBQVkscUJBQXFCO0lBQy9COztPQUVHO0lBQ0gscUdBQTBCLENBQUE7SUFDMUI7O09BRUc7SUFDSCxxSEFBa0MsQ0FBQTtJQUNsQzs7T0FFRztJQUNILDJHQUE2QixDQUFBO0lBQzdCOztPQUVHO0lBQ0gseUdBQTRCLENBQUE7QUFDOUIsQ0FBQyxFQWpCVyxxQkFBcUIsR0FBckIsNkJBQXFCLEtBQXJCLDZCQUFxQixRQWlCaEM7QUFxT0Q7O0dBRUc7QUFDSCxJQUFZLGNBS1g7QUFMRCxXQUFZLGNBQWM7SUFDeEIsdURBQVUsQ0FBQTtJQUNWLGlEQUFPLENBQUE7SUFDUCxpRUFBZSxDQUFBO0lBQ2YsbUVBQWdCLENBQUE7QUFDbEIsQ0FBQyxFQUxXLGNBQWMsR0FBZCxzQkFBYyxLQUFkLHNCQUFjLFFBS3pCO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGFBSVg7QUFKRCxXQUFZLGFBQWE7SUFDdkIscURBQVUsQ0FBQTtJQUNWLHlFQUFvQixDQUFBO0lBQ3BCLDJFQUFxQixDQUFBO0FBQ3ZCLENBQUMsRUFKVyxhQUFhLEdBQWIscUJBQWEsS0FBYixxQkFBYSxRQUl4QiJ9

package/package.json

@@ -1 +1 @@
-{"name": "@ketch-sdk/ketch-types", "version": "1.4.1", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "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.3.1", "@types/jest": "^29.2.5", "@typescript-eslint/eslint-plugin": "^5.48.0", "@typescript-eslint/parser": "^5.48.0", "eslint": "^8.31.0", "eslint-config-prettier": "^8.6.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.2.0", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-junit": "^15.0.0", "prettier": "^2.8.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.23", "typescript": "^4.9.4"}}
+{"name": "@ketch-sdk/ketch-types", "version": "1.4.3", "description": "Ketch Types", "main": "./dist/index.js", "types": "./dist/index.d.ts", "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.3.1", "@types/jest": "^29.2.5", "@typescript-eslint/eslint-plugin": "^5.48.0", "@typescript-eslint/parser": "^5.48.0", "eslint": "^8.31.0", "eslint-config-prettier": "^8.6.0", "eslint-plugin-import": "^2.26.0", "eslint-plugin-jest": "^27.2.0", "eslint-plugin-prettier": "^4.2.1", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-junit": "^15.0.0", "prettier": "^2.8.1", "ts-jest": "^29.0.3", "typedoc": "^0.23.23", "typescript": "^4.9.4"}, "files": ["./dist"]}

package/.editorconfig

@@ -1,13 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-indent_style = space
-indent_size = 2
-tab_width = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-

package/.eslintignore

@@ -1,3 +0,0 @@
-dist/
-node_modules/
-jest.config.js

package/.eslintrc.json

@@ -1,31 +0,0 @@
-{
-  "extends": [
-    "eslint:recommended",
-    "plugin:jest/recommended",
-    "plugin:jest/style",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "env": {
-    "browser": true,
-    "es6": true,
-    "jest/globals": true
-  },
-  "globals": {
-    "Atomics": "readonly",
-    "SharedArrayBuffer": "readonly"
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "plugins": ["@typescript-eslint/eslint-plugin", "jest"],
-  "rules": {
-    "no-empty-function": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "valid-jsdoc": "off",
-    "max-len": ["error", 120],
-    "comma-dangle": "off",
-    "@typescript-eslint/no-explicit-any": "off"
-  }
-}

package/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @sethyates

package/.github/CONTRIBUTING.md

@@ -1,177 +0,0 @@
-## Introduction
-
-### Welcome!
-
-First off, thank you for considering contributing.
-
-Following these guidelines helps to communicate that you respect the time of the developers
-managing and developing this open source project. In return, they should reciprocate that
-respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
-
-This library is an open source project and we love to receive contributions from our community — you!
-There are many ways to contribute, from writing tutorials or blog posts, improving the documentation,
-submitting bug reports and feature requests or writing code which can be incorporated into this
-library itself.
-
-### Using the issue tracker
-
-First things first: Do NOT report security vulnerabilities in public issues! Please disclose
-responsibly by letting the [Ketch team](mailto:security@ketch.com) know upfront.
-We will assess the issue as soon as possible on a best-effort basis and will give you an
-estimate for when we have a fix and release available for an eventual public disclosure.
-
-The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:
-* Please do not use the issue tracker for personal support requests.
-* Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
-
-## Ground Rules
-
-## Responsibilities
-* Ensure that code that goes into core meets all requirements in this checklist:
-  * General
-    - [ ] Is this change useful just to me, or something that I think will benefit others greatly?
-    - [ ] Check for overlap with other PRs
-    - [ ] Think carefully about the long-term implications of the change. How will it affect existing projects that are dependent on this?
-  * Quality
-    - [ ] Is it consistent with all other code?
-    - [ ] Have you documented it appropriately?
-    - [ ] Is it free of lint?
-    - [ ] Do all of the existing tests work? Have you added tests to cover your changes?
-    - [ ] Take the time to get things right. PRs almost always require additional improvements to meet the bar for quality. Be very strict about quality. This usually takes several commits on top of the original PR.
-* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
-* Keep feature versions as small as possible, preferably one new feature per version.
-* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
-
-## Your First Contribution
-
-Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:
-* Beginner issues - issues which should only require a few lines of code, and a test or two.
-* Help wanted issues - issues which should be a bit more involved than beginner issues.
-
-Both issue lists are sorted by total number of comments. While not perfect, number of
-comments is a reasonable proxy for impact a given change will have.
-
-Working on your first Pull Request? You can learn how from this *free* series,
-[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
-
-At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
-
-If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
-
-## Getting started
-
-### For something that is bigger than a one or two line fix:
-
-1. Create your own fork of the code
-2. Do the changes in your fork
-3. If you like the change and think the project could use it:
-    * Be sure you have followed the code style for the project.
-    * Sign the Contributor License Agreement (CLA).
-    * Note the  Code of Conduct.
-    * Send a pull request indicating that you have a CLA on file.
-
-### For a small or "obvious" fix:
-
-Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch, without a CLA.
-
-As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following:
-* Spelling / grammar fixes
-* Typo correction, white space and formatting changes
-* Comment clean up
-* Bug fixes that change default return values or error codes stored in constants
-* Adding logging messages or debugging output
-* Changes to ‘metadata’ files like go.mod, .gitignore, build scripts, etc.
-* Moving source files from one directory or package to another
-
-## How to report a bug
-
-If you find a security vulnerability, do NOT open an issue. Email [security@ketch.com](mailto:security@ketch.com) instead.
-
-In order to determine whether you are dealing with a security issue, ask yourself these two questions:
-* Can I access something that's not mine, or something I shouldn't have access to?
-* Can I disable something for other people?
-
-If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at [security@ketch.com](mailto:security@ketch.com).
-
- When filing an issue, make sure to answer these five questions:
-
-1. What version of Go are you using (go version)?
-2. What did you do?
-3. What did you expect to see?
-4. What did you see instead?
-
-## How to suggest a feature or enhancement
-
-If you find yourself wishing for a feature that doesn't exist in this library, you are
-probably not alone. There are bound to be others out there with similar needs.
-Many of the features that this library has today have been added because our users saw
-the need. Open an issue on our issues list on GitHub which describes the feature
-you would like to see, why you need it, and how it should work.
-
-The core team looks at Pull Requests on a regular basis in a weekly triage meeting.
-
-After feedback has been given we expect responses within two weeks. After two weeks
-we may close the pull request if it isn't showing any activity.
-
-## Commit message and labeling conventions
-
-We have very precise rules over how our git commit messages should be formatted. This leads to **more
-readable messages** that are easy to follow when looking through the **project history**.  Our tooling
-also relies on it to properly assign release numbers.
-
-Improperly formatted commit messages will result in your change not being merged.
-
-### Commit Message Format
-
-Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
-format that includes a **type**, a **scope** and a **subject**:
-
-```html
-<type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-> Any line of the commit message cannot be longer 100 characters!
-  This allows the message to be easier to read on GitHub as well as in various Git tools.
-
-##### Type
-Must be one of the following:
-
-* **feat**: A new feature
-* **fix**: A bug fix
-* **docs**: Documentation only changes
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
-  semi-colons, etc)
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **perf**: A code change that improves performance
-* **test**: Adding missing tests
-* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
-  generation
-
-##### Scope
-The scope could be anything that helps specifying the scope (or feature) that is changing.
-
-Examples
-- fix(token):
-- fix(vault):
-
-##### Subject
-The subject contains a succinct description of the change:
-
-* use the imperative, present tense: "change" not "changed" nor "changes"
-* don't capitalize first letter
-* no dot (.) at the end
-
-##### Body
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes"
-The body should include the motivation for the change and contrast this with previous behavior.
-
-##### Footer
-The footer should contain any information about **Breaking Changes** and is also the place to
-reference GitHub issues that this commit **Closes**, **Fixes**, or **Relates to**.
-
-> Breaking Changes are intended to be highlighted in the ChangeLog as changes that will require
-  community users to modify their code after updating to a version that contains this commit.

package/.github/ISSUE_TEMPLATE.md

@@ -1,19 +0,0 @@
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Detailed Description
-<!--- Provide a detailed description of the change or addition you are proposing -->
-
-## Context
-<!--- Why is this change important to you? How would you use it? -->
-<!--- How can it benefit other users? -->
-
-## Possible Implementation
-<!--- Not obligatory, but suggest an idea for implementing addition or change -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Environment name and version:
-* Server type and version:
-* Operating System and version:
-* Link to your project:

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,30 +0,0 @@
-<!--- Provide a general summary of your changes in the Title above -->
-<!--- Code generated by shipbuilder init 1.21.3. DO NOT EDIT. -->
-
-## Description of this change
-<!--- Describe your changes in detail -->
-<!--- Why is this change required? What problem does it solve? -->
-> Description here
-
-## Why is this change being made?
-- [ ] Chore (non-functional changes)
-- [ ] Bug fix (non-breaking change that fixes an issue)
-- [ ] New feature (non-breaking change that adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-
-## How was this tested? How can the reviewer verify your testing?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
-
-## Related issues
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
-<!--- Please link to the issue here: -->
-
-## Checklist
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
-- [ ] I have evaluated the security impact of this change, and [OWASP Secure Coding Practices](https://owasp.org/www-project-secure-coding-practices-quick-reference-guide/migrated_content#) have been observed.
-- [ ] I have informed stakeholders of my changes.

package/.github/dependabot.yml

@@ -1,18 +0,0 @@
-# Code generated by shipbuilder init 1.21.3. DO NOT EDIT.
-
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    commit-message:
-      prefix: "chore"
-      include: "scope"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    commit-message:
-      prefix: "chore"
-      include: "scope"

package/.github/release.yml

@@ -1,18 +0,0 @@
-changelog:
-  exclude:
-    labels:
-      - ignore-for-release
-    authors:
-      - dependabot
-  categories:
-    - title: Breaking Changes 🛠
-      labels:
-        - Semver-Major
-        - breaking-change
-    - title: Exciting New Features 🎉
-      labels:
-        - Semver-Minor
-        - enhancement
-    - title: Other Changes
-      labels:
-        - "*"

package/.github/workflows/ci.yml

@@ -1,79 +0,0 @@
-# Code generated by shipbuilder init 1.21.3. DO NOT EDIT.
-
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    outputs:
-      version: ${{ steps.version.outputs.version }}
-      version-major: ${{ steps.version.outputs.version-major-only }}
-      version-minor: ${{ format('{0}.{1}', steps.version.outputs.version-major-only, steps.version.outputs.version-minor-only) }}
-      version-patch: ${{ format('{0}.{1}.{2}', steps.version.outputs.version-major-only, steps.version.outputs.version-minor-only, steps.version.outputs.version-patch-only) }}
-    permissions:
-      contents: read
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Generate next version
-        id: version
-        uses: conventional-actions/next-version@v1
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          always-auth: true
-          registry-url: https://registry.npmjs.com/
-          scope: ketch-sdk
-          node-version: 16
-          cache: "npm"
-      - name: Setup Node version
-        uses: conventional-actions/write-version@v1
-        with:
-          output_path: package.json
-          version: ${{ format('{0}.{1}.{2}', steps.version.outputs.version-major-only, steps.version.outputs.version-minor-only, steps.version.outputs.version-patch-only) }}
-      - name: Install dependencies
-        run: npm ci
-      - name: Check format
-        run: npm run format-check
-      - name: Check lint
-        run: npm run lint
-      - name: Check test
-        run: npm run test
-      - name: Build
-        run: npm run build
-      - name: Publish
-        if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-  release:
-    name: Release
-    if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
-    needs:
-      - build
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Create Release
-        uses: conventional-actions/create-release@v1
-        with:
-          tag_name: ${{ needs.build.outputs.version }}
-          artifacts: "*"
-
-concurrency:
-  cancel-in-progress: true
-  group: ${{ github.workflow }}-${{ github.ref }}

package/.prettierignore

@@ -1,3 +0,0 @@
-.github/
-docs/
-dist/

package/.prettierrc

@@ -1,15 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all",
-  "printWidth": 120,
-  "semi": false,
-  "arrowParens": "avoid",
-  "overrides": [
-    {
-      "files": ["**/*.yml", "**/*.yaml"],
-      "options": {
-        "singleQuote": false
-      }
-    }
-  ]
-}

package/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -1,22 +0,0 @@
-:root {
-    --light-code-background: #FFFFFF;
-    --dark-code-background: #1E1E1E;
-}
-
-@media (prefers-color-scheme: light) { :root {
-    --code-background: var(--light-code-background);
-} }
-
-@media (prefers-color-scheme: dark) { :root {
-    --code-background: var(--dark-code-background);
-} }
-
-:root[data-theme='light'] {
-    --code-background: var(--light-code-background);
-}
-
-:root[data-theme='dark'] {
-    --code-background: var(--dark-code-background);
-}
-
-pre, code { background: var(--code-background); }