fix: export types, helper fns

boorad · boorad · commit 37c96cce1e63 · 2025-05-11T09:49:35.000-04:00
diff --git a/packages/example/src/testing/fixtures/aes_gcm.ts b/packages/example/src/testing/fixtures/aes_gcm.ts
@@ -1,4 +1,4 @@
-import type { TagLength } from '../../../../react-native-quick-crypto/src/keys';
+import type { TagLength } from 'react-native-quick-crypto';
 import { decodeHex } from '../tests/util';
 import type {
   AesEncryptDecryptTestVector,
diff --git a/packages/example/src/testing/tests/CipherTests/GenerateKeyPairTests.ts b/packages/example/src/testing/tests/CipherTests/GenerateKeyPairTests.ts
@@ -2,7 +2,7 @@ import { assert, expect } from 'chai';
 import type { Buffer } from '@craftzdog/react-native-buffer';
 import { describe, it } from '../../MochaRNAdapter';
 import crypto from 'react-native-quick-crypto';
-import type { KeyPairKey } from '../../../../../react-native-quick-crypto/src/Cipher';
+import type { KeyObject } from 'react-native-quick-crypto';
 
 // Constructs a regular expression for a PEM-encoded key with the given label.
 function getRegExpForPEM(label: string, cipher?: string | null) {
@@ -16,7 +16,7 @@ function getRegExpForPEM(label: string, cipher?: string | null) {
   return new RegExp(`^${head}${rfc1421Header}\n${body}\n${end}\n$`);
 }
 
-function assertApproximateSize(kpk: KeyPairKey, expectedSize: number) {
+function assertApproximateSize(kpk: string | Buffer | KeyObject, expectedSize: number) {
   const key = kpk as unknown as Buffer;
   const u = typeof key === 'string' ? 'chars' : 'bytes';
   const min = Math.floor(0.9 * expectedSize);
diff --git a/packages/example/src/testing/tests/CipherTests/PublicCipherTests.ts b/packages/example/src/testing/tests/CipherTests/PublicCipherTests.ts
@@ -2,8 +2,7 @@ import { assert, expect } from 'chai';
 import { Buffer } from '@craftzdog/react-native-buffer';
 import { describe, it } from '../../MochaRNAdapter';
 import crypto from 'react-native-quick-crypto';
-import type { KeyPairKey } from '../../../../../react-native-quick-crypto/src/Cipher';
-import type { EncodingOptions } from '../../../../../react-native-quick-crypto/src/keys';
+import type { EncodingOptions, KeyPairKey } from 'react-native-quick-crypto';
 // import { PrivateKey } from 'sscrypto/node';
 
 // Tests that a key pair can be used for encryption / decryption.
diff --git a/packages/example/src/testing/tests/CipherTests/generateKey.ts b/packages/example/src/testing/tests/CipherTests/generateKey.ts
@@ -3,7 +3,7 @@
 import { expect } from 'chai';
 import crypto from 'react-native-quick-crypto';
 import { describe, it } from '../../MochaRNAdapter';
-import type { AESLength } from '../../../../../react-native-quick-crypto/src/keys';
+import type { AESLength } from 'react-native-quick-crypto';
 
 const { generateKey, generateKeySync } = crypto;
 
diff --git a/packages/example/src/testing/tests/RandomTests/randomTests.ts b/packages/example/src/testing/tests/RandomTests/randomTests.ts
@@ -26,10 +26,7 @@ import { describe, it } from '../../MochaRNAdapter';
 import { Buffer } from '@craftzdog/react-native-buffer';
 import { assert } from 'chai';
 import type { Done } from 'mocha';
-import {
-  ab2str,
-  abvToArrayBuffer,
-} from '../../../../../react-native-quick-crypto/src/Utils';
+const { ab2str, abvToArrayBuffer }  = crypto;
 
 describe('random', () => {
   // TODO (Szymon)
@@ -612,7 +609,10 @@ describe('random', () => {
   [true, NaN, null, {}, [], 10].forEach((val) => {
     it(`expect type error: ${val}`, () => {
       assert.throws(
-        () => crypto.randomInt(0, 1, val),
+        () => {
+          // @ts-expect-error Intentionally passing invalid type for callback test
+          crypto.randomInt(0, 1, val);
+        },
         /callback must be a function or undefined/,
       );
     });
diff --git a/packages/example/src/testing/tests/issues/specific_issues.ts b/packages/example/src/testing/tests/issues/specific_issues.ts
@@ -1,4 +1,4 @@
-import type { BinaryLikeNode } from '../../../../../react-native-quick-crypto/src/Utils';
+import type { BinaryLikeNode } from 'react-native-quick-crypto';
 import { Buffer as CraftzdogBuffer } from '@craftzdog/react-native-buffer';
 import { Buffer as FerossBuffer } from 'buffer';
 import crypto from 'react-native-quick-crypto';
diff --git a/packages/example/src/testing/tests/pbkdf2Tests/pbkdf2Tests.ts b/packages/example/src/testing/tests/pbkdf2Tests/pbkdf2Tests.ts
@@ -6,8 +6,7 @@ import { Buffer as SBuffer } from 'safe-buffer';
 
 import type { Done } from 'mocha';
 import { fixtures, type Fixture } from './fixtures';
-import type { HashAlgorithm } from '../../../../../react-native-quick-crypto/src/keys';
-import type { BinaryLike } from '../../../../../react-native-quick-crypto/src/Utils';
+import type { BinaryLike, HashAlgorithm } from 'react-native-quick-crypto';
 
 type TestFixture = [string, string, number, number, string];
 
diff --git a/packages/example/src/testing/tests/webcryptoTests/deriveBits.ts b/packages/example/src/testing/tests/webcryptoTests/deriveBits.ts
@@ -1,10 +1,9 @@
 import { expect } from 'chai';
 import crypto from 'react-native-quick-crypto';
 import { describe, it } from '../../MochaRNAdapter';
-import { ab2str } from '../../../../../react-native-quick-crypto/src/Utils';
-import type { HashAlgorithm } from '../../../../../react-native-quick-crypto/src/keys';
+import type { HashAlgorithm } from 'react-native-quick-crypto';
 
-const { subtle } = crypto;
+const { subtle, ab2str } = crypto;
 
 type TestFixture = [string, string, number, HashAlgorithm, number, string];
 
diff --git a/packages/example/src/testing/tests/webcryptoTests/digest.ts b/packages/example/src/testing/tests/webcryptoTests/digest.ts
@@ -1,15 +1,10 @@
 import { expect } from 'chai';
 import { Buffer } from '@craftzdog/react-native-buffer';
-import crypto from 'react-native-quick-crypto';
 import { describe, it } from '../../MochaRNAdapter';
-import type { HashAlgorithm } from '../../../../../react-native-quick-crypto/src/keys';
-import {
-  ab2str,
-  toArrayBuffer,
-} from '../../../../../react-native-quick-crypto/src/Utils';
-import { createHash } from '../../../../../react-native-quick-crypto/src/Hash';
-
-const { subtle } = crypto;
+import crypto from 'react-native-quick-crypto';
+import type { HashAlgorithm } from 'react-native-quick-crypto';
+
+const { subtle, ab2str, createHash, toArrayBuffer } = crypto;
 
 type Test = [HashAlgorithm, string, number];
 
diff --git a/packages/example/src/testing/tests/webcryptoTests/encrypt_decrypt.ts b/packages/example/src/testing/tests/webcryptoTests/encrypt_decrypt.ts
@@ -13,13 +13,12 @@ import type {
   EncryptDecryptParams,
   KeyUsage,
   RsaOaepParams,
-} from '../../../../../react-native-quick-crypto/src/keys';
+} from 'react-native-quick-crypto';
 import rsa_oaep_fixtures from '../../fixtures/rsa';
 import aes_cbc_fixtures from '../../fixtures/aes_cbc';
 import aes_ctr_fixtures from '../../fixtures/aes_ctr';
 import aes_gcm_fixtures from '../../fixtures/aes_gcm';
 import { assertThrowsAsync } from '../util';
-import { ab2str } from '../../../../../react-native-quick-crypto/src/Utils';
 
 export type RsaEncryptDecryptTestVector = {
   name: string;
@@ -51,7 +50,7 @@ export type BadPadding = {
 };
 export type BadPaddingVectorValue = Record<string, BadPadding>;
 
-const { subtle } = crypto;
+const { subtle, ab2str } = crypto;
 
 // This is only a partial test. The WebCrypto Web Platform Tests
 // will provide much greater coverage.
diff --git a/packages/example/src/testing/tests/webcryptoTests/generateKey.ts b/packages/example/src/testing/tests/webcryptoTests/generateKey.ts
@@ -2,7 +2,6 @@ import { expect } from 'chai';
 // import type { Buffer } from '@craftzdog/react-native-buffer';
 import { describe, it } from '../../MochaRNAdapter';
 import crypto from 'react-native-quick-crypto';
-import { assertThrowsAsync } from '../util';
 import type {
   AESAlgorithm,
   AESLength,
@@ -11,10 +10,10 @@ import type {
   CryptoKeyPair,
   KeyUsage,
   NamedCurve,
-} from '../../../../../react-native-quick-crypto/src/keys';
-import { isCryptoKey } from '../../../../../react-native-quick-crypto/src/keys';
+} from 'react-native-quick-crypto/src/keys';
+import { assertThrowsAsync } from '../util';
 
-const { subtle } = crypto;
+const { subtle, isCryptoKey } = crypto;
 
 const allUsages: KeyUsage[] = [
   'encrypt',
diff --git a/packages/example/src/testing/tests/webcryptoTests/import_export.ts b/packages/example/src/testing/tests/webcryptoTests/import_export.ts
@@ -7,10 +7,6 @@ import {
 } from 'react-native-quick-base64';
 import crypto from 'react-native-quick-crypto';
 import { describe, it } from '../../MochaRNAdapter';
-import {
-  ab2str,
-  binaryLikeToArrayBuffer,
-} from '../../../../../react-native-quick-crypto/src/Utils';
 import { assertThrowsAsync } from '../util';
 import type {
   CryptoKey,
@@ -19,14 +15,20 @@ import type {
   JWK,
   KeyUsage,
   NamedCurve,
+  RandomTypedArrays,
   RSAKeyPairAlgorithm,
   SubtleAlgorithm,
-} from '../../../../../react-native-quick-crypto/src/keys';
-import type { RandomTypedArrays } from '../../../../../react-native-quick-crypto/src/random';
+} from 'react-native-quick-crypto';
 import pubTestKeyEc256 from '../../fixtures/keys/ec_p256_public';
 import privTestKeyEc256 from '../../fixtures/keys/ec_p256_private';
 
-const { subtle, createPublicKey, createPrivateKey } = crypto;
+const {
+  subtle,
+  createPublicKey,
+  createPrivateKey,
+  ab2str,
+  binaryLikeToArrayBuffer,
+} = crypto;
 
 // Tests that a key pair can be used for encryption / decryption.
 // function testEncryptDecrypt(publicKey: any, privateKey: any) {
diff --git a/packages/example/src/testing/tests/webcryptoTests/sign_verify.ts b/packages/example/src/testing/tests/webcryptoTests/sign_verify.ts
@@ -1,7 +1,7 @@
 import type {
   CryptoKey,
   CryptoKeyPair,
-} from '../../../../../../packages/react-native-quick-crypto/src/keys';
+} from 'react-native-quick-crypto';
 import crypto from 'react-native-quick-crypto';
 import { describe, it } from '../../MochaRNAdapter';
 import { expect } from 'chai';
diff --git a/packages/react-native-quick-crypto/src/Cipher.ts b/packages/react-native-quick-crypto/src/Cipher.ts
@@ -932,4 +932,4 @@ export function generateKeyPairSync(
     publicKey,
     privateKey,
   };
-}
+};
diff --git a/packages/react-native-quick-crypto/src/index.ts b/packages/react-native-quick-crypto/src/index.ts
@@ -18,10 +18,9 @@ import { createHmac } from './Hmac';
 import { createHash } from './Hash';
 import { constants } from './constants';
 import { subtle } from './subtle';
-import { getCiphers, getHashes } from './Utils';
 import webcrypto from './webcrypto';
-import { createPrivateKey, createPublicKey, createSecretKey } from './keys';
-
+import * as keys from './keys';
+import * as utils from './Utils';
 /**
  * Loosely matches Node.js {crypto} with some unimplemented functionality
  */
@@ -34,9 +33,6 @@ const QuickCrypto = {
   createCipheriv,
   createDecipher,
   createDecipheriv,
-  createPublicKey,
-  createPrivateKey,
-  createSecretKey,
   publicEncrypt,
   publicDecrypt,
   privateDecrypt,
@@ -48,13 +44,19 @@ const QuickCrypto = {
   createVerify,
   subtle,
   constants,
+  ...keys,
   ...pbkdf2,
   ...random,
-  getCiphers,
-  getHashes,
+  ...utils,
   webcrypto,
 };
 
+// type exports
+export type * from './keys';
+export type * from './random';
+export type * from './Cipher';
+export type * from './Utils';
+
 /**
  * Optional. Patch global.crypto with quickcrypto and global.Buffer with react-native-buffer.
  */
diff --git a/packages/react-native-quick-crypto/src/keys.ts b/packages/react-native-quick-crypto/src/keys.ts
@@ -399,7 +399,7 @@ function prepareAsymmetricKey(
   format: KFormatType;
   data: ArrayBuffer;
   type?: KeyEncoding;
-  passphrase?: BinaryLike;
+  passphrase?: ArrayBuffer | string;
 } {
   // TODO(osp) check, KeyObject some node object
   // if (isKeyObject(key)) {
@@ -465,19 +465,35 @@ export function parsePublicKeyEncoding(
   enc: EncodingOptions,
   keyType: string | undefined,
   objName?: string,
-) {
-  return parseKeyEncoding(enc, keyType, keyType ? true : undefined, objName);
+): {
+  format: KFormatType;
+  type?: KeyEncoding;
+} {
+  return parseKeyEncoding(enc, keyType, keyType ? true : undefined, objName) as {
+    format: KFormatType;
+    type?: KeyEncoding;
+  };
 }
 
 // Parses the private key encoding based on an object. keyType must be undefined
 // when this is used to parse an input encoding and must be a valid key type if
 // used to parse an output encoding.
 export function parsePrivateKeyEncoding(
   enc: EncodingOptions,
-  keyType: string | undefined,
+  keyType?: string,
   objName?: string,
-) {
-  return parseKeyEncoding(enc, keyType, false, objName);
+): {
+  format: KFormatType;
+  type?: KeyEncoding;
+  cipher?: string;
+  passphrase?: ArrayBuffer | string | undefined;
+} {
+  return parseKeyEncoding(enc, keyType, false, objName) as {
+    format: KFormatType;
+    type?: KeyEncoding;
+    cipher?: string;
+    passphrase?: ArrayBuffer | string | undefined;
+  };
 }
 
 // function getKeyObjectHandle(key: any, ctx: KeyInputContext) {
@@ -648,7 +664,7 @@ export class CryptoKey {
   }
 }
 
-class KeyObject {
+export class KeyObject {
   handle: KeyObjectHandle;
   type: 'public' | 'secret' | 'private' | 'unknown' = 'unknown';
   // eslint-disable-next-line @typescript-eslint/no-unused-vars

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { TagLength } from '../../../../react-native-quick-crypto/src/keys';`
	`1`	`+import type { TagLength } from 'react-native-quick-crypto';`
`2`	`2`	`import { decodeHex } from '../tests/util';`
`3`	`3`	`import type {`
`4`	`4`	`AesEncryptDecryptTestVector,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { BinaryLikeNode } from '../../../../../react-native-quick-crypto/src/Utils';`
	`1`	`+import type { BinaryLikeNode } from 'react-native-quick-crypto';`
`2`	`2`	`import { Buffer as CraftzdogBuffer } from '@craftzdog/react-native-buffer';`
`3`	`3`	`import { Buffer as FerossBuffer } from 'buffer';`
`4`	`4`	`import crypto from 'react-native-quick-crypto';`