@playcademy/sdk 0.0.9 → 0.1.1

package/dist/server.d.ts

@@ -96,7 +96,7 @@ interface PlaycademyServerClientConfig {
     config?: PlaycademyConfig;
     /**
      * Optional base URL for Playcademy API.
-     * Defaults to environment variables or 'https://hub.playcademy.com'.
+     * Defaults to environment variables or 'https://hub.playcademy.net'.
      *
      * @example 'http://localhost:3000' for local development
      */

package/dist/server.js

@@ -301,7 +301,7 @@ class PlaycademyClient {
     if (!apiKey || typeof apiKey !== "string") {
       throw new Error("[Playcademy SDK] apiKey is required");
     }
-    const finalBaseUrl = baseUrl || process.env.PLAYCADEMY_BASE_URL || "https://hub.playcademy.com";
+    const finalBaseUrl = baseUrl || process.env.PLAYCADEMY_BASE_URL || "https://hub.playcademy.net";
     const loadedConfig = config.config || await loadConfig(configPath);
     const state = {
       apiKey,

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { AUTH_PROVIDER_IDS } from '@playcademy/constants';
 import { InferSelectModel } from 'drizzle-orm';
 import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 import * as drizzle_zod from 'drizzle-zod';
@@ -645,7 +646,7 @@ declare const items: drizzle_orm_pg_core.PgTableWithColumns<{
             tableName: "items";
             dataType: "string";
             columnType: "PgEnumColumn";
-            data: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+            data: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
             driverParam: string;
             notNull: true;
             hasDefault: true;
@@ -1889,7 +1890,7 @@ declare const characterComponents: drizzle_orm_pg_core.PgTableWithColumns<{
             tableName: "character_components";
             dataType: "string";
             columnType: "PgEnumColumn";
-            data: "accessory" | "body" | "outfit" | "hairstyle" | "eyes";
+            data: "body" | "outfit" | "hairstyle" | "eyes" | "accessory";
             driverParam: string;
             notNull: true;
             hasDefault: false;
@@ -3108,7 +3109,7 @@ declare const InsertItemSchema: drizzle_zod.BuildSchema<"insert", {
         tableName: "items";
         dataType: "string";
         columnType: "PgEnumColumn";
-        data: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+        data: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
         driverParam: string;
         notNull: true;
         hasDefault: true;
@@ -3209,7 +3210,7 @@ declare const UpdateItemSchema: z.ZodObject<Omit<{
     slug?: string | undefined;
     metadata?: Record<string, unknown> | undefined;
     gameId?: string | null | undefined;
-    type?: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other" | undefined;
+    type?: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other" | undefined;
     isPlaceable?: boolean | undefined;
     imageUrl?: string | null | undefined;
 }, {
@@ -3218,7 +3219,7 @@ declare const UpdateItemSchema: z.ZodObject<Omit<{
     slug?: string | undefined;
     metadata?: Record<string, unknown> | undefined;
     gameId?: string | null | undefined;
-    type?: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other" | undefined;
+    type?: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other" | undefined;
     isPlaceable?: boolean | undefined;
     imageUrl?: string | null | undefined;
 }>;
@@ -3705,6 +3706,7 @@ type XpHistoryResponse = {
         xp: number;
     }>;
 };
+type TimebackSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
 type TimebackSetupRequest = {
     gameId: string;
     config: {
@@ -3792,6 +3794,9 @@ type RecordProgressRequest = {
     gameId: string;
     studentId: string;
     progressData: {
+        sensorUrl?: string;
+        subject?: TimebackSubject;
+        appName?: string;
         score?: number;
         totalQuestions?: number;
         correctQuestions?: number;
@@ -3804,9 +3809,6 @@ type RecordProgressRequest = {
         classId?: string;
         courseName?: string;
         studentEmail?: string;
-        subject?: 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
-        appName?: string;
-        sensorUrl?: string;
     };
 };
 type RecordProgressResponse = {
@@ -3817,6 +3819,9 @@ type RecordSessionEndRequest = {
     gameId: string;
     studentId: string;
     sessionData: {
+        sensorUrl?: string;
+        subject?: TimebackSubject;
+        appName?: string;
         activeTimeSeconds: number;
         inactiveTimeSeconds?: number;
         wasteTimeSeconds?: number;
@@ -3825,9 +3830,6 @@ type RecordSessionEndRequest = {
         courseId?: string;
         courseName?: string;
         studentEmail?: string;
-        subject?: 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
-        appName?: string;
-        sensorUrl?: string;
     };
 };
 type RecordSessionEndResponse = {
@@ -3839,6 +3841,9 @@ type AwardXpRequest = {
     studentId: string;
     xpAmount: number;
     metadata: {
+        sensorUrl: string;
+        subject: TimebackSubject;
+        appName: string;
         reason: string;
         activityId?: string;
         activityName?: string;
@@ -3846,9 +3851,6 @@ type AwardXpRequest = {
         courseName?: string;
         studentEmail?: string;
         bonusType?: string;
-        subject?: 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
-        appName?: string;
-        sensorUrl?: string;
     };
 };
 type AwardXpResponse = {
@@ -3857,10 +3859,6 @@ type AwardXpResponse = {
     xpAwarded: number;
 };
 
-declare const AuthProvider: {
-    readonly TIMEBACK: "TIMEBACK";
-};
-
 /**
  * OAuth 2.0 implementation for the Playcademy SDK
  */
@@ -4040,7 +4038,7 @@ interface PlaycademyServerClientConfig {
     config?: PlaycademyConfig;
     /**
      * Optional base URL for Playcademy API.
-     * Defaults to environment variables or 'https://hub.playcademy.com'.
+     * Defaults to environment variables or 'https://hub.playcademy.net'.
      *
      * @example 'http://localhost:3000' for local development
      */
@@ -4295,7 +4293,8 @@ type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
  * Provides namespaced access to all platform features including games, users, inventory, and more.
  */
 declare class PlaycademyClient {
-    private baseUrl;
+    baseUrl: string;
+    gameUrl?: string;
     private authStrategy;
     private gameId?;
     private config;
@@ -4307,7 +4306,7 @@ declare class PlaycademyClient {
      * Creates a new PlaycademyClient instance.
      *
      * @param config - Optional configuration object
-     * @param config.baseUrl - Base URL for API requests (defaults to '/api')
+     * @param config.baseUrl - Base URL (e.g., 'https://hub.playcademy.net' or '/'). SDK automatically appends /api
      * @param config.token - Authentication token
      * @param config.tokenType - Optional token type (auto-detected if not provided)
      * @param config.gameId - Game ID for automatic session management
@@ -4317,10 +4316,19 @@ declare class PlaycademyClient {
     /**
      * Gets the effective base URL for API requests.
      * Converts relative URLs to absolute URLs in browser environments.
+     * Note: baseUrl already includes /api suffix from constructor.
      *
-     * @returns The complete base URL for API requests
+     * @returns The complete base URL for API requests (with /api suffix)
      */
     getBaseUrl(): string;
+    /**
+     * Gets the effective game backend URL for integration requests.
+     * Throws if gameUrl is not configured.
+     *
+     * @returns The complete game backend URL for API requests (with /api suffix)
+     * @throws PlaycademyError if gameUrl is not set
+     */
+    private getGameBackendUrl;
     /**
      * Simple ping method for testing connectivity.
      *
@@ -4408,7 +4416,7 @@ declare class PlaycademyClient {
      */
     private emit;
     /**
-     * Makes an authenticated HTTP request to the API.
+     * Makes an authenticated HTTP request to the platform API.
      *
      * @param path - API endpoint path
      * @param method - HTTP method
@@ -4417,6 +4425,17 @@ declare class PlaycademyClient {
      * @returns Promise resolving to the response data
      */
     protected request<T>(path: string, method: Method, body?: unknown, headers?: Record<string, string>): Promise<T>;
+    /**
+     * Makes an authenticated HTTP request to the game's backend Worker.
+     * Uses gameUrl if set, otherwise falls back to platform API.
+     *
+     * @param path - API endpoint path
+     * @param method - HTTP method
+     * @param body - Request body (optional)
+     * @param headers - Additional headers (optional)
+     * @returns Promise resolving to the response data
+     */
+    protected requestGameBackend<T>(path: string, method: Method, body?: unknown, headers?: Record<string, string>): Promise<T>;
     /**
      * Ensures a gameId is available, throwing an error if not.
      *
@@ -4588,7 +4607,7 @@ declare class PlaycademyClient {
             create: (props: InsertItemInput) => Promise<{
                 id: string;
                 createdAt: Date;
-                type: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+                type: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
                 gameId: string | null;
                 slug: string;
                 displayName: string;
@@ -4600,7 +4619,7 @@ declare class PlaycademyClient {
             get: (itemId: string) => Promise<{
                 id: string;
                 createdAt: Date;
-                type: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+                type: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
                 gameId: string | null;
                 slug: string;
                 displayName: string;
@@ -4612,7 +4631,7 @@ declare class PlaycademyClient {
             list: () => Promise<{
                 id: string;
                 createdAt: Date;
-                type: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+                type: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
                 gameId: string | null;
                 slug: string;
                 displayName: string;
@@ -4624,7 +4643,7 @@ declare class PlaycademyClient {
             update: (itemId: string, props: UpdateItemInput) => Promise<{
                 id: string;
                 createdAt: Date;
-                type: "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "accessory" | "other";
+                type: "accessory" | "currency" | "badge" | "trophy" | "collectible" | "consumable" | "unlock" | "upgrade" | "other";
                 gameId: string | null;
                 slug: string;
                 displayName: string;
@@ -4763,7 +4782,7 @@ declare class PlaycademyClient {
             }) => Promise<TodayXpResponse>;
             total: () => Promise<TotalXpResponse>;
             history: (options?: {
-                startDate? /** TimeBack XP methods (today, total, history) */: string;
+                startDate?: string;
                 endDate?: string;
             }) => Promise<XpHistoryResponse>;
             summary: (options?: {
@@ -4855,6 +4874,15 @@ declare class PlaycademyClient {
             }, cacheOptions?: TTLCacheConfig) => Promise<NotificationStats>;
         };
     };
+    /** Backend methods for calling custom game API routes */
+    backend: {
+        get<T = unknown>(path: string, headers?: Record<string, string>): Promise<T>;
+        post<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
+        put<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
+        patch<T = unknown>(path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
+        delete<T = unknown>(path: string, headers?: Record<string, string>): Promise<T>;
+        request<T = unknown>(path: string, method: Method, body?: unknown, headers?: Record<string, string>): Promise<T>;
+    };
     /** Auto-initializes a PlaycademyClient with context from the environment */
     static init: typeof init;
     /** Authenticates a user with email and password */
@@ -4868,6 +4896,7 @@ declare class PlaycademyClient {
 type TokenType = 'session' | 'apiKey' | 'gameJwt';
 interface ClientConfig {
     baseUrl: string;
+    gameUrl?: string;
     token?: string;
     tokenType?: TokenType;
     gameId?: string;
@@ -4875,11 +4904,12 @@ interface ClientConfig {
 }
 interface InitPayload {
     baseUrl: string;
+    gameUrl?: string;
     token: string;
     gameId: string;
     realtimeUrl?: string;
 }
-type AuthProviderType = (typeof AuthProvider)[keyof typeof AuthProvider];
+type AuthProviderType = (typeof AUTH_PROVIDER_IDS)[keyof typeof AUTH_PROVIDER_IDS];
 interface AuthOptions {
     /** The identity provider to use for authentication */
     provider: AuthProviderType;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@playcademy/sdk",
-    "version": "0.0.9",
+    "version": "0.1.1",
     "type": "module",
     "exports": {
         ".": {
@@ -27,21 +27,22 @@
     "scripts": {
         "build": "bun build.js",
         "lint": "bunx eslint . --fix --ignore-pattern dist",
-        "bump": "SKIP_TESTS=1 bunx bumpp --no-tag --no-push -c \"chore(@playcademy/sdk): release v%s\"",
-        "pub": "bun run build && bun run bump && bun publish --access public",
+        "pub": "bun publish.ts",
         "test": "bun test",
         "test:watch": "bun test --watch",
         "docs": "typedoc"
     },
     "devDependencies": {
-        "playcademy": "0.4.0",
-        "@playcademy/timeback": "0.0.1",
-        "@playcademy/utils": "0.0.1",
+        "@inquirer/prompts": "^7.8.6",
+        "@playcademy/constants": "0.0.1",
         "@playcademy/data": "0.0.1",
         "@playcademy/logger": "0.0.1",
-        "@playcademy/sandbox": "0.1.0-beta.20",
+        "@playcademy/sandbox": "0.1.0",
         "@playcademy/test": "0.0.1",
+        "@playcademy/timeback": "0.0.1",
+        "@playcademy/utils": "0.0.1",
         "@types/bun": "latest",
+        "playcademy": "0.11.2",
         "rollup": "^4.50.2",
         "rollup-plugin-dts": "^6.2.3",
         "typescript": "^5.7.2",