@fgv/ts-web-extras 5.1.0-18 → 5.1.0-19

package/temp/ts-web-extras.api.json

@@ -1099,6 +1099,218 @@
                   "isOptional": false,
                   "isAbstract": false,
                   "name": "toBase64"
+                },
+                {
+                  "kind": "Method",
+                  "canonicalReference": "@fgv/ts-web-extras!CryptoUtils.BrowserCryptoProvider#unwrapBytes:member(1)",
+                  "docComment": "/**\n * Unwraps a payload produced by `wrapBytes` using the recipient's private key. See {@link CryptoUtils.ICryptoProvider.unwrapBytes | ICryptoProvider.unwrapBytes}.\n *\n * @param wrapped - The wrapped payload.\n *\n * @param recipientPrivateKey - The recipient's ECDH P-256 private `CryptoKey`.\n *\n * @param options - HKDF salt and info matching the wrap call.\n *\n * @returns `Success` with the original `plaintext`, or `Failure` with an error.\n */\n",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "unwrapBytes(wrapped: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoUtils.IWrappedBytes",
+                      "canonicalReference": "@fgv/ts-extras!IWrappedBytes:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ", recipientPrivateKey: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoKey",
+                      "canonicalReference": "!CryptoKey:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ", options: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoUtils.IWrapBytesOptions",
+                      "canonicalReference": "@fgv/ts-extras!IWrapBytesOptions:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "): "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Promise",
+                      "canonicalReference": "!Promise:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "<"
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Result",
+                      "canonicalReference": "@fgv/ts-utils!Result:type"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "<"
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Uint8Array",
+                      "canonicalReference": "!Uint8Array:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ">>"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isStatic": false,
+                  "returnTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 13
+                  },
+                  "releaseTag": "Public",
+                  "isProtected": false,
+                  "overloadIndex": 1,
+                  "parameters": [
+                    {
+                      "parameterName": "wrapped",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 1,
+                        "endIndex": 2
+                      },
+                      "isOptional": false
+                    },
+                    {
+                      "parameterName": "recipientPrivateKey",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 3,
+                        "endIndex": 4
+                      },
+                      "isOptional": false
+                    },
+                    {
+                      "parameterName": "options",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 5,
+                        "endIndex": 6
+                      },
+                      "isOptional": false
+                    }
+                  ],
+                  "isOptional": false,
+                  "isAbstract": false,
+                  "name": "unwrapBytes"
+                },
+                {
+                  "kind": "Method",
+                  "canonicalReference": "@fgv/ts-web-extras!CryptoUtils.BrowserCryptoProvider#wrapBytes:member(1)",
+                  "docComment": "/**\n * Wraps `plaintext` for the holder of `recipientPublicKey` using ECIES (ECDH P-256 + HKDF-SHA256 + AES-GCM-256). See {@link CryptoUtils.ICryptoProvider.wrapBytes | ICryptoProvider.wrapBytes}.\n *\n * @param plaintext - The bytes to wrap.\n *\n * @param recipientPublicKey - The recipient's ECDH P-256 public `CryptoKey`.\n *\n * @param options - HKDF salt and info; see {@link CryptoUtils.IWrapBytesOptions | IWrapBytesOptions}.\n *\n * @returns `Success` with the wrapped payload, or `Failure` with an error.\n */\n",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "wrapBytes(plaintext: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Uint8Array",
+                      "canonicalReference": "!Uint8Array:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ", recipientPublicKey: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoKey",
+                      "canonicalReference": "!CryptoKey:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ", options: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoUtils.IWrapBytesOptions",
+                      "canonicalReference": "@fgv/ts-extras!IWrapBytesOptions:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "): "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Promise",
+                      "canonicalReference": "!Promise:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "<"
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Result",
+                      "canonicalReference": "@fgv/ts-utils!Result:type"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "<"
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "CryptoUtils.IWrappedBytes",
+                      "canonicalReference": "@fgv/ts-extras!IWrappedBytes:interface"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ">>"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isStatic": false,
+                  "returnTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 13
+                  },
+                  "releaseTag": "Public",
+                  "isProtected": false,
+                  "overloadIndex": 1,
+                  "parameters": [
+                    {
+                      "parameterName": "plaintext",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 1,
+                        "endIndex": 2
+                      },
+                      "isOptional": false
+                    },
+                    {
+                      "parameterName": "recipientPublicKey",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 3,
+                        "endIndex": 4
+                      },
+                      "isOptional": false
+                    },
+                    {
+                      "parameterName": "options",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 5,
+                        "endIndex": 6
+                      },
+                      "isOptional": false
+                    }
+                  ],
+                  "isOptional": false,
+                  "isAbstract": false,
+                  "name": "wrapBytes"
                 }
               ],
               "implementsTokenRanges": [

package/temp/ts-web-extras.api.md

@@ -25,6 +25,11 @@ class BrowserCryptoProvider implements CryptoUtils_2.ICryptoProvider {
     importPublicKeyJwk(jwk: JsonWebKey, algorithm: CryptoUtils_2.KeyPairAlgorithm): Promise<Result<CryptoKey>>;
     sha256(data: string): Promise<Result<string>>;
     toBase64(data: Uint8Array): string;
+    // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver
+    unwrapBytes(wrapped: CryptoUtils_2.IWrappedBytes, recipientPrivateKey: CryptoKey, options: CryptoUtils_2.IWrapBytesOptions): Promise<Result<Uint8Array>>;
+    // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver
+    // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver
+    wrapBytes(plaintext: Uint8Array, recipientPublicKey: CryptoKey, options: CryptoUtils_2.IWrapBytesOptions): Promise<Result<CryptoUtils_2.IWrappedBytes>>;
 }
 
 // @public