CoreManager.ts

import type { AttributeMap, ObjectCache, OpsMap, State } from './ObjectStateMutations';
import type ParseFile from './ParseFile';
import type { FileSaveOptions, FileSource } from './ParseFile';
import type { Op } from './ParseOp';
import type ParseObject from './ParseObject';
import type { SaveOptions } from './ParseObject';
import type { QueryJSON } from './ParseQuery';
import type ParseUser from './ParseUser';
import type { AuthData } from './ParseUser';
import type { PushData } from './Push';
import type { RequestOptions, FullOptions } from './RESTController';
import type ParseSession from './ParseSession';
import type { HookDeclaration, HookDeleteArg } from './ParseHooks';
import type ParseConfig from './ParseConfig';
import type LiveQueryClient from './LiveQueryClient';
import type ParseInstallation from './ParseInstallation';

export interface AnalyticsController {
  track: (name: string, dimensions: Record<string, string>) => Promise<any>;
}
export interface CloudController {
  run: (name: string, data: any, options?: RequestOptions) => Promise<any>;
  getJobsData: (options?: RequestOptions) => Promise<any>;
  /** Returns promise which resolves with JobStatusId of the job */
  startJob: (name: string, data: any, options?: RequestOptions) => Promise<string>;
}
export interface ConfigController {
  current: () => Promise<ParseConfig> | ParseConfig;
  get: (opts?: RequestOptions) => Promise<ParseConfig>;
  save: (attrs: Record<string, any>, masterKeyOnlyFlags?: Record<string, any>) => Promise<void>;
}
export interface CryptoController {
  encrypt: (obj: any, secretKey: string) => string;
  decrypt: (encryptedText: string, secretKey: any) => string;
}
export interface FileController {
  saveFile: (name: string, source: FileSource, options?: FullOptions) => Promise<any>;
  saveBase64: (
    name: string,
    source: FileSource,
    options?: FileSaveOptions
  ) => Promise<{ name: string; url: string }>;
  download: (uri: string, options?: any) => Promise<{ base64?: string; contentType?: string }>;
  deleteFile: (name: string, options?: { useMasterKey?: boolean }) => Promise<void>;
}
export interface InstallationController {
  currentInstallationId: () => Promise<string>;
  currentInstallation: () => Promise<ParseInstallation | null>;
  updateInstallationOnDisk: (installation: ParseInstallation) => Promise<void>;
}
export interface ObjectController {
  fetch: (
    object: ParseObject | ParseObject[],
    forceFetch: boolean,
    options?: RequestOptions
  ) => Promise<(ParseObject | undefined)[] | ParseObject | undefined>;
  save: (
    object: ParseObject | (ParseObject | ParseFile)[] | null,
    options?: RequestOptions
  ) => Promise<ParseObject | ParseObject[] | ParseFile | undefined>;
  destroy: (
    object: ParseObject | ParseObject[],
    options?: RequestOptions
  ) => Promise<ParseObject | ParseObject[]>;
}
export interface ObjectStateController {
  getState: (obj: any) => State | null;
  initializeState: (obj: any, initial?: State) => State;
  removeState: (obj: any) => State | null;
  getServerData: (obj: any) => AttributeMap;
  setServerData: (obj: any, attributes: AttributeMap) => void;
  getPendingOps: (obj: any) => OpsMap[];
  setPendingOp: (obj: any, attr: string, op?: Op) => void;
  pushPendingState: (obj: any) => void;
  popPendingState: (obj: any) => OpsMap | undefined;
  mergeFirstPendingState: (obj: any) => void;
  getObjectCache: (obj: any) => ObjectCache;
  estimateAttribute: (obj: any, attr: string) => any;
  estimateAttributes: (obj: any) => AttributeMap;
  commitServerChanges: (obj: any, changes: AttributeMap) => void;
  enqueueTask: (obj: any, task: () => Promise<void>) => Promise<void>;
  clearAllState: () => void;
  duplicateState: (source: any, dest: any) => void;
}
export interface PushController {
  send: (data: PushData, options?: FullOptions) => Promise<any>;
}
export interface QueryController {
  find(
    className: string,
    params: QueryJSON,
    options?: RequestOptions
  ): Promise<{ results?: ParseObject[]; className?: string; count?: number }>;
  aggregate(className: string, params: any, options?: RequestOptions): Promise<{ results?: any[] }>;
}
export interface QueueObject {
  queueId: string;
  action: string;
  object: ParseObject;
  serverOptions: SaveOptions | RequestOptions;
  id: string;
  className: string;
  hash: string;
  createdAt: Date;
}
export type Queue = QueueObject[];
export interface EventuallyQueue {
  save: (object: ParseObject, serverOptions?: SaveOptions) => Promise<void>;
  destroy: (object: ParseObject, serverOptions?: RequestOptions) => Promise<void>;
  generateQueueId: (action: string, object: ParseObject) => string;
  enqueue(
    action: string,
    object: ParseObject,
    serverOptions?: SaveOptions | RequestOptions
  ): Promise<void>;
  store(data: Queue): Promise<void>;
  load(): Promise<string | null>;
  getQueue(): Promise<Queue>;
  setQueue(queue: Queue): Promise<void>;
  remove(queueId: string): Promise<void>;
  clear(): Promise<void>;
  queueItemExists(queue: Queue, queueId: string): number;
  length(): Promise<number>;
  sendQueue(): Promise<boolean>;
  sendQueueCallback(object: ParseObject, queueObject: QueueObject): Promise<void>;
  poll(ms?: number): void;
  stopPoll(): void;
  isPolling(): boolean;
  process: {
    create(ObjectType: any, queueObject: any): Promise<void>;
    byId(ObjectType: any, queueObject: any): Promise<void>;
    byHash(ObjectType: any, queueObject: any): Promise<void>;
  };
}
export interface RESTController {
  request: (method: string, path: string, data?: any, options?: RequestOptions) => Promise<any>;
  ajax: (
    method: string,
    url: string,
    data: any,
    headers?: any,
    options?: FullOptions
  ) => Promise<any>;
  handleError: (err?: any) => void;
}
export interface SchemaController {
  purge: (className: string) => Promise<any>;
  get: (className: string, options?: RequestOptions) => Promise<any>;
  delete: (className: string, options?: RequestOptions) => Promise<void>;
  create: (className: string, params: any, options?: RequestOptions) => Promise<any>;
  update: (className: string, params: any, options?: RequestOptions) => Promise<any>;
  send(className: string, method: string, params: any, options?: RequestOptions): Promise<any>;
}
export interface SessionController {
  getSession: (options?: RequestOptions) => Promise<ParseSession>;
}
type StorageController =
  | {
      async: 0;
      getItem: (path: string) => string | null;
      setItem: (path: string, value: string) => void;
      removeItem: (path: string) => void;
      getItemAsync?: (path: string) => Promise<string | null>;
      setItemAsync?: (path: string, value: string) => Promise<void>;
      removeItemAsync?: (path: string) => Promise<void>;
      clear: () => void;
      getAllKeys?: () => string[];
      getAllKeysAsync?: () => Promise<string[]>;
    }
  | {
      async: 1;
      getItem?: (path: string) => string | null;
      setItem?: (path: string, value: string) => void;
      removeItem?: (path: string) => void;
      getItemAsync: (path: string) => Promise<string | null>;
      setItemAsync: (path: string, value: string) => Promise<void>;
      removeItemAsync: (path: string) => Promise<void>;
      clear: () => void;
      getAllKeys?: () => string[];
      getAllKeysAsync?: () => Promise<string[]>;
    };
