@traittech/traits-validator-2 0.1.1

package/README.md

@@ -0,0 +1,19 @@
+## @trevo-finance/traits-validator
+
+Lightweight helper over the Trevo Traits Registry.
+
+### What it does
+
+- bundles `traits/` JSON Schemas into a single `registry.json`;
+- exposes `validateMetadata(payload)` and `validateTraits(payload, registry?, traitsToValidate?)`;
+- ships both ESM and CJS builds so it can run in Token Studio, Trevo Wallet or backend tooling.
+
+### Development
+
+```
+yarn install
+yarn build
+```
+
+`yarn build` will re-generate `schemes/registry.json` + `schemes/metadata_schema.json` before compiling TypeScript.
+

package/dist/cjs/index.d.ts

@@ -0,0 +1,7 @@
+import type { JsonMetadata, Registry } from './types.js';
+import metadataSchema from '../schemes/metadata_schema.json';
+import registry from '../schemes/registry.json';
+export declare const validateMetadata: (data: JsonMetadata) => boolean;
+export declare const validateTraits: (data: JsonMetadata, bundle?: Registry, traitsToValidate?: string[]) => string[];
+export { metadataSchema, registry };
+export * from './types.js';

package/dist/cjs/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registry = exports.metadataSchema = exports.validateTraits = exports.validateMetadata = void 0;
+const _2020_js_1 = __importDefault(require("ajv/dist/2020.js"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const metadata_schema_json_1 = __importDefault(require("../schemes/metadata_schema.json"));
+exports.metadataSchema = metadata_schema_json_1.default;
+const registry_json_1 = __importDefault(require("../schemes/registry.json"));
+exports.registry = registry_json_1.default;
+const ajv = new _2020_js_1.default({ allErrors: true, strict: false });
+(0, ajv_formats_1.default)(ajv);
+const metadataValidate = ajv.compile(metadata_schema_json_1.default);
+const validateMetadata = (data) => metadataValidate(data);
+exports.validateMetadata = validateMetadata;
+const validateTraits = (data, bundle = registry_json_1.default, traitsToValidate) => {
+    if (!(0, exports.validateMetadata)(data)) {
+        throw new Error('Metadata payload is invalid');
+    }
+    const traitIds = traitsToValidate ?? Object.keys(data.traits || {});
+    return traitIds.filter((traitId) => {
+        const traitSchema = bundle[traitId];
+        const traitValue = data.traits?.[traitId];
+        if (!traitSchema || !traitValue) {
+            return false;
+        }
+        const validate = ajv.compile(traitSchema);
+        return validate(traitValue);
+    });
+};
+exports.validateTraits = validateTraits;
+__exportStar(require("./types.js"), exports);

package/dist/cjs/types.d.ts

@@ -0,0 +1,8 @@
+export type JsonSchema = Record<string, unknown>;
+export type Registry = Record<string, JsonSchema>;
+export type JsonMetadata = {
+    metadata_id: string;
+    title: string;
+    description?: string;
+    traits: Record<string, Record<string, unknown>>;
+};

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+import type { JsonMetadata, Registry } from './types.js';
+import metadataSchema from '../schemes/metadata_schema.json';
+import registry from '../schemes/registry.json';
+export declare const validateMetadata: (data: JsonMetadata) => boolean;
+export declare const validateTraits: (data: JsonMetadata, bundle?: Registry, traitsToValidate?: string[]) => string[];
+export { metadataSchema, registry };
+export * from './types.js';

package/dist/esm/index.js

@@ -0,0 +1,25 @@
+import Ajv2020 from 'ajv/dist/2020.js';
+import addFormats from 'ajv-formats';
+import metadataSchema from '../schemes/metadata_schema.json';
+import registry from '../schemes/registry.json';
+const ajv = new Ajv2020({ allErrors: true, strict: false });
+addFormats(ajv);
+const metadataValidate = ajv.compile(metadataSchema);
+export const validateMetadata = (data) => metadataValidate(data);
+export const validateTraits = (data, bundle = registry, traitsToValidate) => {
+    if (!validateMetadata(data)) {
+        throw new Error('Metadata payload is invalid');
+    }
+    const traitIds = traitsToValidate ?? Object.keys(data.traits || {});
+    return traitIds.filter((traitId) => {
+        const traitSchema = bundle[traitId];
+        const traitValue = data.traits?.[traitId];
+        if (!traitSchema || !traitValue) {
+            return false;
+        }
+        const validate = ajv.compile(traitSchema);
+        return validate(traitValue);
+    });
+};
+export { metadataSchema, registry };
+export * from './types.js';

package/dist/esm/types.d.ts

@@ -0,0 +1,8 @@
+export type JsonSchema = Record<string, unknown>;
+export type Registry = Record<string, JsonSchema>;
+export type JsonMetadata = {
+    metadata_id: string;
+    title: string;
+    description?: string;
+    traits: Record<string, Record<string, unknown>>;
+};

package/dist/esm/types.js

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

package/dist/schemes/metadata_schema.json

@@ -0,0 +1,41 @@
+{
+    "$id": "https://trevo-finance.github.io/trevo-traits-registry/traits/metadata_schema.json",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": "Metadata of on-chain entity",
+    "description": "Metadata of an on-chain entity, such as token, NFT, AppAgent etc.",
+    "type": "object",
+    "properties": {
+      "metadata_id": {
+        "description": "The identifier of the document with metadata. Depending on the context, this can be an identifier of on-chain entity, that metadata annotates. Or it can be an application-specific identifier.",
+        "type": "string",
+        "minLength": 5,
+        "maxLength": 128
+      },
+      "title": {
+        "description": "The human readable title of the document with metadata.",
+        "type": "string",
+        "minLength": 5,
+        "maxLength": 128
+      },
+      "description": {
+        "description": "The human readable description of the metadata document.",
+        "type": "string",
+        "maxLength": 1024
+      },
+      "traits": {
+        "description": "The list of traits supported by on-chain entity, that is annotated with this metadata document.",
+        "type": "object",
+        "minProperties": 1,
+        "propertyNames": {
+          "type": "string",
+          "minLength": 5,
+          "maxLength": 128
+        },
+        "patternProperties": {
+          "^.*$": { "type": "object" }
+        }
+      }
+    },
+    "required": [ "metadata_id", "title", "traits" ],
+    "additionalProperties": false
+}