@php-wasm/web-service-worker 1.0.16 → 1.0.17

package/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

package/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("@php-wasm/scopes"),h=25e3;let f=0;function y(e,t,...s){const n=d();return e.postMessage({...t,requestId:n},...s),n}function d(){return++f}function u(e,t,s=h){return new Promise((n,c)=>{const r=a=>{a.data.type==="response"&&a.data.requestId===t&&(e.removeEventListener("message",r),clearTimeout(o),n(a.data.response))},o=setTimeout(()=>{c(new Error("Request timed out")),e.removeEventListener("message",r)},s);e.addEventListener("message",r)})}function R(e,t){return{type:"response",requestId:e,response:t}}async function g(e){let t=new URL(e.request.url);if(!i.isURLScoped(t))try{const o=new URL(e.request.referrer);t=i.setURLScope(t,i.getURLScope(o))}catch{}const s=e.request.headers.get("content-type"),n=e.request.method==="POST"?new Uint8Array(await e.request.clone().arrayBuffer()):void 0,c={};for(const o of e.request.headers.entries())c[o[0]]=o[1];let r;try{const o={method:"request",args:[{body:n,url:t.toString(),method:e.request.method,headers:{...c,Host:t.host,"User-agent":self.navigator.userAgent,"Content-type":s}}]},a=i.getURLScope(t);if(a===null)throw new Error(`The URL ${t.toString()} is not scoped. This should not happen.`);const p=await l(o,a);r=await u(self,p),delete r.headers["x-frame-options"]}catch(o){throw console.error(o,{url:t.toString()}),o}return r.httpStatusCode>=300&&r.httpStatusCode<=399&&r.headers.location?Response.redirect(r.headers.location[0],r.httpStatusCode):new Response(r.bytes,{headers:r.headers,status:r.httpStatusCode})}async function l(e,t){const s=d();for(const n of await self.clients.matchAll({includeUncontrolled:!0}))n.postMessage({...e,scope:t,requestId:s});return s}async function m(e,t){const s=["GET","HEAD"].includes(e.method)||"body"in t?void 0:await e.blob();return new Request(t.url||e.url,{body:s,method:e.method,headers:e.headers,referrer:e.referrer,referrerPolicy:e.referrerPolicy,mode:e.mode==="navigate"?"same-origin":e.mode,credentials:e.credentials,cache:e.cache,redirect:e.redirect,integrity:e.integrity,...t})}function E(e){const t={};return e.headers.forEach((s,n)=>{t[n]=s}),t}exports.awaitReply=u;exports.broadcastMessageExpectReply=l;exports.cloneRequest=m;exports.convertFetchEventToPHPRequest=g;exports.getNextRequestId=d;exports.getRequestHeaders=E;exports.postMessageExpectReply=y;exports.responseTo=R;

package/index.js

