@blockcore/dns 0.0.2 → 0.0.5

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/lib/BlockcoreDns.d.ts

@@ -0,0 +1,12 @@
+import { DnsListEntry, ServiceListEntry } from './types.js';
+export declare class BlockcoreDns {
+    /** Call this to have data to provide an instance of the Blockcore DNS. */
+    static getDnsServers(): Promise<DnsListEntry[]>;
+    private activeServer?;
+    constructor(nameserver: string);
+    setActiveServer(url: string): void;
+    getServicesByType(service: 'Indexer' | 'Explorer'): Promise<ServiceListEntry[]>;
+    getServicesByTypeAndNetwork(service: 'Indexer' | 'Explorer', symbol: string): Promise<ServiceListEntry[]>;
+    getServicesByNetwork(symbol: string): Promise<ServiceListEntry[]>;
+    getExternalIP(): Promise<string>;
+}

package/lib/BlockcoreDns.js

@@ -0,0 +1,37 @@
+import { WebRequest } from './Request.js';
+export class BlockcoreDns {
+    constructor(nameserver) {
+        Object.defineProperty(this, "activeServer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.setActiveServer(nameserver);
+    }
+    /** Call this to have data to provide an instance of the Blockcore DNS. */
+    static async getDnsServers() {
+        const url = `https://chains.blockcore.net/services/DNS.json`;
+        const servers = await WebRequest.fetchJson(url);
+        return servers;
+    }
+    setActiveServer(url) {
+        this.activeServer = url;
+    }
+    async getServicesByType(service) {
+        const url = `${this.activeServer}/api/dns/services/service/${service}`;
+        return await WebRequest.fetchJson(url);
+    }
+    async getServicesByTypeAndNetwork(service, symbol) {
+        const url = `${this.activeServer}/api/dns/services/symbol/${symbol}/service/${service}`;
+        return await WebRequest.fetchJson(url);
+    }
+    async getServicesByNetwork(symbol) {
+        const url = `${this.activeServer}/api/dns/services/symbol/${symbol}`;
+        return await WebRequest.fetchJson(url);
+    }
+    async getExternalIP() {
+        const url = `${this.activeServer}/api/dns/ipaddress`;
+        return await WebRequest.fetchText(url);
+    }
+}

package/lib/Request.d.ts

@@ -0,0 +1,6 @@
+import { Response } from 'node-fetch';
+export declare class WebRequest {
+    static fetchText(url: string): Promise<string>;
+    static fetchJson<T>(url: string): Promise<T>;
+    static fetchUrl(url: string): Promise<Response>;
+}

package/lib/Request.js

@@ -0,0 +1,24 @@
+import fetch from 'node-fetch';
+export class WebRequest {
+    static async fetchText(url) {
+        const response = await WebRequest.fetchUrl(url);
+        return response.text();
+    }
+    static async fetchJson(url) {
+        const response = await WebRequest.fetchUrl(url);
+        return response.json();
+    }
+    static async fetchUrl(url) {
+        return await fetch(url, {
+            method: 'GET',
+            // mode: 'cors',
+            // cache: 'no-cache',
+            // credentials: 'same-origin',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            redirect: 'follow',
+            referrerPolicy: 'no-referrer',
+        });
+    }
+}

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/types.d.ts

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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@blockcore/dns",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "type": "module",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "exports": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
-    "dist"
+    "lib/**/*"
   ],
   "engines": {
     "node": ">=14.16"
@@ -52,7 +52,7 @@
     ]
   },
   "dependencies": {
-    "axios": "^0.27.2",
+    "@blockcore/identity": "^0.0.1",
     "node-fetch": "^3.2.9"
   }
 }

package/dist/BlockcoreDns.d.ts

@@ -1,8 +0,0 @@
-import { BlockcoreDnsOptions } from './options.js';
-export declare class BlockcoreDns {
-    private options;
-    static defaultOptions: BlockcoreDnsOptions;
-    static create(): BlockcoreDns;
-    constructor(options?: BlockcoreDnsOptions);
-    getDnsServers(): Promise<unknown>;
-}

package/dist/BlockcoreDns.js

@@ -1,39 +0,0 @@
-import fetch from 'node-fetch';
-export class BlockcoreDns {
-    constructor(options = BlockcoreDns.defaultOptions) {
-        Object.defineProperty(this, "options", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: options
-        });
-    }
-    static create() {
-        const dns = new BlockcoreDns();
-        return dns;
-    }
-    async getDnsServers() {
-        const url = `${this.options.baseUrl}/services/BLOCKCORE-DNS.json`;
-        const response = await fetch(url, {
-            method: 'GET',
-            // mode: 'cors',
-            // cache: 'no-cache',
-            // credentials: 'same-origin',
-            headers: {
-                'Content-Type': 'application/json',
-            },
-            redirect: 'follow',
-            referrerPolicy: 'no-referrer',
-        });
-        const servers = await response.json();
-        return servers;
-    }
-}
-Object.defineProperty(BlockcoreDns, "defaultOptions", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: {
-        baseUrl: 'https://chains.blockcore.net',
-    }
-});

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export interface Dns {
-    IP: string;
-}

package/dist/options.d.ts

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

package/dist/options.js

@@ -1 +0,0 @@
-export {};