@transcend-io/airgap.js-types 6.5.0 → 6.8.2

package/src/type-utils.ts

@@ -1,110 +0,0 @@
-// external
-import * as t from 'io-ts';
-
-/**
- * To make the inspected type more tractable than a bunch of intersections
- */
- export type Identity<T> = {
-    [K in keyof T]: T[K];
-  };
-
-/**
- * Make selected object keys defined by K optional in type T
- */
- export type Optionalize<T, K extends keyof T> = Identity<
- Omit<T, K> & Partial<T>
->;
-
-/**
- * An arbitrary object keyed by strings for naming consistency
- */
- export type ObjByString = { [key in string]: any }; // eslint-disable-line @typescript-eslint/no-explicit-any
-
-/**
- * Object.entries that actually preserves entries as types.
- *
- * @param o - The object to get the entries from
- * @returns The entries of the object preserving type
- */
- export default function getEntries<
- TKey extends keyof TObj,
- TObj extends ObjByString,
->(o: TObj): [TKey, TObj[TKey]][] {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- return Object.entries(o) as any;
-}
-
-
-/**
- * Invert an object so that the values look up the keys.
- * If the object has an array as the value, each item in the array will be inverted.
- *
- * @param obj - The object to invert
- * @param throwOnDuplicate - When true, throw error if duplicate key detected
- * @returns The inverted object
- */
- export function invert<TKey extends string, TValue extends string | string[]>(
-  obj: { [key in TKey]?: TValue },
-  throwOnDuplicate = true,
-): {
-  [key in TValue extends (infer TK)[] ? TK : TValue]: TValue extends any[]
-    ? TKey[]
-    : TKey;
-} {
-  const result: any = {} as any;
-
-  // Invert
-  getEntries(obj).forEach(([key, instance]: [TKey, TValue | undefined]) => {
-    // Ensure no undefined values
-    if (instance === undefined) {
-      throw new Error('inverse found undefined value, this is not supported');
-    }
-
-    // Handle array case
-    if (Array.isArray(instance)) {
-      instance.forEach((listKey) => {
-        // Create a new entry
-        if (!result[listKey]) {
-          result[listKey] = [key];
-        } else {
-          // Add to existing
-          result[listKey].push(key);
-        }
-      });
-    } else {
-      // Ensure we do not overwrite duplicates
-      if (result[instance] && throwOnDuplicate) {
-        throw new Error(
-          `Encountered duplicate value inverting object: "${instance}: ${key} and ${result[instance]}"`,
-        );
-      }
-      result[instance] = key;
-    }
-  });
-  return result;
-}
-
-/**
- * We care about the values of an enum. This does not come out of the box with io-ts so we have to invert the enum first.
- *
- * @param enm - The enum to invert
- * @returns The io-ts keyof
- */
- export function valuesOf<TEnum extends string>(
-  enm: { [k in string]: TEnum },
-): t.KeyofC<{ [k in TEnum]: unknown }> {
-  return t.keyof(invert(enm) as any);
-}
-
-/**
- * Make an enum compatible with types -- in separate file because Logger/enums and Enum/index circular dependency
- *
- * @param x - The enum
- * @returns The object proxy with error logger when a value is accessed outside of enum
- */
- export function makeEnum<
- T extends { [index: string]: U | U[] },
- U extends string,
->(x: T): T {
- return x;
-}

package/src/ui.ts

@@ -1,92 +0,0 @@
-// external
-import * as t from 'io-ts';
-
-// main
-import { valuesOf } from './type-utils';
-
-// local
-import {
-  DismissedViewState,
-  InitialViewState,
-  PrivacyRegimeEnum,
-} from './enums';
-
-/** Transcend Smart Quarantine API (window.transcend) */
-export type PreInitTranscendAPI = {
-  /** Ready event subscriber */
-  ready(callback: (transcend: TranscendAPI) => void): void;
-};
-
-/**
- * Transcend Consent Manager external methods
- */
-export type ConsentManagerAPI = {
-  /** Show consent manager unless recently dismissed */
-  autoShowConsentManager(): Promise<void>;
-  /** Show consent manager */
-  showConsentManager(): Promise<void>;
-  /** Hide consent manager */
-  hideConsentManager(): Promise<void>;
-  /** Toggle consent manager */
-  toggleConsentManager(): Promise<void>;
-};
-
-/** Transcend Smart Quarantine API (window.transcend) */
-export type TranscendAPI = PreInitTranscendAPI & ConsentManagerAPI;
-
-/**
- * Customer theming
- */
-const Theme = t.type({
-  /** Primary color */
-  primaryColor: t.string,
-  /** Font color */
-  fontColor: t.string,
-});
-
-/**
- * Mobile-first responsive breakpoints
- * No media query for mobile, which is the default
- */
-const Breakpoints = t.type({
-  /** In px, at or above this width is tablet */
-  tablet: t.string,
-  /** In px, at or above this width is desktop */
-  desktop: t.string,
-});
-
-/** Consent manager UI configuration */
-export const ConsentManagerConfig = t.type({
-  /** Customer theming */
-  theme: Theme,
-  /** A set of responsive breakpoints */
-  breakpoints: Breakpoints,
-  /** The privacy policy URL to redirect to */
-  privacyPolicy: t.string,
-  /** What state the consent manager should launch in */
-  initialViewStateByPrivacyRegime: t.record(
-    valuesOf(PrivacyRegimeEnum),
-    valuesOf(InitialViewState),
-  ),
-  /** What state the consent manager should go to when dismissed */
-  dismissedViewState: valuesOf(DismissedViewState),
-});
-
-/** Type override */
-export type ConsentManagerConfig = t.TypeOf<typeof ConsentManagerConfig>;
-
-/** Input for Consent manager UI configuration */
-export const ConsentManagerConfigInput = t.partial(ConsentManagerConfig.props);
-
-/** Type override */
-export type ConsentManagerConfigInput = t.TypeOf<
-  typeof ConsentManagerConfigInput
->;
-
-/**
- * Properties exposed on `self` by the Transcend Smart Quarantine
- */
-export type TranscendView = Window & {
-  /** Transcend Smart Quarantine API */
-  transcend: TranscendAPI;
-};

package/tsconfig.json

@@ -1,40 +0,0 @@
-{
-  "compilerOptions": {
-    /* Basic Options */
-    "incremental": true,
-    "target": "es2020",
-    "module": "commonjs",
-    "lib": ["esnext", "dom"],
-    "allowJs": false,
-    "checkJs": false, // speeds up tsc
-    "jsx": "react",
-    "declaration": true,
-    "composite": true,
-    "declarationMap": true,
-    "sourceMap": true,
-
-    /* Strict Type-Checking Options */
-    "strict": true,
-
-    /* Additional Checks */
-    "noUnusedLocals": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-
-    /* Module Resolution Options */
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "typeRoots": ["@types", "node_modules/@types"],
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "forceConsistentCasingInFileNames": true,
-    
-    "outDir": "./build/airgap.js-types",
-    "rootDir": "src",
-    "tsBuildInfoFile": "../../build/airgap.js-types.tsbuildinfo",
-    "types": []
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "build"],
-  "references": []
-}