@@ -0,0 +1,136 @@
+import { isURLScoped as l, setURLScope as h, getURLScope as i } from "@php-wasm/scopes";
+const p = 25e3;
+let f = 0;
+function g(e, t, ...o) {
+  const n = d();
+  return e.postMessage(
+    {
+      ...t,
+      requestId: n
+    },
+    ...o
+  ), n;
+}
+function d() {
+  return ++f;
+}
+function m(e, t, o = p) {
+  return new Promise((n, c) => {
+    const r = (a) => {
+      a.data.type === "response" && a.data.requestId === t && (e.removeEventListener("message", r), clearTimeout(s), n(a.data.response));
+    }, s = setTimeout(() => {
+      c(new Error("Request timed out")), e.removeEventListener("message", r);
+    }, o);
+    e.addEventListener("message", r);
+  });
+}
+function w(e, t) {
+  return {
+    type: "response",
+    requestId: e,
+    response: t
+  };
+}
+async function E(e) {
+  let t = new URL(e.request.url);
+  if (!l(t))
+    try {
+      const s = new URL(e.request.referrer);
+      t = h(t, i(s));
+    } catch {
+    }
+  const o = e.request.headers.get("content-type"), n = e.request.method === "POST" ? new Uint8Array(await e.request.clone().arrayBuffer()) : void 0, c = {};
+  for (const s of e.request.headers.entries())
+    c[s[0]] = s[1];
+  let r;
+  try {
+    const s = {
+      method: "request",
+      args: [
+        {
+          body: n,
+          url: t.toString(),
+          method: e.request.method,
+          headers: {
+            ...c,
+            Host: t.host,
+            // Safari and Firefox don't make the User-Agent header
+            // available in the fetch event. Let's add it manually:
+            "User-agent": self.navigator.userAgent,
+            "Content-type": o
+          }
+        }
+      ]
+    }, a = i(t);
+    if (a === null)
+      throw new Error(
+        `The URL ${t.toString()} is not scoped. This should not happen.`
+      );
+    const u = await y(s, a);
+    r = await m(self, u), delete r.headers["x-frame-options"];
+  } catch (s) {
+    throw console.error(s, { url: t.toString() }), s;
+  }
+  return r.httpStatusCode >= 300 && r.httpStatusCode <= 399 && r.headers.location ? Response.redirect(
+    r.headers.location[0],
+    r.httpStatusCode
+  ) : new Response(r.bytes, {
+    headers: r.headers,
+    status: r.httpStatusCode
+  });
+}
+async function y(e, t) {
+  const o = d();
+  for (const n of await self.clients.matchAll({
+    // Sometimes the client that triggered the current fetch()
+    // event is considered uncontrolled in Google Chrome. This
+    // only happens on the first few fetches() after the initial
+    // registration of the service worker.
+    includeUncontrolled: !0
+  }))
+    n.postMessage({
+      ...e,
+      /**
+       * Attach the scope with a URL starting with `/scope:` to this message.
+       *
+       * We need this mechanics because this worker broadcasts
+       * events to all the listeners across all browser tabs. Scopes
+       * helps WASM workers ignore requests meant for other WASM workers.
+       */
+      scope: t,
+      requestId: o
+    });
+  return o;
+}
+async function S(e, t) {
+  const o = ["GET", "HEAD"].includes(e.method) || "body" in t ? void 0 : await e.blob();
+  return new Request(t.url || e.url, {
+    body: o,
+    method: e.method,
+    headers: e.headers,
+    referrer: e.referrer,
+    referrerPolicy: e.referrerPolicy,
+    mode: e.mode === "navigate" ? "same-origin" : e.mode,
+    credentials: e.credentials,
+    cache: e.cache,
+    redirect: e.redirect,
+    integrity: e.integrity,
+    ...t
+  });
+}
+function U(e) {
+  const t = {};
+  return e.headers.forEach((o, n) => {
+    t[n] = o;
+  }), t;
+}
+export {
+  m as awaitReply,
+  y as broadcastMessageExpectReply,
+  S as cloneRequest,
+  E as convertFetchEventToPHPRequest,
+  d as getNextRequestId,
+  U as getRequestHeaders,
+  g as postMessageExpectReply,
+  w as responseTo
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/web-service-worker",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "PHP.wasm – service worker utils",
   "repository": {
     "type": "git",
@@ -19,16 +19,24 @@
     "access": "public",
     "directory": "../../../dist/packages/php-wasm/web-service-worker"
   },
-  "license": "GPL-2.0-or-later",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs"
+    },
+    "./package.json": "./package.json",
+    "./README.md": "./README.md"
+  },
   "type": "module",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "gitHead": "bb91e62fb28611a9d447a182aff26dcfced2bb2e",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "license": "GPL-2.0-or-later",
+  "gitHead": "c6b9b151a8baf922d23294d953e346458b9616cb",
   "engines": {
     "node": ">=18.18.0",
     "npm": ">=8.11.0"
   },
   "dependencies": {
-    "@php-wasm/scopes": "1.0.16"
+    "@php-wasm/scopes": "1.0.17"
   }
 }

package/README.md

