@overwolf/ow-electron 12.2.3

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) Electron contributors
+Copyright (c) 2013-2020 GitHub Inc.
+Copyright (c) Overwolf Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# Overwolf Electron
+
+We currently have these npm packages:
+
+- [@overwolf/ow-electron](https://www.npmjs.com/package/@overwolf/ow-electron) is a package based on the
+[electron package](https://www.npmjs.com/package/electron), which adds a
+few features to it
+- [@overwolf/ow-electron-builder](https://www.npmjs.com/package/@overwolf/ow-electron-builder) is a packaged based on electron-builder which
+supports building ow-electron
+- @overwolf/electron-is-overwolf - similar to
+[electron-is-dev](https://www.npmjs.com/package/electron-is-dev)
+
+There is no problem that both packages reside side-by-side with the original
+electron/electron-builder packages in your project. You just have to create new
+package.json scripts:
+
+```
+"scripts": {
+  ...
+
+  "start": "ow-electron .",
+  "build:ow-electron": "ow-electron-builder --publish=never"
+},
+```
+
+## package.json properties
+
+Each ow-electron app should have a unique id. The unique id is auto-generated
+based on the <productName/name + author.name> fields of the package.json.
+
+We use this for ad optimization and optionally, for
+[anonymous analytics](#anonymous-analytics) reports that you may review on our developer's console.
+
+> **NOTE:** To see the generated uid - you can use the OVERWOLF_APP_UID
+> environment variable (process.env.OVERWOLF_APP_UID) once the |app.whenReady|
+> triggers. Before the app is ready, the variable won't exist.
+
+## owadview tag
+
+> **NOTE:** In order to see ads, we first have to setup our backend to support
+> your app's uid (See package.json properties above).
+> Please contact us for further info on this
+> [contact us](https://overwolf.github.io/support/contact-us)
+
+The <owadview/> tag, which is based on the Electron <webview/> tag, hosts and
+auto manages ads in your app.
+
+To use it, place the <owadview/> tag (no attributes required) inside a <div> tag
+which has the size of the standard IAB ad unit you wish to display.
+
+See https://overwolf.github.io/start/monetize-with-ads/ads-monetization-basics
+for some more information about supported ad units + Dos’ and ‘Dont’s. This
+documentation is aimed at the Overwolf platform, however, the general ad
+details are relevant for the ow-electron build as well.
+
+```
+<div style="width: 400px;height: 300px; background: transparent;">
+  <owadview />
+</div>
+```
+
+> **NOTE:** We use background: transparent so that you can show a background
+> image as a fallback when there are no ads inventory to display.
+
+A few extra things to know:
+
+- The <owadview/> starts auto-muted. This can be changed, see
+https://www.electronjs.org/docs/latest/api/webview-tag#webviewsetaudiomutedmuted
+- The tag is self managed so there is no need to worry about visiblity of ads
+or crashes
+
+## Anonymous Analytics
+
+In order to generate some reports for you about the usage of your ow-electron
+app, we collect very few anonymous analytics (such as when the app is launched
+and when an app's window is shown).
+
+You can disable this via code:
+
+```
+import { app } from 'electron';
+
+app.overwolf.disableAnonymousAnalytics();
+
+...
+
+app.whenReady().then(...
+```
+
+> **NOTE:** This call isn't persistent across sessions - it needs to be called
+> every time the app is launched.
+
+
+## Consent Management Platform (CMP)
+
+CMP makes it easier for you to meet the technical requirements of the law by simplifying the legally required process of collecting consent to cookies.
+
+Before using your app, the user should be informed about the existence of the CMP and be able to easily access it.
+
+We recommend showing this information during the installation phase or as a first-time usage message.
+
+The ow-electron comes with a CMP implementation built in.
+
+> **NOTE:** You can leverage our Windows Installer for this (contact us).
+
+In order to know if the user is required to be informed about the CMP - use the |app.overwolf.isCMPRequired| api:
+
+```
+import { app } from 'electron';
+
+await app.overwolf.isCMPRequired();
+```
+
+In order to open the built-in CMP window - use the |app.overwolf.openCMPWindow| api:
+
+
+```
+app.overwolf.openCMPWindow();
+```
+
+

package/checksums.json

@@ -0,0 +1,8 @@
+{ 
+  "electron-api.json": "5cdff2c72e8ed445662aea8ac8a9775b1c5675e9337f1683e865d599577912fc",
+  "ow-electron-v12.2.3-darwin-arm64.zip": "d29d234c09ba810d89ed1fba9e405b6975916ea208d001348379f89b50d1835c",
+  "ow-electron-v12.2.3-darwin-x64.zip": "5af34f1198ce9fd17e9fa581f57a8ad2c9333187fb617fe943f30b8cde9e6231",
+  "ow-electron-v12.2.3-linux-x64.zip": "deae6d0941762147716b8298476080d961df2a32d0f6f57b244cbe3a2553cd24",
+  "ow-electron-v12.2.3-win32-x64.zip": "944b25fcce24b825d79041949411a4a1e600cace642b1c554e3eeb0b3ba38ece",
+  "electron.d.ts": "41eb5e1e0a72ac70cf30fc377e7b821fd62d24104e7ee6621a02f0c55b561cf4"
+}

package/cli.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+const electron = require('./');
+
+const proc = require('child_process');
+
+const child = proc.spawn(electron, process.argv.slice(2), { stdio: 'inherit', windowsHide: false });
+child.on('close', function (code, signal) {
+  if (code === null) {
+    console.error(electron, 'exited with signal', signal);
+    process.exit(1);
+  }
+  process.exit(code);
+});
+
+const handleTerminationSignal = function (signal) {
+  process.on(signal, function signalHandler () {
+    if (!child.killed) {
+      child.kill(signal);
+    }
+  });
+};
+
+handleTerminationSignal('SIGINT');
+handleTerminationSignal('SIGTERM');