@cap-kit/test-plugin 0.1.2 → 1.0.1

package/ios/Sources/TestPlugin/Utils/Logging.swift

@@ -0,0 +1,57 @@
+import Capacitor
+
+/**
+ Centralized logger for the Test plugin.
+
+ This logger mirrors the Android Logger pattern and provides:
+ - a single logging entry point
+ - runtime-controlled verbose logging
+ - consistent log formatting
+
+ Business logic MUST NOT perform configuration checks directly.
+ */
+enum TestLogger {
+
+    /**
+     Controls whether debug logs are printed.
+
+     This value is set once during plugin load
+     based on configuration values.
+     */
+    static var verbose: Bool = false
+
+    /**
+     Prints a verbose / debug log message.
+
+     This method is intended for development-time diagnostics
+     and is automatically silenced when verbose logging is disabled.
+     */
+    static func debug(_ items: Any...) {
+        guard verbose else { return }
+        log(items)
+    }
+
+    /**
+     Prints an error log message.
+
+     Error logs are always printed regardless of verbosity.
+     */
+    static func error(_ items: Any...) {
+        log(items)
+    }
+}
+
+/**
+ Low-level log printer with a consistent prefix.
+
+ This function should not be used directly outside this file.
+ */
+private func log(_ items: Any..., separator: String = " ", terminator: String = "\n") {
+    CAPLog.print("⚡️  Test -", terminator: separator)
+    for (itemIndex, item) in items.enumerated() {
+        CAPLog.print(
+            item,
+            terminator: itemIndex == items.count - 1 ? terminator : separator
+        )
+    }
+}

package/ios/Sources/TestPlugin/Utils/TestUtils.swift

