@xyo-network/crypto-nft-collection-diviner-score-plugin 4.1.1 → 5.0.0

package/dist/browser/index.d.ts

@@ -1,33 +1,4 @@
-import { NftCollectionScoreDivinerConfig, NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { DivinerParams } from '@xyo-network/diviner-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-import { WeightedScoringCriteria, Score } from '@xyo-network/crypto-nft-score-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-
-type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>;
-declare class NftCollectionScoreDiviner<TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams> extends AbstractDiviner<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected divineHandler: (payloads?: Payload[]) => Promise<Payload[]>;
-}
-
-declare const scoringCriteria: {
-    [key: string]: WeightedScoringCriteria<NftCollectionInfo>;
-};
-
-type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey;
-type NftCollectionAnalysis = {
-    [key in ScoringCriteriaKey]: Score;
-};
-declare const analyzeNftCollection: (
-/**
- * The NFT to evaluate
- */
-nft: NftCollectionInfo) => Promise<NftCollectionAnalysis>;
-
-declare const NftCollectionScoreDivinerPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDivinerPlugin<NftCollectionScoreDiviner<NftCollectionScoreDivinerParams>>;
-
-export { NftCollectionScoreDiviner, NftCollectionScoreDivinerPlugin, analyzeNftCollection, NftCollectionScoreDivinerPlugin as default, scoringCriteria };
-export type { NftCollectionAnalysis, NftCollectionScoreDivinerParams, ScoringCriteriaKey };
+export * from './Diviner.ts';
+export * from './lib/index.ts';
+export { NftCollectionScoreDivinerPlugin as default, NftCollectionScoreDivinerPlugin } from './Plugin.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts

@@ -1,33 +1,4 @@
-import { NftCollectionScoreDivinerConfig, NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { DivinerParams } from '@xyo-network/diviner-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-import { WeightedScoringCriteria, Score } from '@xyo-network/crypto-nft-score-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-
-type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>;
-declare class NftCollectionScoreDiviner<TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams> extends AbstractDiviner<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected divineHandler: (payloads?: Payload[]) => Promise<Payload[]>;
-}
-
-declare const scoringCriteria: {
-    [key: string]: WeightedScoringCriteria<NftCollectionInfo>;
-};
-
-type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey;
-type NftCollectionAnalysis = {
-    [key in ScoringCriteriaKey]: Score;
-};
-declare const analyzeNftCollection: (
-/**
- * The NFT to evaluate
- */
-nft: NftCollectionInfo) => Promise<NftCollectionAnalysis>;
-
-declare const NftCollectionScoreDivinerPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDivinerPlugin<NftCollectionScoreDiviner<NftCollectionScoreDivinerParams>>;
-
-export { NftCollectionScoreDiviner, NftCollectionScoreDivinerPlugin, analyzeNftCollection, NftCollectionScoreDivinerPlugin as default, scoringCriteria };
-export type { NftCollectionAnalysis, NftCollectionScoreDivinerParams, ScoringCriteriaKey };
+export * from './Diviner.ts';
+export * from './lib/index.ts';
+export { NftCollectionScoreDivinerPlugin as default, NftCollectionScoreDivinerPlugin } from './Plugin.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts

@@ -1,33 +1,4 @@
-import { NftCollectionScoreDivinerConfig, NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { DivinerParams } from '@xyo-network/diviner-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-import { WeightedScoringCriteria, Score } from '@xyo-network/crypto-nft-score-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-
-type NftCollectionScoreDivinerParams = DivinerParams<AnyConfigSchema<NftCollectionScoreDivinerConfig>>;
-declare class NftCollectionScoreDiviner<TParams extends NftCollectionScoreDivinerParams = NftCollectionScoreDivinerParams> extends AbstractDiviner<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected divineHandler: (payloads?: Payload[]) => Promise<Payload[]>;
-}
-
-declare const scoringCriteria: {
-    [key: string]: WeightedScoringCriteria<NftCollectionInfo>;
-};
-
-type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey;
-type NftCollectionAnalysis = {
-    [key in ScoringCriteriaKey]: Score;
-};
-declare const analyzeNftCollection: (
-/**
- * The NFT to evaluate
- */
-nft: NftCollectionInfo) => Promise<NftCollectionAnalysis>;
-
-declare const NftCollectionScoreDivinerPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDivinerPlugin<NftCollectionScoreDiviner<NftCollectionScoreDivinerParams>>;
-
-export { NftCollectionScoreDiviner, NftCollectionScoreDivinerPlugin, analyzeNftCollection, NftCollectionScoreDivinerPlugin as default, scoringCriteria };
-export type { NftCollectionAnalysis, NftCollectionScoreDivinerParams, ScoringCriteriaKey };
+export * from './Diviner.ts';
+export * from './lib/index.ts';
+export { NftCollectionScoreDivinerPlugin as default, NftCollectionScoreDivinerPlugin } from './Plugin.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-nft-collection-diviner-score-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,25 +28,28 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xyo-network/crypto-nft-collection-payload-plugin": "^4.1.1",
-    "@xyo-network/crypto-nft-payload-plugin": "^4.1.1",
-    "@xyo-network/crypto-nft-score-model": "^4.1.1",
-    "@xyo-network/diviner-abstract": "^4.1.7",
-    "@xyo-network/diviner-model": "^4.1.7",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7"
+    "@xyo-network/crypto-nft-collection-payload-plugin": "^5.0.0",
+    "@xyo-network/crypto-nft-payload-plugin": "^5.0.0",
+    "@xyo-network/crypto-nft-score-model": "^5.0.0",
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/account": "^4.1.7",
-    "@xyo-network/payload-wrapper": "^4.1.7",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/account": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "ethers": "^6.15.0",
-    "knip": "^5.62.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

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

