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

package/package.json

@@ -2,24 +2,48 @@
   "author": "Transcend Inc.",
   "name": "@transcend-io/airgap.js-types",
   "description": "TypeScript types for airgap.js interoperability with custom consent UIs",
-  "version": "6.5.0",
+  "version": "6.8.2",
+  "homepage": "https://github.com/transcend-io/airgap.js-types",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/transcend-io/airgap.js-types.git"
+  },
   "license": "MIT",
-  "main": "src/index",
-  "type": "module",
+  "main": "build/index",
+  "files": [
+    "build/**/*",
+    "package.json"
+  ],
   "scripts": {
-    "build": "tsc --build",
-    "clean": "tsc --build --clean",
-    "lint": "eslint src --ext .ts",
-    "test": "echo \"Error: no test specified\" && exit 1 # TODO"
+    "update:sdks": "yarn set version from sources && yarn sdks base",
+    "update:deps": "yarn upgrade-interactive && yarn update:sdks",
+    "build": "yarn pnpify tsc --build",
+    "clean": "yarn pnpify tsc --build --clean",
+    "lint": "yarn pnpify eslint src --ext .ts",
+    "prepublish": "yarn build",
+    "test": "echo 'no tests'"
   },
   "dependencies": {
+    "@transcend-io/type-utils": "^1.0.4",
     "fp-ts": "^2.11.4",
     "io-ts": "^2.2.16",
-    "io-ts-types": "^0.5.14",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@types/node": "^14.14.31",
-    "typescript": "^4.3.5"
-  }
+    "@typescript-eslint/eslint-plugin": "^5.1.0",
+    "@typescript-eslint/parser": "^5.1.0",
+    "@yarnpkg/pnpify": "^3.1.0-rc.2",
+    "@yarnpkg/sdks": "^2.5.0-rc.2",
+    "depcheck": "^1.4.2",
+    "eslint": "^7.30.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-jsdoc": "^36.1.1",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4"
+  },
+  "packageManager": "yarn@3.1.1"
 }

package/.depcheckrc

@@ -1 +0,0 @@
-ignores: ["@transcend-io/airgap.js-types", "tslib"]

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,34 +0,0 @@
-## Related Issues
-
-- _[none]_
-
-## Public Changelog
-
-<!--- If you have changes in this section, please make sure https://docs.transcend.io is also up-to-date. -->
-<!-- Please adhere to the style guide here https://www.notion.so/transcend/Style-Guide-Change-Logs-70a661461ca64b2b9ffc7bcfc91856c9 -->
-
-_[none]_
-
-## Internal Changelog
-
-_[none]_
-
-## Security Implications
-
-_[none]_
-
-## System Availability
-
-_[none]_
-
-<!---
-
-## Eng Announcements
-
-- _[none]_
-
-## Release Manual Tests
-
-- _[none]_
-
--->

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-    "cSpell.words": [
-        "airgap",
-        "Optionalize"
-    ]
-}

package/src/core.ts

