@utiliread/http 1.27.0 → 1.27.1

package/src/plugins/cursor/index.ts

@@ -1,45 +1,47 @@
-import {
-  HttpBuilder,
-  TypeOrMapper,
-  getMapper,
-} from "@utiliread/http";
-import { deserialize } from "@utiliread/json";
-
-export interface ICursorPage<T> {
-  items: T[];
-  nextCursor: string | null;
-  hasMore: boolean;
-}
-
-// Force declarations to be module augmentations instead of ambient module declarations
-// https://www.typescriptlang.org/docs/handbook/modules/reference.html#ambient-modules
-export default {};
-
-// https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation
-declare module "@utiliread/http" {
-  interface HttpBuilder {
-    expectCursorPage<T>(
-      typeOrMapper: TypeOrMapper<T>,
-    ): HttpBuilderOfT<ICursorPage<T>>;
-  }
-}
-
-HttpBuilder.prototype.expectCursorPage = function <T>(
-  this: HttpBuilder,
-  typeOrMapper: TypeOrMapper<T>,
-) {
-  this.message.headers.set("Accept", "application/json");
-  return this.useHandler((response) => {
-    const promise = response.rawResponse
-      .json()
-      .then((x: ICursorPage<any>): ICursorPage<T> => {
-        const itemFactory = getMapper(deserialize, typeOrMapper);
-        return {
-          items: x.items.map(itemFactory),
-          nextCursor: x.nextCursor,
-          hasMore: x.hasMore,
-        };
-      });
-    return promise;
-  });
-};
+import {
+  HttpBuilder,
+  TypeOrMapper,
+  getMapper,
+} from "@utiliread/http";
+import { deserialize } from "@utiliread/json";
+
+export interface ICursorPage<T> {
+  items: T[];
+  nextCursor: string | null;
+  hasMore: boolean;
+  totalCount?: number;
+}
+
+// Force declarations to be module augmentations instead of ambient module declarations
+// https://www.typescriptlang.org/docs/handbook/modules/reference.html#ambient-modules
+export default {};
+
+// https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation
+declare module "@utiliread/http" {
+  interface HttpBuilder {
+    expectCursorPage<T>(
+      typeOrMapper: TypeOrMapper<T>,
+    ): HttpBuilderOfT<ICursorPage<T>>;
+  }
+}
+
+HttpBuilder.prototype.expectCursorPage = function <T>(
+  this: HttpBuilder,
+  typeOrMapper: TypeOrMapper<T>,
+) {
+  this.message.headers.set("Accept", "application/json");
+  return this.useHandler((response) => {
+    const promise = response.rawResponse
+      .json()
+      .then((x: ICursorPage<any>): ICursorPage<T> => {
+        const itemFactory = getMapper(deserialize, typeOrMapper);
+        return {
+          items: x.items.map(itemFactory),
+          nextCursor: x.nextCursor,
+          hasMore: x.hasMore,
+          totalCount: x.totalCount,
+        };
+      });
+    return promise;
+  });
+};

package/src/query-string.spec.ts

