The component renders to a simple file picker input element. Clicking opens a file dialog. On supporting mobile devices the camera is started to take a picture. The selected images are directly scanned and positive results are indicated by the detect event. You can also select multiple images at the same time (still one event per image though). If no QR code can be recognized an empty array is emitted.
The structure of the event payload is the same as for the detect event on QrcodeStream.
Because the input element is the root element of the component and because Vue components accept fallthrough attributes you can make use of any valid input attribute:
html
<qrcode-capture disabled />
You can also override attributes. To remove attributes, set them to null:
You can drag-and-drop image files from your desktop or images embedded into other web pages anywhere in the area the component occupies. The images are directly scanned and positive results are indicated by the detect event. You can also drop multiple images at the same time (still one event per image though). If no QR code can be recognized an empty array is emitted.
The structure of the event payload is the same as for the detect event on QrcodeStream.
methods: {
+ onError (error) {
+ if (error.name === 'DropImageFetchError') {
+ // drag-and-dropped URL (probably just an <img> element) from different
+ // domain without CORS header caused same-origin-policy violation
+ } else if (error.name === 'DropImageDecodeError') {
+ // drag-and-dropped file is not of type image and can't be decoded
+ } else {
+ // idk, open an issue ¯\_(ツ)_/¯
+ }
+ }
+}
When the user is dragging something over the the component you might want to apply some emphasizing styling. Do that by reacting to the dragover event.
The payload is an array of one or multiple detected codes (only QR codes supported at the moment). The structure of the array items is accroding to the Barcode Detection API spec. Here is an example:
If you scan the same QR code multiple times in a row, detect is still only emitted once. When you hold a QR code in the camera, frames are actually decoded multiple times a second but you don't want to be flooded with detect events that often. That's why the last decoded QR code is always cached and only new results are propagated. However changing the value of paused resets this internal cache.
It might take a while before the component is ready and the scanning process starts. The user has to be asked for camera access permission first and the camera stream has to be loaded.
If you want to show a loading indicator, you can listen for the camera-on event. It's emitted as soon as the camera start streaming.
It carries a promise which resolves with the cameras MediaTrackCapabilities when everything is ready.
In Chrome you can't prompt users for permissions a second time. Once denied, users can only manually grant them. Make sure your users understand why you need access to their camera before you mount this component. Otherwise they might panic and deny and then get frustrated because they don't know how to change their decision.
Emitted whenever the camera is turned off. This happens whenever the camera constraints are modified and the camera has to be restarted or a different camera is started. For example when switching between front and rear camera.
Error events are emitted in particular when camera initialization fails. This can happen a couple of reasons.
html
<qrcode-stream @error="onError"></qrcode-stream>
javascript
methods: {
+ onError(error) {
+ if (error.name === 'NotAllowedError') {
+ // user denied camera access permission
+ } else if (error.name === 'NotFoundError') {
+ // no suitable camera device installed
+ } else if (error.name === 'NotSupportedError') {
+ // page is not served over HTTPS (or localhost)
+ } else if (error.name === 'NotReadableError') {
+ // maybe camera is already in use
+ } else if (error.name === 'OverconstrainedError') {
+ // did you request the front camera although there is none?
+ } else if (error.name === 'StreamApiNotSupportedError') {
+ // browser seems to be lacking features
+ }
+ }
+}
Setting this prop to true freezes the camera. Useful if you want to show some microinteraction after successful scans. When you unpause the camera is restarted so the camera-on event is emitted again.
You can visually highlight detected QR codes in real-time. A transparent canvas overlays the camera stream. When a QR code is detected, its location is painted to the canvas.
To enable this feature, pass a function to track that defines how this should look like. This function is called to produce each frame. It receives the location object as the first argument and a CanvasRenderingContext2D instance as the second argument.
Note that this scanning frequency has to be increased. So if you want to go easy on your target device you might not want to enable tracking.
DANGER
Avoid access to reactive properties in this function (like stuff in data, computed or your Vuex store). The function is called several times a second and might cause memory leaks. To be safe don't access this at all.
Every time the prop is modified, a new camera stream is requested so the camera-on event is emitted again. You can catch errors with the error event. An error can occur for example when you try to use the front camera on a device that doesn't have one.
With the torch prop you can turn a devices flashlight on/off. This is not consistently supported by all devices and browsers. Support can even vary on the same device with the same browser. For example the rear camera often has a flashlight but the front camera doesn't. We can only tell if flashlight control is supported once the camera is loaded and the camera-on event has been emitted. At the moment, torch silently fails on unsupported devices. But from the camera-on events payload you can access the MediaTrackCapabilities object. This will tell you whether or not torch is supported.
Due to API limitations the camera stream must be reloaded when turning the torch on/off. That means the camera-on event will be emitted again.
Any distributed content overlays the camera stream, wrapped in a position: absolute container.
html
<qrcode-stream>
+ <b>stuff here overlays the camera stream</b>
+</qrcode-stream>
+
+
+
+
\ No newline at end of file
diff --git a/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.js b/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.js
new file mode 100644
index 00000000..e6ec39de
--- /dev/null
+++ b/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.js
@@ -0,0 +1,10 @@
+import{_ as n,a as l,b as o,c as r,d as h}from"./chunks/safari_32x32.yJUh4Fxj.js";import{_ as p,D as d,c,k as e,a as t,I as a,R as i,o as k}from"./chunks/framework.lXWH-C-d.js";const I=JSON.parse('{"title":"QrcodeCapture","description":"","frontmatter":{},"headers":[],"relativePath":"api/QrcodeCapture.md","filePath":"api/QrcodeCapture.md","lastUpdated":1708022193000}'),u={name:"api/QrcodeCapture.md"},g=i('
The component renders to a simple file picker input element. Clicking opens a file dialog. On supporting mobile devices the camera is started to take a picture. The selected images are directly scanned and positive results are indicated by the detect event. You can also select multiple images at the same time (still one event per image though). If no QR code can be recognized an empty array is emitted.
The structure of the event payload is the same as for the detect event on QrcodeStream.
',10),m={id:"decode",tabindex:"-1"},E=e("code",null,"decode",-1),y=e("a",{class:"header-anchor",href:"#decode","aria-label":'Permalink to "`decode` "'},"",-1),_=e("p",null,[t("Use "),e("code",null,"detect"),t(" instead. TODO: link old docs.")],-1),b=e("h2",{id:"props",tabindex:"-1"},[t("Props "),e("a",{class:"header-anchor",href:"#props","aria-label":'Permalink to "Props"'},"")],-1),f={id:"formats",tabindex:"-1"},v=e("code",null,"formats",-1),F=e("a",{class:"header-anchor",href:"#formats","aria-label":'Permalink to "`formats` "'},"",-1),C=i(`
Payload Type:BarcodeDetectorOptions['formats']
Default:['qr_code']
The formats prop defines which barcode formats are detected. Supported Formats.
Because the input element is the root element of the component and because Vue components accept fallthrough attributes you can make use of any valid input attribute:
html
<qrcode-capture disabled />
You can also override attributes. To remove attributes, set them to null:
`,12);function q(x,B,T,P,S,A){const s=d("Badge");return k(),c("div",null,[g,e("h3",m,[E,t(),a(s,{text:"removed in v5.0.0",type:"danger"}),t(),y]),_,b,e("h3",f,[v,t(),a(s,{text:"since v5.3.0",type:"info"}),t(),F]),C])}const Q=p(u,[["render",q]]);export{I as __pageData,Q as default};
diff --git a/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.lean.js b/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.lean.js
new file mode 100644
index 00000000..80a10aa5
--- /dev/null
+++ b/pr-preview/pr-422/assets/api_QrcodeCapture.md.CLytv12W.lean.js
@@ -0,0 +1 @@
+import{_ as n,a as l,b as o,c as r,d as h}from"./chunks/safari_32x32.yJUh4Fxj.js";import{_ as p,D as d,c,k as e,a as t,I as a,R as i,o as k}from"./chunks/framework.lXWH-C-d.js";const I=JSON.parse('{"title":"QrcodeCapture","description":"","frontmatter":{},"headers":[],"relativePath":"api/QrcodeCapture.md","filePath":"api/QrcodeCapture.md","lastUpdated":1708022193000}'),u={name:"api/QrcodeCapture.md"},g=i("",10),m={id:"decode",tabindex:"-1"},E=e("code",null,"decode",-1),y=e("a",{class:"header-anchor",href:"#decode","aria-label":'Permalink to "`decode` "'},"",-1),_=e("p",null,[t("Use "),e("code",null,"detect"),t(" instead. TODO: link old docs.")],-1),b=e("h2",{id:"props",tabindex:"-1"},[t("Props "),e("a",{class:"header-anchor",href:"#props","aria-label":'Permalink to "Props"'},"")],-1),f={id:"formats",tabindex:"-1"},v=e("code",null,"formats",-1),F=e("a",{class:"header-anchor",href:"#formats","aria-label":'Permalink to "`formats` "'},"",-1),C=i("",12);function q(x,B,T,P,S,A){const s=d("Badge");return k(),c("div",null,[g,e("h3",m,[E,t(),a(s,{text:"removed in v5.0.0",type:"danger"}),t(),y]),_,b,e("h3",f,[v,t(),a(s,{text:"since v5.3.0",type:"info"}),t(),F]),C])}const Q=p(u,[["render",q]]);export{I as __pageData,Q as default};
diff --git a/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.js b/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.js
new file mode 100644
index 00000000..5c49535b
--- /dev/null
+++ b/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.js
@@ -0,0 +1,30 @@
+import{_ as n,a as l,b as r,c as h,d as p}from"./chunks/safari_32x32.yJUh4Fxj.js";import{_ as o,D as d,c as k,k as s,a as e,I as t,R as a,o as c}from"./chunks/framework.lXWH-C-d.js";const N=JSON.parse('{"title":"QrcodeDropZone","description":"","frontmatter":{},"headers":[],"relativePath":"api/QrcodeDropZone.md","filePath":"api/QrcodeDropZone.md","lastUpdated":1703524587000}'),g={name:"api/QrcodeDropZone.md"},E=a('
You can drag-and-drop image files from your desktop or images embedded into other web pages anywhere in the area the component occupies. The images are directly scanned and positive results are indicated by the detect event. You can also drop multiple images at the same time (still one event per image though). If no QR code can be recognized an empty array is emitted.
The structure of the event payload is the same as for the detect event on QrcodeStream.
',9),y={id:"error",tabindex:"-1"},u=s("code",null,"error",-1),m=s("a",{class:"header-anchor",href:"#error","aria-label":'Permalink to "`error` "'},"",-1),_=a(`
Error events are emitted when a dropped url can't be fetched due to CORS or a dropped file has an unsupported file type.
methods: {
+ onError (error) {
+ if (error.name === 'DropImageFetchError') {
+ // drag-and-dropped URL (probably just an <img> element) from different
+ // domain without CORS header caused same-origin-policy violation
+ } else if (error.name === 'DropImageDecodeError') {
+ // drag-and-dropped file is not of type image and can't be decoded
+ } else {
+ // idk, open an issue ¯\\_(ツ)_/¯
+ }
+ }
+}
`,3),v={id:"formats",tabindex:"-1"},b=s("code",null,"formats",-1),f=s("a",{class:"header-anchor",href:"#formats","aria-label":'Permalink to "`formats` "'},"",-1),D=a(`
Payload Type:BarcodeDetectorOptions['formats']
Default:['qr_code']
The formats prop defines which barcode formats are detected. Supported Formats.
When the user is dragging something over the the component you might want to apply some emphasizing styling. Do that by reacting to the dragover event.
`,9),F={id:"decode",tabindex:"-1"},A=s("code",null,"decode",-1),C=s("a",{class:"header-anchor",href:"#decode","aria-label":'Permalink to "`decode` "'},"",-1),q=a(`
`,8);function T(x,B,P,S,I,w){const i=d("Badge");return c(),k("div",null,[E,s("h3",y,[u,e(),t(i,{text:"new in v5.0.0",type:"info"}),e(),m]),_,s("h3",v,[b,e(),t(i,{text:"since v5.3.0",type:"info"}),e(),f]),D,s("h3",F,[A,e(),t(i,{text:"removed in v5.0.0",type:"danger"}),e(),C]),q])}const O=o(g,[["render",T]]);export{N as __pageData,O as default};
diff --git a/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.lean.js b/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.lean.js
new file mode 100644
index 00000000..63d59fac
--- /dev/null
+++ b/pr-preview/pr-422/assets/api_QrcodeDropZone.md.6Vhi9BoD.lean.js
@@ -0,0 +1 @@
+import{_ as n,a as l,b as r,c as h,d as p}from"./chunks/safari_32x32.yJUh4Fxj.js";import{_ as o,D as d,c as k,k as s,a as e,I as t,R as a,o as c}from"./chunks/framework.lXWH-C-d.js";const N=JSON.parse('{"title":"QrcodeDropZone","description":"","frontmatter":{},"headers":[],"relativePath":"api/QrcodeDropZone.md","filePath":"api/QrcodeDropZone.md","lastUpdated":1703524587000}'),g={name:"api/QrcodeDropZone.md"},E=a("",9),y={id:"error",tabindex:"-1"},u=s("code",null,"error",-1),m=s("a",{class:"header-anchor",href:"#error","aria-label":'Permalink to "`error` "'},"",-1),_=a("",3),v={id:"formats",tabindex:"-1"},b=s("code",null,"formats",-1),f=s("a",{class:"header-anchor",href:"#formats","aria-label":'Permalink to "`formats` "'},"",-1),D=a("",9),F={id:"decode",tabindex:"-1"},A=s("code",null,"decode",-1),C=s("a",{class:"header-anchor",href:"#decode","aria-label":'Permalink to "`decode` "'},"",-1),q=a("",8);function T(x,B,P,S,I,w){const i=d("Badge");return c(),k("div",null,[E,s("h3",y,[u,e(),t(i,{text:"new in v5.0.0",type:"info"}),e(),m]),_,s("h3",v,[b,e(),t(i,{text:"since v5.3.0",type:"info"}),e(),f]),D,s("h3",F,[A,e(),t(i,{text:"removed in v5.0.0",type:"danger"}),e(),C]),q])}const O=o(g,[["render",T]]);export{N as __pageData,O as default};
diff --git a/pr-preview/pr-422/assets/api_QrcodeStream.md.6U_wzjIZ.js b/pr-preview/pr-422/assets/api_QrcodeStream.md.6U_wzjIZ.js
new file mode 100644
index 00000000..15022555
--- /dev/null
+++ b/pr-preview/pr-422/assets/api_QrcodeStream.md.6U_wzjIZ.js
@@ -0,0 +1,100 @@
+import{_ as n,a as h,b as l,c as p,d as r}from"./chunks/safari_32x32.yJUh4Fxj.js";import{_ as k,D as o,c as d,k as s,a as i,I as e,R as t,o as c}from"./chunks/framework.lXWH-C-d.js";const ps=JSON.parse('{"title":"QrcodeStream","description":"","frontmatter":{},"headers":[],"relativePath":"api/QrcodeStream.md","filePath":"api/QrcodeStream.md","lastUpdated":1707952687000}'),E={name:"api/QrcodeStream.md"},g=t('
The payload is an array of one or multiple detected codes (only QR codes supported at the moment). The structure of the array items is accroding to the Barcode Detection API spec. Here is an example:
If you scan the same QR code multiple times in a row, detect is still only emitted once. When you hold a QR code in the camera, frames are actually decoded multiple times a second but you don't want to be flooded with detect events that often. That's why the last decoded QR code is always cached and only new results are propagated. However changing the value of paused resets this internal cache.
`,14),y={id:"formats",tabindex:"-1"},u=s("code",null,"formats",-1),m=s("a",{class:"header-anchor",href:"#formats","aria-label":'Permalink to "`formats` "'},"",-1),F=t('
Payload Type:BarcodeDetectorOptions['formats']
Default:['qr_code']
The formats prop defines which barcode formats are detected. Supported Formats.
',3),C={id:"camera-on",tabindex:"-1"},f=s("code",null,"camera-on",-1),b=s("a",{class:"header-anchor",href:"#camera-on","aria-label":'Permalink to "`camera-on` "'},"",-1),_=t(`
Payload Type:Promise<MediaTrackCapabilities>
It might take a while before the component is ready and the scanning process starts. The user has to be asked for camera access permission first and the camera stream has to be loaded.
If you want to show a loading indicator, you can listen for the camera-on event. It's emitted as soon as the camera start streaming.
It carries a promise which resolves with the cameras MediaTrackCapabilities when everything is ready.
In Chrome you can't prompt users for permissions a second time. Once denied, users can only manually grant them. Make sure your users understand why you need access to their camera before you mount this component. Otherwise they might panic and deny and then get frustrated because they don't know how to change their decision.
`,7),v={id:"camera-off",tabindex:"-1"},q=s("code",null,"camera-off",-1),B=s("a",{class:"header-anchor",href:"#camera-off","aria-label":'Permalink to "`camera-off` "'},"",-1),A=s("ul",null,[s("li",null,[s("strong",null,"Payload Type:"),i(),s("code",null,"void")])],-1),D=s("p",null,"Emitted whenever the camera is turned off. This happens whenever the camera constraints are modified and the camera has to be restarted or a different camera is started. For example when switching between front and rear camera.",-1),T={id:"error",tabindex:"-1"},x=s("code",null,"error",-1),w=s("a",{class:"header-anchor",href:"#error","aria-label":'Permalink to "`error` "'},"",-1),S=t(`
Payload Type:Error
Error events are emitted in particular when camera initialization fails. This can happen a couple of reasons.
html
<qrcode-stream @error="onError"></qrcode-stream>
javascript
methods: {
+ onError(error) {
+ if (error.name === 'NotAllowedError') {
+ // user denied camera access permission
+ } else if (error.name === 'NotFoundError') {
+ // no suitable camera device installed
+ } else if (error.name === 'NotSupportedError') {
+ // page is not served over HTTPS (or localhost)
+ } else if (error.name === 'NotReadableError') {
+ // maybe camera is already in use
+ } else if (error.name === 'OverconstrainedError') {
+ // did you request the front camera although there is none?
+ } else if (error.name === 'StreamApiNotSupportedError') {
+ // browser seems to be lacking features
+ }
+ }
+}
`,4),P={id:"decode",tabindex:"-1"},I=s("code",null,"decode",-1),R=s("a",{class:"header-anchor",href:"#decode","aria-label":'Permalink to "`decode` "'},"",-1),N=s("p",null,[i("Use "),s("code",null,"detect"),i(" instead.")],-1),j=s("p",null,[s("a",{href:"https://github.com/gruhn/vue-qrcode-reader/blob/781484fccd186e8e30c6191f85beec3bd174ef59/docs/api/QrcodeStream.md",target:"_blank",rel:"noreferrer"},"docs for v4.0.0")],-1),M={id:"init",tabindex:"-1"},V=s("code",null,"init",-1),Q=s("a",{class:"header-anchor",href:"#init","aria-label":'Permalink to "`init` "'},"",-1),O=s("p",null,[i("Use "),s("code",null,"camera-on"),i("/"),s("code",null,"error"),i(" instead.")],-1),W=s("p",null,[s("a",{href:"https://github.com/gruhn/vue-qrcode-reader/blob/781484fccd186e8e30c6191f85beec3bd174ef59/docs/api/QrcodeStream.md",target:"_blank",rel:"noreferrer"},"docs for v4.0.0")],-1),U={id:"camera",tabindex:"-1"},H=s("code",null,"camera",-1),Y=s("a",{class:"header-anchor",href:"#camera","aria-label":'Permalink to "`camera` "'},"",-1),z=s("p",null,[i("Use "),s("code",null,"constraints"),i(" instead.")],-1),$=s("p",null,[s("a",{href:"https://github.com/gruhn/vue-qrcode-reader/blob/781484fccd186e8e30c6191f85beec3bd174ef59/docs/api/QrcodeStream.md",target:"_blank",rel:"noreferrer"},"docs for v4.0.0")],-1),G=s("h2",{id:"props",tabindex:"-1"},[i("Props "),s("a",{class:"header-anchor",href:"#props","aria-label":'Permalink to "Props"'},"")],-1),J={id:"paused",tabindex:"-1"},K=s("code",null,"paused",-1),L=s("a",{class:"header-anchor",href:"#paused","aria-label":'Permalink to "`paused` "'},"",-1),X=t(`
Input Type:Boolean
Default:false
Setting this prop to true freezes the camera. Useful if you want to show some microinteraction after successful scans. When you unpause the camera is restarted so the camera-on event is emitted again.
You can visually highlight detected QR codes in real-time. A transparent canvas overlays the camera stream. When a QR code is detected, its location is painted to the canvas.
To enable this feature, pass a function to track that defines how this should look like. This function is called to produce each frame. It receives the location object as the first argument and a CanvasRenderingContext2D instance as the second argument.
Note that this scanning frequency has to be increased. So if you want to go easy on your target device you might not want to enable tracking.
DANGER
Avoid access to reactive properties in this function (like stuff in data, computed or your Vuex store). The function is called several times a second and might cause memory leaks. To be safe don't access this at all.
Every time the prop is modified, a new camera stream is requested so the camera-on event is emitted again. You can catch errors with the error event. An error can occur for example when you try to use the front camera on a device that doesn't have one.
With the torch prop you can turn a devices flashlight on/off. This is not consistently supported by all devices and browsers. Support can even vary on the same device with the same browser. For example the rear camera often has a flashlight but the front camera doesn't. We can only tell if flashlight control is supported once the camera is loaded and the camera-on event has been emitted. At the moment, torch silently fails on unsupported devices. But from the camera-on events payload you can access the MediaTrackCapabilities object. This will tell you whether or not torch is supported.
Due to API limitations the camera stream must be reloaded when turning the torch on/off. That means the camera-on event will be emitted again.
`,2),R=JSON.parse('{"title":"Decode by Drag&Drop","description":"","frontmatter":{},"headers":[],"relativePath":"demos/DragDrop.md","filePath":"demos/DragDrop.md","lastUpdated":1621091954000}'),z={name:"demos/DragDrop.md"},Z=F({...z,setup(s){return(h,g)=>{const p=C("ClientOnly");return r(),E("div",null,[V,P,y(p,null,{default:D(()=>[y(f,{component:I})]),_:1}),U])}}});export{R as __pageData,Z as default};
diff --git a/pr-preview/pr-422/assets/demos_DragDrop.md.pKahbeZR.lean.js b/pr-preview/pr-422/assets/demos_DragDrop.md.pKahbeZR.lean.js
new file mode 100644
index 00000000..a972b6d1
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_DragDrop.md.pKahbeZR.lean.js
@@ -0,0 +1,86 @@
+import{p as B,a as m,_ as f}from"./chunks/camera.k0qov-UY.js";import{d as F,o as r,c as E,r as v,a2 as e,_ as A,D as C,k as t,a as d,t as c,e as _,I as y,w as D,n as q,R as b}from"./chunks/framework.lXWH-C-d.js";const O=F({__name:"QrcodeDropZone",props:{formats:{type:Array,default:()=>["qr_code"]}},emits:["detect","dragover","error"],setup(s,{emit:h}){const g=s,p=h,n=async a=>{try{const i=await a;p("detect",i)}catch(i){p("error",i)}},l=a=>{p("dragover",a)},o=({dataTransfer:a})=>{if(!a)return;l(!1);const i=[...Array.from(a.files)],k=a.getData("text/uri-list");i.forEach(u=>{n(B(u))}),k!==""&&n(m(k,g.formats))};return(a,i)=>(r(),E("div",{onDrop:e(o,["prevent","stop"]),onDragenter:i[0]||(i[0]=e(k=>l(!0),["prevent","stop"])),onDragleave:i[1]||(i[1]=e(k=>l(!1),["prevent","stop"])),onDragover:i[2]||(i[2]=e(()=>{},["prevent","stop"]))},[v(a.$slots,"default")],32))}}),S={components:{QrcodeDropZone:O},data(){return{result:null,error:null,dragover:!1}},methods:{onDetect(s){console.log(s),this.result=JSON.stringify(s.map(h=>h.rawValue))},logErrors(s){s.name==="DropImageFetchError"?this.error="Sorry, you can't load cross-origin images :/":s.name==="DropImageDecodeError"?this.error="Ok, that's not an image. That can't be decoded.":this.error="Ups, what kind of error is this?! "+s.message},onDragOver(s){this.dragover=s}}},x={class:"decode-result"},w={key:0,class:"drop-error"};function N(s,h,g,p,n,l){const o=C("qrcode-drop-zone");return r(),E("div",null,[t("p",x,[d(" Last result: "),t("b",null,c(n.result),1)]),n.error!==null?(r(),E("p",w,c(n.error),1)):_("",!0),y(o,{onDetect:l.onDetect,onDragover:l.onDragOver,onError:l.logErrors},{default:D(()=>[t("div",{class:q(["drop-area",{dragover:n.dragover}])}," DROP SOME IMAGES HERE ",2)]),_:1},8,["onDetect","onDragover","onError"])])}const I=A(S,[["render",N]]),V=t("h1",{id:"decode-by-drag-drop",tabindex:"-1"},[d("Decode by Drag&Drop "),t("a",{class:"header-anchor",href:"#decode-by-drag-drop","aria-label":'Permalink to "Decode by Drag&Drop"'},"")],-1),P=t("p",null,[d("With the "),t("code",null,"QrcodeDropZone"),d(" component you can also drag-and-drop images that should be scanned. Use it as a standalone feature or as a fallback for desktop users.")],-1),U=b(`
`,2),R=JSON.parse('{"title":"Decode by Drag&Drop","description":"","frontmatter":{},"headers":[],"relativePath":"demos/DragDrop.md","filePath":"demos/DragDrop.md","lastUpdated":1621091954000}'),z={name:"demos/DragDrop.md"},Z=F({...z,setup(s){return(h,g)=>{const p=C("ClientOnly");return r(),E("div",null,[V,P,y(p,null,{default:D(()=>[y(f,{component:I})]),_:1}),U])}}});export{R as __pageData,Z as default};
diff --git a/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.js b/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.js
new file mode 100644
index 00000000..a8e3d14b
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.js
@@ -0,0 +1,230 @@
+import{_ as N}from"./chunks/camera.k0qov-UY.js";import{d as x,h as r,j as O,g as I,o as t,c as k,k as n,a as c,a4 as B,a5 as v,F as f,E as D,t as o,b as V,m as M,a6 as U,p as $,q as R,_ as H,D as Y,I as b,w as j,R as z}from"./chunks/framework.lXWH-C-d.js";import{_ as W}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const X=d=>($("data-v-be9f9333"),d=d(),R(),d),J=["value"],L=["value"],Q=X(()=>n("br",null,null,-1)),G=["onUpdate:modelValue","id"],K=["for"],Z={class:"error"},ss={class:"decode-result"},is={key:1,class:"error"},as=x({__name:"FullDemo",setup(d){const u=r("");function A(a){console.log(a),u.value=JSON.stringify(a.map(s=>s.rawValue))}const p=r(null),F=r([]);O(async()=>{F.value=(await navigator.mediaDevices.enumerateDevices()).filter(({kind:a})=>a==="videoinput"),F.value.length>0&&(p.value=F.value[0])});function _(a,s){for(const i of a){const[l,...y]=i.cornerPoints;s.strokeStyle="red",s.beginPath(),s.moveTo(l.x,l.y);for(const{x:e,y:E}of y)s.lineTo(e,E);s.lineTo(l.x,l.y),s.closePath(),s.stroke()}}function q(a,s){for(const i of a){const{boundingBox:{x:l,y,width:e,height:E}}=i;s.lineWidth=2,s.strokeStyle="#007bff",s.strokeRect(l,y,e,E)}}function w(a,s){for(const i of a){const{boundingBox:l,rawValue:y}=i,e=l.x+l.width/2,E=l.y+l.height/2,P=Math.max(12,50*l.width/s.canvas.width);s.font=`bold ${P}px sans-serif`,s.textAlign="center",s.lineWidth=3,s.strokeStyle="#35495e",s.strokeText(i.rawValue,e,E),s.fillStyle="#5cb984",s.fillText(y,e,E)}}const m=[{text:"nothing (default)",value:void 0},{text:"outline",value:_},{text:"centered text",value:w},{text:"bounding box",value:q}],C=r(m[1]),g=r({aztec:!1,code_128:!1,code_39:!1,code_93:!1,codabar:!1,databar:!1,databar_expanded:!1,data_matrix:!1,dx_film_edge:!1,ean_13:!1,ean_8:!1,itf:!1,maxi_code:!1,micro_qr_code:!1,pdf417:!1,qr_code:!0,rm_qr_code:!1,upc_a:!1,upc_e:!1,linear_codes:!1,matrix_codes:!1}),S=I(()=>Object.keys(g.value).filter(a=>g.value[a])),h=r("");function T(a){h.value=`[${a.name}]: `,a.name==="NotAllowedError"?h.value+="you need to grant camera access permission":a.name==="NotFoundError"?h.value+="no camera on this device":a.name==="NotSupportedError"?h.value+="secure context required (HTTPS, localhost)":a.name==="NotReadableError"?h.value+="is the camera already in use?":a.name==="OverconstrainedError"?h.value+="installed cameras are not suitable":a.name==="StreamApiNotSupportedError"?h.value+="Stream API is not supported in this browser":a.name==="InsecureContextError"?h.value+="Camera access is only permitted in secure context. Use HTTPS or localhost rather than HTTP.":h.value+=a.message}return(a,s)=>(t(),k("div",null,[n("p",null,[c(" Modern mobile phones often have a variety of different cameras installed (e.g. front, rear, wide-angle, infrared, desk-view). The one picked by default is sometimes not the best choice. If you want fine-grained control, which camera is used, you can enumerate all installed cameras and then pick the one you need based on it's device ID: "),B(n("select",{"onUpdate:modelValue":s[0]||(s[0]=i=>p.value=i)},[(t(!0),k(f,null,D(F.value,i=>(t(),k("option",{key:i.label,value:i},o(i.label),9,J))),128))],512),[[v,p.value]])]),n("p",null,[c(" Detected codes are visually highlighted in real-time. Use the following dropdown to change the flavor: "),B(n("select",{"onUpdate:modelValue":s[1]||(s[1]=i=>C.value=i)},[(t(),k(f,null,D(m,i=>n("option",{key:i.text,value:i},o(i.text),9,L)),64))],512),[[v,C.value]])]),n("p",null,[c(" By default only QR-codes are detected but a variety of other barcode formats are also supported. You can select one or multiple but the more you select the more expensive scanning becomes: "),Q,(t(!0),k(f,null,D(Object.keys(g.value),i=>(t(),k("span",{key:i,class:"barcode-format-checkbox"},[B(n("input",{type:"checkbox","onUpdate:modelValue":l=>g.value[i]=l,id:i},null,8,G),[[U,g.value[i]]]),n("label",{for:i},o(i),9,K)]))),128))]),n("p",Z,o(h.value),1),n("p",ss,[c(" Last result: "),n("b",null,o(u.value),1)]),n("div",null,[p.value!==null?(t(),V(M(W),{key:0,constraints:{deviceId:p.value.deviceId},track:C.value.value,formats:S.value,onError:T,onDetect:A},null,8,["constraints","track","formats"])):(t(),k("p",is," No cameras on this device "))])]))}}),ns=H(as,[["__scopeId","data-v-be9f9333"]]),ls=n("h1",{id:"full-demo",tabindex:"-1"},[c("Full Demo "),n("a",{class:"header-anchor",href:"#full-demo","aria-label":'Permalink to "Full Demo"'},"")],-1),hs=z(`
<template>
+ <div>
+ <p>
+ Modern mobile phones often have a variety of different cameras installed (e.g. front, rear,
+ wide-angle, infrared, desk-view). The one picked by default is sometimes not the best choice.
+ If you want fine-grained control, which camera is used, you can enumerate all installed
+ cameras and then pick the one you need based on it's device ID:
+
+ <select v-model="selectedDevice">
+ <option
+ v-for="device in devices"
+ :key="device.label"
+ :value="device"
+ >
+ {{ device.label }}
+ </option>
+ </select>
+ </p>
+
+ <p>
+ Detected codes are visually highlighted in real-time. Use the following dropdown to change the
+ flavor:
+
+ <select v-model="trackFunctionSelected">
+ <option
+ v-for="option in trackFunctionOptions"
+ :key="option.text"
+ :value="option"
+ >
+ {{ option.text }}
+ </option>
+ </select>
+ </p>
+
+ <p>
+ By default only QR-codes are detected but a variety of other barcode formats are also
+ supported. You can select one or multiple but the more you select the more expensive scanning
+ becomes: <br />
+
+ <span
+ v-for="option in Object.keys(barcodeFormats)"
+ :key="option"
+ class="barcode-format-checkbox"
+ >
+ <input
+ type="checkbox"
+ v-model="barcodeFormats[option]"
+ :id="option"
+ />
+ <label :for="option">{{ option }}</label>
+ </span>
+ </p>
+
+ <p class="error">{{ error }}</p>
+
+ <p class="decode-result">
+ Last result: <b>{{ result }}</b>
+ </p>
+
+ <div>
+ <qrcode-stream
+ :constraints="{ deviceId: selectedDevice.deviceId }"
+ :track="trackFunctionSelected.value"
+ :formats="selectedBarcodeFormats"
+ @error="onError"
+ @detect="onDetect"
+ v-if="selectedDevice !== null"
+ />
+ <p
+ v-else
+ class="error"
+ >
+ No cameras on this device
+ </p>
+ </div>
+ </div>
+</template>
+
+<script setup lang="ts">
+import { ref, computed, onMounted } from 'vue'
+import { QrcodeStream } from '../../../../src'
+
+/*** detection handling ***/
+
+const result = ref('')
+
+function onDetect(detectedCodes) {
+ console.log(detectedCodes)
+ result.value = JSON.stringify(detectedCodes.map((code) => code.rawValue))
+}
+
+/*** select camera ***/
+
+const selectedDevice = ref(null)
+const devices = ref([])
+
+onMounted(async () => {
+ devices.value = (await navigator.mediaDevices.enumerateDevices()).filter(
+ ({ kind }) => kind === 'videoinput'
+ )
+
+ if (devices.value.length > 0) {
+ selectedDevice.value = devices.value[0]
+ }
+})
+
+/*** track functons ***/
+
+function paintOutline(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const [firstPoint, ...otherPoints] = detectedCode.cornerPoints
+
+ ctx.strokeStyle = 'red'
+
+ ctx.beginPath()
+ ctx.moveTo(firstPoint.x, firstPoint.y)
+ for (const { x, y } of otherPoints) {
+ ctx.lineTo(x, y)
+ }
+ ctx.lineTo(firstPoint.x, firstPoint.y)
+ ctx.closePath()
+ ctx.stroke()
+ }
+}
+function paintBoundingBox(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const {
+ boundingBox: { x, y, width, height }
+ } = detectedCode
+
+ ctx.lineWidth = 2
+ ctx.strokeStyle = '#007bff'
+ ctx.strokeRect(x, y, width, height)
+ }
+}
+function paintCenterText(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const { boundingBox, rawValue } = detectedCode
+
+ const centerX = boundingBox.x + boundingBox.width / 2
+ const centerY = boundingBox.y + boundingBox.height / 2
+
+ const fontSize = Math.max(12, (50 * boundingBox.width) / ctx.canvas.width)
+
+ ctx.font = \`bold \${fontSize}px sans-serif\`
+ ctx.textAlign = 'center'
+
+ ctx.lineWidth = 3
+ ctx.strokeStyle = '#35495e'
+ ctx.strokeText(detectedCode.rawValue, centerX, centerY)
+
+ ctx.fillStyle = '#5cb984'
+ ctx.fillText(rawValue, centerX, centerY)
+ }
+}
+const trackFunctionOptions = [
+ { text: 'nothing (default)', value: undefined },
+ { text: 'outline', value: paintOutline },
+ { text: 'centered text', value: paintCenterText },
+ { text: 'bounding box', value: paintBoundingBox }
+]
+const trackFunctionSelected = ref(trackFunctionOptions[1])
+
+/*** barcode formats ***/
+
+const barcodeFormats = ref({
+ aztec: false,
+ code_128: false,
+ code_39: false,
+ code_93: false,
+ codabar: false,
+ databar: false,
+ databar_expanded: false,
+ data_matrix: false,
+ dx_film_edge: false,
+ ean_13: false,
+ ean_8: false,
+ itf: false,
+ maxi_code: false,
+ micro_qr_code: false,
+ pdf417: false,
+ qr_code: true,
+ rm_qr_code: false,
+ upc_a: false,
+ upc_e: false,
+ linear_codes: false,
+ matrix_codes: false
+})
+const selectedBarcodeFormats = computed(() => {
+ return Object.keys(barcodeFormats.value).filter((format) => barcodeFormats.value[format])
+})
+
+/*** error handling ***/
+
+const error = ref('')
+
+function onError(err) {
+ error.value = \`[\${err.name}]: \`
+
+ if (err.name === 'NotAllowedError') {
+ error.value += 'you need to grant camera access permission'
+ } else if (err.name === 'NotFoundError') {
+ error.value += 'no camera on this device'
+ } else if (err.name === 'NotSupportedError') {
+ error.value += 'secure context required (HTTPS, localhost)'
+ } else if (err.name === 'NotReadableError') {
+ error.value += 'is the camera already in use?'
+ } else if (err.name === 'OverconstrainedError') {
+ error.value += 'installed cameras are not suitable'
+ } else if (err.name === 'StreamApiNotSupportedError') {
+ error.value += 'Stream API is not supported in this browser'
+ } else if (err.name === 'InsecureContextError') {
+ error.value +=
+ 'Camera access is only permitted in secure context. Use HTTPS or localhost rather than HTTP.'
+ } else {
+ error.value += err.message
+ }
+}
+</script>
+
+<style scoped>
+.error {
+ font-weight: bold;
+ color: red;
+}
+.barcode-format-checkbox {
+ margin-right: 10px;
+ white-space: nowrap;
+}
+</style>
`,2),Es=JSON.parse('{"title":"Full Demo","description":"","frontmatter":{},"headers":[],"relativePath":"demos/FullDemo.md","filePath":"demos/FullDemo.md","lastUpdated":1707952687000}'),ts={name:"demos/FullDemo.md"},rs=x({...ts,setup(d){return(u,A)=>{const p=Y("ClientOnly");return t(),k("div",null,[ls,b(p,null,{default:j(()=>[b(N,{component:ns})]),_:1}),hs])}}});export{Es as __pageData,rs as default};
diff --git a/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.lean.js b/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.lean.js
new file mode 100644
index 00000000..a8e3d14b
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_FullDemo.md.hnclp-Su.lean.js
@@ -0,0 +1,230 @@
+import{_ as N}from"./chunks/camera.k0qov-UY.js";import{d as x,h as r,j as O,g as I,o as t,c as k,k as n,a as c,a4 as B,a5 as v,F as f,E as D,t as o,b as V,m as M,a6 as U,p as $,q as R,_ as H,D as Y,I as b,w as j,R as z}from"./chunks/framework.lXWH-C-d.js";import{_ as W}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const X=d=>($("data-v-be9f9333"),d=d(),R(),d),J=["value"],L=["value"],Q=X(()=>n("br",null,null,-1)),G=["onUpdate:modelValue","id"],K=["for"],Z={class:"error"},ss={class:"decode-result"},is={key:1,class:"error"},as=x({__name:"FullDemo",setup(d){const u=r("");function A(a){console.log(a),u.value=JSON.stringify(a.map(s=>s.rawValue))}const p=r(null),F=r([]);O(async()=>{F.value=(await navigator.mediaDevices.enumerateDevices()).filter(({kind:a})=>a==="videoinput"),F.value.length>0&&(p.value=F.value[0])});function _(a,s){for(const i of a){const[l,...y]=i.cornerPoints;s.strokeStyle="red",s.beginPath(),s.moveTo(l.x,l.y);for(const{x:e,y:E}of y)s.lineTo(e,E);s.lineTo(l.x,l.y),s.closePath(),s.stroke()}}function q(a,s){for(const i of a){const{boundingBox:{x:l,y,width:e,height:E}}=i;s.lineWidth=2,s.strokeStyle="#007bff",s.strokeRect(l,y,e,E)}}function w(a,s){for(const i of a){const{boundingBox:l,rawValue:y}=i,e=l.x+l.width/2,E=l.y+l.height/2,P=Math.max(12,50*l.width/s.canvas.width);s.font=`bold ${P}px sans-serif`,s.textAlign="center",s.lineWidth=3,s.strokeStyle="#35495e",s.strokeText(i.rawValue,e,E),s.fillStyle="#5cb984",s.fillText(y,e,E)}}const m=[{text:"nothing (default)",value:void 0},{text:"outline",value:_},{text:"centered text",value:w},{text:"bounding box",value:q}],C=r(m[1]),g=r({aztec:!1,code_128:!1,code_39:!1,code_93:!1,codabar:!1,databar:!1,databar_expanded:!1,data_matrix:!1,dx_film_edge:!1,ean_13:!1,ean_8:!1,itf:!1,maxi_code:!1,micro_qr_code:!1,pdf417:!1,qr_code:!0,rm_qr_code:!1,upc_a:!1,upc_e:!1,linear_codes:!1,matrix_codes:!1}),S=I(()=>Object.keys(g.value).filter(a=>g.value[a])),h=r("");function T(a){h.value=`[${a.name}]: `,a.name==="NotAllowedError"?h.value+="you need to grant camera access permission":a.name==="NotFoundError"?h.value+="no camera on this device":a.name==="NotSupportedError"?h.value+="secure context required (HTTPS, localhost)":a.name==="NotReadableError"?h.value+="is the camera already in use?":a.name==="OverconstrainedError"?h.value+="installed cameras are not suitable":a.name==="StreamApiNotSupportedError"?h.value+="Stream API is not supported in this browser":a.name==="InsecureContextError"?h.value+="Camera access is only permitted in secure context. Use HTTPS or localhost rather than HTTP.":h.value+=a.message}return(a,s)=>(t(),k("div",null,[n("p",null,[c(" Modern mobile phones often have a variety of different cameras installed (e.g. front, rear, wide-angle, infrared, desk-view). The one picked by default is sometimes not the best choice. If you want fine-grained control, which camera is used, you can enumerate all installed cameras and then pick the one you need based on it's device ID: "),B(n("select",{"onUpdate:modelValue":s[0]||(s[0]=i=>p.value=i)},[(t(!0),k(f,null,D(F.value,i=>(t(),k("option",{key:i.label,value:i},o(i.label),9,J))),128))],512),[[v,p.value]])]),n("p",null,[c(" Detected codes are visually highlighted in real-time. Use the following dropdown to change the flavor: "),B(n("select",{"onUpdate:modelValue":s[1]||(s[1]=i=>C.value=i)},[(t(),k(f,null,D(m,i=>n("option",{key:i.text,value:i},o(i.text),9,L)),64))],512),[[v,C.value]])]),n("p",null,[c(" By default only QR-codes are detected but a variety of other barcode formats are also supported. You can select one or multiple but the more you select the more expensive scanning becomes: "),Q,(t(!0),k(f,null,D(Object.keys(g.value),i=>(t(),k("span",{key:i,class:"barcode-format-checkbox"},[B(n("input",{type:"checkbox","onUpdate:modelValue":l=>g.value[i]=l,id:i},null,8,G),[[U,g.value[i]]]),n("label",{for:i},o(i),9,K)]))),128))]),n("p",Z,o(h.value),1),n("p",ss,[c(" Last result: "),n("b",null,o(u.value),1)]),n("div",null,[p.value!==null?(t(),V(M(W),{key:0,constraints:{deviceId:p.value.deviceId},track:C.value.value,formats:S.value,onError:T,onDetect:A},null,8,["constraints","track","formats"])):(t(),k("p",is," No cameras on this device "))])]))}}),ns=H(as,[["__scopeId","data-v-be9f9333"]]),ls=n("h1",{id:"full-demo",tabindex:"-1"},[c("Full Demo "),n("a",{class:"header-anchor",href:"#full-demo","aria-label":'Permalink to "Full Demo"'},"")],-1),hs=z(`
<template>
+ <div>
+ <p>
+ Modern mobile phones often have a variety of different cameras installed (e.g. front, rear,
+ wide-angle, infrared, desk-view). The one picked by default is sometimes not the best choice.
+ If you want fine-grained control, which camera is used, you can enumerate all installed
+ cameras and then pick the one you need based on it's device ID:
+
+ <select v-model="selectedDevice">
+ <option
+ v-for="device in devices"
+ :key="device.label"
+ :value="device"
+ >
+ {{ device.label }}
+ </option>
+ </select>
+ </p>
+
+ <p>
+ Detected codes are visually highlighted in real-time. Use the following dropdown to change the
+ flavor:
+
+ <select v-model="trackFunctionSelected">
+ <option
+ v-for="option in trackFunctionOptions"
+ :key="option.text"
+ :value="option"
+ >
+ {{ option.text }}
+ </option>
+ </select>
+ </p>
+
+ <p>
+ By default only QR-codes are detected but a variety of other barcode formats are also
+ supported. You can select one or multiple but the more you select the more expensive scanning
+ becomes: <br />
+
+ <span
+ v-for="option in Object.keys(barcodeFormats)"
+ :key="option"
+ class="barcode-format-checkbox"
+ >
+ <input
+ type="checkbox"
+ v-model="barcodeFormats[option]"
+ :id="option"
+ />
+ <label :for="option">{{ option }}</label>
+ </span>
+ </p>
+
+ <p class="error">{{ error }}</p>
+
+ <p class="decode-result">
+ Last result: <b>{{ result }}</b>
+ </p>
+
+ <div>
+ <qrcode-stream
+ :constraints="{ deviceId: selectedDevice.deviceId }"
+ :track="trackFunctionSelected.value"
+ :formats="selectedBarcodeFormats"
+ @error="onError"
+ @detect="onDetect"
+ v-if="selectedDevice !== null"
+ />
+ <p
+ v-else
+ class="error"
+ >
+ No cameras on this device
+ </p>
+ </div>
+ </div>
+</template>
+
+<script setup lang="ts">
+import { ref, computed, onMounted } from 'vue'
+import { QrcodeStream } from '../../../../src'
+
+/*** detection handling ***/
+
+const result = ref('')
+
+function onDetect(detectedCodes) {
+ console.log(detectedCodes)
+ result.value = JSON.stringify(detectedCodes.map((code) => code.rawValue))
+}
+
+/*** select camera ***/
+
+const selectedDevice = ref(null)
+const devices = ref([])
+
+onMounted(async () => {
+ devices.value = (await navigator.mediaDevices.enumerateDevices()).filter(
+ ({ kind }) => kind === 'videoinput'
+ )
+
+ if (devices.value.length > 0) {
+ selectedDevice.value = devices.value[0]
+ }
+})
+
+/*** track functons ***/
+
+function paintOutline(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const [firstPoint, ...otherPoints] = detectedCode.cornerPoints
+
+ ctx.strokeStyle = 'red'
+
+ ctx.beginPath()
+ ctx.moveTo(firstPoint.x, firstPoint.y)
+ for (const { x, y } of otherPoints) {
+ ctx.lineTo(x, y)
+ }
+ ctx.lineTo(firstPoint.x, firstPoint.y)
+ ctx.closePath()
+ ctx.stroke()
+ }
+}
+function paintBoundingBox(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const {
+ boundingBox: { x, y, width, height }
+ } = detectedCode
+
+ ctx.lineWidth = 2
+ ctx.strokeStyle = '#007bff'
+ ctx.strokeRect(x, y, width, height)
+ }
+}
+function paintCenterText(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const { boundingBox, rawValue } = detectedCode
+
+ const centerX = boundingBox.x + boundingBox.width / 2
+ const centerY = boundingBox.y + boundingBox.height / 2
+
+ const fontSize = Math.max(12, (50 * boundingBox.width) / ctx.canvas.width)
+
+ ctx.font = \`bold \${fontSize}px sans-serif\`
+ ctx.textAlign = 'center'
+
+ ctx.lineWidth = 3
+ ctx.strokeStyle = '#35495e'
+ ctx.strokeText(detectedCode.rawValue, centerX, centerY)
+
+ ctx.fillStyle = '#5cb984'
+ ctx.fillText(rawValue, centerX, centerY)
+ }
+}
+const trackFunctionOptions = [
+ { text: 'nothing (default)', value: undefined },
+ { text: 'outline', value: paintOutline },
+ { text: 'centered text', value: paintCenterText },
+ { text: 'bounding box', value: paintBoundingBox }
+]
+const trackFunctionSelected = ref(trackFunctionOptions[1])
+
+/*** barcode formats ***/
+
+const barcodeFormats = ref({
+ aztec: false,
+ code_128: false,
+ code_39: false,
+ code_93: false,
+ codabar: false,
+ databar: false,
+ databar_expanded: false,
+ data_matrix: false,
+ dx_film_edge: false,
+ ean_13: false,
+ ean_8: false,
+ itf: false,
+ maxi_code: false,
+ micro_qr_code: false,
+ pdf417: false,
+ qr_code: true,
+ rm_qr_code: false,
+ upc_a: false,
+ upc_e: false,
+ linear_codes: false,
+ matrix_codes: false
+})
+const selectedBarcodeFormats = computed(() => {
+ return Object.keys(barcodeFormats.value).filter((format) => barcodeFormats.value[format])
+})
+
+/*** error handling ***/
+
+const error = ref('')
+
+function onError(err) {
+ error.value = \`[\${err.name}]: \`
+
+ if (err.name === 'NotAllowedError') {
+ error.value += 'you need to grant camera access permission'
+ } else if (err.name === 'NotFoundError') {
+ error.value += 'no camera on this device'
+ } else if (err.name === 'NotSupportedError') {
+ error.value += 'secure context required (HTTPS, localhost)'
+ } else if (err.name === 'NotReadableError') {
+ error.value += 'is the camera already in use?'
+ } else if (err.name === 'OverconstrainedError') {
+ error.value += 'installed cameras are not suitable'
+ } else if (err.name === 'StreamApiNotSupportedError') {
+ error.value += 'Stream API is not supported in this browser'
+ } else if (err.name === 'InsecureContextError') {
+ error.value +=
+ 'Camera access is only permitted in secure context. Use HTTPS or localhost rather than HTTP.'
+ } else {
+ error.value += err.message
+ }
+}
+</script>
+
+<style scoped>
+.error {
+ font-weight: bold;
+ color: red;
+}
+.barcode-format-checkbox {
+ margin-right: 10px;
+ white-space: nowrap;
+}
+</style>
`,2),Es=JSON.parse('{"title":"Full Demo","description":"","frontmatter":{},"headers":[],"relativePath":"demos/FullDemo.md","filePath":"demos/FullDemo.md","lastUpdated":1707952687000}'),ts={name:"demos/FullDemo.md"},rs=x({...ts,setup(d){return(u,A)=>{const p=Y("ClientOnly");return t(),k("div",null,[ls,b(p,null,{default:j(()=>[b(N,{component:ns})]),_:1}),hs])}}});export{Es as __pageData,rs as default};
diff --git a/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.js b/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.js
new file mode 100644
index 00000000..cb4f333a
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.js
@@ -0,0 +1,130 @@
+import{_ as y}from"./chunks/camera.k0qov-UY.js";import{_ as F,f as o,D as t,o as k,c as E,I as e,w as r,k as i,n as u,d as C,a as d,R as m}from"./chunks/framework.lXWH-C-d.js";import{_ as f}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const B={components:{QrcodeStream:f},data(){return{fullscreen:!1}},computed:{fullscreenIcon(){return this.fullscreen?"/fullscreen-exit.svg":"/fullscreen.svg"}},watch:{fullscreen(s){s?this.requestFullscreen():this.exitFullscreen()}},methods:{onFullscreenChange(s){this.fullscreen=document.fullscreenElement!==null},requestFullscreen(){const s=this.$refs.wrapper;s.requestFullscreen?s.requestFullscreen():s.mozRequestFullScreen?s.mozRequestFullScreen():s.webkitRequestFullscreen?s.webkitRequestFullscreen():s.msRequestFullscreen&&s.msRequestFullscreen()},exitFullscreen(){document.exitFullscreen?document.exitFullscreen():document.mozCancelFullScreen?document.mozCancelFullScreen():document.webkitExitFullscreen?document.webkitExitFullscreen():document.msExitFullscreen&&document.msExitFullscreen()},logErrors:console.error,withBase:o}},A=["src"];function D(s,a,c,h,l,n){const g=t("qrcode-stream");return k(),E("div",{class:u({fullscreen:l.fullscreen}),ref:"wrapper",onFullscreenchange:a[1]||(a[1]=(...p)=>n.onFullscreenChange&&n.onFullscreenChange(...p))},[e(g,{onError:n.logErrors},{default:r(()=>[i("button",{onClick:a[0]||(a[0]=p=>l.fullscreen=!l.fullscreen),class:"fullscreen-button"},[i("img",{src:n.withBase(n.fullscreenIcon),alt:"toggle fullscreen"},null,8,A)])]),_:1},8,["onError"])],34)}const q=F(B,[["render",D],["__scopeId","data-v-39d64d0c"]]),_=i("h1",{id:"fullscreen",tabindex:"-1"},[d("Fullscreen "),i("a",{class:"header-anchor",href:"#fullscreen","aria-label":'Permalink to "Fullscreen"'},"")],-1),b=i("p",null,[i("code",null,"QrcodeStream"),d(" always covers the entire space available. Not more, not less. So to go fullscreen, simply put the component in a wrapper element that occupies the entire screen.")],-1),x=m(`
<template>
+ <div
+ :class="{ fullscreen: fullscreen }"
+ ref="wrapper"
+ @fullscreenchange="onFullscreenChange"
+ >
+ <qrcode-stream @error="logErrors">
+ <button
+ @click="fullscreen = !fullscreen"
+ class="fullscreen-button"
+ >
+ <img
+ :src="withBase(fullscreenIcon)"
+ alt="toggle fullscreen"
+ />
+ </button>
+ </qrcode-stream>
+ </div>
+</template>
+
+<script>
+import { withBase } from 'vitepress'
+
+import { QrcodeStream } from '../../../../src'
+
+// NOTE: calling \`requestFullscreen\` might prompt the user with another
+// permission dialog. You already asked for camera access permission so this is
+// a rather invasive move.
+//
+// Even without calling \`requestFullscreen\` the entire viewport is covered
+// by the camera stream. So consider skipping \`requestFullscreen\` in your
+// implementation.
+
+export default {
+ components: { QrcodeStream },
+
+ data() {
+ return {
+ fullscreen: false
+ }
+ },
+
+ computed: {
+ fullscreenIcon() {
+ if (this.fullscreen) {
+ return '/fullscreen-exit.svg'
+ } else {
+ return '/fullscreen.svg'
+ }
+ }
+ },
+
+ watch: {
+ fullscreen(enterFullscreen) {
+ if (enterFullscreen) {
+ this.requestFullscreen()
+ } else {
+ this.exitFullscreen()
+ }
+ }
+ },
+
+ methods: {
+ onFullscreenChange(event) {
+ // This becomes important when the user doesn't use the button to exit
+ // fullscreen but hits ESC on desktop, pushes a physical back button on
+ // mobile etc.
+
+ this.fullscreen = document.fullscreenElement !== null
+ },
+
+ requestFullscreen() {
+ const elem = this.$refs.wrapper
+
+ if (elem.requestFullscreen) {
+ elem.requestFullscreen()
+ } else if (elem.mozRequestFullScreen) {
+ /* Firefox */
+ elem.mozRequestFullScreen()
+ } else if (elem.webkitRequestFullscreen) {
+ /* Chrome, Safari and Opera */
+ elem.webkitRequestFullscreen()
+ } else if (elem.msRequestFullscreen) {
+ /* IE/Edge */
+ elem.msRequestFullscreen()
+ }
+ },
+
+ exitFullscreen() {
+ if (document.exitFullscreen) {
+ document.exitFullscreen()
+ } else if (document.mozCancelFullScreen) {
+ /* Firefox */
+ document.mozCancelFullScreen()
+ } else if (document.webkitExitFullscreen) {
+ /* Chrome, Safari and Opera */
+ document.webkitExitFullscreen()
+ } else if (document.msExitFullscreen) {
+ /* IE/Edge */
+ document.msExitFullscreen()
+ }
+ },
+
+ logErrors: console.error,
+
+ withBase
+ }
+}
+</script>
+
+<style scoped>
+.fullscreen {
+ position: fixed;
+ z-index: 1000;
+ top: 0;
+ bottom: 0;
+ right: 0;
+ left: 0;
+}
+.fullscreen-button {
+ background-color: white;
+ position: absolute;
+ bottom: 0;
+ right: 0;
+ margin: 1rem;
+}
+.fullscreen-button img {
+ width: 2rem;
+}
+</style>
`,2),z=JSON.parse('{"title":"Fullscreen","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Fullscreen.md","filePath":"demos/Fullscreen.md","lastUpdated":1621091954000}'),v={name:"demos/Fullscreen.md"},I=C({...v,setup(s){return(a,c)=>{const h=t("ClientOnly");return k(),E("div",null,[_,b,e(h,null,{default:r(()=>[e(y,{component:q})]),_:1}),x])}}});export{z as __pageData,I as default};
diff --git a/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.lean.js b/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.lean.js
new file mode 100644
index 00000000..cb4f333a
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Fullscreen.md.rVl0DQdx.lean.js
@@ -0,0 +1,130 @@
+import{_ as y}from"./chunks/camera.k0qov-UY.js";import{_ as F,f as o,D as t,o as k,c as E,I as e,w as r,k as i,n as u,d as C,a as d,R as m}from"./chunks/framework.lXWH-C-d.js";import{_ as f}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const B={components:{QrcodeStream:f},data(){return{fullscreen:!1}},computed:{fullscreenIcon(){return this.fullscreen?"/fullscreen-exit.svg":"/fullscreen.svg"}},watch:{fullscreen(s){s?this.requestFullscreen():this.exitFullscreen()}},methods:{onFullscreenChange(s){this.fullscreen=document.fullscreenElement!==null},requestFullscreen(){const s=this.$refs.wrapper;s.requestFullscreen?s.requestFullscreen():s.mozRequestFullScreen?s.mozRequestFullScreen():s.webkitRequestFullscreen?s.webkitRequestFullscreen():s.msRequestFullscreen&&s.msRequestFullscreen()},exitFullscreen(){document.exitFullscreen?document.exitFullscreen():document.mozCancelFullScreen?document.mozCancelFullScreen():document.webkitExitFullscreen?document.webkitExitFullscreen():document.msExitFullscreen&&document.msExitFullscreen()},logErrors:console.error,withBase:o}},A=["src"];function D(s,a,c,h,l,n){const g=t("qrcode-stream");return k(),E("div",{class:u({fullscreen:l.fullscreen}),ref:"wrapper",onFullscreenchange:a[1]||(a[1]=(...p)=>n.onFullscreenChange&&n.onFullscreenChange(...p))},[e(g,{onError:n.logErrors},{default:r(()=>[i("button",{onClick:a[0]||(a[0]=p=>l.fullscreen=!l.fullscreen),class:"fullscreen-button"},[i("img",{src:n.withBase(n.fullscreenIcon),alt:"toggle fullscreen"},null,8,A)])]),_:1},8,["onError"])],34)}const q=F(B,[["render",D],["__scopeId","data-v-39d64d0c"]]),_=i("h1",{id:"fullscreen",tabindex:"-1"},[d("Fullscreen "),i("a",{class:"header-anchor",href:"#fullscreen","aria-label":'Permalink to "Fullscreen"'},"")],-1),b=i("p",null,[i("code",null,"QrcodeStream"),d(" always covers the entire space available. Not more, not less. So to go fullscreen, simply put the component in a wrapper element that occupies the entire screen.")],-1),x=m(`
<template>
+ <div
+ :class="{ fullscreen: fullscreen }"
+ ref="wrapper"
+ @fullscreenchange="onFullscreenChange"
+ >
+ <qrcode-stream @error="logErrors">
+ <button
+ @click="fullscreen = !fullscreen"
+ class="fullscreen-button"
+ >
+ <img
+ :src="withBase(fullscreenIcon)"
+ alt="toggle fullscreen"
+ />
+ </button>
+ </qrcode-stream>
+ </div>
+</template>
+
+<script>
+import { withBase } from 'vitepress'
+
+import { QrcodeStream } from '../../../../src'
+
+// NOTE: calling \`requestFullscreen\` might prompt the user with another
+// permission dialog. You already asked for camera access permission so this is
+// a rather invasive move.
+//
+// Even without calling \`requestFullscreen\` the entire viewport is covered
+// by the camera stream. So consider skipping \`requestFullscreen\` in your
+// implementation.
+
+export default {
+ components: { QrcodeStream },
+
+ data() {
+ return {
+ fullscreen: false
+ }
+ },
+
+ computed: {
+ fullscreenIcon() {
+ if (this.fullscreen) {
+ return '/fullscreen-exit.svg'
+ } else {
+ return '/fullscreen.svg'
+ }
+ }
+ },
+
+ watch: {
+ fullscreen(enterFullscreen) {
+ if (enterFullscreen) {
+ this.requestFullscreen()
+ } else {
+ this.exitFullscreen()
+ }
+ }
+ },
+
+ methods: {
+ onFullscreenChange(event) {
+ // This becomes important when the user doesn't use the button to exit
+ // fullscreen but hits ESC on desktop, pushes a physical back button on
+ // mobile etc.
+
+ this.fullscreen = document.fullscreenElement !== null
+ },
+
+ requestFullscreen() {
+ const elem = this.$refs.wrapper
+
+ if (elem.requestFullscreen) {
+ elem.requestFullscreen()
+ } else if (elem.mozRequestFullScreen) {
+ /* Firefox */
+ elem.mozRequestFullScreen()
+ } else if (elem.webkitRequestFullscreen) {
+ /* Chrome, Safari and Opera */
+ elem.webkitRequestFullscreen()
+ } else if (elem.msRequestFullscreen) {
+ /* IE/Edge */
+ elem.msRequestFullscreen()
+ }
+ },
+
+ exitFullscreen() {
+ if (document.exitFullscreen) {
+ document.exitFullscreen()
+ } else if (document.mozCancelFullScreen) {
+ /* Firefox */
+ document.mozCancelFullScreen()
+ } else if (document.webkitExitFullscreen) {
+ /* Chrome, Safari and Opera */
+ document.webkitExitFullscreen()
+ } else if (document.msExitFullscreen) {
+ /* IE/Edge */
+ document.msExitFullscreen()
+ }
+ },
+
+ logErrors: console.error,
+
+ withBase
+ }
+}
+</script>
+
+<style scoped>
+.fullscreen {
+ position: fixed;
+ z-index: 1000;
+ top: 0;
+ bottom: 0;
+ right: 0;
+ left: 0;
+}
+.fullscreen-button {
+ background-color: white;
+ position: absolute;
+ bottom: 0;
+ right: 0;
+ margin: 1rem;
+}
+.fullscreen-button img {
+ width: 2rem;
+}
+</style>
`,2),z=JSON.parse('{"title":"Fullscreen","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Fullscreen.md","filePath":"demos/Fullscreen.md","lastUpdated":1621091954000}'),v={name:"demos/Fullscreen.md"},I=C({...v,setup(s){return(a,c)=>{const h=t("ClientOnly");return k(),E("div",null,[_,b,e(h,null,{default:r(()=>[e(y,{component:q})]),_:1}),x])}}});export{z as __pageData,I as default};
diff --git a/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.js b/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.js
new file mode 100644
index 00000000..0dedb8df
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.js
@@ -0,0 +1,57 @@
+import{_ as y}from"./chunks/camera.k0qov-UY.js";import{_ as F}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";import{_ as C,D as E,o as i,c as t,k as s,b as m,w as r,e,d as u,I as k,a as l,R as _}from"./chunks/framework.lXWH-C-d.js";const B={components:{QrcodeStream:F},data(){return{loading:!0,destroyed:!1}},methods:{onCameraOn(){this.loading=!1},async reload(){this.destroyed=!0,await this.$nextTick(),this.destroyed=!1,this.loading=!0}}},f={key:0,class:"loading-indicator"};function D(d,a,o,h,p,n){const g=E("qrcode-stream");return i(),t("div",null,[s("button",{onClick:a[0]||(a[0]=(...c)=>n.reload&&n.reload(...c))},"Destroy And Re-Create Component"),p.destroyed?e("",!0):(i(),m(g,{key:0,onCameraOn:n.onCameraOn},{default:r(()=>[p.loading?(i(),t("div",f," Loading... ")):e("",!0)]),_:1},8,["onCameraOn"]))])}const A=C(B,[["render",D],["__scopeId","data-v-3ae3ffac"]]),v=s("h1",{id:"show-loading-indicator",tabindex:"-1"},[l("Show Loading Indicator "),s("a",{class:"header-anchor",href:"#show-loading-indicator","aria-label":'Permalink to "Show Loading Indicator"'},"")],-1),b=s("p",null,[l("There is some delay between mounting the component and the camera stream becoming visible. Listen for the "),s("code",null,"camera-on"),l(" event to show a loading indicator.")],-1),q=s("p",null,"Push the button below to force destroy and re-create the component.",-1),w=_(`
`,2),O=JSON.parse('{"title":"Show Loading Indicator","description":"","frontmatter":{},"headers":[],"relativePath":"demos/LoadingIndicator.md","filePath":"demos/LoadingIndicator.md","lastUpdated":1688667092000}'),x={name:"demos/LoadingIndicator.md"},N=u({...x,setup(d){return(a,o)=>{const h=E("ClientOnly");return i(),t("div",null,[v,b,q,k(h,null,{default:r(()=>[k(y,{component:A})]),_:1}),w])}}});export{O as __pageData,N as default};
diff --git a/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.lean.js b/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.lean.js
new file mode 100644
index 00000000..0dedb8df
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_LoadingIndicator.md._gfElcQN.lean.js
@@ -0,0 +1,57 @@
+import{_ as y}from"./chunks/camera.k0qov-UY.js";import{_ as F}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";import{_ as C,D as E,o as i,c as t,k as s,b as m,w as r,e,d as u,I as k,a as l,R as _}from"./chunks/framework.lXWH-C-d.js";const B={components:{QrcodeStream:F},data(){return{loading:!0,destroyed:!1}},methods:{onCameraOn(){this.loading=!1},async reload(){this.destroyed=!0,await this.$nextTick(),this.destroyed=!1,this.loading=!0}}},f={key:0,class:"loading-indicator"};function D(d,a,o,h,p,n){const g=E("qrcode-stream");return i(),t("div",null,[s("button",{onClick:a[0]||(a[0]=(...c)=>n.reload&&n.reload(...c))},"Destroy And Re-Create Component"),p.destroyed?e("",!0):(i(),m(g,{key:0,onCameraOn:n.onCameraOn},{default:r(()=>[p.loading?(i(),t("div",f," Loading... ")):e("",!0)]),_:1},8,["onCameraOn"]))])}const A=C(B,[["render",D],["__scopeId","data-v-3ae3ffac"]]),v=s("h1",{id:"show-loading-indicator",tabindex:"-1"},[l("Show Loading Indicator "),s("a",{class:"header-anchor",href:"#show-loading-indicator","aria-label":'Permalink to "Show Loading Indicator"'},"")],-1),b=s("p",null,[l("There is some delay between mounting the component and the camera stream becoming visible. Listen for the "),s("code",null,"camera-on"),l(" event to show a loading indicator.")],-1),q=s("p",null,"Push the button below to force destroy and re-create the component.",-1),w=_(`
`,2),O=JSON.parse('{"title":"Show Loading Indicator","description":"","frontmatter":{},"headers":[],"relativePath":"demos/LoadingIndicator.md","filePath":"demos/LoadingIndicator.md","lastUpdated":1688667092000}'),x={name:"demos/LoadingIndicator.md"},N=u({...x,setup(d){return(a,o)=>{const h=E("ClientOnly");return i(),t("div",null,[v,b,q,k(h,null,{default:r(()=>[k(y,{component:A})]),_:1}),w])}}});export{O as __pageData,N as default};
diff --git a/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.js b/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.js
new file mode 100644
index 00000000..045630f3
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.js
@@ -0,0 +1,86 @@
+import{_ as o}from"./chunks/camera.k0qov-UY.js";import{_ as c,f as y,D as p,o as e,c as E,k as s,a as i,t as F,I as l,w as r,a7 as C,a4 as m,d as u,R as B}from"./chunks/framework.lXWH-C-d.js";import{_ as f}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const _={components:{QrcodeStream:f},data(){return{paused:!1,result:"",showScanConfirmation:!1}},methods:{onCameraOn(){this.showScanConfirmation=!1},onCameraOff(){this.showScanConfirmation=!0},onError:console.error,async onDetect(a){this.result=JSON.stringify(a.map(n=>n.rawValue)),this.paused=!0,await this.timeout(500),this.paused=!1},timeout(a){return new Promise(n=>{window.setTimeout(n,a)})},withBase:y}},D={class:"decode-result"},w={class:"scan-confirmation"},A=["src"];function S(a,n,d,k,t,h){const g=p("qrcode-stream");return e(),E("div",null,[s("p",D,[i(" Last result: "),s("b",null,F(t.result),1)]),l(g,{paused:t.paused,onDetect:h.onDetect,onCameraOn:h.onCameraOn,onCameraOff:h.onCameraOff,onError:h.onError},{default:r(()=>[m(s("div",w,[s("img",{src:h.withBase("/checkmark.svg"),alt:"Checkmark",width:"128"},null,8,A)],512),[[C,t.showScanConfirmation]])]),_:1},8,["paused","onDetect","onCameraOn","onCameraOff","onError"])])}const q=c(_,[["render",S],["__scopeId","data-v-2c48d920"]]),v=s("h1",{id:"scan-same-qr-code-more-than-once",tabindex:"-1"},[i("Scan Same QR Code More Than Once "),s("a",{class:"header-anchor",href:"#scan-same-qr-code-more-than-once","aria-label":'Permalink to "Scan Same QR Code More Than Once"'},"")],-1),O=s("p",null,[i("You might have noticed that scanning the same QR code again doesn't work. The thing is when a QR code is in the view of your the camera it's decoded multiple times a second. You don't want to be flooded with "),s("code",null,"detect"),i(` events that often though. That's why the last decoded QR code is "cached" and an event is only emitted, when the decoded content changes.`)],-1),b=s("p",null,[i("However this cache is reset when you change the "),s("code",null,"paused"),i(" prop. We can exploit that to scan same QR codes multiple times in a row.")],-1),Q=B(`
`,2),N=JSON.parse('{"title":"Scan Same QR Code More Than Once","description":"","frontmatter":{},"headers":[],"relativePath":"demos/ScanSameQrcodeMoreThanOnce.md","filePath":"demos/ScanSameQrcodeMoreThanOnce.md","lastUpdated":1688836566000}'),x={name:"demos/ScanSameQrcodeMoreThanOnce.md"},P=u({...x,setup(a){return(n,d)=>{const k=p("ClientOnly");return e(),E("div",null,[v,O,b,l(k,null,{default:r(()=>[l(o,{component:q})]),_:1}),Q])}}});export{N as __pageData,P as default};
diff --git a/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.lean.js b/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.lean.js
new file mode 100644
index 00000000..045630f3
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.lean.js
@@ -0,0 +1,86 @@
+import{_ as o}from"./chunks/camera.k0qov-UY.js";import{_ as c,f as y,D as p,o as e,c as E,k as s,a as i,t as F,I as l,w as r,a7 as C,a4 as m,d as u,R as B}from"./chunks/framework.lXWH-C-d.js";import{_ as f}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const _={components:{QrcodeStream:f},data(){return{paused:!1,result:"",showScanConfirmation:!1}},methods:{onCameraOn(){this.showScanConfirmation=!1},onCameraOff(){this.showScanConfirmation=!0},onError:console.error,async onDetect(a){this.result=JSON.stringify(a.map(n=>n.rawValue)),this.paused=!0,await this.timeout(500),this.paused=!1},timeout(a){return new Promise(n=>{window.setTimeout(n,a)})},withBase:y}},D={class:"decode-result"},w={class:"scan-confirmation"},A=["src"];function S(a,n,d,k,t,h){const g=p("qrcode-stream");return e(),E("div",null,[s("p",D,[i(" Last result: "),s("b",null,F(t.result),1)]),l(g,{paused:t.paused,onDetect:h.onDetect,onCameraOn:h.onCameraOn,onCameraOff:h.onCameraOff,onError:h.onError},{default:r(()=>[m(s("div",w,[s("img",{src:h.withBase("/checkmark.svg"),alt:"Checkmark",width:"128"},null,8,A)],512),[[C,t.showScanConfirmation]])]),_:1},8,["paused","onDetect","onCameraOn","onCameraOff","onError"])])}const q=c(_,[["render",S],["__scopeId","data-v-2c48d920"]]),v=s("h1",{id:"scan-same-qr-code-more-than-once",tabindex:"-1"},[i("Scan Same QR Code More Than Once "),s("a",{class:"header-anchor",href:"#scan-same-qr-code-more-than-once","aria-label":'Permalink to "Scan Same QR Code More Than Once"'},"")],-1),O=s("p",null,[i("You might have noticed that scanning the same QR code again doesn't work. The thing is when a QR code is in the view of your the camera it's decoded multiple times a second. You don't want to be flooded with "),s("code",null,"detect"),i(` events that often though. That's why the last decoded QR code is "cached" and an event is only emitted, when the decoded content changes.`)],-1),b=s("p",null,[i("However this cache is reset when you change the "),s("code",null,"paused"),i(" prop. We can exploit that to scan same QR codes multiple times in a row.")],-1),Q=B(`
`,2),N=JSON.parse('{"title":"Scan Same QR Code More Than Once","description":"","frontmatter":{},"headers":[],"relativePath":"demos/ScanSameQrcodeMoreThanOnce.md","filePath":"demos/ScanSameQrcodeMoreThanOnce.md","lastUpdated":1688836566000}'),x={name:"demos/ScanSameQrcodeMoreThanOnce.md"},P=u({...x,setup(a){return(n,d)=>{const k=p("ClientOnly");return e(),E("div",null,[v,O,b,l(k,null,{default:r(()=>[l(o,{component:q})]),_:1}),Q])}}});export{N as __pageData,P as default};
diff --git a/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.js b/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.js
new file mode 100644
index 00000000..cf343e4e
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.js
@@ -0,0 +1,79 @@
+import{_ as s,c as i,o as a,R as n}from"./chunks/framework.lXWH-C-d.js";const F=JSON.parse('{"title":"Simple","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Simple.md","filePath":"demos/Simple.md","lastUpdated":1692216176000}'),h={name:"demos/Simple.md"},k=n(`
All other demos on this page utilize single-file components. To use them in your project you need a bundler like vite. For an example that works without a build step and right in the browser:
<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Simple Demo</title>
+
+ <script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
+ <script src="https://unpkg.com/vue-qrcode-reader@5/dist/vue-qrcode-reader.umd.js"></script>
+</head>
+<body>
+ <div id="app">
+ <h1>Simple Demo</h1>
+
+ <p style="color: red">{{ error }}</p>
+
+ <p>Last result: <b>{{ result }}</b></p>
+
+ <div style="border: 2px solid black">
+ <qrcode-stream :track="paintBoundingBox" @detect="onDetect" @error="onError"></qrcode-stream>
+ </div>
+ </div>
+</body>
+<script>
+ const { createApp, ref } = Vue
+
+ const result = ref('')
+ const error = ref('')
+
+ function paintBoundingBox(detectedCodes, ctx) {
+ for (const detectedCode of detectedCodes) {
+ const {
+ boundingBox: { x, y, width, height }
+ } = detectedCode
+
+ ctx.lineWidth = 2
+ ctx.strokeStyle = '#007bff'
+ ctx.strokeRect(x, y, width, height)
+ }
+ }
+
+ function onError(err) {
+ error.value = \`[\${err.name}]: \`
+
+ if (err.name === 'NotAllowedError') {
+ error.value += 'you need to grant camera access permission'
+ } else if (err.name === 'NotFoundError') {
+ error.value += 'no camera on this device'
+ } else if (err.name === 'NotSupportedError') {
+ error.value += 'secure context required (HTTPS, localhost)'
+ } else if (err.name === 'NotReadableError') {
+ error.value += 'is the camera already in use?'
+ } else if (err.name === 'OverconstrainedError') {
+ error.value += 'installed cameras are not suitable'
+ } else if (err.name === 'StreamApiNotSupportedError') {
+ error.value += 'Stream API is not supported in this browser'
+ } else if (err.name === 'InsecureContextError') {
+ error.value += 'Camera access is only permitted in secure context. Use HTTPS or localhost rather than HTTP.'
+ } else {
+ error.value += err.message
+ }
+ }
+
+ function onDetect(detectedCodes) {
+ result.value = JSON.stringify(
+ detectedCodes.map(code => code.rawValue)
+ )
+ }
+
+ const app = createApp({
+ setup() {
+ return { result, error, onDetect, onError, paintBoundingBox }
+ }
+ })
+ app.use(VueQrcodeReader)
+ app.mount('#app')
+</script>
+</html>
`,5),l=[k];function t(p,e,E,r,d,g){return a(),i("div",null,l)}const o=s(h,[["render",t]]);export{F as __pageData,o as default};
diff --git a/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.lean.js b/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.lean.js
new file mode 100644
index 00000000..d5e1bdc5
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Simple.md.1VshYyx0.lean.js
@@ -0,0 +1 @@
+import{_ as s,c as i,o as a,R as n}from"./chunks/framework.lXWH-C-d.js";const F=JSON.parse('{"title":"Simple","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Simple.md","filePath":"demos/Simple.md","lastUpdated":1692216176000}'),h={name:"demos/Simple.md"},k=n("",5),l=[k];function t(p,e,E,r,d,g){return a(),i("div",null,l)}const o=s(h,[["render",t]]);export{F as __pageData,o as default};
diff --git a/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.js b/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.js
new file mode 100644
index 00000000..c627ae97
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.js
@@ -0,0 +1,95 @@
+import{_ as c}from"./chunks/camera.k0qov-UY.js";import{_ as y,f as F,D as E,o as t,c as l,e as r,I as e,w as d,k as a,d as C,a as m,R as u}from"./chunks/framework.lXWH-C-d.js";import{_ as B}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const f={components:{QrcodeStream:B},data(){return{facingMode:"environment",noRearCamera:!1,noFrontCamera:!1}},methods:{switchCamera(){switch(this.facingMode){case"environment":this.facingMode="user";break;case"user":this.facingMode="environment";break}},onError(n){const s=this.facingMode==="user",p=this.facingMode==="environment",i=n.name==="OverconstrainedError";p&&i&&(this.noRearCamera=!0),s&&i&&(this.noFrontCamera=!0),console.error(n)},withBase:F}},D={key:0,class:"error"},A={key:1,class:"error"},_=["src"];function v(n,s,p,i,k,h){const g=E("qrcode-stream");return t(),l("div",null,[k.noFrontCamera?(t(),l("p",D," You don't seem to have a front camera on your device ")):r("",!0),k.noRearCamera?(t(),l("p",A," You don't seem to have a rear camera on your device ")):r("",!0),e(g,{constraints:{facingMode:k.facingMode},onError:h.onError},{default:d(()=>[a("button",{onClick:s[0]||(s[0]=(...o)=>h.switchCamera&&h.switchCamera(...o))},[a("img",{src:h.withBase("/camera-switch.svg"),alt:"switch camera"},null,8,_)])]),_:1},8,["constraints","onError"])])}const w=y(f,[["render",v],["__scopeId","data-v-6622b1c4"]]),q=a("h1",{id:"switch-to-front-camera",tabindex:"-1"},[m("Switch to Front Camera "),a("a",{class:"header-anchor",href:"#switch-to-front-camera","aria-label":'Permalink to "Switch to Front Camera"'},"")],-1),b=a("p",null,"You can also allow users to choose the front or rear camera on their device.",-1),M=u(`
`,2),O=JSON.parse('{"title":"Switch to Front Camera","description":"","frontmatter":{},"headers":[],"relativePath":"demos/SwitchCamera.md","filePath":"demos/SwitchCamera.md","lastUpdated":1621091954000}'),S={name:"demos/SwitchCamera.md"},V=C({...S,setup(n){return(s,p)=>{const i=E("ClientOnly");return t(),l("div",null,[q,b,e(i,null,{default:d(()=>[e(c,{component:w})]),_:1}),M])}}});export{O as __pageData,V as default};
diff --git a/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.lean.js b/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.lean.js
new file mode 100644
index 00000000..c627ae97
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_SwitchCamera.md.cHlgHu4J.lean.js
@@ -0,0 +1,95 @@
+import{_ as c}from"./chunks/camera.k0qov-UY.js";import{_ as y,f as F,D as E,o as t,c as l,e as r,I as e,w as d,k as a,d as C,a as m,R as u}from"./chunks/framework.lXWH-C-d.js";import{_ as B}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const f={components:{QrcodeStream:B},data(){return{facingMode:"environment",noRearCamera:!1,noFrontCamera:!1}},methods:{switchCamera(){switch(this.facingMode){case"environment":this.facingMode="user";break;case"user":this.facingMode="environment";break}},onError(n){const s=this.facingMode==="user",p=this.facingMode==="environment",i=n.name==="OverconstrainedError";p&&i&&(this.noRearCamera=!0),s&&i&&(this.noFrontCamera=!0),console.error(n)},withBase:F}},D={key:0,class:"error"},A={key:1,class:"error"},_=["src"];function v(n,s,p,i,k,h){const g=E("qrcode-stream");return t(),l("div",null,[k.noFrontCamera?(t(),l("p",D," You don't seem to have a front camera on your device ")):r("",!0),k.noRearCamera?(t(),l("p",A," You don't seem to have a rear camera on your device ")):r("",!0),e(g,{constraints:{facingMode:k.facingMode},onError:h.onError},{default:d(()=>[a("button",{onClick:s[0]||(s[0]=(...o)=>h.switchCamera&&h.switchCamera(...o))},[a("img",{src:h.withBase("/camera-switch.svg"),alt:"switch camera"},null,8,_)])]),_:1},8,["constraints","onError"])])}const w=y(f,[["render",v],["__scopeId","data-v-6622b1c4"]]),q=a("h1",{id:"switch-to-front-camera",tabindex:"-1"},[m("Switch to Front Camera "),a("a",{class:"header-anchor",href:"#switch-to-front-camera","aria-label":'Permalink to "Switch to Front Camera"'},"")],-1),b=a("p",null,"You can also allow users to choose the front or rear camera on their device.",-1),M=u(`
`,2),O=JSON.parse('{"title":"Switch to Front Camera","description":"","frontmatter":{},"headers":[],"relativePath":"demos/SwitchCamera.md","filePath":"demos/SwitchCamera.md","lastUpdated":1621091954000}'),S={name:"demos/SwitchCamera.md"},V=C({...S,setup(n){return(s,p)=>{const i=E("ClientOnly");return t(),l("div",null,[q,b,e(i,null,{default:d(()=>[e(c,{component:w})]),_:1}),M])}}});export{O as __pageData,V as default};
diff --git a/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.js b/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.js
new file mode 100644
index 00000000..baea47d3
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.js
@@ -0,0 +1,97 @@
+import{_ as B}from"./chunks/camera.k0qov-UY.js";import{d as c,h as E,j as v,g as A,o as l,c as p,k as s,a as e,a4 as D,a5 as m,F as f,E as _,e as d,a8 as q,t as b,b as w,w as o,f as x,m as g,_ as N,D as S,I as y,R as I}from"./chunks/framework.lXWH-C-d.js";import{_ as T}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const $=["value"],M={key:0,class:"error"},O=["disabled"],P=["src"],V=c({__name:"Torch",setup(F){const i=E(null),h=E([]);v(async()=>{h.value=(await navigator.mediaDevices.enumerateDevices()).filter(({kind:t})=>t==="videoinput"),h.value.length>0&&(i.value=h.value[0])});const a=E(!1),r=E(!1),u=A(()=>a.value?"/flash-off.svg":"/flash-on.svg");function C(t){console.log(t),r.value=!t.torch}return(t,k)=>(l(),p("div",null,[s("p",null,[e(" Pick camera: "),D(s("select",{"onUpdate:modelValue":k[0]||(k[0]=n=>i.value=n)},[(l(!0),p(f,null,_(h.value,n=>(l(),p("option",{key:n.label,value:n},b(n.label),9,$))),128))],512),[[m,i.value]])]),r.value?(l(),p("p",M," Torch not supported for active camera ")):d("",!0),i.value!==null?q([a.value,i.value.deviceId],()=>(l(),w(g(T),{key:1,torch:a.value,constraints:{deviceId:i.value.deviceId},onError:console.error,onCameraOn:C},{default:o(()=>[s("button",{onClick:k[1]||(k[1]=n=>a.value=!a.value),disabled:r.value},[s("img",{src:g(x)(u.value),alt:"toggle torch"},null,8,P)],8,O)]),_:1},8,["torch","constraints","onError"])),k,2):d("",!0)]))}}),U=N(V,[["__scopeId","data-v-cf37801d"]]),j=s("h1",{id:"torch-flashlight",tabindex:"-1"},[e("Torch (Flashlight) "),s("a",{class:"header-anchor",href:"#torch-flashlight","aria-label":'Permalink to "Torch (Flashlight)"'},"")],-1),J=s("p",null,[e("In low-light conditions you might want to make use of the cameras flashlight. Using the "),s("code",null,"torch"),e(" prop, you can turn the flashlight on/off. Note that support is inconsistent across devices and browsers and can only be detected after already starting the camera.")],-1),L=s("p",null,[e("Feature sponsored by "),s("a",{href:"https://aeschbacher.ch",target:"_blank",rel:"noreferrer"},"aeschbacher.ch")],-1),Q=I(`
`,2),K=JSON.parse('{"title":"Torch (Flashlight)","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Torch.md","filePath":"demos/Torch.md","lastUpdated":1688667092000}'),R={name:"demos/Torch.md"},W=c({...R,setup(F){return(i,h)=>{const a=S("ClientOnly");return l(),p("div",null,[j,J,L,y(a,null,{default:o(()=>[y(B,{component:U})]),_:1}),Q])}}});export{K as __pageData,W as default};
diff --git a/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.lean.js b/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.lean.js
new file mode 100644
index 00000000..baea47d3
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Torch.md.8UFlvoqz.lean.js
@@ -0,0 +1,97 @@
+import{_ as B}from"./chunks/camera.k0qov-UY.js";import{d as c,h as E,j as v,g as A,o as l,c as p,k as s,a as e,a4 as D,a5 as m,F as f,E as _,e as d,a8 as q,t as b,b as w,w as o,f as x,m as g,_ as N,D as S,I as y,R as I}from"./chunks/framework.lXWH-C-d.js";import{_ as T}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";const $=["value"],M={key:0,class:"error"},O=["disabled"],P=["src"],V=c({__name:"Torch",setup(F){const i=E(null),h=E([]);v(async()=>{h.value=(await navigator.mediaDevices.enumerateDevices()).filter(({kind:t})=>t==="videoinput"),h.value.length>0&&(i.value=h.value[0])});const a=E(!1),r=E(!1),u=A(()=>a.value?"/flash-off.svg":"/flash-on.svg");function C(t){console.log(t),r.value=!t.torch}return(t,k)=>(l(),p("div",null,[s("p",null,[e(" Pick camera: "),D(s("select",{"onUpdate:modelValue":k[0]||(k[0]=n=>i.value=n)},[(l(!0),p(f,null,_(h.value,n=>(l(),p("option",{key:n.label,value:n},b(n.label),9,$))),128))],512),[[m,i.value]])]),r.value?(l(),p("p",M," Torch not supported for active camera ")):d("",!0),i.value!==null?q([a.value,i.value.deviceId],()=>(l(),w(g(T),{key:1,torch:a.value,constraints:{deviceId:i.value.deviceId},onError:console.error,onCameraOn:C},{default:o(()=>[s("button",{onClick:k[1]||(k[1]=n=>a.value=!a.value),disabled:r.value},[s("img",{src:g(x)(u.value),alt:"toggle torch"},null,8,P)],8,O)]),_:1},8,["torch","constraints","onError"])),k,2):d("",!0)]))}}),U=N(V,[["__scopeId","data-v-cf37801d"]]),j=s("h1",{id:"torch-flashlight",tabindex:"-1"},[e("Torch (Flashlight) "),s("a",{class:"header-anchor",href:"#torch-flashlight","aria-label":'Permalink to "Torch (Flashlight)"'},"")],-1),J=s("p",null,[e("In low-light conditions you might want to make use of the cameras flashlight. Using the "),s("code",null,"torch"),e(" prop, you can turn the flashlight on/off. Note that support is inconsistent across devices and browsers and can only be detected after already starting the camera.")],-1),L=s("p",null,[e("Feature sponsored by "),s("a",{href:"https://aeschbacher.ch",target:"_blank",rel:"noreferrer"},"aeschbacher.ch")],-1),Q=I(`
`,2),K=JSON.parse('{"title":"Torch (Flashlight)","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Torch.md","filePath":"demos/Torch.md","lastUpdated":1688667092000}'),R={name:"demos/Torch.md"},W=c({...R,setup(F){return(i,h)=>{const a=S("ClientOnly");return l(),p("div",null,[j,J,L,y(a,null,{default:o(()=>[y(B,{component:U})]),_:1}),Q])}}});export{K as __pageData,W as default};
diff --git a/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.js b/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.js
new file mode 100644
index 00000000..1ad9a508
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.js
@@ -0,0 +1,57 @@
+import{p as y,_ as u}from"./chunks/camera.k0qov-UY.js";import{d as c,o as e,c as p,_ as F,D as g,k as s,a as h,a4 as m,a5 as C,F as _,E as f,t as o,I as d,w as D,R as B}from"./chunks/framework.lXWH-C-d.js";const v=c({__name:"QrcodeCapture",props:{formats:{type:Array,default:()=>["qr_code"]}},emits:["detect"],setup(i,{emit:a}){const r=i,k=a,n=l=>{if(!(!(l.target instanceof HTMLInputElement)||!l.target.files))for(const E of Array.from(l.target.files))y(E,r.formats).then(t=>{k("detect",t)})};return(l,E)=>(e(),p("input",{onChange:n,type:"file",name:"image",accept:"image/*",capture:"environment",multiple:""},null,32))}}),A={components:{QrcodeCapture:v},data(){const i=[{text:"rear camera (default)",value:"environment"},{text:"front camera",value:"user"},{text:"force file dialog",value:null}];return{result:"",options:i,selected:i[0]}},methods:{onDetect(i){console.log(i),this.result=JSON.stringify(i.map(a=>a.rawValue))}}},b=["value"],q=s("hr",null,null,-1),x={class:"decode-result"};function w(i,a,r,k,n,l){const E=g("qrcode-capture");return e(),p("div",null,[s("p",null,[h(" Capture: "),m(s("select",{"onUpdate:modelValue":a[0]||(a[0]=t=>n.selected=t)},[(e(!0),p(_,null,f(n.options,t=>(e(),p("option",{key:t.text,value:t},o(t.text),9,b))),128))],512),[[C,n.selected]])]),q,s("p",x,[h(" Last result: "),s("b",null,o(n.result),1)]),d(E,{onDetect:l.onDetect,capture:n.selected.value},null,8,["onDetect","capture"])])}const S=F(A,[["render",w]]),U=s("h1",{id:"decode-by-upload",tabindex:"-1"},[h("Decode by Upload "),s("a",{class:"header-anchor",href:"#decode-by-upload","aria-label":'Permalink to "Decode by Upload"'},"")],-1),N=s("p",null,[h("Finally, with "),s("code",null,"QrcodeCapture"),h(" comes another component which allows image scanning via classic file upload. Nothing is actually uploaded. Everything is happening client-side.")],-1),V=s("p",null,"If you are on mobile and your browser supports it, you are not prompted with a file dialog but with your camera. So you can directly take the picture to be uploaded. Adjust this behavior with the following dropdown:",-1),O=B(`
`,2),P=JSON.parse('{"title":"Decode by Upload","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Upload.md","filePath":"demos/Upload.md","lastUpdated":1703524587000}'),Q={name:"demos/Upload.md"},$=c({...Q,setup(i){return(a,r)=>{const k=g("ClientOnly");return e(),p("div",null,[U,N,V,d(k,null,{default:D(()=>[d(u,{component:S})]),_:1}),O])}}});export{P as __pageData,$ as default};
diff --git a/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.lean.js b/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.lean.js
new file mode 100644
index 00000000..1ad9a508
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Upload.md.4cV7tPYv.lean.js
@@ -0,0 +1,57 @@
+import{p as y,_ as u}from"./chunks/camera.k0qov-UY.js";import{d as c,o as e,c as p,_ as F,D as g,k as s,a as h,a4 as m,a5 as C,F as _,E as f,t as o,I as d,w as D,R as B}from"./chunks/framework.lXWH-C-d.js";const v=c({__name:"QrcodeCapture",props:{formats:{type:Array,default:()=>["qr_code"]}},emits:["detect"],setup(i,{emit:a}){const r=i,k=a,n=l=>{if(!(!(l.target instanceof HTMLInputElement)||!l.target.files))for(const E of Array.from(l.target.files))y(E,r.formats).then(t=>{k("detect",t)})};return(l,E)=>(e(),p("input",{onChange:n,type:"file",name:"image",accept:"image/*",capture:"environment",multiple:""},null,32))}}),A={components:{QrcodeCapture:v},data(){const i=[{text:"rear camera (default)",value:"environment"},{text:"front camera",value:"user"},{text:"force file dialog",value:null}];return{result:"",options:i,selected:i[0]}},methods:{onDetect(i){console.log(i),this.result=JSON.stringify(i.map(a=>a.rawValue))}}},b=["value"],q=s("hr",null,null,-1),x={class:"decode-result"};function w(i,a,r,k,n,l){const E=g("qrcode-capture");return e(),p("div",null,[s("p",null,[h(" Capture: "),m(s("select",{"onUpdate:modelValue":a[0]||(a[0]=t=>n.selected=t)},[(e(!0),p(_,null,f(n.options,t=>(e(),p("option",{key:t.text,value:t},o(t.text),9,b))),128))],512),[[C,n.selected]])]),q,s("p",x,[h(" Last result: "),s("b",null,o(n.result),1)]),d(E,{onDetect:l.onDetect,capture:n.selected.value},null,8,["onDetect","capture"])])}const S=F(A,[["render",w]]),U=s("h1",{id:"decode-by-upload",tabindex:"-1"},[h("Decode by Upload "),s("a",{class:"header-anchor",href:"#decode-by-upload","aria-label":'Permalink to "Decode by Upload"'},"")],-1),N=s("p",null,[h("Finally, with "),s("code",null,"QrcodeCapture"),h(" comes another component which allows image scanning via classic file upload. Nothing is actually uploaded. Everything is happening client-side.")],-1),V=s("p",null,"If you are on mobile and your browser supports it, you are not prompted with a file dialog but with your camera. So you can directly take the picture to be uploaded. Adjust this behavior with the following dropdown:",-1),O=B(`
`,2),P=JSON.parse('{"title":"Decode by Upload","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Upload.md","filePath":"demos/Upload.md","lastUpdated":1703524587000}'),Q={name:"demos/Upload.md"},$=c({...Q,setup(i){return(a,r)=>{const k=g("ClientOnly");return e(),p("div",null,[U,N,V,d(k,null,{default:D(()=>[d(u,{component:S})]),_:1}),O])}}});export{P as __pageData,$ as default};
diff --git a/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.js b/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.js
new file mode 100644
index 00000000..58d1f705
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.js
@@ -0,0 +1,119 @@
+import{_ as c}from"./chunks/camera.k0qov-UY.js";import{_ as F}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";import{_ as o,D as E,o as a,c as n,k as l,a as r,t as C,I as k,w as d,e as t,d as u,R as B}from"./chunks/framework.lXWH-C-d.js";const m={components:{QrcodeStream:F},data(){return{isValid:void 0,paused:!1,result:null}},computed:{validationPending(){return this.isValid===void 0&&this.paused},validationSuccess(){return this.isValid===!0},validationFailure(){return this.isValid===!1}},methods:{onError:console.error,resetValidationState(){this.isValid=void 0},async onDetect([i]){this.result=i.rawValue,this.paused=!0,await this.timeout(3e3),this.isValid=this.result.startsWith("http"),await this.timeout(2e3),this.paused=!1},timeout(i){return new Promise(h=>{window.setTimeout(h,i)})}}},D={class:"decode-result"},v={key:0,class:"validation-success"},A={key:1,class:"validation-failure"},_={key:2,class:"validation-pending"};function f(i,h,g,p,e,s){const y=E("qrcode-stream");return a(),n("div",null,[l("p",D,[r(" Last result: "),l("b",null,C(e.result),1)]),k(y,{paused:e.paused,onDetect:s.onDetect,onError:s.onError,onCameraOn:s.resetValidationState},{default:d(()=>[s.validationSuccess?(a(),n("div",v," This is a URL ")):t("",!0),s.validationFailure?(a(),n("div",A," This is NOT a URL! ")):t("",!0),s.validationPending?(a(),n("div",_," Long validation in progress... ")):t("",!0)]),_:1},8,["paused","onDetect","onError","onCameraOn"])])}const V=o(m,[["render",f],["__scopeId","data-v-2a6ebd39"]]),q=l("h1",{id:"pause-validate",tabindex:"-1"},[r("Pause & Validate "),l("a",{class:"header-anchor",href:"#pause-validate","aria-label":'Permalink to "Pause & Validate"'},"")],-1),w=l("p",null,"By pausing you can process each scanned QR-code one at a time. The last received frame is still displayed so it just looks like the stream is paused.",-1),b=B(`
`,2),L=JSON.parse('{"title":"Pause & Validate","description":"","frontmatter":{},"headers":[],"relativePath":"demos/Validate.md","filePath":"demos/Validate.md","lastUpdated":1688836566000}'),S={name:"demos/Validate.md"},N=u({...S,setup(i){return(h,g)=>{const p=E("ClientOnly");return a(),n("div",null,[q,w,k(p,null,{default:d(()=>[k(c,{component:V})]),_:1}),b])}}});export{L as __pageData,N as default};
diff --git a/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.lean.js b/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.lean.js
new file mode 100644
index 00000000..58d1f705
--- /dev/null
+++ b/pr-preview/pr-422/assets/demos_Validate.md.mZSvWK2M.lean.js
@@ -0,0 +1,119 @@
+import{_ as c}from"./chunks/camera.k0qov-UY.js";import{_ as F}from"./chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js";import{_ as o,D as E,o as a,c as n,k as l,a as r,t as C,I as k,w as d,e as t,d as u,R as B}from"./chunks/framework.lXWH-C-d.js";const m={components:{QrcodeStream:F},data(){return{isValid:void 0,paused:!1,result:null}},computed:{validationPending(){return this.isValid===void 0&&this.paused},validationSuccess(){return this.isValid===!0},validationFailure(){return this.isValid===!1}},methods:{onError:console.error,resetValidationState(){this.isValid=void 0},async onDetect([i]){this.result=i.rawValue,this.paused=!0,await this.timeout(3e3),this.isValid=this.result.startsWith("http"),await this.timeout(2e3),this.paused=!1},timeout(i){return new Promise(h=>{window.setTimeout(h,i)})}}},D={class:"decode-result"},v={key:0,class:"validation-success"},A={key:1,class:"validation-failure"},_={key:2,class:"validation-pending"};function f(i,h,g,p,e,s){const y=E("qrcode-stream");return a(),n("div",null,[l("p",D,[r(" Last result: "),l("b",null,C(e.result),1)]),k(y,{paused:e.paused,onDetect:s.onDetect,onError:s.onError,onCameraOn:s.resetValidationState},{default:d(()=>[s.validationSuccess?(a(),n("div",v," This is a URL ")):t("",!0),s.validationFailure?(a(),n("div",A," This is NOT a URL! ")):t("",!0),s.validationPending?(a(),n("div",_," Long validation in progress... ")):t("",!0)]),_:1},8,["paused","onDetect","onError","onCameraOn"])])}const V=o(m,[["render",f],["__scopeId","data-v-2a6ebd39"]]),q=l("h1",{id:"pause-validate",tabindex:"-1"},[r("Pause & Validate "),l("a",{class:"header-anchor",href:"#pause-validate","aria-label":'Permalink to "Pause & Validate"'},"")],-1),w=l("p",null,"By pausing you can process each scanned QR-code one at a time. The last received frame is still displayed so it just looks like the stream is paused.",-1),b=B(`
With the QrcodeDropZone component you can also drag-and-drop images that should be scanned. Use it as a standalone feature or as a fallback for desktop users.
QrcodeStream always covers the entire space available. Not more, not less. So to go fullscreen, simply put the component in a wrapper element that occupies the entire screen.
You might have noticed that scanning the same QR code again doesn't work. The thing is when a QR code is in the view of your the camera it's decoded multiple times a second. You don't want to be flooded with detect events that often though. That's why the last decoded QR code is "cached" and an event is only emitted, when the decoded content changes.
However this cache is reset when you change the paused prop. We can exploit that to scan same QR codes multiple times in a row.
All other demos on this page utilize single-file components. To use them in your project you need a bundler like vite. For an example that works without a build step and right in the browser:
In low-light conditions you might want to make use of the cameras flashlight. Using the torch prop, you can turn the flashlight on/off. Note that support is inconsistent across devices and browsers and can only be detected after already starting the camera.
Finally, with QrcodeCapture comes another component which allows image scanning via classic file upload. Nothing is actually uploaded. Everything is happening client-side.
If you are on mobile and your browser supports it, you are not prompted with a file dialog but with your camera. So you can directly take the picture to be uploaded. Adjust this behavior with the following dropdown:
+
+
+
diff --git a/pr-preview/pr-422/sw.js b/pr-preview/pr-422/sw.js
new file mode 100644
index 00000000..21d06427
--- /dev/null
+++ b/pr-preview/pr-422/sw.js
@@ -0,0 +1,330 @@
+/**
+ * Copyright 2018 Google Inc. All Rights Reserved.
+ * 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.
+ */
+
+// If the loader is already loaded, just stop.
+if (!self.define) {
+ let registry = {};
+
+ // Used for `eval` and `importScripts` where we can't get script URL by other means.
+ // In both cases, it's safe to use a global var because those functions are synchronous.
+ let nextDefineUri;
+
+ const singleRequire = (uri, parentUri) => {
+ uri = new URL(uri + ".js", parentUri).href;
+ return registry[uri] || (
+
+ new Promise(resolve => {
+ if ("document" in self) {
+ const script = document.createElement("script");
+ script.src = uri;
+ script.onload = resolve;
+ document.head.appendChild(script);
+ } else {
+ nextDefineUri = uri;
+ importScripts(uri);
+ resolve();
+ }
+ })
+
+ .then(() => {
+ let promise = registry[uri];
+ if (!promise) {
+ throw new Error(`Module ${uri} didn’t register its module`);
+ }
+ return promise;
+ })
+ );
+ };
+
+ self.define = (depsNames, factory) => {
+ const uri = nextDefineUri || ("document" in self ? document.currentScript.src : "") || location.href;
+ if (registry[uri]) {
+ // Module is already loading or loaded.
+ return;
+ }
+ let exports = {};
+ const require = depUri => singleRequire(depUri, uri);
+ const specialDeps = {
+ module: { uri },
+ exports,
+ require
+ };
+ registry[uri] = Promise.all(depsNames.map(
+ depName => specialDeps[depName] || require(depName)
+ )).then(deps => {
+ factory(...deps);
+ return exports;
+ });
+ };
+}
+define(['./workbox-ab7aa862'], (function (workbox) { 'use strict';
+
+ self.skipWaiting();
+ workbox.clientsClaim();
+
+ /**
+ * The precacheAndRoute() method efficiently caches and responds to
+ * requests for URLs in the manifest.
+ * See https://goo.gl/S9QRab
+ */
+ workbox.precacheAndRoute([{
+ "url": "404.html",
+ "revision": "82fea62ea4831fe8a21d00f9ca5d9401"
+ }, {
+ "url": "api/QrcodeCapture.html",
+ "revision": "7c2f04a29fe6f160e31aee16c5184576"
+ }, {
+ "url": "api/QrcodeDropZone.html",
+ "revision": "763340ba6c9cc95e6d8656a8bbc0a97d"
+ }, {
+ "url": "api/QrcodeStream.html",
+ "revision": "9cd6bbf76b02d61fb6cacb5b8a3175fa"
+ }, {
+ "url": "assets/api_QrcodeCapture.md.CLytv12W.js",
+ "revision": null
+ }, {
+ "url": "assets/api_QrcodeCapture.md.CLytv12W.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/api_QrcodeDropZone.md.6Vhi9BoD.js",
+ "revision": null
+ }, {
+ "url": "assets/api_QrcodeDropZone.md.6Vhi9BoD.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/api_QrcodeStream.md.6U_wzjIZ.js",
+ "revision": null
+ }, {
+ "url": "assets/api_QrcodeStream.md.6U_wzjIZ.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/app.XL8Z-4aO.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/@localSearchIndexroot.uOxXtlza.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/camera.k0qov-UY.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/framework.lXWH-C-d.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/QrcodeStream.vue_vue_type_script_setup_true_lang.M0FehY61.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/safari_32x32.yJUh4Fxj.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/theme.51RuvN-X.js",
+ "revision": null
+ }, {
+ "url": "assets/chunks/VPLocalSearchBox.hsU9LcJz.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_DragDrop.md.pKahbeZR.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_DragDrop.md.pKahbeZR.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_FullDemo.md.hnclp-Su.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_FullDemo.md.hnclp-Su.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Fullscreen.md.rVl0DQdx.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Fullscreen.md.rVl0DQdx.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_LoadingIndicator.md._gfElcQN.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_LoadingIndicator.md._gfElcQN.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_ScanSameQrcodeMoreThanOnce.md.XGhy0WtB.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Simple.md.1VshYyx0.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Simple.md.1VshYyx0.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_SwitchCamera.md.cHlgHu4J.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_SwitchCamera.md.cHlgHu4J.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Torch.md.8UFlvoqz.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Torch.md.8UFlvoqz.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Upload.md.4cV7tPYv.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Upload.md.4cV7tPYv.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Validate.md.mZSvWK2M.js",
+ "revision": null
+ }, {
+ "url": "assets/demos_Validate.md.mZSvWK2M.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/index.md.P29hKITW.js",
+ "revision": null
+ }, {
+ "url": "assets/index.md.P29hKITW.lean.js",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-cyrillic-ext.OVycGSDq.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-cyrillic.-nLMcIwj.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-greek-ext.hznxWNZO.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-greek.PSfer2Kc.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-latin-ext.RnFly65-.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-latin.27E69YJn.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-italic-vietnamese.xzQHe1q1.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-cyrillic-ext.8T9wMG5w.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-cyrillic.jIZ9REo5.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-greek-ext.9JiNzaSO.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-greek.Cb5wWeGA.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-latin-ext.GZWE-KO4.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-latin.bvIUbFQP.woff2",
+ "revision": null
+ }, {
+ "url": "assets/inter-roman-vietnamese.paY3CzEB.woff2",
+ "revision": null
+ }, {
+ "url": "assets/style.Kol-L_f3.css",
+ "revision": null
+ }, {
+ "url": "camera-switch.svg",
+ "revision": "c966900237eef848d4aeb18b0ad64371"
+ }, {
+ "url": "checkmark.svg",
+ "revision": "398fc16c5cbd6c20b529b76742c33942"
+ }, {
+ "url": "debug-memory-leak.html",
+ "revision": "baffbefe1bde1d10f0c089b20f0cb9ed"
+ }, {
+ "url": "demos/DragDrop.html",
+ "revision": "8fda298bcccf53deede3b038326ddf7a"
+ }, {
+ "url": "demos/FullDemo.html",
+ "revision": "d145754e8431c89c9dff46dcda853896"
+ }, {
+ "url": "demos/Fullscreen.html",
+ "revision": "c5d65c33aba4ce38d68d9d4fe0238581"
+ }, {
+ "url": "demos/LoadingIndicator.html",
+ "revision": "d5859827e0d3bfdc460c95e314bc1c90"
+ }, {
+ "url": "demos/ScanSameQrcodeMoreThanOnce.html",
+ "revision": "2622e3e6de87940f8d747d616558c3f9"
+ }, {
+ "url": "demos/Simple.html",
+ "revision": "7c3844f17e678336b3414417ec392ff1"
+ }, {
+ "url": "demos/SwitchCamera.html",
+ "revision": "51a603900cbb644718f1032ad113c129"
+ }, {
+ "url": "demos/Torch.html",
+ "revision": "5307d3837b878bc92ff3df59c84382a3"
+ }, {
+ "url": "demos/Upload.html",
+ "revision": "2ee088f69b980f37f0d314ca762274aa"
+ }, {
+ "url": "demos/Validate.html",
+ "revision": "3e320abc22a1525b951d150f4f18b3e1"
+ }, {
+ "url": "flash-off.svg",
+ "revision": "8b05f5dcd6712992a544b34520ec7262"
+ }, {
+ "url": "flash-on.svg",
+ "revision": "23580871877110ec5e7dcd41efdbd07b"
+ }, {
+ "url": "fullscreen-exit.svg",
+ "revision": "77f8bddd41a7894d1a00324ed9dcb8f9"
+ }, {
+ "url": "fullscreen.svg",
+ "revision": "432c44f09de0b4e0f9e236fad9b8c7f9"
+ }, {
+ "url": "index.html",
+ "revision": "0c1ef4248e096c8bb041ee1f6d0b7c70"
+ }, {
+ "url": "logo.png",
+ "revision": "5f0c1d6358641bc48207acb9fa0b6182"
+ }, {
+ "url": "pwa-192x192.png",
+ "revision": "05431c417219f6c247a23488366a2b41"
+ }, {
+ "url": "pwa-512x512.png",
+ "revision": "5e0a4893ebdd02af95cf73c7b7759ddd"
+ }, {
+ "url": "registerSW.js",
+ "revision": "2dd3bf1f54895cd95baf5fd5f8f81669"
+ }, {
+ "url": "select-camera-demo.html",
+ "revision": "caa12e13f97000bc06e565e64bb8bd0f"
+ }, {
+ "url": "simple-demo.html",
+ "revision": "d2e0337bc830c36ac24089933500e897"
+ }, {
+ "url": "pwa-192x192.png",
+ "revision": "05431c417219f6c247a23488366a2b41"
+ }, {
+ "url": "pwa-512x512.png",
+ "revision": "5e0a4893ebdd02af95cf73c7b7759ddd"
+ }, {
+ "url": "manifest.webmanifest",
+ "revision": "bf160524172ad2bd1a1467ab7ca44ec3"
+ }], {});
+ workbox.cleanupOutdatedCaches();
+ workbox.registerRoute(new workbox.NavigationRoute(workbox.createHandlerBoundToURL("index.html")));
+
+}));
diff --git a/pr-preview/pr-422/workbox-ab7aa862.js b/pr-preview/pr-422/workbox-ab7aa862.js
new file mode 100644
index 00000000..62f106ff
--- /dev/null
+++ b/pr-preview/pr-422/workbox-ab7aa862.js
@@ -0,0 +1,3394 @@
+define(['exports'], (function (exports) { 'use strict';
+
+ // @ts-ignore
+ try {
+ self['workbox:core:7.0.0'] && _();
+ } catch (e) {}
+
+ /*
+ Copyright 2019 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.
+ */
+ /**
+ * Claim any currently available clients once the service worker
+ * becomes active. This is normally used in conjunction with `skipWaiting()`.
+ *
+ * @memberof workbox-core
+ */
+ function clientsClaim() {
+ self.addEventListener('activate', () => self.clients.claim());
+ }
+
+ /*
+ Copyright 2019 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.
+ */
+ const logger = (() => {
+ // Don't overwrite this value if it's already set.
+ // See https://github.com/GoogleChrome/workbox/pull/2284#issuecomment-560470923
+ if (!('__WB_DISABLE_DEV_LOGS' in globalThis)) {
+ self.__WB_DISABLE_DEV_LOGS = false;
+ }
+ let inGroup = false;
+ const methodToColorMap = {
+ debug: `#7f8c8d`,
+ log: `#2ecc71`,
+ warn: `#f39c12`,
+ error: `#c0392b`,
+ groupCollapsed: `#3498db`,
+ groupEnd: null // No colored prefix on groupEnd
+ };
+
+ const print = function (method, args) {
+ if (self.__WB_DISABLE_DEV_LOGS) {
+ return;
+ }
+ if (method === 'groupCollapsed') {
+ // Safari doesn't print all console.groupCollapsed() arguments:
+ // https://bugs.webkit.org/show_bug.cgi?id=182754
+ if (/^((?!chrome|android).)*safari/i.test(navigator.userAgent)) {
+ console[method](...args);
+ return;
+ }
+ }
+ const styles = [`background: ${methodToColorMap[method]}`, `border-radius: 0.5em`, `color: white`, `font-weight: bold`, `padding: 2px 0.5em`];
+ // When in a group, the workbox prefix is not displayed.
+ const logPrefix = inGroup ? [] : ['%cworkbox', styles.join(';')];
+ console[method](...logPrefix, ...args);
+ if (method === 'groupCollapsed') {
+ inGroup = true;
+ }
+ if (method === 'groupEnd') {
+ inGroup = false;
+ }
+ };
+ // eslint-disable-next-line @typescript-eslint/ban-types
+ const api = {};
+ const loggerMethods = Object.keys(methodToColorMap);
+ for (const key of loggerMethods) {
+ const method = key;
+ api[method] = (...args) => {
+ print(method, args);
+ };
+ }
+ return api;
+ })();
+
+ /*
+ 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.
+ */
+ const messages = {
+ 'invalid-value': ({
+ paramName,
+ validValueDescription,
+ value
+ }) => {
+ if (!paramName || !validValueDescription) {
+ throw new Error(`Unexpected input to 'invalid-value' error.`);
+ }
+ return `The '${paramName}' parameter was given a value with an ` + `unexpected value. ${validValueDescription} Received a value of ` + `${JSON.stringify(value)}.`;
+ },
+ 'not-an-array': ({
+ moduleName,
+ className,
+ funcName,
+ paramName
+ }) => {
+ if (!moduleName || !className || !funcName || !paramName) {
+ throw new Error(`Unexpected input to 'not-an-array' error.`);
+ }
+ return `The parameter '${paramName}' passed into ` + `'${moduleName}.${className}.${funcName}()' must be an array.`;
+ },
+ 'incorrect-type': ({
+ expectedType,
+ paramName,
+ moduleName,
+ className,
+ funcName
+ }) => {
+ if (!expectedType || !paramName || !moduleName || !funcName) {
+ throw new Error(`Unexpected input to 'incorrect-type' error.`);
+ }
+ const classNameStr = className ? `${className}.` : '';
+ return `The parameter '${paramName}' passed into ` + `'${moduleName}.${classNameStr}` + `${funcName}()' must be of type ${expectedType}.`;
+ },
+ 'incorrect-class': ({
+ expectedClassName,
+ paramName,
+ moduleName,
+ className,
+ funcName,
+ isReturnValueProblem
+ }) => {
+ if (!expectedClassName || !moduleName || !funcName) {
+ throw new Error(`Unexpected input to 'incorrect-class' error.`);
+ }
+ const classNameStr = className ? `${className}.` : '';
+ if (isReturnValueProblem) {
+ return `The return value from ` + `'${moduleName}.${classNameStr}${funcName}()' ` + `must be an instance of class ${expectedClassName}.`;
+ }
+ return `The parameter '${paramName}' passed into ` + `'${moduleName}.${classNameStr}${funcName}()' ` + `must be an instance of class ${expectedClassName}.`;
+ },
+ 'missing-a-method': ({
+ expectedMethod,
+ paramName,
+ moduleName,
+ className,
+ funcName
+ }) => {
+ if (!expectedMethod || !paramName || !moduleName || !className || !funcName) {
+ throw new Error(`Unexpected input to 'missing-a-method' error.`);
+ }
+ return `${moduleName}.${className}.${funcName}() expected the ` + `'${paramName}' parameter to expose a '${expectedMethod}' method.`;
+ },
+ 'add-to-cache-list-unexpected-type': ({
+ entry
+ }) => {
+ return `An unexpected entry was passed to ` + `'workbox-precaching.PrecacheController.addToCacheList()' The entry ` + `'${JSON.stringify(entry)}' isn't supported. You must supply an array of ` + `strings with one or more characters, objects with a url property or ` + `Request objects.`;
+ },
+ 'add-to-cache-list-conflicting-entries': ({
+ firstEntry,
+ secondEntry
+ }) => {
+ if (!firstEntry || !secondEntry) {
+ throw new Error(`Unexpected input to ` + `'add-to-cache-list-duplicate-entries' error.`);
+ }
+ return `Two of the entries passed to ` + `'workbox-precaching.PrecacheController.addToCacheList()' had the URL ` + `${firstEntry} but different revision details. Workbox is ` + `unable to cache and version the asset correctly. Please remove one ` + `of the entries.`;
+ },
+ 'plugin-error-request-will-fetch': ({
+ thrownErrorMessage
+ }) => {
+ if (!thrownErrorMessage) {
+ throw new Error(`Unexpected input to ` + `'plugin-error-request-will-fetch', error.`);
+ }
+ return `An error was thrown by a plugins 'requestWillFetch()' method. ` + `The thrown error message was: '${thrownErrorMessage}'.`;
+ },
+ 'invalid-cache-name': ({
+ cacheNameId,
+ value
+ }) => {
+ if (!cacheNameId) {
+ throw new Error(`Expected a 'cacheNameId' for error 'invalid-cache-name'`);
+ }
+ return `You must provide a name containing at least one character for ` + `setCacheDetails({${cacheNameId}: '...'}). Received a value of ` + `'${JSON.stringify(value)}'`;
+ },
+ 'unregister-route-but-not-found-with-method': ({
+ method
+ }) => {
+ if (!method) {
+ throw new Error(`Unexpected input to ` + `'unregister-route-but-not-found-with-method' error.`);
+ }
+ return `The route you're trying to unregister was not previously ` + `registered for the method type '${method}'.`;
+ },
+ 'unregister-route-route-not-registered': () => {
+ return `The route you're trying to unregister was not previously ` + `registered.`;
+ },
+ 'queue-replay-failed': ({
+ name
+ }) => {
+ return `Replaying the background sync queue '${name}' failed.`;
+ },
+ 'duplicate-queue-name': ({
+ name
+ }) => {
+ return `The Queue name '${name}' is already being used. ` + `All instances of backgroundSync.Queue must be given unique names.`;
+ },
+ 'expired-test-without-max-age': ({
+ methodName,
+ paramName
+ }) => {
+ return `The '${methodName}()' method can only be used when the ` + `'${paramName}' is used in the constructor.`;
+ },
+ 'unsupported-route-type': ({
+ moduleName,
+ className,
+ funcName,
+ paramName
+ }) => {
+ return `The supplied '${paramName}' parameter was an unsupported type. ` + `Please check the docs for ${moduleName}.${className}.${funcName} for ` + `valid input types.`;
+ },
+ 'not-array-of-class': ({
+ value,
+ expectedClass,
+ moduleName,
+ className,
+ funcName,
+ paramName
+ }) => {
+ return `The supplied '${paramName}' parameter must be an array of ` + `'${expectedClass}' objects. Received '${JSON.stringify(value)},'. ` + `Please check the call to ${moduleName}.${className}.${funcName}() ` + `to fix the issue.`;
+ },
+ 'max-entries-or-age-required': ({
+ moduleName,
+ className,
+ funcName
+ }) => {
+ return `You must define either config.maxEntries or config.maxAgeSeconds` + `in ${moduleName}.${className}.${funcName}`;
+ },
+ 'statuses-or-headers-required': ({
+ moduleName,
+ className,
+ funcName
+ }) => {
+ return `You must define either config.statuses or config.headers` + `in ${moduleName}.${className}.${funcName}`;
+ },
+ 'invalid-string': ({
+ moduleName,
+ funcName,
+ paramName
+ }) => {
+ if (!paramName || !moduleName || !funcName) {
+ throw new Error(`Unexpected input to 'invalid-string' error.`);
+ }
+ return `When using strings, the '${paramName}' parameter must start with ` + `'http' (for cross-origin matches) or '/' (for same-origin matches). ` + `Please see the docs for ${moduleName}.${funcName}() for ` + `more info.`;
+ },
+ 'channel-name-required': () => {
+ return `You must provide a channelName to construct a ` + `BroadcastCacheUpdate instance.`;
+ },
+ 'invalid-responses-are-same-args': () => {
+ return `The arguments passed into responsesAreSame() appear to be ` + `invalid. Please ensure valid Responses are used.`;
+ },
+ 'expire-custom-caches-only': () => {
+ return `You must provide a 'cacheName' property when using the ` + `expiration plugin with a runtime caching strategy.`;
+ },
+ 'unit-must-be-bytes': ({
+ normalizedRangeHeader
+ }) => {
+ if (!normalizedRangeHeader) {
+ throw new Error(`Unexpected input to 'unit-must-be-bytes' error.`);
+ }
+ return `The 'unit' portion of the Range header must be set to 'bytes'. ` + `The Range header provided was "${normalizedRangeHeader}"`;
+ },
+ 'single-range-only': ({
+ normalizedRangeHeader
+ }) => {
+ if (!normalizedRangeHeader) {
+ throw new Error(`Unexpected input to 'single-range-only' error.`);
+ }
+ return `Multiple ranges are not supported. Please use a single start ` + `value, and optional end value. The Range header provided was ` + `"${normalizedRangeHeader}"`;
+ },
+ 'invalid-range-values': ({
+ normalizedRangeHeader
+ }) => {
+ if (!normalizedRangeHeader) {
+ throw new Error(`Unexpected input to 'invalid-range-values' error.`);
+ }
+ return `The Range header is missing both start and end values. At least ` + `one of those values is needed. The Range header provided was ` + `"${normalizedRangeHeader}"`;
+ },
+ 'no-range-header': () => {
+ return `No Range header was found in the Request provided.`;
+ },
+ 'range-not-satisfiable': ({
+ size,
+ start,
+ end
+ }) => {
+ return `The start (${start}) and end (${end}) values in the Range are ` + `not satisfiable by the cached response, which is ${size} bytes.`;
+ },
+ 'attempt-to-cache-non-get-request': ({
+ url,
+ method
+ }) => {
+ return `Unable to cache '${url}' because it is a '${method}' request and ` + `only 'GET' requests can be cached.`;
+ },
+ 'cache-put-with-no-response': ({
+ url
+ }) => {
+ return `There was an attempt to cache '${url}' but the response was not ` + `defined.`;
+ },
+ 'no-response': ({
+ url,
+ error
+ }) => {
+ let message = `The strategy could not generate a response for '${url}'.`;
+ if (error) {
+ message += ` The underlying error is ${error}.`;
+ }
+ return message;
+ },
+ 'bad-precaching-response': ({
+ url,
+ status
+ }) => {
+ return `The precaching request for '${url}' failed` + (status ? ` with an HTTP status of ${status}.` : `.`);
+ },
+ 'non-precached-url': ({
+ url
+ }) => {
+ return `createHandlerBoundToURL('${url}') was called, but that URL is ` + `not precached. Please pass in a URL that is precached instead.`;
+ },
+ 'add-to-cache-list-conflicting-integrities': ({
+ url
+ }) => {
+ return `Two of the entries passed to ` + `'workbox-precaching.PrecacheController.addToCacheList()' had the URL ` + `${url} with different integrity values. Please remove one of them.`;
+ },
+ 'missing-precache-entry': ({
+ cacheName,
+ url
+ }) => {
+ return `Unable to find a precached response in ${cacheName} for ${url}.`;
+ },
+ 'cross-origin-copy-response': ({
+ origin
+ }) => {
+ return `workbox-core.copyResponse() can only be used with same-origin ` + `responses. It was passed a response with origin ${origin}.`;
+ },
+ 'opaque-streams-source': ({
+ type
+ }) => {
+ const message = `One of the workbox-streams sources resulted in an ` + `'${type}' response.`;
+ if (type === 'opaqueredirect') {
+ return `${message} Please do not use a navigation request that results ` + `in a redirect as a source.`;
+ }
+ return `${message} Please ensure your sources are CORS-enabled.`;
+ }
+ };
+
+ /*
+ 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.
+ */
+ const generatorFunction = (code, details = {}) => {
+ const message = messages[code];
+ if (!message) {
+ throw new Error(`Unable to find message for code '${code}'.`);
+ }
+ return message(details);
+ };
+ const messageGenerator = generatorFunction;
+
+ /*
+ 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.
+ */
+ /**
+ * Workbox errors should be thrown with this class.
+ * This allows use to ensure the type easily in tests,
+ * helps developers identify errors from workbox
+ * easily and allows use to optimise error
+ * messages correctly.
+ *
+ * @private
+ */
+ class WorkboxError extends Error {
+ /**
+ *
+ * @param {string} errorCode The error code that
+ * identifies this particular error.
+ * @param {Object=} details Any relevant arguments
+ * that will help developers identify issues should
+ * be added as a key on the context object.
+ */
+ constructor(errorCode, details) {
+ const message = messageGenerator(errorCode, details);
+ super(message);
+ this.name = errorCode;
+ this.details = details;
+ }
+ }
+
+ /*
+ 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.
+ */
+ /*
+ * This method throws if the supplied value is not an array.
+ * The destructed values are required to produce a meaningful error for users.
+ * The destructed and restructured object is so it's clear what is
+ * needed.
+ */
+ const isArray = (value, details) => {
+ if (!Array.isArray(value)) {
+ throw new WorkboxError('not-an-array', details);
+ }
+ };
+ const hasMethod = (object, expectedMethod, details) => {
+ const type = typeof object[expectedMethod];
+ if (type !== 'function') {
+ details['expectedMethod'] = expectedMethod;
+ throw new WorkboxError('missing-a-method', details);
+ }
+ };
+ const isType = (object, expectedType, details) => {
+ if (typeof object !== expectedType) {
+ details['expectedType'] = expectedType;
+ throw new WorkboxError('incorrect-type', details);
+ }
+ };
+ const isInstance = (object,
+ // Need the general type to do the check later.
+ // eslint-disable-next-line @typescript-eslint/ban-types
+ expectedClass, details) => {
+ if (!(object instanceof expectedClass)) {
+ details['expectedClassName'] = expectedClass.name;
+ throw new WorkboxError('incorrect-class', details);
+ }
+ };
+ const isOneOf = (value, validValues, details) => {
+ if (!validValues.includes(value)) {
+ details['validValueDescription'] = `Valid values are ${JSON.stringify(validValues)}.`;
+ throw new WorkboxError('invalid-value', details);
+ }
+ };
+ const isArrayOfClass = (value,
+ // Need general type to do check later.
+ expectedClass,
+ // eslint-disable-line
+ details) => {
+ const error = new WorkboxError('not-array-of-class', details);
+ if (!Array.isArray(value)) {
+ throw error;
+ }
+ for (const item of value) {
+ if (!(item instanceof expectedClass)) {
+ throw error;
+ }
+ }
+ };
+ const finalAssertExports = {
+ hasMethod,
+ isArray,
+ isInstance,
+ isOneOf,
+ isType,
+ isArrayOfClass
+ };
+
+ // @ts-ignore
+ try {
+ self['workbox:routing:7.0.0'] && _();
+ } catch (e) {}
+
+ /*
+ 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.
+ */
+ /**
+ * The default HTTP method, 'GET', used when there's no specific method
+ * configured for a route.
+ *
+ * @type {string}
+ *
+ * @private
+ */
+ const defaultMethod = 'GET';
+ /**
+ * The list of valid HTTP methods associated with requests that could be routed.
+ *
+ * @type {Array}
+ *
+ * @private
+ */
+ const validMethods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT'];
+
+ /*
+ 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.
+ */
+ /**
+ * @param {function()|Object} handler Either a function, or an object with a
+ * 'handle' method.
+ * @return {Object} An object with a handle method.
+ *
+ * @private
+ */
+ const normalizeHandler = handler => {
+ if (handler && typeof handler === 'object') {
+ {
+ finalAssertExports.hasMethod(handler, 'handle', {
+ moduleName: 'workbox-routing',
+ className: 'Route',
+ funcName: 'constructor',
+ paramName: 'handler'
+ });
+ }
+ return handler;
+ } else {
+ {
+ finalAssertExports.isType(handler, 'function', {
+ moduleName: 'workbox-routing',
+ className: 'Route',
+ funcName: 'constructor',
+ paramName: 'handler'
+ });
+ }
+ return {
+ handle: handler
+ };
+ }
+ };
+
+ /*
+ 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.
+ */
+ /**
+ * A `Route` consists of a pair of callback functions, "match" and "handler".
+ * The "match" callback determine if a route should be used to "handle" a
+ * request by returning a non-falsy value if it can. The "handler" callback
+ * is called when there is a match and should return a Promise that resolves
+ * to a `Response`.
+ *
+ * @memberof workbox-routing
+ */
+ class Route {
+ /**
+ * Constructor for Route class.
+ *
+ * @param {workbox-routing~matchCallback} match
+ * A callback function that determines whether the route matches a given
+ * `fetch` event by returning a non-falsy value.
+ * @param {workbox-routing~handlerCallback} handler A callback
+ * function that returns a Promise resolving to a Response.
+ * @param {string} [method='GET'] The HTTP method to match the Route
+ * against.
+ */
+ constructor(match, handler, method = defaultMethod) {
+ {
+ finalAssertExports.isType(match, 'function', {
+ moduleName: 'workbox-routing',
+ className: 'Route',
+ funcName: 'constructor',
+ paramName: 'match'
+ });
+ if (method) {
+ finalAssertExports.isOneOf(method, validMethods, {
+ paramName: 'method'
+ });
+ }
+ }
+ // These values are referenced directly by Router so cannot be
+ // altered by minificaton.
+ this.handler = normalizeHandler(handler);
+ this.match = match;
+ this.method = method;
+ }
+ /**
+ *
+ * @param {workbox-routing-handlerCallback} handler A callback
+ * function that returns a Promise resolving to a Response
+ */
+ setCatchHandler(handler) {
+ this.catchHandler = normalizeHandler(handler);
+ }
+ }
+
+ /*
+ 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.
+ */
+ /**
+ * RegExpRoute makes it easy to create a regular expression based
+ * {@link workbox-routing.Route}.
+ *
+ * For same-origin requests the RegExp only needs to match part of the URL. For
+ * requests against third-party servers, you must define a RegExp that matches
+ * the start of the URL.
+ *
+ * @memberof workbox-routing
+ * @extends workbox-routing.Route
+ */
+ class RegExpRoute extends Route {
+ /**
+ * If the regular expression contains
+ * [capture groups]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#grouping-back-references},
+ * the captured values will be passed to the
+ * {@link workbox-routing~handlerCallback} `params`
+ * argument.
+ *
+ * @param {RegExp} regExp The regular expression to match against URLs.
+ * @param {workbox-routing~handlerCallback} handler A callback
+ * function that returns a Promise resulting in a Response.
+ * @param {string} [method='GET'] The HTTP method to match the Route
+ * against.
+ */
+ constructor(regExp, handler, method) {
+ {
+ finalAssertExports.isInstance(regExp, RegExp, {
+ moduleName: 'workbox-routing',
+ className: 'RegExpRoute',
+ funcName: 'constructor',
+ paramName: 'pattern'
+ });
+ }
+ const match = ({
+ url
+ }) => {
+ const result = regExp.exec(url.href);
+ // Return immediately if there's no match.
+ if (!result) {
+ return;
+ }
+ // Require that the match start at the first character in the URL string
+ // if it's a cross-origin request.
+ // See https://github.com/GoogleChrome/workbox/issues/281 for the context
+ // behind this behavior.
+ if (url.origin !== location.origin && result.index !== 0) {
+ {
+ logger.debug(`The regular expression '${regExp.toString()}' only partially matched ` + `against the cross-origin URL '${url.toString()}'. RegExpRoute's will only ` + `handle cross-origin requests if they match the entire URL.`);
+ }
+ return;
+ }
+ // If the route matches, but there aren't any capture groups defined, then
+ // this will return [], which is truthy and therefore sufficient to
+ // indicate a match.
+ // If there are capture groups, then it will return their values.
+ return result.slice(1);
+ };
+ super(match, handler, method);
+ }
+ }
+
+ /*
+ 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.
+ */
+ const getFriendlyURL = url => {
+ const urlObj = new URL(String(url), location.href);
+ // See https://github.com/GoogleChrome/workbox/issues/2323
+ // We want to include everything, except for the origin if it's same-origin.
+ return urlObj.href.replace(new RegExp(`^${location.origin}`), '');
+ };
+
+ /*
+ 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.
+ */
+ /**
+ * The Router can be used to process a `FetchEvent` using one or more
+ * {@link workbox-routing.Route}, responding with a `Response` if
+ * a matching route exists.
+ *
+ * If no route matches a given a request, the Router will use a "default"
+ * handler if one is defined.
+ *
+ * Should the matching Route throw an error, the Router will use a "catch"
+ * handler if one is defined to gracefully deal with issues and respond with a
+ * Request.
+ *
+ * If a request matches multiple routes, the **earliest** registered route will
+ * be used to respond to the request.
+ *
+ * @memberof workbox-routing
+ */
+ class Router {
+ /**
+ * Initializes a new Router.
+ */
+ constructor() {
+ this._routes = new Map();
+ this._defaultHandlerMap = new Map();
+ }
+ /**
+ * @return {Map>} routes A `Map` of HTTP
+ * method name ('GET', etc.) to an array of all the corresponding `Route`
+ * instances that are registered.
+ */
+ get routes() {
+ return this._routes;
+ }
+ /**
+ * Adds a fetch event listener to respond to events when a route matches
+ * the event's request.
+ */
+ addFetchListener() {
+ // See https://github.com/Microsoft/TypeScript/issues/28357#issuecomment-436484705
+ self.addEventListener('fetch', event => {
+ const {
+ request
+ } = event;
+ const responsePromise = this.handleRequest({
+ request,
+ event
+ });
+ if (responsePromise) {
+ event.respondWith(responsePromise);
+ }
+ });
+ }
+ /**
+ * Adds a message event listener for URLs to cache from the window.
+ * This is useful to cache resources loaded on the page prior to when the
+ * service worker started controlling it.
+ *
+ * The format of the message data sent from the window should be as follows.
+ * Where the `urlsToCache` array may consist of URL strings or an array of
+ * URL string + `requestInit` object (the same as you'd pass to `fetch()`).
+ *
+ * ```
+ * {
+ * type: 'CACHE_URLS',
+ * payload: {
+ * urlsToCache: [
+ * './script1.js',
+ * './script2.js',
+ * ['./script3.js', {mode: 'no-cors'}],
+ * ],
+ * },
+ * }
+ * ```
+ */
+ addCacheListener() {
+ // See https://github.com/Microsoft/TypeScript/issues/28357#issuecomment-436484705
+ self.addEventListener('message', event => {
+ // event.data is type 'any'
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+ if (event.data && event.data.type === 'CACHE_URLS') {
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+ const {
+ payload
+ } = event.data;
+ {
+ logger.debug(`Caching URLs from the window`, payload.urlsToCache);
+ }
+ const requestPromises = Promise.all(payload.urlsToCache.map(entry => {
+ if (typeof entry === 'string') {
+ entry = [entry];
+ }
+ const request = new Request(...entry);
+ return this.handleRequest({
+ request,
+ event
+ });
+ // TODO(philipwalton): TypeScript errors without this typecast for
+ // some reason (probably a bug). The real type here should work but
+ // doesn't: `Array | undefined>`.
+ })); // TypeScript
+ event.waitUntil(requestPromises);
+ // If a MessageChannel was used, reply to the message on success.
+ if (event.ports && event.ports[0]) {
+ void requestPromises.then(() => event.ports[0].postMessage(true));
+ }
+ }
+ });
+ }
+ /**
+ * Apply the routing rules to a FetchEvent object to get a Response from an
+ * appropriate Route's handler.
+ *
+ * @param {Object} options
+ * @param {Request} options.request The request to handle.
+ * @param {ExtendableEvent} options.event The event that triggered the
+ * request.
+ * @return {Promise|undefined} A promise is returned if a
+ * registered route can handle the request. If there is no matching
+ * route and there's no `defaultHandler`, `undefined` is returned.
+ */
+ handleRequest({
+ request,
+ event
+ }) {
+ {
+ finalAssertExports.isInstance(request, Request, {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'handleRequest',
+ paramName: 'options.request'
+ });
+ }
+ const url = new URL(request.url, location.href);
+ if (!url.protocol.startsWith('http')) {
+ {
+ logger.debug(`Workbox Router only supports URLs that start with 'http'.`);
+ }
+ return;
+ }
+ const sameOrigin = url.origin === location.origin;
+ const {
+ params,
+ route
+ } = this.findMatchingRoute({
+ event,
+ request,
+ sameOrigin,
+ url
+ });
+ let handler = route && route.handler;
+ const debugMessages = [];
+ {
+ if (handler) {
+ debugMessages.push([`Found a route to handle this request:`, route]);
+ if (params) {
+ debugMessages.push([`Passing the following params to the route's handler:`, params]);
+ }
+ }
+ }
+ // If we don't have a handler because there was no matching route, then
+ // fall back to defaultHandler if that's defined.
+ const method = request.method;
+ if (!handler && this._defaultHandlerMap.has(method)) {
+ {
+ debugMessages.push(`Failed to find a matching route. Falling ` + `back to the default handler for ${method}.`);
+ }
+ handler = this._defaultHandlerMap.get(method);
+ }
+ if (!handler) {
+ {
+ // No handler so Workbox will do nothing. If logs is set of debug
+ // i.e. verbose, we should print out this information.
+ logger.debug(`No route found for: ${getFriendlyURL(url)}`);
+ }
+ return;
+ }
+ {
+ // We have a handler, meaning Workbox is going to handle the route.
+ // print the routing details to the console.
+ logger.groupCollapsed(`Router is responding to: ${getFriendlyURL(url)}`);
+ debugMessages.forEach(msg => {
+ if (Array.isArray(msg)) {
+ logger.log(...msg);
+ } else {
+ logger.log(msg);
+ }
+ });
+ logger.groupEnd();
+ }
+ // Wrap in try and catch in case the handle method throws a synchronous
+ // error. It should still callback to the catch handler.
+ let responsePromise;
+ try {
+ responsePromise = handler.handle({
+ url,
+ request,
+ event,
+ params
+ });
+ } catch (err) {
+ responsePromise = Promise.reject(err);
+ }
+ // Get route's catch handler, if it exists
+ const catchHandler = route && route.catchHandler;
+ if (responsePromise instanceof Promise && (this._catchHandler || catchHandler)) {
+ responsePromise = responsePromise.catch(async err => {
+ // If there's a route catch handler, process that first
+ if (catchHandler) {
+ {
+ // Still include URL here as it will be async from the console group
+ // and may not make sense without the URL
+ logger.groupCollapsed(`Error thrown when responding to: ` + ` ${getFriendlyURL(url)}. Falling back to route's Catch Handler.`);
+ logger.error(`Error thrown by:`, route);
+ logger.error(err);
+ logger.groupEnd();
+ }
+ try {
+ return await catchHandler.handle({
+ url,
+ request,
+ event,
+ params
+ });
+ } catch (catchErr) {
+ if (catchErr instanceof Error) {
+ err = catchErr;
+ }
+ }
+ }
+ if (this._catchHandler) {
+ {
+ // Still include URL here as it will be async from the console group
+ // and may not make sense without the URL
+ logger.groupCollapsed(`Error thrown when responding to: ` + ` ${getFriendlyURL(url)}. Falling back to global Catch Handler.`);
+ logger.error(`Error thrown by:`, route);
+ logger.error(err);
+ logger.groupEnd();
+ }
+ return this._catchHandler.handle({
+ url,
+ request,
+ event
+ });
+ }
+ throw err;
+ });
+ }
+ return responsePromise;
+ }
+ /**
+ * Checks a request and URL (and optionally an event) against the list of
+ * registered routes, and if there's a match, returns the corresponding
+ * route along with any params generated by the match.
+ *
+ * @param {Object} options
+ * @param {URL} options.url
+ * @param {boolean} options.sameOrigin The result of comparing `url.origin`
+ * against the current origin.
+ * @param {Request} options.request The request to match.
+ * @param {Event} options.event The corresponding event.
+ * @return {Object} An object with `route` and `params` properties.
+ * They are populated if a matching route was found or `undefined`
+ * otherwise.
+ */
+ findMatchingRoute({
+ url,
+ sameOrigin,
+ request,
+ event
+ }) {
+ const routes = this._routes.get(request.method) || [];
+ for (const route of routes) {
+ let params;
+ // route.match returns type any, not possible to change right now.
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+ const matchResult = route.match({
+ url,
+ sameOrigin,
+ request,
+ event
+ });
+ if (matchResult) {
+ {
+ // Warn developers that using an async matchCallback is almost always
+ // not the right thing to do.
+ if (matchResult instanceof Promise) {
+ logger.warn(`While routing ${getFriendlyURL(url)}, an async ` + `matchCallback function was used. Please convert the ` + `following route to use a synchronous matchCallback function:`, route);
+ }
+ }
+ // See https://github.com/GoogleChrome/workbox/issues/2079
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+ params = matchResult;
+ if (Array.isArray(params) && params.length === 0) {
+ // Instead of passing an empty array in as params, use undefined.
+ params = undefined;
+ } else if (matchResult.constructor === Object &&
+ // eslint-disable-line
+ Object.keys(matchResult).length === 0) {
+ // Instead of passing an empty object in as params, use undefined.
+ params = undefined;
+ } else if (typeof matchResult === 'boolean') {
+ // For the boolean value true (rather than just something truth-y),
+ // don't set params.
+ // See https://github.com/GoogleChrome/workbox/pull/2134#issuecomment-513924353
+ params = undefined;
+ }
+ // Return early if have a match.
+ return {
+ route,
+ params
+ };
+ }
+ }
+ // If no match was found above, return and empty object.
+ return {};
+ }
+ /**
+ * Define a default `handler` that's called when no routes explicitly
+ * match the incoming request.
+ *
+ * Each HTTP method ('GET', 'POST', etc.) gets its own default handler.
+ *
+ * Without a default handler, unmatched requests will go against the
+ * network as if there were no service worker present.
+ *
+ * @param {workbox-routing~handlerCallback} handler A callback
+ * function that returns a Promise resulting in a Response.
+ * @param {string} [method='GET'] The HTTP method to associate with this
+ * default handler. Each method has its own default.
+ */
+ setDefaultHandler(handler, method = defaultMethod) {
+ this._defaultHandlerMap.set(method, normalizeHandler(handler));
+ }
+ /**
+ * If a Route throws an error while handling a request, this `handler`
+ * will be called and given a chance to provide a response.
+ *
+ * @param {workbox-routing~handlerCallback} handler A callback
+ * function that returns a Promise resulting in a Response.
+ */
+ setCatchHandler(handler) {
+ this._catchHandler = normalizeHandler(handler);
+ }
+ /**
+ * Registers a route with the router.
+ *
+ * @param {workbox-routing.Route} route The route to register.
+ */
+ registerRoute(route) {
+ {
+ finalAssertExports.isType(route, 'object', {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'registerRoute',
+ paramName: 'route'
+ });
+ finalAssertExports.hasMethod(route, 'match', {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'registerRoute',
+ paramName: 'route'
+ });
+ finalAssertExports.isType(route.handler, 'object', {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'registerRoute',
+ paramName: 'route'
+ });
+ finalAssertExports.hasMethod(route.handler, 'handle', {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'registerRoute',
+ paramName: 'route.handler'
+ });
+ finalAssertExports.isType(route.method, 'string', {
+ moduleName: 'workbox-routing',
+ className: 'Router',
+ funcName: 'registerRoute',
+ paramName: 'route.method'
+ });
+ }
+ if (!this._routes.has(route.method)) {
+ this._routes.set(route.method, []);
+ }
+ // Give precedence to all of the earlier routes by adding this additional
+ // route to the end of the array.
+ this._routes.get(route.method).push(route);
+ }
+ /**
+ * Unregisters a route with the router.
+ *
+ * @param {workbox-routing.Route} route The route to unregister.
+ */
+ unregisterRoute(route) {
+ if (!this._routes.has(route.method)) {
+ throw new WorkboxError('unregister-route-but-not-found-with-method', {
+ method: route.method
+ });
+ }
+ const routeIndex = this._routes.get(route.method).indexOf(route);
+ if (routeIndex > -1) {
+ this._routes.get(route.method).splice(routeIndex, 1);
+ } else {
+ throw new WorkboxError('unregister-route-route-not-registered');
+ }
+ }
+ }
+
+ /*
+ Copyright 2019 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.
+ */
+ let defaultRouter;
+ /**
+ * Creates a new, singleton Router instance if one does not exist. If one
+ * does already exist, that instance is returned.
+ *
+ * @private
+ * @return {Router}
+ */
+ const getOrCreateDefaultRouter = () => {
+ if (!defaultRouter) {
+ defaultRouter = new Router();
+ // The helpers that use the default Router assume these listeners exist.
+ defaultRouter.addFetchListener();
+ defaultRouter.addCacheListener();
+ }
+ return defaultRouter;
+ };
+
+ /*
+ Copyright 2019 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.
+ */
+ /**
+ * Easily register a RegExp, string, or function with a caching
+ * strategy to a singleton Router instance.
+ *
+ * This method will generate a Route for you if needed and
+ * call {@link workbox-routing.Router#registerRoute}.
+ *
+ * @param {RegExp|string|workbox-routing.Route~matchCallback|workbox-routing.Route} capture
+ * If the capture param is a `Route`, all other arguments will be ignored.
+ * @param {workbox-routing~handlerCallback} [handler] A callback
+ * function that returns a Promise resulting in a Response. This parameter
+ * is required if `capture` is not a `Route` object.
+ * @param {string} [method='GET'] The HTTP method to match the Route
+ * against.
+ * @return {workbox-routing.Route} The generated `Route`.
+ *
+ * @memberof workbox-routing
+ */
+ function registerRoute(capture, handler, method) {
+ let route;
+ if (typeof capture === 'string') {
+ const captureUrl = new URL(capture, location.href);
+ {
+ if (!(capture.startsWith('/') || capture.startsWith('http'))) {
+ throw new WorkboxError('invalid-string', {
+ moduleName: 'workbox-routing',
+ funcName: 'registerRoute',
+ paramName: 'capture'
+ });
+ }
+ // We want to check if Express-style wildcards are in the pathname only.
+ // TODO: Remove this log message in v4.
+ const valueToCheck = capture.startsWith('http') ? captureUrl.pathname : capture;
+ // See https://github.com/pillarjs/path-to-regexp#parameters
+ const wildcards = '[*:?+]';
+ if (new RegExp(`${wildcards}`).exec(valueToCheck)) {
+ logger.debug(`The '$capture' parameter contains an Express-style wildcard ` + `character (${wildcards}). Strings are now always interpreted as ` + `exact matches; use a RegExp for partial or wildcard matches.`);
+ }
+ }
+ const matchCallback = ({
+ url
+ }) => {
+ {
+ if (url.pathname === captureUrl.pathname && url.origin !== captureUrl.origin) {
+ logger.debug(`${capture} only partially matches the cross-origin URL ` + `${url.toString()}. This route will only handle cross-origin requests ` + `if they match the entire URL.`);
+ }
+ }
+ return url.href === captureUrl.href;
+ };
+ // If `capture` is a string then `handler` and `method` must be present.
+ route = new Route(matchCallback, handler, method);
+ } else if (capture instanceof RegExp) {
+ // If `capture` is a `RegExp` then `handler` and `method` must be present.
+ route = new RegExpRoute(capture, handler, method);
+ } else if (typeof capture === 'function') {
+ // If `capture` is a function then `handler` and `method` must be present.
+ route = new Route(capture, handler, method);
+ } else if (capture instanceof Route) {
+ route = capture;
+ } else {
+ throw new WorkboxError('unsupported-route-type', {
+ moduleName: 'workbox-routing',
+ funcName: 'registerRoute',
+ paramName: 'capture'
+ });
+ }
+ const defaultRouter = getOrCreateDefaultRouter();
+ defaultRouter.registerRoute(route);
+ return route;
+ }
+
+ /*
+ 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.
+ */
+ const _cacheNameDetails = {
+ googleAnalytics: 'googleAnalytics',
+ precache: 'precache-v2',
+ prefix: 'workbox',
+ runtime: 'runtime',
+ suffix: typeof registration !== 'undefined' ? registration.scope : ''
+ };
+ const _createCacheName = cacheName => {
+ return [_cacheNameDetails.prefix, cacheName, _cacheNameDetails.suffix].filter(value => value && value.length > 0).join('-');
+ };
+ const eachCacheNameDetail = fn => {
+ for (const key of Object.keys(_cacheNameDetails)) {
+ fn(key);
+ }
+ };
+ const cacheNames = {
+ updateDetails: details => {
+ eachCacheNameDetail(key => {
+ if (typeof details[key] === 'string') {
+ _cacheNameDetails[key] = details[key];
+ }
+ });
+ },
+ getGoogleAnalyticsName: userCacheName => {
+ return userCacheName || _createCacheName(_cacheNameDetails.googleAnalytics);
+ },
+ getPrecacheName: userCacheName => {
+ return userCacheName || _createCacheName(_cacheNameDetails.precache);
+ },
+ getPrefix: () => {
+ return _cacheNameDetails.prefix;
+ },
+ getRuntimeName: userCacheName => {
+ return userCacheName || _createCacheName(_cacheNameDetails.runtime);
+ },
+ getSuffix: () => {
+ return _cacheNameDetails.suffix;
+ }
+ };
+
+ /*
+ Copyright 2020 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.
+ */
+ /**
+ * A utility method that makes it easier to use `event.waitUntil` with
+ * async functions and return the result.
+ *
+ * @param {ExtendableEvent} event
+ * @param {Function} asyncFn
+ * @return {Function}
+ * @private
+ */
+ function waitUntil(event, asyncFn) {
+ const returnPromise = asyncFn();
+ event.waitUntil(returnPromise);
+ return returnPromise;
+ }
+
+ // @ts-ignore
+ try {
+ self['workbox:precaching:7.0.0'] && _();
+ } catch (e) {}
+
+ /*
+ 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.
+ */
+ // Name of the search parameter used to store revision info.
+ const REVISION_SEARCH_PARAM = '__WB_REVISION__';
+ /**
+ * Converts a manifest entry into a versioned URL suitable for precaching.
+ *
+ * @param {Object|string} entry
+ * @return {string} A URL with versioning info.
+ *
+ * @private
+ * @memberof workbox-precaching
+ */
+ function createCacheKey(entry) {
+ if (!entry) {
+ throw new WorkboxError('add-to-cache-list-unexpected-type', {
+ entry
+ });
+ }
+ // If a precache manifest entry is a string, it's assumed to be a versioned
+ // URL, like '/app.abcd1234.js'. Return as-is.
+ if (typeof entry === 'string') {
+ const urlObject = new URL(entry, location.href);
+ return {
+ cacheKey: urlObject.href,
+ url: urlObject.href
+ };
+ }
+ const {
+ revision,
+ url
+ } = entry;
+ if (!url) {
+ throw new WorkboxError('add-to-cache-list-unexpected-type', {
+ entry
+ });
+ }
+ // If there's just a URL and no revision, then it's also assumed to be a
+ // versioned URL.
+ if (!revision) {
+ const urlObject = new URL(url, location.href);
+ return {
+ cacheKey: urlObject.href,
+ url: urlObject.href
+ };
+ }
+ // Otherwise, construct a properly versioned URL using the custom Workbox
+ // search parameter along with the revision info.
+ const cacheKeyURL = new URL(url, location.href);
+ const originalURL = new URL(url, location.href);
+ cacheKeyURL.searchParams.set(REVISION_SEARCH_PARAM, revision);
+ return {
+ cacheKey: cacheKeyURL.href,
+ url: originalURL.href
+ };
+ }
+
+ /*
+ Copyright 2020 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.
+ */
+ /**
+ * A plugin, designed to be used with PrecacheController, to determine the
+ * of assets that were updated (or not updated) during the install event.
+ *
+ * @private
+ */
+ class PrecacheInstallReportPlugin {
+ constructor() {
+ this.updatedURLs = [];
+ this.notUpdatedURLs = [];
+ this.handlerWillStart = async ({
+ request,
+ state
+ }) => {
+ // TODO: `state` should never be undefined...
+ if (state) {
+ state.originalRequest = request;
+ }
+ };
+ this.cachedResponseWillBeUsed = async ({
+ event,
+ state,
+ cachedResponse
+ }) => {
+ if (event.type === 'install') {
+ if (state && state.originalRequest && state.originalRequest instanceof Request) {
+ // TODO: `state` should never be undefined...
+ const url = state.originalRequest.url;
+ if (cachedResponse) {
+ this.notUpdatedURLs.push(url);
+ } else {
+ this.updatedURLs.push(url);
+ }
+ }
+ }
+ return cachedResponse;
+ };
+ }
+ }
+
+ /*
+ Copyright 2020 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.
+ */
+ /**
+ * A plugin, designed to be used with PrecacheController, to translate URLs into
+ * the corresponding cache key, based on the current revision info.
+ *
+ * @private
+ */
+ class PrecacheCacheKeyPlugin {
+ constructor({
+ precacheController
+ }) {
+ this.cacheKeyWillBeUsed = async ({
+ request,
+ params
+ }) => {
+ // Params is type any, can't change right now.
+ /* eslint-disable */
+ const cacheKey = (params === null || params === void 0 ? void 0 : params.cacheKey) || this._precacheController.getCacheKeyForURL(request.url);
+ /* eslint-enable */
+ return cacheKey ? new Request(cacheKey, {
+ headers: request.headers
+ }) : request;
+ };
+ this._precacheController = precacheController;
+ }
+ }
+
+ /*
+ 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.
+ */
+ /**
+ * @param {string} groupTitle
+ * @param {Array} deletedURLs
+ *
+ * @private
+ */
+ const logGroup = (groupTitle, deletedURLs) => {
+ logger.groupCollapsed(groupTitle);
+ for (const url of deletedURLs) {
+ logger.log(url);
+ }
+ logger.groupEnd();
+ };
+ /**
+ * @param {Array} deletedURLs
+ *
+ * @private
+ * @memberof workbox-precaching
+ */
+ function printCleanupDetails(deletedURLs) {
+ const deletionCount = deletedURLs.length;
+ if (deletionCount > 0) {
+ logger.groupCollapsed(`During precaching cleanup, ` + `${deletionCount} cached ` + `request${deletionCount === 1 ? ' was' : 's were'} deleted.`);
+ logGroup('Deleted Cache Requests', deletedURLs);
+ logger.groupEnd();
+ }
+ }
+
+ /*
+ 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.
+ */
+ /**
+ * @param {string} groupTitle
+ * @param {Array} urls
+ *
+ * @private
+ */
+ function _nestedGroup(groupTitle, urls) {
+ if (urls.length === 0) {
+ return;
+ }
+ logger.groupCollapsed(groupTitle);
+ for (const url of urls) {
+ logger.log(url);
+ }
+ logger.groupEnd();
+ }
+ /**
+ * @param {Array} urlsToPrecache
+ * @param {Array} urlsAlreadyPrecached
+ *
+ * @private
+ * @memberof workbox-precaching
+ */
+ function printInstallDetails(urlsToPrecache, urlsAlreadyPrecached) {
+ const precachedCount = urlsToPrecache.length;
+ const alreadyPrecachedCount = urlsAlreadyPrecached.length;
+ if (precachedCount || alreadyPrecachedCount) {
+ let message = `Precaching ${precachedCount} file${precachedCount === 1 ? '' : 's'}.`;
+ if (alreadyPrecachedCount > 0) {
+ message += ` ${alreadyPrecachedCount} ` + `file${alreadyPrecachedCount === 1 ? ' is' : 's are'} already cached.`;
+ }
+ logger.groupCollapsed(message);
+ _nestedGroup(`View newly precached URLs.`, urlsToPrecache);
+ _nestedGroup(`View previously precached URLs.`, urlsAlreadyPrecached);
+ logger.groupEnd();
+ }
+ }
+
+ /*
+ Copyright 2019 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.
+ */
+ let supportStatus;
+ /**
+ * A utility function that determines whether the current browser supports
+ * constructing a new `Response` from a `response.body` stream.
+ *
+ * @return {boolean} `true`, if the current browser can successfully
+ * construct a `Response` from a `response.body` stream, `false` otherwise.
+ *
+ * @private
+ */
+ function canConstructResponseFromBodyStream() {
+ if (supportStatus === undefined) {
+ const testResponse = new Response('');
+ if ('body' in testResponse) {
+ try {
+ new Response(testResponse.body);
+ supportStatus = true;
+ } catch (error) {
+ supportStatus = false;
+ }
+ }
+ supportStatus = false;
+ }
+ return supportStatus;
+ }
+
+ /*
+ Copyright 2019 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.
+ */
+ /**
+ * Allows developers to copy a response and modify its `headers`, `status`,
+ * or `statusText` values (the values settable via a
+ * [`ResponseInit`]{@link https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#Syntax}
+ * object in the constructor).
+ * To modify these values, pass a function as the second argument. That
+ * function will be invoked with a single object with the response properties
+ * `{headers, status, statusText}`. The return value of this function will
+ * be used as the `ResponseInit` for the new `Response`. To change the values
+ * either modify the passed parameter(s) and return it, or return a totally
+ * new object.
+ *
+ * This method is intentionally limited to same-origin responses, regardless of
+ * whether CORS was used or not.
+ *
+ * @param {Response} response
+ * @param {Function} modifier
+ * @memberof workbox-core
+ */
+ async function copyResponse(response, modifier) {
+ let origin = null;
+ // If response.url isn't set, assume it's cross-origin and keep origin null.
+ if (response.url) {
+ const responseURL = new URL(response.url);
+ origin = responseURL.origin;
+ }
+ if (origin !== self.location.origin) {
+ throw new WorkboxError('cross-origin-copy-response', {
+ origin
+ });
+ }
+ const clonedResponse = response.clone();
+ // Create a fresh `ResponseInit` object by cloning the headers.
+ const responseInit = {
+ headers: new Headers(clonedResponse.headers),
+ status: clonedResponse.status,
+ statusText: clonedResponse.statusText
+ };
+ // Apply any user modifications.
+ const modifiedResponseInit = modifier ? modifier(responseInit) : responseInit;
+ // Create the new response from the body stream and `ResponseInit`
+ // modifications. Note: not all browsers support the Response.body stream,
+ // so fall back to reading the entire body into memory as a blob.
+ const body = canConstructResponseFromBodyStream() ? clonedResponse.body : await clonedResponse.blob();
+ return new Response(body, modifiedResponseInit);
+ }
+
+ /*
+ Copyright 2020 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.
+ */
+ function stripParams(fullURL, ignoreParams) {
+ const strippedURL = new URL(fullURL);
+ for (const param of ignoreParams) {
+ strippedURL.searchParams.delete(param);
+ }
+ return strippedURL.href;
+ }
+ /**
+ * Matches an item in the cache, ignoring specific URL params. This is similar
+ * to the `ignoreSearch` option, but it allows you to ignore just specific
+ * params (while continuing to match on the others).
+ *
+ * @private
+ * @param {Cache} cache
+ * @param {Request} request
+ * @param {Object} matchOptions
+ * @param {Array} ignoreParams
+ * @return {Promise}
+ */
+ async function cacheMatchIgnoreParams(cache, request, ignoreParams, matchOptions) {
+ const strippedRequestURL = stripParams(request.url, ignoreParams);
+ // If the request doesn't include any ignored params, match as normal.
+ if (request.url === strippedRequestURL) {
+ return cache.match(request, matchOptions);
+ }
+ // Otherwise, match by comparing keys
+ const keysOptions = Object.assign(Object.assign({}, matchOptions), {
+ ignoreSearch: true
+ });
+ const cacheKeys = await cache.keys(request, keysOptions);
+ for (const cacheKey of cacheKeys) {
+ const strippedCacheKeyURL = stripParams(cacheKey.url, ignoreParams);
+ if (strippedRequestURL === strippedCacheKeyURL) {
+ return cache.match(cacheKey, matchOptions);
+ }
+ }
+ return;
+ }
+
+ /*
+ 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.
+ */
+ /**
+ * The Deferred class composes Promises in a way that allows for them to be
+ * resolved or rejected from outside the constructor. In most cases promises
+ * should be used directly, but Deferreds can be necessary when the logic to
+ * resolve a promise must be separate.
+ *
+ * @private
+ */
+ class Deferred {
+ /**
+ * Creates a promise and exposes its resolve and reject functions as methods.
+ */
+ constructor() {
+ this.promise = new Promise((resolve, reject) => {
+ this.resolve = resolve;
+ this.reject = reject;
+ });
+ }
+ }
+
+ /*
+ 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.
+ */
+ // Callbacks to be executed whenever there's a quota error.
+ // Can't change Function type right now.
+ // eslint-disable-next-line @typescript-eslint/ban-types
+ const quotaErrorCallbacks = new Set();
+
+ /*
+ 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.
+ */
+ /**
+ * Runs all of the callback functions, one at a time sequentially, in the order
+ * in which they were registered.
+ *
+ * @memberof workbox-core
+ * @private
+ */
+ async function executeQuotaErrorCallbacks() {
+ {
+ logger.log(`About to run ${quotaErrorCallbacks.size} ` + `callbacks to clean up caches.`);
+ }
+ for (const callback of quotaErrorCallbacks) {
+ await callback();
+ {
+ logger.log(callback, 'is complete.');
+ }
+ }
+ {
+ logger.log('Finished running callbacks.');
+ }
+ }
+
+ /*
+ Copyright 2019 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.
+ */
+ /**
+ * Returns a promise that resolves and the passed number of milliseconds.
+ * This utility is an async/await-friendly version of `setTimeout`.
+ *
+ * @param {number} ms
+ * @return {Promise}
+ * @private
+ */
+ function timeout(ms) {
+ return new Promise(resolve => setTimeout(resolve, ms));
+ }
+
+ // @ts-ignore
+ try {
+ self['workbox:strategies:7.0.0'] && _();
+ } catch (e) {}
+
+ /*
+ Copyright 2020 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.
+ */
+ function toRequest(input) {
+ return typeof input === 'string' ? new Request(input) : input;
+ }
+ /**
+ * A class created every time a Strategy instance instance calls
+ * {@link workbox-strategies.Strategy~handle} or
+ * {@link workbox-strategies.Strategy~handleAll} that wraps all fetch and
+ * cache actions around plugin callbacks and keeps track of when the strategy
+ * is "done" (i.e. all added `event.waitUntil()` promises have resolved).
+ *
+ * @memberof workbox-strategies
+ */
+ class StrategyHandler {
+ /**
+ * Creates a new instance associated with the passed strategy and event
+ * that's handling the request.
+ *
+ * The constructor also initializes the state that will be passed to each of
+ * the plugins handling this request.
+ *
+ * @param {workbox-strategies.Strategy} strategy
+ * @param {Object} options
+ * @param {Request|string} options.request A request to run this strategy for.
+ * @param {ExtendableEvent} options.event The event associated with the
+ * request.
+ * @param {URL} [options.url]
+ * @param {*} [options.params] The return value from the
+ * {@link workbox-routing~matchCallback} (if applicable).
+ */
+ constructor(strategy, options) {
+ this._cacheKeys = {};
+ /**
+ * The request the strategy is performing (passed to the strategy's
+ * `handle()` or `handleAll()` method).
+ * @name request
+ * @instance
+ * @type {Request}
+ * @memberof workbox-strategies.StrategyHandler
+ */
+ /**
+ * The event associated with this request.
+ * @name event
+ * @instance
+ * @type {ExtendableEvent}
+ * @memberof workbox-strategies.StrategyHandler
+ */
+ /**
+ * A `URL` instance of `request.url` (if passed to the strategy's
+ * `handle()` or `handleAll()` method).
+ * Note: the `url` param will be present if the strategy was invoked
+ * from a workbox `Route` object.
+ * @name url
+ * @instance
+ * @type {URL|undefined}
+ * @memberof workbox-strategies.StrategyHandler
+ */
+ /**
+ * A `param` value (if passed to the strategy's
+ * `handle()` or `handleAll()` method).
+ * Note: the `param` param will be present if the strategy was invoked
+ * from a workbox `Route` object and the
+ * {@link workbox-routing~matchCallback} returned
+ * a truthy value (it will be that value).
+ * @name params
+ * @instance
+ * @type {*|undefined}
+ * @memberof workbox-strategies.StrategyHandler
+ */
+ {
+ finalAssertExports.isInstance(options.event, ExtendableEvent, {
+ moduleName: 'workbox-strategies',
+ className: 'StrategyHandler',
+ funcName: 'constructor',
+ paramName: 'options.event'
+ });
+ }
+ Object.assign(this, options);
+ this.event = options.event;
+ this._strategy = strategy;
+ this._handlerDeferred = new Deferred();
+ this._extendLifetimePromises = [];
+ // Copy the plugins list (since it's mutable on the strategy),
+ // so any mutations don't affect this handler instance.
+ this._plugins = [...strategy.plugins];
+ this._pluginStateMap = new Map();
+ for (const plugin of this._plugins) {
+ this._pluginStateMap.set(plugin, {});
+ }
+ this.event.waitUntil(this._handlerDeferred.promise);
+ }
+ /**
+ * Fetches a given request (and invokes any applicable plugin callback
+ * methods) using the `fetchOptions` (for non-navigation requests) and
+ * `plugins` defined on the `Strategy` object.
+ *
+ * The following plugin lifecycle methods are invoked when using this method:
+ * - `requestWillFetch()`
+ * - `fetchDidSucceed()`
+ * - `fetchDidFail()`
+ *
+ * @param {Request|string} input The URL or request to fetch.
+ * @return {Promise}
+ */
+ async fetch(input) {
+ const {
+ event
+ } = this;
+ let request = toRequest(input);
+ if (request.mode === 'navigate' && event instanceof FetchEvent && event.preloadResponse) {
+ const possiblePreloadResponse = await event.preloadResponse;
+ if (possiblePreloadResponse) {
+ {
+ logger.log(`Using a preloaded navigation response for ` + `'${getFriendlyURL(request.url)}'`);
+ }
+ return possiblePreloadResponse;
+ }
+ }
+ // If there is a fetchDidFail plugin, we need to save a clone of the
+ // original request before it's either modified by a requestWillFetch
+ // plugin or before the original request's body is consumed via fetch().
+ const originalRequest = this.hasCallback('fetchDidFail') ? request.clone() : null;
+ try {
+ for (const cb of this.iterateCallbacks('requestWillFetch')) {
+ request = await cb({
+ request: request.clone(),
+ event
+ });
+ }
+ } catch (err) {
+ if (err instanceof Error) {
+ throw new WorkboxError('plugin-error-request-will-fetch', {
+ thrownErrorMessage: err.message
+ });
+ }
+ }
+ // The request can be altered by plugins with `requestWillFetch` making
+ // the original request (most likely from a `fetch` event) different
+ // from the Request we make. Pass both to `fetchDidFail` to aid debugging.
+ const pluginFilteredRequest = request.clone();
+ try {
+ let fetchResponse;
+ // See https://github.com/GoogleChrome/workbox/issues/1796
+ fetchResponse = await fetch(request, request.mode === 'navigate' ? undefined : this._strategy.fetchOptions);
+ if ("development" !== 'production') {
+ logger.debug(`Network request for ` + `'${getFriendlyURL(request.url)}' returned a response with ` + `status '${fetchResponse.status}'.`);
+ }
+ for (const callback of this.iterateCallbacks('fetchDidSucceed')) {
+ fetchResponse = await callback({
+ event,
+ request: pluginFilteredRequest,
+ response: fetchResponse
+ });
+ }
+ return fetchResponse;
+ } catch (error) {
+ {
+ logger.log(`Network request for ` + `'${getFriendlyURL(request.url)}' threw an error.`, error);
+ }
+ // `originalRequest` will only exist if a `fetchDidFail` callback
+ // is being used (see above).
+ if (originalRequest) {
+ await this.runCallbacks('fetchDidFail', {
+ error: error,
+ event,
+ originalRequest: originalRequest.clone(),
+ request: pluginFilteredRequest.clone()
+ });
+ }
+ throw error;
+ }
+ }
+ /**
+ * Calls `this.fetch()` and (in the background) runs `this.cachePut()` on
+ * the response generated by `this.fetch()`.
+ *
+ * The call to `this.cachePut()` automatically invokes `this.waitUntil()`,
+ * so you do not have to manually call `waitUntil()` on the event.
+ *
+ * @param {Request|string} input The request or URL to fetch and cache.
+ * @return {Promise}
+ */
+ async fetchAndCachePut(input) {
+ const response = await this.fetch(input);
+ const responseClone = response.clone();
+ void this.waitUntil(this.cachePut(input, responseClone));
+ return response;
+ }
+ /**
+ * Matches a request from the cache (and invokes any applicable plugin
+ * callback methods) using the `cacheName`, `matchOptions`, and `plugins`
+ * defined on the strategy object.
+ *
+ * The following plugin lifecycle methods are invoked when using this method:
+ * - cacheKeyWillByUsed()
+ * - cachedResponseWillByUsed()
+ *
+ * @param {Request|string} key The Request or URL to use as the cache key.
+ * @return {Promise} A matching response, if found.
+ */
+ async cacheMatch(key) {
+ const request = toRequest(key);
+ let cachedResponse;
+ const {
+ cacheName,
+ matchOptions
+ } = this._strategy;
+ const effectiveRequest = await this.getCacheKey(request, 'read');
+ const multiMatchOptions = Object.assign(Object.assign({}, matchOptions), {
+ cacheName
+ });
+ cachedResponse = await caches.match(effectiveRequest, multiMatchOptions);
+ {
+ if (cachedResponse) {
+ logger.debug(`Found a cached response in '${cacheName}'.`);
+ } else {
+ logger.debug(`No cached response found in '${cacheName}'.`);
+ }
+ }
+ for (const callback of this.iterateCallbacks('cachedResponseWillBeUsed')) {
+ cachedResponse = (await callback({
+ cacheName,
+ matchOptions,
+ cachedResponse,
+ request: effectiveRequest,
+ event: this.event
+ })) || undefined;
+ }
+ return cachedResponse;
+ }
+ /**
+ * Puts a request/response pair in the cache (and invokes any applicable
+ * plugin callback methods) using the `cacheName` and `plugins` defined on
+ * the strategy object.
+ *
+ * The following plugin lifecycle methods are invoked when using this method:
+ * - cacheKeyWillByUsed()
+ * - cacheWillUpdate()
+ * - cacheDidUpdate()
+ *
+ * @param {Request|string} key The request or URL to use as the cache key.
+ * @param {Response} response The response to cache.
+ * @return {Promise} `false` if a cacheWillUpdate caused the response
+ * not be cached, and `true` otherwise.
+ */
+ async cachePut(key, response) {
+ const request = toRequest(key);
+ // Run in the next task to avoid blocking other cache reads.
+ // https://github.com/w3c/ServiceWorker/issues/1397
+ await timeout(0);
+ const effectiveRequest = await this.getCacheKey(request, 'write');
+ {
+ if (effectiveRequest.method && effectiveRequest.method !== 'GET') {
+ throw new WorkboxError('attempt-to-cache-non-get-request', {
+ url: getFriendlyURL(effectiveRequest.url),
+ method: effectiveRequest.method
+ });
+ }
+ // See https://github.com/GoogleChrome/workbox/issues/2818
+ const vary = response.headers.get('Vary');
+ if (vary) {
+ logger.debug(`The response for ${getFriendlyURL(effectiveRequest.url)} ` + `has a 'Vary: ${vary}' header. ` + `Consider setting the {ignoreVary: true} option on your strategy ` + `to ensure cache matching and deletion works as expected.`);
+ }
+ }
+ if (!response) {
+ {
+ logger.error(`Cannot cache non-existent response for ` + `'${getFriendlyURL(effectiveRequest.url)}'.`);
+ }
+ throw new WorkboxError('cache-put-with-no-response', {
+ url: getFriendlyURL(effectiveRequest.url)
+ });
+ }
+ const responseToCache = await this._ensureResponseSafeToCache(response);
+ if (!responseToCache) {
+ {
+ logger.debug(`Response '${getFriendlyURL(effectiveRequest.url)}' ` + `will not be cached.`, responseToCache);
+ }
+ return false;
+ }
+ const {
+ cacheName,
+ matchOptions
+ } = this._strategy;
+ const cache = await self.caches.open(cacheName);
+ const hasCacheUpdateCallback = this.hasCallback('cacheDidUpdate');
+ const oldResponse = hasCacheUpdateCallback ? await cacheMatchIgnoreParams(
+ // TODO(philipwalton): the `__WB_REVISION__` param is a precaching
+ // feature. Consider into ways to only add this behavior if using
+ // precaching.
+ cache, effectiveRequest.clone(), ['__WB_REVISION__'], matchOptions) : null;
+ {
+ logger.debug(`Updating the '${cacheName}' cache with a new Response ` + `for ${getFriendlyURL(effectiveRequest.url)}.`);
+ }
+ try {
+ await cache.put(effectiveRequest, hasCacheUpdateCallback ? responseToCache.clone() : responseToCache);
+ } catch (error) {
+ if (error instanceof Error) {
+ // See https://developer.mozilla.org/en-US/docs/Web/API/DOMException#exception-QuotaExceededError
+ if (error.name === 'QuotaExceededError') {
+ await executeQuotaErrorCallbacks();
+ }
+ throw error;
+ }
+ }
+ for (const callback of this.iterateCallbacks('cacheDidUpdate')) {
+ await callback({
+ cacheName,
+ oldResponse,
+ newResponse: responseToCache.clone(),
+ request: effectiveRequest,
+ event: this.event
+ });
+ }
+ return true;
+ }
+ /**
+ * Checks the list of plugins for the `cacheKeyWillBeUsed` callback, and
+ * executes any of those callbacks found in sequence. The final `Request`
+ * object returned by the last plugin is treated as the cache key for cache
+ * reads and/or writes. If no `cacheKeyWillBeUsed` plugin callbacks have
+ * been registered, the passed request is returned unmodified
+ *
+ * @param {Request} request
+ * @param {string} mode
+ * @return {Promise}
+ */
+ async getCacheKey(request, mode) {
+ const key = `${request.url} | ${mode}`;
+ if (!this._cacheKeys[key]) {
+ let effectiveRequest = request;
+ for (const callback of this.iterateCallbacks('cacheKeyWillBeUsed')) {
+ effectiveRequest = toRequest(await callback({
+ mode,
+ request: effectiveRequest,
+ event: this.event,
+ // params has a type any can't change right now.
+ params: this.params // eslint-disable-line
+ }));
+ }
+
+ this._cacheKeys[key] = effectiveRequest;
+ }
+ return this._cacheKeys[key];
+ }
+ /**
+ * Returns true if the strategy has at least one plugin with the given
+ * callback.
+ *
+ * @param {string} name The name of the callback to check for.
+ * @return {boolean}
+ */
+ hasCallback(name) {
+ for (const plugin of this._strategy.plugins) {
+ if (name in plugin) {
+ return true;
+ }
+ }
+ return false;
+ }
+ /**
+ * Runs all plugin callbacks matching the given name, in order, passing the
+ * given param object (merged ith the current plugin state) as the only
+ * argument.
+ *
+ * Note: since this method runs all plugins, it's not suitable for cases
+ * where the return value of a callback needs to be applied prior to calling
+ * the next callback. See
+ * {@link workbox-strategies.StrategyHandler#iterateCallbacks}
+ * below for how to handle that case.
+ *
+ * @param {string} name The name of the callback to run within each plugin.
+ * @param {Object} param The object to pass as the first (and only) param
+ * when executing each callback. This object will be merged with the
+ * current plugin state prior to callback execution.
+ */
+ async runCallbacks(name, param) {
+ for (const callback of this.iterateCallbacks(name)) {
+ // TODO(philipwalton): not sure why `any` is needed. It seems like
+ // this should work with `as WorkboxPluginCallbackParam[C]`.
+ await callback(param);
+ }
+ }
+ /**
+ * Accepts a callback and returns an iterable of matching plugin callbacks,
+ * where each callback is wrapped with the current handler state (i.e. when
+ * you call each callback, whatever object parameter you pass it will
+ * be merged with the plugin's current state).
+ *
+ * @param {string} name The name fo the callback to run
+ * @return {Array}
+ */
+ *iterateCallbacks(name) {
+ for (const plugin of this._strategy.plugins) {
+ if (typeof plugin[name] === 'function') {
+ const state = this._pluginStateMap.get(plugin);
+ const statefulCallback = param => {
+ const statefulParam = Object.assign(Object.assign({}, param), {
+ state
+ });
+ // TODO(philipwalton): not sure why `any` is needed. It seems like
+ // this should work with `as WorkboxPluginCallbackParam[C]`.
+ return plugin[name](statefulParam);
+ };
+ yield statefulCallback;
+ }
+ }
+ }
+ /**
+ * Adds a promise to the
+ * [extend lifetime promises]{@link https://w3c.github.io/ServiceWorker/#extendableevent-extend-lifetime-promises}
+ * of the event event associated with the request being handled (usually a
+ * `FetchEvent`).
+ *
+ * Note: you can await
+ * {@link workbox-strategies.StrategyHandler~doneWaiting}
+ * to know when all added promises have settled.
+ *
+ * @param {Promise} promise A promise to add to the extend lifetime promises
+ * of the event that triggered the request.
+ */
+ waitUntil(promise) {
+ this._extendLifetimePromises.push(promise);
+ return promise;
+ }
+ /**
+ * Returns a promise that resolves once all promises passed to
+ * {@link workbox-strategies.StrategyHandler~waitUntil}
+ * have settled.
+ *
+ * Note: any work done after `doneWaiting()` settles should be manually
+ * passed to an event's `waitUntil()` method (not this handler's
+ * `waitUntil()` method), otherwise the service worker thread my be killed
+ * prior to your work completing.
+ */
+ async doneWaiting() {
+ let promise;
+ while (promise = this._extendLifetimePromises.shift()) {
+ await promise;
+ }
+ }
+ /**
+ * Stops running the strategy and immediately resolves any pending
+ * `waitUntil()` promises.
+ */
+ destroy() {
+ this._handlerDeferred.resolve(null);
+ }
+ /**
+ * This method will call cacheWillUpdate on the available plugins (or use
+ * status === 200) to determine if the Response is safe and valid to cache.
+ *
+ * @param {Request} options.request
+ * @param {Response} options.response
+ * @return {Promise}
+ *
+ * @private
+ */
+ async _ensureResponseSafeToCache(response) {
+ let responseToCache = response;
+ let pluginsUsed = false;
+ for (const callback of this.iterateCallbacks('cacheWillUpdate')) {
+ responseToCache = (await callback({
+ request: this.request,
+ response: responseToCache,
+ event: this.event
+ })) || undefined;
+ pluginsUsed = true;
+ if (!responseToCache) {
+ break;
+ }
+ }
+ if (!pluginsUsed) {
+ if (responseToCache && responseToCache.status !== 200) {
+ responseToCache = undefined;
+ }
+ {
+ if (responseToCache) {
+ if (responseToCache.status !== 200) {
+ if (responseToCache.status === 0) {
+ logger.warn(`The response for '${this.request.url}' ` + `is an opaque response. The caching strategy that you're ` + `using will not cache opaque responses by default.`);
+ } else {
+ logger.debug(`The response for '${this.request.url}' ` + `returned a status code of '${response.status}' and won't ` + `be cached as a result.`);
+ }
+ }
+ }
+ }
+ }
+ return responseToCache;
+ }
+ }
+
+ /*
+ Copyright 2020 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.
+ */
+ /**
+ * An abstract base class that all other strategy classes must extend from:
+ *
+ * @memberof workbox-strategies
+ */
+ class Strategy {
+ /**
+ * Creates a new instance of the strategy and sets all documented option
+ * properties as public instance properties.
+ *
+ * Note: if a custom strategy class extends the base Strategy class and does
+ * not need more than these properties, it does not need to define its own
+ * constructor.
+ *
+ * @param {Object} [options]
+ * @param {string} [options.cacheName] Cache name to store and retrieve
+ * requests. Defaults to the cache names provided by
+ * {@link workbox-core.cacheNames}.
+ * @param {Array