export interface LocalDatastoreController {
  fromPinWithName: (name: string) => any | undefined;
  pinWithName: (name: string, objects: any) => void;
  unPinWithName: (name: string) => void;
  getAllContents: () => any | undefined;
  clear: () => void;
  // Use for testing
  // getRawStorage(): Promise<Object>,
}
export interface UserController {
  setCurrentUser: (user: ParseUser) => Promise<void>;
  currentUser: () => ParseUser | null;
  currentUserAsync: () => Promise<ParseUser | null>;
  signUp: (user: ParseUser, attrs: AttributeMap, options?: RequestOptions) => Promise<ParseUser>;
  logIn: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
  loginAs: (user: ParseUser, userId: string) => Promise<ParseUser>;
  become: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
  hydrate: (user: ParseUser, userJSON: AttributeMap) => Promise<ParseUser>;
  logOut: (options?: RequestOptions & { clearSession?: boolean }) => Promise<void>;
  me: (user: ParseUser, options?: RequestOptions) => Promise<ParseUser>;
  requestPasswordReset: (email: string, options?: RequestOptions) => Promise<void>;
  updateUserOnDisk: (user: ParseUser) => Promise<ParseUser>;
  upgradeToRevocableSession: (user: ParseUser, options?: RequestOptions) => Promise<void>;
  linkWith: (user: ParseUser, authData: AuthData, options?: FullOptions) => Promise<ParseUser>;
  removeUserFromDisk: () => Promise<void>;
  verifyPassword: (
    username: string,
    password: string,
    options?: RequestOptions
  ) => Promise<ParseUser>;
  requestEmailVerification: (email: string, options?: RequestOptions) => Promise<void>;
}
export interface HooksController {
  get: (type: string, functionName?: string, triggerName?: string) => Promise<any>;
  create: (hook: HookDeclaration) => Promise<any>;
  remove: (hook: HookDeleteArg) => Promise<any>;
  update: (hook: HookDeclaration) => Promise<any>;
  // Renamed to sendRequest since ParseHooks file & tests file uses this. (originally declared as just "send")
  sendRequest?: (method: string, path: string, body?: any) => Promise<any>;
}
export interface LiveQueryControllerType {
  setDefaultLiveQueryClient(liveQueryClient: LiveQueryClient): void;
  getDefaultLiveQueryClient(): Promise<LiveQueryClient>;
  _clearCachedDefaultClient(): void;
}
/** Based on https://github.com/react-native-async-storage/async-storage/blob/main/packages/default-storage-backend/src/types.ts */
export interface AsyncStorageType {
  /** Fetches an item for a `key` and invokes a callback upon completion. */
  getItem: (
    key: string,
    callback?: (error?: Error | null, result?: string | null) => void
  ) => Promise<string | null>;
  /** Sets the value for a `key` and invokes a callback upon completion. */
  setItem: (key: string, value: string, callback?: (error?: Error | null) => void) => Promise<void>;
  /** Removes an item for a `key` and invokes a callback upon completion. */
  removeItem: (key: string, callback?: (error?: Error | null) => void) => Promise<void>;
  /** Merges an existing `key` value with an input value, assuming both values are stringified JSON. */
  mergeItem: (
    key: string,
    value: string,
    callback?: (error?: Error | null) => void
  ) => Promise<void>;
  /**
   * Erases *all* `AsyncStorage` for all clients, libraries, etc. You probably
   * don't want to call this; use `removeItem` or `multiRemove` to clear only
   * your app's keys.
   */
  clear: (callback?: (error?: Error | null) => void) => Promise<void>;
  /** Gets *all* keys known to your app; for all callers, libraries, etc. */
  getAllKeys: (
    callback?: (error?: Error | null, result?: readonly string[] | null) => void
  ) => Promise<readonly string[]>;
  /**
   * This allows you to batch the fetching of items given an array of `key`
   * inputs. Your callback will be invoked with an array of corresponding
   * key-value pairs found.
   */
  multiGet: (
    keys: readonly string[],
    callback?: (
      errors?: readonly (Error | null)[] | null,
      result?: readonly [string, string][]
    ) => void
  ) => Promise<readonly [string, string | null][]>;

