From 690c5bd948247ef91c3e7c47ef6310d334e9f38d Mon Sep 17 00:00:00 2001 From: Fadi George Date: Fri, 15 May 2026 15:00:13 -0700 Subject: [PATCH 1/5] feat(examples): add Vue 2/3 Vite example apps --- README.md | 17 ++++- outputs/react/example/vite.config.ts | 4 +- outputs/vue/v2/example/.gitignore | 22 +++++++ outputs/vue/v2/example/README.md | 24 +++++++ outputs/vue/v2/example/index.html | 14 ++++ outputs/vue/v2/example/package.json | 18 ++++++ .../v2/example/public/OneSignalSDKWorker.js | 1 + outputs/vue/v2/example/scripts/setup.sh | 25 ++++++++ outputs/vue/v2/example/src/App.vue | 54 ++++++++++++++++ outputs/vue/v2/example/src/assets/logo.png | Bin 0 -> 6849 bytes .../v2/example/src/components/HelloWorld.vue | 60 ++++++++++++++++++ outputs/vue/v2/example/src/main.ts | 18 ++++++ outputs/vue/v2/example/src/shims-vue.d.ts | 7 ++ outputs/vue/v2/example/tsconfig.json | 20 ++++++ outputs/vue/v2/example/vite.config.ts | 11 ++++ outputs/vue/v2/vite.config.ts | 4 +- outputs/vue/v3/example/.gitignore | 22 +++++++ outputs/vue/v3/example/README.md | 31 ++++----- outputs/vue/v3/example/babel.config.js | 5 -- outputs/vue/v3/example/index.html | 14 ++++ outputs/vue/v3/example/package.json | 44 +++---------- .../v3/example/public/OneSignalSDKWorker.js | 2 +- outputs/vue/v3/example/public/index.html | 17 ----- outputs/vue/v3/example/scripts/setup.sh | 25 ++++++++ outputs/vue/v3/example/src/App.vue | 28 ++++---- .../v3/example/src/components/HelloWorld.vue | 53 ++++++++-------- outputs/vue/v3/example/src/main.js | 8 --- outputs/vue/v3/example/src/main.ts | 11 ++++ outputs/vue/v3/example/src/shims-vue.d.ts | 8 +++ outputs/vue/v3/example/tsconfig.json | 20 ++++++ outputs/vue/v3/example/vite.config.ts | 11 ++++ src/static/vue/v2/example/.gitignore | 22 +++++++ src/static/vue/v2/example/README.md | 24 +++++++ src/static/vue/v2/example/index.html | 14 ++++ src/static/vue/v2/example/package.json | 18 ++++++ .../v2/example/public/OneSignalSDKWorker.js | 1 + src/static/vue/v2/example/scripts/setup.sh | 25 ++++++++ src/static/vue/v2/example/src/App.vue | 54 ++++++++++++++++ src/static/vue/v2/example/src/assets/logo.png | Bin 0 -> 6849 bytes .../v2/example/src/components/HelloWorld.vue | 60 ++++++++++++++++++ src/static/vue/v2/example/src/main.ts | 18 ++++++ src/static/vue/v2/example/src/shims-vue.d.ts | 7 ++ src/static/vue/v2/example/tsconfig.json | 20 ++++++ src/static/vue/v2/example/vite.config.ts | 11 ++++ src/static/vue/v2/vite.config.ts | 4 +- src/static/vue/v3/example/.gitignore | 22 +++++++ src/static/vue/v3/example/README.md | 31 ++++----- src/static/vue/v3/example/babel.config.js | 5 -- src/static/vue/v3/example/index.html | 14 ++++ src/static/vue/v3/example/package.json | 44 +++---------- .../v3/example/public/OneSignalSDKWorker.js | 2 +- src/static/vue/v3/example/public/index.html | 17 ----- src/static/vue/v3/example/scripts/setup.sh | 25 ++++++++ src/static/vue/v3/example/src/App.vue | 28 ++++---- .../v3/example/src/components/HelloWorld.vue | 53 ++++++++-------- src/static/vue/v3/example/src/main.js | 8 --- src/static/vue/v3/example/src/main.ts | 11 ++++ src/static/vue/v3/example/src/shims-vue.d.ts | 8 +++ src/static/vue/v3/example/tsconfig.json | 20 ++++++ src/static/vue/v3/example/vite.config.ts | 11 ++++ 60 files changed, 923 insertions(+), 252 deletions(-) create mode 100644 outputs/vue/v2/example/.gitignore create mode 100644 outputs/vue/v2/example/README.md create mode 100644 outputs/vue/v2/example/index.html create mode 100644 outputs/vue/v2/example/package.json create mode 100644 outputs/vue/v2/example/public/OneSignalSDKWorker.js create mode 100755 outputs/vue/v2/example/scripts/setup.sh create mode 100644 outputs/vue/v2/example/src/App.vue create mode 100644 outputs/vue/v2/example/src/assets/logo.png create mode 100644 outputs/vue/v2/example/src/components/HelloWorld.vue create mode 100644 outputs/vue/v2/example/src/main.ts create mode 100644 outputs/vue/v2/example/src/shims-vue.d.ts create mode 100644 outputs/vue/v2/example/tsconfig.json create mode 100644 outputs/vue/v2/example/vite.config.ts create mode 100644 outputs/vue/v3/example/.gitignore delete mode 100644 outputs/vue/v3/example/babel.config.js create mode 100644 outputs/vue/v3/example/index.html delete mode 100644 outputs/vue/v3/example/public/index.html create mode 100755 outputs/vue/v3/example/scripts/setup.sh delete mode 100644 outputs/vue/v3/example/src/main.js create mode 100644 outputs/vue/v3/example/src/main.ts create mode 100644 outputs/vue/v3/example/src/shims-vue.d.ts create mode 100644 outputs/vue/v3/example/tsconfig.json create mode 100644 outputs/vue/v3/example/vite.config.ts create mode 100644 src/static/vue/v2/example/.gitignore create mode 100644 src/static/vue/v2/example/README.md create mode 100644 src/static/vue/v2/example/index.html create mode 100644 src/static/vue/v2/example/package.json create mode 100644 src/static/vue/v2/example/public/OneSignalSDKWorker.js create mode 100755 src/static/vue/v2/example/scripts/setup.sh create mode 100644 src/static/vue/v2/example/src/App.vue create mode 100644 src/static/vue/v2/example/src/assets/logo.png create mode 100644 src/static/vue/v2/example/src/components/HelloWorld.vue create mode 100644 src/static/vue/v2/example/src/main.ts create mode 100644 src/static/vue/v2/example/src/shims-vue.d.ts create mode 100644 src/static/vue/v2/example/tsconfig.json create mode 100644 src/static/vue/v2/example/vite.config.ts create mode 100644 src/static/vue/v3/example/.gitignore delete mode 100644 src/static/vue/v3/example/babel.config.js create mode 100644 src/static/vue/v3/example/index.html delete mode 100644 src/static/vue/v3/example/public/index.html create mode 100755 src/static/vue/v3/example/scripts/setup.sh delete mode 100644 src/static/vue/v3/example/src/main.js create mode 100644 src/static/vue/v3/example/src/main.ts create mode 100644 src/static/vue/v3/example/src/shims-vue.d.ts create mode 100644 src/static/vue/v3/example/tsconfig.json create mode 100644 src/static/vue/v3/example/vite.config.ts diff --git a/README.md b/README.md index c902812c..ae645998 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,20 @@ Set up a new React, Vue, or Angular App so the new app and final package repo is ## Creating Test Apps -### React Example App +Each shim ships with a ready-to-run example under its `example/` folder. After +building the codegen (`npm run build`), the easiest way to try the shims +locally is: + +``` +cd build/react/example # or build/vue/v2/example, build/vue/v3/example +vp run start +``` + +The `prestart` hook invokes `scripts/setup.sh`, which builds the parent shim, +packs it as a tarball, and installs it into the example before launching the +dev server on http://localhost:3000. + +### React Example App (alternative) ``` cd ~/tmp @@ -85,7 +98,7 @@ cd web-shim-test-react npm link {YOUR_PATH_HERE}/web-shim-codegen/build/react ``` -### Vue Example App +### Vue Example App (alternative) ``` cd ~/tmp diff --git a/outputs/react/example/vite.config.ts b/outputs/react/example/vite.config.ts index 839b4ee7..8d1480b4 100644 --- a/outputs/react/example/vite.config.ts +++ b/outputs/react/example/vite.config.ts @@ -1,6 +1,6 @@ -import react from '@vitejs/plugin-react'; +import react from "@vitejs/plugin-react"; -import { defineConfig } from 'vite-plus'; +import { defineConfig } from "vite-plus"; export default defineConfig({ plugins: [react()], diff --git a/outputs/vue/v2/example/.gitignore b/outputs/vue/v2/example/.gitignore new file mode 100644 index 00000000..59abcece --- /dev/null +++ b/outputs/vue/v2/example/.gitignore @@ -0,0 +1,22 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js +onesignal-vue-*.tgz + +# production +/dist + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* + +dev-ssl.crt +dev-ssl.key diff --git a/outputs/vue/v2/example/README.md b/outputs/vue/v2/example/README.md new file mode 100644 index 00000000..60d0e188 --- /dev/null +++ b/outputs/vue/v2/example/README.md @@ -0,0 +1,24 @@ +# example-vue2 + +A minimal Vue 2 app showcasing `onesignal-vue`. + +## Setup + +Replace `` in `src/main.ts` with your OneSignal app id. + +## Available Scripts + +In the project directory, you can run: + +### `npm start` + +Builds the parent `onesignal-vue` package, packs it as a tarball, installs it +locally, and runs the dev server. Open +[http://localhost:3000](http://localhost:3000) to view the app. + +The page will reload if you make edits. + +## Re-running setup + +Run `vp run setup` to rebuild the parent package and re-install the freshly +packed tarball into the example. diff --git a/outputs/vue/v2/example/index.html b/outputs/vue/v2/example/index.html new file mode 100644 index 00000000..c4f71fc1 --- /dev/null +++ b/outputs/vue/v2/example/index.html @@ -0,0 +1,14 @@ + + + + + + + Vue 2 OneSignal Example + + + +
+ + + diff --git a/outputs/vue/v2/example/package.json b/outputs/vue/v2/example/package.json new file mode 100644 index 00000000..3d8cdd87 --- /dev/null +++ b/outputs/vue/v2/example/package.json @@ -0,0 +1,18 @@ +{ + "name": "example-vue2", + "version": "0.1.0", + "private": true, + "dependencies": { + "vue": "^2.7.16" + }, + "scripts": { + "setup": "./scripts/setup.sh", + "prestart": "vp run setup", + "start": "vp dev" + }, + "devDependencies": { + "@vitejs/plugin-vue2": "^2.3.4", + "typescript": "^5.8.2" + }, + "packageManager": "bun@1.3.13" +} diff --git a/outputs/vue/v2/example/public/OneSignalSDKWorker.js b/outputs/vue/v2/example/public/OneSignalSDKWorker.js new file mode 100644 index 00000000..3f15a077 --- /dev/null +++ b/outputs/vue/v2/example/public/OneSignalSDKWorker.js @@ -0,0 +1 @@ +importScripts("https://onesignal.com/sdks/web/v16/OneSignalSDK.sw.js"); diff --git a/outputs/vue/v2/example/scripts/setup.sh b/outputs/vue/v2/example/scripts/setup.sh new file mode 100755 index 00000000..773ec621 --- /dev/null +++ b/outputs/vue/v2/example/scripts/setup.sh @@ -0,0 +1,25 @@ +#!/bin/bash +set -euo pipefail + +bold=$(tput bold 2>/dev/null || true) +normal=$(tput sgr0 2>/dev/null || true) + +log() { + echo -e "\n${bold}$1${normal}" +} + +EXAMPLE_DIR="$(cd "$(dirname "$0")/.." && pwd)" +PARENT_DIR="$(cd "$EXAMPLE_DIR/.." && pwd)" + +log "Building onesignal-vue in $PARENT_DIR" +cd "$PARENT_DIR" +vp run build + +log "Packing onesignal-vue" +rm -f "$EXAMPLE_DIR"/onesignal-vue-*.tgz +TARBALL=$(bun pm pack | grep -E '\.tgz$' | tail -1) +mv "$PARENT_DIR/$TARBALL" "$EXAMPLE_DIR/$TARBALL" + +log "Installing tarball into example" +cd "$EXAMPLE_DIR" +vp add "./$TARBALL" diff --git a/outputs/vue/v2/example/src/App.vue b/outputs/vue/v2/example/src/App.vue new file mode 100644 index 00000000..0ccd499f --- /dev/null +++ b/outputs/vue/v2/example/src/App.vue @@ -0,0 +1,54 @@ + + + + + diff --git a/outputs/vue/v2/example/src/assets/logo.png b/outputs/vue/v2/example/src/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f3d2503fc2a44b5053b0837ebea6e87a2d339a43 GIT binary patch literal 6849 zcmaKRcUV(fvo}bjDT-7nLI_nlK}sT_69H+`qzVWDA|yaU?}j417wLi^B1KB1SLsC& zL0ag7$U(XW5YR7p&Ux?sP$d4lvMt8C^+TcQu4F zQqv!UF!I+kw)c0jhd6+g6oCr9P?7)?!qX1ui*iL{p}sKCAGuJ{{W)0z1pLF|=>h}& zt(2Lr0Z`2ig8<5i%Zk}cO5Fm=LByqGWaS`oqChZdEFmc`0hSb#gg|Aap^{+WKOYcj zHjINK)KDG%&s?Mt4CL(T=?;~U@bU2x_mLKN!#GJuK_CzbNw5SMEJorG!}_5;?R>@1 zSl)jns3WlU7^J%=(hUtfmuUCU&C3%8B5C^f5>W2Cy8jW3#{Od{lF1}|?c61##3dzA zsPlFG;l_FzBK}8>|H_Ru_H#!_7$UH4UKo3lKOA}g1(R&|e@}GINYVzX?q=_WLZCgh z)L|eJMce`D0EIwgRaNETDsr+?vQknSGAi=7H00r`QnI%oQnFxm`G2umXso9l+8*&Q z7WqF|$p49js$mdzo^BXpH#gURy=UO;=IMrYc5?@+sR4y_?d*~0^YP7d+y0{}0)zBM zIKVM(DBvICK#~7N0a+PY6)7;u=dutmNqK3AlsrUU9U`d;msiucB_|8|2kY=(7XA;G zwDA8AR)VCA#JOkxm#6oHNS^YVuOU;8p$N)2{`;oF|rQ?B~K$%rHDxXs+_G zF5|-uqHZvSzq}L;5Kcy_P+x0${33}Ofb6+TX&=y;;PkEOpz%+_bCw_{<&~ zeLV|!bP%l1qxywfVr9Z9JI+++EO^x>ZuCK);=$VIG1`kxK8F2M8AdC$iOe3cj1fo(ce4l-9 z7*zKy3={MixvUk=enQE;ED~7tv%qh&3lR<0m??@w{ILF|e#QOyPkFYK!&Up7xWNtL zOW%1QMC<3o;G9_S1;NkPB6bqbCOjeztEc6TsBM<(q9((JKiH{01+Ud=uw9B@{;(JJ z-DxI2*{pMq`q1RQc;V8@gYAY44Z!%#W~M9pRxI(R?SJ7sy7em=Z5DbuDlr@*q|25V)($-f}9c#?D%dU^RS<(wz?{P zFFHtCab*!rl(~j@0(Nadvwg8q|4!}L^>d?0al6}Rrv9$0M#^&@zjbfJy_n!%mVHK4 z6pLRIQ^Uq~dnyy$`ay51Us6WaP%&O;@49m&{G3z7xV3dLtt1VTOMYl3UW~Rm{Eq4m zF?Zl_v;?7EFx1_+#WFUXxcK78IV)FO>42@cm@}2I%pVbZqQ}3;p;sDIm&knay03a^ zn$5}Q$G!@fTwD$e(x-~aWP0h+4NRz$KlnO_H2c< z(XX#lPuW_%H#Q+c&(nRyX1-IadKR-%$4FYC0fsCmL9ky3 zKpxyjd^JFR+vg2!=HWf}2Z?@Td`0EG`kU?{8zKrvtsm)|7>pPk9nu@2^z96aU2<#` z2QhvH5w&V;wER?mopu+nqu*n8p~(%QkwSs&*0eJwa zMXR05`OSFpfyRb!Y_+H@O%Y z0=K^y6B8Gcbl?SA)qMP3Z+=C(?8zL@=74R=EVnE?vY!1BQy2@q*RUgRx4yJ$k}MnL zs!?74QciNb-LcG*&o<9=DSL>1n}ZNd)w1z3-0Pd^4ED1{qd=9|!!N?xnXjM!EuylY z5=!H>&hSofh8V?Jofyd!h`xDI1fYAuV(sZwwN~{$a}MX^=+0TH*SFp$vyxmUv7C*W zv^3Gl0+eTFgBi3FVD;$nhcp)ka*4gSskYIqQ&+M}xP9yLAkWzBI^I%zR^l1e?bW_6 zIn{mo{dD=)9@V?s^fa55jh78rP*Ze<3`tRCN4*mpO$@7a^*2B*7N_|A(Ve2VB|)_o z$=#_=aBkhe(ifX}MLT()@5?OV+~7cXC3r!%{QJxriXo9I%*3q4KT4Xxzyd{ z9;_%=W%q!Vw$Z7F3lUnY+1HZ*lO;4;VR2+i4+D(m#01OYq|L_fbnT;KN<^dkkCwtd zF7n+O7KvAw8c`JUh6LmeIrk4`F3o|AagKSMK3))_5Cv~y2Bb2!Ibg9BO7Vkz?pAYX zoI=B}+$R22&IL`NCYUYjrdhwjnMx_v=-Qcx-jmtN>!Zqf|n1^SWrHy zK|MwJ?Z#^>)rfT5YSY{qjZ&`Fjd;^vv&gF-Yj6$9-Dy$<6zeP4s+78gS2|t%Z309b z0^fp~ue_}i`U9j!<|qF92_3oB09NqgAoehQ`)<)dSfKoJl_A6Ec#*Mx9Cpd-p#$Ez z={AM*r-bQs6*z$!*VA4|QE7bf@-4vb?Q+pPKLkY2{yKsw{&udv_2v8{Dbd zm~8VAv!G~s)`O3|Q6vFUV%8%+?ZSVUa(;fhPNg#vab@J*9XE4#D%)$UU-T5`fwjz! z6&gA^`OGu6aUk{l*h9eB?opVdrHK>Q@U>&JQ_2pR%}TyOXGq_6s56_`U(WoOaAb+K zXQr#6H}>a-GYs9^bGP2Y&hSP5gEtW+GVC4=wy0wQk=~%CSXj=GH6q z-T#s!BV`xZVxm{~jr_ezYRpqqIcXC=Oq`b{lu`Rt(IYr4B91hhVC?yg{ol4WUr3v9 zOAk2LG>CIECZ-WIs0$N}F#eoIUEtZudc7DPYIjzGqDLWk_A4#(LgacooD z2K4IWs@N`Bddm-{%oy}!k0^i6Yh)uJ1S*90>|bm3TOZxcV|ywHUb(+CeX-o1|LTZM zwU>dY3R&U)T(}5#Neh?-CWT~@{6Ke@sI)uSuzoah8COy)w)B)aslJmp`WUcjdia-0 zl2Y}&L~XfA`uYQboAJ1;J{XLhYjH){cObH3FDva+^8ioOQy%Z=xyjGLmWMrzfFoH; zEi3AG`_v+%)&lDJE;iJWJDI@-X9K5O)LD~j*PBe(wu+|%ar~C+LK1+-+lK=t# z+Xc+J7qp~5q=B~rD!x78)?1+KUIbYr^5rcl&tB-cTtj+e%{gpZZ4G~6r15+d|J(ky zjg@@UzMW0k9@S#W(1H{u;Nq(7llJbq;;4t$awM;l&(2s+$l!Ay9^Ge|34CVhr7|BG z?dAR83smef^frq9V(OH+a+ki#q&-7TkWfFM=5bsGbU(8mC;>QTCWL5ydz9s6k@?+V zcjiH`VI=59P-(-DWXZ~5DH>B^_H~;4$)KUhnmGo*G!Tq8^LjfUDO)lASN*=#AY_yS zqW9UX(VOCO&p@kHdUUgsBO0KhXxn1sprK5h8}+>IhX(nSXZKwlNsjk^M|RAaqmCZB zHBolOHYBas@&{PT=R+?d8pZu zUHfyucQ`(umXSW7o?HQ3H21M`ZJal+%*)SH1B1j6rxTlG3hx1IGJN^M7{$j(9V;MZ zRKybgVuxKo#XVM+?*yTy{W+XHaU5Jbt-UG33x{u(N-2wmw;zzPH&4DE103HV@ER86 z|FZEmQb|&1s5#`$4!Cm}&`^{(4V}OP$bk`}v6q6rm;P!H)W|2i^e{7lTk2W@jo_9q z*aw|U7#+g59Fv(5qI`#O-qPj#@_P>PC#I(GSp3DLv7x-dmYK=C7lPF8a)bxb=@)B1 zUZ`EqpXV2dR}B&r`uM}N(TS99ZT0UB%IN|0H%DcVO#T%L_chrgn#m6%x4KE*IMfjX zJ%4veCEqbXZ`H`F_+fELMC@wuy_ch%t*+Z+1I}wN#C+dRrf2X{1C8=yZ_%Pt6wL_~ zZ2NN-hXOT4P4n$QFO7yYHS-4wF1Xfr-meG9Pn;uK51?hfel`d38k{W)F*|gJLT2#T z<~>spMu4(mul-8Q3*pf=N4DcI)zzjqAgbE2eOT7~&f1W3VsdD44Ffe;3mJp-V@8UC z)|qnPc12o~$X-+U@L_lWqv-RtvB~%hLF($%Ew5w>^NR82qC_0FB z)=hP1-OEx?lLi#jnLzH}a;Nvr@JDO-zQWd}#k^an$Kwml;MrD&)sC5b`s0ZkVyPkb zt}-jOq^%_9>YZe7Y}PhW{a)c39G`kg(P4@kxjcYfgB4XOOcmezdUI7j-!gs7oAo2o zx(Ph{G+YZ`a%~kzK!HTAA5NXE-7vOFRr5oqY$rH>WI6SFvWmahFav!CfRMM3%8J&c z*p+%|-fNS_@QrFr(at!JY9jCg9F-%5{nb5Bo~z@Y9m&SHYV`49GAJjA5h~h4(G!Se zZmK{Bo7ivCfvl}@A-ptkFGcWXAzj3xfl{evi-OG(TaCn1FAHxRc{}B|x+Ua1D=I6M z!C^ZIvK6aS_c&(=OQDZfm>O`Nxsw{ta&yiYPA~@e#c%N>>#rq)k6Aru-qD4(D^v)y z*>Rs;YUbD1S8^D(ps6Jbj0K3wJw>L4m)0e(6Pee3Y?gy9i0^bZO?$*sv+xKV?WBlh zAp*;v6w!a8;A7sLB*g-^<$Z4L7|5jXxxP1}hQZ<55f9<^KJ>^mKlWSGaLcO0=$jem zWyZkRwe~u{{tU63DlCaS9$Y4CP4f?+wwa(&1ou)b>72ydrFvm`Rj-0`kBJgK@nd(*Eh!(NC{F-@=FnF&Y!q`7){YsLLHf0_B6aHc# z>WIuHTyJwIH{BJ4)2RtEauC7Yq7Cytc|S)4^*t8Va3HR zg=~sN^tp9re@w=GTx$;zOWMjcg-7X3Wk^N$n;&Kf1RgVG2}2L-(0o)54C509C&77i zrjSi{X*WV=%C17((N^6R4Ya*4#6s_L99RtQ>m(%#nQ#wrRC8Y%yxkH;d!MdY+Tw@r zjpSnK`;C-U{ATcgaxoEpP0Gf+tx);buOMlK=01D|J+ROu37qc*rD(w`#O=3*O*w9?biwNoq3WN1`&Wp8TvKj3C z3HR9ssH7a&Vr<6waJrU zdLg!ieYz%U^bmpn%;(V%%ugMk92&?_XX1K@mwnVSE6!&%P%Wdi7_h`CpScvspMx?N zQUR>oadnG17#hNc$pkTp+9lW+MBKHRZ~74XWUryd)4yd zj98$%XmIL4(9OnoeO5Fnyn&fpQ9b0h4e6EHHw*l68j;>(ya`g^S&y2{O8U>1*>4zR zq*WSI_2o$CHQ?x0!wl9bpx|Cm2+kFMR)oMud1%n2=qn5nE&t@Fgr#=Zv2?}wtEz^T z9rrj=?IH*qI5{G@Rn&}^Z{+TW}mQeb9=8b<_a`&Cm#n%n~ zU47MvCBsdXFB1+adOO)03+nczfWa#vwk#r{o{dF)QWya9v2nv43Zp3%Ps}($lA02*_g25t;|T{A5snSY?3A zrRQ~(Ygh_ebltHo1VCbJb*eOAr;4cnlXLvI>*$-#AVsGg6B1r7@;g^L zFlJ_th0vxO7;-opU@WAFe;<}?!2q?RBrFK5U{*ai@NLKZ^};Ul}beukveh?TQn;$%9=R+DX07m82gP$=}Uo_%&ngV`}Hyv8g{u z3SWzTGV|cwQuFIs7ZDOqO_fGf8Q`8MwL}eUp>q?4eqCmOTcwQuXtQckPy|4F1on8l zP*h>d+cH#XQf|+6c|S{7SF(Lg>bR~l(0uY?O{OEVlaxa5@e%T&xju=o1`=OD#qc16 zSvyH*my(dcp6~VqR;o(#@m44Lug@~_qw+HA=mS#Z^4reBy8iV?H~I;{LQWk3aKK8$bLRyt$g?- +
+

