@spawnco/sdk-types 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './v1';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export * from './v1';

package/dist/index.mjs

@@ -0,0 +1 @@
+export * from './v1.js';

package/dist/v1.d.ts

@@ -0,0 +1,157 @@
+type Scope = "global" | `room:${string}` | `user:${string}`;
+type Cost = {
+    readUnits?: number;
+    writeUnits?: number;
+    usd?: number;
+};
+type Item = {
+    id: string;
+    data: unknown;
+};
+type Balance = Record<string, number>;
+interface User {
+    id: string;
+    username: string;
+    avatarURL: string;
+    isGuest: boolean;
+}
+interface UserModule {
+    me(): Promise<User>;
+    upgradeGuest(): Promise<User>;
+}
+interface StorageKV {
+    get<T = unknown>(key: string, opts?: {
+        scope?: Scope;
+    }): Promise<{
+        value: T | null;
+        rev?: string;
+    }>;
+    put<T = unknown>(key: string, value: T, opts?: {
+        scope?: Scope;
+        rev?: string;
+    }): Promise<{
+        rev: string;
+        cost: Cost;
+    }>;
+    del(key: string, opts?: {
+        scope?: Scope;
+        rev?: string;
+    }): Promise<{
+        cost: Cost;
+    }>;
+}
+interface StorageObj {
+    get<T = unknown>(key: string, opts?: {
+        scope?: Scope;
+    }): Promise<{
+        value: T | null;
+        rev?: string;
+    }>;
+    set<T = unknown>(key: string, value: T, opts?: {
+        scope?: Scope;
+        rev?: string;
+    }): Promise<{
+        rev: string;
+        cost: Cost;
+    }>;
+    del(key: string, opts?: {
+        scope?: Scope;
+        rev?: string;
+    }): Promise<{
+        cost: Cost;
+    }>;
+}
+interface StorageLedger {
+    append<T>(stream: string, data: T): Promise<{
+        id: string;
+        ts: number;
+        data: T;
+        cost: Cost;
+    }>;
+    query<T>(stream: string, cursor?: string, limit?: number): Promise<{
+        entries: {
+            id: string;
+            ts: number;
+            data: T;
+        }[];
+        next?: string;
+        cost: Cost;
+    }>;
+}
+interface StorageModule {
+    kv: StorageKV;
+    obj: StorageObj;
+    ledger: StorageLedger;
+}
+interface RoomInstance {
+    id: string;
+    state(): any;
+    broadcast<T>(type: string, payload: T): void;
+    on<T = any>(type: string, cb: (payload: T, peerId: string) => void): void;
+    unsubscribe<T = any>(type: string, cb: (payload: T, peerId: string) => void): void;
+    leave(): void;
+}
+interface RoomModule {
+    quick(): Promise<RoomInstance>;
+    create(opts?: {
+        maxPlayers?: number;
+        meta?: any;
+    }): Promise<string>;
+    join(roomId: string): Promise<RoomInstance>;
+}
+interface EconomyModule {
+    catalog(): Promise<{
+        id: string;
+        priceSBX: number;
+        meta?: any;
+    }[]>;
+    buy(itemId: string): Promise<{
+        ok: boolean;
+        receipt: string;
+    }>;
+    balance(kind?: "sbx" | "usd"): Promise<number>;
+}
+interface InventoryState {
+    items: Item[];
+    balances: Balance;
+    rev: string;
+}
+interface InventoryModule {
+    list(): Promise<InventoryState>;
+    claim(dropId: string, opts?: {
+        rev?: string;
+    }): Promise<InventoryState>;
+    on(event: "update", cb: (diff: Partial<InventoryState>) => void): void;
+}
+export interface SpawnClientSDK__V1 {
+    user: UserModule;
+    storage: StorageModule;
+    room: RoomModule;
+    economy: EconomyModule;
+    inventory: InventoryModule;
+    ai?: never;
+    auction?: never;
+}
+export interface SpawnClientSDK__V0 {
+    ready: () => Promise<boolean>;
+    user: UserModule;
+}
+interface WorkerInventory {
+    applyDiff(userId: string, diff: {
+        addItems?: Item[];
+        removeItems?: string[];
+        incBalance?: Balance;
+    }): Promise<void>;
+}
+interface WorkerEconomy {
+    creditSBX(userId: string, amount: number): Promise<void>;
+    grant(userId: string, itemOrCoins: string | number): Promise<void>;
+}
+export interface SpawnServerSDK__V1 {
+    storage: StorageModule;
+    room: RoomModule;
+    inventory: WorkerInventory;
+    economy: WorkerEconomy;
+}
+export {};
+//# sourceMappingURL=v1.d.ts.map

