fix: add missing SiteConfig service override typings and definitions

eslint.config.js

@@ -13,6 +13,7 @@ module.exports = tseslint.config(
       'test-site/*',
       'config/*',
       'docs/*',
+      'test-types/*',
     ],
   },
 );

runtime/analytics/types.ts

@@ -0,0 +1,7 @@
+export interface AnalyticsService {
+  sendTrackingLogEvent(eventName: string, properties: object): Promise<void>,
+  identifyAuthenticatedUser(userId: string | number, traits?: Record<string, unknown>): void,
+  identifyAnonymousUser(traits?: Record<string, unknown>): void,
+  sendTrackEvent(eventName?: string, properties?: Record<string, unknown>): void,
+  sendPageEvent(category: string, name: string, properties?: Record<string, unknown>): void,
+}

runtime/auth/types.ts

@@ -0,0 +1,13 @@
+export interface AuthService {
+  getAuthenticatedHttpClient(options?: Record<string, unknown>): unknown,
+  getHttpClient(options?: Record<string, unknown>): unknown,
+  getLoginRedirectUrl(redirectUrl?: string): string,
+  redirectToLogin(redirectUrl?: string): void,
+  getLogoutRedirectUrl(redirectUrl?: string): string,
+  redirectToLogout(redirectUrl?: string): void,
+  getAuthenticatedUser(): Record<string, unknown> | null,
+  setAuthenticatedUser(authUser: Record<string, unknown>): void,
+  fetchAuthenticatedUser(options?: Record<string, unknown>): Promise<Record<string, unknown> | null>,
+  ensureAuthenticatedUser(redirectUrl?: string): Promise<Record<string, unknown>>,
+  hydrateAuthenticatedUser(): Promise<null>,
+}

test-types/site-config-service-overrides.typecheck.ts

@@ -0,0 +1,18 @@
+import { SiteConfig } from '../types';
+import NewRelicLoggingService from '../runtime/logging/NewRelicLoggingService';
+import SegmentAnalyticsService from '../runtime/analytics/SegmentAnalyticsService';
+import AxiosJwtAuthService from '../runtime/auth/AxiosJwtAuthService';
+
+const config: SiteConfig = {
+    loggingService: NewRelicLoggingService,
+    analyticsService: SegmentAnalyticsService,
+    authService: AxiosJwtAuthService,
+    siteId: '',
+    siteName: '',
+    baseUrl: '',
+    lmsBaseUrl: '',
+    loginUrl: '',
+    logoutUrl: '',
+}
+
+export default config;

types.ts

@@ -2,6 +2,9 @@ import { FC, ReactElement, ReactNode } from 'react';
 import { MessageDescriptor } from 'react-intl';
 import { RouteObject } from 'react-router';
 import { SlotOperation } from './runtime/slots/types';
+import { LoggingService } from './runtime/logging/types';
+import { AnalyticsService } from './runtime/analytics/types';
+import { AuthService } from './runtime/auth/types';
 
 // Apps
 
@@ -59,6 +62,35 @@ export interface RequiredSiteConfig {
 export type LocalizedMessages = Record<string, Record<string, string>>;
 export type SiteMessages = LocalizedMessages[];
 
+export type { LoggingService, AnalyticsService, AuthService };
+
+// Logging instantiated
+export type LoggingServiceClass = new (options: {
+  config: SiteConfig,
+}) => LoggingService;
+
+// Analytics instantiated
+export type AnalyticsServiceClass = new (options: {
+  config: SiteConfig,
+  loggingService: LoggingService,
+  httpClient: unknown,
+}) => AnalyticsService;
+
+// Auth instantiated
+export type AuthServiceClass = new (options: {
+  config: {
+    baseUrl: string,
+    lmsBaseUrl: string,
+    loginUrl: string,
+    logoutUrl: string,
+    refreshAccessTokenApiPath: string,
+    accessTokenCookieName: string,
+    csrfTokenApiPath: string,
+  },
+  loggingService: object,
+  middleware?: unknown[],
+}) => AuthService;
+
 export interface OptionalSiteConfig {
   // Site environment
   environment: EnvironmentTypes,
@@ -92,6 +124,11 @@ export interface OptionalSiteConfig {
 
   // Analytics
   segmentKey: string | null,
+
+  // Services
+  loggingService: LoggingServiceClass,
+  analyticsService: AnalyticsServiceClass,
+  authService: AuthServiceClass,
 }
 
 export type SiteConfig = RequiredSiteConfig & Partial<OptionalSiteConfig>;