expo-crypto 10.1.0 → 10.1.1

package/CHANGELOG.md

@@ -10,6 +10,10 @@
 
 ### 💡 Others
 
+## 10.1.1 — 2021-12-08
+
+_This version does not introduce any user-facing changes._
+
 ## 10.1.0 — 2021-12-03
 
 _This version does not introduce any user-facing changes._

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven'
 
 group = 'host.exp.exponent'
-version = '10.1.0'
+version = '10.1.1'
 
 buildscript {
   // Simple helper that allows the root project to override versions declared by this library.
@@ -57,7 +57,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 25
-    versionName "10.1.0"
+    versionName "10.1.1"
   }
   lintOptions {
     abortOnError false

package/build/Crypto.d.ts

@@ -1,3 +1,23 @@
 import { CryptoDigestAlgorithm, CryptoDigestOptions, Digest } from './Crypto.types';
 export * from './Crypto.types';
+/**
+ * The `digestStringAsync()` method of `Crypto` generates a digest of the supplied `data` string with the provided digest `algorithm`.
+ * A digest is a short fixed-length value derived from some variable-length input. **Cryptographic digests** should exhibit _collision-resistance_,
+ * meaning that it's very difficult to generate multiple inputs that have equal digest values.
+ * You can specify the returned string format as one of `CryptoEncoding`. By default, the resolved value will be formatted as a `HEX` string.
+ * On web, this method can only be called from a secure origin (https) otherwise an error will be thrown.
+ *
+ * @param algorithm The cryptographic hash function to use to transform a block of data into a fixed-size output.
+ * @param data The value that will be used to generate a digest.
+ * @param options Format of the digest string. Defaults to: `CryptoDigestOptions.HEX`.
+ * @return Return a Promise which fulfills with a value representing the hashed input.
+ *
+ * @example
+ * ```ts
+ * const digest = await Crypto.digestStringAsync(
+ *   Crypto.CryptoDigestAlgorithm.SHA512,
+ *   '🥓 Easy to Digest! 💙'
+ * );
+ * ```
+ */
 export declare function digestStringAsync(algorithm: CryptoDigestAlgorithm, data: string, options?: CryptoDigestOptions): Promise<Digest>;

package/build/Crypto.js

@@ -23,6 +23,27 @@ function assertEncoding(encoding) {
         throw new CryptoError(`Invalid encoding provided. Expected one of: CryptoEncoding.${Object.keys(CryptoEncoding).join(', CryptoEncoding.')}`);
     }
 }
