@xyo-network/crypto-nft-diviner-score-plugin 5.3.2 → 5.3.4

package/dist/node/lib/rating/criteria/scoring/metadata/youtubeUrl.d.ts

@@ -0,0 +1,5 @@
+import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin';
+import type { ScaledScore } from '@xyo-network/crypto-nft-score-model';
+export declare const scoreNftYoutubeUrl: (nft: NftInfoFields | OpenSeaNftInfoFields) => ScaledScore;
+export declare const scoreYoutubeUrl: (youtube_url: unknown) => ScaledScore;
+//# sourceMappingURL=youtubeUrl.d.ts.map

package/dist/node/lib/rating/criteria/scoring/metadata/youtubeUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"youtubeUrl.d.ts","sourceRoot":"","sources":["../../../../../../../src/lib/rating/criteria/scoring/metadata/youtubeUrl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAA;AACjG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAA;AAKtE,eAAO,MAAM,kBAAkB,GAAI,KAAK,aAAa,GAAG,oBAAoB,KAAG,WAE9E,CAAA;AACD,eAAO,MAAM,eAAe,GAAI,aAAa,OAAO,KAAG,WAOtD,CAAA"}

package/dist/node/lib/rating/criteria/scoring/supply.d.ts

@@ -0,0 +1,4 @@
+import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin';
+import type { PassFailScoringFunction } from '@xyo-network/crypto-nft-score-model';
+export declare const scoreSupply: PassFailScoringFunction<NftInfoFields>;
+//# sourceMappingURL=supply.d.ts.map

package/dist/node/lib/rating/criteria/scoring/supply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supply.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/supply.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAGlF,eAAO,MAAM,WAAW,EAAE,uBAAuB,CAAC,aAAa,CAQ9D,CAAA"}

package/dist/node/lib/rating/criteria/scoring/tokenId.d.ts

@@ -0,0 +1,10 @@
+import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin';
+import type { PassFailScoringFunction } from '@xyo-network/crypto-nft-score-model';
+/**
+ * Callers SHALL NOT assume that ID numbers have any specific pattern to them, and
+ * MUST treat the ID as a "black box"
+ * @param nft
+ * @returns
+ */
+export declare const scoreTokenId: PassFailScoringFunction<NftInfoFields>;
+//# sourceMappingURL=tokenId.d.ts.map

package/dist/node/lib/rating/criteria/scoring/tokenId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenId.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/tokenId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAGlF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,uBAAuB,CAAC,aAAa,CAQ/D,CAAA"}

package/dist/node/lib/rating/criteria/scoring/type.d.ts

@@ -0,0 +1,4 @@
+import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin';
+import type { PassFailScoringFunction } from '@xyo-network/crypto-nft-score-model';
+export declare const scoreType: PassFailScoringFunction<NftInfoFields>;
+//# sourceMappingURL=type.d.ts.map

package/dist/node/lib/rating/criteria/scoring/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/rating/criteria/scoring/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAGlF,eAAO,MAAM,SAAS,EAAE,uBAAuB,CAAC,aAAa,CAM5D,CAAA"}

package/dist/node/lib/rating/criteria/scoringCriteria.d.ts

