voluptasmollitia/packages/firestore/compat/bundle.ts

Monorepo for the Firebase JavaScript SDK

/**
 * @license
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file 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 {
  loadBundle as expLoadBundle,
  namedQuery as expNamedQuery,
  LoadBundleTask
} from '../exp/index';
import { Firestore, Query } from '../src/api/database';

export function loadBundle(
  this: Firestore,
  data: ArrayBuffer | ReadableStream<Uint8Array> | string
): LoadBundleTask {
  return expLoadBundle(this._delegate, data);
}

export function namedQuery(
  this: Firestore,
  queryName: string
): Promise<Query | null> {
  return expNamedQuery(this._delegate, queryName).then(expQuery => {
    if (!expQuery) {
      return null;
    }
    return new Query(
      this,
      // We can pass `expQuery` here directly since named queries don't have a UserDataConverter.
      // Otherwise, we would have to create a new ExpQuery and pass the old UserDataConverter.
      expQuery
    );
  });
}

/**
 * Prototype patches bundle loading to Firestore.
 */
export function registerBundle(instance: typeof Firestore): void {
  instance.prototype.loadBundle = loadBundle;
  instance.prototype.namedQuery = namedQuery;
}