@@ -1,351 +0,0 @@
-// external
-import * as t from 'io-ts';
-
-// main
-import { valuesOf } from './type-utils';
-
-// local
-import { ConfigurablePurpose, PrivacyRegimeEnum, SpecialTrackingPurpose } from './enums';
-
-/* eslint-disable max-lines */
-
-/** Transcend logger items */
-export type LogItem = {
-  /** Log item content */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  content: any;
-  /** Log item styles */
-  styles: string[];
-};
-
-/** Transcend logger entry tag */
-export type LogTag = LogItem & {
-  /** Log tag content must be a string */
-  content: string;
-  /** Log tags must have only one style */
-  styles: string[1];
-};
-
-/** Transcend logger entry message */
-export type LogMessage = LogItem;
-
-/** Console-safe log levels */
-export const ConsoleSafeLogLevel = t.keyof({
-  info: null,
-  log: null,
-  warn: null,
-  debug: null,
-  error: null,
-  trace: null,
-  // meta-levels:
-  group: null,
-  groupCollapsed: null,
-  groupEnd: null,
-});
-
-/** Override type */
-export type ConsoleSafeLogLevel = t.TypeOf<typeof ConsoleSafeLogLevel>;
-
-/** Airgap log levels */
-export const LogLevel = t.union([ConsoleSafeLogLevel, t.literal('fatal')]);
-/** Override type */
-export type LogLevel = t.TypeOf<typeof LogLevel>;
-
-/** Airgap logger entry types */
-export type LogEntryType = LogLevel;
-
-/** Airgap logger entries */
-export type LogEntry = {
-  /** Log entry tag */
-  tag: LogTag;
-  /** Log entry message */
-  message: LogMessage;
-};
-
-/**
- * Log emitter function
- */
-export type LogEmitter = ((...entries: any[]) => void) & {
-  /** Styled log emitter function */
-  styled(styles?: null | string | string[], ...entries: any[]): void;
-};
-
-/** Transcend Logger API */
-export type Logger = {
-  /**
-   * Set log tag during callback execution or from
-   * this point on if no callback is provided.
-   */
-  tag(logTag: string, callback?: () => any): void;
-} & {
-  /** Log emitter (e.g. `logger.log()`) */
-  [method in LogLevel]: LogEmitter;
-};
-
-/** AirgapAuth auth options */
-export type AirgapAuthMap = {
-  /** A `load` event from a just-loaded airgap.js script element (which implies auth by being loaded before airgap.js) */
-  load?: Event;
-  /** A user-initiated interaction event that was just dispatched. */
-  interaction?: UIEvent;
-  /** Automatically reload the page if needed to remove CSP. `false` by default. */
-  autoReload?: boolean;
-};
-
-/** Airgap authorization proof */
-export type AirgapAuth =
-  | null
-  | AirgapAuthMap
-  /** A user-initiated interaction event that was just dispatched. */
-  | UIEvent
-  /** A `load` event from a just-loaded airgap.js script element (which implies auth by being loaded before airgap.js) */
-  | Event;
-
-/** A boolean value represented as either `'on'` or `'off'` */
-export const BooleanString = t.keyof({
-  on: null,
-  off: null,
-});
-/** Type override */
-export type BooleanString = t.TypeOf<typeof BooleanString>;
-
-/** Potentially applicable data privacy legal regimes */
-export const PrivacyRegime = valuesOf(PrivacyRegimeEnum);
-
-/** type overload */
-export type PrivacyRegime = t.TypeOf<typeof PrivacyRegime>;
-
-/** airgap.js API */
-export type AirgapAPI = Readonly<{
-  /** Airgap ready event subscriber */
-  ready(callback: (airgap: AirgapAPI) => void): void;
-  /** Enqueue cross-domain data sync across all airgap bundle domains */
-  sync(): Promise<void>;
-  /** Resolve airgap request overrides for a URL */
-  resolve(url: Stringifiable): string;
-  /** Get tracking consent */
-  getConsent(): TrackingConsentDetails;
-  /** Set tracking consent */
-  setConsent(
-    /** Airgap auth proof */
-    auth: AirgapAuth,
-    /** The tracking consent options. */
-    consent: TrackingConsent,
-  ): boolean;
-  /** Consents the user to all tracking purposes (requires recent UI interaction) */
-  optIn(
-    /** Airgap auth proof */
-    auth: AirgapAuth,
-  ): boolean;
-  /** Revokes consent for all tracking purposes (requires recent UI interaction) */
-  optOut(
-    /** Airgap auth proof */
-    auth: AirgapAuth,
-  ): boolean;
-  /** Returns true if the user is fully-opted in to all first-order tracking purposes */
-  isOptedIn(): boolean;
-  /** Returns true if the user is fully-opted out to all first-order tracking purposes */
-  isOptedOut(): boolean;
-  /** Get initialized tracking purposes config */
-  getPurposeTypes(): TrackingPurposesTypes;
-  /** Clear airgap queue & caches. Returns `true` on success. */
-  clear(auth: AirgapAuth): boolean;
-  /** Reset airgap queue and consent. Returns `true` on success. */
-  reset(
-    /** An airgap auth proof */
-    auth: AirgapAuth,
-    /** Automatically reload the page if needed to remove CSP. */
-    autoReload?: boolean,
-  ): boolean;
-  /** Get a list of legal regimes that are potentially applicable to the user */
-  getRegimes(): Promise<Set<PrivacyRegime>>;
-  /** Get a list of detected active user agent privacy signals */
-  getPrivacySignals(): Promise<Set<UserPrivacySignal>>;
-  /** airgap.js version number */
-  version: string;
-}> &
-  EventTarget;
-
-/**
- * airgap.js event type
- */
-export type AirgapEventType = 'consent-change' | 'purpose-map-load';
-
-/** 'consent-change' custom event details */
-export type ConsentChangeEventDetails = {
-  /** The old tracking consent */
-  oldConsent: TrackingConsentDetails;
-  /** The new tracking consent */
-  consent: TrackingConsentDetails;
-  /** The tracking consent diff (what's changed in the new consent) */
-  changes: ConsentChange | null;
-};
-
-/** Removable process (can remove watchers, overrides, and protections) */
-export type Removable = {
-  /** Remove/revoke process */
-  remove(): void;
-};
-
-/** Any value which implements `toString()` */
-export type Stringifiable =
-  | string
-  | (string & {
-      toString(): string;
-    });
-
-/** Special `defaultConsent` automatic opt-out value for any potential reason */
-export const AutoOptOut = t.literal('Auto');
-/** Type override */
-export type AutoOptOut = t.TypeOf<typeof AutoOptOut>;
-
-/** Special `defaultConsent` automatic opt-out value for GDPR-protected users */
-export const AutoOptOutForGDPR = t.literal('AutoGDPR');
-/** Type override */
-export type AutoOptOutForGDPR = t.TypeOf<typeof AutoOptOutForGDPR>;
-
-/**
- * Special `defaultConsent` automatic opt-out value for users with DNT enabled.
- * Note that DNT is enabled by default for some browsers.
- */
-export const AutoOptOutForDNT = t.literal('AutoDNT');
-/** Type override */
-export type AutoOptOutForDNT = t.TypeOf<typeof AutoOptOutForDNT>;
-
-/**
- * Special `defaultConsent` automatic opt-out value for users with GPC enabled.
- */
-export const AutoOptOutForGPC = t.literal('AutoGPC');
-/** Type override */
-export type AutoOptOutForGPC = t.TypeOf<typeof AutoOptOutForGPC>;
-
-/** Potential values for `defaultConsent` config token list */
-export const DefaultConsentConfigValue = t.union([
-  t.boolean,
-  AutoOptOut,
-  AutoOptOutForGDPR,
-  AutoOptOutForDNT,
-  AutoOptOutForGPC,
-  BooleanString,
-]);
-/** Type override */
-export type DefaultConsentConfigValue = t.TypeOf<
-  typeof DefaultConsentConfigValue
->;
-
-/** Tracking purpose metadata */
-export const TrackingPurposeDetails = t.intersection([
-  t.type({
-    /** Tracking purpose name */
-    name: t.string,
-    /** Tracking purpose description (used in Consent Manager UI) */
-    description: t.string,
-    /** Tracking purpose default consent (default: false) */
-    defaultConsent: DefaultConsentConfigValue,
-    /**
-     * Is this a first-order tracking purpose? If false, this is a
-     * second-order tracking purpose that should only be used for
-     * request overrides.
-     *
-     * This parameter previously meant:
-     *   Show tracking purpose in consent manager UI.
-     *
-     * Default value: true
-     */
-    showInConsentManager: t.boolean,
-    /** Allow user to configure their consent for this purpose (default: true) */
-    configurable: t.boolean,
-    /** Is tracking purpose "essential" - i.e. consent is mandatory / equivalent to 'essential' permission (default: false) */
-    essential: t.boolean,
-  }),
-  t.partial({
-    /** Tracking type */
-    trackingType: valuesOf(ConfigurablePurpose),
-  }),
-]);
-/** Type override */
-export type TrackingPurposeDetails = t.TypeOf<typeof TrackingPurposeDetails>;
-
-/** Tracking purposes types configuration */
-export const TrackingPurposesTypes = t.record(t.string, TrackingPurposeDetails);
-/** Type override */
-export type TrackingPurposesTypes = t.TypeOf<typeof TrackingPurposesTypes>;
-
-/** Fully-resolved `defaultConsent` config */
-export const DefaultConsentConfig = t.record(
-  t.string,
-  DefaultConsentConfigValue,
-);
-/** Type override */
-export type DefaultConsentConfig = t.TypeOf<typeof DefaultConsentConfig>;
-
-/** Tracking purposes configuration */
-export const TrackingPurposesConfig = t.intersection([
-  t.type({
-    /** Inherit default tracking purposes config */
-    useDefault: t.boolean,
-    types: TrackingPurposesTypes,
-  }),
-  t.partial({
-    defaultConsent: t.union([DefaultConsentConfigValue, DefaultConsentConfig]),
-  }),
-]);
-
-/** Type override */
-export type TrackingPurposesConfig = {
-  /** Inherit default tracking purposes config (Functional, Advertising, Analytics) */
-  useDefault: boolean;
-  /** Tracking purpose types */
-  types: TrackingPurposesTypes;
-  /** Default consent states (takes precedence over `TrackingPurposesTypes[purpose].defaultConsent`) */
-  defaultConsent?: DefaultConsentConfigValue | DefaultConsentConfig;
-};
-
-/** Tracking purpose consent config */
-export type TrackingConsent = {
-  /** Consent to tracking for essential purposes */
-  Essential?: true;
-  /** Unknown (unable to be directly consented) */
-  Unknown?: false;
-  /** Custom tracking purpose */
-  [purpose: string]: boolean | undefined;
-};
-
-/** Tracking purpose consent config with timestamp & auth metadata */
-export type TrackingConsentDetails = {
-  /** Tracking consent config */
-  purposes: TrackingConsent;
-  /** Consent last-modified timestamp (ISO 8601) */
-  timestamp: string;
-};
-
-/** Tracking purpose */
-export const TrackingPurpose = t.union([
-  t.keyof(SpecialTrackingPurpose),
-  t.string,
-]);
-
-/** Type override */
-export type TrackingPurpose = t.TypeOf<typeof TrackingPurpose>;
-
-/** Tracking purposes */
-export type TrackingPurposes = Set<TrackingPurpose>;
-
-/** User-configurable user agent privacy signal */
-export const UserPrivacySignal = t.union([
-  /** Global Privacy Control */
-  t.literal('GPC'),
-  /** Do Not Track */
-  t.literal('DNT'),
-]);
-
-/** type overload */
-export type UserPrivacySignal = t.TypeOf<typeof UserPrivacySignal>;
-
-/** Tracking consent change diffs */
-export const ConsentChange = t.record(TrackingPurpose, t.boolean);
-
-/** type overload */
-export type ConsentChange = t.TypeOf<typeof ConsentChange>;
-
-/* eslint-enable max-lines */

