refactor: move to types/ directory

russellwheatley · russellwheatley · commit e02db2c64c3d · 2025-12-10T17:05:53.000Z
diff --git a/packages/app/lib/common/index.ts b/packages/app/lib/common/index.ts
@@ -17,6 +17,7 @@
 import { Platform } from 'react-native';
 import Base64 from './Base64';
 import { isFunction, isObject, isString } from './validate';
+import type { DataUrlParts, Observer } from '../types/internal';
 
 export * from './id';
 export * from './path';
@@ -26,10 +27,7 @@ export * from './validate';
 export { default as Base64 } from './Base64';
 export { default as ReferenceBase } from './ReferenceBase';
 
-export interface DataUrlParts {
-  base64String: string | undefined;
-  mediaType: string | undefined;
-}
+export type { DataUrlParts, Observer };
 
 export function getDataUrlParts(dataUrlString: string): DataUrlParts {
   const isBase64 = dataUrlString.includes(';base64');
@@ -111,12 +109,6 @@ export function tryJSONStringify(data: any): string | null {
   }
 }
 
-export interface Observer<T> {
-  next: (value: T) => void;
-  error?: (error: Error) => void;
-  complete?: () => void;
-}
-
 export function parseListenerOrObserver<T>(
   listenerOrObserver: ((value: T) => void) | Observer<T>,
 ): (value: T) => void {
diff --git a/packages/app/lib/common/promise.ts b/packages/app/lib/common/promise.ts
@@ -16,12 +16,7 @@
  */
 
 import { isFunction } from './validate';
-
-export interface Deferred<T> {
-  promise: Promise<T>;
-  resolve: ((value: T) => void) | null;
-  reject: ((reason?: any) => void) | null;
-}
+import type { Deferred, Callback } from '../types/internal';
 
 /**
  * Creates a deferred promise
@@ -41,8 +36,6 @@ export function promiseDefer<T = void>(): Deferred<T> {
   return deferred;
 }
 
-type Callback<T> = ((error: Error | null, result?: T) => void) | ((error: Error | null) => void);
-
 /**
  * Attaches an optional callback to a promise
  * @param promise
diff --git a/packages/app/lib/common/serialize.ts b/packages/app/lib/common/serialize.ts
@@ -17,11 +17,7 @@
 
 import { tryJSONParse, tryJSONStringify } from './index';
 import { isObject } from './validate';
-
-export interface SerializedValue {
-  type: string;
-  value: any;
-}
+import type { SerializedValue } from '../types/internal';
 
 export function serializeType(value: any): SerializedValue {
   if (isObject(value)) {
diff --git a/packages/app/lib/internal/FirebaseModule.ts b/packages/app/lib/internal/FirebaseModule.ts
@@ -18,27 +18,12 @@
 import { getAppModule, getNativeModule } from './registry/nativeModule';
 import SharedEventEmitter from './SharedEventEmitter';
 import type { ReactNativeFirebase } from '../types/app';
+import type { FirebaseJsonConfig, ModuleConfig } from '../types/internal';
 import type { ReactNativeFirebaseNativeModules } from './NativeModules';
 import type EventEmitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
 
-/**
- * Firebase JSON configuration from firebase.json file
- * Structure: { "react-native": { [key: string]: boolean | string }, ... }
- */
-export type FirebaseJsonConfig = Record<string, unknown>;
-
 let firebaseJson: FirebaseJsonConfig | null = null;
 
-export interface ModuleConfig {
-  namespace: string;
-  nativeModuleName?: string | string[];
-  hasMultiAppSupport?: boolean;
-  hasCustomUrlOrRegionSupport?: boolean;
-  nativeEvents?: boolean | string[];
-  disablePrependCustomUrlOrRegion?: boolean;
-  turboModule?: boolean;
-}
-
 export default class FirebaseModule<
   NativeModuleName extends keyof ReactNativeFirebaseNativeModules = any,
 > {
diff --git a/packages/app/lib/internal/NativeFirebaseError.ts b/packages/app/lib/internal/NativeFirebaseError.ts
@@ -15,20 +15,7 @@
  *
  */
 
-export interface NativeErrorUserInfo {
-  code?: string;
-  message?: string;
-  nativeErrorCode?: string | number;
-  nativeErrorMessage?: string;
-  [key: string]: any;
-}
-
-export interface NativeError {
-  userInfo: NativeErrorUserInfo;
-  message?: string;
-  customData?: any;
-  operationType?: string;
-}
+import type { NativeErrorUserInfo, NativeError } from '../types/internal';
 
 export default class NativeFirebaseError extends Error {
   readonly namespace!: string;
diff --git a/packages/app/lib/internal/asyncStorage.ts b/packages/app/lib/internal/asyncStorage.ts
@@ -15,12 +15,7 @@
  *
  */
 
-// AsyncStorage interface compatible with React Native AsyncStorage
-export interface AsyncStorageStatic {
-  setItem: (key: string, value: string) => Promise<void>;
-  getItem: (key: string) => Promise<string | null>;
-  removeItem: (key: string) => Promise<void>;
-}
+import type { AsyncStorageStatic } from '../types/internal';
 
 // Memory storage Map instance
 export const memoryStorage = new Map<string, string>();
diff --git a/packages/app/lib/internal/logger.ts b/packages/app/lib/internal/logger.ts
@@ -15,20 +15,9 @@
  *
  */
 
-export type LogLevelString = 'debug' | 'verbose' | 'info' | 'warn' | 'error' | 'silent';
+import type { LogCallback, LogOptions } from '../types/app';
 
-export interface LogOptions {
-  level?: LogLevelString;
-}
-
-export type LogCallback = (callbackParams: LogCallbackParams) => void;
-
-export interface LogCallbackParams {
-  level: LogLevelString;
-  message: string;
-  args: unknown[];
-  type: string;
-}
+type LogLevelString = 'debug' | 'verbose' | 'info' | 'warn' | 'error' | 'silent';
 
 /**
  * The JS SDK supports 5 log levels and also allows a user the ability to
diff --git a/packages/app/lib/internal/registry/namespace.ts b/packages/app/lib/internal/registry/namespace.ts
@@ -20,7 +20,7 @@ import FirebaseApp from '../../FirebaseApp';
 import { version as SDK_VERSION } from '../../version';
 import { DEFAULT_APP_NAME, KNOWN_NAMESPACES, type KnownNamespace } from '../constants';
 import FirebaseModule from '../FirebaseModule';
-import type { ModuleGetter, FirebaseRoot, NamespaceConfig } from '../../types/app';
+import type { ModuleGetter, FirebaseRoot, NamespaceConfig } from '../../types/internal';
 import {
   getApp,
   getApps,
diff --git a/packages/app/lib/internal/registry/nativeModule.ts b/packages/app/lib/internal/registry/nativeModule.ts
@@ -15,7 +15,8 @@
  *
  */
 import { APP_NATIVE_MODULE } from '../constants';
-import NativeFirebaseError, { type NativeError } from '../NativeFirebaseError';
+import NativeFirebaseError from '../NativeFirebaseError';
+import type { NativeError } from '../../types/internal';
 import RNFBNativeEventEmitter from '../RNFBNativeEventEmitter';
 import SharedEventEmitter from '../SharedEventEmitter';
 import { getReactNativeModule } from '../nativeModule';
diff --git a/packages/app/lib/types/app.ts b/packages/app/lib/types/app.ts
@@ -626,62 +626,3 @@ export interface LogOptions {
 
 // Re-export FirebaseApp as a named type for easier importing
 export type FirebaseApp = ReactNativeFirebase.FirebaseApp;
-
-/**
- * Internal namespace types for Firebase module registry
- */
-
-/**
- * Type for a Firebase module getter function that can optionally accept
- * a custom URL/region/databaseId parameter
- */
-export type ModuleGetter = {
-  (customUrlOrRegionOrDatabaseId?: string): ReactNativeFirebase.FirebaseModule;
-  [key: string]: unknown;
-};
-
-/**
- * Type for Firebase root object with module getters
- */
-export interface FirebaseRoot {
-  initializeApp: (
-    options: ReactNativeFirebase.FirebaseAppOptions,
-    configOrName?: string | ReactNativeFirebase.FirebaseAppConfig,
-  ) => Promise<ReactNativeFirebase.FirebaseApp>;
-  setReactNativeAsyncStorage: (asyncStorage: ReactNativeFirebase.ReactNativeAsyncStorage) => void;
-  app: (name?: string) => ReactNativeFirebase.FirebaseApp;
-  apps: ReactNativeFirebase.FirebaseApp[];
-  SDK_VERSION: string;
-  setLogLevel: (logLevel: ReactNativeFirebase.LogLevelString) => void;
-  [key: string]: unknown;
-}
-
-/**
- * Configuration interface for module namespace registration
- */
-export interface ModuleConfig {
-  namespace: string;
-  nativeModuleName?: string | string[];
-  hasMultiAppSupport?: boolean;
-  hasCustomUrlOrRegionSupport?: boolean;
-  nativeEvents?: boolean | string[];
-  disablePrependCustomUrlOrRegion?: boolean;
-  turboModule?: boolean;
-}
-
-/**
- * Extended configuration for namespace registration including native module details
- */
-export interface NamespaceConfig extends ModuleConfig {
-  nativeModuleName: string | string[];
-  nativeEvents: boolean | string[];
-  // ModuleClass can be FirebaseModule or any subclass of it
-  // Uses FirebaseAppBase (the concrete class type) rather than FirebaseApp (the augmented interface)
-  ModuleClass: new (
-    app: ReactNativeFirebase.FirebaseAppBase,
-    config: ModuleConfig,
-    customUrlOrRegion?: string | null,
-  ) => ReactNativeFirebase.FirebaseModule;
-  statics?: object;
-  version?: string;
-}
diff --git a/packages/app/lib/types/internal.ts b/packages/app/lib/types/internal.ts
@@ -0,0 +1,141 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import type { ReactNativeFirebase } from './app';
+
+/**
+ * Internal types for React Native Firebase
+ * These types are used internally across multiple files and should not be exported to consumers
+ */
+
+/**
+ * Firebase JSON configuration from firebase.json file
+ * Structure: { "react-native": { [key: string]: boolean | string }, ... }
+ */
+export type FirebaseJsonConfig = Record<string, unknown>;
+
+/**
+ * Configuration for module namespace registration
+ */
+export interface ModuleConfig {
+  namespace: string;
+  nativeModuleName?: string | string[];
+  hasMultiAppSupport?: boolean;
+  hasCustomUrlOrRegionSupport?: boolean;
+  nativeEvents?: boolean | string[];
+  disablePrependCustomUrlOrRegion?: boolean;
+  turboModule?: boolean;
+}
+
+/**
+ * Extended configuration for namespace registration including native module details
+ */
+export interface NamespaceConfig extends ModuleConfig {
+  nativeModuleName: string | string[];
+  nativeEvents: boolean | string[];
+  // ModuleClass can be FirebaseModule or any subclass of it
+  // Uses FirebaseAppBase (the concrete class type) rather than FirebaseApp (the augmented interface)
+  ModuleClass: new (
+    app: ReactNativeFirebase.FirebaseAppBase,
+    config: ModuleConfig,
+    customUrlOrRegion?: string | null,
+  ) => ReactNativeFirebase.FirebaseModule;
+  statics?: object;
+  version?: string;
+}
+
+/**
+ * Type for a Firebase module getter function that can optionally accept
+ * a custom URL/region/databaseId parameter
+ */
+export type ModuleGetter = {
+  (customUrlOrRegionOrDatabaseId?: string): ReactNativeFirebase.FirebaseModule;
+  [key: string]: unknown;
+};
+
+/**
+ * Type for Firebase root object with module getters
+ */
+export interface FirebaseRoot {
+  initializeApp: (
+    options: ReactNativeFirebase.FirebaseAppOptions,
+    configOrName?: string | ReactNativeFirebase.FirebaseAppConfig,
+  ) => Promise<ReactNativeFirebase.FirebaseApp>;
+  setReactNativeAsyncStorage: (asyncStorage: ReactNativeFirebase.ReactNativeAsyncStorage) => void;
+  app: (name?: string) => ReactNativeFirebase.FirebaseApp;
+  apps: ReactNativeFirebase.FirebaseApp[];
+  SDK_VERSION: string;
+  setLogLevel: (logLevel: ReactNativeFirebase.LogLevelString) => void;
+  [key: string]: unknown;
+}
+
+/**
+ * Native error types
+ */
+export interface NativeErrorUserInfo {
+  code?: string;
+  message?: string;
+  nativeErrorCode?: string | number;
+  nativeErrorMessage?: string;
+  [key: string]: any;
+}
+
+export interface NativeError {
+  userInfo: NativeErrorUserInfo;
+  message?: string;
+  customData?: any;
+  operationType?: string;
+}
+
+/**
+ * AsyncStorage interface compatible with React Native AsyncStorage
+ * Internal version used by the library
+ */
+export interface AsyncStorageStatic {
+  setItem: (key: string, value: string) => Promise<void>;
+  getItem: (key: string) => Promise<string | null>;
+  removeItem: (key: string) => Promise<void>;
+}
+
+/**
+ * Common utility types
+ */
+export interface DataUrlParts {
+  base64String: string | undefined;
+  mediaType: string | undefined;
+}
+
+export interface Observer<T> {
+  next: (value: T) => void;
+  error?: (error: Error) => void;
+  complete?: () => void;
+}
+
+export interface SerializedValue {
+  type: string;
+  value: any;
+}
+
+export interface Deferred<T> {
+  promise: Promise<T>;
+  resolve: ((value: T) => void) | null;
+  reject: ((reason?: any) => void) | null;
+}
+
+export type Callback<T> =
+  | ((error: Error | null, result?: T) => void)
+  | ((error: Error | null) => void);