@@ -0,0 +1,55 @@
+export declare const scoringCriteria: {
+    Attributes: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'Animation URL': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'Background Color': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    Description: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'External Url': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    Image: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'Image Data': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    Name: {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'YouTube URL': {
+        score: (nft: import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields | import("@xyo-network/crypto-nft-payload-plugin").OpenSeaNftInfoFields) => import("@xyo-network/crypto-nft-score-model").ScaledScore;
+        weight: number;
+    };
+    'Contract Address': {
+        score: import("@xyo-network/crypto-nft-score-model").PassFailScoringFunction<import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields>;
+        weight: number;
+    };
+    Supply: {
+        score: import("@xyo-network/crypto-nft-score-model").PassFailScoringFunction<import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields>;
+        weight: number;
+    };
+    'Token Id': {
+        score: import("@xyo-network/crypto-nft-score-model").PassFailScoringFunction<import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields>;
+        weight: number;
+    };
+    Type: {
+        score: import("@xyo-network/crypto-nft-score-model").PassFailScoringFunction<import("@xyo-network/crypto-nft-payload-plugin").NftInfoFields>;
+        weight: number;
+    };
+};
+//# sourceMappingURL=scoringCriteria.d.ts.map

package/dist/node/lib/rating/criteria/scoringCriteria.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scoringCriteria.d.ts","sourceRoot":"","sources":["../../../../../src/lib/rating/criteria/scoringCriteria.ts"],"names":[],"mappings":"AA8BA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAM3B,CAAA"}

package/dist/node/lib/rating/index.d.ts

@@ -0,0 +1,3 @@
+export * from './analyzeNft.ts';
+export * from './criteria/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/lib/rating/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/rating/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-nft-diviner-score-plugin",
-  "version": "5.3.2",
+  "version": "5.3.4",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,19 +30,19 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "!**/*.bench.*",
-    "!**/*.spec.*",
-    "!**/*.test.*"
+    "README.md"
   ],
+  "dependencies": {
+    "@xyo-network/crypto-nft-payload-plugin": "~5.3.4",
+    "@xyo-network/crypto-nft-score-model": "~5.3.4"
+  },
   "devDependencies": {
     "@types/svg-parser": "~2.0.6",
     "@xylabs/sdk-js": "^5.0.90",
+    "@xylabs/ts-scripts-common": "~7.5.10",
     "@xylabs/ts-scripts-yarn3": "~7.5.10",
     "@xylabs/tsconfig": "~7.5.10",
     "@xylabs/vitest-extended": "~5.0.90",
-    "@xyo-network/crypto-nft-payload-plugin": "~5.3.2",
-    "@xyo-network/crypto-nft-score-model": "~5.3.2",
     "@xyo-network/diviner-abstract": "~5.3.5",
     "@xyo-network/diviner-model": "~5.3.5",
     "@xyo-network/module-model": "~5.3.5",
@@ -57,6 +57,14 @@
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
+    "@xyo-network/diviner-abstract": "^5",
+    "@xyo-network/diviner-model": "^5",
+    "@xyo-network/module-model": "^5",
+    "@xyo-network/payload-model": "^5",
+    "@xyo-network/payloadset-plugin": "^5",
+    "@xyo-network/sdk-js": "^5",
+    "ethers": "^6",
+    "svg-parser": "^2",
     "zod": "^4"
   },
   "publishConfig": {

package/src/Diviner.ts

@@ -1,53 +0,0 @@
-import type {
-  NftInfo,
-  NftScore,
-  NftScoreDivinerConfig,
-} from '@xyo-network/crypto-nft-payload-plugin'
-import {
-  isNftInfo,
-  NftScoreDivinerConfigSchema,
-  NftScoreSchema,
-} from '@xyo-network/crypto-nft-payload-plugin'
-import { AbstractDiviner } from '@xyo-network/diviner-abstract'
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-import type { Payload, Schema } from '@xyo-network/payload-model'
-import { PayloadBuilder } from '@xyo-network/sdk-js'
-
-import type { NftAnalysis } from './lib/index.ts'
-import { analyzeNft } from './lib/index.ts'
-
-export type NftScoreDivinerParams = DivinerParams<AnyConfigSchema<NftScoreDivinerConfig>>
-
-const toNftScorePayload = (nftInfo: NftInfo, scores: NftAnalysis): NftScore => {
-  const {
-
-    address, chainId, types,
-  } = nftInfo
-  return {
-    address, chainId, schema: NftScoreSchema, scores, types,
-  }
-}
-
-export const isNftScore = (payload: Payload): payload is NftScore => payload.schema === NftScoreSchema
-
-export class NftScoreDiviner<TParams extends NftScoreDivinerParams = NftScoreDivinerParams> extends AbstractDiviner<TParams> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, NftScoreDivinerConfigSchema]
-  static override readonly defaultConfigSchema: Schema = NftScoreDivinerConfigSchema
-
-  protected override divineHandler = async (payloads?: Payload[]): Promise<Payload[]> => {
-    const nftInfos = payloads?.filter(isNftInfo) ?? []
-    const results = await Promise.all(
-      nftInfos.map<Promise<NftScore>>(async (nftInfo) => {
-        const [score, sourceHash] = await Promise.all([
-          // Analyze the NFT
-          toNftScorePayload(nftInfo, await analyzeNft(nftInfo)),
-          // Hash the source payload
-          PayloadBuilder.dataHash(nftInfo),
-        ])
-        return { ...score, sources: [sourceHash] }
-      }),
-    )
-    return results
-  }
-}

