@spawnco/sdk-types 0.0.21 → 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.mts +33 -1
  2. package/dist/index.d.ts +33 -1
  3. package/package.json +1 -1
  4. package/src/v1.ts +50 -0
package/dist/index.d.mts CHANGED
@@ -58,6 +58,23 @@ interface SpawnClientSDK__V1<TConfig = any> {
58
58
  analytics: {
59
59
  track(event: string, data: Record<string, any>): Promise<void>;
60
60
  };
61
+ leaderboard: {
62
+ submit(leaderboardId: string, score: number): Promise<{
63
+ rank: number;
64
+ improved: boolean;
65
+ }>;
66
+ top(leaderboardId: string, options?: {
67
+ period?: 'today' | 'week' | 'month' | 'all';
68
+ limit?: number;
69
+ }): Promise<LeaderboardEntry[]>;
70
+ around(leaderboardId: string, options?: {
71
+ period?: 'today' | 'week' | 'month' | 'all';
72
+ range?: number;
73
+ }): Promise<{
74
+ entries: LeaderboardEntry[];
75
+ myRank: number;
76
+ }>;
77
+ };
61
78
  }
62
79
  interface SpawnServerSDK__V1<TConfig = any> {
63
80
  user: {
@@ -116,6 +133,13 @@ interface SpawnServerSDK__V1<TConfig = any> {
116
133
  delete(key: string): Promise<void>;
117
134
  };
118
135
  };
136
+ leaderboard: {
137
+ submit(userId: string, leaderboardId: string, score: number): Promise<void>;
138
+ getMultiple(leaderboardIds: string[], options?: {
139
+ period?: 'today' | 'week' | 'month' | 'all';
140
+ limit?: number;
141
+ }): Promise<Record<string, LeaderboardEntry[]>>;
142
+ };
119
143
  }
