Upgrade to 0.3.0

Author: earrietadev

CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file. See
 [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.3.0] (2025-05-01)
+
+### Add
+
+- Include new static method `isValidDomain`
+
 ### [0.2.0] (2025-03-30)
 
 ### Change

README.md

@@ -4,8 +4,9 @@ protocol
 ## Installation
 
 ```shell
-npm i @creit.tech/sorobandomains-sdk
+npx jsr add @creit-tech/sorobandomains-sdk
 ```
+> If you are using another tool like Deno, Bun or PNPM; check the installation instructions [here](https://jsr.io/@creit-tech/sorobandomains-sdk). 
 
 ## The SorobanDomainsSDK class
 

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@creit-tech/sorobandomains-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "An SDK to easily fetch domains from the sorobandomains.org protocol",
   "license": "MIT",
   "author": {

src/sdk.test.ts

@@ -21,4 +21,17 @@ describe("Basic logic", (): void => {
     const generatedSubNode: string = SorobanDomainsSDK.parseDomain({ domain: "stellar", subDomain: "payments" });
     assertEquals(expectedSubNode, generatedSubNode);
   });
+
+  test("It should validate domains correctly", (): void => {
+    assertEquals(true, SorobanDomainsSDK.isValidDomain('stellar.xlm'));
+    assertEquals(true, SorobanDomainsSDK.isValidDomain('dev.stellar.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('another.dev.stellar.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('stellar'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('stellar..xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain(' stellar.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('qwertyuiopasdfghjklzxcvbnm.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('hello-world.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('steLLar.xlm'));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain('ste11ar.xlm'));
+  });
 });

src/sdk.ts

@@ -44,6 +44,20 @@ export class SorobanDomainsSDK {
     }
   }
 
+  /**
+   * This method validates a domain string follow certain criteria required by the registry contract.
+   * NOTE: It does not validate wrong TLDs
+   *
+   * @param domain {String} - The domain to validate, for example: stellar.xlm
+   */
+  static isValidDomain(domain: string): boolean {
+    const domainRegex: RegExp = new RegExp('^[a-z]+(\\.[a-z]+)*\\.[a-z]{2,}$');
+    if (!domainRegex.test(domain)) return false;
+    const parts: string[] = domain.split('.');
+    if (parts.length > 3) return false;
+    return parts.every((part: string): boolean => part.length <= 15);
+  }
+
   /**
    * This function parses the domain you want to use, and it will search it in the contract.
    * This function doesn't validate the domain you're providing is a valid one.