package/src/Plugin.ts

@@ -1,16 +0,0 @@
-import { NftSchema } from '@xyo-network/crypto-nft-payload-plugin'
-import { PayloadSetSchema } from '@xyo-network/payload-model'
-import { createPayloadSetDivinerPlugin } from '@xyo-network/payloadset-plugin'
-
-import { NftScoreDiviner } from './Diviner.ts'
-
-export const NftScoreDivinerPlugin = () =>
-  createPayloadSetDivinerPlugin<NftScoreDiviner>(
-    { required: { [NftSchema]: 1 }, schema: PayloadSetSchema },
-    {
-      diviner: async (params) => {
-        const result = await NftScoreDiviner.create(params)
-        return result
-      },
-    },
-  )

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './Diviner.ts'
-export * from './lib/index.ts'
-export { NftScoreDivinerPlugin as default, NftScoreDivinerPlugin } from './Plugin.ts'

package/src/lib/index.ts

@@ -1 +0,0 @@
-export * from './rating/index.ts'

package/src/lib/rating/analyzeNft.ts

@@ -1,28 +0,0 @@
-import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { Score } from '@xyo-network/crypto-nft-score-model'
-
-import { scoringCriteria } from './criteria/index.ts'
-
-export type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey
-
-export type NftAnalysis = {
-  [key in ScoringCriteriaKey]: Score
-}
-
-export const analyzeNft = async (
-  /**
-   * The NFT to evaluate
-   */
-  nft: NftInfoFields,
-): Promise<NftAnalysis> => {
-  const result = Object.fromEntries(
-    await Promise.all(
-      Object.entries(scoringCriteria).map(async ([key, { score, weight }]) => {
-        const rawScore = await score(nft)
-        const weighted = rawScore.map(v => v * weight) as Score
-        return [key, weighted] as const
-      }),
-    ),
-  ) as NftAnalysis
-  return result
-}

package/src/lib/rating/criteria/index.ts

@@ -1 +0,0 @@
-export * from './scoringCriteria.ts'

package/src/lib/rating/criteria/scoring/contract.ts

@@ -1,11 +0,0 @@
-import type { NftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { PassFailScoringFunction } from '@xyo-network/crypto-nft-score-model'
-import { FAIL, PASS } from '@xyo-network/crypto-nft-score-model'
-import { isAddress } from 'ethers'
-
-export const scoreContractAddress: PassFailScoringFunction<NftInfoFields> = (nft: NftInfoFields) => {
-  if (!nft.address) return FAIL
-  if (typeof nft.address !== 'string') return FAIL
-  if (!isAddress(nft.address)) return FAIL
-  return PASS
-}

package/src/lib/rating/criteria/scoring/index.ts

@@ -1,5 +0,0 @@
-export * from './contract.ts'
-export * from './metadata/index.ts'
-export * from './supply.ts'
-export * from './tokenId.ts'
-export * from './type.ts'

package/src/lib/rating/criteria/scoring/metadata/animationUrl.ts

@@ -1,27 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import {
-  incrementPossible, incrementTotal, incrementTotalAndPossible, PASS,
-} from '@xyo-network/crypto-nft-score-model'
-
-import {
-  isSecure, isValidUrl, isWeb3,
-} from './lib/index.ts'
-
-export const scoreNftAnimationUrl = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreAnimationUrl(nft.metadata?.animation_url)
-}
-
-export const scoreAnimationUrl = (animation_url: unknown): ScaledScore => {
-  const score: ScaledScore = [0, 0]
-  if (animation_url === undefined || animation_url === null) return PASS
-  incrementPossible(score)
-  if (typeof animation_url !== 'string') return score
-  incrementTotalAndPossible(score)
-  if (!isValidUrl(animation_url)) return score
-  incrementTotalAndPossible(score)
-  if (!isSecure(animation_url)) return score
-  incrementTotalAndPossible(score)
-  if (!isWeb3(animation_url)) return score
-  return incrementTotal(score)
-}

