@capawesome/capacitor-app-integrity 0.0.1

package/dist/docs.json

@@ -0,0 +1,472 @@
+{
+  "api": {
+    "name": "AppIntegrityPlugin",
+    "slug": "appintegrityplugin",
+    "docs": "",
+    "tags": [
+      {
+        "text": "0.1.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "attestKey",
+        "signature": "(options: AttestKeyOptions) => Promise<AttestKeyResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AttestKeyOptions"
+          }
+        ],
+        "returns": "Promise<AttestKeyResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Attest a key generated with `generateKey()` using Apple's App Attest service.\n\nThe returned attestation object must be sent to your server, which verifies\nit with Apple and stores the key identifier for future assertions.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "AttestKeyResult",
+          "AttestKeyOptions"
+        ],
+        "slug": "attestkey"
+      },
+      {
+        "name": "generateAssertion",
+        "signature": "(options: GenerateAssertionOptions) => Promise<GenerateAssertionResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GenerateAssertionOptions"
+          }
+        ],
+        "returns": "Promise<GenerateAssertionResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Generate an assertion for the given client data using an attested key.\n\nThe returned assertion must be sent to your server along with the client\ndata, where it is verified using the previously stored key identifier.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "GenerateAssertionResult",
+          "GenerateAssertionOptions"
+        ],
+        "slug": "generateassertion"
+      },
+      {
+        "name": "generateKey",
+        "signature": "() => Promise<GenerateKeyResult>",
+        "parameters": [],
+        "returns": "Promise<GenerateKeyResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Generate a new App Attest key pair.\n\nThe private key is stored in the Secure Enclave. Store the returned key\nidentifier in your app to attest the key and generate assertions later.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "GenerateKeyResult"
+        ],
+        "slug": "generatekey"
+      },
+      {
+        "name": "isAvailable",
+        "signature": "() => Promise<IsAvailableResult>",
+        "parameters": [],
+        "returns": "Promise<IsAvailableResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether app integrity attestation is available on this device.\n\nOn Android, this checks whether Google Play Services is available.\nOn iOS, this checks whether the App Attest service is supported.\nOn iOS, the App Attest service is not supported on simulators.",
+        "complexTypes": [
+          "IsAvailableResult"
+        ],
+        "slug": "isavailable"
+      },
+      {
+        "name": "prepareIntegrityToken",
+        "signature": "(options: PrepareIntegrityTokenOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PrepareIntegrityTokenOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Prepare the integrity token provider for standard integrity token requests.\n\nCall this method once, for example at app start, before calling\n`requestIntegrityToken(...)` with a request hash. The preparation can take\nseveral seconds, so it should be done well ahead of the first request.\n\nOnly available on Android.",
+        "complexTypes": [
+          "PrepareIntegrityTokenOptions"
+        ],
+        "slug": "prepareintegritytoken"
+      },
+      {
+        "name": "requestIntegrityToken",
+        "signature": "(options: RequestIntegrityTokenOptions) => Promise<RequestIntegrityTokenResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RequestIntegrityTokenOptions"
+          }
+        ],
+        "returns": "Promise<RequestIntegrityTokenResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Request an integrity token from the Play Integrity API.\n\nProvide a `requestHash` for a standard request (recommended, requires a\nprior call to `prepareIntegrityToken(...)`) or a `nonce` for a classic request.\n\nThe returned token must be sent to your server, which decrypts and\nverifies it via Google's servers.\n\nOnly available on Android.",
+        "complexTypes": [
+          "RequestIntegrityTokenResult",
+          "RequestIntegrityTokenOptions"
+        ],
+        "slug": "requestintegritytoken"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "AttestKeyResult",
+      "slug": "attestkeyresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "attestationObject",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The attestation object, encoded as a base64 string.\n\nSend this to your server for verification with Apple.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "AttestKeyOptions",
+      "slug": "attestkeyoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "challenge",
+          "tags": [
+            {
+              "text": "'dGhpc2lzYWNoYWxsZW5nZQ=='",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The one-time challenge received from your server, encoded as a\nbase64 string.\n\nThe challenge is hashed with SHA-256 on the device before it is passed\nto the App Attest service.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "keyId",
+          "tags": [
+            {
+              "text": "'Kh0DIEwVJTDJUyIRZ4M9BvJn/i4RSSGDkFvUZOaSm5g='",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the key to attest, as returned by `generateKey()`.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GenerateAssertionResult",
+      "slug": "generateassertionresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assertion",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The assertion object, encoded as a base64 string.\n\nSend this to your server for verification.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GenerateAssertionOptions",
+      "slug": "generateassertionoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "clientData",
+          "tags": [
+            {
+              "text": "'eyJjaGFsbGVuZ2UiOiJkR2hwYzJsellXTm9ZV3hzWlc1blpRPT0ifQ=='",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The client data to sign, encoded as a base64 string.\n\nThis is usually a JSON payload that includes a one-time challenge\nreceived from your server. The client data is hashed with SHA-256 on the\ndevice before it is passed to the App Attest service.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "keyId",
+          "tags": [
+            {
+              "text": "'Kh0DIEwVJTDJUyIRZ4M9BvJn/i4RSSGDkFvUZOaSm5g='",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of an attested key, as returned by `generateKey()`.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GenerateKeyResult",
+      "slug": "generatekeyresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "keyId",
+          "tags": [
+            {
+              "text": "'Kh0DIEwVJTDJUyIRZ4M9BvJn/i4RSSGDkFvUZOaSm5g='",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the generated key pair.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "IsAvailableResult",
+      "slug": "isavailableresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether app integrity attestation is available on this device.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PrepareIntegrityTokenOptions",
+      "slug": "prepareintegritytokenoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cloudProjectNumber",
+          "tags": [
+            {
+              "text": "123456789012",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The Google Cloud project number of the project that is linked\nto your Play Console developer account.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "RequestIntegrityTokenResult",
+      "slug": "requestintegritytokenresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "token",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The integrity token.\n\nSend this to your server, which decrypts and verifies it via\nGoogle's servers.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "RequestIntegrityTokenOptions",
+      "slug": "requestintegritytokenoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cloudProjectNumber",
+          "tags": [
+            {
+              "text": "123456789012",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The Google Cloud project number of the project that is linked\nto your Play Console developer account.\n\nOnly used for classic requests. It is required if your app is\ndistributed outside of Google Play.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "nonce",
+          "tags": [
+            {
+              "text": "'dGhpc2lzYW5vbmNl'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The one-time nonce for a classic request, encoded as a base64\nweb-safe no-wrap string.\n\nProvide either `nonce` or `requestHash`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "requestHash",
+          "tags": [
+            {
+              "text": "'2cp24z...'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The request hash for a standard request.\n\nRequires a prior call to `prepareIntegrityToken(...)`.\n\nProvide either `nonce` or `requestHash`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}