  /**
   * Use this as a batch operation for storing multiple key-value pairs. When
   * the operation completes you'll get a single callback with any errors.
   *
   * See https://react-native-async-storage.github.io/async-storage/docs/api#multiset
   */
  multiSet: (
    keyValuePairs: [string, string][],
    callback?: (errors?: readonly (Error | null)[] | null) => void
  ) => Promise<readonly [string, string | null][]>;

  /**
   * Call this to batch the deletion of all keys in the `keys` array.
   *
   * See https://react-native-async-storage.github.io/async-storage/docs/api#multiremove
   */
  multiRemove: (
    keys: readonly string[],
    callback?: (errors?: readonly (Error | null)[] | null) => void
  ) => Promise<void>;

  /**
   * Batch operation to merge in existing and new values for a given set of
   * keys. This assumes that the values are stringified JSON.
   *
   * See https://react-native-async-storage.github.io/async-storage/docs/api#multimerge
   */
  multiMerge: (
    keyValuePairs: [string, string][],
    callback?: (errors?: readonly (Error | null)[] | null) => void
  ) => Promise<void>;
}
export interface WebSocketController {
  onopen: () => void;
  onmessage: (message: any) => void;
  onclose: (arg?: any) => void;
  onerror: (error: any) => void;
  send: (data: any) => void;
  close: () => void;
}
interface Config {
  AnalyticsController?: AnalyticsController;
  CloudController?: CloudController;
  ConfigController?: ConfigController;
  FileController?: FileController;
  InstallationController?: InstallationController;
  ObjectController?: ObjectController;
  ObjectStateController?: ObjectStateController;
  PushController?: PushController;
  QueryController?: QueryController;
  RESTController?: RESTController;
  SchemaController?: SchemaController;
  SessionController?: SessionController;
  StorageController?: StorageController;
  LocalDatastoreController?: LocalDatastoreController;
  UserController?: UserController;
  HooksController?: HooksController;
  WebSocketController?: new (
    url: string | URL,
    protocols?: string | string[] | undefined
  ) => WebSocketController;
  LiveQueryController?: LiveQueryControllerType;
  AsyncStorage?: AsyncStorageType;
}