package/dist/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../src/v1.ts"],"names":[],"mappings":"AACA,KAAK,KAAK,GAAG,QAAQ,GAAG,QAAQ,MAAM,EAAE,GAAG,QAAQ,MAAM,EAAE,CAAC;AAC5D,KAAK,IAAI,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACtE,KAAK,IAAI,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AAC1C,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtC,UAAU,IAAI;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB;AAGD,UAAU,UAAU;IAClB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AAGD,UAAU,SAAS;IACjB,GAAG,CAAC,CAAC,GAAG,OAAO,EACb,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC;QAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9C,GAAG,CAAC,CAAC,GAAG,OAAO,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,EACR,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACxC,GAAG,CACD,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CAC5B;AAED,UAAU,UAAU;IAClB,GAAG,CAAC,CAAC,GAAG,OAAO,EACb,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,GACvB,OAAO,CAAC;QAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9C,GAAG,CAAC,CAAC,GAAG,OAAO,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,EACR,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACxC,GAAG,CACD,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GACrC,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CAC5B;AAED,UAAU,aAAa;IACrB,MAAM,CAAC,CAAC,EACN,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,CAAC,GACN,OAAO,CAAC;QACT,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,CAAC,CAAC;QACR,IAAI,EAAE,IAAI,CAAC;KACZ,CAAC,CAAC;IACH,KAAK,CAAC,CAAC,EACL,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC;QACT,OAAO,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,CAAC,CAAA;SAAE,EAAE,CAAC;QAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,IAAI,CAAC;KACZ,CAAC,CAAC;CACJ;AAED,UAAU,aAAa;IACrB,EAAE,EAAE,SAAS,CAAC;IACd,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,EAAE,aAAa,CAAC;CACvB;AAGD,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,IAAI,GAAG,CAAC;IACb,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAC7C,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,WAAW,CAAC,CAAC,GAAG,GAAG,EACjB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GACvC,IAAI,CAAC;IACR,KAAK,IAAI,IAAI,CAAC;CACf;AAED,UAAU,UAAU;IAClB,KAAK,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/B,MAAM,CAAC,IAAI,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC7C;AAGD,UAAU,aAAa;IACrB,OAAO,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAE,EAAE,CAAC,CAAC;IACnE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAChD;AAGD,UAAU,cAAc;IACtB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,eAAe;IACvB,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACxE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;CACxE;AAGD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,aAAa,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAE3B,EAAE,CAAC,EAAE,KAAK,CAAC;IACX,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAI,EAAE,UAAU,CAAC;CAClB;AAGD,UAAU,eAAe;IACvB,SAAS,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED,UAAU,aAAa;IACrB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;CACxB"}

package/dist/v1.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@spawnco/sdk-types",
+  "version": "0.0.1",
+  "description": "TypeScript type definitions for Spawn SDK",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "keywords": [
+    "spawn",
+    "sdk",
+    "types",
+    "typescript"
+  ],
+  "author": "Spawn",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './v1';

package/src/v1.ts