+// @needsAudit
+/**
+ * The `digestStringAsync()` method of `Crypto` generates a digest of the supplied `data` string with the provided digest `algorithm`.
+ * A digest is a short fixed-length value derived from some variable-length input. **Cryptographic digests** should exhibit _collision-resistance_,
+ * meaning that it's very difficult to generate multiple inputs that have equal digest values.
+ * You can specify the returned string format as one of `CryptoEncoding`. By default, the resolved value will be formatted as a `HEX` string.
+ * On web, this method can only be called from a secure origin (https) otherwise an error will be thrown.
+ *
+ * @param algorithm The cryptographic hash function to use to transform a block of data into a fixed-size output.
+ * @param data The value that will be used to generate a digest.
+ * @param options Format of the digest string. Defaults to: `CryptoDigestOptions.HEX`.
+ * @return Return a Promise which fulfills with a value representing the hashed input.
+ *
+ * @example
+ * ```ts
+ * const digest = await Crypto.digestStringAsync(
+ *   Crypto.CryptoDigestAlgorithm.SHA512,
+ *   '🥓 Easy to Digest! 💙'
+ * );
+ * ```
+ */
 export async function digestStringAsync(algorithm, data, options = { encoding: CryptoEncoding.HEX }) {
     if (!ExpoCrypto.digestStringAsync) {
         throw new UnavailabilityError('expo-crypto', 'digestStringAsync');

package/build/Crypto.js.map

@@ -1 +1 @@
-{"version":3,"file":"Crypto.js","sourceRoot":"","sources":["../src/Crypto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAA+B,MAAM,gBAAgB,CAAC;AACpG,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,cAAc,gBAAgB,CAAC;AAE/B,MAAM,WAAY,SAAQ,SAAS;IACjC,IAAI,GAAG,YAAY,CAAC;IAEpB,YAAY,OAAe;QACzB,KAAK,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAC;IACnC,CAAC;CACF;AAED,SAAS,eAAe,CAAC,SAAgC;IACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC7D,MAAM,IAAI,WAAW,CACnB,sEAAsE,MAAM,CAAC,IAAI,CAC/E,qBAAqB,CACtB,CAAC,IAAI,CAAC,mCAAmC,CAAC,EAAE,CAC9C,CAAC;KACH;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,IAAI,WAAW,CAAC,2CAA2C,CAAC,CAAC;KACpE;AACH,CAAC;AAED,SAAS,cAAc,CAAC,QAAwB;IAC9C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACrD,MAAM,IAAI,WAAW,CACnB,8DAA8D,MAAM,CAAC,IAAI,CACvE,cAAc,CACf,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAC9B,CAAC;KACH;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,SAAgC,EAChC,IAAY,EACZ,UAA+B,EAAE,QAAQ,EAAE,cAAc,CAAC,GAAG,EAAE;IAE/D,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACjC,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;KACnE;IAED,eAAe,CAAC,SAAS,CAAC,CAAC;IAC3B,UAAU,CAAC,IAAI,CAAC,CAAC;IACjB,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEjC,OAAO,MAAM,UAAU,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACtE,CAAC","sourcesContent":["import { UnavailabilityError } from 'expo-modules-core';\n\nimport { CryptoDigestAlgorithm, CryptoEncoding, CryptoDigestOptions, Digest } from './Crypto.types';\nimport ExpoCrypto from './ExpoCrypto';\n\nexport * from './Crypto.types';\n\nclass CryptoError extends TypeError {\n  code = 'ERR_CRYPTO';\n\n  constructor(message: string) {\n    super(`expo-crypto: ${message}`);\n  }\n}\n\nfunction assertAlgorithm(algorithm: CryptoDigestAlgorithm): void {\n  if (!Object.values(CryptoDigestAlgorithm).includes(algorithm)) {\n    throw new CryptoError(\n      `Invalid algorithm provided. Expected one of: CryptoDigestAlgorithm.${Object.keys(\n        CryptoDigestAlgorithm\n      ).join(', AlgCryptoDigestAlgorithmorithm.')}`\n    );\n  }\n}\n\nfunction assertData(data: string): void {\n  if (typeof data !== 'string') {\n    throw new CryptoError(`Invalid data provided. Expected a string.`);\n  }\n}\n\nfunction assertEncoding(encoding: CryptoEncoding): void {\n  if (!Object.values(CryptoEncoding).includes(encoding)) {\n    throw new CryptoError(\n      `Invalid encoding provided. Expected one of: CryptoEncoding.${Object.keys(\n        CryptoEncoding\n      ).join(', CryptoEncoding.')}`\n    );\n  }\n}\n\nexport async function digestStringAsync(\n  algorithm: CryptoDigestAlgorithm,\n  data: string,\n  options: CryptoDigestOptions = { encoding: CryptoEncoding.HEX }\n): Promise<Digest> {\n  if (!ExpoCrypto.digestStringAsync) {\n    throw new UnavailabilityError('expo-crypto', 'digestStringAsync');\n  }\n\n  assertAlgorithm(algorithm);\n  assertData(data);\n  assertEncoding(options.encoding);\n\n  return await ExpoCrypto.digestStringAsync(algorithm, data, options);\n}\n"]}
+{"version":3,"file":"Crypto.js","sourceRoot":"","sources":["../src/Crypto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAA+B,MAAM,gBAAgB,CAAC;AACpG,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,cAAc,gBAAgB,CAAC;AAE/B,MAAM,WAAY,SAAQ,SAAS;IACjC,IAAI,GAAG,YAAY,CAAC;IAEpB,YAAY,OAAe;QACzB,KAAK,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAC;IACnC,CAAC;CACF;AAED,SAAS,eAAe,CAAC,SAAgC;IACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC7D,MAAM,IAAI,WAAW,CACnB,sEAAsE,MAAM,CAAC,IAAI,CAC/E,qBAAqB,CACtB,CAAC,IAAI,CAAC,mCAAmC,CAAC,EAAE,CAC9C,CAAC;KACH;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,IAAI,WAAW,CAAC,2CAA2C,CAAC,CAAC;KACpE;AACH,CAAC;AAED,SAAS,cAAc,CAAC,QAAwB;IAC9C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACrD,MAAM,IAAI,WAAW,CACnB,8DAA8D,MAAM,CAAC,IAAI,CACvE,cAAc,CACf,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAC9B,CAAC;KACH;AACH,CAAC;AAED,cAAc;AACd;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,SAAgC,EAChC,IAAY,EACZ,UAA+B,EAAE,QAAQ,EAAE,cAAc,CAAC,GAAG,EAAE;IAE/D,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACjC,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;KACnE;IAED,eAAe,CAAC,SAAS,CAAC,CAAC;IAC3B,UAAU,CAAC,IAAI,CAAC,CAAC;IACjB,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEjC,OAAO,MAAM,UAAU,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACtE,CAAC","sourcesContent":["import { UnavailabilityError } from 'expo-modules-core';\n\nimport { CryptoDigestAlgorithm, CryptoEncoding, CryptoDigestOptions, Digest } from './Crypto.types';\nimport ExpoCrypto from './ExpoCrypto';\n\nexport * from './Crypto.types';\n\nclass CryptoError extends TypeError {\n  code = 'ERR_CRYPTO';\n\n  constructor(message: string) {\n    super(`expo-crypto: ${message}`);\n  }\n}\n\nfunction assertAlgorithm(algorithm: CryptoDigestAlgorithm): void {\n  if (!Object.values(CryptoDigestAlgorithm).includes(algorithm)) {\n    throw new CryptoError(\n      `Invalid algorithm provided. Expected one of: CryptoDigestAlgorithm.${Object.keys(\n        CryptoDigestAlgorithm\n      ).join(', AlgCryptoDigestAlgorithmorithm.')}`\n    );\n  }\n}\n\nfunction assertData(data: string): void {\n  if (typeof data !== 'string') {\n    throw new CryptoError(`Invalid data provided. Expected a string.`);\n  }\n}\n\nfunction assertEncoding(encoding: CryptoEncoding): void {\n  if (!Object.values(CryptoEncoding).includes(encoding)) {\n    throw new CryptoError(\n      `Invalid encoding provided. Expected one of: CryptoEncoding.${Object.keys(\n        CryptoEncoding\n      ).join(', CryptoEncoding.')}`\n    );\n  }\n}\n\n// @needsAudit\n/**\n * The `digestStringAsync()` method of `Crypto` generates a digest of the supplied `data` string with the provided digest `algorithm`.\n * A digest is a short fixed-length value derived from some variable-length input. **Cryptographic digests** should exhibit _collision-resistance_,\n * meaning that it's very difficult to generate multiple inputs that have equal digest values.\n * You can specify the returned string format as one of `CryptoEncoding`. By default, the resolved value will be formatted as a `HEX` string.\n * On web, this method can only be called from a secure origin (https) otherwise an error will be thrown.\n *\n * @param algorithm The cryptographic hash function to use to transform a block of data into a fixed-size output.\n * @param data The value that will be used to generate a digest.\n * @param options Format of the digest string. Defaults to: `CryptoDigestOptions.HEX`.\n * @return Return a Promise which fulfills with a value representing the hashed input.\n *\n * @example\n * ```ts\n * const digest = await Crypto.digestStringAsync(\n *   Crypto.CryptoDigestAlgorithm.SHA512,\n *   '🥓 Easy to Digest! 💙'\n * );\n * ```\n */\nexport async function digestStringAsync(\n  algorithm: CryptoDigestAlgorithm,\n  data: string,\n  options: CryptoDigestOptions = { encoding: CryptoEncoding.HEX }\n): Promise<Digest> {\n  if (!ExpoCrypto.digestStringAsync) {\n    throw new UnavailabilityError('expo-crypto', 'digestStringAsync');\n  }\n\n  assertAlgorithm(algorithm);\n  assertData(data);\n  assertEncoding(options.encoding);\n\n  return await ExpoCrypto.digestStringAsync(algorithm, data, options);\n}\n"]}

package/build/Crypto.types.d.ts

@@ -1,25 +1,55 @@
+/**
+ * [`Cryptographic hash function`](https://developer.mozilla.org/en-US/docs/Glossary/Cryptographic_hash_function)
+ * is an algorithm that can be used to generate a checksum value. They have a variety of applications in cryptography.
+ * > Cryptographic hash functions like [`SHA1`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1),
+ * > `MD5` are **vulnerable**! Attacks have been proven to significantly reduce their collision resistance.
+ * > Message-digest algorithms shouldn't be used for creating secure digests.
+ */
 export declare enum CryptoDigestAlgorithm {
     /**
-     * SHA1 is vulnerable and should not be used.
-     * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1
+     * `160` bits.
      */
     SHA1 = "SHA-1",
+    /**
+     * `256` bits. Collision Resistant.
+     */
     SHA256 = "SHA-256",
+    /**
+     * `384` bits. Collision Resistant.
+     */
     SHA384 = "SHA-384",
+    /**
+     * `512` bits. Collision Resistant.
+     */
     SHA512 = "SHA-512",
     /**
-     * MD* is not supported on web.
-     * message-digest algorithms shouldn't be used for creating secure digests.
+     * `128` bits.
+     * @platform ios
      */
     MD2 = "MD2",
+    /**
+     * `128` bits.
+     * @platform ios
+     */
     MD4 = "MD4",
+    /**
+     * `128` bits.
+     * @platform android
+     * @platform ios
+     */
     MD5 = "MD5"
 }
 export declare enum CryptoEncoding {
     HEX = "hex",
+    /**
+     * Has trailing padding. Does not wrap lines. Does not have a trailing newline.
+     */
     BASE64 = "base64"
 }
 export declare type CryptoDigestOptions = {
+    /**
+     * Format the digest is returned in.
+     */
     encoding: CryptoEncoding;
 };
 export declare type Digest = string;

package/build/Crypto.types.js

@@ -1,24 +1,53 @@
+// @needsAudit
+/**
+ * [`Cryptographic hash function`](https://developer.mozilla.org/en-US/docs/Glossary/Cryptographic_hash_function)
+ * is an algorithm that can be used to generate a checksum value. They have a variety of applications in cryptography.
+ * > Cryptographic hash functions like [`SHA1`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1),
+ * > `MD5` are **vulnerable**! Attacks have been proven to significantly reduce their collision resistance.
+ * > Message-digest algorithms shouldn't be used for creating secure digests.
+ */
 export var CryptoDigestAlgorithm;
 (function (CryptoDigestAlgorithm) {
     /**
-     * SHA1 is vulnerable and should not be used.
-     * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1
+     * `160` bits.
      */
     CryptoDigestAlgorithm["SHA1"] = "SHA-1";
+    /**
+     * `256` bits. Collision Resistant.
+     */
     CryptoDigestAlgorithm["SHA256"] = "SHA-256";
+    /**
+     * `384` bits. Collision Resistant.
+     */
     CryptoDigestAlgorithm["SHA384"] = "SHA-384";
+    /**
+     * `512` bits. Collision Resistant.
+     */
     CryptoDigestAlgorithm["SHA512"] = "SHA-512";
     /**
-     * MD* is not supported on web.
-     * message-digest algorithms shouldn't be used for creating secure digests.
+     * `128` bits.
+     * @platform ios
      */
     CryptoDigestAlgorithm["MD2"] = "MD2";
+    /**
+     * `128` bits.
+     * @platform ios
+     */
     CryptoDigestAlgorithm["MD4"] = "MD4";
+    /**
+     * `128` bits.
+     * @platform android
+     * @platform ios
+     */
     CryptoDigestAlgorithm["MD5"] = "MD5";
 })(CryptoDigestAlgorithm || (CryptoDigestAlgorithm = {}));
+// @needsAudit
 export var CryptoEncoding;
 (function (CryptoEncoding) {
     CryptoEncoding["HEX"] = "hex";
+    /**
+     * Has trailing padding. Does not wrap lines. Does not have a trailing newline.
+     */
     CryptoEncoding["BASE64"] = "base64";
 })(CryptoEncoding || (CryptoEncoding = {}));
 //# sourceMappingURL=Crypto.types.js.map

package/build/Crypto.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"Crypto.types.js","sourceRoot":"","sources":["../src/Crypto.types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,qBAgBX;AAhBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,uCAAc,CAAA;IACd,2CAAkB,CAAA;IAClB,2CAAkB,CAAA;IAClB,2CAAkB,CAAA;IAClB;;;OAGG;IACH,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,oCAAW,CAAA;AACb,CAAC,EAhBW,qBAAqB,KAArB,qBAAqB,QAgBhC;AAED,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,mCAAiB,CAAA;AACnB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB","sourcesContent":["export enum CryptoDigestAlgorithm {\n  /**\n   * SHA1 is vulnerable and should not be used.\n   * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1\n   */\n  SHA1 = 'SHA-1',\n  SHA256 = 'SHA-256',\n  SHA384 = 'SHA-384',\n  SHA512 = 'SHA-512',\n  /**\n   * MD* is not supported on web.\n   * message-digest algorithms shouldn't be used for creating secure digests.\n   */\n  MD2 = 'MD2',\n  MD4 = 'MD4',\n  MD5 = 'MD5',\n}\n\nexport enum CryptoEncoding {\n  HEX = 'hex',\n  BASE64 = 'base64',\n}\n\nexport type CryptoDigestOptions = { encoding: CryptoEncoding };\n\nexport type Digest = string;\n"]}
+{"version":3,"file":"Crypto.types.js","sourceRoot":"","sources":["../src/Crypto.types.ts"],"names":[],"mappings":"AAAA,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,qBAiCX;AAjCD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,uCAAc,CAAA;IACd;;OAEG;IACH,2CAAkB,CAAA;IAClB;;OAEG;IACH,2CAAkB,CAAA;IAClB;;OAEG;IACH,2CAAkB,CAAA;IAClB;;;OAGG;IACH,oCAAW,CAAA;IACX;;;OAGG;IACH,oCAAW,CAAA;IACX;;;;OAIG;IACH,oCAAW,CAAA;AACb,CAAC,EAjCW,qBAAqB,KAArB,qBAAqB,QAiChC;AAED,cAAc;AACd,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX;;OAEG;IACH,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB","sourcesContent":["// @needsAudit\n/**\n * [`Cryptographic hash function`](https://developer.mozilla.org/en-US/docs/Glossary/Cryptographic_hash_function)\n * is an algorithm that can be used to generate a checksum value. They have a variety of applications in cryptography.\n * > Cryptographic hash functions like [`SHA1`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1),\n * > `MD5` are **vulnerable**! Attacks have been proven to significantly reduce their collision resistance.\n * > Message-digest algorithms shouldn't be used for creating secure digests.\n */\nexport enum CryptoDigestAlgorithm {\n  /**\n   * `160` bits.\n   */\n  SHA1 = 'SHA-1',\n  /**\n   * `256` bits. Collision Resistant.\n   */\n  SHA256 = 'SHA-256',\n  /**\n   * `384` bits. Collision Resistant.\n   */\n  SHA384 = 'SHA-384',\n  /**\n   * `512` bits. Collision Resistant.\n   */\n  SHA512 = 'SHA-512',\n  /**\n   * `128` bits.\n   * @platform ios\n   */\n  MD2 = 'MD2',\n  /**\n   * `128` bits.\n   * @platform ios\n   */\n  MD4 = 'MD4',\n  /**\n   * `128` bits.\n   * @platform android\n   * @platform ios\n   */\n  MD5 = 'MD5',\n}\n\n// @needsAudit\nexport enum CryptoEncoding {\n  HEX = 'hex',\n  /**\n   * Has trailing padding. Does not wrap lines. Does not have a trailing newline.\n   */\n  BASE64 = 'base64',\n}\n\n// @needsAudit\nexport type CryptoDigestOptions = {\n  /**\n   * Format the digest is returned in.\n   */\n  encoding: CryptoEncoding;\n};\n\n// @docsMissing\nexport type Digest = string;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-crypto",
-  "version": "10.1.0",
+  "version": "10.1.1",
   "description": "Expo universal module for crypto",
   "main": "build/Crypto.js",
   "types": "build/Crypto.d.ts",
@@ -45,5 +45,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "2e5c6983b86d5ecfca028ba64002897d8adc2cc4"
+  "gitHead": "cf8e7fde1b19e10dd9b74a8af0e9362ae8e14001"
 }

package/src/Crypto.ts

@@ -39,6 +39,27 @@ function assertEncoding(encoding: CryptoEncoding): void {
   }
 }
 
+// @needsAudit
+/**
+ * The `digestStringAsync()` method of `Crypto` generates a digest of the supplied `data` string with the provided digest `algorithm`.
+ * A digest is a short fixed-length value derived from some variable-length input. **Cryptographic digests** should exhibit _collision-resistance_,
+ * meaning that it's very difficult to generate multiple inputs that have equal digest values.
+ * You can specify the returned string format as one of `CryptoEncoding`. By default, the resolved value will be formatted as a `HEX` string.
+ * On web, this method can only be called from a secure origin (https) otherwise an error will be thrown.
+ *
+ * @param algorithm The cryptographic hash function to use to transform a block of data into a fixed-size output.
+ * @param data The value that will be used to generate a digest.
+ * @param options Format of the digest string. Defaults to: `CryptoDigestOptions.HEX`.
+ * @return Return a Promise which fulfills with a value representing the hashed input.
+ *
+ * @example
+ * ```ts
+ * const digest = await Crypto.digestStringAsync(
+ *   Crypto.CryptoDigestAlgorithm.SHA512,
+ *   '🥓 Easy to Digest! 💙'
+ * );
+ * ```
+ */
 export async function digestStringAsync(
   algorithm: CryptoDigestAlgorithm,
   data: string,

package/src/Crypto.types.ts

@@ -1,26 +1,62 @@
+// @needsAudit
+/**
+ * [`Cryptographic hash function`](https://developer.mozilla.org/en-US/docs/Glossary/Cryptographic_hash_function)
+ * is an algorithm that can be used to generate a checksum value. They have a variety of applications in cryptography.
+ * > Cryptographic hash functions like [`SHA1`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1),
+ * > `MD5` are **vulnerable**! Attacks have been proven to significantly reduce their collision resistance.
+ * > Message-digest algorithms shouldn't be used for creating secure digests.
+ */
 export enum CryptoDigestAlgorithm {
   /**
-   * SHA1 is vulnerable and should not be used.
-   * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#SHA-1
+   * `160` bits.
    */
   SHA1 = 'SHA-1',
+  /**
+   * `256` bits. Collision Resistant.
+   */
   SHA256 = 'SHA-256',
+  /**
+   * `384` bits. Collision Resistant.
+   */
   SHA384 = 'SHA-384',
+  /**
+   * `512` bits. Collision Resistant.
+   */
   SHA512 = 'SHA-512',
   /**
-   * MD* is not supported on web.
-   * message-digest algorithms shouldn't be used for creating secure digests.
+   * `128` bits.
+   * @platform ios
    */
   MD2 = 'MD2',
+  /**
+   * `128` bits.
+   * @platform ios
+   */
   MD4 = 'MD4',
+  /**
+   * `128` bits.
+   * @platform android
+   * @platform ios
+   */
   MD5 = 'MD5',
 }
 
+// @needsAudit
 export enum CryptoEncoding {
   HEX = 'hex',
+  /**
+   * Has trailing padding. Does not wrap lines. Does not have a trailing newline.
+   */
   BASE64 = 'base64',
 }
 
-export type CryptoDigestOptions = { encoding: CryptoEncoding };
+// @needsAudit
+export type CryptoDigestOptions = {
+  /**
+   * Format the digest is returned in.
+   */
+  encoding: CryptoEncoding;
+};
 
+// @docsMissing
 export type Digest = string;