const config: Config & Record<string, any> = {
  IS_NODE:
    typeof process !== 'undefined' &&
    !!process.versions &&
    !!process.versions.node &&
    !process.versions.electron,
  REQUEST_ATTEMPT_LIMIT: 5,
  REQUEST_BATCH_SIZE: 20,
  REQUEST_HEADERS: {},
  SERVER_URL: 'https://api.parse.com/1',
  SERVER_AUTH_TYPE: null,
  SERVER_AUTH_TOKEN: null,
  LIVEQUERY_SERVER_URL: null,
  ENCRYPTED_KEY: null,
  VERSION: 'js' + process.env.npm_package_version,
  APPLICATION_ID: null,
  JAVASCRIPT_KEY: null,
  MAINTENANCE_KEY: null,
  MASTER_KEY: null,
  USE_MASTER_KEY: false,
  PERFORM_USER_REWRITE: true,
  FORCE_REVOCABLE_SESSION: false,
  ENCRYPTED_USER: false,
  IDEMPOTENCY: false,
  ALLOW_CUSTOM_OBJECT_ID: false,
  PARSE_ERRORS: [],
  NODE_LOGGING: false,
};

function requireMethods(name: string, methods: string[], controller: any) {
  methods.forEach(func => {
    if (typeof controller[func] !== 'function') {
      throw new Error(`${name} must implement ${func}()`);
    }
  });
}

