@bsv/overlay-discovery-services 1.4.0 → 1.4.2

package/dist/esm/src/utils/generateDocs.js

@@ -0,0 +1,46 @@
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import * as path from 'path';
+const execPromise = promisify(exec);
+const docs = [
+    {
+        input: './src/SHIP/SHIPTopicManager.ts',
+        output: './docs/SHIP/ship-topic-manager.md'
+    },
+    {
+        input: './src/SHIP/SHIPLookupService.ts',
+        output: './docs/SHIP/ship-lookup-service.md'
+    },
+    {
+        input: './src/SHIP/SHIPStorage.ts',
+        output: './docs/SHIP/ship-storage.md'
+    },
+    {
+        input: './src/SLAP/SLAPTopicManager.ts',
+        output: './docs/SLAP/slap-topic-manager.md'
+    },
+    {
+        input: './src/SLAP/SLAPLookupService.ts',
+        output: './docs/SLAP/slap-lookup-service.md'
+    },
+    {
+        input: './src/SLAP/SLAPStorage.ts',
+        output: './docs/SLAP/slap-storage.md'
+    }
+];
+// Helper function for generating updated documentation
+const generateDocs = async () => {
+    for (const doc of docs) {
+        const command = `npx ts2md --inputFilename ${path.resolve(doc.input)} --outputFilename ${path.resolve(doc.output)} --firstHeadingLevel 2 --noTitle true --readmeMerge true`;
+        try {
+            const { stdout, stderr } = await execPromise(command);
+            console.log(`stdout: ${stdout}`);
+            console.error(`stderr: ${stderr}`);
+        }
+        catch (error) {
+            console.error(`Error generating documentation for ${doc.input}:`, error);
+        }
+    }
+};
+generateDocs().then(() => console.log('Documentation generation complete')).catch(error => console.error('Error:', error));
+//# sourceMappingURL=generateDocs.js.map

package/dist/esm/src/utils/generateDocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateDocs.js","sourceRoot":"","sources":["../../../../src/utils/generateDocs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;AAOnC,MAAM,IAAI,GAAgB;IACxB;QACE,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,mCAAmC;KAC5C;IACD;QACE,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,oCAAoC;KAC7C;IACD;QACE,KAAK,EAAE,2BAA2B;QAClC,MAAM,EAAE,6BAA6B;KACtC;IACD;QACE,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,mCAAmC;KAC5C;IACD;QACE,KAAK,EAAE,iCAAiC;QACxC,MAAM,EAAE,oCAAoC;KAC7C;IACD;QACE,KAAK,EAAE,2BAA2B;QAClC,MAAM,EAAE,6BAA6B;KACtC;CACF,CAAA;AAED,uDAAuD;AACvD,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;IAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,6BAA6B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,0DAA0D,CAAA;QAC3K,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAA;YACrD,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YAChC,OAAO,CAAC,KAAK,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sCAAsC,GAAG,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,CAAA;QAC1E,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,YAAY,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAA"}

package/dist/esm/src/utils/getDocumentation.js

@@ -0,0 +1,20 @@
+import { promises as fs } from 'fs';
+import { resolve, dirname } from 'path';
+/**
+ * Returns documentation specific to the provided filename
+ * @param {string} filePath - The path of the markdown file
+ * @returns A promise that resolves to the documentation string
+ */
+async function getDocumentation(filePath) {
+    try {
+        const resolvedPath = resolve(dirname(require.resolve('@bsv/overlay-discovery-services')), '../../', filePath);
+        const data = await fs.readFile(resolvedPath, 'utf-8');
+        return data;
+    }
+    catch (error) {
+        console.error('Error reading documentation file:', error);
+        throw new Error('Failed to read documentation file');
+    }
+}
+export { getDocumentation };
+//# sourceMappingURL=getDocumentation.js.map

package/dist/esm/src/utils/getDocumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDocumentation.js","sourceRoot":"","sources":["../../../../src/utils/getDocumentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAA;AACnC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACvC;;;;GAIG;AACH,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IAC9C,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,iCAAiC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;QAC7G,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QACrD,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAA;QACzD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;AACH,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/dist/esm/src/utils/isAdvertisableURI.js