@@ -0,0 +1,158 @@
+// Common types
+type Scope = "global" | `room:${string}` | `user:${string}`;
+type Cost = { readUnits?: number; writeUnits?: number; usd?: number };
+type Item = { id: string; data: unknown };
+type Balance = Record<string, number>;
+
+interface User {
+  id: string;
+  username: string;
+  avatarURL: string;
+  isGuest: boolean;
+}
+
+// User module
+interface UserModule {
+  me(): Promise<User>;
+  upgradeGuest(): Promise<User>; // prompts sign-in
+}
+
+// Storage module
+interface StorageKV {
+  get<T = unknown>(
+    key: string,
+    opts?: { scope?: Scope }
+  ): Promise<{ value: T | null; rev?: string }>;
+  put<T = unknown>(
+    key: string,
+    value: T,
+    opts?: { scope?: Scope; rev?: string }
+  ): Promise<{ rev: string; cost: Cost }>;
+  del(
+    key: string,
+    opts?: { scope?: Scope; rev?: string }
+  ): Promise<{ cost: Cost }>;
+}
+
+interface StorageObj {
+  get<T = unknown>(
+    key: string,
+    opts?: { scope?: Scope }
+  ): Promise<{ value: T | null; rev?: string }>;
+  set<T = unknown>(
+    key: string,
+    value: T,
+    opts?: { scope?: Scope; rev?: string }
+  ): Promise<{ rev: string; cost: Cost }>;
+  del(
+    key: string,
+    opts?: { scope?: Scope; rev?: string }
+  ): Promise<{ cost: Cost }>;
+}
+
+interface StorageLedger {
+  append<T>(
+    stream: string,
+    data: T
+  ): Promise<{
+    id: string;
+    ts: number;
+    data: T;
+    cost: Cost;
+  }>;
+  query<T>(
+    stream: string,
+    cursor?: string,
+    limit?: number
+  ): Promise<{
+    entries: { id: string; ts: number; data: T }[];
+    next?: string;
+    cost: Cost;
+  }>;
+}
+
+interface StorageModule {
+  kv: StorageKV;
+  obj: StorageObj;
+  ledger: StorageLedger;
+}
+
+// Room module
+interface RoomInstance {
+  id: string;
+  state(): any;
+  broadcast<T>(type: string, payload: T): void;
+  on<T = any>(type: string, cb: (payload: T, peerId: string) => void): void;
+  unsubscribe<T = any>(
+    type: string,
+    cb: (payload: T, peerId: string) => void
+  ): void;
+  leave(): void;
+}
+
+interface RoomModule {
+  quick(): Promise<RoomInstance>;
+  create(opts?: { maxPlayers?: number; meta?: any }): Promise<string>;
+  join(roomId: string): Promise<RoomInstance>;
+}
+
+// Economy module
+interface EconomyModule {
+  catalog(): Promise<{ id: string; priceSBX: number; meta?: any }[]>;
+  buy(itemId: string): Promise<{ ok: boolean; receipt: string }>;
+  balance(kind?: "sbx" | "usd"): Promise<number>;
+}
+
+// Inventory module
+interface InventoryState {
+  items: Item[];
+  balances: Balance;
+  rev: string;
+}
+
+interface InventoryModule {
+  list(): Promise<InventoryState>;
+  claim(dropId: string, opts?: { rev?: string }): Promise<InventoryState>;
+  on(event: "update", cb: (diff: Partial<InventoryState>) => void): void;
+}
+
+// Client SDK interface
+export interface SpawnClientSDK__V1 {
+  user: UserModule;
+  storage: StorageModule;
+  room: RoomModule;
+  economy: EconomyModule;
+  inventory: InventoryModule;
+  // Reserved for future use
+  ai?: never;
+  auction?: never;
+}
+
+export interface SpawnClientSDK__V0 {
+  ready: () => Promise<boolean>;
+  user: UserModule;
+}
+
+// Worker interface
+interface WorkerInventory {
+  applyDiff(
+    userId: string,
+    diff: {
+      addItems?: Item[];
+      removeItems?: string[];
+      incBalance?: Balance;
+    }
+  ): Promise<void>;
+}
+
+interface WorkerEconomy {
+  creditSBX(userId: string, amount: number): Promise<void>;
+  grant(userId: string, itemOrCoins: string | number): Promise<void>;
+}
+
+export interface SpawnServerSDK__V1 {
+  storage: StorageModule;
+  room: RoomModule;
+  inventory: WorkerInventory;
+  economy: WorkerEconomy;
+}