@xrplkit/xls26 2.0.0 → 2.1.0

package/package.json

@@ -1,12 +1,19 @@
 {
     "name": "@xrplkit/xls26",
     "type": "module",
-    "version": "2.0.0",
+    "version": "2.1.0",
     "main": "xls26.js",
     "dependencies": {
         "@xrplkit/toml": "1.0.0"
     },
     "publishConfig": {
         "access": "public"
-    }
+    },
+    "keywords": [
+        "xrpl",
+        "xls-26",
+        "parser",
+        "metadata",
+        "tokens"
+    ]
 }

package/readme.md

@@ -7,7 +7,7 @@ This package exports one single function called `parse` that converts the string
 ## Example
 Assuming you have a file named `xrp-ledger.toml` in the current working directory. An example file can be found below.
 
-```
+```javascript
 import fs from 'fs'
 import { parse } from '@xrplkit/xls26'
 
@@ -20,7 +20,7 @@ console.log(xls26Data)
 
 ### Example File
 
-```
+```toml
 [[ISSUERS]]
 address = "rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr"
 name = "CasinoCoin"
@@ -45,35 +45,35 @@ type = "socialmedia"
 
 ### Example Output
 
-```
+```javascript
 {
-	issuers: [
-		{
-			address: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
-			name: 'CasinoCoin'
-		}
-	],
-	tokens: [
-		{
-			currency: 'CSC',
-			issuer: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
-			name: 'CasinoCoin',
-			desc: 'CasinoCoin (CSC) is a digital currency, developed specifically for the regulated gaming industry.',
-			icon: 'https://static.xrplmeta.org/icons/csc.png',
-			weblinks: [
-				{
-					url: 'https://casinocoin.im',
-					type: 'website',
-					title: 'Official Website'
-				},
-				{
-					url: 'https://twitter.com/CasinoCoin', 
-					type: 'socialmedia' 
-				}
-			]
-		}
-	],
-	issues: []
+    issuers: [
+        {
+            address: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
+            name: 'CasinoCoin'
+        }
+    ],
+    tokens: [
+        {
+            currency: 'CSC',
+            issuer: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
+            name: 'CasinoCoin',
+            desc: 'CasinoCoin (CSC) is a digital currency, developed specifically for the regulated gaming industry.',
+            icon: 'https://static.xrplmeta.org/icons/csc.png',
+            weblinks: [
+                {
+                    url: 'https://casinocoin.im',
+                    type: 'website',
+                    title: 'Official Website'
+                },
+                {
+                    url: 'https://twitter.com/CasinoCoin', 
+                    type: 'socialmedia' 
+                }
+            ]
+        }
+    ],
+    issues: []
 }
 
 ```

package/xls26.js

@@ -39,6 +39,13 @@ const issuerFields = [
 				throw 'has to be a non empty string'
 		}
 	},
+	{
+		key: 'domain',
+		validate: v => {
+			if(typeof v !== 'string' || v.length === 0)
+				throw 'has to be a non empty string'
+		}
+	},
 	{
 		key: 'icon',
 		alternativeKeys: ['avatar'],
@@ -139,7 +146,7 @@ const weblinkFields = [
 
 export function parse(str){
 	try{
-		var toml = parseToml(str, 'camelCase')
+		var toml = parseToml(str)
 	}catch(error){
 		throw new Error(`Failed to parse .toml: Syntax error at line ${error.line}:${error.column}`)
 	}
@@ -148,8 +155,9 @@ export function parse(str){
 	let tokens = []
 	let issues = []
 
-	if(toml.issuers){
-		for(let stanza of toml.issuers){
+
+	if(toml.ISSUERS){
+		for(let stanza of toml.ISSUERS){
 			let { valid, parsed: issuer, issues: issuerIssues } = parseStanza(stanza, issuerFields)
 
 			if(valid)
@@ -161,13 +169,13 @@ export function parse(str){
 				)
 			)
 
-			if(valid && stanza.weblinks){
-				for(let substanza of stanza.weblinks){
+			if(valid && stanza.WEBLINKS){
+				for(let substanza of stanza.WEBLINKS){
 					let { valid, parsed: weblink, issues: weblinkIssues } = parseStanza(substanza, weblinkFields)
 
 					if(valid){
 						issuer.weblinks = [
-							...(token.weblinks || []),
+							...(issuer.weblinks || []),
 							weblink
 						]
 					}
@@ -182,8 +190,8 @@ export function parse(str){
 		}
 	}
 
-	if(toml.tokens){
-		for(let stanza of toml.tokens){
+	if(toml.TOKENS){
+		for(let stanza of toml.TOKENS){
 			let { valid, parsed: token, issues: tokenIssues } = parseStanza(stanza, tokenFields)
 
 			if(valid)
@@ -195,8 +203,8 @@ export function parse(str){
 				)
 			)
 
-			if(valid && stanza.weblinks){
-				for(let substanza of stanza.weblinks){
+			if(valid && stanza.WEBLINKS){
+				for(let substanza of stanza.WEBLINKS){
 					let { valid, parsed: weblink, issues: weblinkIssues } = parseStanza(substanza, weblinkFields)
 
 					if(valid){
@@ -236,7 +244,7 @@ function parseStanza(stanza, schemas){
 			keys.push(...alternativeKeys)
 
 		for(let k of keys){
-			if(!stanza.hasOwnProperty(k))
+			if(stanza[k] === undefined)
 				continue
 
 			let value = stanza[k]
@@ -254,7 +262,7 @@ function parseStanza(stanza, schemas){
 			break
 		}
 
-		if(essential && !parsed.hasOwnProperty(key)){
+		if(essential && parsed[key] === undefined){
 			issues.push(`${key} field missing: skipping stanza`)
 			valid = false
 		}