@cap-kit/integrity 8.0.0-next.6

package/dist/docs.json

@@ -0,0 +1,598 @@
+{
+  "api": {
+    "name": "IntegrityPlugin",
+    "slug": "integrityplugin",
+    "docs": "Public JavaScript API for the Integrity Capacitor plugin.\n\nThis interface defines a stable, platform-agnostic API.\nAll methods behave consistently across Android, iOS, and Web.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "check",
+        "signature": "(options?: IntegrityCheckOptions | undefined) => Promise<IntegrityReport>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "IntegrityCheckOptions | undefined"
+          }
+        ],
+        "returns": "Promise<IntegrityReport>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```ts\nconst report = await Integrity.check();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Executes a runtime integrity check.",
+        "complexTypes": [
+          "IntegrityReport",
+          "IntegrityCheckOptions"
+        ],
+        "slug": "check"
+      },
+      {
+        "name": "presentBlockPage",
+        "signature": "(options?: PresentBlockPageOptions | undefined) => Promise<PresentBlockPageResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PresentBlockPageOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PresentBlockPageResult>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```ts\nawait Integrity.presentBlockPage({ reason: 'integrity_failed' });\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Presents the configured integrity block page, if enabled.\n\nThe plugin never decides *when* this method should be called.\nInvocation is entirely controlled by the host application.",
+        "complexTypes": [
+          "PresentBlockPageResult",
+          "PresentBlockPageOptions"
+        ],
+        "slug": "presentblockpage"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise resolving to the plugin version."
+          },
+          {
+            "name": "example",
+            "text": "```ts\nconst { version } = await Integrity.getPluginVersion();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Returns the native plugin version.\n\nThe returned version corresponds to the native implementation\nbundled with the application.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'integritySignal', listenerFunc: (signal: IntegritySignalEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The event to listen for ('integritySignal').",
+            "type": "'integritySignal'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Callback invoked with the detected signal.",
+            "type": "(signal: IntegritySignal) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName The event to listen for ('integritySignal')."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback invoked with the detected signal."
+          },
+          {
+            "name": "returns",
+            "text": "A Promise resolving to a `PluginListenerHandle`."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Registers a listener for real-time integrity signals.\n\nThe provided callback is invoked every time a new integrity\nsignal is detected by the native layer.\n\nBEHAVIOR:\n- Signals may be emitted at any time after plugin initialization.\n- Signals detected before listener registration MAY be delivered\n  immediately after registration.\n- No guarantees are made about signal frequency or ordering\n  across platforms.\n\nIMPORTANT:\n- This listener is non-blocking.\n- The plugin does NOT enforce any policy based on signals.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "IntegritySignalEvent"
+        ],
+        "slug": "addlistenerintegritysignal-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Removes all registered listeners for this plugin.\n\nNOTE:\n- Removing listeners does NOT stop signal detection natively.\n- Signals may continue to be detected and buffered\n  until a listener is registered again.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "IntegrityReport",
+      "slug": "integrityreport",
+      "docs": "Result object returned by `Integrity.check()`.\n\nThis object aggregates all detected signals\nand provides a provisional integrity score.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "compromised",
+          "tags": [],
+          "docs": "Indicates whether the environment is considered compromised\naccording to the current scoring model.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "score",
+          "tags": [],
+          "docs": "Provisional integrity score.\n\nThe score ranges from 0 to 100 and is derived\nfrom the detected signals.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "signals",
+          "tags": [],
+          "docs": "List of detected integrity signals.",
+          "complexTypes": [
+            "IntegritySignal"
+          ],
+          "type": "IntegritySignal[]"
+        },
+        {
+          "name": "environment",
+          "tags": [],
+          "docs": "Execution environment summary.",
+          "complexTypes": [
+            "IntegrityEnvironment"
+          ],
+          "type": "IntegrityEnvironment"
+        },
+        {
+          "name": "timestamp",
+          "tags": [],
+          "docs": "Unix timestamp (milliseconds) when the check was performed.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "scoreExplanation",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional explanation metadata describing how the integrity score\nwas derived from the detected signals.\n\nThis field is informational only and MUST NOT be treated\nas a security decision or enforcement mechanism.",
+          "complexTypes": [
+            "IntegrityScoreExplanation"
+          ],
+          "type": "IntegrityScoreExplanation"
+        }
+      ]
+    },
+    {
+      "name": "IntegritySignal",
+      "slug": "integritysignal",
+      "docs": "A single integrity signal detected on the current device.\n\nSignals represent *observations*, not decisions.\nMultiple signals MAY be combined by the host application\nto derive a security policy.\n\nSignals:\n- are emitted asynchronously\n- may occur at any time during the app lifecycle\n- may be emitted before or after the first call to `check()`",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Stable identifier for the signal.\n\nThis value:\n- is stable across releases\n- MUST NOT be parsed or pattern-matched\n- is intended for analytics, logging, and policy evaluation",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "category",
+          "tags": [],
+          "docs": "High-level category of the signal.\n\nCategories allow grouping related signals\nwithout relying on specific identifiers.",
+          "complexTypes": [
+            "IntegritySignalCategory"
+          ],
+          "type": "IntegritySignalCategory"
+        },
+        {
+          "name": "confidence",
+          "tags": [],
+          "docs": "Confidence level of the detection.\n\nThis value expresses how strongly the signal correlates\nwith a potentially compromised or risky environment.\n\nNOTE:\nAlthough typed as a string union in the public API,\nnative implementations MUST only emit values defined\nby the internal IntegrityConfidenceLevel enum.",
+          "complexTypes": [
+            "IntegrityConfidenceLevel"
+          ],
+          "type": "IntegrityConfidenceLevel"
+        },
+        {
+          "name": "description",
+          "tags": [],
+          "docs": "Optional human-readable description.\n\nThis field:\n- is intended for diagnostics and debugging only\n- MAY be omitted or redacted in production builds\n- MUST NOT be relied upon programmatically",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "metadata",
+          "tags": [],
+          "docs": "Additional diagnostic metadata associated with the signal.\n\nMetadata provides granular details about the detection\n(e.g. matched filesystem paths, runtime artifacts,\nor environment properties) without altering the\nstable signal identifier.\n\nIMPORTANT:\n- Metadata is informational only.\n- Keys and values are NOT guaranteed to be stable.\n- Applications MUST NOT rely on specific metadata fields\n  for security decisions.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string | number | boolean>"
+        }
+      ]
+    },
+    {
+      "name": "IntegrityEnvironment",
+      "slug": "integrityenvironment",
+      "docs": "Summary of the execution environment in which\nthe integrity check was performed.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "platform",
+          "tags": [],
+          "docs": "Current platform.",
+          "complexTypes": [],
+          "type": "'ios' | 'android' | 'web'"
+        },
+        {
+          "name": "isEmulator",
+          "tags": [],
+          "docs": "Indicates whether the app is running\nin an emulator or simulator environment.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isDebugBuild",
+          "tags": [],
+          "docs": "Indicates whether the app was built\nin debug/development mode.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "IntegrityScoreExplanation",
+      "slug": "integrityscoreexplanation",
+      "docs": "Describes how the integrity score was derived.\n\nThis structure provides transparency and auditability\nwithout exposing internal scoring algorithms.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalSignals",
+          "tags": [],
+          "docs": "Total number of detected signals.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "byConfidence",
+          "tags": [],
+          "docs": "Breakdown of signals by confidence level.",
+          "complexTypes": [],
+          "type": "{ high: number; medium: number; low: number; }"
+        },
+        {
+          "name": "contributors",
+          "tags": [],
+          "docs": "List of signal identifiers that contributed to the score.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "IntegrityCheckOptions",
+      "slug": "integritycheckoptions",
+      "docs": "Options controlling the behavior of `Integrity.check()`.\n\nThese options influence *how* checks are performed,\nnot *what* the public API returns.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "level",
+          "tags": [],
+          "docs": "Desired strictness level.\n\nHigher levels may enable additional heuristics\nat the cost of performance.",
+          "complexTypes": [],
+          "type": "'basic' | 'standard' | 'strict' | undefined"
+        },
+        {
+          "name": "includeDebugInfo",
+          "tags": [],
+          "docs": "Includes additional debug information\nin the returned signals when enabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PresentBlockPageResult",
+      "slug": "presentblockpageresult",
+      "docs": "Result object returned by `presentBlockPage()`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "presented",
+          "tags": [],
+          "docs": "Indicates whether the block page was actually presented.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PresentBlockPageOptions",
+      "slug": "presentblockpageoptions",
+      "docs": "Options for presenting the integrity block page.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reason",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional reason code passed to the block page.\n\nThis value may be used for analytics,\nlocalization, or user messaging.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "dismissible",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the block page can be dismissed by the user.\n\nDefaults to false.\nIn production environments, this should typically remain disabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Result returned by the getPluginVersion method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "The native version string of the plugin.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "IntegrityConfidenceLevel",
+      "slug": "integrityconfidencelevel",
+      "members": [
+        {
+          "name": "LOW",
+          "value": "'low'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MEDIUM",
+          "value": "'medium'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "HIGH",
+          "value": "'high'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "IntegritySignalCategory",
+      "slug": "integritysignalcategory",
+      "docs": "Category of a detected integrity signal.\n\nCategories are intentionally broad and stable.\nNew detection techniques MUST reuse existing categories\nwhenever possible to avoid breaking consumers.",
+      "types": [
+        {
+          "text": "'root'",
+          "complexTypes": []
+        },
+        {
+          "text": "'jailbreak'",
+          "complexTypes": []
+        },
+        {
+          "text": "'emulator'",
+          "complexTypes": []
+        },
+        {
+          "text": "'debug'",
+          "complexTypes": []
+        },
+        {
+          "text": "'hook'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tamper'",
+          "complexTypes": []
+        },
+        {
+          "text": "'environment'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "IntegritySignalEvent",
+      "slug": "integritysignalevent",
+      "docs": "Event payload emitted when a new integrity signal is detected.\n\nThis event represents a *real-time observation* of a potential\nintegrity-relevant condition on the device.\n\nIMPORTANT:\n- Signals are observational only.\n- Emitting a signal does NOT imply that the environment is compromised.\n- No blocking or enforcement is performed by the plugin.\n\nThe host application is responsible for:\n- interpreting signals\n- correlating multiple signals\n- applying any security or UX policy",
+      "types": [
+        {
+          "text": "IntegritySignal",
+          "complexTypes": [
+            "IntegritySignal"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": [
+    {
+      "name": "Integrity",
+      "slug": "integrity",
+      "properties": [
+        {
+          "name": "verboseLogging",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enables verbose native logging.\n\nWhen enabled, additional debug information is printed\nto the native console (Logcat on Android, Xcode on iOS).\n\nThis option affects native logging behavior only and\nhas no impact on the JavaScript API or runtime behavior.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "blockPage",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional configuration for the integrity block page.\n\nThis configuration controls the availability and source\nof a developer-provided HTML page that may be presented\nto the end user when the host application decides to do so.\n\nThis configuration is:\n- read only by native code\n- immutable at runtime\n- NOT accessible from JavaScript\n\nThe Integrity plugin will NEVER automatically present\nthe block page. Presentation is always explicitly triggered\nby the host application via the public API.",
+          "complexTypes": [
+            "IntegrityBlockPageConfig"
+          ],
+          "type": "IntegrityBlockPageConfig"
+        },
+        {
+          "name": "jailbreakUrlSchemes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Optional configuration for jailbreak URL scheme probing (iOS only).\n\nWhen enabled, the native iOS implementation may probe for\nknown jailbreak-related applications using URL schemes\nsuch as `cydia://`.\n\nThis configuration:\n- is read natively at runtime\n- is immutable\n- is NOT accessible from JavaScript\n- does NOT alter the public JavaScript API",
+          "complexTypes": [
+            "JailbreakUrlSchemesConfig"
+          ],
+          "type": "JailbreakUrlSchemesConfig"
+        }
+      ],
+      "docs": "Configuration options for the Integrity plugin."
+    }
+  ]
+}