io.appium.settings 5.6.0 → 5.7.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.7.0](https://github.com/appium/io.appium.settings/compare/v5.6.0...v5.7.0) (2024-01-11)
+
+
+### Features
+
+* Make the index typed ([#140](https://github.com/appium/io.appium.settings/issues/140)) ([7020af0](https://github.com/appium/io.appium.settings/commit/7020af0c0ec542b2271b5e4685ff9c63a5faa4c2))
+
 ## [5.6.0](https://github.com/appium/io.appium.settings/compare/v5.5.0...v5.6.0) (2024-01-10)
 
 

package/build/lib/index.d.ts

@@ -0,0 +1,4 @@
+export const path: string;
+export * from "./constants";
+export { SettingsApp } from "./client";
+//# sourceMappingURL=index.d.ts.map

package/build/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":"AAKA,0BAAyC"}

package/build/lib/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsApp = exports.path = void 0;
+const source_map_support_1 = require("source-map-support");
+(0, source_map_support_1.install)();
+const utils_1 = require("./utils");
+exports.path = (0, utils_1.getSettingsApkPath)();
+__exportStar(require("./constants"), exports);
+var client_1 = require("./client");
+Object.defineProperty(exports, "SettingsApp", { enumerable: true, get: function () { return client_1.SettingsApp; } });
+//# sourceMappingURL=index.js.map

package/build/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2DAA2C;AAC3C,IAAA,4BAAO,GAAE,CAAC;AAEV,mCAA6C;AAEhC,QAAA,IAAI,GAAG,IAAA,0BAAkB,GAAE,CAAC;AACzC,8CAA4B;AAC5B,mCAAuC;AAA9B,qGAAA,WAAW,OAAA"}

package/build/lib/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+export function getSettingsApkPath(): string;
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AA4BA;;;;GAIG;AACH,sCAFa,MAAM,CAIlB"}

package/build/lib/utils.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSettingsApkPath = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const MODULE_NAME = 'io.appium.settings';
+/**
+ * Tries to synchronously detect the absolute path to the folder
+ * where the given `moduleName` is located.
+ *
+ * @returns {string} Full path to the module root
+ */
+function getModuleRootSync() {
+    let currentDir = __dirname;
+    let isAtFsRoot = false;
+    while (!isAtFsRoot) {
+        const manifestPath = node_path_1.default.join(currentDir, 'package.json');
+        try {
+            if (node_fs_1.default.existsSync(manifestPath) &&
+                JSON.parse(node_fs_1.default.readFileSync(manifestPath, 'utf8')).name === MODULE_NAME) {
+                return currentDir;
+            }
+        }
+        catch (ign) { }
+        currentDir = node_path_1.default.dirname(currentDir);
+        isAtFsRoot = currentDir.length <= node_path_1.default.dirname(currentDir).length;
+    }
+    throw new Error(`Cannot find the root of the ${MODULE_NAME} Node.js module`);
+}
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+function getSettingsApkPath() {
+    return node_path_1.default.resolve(getModuleRootSync(), 'apks', 'settings_apk-debug.apk');
+}
+exports.getSettingsApkPath = getSettingsApkPath;
+//# sourceMappingURL=utils.js.map

package/build/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAC7B,sDAAyB;AAEzB,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEzC;;;;;GAKG;AACH,SAAS,iBAAiB;IACxB,IAAI,UAAU,GAAG,SAAS,CAAC;IAC3B,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,OAAO,CAAC,UAAU,EAAE,CAAC;QACnB,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC3D,IAAI,CAAC;YACH,IAAI,iBAAE,CAAC,UAAU,CAAC,YAAY,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC3E,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;QAChB,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,IAAI,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACpE,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,WAAW,iBAAiB,CAAC,CAAC;AAC/E,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB;IAChC,OAAO,mBAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAC7E,CAAC;AAFD,gDAEC"}

package/lib/index.js

@@ -0,0 +1,8 @@
+import {install} from 'source-map-support';
+install();
+
+import { getSettingsApkPath } from './utils';
+
+export const path = getSettingsApkPath();
+export * from './constants';
+export { SettingsApp } from './client';

package/lib/utils.js

@@ -0,0 +1,36 @@
+import path from 'node:path';
+import fs from 'node:fs';
+
+const MODULE_NAME = 'io.appium.settings';
+
+/**
+ * Tries to synchronously detect the absolute path to the folder
+ * where the given `moduleName` is located.
+ *
+ * @returns {string} Full path to the module root
+ */
+function getModuleRootSync () {
+  let currentDir = __dirname;
+  let isAtFsRoot = false;
+  while (!isAtFsRoot) {
+    const manifestPath = path.join(currentDir, 'package.json');
+    try {
+      if (fs.existsSync(manifestPath) &&
+          JSON.parse(fs.readFileSync(manifestPath, 'utf8')).name === MODULE_NAME) {
+        return currentDir;
+      }
+    } catch (ign) {}
+    currentDir = path.dirname(currentDir);
+    isAtFsRoot = currentDir.length <= path.dirname(currentDir).length;
+  }
+  throw new Error(`Cannot find the root of the ${MODULE_NAME} Node.js module`);
+}
+
+/**
+ * Get the full path to the Settings APK
+ *
+ * @returns {string}
+ */
+export function getSettingsApkPath() {
+  return path.resolve(getModuleRootSync(), 'apks', 'settings_apk-debug.apk');
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "io.appium.settings",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "App for dealing with Android settings",
-  "main": "index.js",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "scripts": {
     "bump-gradle-version": "node scripts/gradle-version-update.js --package-version=${npm_package_version} && git add app/build.gradle",
     "lint": "./gradlew lint",
@@ -29,7 +30,6 @@
     "settings"
   ],
   "files": [
-    "index.js",
     "lib",
     "build/lib",
     "apks",

package/index.js

@@ -1,9 +0,0 @@
-const path = require('node:path');
-const { SettingsApp } = require('./build/lib/client');
-const constants = require('./build/lib/constants');
-
-module.exports = {
-  path: path.resolve(__dirname, 'apks', 'settings_apk-debug.apk'),
-  SettingsApp,
-  ...constants,
-};