package/src/enums/privacyRegime.ts

@@ -1,15 +0,0 @@
-/** Potentially applicable data privacy legal regimes */
-export enum PrivacyRegimeEnum {
-  /** Unable to determine any applicable regimes */
-  Unknown = 'Unknown',
-  /** California Privacy Rights Act (and CCPA: California Consumer Privacy Act) */
-  CPRA = 'CPRA',
-  /** EU General Data Protection Regulation */
-  GDPR = 'GDPR',
-  /** Brazil Lei Geral de Proteção de Dados (General Personal Data Protection Law) */
-  LGPD = 'LGPD',
-  /** Virginia Consumer Data Protection Act */
-  CDPA = 'CDPA',
-  /** Colorado Privacy Act */
-  CPA = 'CPA',
-}

package/src/enums/purpose.ts

@@ -1,62 +0,0 @@
-// main
-import { makeEnum } from '../type-utils';
-
-/**
- * The options for the type of purpose that airgap classifies requests into
- */
-export const SpecialTrackingPurpose = makeEnum({
-  /** The request has an unknown tracking purpose */
-  Unknown: 'Unknown',
-  /** The request is necessary for the essential features of the website */
-  Essential: 'Essential',
-});
-
-/** Type override */
-export type SpecialTrackingPurpose =
-  typeof SpecialTrackingPurpose[keyof typeof SpecialTrackingPurpose];
-
-/**
- * Possible values for the default consent that can be given to a tracking purpose
- */
-export const DefaultConsentValue = makeEnum({
-  /** Tracking purpose is NOT consented to by default */
-  Off: 'off',
-  /**
-   * Tracking purpose is consented to by default, unless user is protected by GDPR
-   * or has DNT or GPC enabled
-   */
-  Auto: 'Auto',
-});
-
-/** Type override */
-export type DefaultConsentValue =
-  typeof DefaultConsentValue[keyof typeof DefaultConsentValue];
-
-/**
- * Purposes that can be configured
- */
-export const ConfigurablePurpose = makeEnum({
-  /** SaaS tools used for advertising purposes */
-  Advertising: 'Advertising',
-  /** SaaS tools used for analytics purposes */
-  Analytics: 'Analytics',
-  /** SaaS tools used for functional purposes */
-  Functional: 'Functional',
-  /** SaaS tools used for selling personal information */
-  SaleOfInfo: 'SaleOfInfo',
-});
-
-/** Type override */
-export type ConfigurablePurpose =
-  typeof ConfigurablePurpose[keyof typeof ConfigurablePurpose];
-
-/**
- * Purposes used by the purpose map
- */
-export const Purpose = makeEnum({
-  ...SpecialTrackingPurpose,
-  ...ConfigurablePurpose,
-});
-
-/** Type override */
-export type Purpose = typeof Purpose[keyof typeof Purpose];

