@skyblock-finance/actions 0.9.1 → 0.11.0

package/package.json

@@ -43,5 +43,5 @@
 	"sideEffects": false,
 	"type": "commonjs",
 	"types": "dist/index.d.ts",
-	"version": "0.9.1"
+	"version": "0.11.0"
 }

package/source/data.test.ts

@@ -1,8 +1,11 @@
-import { actionSchema } from './schema'
-import { allActions } from './data'
-import { z } from 'zod/v4'
-import { describe, expect, test } from 'bun:test'
+import { expect, test } from 'bun:test'
 import assert from 'node:assert'
+
+import jsonStableStringify from 'json-stable-stringify'
+import { z } from 'zod/v4'
+
+import { allActions } from './data'
+import { actionSchema } from './schema'
 import { ActionIoItem } from './types'
 
 test('all actions follow the schema', () => {
@@ -68,34 +71,57 @@ test('sumUp works', () => {
 	)
 })
 
-describe('every action’s workbench inputs match its crafing grid', () => {
+test('every action’s workbench inputs match its crafing grid', () => {
 	for (const action of allActions) {
 		for (const grid of action.place.filter((x) => x.type === 'workbench')) {
-			test(`${JSON.stringify(action.outputs)} is valid`, () => {
-				assert(grid.type === 'workbench')
+			assert(grid.type === 'workbench')
 
-				const actual = sumUp(action.inputs.filter((x) => x.type === 'item'))
+			const actual = sumUp(action.inputs.filter((x) => x.type === 'item'))
 
-				const expected = sumUp(grid.grid.filter((x) => x !== null))
+			const expected = sumUp(grid.grid.filter((x) => x !== null))
 
-				expect(actual).toEqual(expected)
-			})
+			expect(
+				actual,
+				`${JSON.stringify(action)} doesn't match its crafting grid`,
+			).toEqual(expected)
 		}
 	}
 })
 
-describe('every action’s anvil inputs match its crafing grid', () => {
+test('every action’s anvil inputs match its crafing grid', () => {
 	for (const action of allActions) {
 		for (const grid of action.place.filter((x) => x.type === 'anvil')) {
-			test(`${JSON.stringify(action.outputs)} is valid`, () => {
-				assert(grid.type === 'anvil')
+			assert(grid.type === 'anvil')
 
-				const actual = sumUp(action.inputs.filter((x) => x.type === 'item'))
+			const actual = sumUp(action.inputs.filter((x) => x.type === 'item'))
+
+			const expected = sumUp([grid.left, grid.right])
+
+			expect(actual, `${JSON.stringify(action)} doesn't match`).toEqual(
+				expected,
+			)
+		}
+	}
+})
+
+test('no duplicate actions exist', () => {
+	const seen = new Set<string>()
+
+	for (const action of allActions) {
+		for (const place of action.place) {
+			const syntheticAction = {
+				...action,
+				place,
+			}
+			const json = jsonStableStringify(syntheticAction)
 
-				const expected = sumUp([grid.left, grid.right])
+			if (!json) throw new Error(`invalid action: ${JSON.stringify(action)}`)
 
-				expect(actual).toEqual(expected)
-			})
+			if (seen.has(json)) {
+				throw new Error(`duplicate action: ${json}`)
+			} else {
+				seen.add(json)
+			}
 		}
 	}
 })

package/source/data.ts

@@ -1,20 +1,29 @@
-import { actions as _adventurer } from '../data/merchants/adventurer.json'
 import { actions as _bitsCrafts } from '../data/bits-crafts.json'
+import { actions as _crimsonIsle } from '../data/crimson-isle.json'
+import { actions as _forging } from '../data/forging.json'
+import { actions as _gems } from '../data/gems.json'
+import { actions as _gemstones } from '../data/gemstones.json'
+import { actions as _adventurer } from '../data/merchants/adventurer.json'
 import { actions as _bubu } from '../data/merchants/bubu.json'
 import { actions as _bulvar } from '../data/merchants/bulvar.json'
-import { actions as _crimsonIsle } from '../data/crimson-isle.json'
 import { actions as _einary } from '../data/merchants/einary.json'
 import { actions as _elizabeth } from '../data/merchants/elizabeth.json'
 import { actions as _fishingMerchant } from '../data/merchants/fishing-merchant.json'
-import { actions as _gems } from '../data/gems.json'
-import { actions as _gemstones } from '../data/gemstones.json'
-import { actions as _northStarsCrafts } from '../data/north-stars-crafts.json'
+import { actions as _hilda } from '../data/merchants/hilda.json'
+import { actions as _marthos } from '../data/merchants/marthos.json'
 import { actions as _phillip } from '../data/merchants/phillip.json'
 import { actions as _plumberJoe } from '../data/merchants/plumber-joe.json'
 import { actions as _seymour } from '../data/merchants/seymour.json'
 import { actions as _skymart } from '../data/merchants/skymart.json'
 import { actions as _smithmonger } from '../data/merchants/smithmonger.json'
+import { actions as _minionsBlaze } from '../data/minions/blaze.json'
+import { actions as _minionsCaveSpider } from '../data/minions/cave-spider.json'
+import { actions as _minionsCreeper } from '../data/minions/creeper.json'
+import { actions as _minionsEnderman } from '../data/minions/enderman.json'
+import { actions as _minionsGhast } from '../data/minions/ghast.json'
+import { actions as _northStarsCrafts } from '../data/north-stars-crafts.json'
 import { actions as _wood } from '../data/wood.json'
+
 import { Action } from './types'
 
 // merchants
@@ -25,22 +34,33 @@ export const bulvar = _bulvar as Action[]
 export const einary = _einary as Action[]
 export const elizabeth = _elizabeth as Action[]
 export const fishingMerchant = _fishingMerchant as Action[]
+export const hilda = _hilda as Action[]
+export const marthos = _marthos as Action[]
 export const phillip = _phillip as Action[]
 export const plumberJoe = _plumberJoe as Action[]
 export const seymour = _seymour as Action[]
 export const skymart = _skymart as Action[]
 export const smithmonger = _smithmonger as Action[]
 
+// minions
+
+export const minionsBlaze = _minionsBlaze as Action[]
+export const minionsCaveSpider = _minionsCaveSpider as Action[]
+export const minionsCreeper = _minionsCreeper as Action[]
+export const minionsEnderman = _minionsEnderman as Action[]
+export const minionsGhast = _minionsGhast as Action[]
+
 // other
 
 export const bitsCrafts = _bitsCrafts as Action[]
 export const crimsonIsle = _crimsonIsle as Action[]
+export const forging = _forging as Action[]
 export const gems = _gems as Action[]
 export const gemstones = _gemstones as Action[]
 export const northStarsCrafts = _northStarsCrafts as Action[]
 export const wood = _wood as Action[]
 
-export const allActions = [
+export const allActions: Action[] = [
 	...adventurer,
 	...bitsCrafts,
 	...bubu,
@@ -49,8 +69,16 @@ export const allActions = [
 	...einary,
 	...elizabeth,
 	...fishingMerchant,
+	...forging,
 	...gems,
 	...gemstones,
+	...hilda,
+	...marthos,
+	...minionsBlaze,
+	...minionsCaveSpider,
+	...minionsCreeper,
+	...minionsEnderman,
+	...minionsGhast,
 	...northStarsCrafts,
 	...phillip,
 	...plumberJoe,

package/source/index.ts

@@ -1,17 +1,22 @@
 export * from './data'
+export { npcs } from './npcs'
+export {
+	actionIoCrystalSchema,
+	actionIoCurrencySchema,
+	actionIoItemSchema,
+	actionIoSchema,
+	actionPlaceSchema,
+	actionRequirementSchema,
+	actionSchema,
+	npcIdSchema,
+} from './schema'
 export {
 	Action,
 	ActionCurrency,
 	ActionIo,
+	ActionIoCrystal,
 	ActionIoCurrency,
 	ActionIoItem,
+	ActionRequirement,
 	NpcId,
 } from './types'
-export {
-	actionIoItemSchema,
-	actionIoSchema,
-	actionPlaceSchema,
-	actionSchema,
-	npcIdSchema,
-} from './schema'
-export { npcs } from './npcs'

package/source/npcs.ts

@@ -1,100 +1,114 @@
 import { NpcId } from './types'
 
 type NpcMetadata = {
-	name: string
 	links: {
 		communityWiki: `https://hypixelskyblock.minecraft.wiki/${string}` | null
 		hypixelWiki: `https://wiki.hypixel.net/${string}` | null
 	}
+	name: string
 }
 
 const _npcs: Record<NpcId, NpcMetadata> = {
 	ADVENTURER: {
-		name: 'Adventurer',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Adventurer',
 			hypixelWiki: 'https://wiki.hypixel.net/Adventurer',
 		},
+		name: 'Adventurer',
 	},
 	ALCHEMIST: {
-		name: 'Alchemist',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Alchemist',
 			hypixelWiki: 'https://wiki.hypixel.net/Alchemist',
 		},
+		name: 'Alchemist',
 	},
 	BUBU: {
-		name: 'Bubu',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Bubu',
 			hypixelWiki: 'https://wiki.hypixel.net/Bubu',
 		},
+		name: 'Bubu',
 	},
 	BULVAR: {
-		name: 'Bulvar',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Bulvar',
 			hypixelWiki: 'https://wiki.hypixel.net/Bulvar',
 		},
+		name: 'Bulvar',
 	},
 	EINARY: {
-		name: 'Einary',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Einary',
 			hypixelWiki: 'https://wiki.hypixel.net/Einary',
 		},
+		name: 'Einary',
 	},
 	ELIZABETH: {
-		name: 'Elizabeth',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Elizabeth',
 			hypixelWiki: 'https://wiki.hypixel.net/Elizabeth',
 		},
+		name: 'Elizabeth',
 	},
 	FISHING_MERCHANT: {
-		name: 'Fishing Merchant',
 		links: {
 			communityWiki:
 				'https://hypixelskyblock.minecraft.wiki/w/Fishing_Merchant',
 			hypixelWiki: 'https://wiki.hypixel.net/Fishing_Merchant',
 		},
+		name: 'Fishing Merchant',
+	},
+	HILDA: {
+		links: {
+			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Hilda',
+			hypixelWiki: 'https://wiki.hypixel.net/Hilda',
+		},
+		name: 'Hilda',
+	},
+	MARTHOS: {
+		links: {
+			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Marthos',
+			hypixelWiki: 'https://wiki.hypixel.net/Marthos',
+		},
+		name: 'Marthos',
 	},
 	PHILLIP: {
-		name: 'Pesthunter Phillip',
 		links: {
 			communityWiki:
 				'https://hypixelskyblock.minecraft.wiki/w/Pesthunter_Phillip',
 			hypixelWiki: 'https://wiki.hypixel.net/Pesthunter_Phillip',
 		},
+		name: 'Pesthunter Phillip',
+	},
+	PLUMBER_JOE: {
+		links: {
+			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Plumber_Joe',
+			hypixelWiki: 'https://wiki.hypixel.net/Plumber_Joe',
+		},
+		name: 'Plumber Joe',
 	},
 	SEYMOUR: {
-		name: 'Seymour',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Seymour',
 			hypixelWiki: 'https://wiki.hypixel.net/Seymour',
 		},
+		name: 'Seymour',
 	},
 	SKYMART: {
-		name: 'SkyMart',
 		links: {
 			communityWiki:
 				'https://hypixelskyblock.minecraft.wiki/w/The_Garden#The_Desk',
 			hypixelWiki: 'https://wiki.hypixel.net/Garden#Desk',
 		},
+		name: 'SkyMart',
 	},
 	SMITHMONGER: {
-		name: 'Smithmonger',
 		links: {
 			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Smithmonger',
 			hypixelWiki: 'https://wiki.hypixel.net/Smithmonger',
 		},
-	},
-	PLUMBER_JOE: {
-		name: 'Plumber Joe',
-		links: {
-			communityWiki: 'https://hypixelskyblock.minecraft.wiki/w/Plumber_Joe',
-			hypixelWiki: 'https://wiki.hypixel.net/Plumber_Joe',
-		},
+		name: 'Smithmonger',
 	},
 }
 

package/source/schema.ts

@@ -1,31 +1,35 @@
 import { z } from 'zod/v4'
 
-export const actionIoItemSchema = z
-	.object({
-		amount: z.number(),
-		id: z.string(),
-		type: z.literal('item'),
-	})
-	.strict()
+export const actionIoCrystalSchema = z.strictObject({
+	amount: z.number(),
+	id: z.string(),
+	type: z.literal('crystal'),
+})
 
-export const actionIoCurrencySchema = z
-	.object({
-		amount: z.number(),
-		id: z.enum([
-			'bit',
-			'coin',
-			'copper',
-			'gem',
-			'north-star',
-			'pest',
-			'second',
-			'usd',
-		]),
-		type: z.literal('currency'),
-	})
-	.strict()
+export const actionIoCurrencySchema = z.strictObject({
+	amount: z.number(),
+	id: z.enum([
+		'bit',
+		'coin',
+		'copper',
+		'gem',
+		'forge-second',
+		'north-star',
+		'pest',
+		'second',
+		'usd',
+	]),
+	type: z.literal('currency'),
+})
+
+export const actionIoItemSchema = z.strictObject({
+	amount: z.number(),
+	id: z.string(),
+	type: z.literal('item'),
+})
 
 export const actionIoSchema = z.discriminatedUnion('type', [
+	actionIoCrystalSchema,
 	actionIoCurrencySchema,
 	actionIoItemSchema,
 ])
@@ -38,6 +42,8 @@ export const npcIdSchema = z.enum([
 	'EINARY',
 	'ELIZABETH',
 	'FISHING_MERCHANT',
+	'HILDA',
+	'MARTHOS',
 	'PHILLIP',
 	'PLUMBER_JOE',
 	'SEYMOUR',
@@ -51,6 +57,9 @@ export const actionPlaceSchema = z.discriminatedUnion('type', [
 		right: actionIoItemSchema,
 		type: z.literal('anvil'),
 	}),
+	z.strictObject({
+		type: z.literal('forge'),
+	}),
 	z.strictObject({
 		id: npcIdSchema,
 		type: z.literal('npc'),
@@ -65,17 +74,34 @@ export const actionPlaceSchema = z.discriminatedUnion('type', [
 	}),
 ])
 
-export const actionSchema = z
-	.object({
-		inputs: z.array(actionIoSchema),
-		outputs: z.array(actionIoSchema),
-		place: z.array(actionPlaceSchema),
-	})
-	.strict()
+/**
+ * NOTE: This schema uses uppercase to align 1-to-1 with the Skyblock Items API's requirements format.
+ */
+export const actionRequirementSchema = z.discriminatedUnion('type', [
+	z.strictObject({
+		collection: z.enum(['GEMSTONE' /* to be added as-needed */]),
+		tier: z.int().min(1).max(10),
+		type: z.literal('COLLECTION'),
+	}),
+	z.strictObject({
+		level: z.int().min(1).max(60),
+		skill: z.enum(['MINING' /* to be added as-needed */]),
+		type: z.literal('SKILL'),
+	}),
+	z.strictObject({
+		tier: z.int().min(1).max(10),
+		type: z.literal('HEART_OF_THE_MOUNTAIN'),
+	}),
+])
+
+export const actionSchema = z.strictObject({
+	inputs: z.array(actionIoSchema),
+	outputs: z.array(actionIoSchema),
+	place: z.array(actionPlaceSchema),
+	requirements: z.array(actionRequirementSchema).optional(),
+})
 
-export const actionDefinitionSchema = z
-	.object({
-		actions: z.array(actionSchema),
-		$schema: z.string().optional(),
-	})
-	.strict()
+export const actionDefinitionSchema = z.strictObject({
+	$schema: z.string().optional(),
+	actions: z.array(actionSchema),
+})

package/source/types.ts

@@ -1,8 +1,11 @@
 import { z } from 'zod/v4'
+
 import {
+	actionIoCrystalSchema,
 	actionIoCurrencySchema,
 	actionIoItemSchema,
 	actionIoSchema,
+	actionRequirementSchema,
 	actionSchema,
 	npcIdSchema,
 } from './schema'
@@ -10,6 +13,8 @@ import {
 export type Action = z.output<typeof actionSchema>
 export type ActionCurrency = z.output<typeof actionIoCurrencySchema.shape.id>
 export type ActionIo = z.output<typeof actionIoSchema>
+export type ActionIoCrystal = z.output<typeof actionIoCrystalSchema>
 export type ActionIoCurrency = z.output<typeof actionIoCurrencySchema>
 export type ActionIoItem = z.output<typeof actionIoItemSchema>
+export type ActionRequirement = z.output<typeof actionRequirementSchema>
 export type NpcId = z.output<typeof npcIdSchema>