const CoreManager = {
  get: function (key: string): any {
    if (Object.hasOwn(config, key)) {
      return config[key];
    }
    throw new Error('Configuration key not found: ' + key);
  },

  set: function (key: string, value: any): void {
    config[key] = value;
  },

  setIfNeeded: function (key: string, value: any): any {
    if (!Object.hasOwn(config, key)) {
      config[key] = value;
    }
    return config[key];
  },

  /* Specialized Controller Setters/Getters */

  setAnalyticsController(controller: AnalyticsController) {
    requireMethods('AnalyticsController', ['track'], controller);
    config['AnalyticsController'] = controller;
  },

  getAnalyticsController(): AnalyticsController {
    return config['AnalyticsController']!;
  },

  setCloudController(controller: CloudController) {
    requireMethods('CloudController', ['run', 'getJobsData', 'startJob'], controller);
    config['CloudController'] = controller;
  },

  getCloudController(): CloudController {
    return config['CloudController']!;
  },

  setConfigController(controller: ConfigController) {
    requireMethods('ConfigController', ['current', 'get', 'save'], controller);
    config['ConfigController'] = controller;
  },

  getConfigController(): ConfigController {
    return config['ConfigController']!;
  },

  setCryptoController(controller: CryptoController) {
    requireMethods('CryptoController', ['encrypt', 'decrypt'], controller);
    config['CryptoController'] = controller;
  },

  getCryptoController(): CryptoController {
    return config['CryptoController'];
  },

  setEventEmitter(eventEmitter: any) {
    config['EventEmitter'] = eventEmitter;
  },

  getEventEmitter(): any {
    return config['EventEmitter'];
  },

  setFileController(controller: FileController) {
    requireMethods('FileController', ['saveFile', 'saveBase64'], controller);
    config['FileController'] = controller;
  },

  setEventuallyQueue(controller: EventuallyQueue) {
    requireMethods('EventuallyQueue', ['poll', 'save', 'destroy'], controller);
    config['EventuallyQueue'] = controller;
  },

  getEventuallyQueue(): EventuallyQueue {
    return config['EventuallyQueue']!;
  },

  getFileController(): FileController {
    return config['FileController']!;
  },

  setInstallationController(controller: InstallationController) {
    requireMethods(
      'InstallationController',
      ['currentInstallationId', 'currentInstallation', 'updateInstallationOnDisk'],
      controller
    );
    config['InstallationController'] = controller;
  },

  getInstallationController(): InstallationController {
    return config['InstallationController']!;
  },

  setLiveQuery(liveQuery: any) {
    config['LiveQuery'] = liveQuery;
  },

  getLiveQuery(): any {
    return config['LiveQuery'];
  },

  setObjectController(controller: ObjectController) {
    requireMethods('ObjectController', ['save', 'fetch', 'destroy'], controller);
    config['ObjectController'] = controller;
  },

  getObjectController(): ObjectController {
    return config['ObjectController']!;
  },

  setObjectStateController(controller: ObjectStateController) {
    requireMethods(
      'ObjectStateController',
      [
        'getState',
        'initializeState',
        'removeState',
        'getServerData',
        'setServerData',
        'getPendingOps',
        'setPendingOp',
        'pushPendingState',
        'popPendingState',
        'mergeFirstPendingState',
        'getObjectCache',
        'estimateAttribute',
        'estimateAttributes',
        'commitServerChanges',
        'enqueueTask',
        'clearAllState',
      ],
      controller
    );

    config['ObjectStateController'] = controller;
  },

  getObjectStateController(): ObjectStateController {
    return config['ObjectStateController']!;
  },

  setPushController(controller: PushController) {
    requireMethods('PushController', ['send'], controller);
    config['PushController'] = controller;
  },

  getPushController(): PushController {
    return config['PushController']!;
  },

  setQueryController(controller: QueryController) {
    requireMethods('QueryController', ['find', 'aggregate'], controller);
    config['QueryController'] = controller;
  },

  getQueryController(): QueryController {
    return config['QueryController']!;
  },

  setRESTController(controller: RESTController) {
    requireMethods('RESTController', ['request', 'ajax'], controller);
    config['RESTController'] = controller;
  },

  getRESTController(): RESTController {
    return config['RESTController']!;
  },

  setSchemaController(controller: SchemaController) {
    requireMethods(
      'SchemaController',
      ['get', 'create', 'update', 'delete', 'send', 'purge'],
      controller
    );
    config['SchemaController'] = controller;
  },

  getSchemaController(): SchemaController {
    return config['SchemaController']!;
  },

  setSessionController(controller: SessionController) {
    requireMethods('SessionController', ['getSession'], controller);
    config['SessionController'] = controller;
  },

  getSessionController(): SessionController {
    return config['SessionController']!;
  },

  setStorageController(controller: StorageController) {
    if (controller.async) {
      requireMethods(
        'An async StorageController',
        ['getItemAsync', 'setItemAsync', 'removeItemAsync', 'getAllKeysAsync'],
        controller
      );
    } else {
      requireMethods(
        'A synchronous StorageController',
        ['getItem', 'setItem', 'removeItem', 'getAllKeys'],
        controller
      );
    }
    config['StorageController'] = controller;
  },

  setLocalDatastoreController(controller: LocalDatastoreController) {
    requireMethods(
      'LocalDatastoreController',
      ['pinWithName', 'fromPinWithName', 'unPinWithName', 'getAllContents', 'clear'],
      controller
    );
    config['LocalDatastoreController'] = controller;
  },

  getLocalDatastoreController(): LocalDatastoreController {
    return config['LocalDatastoreController']!;
  },

  setLocalDatastore(store: any) {
    config['LocalDatastore'] = store;
  },

  getLocalDatastore() {
    return config['LocalDatastore'];
  },

  getStorageController(): StorageController {
    return config['StorageController']!;
  },

  setAsyncStorage(storage: AsyncStorageType) {
    config['AsyncStorage'] = storage;
  },

  getAsyncStorage() {
    return config['AsyncStorage'];
  },

  setWebSocketController(
    controller: new (
      url: string | URL,
      protocols?: string | string[] | undefined
    ) => WebSocketController
  ) {
    config['WebSocketController'] = controller;
  },

  getWebSocketController(): new (
    url: string | URL,
    protocols?: string | string[] | undefined
  ) => WebSocketController {
    return config['WebSocketController']!;
  },

  setUserController(controller: UserController) {
    requireMethods(
      'UserController',
      [
        'setCurrentUser',
        'currentUser',
        'currentUserAsync',
        'signUp',
        'logIn',
        'become',
        'logOut',
        'me',
        'requestPasswordReset',
        'upgradeToRevocableSession',
        'requestEmailVerification',
        'verifyPassword',
        'linkWith',
      ],
      controller
    );
    config['UserController'] = controller;
  },

  getUserController(): UserController {
    return config['UserController']!;
  },

  setLiveQueryController(controller: LiveQueryControllerType) {
    requireMethods(
      'LiveQueryController',
      ['setDefaultLiveQueryClient', 'getDefaultLiveQueryClient', '_clearCachedDefaultClient'],
      controller
    );
    config['LiveQueryController'] = controller;
  },

  getLiveQueryController(): LiveQueryControllerType {
    return config['LiveQueryController']!;
  },

  setHooksController(controller: HooksController) {
    requireMethods('HooksController', ['create', 'get', 'update', 'remove'], controller);
    config['HooksController'] = controller;
  },

  getHooksController(): HooksController {
    return config['HooksController']!;
  },

  setParseOp(op: any) {
    config['ParseOp'] = op;
  },

  getParseOp() {
    return config['ParseOp']!;
  },

  setParseObject(object: any) {
    config['ParseObject'] = object;
  },

  getParseObject() {
    return config['ParseObject']!;
  },

  setParseQuery(query: any) {
    config['ParseQuery'] = query;
  },

  getParseQuery() {
    return config['ParseQuery']!;
  },

  setParseRole(role: any) {
    config['ParseRole'] = role;
  },

  getParseRole() {
    return config['ParseRole']!;
  },

  setParseUser(user: any) {
    config['ParseUser'] = user;
  },

  getParseUser() {
    return config['ParseUser']!;
  },
};

export default CoreManager;