package/src/enums/viewState.ts

@@ -1,67 +0,0 @@
-// main
-import { makeEnum } from '../type-utils';
-
-/**
- * Consent Manager view states that can be used at launch
- */
-export const InitialViewState = makeEnum({
-  /* expanded and showing quick select options */
-  QuickOptions: 'QuickOptions',
-  /* accept all or more options */
-  AcceptAll: 'AcceptAll',
-  /* data collection notice with do not sell */
-  NoticeAndDoNotSell: 'NoticeAndDoNotSell',
-  /* hidden */
-  Hidden: 'Hidden',
-});
-
-/**
- * Type override
- */
-export type InitialViewState =
-  typeof InitialViewState[keyof typeof InitialViewState];
-
-/**
- * Consent Manager view states that can be navigated to after initial view state
- */
-export const DeepViewState = makeEnum({
-  /* expanded and showing full checkbox options */
-  CompleteOptions: 'CompleteOptions',
-  /* language options */
-  LanguageOptions: 'LanguageOptions',
-});
-
-/**
- * Type override
- */
-export type DeepViewState = typeof DeepViewState[keyof typeof DeepViewState];
-
-/**
- * Consent Manager view states after it's been dismissed
- */
-export const DismissedViewState = makeEnum({
-  /* showing and collapsed */
-  Collapsed: 'Collapsed',
-  /* closed */
-  Closed: 'Closed',
-});
-
-/**
- * Type override
- */
-export type DismissedViewState =
-  typeof DismissedViewState[keyof typeof DismissedViewState];
-
-/**
- * All possible view states of the Consent Manager
- */
-export const ViewState = {
-  ...InitialViewState,
-  ...DeepViewState,
-  ...DismissedViewState,
-};
-
-/**
- * Type override
- */
-export type ViewState = InitialViewState | DeepViewState | DismissedViewState;

package/src/index.ts

@@ -1 +0,0 @@
-export * from './core';