Merge pull request #19 from MasterKale/feature/docs

feature/docs

7 files changed, 30 insertions, 26 deletions

diff --git a/packages/server/src/assertion/verifyAssertionResponse.ts b/packages/server/src/assertion/verifyAssertionResponse.ts
index 0d74795..24ee17e 100644
--- a/packages/server/src/assertion/verifyAssertionResponse.ts
+++ b/packages/server/src/assertion/verifyAssertionResponse.ts
@@ -5,12 +5,11 @@ import {
   VerifiedAssertion,
 } from '@simplewebauthn/typescript-types';
 
-import decodeClientDataJSON from '@helpers/decodeClientDataJSON';
-
-import toHash from '@helpers/toHash';
-import convertASN1toPEM from '@helpers/convertASN1toPEM';
-import verifySignature from '@helpers/verifySignature';
-import parseAuthenticatorData from '@helpers/parseAuthenticatorData';
+import decodeClientDataJSON from '../helpers/decodeClientDataJSON';
+import toHash from '../helpers/toHash';
+import convertASN1toPEM from '../helpers/convertASN1toPEM';
+import verifySignature from '../helpers/verifySignature';
+import parseAuthenticatorData from '../helpers/parseAuthenticatorData';
 
 /**
  * Verify that the user has legitimately completed the login process
diff --git a/packages/server/src/attestation/verifications/verifyAndroidSafetyNet.ts b/packages/server/src/attestation/verifications/verifyAndroidSafetyNet.ts
index 81781b3..0f604d0 100644
--- a/packages/server/src/attestation/verifications/verifyAndroidSafetyNet.ts
+++ b/packages/server/src/attestation/verifications/verifyAndroidSafetyNet.ts
@@ -7,11 +7,11 @@ import {
   SafetyNetJWTSignature,
 } from '@simplewebauthn/typescript-types';
 
-import toHash from '@helpers/toHash';
-import verifySignature from '@helpers/verifySignature';
-import convertCOSEtoPKCS from '@helpers/convertCOSEtoPKCS';
-import getCertificateInfo from '@helpers/getCertificateInfo';
-import parseAuthenticatorData from '@helpers/parseAuthenticatorData';
+import toHash from '../../helpers/toHash';
+import verifySignature from '../../helpers/verifySignature';
+import convertCOSEtoPKCS from '../../helpers/convertCOSEtoPKCS';
+import getCertificateInfo from '../../helpers/getCertificateInfo';
+import parseAuthenticatorData from '../../helpers/parseAuthenticatorData';
 
 /**
  * Verify an attestation response with fmt 'android-safetynet'
diff --git a/packages/server/src/attestation/verifications/verifyFIDOU2F.ts b/packages/server/src/attestation/verifications/verifyFIDOU2F.ts
index 3ec5f60..e518dc8 100644
--- a/packages/server/src/attestation/verifications/verifyFIDOU2F.ts
+++ b/packages/server/src/attestation/verifications/verifyFIDOU2F.ts
@@ -1,11 +1,11 @@
 import base64url from 'base64url';
 import { AttestationObject, VerifiedAttestation } from '@simplewebauthn/typescript-types';
 
-import toHash from '@helpers/toHash';
-import convertCOSEtoPKCS from '@helpers/convertCOSEtoPKCS';
-import convertASN1toPEM from '@helpers/convertASN1toPEM';
-import verifySignature from '@helpers/verifySignature';
-import parseAuthenticatorData from '@helpers/parseAuthenticatorData';
+import toHash from '../../helpers/toHash';
+import convertCOSEtoPKCS from '../../helpers/convertCOSEtoPKCS';
+import convertASN1toPEM from '../../helpers/convertASN1toPEM';
+import verifySignature from '../../helpers/verifySignature';
+import parseAuthenticatorData from '../../helpers/parseAuthenticatorData';
 
 /**
  * Verify an attestation response with fmt 'fido-u2f'
diff --git a/packages/server/src/attestation/verifications/verifyNone.ts b/packages/server/src/attestation/verifications/verifyNone.ts
index 4c0a6cc..423f4fd 100644
--- a/packages/server/src/attestation/verifications/verifyNone.ts
+++ b/packages/server/src/attestation/verifications/verifyNone.ts
@@ -1,8 +1,8 @@
 import base64url from 'base64url';
 import { AttestationObject, VerifiedAttestation } from '@simplewebauthn/typescript-types';
 
-import convertCOSEtoPKCS from '@helpers/convertCOSEtoPKCS';
-import parseAuthenticatorData from '@helpers/parseAuthenticatorData';
+import convertCOSEtoPKCS from '../../helpers/convertCOSEtoPKCS';
+import parseAuthenticatorData from '../../helpers/parseAuthenticatorData';
 
 /**
  * Verify an attestation response with fmt 'none'
diff --git a/packages/server/src/attestation/verifications/verifyPacked.ts b/packages/server/src/attestation/verifications/verifyPacked.ts
index 1d7145b..f7b9932 100644
--- a/packages/server/src/attestation/verifications/verifyPacked.ts
+++ b/packages/server/src/attestation/verifications/verifyPacked.ts
@@ -9,12 +9,12 @@ import {
   COSEPublicKey as COSEPublicKeyType,
 } from '@simplewebauthn/typescript-types';
 
-import convertCOSEtoPKCS from '@helpers/convertCOSEtoPKCS';
-import toHash from '@helpers/toHash';
-import convertASN1toPEM from '@helpers/convertASN1toPEM';
-import getCertificateInfo from '@helpers/getCertificateInfo';
-import verifySignature from '@helpers/verifySignature';
-import parseAuthenticatorData from '@helpers/parseAuthenticatorData';
+import convertCOSEtoPKCS from '../../helpers/convertCOSEtoPKCS';
+import toHash from '../../helpers/toHash';
+import convertASN1toPEM from '../../helpers/convertASN1toPEM';
+import getCertificateInfo from '../../helpers/getCertificateInfo';
+import verifySignature from '../../helpers/verifySignature';
+import parseAuthenticatorData from '../../helpers/parseAuthenticatorData';
 
 /**
  * Verify an attestation response with fmt 'packed'
diff --git a/packages/server/src/attestation/verifyAttestationResponse.ts b/packages/server/src/attestation/verifyAttestationResponse.ts
index c531178..e336d2a 100644
--- a/packages/server/src/attestation/verifyAttestationResponse.ts
+++ b/packages/server/src/attestation/verifyAttestationResponse.ts
@@ -1,5 +1,5 @@
-import decodeAttestationObject from '@helpers/decodeAttestationObject';
-import decodeClientDataJSON from '@helpers/decodeClientDataJSON';
+import decodeAttestationObject from '../helpers/decodeAttestationObject';
+import decodeClientDataJSON from '../helpers/decodeClientDataJSON';
 import {
   ATTESTATION_FORMATS,
   AuthenticatorAttestationResponseJSON,
diff --git a/packages/server/src/index.ts b/packages/server/src/index.ts
index 14a7f3d..86d66e5 100644
--- a/packages/server/src/index.ts
+++ b/packages/server/src/index.ts
@@ -1,3 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module @simplewebauthn/server
+ * @preferred
+ */
 import generateAttestationOptions from './attestation/generateAttestationOptions';
 import verifyAttestationResponse from './attestation/verifyAttestationResponse';
 import generateAssertionOptions from './assertion/generateAssertionOptions';