chore: tweaks

wevm · Aug 20, 2024 · a5648da · a5648da
1 parent c0206d8
commit a5648da
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 31 deletions.
diff --git a/site/vocs.config.tsx b/site/vocs.config.tsx
@@ -413,33 +413,33 @@ export default defineConfig({
             },
           ],
         },
-        // {
-        //   text: 'Siwe (ERC-4361) 🚧',
-        //   collapsed: true,
-        //   link: '/api/siwe',
-        //   items: [
-        //     {
-        //       text: '.createMessage',
-        //       link: '/api/siwe/createMessage',
-        //     },
-        //     {
-        //       text: '.generateNonce',
-        //       link: '/api/siwe/generateNonce',
-        //     },
-        //     {
-        //       text: '.isUri',
-        //       link: '/api/siwe/isUri',
-        //     },
-        //     {
-        //       text: '.parseMessage',
-        //       link: '/api/siwe/parseMessage',
-        //     },
-        //     {
-        //       text: '.validateMessage',
-        //       link: '/api/siwe/validateMessage',
-        //     },
-        //   ],
-        // },
+        {
+          text: 'Siwe (ERC-4361) 🚧',
+          collapsed: true,
+          link: '/api/siwe',
+          items: [
+            {
+              text: '.createMessage',
+              link: '/api/siwe/createMessage',
+            },
+            {
+              text: '.generateNonce',
+              link: '/api/siwe/generateNonce',
+            },
+            {
+              text: '.isUri',
+              link: '/api/siwe/isUri',
+            },
+            {
+              text: '.parseMessage',
+              link: '/api/siwe/parseMessage',
+            },
+            {
+              text: '.validateMessage',
+              link: '/api/siwe/validateMessage',
+            },
+          ],
+        },
         {
           text: 'Transaction 🚧',
           collapsed: true,

diff --git a/src/Siwe.test.ts b/src/Siwe.test.ts
@@ -0,0 +1,18 @@
+import { expect, test } from 'vitest'
+import * as exports from './Siwe.js'
+
+test('exports', () => {
+  expect(Object.keys(exports)).toMatchInlineSnapshot(`
+    [
+      "createMessage",
+      "createSiweMessage",
+      "generateNonce",
+      "generateSiweNonce",
+      "isUri",
+      "parseMessage",
+      "parseSiweMessage",
+      "validateMessage",
+      "validateSiweMessage",
+    ]
+  `)
+})
diff --git a/src/Siwe.ts b/src/Siwe.ts
@@ -8,6 +8,8 @@ export {
   generateSiweNonce,
 } from './internal/siwe/generateSiweNonce.js'
 
+export { isUri } from './internal/siwe/isUri.js'
+
 export {
   parseSiweMessage as parseMessage,
   parseSiweMessage,

diff --git a/src/internal/siwe/createSiweMessage.ts b/src/internal/siwe/createSiweMessage.ts
@@ -1,7 +1,7 @@
 import type { GlobalErrorType } from 'src/Errors.js'
 import { toAddress } from '../address/from.js'
 import { SiweInvalidMessageFieldError } from '../errors/siwe.js'
-import { isUri } from '../isUri.js'
+import { isUri } from './isUri.js'
 import type { SiweMessage } from '../types/siwe.js'
 
 /**

diff --git a/src/internal/isUri.test.ts → src/internal/siwe/isUri.test.ts b/src/internal/isUri.test.ts → src/internal/siwe/isUri.test.ts
diff --git a/src/internal/isUri.ts → src/internal/siwe/isUri.ts b/src/internal/isUri.ts → src/internal/siwe/isUri.ts
@@ -1,7 +1,19 @@
-/** @internal */
-export function isUri(value: string) {
-  // based on https://github.com/ogt/valid-url
+// based on https://github.com/ogt/valid-url
+
+/**
+ * Check if the given URI is a valid URI.
+ *
+ * - Docs: https://oxlib.sh/api/siwe/isUri
+ * - Spec: https://www.rfc-editor.org/rfc/rfc3986
+ *
+ * @example
+ * import { Siwe } from 'ox'
+ *
+ * Siwe.isUri('https://example.com/foo')
+ * // true
+ */
 
+export function isUri(value: string) {
   // check for illegal characters
   if (/[^a-z0-9\:\/\?\#\[\]\@\!\$\&\'\(\)\*\+\,\;\=\.\-\_\~\%]/i.test(value))
     return false