@panyam/tsappkit 0.6.3 → 0.6.9

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/dist/wasmhost/index.d.mts

@@ -14,7 +14,8 @@ interface StartWorkerOptions {
 }
 /**
  * Starts the worker and resolves with it once the Go program has installed its exports, or rejects
- * with why it couldn't load. Relative URLs resolve against the page, not the worker script.
+ * with why it couldn't load (and terminates it, since it can't answer anything). Relative URLs
+ * resolve against the page, not the worker script.
  */
 declare function startWorker(opts: StartWorkerOptions): Promise<Worker>;
 /**
@@ -22,8 +23,31 @@ declare function startWorker(opts: StartWorkerOptions): Promise<Worker>;
  * Only the path and query reach the worker, so baseUrl can be anything absolute, such as
  * location.origin. It rejects if the worker reports an error (no handler, a failed build, a handler
  * panic) and resolves with any HTTP status the handler chose.
+ *
+ * A handler that flushes (http.Flusher) streams: the Response resolves at its first flush, and its
+ * body delivers each flush as it happens, even from a Go loop that never yields, then the rest
+ * when the handler returns. Aborting the request (init.signal) rejects it, or errors a body that's
+ * already streaming, and cancels the handler's context; a handler sees that the next time it checks
+ * ctx, which a loop that never yields to JS doesn't get to do (a lane ends such a worker instead).
+ * Once the body is streaming, Chrome's text() and json() report the abort as "TypeError: Failed to
+ * fetch" rather than an AbortError, so tell an abort from a failure by signal.aborted.
  */
 declare function workerFetch(worker: Worker): (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/**
+ * A fetch like workerFetch's, except that each call starts a fresh worker from `opts`, sends it that
+ * one request, and terminates it once the response is in, whether the request succeeded or not.
+ * Ending the worker is the only way to give its wasm memory back to the browser, since wasm memory
+ * never shrinks, so route a request with a big transient peak (an ingest that parses a large input
+ * on the way to a small result) through this, and have it leave its result in the shared Cache
+ * (Go's wasmhost.BrowserCache) for the long-lived worker to load. Every worker for the same `ns`
+ * sees the same cache.
+ *
+ * Each call pays for a worker start and a wasm instantiate, a few hundred ms, so it's for jobs
+ * that take seconds, not for ordinary requests. The worker ends when the response's body has been
+ * read to the end, fails, or is cancelled, so a streamed body isn't cut short; read or cancel the
+ * body, or the worker stays up.
+ */
+declare function oneShotFetch(opts: StartWorkerOptions): (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 /**
  * Replaces the mount `name` with `files`. The buffers are transferred to the worker, not copied, so
  * each Uint8Array is empty here afterwards; copy first anything the page still needs. Resolves once
@@ -59,4 +83,54 @@ declare function filesFromDrop(dt: DataTransfer): Promise<Files>;
  */
 declare function filesFromFileList(list: FileList | File[]): Promise<Files>;
 
-export { type Files, type StartWorkerOptions, addFiles, filesFromDrop, filesFromFileList, mountFiles, startWorker, unmountFiles, workerFetch, workerMemory };
+type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+interface LaneOptions {
+    /**
+     * Runs on each new worker before the lane hands it a request: typically a request that loads
+     * the service's state from the cache (wasmhost.BrowserCache), so a replacement worker answers
+     * like the one it replaced. A warm that throws ends that worker, and the error is what the next
+     * request gets; the request after it starts another worker.
+     */
+    warm?: (fetch: Fetch) => Promise<unknown>;
+    /**
+     * A memory limit for the lane's worker, in bytes of wasm memory (workerMemory). Wasm memory never
+     * shrinks, so a long-lived worker creeps up through requests that each allocate and drop some.
+     * When a request finishes (its body read to the end, or failed) and the lane has nothing else
+     * in flight, the lane asks the worker how much it holds, and past this limit replaces it with a
+     * fresh one, warmed as on an abort. It never interrupts a request, so a lane that's never idle
+     * never restarts, and a response whose body nobody reads keeps the lane busy. Size it above what
+     * the warmed state needs, or the lane restarts after every request.
+     */
+    maxMemoryBytes?: number;
+    /** Called when the lane replaces its worker for passing maxMemoryBytes, with what it held. */
+    onRestart?: (why: {
+        memoryBytes: number;
+    }) => void;
+}
+/** One replaceable worker. See startLane. */
+interface Lane {
+    /**
+     * A fetch for a Connect transport, like workerFetch, answered by the lane's current worker.
+     * Aborting a request (init.signal) rejects it with the signal's reason at once (or errors its
+     * body, if it's already streaming), terminates the worker, and starts and warms a new one; other
+     * requests still waiting on the old worker are rejected too. A request made meanwhile waits for
+     * the new worker.
+     */
+    fetch: Fetch;
+    /** The lane's current worker, once it's started and warmed. */
+    worker(): Promise<Worker>;
+    /** Replaces the worker, as an abort does, and resolves once the new one is warm. */
+    restart(): Promise<void>;
+    /** Terminates the worker. Requests after this reject. */
+    close(): void;
+}
+/**
+ * Starts a lane: a worker from `opts`, warmed with `lane.warm`, that the lane replaces whenever a
+ * request on it is aborted. Give each kind of request its own lane (a "serve" lane for quick
+ * queries, a "jobs" lane for long jobs) by building each client's transport on that lane's fetch.
+ * Every lane of one ns shares the same Cache, which is how a replacement or a second lane gets the
+ * state without rebuilding it.
+ */
+declare function startLane(opts: StartWorkerOptions, lane?: LaneOptions): Lane;
+
+export { type Files, type Lane, type LaneOptions, type StartWorkerOptions, addFiles, filesFromDrop, filesFromFileList, mountFiles, oneShotFetch, startLane, startWorker, unmountFiles, workerFetch, workerMemory };

package/dist/wasmhost/index.d.ts

@@ -14,7 +14,8 @@ interface StartWorkerOptions {
 }
 /**
  * Starts the worker and resolves with it once the Go program has installed its exports, or rejects
- * with why it couldn't load. Relative URLs resolve against the page, not the worker script.
+ * with why it couldn't load (and terminates it, since it can't answer anything). Relative URLs
+ * resolve against the page, not the worker script.
  */
 declare function startWorker(opts: StartWorkerOptions): Promise<Worker>;
 /**
@@ -22,8 +23,31 @@ declare function startWorker(opts: StartWorkerOptions): Promise<Worker>;
  * Only the path and query reach the worker, so baseUrl can be anything absolute, such as
  * location.origin. It rejects if the worker reports an error (no handler, a failed build, a handler
  * panic) and resolves with any HTTP status the handler chose.
+ *
+ * A handler that flushes (http.Flusher) streams: the Response resolves at its first flush, and its
+ * body delivers each flush as it happens, even from a Go loop that never yields, then the rest
+ * when the handler returns. Aborting the request (init.signal) rejects it, or errors a body that's
+ * already streaming, and cancels the handler's context; a handler sees that the next time it checks
+ * ctx, which a loop that never yields to JS doesn't get to do (a lane ends such a worker instead).
+ * Once the body is streaming, Chrome's text() and json() report the abort as "TypeError: Failed to
+ * fetch" rather than an AbortError, so tell an abort from a failure by signal.aborted.
  */
 declare function workerFetch(worker: Worker): (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/**
+ * A fetch like workerFetch's, except that each call starts a fresh worker from `opts`, sends it that
+ * one request, and terminates it once the response is in, whether the request succeeded or not.
+ * Ending the worker is the only way to give its wasm memory back to the browser, since wasm memory
+ * never shrinks, so route a request with a big transient peak (an ingest that parses a large input
+ * on the way to a small result) through this, and have it leave its result in the shared Cache
+ * (Go's wasmhost.BrowserCache) for the long-lived worker to load. Every worker for the same `ns`
+ * sees the same cache.
+ *
+ * Each call pays for a worker start and a wasm instantiate, a few hundred ms, so it's for jobs
+ * that take seconds, not for ordinary requests. The worker ends when the response's body has been
+ * read to the end, fails, or is cancelled, so a streamed body isn't cut short; read or cancel the
+ * body, or the worker stays up.
+ */
+declare function oneShotFetch(opts: StartWorkerOptions): (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 /**
  * Replaces the mount `name` with `files`. The buffers are transferred to the worker, not copied, so
  * each Uint8Array is empty here afterwards; copy first anything the page still needs. Resolves once
@@ -59,4 +83,54 @@ declare function filesFromDrop(dt: DataTransfer): Promise<Files>;
  */
 declare function filesFromFileList(list: FileList | File[]): Promise<Files>;
 
-export { type Files, type StartWorkerOptions, addFiles, filesFromDrop, filesFromFileList, mountFiles, startWorker, unmountFiles, workerFetch, workerMemory };
+type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+interface LaneOptions {
+    /**
+     * Runs on each new worker before the lane hands it a request: typically a request that loads
+     * the service's state from the cache (wasmhost.BrowserCache), so a replacement worker answers
+     * like the one it replaced. A warm that throws ends that worker, and the error is what the next
+     * request gets; the request after it starts another worker.
+     */
+    warm?: (fetch: Fetch) => Promise<unknown>;
+    /**
+     * A memory limit for the lane's worker, in bytes of wasm memory (workerMemory). Wasm memory never
+     * shrinks, so a long-lived worker creeps up through requests that each allocate and drop some.
+     * When a request finishes (its body read to the end, or failed) and the lane has nothing else
+     * in flight, the lane asks the worker how much it holds, and past this limit replaces it with a
+     * fresh one, warmed as on an abort. It never interrupts a request, so a lane that's never idle
+     * never restarts, and a response whose body nobody reads keeps the lane busy. Size it above what
+     * the warmed state needs, or the lane restarts after every request.
+     */
+    maxMemoryBytes?: number;
+    /** Called when the lane replaces its worker for passing maxMemoryBytes, with what it held. */
+    onRestart?: (why: {
+        memoryBytes: number;
+    }) => void;
+}
+/** One replaceable worker. See startLane. */
+interface Lane {
+    /**
+     * A fetch for a Connect transport, like workerFetch, answered by the lane's current worker.
+     * Aborting a request (init.signal) rejects it with the signal's reason at once (or errors its
+     * body, if it's already streaming), terminates the worker, and starts and warms a new one; other
+     * requests still waiting on the old worker are rejected too. A request made meanwhile waits for
+     * the new worker.
+     */
+    fetch: Fetch;
+    /** The lane's current worker, once it's started and warmed. */
+    worker(): Promise<Worker>;
+    /** Replaces the worker, as an abort does, and resolves once the new one is warm. */
+    restart(): Promise<void>;
+    /** Terminates the worker. Requests after this reject. */
+    close(): void;
+}
+/**
+ * Starts a lane: a worker from `opts`, warmed with `lane.warm`, that the lane replaces whenever a
+ * request on it is aborted. Give each kind of request its own lane (a "serve" lane for quick
+ * queries, a "jobs" lane for long jobs) by building each client's transport on that lane's fetch.
+ * Every lane of one ns shares the same Cache, which is how a replacement or a second lane gets the
+ * state without rebuilding it.
+ */
+declare function startLane(opts: StartWorkerOptions, lane?: LaneOptions): Lane;
+
+export { type Files, type Lane, type LaneOptions, type StartWorkerOptions, addFiles, filesFromDrop, filesFromFileList, mountFiles, oneShotFetch, startLane, startWorker, unmountFiles, workerFetch, workerMemory };