package/src/lib/rating/criteria/scoring/metadata/attributes/evaluateAttributes.ts

@@ -1,90 +0,0 @@
-import type {
-  NftAttribute, NftInfoFields, OpenSeaNftAttribute, OpenSeaNftInfoFields,
-} from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import {
-  incrementPossible, incrementTotal, incrementTotalAndPossible,
-} from '@xyo-network/crypto-nft-score-model'
-
-const isDate = (value: unknown): value is Date => {
-  if (isNumber(value)) {
-    try {
-      new Date(value)
-      return true
-    } catch {
-      return false
-    }
-  }
-  return false
-}
-
-const isNumber = (value: unknown): value is number => typeof value === 'number'
-
-const isPercentage = (value: unknown): boolean => isNumber(value) && value >= 0 && value <= 100
-
-const isNonEmptyString = (value: unknown): value is string => typeof value === 'string' && value.length > 0
-
-const isNonEmptyStringOrNumber = (value: unknown): value is string | number => value === 'number' || isNonEmptyString(value)
-
-export const evaluateNftAttributes = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore =>
-  nft?.metadata?.attributes ? evaluateAttributes(nft?.metadata?.attributes) : [0, 1]
-
-export const evaluateAttributes = (attributes: NftAttribute[] | OpenSeaNftAttribute[] | unknown): ScaledScore => {
-  if (!attributes || !Array.isArray(attributes) || attributes.length === 0) return [0, 1]
-  const score: ScaledScore = [0, 0]
-  for (const attribute of attributes) {
-    const [attributeTotal, attributePossible] = evaluateAttribute(attribute)
-    incrementTotalAndPossible(score, attributeTotal, attributePossible)
-  }
-  return [1, 1]
-}
-
-export const evaluateAttribute = (attribute: OpenSeaNftAttribute): ScaledScore => {
-  const score: ScaledScore = [0, 1]
-  const max_value = attribute?.max_value
-  const trait_type = attribute?.trait_type
-  const value = attribute?.value
-
-  // Validate trait_type & value
-  if (!attribute || typeof attribute !== 'object' || !isNonEmptyString(trait_type) || !isNonEmptyStringOrNumber(value)) return score
-  incrementTotal(score)
-
-  // Validate display_type
-  incrementPossible(score)
-  if (validDisplayType(attribute)) incrementTotal(score)
-
-  // Validate max_value
-  if (max_value !== undefined) {
-    incrementPossible(score)
-    if (isNumber(max_value) && isNumber(value) && value <= max_value) incrementTotal(score)
-  }
-
-  return score
-}
-
-const validDisplayType = (attribute: OpenSeaNftAttribute): boolean => {
-  switch (attribute?.display_type) {
-    case 'number':
-    case 'boost_number': {
-      if (isNumber(attribute?.value)) return true
-      break
-    }
-    case 'boost_percentage': {
-      if (isPercentage(attribute?.value)) return true
-      break
-    }
-    case 'date': {
-      if (isDate(attribute?.value)) return true
-      break
-    }
-    case 'string':
-    case undefined: {
-      if (isNonEmptyString(attribute?.value)) return true
-      break
-    }
-    default: {
-      break
-    }
-  }
-  return false
-}

package/src/lib/rating/criteria/scoring/metadata/attributes/index.ts

@@ -1 +0,0 @@
-export * from './evaluateAttributes.ts'

package/src/lib/rating/criteria/scoring/metadata/backgroundColor.ts

