Feature request: Update the clan stock to include the furnitures that are set to be sold and/or set onto stall

[BillTheBeast]

What do you want to see in the API?

Update the clan stock to include the furnitures that are set to be sold and/or set onto stall (Ie. are currently placed into the fleamarket)

How do you think this should work?

Currently the clans furniture are split into three groups:

• Stock that contains most of the furniture clan has and can use.
  • These are fetched through the Stock endpoint.
• Furniture that are approved for selling but aren't yet placed onto the stall.
  • These are fetched through the fleamarket endpoint.
    • The problem is that this endpoint contains all furniture in the fleamarket from every clan. This is mostly redundant now since all of the furniture in fleamarket should be fetched with the clans stalls. And also is liable to be clogged due to the number to furniture there would eventually be in this.
• Furniture placed onto stalls.
  • These are fetched with the stalldata.

The second group is currently very problematic due to the things that I noted under it.

By deprecating the second group and moving it under allowing also the furniture that are tagged to be sold (as well as the furniture placed into stalls) also be available through the stock solves a lot of the issues here as that allows clients an easy access to all of the clans furniture regardless where they are.

• Note: The furniture that are placed onto the stall should still also be available through the stall endpoint as this is how other clans would gain access to it.

The furniture currently has a "status" field that is mainly used to track the status of the furniture when it is approved to be sold. This could be expanded to also include a status for when the furniture is just "normally" in the stock. (InStock - enum). This would make it possible to differentiate if the furniture is being sold or not.

Any additional info?

The status field values are currently: "available", "shipping" and "booked".
There is lacking documentation on what each of these actually means. This should also be improved.

My personal understanding is that:
"available" = Tagged as to be sold but not on stall yet.
"shipping" = On stall waiting to be bought
"booked" = Another clan has reserved the furniture and are in a process of voting whether to buy the furniture.

But you should double check if this is how it actually works and document them properly.

[CapoMK25]

Assigned to myself, I'll start work on this by the latest when my PR is merged, possibly earlier since the risk of touching the exact same files is fairly low, max the fleamarket.service.ts if that.

[CapoMK25]

@BillTheBeast Working on #841. Quick clarifications:

For the Stock response shape: should fleaMarketItems be a separate field alongside items, or merged into a single flat list with a status field on each?

The InStock status: do Items in the regular Item collection need an actual status field, or is "no status field" implicitly InStock?

Will deprecate GET /fleaMarket with @deprecated tag (keep functional) per the issue description. I won't delete it outright to preserve it instead.

[CapoMK25]

FYI for question 2, I went ahead and checked item.schema.ts and Items currently have no status field at all (only name, weight, price etc.). Adding one means a schema change + figuring out what to do with existing documents (default them to IN_STOCK, or treat missing-status as implicit IN_STOCK). Both are workable, but worth knowing it's a schema change either way. @BillTheBeast

[BillTheBeast]

For the Stock response shape: should fleaMarketItems be a separate field alongside items, or merged into a single flat list with a status field on each?

Either works realistically. Whichever is easier for you to handle and maintain.

The InStock status: do Items in the regular Item collection need an actual status field, or is "no status field" implicitly InStock?

If the items normally in stall and those that are set to be sold/ in stall are in separate lists then there likely doesn't need to be an status field for the "normal" stock items.

Leaving the field blank (in unified list) could also work but it likely would be easier to determine that thing went right when there is a field and value for when the furniture are in stock.