@hauska-sdk/vda 0.1.0

package/dist/validation.js

@@ -0,0 +1,203 @@
+/**
+ * @hauska-sdk/vda
+ * VDA Metadata Validation
+ */
+/**
+ * Valid asset types
+ */
+export const VALID_ASSET_TYPES = [
+    "deed",
+    "blueprint",
+    "permit",
+    "contract",
+    "health-record",
+    "well-log",
+    "access-pass",
+    "invoice",
+];
+/**
+ * Valid spoke types
+ */
+export const VALID_SPOKE_TYPES = [
+    "real-estate",
+    "healthcare",
+    "oil-gas",
+    "architect",
+    "municipal",
+];
+/**
+ * Valid permission types
+ */
+export const VALID_PERMISSION_TYPES = [
+    "view",
+    "download",
+    "write",
+    "annotate",
+];
+/**
+ * Validate VDA metadata
+ */
+export function validateVDAMetadata(metadata) {
+    const errors = [];
+    // Validate assetId
+    if (!metadata.assetId) {
+        errors.push({
+            field: "assetId",
+            message: "Asset ID is required",
+        });
+    }
+    else if (typeof metadata.assetId !== "string" || metadata.assetId.trim() === "") {
+        errors.push({
+            field: "assetId",
+            message: "Asset ID must be a non-empty string",
+        });
+    }
+    // Validate assetType
+    if (!metadata.assetType) {
+        errors.push({
+            field: "assetType",
+            message: "Asset type is required",
+        });
+    }
+    else if (!VALID_ASSET_TYPES.includes(metadata.assetType)) {
+        errors.push({
+            field: "assetType",
+            message: `Invalid asset type. Must be one of: ${VALID_ASSET_TYPES.join(", ")}`,
+        });
+    }
+    // Validate universal metadata (at least one required)
+    const hasUniversalKey = metadata.address || metadata.legalDesc || metadata.patientId || metadata.api14;
+    if (!hasUniversalKey) {
+        errors.push({
+            field: "universalMetadata",
+            message: "At least one universal metadata key is required (address, legalDesc, patientId, or api14)",
+        });
+    }
+    // Validate ownerWallet
+    if (!metadata.ownerWallet) {
+        errors.push({
+            field: "ownerWallet",
+            message: "Owner wallet is required",
+        });
+    }
+    else if (!isValidEthereumAddress(metadata.ownerWallet)) {
+        errors.push({
+            field: "ownerWallet",
+            message: "Owner wallet must be a valid Ethereum address",
+        });
+    }
+    // Validate spoke
+    if (!metadata.spoke) {
+        errors.push({
+            field: "spoke",
+            message: "Spoke is required",
+        });
+    }
+    else if (!VALID_SPOKE_TYPES.includes(metadata.spoke)) {
+        errors.push({
+            field: "spoke",
+            message: `Invalid spoke. Must be one of: ${VALID_SPOKE_TYPES.join(", ")}`,
+        });
+    }
+    // Validate access pass fields (if assetType is access-pass)
+    if (metadata.assetType === "access-pass") {
+        if (!metadata.expiry) {
+            errors.push({
+                field: "expiry",
+                message: "Expiry is required for access pass VDAs",
+            });
+        }
+        else if (metadata.expiry <= Date.now()) {
+            errors.push({
+                field: "expiry",
+                message: "Expiry must be in the future",
+            });
+        }
+        if (!metadata.accessibleVDAs || metadata.accessibleVDAs.length === 0) {
+            errors.push({
+                field: "accessibleVDAs",
+                message: "Accessible VDAs array is required for access pass VDAs",
+            });
+        }
+        if (!metadata.permissions || metadata.permissions.length === 0) {
+            errors.push({
+                field: "permissions",
+                message: "Permissions array is required for access pass VDAs",
+            });
+        }
+        else {
+            // Validate each permission
+            for (const permission of metadata.permissions) {
+                if (!VALID_PERMISSION_TYPES.includes(permission)) {
+                    errors.push({
+                        field: "permissions",
+                        message: `Invalid permission: ${permission}. Must be one of: ${VALID_PERMISSION_TYPES.join(", ")}`,
+                    });
+                }
+            }
+        }
+        // Validate grantorWallet for access passes
+        if (!metadata.grantorWallet) {
+            errors.push({
+                field: "grantorWallet",
+                message: "Grantor wallet is required for access pass VDAs",
+            });
+        }
+        else if (!isValidEthereumAddress(metadata.grantorWallet)) {
+            errors.push({
+                field: "grantorWallet",
+                message: "Grantor wallet must be a valid Ethereum address",
+            });
+        }
+    }
+    // Validate timestamps
+    if (metadata.createdAt !== undefined && typeof metadata.createdAt !== "number") {
+        errors.push({
+            field: "createdAt",
+            message: "Created at must be a number (Unix timestamp)",
+        });
+    }
+    if (metadata.updatedAt !== undefined && typeof metadata.updatedAt !== "number") {
+        errors.push({
+            field: "updatedAt",
+            message: "Updated at must be a number (Unix timestamp)",
+        });
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+    };
+}
+/**
+ * Validate Ethereum address format
+ */
+function isValidEthereumAddress(address) {
+    // Ethereum address: 0x followed by 40 hex characters
+    return /^0x[a-fA-F0-9]{40}$/.test(address);
+}
+/**
+ * Normalize address for search (basic normalization)
+ */
+export function normalizeAddress(address) {
+    // Convert to lowercase and trim
+    return address.toLowerCase().trim();
+}
+/**
+ * Check if metadata has required universal key for spoke
+ */
+export function hasRequiredUniversalKey(metadata, spoke) {
+    switch (spoke) {
+        case "real-estate":
+            return !!(metadata.address || metadata.legalDesc);
+        case "healthcare":
+            return !!metadata.patientId;
+        case "oil-gas":
+            return !!metadata.api14;
+        case "architect":
+        case "municipal":
+            return !!(metadata.address || metadata.legalDesc);
+        default:
+            return !!(metadata.address || metadata.legalDesc || metadata.patientId || metadata.api14);
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAgB;IAC5C,MAAM;IACN,WAAW;IACX,QAAQ;IACR,UAAU;IACV,eAAe;IACf,UAAU;IACV,aAAa;IACb,SAAS;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAgB;IAC5C,aAAa;IACb,YAAY;IACZ,SAAS;IACT,WAAW;IACX,WAAW;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAqB;IACtD,MAAM;IACN,UAAU;IACV,OAAO;IACP,UAAU;CACX,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAA8B;IAIhE,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,mBAAmB;IACnB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,sBAAsB;SAChC,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAClF,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,qCAAqC;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,qBAAqB;IACrB,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,wBAAwB;SAClC,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAsB,CAAC,EAAE,CAAC;QACxE,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,uCAAuC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IACtD,MAAM,eAAe,GACnB,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC;IAEjF,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,mBAAmB;YAC1B,OAAO,EACL,2FAA2F;SAC9F,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,+CAA+C;SACzD,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,mBAAmB;SAC7B,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAkB,CAAC,EAAE,CAAC;QACpE,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,kCAAkC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC1E,CAAC,CAAC;IACL,CAAC;IAED,4DAA4D;IAC5D,IAAI,QAAQ,CAAC,SAAS,KAAK,aAAa,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,QAAQ;gBACf,OAAO,EAAE,yCAAyC;aACnD,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,QAAQ;gBACf,OAAO,EAAE,8BAA8B;aACxC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrE,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,gBAAgB;gBACvB,OAAO,EAAE,wDAAwD;aAClE,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,aAAa;gBACpB,OAAO,EAAE,oDAAoD;aAC9D,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,2BAA2B;YAC3B,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;gBAC9C,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,UAA4B,CAAC,EAAE,CAAC;oBACnE,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,aAAa;wBACpB,OAAO,EAAE,uBAAuB,UAAU,qBAAqB,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;qBACnG,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,2CAA2C;QAC3C,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,iDAAiD;aAC3D,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3D,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,iDAAiD;aAC3D,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,sBAAsB;IACtB,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,QAAQ,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC/E,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,8CAA8C;SACxD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,QAAQ,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC/E,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,8CAA8C;SACxD,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,OAAe;IAC7C,qDAAqD;IACrD,OAAO,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,gCAAgC;IAChC,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAA8B,EAC9B,KAAgB;IAEhB,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,aAAa;YAChB,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpD,KAAK,YAAY;YACf,OAAO,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC9B,KAAK,SAAS;YACZ,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1B,KAAK,WAAW,CAAC;QACjB,KAAK,WAAW;YACd,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpD;YACE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@hauska-sdk/vda",
+  "version": "0.1.0",
+  "description": "CNS Protocol VDA SDK - Verified Digital Assets management",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@hauska-sdk/wallet": "^0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "rimraf": "^5.0.5",
+    "vitest": "^4.0.18"
+  },
+  "keywords": [
+    "cns-protocol",
+    "vda",
+    "digital-assets",
+    "ownership",
+    "verified-digital-assets",
+    "metadata",
+    "access-control"
+  ],
+  "author": "Hauska SDK Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hauska-sdk/hauska-sdk.git",
+    "directory": "packages/vda"
+  },
+  "bugs": {
+    "url": "https://github.com/hauska-sdk/hauska-sdk/issues"
+  },
+  "homepage": "https://github.com/hauska-sdk/hauska-sdk#readme",
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=9.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}