@@ -1,21 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import {
-  incrementPossible, incrementTotal, incrementTotalAndPossible, PASS,
-} from '@xyo-network/crypto-nft-score-model'
-
-const isHexColor = /^[\da-f]{6}$/i
-
-export const scoreNftBackgroundColor = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreBackgroundColor(nft.metadata?.background_color)
-}
-
-export const scoreBackgroundColor = (background_color: unknown): ScaledScore => {
-  const score: ScaledScore = [0, 0]
-  if (background_color === undefined || background_color === null) return PASS
-  incrementPossible(score)
-  if (typeof background_color !== 'string') return score
-  incrementTotalAndPossible(score)
-  if (!isHexColor.test(background_color.toUpperCase())) return score
-  return incrementTotal(score)
-}

package/src/lib/rating/criteria/scoring/metadata/description.ts

@@ -1,13 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { incrementTotal } from '@xyo-network/crypto-nft-score-model'
-
-export const scoreNftDescription = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreDescription(nft.metadata?.description)
-}
-
-export const scoreDescription = (description: unknown): ScaledScore => {
-  const score: ScaledScore = [0, 1]
-  if (!description || typeof description !== 'string') return score
-  return incrementTotal(score)
-}

package/src/lib/rating/criteria/scoring/metadata/externalUrl.ts

@@ -1,16 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { incrementTotal } from '@xyo-network/crypto-nft-score-model'
-
-import { isSecure, isValidUrl } from './lib/index.ts'
-
-export const scoreNftExternalUrl = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreExternalUrl(nft?.metadata?.external_url)
-}
-export const scoreExternalUrl = (external_url: unknown): ScaledScore => {
-  const score: ScaledScore = [0, 2]
-  if (external_url === undefined || external_url === null || typeof external_url !== 'string' || !isValidUrl(external_url)) return score
-  incrementTotal(score)
-  if (!isSecure(external_url)) return score
-  return incrementTotal(score)
-}

package/src/lib/rating/criteria/scoring/metadata/image.ts

@@ -1,30 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { incrementTotal, PASS } from '@xyo-network/crypto-nft-score-model'
-
-import {
-  isSecure, isValidUrl, isWeb3,
-} from './lib/index.ts'
-
-const MaxPossibleImageScore = 3
-
-export const scoreNftImage = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  // If there's no image data
-  if (nft?.metadata?.image) {
-    return scoreImage(nft.metadata?.image)
-  } else {
-    // but there is image data, skip this scoring criteria, otherwise fail it completely
-    return nft.metadata?.image_data ? PASS : [0, MaxPossibleImageScore]
-  }
-}
-
-export const scoreImage = (image: unknown): ScaledScore => {
-  const score: ScaledScore = [0, MaxPossibleImageScore]
-  if (!image || typeof image !== 'string' || !isValidUrl(image)) return score
-  incrementTotal(score)
-  if (!isSecure(image)) return score
-  incrementTotal(score)
-  if (!isWeb3(image)) return score
-  incrementTotal(score)
-  return score
-}

package/src/lib/rating/criteria/scoring/metadata/imageData.ts

@@ -1,36 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { PASS } from '@xyo-network/crypto-nft-score-model'
-import { parse } from 'svg-parser'
-
-const MaxPossibleImageDataScore = 1
-
-// TODO: There is probably a deeper check we can do
-// here, but this is a good start
-const isValidImageData = (image_data: string): boolean => {
-  // If it doesn't start with an svg tag, it's not an svg
-  if (!image_data.startsWith('<svg')) return false
-  try {
-    // If it can't be parsed, it's not an svg
-    parse(image_data)
-    return true
-  } catch {
-    return false
-  }
-}
-
-export const scoreNftImageData = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  // If there's no image data
-  if (nft?.metadata?.image_data) {
-    return scoreImageData(nft.metadata?.image_data)
-  } else {
-    // but there is an image, skip this scoring criteria, otherwise fail it completely
-    return nft.metadata?.image ? PASS : [0, MaxPossibleImageDataScore]
-  }
-}
-
-export const scoreImageData = (image_data: unknown): ScaledScore => {
-  return !image_data || typeof image_data !== 'string' || !isValidImageData(image_data)
-    ? [0, MaxPossibleImageDataScore]
-    : [MaxPossibleImageDataScore, MaxPossibleImageDataScore]
-}

