@playcademy/sdk 0.0.9 → 0.1.1

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 import * as drizzle_zod from 'drizzle-zod';
 import { z } from 'zod';
 import { OrganizationConfig, CourseConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/timeback/types';
+import { AUTH_PROVIDER_IDS } from '@playcademy/constants';
 
 declare const users: drizzle_orm_pg_core.PgTableWithColumns<{
     name: "user";
@@ -552,7 +553,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;
@@ -1439,7 +1440,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;
@@ -2441,7 +2442,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;
@@ -2542,7 +2543,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;
 }, {
@@ -2551,7 +2552,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;
 }>;
@@ -3021,6 +3022,7 @@ type XpHistoryResponse = {
         xp: number;
     }>;
 };
+type TimebackSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
 type TimebackSetupRequest = {
     gameId: string;
     config: {
@@ -3108,6 +3110,9 @@ type RecordProgressRequest = {
     gameId: string;
     studentId: string;
     progressData: {
+        sensorUrl?: string;
+        subject?: TimebackSubject;
+        appName?: string;
         score?: number;
         totalQuestions?: number;
         correctQuestions?: number;
@@ -3120,9 +3125,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 = {
@@ -3133,6 +3135,9 @@ type RecordSessionEndRequest = {
     gameId: string;
     studentId: string;
     sessionData: {
+        sensorUrl?: string;
+        subject?: TimebackSubject;
+        appName?: string;
         activeTimeSeconds: number;
         inactiveTimeSeconds?: number;
         wasteTimeSeconds?: number;
@@ -3141,9 +3146,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 = {
@@ -3155,6 +3157,9 @@ type AwardXpRequest = {
     studentId: string;
     xpAmount: number;
     metadata: {
+        sensorUrl: string;
+        subject: TimebackSubject;
+        appName: string;
         reason: string;
         activityId?: string;
         activityName?: string;
@@ -3162,9 +3167,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 = {
@@ -3173,24 +3175,6 @@ type AwardXpResponse = {
     xpAwarded: number;
 };
 
-/**
- * SDK Constants
- * These are re-exported from @playcademy/data but defined here
- * to avoid bundling issues with API Extractor
- */
-declare const CURRENCIES: {
-    readonly PRIMARY: "PLAYCADEMY_CREDITS";
-    readonly XP: "PLAYCADEMY_XP";
-};
-declare const BADGES: {
-    readonly FOUNDING_MEMBER: "FOUNDING_MEMBER_BADGE";
-    readonly EARLY_ADOPTER: "EARLY_ADOPTER_BADGE";
-    readonly FIRST_GAME: "FIRST_GAME_BADGE";
-};
-declare const AuthProvider: {
-    readonly TIMEBACK: "TIMEBACK";
-};
-
 /**
  * @fileoverview Server SDK Type Definitions
  *
@@ -3263,12 +3247,13 @@ interface BackendDeploymentBundle {
 type TokenType = 'session' | 'apiKey' | 'gameJwt';
 interface ClientConfig {
     baseUrl: string;
+    gameUrl?: string;
     token?: string;
     tokenType?: TokenType;
     gameId?: string;
     autoStartSession?: boolean;
 }
-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;
@@ -3620,7 +3605,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;
@@ -3632,7 +3618,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
@@ -3642,10 +3628,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.
      *
@@ -3733,7 +3728,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
@@ -3742,6 +3737,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.
      *
@@ -3913,7 +3919,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;
@@ -3925,7 +3931,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;
@@ -3937,7 +3943,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;
@@ -3949,7 +3955,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;
@@ -4088,7 +4094,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?: {
@@ -4180,6 +4186,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 */
@@ -4734,5 +4749,5 @@ declare class PlaycademyMessaging {
  */
 declare const messaging: PlaycademyMessaging;
 
-export { AuthProvider, BADGES, CURRENCIES, MessageEvents, PlaycademyClient, messaging };
+export { MessageEvents, PlaycademyClient, messaging };
 export type { DevUploadEvent, DevUploadHooks };