@serwist/background-sync 9.0.0-preview.17 → 9.0.0-preview.18

package/src/QueueStore.ts

@@ -1,161 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-import { assert } from "@serwist/core/internal";
-
-import type { QueueStoreEntry, UnidentifiedQueueStoreEntry } from "./QueueDb.js";
-import { QueueDb } from "./QueueDb.js";
-
-/**
- * A class to manage storing requests from a Queue in IndexedDB,
- * indexed by their queue name for easier access.
- *
- * Most developers will not need to access this class directly;
- * it is exposed for advanced use cases.
- */
-export class QueueStore {
-  private readonly _queueName: string;
-  private readonly _queueDb: QueueDb;
-
-  /**
-   * Associates this instance with a Queue instance, so entries added can be
-   * identified by their queue name.
-   *
-   * @param queueName
-   */
-  constructor(queueName: string) {
-    this._queueName = queueName;
-    this._queueDb = new QueueDb();
-  }
-
-  /**
-   * Append an entry last in the queue.
-   *
-   * @param entry
-   */
-  async pushEntry(entry: UnidentifiedQueueStoreEntry): Promise<void> {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(entry, "object", {
-        moduleName: "@serwist/background-sync",
-        className: "QueueStore",
-        funcName: "pushEntry",
-        paramName: "entry",
-      });
-      assert!.isType(entry.requestData, "object", {
-        moduleName: "@serwist/background-sync",
-        className: "QueueStore",
-        funcName: "pushEntry",
-        paramName: "entry.requestData",
-      });
-    }
-
-    // biome-ignore lint/performance/noDelete: Don't specify an ID since one is automatically generated.
-    delete entry.id;
-    entry.queueName = this._queueName;
-
-    await this._queueDb.addEntry(entry);
-  }
-
-  /**
-   * Prepend an entry first in the queue.
-   *
-   * @param entry
-   */
-  async unshiftEntry(entry: UnidentifiedQueueStoreEntry): Promise<void> {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(entry, "object", {
-        moduleName: "@serwist/background-sync",
-        className: "QueueStore",
-        funcName: "unshiftEntry",
-        paramName: "entry",
-      });
-      assert!.isType(entry.requestData, "object", {
-        moduleName: "@serwist/background-sync",
-        className: "QueueStore",
-        funcName: "unshiftEntry",
-        paramName: "entry.requestData",
-      });
-    }
-
-    const firstId = await this._queueDb.getFirstEntryId();
-
-    if (firstId) {
-      // Pick an ID one less than the lowest ID in the object store.
-      entry.id = firstId - 1;
-    } else {
-      // biome-ignore lint/performance/noDelete: Let the auto-incrementor assign the ID.
-      delete entry.id;
-    }
-    entry.queueName = this._queueName;
-
-    await this._queueDb.addEntry(entry);
-  }
-
-  /**
-   * Removes and returns the last entry in the queue matching the `queueName`.
-   *
-   * @returns
-   */
-  async popEntry(): Promise<QueueStoreEntry | undefined> {
-    return this._removeEntry(await this._queueDb.getLastEntryByQueueName(this._queueName));
-  }
-
-  /**
-   * Removes and returns the first entry in the queue matching the `queueName`.
-   *
-   * @returns
-   */
-  async shiftEntry(): Promise<QueueStoreEntry | undefined> {
-    return this._removeEntry(await this._queueDb.getFirstEntryByQueueName(this._queueName));
-  }
-
-  /**
-   * Returns all entries in the store matching the `queueName`.
-   *
-   * @returns
-   */
-  async getAll(): Promise<QueueStoreEntry[]> {
-    return await this._queueDb.getAllEntriesByQueueName(this._queueName);
-  }
-
-  /**
-   * Returns the number of entries in the store matching the `queueName`.
-   *
-   * @returns
-   */
-  async size(): Promise<number> {
-    return await this._queueDb.getEntryCountByQueueName(this._queueName);
-  }
-
-  /**
-   * Deletes the entry for the given ID.
-   *
-   * WARNING: this method does not ensure the deleted entry belongs to this
-   * queue (i.e. matches the `queueName`). But this limitation is acceptable
-   * as this class is not publicly exposed. An additional check would make
-   * this method slower than it needs to be.
-   *
-   * @param id
-   */
-  async deleteEntry(id: number): Promise<void> {
-    await this._queueDb.deleteEntry(id);
-  }
-
-  /**
-   * Removes and returns the first or last entry in the queue (based on the
-   * `direction` argument) matching the `queueName`.
-   *
-   * @returns
-   * @private
-   */
-  async _removeEntry(entry?: QueueStoreEntry): Promise<QueueStoreEntry | undefined> {
-    if (entry) {
-      await this.deleteEntry(entry.id);
-    }
-    return entry;
-  }
-}