@@ -1,7 +0,0 @@
-# php-wasm-web-service-worker
-
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build php-wasm-web-service-worker` to build the library.

package/src/index.js

@@ -1,3 +0,0 @@
-export * from './utils';
-export * from './messaging';
-//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}

package/src/messaging.js

@@ -1,105 +0,0 @@
-const DEFAULT_RESPONSE_TIMEOUT = 25000;
-let lastRequestId = 0;
-/**
- * Posts a message branded with a unique `requestId` to the given `target`.
- * Then returns the `requestId` so it can be used to await a reply.
- * Effectively, it implements the request/response dynamics on
- * of JavaScript's `postMessage`
- *
- * @example
- *
- * In the main app:
- *
- * ```js
- * import { postMessageExpectReply, awaitReply } from 'php-wasm-browser';
- * const iframeWindow = iframe.contentWindow;
- * const requestId = postMessageExpectReply(iframeWindow, {
- *    type: "get_php_version"
- * });
- * const response = await awaitReply(iframeWindow, requestId);
- * console.log(response);
- * // "8.0.24"
- * ```
- *
- * In the iframe:
- *
- * ```js
- * import { responseTo } from 'php-wasm-browser';
- * window.addEventListener('message', (event) => {
- *    let response = '8.0.24';
- *    if(event.data.type === 'get_php_version') {
- *       response = '8.0.24';
- *    } else {
- *       throw new Error(`Unexpected message type: ${event.data.type}`);
- *    }
- *
- *    // When `requestId` is present, the other thread expects a response:
- *    if (event.data.requestId) {
- *       const response = responseTo(event.data.requestId, response);
- *       window.parent.postMessage(response, event.origin);
- *    }
- * });
- * ```
- *
- * @param  target          An object that has a `postMessage` method.
- * @param  message         A key-value object that can be serialized to JSON.
- * @param  postMessageArgs Additional arguments to pass to `postMessage`.
- * @returns The message ID for awaitReply().
- */
-export function postMessageExpectReply(target, message, ...postMessageArgs) {
-    const requestId = getNextRequestId();
-    target.postMessage({
-        ...message,
-        requestId,
-    }, ...postMessageArgs);
-    return requestId;
-}
-export function getNextRequestId() {
-    return ++lastRequestId;
-}
-/**
- * Awaits a reply to the message with the given ID.
- *
- * @see postMessageExpectReply
- * @throws {@link Error} If the reply is not received within the timeout.
- * @param  messageTarget EventEmitter emitting `message` events, e.g. `window`
- *                       or a `Worker` instance.
- * @param  requestId     The message ID returned by postMessageExpectReply().
- * @param  timeout       The number of milliseconds to wait for a reply before
- *                       throwing an error.
- * @returns The reply from the messageTarget.
- */
-export function awaitReply(messageTarget, requestId, timeout = DEFAULT_RESPONSE_TIMEOUT) {
-    return new Promise((resolve, reject) => {
-        const responseHandler = (event) => {
-            if (event.data.type === 'response' &&
-                event.data.requestId === requestId) {
-                messageTarget.removeEventListener('message', responseHandler);
-                clearTimeout(failOntimeout);
-                resolve(event.data.response);
-            }
-        };
-        const failOntimeout = setTimeout(() => {
-            reject(new Error('Request timed out'));
-            messageTarget.removeEventListener('message', responseHandler);
-        }, timeout);
-        messageTarget.addEventListener('message', responseHandler);
-    });
-}
-/**
- * Creates a response message to the given message ID.
- *
- * @see postMessageExpectReply
- * @param  requestId The message ID sent from the other thread by
- *                   `postMessageExpectReply` in the `message` event.
- * @param  response  The response to send back to the messageTarget.
- * @returns A message object that can be sent back to the other thread.
- */
-export function responseTo(requestId, response) {
-    return {
-        type: 'response',
-        requestId,
-        response,
-    };
-}
-//# sourceMappingURL=messaging.js.map

package/src/messaging.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/messaging.ts"],"names":[],"mappings":"AAAA,MAAM,wBAAwB,GAAG,KAAK,CAAC;AAEvC,IAAI,aAAa,GAAG,CAAC,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAAyB,EACzB,OAA4B,EAC5B,GAAG,eAAsB;IAEzB,MAAM,SAAS,GAAG,gBAAgB,EAAE,CAAC;IACrC,MAAM,CAAC,WAAW,CACjB;QACC,GAAG,OAAO;QACV,SAAS;KACT,EACD,GAAG,eAAe,CAClB,CAAC;IACF,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC/B,OAAO,EAAE,aAAa,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACzB,aAAoC,EACpC,SAAiB,EACjB,UAAkB,wBAAwB;IAE1C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,CAAC,KAAmB,EAAE,EAAE;YAC/C,IACC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU;gBAC9B,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EACjC,CAAC;gBACF,aAAa,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;gBAC9D,YAAY,CAAC,aAAa,CAAC,CAAC;gBAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC,CAAC;QAEF,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;YACrC,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;YACvC,aAAa,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAC/D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,aAAa,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACzB,SAAiB,EACjB,QAAW;IAEX,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,SAAS;QACT,QAAQ;KACR,CAAC;AACH,CAAC"}

package/src/utils.js

@@ -1,168 +0,0 @@
-/// <reference lib="WebWorker" />
-import { awaitReply, getNextRequestId } from './messaging';
-import { getURLScope, isURLScoped, setURLScope } from '@php-wasm/scopes';
-export async function convertFetchEventToPHPRequest(event) {
-    let url = new URL(event.request.url);
-    if (!isURLScoped(url)) {
-        try {
-            const referrerUrl = new URL(event.request.referrer);
-            url = setURLScope(url, getURLScope(referrerUrl));
-        }
-        catch (e) {
-            // ignore
-        }
-    }
-    const contentType = event.request.headers.get('content-type');
-    const body = event.request.method === 'POST'
-        ? new Uint8Array(await event.request.clone().arrayBuffer())
-        : undefined;
-    const requestHeaders = {};
-    for (const pair of event.request.headers.entries()) {
-        requestHeaders[pair[0]] = pair[1];
-    }
-    let phpResponse;
-    try {
-        const message = {
-            method: 'request',
-            args: [
-                {
-                    body,
-                    url: url.toString(),
-                    method: event.request.method,
-                    headers: {
-                        ...requestHeaders,
-                        Host: url.host,
-                        // Safari and Firefox don't make the User-Agent header
-                        // available in the fetch event. Let's add it manually:
-                        'User-agent': self.navigator.userAgent,
-                        'Content-type': contentType,
-                    },
-                },
-            ],
-        };
-        const scope = getURLScope(url);
-        if (scope === null) {
-            throw new Error(`The URL ${url.toString()} is not scoped. This should not happen.`);
-        }
-        const requestId = await broadcastMessageExpectReply(message, scope);
-        phpResponse = await awaitReply(self, requestId);
-        // X-frame-options gets in a way when PHP is
-        // being displayed in an iframe.
-        delete phpResponse.headers['x-frame-options'];
-    }
-    catch (e) {
-        console.error(e, { url: url.toString() });
-        throw e;
-    }
-    /**
-     * Safari has a bug that prevents Service Workers from redirecting relative URLs.
-     * When attempting to redirect to a relative URL, the network request will return an error.
-     * See the Webkit bug for details: https://bugs.webkit.org/show_bug.cgi?id=282427.
-     *
-     * Because PHP and WordPress can redirect to both relative and absolute URLs
-     * using the `location` header we need to ensure redirects are processed
-     * correctly by the Service Worker.
-     *
-     * As a workaround for Safari Service Workers, we use `Response.redirect()`
-     * for all redirect responses (300-399 status codes) coming from PHP.
-     * This solution was suggested in the Webkit bug comment:
-     * https://bugs.webkit.org/show_bug.cgi?id=282427#c2
-     */
-    if (phpResponse.httpStatusCode >= 300 &&
-        phpResponse.httpStatusCode <= 399 &&
-        phpResponse.headers['location']) {
-        return Response.redirect(phpResponse.headers['location'][0], phpResponse.httpStatusCode);
-    }
-    return new Response(phpResponse.bytes, {
-        headers: phpResponse.headers,
-        status: phpResponse.httpStatusCode,
-    });
-}
-/**
- * Sends the message to all the controlled clients
- * of this service worker.
- *
- * This used to be implemented with a BroadcastChannel, but
- * it didn't work in Safari. BroadcastChannel breaks iframe
- * embedding the playground in Safari.
- *
- * Weirdly, Safari does not pass any messages from the ServiceWorker
- * to Window if the page is rendered inside an iframe. Window to Service
- * Worker communication works just fine.
- *
- * The regular client.postMessage() communication works perfectly, so that's
- * what this function uses to broadcast the message.
- *
- * @param  message The message to broadcast.
- * @param  scope   Target web worker scope.
- * @returns The request ID to receive the reply.
- */
-export async function broadcastMessageExpectReply(message, scope) {
-    const requestId = getNextRequestId();
-    for (const client of await self.clients.matchAll({
-        // Sometimes the client that triggered the current fetch()
-        // event is considered uncontrolled in Google Chrome. This
-        // only happens on the first few fetches() after the initial
-        // registration of the service worker.
-        includeUncontrolled: true,
-    })) {
-        client.postMessage({
-            ...message,
-            /**
-             * Attach the scope with a URL starting with `/scope:` to this message.
-             *
-             * We need this mechanics because this worker broadcasts
-             * events to all the listeners across all browser tabs. Scopes
-             * helps WASM workers ignore requests meant for other WASM workers.
-             */
-            scope,
-            requestId,
-        });
-    }
-    return requestId;
-}
-/**
- * Copy a request with custom overrides.
- *
- * This function is only needed because Request properties
- * are read-only. The only way to change e.g. a URL is to
- * create an entirely new request:
- *
- * https://developer.mozilla.org/en-US/docs/Web/API/Request
- *
- * @param  request
- * @param  overrides
- * @returns The new request.
- */
-export async function cloneRequest(request, overrides) {
-    const body = ['GET', 'HEAD'].includes(request.method) || 'body' in overrides
-        ? undefined
-        : await request.blob();
-    return new Request(overrides['url'] || request.url, {
-        body,
-        method: request.method,
-        headers: request.headers,
-        referrer: request.referrer,
-        referrerPolicy: request.referrerPolicy,
-        mode: request.mode === 'navigate' ? 'same-origin' : request.mode,
-        credentials: request.credentials,
-        cache: request.cache,
-        redirect: request.redirect,
-        integrity: request.integrity,
-        ...overrides,
-    });
-}
-/**
- * Extracts headers from a Request as a plain key->value JS object.
- *
- * @param request
- * @returns
- */
-export function getRequestHeaders(request) {
-    const headers = {};
-    request.headers.forEach((value, key) => {
-        headers[key] = value;
-    });
-    return headers;
-}
-//# sourceMappingURL=utils.js.map

package/src/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../packages/php-wasm/web-service-worker/src/utils.ts"],"names":[],"mappings":"AAAA,iCAAiC;AAGjC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEzE,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,KAAiB;IACpE,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAErC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,CAAC;YACJ,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,WAAW,CAAE,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,SAAS;QACV,CAAC;IACF,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAE,CAAC;IAC/D,MAAM,IAAI,GACT,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM;QAC9B,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC;QAC3D,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,cAAc,GAA2B,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAK,KAAK,CAAC,OAAO,CAAC,OAAe,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7D,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,WAAW,CAAC;IAChB,IAAI,CAAC;QACJ,MAAM,OAAO,GAAG;YACf,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE;gBACL;oBACC,IAAI;oBACJ,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;oBACnB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM;oBAC5B,OAAO,EAAE;wBACR,GAAG,cAAc;wBACjB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,sDAAsD;wBACtD,uDAAuD;wBACvD,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;wBACtC,cAAc,EAAE,WAAW;qBAC3B;iBACD;aACD;SACD,CAAC;QACF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACd,WAAW,GAAG,CAAC,QAAQ,EAAE,yCAAyC,CAClE,CAAC;QACH,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,2BAA2B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpE,WAAW,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAEhD,4CAA4C;QAC5C,gCAAgC;QAChC,OAAO,WAAW,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IACC,WAAW,CAAC,cAAc,IAAI,GAAG;QACjC,WAAW,CAAC,cAAc,IAAI,GAAG;QACjC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAC9B,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CACvB,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAClC,WAAW,CAAC,cAAc,CAC1B,CAAC;IACH,CAAC;IAED,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE;QACtC,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,MAAM,EAAE,WAAW,CAAC,cAAc;KAClC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,OAAY,EAAE,KAAa;IAC5E,MAAM,SAAS,GAAG,gBAAgB,EAAE,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAChD,0DAA0D;QAC1D,0DAA0D;QAC1D,4DAA4D;QAC5D,sCAAsC;QACtC,mBAAmB,EAAE,IAAI;KACzB,CAAC,EAAE,CAAC;QACJ,MAAM,CAAC,WAAW,CAAC;YAClB,GAAG,OAAO;YACV;;;;;;eAMG;YACH,KAAK;YACL,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CACjC,OAAgB,EAChB,SAA8B;IAE9B,MAAM,IAAI,GACT,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,SAAS;QAC9D,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IAEzB,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE;QACnD,IAAI;QACJ,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI;QAChE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,GAAG,SAAS;KACZ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IACjD,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;QACtD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AAChB,CAAC"}