@@ -21,9 +21,9 @@ export const isAdvertisableURI = (uri) => {
     // Helper function: validate a URL by substituting its scheme if needed.
     const validateCustomHttpsURI = (uri, prefix) => {
         try {
-            const modifiedURI = uri.replace(prefix, "https://");
+            const modifiedURI = uri.replace(prefix, 'https://');
             const parsed = new URL(modifiedURI);
-            if (parsed.hostname.toLowerCase() === "localhost")
+            if (parsed.hostname.toLowerCase() === 'localhost')
                 return false;
             if (parsed.pathname !== '/')
                 return false;
@@ -34,32 +34,32 @@ export const isAdvertisableURI = (uri) => {
         }
     };
     // HTTPS-based schemes – disallow localhost.
-    if (uri.startsWith("https://")) {
-        return validateCustomHttpsURI(uri, "https://");
+    if (uri.startsWith('https://')) {
+        return validateCustomHttpsURI(uri, 'https://');
     }
     // Plain auth over HTTPS, but no payment can be collected
-    else if (uri.startsWith("https+bsvauth://")) {
-        return validateCustomHttpsURI(uri, "https+bsvauth://");
+    else if (uri.startsWith('https+bsvauth://')) {
+        return validateCustomHttpsURI(uri, 'https+bsvauth://');
     }
     // Auth and payment over HTTPS
-    else if (uri.startsWith("https+bsvauth+smf://")) {
-        return validateCustomHttpsURI(uri, "https+bsvauth+smf://");
+    else if (uri.startsWith('https+bsvauth+smf://')) {
+        return validateCustomHttpsURI(uri, 'https+bsvauth+smf://');
     }
     // A protocol allowing you to also supply sCrypt off-chain values to the topical admissibility checking context
-    else if (uri.startsWith("https+bsvauth+scrypt-offchain://")) {
-        return validateCustomHttpsURI(uri, "https+bsvauth+scrypt-offchain://");
+    else if (uri.startsWith('https+bsvauth+scrypt-offchain://')) {
+        return validateCustomHttpsURI(uri, 'https+bsvauth+scrypt-offchain://');
     }
     // A protocol allowing overlays that deal with real-time transactions (non-finals)
-    else if (uri.startsWith("https+rtt://")) {
-        return validateCustomHttpsURI(uri, "https+rtt://");
+    else if (uri.startsWith('https+rtt://')) {
+        return validateCustomHttpsURI(uri, 'https+rtt://');
     }
     // WSS for real-time event-listening lookups.
-    else if (uri.startsWith("wss://")) {
+    else if (uri.startsWith('wss://')) {
         try {
             const parsed = new URL(uri);
-            if (parsed.protocol !== "wss:")
+            if (parsed.protocol !== 'wss:')
                 return false;
-            if (parsed.hostname.toLowerCase() === "localhost")
+            if (parsed.hostname.toLowerCase() === 'localhost')
                 return false;
             return true;
         }
@@ -68,18 +68,18 @@ export const isAdvertisableURI = (uri) => {
         }
     }
     // JS8 Call–based advertisement.
-    else if (uri.startsWith("js8c+bsvauth+smf:")) {
+    else if (uri.startsWith('js8c+bsvauth+smf:')) {
         // Expect a query string with parameters.
-        const queryIndex = uri.indexOf("?");
+        const queryIndex = uri.indexOf('?');
         if (queryIndex === -1)
             return false;
         const queryStr = uri.substring(queryIndex);
         const params = new URLSearchParams(queryStr);
         // Required parameters: lat, long, freq, and radius.
-        const latStr = params.get("lat");
-        const longStr = params.get("long");
-        const freqStr = params.get("freq");
-        const radiusStr = params.get("radius");
+        const latStr = params.get('lat');
+        const longStr = params.get('long');
+        const freqStr = params.get('freq');
+        const radiusStr = params.get('radius');
         if (!latStr || !longStr || !freqStr || !radiusStr)
             return false;
         // Validate latitude and longitude ranges.

package/dist/esm/src/utils/isAdvertisableURI.js.map

@@ -1 +1 @@
-{"version":3,"file":"isAdvertisableURI.js","sourceRoot":"","sources":["../../../../src/utils/isAdvertisableURI.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAW,EAAE;IACxD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAE/D,wEAAwE;IACxE,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAE,MAAc,EAAW,EAAE;QACtE,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;YACpC,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,WAAW;gBAAE,OAAO,KAAK,CAAC;YAChE,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG;gBAAE,OAAO,KAAK,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC;IAEF,4CAA4C;IAC5C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,sBAAsB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC;IACD,yDAAyD;SACpD,IAAI,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC5C,OAAO,sBAAsB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACzD,CAAC;IACD,8BAA8B;SACzB,IAAI,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAChD,OAAO,sBAAsB,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IACD,+GAA+G;SAC1G,IAAI,GAAG,CAAC,UAAU,CAAC,kCAAkC,CAAC,EAAE,CAAC;QAC5D,OAAO,sBAAsB,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAC;IACzE,CAAC;IACD,kFAAkF;SAC7E,IAAI,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACxC,OAAO,sBAAsB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;IACD,6CAA6C;SACxC,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;gBAAE,OAAO,KAAK,CAAC;YAC7C,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,WAAW;gBAAE,OAAO,KAAK,CAAC;YAChE,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,gCAAgC;SAC3B,IAAI,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC7C,yCAAyC;QACzC,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,UAAU,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAEpC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;QAE7C,oDAAoD;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QAEhE,0CAA0C;QAC1C,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE;YAAE,OAAO,KAAK,CAAC;QACtD,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,GAAG,GAAG;YAAE,OAAO,KAAK,CAAC;QAExD,qEAAqE;QACrE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAEjD,oEAAoE;QACpE,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW;YAAE,OAAO,KAAK,CAAC;QAC/B,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAErD,yEAAyE;QACzE,iDAAiD;QACjD,yEAAyE;QACzE,iFAAiF;QACjF,kFAAkF;QAClF,0DAA0D;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAAiD;IACjD,+CAA+C;IAE/C,oEAAoE;IACpE,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
+{"version":3,"file":"isAdvertisableURI.js","sourceRoot":"","sources":["../../../../src/utils/isAdvertisableURI.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAW,EAAE;IACxD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,KAAK,CAAA;IAE9D,wEAAwE;IACxE,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAE,MAAc,EAAW,EAAE;QACtE,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YACnD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;YACnC,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,WAAW;gBAAE,OAAO,KAAK,CAAA;YAC/D,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG;gBAAE,OAAO,KAAK,CAAA;YACzC,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC,CAAA;IAED,4CAA4C;IAC5C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,sBAAsB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IAChD,CAAC;IACD,yDAAyD;SACpD,IAAI,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC5C,OAAO,sBAAsB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAA;IACxD,CAAC;IACD,8BAA8B;SACzB,IAAI,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAChD,OAAO,sBAAsB,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAA;IAC5D,CAAC;IACD,+GAA+G;SAC1G,IAAI,GAAG,CAAC,UAAU,CAAC,kCAAkC,CAAC,EAAE,CAAC;QAC5D,OAAO,sBAAsB,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAA;IACxE,CAAC;IACD,kFAAkF;SAC7E,IAAI,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACxC,OAAO,sBAAsB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAA;IACpD,CAAC;IACD,6CAA6C;SACxC,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;YAC3B,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;gBAAE,OAAO,KAAK,CAAA;YAC5C,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,WAAW;gBAAE,OAAO,KAAK,CAAA;YAC/D,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,gCAAgC;SAC3B,IAAI,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC7C,yCAAyC;QACzC,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACnC,IAAI,UAAU,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QAEnC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QAE5C,oDAAoD;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAClC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAClC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAEtC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAA;QAE/D,0CAA0C;QAC1C,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;QAC9B,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;QAC/B,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE;YAAE,OAAO,KAAK,CAAA;QACrD,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,GAAG,GAAG;YAAE,OAAO,KAAK,CAAA;QAEvD,qEAAqE;QACrE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QAChD,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAA;QAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC;YAAE,OAAO,KAAK,CAAA;QAEhD,oEAAoE;QACpE,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QACpD,IAAI,CAAC,WAAW;YAAE,OAAO,KAAK,CAAA;QAC9B,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5C,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC;YAAE,OAAO,KAAK,CAAA;QAEpD,yEAAyE;QACzE,iDAAiD;QACjD,yEAAyE;QACzE,iFAAiF;QACjF,kFAAkF;QAClF,0DAA0D;QAC1D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,iDAAiD;IACjD,+CAA+C;IAE/C,oEAAoE;IACpE,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/dist/esm/src/utils/isValidDomain.js

@@ -0,0 +1,11 @@
+/**
+ * Validates if the provided domain name is valid.
+ * @param domain - The domain name to validate.
+ * @returns True if the domain name is valid, false otherwise.
+ */
+export const isValidDomain = (domain) => {
+    // Simple regex to validate domain name
+    const domainRegex = /^(https?:\/\/)?((([a-zA-Z0-9-]+)\.)+([a-zA-Z]{2,})|localhost(:[0-9]+))(\/.*)?$/;
+    return domainRegex.test(domain);
+};
+//# sourceMappingURL=isValidDomain.js.map

package/dist/esm/src/utils/isValidDomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidDomain.js","sourceRoot":"","sources":["../../../../src/utils/isValidDomain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAW,EAAE;IACvD,uCAAuC;IACvC,MAAM,WAAW,GAAG,gFAAgF,CAAA;IACpG,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACjC,CAAC,CAAA"}

package/dist/esm/src/utils/isValidServiceName.js

@@ -0,0 +1,10 @@
+/**
+ * Validates if the provided service name is valid based on BRC-87 guidelines.
+ * @param service - The service name to validate.
+ * @returns True if the service name is valid, false otherwise.
+ */
+export const isValidServiceName = (service) => {
+    const serviceRegex = /^(?!_)(?!.*__)[a-z_]{1,50}(?<!_)$/;
+    return serviceRegex.test(service);
+};
+//# sourceMappingURL=isValidServiceName.js.map

package/dist/esm/src/utils/isValidServiceName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidServiceName.js","sourceRoot":"","sources":["../../../../src/utils/isValidServiceName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAW,EAAE;IAC7D,MAAM,YAAY,GAAG,mCAAmC,CAAA;IACxD,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,CAAC,CAAA"}

package/dist/esm/src/utils/verifyToken.js

@@ -0,0 +1,18 @@
+import { PublicKey, Signature } from '@bsv/sdk';
+/**
+ * Verifies the BRC-48 locking key and the signature.
+ * @private
+ * @param identityKey - The BRC-31 identity key of the advertiser.
+ * @param lockingPublicKey - The public key used in the output's locking script.
+ * @param fields - The fields of the token.
+ * @param signature - The signature over the token fields.
+ * @param protocolId - The protocol ID (e.g., 'SHIP' or 'SLAP').
+ * @throws Will throw an error if the locking key or signature is invalid.
+ */
+export const verifyToken = (identityKey, lockingPublicKey, fields, signature) => {
+    const pubKey = PublicKey.fromString(lockingPublicKey);
+    const hasValidSignature = pubKey.verify(Array.from(Buffer.concat(fields)), Signature.fromDER(signature, 'hex'));
+    if (!hasValidSignature)
+        throw new Error('Invalid signature!');
+};
+//# sourceMappingURL=verifyToken.js.map

package/dist/esm/src/utils/verifyToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifyToken.js","sourceRoot":"","sources":["../../../../src/utils/verifyToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAE/C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,WAAmB,EACnB,gBAAwB,EACxB,MAAgB,EAChB,SAAiB,EACX,EAAE;IACR,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;IACrD,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CACrC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EACjC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CACpC,CAAA;IAED,IAAI,CAAC,iBAAiB;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;AAC/D,CAAC,CAAA"}