package/src/StorableRequest.ts

@@ -1,142 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import type { MapLikeObject } from "@serwist/core";
-import { assert } from "@serwist/core/internal";
-
-type SerializableProperties = "method" | "referrer" | "referrerPolicy" | "mode" | "credentials" | "cache" | "redirect" | "integrity" | "keepalive";
-
-const serializableProperties: SerializableProperties[] = [
-  "method",
-  "referrer",
-  "referrerPolicy",
-  "mode",
-  "credentials",
-  "cache",
-  "redirect",
-  "integrity",
-  "keepalive",
-];
-
-export interface RequestData extends MapLikeObject {
-  url: string;
-  headers: MapLikeObject;
-  body?: ArrayBuffer;
-}
-
-/**
- * A class to make it easier to serialize and de-serialize requests so they
- * can be stored in IndexedDB.
- *
- * Most developers will not need to access this class directly;
- * it is exposed for advanced use cases.
- */
-export class StorableRequest {
-  private readonly _requestData: RequestData;
-
-  /**
-   * Converts a Request object to a plain object that can be structured
-   * cloned or JSON-stringified.
-   *
-   * @param request
-   * @returns
-   */
-  static async fromRequest(request: Request): Promise<StorableRequest> {
-    const requestData: RequestData = {
-      url: request.url,
-      headers: {},
-    };
-
-    // Set the body if present.
-    if (request.method !== "GET") {
-      // Use ArrayBuffer to support non-text request bodies.
-      // NOTE: we can't use Blobs becuse Safari doesn't support storing
-      // Blobs in IndexedDB in some cases:
-      // https://github.com/dfahlander/Dexie.js/issues/618#issuecomment-398348457
-      requestData.body = await request.clone().arrayBuffer();
-    }
-
-    request.headers.forEach((value, key) => {
-      requestData.headers[key] = value;
-    });
-
-    // Add all other serializable request properties
-    for (const prop of serializableProperties) {
-      if (request[prop] !== undefined) {
-        requestData[prop] = request[prop];
-      }
-    }
-
-    return new StorableRequest(requestData);
-  }
-
-  /**
-   * Accepts an object of request data that can be used to construct a
-   * `Request` but can also be stored in IndexedDB.
-   *
-   * @param requestData An object of request data that includes the `url` plus any relevant properties of
-   * [requestInit](https://fetch.spec.whatwg.org/#requestinit).
-   */
-  constructor(requestData: RequestData) {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(requestData, "object", {
-        moduleName: "@serwist/background-sync",
-        className: "StorableRequest",
-        funcName: "constructor",
-        paramName: "requestData",
-      });
-      assert!.isType(requestData.url, "string", {
-        moduleName: "@serwist/background-sync",
-        className: "StorableRequest",
-        funcName: "constructor",
-        paramName: "requestData.url",
-      });
-    }
-
-    // If the request's mode is `navigate`, convert it to `same-origin` since
-    // navigation requests can't be constructed via script.
-    if (requestData.mode === "navigate") {
-      requestData.mode = "same-origin";
-    }
-
-    this._requestData = requestData;
-  }
-
-  /**
-   * Returns a deep clone of the instances `_requestData` object.
-   *
-   * @returns
-   */
-  toObject(): RequestData {
-    const requestData = Object.assign({}, this._requestData);
-    requestData.headers = Object.assign({}, this._requestData.headers);
-    if (requestData.body) {
-      requestData.body = requestData.body.slice(0);
-    }
-
-    return requestData;
-  }
-
-  /**
-   * Converts this instance to a Request.
-   *
-   * @returns
-   */
-  toRequest(): Request {
-    return new Request(this._requestData.url, this._requestData);
-  }
-
-  /**
-   * Creates and returns a deep clone of the instance.
-   *
-   * @returns
-   */
-  clone(): StorableRequest {
-    return new StorableRequest(this.toObject());
-  }
-}