BlueGit

timfa questward

Attribute gift items to John Questward with natural origins.

Gift stacks use craft/gather verbs (Smithed, Mined, Carved, …) instead of gods origin.

timfa Tim Falken · pushed by timfa

Authored 2026-09-02 · 2 months ago

Hash
675d80921da8e5d697ab776eb11302e20cc3c9d9
Parent
1cdbf0ae
4 files changed +110 −6
server/src/gifts/service.js +3 −2
@@ -1,12 +1,13 @@
1 1 import { randomUUID } from "node:crypto";
2 2 import { ItemId, itemDefinition, LETTER_MAX_BODY_CHARS } from "../../../shared/definitions/items.js";
3 3 import { insertStackGrowable, normalizeVault } from "../../../shared/items/inventory.js";
4 import { attachOrigins, godsOrigin, writtenOrigin } from "../../../shared/items/origin.js";
4 import { attachOrigins, writtenOrigin } from "../../../shared/items/origin.js";
5 5 import {
6 6 formatGiftLetterBody,
7 7 QUESTWARD_GIFT_AUTHOR,
8 8 QUESTWARD_GIFT_ORG
9 9 } from "../../../shared/courier/giftLetters.js";
10 import { giftItemOrigin } from "../../../shared/courier/giftOrigin.js";
10 11
11 12 function userError (message)
12 13 {
@@ -66,7 +67,7 @@ export class GiftService
66 67 const stack = attachOrigins({
67 68 itemId: entry.itemId,
68 69 quantity: entry.quantity,
69 origins: [{ origin: godsOrigin(), quantity: entry.quantity }]
70 origins: [{ origin: giftItemOrigin(entry.itemId), quantity: entry.quantity }]
70 71 });
71 72 this.#creditBank(characterId, stack, def);
72 73 credited.push({
@@ -1,12 +1,13 @@
1import { randomUUID } from "node:crypto";
1import { randomUUID } from "node:crypto";
2import { ItemId, itemDefinition, LETTER_MAX_BODY_CHARS } from "../../../shared/definitions/items.js";
2import { ItemId, itemDefinition, LETTER_MAX_BODY_CHARS } from "../../../shared/definitions/items.js";
3import { insertStackGrowable, normalizeVault } from "../../../shared/items/inventory.js";
3import { insertStackGrowable, normalizeVault } from "../../../shared/items/inventory.js";
4import { attachOrigins, godsOrigin, writtenOrigin } from "../../../shared/items/origin.js";
4import { attachOrigins, writtenOrigin } from "../../../shared/items/origin.js";
5import {
5import {
6 formatGiftLetterBody,
6 formatGiftLetterBody,
7 QUESTWARD_GIFT_AUTHOR,
7 QUESTWARD_GIFT_AUTHOR,
8 QUESTWARD_GIFT_ORG
8 QUESTWARD_GIFT_ORG
9} from "../../../shared/courier/giftLetters.js";
9} from "../../../shared/courier/giftLetters.js";
10import { giftItemOrigin } from "../../../shared/courier/giftOrigin.js";
10
11
11function userError (message)
12function userError (message)
12{
13{
@@ -66,7 +67,7 @@ export class GiftService
66 const stack = attachOrigins({
67 const stack = attachOrigins({
67 itemId: entry.itemId,
68 itemId: entry.itemId,
68 quantity: entry.quantity,
69 quantity: entry.quantity,
69 origins: [{ origin: godsOrigin(), quantity: entry.quantity }]
70 origins: [{ origin: giftItemOrigin(entry.itemId), quantity: entry.quantity }]
70 });
71 });
71 this.#creditBank(characterId, stack, def);
72 this.#creditBank(characterId, stack, def);
72 credited.push({
73 credited.push({
server/tests/gifts.test.js +25 −4
@@ -10,8 +10,11 @@ import {
10 10 QUESTWARD_GIFT_AUTHOR,
11 11 QUESTWARD_GIFT_ORG
12 12 } from "../../shared/courier/giftLetters.js";
13 import { giftItemOrigin } from "../../shared/courier/giftOrigin.js";
13 14 import { formatLetterSignature } from "../../shared/courier/systemLetters.js";
14 15 import { ItemId } from "../../shared/definitions/items.js";
16 import { CraftingItemId } from "../../shared/definitions/craftingItems.js";
17 import { originLabel, ItemOriginKind, CraftOriginVerb, GatherOriginVerb } from "../../shared/items/origin.js";
15 18 import { BlockType } from "../../shared/definitions/tiles.js";
16 19 import { createEmptyChunkData, encodeChunkBlob, decodeChunkBlob } from "../src/world/chunkData.js";
17 20 import { GiftService } from "../src/gifts/service.js";
@@ -97,6 +100,23 @@ test("gift letter body and signature match Questward CEO format", () =>
97 100 );
98 101 });
99 102
103 test("gift item origins use natural verbs with John Questward", () =>
104 {
105 assert.equal(
106 originLabel(giftItemOrigin(ItemId.stick)),
107 "Carved by John Questward"
108 );
109 assert.equal(
110 originLabel(giftItemOrigin(CraftingItemId.copperOre)),
111 "Mined by John Questward"
112 );
113 const made = giftItemOrigin(ItemId.letter);
114 assert.equal(made.kind, ItemOriginKind.crafted);
115 assert.equal(made.displayName, QUESTWARD_GIFT_AUTHOR);
116 assert.equal(made.verb, CraftOriginVerb.made);
117 assert.equal(giftItemOrigin(CraftingItemId.copperOre).verb, GatherOriginVerb.mined);
118 });
119
100 120 test("admin gift credits bank and queues a system letter", () =>
101 121 {
102 122 const harness = makeSimulation({ workerCount: 1 });
@@ -126,11 +146,12 @@ test("admin gift credits bank and queues a system letter", () =>
126 146 assert.equal(result.ok, true);
127 147
128 148 const after = harness.stateDb.getBag(character.character_id);
129 const stickAfter = (after.vault ?? []).reduce(
130 (sum, slot) => sum + (slot?.itemId === ItemId.stick ? (slot.quantity | 0) : 0),
131 0
149 const stickStack = (after.vault ?? []).find((slot) => slot?.itemId === ItemId.stick);
150 assert.equal(stickStack?.quantity, stickBefore + 5);
151 assert.equal(
152 originLabel(stickStack?.origins?.[0]?.origin),
153 "Carved by John Questward"
132 154 );
133 assert.equal(stickAfter, stickBefore + 5);
134 155
135 156 const held = harness.stateDb.listHeldCourierDeliveries(character.character_id);
136 157 const foundHeld = held.some((row) =>
@@ -10,8 +10,11 @@ import {
10 QUESTWARD_GIFT_AUTHOR,
10 QUESTWARD_GIFT_AUTHOR,
11 QUESTWARD_GIFT_ORG
11 QUESTWARD_GIFT_ORG
12} from "../../shared/courier/giftLetters.js";
12} from "../../shared/courier/giftLetters.js";
13import { giftItemOrigin } from "../../shared/courier/giftOrigin.js";
13import { formatLetterSignature } from "../../shared/courier/systemLetters.js";
14import { formatLetterSignature } from "../../shared/courier/systemLetters.js";
14import { ItemId } from "../../shared/definitions/items.js";
15import { ItemId } from "../../shared/definitions/items.js";
16import { CraftingItemId } from "../../shared/definitions/craftingItems.js";
17import { originLabel, ItemOriginKind, CraftOriginVerb, GatherOriginVerb } from "../../shared/items/origin.js";
15import { BlockType } from "../../shared/definitions/tiles.js";
18import { BlockType } from "../../shared/definitions/tiles.js";
16import { createEmptyChunkData, encodeChunkBlob, decodeChunkBlob } from "../src/world/chunkData.js";
19import { createEmptyChunkData, encodeChunkBlob, decodeChunkBlob } from "../src/world/chunkData.js";
17import { GiftService } from "../src/gifts/service.js";
20import { GiftService } from "../src/gifts/service.js";
@@ -97,6 +100,23 @@ test("gift letter body and signature match Questward CEO format", () =>
97 );
100 );
98});
101});
99
102
103test("gift item origins use natural verbs with John Questward", () =>
104{
105 assert.equal(
106 originLabel(giftItemOrigin(ItemId.stick)),
107 "Carved by John Questward"
108 );
109 assert.equal(
110 originLabel(giftItemOrigin(CraftingItemId.copperOre)),
111 "Mined by John Questward"
112 );
113 const made = giftItemOrigin(ItemId.letter);
114 assert.equal(made.kind, ItemOriginKind.crafted);
115 assert.equal(made.displayName, QUESTWARD_GIFT_AUTHOR);
116 assert.equal(made.verb, CraftOriginVerb.made);
117 assert.equal(giftItemOrigin(CraftingItemId.copperOre).verb, GatherOriginVerb.mined);
118});
119
100test("admin gift credits bank and queues a system letter", () =>
120test("admin gift credits bank and queues a system letter", () =>
101{
121{
102 const harness = makeSimulation({ workerCount: 1 });
122 const harness = makeSimulation({ workerCount: 1 });
@@ -126,11 +146,12 @@ test("admin gift credits bank and queues a system letter", () =>
126 assert.equal(result.ok, true);
146 assert.equal(result.ok, true);
127
147
128 const after = harness.stateDb.getBag(character.character_id);
148 const after = harness.stateDb.getBag(character.character_id);
129 const stickAfter = (after.vault ?? []).reduce(
149 const stickStack = (after.vault ?? []).find((slot) => slot?.itemId === ItemId.stick);
130 (sum, slot) => sum + (slot?.itemId === ItemId.stick ? (slot.quantity | 0) : 0),
150 assert.equal(stickStack?.quantity, stickBefore + 5);
131 0
151 assert.equal(
152 originLabel(stickStack?.origins?.[0]?.origin),
153 "Carved by John Questward"
132 );
154 );
133 assert.equal(stickAfter, stickBefore + 5);
134
155
135 const held = harness.stateDb.listHeldCourierDeliveries(character.character_id);
156 const held = harness.stateDb.listHeldCourierDeliveries(character.character_id);
136 const foundHeld = held.some((row) =>
157 const foundHeld = held.some((row) =>
shared/courier/giftOrigin.js added +81 −0
@@ -0,0 +1,81 @@
1 import { ItemId, itemDefinition } from "../definitions/items.js";
2 import { ItemFamilyId } from "../definitions/tierFamilies.js";
3 import { HerbItemId } from "../definitions/herbs.js";
4 import { CRAFT_RECIPES, recipeStationIds } from "../crafting/stationRecipes.js";
5 import
6 {
7 CraftOriginVerb,
8 GatherOriginVerb,
9 craftOrigin,
10 craftOriginVerbForStation,
11 gatherOrigin
12 } from "../items/origin.js";
13 import { QUESTWARD_GIFT_AUTHOR } from "./giftLetters.js";
14
15 const HERB_ITEM_IDS = new Set(Object.values(HerbItemId));
16
17 /** @type {Map<number, string>|null} */
18 let craftStationByOutputId = null;
19
20 function craftStationForOutput (itemId)
21 {
22 if (!craftStationByOutputId)
23 {
24 craftStationByOutputId = new Map();
25 for (const recipe of CRAFT_RECIPES)
26 {
27 const outId = recipe?.output?.itemId | 0;
28 if (!outId || craftStationByOutputId.has(outId))
29 { continue; }
30 const stationId = recipeStationIds(recipe)[0];
31 if (stationId)
32 { craftStationByOutputId.set(outId, stationId); }
33 }
34 }
35 return craftStationByOutputId.get(itemId | 0) ?? null;
36 }
37
38 /**
39 * Natural player-style origin for an admin gift, attributed to John Questward
40 * (e.g. `Smithed by John Questward`, `Mined by John Questward`).
41 */
42 export function giftItemOrigin (itemId, displayName = QUESTWARD_GIFT_AUTHOR)
43 {
44 const name = String(displayName ?? "").trim() || QUESTWARD_GIFT_AUTHOR;
45 const id = itemId | 0;
46 const def = itemDefinition(id);
47 const key = String(def?.key ?? "");
48 const familyId = def?.familyId ?? null;
49
50 if (
51 familyId === ItemFamilyId.ore
52 || def?.defaultState === "ore"
53 || key.endsWith("-ore")
54 || key === "coal"
55 )
56 { return gatherOrigin(GatherOriginVerb.mined, name); }
57
58 if (familyId === ItemFamilyId.log || def?.defaultState === "log" || key.endsWith("-log"))
59 { return gatherOrigin(GatherOriginVerb.felled, name); }
60
61 if (def?.fishSpeciesId && (def.cookState === "raw" || key.startsWith("uncooked-")))
62 { return gatherOrigin(GatherOriginVerb.caught, name); }
63
64 if (HERB_ITEM_IDS.has(id) || id === ItemId.flower)
65 { return gatherOrigin(GatherOriginVerb.picked, name); }
66
67 if (def?.defaultState === "wool")
68 { return gatherOrigin(GatherOriginVerb.sheared, name); }
69
70 if (id === ItemId.potion || def?.potion)
71 { return craftOrigin(CraftOriginVerb.brewed, name); }
72
73 if (id === ItemId.dye)
74 { return craftOrigin(CraftOriginVerb.mixed, name); }
75
76 const stationId = craftStationForOutput(id);
77 if (stationId)
78 { return craftOrigin(craftOriginVerbForStation(stationId), name); }
79
80 return craftOrigin(CraftOriginVerb.made, name);
81 }
@@ -0,0 +1,81 @@
1import { ItemId, itemDefinition } from "../definitions/items.js";
2import { ItemFamilyId } from "../definitions/tierFamilies.js";
3import { HerbItemId } from "../definitions/herbs.js";
4import { CRAFT_RECIPES, recipeStationIds } from "../crafting/stationRecipes.js";
5import
6{
7 CraftOriginVerb,
8 GatherOriginVerb,
9 craftOrigin,
10 craftOriginVerbForStation,
11 gatherOrigin
12} from "../items/origin.js";
13import { QUESTWARD_GIFT_AUTHOR } from "./giftLetters.js";
14
15const HERB_ITEM_IDS = new Set(Object.values(HerbItemId));
16
17/** @type {Map<number, string>|null} */
18let craftStationByOutputId = null;
19
20function craftStationForOutput (itemId)
21{
22 if (!craftStationByOutputId)
23 {
24 craftStationByOutputId = new Map();
25 for (const recipe of CRAFT_RECIPES)
26 {
27 const outId = recipe?.output?.itemId | 0;
28 if (!outId || craftStationByOutputId.has(outId))
29 { continue; }
30 const stationId = recipeStationIds(recipe)[0];
31 if (stationId)
32 { craftStationByOutputId.set(outId, stationId); }
33 }
34 }
35 return craftStationByOutputId.get(itemId | 0) ?? null;
36}
37
38/**
39 * Natural player-style origin for an admin gift, attributed to John Questward
40 * (e.g. `Smithed by John Questward`, `Mined by John Questward`).
41 */
42export function giftItemOrigin (itemId, displayName = QUESTWARD_GIFT_AUTHOR)
43{
44 const name = String(displayName ?? "").trim() || QUESTWARD_GIFT_AUTHOR;
45 const id = itemId | 0;
46 const def = itemDefinition(id);
47 const key = String(def?.key ?? "");
48 const familyId = def?.familyId ?? null;
49
50 if (
51 familyId === ItemFamilyId.ore
52 || def?.defaultState === "ore"
53 || key.endsWith("-ore")
54 || key === "coal"
55 )
56 { return gatherOrigin(GatherOriginVerb.mined, name); }
57
58 if (familyId === ItemFamilyId.log || def?.defaultState === "log" || key.endsWith("-log"))
59 { return gatherOrigin(GatherOriginVerb.felled, name); }
60
61 if (def?.fishSpeciesId && (def.cookState === "raw" || key.startsWith("uncooked-")))
62 { return gatherOrigin(GatherOriginVerb.caught, name); }
63
64 if (HERB_ITEM_IDS.has(id) || id === ItemId.flower)
65 { return gatherOrigin(GatherOriginVerb.picked, name); }
66
67 if (def?.defaultState === "wool")
68 { return gatherOrigin(GatherOriginVerb.sheared, name); }
69
70 if (id === ItemId.potion || def?.potion)
71 { return craftOrigin(CraftOriginVerb.brewed, name); }
72
73 if (id === ItemId.dye)
74 { return craftOrigin(CraftOriginVerb.mixed, name); }
75
76 const stationId = craftStationForOutput(id);
77 if (stationId)
78 { return craftOrigin(craftOriginVerbForStation(stationId), name); }
79
80 return craftOrigin(CraftOriginVerb.made, name);
81}
shared/courier/systemLetters.js +1 −0
@@ -9,6 +9,7 @@ export {
9 9 formatGiftLetterBody,
10 10 formatGiftItemBullet
11 11 } from "./giftLetters.js";
12 export { giftItemOrigin } from "./giftOrigin.js";
12 13
13 14 export function isCentralExchangeLetter (instance)
14 15 {
@@ -9,6 +9,7 @@ export {
9 formatGiftLetterBody,
9 formatGiftLetterBody,
10 formatGiftItemBullet
10 formatGiftItemBullet
11} from "./giftLetters.js";
11} from "./giftLetters.js";
12export { giftItemOrigin } from "./giftOrigin.js";
12
13
13export function isCentralExchangeLetter (instance)
14export function isCentralExchangeLetter (instance)
14{
15{