@voltro/plugin-inventory 0.0.0-stage → 0.87.0

package/dist/reservation.js

@@ -0,0 +1,85 @@
+import { inventoryError as e } from "./errors.js";
+import { identifier as t, integer as n, list as r, object as i } from "./capture.js";
+//#region src/reservation.ts
+var a = (a) => {
+	let o = r(a, 32).map((e) => {
+		let r = i(e, ["instanceId", "qty"]);
+		return Object.freeze({
+			instanceId: t(r.instanceId),
+			qty: n(r.qty, 1, 1e6)
+		});
+	}).sort((e, t) => e.instanceId < t.instanceId ? -1 : +(e.instanceId > t.instanceId));
+	if (!o.length || new Set(o.map((e) => e.instanceId)).size !== o.length) throw e("invalid_input");
+	return Object.freeze(o);
+}, o = (n) => {
+	let r = i(n, [
+		"tenantId",
+		"owner",
+		"reservationId"
+	]), a = i(r.owner, ["ownerKind", "ownerId"]);
+	if (a.ownerKind !== "player" && a.ownerKind !== "guild") throw e("invalid_input");
+	return Object.freeze({
+		tenantId: t(r.tenantId),
+		reservationId: t(r.reservationId),
+		owner: Object.freeze({
+			ownerKind: a.ownerKind,
+			ownerId: t(a.ownerId)
+		})
+	});
+}, s = (e) => {
+	let t = i(e, [
+		"tenantId",
+		"owner",
+		"reservationId",
+		"items"
+	]);
+	return Object.freeze({
+		...o({
+			tenantId: t.tenantId,
+			owner: t.owner,
+			reservationId: t.reservationId
+		}),
+		items: a(t.items)
+	});
+}, c = (t) => {
+	let n = i(t, [
+		"tenantId",
+		"from",
+		"to",
+		"reservationId"
+	]), r = o({
+		tenantId: n.tenantId,
+		owner: n.from,
+		reservationId: n.reservationId
+	}), a = o({
+		tenantId: n.tenantId,
+		owner: n.to,
+		reservationId: n.reservationId
+	});
+	if (r.owner.ownerKind === a.owner.ownerKind && r.owner.ownerId === a.owner.ownerId) throw e("invalid_input");
+	return Object.freeze({
+		tenantId: r.tenantId,
+		reservationId: r.reservationId,
+		from: r.owner,
+		to: a.owner
+	});
+}, l = (e) => {
+	let t = i(e, [
+		"tenantId",
+		"from",
+		"to",
+		"reservationId",
+		"items"
+	]), n = c({
+		tenantId: t.tenantId,
+		from: t.from,
+		to: t.to,
+		reservationId: t.reservationId
+	});
+	return Object.freeze({
+		...n,
+		items: a(t.items)
+	});
+};
+//#endregion
+export { o as captureInventoryReleaseInput, c as captureInventoryReservationTransferInput, s as captureInventoryReserveInput, l as captureInventoryReserveTransferInput, a as captureReservationItems };

package/dist/rpc.d.ts

