@blockcore/dns 0.0.2 → 0.0.3

package/README.md

@@ -22,4 +22,28 @@
 npm install @blockcore/dns
 ```
 
-**Warning:** This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and does not provide a CommonJS export. If your project uses CommonJS, you'll have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function.
+**Warning:** This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and does not provide a CommonJS export. If your project uses CommonJS, you'll have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function.
+
+
+## Usage
+
+```ts
+import { BlockcoreDns } from '@blockcore/dns';
+
+let dns = new BlockcoreDns();
+let servers = await dns.getDnsServers();
+```
+
+After getting the servers, either you can loop all of them or pick a single one:
+
+```ts
+let server = servers[0];
+
+dns.setActiveServer(dnsServer.url);
+
+await dns.getServicesByType('Indexer');
+await dns.getServicesByNetwork('CITY');
+await dns.getServicesByTypeAndNetwork('Indexer', 'CITY');
+await dns.getExternalIP();
+```
+

package/dist/BlockcoreDns.d.ts

@@ -1,8 +1,17 @@
-import { BlockcoreDnsOptions } from './options.js';
+import { BlockcoreDnsOptions, DnsListEntry, ServiceListEntry } from './types.js';
 export declare class BlockcoreDns {
     private options;
     static defaultOptions: BlockcoreDnsOptions;
     static create(): BlockcoreDns;
+    private activeServer?;
     constructor(options?: BlockcoreDnsOptions);
-    getDnsServers(): Promise<unknown>;
+    setActiveServer(url: string): void;
+    getDnsServers(): Promise<DnsListEntry[]>;
+    getServicesByType(service: 'Indexer' | 'Explorer'): Promise<ServiceListEntry[]>;
+    getServicesByTypeAndNetwork(service: 'Indexer' | 'Explorer', symbol: string): Promise<ServiceListEntry[]>;
+    getServicesByNetwork(symbol: string): Promise<ServiceListEntry[]>;
+    getExternalIP(): Promise<string>;
+    private fetchText;
+    private fetchJson;
+    private fetchUrl;
 }

package/dist/BlockcoreDns.js

@@ -7,14 +7,51 @@ export class BlockcoreDns {
             writable: true,
             value: options
         });
+        Object.defineProperty(this, "activeServer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
     }
     static create() {
         const dns = new BlockcoreDns();
         return dns;
     }
+    setActiveServer(url) {
+        this.activeServer = url;
+    }
     async getDnsServers() {
-        const url = `${this.options.baseUrl}/services/BLOCKCORE-DNS.json`;
-        const response = await fetch(url, {
+        const url = `${this.options.baseUrl}/services/DNS.json`;
+        const servers = await this.fetchJson(url);
+        return servers;
+    }
+    async getServicesByType(service) {
+        const url = `${this.activeServer}/api/dns/services/service/${service}`;
+        return await this.fetchJson(url);
+    }
+    async getServicesByTypeAndNetwork(service, symbol) {
+        const url = `${this.activeServer}/api/dns/services/symbol/${symbol}/service/${service}`;
+        return await this.fetchJson(url);
+    }
+    async getServicesByNetwork(symbol) {
+        const url = `${this.activeServer}/api/dns/services/symbol/${symbol}`;
+        return await this.fetchJson(url);
+    }
+    async getExternalIP() {
+        const url = `${this.activeServer}/api/dns/ipaddress`;
+        return await this.fetchText(url);
+    }
+    async fetchText(url) {
+        const response = await this.fetchUrl(url);
+        return response.text();
+    }
+    async fetchJson(url) {
+        const response = await this.fetchUrl(url);
+        return response.json();
+    }
+    async fetchUrl(url) {
+        return await fetch(url, {
             method: 'GET',
             // mode: 'cors',
             // cache: 'no-cache',
@@ -25,8 +62,6 @@ export class BlockcoreDns {
             redirect: 'follow',
             referrerPolicy: 'no-referrer',
         });
-        const servers = await response.json();
-        return servers;
     }
 }
 Object.defineProperty(BlockcoreDns, "defaultOptions", {

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export interface Dns {
-    IP: string;
-}
+export * from './BlockcoreDns.js';
+export * from './types.js';

package/dist/index.js

@@ -1 +1,2 @@
-export {};
+export * from './BlockcoreDns.js';
+export * from './types.js';

package/dist/types.d.ts

@@ -0,0 +1,14 @@
+export interface DnsListEntry {
+    url: string;
+    contact: string;
+}
+export interface ServiceListEntry {
+    domain: string;
+    symbol: string;
+    service: string;
+    ttl: number;
+    online: boolean;
+}
+export interface BlockcoreDnsOptions {
+    baseUrl: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockcore/dns",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/options.d.ts

@@ -1,3 +0,0 @@
-export interface BlockcoreDnsOptions {
-    baseUrl: string;
-}