package/src/lib/rating/criteria/scoring/metadata/index.ts

@@ -1,9 +0,0 @@
-export * from './animationUrl.ts'
-export * from './attributes/index.ts'
-export * from './backgroundColor.ts'
-export * from './description.ts'
-export * from './externalUrl.ts'
-export * from './image.ts'
-export * from './imageData.ts'
-export * from './name.ts'
-export * from './youtubeUrl.ts'

package/src/lib/rating/criteria/scoring/metadata/lib/index.ts

@@ -1 +0,0 @@
-export * from './urlHelpers.ts'

package/src/lib/rating/criteria/scoring/metadata/lib/urlHelpers.ts

@@ -1,16 +0,0 @@
-export const web3Protocols = ['ipfs:', 'ar:']
-
-export const toUrl = (url?: string | null): URL | undefined => {
-  if (!url) return undefined
-  try {
-    return new URL(url)
-  } catch {
-    return undefined
-  }
-}
-
-export const isValidUrl = (url?: string | null): boolean => toUrl(url) !== undefined
-// eslint-disable-next-line unicorn/prefer-includes
-export const isWeb3 = (url?: string | null): boolean => web3Protocols.some(protocol => protocol === toUrl(url)?.protocol)
-export const isWeb2 = (url?: string | null): boolean => !isWeb3(url)
-export const isSecure = (url?: string | null): boolean => isWeb3(url) || toUrl(url)?.protocol === 'https:'

package/src/lib/rating/criteria/scoring/metadata/name.ts

@@ -1,12 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { incrementTotal } from '@xyo-network/crypto-nft-score-model'
-
-export const scoreNftName = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreName(nft.metadata?.name)
-}
-export const scoreName = (name: unknown): ScaledScore => {
-  const score: ScaledScore = [0, 1]
-  if (!name || typeof name !== 'string') return score
-  return incrementTotal(score)
-}

package/src/lib/rating/criteria/scoring/metadata/spec/testHelpers.ts

@@ -1,33 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { PASS } from '@xyo-network/crypto-nft-score-model'
-import { expect } from 'vitest'
-
-export const expectMaxPossibleScore = (score: ScaledScore) => {
-  const [total, possible] = score
-  expect(total).toBeNumber()
-  expect(total).toBePositive()
-  expect(possible).toBeNumber()
-  expect(possible).toBePositive()
-  expect(total).toEqual(possible)
-}
-
-export const expectLoweredScore = (score: ScaledScore) => {
-  const [total, possible] = score
-  expect(total).toBeNumber()
-  expect(total).not.toBeNegative()
-  expect(possible).toBeNumber()
-  expect(possible).toBePositive()
-  expect(total).toBeLessThan(possible)
-}
-
-export const expectMiniumScore = (score: ScaledScore) => {
-  const [total] = score
-  expectLoweredScore(score)
-  expect(total).toBe(0)
-}
-
-export const expectNoScore = (score: ScaledScore) => {
-  expect(score).toEqual(PASS)
-}

package/src/lib/rating/criteria/scoring/metadata/youtubeUrl.ts

@@ -1,17 +0,0 @@
-import type { NftInfoFields, OpenSeaNftInfoFields } from '@xyo-network/crypto-nft-payload-plugin'
-import type { ScaledScore } from '@xyo-network/crypto-nft-score-model'
-import { incrementTotal, PASS } from '@xyo-network/crypto-nft-score-model'
-
-import { isSecure, isValidUrl } from './lib/index.ts'
-
-export const scoreNftYoutubeUrl = (nft: NftInfoFields | OpenSeaNftInfoFields): ScaledScore => {
-  return scoreYoutubeUrl(nft?.metadata?.youtube_url)
-}
-export const scoreYoutubeUrl = (youtube_url: unknown): ScaledScore => {
-  if (youtube_url === undefined || youtube_url === null) return PASS
-  const score: ScaledScore = [0, 2]
-  if (typeof youtube_url !== 'string' || !isValidUrl(youtube_url)) return score
-  incrementTotal(score)
-  if (!isSecure(youtube_url)) return score
-  return incrementTotal(score)
-}