@@ -0,0 +1,145 @@
+import { ActionProcedureDescriptor } from '@voltro/protocol';
+import { PluginRpcClientDescriptor } from '@voltro/protocol';
+import { QueryProcedureDescriptor } from '@voltro/protocol';
+import { Schema } from 'effect';
+import { YieldableError } from 'effect/Cause';
+
+export declare const CatalogItemSchema: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly schemaVersion: Schema.Number;
+    readonly kind: Schema.Literals<readonly ["consumable", "equipment", "cosmetic", "currencyBundle", "key", "mod"]>;
+    readonly stackable: Schema.Boolean;
+    readonly maxStack: Schema.Number;
+    readonly tradable: Schema.Boolean;
+    readonly rarity: Schema.String;
+    readonly tags: Schema.$Array<Schema.String>;
+    readonly equipSlot: Schema.NullOr<Schema.String>;
+    readonly expiresAfter: Schema.NullOr<Schema.Number>;
+    readonly display: Schema.Struct<{
+        readonly nameKey: Schema.String;
+        readonly icon: Schema.NullOr<Schema.String>;
+    }>;
+    readonly attributes: Schema.Unknown;
+    readonly instanceDefaults: Schema.Unknown;
+}>;
+
+export declare const CatalogSnapshotSchema: Schema.Struct<{
+    readonly revision: Schema.String;
+    readonly items: Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly schemaVersion: Schema.Number;
+        readonly kind: Schema.Literals<readonly ["consumable", "equipment", "cosmetic", "currencyBundle", "key", "mod"]>;
+        readonly stackable: Schema.Boolean;
+        readonly maxStack: Schema.Number;
+        readonly tradable: Schema.Boolean;
+        readonly rarity: Schema.String;
+        readonly tags: Schema.$Array<Schema.String>;
+        readonly equipSlot: Schema.NullOr<Schema.String>;
+        readonly expiresAfter: Schema.NullOr<Schema.Number>;
+        readonly display: Schema.Struct<{
+            readonly nameKey: Schema.String;
+            readonly icon: Schema.NullOr<Schema.String>;
+        }>;
+        readonly attributes: Schema.Unknown;
+        readonly instanceDefaults: Schema.Unknown;
+    }>>;
+}>;
+
+export declare const INVENTORY_NAME = "@voltro/plugin-inventory";
+
+export declare const inventoryCatalogDescriptor: QueryProcedureDescriptor<"inventory.catalog", Schema.Struct<{}>, Schema.Struct<{
+    readonly revision: Schema.String;
+    readonly items: Schema.$Array<Schema.Struct<{
+        readonly id: Schema.String;
+        readonly schemaVersion: Schema.Number;
+        readonly kind: Schema.Literals<readonly ["consumable", "equipment", "cosmetic", "currencyBundle", "key", "mod"]>;
+        readonly stackable: Schema.Boolean;
+        readonly maxStack: Schema.Number;
+        readonly tradable: Schema.Boolean;
+        readonly rarity: Schema.String;
+        readonly tags: Schema.$Array<Schema.String>;
+        readonly equipSlot: Schema.NullOr<Schema.String>;
+        readonly expiresAfter: Schema.NullOr<Schema.Number>;
+        readonly display: Schema.Struct<{
+            readonly nameKey: Schema.String;
+            readonly icon: Schema.NullOr<Schema.String>;
+        }>;
+        readonly attributes: Schema.Unknown;
+        readonly instanceDefaults: Schema.Unknown;
+    }>>;
+}>, typeof InventoryError>;
+
+export declare const inventoryEquipDescriptor: ActionProcedureDescriptor<"inventory.equip", Schema.Struct<{
+    readonly slotSet: Schema.String;
+    readonly slot: Schema.String;
+    readonly instanceId: Schema.NullOr<Schema.String>;
+    readonly requestId: Schema.String;
+}>, Schema.Struct<{
+    readonly operationId: Schema.String;
+    readonly kind: Schema.Literals<readonly ["grant", "consume", "equip", "expire", "craft", "reserve", "release", "transfer-out", "transfer-in"]>;
+    readonly changes: Schema.$Array<Schema.Struct<{
+        readonly instanceId: Schema.String;
+        readonly delta: Schema.Number;
+    }>>;
+    readonly at: Schema.Number;
+}>, typeof InventoryError>;
+
+/** Public errors carry codes, never subjects, catalog values or provider causes. */
+declare class InventoryError extends InventoryError_base {
+}
+
+declare const InventoryError_base: Schema.Class<InventoryError, Schema.TaggedStruct<"InventoryError", {
+    readonly code: Schema.Literals<readonly ["invalid_input", "invalid_record", "invalid_item", "invalid_attributes", "conflict", "forbidden", "not_found", "unavailable", "limit_exceeded", "erased", "insufficient_items", "insufficient_funds", "payment_refused", "locked", "expired", "invalid_slot"]>;
+}>, YieldableError>;
+
+export declare const InventoryInstanceSchema: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly itemId: Schema.String;
+    readonly schemaVersion: Schema.Number;
+    readonly qty: Schema.Number;
+    readonly attributes: Schema.Unknown;
+    readonly acquiredAt: Schema.Number;
+    readonly expiresAt: Schema.NullOr<Schema.Number>;
+    readonly locked: Schema.Boolean;
+    readonly source: Schema.String;
+}>;
+
+export declare const inventoryLoadoutDescriptor: QueryProcedureDescriptor<"inventory.loadout", Schema.Struct<{
+    readonly slotSet: Schema.String;
+}>, Schema.$Array<Schema.Struct<{
+    readonly slotSet: Schema.String;
+    readonly slot: Schema.String;
+    readonly instanceId: Schema.String;
+}>>, typeof InventoryError>;
+
+export declare const InventoryLoadoutSchema: Schema.Struct<{
+    readonly slotSet: Schema.String;
+    readonly slot: Schema.String;
+    readonly instanceId: Schema.String;
+}>;
+
+export declare const inventoryMineDescriptor: QueryProcedureDescriptor<"inventory.mine", Schema.Struct<{}>, Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly itemId: Schema.String;
+    readonly schemaVersion: Schema.Number;
+    readonly qty: Schema.Number;
+    readonly attributes: Schema.Unknown;
+    readonly acquiredAt: Schema.Number;
+    readonly expiresAt: Schema.NullOr<Schema.Number>;
+    readonly locked: Schema.Boolean;
+    readonly source: Schema.String;
+}>>, typeof InventoryError>;
+
+export declare const InventoryReceiptSchema: Schema.Struct<{
+    readonly operationId: Schema.String;
+    readonly kind: Schema.Literals<readonly ["grant", "consume", "equip", "expire", "craft", "reserve", "release", "transfer-out", "transfer-in"]>;
+    readonly changes: Schema.$Array<Schema.Struct<{
+        readonly instanceId: Schema.String;
+        readonly delta: Schema.Number;
+    }>>;
+    readonly at: Schema.Number;
+}>;
+
+export declare const inventoryRpcClientImports: readonly PluginRpcClientDescriptor[];
+
+export { }