@@ -1,96 +1,96 @@
-import { DateTime, Duration } from "luxon";
-
-import { QueryString } from "./query-string";
-import { expect } from "chai";
-
-describe("query-string", () => {
-  it("should handle string", () => {
-    const qs = QueryString.serialize({
-      aString: "hello",
-    });
-
-    expect(qs).to.equal("?aString=hello");
-  });
-
-  it("should handle string array", () => {
-    const qs = QueryString.serialize({
-      aString: ["hello", "world"],
-    });
-
-    expect(qs).to.equal("?aString[0]=hello&aString[1]=world");
-  });
-
-  it("should handle object array", () => {
-    const qs = QueryString.serialize({
-      array: [{ a: "hello" }, { b: "world" }],
-    });
-
-    expect(qs).to.equal("?array[0].a=hello&array[1].b=world");
-  });
-
-  it("should handle luxon DateTime in local timezone", () => {
-    const datetime = DateTime.fromObject({
-      year: 2014,
-      month: 11,
-      day: 12,
-      hour: 21,
-      minute: 6,
-    });
-    const qs = QueryString.serialize({
-      aDateTime: datetime,
-    });
-
-    expect(qs).to.equal(
-      "?aDateTime=" + encodeURIComponent("2014-11-12T21:06:00.000+01:00"),
-    );
-  });
-
-  it("should handle luxon DateTime in utc", () => {
-    const datetime = DateTime.fromObject({
-      year: 2014,
-      month: 11,
-      day: 12,
-      hour: 21,
-      minute: 6,
-    }).toUTC();
-    const qs = QueryString.serialize({
-      aDateTime: datetime,
-    });
-
-    expect(qs).to.equal(
-      "?aDateTime=" + encodeURIComponent("2014-11-12T20:06:00.000Z"),
-    );
-  });
-
-  it("should handle luxon Duration", () => {
-    const duration = Duration.fromObject({
-      years: 1,
-      months: 2,
-      days: 3,
-      hours: 4,
-      minutes: 5,
-      seconds: 6,
-    });
-    const qs = QueryString.serialize({
-      aDuration: duration,
-    });
-
-    expect(qs).to.equal("?aDuration=" + encodeURIComponent("P1Y2M3DT4H5M6S"));
-  });
-
-  it("should handle null", () => {
-    const qs = QueryString.serialize({
-      null: null,
-    });
-
-    expect(qs).to.equal("?null");
-  });
-
-  it("should not include undefined", () => {
-    const qs = QueryString.serialize({
-      null: undefined,
-    });
-
-    expect(qs).to.equal("");
-  });
-});
+import { DateTime, Duration } from "luxon";
+
+import { QueryString } from "./query-string";
+import { expect } from "chai";
+
+describe("query-string", () => {
+  it("should handle string", () => {
+    const qs = QueryString.serialize({
+      aString: "hello",
+    });
+
+    expect(qs).to.equal("?aString=hello");
+  });
+
+  it("should handle string array", () => {
+    const qs = QueryString.serialize({
+      aString: ["hello", "world"],
+    });
+
+    expect(qs).to.equal("?aString[0]=hello&aString[1]=world");
+  });
+
+  it("should handle object array", () => {
+    const qs = QueryString.serialize({
+      array: [{ a: "hello" }, { b: "world" }],
+    });
+
+    expect(qs).to.equal("?array[0].a=hello&array[1].b=world");
+  });
+
+  it("should handle luxon DateTime in local timezone", () => {
+    const datetime = DateTime.fromObject({
+      year: 2014,
+      month: 11,
+      day: 12,
+      hour: 21,
+      minute: 6,
+    });
+    const qs = QueryString.serialize({
+      aDateTime: datetime,
+    });
+
+    expect(qs).to.equal(
+      "?aDateTime=" + encodeURIComponent("2014-11-12T21:06:00.000+01:00"),
+    );
+  });
+
+  it("should handle luxon DateTime in utc", () => {
+    const datetime = DateTime.fromObject({
+      year: 2014,
+      month: 11,
+      day: 12,
+      hour: 21,
+      minute: 6,
+    }).toUTC();
+    const qs = QueryString.serialize({
+      aDateTime: datetime,
+    });
+
+    expect(qs).to.equal(
+      "?aDateTime=" + encodeURIComponent("2014-11-12T20:06:00.000Z"),
+    );
+  });
+
+  it("should handle luxon Duration", () => {
+    const duration = Duration.fromObject({
+      years: 1,
+      months: 2,
+      days: 3,
+      hours: 4,
+      minutes: 5,
+      seconds: 6,
+    });
+    const qs = QueryString.serialize({
+      aDuration: duration,
+    });
+
+    expect(qs).to.equal("?aDuration=" + encodeURIComponent("P1Y2M3DT4H5M6S"));
+  });
+
+  it("should handle null", () => {
+    const qs = QueryString.serialize({
+      null: null,
+    });
+
+    expect(qs).to.equal("?null");
+  });
+
+  it("should not include undefined", () => {
+    const qs = QueryString.serialize({
+      null: undefined,
+    });
+
+    expect(qs).to.equal("");
+  });
+});

package/src/query-string.ts

