Merge pull request #76 from Cardano-Forge/feat/MET-68

Remove CIPs rules
Cardano-Forge · Oct 21, 2024 · 24bc63f · 24bc63f
2 parents 7d59b8c + 75a8199
commit 24bc63f
Show file tree

Hide file tree

Showing 33 changed files with 31 additions and 175 deletions.
diff --git a/core/validator/deno.json b/core/validator/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@ada-anvil/metadraft-validator",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "exports": "./src/mod.ts",
   "imports": {
     "@deno/dnt": "jsr:@deno/dnt@^0.41.2",

diff --git a/core/validator/src/mapping.ts b/core/validator/src/mapping.ts
@@ -1,5 +1,3 @@
-import { Cip25Version1 } from "./rules/cip-25-version-1.ts";
-import { Cip25Version2 } from "./rules/cip-25-version-2.ts";
 import { CompareAttributesKeys } from "./rules/compare-attributes-keys.ts";
 import { CompareRootKeys } from "./rules/compare-root-keys.ts";
 import { CompareRootValues } from "./rules/compare-root-values.ts";
@@ -31,8 +29,6 @@ export { DuplicateImage } from "./rules/duplicate-image.ts";
 export { DuplicateName } from "./rules/duplicate-name.ts";
 
 export const mapping = {
-  cip25Version1: Cip25Version1,
-  cip25Version2: Cip25Version2,
   compareAttributesKeys: CompareAttributesKeys,
   compareRootKeys: CompareRootKeys,
   compareRootValues: CompareRootValues,

diff --git a/core/validator/src/mod.ts b/core/validator/src/mod.ts
@@ -6,8 +6,6 @@ export { split } from "./format/split.ts";
 
 export * from "./utils/types.ts";
 
-export { Cip25Version1 } from "./rules/cip-25-version-1.ts";
-export { Cip25Version2 } from "./rules/cip-25-version-2.ts";
 export { CompareAttributesKeys } from "./rules/compare-attributes-keys.ts";
 export { CompareRootKeys } from "./rules/compare-root-keys.ts";
 export { CompareRootValues } from "./rules/compare-root-values.ts";

diff --git a/core/validator/src/reader/readers/csv.ts b/core/validator/src/reader/readers/csv.ts
@@ -45,7 +45,7 @@ export class CsvReader extends BaseReader {
    * @param {string} pathOrData - The file path containing CSV data or the CSV data as a string.
    * @return {DataRead[]} An array of objects representing the parsed CSV data.
    */
-  Load(pathOrData: string): DataRead[] {
+  override Load(pathOrData: string): DataRead[] {
     const reader = csvToJson
       .formatValueByType(this.options.valueByType)
       .fieldDelimiter(this.options.delimiter)
@@ -66,7 +66,7 @@ export class CsvReader extends BaseReader {
    *
    * @return {DataRead[] | null} The read CSV data.
    */
-  Read(): DataRead[] | null {
+  override Read(): DataRead[] | null {
     return this.data;
   }
 }
diff --git a/core/validator/src/reader/readers/json.ts b/core/validator/src/reader/readers/json.ts
@@ -23,7 +23,7 @@ export class JsonReader extends BaseReader {
    * @param {string} pathOrData - The file path containing JSON data or the JSON data as a string.
    * @return {DataRead[]} The loaded JSON data as an object.
    */
-  Load(pathOrData: string): DataRead[] {
+  override Load(pathOrData: string): DataRead[] {
     if (isValidPath(pathOrData)) {
       this.data = JSON.parse(readFileSync(pathOrData, "utf8"));
     } else {
@@ -38,7 +38,7 @@ export class JsonReader extends BaseReader {
    *
    * @return {DataRead[] | null} The read JSON data.
    */
-  Read(): DataRead[] | null {
+  override Read(): DataRead[] | null {
     return this.data;
   }
 }
diff --git a/core/validator/src/rules/cip-25-version-1.ts b/core/validator/src/rules/cip-25-version-1.ts
diff --git a/core/validator/src/rules/cip-25-version-2.ts b/core/validator/src/rules/cip-25-version-2.ts
diff --git a/core/validator/src/rules/compare-attributes-keys.ts b/core/validator/src/rules/compare-attributes-keys.ts
@@ -39,7 +39,7 @@ export class CompareAttributesKeys extends BaseValidator {
    * @param _metadatas - An array of metadata objects, currently unused but provided for consistency with other validators.
    * @returns An array of results from validation checks.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/compare-root-keys.ts b/core/validator/src/rules/compare-root-keys.ts
@@ -38,7 +38,7 @@ export class CompareRootKeys extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas (not used in this validator).
    * @returns {StateOutput} An array containing the validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/compare-root-values.ts b/core/validator/src/rules/compare-root-values.ts
@@ -41,7 +41,7 @@ export class CompareRootValues extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas (not used in this validator).
    * @returns {StateOutput} An array containing the validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/duplicate-asset-name.ts b/core/validator/src/rules/duplicate-asset-name.ts
@@ -31,7 +31,7 @@ export class DuplicateAssetName extends BaseValidator {
    * @param {Record<string, StateOutput>} validations - An object of all validations made.
    * @returns {Record<string, StateOutput>} An array containing the validation results.
    */
-  ExecuteOnce(
+  override ExecuteOnce(
     metadatas: object[],
     validations: Record<string, StateOutput>
   ): Record<string, StateOutput> {

diff --git a/core/validator/src/rules/duplicate-image.ts b/core/validator/src/rules/duplicate-image.ts
@@ -31,7 +31,7 @@ export class DuplicateImage extends BaseValidator {
    * @param {Record<string, StateOutput>} validations - An object of all validations made.
    * @returns {Record<string, StateOutput>} An array containing the validation results.
    */
-  ExecuteOnce(
+  override ExecuteOnce(
     metadatas: object[],
     validations: Record<string, StateOutput>
   ): Record<string, StateOutput> {

diff --git a/core/validator/src/rules/duplicate-keys.ts b/core/validator/src/rules/duplicate-keys.ts
@@ -43,7 +43,7 @@ export class DuplicateKeys extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas, currently not used.
    * @returns {StateOutput} - An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/duplicate-name-and-image.ts b/core/validator/src/rules/duplicate-name-and-image.ts
@@ -31,7 +31,7 @@ export class DuplicateNameAndImage extends BaseValidator {
    * @param {Record<string, StateOutput>} validations - An object of all validations made.
    * @returns {Record<string, StateOutput>} An array containing the validation results.
    */
-  ExecuteOnce(
+  override ExecuteOnce(
     metadatas: object[],
     validations: Record<string, StateOutput>
   ): Record<string, StateOutput> {

diff --git a/core/validator/src/rules/duplicate-name.ts b/core/validator/src/rules/duplicate-name.ts
@@ -31,7 +31,7 @@ export class DuplicateName extends BaseValidator {
    * @param {Record<string, StateOutput>} validations - An object of all validations made.
    * @returns {Record<string, StateOutput>} An array containing the validation results.
    */
-  ExecuteOnce(
+  override ExecuteOnce(
     metadatas: object[],
     validations: Record<string, StateOutput>
   ): Record<string, StateOutput> {

diff --git a/core/validator/src/rules/has-required-keys.ts b/core/validator/src/rules/has-required-keys.ts
@@ -32,7 +32,7 @@ export class HasRequiredKeys extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas, currently not used.
    * @returns {StateOutput} - An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-alphanumeric.ts b/core/validator/src/rules/key-alphanumeric.ts
@@ -35,7 +35,7 @@ export class KeyAlphanumeric extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas, currently not used.
    * @returns {StateOutput} - An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-anvil-case.ts b/core/validator/src/rules/key-anvil-case.ts
@@ -36,7 +36,7 @@ export class KeyAnvilCase extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas, currently not used.
    * @returns {StateOutput} - An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-attributes.ts b/core/validator/src/rules/key-attributes.ts
@@ -33,7 +33,7 @@ export class KeyAttributes extends BaseValidator {
    * @param {unknown[]} _metadatas - An array of all metadatas, currently not used.
    * @returns {StateOutput} - An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[],

diff --git a/core/validator/src/rules/key-camel-case.ts b/core/validator/src/rules/key-camel-case.ts
@@ -35,7 +35,7 @@ export class KeyCamelCase extends BaseValidator {
    * @param {unknown[]} _metadatas - The list of all metadatas (not used in this validator).
    * @returns {StateOutput} An array containing the validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-description.ts b/core/validator/src/rules/key-description.ts
@@ -34,7 +34,7 @@ export class KeyDescription extends BaseValidator {
    * @param _metadatas - Ignored; included for compatibility with BaseValidator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-files.ts b/core/validator/src/rules/key-files.ts
@@ -34,7 +34,7 @@ export class KeyFiles extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-image.ts b/core/validator/src/rules/key-image.ts
@@ -34,7 +34,7 @@ export class KeyImage extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-length.ts b/core/validator/src/rules/key-length.ts
@@ -36,7 +36,7 @@ export class KeyLength extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-lower-case.ts b/core/validator/src/rules/key-lower-case.ts
@@ -36,7 +36,7 @@ export class KeyLowerCase extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-media-type.ts b/core/validator/src/rules/key-media-type.ts
@@ -33,7 +33,7 @@ export class KeyMediaType extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-media.ts b/core/validator/src/rules/key-media.ts
@@ -33,7 +33,7 @@ export class KeyMedia extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]

diff --git a/core/validator/src/rules/key-name.ts b/core/validator/src/rules/key-name.ts
@@ -33,7 +33,7 @@ export class KeyName extends BaseValidator {
    * @param _metadatas - An array of metadata objects, ignored in this validator.
    * @returns {StateOutput} An array of validation results.
    */
-  Execute(
+  override Execute(
     assetName: string,
     metadata: unknown,
     _metadatas: unknown[]