keq 5.0.0-alpha.32 → 5.0.0-alpha.34

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 5.0.0-alpha.34
+
+### Major Changes
+
+- f8abc63: **BREAKING CHANGE:** Remove `end()`, add `derive()` for reusing request configuration and `fire()` for fire-and-forget invocation.
+
+### Minor Changes
+
+- a7a83da: **Perf:** Core now extends Promise, making keq instances true Promises instead of thenables.
+
+## 5.0.0-alpha.33
+
 ## 5.0.0-alpha.32
 
 ### Minor Changes

package/README.md

@@ -36,7 +36,7 @@ Keq wraps the Fetch APIs, adding chain calls and middleware functions.
 ### Send Request
 
 A request can be initiated by invoking the appropriate method on the request object,
-then calling `.then()` (or `.end()` or `await`) to send the request.
+then calling `.then()` (or `await`) to send the request.
 For example a simple GET request:
 
 ```javascript

package/dist/index.js

@@ -1296,13 +1296,27 @@ function queryStringify(query, options) {
 }
 
 // src/request/core.ts
-var Core = class {
+var import_json2 = require("klona/json");
+var Core = class extends Promise {
   constructor(url, options) {
+    let resolve;
+    let reject;
+    super((res, rej) => {
+      resolve = res;
+      reject = rej;
+    });
     /**
      * The unique identifier of the request's location in the code
      */
     __publicField(this, "__locationId__");
-    __publicField(this, "requestPromise");
+    /** Deferred resolve callback captured from the Promise executor. */
+    __publicField(this, "__resolve__");
+    /** Deferred reject callback captured from the Promise executor. */
+    __publicField(this, "__reject__");
+    /** Whether the request has been lazily triggered by `.then()`. */
+    __publicField(this, "__triggered__", false);
+    /** Cached promise for idempotent `end()` calls. */
+    __publicField(this, "__requestPromise__");
     __publicField(this, "requestInit");
     __publicField(this, "__listeners__", {});
     __publicField(this, "__global__");
@@ -1313,6 +1327,8 @@ var Core = class {
       resolveWithFullResponse: false,
       resolveWith: "intelligent"
     });
+    this.__resolve__ = resolve;
+    this.__reject__ = reject;
     this.__global__ = options.global || {};
     this.__locationId__ = options.locationId;
     this.__qs__ = options.qs;
@@ -1328,6 +1344,12 @@ var Core = class {
       this.__append_middlewares__.push(...options.middlewares);
     }
   }
+  /**
+   * Ensures `.then()`, `.catch()`, `.finally()` return plain Promise instances instead of Core/Keq instances.
+   */
+  static get [Symbol.species]() {
+    return Promise;
+  }
   get __middlewares__() {
     return [...this.__prepend_middlewares__, ...this.__append_middlewares__];
   }
@@ -1363,6 +1385,36 @@ var Core = class {
     }
     return this;
   }
+  derive() {
+    const derived = new this.constructor(
+      this.requestInit.url,
+      {
+        method: this.requestInit.method,
+        headers: this.requestInit.headers,
+        body: this.requestInit.body,
+        pathParameters: this.requestInit.pathParameters,
+        cache: this.requestInit.cache,
+        credentials: this.requestInit.credentials,
+        integrity: this.requestInit.integrity,
+        keepalive: this.requestInit.keepalive,
+        mode: this.requestInit.mode,
+        redirect: this.requestInit.redirect,
+        referrer: this.requestInit.referrer,
+        referrerPolicy: this.requestInit.referrerPolicy,
+        locationId: this.__locationId__,
+        global: this.__global__,
+        qs: this.__qs__ ? { ...this.__qs__ } : void 0,
+        middlewares: [...this.__append_middlewares__]
+      }
+    );
+    derived.__prepend_middlewares__ = [...this.__prepend_middlewares__];
+    derived.__listeners__ = {};
+    for (const key in this.__listeners__) {
+      derived.__listeners__[key] = [...this.__listeners__[key]];
+    }
+    derived.__options__ = (0, import_json2.klona)(this.__options__);
+    return derived;
+  }
   buildSharedContext() {
     const coreContext = new KeqSharedContext({
       locationId: this.__locationId__,
@@ -1414,45 +1466,47 @@ var Core = class {
       attempt = attemptWithDefault + 1;
     }
   }
-  async end() {
-    var _a6;
-    const coreContext = await this.run();
-    const resolveWithMode = coreContext.options.resolveWith;
-    if (resolveWithMode === "response") {
-      return (_a6 = coreContext.response) == null ? void 0 : _a6.clone();
-    }
-    const response = coreContext.response;
-    if (!resolveWithMode || resolveWithMode === "intelligent") {
-      const output = coreContext.output;
-      if (output !== void 0) {
-        return output;
-      }
-      return await intelligentParseResponse(response);
+  __execute__() {
+    if (!this.__requestPromise__) {
+      this.__requestPromise__ = (async () => {
+        var _a6;
+        const coreContext = await this.run();
+        const resolveWithMode = coreContext.options.resolveWith;
+        if (resolveWithMode === "response") {
+          return (_a6 = coreContext.response) == null ? void 0 : _a6.clone();
+        }
+        const response = coreContext.response;
+        if (!resolveWithMode || resolveWithMode === "intelligent") {
+          const output = coreContext.output;
+          if (output !== void 0) {
+            return output;
+          }
+          return await intelligentParseResponse(response);
+        }
+        if (!response) {
+          throw new Exception([
+            "Unable to process the response with '".concat(resolveWithMode, "'. Possible causes:"),
+            "1. The request was never initiated or sent",
+            "2. The request failed before a response was received."
+          ].join("\n"));
+        }
+        return await resolveWith(response, resolveWithMode);
+      })();
     }
-    if (!response) {
-      throw new Exception([
-        "Unable to process the response with '".concat(resolveWithMode, "'. Possible causes:"),
-        "1. The request was never initiated or sent",
-        "2. The request failed before a response was received."
-      ].join("\n"));
+    return this.__requestPromise__;
+  }
+  fire() {
+    if (!this.__triggered__) {
+      this.__triggered__ = true;
+      this.__execute__().then(this.__resolve__, this.__reject__);
     }
-    return await resolveWith(response, resolveWithMode);
   }
-  /**
-   * Attaches callbacks for the resolution and/or rejection of the Promise.
-   * @param onfulfilled The callback to execute when the Promise is resolved.
-   * @param onrejected The callback to execute when the Promise is rejected.
-   * @returns A Promise for the completion of which ever callback is executed.
-   */
   then(onfulfilled, onrejected) {
-    if (!this.requestPromise) this.requestPromise = this.end();
-    return this.requestPromise.then(onfulfilled, onrejected);
-  }
-  catch(onrejected) {
-    return this.end().catch(onrejected);
-  }
-  finally(onfinally) {
-    return this.end().finally(onfinally);
+    if (!this.__triggered__) {
+      this.__triggered__ = true;
+      this.__execute__().then(this.__resolve__, this.__reject__);
+    }
+    return super.then(onfulfilled, onrejected);
   }
 };
 
@@ -1632,8 +1686,8 @@ var Keq = class extends Core {
     this.option("timeout", { millisecond: milliseconds });
     return this;
   }
-  resolveWith(m2) {
-    this.option("resolveWith", m2);
+  resolveWith(m) {
+    this.option("resolveWith", m);
     return this;
   }
 };
@@ -1676,10 +1730,11 @@ function keqModuleRoute(moduleName) {
 }
 
 // src/router/keq-pathname-route.ts
-var m = __toESM(require("minimatch"));
+var import_picomatch = __toESM(require("picomatch"));
 function keqPathnameRoute(pathname) {
+  const isMatch = (0, import_picomatch.default)(pathname);
   return (ctx) => {
-    return m.minimatch(ctx.request.url.pathname, pathname);
+    return isMatch(ctx.request.url.pathname);
   };
 }