chore: reduce size of partial types (#484)

Author: williazz

src/orchestration/Orchestration.ts

@@ -52,57 +52,6 @@ export type Telemetry = string | (string | object)[];
 
 export type PageIdFormat = 'PATH' | 'HASH' | 'PATH_AND_HASH';
 
-export type PartialCookieAttributes = {
-    unique?: boolean;
-    domain?: string;
-    path?: string;
-    sameSite?: string;
-    secure?: boolean;
-};
-
-export type PartialConfig = {
-    allowCookies?: boolean;
-    batchLimit?: number;
-    client?: string;
-    clientBuilder?: ClientBuilder;
-    cookieAttributes?: PartialCookieAttributes;
-    disableAutoPageView?: boolean;
-    dispatchInterval?: number;
-    enableRumClient?: boolean;
-    enableXRay?: boolean;
-    endpoint?: string;
-    eventCacheSize?: number;
-    eventPluginsToLoad?: Plugin[];
-    guestRoleArn?: string;
-    identityPoolId?: string;
-    pageIdFormat?: PageIdFormat;
-    pagesToExclude?: RegExp[];
-    pagesToInclude?: RegExp[];
-    signing?: boolean;
-    recordResourceUrl?: boolean;
-    routeChangeComplete?: number;
-    routeChangeTimeout?: number;
-    sessionAttributes?: { [k: string]: string | number | boolean };
-    sessionEventLimit?: number;
-    sessionLengthSeconds?: number;
-    sessionSampleRate?: number;
-    /**
-     * Application owners think about data collection in terms of the categories
-     * of data being collected. For example, JavaScript errors, page load
-     * performance, user journeys and user interactions are data collection
-     * categories. However, there is not a 1-1 mapping between data collection
-     * categories and plugins.
-     *
-     * This configuration option allows application owners to define the data
-     * categories they want to collect without needing to understand and
-     * instantiate each plugin themselves. The toolkit will instantiate the
-     * plugins which map to the selected categories.
-     */
-    telemetries?: Telemetry[];
-    useBeacon?: boolean;
-    userIdRetentionDays?: number;
-};
-
 export const defaultCookieAttributes = (): CookieAttributes => {
     return {
         unique: false,
@@ -153,7 +102,9 @@ export type CookieAttributes = {
     secure: boolean;
 };
 
-export type Config = {
+export type PartialCookieAttributes = Partial<CookieAttributes>;
+
+export interface Config {
     allowCookies: boolean;
     batchLimit: number;
     client: string;
@@ -190,10 +141,27 @@ export type Config = {
     sessionEventLimit: number;
     sessionLengthSeconds: number;
     sessionSampleRate: number;
+    /**
+     * Application owners think about data collection in terms of the categories
+     * of data being collected. For example, JavaScript errors, page load
+     * performance, user journeys and user interactions are data collection
+     * categories. However, there is not a 1-1 mapping between data collection
+     * categories and plugins.
+     *
+     * This configuration option allows application owners to define the data
+     * categories they want to collect without needing to understand and
+     * instantiate each plugin themselves. The toolkit will instantiate the
+     * plugins which map to the selected categories.
+     */
     telemetries: Telemetry[];
     useBeacon: boolean;
     userIdRetentionDays: number;
-};
+}
+
+export interface PartialConfig
+    extends Omit<Partial<Config>, 'cookieAttributes'> {
+    cookieAttributes?: PartialCookieAttributes;
+}
 
 /**
  * An orchestrator which (1) initializes cwr components and (2) provides the API for the application to interact

src/plugins/event-plugins/DomEventPlugin.ts

@@ -26,12 +26,6 @@ export type TargetDomEvent = {
     element?: HTMLElement;
 };
 
-export type PartialDomEventPluginConfig = {
-    interactionId?: (event: Event) => string;
-    enableMutationObserver?: boolean;
-    events?: TargetDomEvent[];
-};
-
 export type DomEventPluginConfig = {
     interactionId: (event: Event) => string;
     enableMutationObserver?: boolean;
@@ -62,7 +56,7 @@ export class DomEventPlugin<
     private config: DomEventPluginConfig;
     private observer: MutationObserver | undefined;
 
-    constructor(config?: PartialDomEventPluginConfig) {
+    constructor(config?: Partial<DomEventPluginConfig>) {
         super(DOM_EVENT_PLUGIN_ID);
         this.eventListenerMap = new Map<
             TargetDomEvent,

src/plugins/event-plugins/FetchPlugin.ts

@@ -5,7 +5,6 @@ import {
 } from '../../events/xray-trace-event';
 import { MonkeyPatched } from '../MonkeyPatched';
 import {
-    PartialHttpPluginConfig,
     defaultConfig,
     epochTime,
     createXRayTraceEvent,
@@ -55,7 +54,7 @@ export const FETCH_PLUGIN_ID = 'fetch';
 export class FetchPlugin extends MonkeyPatched<Window, 'fetch'> {
     private readonly config: HttpPluginConfig;
 
-    constructor(config?: PartialHttpPluginConfig) {
+    constructor(config?: Partial<HttpPluginConfig>) {
         super(FETCH_PLUGIN_ID);
         this.config = { ...defaultConfig, ...config };
     }

src/plugins/event-plugins/NavigationPlugin.ts

@@ -2,7 +2,6 @@ import { InternalPlugin } from '../InternalPlugin';
 import { NavigationEvent } from '../../events/navigation-event';
 import { PERFORMANCE_NAVIGATION_EVENT_TYPE } from '../utils/constant';
 import {
-    PartialPerformancePluginConfig,
     PerformancePluginConfig,
     defaultPerformancePluginConfig
 } from '../utils/performance-utils';
@@ -19,7 +18,7 @@ const LOAD = 'load';
  */
 export class NavigationPlugin extends InternalPlugin {
     private config: PerformancePluginConfig;
-    constructor(config?: PartialPerformancePluginConfig) {
+    constructor(config?: Partial<PerformancePluginConfig>) {
         super(NAVIGATION_EVENT_PLUGIN_ID);
         this.config = { ...defaultPerformancePluginConfig, ...config };
     }

src/plugins/event-plugins/ResourcePlugin.ts

@@ -4,7 +4,6 @@ import { ResourceEvent } from '../../events/resource-event';
 import { PERFORMANCE_RESOURCE_EVENT_TYPE } from '../utils/constant';
 import {
     defaultPerformancePluginConfig,
-    PartialPerformancePluginConfig,
     PerformancePluginConfig
 } from '../utils/performance-utils';
 
@@ -20,7 +19,7 @@ export class ResourcePlugin extends InternalPlugin {
     private resourceObserver: PerformanceObserver;
     private eventCount: number;
 
-    constructor(config?: PartialPerformancePluginConfig) {
+    constructor(config?: Partial<PerformancePluginConfig>) {
         super(RESOURCE_EVENT_PLUGIN_ID);
         this.config = { ...defaultPerformancePluginConfig, ...config };
         this.eventCount = 0;

src/plugins/event-plugins/XhrPlugin.ts

@@ -2,7 +2,6 @@ import { XRayTraceEvent } from '../../events/xray-trace-event';
 import { HttpEvent } from '../../events/http-event';
 import { MonkeyPatch, MonkeyPatched } from '../MonkeyPatched';
 import {
-    PartialHttpPluginConfig,
     defaultConfig,
     epochTime,
     createXRayTraceEvent,
@@ -99,7 +98,7 @@ export class XhrPlugin extends MonkeyPatched<XMLHttpRequest, 'send' | 'open'> {
     private xhrMap: Map<XMLHttpRequest, XhrDetails>;
     private isSyntheticsUA: boolean;
 
-    constructor(config?: PartialHttpPluginConfig) {
+    constructor(config?: Partial<HttpPluginConfig>) {
         super(XHR_PLUGIN_ID);
         this.config = { ...defaultConfig, ...config };
         this.xhrMap = new Map<XMLHttpRequest, XhrDetails>();

src/plugins/event-plugins/__tests__/FetchPlugin.integ.test.ts

@@ -1,6 +1,6 @@
 import { Orchestration } from '../../../orchestration/Orchestration';
 import { createAwsCredentials } from '../../../test-utils/test-utils';
-import { PartialHttpPluginConfig } from '../../utils/http-utils';
+import { HttpPluginConfig } from '../../utils/http-utils';
 import { FetchPlugin } from '../FetchPlugin';
 
 const mockFetch = jest.fn(
@@ -27,7 +27,7 @@ describe('FetchPlugin integ tests', () => {
 
     test('dispatch requests are not recorded by the http plugin', async () => {
         // Init
-        const config: PartialHttpPluginConfig = {
+        const config: Partial<HttpPluginConfig> = {
             recordAllRequests: true
         };