@ohos-ports/itwcw-package-analytics 0.0.0-stage → 1.0.8-beta.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Changelog Categories
+
+- `BREAKING` for breaking changes.
+- `Added` for new features.
+- `Changed` for changes in existing functionality.
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for any bug fixes.
+- `Security` in case of vulnerabilities.
+
+---
+## [1.0.0] - 2024-06-19
+### Added
+- Initial release of the project 🚀

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ITWCW Package Analytics
+
+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

@@ -1,3 +1,54 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://itwcreativeworks.com">
+    <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
+  </a>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  <img src="https://img.shields.io/github/package-json/v/itw-creative-works/itwcw-package-analytics.svg">
+  <br>
+  <img src="https://img.shields.io/librariesio/release/npm/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/bundlephobia/min/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/codeclimate/maintainability-percentage/itw-creative-works/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/npm/dm/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/node/v/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/website/https/itwcreativeworks.com.svg">
+  <img src="https://img.shields.io/github/license/itw-creative-works/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/github/contributors/itw-creative-works/itwcw-package-analytics.svg">
+  <img src="https://img.shields.io/github/last-commit/itw-creative-works/itwcw-package-analytics.svg">
+  <br>
+  <br>
+  <a href="https://itwcreativeworks.com">Site</a> | <a href="https://www.npmjs.com/package/itwcw-package-analytics">NPM Module</a> | <a href="https://github.com/itw-creative-works/itwcw-package-analytics">GitHub Repo</a>
+  <br>
+  <br>
+  <strong>itwcw-package-analytics</strong> is the official npm module of <a href="https://itwcreativeworks.com">ITWCW Package Analytics</a>, an internal package our company uses to monitor and analyze our npm packages.
+</p>
+
+## 🦄 Features
+* Analytics for npm packages
+* Reporting to GA4
+
+## 📦 Install ITWCW Package Analytics
+### Option 1: Install via npm
+Install with npm if you plan to use `itwcw-package-analytics` in a Node project or in the browser.
+```shell
+npm install itwcw-package-analytics
+```
+
+Upon installation, the package will perform an analytics request using the ITWCW Package Analytics service to report the installation.
+
+## 🗨️ Final Words
+If you are still having difficulty, we would love for you to post
+a question to [the ITWCW Package Analytics issues page](https://github.com/itw-creative-works/itwcw-package-analytics/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
+
+## 📚 Projects Using this Library
+* [ITW Creative Works](https://itwcreativeworks.com)
+* [Somiibo](https://somiibo.com)
+* [Slapform](https://slapform.com)
+* [StudyMonkey](https://studymonkey.ai)
+* [DashQR](https://dashqr.com)
+* [Replyify](https://replyify.app)
+* [SoundGrail](https://soundgrail.com)
+* [Trusteroo](https://trusteroo.com)
+
+Ask us to have your project listed! :)

package/dist/index.js

@@ -0,0 +1,53 @@
+(function (root, factory) {
+  // https://github.com/umdjs/umd/blob/master/templates/returnExports.js
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define([], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // Node. Does not work with strict CommonJS, but
+    // only CommonJS-like environments that support module.exports,
+    // like Node.
+    module.exports = factory();
+  } else {
+    // Browser globals (root is window)
+    root.returnExports = factory();
+  }
+}(typeof self !== 'undefined' ? self : this, function () {
+
+  var environment = (Object.prototype.toString.call(typeof process !== 'undefined' ? process : 0) === '[object process]') ? 'node' : 'browser';
+
+  var SOURCE = 'library';
+  var VERSION = '1.0.8';
+
+  function ITWCWPackageAnalytics(options) {
+    var self = this;
+
+    self.options = options || {};
+
+    return self
+  };
+
+  ITWCWPackageAnalytics.prototype.method = function (options) {
+    var self = this;
+
+    options = options || {};
+
+    return new Promise(function(resolve, reject) {
+
+    });
+  }
+
+  // Register
+  if (environment === 'browser') {
+    try {
+      window.ITWCWPackageAnalytics = ITWCWPackageAnalytics;
+    } catch (e) {
+    }
+  }
+
+  // Just return a value to define the module export.
+  // This example returns an object, but the module
+  // can return a function as the exported value.
+  return ITWCWPackageAnalytics; // Enable if using UMD
+
+}));

package/dist/postinstall.js

@@ -0,0 +1,212 @@
+const jetpack = require('fs-jetpack');
+const fetch = require('wonderful-fetch');
+const path = require('path');
+
+// const argv = require('yargs').argv;
+
+// Safely require a file and return null if it fails
+function safeRequire(filePath, label) {
+  try {
+    return require(filePath);
+  } catch (e) {
+    console.warn(`[itwcw-package-analytics]: Failed to load ${label} at ${filePath}:`, e.message);
+    return null;
+  }
+}
+
+module.exports = async function (options) {
+  // Set the options
+  options = options || {};
+  options.cwd = options.cwd || process.cwd();
+  options.npmPackageName = options.npmPackageName || '';
+  options.isPostInstall = typeof options.isPostInstall === 'undefined' ? false : options.isPostInstall;
+
+  // Get the package.json files
+  const thisPackageJSON = safeRequire('../package.json', 'this package.json');
+  const theirPackageJSON = safeRequire(path.join(options.cwd, 'package.json'), 'their package.json');
+
+  // Exit if either package.json failed to load
+  if (!thisPackageJSON || !theirPackageJSON) {
+    console.warn('[itwcw-package-analytics]: Skipping analytics due to missing package.json');
+    return;
+  }
+
+  // Send analytics
+  await sendAnalytics(thisPackageJSON, theirPackageJSON)
+  .then((r) => {
+    console.log(`[itwcw-package-analytics]: Sent analytics code=${r.status}`);
+  })
+  .catch(e => {
+    console.log(`[itwcw-package-analytics]: Failed to send analytics`, e);
+  });
+}
+
+// Send analytics
+function sendAnalytics(thisPackageJSON, theirPackageJSON) {
+  return new Promise(async function(resolve, reject) {
+    // Guard: wrap the async executor so a synchronous/awaited throw rejects
+    // the outer promise instead of leaving it pending (async executor anti-pattern)
+    try {
+    const uuidv5 = require('uuid').v5;
+    const os = require('os');
+    // Guard: os.userInfo() throws ERR_SYSTEM_ERROR on platforms without a user
+    // database entry (uv_os_get_passwd ENOENT, e.g. openharmony) — fall back to
+    // a neutral object so the analytics fields degrade gracefully there
+    let userInfo;
+    try {
+      userInfo = os.userInfo();
+    } catch (e) {
+      console.warn('[itwcw-package-analytics]: os.userInfo() unavailable, using fallback:', e.message);
+      userInfo = { username: '', homedir: '', shell: '', uid: -1, gid: -1 };
+    }
+
+    // Build url and body
+    const analyticsId = 'G-9YP4NNBLY3';
+    const analyticsSecret = 'w3Z2tfucR9KFPB8it5WkyQ';
+    const url = `https://www.google-analytics.com/mp/collect?measurement_id=${analyticsId}&api_secret=${analyticsSecret}`;
+    const mac = getDeviceUniqueId();
+    const uuid = uuidv5(mac, '4caf995a-3d43-451b-b34d-e535d2663bc1');
+    const simpleOS = getSimpleOS(os.platform());
+    const name = (theirPackageJSON.name || 'unknown')
+      // Replace anything not a letter, number, or underscore with an underscore
+      .replace(/[^a-zA-Z0-9_]/g, '_')
+      // Remove leading and trailing underscores
+      .replace(/^_+|_+$/g, '')
+      // Remove multiple underscores
+      .replace(/_+/g, '_');
+
+    // Build body
+    const body = {
+      client_id: uuid,
+      user_id: uuid,
+      // timestamp_micros: new Date().getTime() * 1000,
+      user_properties: {
+        // operating_system: simpleOS, // CAUSES EVENT TO NOT BE SENT
+      },
+      user_data: {
+      },
+      // consent: {},
+      // non_personalized_ads: false,
+      events: [{
+        name: name,
+        params: {
+          packageName: theirPackageJSON.name,
+          packageVersion: theirPackageJSON.version,
+          preparePackageVersion: thisPackageJSON.version,
+          os: simpleOS,
+          platform: os.platform(),
+          arch: os.arch(),
+          release: os.release(),
+          hostname: os.hostname(),
+          cpus: os.cpus().length,
+          memory: os.totalmem(),
+          uptime: os.uptime(),
+          username: userInfo.username,
+          homedir: userInfo.homedir,
+          shell: userInfo.shell,
+          uid: userInfo.uid,
+          gid: userInfo.gid,
+        },
+      }],
+    }
+
+    // Get the user's location
+    const geolocationCachePath = path.resolve(os.tmpdir(), 'itwcw-package-analytics-geolocation-cache.json');
+    const geolocation = await fetch('https://ipapi.co/json/', {
+      response: 'json',
+      tries: 2,
+      timeout: 30000,
+    })
+    .then((r) => {
+      // Save to tmpdir
+      jetpack.write(geolocationCachePath, JSON.stringify(r, null, 2));
+
+      return r;
+    })
+    .catch((e) => {
+      console.log(`[itwcw-package-analytics]: Failed to get geolocation`, e.message);
+
+      // Try to get from cache
+      if (jetpack.exists(geolocationCachePath)) {
+        console.log(`[itwcw-package-analytics]: Used cached geolocation`);
+
+        return JSON.parse(jetpack.read(geolocationCachePath));
+      }
+    });
+
+    // Add the geolocation to the body
+    if (geolocation) {
+      body.user_data.city = geolocation.city || 'Unknown';
+      body.user_data.region = geolocation.region || 'Unknown';
+      body.user_data.country = geolocation.country || 'Unknown';
+
+      body.user_properties.language = (geolocation.languages || 'Unknown').split(',')[0];
+    }
+
+    // Log the options
+    // console.log(`[itwcw-package-analytics]: Sending analytics mac=${mac}, uuid=${uuid}...`, body, body.events[0].params);
+    console.log(`[itwcw-package-analytics]: Sending analytics mac=${mac}, uuid=${uuid}...`);
+
+    // Send event
+    fetch(url, {
+      method: 'post',
+      response: 'raw',
+      tries: 2,
+      timeout: 30000,
+      body: body,
+    })
+    .then((r) => {
+      resolve(r);
+    })
+    .catch((e) => {
+      reject(e);
+    });
+    } catch (err) {
+      reject(err);
+    }
+  });
+}
+
+const getDeviceUniqueId = () => {
+  const os = require('os');
+  const interfaces = os.networkInterfaces();
+
+  // Find the first valid MAC address
+  for (const name in interfaces) {
+    for (const net of interfaces[name]) {
+      if (!net.internal && net.mac && net.mac !== '00:00:00:00:00:00') {
+        return net.mac;
+      }
+    }
+  }
+
+  // Log
+  console.warn('No valid MAC address found. Generating a random MAC address.');
+
+  // Generate a random MAC address
+  const hexDigits = '0123456789ABCDEF';
+  let mac = '';
+  for (let i = 0; i < 6; i++) {
+    let byte = '';
+    for (let j = 0; j < 2; j++) {
+      byte += hexDigits.charAt(Math.floor(Math.random() * 16));
+    }
+    mac += byte;
+    if (i !== 5) mac += ':';
+  }
+  return mac;
+};
+
+const getSimpleOS = (platform) => {
+  switch (platform) {
+    case 'darwin':
+      return 'mac';
+    case 'win32':
+      return 'windows';
+    case 'linux':
+      return 'linux';
+    default:
+      return platform;
+  }
+};
+

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@ohos-ports/itwcw-package-analytics",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.8-beta.0",
+  "description": "Reporting tool for ITW Creative Works packages",
+  "main": "./dist/index.js",
+  "scripts": {
+    "test": "npm run prepare && ./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
+    "prepare": "node -e \"require('prepare-package')()\"",
+    "prepare:watch": "node -e \"require('prepare-package/watch')()\"",
+    "postinstall": "node -e \"require('./dist/postinstall.js')({cwd: process.env.INIT_CWD, npmPackageName: process.env.npm_package_name})\""
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/itwcw-package-analytics/1.0.8"
+  },
+  "keywords": [
+    "itwcw-package-analytics"
+  ],
+  "author": "ITW Creative Works",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/itw-creative-works/itwcw-package-analytics/issues"
+  },
+  "homepage": "https://itwcreativeworks.com",
+  "preparePackage": {
+    "input": "./src",
+    "output": "./dist",
+    "replace": {}
+  },
+  "dependencies": {
+    "fs-jetpack": "^4.3.1",
+    "uuid": "^9.0.1",
+    "wonderful-fetch": "^1.3.4"
+  },
+  "devDependencies": {
+    "mocha": "^8.4.0",
+    "prepare-package": "^1.2.6"
+  }
+}