package/dist/rpc.js

@@ -0,0 +1,135 @@
+import { InventoryError as e } from "./errors.js";
+import { Schema as t } from "effect";
+import { defineAction as n, defineQuery as r } from "@voltro/protocol";
+//#region src/rpc.ts
+var i = "@voltro/plugin-inventory", a = t.Struct({
+	id: t.String,
+	itemId: t.String,
+	schemaVersion: t.Number,
+	qty: t.Number,
+	attributes: t.Unknown,
+	acquiredAt: t.Number,
+	expiresAt: t.NullOr(t.Number),
+	locked: t.Boolean,
+	source: t.String
+}), o = t.Struct({
+	slotSet: t.String,
+	slot: t.String,
+	instanceId: t.String
+}), s = t.Struct({
+	operationId: t.String,
+	kind: t.Literals([
+		"grant",
+		"consume",
+		"equip",
+		"expire",
+		"craft",
+		"reserve",
+		"release",
+		"transfer-out",
+		"transfer-in"
+	]),
+	changes: t.Array(t.Struct({
+		instanceId: t.String,
+		delta: t.Number
+	})),
+	at: t.Number
+}), c = t.Struct({
+	id: t.String,
+	schemaVersion: t.Number,
+	kind: t.Literals([
+		"consumable",
+		"equipment",
+		"cosmetic",
+		"currencyBundle",
+		"key",
+		"mod"
+	]),
+	stackable: t.Boolean,
+	maxStack: t.Number,
+	tradable: t.Boolean,
+	rarity: t.String,
+	tags: t.Array(t.String),
+	equipSlot: t.NullOr(t.String),
+	expiresAfter: t.NullOr(t.Number),
+	display: t.Struct({
+		nameKey: t.String,
+		icon: t.NullOr(t.String)
+	}),
+	attributes: t.Unknown,
+	instanceDefaults: t.Unknown
+}), l = t.Struct({
+	revision: t.String,
+	items: t.Array(c)
+}), u = "The installed service requires a verified user or guest; tenant and owner come from its authenticated Subject.", d = r({
+	name: "inventory.mine",
+	input: t.Struct({}),
+	output: t.Array(a),
+	error: e,
+	source: ["_voltro_inv_items", "_voltro_inv_subjects"],
+	openAccess: u
+}), f = r({
+	name: "inventory.loadout",
+	input: t.Struct({ slotSet: t.String }),
+	output: t.Array(o),
+	error: e,
+	source: [
+		"_voltro_inv_items",
+		"_voltro_inv_loadouts",
+		"_voltro_inv_subjects"
+	],
+	openAccess: u
+}), p = r({
+	name: "inventory.catalog",
+	input: t.Struct({}),
+	output: l,
+	error: e,
+	source: ["_voltro_inv_catalog", "_voltro_inv_catalog_heads"],
+	openAccess: "Authenticated user or guest reads only the app-configured channel and locale in the Subject tenant."
+}), m = n({
+	name: "inventory.equip",
+	input: t.Struct({
+		slotSet: t.String,
+		slot: t.String,
+		instanceId: t.NullOr(t.String),
+		requestId: t.String
+	}),
+	output: s,
+	error: e,
+	openAccess: "Only an equip/unequip intention is accepted. The installed service derives owner and tenant, checks possession and slot, and never accepts client state."
+}), h = [
+	{
+		tag: "inventory.mine",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-inventory/rpc",
+			name: "inventoryMineDescriptor"
+		}
+	},
+	{
+		tag: "inventory.loadout",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-inventory/rpc",
+			name: "inventoryLoadoutDescriptor"
+		}
+	},
+	{
+		tag: "inventory.catalog",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-inventory/rpc",
+			name: "inventoryCatalogDescriptor"
+		}
+	},
+	{
+		tag: "inventory.equip",
+		kind: "action",
+		import: {
+			module: "@voltro/plugin-inventory/rpc",
+			name: "inventoryEquipDescriptor"
+		}
+	}
+];
+//#endregion
+export { c as CatalogItemSchema, l as CatalogSnapshotSchema, i as INVENTORY_NAME, a as InventoryInstanceSchema, o as InventoryLoadoutSchema, s as InventoryReceiptSchema, p as inventoryCatalogDescriptor, m as inventoryEquipDescriptor, f as inventoryLoadoutDescriptor, d as inventoryMineDescriptor, h as inventoryRpcClientImports };