120
144
  interface TokenPayload {
121
145
  sub: string;
@@ -154,7 +178,15 @@ interface Item {
154
178
  id: string;
155
179
  data?: Record<string, any>;
156
180
  }
181
+ interface LeaderboardEntry {
182
+ rank: number;
183
+ username: string;
184
+ avatarUrl?: string;
185
+ score: number;
186
+ isMe?: boolean;
187
+ timestamp: number;
188
+ }
157
189
  type SpawnClientSDK__V0<TConfig = any> = Omit<SpawnClientSDK__V1<TConfig>, 'economy' | 'inventory'>;
158
190
  type SpawnServerSDK__V0<TConfig = any> = Omit<SpawnServerSDK__V1<TConfig>, 'economy' | 'inventory' | 'room'>;
159
191
 
160
- export type { Item, Room, RoomInfo, RoomVisibility, SpawnClientSDK__V0, SpawnClientSDK__V1, SpawnServerSDK__V0, SpawnServerSDK__V1, TokenPayload, User };
192
+ export type { Item, LeaderboardEntry, Room, RoomInfo, RoomVisibility, SpawnClientSDK__V0, SpawnClientSDK__V1, SpawnServerSDK__V0, SpawnServerSDK__V1, TokenPayload, User };
package/dist/index.d.ts CHANGED
@@ -58,6 +58,23 @@ interface SpawnClientSDK__V1<TConfig = any> {
58
58
  analytics: {
59
59
  track(event: string, data: Record<string, any>): Promise<void>;
60
60
  };
61
+ leaderboard: {
62
+ submit(leaderboardId: string, score: number): Promise<{
63
+ rank: number;
64
+ improved: boolean;
65
+ }>;
66
+ top(leaderboardId: string, options?: {
67
+ period?: 'today' | 'week' | 'month' | 'all';
68
+ limit?: number;
69
+ }): Promise<LeaderboardEntry[]>;
70
+ around(leaderboardId: string, options?: {
71
+ period?: 'today' | 'week' | 'month' | 'all';
72
+ range?: number;
73
+ }): Promise<{
74
+ entries: LeaderboardEntry[];
75
+ myRank: number;
76
+ }>;
77
+ };
61
78
  }
62
79
  interface SpawnServerSDK__V1<TConfig = any> {
63
80
  user: {
@@ -116,6 +133,13 @@ interface SpawnServerSDK__V1<TConfig = any> {
116
133
  delete(key: string): Promise<void>;
117
134
  };
118
135
  };
136
+ leaderboard: {
137
+ submit(userId: string, leaderboardId: string, score: number): Promise<void>;
138
+ getMultiple(leaderboardIds: string[], options?: {
139
+ period?: 'today' | 'week' | 'month' | 'all';
140
+ limit?: number;
141
+ }): Promise<Record<string, LeaderboardEntry[]>>;
142
+ };
119
143
  }
120
144
  interface TokenPayload {
121
145
  sub: string;
@@ -154,7 +178,15 @@ interface Item {
154
178
  id: string;
155
179
  data?: Record<string, any>;
156
180
  }
181
+ interface LeaderboardEntry {
182
+ rank: number;
183
+ username: string;
184
+ avatarUrl?: string;
185
+ score: number;
186
+ isMe?: boolean;
187
+ timestamp: number;
188
+ }
157
189
  type SpawnClientSDK__V0<TConfig = any> = Omit<SpawnClientSDK__V1<TConfig>, 'economy' | 'inventory'>;
158
190
  type SpawnServerSDK__V0<TConfig = any> = Omit<SpawnServerSDK__V1<TConfig>, 'economy' | 'inventory' | 'room'>;
159
191
 
160
- export type { Item, Room, RoomInfo, RoomVisibility, SpawnClientSDK__V0, SpawnClientSDK__V1, SpawnServerSDK__V0, SpawnServerSDK__V1, TokenPayload, User };
192
+ export type { Item, LeaderboardEntry, Room, RoomInfo, RoomVisibility, SpawnClientSDK__V0, SpawnClientSDK__V1, SpawnServerSDK__V0, SpawnServerSDK__V1, TokenPayload, User };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spawnco/sdk-types",
3
- "version": "0.0.21",
3
+ "version": "0.0.22",
4
4
  "description": "TypeScript type definitions for Spawn SDK",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
package/src/v1.ts CHANGED
@@ -60,6 +60,35 @@ export interface SpawnClientSDK__V1<TConfig = any> {
60
60
  analytics: {
61
61
  track(event: string, data: Record<string, any>): Promise<void>;
62
62
  };
63
+
64
+ leaderboard: {
65
+ submit(
66
+ leaderboardId: string,
67
+ score: number
68
+ ): Promise<{
69
+ rank: number;
70
+ improved: boolean;
71
+ }>;
72
+
73
+ top(
74
+ leaderboardId: string,
75
+ options?: {
76
+ period?: 'today' | 'week' | 'month' | 'all';
77
+ limit?: number;
78
+ }
79
+ ): Promise<LeaderboardEntry[]>;
80
+
81
+ around(
82
+ leaderboardId: string,
83
+ options?: {
84
+ period?: 'today' | 'week' | 'month' | 'all';
85
+ range?: number;
86
+ }
87
+ ): Promise<{
88
+ entries: LeaderboardEntry[];
89
+ myRank: number;
90
+ }>;
91
+ };
63
92
  }
64
93
 
65
94
  // Server SDK - available in Durable Objects
@@ -123,6 +152,18 @@ export interface SpawnServerSDK__V1<TConfig = any> {
123
152
  delete(key: string): Promise<void>;
124
153
  };
125
154
  };
155
+
156
+ leaderboard: {
157
+ submit(userId: string, leaderboardId: string, score: number): Promise<void>;
158
+
159
+ getMultiple(
160
+ leaderboardIds: string[],
161
+ options?: {
162
+ period?: 'today' | 'week' | 'month' | 'all';
163
+ limit?: number;
164
+ }
165
+ ): Promise<Record<string, LeaderboardEntry[]>>;
166
+ };
126
167
  }
127
168
 
128
169
  // Token types
@@ -170,6 +211,15 @@ export interface Item {
170
211
  data?: Record<string, any>;
171
212
  }
172
213
 
214
+ export interface LeaderboardEntry {
215
+ rank: number;
216
+ username: string;
217
+ avatarUrl?: string;
218
+ score: number;
219
+ isMe?: boolean;
220
+ timestamp: number;
221
+ }
222
+
173
223
  // v0 sdk types for testing
174
224
 
175
225
  export type SpawnClientSDK__V0<TConfig = any> = Omit<SpawnClientSDK__V1<TConfig>, 'economy' | 'inventory'>;