{{ msg }}

+

+ Edit src/App.vue and save to reload.
+ Replace <YOUR_APP_ID> in src/main.ts with + your OneSignal app id. +

+

Essential Links

+ +
+ + + + + diff --git a/outputs/vue/v2/example/src/main.ts b/outputs/vue/v2/example/src/main.ts new file mode 100644 index 00000000..1cc62601 --- /dev/null +++ b/outputs/vue/v2/example/src/main.ts @@ -0,0 +1,18 @@ +import Vue from 'vue'; +import OneSignalVuePlugin from 'onesignal-vue'; + +import App from './App.vue'; + +Vue.config.productionTip = false; + +Vue.use(OneSignalVuePlugin); + +new Vue({ + render: (h) => h(App), + beforeMount() { + this.$OneSignal.init({ + appId: '', + allowLocalhostAsSecureOrigin: true, + }); + }, +}).$mount('#app'); diff --git a/outputs/vue/v2/example/src/shims-vue.d.ts b/outputs/vue/v2/example/src/shims-vue.d.ts new file mode 100644 index 00000000..628fb979 --- /dev/null +++ b/outputs/vue/v2/example/src/shims-vue.d.ts @@ -0,0 +1,7 @@ +declare module '*.vue' { + import Vue from 'vue'; + + export default Vue; +} + +declare module '*.png'; diff --git a/outputs/vue/v2/example/tsconfig.json b/outputs/vue/v2/example/tsconfig.json new file mode 100644 index 00000000..3afe50e4 --- /dev/null +++ b/outputs/vue/v2/example/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "esnext", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "esModuleInterop": true, + "allowSyntheticDefaultImports": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "module": "esnext", + "moduleResolution": "bundler", + "resolveJsonModule": true, + "isolatedModules": true, + "noEmit": true, + "jsx": "preserve", + "types": ["vite/client"] + }, + "include": ["src"] +} diff --git a/outputs/vue/v2/example/vite.config.ts b/outputs/vue/v2/example/vite.config.ts new file mode 100644 index 00000000..69cebc1e --- /dev/null +++ b/outputs/vue/v2/example/vite.config.ts @@ -0,0 +1,11 @@ +import vue from '@vitejs/plugin-vue2'; + +import { defineConfig } from 'vite-plus'; + +export default defineConfig({ + plugins: [vue()], + server: { + port: 3000, + open: true, + }, +}); diff --git a/outputs/vue/v2/vite.config.ts b/outputs/vue/v2/vite.config.ts index 6aac93fd..771f931a 100644 --- a/outputs/vue/v2/vite.config.ts +++ b/outputs/vue/v2/vite.config.ts @@ -5,14 +5,14 @@ export default defineConfig({ '*': 'vp check --fix', }, fmt: { - ignorePatterns: ['dist', 'node_modules'], + ignorePatterns: ['dist', 'example', 'node_modules'], singleQuote: true, sortImports: { enabled: true, }, }, lint: { - ignorePatterns: ['dist', 'node_modules'], + ignorePatterns: ['dist', 'example', 'node_modules'], rules: { 'typescript/require-await': 'error', }, diff --git a/outputs/vue/v3/example/.gitignore b/outputs/vue/v3/example/.gitignore new file mode 100644 index 00000000..40f70169 --- /dev/null +++ b/outputs/vue/v3/example/.gitignore @@ -0,0 +1,22 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js +onesignal-onesignal-vue3-*.tgz + +# production +/dist + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* + +dev-ssl.crt +dev-ssl.key diff --git a/outputs/vue/v3/example/README.md b/outputs/vue/v3/example/README.md index af882c8d..ca5446c9 100644 --- a/outputs/vue/v3/example/README.md +++ b/outputs/vue/v3/example/README.md @@ -1,29 +1,24 @@ # example-vue3 -## Project setup +A minimal Vue 3 app showcasing `@onesignal/onesignal-vue3`. -``` -npm install -``` +## Setup -### Compiles and hot-reloads for development +Replace `` in `src/main.ts` with your OneSignal app id. -``` -npm run serve -``` +## Available Scripts -### Compiles and minifies for production +In the project directory, you can run: -``` -npm run build -``` +### `npm start` -### Lints and fixes files +Builds the parent `@onesignal/onesignal-vue3` package, packs it as a tarball, +installs it locally, and runs the dev server. Open +[http://localhost:3000](http://localhost:3000) to view the app. -``` -npm run lint -``` +The page will reload if you make edits. -### Customize configuration +## Re-running setup -See [Configuration Reference](https://cli.vuejs.org/config/). +Run `vp run setup` to rebuild the parent package and re-install the freshly +packed tarball into the example. diff --git a/outputs/vue/v3/example/babel.config.js b/outputs/vue/v3/example/babel.config.js deleted file mode 100644 index e9558405..00000000 --- a/outputs/vue/v3/example/babel.config.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - presets: [ - '@vue/cli-plugin-babel/preset' - ] -} diff --git a/outputs/vue/v3/example/index.html b/outputs/vue/v3/example/index.html new file mode 100644 index 00000000..539452ce --- /dev/null +++ b/outputs/vue/v3/example/index.html @@ -0,0 +1,14 @@ + + + + + + + Vue 3 OneSignal Example + + + +
+ + + diff --git a/outputs/vue/v3/example/package.json b/outputs/vue/v3/example/package.json index 7724836c..37b4408e 100644 --- a/outputs/vue/v3/example/package.json +++ b/outputs/vue/v3/example/package.json @@ -2,42 +2,18 @@ "name": "example-vue3", "version": "0.1.0", "private": true, - "scripts": { - "serve": "vue-cli-service serve", - "build": "vue-cli-service build", - "lint": "vue-cli-service lint" - }, "dependencies": { - "@onesignal/onesignal-vue3": "^1.0.0", - "core-js": "^3.6.5", - "vue": "^3.0.0" + "vue": "^3.5.0" }, - "devDependencies": { - "@vue/cli-plugin-babel": "~4.5.13", - "@vue/cli-plugin-eslint": "~4.5.13", - "@vue/cli-service": "~4.5.13", - "@vue/compiler-sfc": "^3.0.0", - "babel-eslint": "^10.1.0", - "eslint": "^6.7.2", - "eslint-plugin-vue": "^7.0.0" + "scripts": { + "setup": "./scripts/setup.sh", + "prestart": "vp run setup", + "start": "vp dev" }, - "eslintConfig": { - "root": true, - "env": { - "node": true - }, - "extends": [ - "plugin:vue/vue3-essential", - "eslint:recommended" - ], - "parserOptions": { - "parser": "babel-eslint" - }, - "rules": {} + "devDependencies": { + "@vitejs/plugin-vue": "^6.0.7", + "typescript": "^5.8.2", + "vue-tsc": "^2.2.0" }, - "browserslist": [ - "> 1%", - "last 2 versions", - "not dead" - ] + "packageManager": "bun@1.3.13" } diff --git a/outputs/vue/v3/example/public/OneSignalSDKWorker.js b/outputs/vue/v3/example/public/OneSignalSDKWorker.js index f674ccfd..3f15a077 100644 --- a/outputs/vue/v3/example/public/OneSignalSDKWorker.js +++ b/outputs/vue/v3/example/public/OneSignalSDKWorker.js @@ -1 +1 @@ -importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js"); +importScripts("https://onesignal.com/sdks/web/v16/OneSignalSDK.sw.js"); diff --git a/outputs/vue/v3/example/public/index.html b/outputs/vue/v3/example/public/index.html deleted file mode 100644 index 3e5a1396..00000000 --- a/outputs/vue/v3/example/public/index.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - <%= htmlWebpackPlugin.options.title %> - - - -
- - - diff --git a/outputs/vue/v3/example/scripts/setup.sh b/outputs/vue/v3/example/scripts/setup.sh new file mode 100755 index 00000000..9a4ba261 --- /dev/null +++ b/outputs/vue/v3/example/scripts/setup.sh @@ -0,0 +1,25 @@ +#!/bin/bash +set -euo pipefail + +bold=$(tput bold 2>/dev/null || true) +normal=$(tput sgr0 2>/dev/null || true) + +log() { + echo -e "\n${bold}$1${normal}" +} + +EXAMPLE_DIR="$(cd "$(dirname "$0")/.." && pwd)" +PARENT_DIR="$(cd "$EXAMPLE_DIR/.." && pwd)" + +log "Building @onesignal/onesignal-vue3 in $PARENT_DIR" +cd "$PARENT_DIR" +vp run build + +log "Packing @onesignal/onesignal-vue3" +rm -f "$EXAMPLE_DIR"/onesignal-onesignal-vue3-*.tgz +TARBALL=$(bun pm pack | grep -E '\.tgz$' | tail -1) +mv "$PARENT_DIR/$TARBALL" "$EXAMPLE_DIR/$TARBALL" + +log "Installing tarball into example" +cd "$EXAMPLE_DIR" +vp add "./$TARBALL" diff --git a/outputs/vue/v3/example/src/App.vue b/outputs/vue/v3/example/src/App.vue index 1d812281..6060323d 100644 --- a/outputs/vue/v3/example/src/App.vue +++ b/outputs/vue/v3/example/src/App.vue @@ -1,41 +1,45 @@ - diff --git a/src/static/vue/v2/example/src/assets/logo.png b/src/static/vue/v2/example/src/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f3d2503fc2a44b5053b0837ebea6e87a2d339a43 GIT binary patch literal 6849 zcmaKRcUV(fvo}bjDT-7nLI_nlK}sT_69H+`qzVWDA|yaU?}j417wLi^B1KB1SLsC& zL0ag7$U(XW5YR7p&Ux?sP$d4lvMt8C^+TcQu4F zQqv!UF!I+kw)c0jhd6+g6oCr9P?7)?!qX1ui*iL{p}sKCAGuJ{{W)0z1pLF|=>h}& zt(2Lr0Z`2ig8<5i%Zk}cO5Fm=LByqGWaS`oqChZdEFmc`0hSb#gg|Aap^{+WKOYcj zHjINK)KDG%&s?Mt4CL(T=?;~U@bU2x_mLKN!#GJuK_CzbNw5SMEJorG!}_5;?R>@1 zSl)jns3WlU7^J%=(hUtfmuUCU&C3%8B5C^f5>W2Cy8jW3#{Od{lF1}|?c61##3dzA zsPlFG;l_FzBK}8>|H_Ru_H#!_7$UH4UKo3lKOA}g1(R&|e@}GINYVzX?q=_WLZCgh z)L|eJMce`D0EIwgRaNETDsr+?vQknSGAi=7H00r`QnI%oQnFxm`G2umXso9l+8*&Q z7WqF|$p49js$mdzo^BXpH#gURy=UO;=IMrYc5?@+sR4y_?d*~0^YP7d+y0{}0)zBM zIKVM(DBvICK#~7N0a+PY6)7;u=dutmNqK3AlsrUU9U`d;msiucB_|8|2kY=(7XA;G zwDA8AR)VCA#JOkxm#6oHNS^YVuOU;8p$N)2{`;oF|rQ?B~K$%rHDxXs+_G zF5|-uqHZvSzq}L;5Kcy_P+x0${33}Ofb6+TX&=y;;PkEOpz%+_bCw_{<&~ zeLV|!bP%l1qxywfVr9Z9JI+++EO^x>ZuCK);=$VIG1`kxK8F2M8AdC$iOe3cj1fo(ce4l-9 z7*zKy3={MixvUk=enQE;ED~7tv%qh&3lR<0m??@w{ILF|e#QOyPkFYK!&Up7xWNtL zOW%1QMC<3o;G9_S1;NkPB6bqbCOjeztEc6TsBM<(q9((JKiH{01+Ud=uw9B@{;(JJ z-DxI2*{pMq`q1RQc;V8@gYAY44Z!%#W~M9pRxI(R?SJ7sy7em=Z5DbuDlr@*q|25V)($-f}9c#?D%dU^RS<(wz?{P zFFHtCab*!rl(~j@0(Nadvwg8q|4!}L^>d?0al6}Rrv9$0M#^&@zjbfJy_n!%mVHK4 z6pLRIQ^Uq~dnyy$`ay51Us6WaP%&O;@49m&{G3z7xV3dLtt1VTOMYl3UW~Rm{Eq4m zF?Zl_v;?7EFx1_+#WFUXxcK78IV)FO>42@cm@}2I%pVbZqQ}3;p;sDIm&knay03a^ zn$5}Q$G!@fTwD$e(x-~aWP0h+4NRz$KlnO_H2c< z(XX#lPuW_%H#Q+c&(nRyX1-IadKR-%$4FYC0fsCmL9ky3 zKpxyjd^JFR+vg2!=HWf}2Z?@Td`0EG`kU?{8zKrvtsm)|7>pPk9nu@2^z96aU2<#` z2QhvH5w&V;wER?mopu+nqu*n8p~(%QkwSs&*0eJwa zMXR05`OSFpfyRb!Y_+H@O%Y z0=K^y6B8Gcbl?SA)qMP3Z+=C(?8zL@=74R=EVnE?vY!1BQy2@q*RUgRx4yJ$k}MnL zs!?74QciNb-LcG*&o<9=DSL>1n}ZNd)w1z3-0Pd^4ED1{qd=9|!!N?xnXjM!EuylY z5=!H>&hSofh8V?Jofyd!h`xDI1fYAuV(sZwwN~{$a}MX^=+0TH*SFp$vyxmUv7C*W zv^3Gl0+eTFgBi3FVD;$nhcp)ka*4gSskYIqQ&+M}xP9yLAkWzBI^I%zR^l1e?bW_6 zIn{mo{dD=)9@V?s^fa55jh78rP*Ze<3`tRCN4*mpO$@7a^*2B*7N_|A(Ve2VB|)_o z$=#_=aBkhe(ifX}MLT()@5?OV+~7cXC3r!%{QJxriXo9I%*3q4KT4Xxzyd{ z9;_%=W%q!Vw$Z7F3lUnY+1HZ*lO;4;VR2+i4+D(m#01OYq|L_fbnT;KN<^dkkCwtd zF7n+O7KvAw8c`JUh6LmeIrk4`F3o|AagKSMK3))_5Cv~y2Bb2!Ibg9BO7Vkz?pAYX zoI=B}+$R22&IL`NCYUYjrdhwjnMx_v=-Qcx-jmtN>!Zqf|n1^SWrHy zK|MwJ?Z#^>)rfT5YSY{qjZ&`Fjd;^vv&gF-Yj6$9-Dy$<6zeP4s+78gS2|t%Z309b z0^fp~ue_}i`U9j!<|qF92_3oB09NqgAoehQ`)<)dSfKoJl_A6Ec#*Mx9Cpd-p#$Ez z={AM*r-bQs6*z$!*VA4|QE7bf@-4vb?Q+pPKLkY2{yKsw{&udv_2v8{Dbd zm~8VAv!G~s)`O3|Q6vFUV%8%+?ZSVUa(;fhPNg#vab@J*9XE4#D%)$UU-T5`fwjz! z6&gA^`OGu6aUk{l*h9eB?opVdrHK>Q@U>&JQ_2pR%}TyOXGq_6s56_`U(WoOaAb+K zXQr#6H}>a-GYs9^bGP2Y&hSP5gEtW+GVC4=wy0wQk=~%CSXj=GH6q z-T#s!BV`xZVxm{~jr_ezYRpqqIcXC=Oq`b{lu`Rt(IYr4B91hhVC?yg{ol4WUr3v9 zOAk2LG>CIECZ-WIs0$N}F#eoIUEtZudc7DPYIjzGqDLWk_A4#(LgacooD z2K4IWs@N`Bddm-{%oy}!k0^i6Yh)uJ1S*90>|bm3TOZxcV|ywHUb(+CeX-o1|LTZM zwU>dY3R&U)T(}5#Neh?-CWT~@{6Ke@sI)uSuzoah8COy)w)B)aslJmp`WUcjdia-0 zl2Y}&L~XfA`uYQboAJ1;J{XLhYjH){cObH3FDva+^8ioOQy%Z=xyjGLmWMrzfFoH; zEi3AG`_v+%)&lDJE;iJWJDI@-X9K5O)LD~j*PBe(wu+|%ar~C+LK1+-+lK=t# z+Xc+J7qp~5q=B~rD!x78)?1+KUIbYr^5rcl&tB-cTtj+e%{gpZZ4G~6r15+d|J(ky zjg@@UzMW0k9@S#W(1H{u;Nq(7llJbq;;4t$awM;l&(2s+$l!Ay9^Ge|34CVhr7|BG z?dAR83smef^frq9V(OH+a+ki#q&-7TkWfFM=5bsGbU(8mC;>QTCWL5ydz9s6k@?+V zcjiH`VI=59P-(-DWXZ~5DH>B^_H~;4$)KUhnmGo*G!Tq8^LjfUDO)lASN*=#AY_yS zqW9UX(VOCO&p@kHdUUgsBO0KhXxn1sprK5h8}+>IhX(nSXZKwlNsjk^M|RAaqmCZB zHBolOHYBas@&{PT=R+?d8pZu zUHfyucQ`(umXSW7o?HQ3H21M`ZJal+%*)SH1B1j6rxTlG3hx1IGJN^M7{$j(9V;MZ zRKybgVuxKo#XVM+?*yTy{W+XHaU5Jbt-UG33x{u(N-2wmw;zzPH&4DE103HV@ER86 z|FZEmQb|&1s5#`$4!Cm}&`^{(4V}OP$bk`}v6q6rm;P!H)W|2i^e{7lTk2W@jo_9q z*aw|U7#+g59Fv(5qI`#O-qPj#@_P>PC#I(GSp3DLv7x-dmYK=C7lPF8a)bxb=@)B1 zUZ`EqpXV2dR}B&r`uM}N(TS99ZT0UB%IN|0H%DcVO#T%L_chrgn#m6%x4KE*IMfjX zJ%4veCEqbXZ`H`F_+fELMC@wuy_ch%t*+Z+1I}wN#C+dRrf2X{1C8=yZ_%Pt6wL_~ zZ2NN-hXOT4P4n$QFO7yYHS-4wF1Xfr-meG9Pn;uK51?hfel`d38k{W)F*|gJLT2#T z<~>spMu4(mul-8Q3*pf=N4DcI)zzjqAgbE2eOT7~&f1W3VsdD44Ffe;3mJp-V@8UC z)|qnPc12o~$X-+U@L_lWqv-RtvB~%hLF($%Ew5w>^NR82qC_0FB z)=hP1-OEx?lLi#jnLzH}a;Nvr@JDO-zQWd}#k^an$Kwml;MrD&)sC5b`s0ZkVyPkb zt}-jOq^%_9>YZe7Y}PhW{a)c39G`kg(P4@kxjcYfgB4XOOcmezdUI7j-!gs7oAo2o zx(Ph{G+YZ`a%~kzK!HTAA5NXE-7vOFRr5oqY$rH>WI6SFvWmahFav!CfRMM3%8J&c z*p+%|-fNS_@QrFr(at!JY9jCg9F-%5{nb5Bo~z@Y9m&SHYV`49GAJjA5h~h4(G!Se zZmK{Bo7ivCfvl}@A-ptkFGcWXAzj3xfl{evi-OG(TaCn1FAHxRc{}B|x+Ua1D=I6M z!C^ZIvK6aS_c&(=OQDZfm>O`Nxsw{ta&yiYPA~@e#c%N>>#rq)k6Aru-qD4(D^v)y z*>Rs;YUbD1S8^D(ps6Jbj0K3wJw>L4m)0e(6Pee3Y?gy9i0^bZO?$*sv+xKV?WBlh zAp*;v6w!a8;A7sLB*g-^<$Z4L7|5jXxxP1}hQZ<55f9<^KJ>^mKlWSGaLcO0=$jem zWyZkRwe~u{{tU63DlCaS9$Y4CP4f?+wwa(&1ou)b>72ydrFvm`Rj-0`kBJgK@nd(*Eh!(NC{F-@=FnF&Y!q`7){YsLLHf0_B6aHc# z>WIuHTyJwIH{BJ4)2RtEauC7Yq7Cytc|S)4^*t8Va3HR zg=~sN^tp9re@w=GTx$;zOWMjcg-7X3Wk^N$n;&Kf1RgVG2}2L-(0o)54C509C&77i zrjSi{X*WV=%C17((N^6R4Ya*4#6s_L99RtQ>m(%#nQ#wrRC8Y%yxkH;d!MdY+Tw@r zjpSnK`;C-U{ATcgaxoEpP0Gf+tx);buOMlK=01D|J+ROu37qc*rD(w`#O=3*O*w9?biwNoq3WN1`&Wp8TvKj3C z3HR9ssH7a&Vr<6waJrU zdLg!ieYz%U^bmpn%;(V%%ugMk92&?_XX1K@mwnVSE6!&%P%Wdi7_h`CpScvspMx?N zQUR>oadnG17#hNc$pkTp+9lW+MBKHRZ~74XWUryd)4yd zj98$%XmIL4(9OnoeO5Fnyn&fpQ9b0h4e6EHHw*l68j;>(ya`g^S&y2{O8U>1*>4zR zq*WSI_2o$CHQ?x0!wl9bpx|Cm2+kFMR)oMud1%n2=qn5nE&t@Fgr#=Zv2?}wtEz^T z9rrj=?IH*qI5{G@Rn&}^Z{+TW}mQeb9=8b<_a`&Cm#n%n~ zU47MvCBsdXFB1+adOO)03+nczfWa#vwk#r{o{dF)QWya9v2nv43Zp3%Ps}($lA02*_g25t;|T{A5snSY?3A zrRQ~(Ygh_ebltHo1VCbJb*eOAr;4cnlXLvI>*$-#AVsGg6B1r7@;g^L zFlJ_th0vxO7;-opU@WAFe;<}?!2q?RBrFK5U{*ai@NLKZ^};Ul}beukveh?TQn;$%9=R+DX07m82gP$=}Uo_%&ngV`}Hyv8g{u z3SWzTGV|cwQuFIs7ZDOqO_fGf8Q`8MwL}eUp>q?4eqCmOTcwQuXtQckPy|4F1on8l zP*h>d+cH#XQf|+6c|S{7SF(Lg>bR~l(0uY?O{OEVlaxa5@e%T&xju=o1`=OD#qc16 zSvyH*my(dcp6~VqR;o(#@m44Lug@~_qw+HA=mS#Z^4reBy8iV?H~I;{LQWk3aKK8$bLRyt$g?- +
+

{{ msg }}

+

+ Edit src/App.vue and save to reload.
+ Replace <YOUR_APP_ID> in src/main.ts with + your OneSignal app id. +

+

Essential Links

+ +
+ + + + + diff --git a/src/static/vue/v2/example/src/main.ts b/src/static/vue/v2/example/src/main.ts new file mode 100644 index 00000000..1cc62601 --- /dev/null +++ b/src/static/vue/v2/example/src/main.ts @@ -0,0 +1,18 @@ +import Vue from 'vue'; +import OneSignalVuePlugin from 'onesignal-vue'; + +import App from './App.vue'; + +Vue.config.productionTip = false; + +Vue.use(OneSignalVuePlugin); + +new Vue({ + render: (h) => h(App), + beforeMount() { + this.$OneSignal.init({ + appId: '', + allowLocalhostAsSecureOrigin: true, + }); + }, +}).$mount('#app'); diff --git a/src/static/vue/v2/example/src/shims-vue.d.ts b/src/static/vue/v2/example/src/shims-vue.d.ts new file mode 100644 index 00000000..628fb979 --- /dev/null +++ b/src/static/vue/v2/example/src/shims-vue.d.ts @@ -0,0 +1,7 @@ +declare module '*.vue' { + import Vue from 'vue'; + + export default Vue; +} + +declare module '*.png'; diff --git a/src/static/vue/v2/example/tsconfig.json b/src/static/vue/v2/example/tsconfig.json new file mode 100644 index 00000000..3afe50e4 --- /dev/null +++ b/src/static/vue/v2/example/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "esnext", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "esModuleInterop": true, + "allowSyntheticDefaultImports": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "module": "esnext", + "moduleResolution": "bundler", + "resolveJsonModule": true, + "isolatedModules": true, + "noEmit": true, + "jsx": "preserve", + "types": ["vite/client"] + }, + "include": ["src"] +} diff --git a/src/static/vue/v2/example/vite.config.ts b/src/static/vue/v2/example/vite.config.ts new file mode 100644 index 00000000..69cebc1e --- /dev/null +++ b/src/static/vue/v2/example/vite.config.ts @@ -0,0 +1,11 @@ +import vue from '@vitejs/plugin-vue2'; + +import { defineConfig } from 'vite-plus'; + +export default defineConfig({ + plugins: [vue()], + server: { + port: 3000, + open: true, + }, +}); diff --git a/src/static/vue/v2/vite.config.ts b/src/static/vue/v2/vite.config.ts index 6aac93fd..771f931a 100644 --- a/src/static/vue/v2/vite.config.ts +++ b/src/static/vue/v2/vite.config.ts @@ -5,14 +5,14 @@ export default defineConfig({ '*': 'vp check --fix', }, fmt: { - ignorePatterns: ['dist', 'node_modules'], + ignorePatterns: ['dist', 'example', 'node_modules'], singleQuote: true, sortImports: { enabled: true, }, }, lint: { - ignorePatterns: ['dist', 'node_modules'], + ignorePatterns: ['dist', 'example', 'node_modules'], rules: { 'typescript/require-await': 'error', }, diff --git a/src/static/vue/v3/example/.gitignore b/src/static/vue/v3/example/.gitignore new file mode 100644 index 00000000..40f70169 --- /dev/null +++ b/src/static/vue/v3/example/.gitignore @@ -0,0 +1,22 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js +onesignal-onesignal-vue3-*.tgz + +# production +/dist + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* + +dev-ssl.crt +dev-ssl.key diff --git a/src/static/vue/v3/example/README.md b/src/static/vue/v3/example/README.md index af882c8d..ca5446c9 100644 --- a/src/static/vue/v3/example/README.md +++ b/src/static/vue/v3/example/README.md @@ -1,29 +1,24 @@ # example-vue3 -## Project setup +A minimal Vue 3 app showcasing `@onesignal/onesignal-vue3`. -``` -npm install -``` +## Setup -### Compiles and hot-reloads for development +Replace `` in `src/main.ts` with your OneSignal app id. -``` -npm run serve -``` +## Available Scripts -### Compiles and minifies for production +In the project directory, you can run: -``` -npm run build -``` +### `npm start` -### Lints and fixes files +Builds the parent `@onesignal/onesignal-vue3` package, packs it as a tarball, +installs it locally, and runs the dev server. Open +[http://localhost:3000](http://localhost:3000) to view the app. -``` -npm run lint -``` +The page will reload if you make edits. -### Customize configuration +## Re-running setup -See [Configuration Reference](https://cli.vuejs.org/config/). +Run `vp run setup` to rebuild the parent package and re-install the freshly +packed tarball into the example. diff --git a/src/static/vue/v3/example/babel.config.js b/src/static/vue/v3/example/babel.config.js deleted file mode 100644 index e9558405..00000000 --- a/src/static/vue/v3/example/babel.config.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - presets: [ - '@vue/cli-plugin-babel/preset' - ] -} diff --git a/src/static/vue/v3/example/index.html b/src/static/vue/v3/example/index.html new file mode 100644 index 00000000..539452ce --- /dev/null +++ b/src/static/vue/v3/example/index.html @@ -0,0 +1,14 @@ + + + + + + + Vue 3 OneSignal Example + + + +
+ + + diff --git a/src/static/vue/v3/example/package.json b/src/static/vue/v3/example/package.json index 7724836c..37b4408e 100644 --- a/src/static/vue/v3/example/package.json +++ b/src/static/vue/v3/example/package.json @@ -2,42 +2,18 @@ "name": "example-vue3", "version": "0.1.0", "private": true, - "scripts": { - "serve": "vue-cli-service serve", - "build": "vue-cli-service build", - "lint": "vue-cli-service lint" - }, "dependencies": { - "@onesignal/onesignal-vue3": "^1.0.0", - "core-js": "^3.6.5", - "vue": "^3.0.0" + "vue": "^3.5.0" }, - "devDependencies": { - "@vue/cli-plugin-babel": "~4.5.13", - "@vue/cli-plugin-eslint": "~4.5.13", - "@vue/cli-service": "~4.5.13", - "@vue/compiler-sfc": "^3.0.0", - "babel-eslint": "^10.1.0", - "eslint": "^6.7.2", - "eslint-plugin-vue": "^7.0.0" + "scripts": { + "setup": "./scripts/setup.sh", + "prestart": "vp run setup", + "start": "vp dev" }, - "eslintConfig": { - "root": true, - "env": { - "node": true - }, - "extends": [ - "plugin:vue/vue3-essential", - "eslint:recommended" - ], - "parserOptions": { - "parser": "babel-eslint" - }, - "rules": {} + "devDependencies": { + "@vitejs/plugin-vue": "^6.0.7", + "typescript": "^5.8.2", + "vue-tsc": "^2.2.0" }, - "browserslist": [ - "> 1%", - "last 2 versions", - "not dead" - ] + "packageManager": "bun@1.3.13" } diff --git a/src/static/vue/v3/example/public/OneSignalSDKWorker.js b/src/static/vue/v3/example/public/OneSignalSDKWorker.js index f674ccfd..3f15a077 100644 --- a/src/static/vue/v3/example/public/OneSignalSDKWorker.js +++ b/src/static/vue/v3/example/public/OneSignalSDKWorker.js @@ -1 +1 @@ -importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js"); +importScripts("https://onesignal.com/sdks/web/v16/OneSignalSDK.sw.js"); diff --git a/src/static/vue/v3/example/public/index.html b/src/static/vue/v3/example/public/index.html deleted file mode 100644 index 3e5a1396..00000000 --- a/src/static/vue/v3/example/public/index.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - <%= htmlWebpackPlugin.options.title %> - - - -
- - - diff --git a/src/static/vue/v3/example/scripts/setup.sh b/src/static/vue/v3/example/scripts/setup.sh new file mode 100755 index 00000000..9a4ba261 --- /dev/null +++ b/src/static/vue/v3/example/scripts/setup.sh @@ -0,0 +1,25 @@ +#!/bin/bash +set -euo pipefail + +bold=$(tput bold 2>/dev/null || true) +normal=$(tput sgr0 2>/dev/null || true) + +log() { + echo -e "\n${bold}$1${normal}" +} + +EXAMPLE_DIR="$(cd "$(dirname "$0")/.." && pwd)" +PARENT_DIR="$(cd "$EXAMPLE_DIR/.." && pwd)" + +log "Building @onesignal/onesignal-vue3 in $PARENT_DIR" +cd "$PARENT_DIR" +vp run build + +log "Packing @onesignal/onesignal-vue3" +rm -f "$EXAMPLE_DIR"/onesignal-onesignal-vue3-*.tgz +TARBALL=$(bun pm pack | grep -E '\.tgz$' | tail -1) +mv "$PARENT_DIR/$TARBALL" "$EXAMPLE_DIR/$TARBALL" + +log "Installing tarball into example" +cd "$EXAMPLE_DIR" +vp add "./$TARBALL" diff --git a/src/static/vue/v3/example/src/App.vue b/src/static/vue/v3/example/src/App.vue index 1d812281..6060323d 100644 --- a/src/static/vue/v3/example/src/App.vue +++ b/src/static/vue/v3/example/src/App.vue @@ -1,41 +1,45 @@ -