refactor: revise public/internal APIs

Author: rasendubi

package.json

@@ -16,6 +16,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
     }
   },
   "scripts": {

src/index.ts

@@ -1,147 +1,25 @@
-import ApiEndpoints from './api-endpoints';
-import { logger as applicationLogger, loggerPrefix } from './application-logger';
-import { IAssignmentHooks } from './assignment-hooks';
-import { IAssignmentLogger, IAssignmentEvent } from './assignment-logger';
-import { IBanditLogger, IBanditEvent } from './bandit-logger';
-import {
-  AbstractAssignmentCache,
-  AssignmentCache,
-  AsyncMap,
-  AssignmentCacheKey,
-  AssignmentCacheValue,
-  AssignmentCacheEntry,
-  assignmentCacheKeyToString,
-  assignmentCacheValueToString,
-} from './cache/abstract-assignment-cache';
-import { LRUInMemoryAssignmentCache } from './cache/lru-in-memory-assignment-cache';
-import { NonExpiringInMemoryAssignmentCache } from './cache/non-expiring-in-memory-cache-assignment';
-import EppoClient, {
+// Public APIs.
+//
+// The section below is intended for public usage and may be re-exported by SDKs.
+export { KVStore, MemoryStore } from './kvstore';
+export { IAssignmentHooks } from './assignment-hooks';
+export { IAssignmentLogger, IAssignmentEvent } from './assignment-logger';
+export { IBanditLogger, IBanditEvent } from './bandit-logger';
+export {
+  default as EppoClient,
   EppoClientParameters,
   IAssignmentDetails,
   IContainerExperiment,
 } from './client/eppo-client';
-import { Subject } from './client/subject';
-import FlagConfigRequestor from './configuration-requestor';
-import {
-  IConfigurationWire,
-  IObfuscatedPrecomputedConfigurationResponse,
-  IPrecomputedConfigurationResponse,
-} from './configuration-wire/configuration-wire-types';
-import * as constants from './constants';
-import { decodePrecomputedFlag } from './decoding';
-import { EppoAssignmentLogger } from './eppo-assignment-logger';
-import BatchEventProcessor from './events/batch-event-processor';
-import { BoundedEventQueue } from './events/bounded-event-queue';
-import DefaultEventDispatcher, {
-  DEFAULT_EVENT_DISPATCHER_CONFIG,
-  DEFAULT_EVENT_DISPATCHER_BATCH_SIZE,
-  newDefaultEventDispatcher,
-} from './events/default-event-dispatcher';
-import Event from './events/event';
-import EventDispatcher from './events/event-dispatcher';
-import NamedEventQueue from './events/named-event-queue';
-import NetworkStatusListener from './events/network-status-listener';
-import HttpClient from './http-client';
-import {
-  PrecomputedFlag,
-  Flag,
-  ObfuscatedFlag,
-  VariationType,
-  FormatEnum,
-  BanditParameters,
-  BanditVariation,
-  IObfuscatedPrecomputedBandit,
-  Variation,
-  Environment,
-} from './interfaces';
-import { KVStore, MemoryStore } from './kvstore';
-import { buildStorageKeySuffix } from './obfuscation';
-import {
+export { Subject } from './client/subject';
+export * as constants from './constants';
+export { EppoAssignmentLogger } from './eppo-assignment-logger';
+
+export {
   AttributeType,
   Attributes,
   BanditActions,
   BanditSubjectAttributes,
   ContextAttributes,
   FlagKey,
 } from './types';
-import * as validation from './validation';
-
-export {
-  loggerPrefix,
-  applicationLogger,
-  AbstractAssignmentCache,
-  IAssignmentDetails,
-  IAssignmentHooks,
-  IAssignmentLogger,
-  EppoAssignmentLogger,
-  IAssignmentEvent,
-  IBanditLogger,
-  IBanditEvent,
-  IContainerExperiment,
-  EppoClientParameters,
-  EppoClient,
-  constants,
-  ApiEndpoints,
-  FlagConfigRequestor,
-  HttpClient,
-  validation,
-
-  // Precomputed Client
-  IObfuscatedPrecomputedConfigurationResponse,
-  IObfuscatedPrecomputedBandit,
-
-  // Configuration store
-  KVStore,
-  MemoryStore,
-
-  // Assignment cache
-  AssignmentCacheKey,
-  AssignmentCacheValue,
-  AssignmentCacheEntry,
-  AssignmentCache,
-  AsyncMap,
-  NonExpiringInMemoryAssignmentCache,
-  LRUInMemoryAssignmentCache,
-  assignmentCacheKeyToString,
-  assignmentCacheValueToString,
-
-  // Interfaces
-  Flag,
-  ObfuscatedFlag,
-  Variation,
-  VariationType,
-  AttributeType,
-  Attributes,
-  ContextAttributes,
-  BanditSubjectAttributes,
-  BanditActions,
-  BanditVariation,
-  BanditParameters,
-  Environment,
-  FormatEnum,
-
-  // event dispatcher types
-  NamedEventQueue,
-  EventDispatcher,
-  BoundedEventQueue,
-  DEFAULT_EVENT_DISPATCHER_CONFIG,
-  DEFAULT_EVENT_DISPATCHER_BATCH_SIZE,
-  newDefaultEventDispatcher,
-  BatchEventProcessor,
-  NetworkStatusListener,
-  DefaultEventDispatcher,
-  Event,
-
-  // Configuration interchange.
-  IConfigurationWire,
-  IPrecomputedConfigurationResponse,
-  PrecomputedFlag,
-  FlagKey,
-
-  // Test helpers
-  decodePrecomputedFlag,
-
-  // Utilities
-  buildStorageKeySuffix,
-  Subject,
-};

src/internal.ts

@@ -0,0 +1,53 @@
+// Internal APIs.
+//
+// The section below is intended for internal usage in SDKs and is not part of the public API. It is
+// not subjected to semantic versioning and may change at any time.
+export { loggerPrefix, logger as applicationLogger } from './application-logger';
+export { default as ApiEndpoints } from './api-endpoints';
+export { default as ConfigurationRequestor } from './configuration-requestor';
+export { default as HttpClient } from './http-client';
+export { validateNotBlank } from './validation';
+export { LRUInMemoryAssignmentCache } from './cache/lru-in-memory-assignment-cache';
+export { buildStorageKeySuffix } from './obfuscation';
+export {
+  AbstractAssignmentCache,
+  AssignmentCache,
+  AsyncMap,
+  AssignmentCacheKey,
+  AssignmentCacheValue,
+  AssignmentCacheEntry,
+  assignmentCacheKeyToString,
+  assignmentCacheValueToString,
+} from './cache/abstract-assignment-cache';
+export { NonExpiringInMemoryAssignmentCache } from './cache/non-expiring-in-memory-cache-assignment';
+export {
+  IConfigurationWire,
+  IObfuscatedPrecomputedConfigurationResponse,
+  IPrecomputedConfigurationResponse,
+} from './configuration-wire/configuration-wire-types';
+export { decodePrecomputedFlag } from './decoding';
+export { default as BatchEventProcessor } from './events/batch-event-processor';
+export { BoundedEventQueue } from './events/bounded-event-queue';
+export {
+  default as DefaultEventDispatcher,
+  DEFAULT_EVENT_DISPATCHER_CONFIG,
+  DEFAULT_EVENT_DISPATCHER_BATCH_SIZE,
+  newDefaultEventDispatcher,
+} from './events/default-event-dispatcher';
+export { default as Event } from './events/event';
+export { default as EventDispatcher } from './events/event-dispatcher';
+export { default as NamedEventQueue } from './events/named-event-queue';
+export { default as NetworkStatusListener } from './events/network-status-listener';
+export {
+  PrecomputedFlag,
+  Flag,
+  ObfuscatedFlag,
+  VariationType,
+  FormatEnum,
+  BanditParameters,
+  BanditVariation,
+  IObfuscatedPrecomputedBandit,
+  Variation,
+  Environment,
+} from './interfaces';
+export { FlagKey } from './types';