@@ -1,75 +1,75 @@
-import { DateTime, Duration } from "luxon";
-
-export class QueryString {
-  static serialize(params: any) {
-    if (!params) {
-      return "";
-    }
-    const serialized = this._serializeQueryString(params);
-    if (!serialized.length) {
-      return "";
-    }
-    return "?" + serialized;
-  }
-
-  static append(url: string, params: any) {
-    if (!params) {
-      return url;
-    }
-    const any = url.indexOf("?") >= 0;
-    const separator = any ? "&" : "?";
-
-    return url + separator + this._serializeQueryString(params);
-  }
-
-  static getParameter(name: string) {
-    const regex = new RegExp(`[?&]${name}(=([^&#]*)|&|#|$)`);
-    const match = regex.exec(window.location.href);
-    if (match) {
-      if (match[1].length > 0) {
-        return decodeURIComponent(match[2]);
-      } else {
-        return null;
-      }
-    }
-  }
-
-  private static _serializeQueryString(source: any, prefix?: string) {
-    const parts: string[] = [];
-    for (const propertyName in source) {
-      if (source.hasOwnProperty(propertyName)) {
-        const key =
-          prefix != null
-            ? prefix +
-              (Array.isArray(source)
-                ? "[" + encodeURIComponent(propertyName) + "]"
-                : "." + encodeURIComponent(propertyName))
-            : encodeURIComponent(propertyName);
-        const value = source[propertyName];
-
-        if (value instanceof DateTime) {
-          if (value.isValid) {
-            parts.push(key + "=" + encodeURIComponent(value.toISO()!));
-          }
-        } else if (value instanceof Duration) {
-          if (value.isValid) {
-            parts.push(key + "=" + encodeURIComponent(value.toISO()!));
-          }
-        } else if (value === null) {
-          parts.push(key);
-        } else if (value !== undefined) {
-          if ("function" === typeof value.toISOString) {
-            parts.push(key + "=" + encodeURIComponent(value.toISOString()));
-          }
-          if (typeof value === "object") {
-            parts.push(this._serializeQueryString(value, key));
-          } else {
-            parts.push(key + "=" + encodeURIComponent(value));
-          }
-        }
-      }
-    }
-
-    return parts.join("&");
-  }
-}
+import { DateTime, Duration } from "luxon";
+
+export class QueryString {
+  static serialize(params: any) {
+    if (!params) {
+      return "";
+    }
+    const serialized = this._serializeQueryString(params);
+    if (!serialized.length) {
+      return "";
+    }
+    return "?" + serialized;
+  }
+
+  static append(url: string, params: any) {
+    if (!params) {
+      return url;
+    }
+    const any = url.indexOf("?") >= 0;
+    const separator = any ? "&" : "?";
+
+    return url + separator + this._serializeQueryString(params);
+  }
+
+  static getParameter(name: string) {
+    const regex = new RegExp(`[?&]${name}(=([^&#]*)|&|#|$)`);
+    const match = regex.exec(window.location.href);
+    if (match) {
+      if (match[1].length > 0) {
+        return decodeURIComponent(match[2]);
+      } else {
+        return null;
+      }
+    }
+  }
+
+  private static _serializeQueryString(source: any, prefix?: string) {
+    const parts: string[] = [];
+    for (const propertyName in source) {
+      if (source.hasOwnProperty(propertyName)) {
+        const key =
+          prefix != null
+            ? prefix +
+              (Array.isArray(source)
+                ? "[" + encodeURIComponent(propertyName) + "]"
+                : "." + encodeURIComponent(propertyName))
+            : encodeURIComponent(propertyName);
+        const value = source[propertyName];
+
+        if (value instanceof DateTime) {
+          if (value.isValid) {
+            parts.push(key + "=" + encodeURIComponent(value.toISO()!));
+          }
+        } else if (value instanceof Duration) {
+          if (value.isValid) {
+            parts.push(key + "=" + encodeURIComponent(value.toISO()!));
+          }
+        } else if (value === null) {
+          parts.push(key);
+        } else if (value !== undefined) {
+          if ("function" === typeof value.toISOString) {
+            parts.push(key + "=" + encodeURIComponent(value.toISOString()));
+          }
+          if (typeof value === "object") {
+            parts.push(this._serializeQueryString(value, key));
+          } else {
+            parts.push(key + "=" + encodeURIComponent(value));
+          }
+        }
+      }
+    }
+
+    return parts.join("&");
+  }
+}