@@ -0,0 +1,32 @@
+import '@xylabs/vitest-extended'
+
+import { readFile } from 'node:fs/promises'
+import Path from 'node:path'
+
+import type { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { scoreIndividualAttributes } from '../scoreIndividualAttributes.ts'
+
+describe('scoreIndividualAttributes', () => {
+  let collections: NftCollectionInfo[]
+  beforeAll(async () => {
+    const filePath = Path.join(__dirname, '../../../../spec', 'testData.json')
+    const fileContents = await readFile(filePath, 'utf8')
+    collections = JSON.parse(fileContents) as NftCollectionInfo[]
+  })
+  it('evaluates the NFT collection', () => {
+    for (let collection of collections) {
+      const score = scoreIndividualAttributes(collection)
+      const [total, possible] = score
+      expect(total).toBeNumber()
+      expect(total).not.toBeNegative()
+      expect(possible).toBeNumber()
+      expect(possible).not.toBeNegative()
+      expect(total).toBeLessThanOrEqual(possible)
+    }
+  })
+})

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

@@ -0,0 +1,32 @@
+import '@xylabs/vitest-extended'
+
+import { readFile } from 'node:fs/promises'
+import Path from 'node:path'
+
+import type { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { scoreTotalAttributes } from '../scoreTotalAttributes.ts'
+
+describe('scoreTotalAttributes', () => {
+  let collections: NftCollectionInfo[]
+  beforeAll(async () => {
+    const filePath = Path.join(__dirname, '../../../../spec', 'testData.json')
+    const fileContents = await readFile(filePath, 'utf8')
+    collections = JSON.parse(fileContents) as NftCollectionInfo[]
+  })
+  it('evaluates the NFT collection', () => {
+    for (let collection of collections) {
+      const score = scoreTotalAttributes(collection)
+      const [total, possible] = score
+      expect(total).toBeNumber()
+      expect(total).not.toBeNegative()
+      expect(possible).toBeNumber()
+      expect(possible).not.toBeNegative()
+      expect(total).toBeLessThanOrEqual(possible)
+    }
+  })
+})

package/src/lib/rating/criteria/scoring/spec/total.spec.ts

@@ -0,0 +1,42 @@
+import '@xylabs/vitest-extended'
+
+import type { NftCollectionCount } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { scoreTotal } from '../total.ts'
+
+describe('scoreTotal', () => {
+  const values: [total: number, expected: number][] = [
+    [1, 0],
+    [2, 0],
+    [3, 0],
+    [10, 1],
+    [20, 1],
+    [30, 2],
+    [100, 3],
+    [200, 4],
+    [300, 5],
+    [1000, 7],
+    [2000, 9],
+    [3000, 9],
+    [10_000, 10],
+    [20_000, 10],
+    [30_000, 9],
+    [100_000, 7],
+    [200_000, 6],
+    [300_000, 5],
+  ]
+
+  it.each(values)('scores %s as %s', (total, expected) => {
+    const collection: NftCollectionCount = { total }
+    const [score, possible] = scoreTotal(collection)
+    expect(score).toBeNumber()
+    expect(score).not.toBeNegative()
+    expect(possible).not.toBeNegative()
+    expect(possible).toBeNumber()
+    expect(score).toBe(expected)
+  })
+})

package/src/lib/rating/spec/analyzeNftCollection.spec.ts

@@ -0,0 +1,38 @@
+import '@xylabs/vitest-extended'
+
+import { readFile } from 'node:fs/promises'
+import Path from 'node:path'
+
+import type { NftCollectionInfo } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import {
+  beforeAll,
+  describe, expect, it,
+} from 'vitest'
+
+import { analyzeNftCollection } from '../analyzeNftCollection.ts'
+
+describe('analyzeNftCollection', () => {
+  let collections: NftCollectionInfo[]
+  beforeAll(async () => {
+    const filePath = Path.join(__dirname, 'testData.json')
+    const fileContents = await readFile(filePath, 'utf8')
+    collections = JSON.parse(fileContents) as NftCollectionInfo[]
+  })
+  it('evaluates the NFT collection', async () => {
+    await Promise.all(
+      collections.map(async (collection) => {
+        const rating = await analyzeNftCollection(collection)
+        expect(rating).toBeObject()
+        for (let [key, score] of Object.entries(rating)) {
+          expect(key).toBeString()
+          const [total, possible] = score
+          expect(total).toBeNumber()
+          expect(total).not.toBeNegative()
+          expect(possible).toBeNumber()
+          expect(possible).not.toBeNegative()
+          expect(total).toBeLessThanOrEqual(possible)
+        }
+      }),
+    )
+  })
+})