@@ -0,0 +1,12 @@
+import Foundation
+
+/**
+ Utility helpers for the Test plugin.
+
+ This type is intentionally empty and serves as a placeholder
+ for future shared helper functions.
+
+ Keeping a dedicated utilities file helps maintain a clean
+ separation between core logic and helper code.
+ */
+struct TestUtils {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-kit/test-plugin",
-  "version": "0.1.2",
+  "version": "1.0.1",
   "description": "Test plugin for Cap-Kit.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -37,26 +37,26 @@
     "access": "public"
   },
   "devDependencies": {
-    "@capacitor/cli": "^8.0.0",
-    "@capacitor/android": "^8.0.0",
-    "@capacitor/core": "^8.0.0",
+    "@capacitor/cli": "^8.0.1",
+    "@capacitor/android": "^8.0.1",
+    "@capacitor/core": "^8.0.1",
     "@capacitor/docgen": "^0.3.1",
-    "@capacitor/ios": "^8.0.0",
+    "@capacitor/ios": "^8.0.1",
     "@eslint/eslintrc": "^3.3.3",
     "@eslint/js": "^9.39.2",
     "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.32.0",
     "globals": "^17.0.0",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.0",
     "prettier-plugin-java": "^2.8.1",
     "rimraf": "^6.1.2",
-    "rollup": "^4.55.1",
+    "rollup": "^4.55.2",
     "swiftlint": "^2.0.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.52.0"
+    "typescript-eslint": "^8.53.1"
   },
   "peerDependencies": {
-    "@capacitor/core": ">=8.0.0"
+    "@capacitor/core": ">=8.0.1"
   },
   "capacitor": {
     "ios": {

package/android/src/main/java/com/capkit/test/Logger.kt

@@ -1,25 +0,0 @@
-package com.capkit.test
-
-import android.util.Log
-
-/**
- * Utility object for logging messages with a custom prefix.
- */
-object Logger {
-  private const val TAG = "⚡️ Test"
-
-  fun debug(vararg messages: String) {
-    log(TAG, *messages)
-  }
-
-  fun log(
-    tag: String,
-    vararg messages: String,
-  ) {
-    val sb = StringBuilder()
-    for (msg in messages) {
-      sb.append(msg).append(" ")
-    }
-    Log.d(tag, sb.toString())
-  }
-}

package/android/src/main/java/com/capkit/test/Test.kt

@@ -1,20 +0,0 @@
-package com.capkit.test
-
-/**
- * Native implementation for the Test Capacitor plugin.
- *
- * This class contains platform logic only and does not depend on
- * Capacitor plugin APIs.
- */
-class Test {
-  /**
-   * Returns the provided string unchanged.
-   *
-   * @param value Input string.
-   * @return The same string.
-   */
-  fun echo(value: String): String {
-    Logger.debug(value)
-    return value
-  }
-}

package/android/src/main/java/com/capkit/test/TestConfig.kt

@@ -1,16 +0,0 @@
-package com.capkit.test
-
-import com.getcapacitor.Plugin
-
-/**
- * Helper class to manage the plugin configuration.
- * It parses the values from capacitor.config.json
- */
-class TestConfig(plugin: Plugin) {
-  val customMessage: String
-
-  init {
-    // "customMessage" must match the key in capacitor.config.ts
-    customMessage = plugin.getConfig().getString("customMessage") ?: " (from config)"
-  }
-}

package/android/src/main/java/com/capkit/test/TestPlugin.kt

@@ -1,60 +0,0 @@
-package com.capkit.test
-
-import com.getcapacitor.JSObject
-import com.getcapacitor.Plugin
-import com.getcapacitor.PluginCall
-import com.getcapacitor.PluginMethod
-import com.getcapacitor.annotation.CapacitorPlugin
-
-/**
- * Capacitor bridge for the Test plugin.
- *
- * This class exposes native Android functionality to JavaScript
- * and delegates all business logic to the implementation class.
- */
-@CapacitorPlugin(
-  name = "Test",
-)
-class TestPlugin : Plugin() {
-  private lateinit var config: TestConfig
-
-  override fun load() {
-    super.load()
-    Logger.debug("Loading plugin")
-    config = TestConfig(this)
-  }
-
-  /** Plugin version (injected by Gradle). */
-  private val pluginVersion: String = BuildConfig.PLUGIN_VERSION
-
-  /** Native implementation (business logic). */
-  private val implementation = Test()
-
-  /**
-   * Echoes a string back to JavaScript.
-   *
-   * @param call Capacitor plugin call containing the `value` parameter.
-   */
-  @PluginMethod
-  fun echo(call: PluginCall) {
-    var value = call.getString("value") ?: ""
-    Logger.debug("Echoing value: $value")
-
-    // Append the custom message from the configuration
-    value += config.customMessage
-
-    val ret = JSObject()
-    ret.put("value", implementation.echo(value))
-    call.resolve(ret)
-  }
-
-  /**
-   * Returns the plugin version.
-   */
-  @PluginMethod
-  fun getPluginVersion(call: PluginCall) {
-    val ret = JSObject()
-    ret.put("version", pluginVersion)
-    call.resolve(ret)
-  }
-}

package/ios/Sources/TestPlugin/Logging.swift

@@ -1,32 +0,0 @@
-import Capacitor
-
-/**
- * Utility function for logging messages with a custom prefix.
- *
- * This function is designed to format log messages for the Test plugin. It prepends the log output
- * with a custom prefix (`⚡️  Test -`) to easily identify logs associated with this plugin.
- *
- * @param items - Items to log, stringified and logged in order.
- * @param separator - A string used to separate the logged items. Defaults to a single space (`" "`).
- * @param terminator - A string appended to the end of the log message. Defaults to a newline (`"\n"`).
- *
- * Example Usage:
- * ```
- * log("This is a message", "with multiple parts", separator: ", ")
- * // Output: ⚡️  Test - This is a message, with multiple parts
- * ```
- *
- * Note:
- * - This function uses Capacitor's `CAPLog.print` for outputting log messages.
- * - Multiple items use `separator` and end with `terminator`.
- */
-func log(_ items: Any..., separator: String = " ", terminator: String = "\n") {
-    // Prefix the log with "⚡️  Test -"
-    CAPLog.print("⚡️  Test -", terminator: separator)
-
-    // Iterate over the provided items and print each one
-    for (itemIndex, item) in items.enumerated() {
-        // Use the specified separator between items, and the terminator for the final item
-        CAPLog.print(item, terminator: itemIndex == items.count - 1 ? terminator : separator)
-    }
-}