@playcademy/sdk 0.6.1-beta.4 → 0.6.1-beta.5
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.
- package/dist/index.d.ts +18 -18
- package/dist/index.js +28 -5
- package/dist/internal.d.ts +172 -504
- package/dist/internal.js +28 -5
- package/dist/server/edge.d.ts +4 -4
- package/dist/server.d.ts +4 -4
- package/dist/types.d.ts +326 -326
- package/package.json +6 -1
package/dist/internal.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
+
import { SchemaInfo } from '@playcademy/cloudflare';
|
|
1
2
|
import { InferSelectModel } from 'drizzle-orm';
|
|
2
3
|
import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
|
|
3
4
|
import * as drizzle_zod from 'drizzle-zod';
|
|
4
5
|
import { z } from 'zod';
|
|
5
|
-
import { SchemaInfo } from '@playcademy/cloudflare';
|
|
6
6
|
import { AUTH_PROVIDER_IDS } from '@playcademy/constants';
|
|
7
7
|
|
|
8
8
|
/** Permitted HTTP verbs */
|
|
@@ -315,6 +315,56 @@ interface PopulateStudentResponse {
|
|
|
315
315
|
status: string;
|
|
316
316
|
message?: string;
|
|
317
317
|
}
|
|
318
|
+
interface TimebackSetupRequest {
|
|
319
|
+
gameId: string;
|
|
320
|
+
config: {
|
|
321
|
+
organization: {
|
|
322
|
+
name: string;
|
|
323
|
+
type: string;
|
|
324
|
+
identifier: string;
|
|
325
|
+
};
|
|
326
|
+
course: {
|
|
327
|
+
title: string;
|
|
328
|
+
subjects: string[];
|
|
329
|
+
grades: number[];
|
|
330
|
+
courseCode: string;
|
|
331
|
+
level: string;
|
|
332
|
+
gradingScheme: string;
|
|
333
|
+
metadata?: Record<string, unknown>;
|
|
334
|
+
};
|
|
335
|
+
component: {
|
|
336
|
+
title: string;
|
|
337
|
+
sortOrder: number;
|
|
338
|
+
prerequisites: string[];
|
|
339
|
+
prerequisiteCriteria: string;
|
|
340
|
+
};
|
|
341
|
+
resource: {
|
|
342
|
+
title: string;
|
|
343
|
+
vendorResourceId: string;
|
|
344
|
+
vendorId: string;
|
|
345
|
+
applicationId: string;
|
|
346
|
+
roles: string[];
|
|
347
|
+
importance: string;
|
|
348
|
+
metadata: {
|
|
349
|
+
type?: string;
|
|
350
|
+
launchUrl?: string;
|
|
351
|
+
toolProvider?: string;
|
|
352
|
+
instructionalMethod?: string;
|
|
353
|
+
subject?: string;
|
|
354
|
+
grades?: number[];
|
|
355
|
+
language?: string;
|
|
356
|
+
xp?: number;
|
|
357
|
+
[key: string]: unknown;
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
componentResource: {
|
|
361
|
+
title: string;
|
|
362
|
+
sortOrder: number;
|
|
363
|
+
lessonType: string | null;
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
verbose?: boolean;
|
|
367
|
+
}
|
|
318
368
|
interface PlatformTimebackSetupRequest {
|
|
319
369
|
gameId: string;
|
|
320
370
|
courses: DerivedPlatformCourseConfig[];
|
|
@@ -1304,7 +1354,7 @@ declare const users: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
1304
1354
|
generated: undefined;
|
|
1305
1355
|
}, {}, {}>;
|
|
1306
1356
|
};
|
|
1307
|
-
dialect:
|
|
1357
|
+
dialect: 'pg';
|
|
1308
1358
|
}>;
|
|
1309
1359
|
|
|
1310
1360
|
interface GameMetadata {
|
|
@@ -1580,7 +1630,7 @@ declare const games: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
1580
1630
|
generated: undefined;
|
|
1581
1631
|
}, {}, {}>;
|
|
1582
1632
|
};
|
|
1583
|
-
dialect:
|
|
1633
|
+
dialect: 'pg';
|
|
1584
1634
|
}>;
|
|
1585
1635
|
declare const gameSessions: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
1586
1636
|
name: "game_sessions";
|
|
@@ -1672,7 +1722,7 @@ declare const gameSessions: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
1672
1722
|
generated: undefined;
|
|
1673
1723
|
}, {}, {}>;
|
|
1674
1724
|
};
|
|
1675
|
-
dialect:
|
|
1725
|
+
dialect: 'pg';
|
|
1676
1726
|
}>;
|
|
1677
1727
|
/**
|
|
1678
1728
|
* Custom hostnames table
|
|
@@ -1873,7 +1923,7 @@ declare const gameCustomHostnames: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
1873
1923
|
generated: undefined;
|
|
1874
1924
|
}, {}, {}>;
|
|
1875
1925
|
};
|
|
1876
|
-
dialect:
|
|
1926
|
+
dialect: 'pg';
|
|
1877
1927
|
}>;
|
|
1878
1928
|
declare const items: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
1879
1929
|
name: "items";
|
|
@@ -2050,7 +2100,7 @@ declare const items: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2050
2100
|
generated: undefined;
|
|
2051
2101
|
}, {}, {}>;
|
|
2052
2102
|
};
|
|
2053
|
-
dialect:
|
|
2103
|
+
dialect: 'pg';
|
|
2054
2104
|
}>;
|
|
2055
2105
|
declare const inventoryItems: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2056
2106
|
name: "inventory_items";
|
|
@@ -2142,7 +2192,7 @@ declare const inventoryItems: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2142
2192
|
generated: undefined;
|
|
2143
2193
|
}, {}, {}>;
|
|
2144
2194
|
};
|
|
2145
|
-
dialect:
|
|
2195
|
+
dialect: 'pg';
|
|
2146
2196
|
}>;
|
|
2147
2197
|
declare const currencies: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2148
2198
|
name: "currencies";
|
|
@@ -2251,7 +2301,7 @@ declare const currencies: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2251
2301
|
generated: undefined;
|
|
2252
2302
|
}, {}, {}>;
|
|
2253
2303
|
};
|
|
2254
|
-
dialect:
|
|
2304
|
+
dialect: 'pg';
|
|
2255
2305
|
}>;
|
|
2256
2306
|
declare const shopListings: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2257
2307
|
name: "shop_listings";
|
|
@@ -2445,7 +2495,7 @@ declare const shopListings: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2445
2495
|
generated: undefined;
|
|
2446
2496
|
}, {}, {}>;
|
|
2447
2497
|
};
|
|
2448
|
-
dialect:
|
|
2498
|
+
dialect: 'pg';
|
|
2449
2499
|
}>;
|
|
2450
2500
|
declare const maps: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2451
2501
|
name: "maps";
|
|
@@ -2596,7 +2646,7 @@ declare const maps: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2596
2646
|
generated: undefined;
|
|
2597
2647
|
}, {}, {}>;
|
|
2598
2648
|
};
|
|
2599
|
-
dialect:
|
|
2649
|
+
dialect: 'pg';
|
|
2600
2650
|
}>;
|
|
2601
2651
|
declare const mapElements: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2602
2652
|
name: "map_elements";
|
|
@@ -2709,7 +2759,7 @@ declare const mapElements: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2709
2759
|
$type: Record<string, unknown>;
|
|
2710
2760
|
}>;
|
|
2711
2761
|
};
|
|
2712
|
-
dialect:
|
|
2762
|
+
dialect: 'pg';
|
|
2713
2763
|
}>;
|
|
2714
2764
|
declare const mapObjects: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
2715
2765
|
name: "map_objects";
|
|
@@ -2869,7 +2919,7 @@ declare const mapObjects: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2869
2919
|
generated: undefined;
|
|
2870
2920
|
}, {}, {}>;
|
|
2871
2921
|
};
|
|
2872
|
-
dialect:
|
|
2922
|
+
dialect: 'pg';
|
|
2873
2923
|
}>;
|
|
2874
2924
|
|
|
2875
2925
|
declare const userLevels: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
@@ -2996,7 +3046,7 @@ declare const userLevels: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
2996
3046
|
generated: undefined;
|
|
2997
3047
|
}, {}, {}>;
|
|
2998
3048
|
};
|
|
2999
|
-
dialect:
|
|
3049
|
+
dialect: 'pg';
|
|
3000
3050
|
}>;
|
|
3001
3051
|
declare const levelConfigs: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
3002
3052
|
name: "level_configs";
|
|
@@ -3088,7 +3138,7 @@ declare const levelConfigs: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
3088
3138
|
generated: undefined;
|
|
3089
3139
|
}, {}, {}>;
|
|
3090
3140
|
};
|
|
3091
|
-
dialect:
|
|
3141
|
+
dialect: 'pg';
|
|
3092
3142
|
}>;
|
|
3093
3143
|
|
|
3094
3144
|
declare const spriteTemplates: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
@@ -3185,7 +3235,7 @@ declare const spriteTemplates: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
3185
3235
|
generated: undefined;
|
|
3186
3236
|
}, {}, {}>;
|
|
3187
3237
|
};
|
|
3188
|
-
dialect:
|
|
3238
|
+
dialect: 'pg';
|
|
3189
3239
|
}>;
|
|
3190
3240
|
declare const characterComponents: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
3191
3241
|
name: "character_components";
|
|
@@ -3368,7 +3418,7 @@ declare const characterComponents: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
3368
3418
|
generated: undefined;
|
|
3369
3419
|
}, {}, {}>;
|
|
3370
3420
|
};
|
|
3371
|
-
dialect:
|
|
3421
|
+
dialect: 'pg';
|
|
3372
3422
|
}>;
|
|
3373
3423
|
declare const playerCharacters: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
3374
3424
|
name: "player_characters";
|
|
@@ -3511,7 +3561,7 @@ declare const playerCharacters: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
3511
3561
|
generated: undefined;
|
|
3512
3562
|
}, {}, {}>;
|
|
3513
3563
|
};
|
|
3514
|
-
dialect:
|
|
3564
|
+
dialect: 'pg';
|
|
3515
3565
|
}>;
|
|
3516
3566
|
declare const playerCharacterAccessories: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
3517
3567
|
name: "player_character_accessories";
|
|
@@ -3622,7 +3672,7 @@ declare const playerCharacterAccessories: drizzle_orm_pg_core.PgTableWithColumns
|
|
|
3622
3672
|
generated: undefined;
|
|
3623
3673
|
}, {}, {}>;
|
|
3624
3674
|
};
|
|
3625
|
-
dialect:
|
|
3675
|
+
dialect: 'pg';
|
|
3626
3676
|
}>;
|
|
3627
3677
|
declare const notifications: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
3628
3678
|
name: "notifications";
|
|
@@ -3907,7 +3957,7 @@ declare const notifications: drizzle_orm_pg_core.PgTableWithColumns<{
|
|
|
3907
3957
|
generated: undefined;
|
|
3908
3958
|
}, {}, {}>;
|
|
3909
3959
|
};
|
|
3910
|
-
dialect:
|
|
3960
|
+
dialect: 'pg';
|
|
3911
3961
|
}>;
|
|
3912
3962
|
declare const UpsertGameMetadataSchema: z.ZodEffects<z.ZodObject<{
|
|
3913
3963
|
displayName: z.ZodString;
|
|
@@ -6905,8 +6955,8 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6905
6955
|
*/
|
|
6906
6956
|
runtime: {
|
|
6907
6957
|
getGameToken: (gameId: string, options?: {
|
|
6908
|
-
apply?: boolean
|
|
6909
|
-
}
|
|
6958
|
+
apply?: boolean;
|
|
6959
|
+
}) => Promise<GameTokenResponse>;
|
|
6910
6960
|
exit: () => Promise<void>;
|
|
6911
6961
|
onInit: (handler: (context: GameContextPayload) => void) => void;
|
|
6912
6962
|
onTokenRefresh: (handler: (data: {
|
|
@@ -6930,7 +6980,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6930
6980
|
getListenerCounts: () => Record<string, number>;
|
|
6931
6981
|
assets: {
|
|
6932
6982
|
url(pathOrStrings: string | TemplateStringsArray, ...values: unknown[]): string;
|
|
6933
|
-
fetch: (path: string, options?: RequestInit
|
|
6983
|
+
fetch: (path: string, options?: RequestInit) => Promise<Response>;
|
|
6934
6984
|
json: <T = unknown>(path: string) => Promise<T>;
|
|
6935
6985
|
blob: (path: string) => Promise<Blob>;
|
|
6936
6986
|
text: (path: string) => Promise<string>;
|
|
@@ -6961,13 +7011,13 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6961
7011
|
* - `get(path)`, `post(path, body)`, `put()`, `delete()` - HTTP methods
|
|
6962
7012
|
*/
|
|
6963
7013
|
backend: {
|
|
6964
|
-
get<T = unknown>(path: string, headers?: Record<string, string>
|
|
6965
|
-
post<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>
|
|
6966
|
-
put<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>
|
|
6967
|
-
patch<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>
|
|
6968
|
-
delete<T = unknown>(path: string, headers?: Record<string, string>
|
|
6969
|
-
request<T = unknown>(path: string, method: Method, body?: unknown, headers?: Record<string, string>
|
|
6970
|
-
download(path: string, method?: Method, body?: unknown, headers?: Record<string, string>
|
|
7014
|
+
get<T = unknown>(path: string, headers?: Record<string, string>): Promise<T>;
|
|
7015
|
+
post<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
|
|
7016
|
+
put<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
|
|
7017
|
+
patch<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
|
|
7018
|
+
delete<T = unknown>(path: string, headers?: Record<string, string>): Promise<T>;
|
|
7019
|
+
request<T = unknown>(path: string, method: Method, body?: unknown, headers?: Record<string, string>): Promise<T>;
|
|
7020
|
+
download(path: string, method?: Method, body?: unknown, headers?: Record<string, string>): Promise<Response>;
|
|
6971
7021
|
url(pathOrStrings: string | TemplateStringsArray, ...values: unknown[]): string;
|
|
6972
7022
|
};
|
|
6973
7023
|
/**
|
|
@@ -6982,21 +7032,21 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6982
7032
|
password: string;
|
|
6983
7033
|
}) => Promise<{
|
|
6984
7034
|
success: boolean;
|
|
6985
|
-
token?: string
|
|
7035
|
+
token?: string;
|
|
6986
7036
|
user?: {
|
|
6987
7037
|
id: string;
|
|
6988
7038
|
email: string;
|
|
6989
|
-
}
|
|
6990
|
-
expiresAt?: string
|
|
6991
|
-
error?: string
|
|
7039
|
+
};
|
|
7040
|
+
expiresAt?: string;
|
|
7041
|
+
error?: string;
|
|
6992
7042
|
}>;
|
|
6993
7043
|
logout: () => Promise<void>;
|
|
6994
7044
|
apiKeys: {
|
|
6995
7045
|
create: (options?: {
|
|
6996
|
-
name?: string
|
|
6997
|
-
expiresIn?: number | null
|
|
6998
|
-
permissions?: Record<string, string[]
|
|
6999
|
-
}
|
|
7046
|
+
name?: string;
|
|
7047
|
+
expiresIn?: number | null;
|
|
7048
|
+
permissions?: Record<string, string[]>;
|
|
7049
|
+
}) => Promise<BetterAuthApiKeyResponse>;
|
|
7000
7050
|
list: () => Promise<BetterAuthApiKey[]>;
|
|
7001
7051
|
revoke: (keyId: string) => Promise<void>;
|
|
7002
7052
|
};
|
|
@@ -7013,18 +7063,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7013
7063
|
resumeGame: (gameId: string) => Promise<void>;
|
|
7014
7064
|
};
|
|
7015
7065
|
items: {
|
|
7016
|
-
create: (props: {
|
|
7017
|
-
id?: string | undefined;
|
|
7018
|
-
slug: string;
|
|
7019
|
-
gameId?: string | null | undefined;
|
|
7020
|
-
displayName: string;
|
|
7021
|
-
description?: string | null | undefined;
|
|
7022
|
-
type?: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade" | undefined;
|
|
7023
|
-
isPlaceable?: boolean | undefined;
|
|
7024
|
-
imageUrl?: string | null | undefined;
|
|
7025
|
-
metadata?: Record<string, unknown> | undefined;
|
|
7026
|
-
createdAt?: Date | undefined;
|
|
7027
|
-
}) => Promise<{
|
|
7066
|
+
create: (props: InsertItemInput) => Promise<{
|
|
7028
7067
|
createdAt: Date;
|
|
7029
7068
|
description: string | null;
|
|
7030
7069
|
displayName: string;
|
|
@@ -7060,16 +7099,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7060
7099
|
slug: string;
|
|
7061
7100
|
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7062
7101
|
}[]>;
|
|
7063
|
-
update: (itemId: string, props: {
|
|
7064
|
-
slug?: string | undefined;
|
|
7065
|
-
gameId?: string | null | undefined;
|
|
7066
|
-
displayName?: string | undefined;
|
|
7067
|
-
description?: string | null | undefined;
|
|
7068
|
-
type?: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade" | undefined;
|
|
7069
|
-
isPlaceable?: boolean | undefined;
|
|
7070
|
-
imageUrl?: string | null | undefined;
|
|
7071
|
-
metadata?: Record<string, unknown> | undefined;
|
|
7072
|
-
}) => Promise<{
|
|
7102
|
+
update: (itemId: string, props: UpdateItemInput) => Promise<{
|
|
7073
7103
|
createdAt: Date;
|
|
7074
7104
|
description: string | null;
|
|
7075
7105
|
displayName: string;
|
|
@@ -7084,14 +7114,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7084
7114
|
delete: (itemId: string) => Promise<void>;
|
|
7085
7115
|
};
|
|
7086
7116
|
currencies: {
|
|
7087
|
-
create: (props: {
|
|
7088
|
-
id?: string | undefined;
|
|
7089
|
-
itemId: string;
|
|
7090
|
-
symbol?: string | null | undefined;
|
|
7091
|
-
isPrimary: boolean;
|
|
7092
|
-
createdAt?: Date | undefined;
|
|
7093
|
-
updatedAt?: Date | null | undefined;
|
|
7094
|
-
}) => Promise<{
|
|
7117
|
+
create: (props: InsertCurrencyInput) => Promise<{
|
|
7095
7118
|
createdAt: Date;
|
|
7096
7119
|
id: string;
|
|
7097
7120
|
isPrimary: boolean;
|
|
@@ -7115,11 +7138,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7115
7138
|
symbol: string | null;
|
|
7116
7139
|
updatedAt: Date | null;
|
|
7117
7140
|
}[]>;
|
|
7118
|
-
update: (currencyId: string, props: {
|
|
7119
|
-
itemId?: string | undefined;
|
|
7120
|
-
symbol?: string | null | undefined;
|
|
7121
|
-
isPrimary?: boolean | undefined;
|
|
7122
|
-
}) => Promise<{
|
|
7141
|
+
update: (currencyId: string, props: UpdateCurrencyInput) => Promise<{
|
|
7123
7142
|
createdAt: Date;
|
|
7124
7143
|
id: string;
|
|
7125
7144
|
isPrimary: boolean;
|
|
@@ -7130,19 +7149,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7130
7149
|
delete: (currencyId: string) => Promise<void>;
|
|
7131
7150
|
};
|
|
7132
7151
|
shopListings: {
|
|
7133
|
-
create: (props: {
|
|
7134
|
-
id?: string | undefined;
|
|
7135
|
-
itemId: string;
|
|
7136
|
-
currencyId: string;
|
|
7137
|
-
price: number;
|
|
7138
|
-
sellBackPercentage?: number | null | undefined;
|
|
7139
|
-
stock?: number | null | undefined;
|
|
7140
|
-
isActive: boolean;
|
|
7141
|
-
availableFrom?: Date | null | undefined;
|
|
7142
|
-
availableUntil?: Date | null | undefined;
|
|
7143
|
-
createdAt?: Date | undefined;
|
|
7144
|
-
updatedAt?: Date | null | undefined;
|
|
7145
|
-
}) => Promise<{
|
|
7152
|
+
create: (props: InsertShopListingInput) => Promise<{
|
|
7146
7153
|
availableFrom: Date | null;
|
|
7147
7154
|
availableUntil: Date | null;
|
|
7148
7155
|
createdAt: Date;
|
|
@@ -7181,19 +7188,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7181
7188
|
stock: number | null;
|
|
7182
7189
|
updatedAt: Date | null;
|
|
7183
7190
|
}[]>;
|
|
7184
|
-
update: (listingId: string, props: {
|
|
7185
|
-
id?: string | undefined;
|
|
7186
|
-
itemId?: string | undefined;
|
|
7187
|
-
currencyId?: string | undefined;
|
|
7188
|
-
price?: number | undefined;
|
|
7189
|
-
sellBackPercentage?: number | null | undefined;
|
|
7190
|
-
stock?: number | null | undefined;
|
|
7191
|
-
isActive?: boolean | undefined;
|
|
7192
|
-
availableFrom?: Date | null | undefined;
|
|
7193
|
-
availableUntil?: Date | null | undefined;
|
|
7194
|
-
createdAt?: Date | undefined;
|
|
7195
|
-
updatedAt?: Date | null | undefined;
|
|
7196
|
-
}) => Promise<{
|
|
7191
|
+
update: (listingId: string, props: UpdateShopListingInput) => Promise<{
|
|
7197
7192
|
availableFrom: Date | null;
|
|
7198
7193
|
availableUntil: Date | null;
|
|
7199
7194
|
createdAt: Date;
|
|
@@ -7218,33 +7213,17 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7218
7213
|
dev: {
|
|
7219
7214
|
status: {
|
|
7220
7215
|
apply: () => Promise<void>;
|
|
7221
|
-
get: () => Promise<
|
|
7216
|
+
get: () => Promise<DeveloperStatusValue>;
|
|
7222
7217
|
};
|
|
7223
7218
|
games: {
|
|
7224
7219
|
deploy: (slug: string, options: {
|
|
7225
|
-
metadata?:
|
|
7226
|
-
|
|
7227
|
-
|
|
7228
|
-
|
|
7229
|
-
metadata: Record<string, unknown>;
|
|
7230
|
-
gameType: "external" | "hosted";
|
|
7231
|
-
visibility?: "internal" | "unlisted" | "visible" | undefined;
|
|
7232
|
-
externalUrl?: string | undefined;
|
|
7233
|
-
} | undefined;
|
|
7234
|
-
file?: Blob | File | null | undefined;
|
|
7235
|
-
backend?: BackendDeploymentBundle | undefined;
|
|
7236
|
-
hooks?: DevUploadHooks | undefined;
|
|
7237
|
-
}) => Promise<Game>;
|
|
7238
|
-
seed: (slug: string, code: string, environment?: "production" | "staging" | undefined, secrets?: Record<string, string> | undefined) => Promise<SeedResponse>;
|
|
7239
|
-
upsert: (slug: string, metadata: {
|
|
7240
|
-
displayName: string;
|
|
7241
|
-
mapElementId?: string | null | undefined;
|
|
7242
|
-
platform: "godot" | "unity" | "web";
|
|
7243
|
-
metadata: Record<string, unknown>;
|
|
7244
|
-
gameType: "external" | "hosted";
|
|
7245
|
-
visibility?: "internal" | "unlisted" | "visible" | undefined;
|
|
7246
|
-
externalUrl?: string | undefined;
|
|
7220
|
+
metadata?: UpsertGameMetadataInput;
|
|
7221
|
+
file?: File | Blob | null;
|
|
7222
|
+
backend?: BackendDeploymentBundle;
|
|
7223
|
+
hooks?: DevUploadHooks;
|
|
7247
7224
|
}) => Promise<Game>;
|
|
7225
|
+
seed: (slug: string, code: string, environment?: 'staging' | 'production', secrets?: Record<string, string>) => Promise<SeedResponse>;
|
|
7226
|
+
upsert: (slug: string, metadata: UpsertGameMetadataInput) => Promise<Game>;
|
|
7248
7227
|
delete: (gameId: string) => Promise<void>;
|
|
7249
7228
|
secrets: {
|
|
7250
7229
|
set: (slug: string, secrets: Record<string, string>) => Promise<string[]>;
|
|
@@ -7255,7 +7234,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7255
7234
|
reset: (slug: string, schema?: {
|
|
7256
7235
|
sql: string;
|
|
7257
7236
|
hash: string;
|
|
7258
|
-
}
|
|
7237
|
+
}) => Promise<{
|
|
7259
7238
|
success: boolean;
|
|
7260
7239
|
deploymentId: string;
|
|
7261
7240
|
resetAt: string;
|
|
@@ -7263,13 +7242,13 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7263
7242
|
}>;
|
|
7264
7243
|
};
|
|
7265
7244
|
bucket: {
|
|
7266
|
-
list: (slug: string, prefix?: string
|
|
7245
|
+
list: (slug: string, prefix?: string) => Promise<BucketFile[]>;
|
|
7267
7246
|
get: (slug: string, key: string) => Promise<ArrayBuffer>;
|
|
7268
|
-
put: (slug: string, key: string, content:
|
|
7247
|
+
put: (slug: string, key: string, content: Blob | ArrayBuffer | Uint8Array, contentType?: string) => Promise<void>;
|
|
7269
7248
|
delete: (slug: string, key: string) => Promise<void>;
|
|
7270
7249
|
};
|
|
7271
7250
|
kv: {
|
|
7272
|
-
list: (slug: string, prefix?: string
|
|
7251
|
+
list: (slug: string, prefix?: string) => Promise<KVKeyEntry[]>;
|
|
7273
7252
|
get: (slug: string, key: string) => Promise<string | null>;
|
|
7274
7253
|
set: (slug: string, key: string, value: string) => Promise<void>;
|
|
7275
7254
|
delete: (slug: string, key: string) => Promise<void>;
|
|
@@ -7281,176 +7260,29 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7281
7260
|
domains: {
|
|
7282
7261
|
add: (slug: string, hostname: string) => Promise<GameCustomHostname>;
|
|
7283
7262
|
list: (slug: string) => Promise<GameCustomHostname[]>;
|
|
7284
|
-
status: (slug: string, hostname: string, refresh?: boolean
|
|
7263
|
+
status: (slug: string, hostname: string, refresh?: boolean) => Promise<GameCustomHostname>;
|
|
7285
7264
|
delete: (slug: string, hostname: string) => Promise<void>;
|
|
7286
7265
|
};
|
|
7287
7266
|
logs: {
|
|
7288
|
-
getToken: (slug: string, environment:
|
|
7267
|
+
getToken: (slug: string, environment: 'staging' | 'production') => Promise<{
|
|
7289
7268
|
token: string;
|
|
7290
7269
|
workerId: string;
|
|
7291
7270
|
}>;
|
|
7292
7271
|
};
|
|
7293
7272
|
};
|
|
7294
7273
|
items: {
|
|
7295
|
-
create: (gameId: string, slug: string, itemData: Omit<
|
|
7296
|
-
|
|
7297
|
-
|
|
7298
|
-
|
|
7299
|
-
displayName: string;
|
|
7300
|
-
description?: string | null | undefined;
|
|
7301
|
-
type?: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade" | undefined;
|
|
7302
|
-
isPlaceable?: boolean | undefined;
|
|
7303
|
-
imageUrl?: string | null | undefined;
|
|
7304
|
-
metadata?: Record<string, unknown> | undefined;
|
|
7305
|
-
createdAt?: Date | undefined;
|
|
7306
|
-
}, "gameId" | "slug">) => Promise<{
|
|
7307
|
-
createdAt: Date;
|
|
7308
|
-
description: string | null;
|
|
7309
|
-
displayName: string;
|
|
7310
|
-
gameId: string | null;
|
|
7311
|
-
id: string;
|
|
7312
|
-
imageUrl: string | null;
|
|
7313
|
-
isPlaceable: boolean;
|
|
7314
|
-
metadata: unknown;
|
|
7315
|
-
slug: string;
|
|
7316
|
-
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7317
|
-
}>;
|
|
7318
|
-
update: (gameId: string, itemId: string, updates: {
|
|
7319
|
-
slug?: string | undefined;
|
|
7320
|
-
gameId?: string | null | undefined;
|
|
7321
|
-
displayName?: string | undefined;
|
|
7322
|
-
description?: string | null | undefined;
|
|
7323
|
-
type?: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade" | undefined;
|
|
7324
|
-
isPlaceable?: boolean | undefined;
|
|
7325
|
-
imageUrl?: string | null | undefined;
|
|
7326
|
-
metadata?: Record<string, unknown> | undefined;
|
|
7327
|
-
}) => Promise<{
|
|
7328
|
-
createdAt: Date;
|
|
7329
|
-
description: string | null;
|
|
7330
|
-
displayName: string;
|
|
7331
|
-
gameId: string | null;
|
|
7332
|
-
id: string;
|
|
7333
|
-
imageUrl: string | null;
|
|
7334
|
-
isPlaceable: boolean;
|
|
7335
|
-
metadata: unknown;
|
|
7336
|
-
slug: string;
|
|
7337
|
-
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7338
|
-
}>;
|
|
7339
|
-
list: (gameId: string) => Promise<{
|
|
7340
|
-
createdAt: Date;
|
|
7341
|
-
description: string | null;
|
|
7342
|
-
displayName: string;
|
|
7343
|
-
gameId: string | null;
|
|
7344
|
-
id: string;
|
|
7345
|
-
imageUrl: string | null;
|
|
7346
|
-
isPlaceable: boolean;
|
|
7347
|
-
metadata: unknown;
|
|
7348
|
-
slug: string;
|
|
7349
|
-
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7350
|
-
}[]>;
|
|
7351
|
-
get: (gameId: string, slug: string) => Promise<{
|
|
7352
|
-
createdAt: Date;
|
|
7353
|
-
description: string | null;
|
|
7354
|
-
displayName: string;
|
|
7355
|
-
gameId: string | null;
|
|
7356
|
-
id: string;
|
|
7357
|
-
imageUrl: string | null;
|
|
7358
|
-
isPlaceable: boolean;
|
|
7359
|
-
metadata: unknown;
|
|
7360
|
-
slug: string;
|
|
7361
|
-
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7362
|
-
}>;
|
|
7274
|
+
create: (gameId: string, slug: string, itemData: Omit<InsertItemInput, 'slug' | 'gameId'>) => Promise<ItemRow>;
|
|
7275
|
+
update: (gameId: string, itemId: string, updates: UpdateItemInput) => Promise<ItemRow>;
|
|
7276
|
+
list: (gameId: string) => Promise<ItemRow[]>;
|
|
7277
|
+
get: (gameId: string, slug: string) => Promise<ItemRow>;
|
|
7363
7278
|
delete: (gameId: string, itemId: string) => Promise<void>;
|
|
7364
7279
|
shop: {
|
|
7365
|
-
create: (gameId: string, itemId: string, listingData: Omit<
|
|
7366
|
-
|
|
7367
|
-
|
|
7368
|
-
currencyId: string;
|
|
7369
|
-
price: number;
|
|
7370
|
-
sellBackPercentage?: number | null | undefined;
|
|
7371
|
-
stock?: number | null | undefined;
|
|
7372
|
-
isActive: boolean;
|
|
7373
|
-
availableFrom?: Date | null | undefined;
|
|
7374
|
-
availableUntil?: Date | null | undefined;
|
|
7375
|
-
createdAt?: Date | undefined;
|
|
7376
|
-
updatedAt?: Date | null | undefined;
|
|
7377
|
-
}, "itemId">) => Promise<{
|
|
7378
|
-
availableFrom: Date | null;
|
|
7379
|
-
availableUntil: Date | null;
|
|
7380
|
-
createdAt: Date;
|
|
7381
|
-
currencyId: string;
|
|
7382
|
-
id: string;
|
|
7383
|
-
isActive: boolean;
|
|
7384
|
-
itemId: string;
|
|
7385
|
-
price: number;
|
|
7386
|
-
sellBackPercentage: number | null;
|
|
7387
|
-
stock: number | null;
|
|
7388
|
-
updatedAt: Date | null;
|
|
7389
|
-
}>;
|
|
7390
|
-
get: (gameId: string, itemId: string) => Promise<{
|
|
7391
|
-
availableFrom: Date | null;
|
|
7392
|
-
availableUntil: Date | null;
|
|
7393
|
-
createdAt: Date;
|
|
7394
|
-
currencyId: string;
|
|
7395
|
-
id: string;
|
|
7396
|
-
isActive: boolean;
|
|
7397
|
-
itemId: string;
|
|
7398
|
-
price: number;
|
|
7399
|
-
sellBackPercentage: number | null;
|
|
7400
|
-
stock: number | null;
|
|
7401
|
-
updatedAt: Date | null;
|
|
7402
|
-
} | null>;
|
|
7403
|
-
update: (gameId: string, itemId: string, updates: {
|
|
7404
|
-
id?: string | undefined;
|
|
7405
|
-
itemId?: string | undefined;
|
|
7406
|
-
currencyId?: string | undefined;
|
|
7407
|
-
price?: number | undefined;
|
|
7408
|
-
sellBackPercentage?: number | null | undefined;
|
|
7409
|
-
stock?: number | null | undefined;
|
|
7410
|
-
isActive?: boolean | undefined;
|
|
7411
|
-
availableFrom?: Date | null | undefined;
|
|
7412
|
-
availableUntil?: Date | null | undefined;
|
|
7413
|
-
createdAt?: Date | undefined;
|
|
7414
|
-
updatedAt?: Date | null | undefined;
|
|
7415
|
-
}) => Promise<{
|
|
7416
|
-
availableFrom: Date | null;
|
|
7417
|
-
availableUntil: Date | null;
|
|
7418
|
-
createdAt: Date;
|
|
7419
|
-
currencyId: string;
|
|
7420
|
-
id: string;
|
|
7421
|
-
isActive: boolean;
|
|
7422
|
-
itemId: string;
|
|
7423
|
-
price: number;
|
|
7424
|
-
sellBackPercentage: number | null;
|
|
7425
|
-
stock: number | null;
|
|
7426
|
-
updatedAt: Date | null;
|
|
7427
|
-
}>;
|
|
7280
|
+
create: (gameId: string, itemId: string, listingData: Omit<InsertShopListingInput, 'itemId'>) => Promise<ShopListingRow>;
|
|
7281
|
+
get: (gameId: string, itemId: string) => Promise<ShopListingRow | null>;
|
|
7282
|
+
update: (gameId: string, itemId: string, updates: UpdateShopListingInput) => Promise<ShopListingRow>;
|
|
7428
7283
|
delete: (gameId: string, itemId: string) => Promise<void>;
|
|
7429
|
-
list: (gameId: string) => Promise<({
|
|
7430
|
-
|
|
7431
|
-
availableUntil: Date | null;
|
|
7432
|
-
createdAt: Date;
|
|
7433
|
-
currencyId: string;
|
|
7434
|
-
id: string;
|
|
7435
|
-
isActive: boolean;
|
|
7436
|
-
itemId: string;
|
|
7437
|
-
price: number;
|
|
7438
|
-
sellBackPercentage: number | null;
|
|
7439
|
-
stock: number | null;
|
|
7440
|
-
updatedAt: Date | null;
|
|
7441
|
-
} & {
|
|
7442
|
-
item: {
|
|
7443
|
-
createdAt: Date;
|
|
7444
|
-
description: string | null;
|
|
7445
|
-
displayName: string;
|
|
7446
|
-
gameId: string | null;
|
|
7447
|
-
id: string;
|
|
7448
|
-
imageUrl: string | null;
|
|
7449
|
-
isPlaceable: boolean;
|
|
7450
|
-
metadata: unknown;
|
|
7451
|
-
slug: string;
|
|
7452
|
-
type: "accessory" | "badge" | "collectible" | "consumable" | "currency" | "other" | "trophy" | "unlock" | "upgrade";
|
|
7453
|
-
};
|
|
7284
|
+
list: (gameId: string) => Promise<(ShopListingRow & {
|
|
7285
|
+
item: ItemRow;
|
|
7454
7286
|
})[]>;
|
|
7455
7287
|
};
|
|
7456
7288
|
};
|
|
@@ -7463,21 +7295,21 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7463
7295
|
* - `getGameToken(gameId)` - Get short-lived game auth token
|
|
7464
7296
|
*/
|
|
7465
7297
|
games: {
|
|
7466
|
-
fetch: (gameIdOrSlug: string, options?: TTLCacheConfig
|
|
7467
|
-
list: (options?: TTLCacheConfig
|
|
7298
|
+
fetch: (gameIdOrSlug: string, options?: TTLCacheConfig) => Promise<FetchedGame>;
|
|
7299
|
+
list: (options?: TTLCacheConfig) => Promise<Game[]>;
|
|
7468
7300
|
getSubjects: () => Promise<Record<string, string | null>>;
|
|
7469
|
-
startSession: (gameId?: string
|
|
7470
|
-
endSession: (sessionId: string, gameId?: string
|
|
7301
|
+
startSession: (gameId?: string) => Promise<StartSessionResponse>;
|
|
7302
|
+
endSession: (sessionId: string, gameId?: string) => Promise<void>;
|
|
7471
7303
|
token: {
|
|
7472
7304
|
create: (gameId: string, options?: {
|
|
7473
|
-
apply?: boolean
|
|
7474
|
-
}
|
|
7305
|
+
apply?: boolean;
|
|
7306
|
+
}) => Promise<GameTokenResponse>;
|
|
7475
7307
|
};
|
|
7476
7308
|
leaderboard: {
|
|
7477
7309
|
get: (gameId: string, options?: {
|
|
7478
|
-
limit?: number
|
|
7479
|
-
offset?: number
|
|
7480
|
-
}
|
|
7310
|
+
limit?: number;
|
|
7311
|
+
offset?: number;
|
|
7312
|
+
}) => Promise<LeaderboardEntry[]>;
|
|
7481
7313
|
};
|
|
7482
7314
|
};
|
|
7483
7315
|
/**
|
|
@@ -7486,34 +7318,20 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7486
7318
|
* - `update(config)` - Update avatar appearance
|
|
7487
7319
|
*/
|
|
7488
7320
|
character: {
|
|
7489
|
-
get: (userId?: string
|
|
7321
|
+
get: (userId?: string) => Promise<PlayerCharacterRow | null>;
|
|
7490
7322
|
create: (characterData: CreateCharacterData) => Promise<PlayerCharacterRow>;
|
|
7491
7323
|
update: (updates: UpdateCharacterData) => Promise<PlayerCharacterRow>;
|
|
7492
7324
|
components: {
|
|
7493
|
-
list: (options?:
|
|
7494
|
-
clearCache: (key?: string
|
|
7325
|
+
list: (options?: CharacterComponentsOptions & TTLCacheConfig) => Promise<CharacterComponentWithSpriteUrl[]>;
|
|
7326
|
+
clearCache: (key?: string) => void;
|
|
7495
7327
|
getCacheKeys: () => string[];
|
|
7496
7328
|
};
|
|
7497
7329
|
accessories: {
|
|
7498
|
-
equip: (slot: string, componentId: string) => Promise<
|
|
7499
|
-
accessoryComponentId: string;
|
|
7500
|
-
equippedAt: Date;
|
|
7501
|
-
id: string;
|
|
7502
|
-
playerCharacterId: string;
|
|
7503
|
-
slot: string;
|
|
7504
|
-
updatedAt: Date;
|
|
7505
|
-
}>;
|
|
7330
|
+
equip: (slot: string, componentId: string) => Promise<PlayerCharacterAccessoryRow>;
|
|
7506
7331
|
remove: (slot: string) => Promise<{
|
|
7507
7332
|
success: boolean;
|
|
7508
7333
|
}>;
|
|
7509
|
-
list: () => Promise<
|
|
7510
|
-
accessoryComponentId: string;
|
|
7511
|
-
equippedAt: Date;
|
|
7512
|
-
id: string;
|
|
7513
|
-
playerCharacterId: string;
|
|
7514
|
-
slot: string;
|
|
7515
|
-
updatedAt: Date;
|
|
7516
|
-
}[]>;
|
|
7334
|
+
list: () => Promise<PlayerCharacterAccessoryRow[]>;
|
|
7517
7335
|
};
|
|
7518
7336
|
};
|
|
7519
7337
|
/**
|
|
@@ -7523,11 +7341,11 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7523
7341
|
* - `award(achievementId)` - Grant achievement to user
|
|
7524
7342
|
*/
|
|
7525
7343
|
achievements: {
|
|
7526
|
-
list: (options?: TTLCacheConfig
|
|
7344
|
+
list: (options?: TTLCacheConfig) => Promise<AchievementCurrent[]>;
|
|
7527
7345
|
history: {
|
|
7528
7346
|
list: (queryOptions?: {
|
|
7529
|
-
limit?: number
|
|
7530
|
-
}
|
|
7347
|
+
limit?: number;
|
|
7348
|
+
}, cacheOptions?: TTLCacheConfig) => Promise<AchievementHistoryEntry[]>;
|
|
7531
7349
|
};
|
|
7532
7350
|
progress: {
|
|
7533
7351
|
submit: (achievementId: string) => Promise<AchievementProgressResponse>;
|
|
@@ -7539,7 +7357,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7539
7357
|
* - `submit(leaderboardId, score)` - Submit score to leaderboard
|
|
7540
7358
|
*/
|
|
7541
7359
|
leaderboard: {
|
|
7542
|
-
fetch: (options?: LeaderboardOptions
|
|
7360
|
+
fetch: (options?: LeaderboardOptions) => Promise<GameLeaderboardEntry[]>;
|
|
7543
7361
|
getUserRank: (gameId: string, userId: string) => Promise<UserRank | null>;
|
|
7544
7362
|
};
|
|
7545
7363
|
/**
|
|
@@ -7548,36 +7366,16 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7548
7366
|
* - `addXp(amount)` - Award XP to user
|
|
7549
7367
|
*/
|
|
7550
7368
|
levels: {
|
|
7551
|
-
get: () => Promise<
|
|
7552
|
-
|
|
7553
|
-
currentLevel: number;
|
|
7554
|
-
currentXp: number;
|
|
7555
|
-
lastLevelUpAt: Date | null;
|
|
7556
|
-
totalXP: number;
|
|
7557
|
-
updatedAt: Date | null;
|
|
7558
|
-
userId: string;
|
|
7559
|
-
}>;
|
|
7560
|
-
progress: (options?: CooldownCacheConfig | undefined) => Promise<{
|
|
7369
|
+
get: () => Promise<UserLevelRow>;
|
|
7370
|
+
progress: (options?: CooldownCacheConfig) => Promise<{
|
|
7561
7371
|
level: number;
|
|
7562
7372
|
currentXp: number;
|
|
7563
7373
|
xpToNextLevel: number;
|
|
7564
7374
|
totalXP: number;
|
|
7565
7375
|
}>;
|
|
7566
7376
|
config: {
|
|
7567
|
-
list: () => Promise<
|
|
7568
|
-
|
|
7569
|
-
creditsReward: number;
|
|
7570
|
-
id: string;
|
|
7571
|
-
level: number;
|
|
7572
|
-
xpRequired: number;
|
|
7573
|
-
}[]>;
|
|
7574
|
-
get: (level: number) => Promise<{
|
|
7575
|
-
createdAt: Date;
|
|
7576
|
-
creditsReward: number;
|
|
7577
|
-
id: string;
|
|
7578
|
-
level: number;
|
|
7579
|
-
xpRequired: number;
|
|
7580
|
-
} | null>;
|
|
7377
|
+
list: () => Promise<LevelConfigRow[]>;
|
|
7378
|
+
get: (level: number) => Promise<LevelConfigRow | null>;
|
|
7581
7379
|
};
|
|
7582
7380
|
};
|
|
7583
7381
|
/**
|
|
@@ -7595,108 +7393,23 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7595
7393
|
*/
|
|
7596
7394
|
notifications: {
|
|
7597
7395
|
list: (queryOptions?: {
|
|
7598
|
-
status?: NotificationStatus
|
|
7599
|
-
type?: NotificationType
|
|
7600
|
-
limit?: number
|
|
7601
|
-
offset?: number
|
|
7602
|
-
}
|
|
7603
|
-
|
|
7604
|
-
|
|
7605
|
-
|
|
7606
|
-
|
|
7607
|
-
deliveredAt: Date | null;
|
|
7608
|
-
expiresAt: Date | null;
|
|
7609
|
-
id: string;
|
|
7610
|
-
message: string;
|
|
7611
|
-
metadata: unknown;
|
|
7612
|
-
method: string | null;
|
|
7613
|
-
priority: "high" | "low" | "normal" | "urgent";
|
|
7614
|
-
seenAt: Date | null;
|
|
7615
|
-
status: "clicked" | "delivered" | "dismissed" | "expired" | "pending" | "seen";
|
|
7616
|
-
title: string;
|
|
7617
|
-
type: string;
|
|
7618
|
-
userId: string;
|
|
7619
|
-
}[]>;
|
|
7620
|
-
markAsSeen: (notificationId: string) => Promise<{
|
|
7621
|
-
clickUrl: string | null;
|
|
7622
|
-
clickedAt: Date | null;
|
|
7623
|
-
createdAt: Date;
|
|
7624
|
-
data: unknown;
|
|
7625
|
-
deliveredAt: Date | null;
|
|
7626
|
-
expiresAt: Date | null;
|
|
7627
|
-
id: string;
|
|
7628
|
-
message: string;
|
|
7629
|
-
metadata: unknown;
|
|
7630
|
-
method: string | null;
|
|
7631
|
-
priority: "high" | "low" | "normal" | "urgent";
|
|
7632
|
-
seenAt: Date | null;
|
|
7633
|
-
status: "clicked" | "delivered" | "dismissed" | "expired" | "pending" | "seen";
|
|
7634
|
-
title: string;
|
|
7635
|
-
type: string;
|
|
7636
|
-
userId: string;
|
|
7637
|
-
}>;
|
|
7638
|
-
markAsClicked: (notificationId: string) => Promise<{
|
|
7639
|
-
clickUrl: string | null;
|
|
7640
|
-
clickedAt: Date | null;
|
|
7641
|
-
createdAt: Date;
|
|
7642
|
-
data: unknown;
|
|
7643
|
-
deliveredAt: Date | null;
|
|
7644
|
-
expiresAt: Date | null;
|
|
7645
|
-
id: string;
|
|
7646
|
-
message: string;
|
|
7647
|
-
metadata: unknown;
|
|
7648
|
-
method: string | null;
|
|
7649
|
-
priority: "high" | "low" | "normal" | "urgent";
|
|
7650
|
-
seenAt: Date | null;
|
|
7651
|
-
status: "clicked" | "delivered" | "dismissed" | "expired" | "pending" | "seen";
|
|
7652
|
-
title: string;
|
|
7653
|
-
type: string;
|
|
7654
|
-
userId: string;
|
|
7655
|
-
}>;
|
|
7656
|
-
dismiss: (notificationId: string) => Promise<{
|
|
7657
|
-
clickUrl: string | null;
|
|
7658
|
-
clickedAt: Date | null;
|
|
7659
|
-
createdAt: Date;
|
|
7660
|
-
data: unknown;
|
|
7661
|
-
deliveredAt: Date | null;
|
|
7662
|
-
expiresAt: Date | null;
|
|
7663
|
-
id: string;
|
|
7664
|
-
message: string;
|
|
7665
|
-
metadata: unknown;
|
|
7666
|
-
method: string | null;
|
|
7667
|
-
priority: "high" | "low" | "normal" | "urgent";
|
|
7668
|
-
seenAt: Date | null;
|
|
7669
|
-
status: "clicked" | "delivered" | "dismissed" | "expired" | "pending" | "seen";
|
|
7670
|
-
title: string;
|
|
7671
|
-
type: string;
|
|
7672
|
-
userId: string;
|
|
7673
|
-
}>;
|
|
7674
|
-
markAsDelivered: (notificationId: string, method?: NotificationMethod) => Promise<{
|
|
7675
|
-
clickUrl: string | null;
|
|
7676
|
-
clickedAt: Date | null;
|
|
7677
|
-
createdAt: Date;
|
|
7678
|
-
data: unknown;
|
|
7679
|
-
deliveredAt: Date | null;
|
|
7680
|
-
expiresAt: Date | null;
|
|
7681
|
-
id: string;
|
|
7682
|
-
message: string;
|
|
7683
|
-
metadata: unknown;
|
|
7684
|
-
method: string | null;
|
|
7685
|
-
priority: "high" | "low" | "normal" | "urgent";
|
|
7686
|
-
seenAt: Date | null;
|
|
7687
|
-
status: "clicked" | "delivered" | "dismissed" | "expired" | "pending" | "seen";
|
|
7688
|
-
title: string;
|
|
7689
|
-
type: string;
|
|
7690
|
-
userId: string;
|
|
7691
|
-
}>;
|
|
7396
|
+
status?: NotificationStatus;
|
|
7397
|
+
type?: NotificationType;
|
|
7398
|
+
limit?: number;
|
|
7399
|
+
offset?: number;
|
|
7400
|
+
}, cacheOptions?: TTLCacheConfig) => Promise<NotificationRow[]>;
|
|
7401
|
+
markAsSeen: (notificationId: string) => Promise<NotificationRow>;
|
|
7402
|
+
markAsClicked: (notificationId: string) => Promise<NotificationRow>;
|
|
7403
|
+
dismiss: (notificationId: string) => Promise<NotificationRow>;
|
|
7404
|
+
markAsDelivered: (notificationId: string, method?: NotificationMethod) => Promise<NotificationRow>;
|
|
7692
7405
|
deliverPending: () => Promise<{
|
|
7693
7406
|
success: boolean;
|
|
7694
7407
|
}>;
|
|
7695
7408
|
stats: {
|
|
7696
7409
|
get: (queryOptions?: {
|
|
7697
|
-
from?: string
|
|
7698
|
-
to?: string
|
|
7699
|
-
}
|
|
7410
|
+
from?: string;
|
|
7411
|
+
to?: string;
|
|
7412
|
+
}, cacheOptions?: TTLCacheConfig) => Promise<NotificationStats>;
|
|
7700
7413
|
};
|
|
7701
7414
|
};
|
|
7702
7415
|
/**
|
|
@@ -7705,8 +7418,8 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7705
7418
|
* - `unlock(areaId)` - Unlock a new map area
|
|
7706
7419
|
*/
|
|
7707
7420
|
maps: {
|
|
7708
|
-
get: (identifier: string, options?: TTLCacheConfig
|
|
7709
|
-
elements: (mapId: string, options?: TTLCacheConfig
|
|
7421
|
+
get: (identifier: string, options?: TTLCacheConfig) => Promise<MapData>;
|
|
7422
|
+
elements: (mapId: string, options?: TTLCacheConfig) => Promise<MapElementWithGame[]>;
|
|
7710
7423
|
objects: {
|
|
7711
7424
|
list: (mapId: string) => Promise<MapObjectWithItem[]>;
|
|
7712
7425
|
create: (mapId: string, objectData: CreateMapObjectData) => Promise<MapObjectWithItem>;
|
|
@@ -7737,10 +7450,10 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7737
7450
|
* - `getByUser(userId)` - Get all scores for a user
|
|
7738
7451
|
*/
|
|
7739
7452
|
scores: {
|
|
7740
|
-
submit: (gameId: string, score: number, metadata?: Record<string, unknown>
|
|
7453
|
+
submit: (gameId: string, score: number, metadata?: Record<string, unknown>) => Promise<ScoreSubmission>;
|
|
7741
7454
|
getByUser: (gameId: string, userId: string, options?: {
|
|
7742
|
-
limit?: number
|
|
7743
|
-
}
|
|
7455
|
+
limit?: number;
|
|
7456
|
+
}) => Promise<UserScore[]>;
|
|
7744
7457
|
};
|
|
7745
7458
|
/**
|
|
7746
7459
|
* TimeBack integration for user context, XP tracking, and course management.
|
|
@@ -7761,9 +7474,9 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7761
7474
|
timeback: {
|
|
7762
7475
|
readonly user: PlatformTimebackUser;
|
|
7763
7476
|
populateStudent: (names?: {
|
|
7764
|
-
firstName?: string
|
|
7765
|
-
lastName?: string
|
|
7766
|
-
}
|
|
7477
|
+
firstName?: string;
|
|
7478
|
+
lastName?: string;
|
|
7479
|
+
}) => Promise<PopulateStudentResponse>;
|
|
7767
7480
|
startActivity: (_metadata: ActivityData) => void;
|
|
7768
7481
|
pauseActivity: () => void;
|
|
7769
7482
|
resumeActivity: () => void;
|
|
@@ -7773,82 +7486,37 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7773
7486
|
verify: (gameId: string) => Promise<TimebackVerifyAllResponse>;
|
|
7774
7487
|
cleanup: (gameId: string) => Promise<void>;
|
|
7775
7488
|
get: (gameId: string) => Promise<GameTimebackIntegration[]>;
|
|
7776
|
-
getConfig: (gameId: string) => Promise<
|
|
7777
|
-
organization: {
|
|
7778
|
-
name: string;
|
|
7779
|
-
type: string;
|
|
7780
|
-
identifier: string;
|
|
7781
|
-
};
|
|
7782
|
-
course: {
|
|
7783
|
-
title: string;
|
|
7784
|
-
subjects: string[];
|
|
7785
|
-
grades: number[];
|
|
7786
|
-
courseCode: string;
|
|
7787
|
-
level: string;
|
|
7788
|
-
gradingScheme: string;
|
|
7789
|
-
metadata?: Record<string, unknown> | undefined;
|
|
7790
|
-
};
|
|
7791
|
-
component: {
|
|
7792
|
-
title: string;
|
|
7793
|
-
sortOrder: number;
|
|
7794
|
-
prerequisites: string[];
|
|
7795
|
-
prerequisiteCriteria: string;
|
|
7796
|
-
};
|
|
7797
|
-
resource: {
|
|
7798
|
-
title: string;
|
|
7799
|
-
vendorResourceId: string;
|
|
7800
|
-
vendorId: string;
|
|
7801
|
-
applicationId: string;
|
|
7802
|
-
roles: string[];
|
|
7803
|
-
importance: string;
|
|
7804
|
-
metadata: {
|
|
7805
|
-
[key: string]: unknown;
|
|
7806
|
-
type?: string | undefined;
|
|
7807
|
-
launchUrl?: string | undefined;
|
|
7808
|
-
toolProvider?: string | undefined;
|
|
7809
|
-
instructionalMethod?: string | undefined;
|
|
7810
|
-
subject?: string | undefined;
|
|
7811
|
-
grades?: number[] | undefined;
|
|
7812
|
-
language?: string | undefined;
|
|
7813
|
-
xp?: number | undefined;
|
|
7814
|
-
};
|
|
7815
|
-
};
|
|
7816
|
-
componentResource: {
|
|
7817
|
-
title: string;
|
|
7818
|
-
sortOrder: number;
|
|
7819
|
-
lessonType: string | null;
|
|
7820
|
-
};
|
|
7821
|
-
}>;
|
|
7489
|
+
getConfig: (gameId: string) => Promise<TimebackSetupRequest['config']>;
|
|
7822
7490
|
};
|
|
7823
7491
|
xp: {
|
|
7824
7492
|
today: (options?: {
|
|
7825
|
-
date?: string
|
|
7826
|
-
timezone?: string
|
|
7827
|
-
}
|
|
7493
|
+
date?: string;
|
|
7494
|
+
timezone?: string;
|
|
7495
|
+
}) => Promise<TodayXpResponse>;
|
|
7828
7496
|
total: () => Promise<TotalXpResponse>;
|
|
7829
7497
|
history: (options?: {
|
|
7830
|
-
startDate?: string
|
|
7831
|
-
endDate?: string
|
|
7832
|
-
}
|
|
7498
|
+
startDate?: string;
|
|
7499
|
+
endDate?: string;
|
|
7500
|
+
}) => Promise<XpHistoryResponse>;
|
|
7833
7501
|
summary: (options?: {
|
|
7834
|
-
date?: string
|
|
7835
|
-
timezone?: string
|
|
7836
|
-
}
|
|
7502
|
+
date?: string;
|
|
7503
|
+
timezone?: string;
|
|
7504
|
+
}) => Promise<XpSummaryResponse>;
|
|
7837
7505
|
};
|
|
7838
7506
|
students: {
|
|
7839
|
-
get: (timebackId: string, options?: TTLCacheConfig
|
|
7840
|
-
clearCache: (timebackId?: string
|
|
7507
|
+
get: (timebackId: string, options?: TTLCacheConfig) => Promise<PlatformTimebackUserContext>;
|
|
7508
|
+
clearCache: (timebackId?: string) => void;
|
|
7841
7509
|
};
|
|
7842
7510
|
admin: {
|
|
7843
7511
|
getRoster: (gameId: string, courseId: string) => Promise<TimebackRosterResponse>;
|
|
7844
7512
|
getStudentOverview: (timebackId: string, options: {
|
|
7845
7513
|
gameId: string;
|
|
7846
|
-
courseId?: string
|
|
7514
|
+
courseId?: string;
|
|
7847
7515
|
}) => Promise<TimebackStudentOverviewResponse>;
|
|
7848
7516
|
getStudentActivity: (timebackId: string, courseId: string, options: {
|
|
7849
7517
|
gameId: string;
|
|
7850
|
-
limit?: number
|
|
7851
|
-
offset?: number
|
|
7518
|
+
limit?: number;
|
|
7519
|
+
offset?: number;
|
|
7852
7520
|
}) => Promise<TimebackStudentActivityResponse>;
|
|
7853
7521
|
grantXp: (request: GrantTimebackXpRequest) => Promise<TimebackAdminMutationResponse>;
|
|
7854
7522
|
adjustTime: (request: AdjustTimebackTimeRequest) => Promise<TimebackAdminMutationResponse>;
|