playcademy 0.14.3 → 0.14.4-alpha.2

package/dist/index.d.ts

@@ -1,10 +1,14 @@
-import { UserInfo, ApiKey, BackendDeploymentResponse } from '@playcademy/data/types';
+import { UserInfo, ApiKey } from '@playcademy/data/types';
 import { SchemaInfo } from '@playcademy/cloudflare';
 import { OrganizationConfig, CourseConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/timeback/types';
 export { ComponentConfig, ComponentResourceConfig, CourseConfig, DerivedComponentConfig, DerivedComponentResourceConfig, DerivedCourseConfig, DerivedOrganizationConfig, DerivedResourceConfig, DerivedTimebackConfig, OrganizationConfig, ResourceConfig, TimebackGrade, TimebackSourcedIds, TimebackSubject } from '@playcademy/timeback/types';
 import { PlaycademyClient } from '@playcademy/sdk';
 import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 
+/**
+ * Authentication strategies for Better Auth integration
+ */
+type AuthStrategy = 'email' | 'github' | 'google' | 'platform';
 /**
  * Type of authentication token
  * Duplicated from SDK to avoid circular dependency
@@ -288,6 +292,8 @@ interface IntegrationsConfig {
     kv?: boolean;
     /** Bucket storage (optional) */
     bucket?: boolean;
+    /** Authentication (optional) */
+    auth?: boolean;
 }
 /**
  * Unified Playcademy configuration
@@ -459,8 +465,8 @@ declare const games: drizzle_orm_pg_core.PgTableWithColumns<{
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
-        assetBundleBase: drizzle_orm_pg_core.PgColumn<{
-            name: "asset_bundle_base";
+        deploymentUrl: drizzle_orm_pg_core.PgColumn<{
+            name: "deployment_url";
             tableName: "games";
             dataType: "string";
             columnType: "PgText";
@@ -584,19 +590,82 @@ declare const games: drizzle_orm_pg_core.PgTableWithColumns<{
     dialect: "pg";
 }>;
 type GameRow = typeof games.$inferSelect;
-type BaseGame = Omit<GameRow, 'gameType' | 'assetBundleBase' | 'externalUrl'>;
+type BaseGame = Omit<GameRow, 'gameType' | 'deploymentUrl' | 'externalUrl'>;
 type HostedGame = BaseGame & {
     gameType: 'hosted';
-    assetBundleBase: string;
+    deploymentUrl: string;
     externalUrl: null;
 };
 type ExternalGame = BaseGame & {
     gameType: 'external';
-    assetBundleBase: null;
+    deploymentUrl: null;
     externalUrl: string;
 };
 type Game = HostedGame | ExternalGame;
 
+/**
+ * Integration-related types
+ */
+
+/**
+ * Database integration scaffold options
+ */
+interface DatabaseIntegrationOptions {
+    /** Directory for database files (e.g., 'db') */
+    directory: string;
+}
+/**
+ * Custom API routes integration scaffold options
+ */
+interface CustomRoutesIntegrationOptions {
+    /** Directory for custom routes (e.g., 'server/api') */
+    directory: string;
+}
+/**
+ * Represents a change in integration configuration
+ */
+interface IntegrationConfigChange {
+    /** Human-readable label for the change */
+    label: string;
+    /** Current value */
+    current: string;
+    /** New value */
+    next: string;
+    /** Field path (e.g., 'course.title') */
+    field: string;
+}
+/**
+ * Interface for integration change detectors
+ * Each integration can implement this to detect configuration changes
+ */
+interface IntegrationChangeDetector<TConfig = unknown> {
+    /**
+     * Detect changes between current and new configuration
+     * @param currentConfig - Currently deployed integration config
+     * @param newConfig - New integration config from local file
+     * @returns Array of detected changes
+     */
+    detectChanges(currentConfig: TConfig, newConfig: TConfig): IntegrationConfigChange[];
+    /**
+     * Handle configuration changes
+     * Called automatically during deployment when metadata has changed
+     * Implementation should: fetch current config, detect changes, update if needed
+     *
+     * @param gameId - The game ID
+     * @param client - Playcademy API client
+     * @param localConfig - Full local PlaycademyConfig
+     * @param verbose - Verbose logging flag
+     */
+    onConfigChange?(gameId: string, client: PlaycademyClient, localConfig: unknown, verbose?: boolean): Promise<void>;
+}
+/**
+ * Registry of integration change detectors
+ * Maps to the same keys as IntegrationsConfig from SDK
+ */
+type IntegrationChangeDetectors = {
+    [K in keyof IntegrationsConfig]: IntegrationChangeDetector;
+};
+
 /**
  * Deployed game tracking - maps project directories to game IDs
  */
@@ -618,25 +687,6 @@ interface DeployedGameInfo {
 interface GameStore {
     [projectPath: string]: DeployedGameInfo;
 }
-/**
- * Backend deployment response with code hash for change detection
- */
-interface BackendDeploymentWithHash extends BackendDeploymentResponse {
-    /** SHA-256 hash of the custom routes directory */
-    customRoutesHash: string | null;
-    /** Size of custom routes source files in bytes */
-    customRoutesSize: number | null;
-    /** Size of the deployed backend bundle in bytes */
-    backendSize: number;
-    /** Drizzle schema JSON snapshot */
-    schemaSnapshot?: unknown;
-    /** List of enabled integration keys (e.g., ['timeback', 'auth']) */
-    integrationKeys: string[];
-    /** Hash of integrations config (for detecting metadata changes) */
-    integrationsHash: string | null;
-    /** Secret keys that have been deployed */
-    deployedSecrets?: string[];
-}
 /**
  * Deployment context containing all information needed for deployment
  */
@@ -674,6 +724,10 @@ interface DeploymentChanges {
     backend: boolean | undefined;
     customRoutes: boolean | undefined;
     integrations: boolean | undefined;
+    integrationsMetadata?: Array<{
+        name: string;
+        changes: IntegrationConfigChange[];
+    }>;
     schema?: boolean;
     secrets?: boolean;
 }
@@ -689,12 +743,34 @@ interface DeploymentPlan {
     currentCustomRoutesSize?: number;
     currentBackendSize?: number;
 }
+/**
+ * Backend deployment metadata for tracking changes
+ * This is what we need to save for next deployment's change detection
+ */
+interface BackendDeploymentMetadata {
+    /** SHA-256 hash of the custom routes directory */
+    customRoutesHash: string | null;
+    /** Size of custom routes source files in bytes */
+    customRoutesSize: number | null;
+    /** Size of the deployed backend bundle in bytes */
+    backendSize: number;
+    /** Drizzle schema JSON snapshot */
+    schemaSnapshot?: unknown;
+    /** List of enabled integration keys (e.g., ['timeback', 'auth']) */
+    integrationKeys: string[];
+    /** Hash of integrations config (for detecting metadata changes) */
+    integrationsHash: string | null;
+    /** Secret keys that have been deployed */
+    deployedSecrets?: string[];
+    /** When this backend was deployed */
+    deployedAt: string;
+}
 /**
  * Result of a deployment
  */
 interface DeploymentResult {
     game: Game;
-    backendDeployment?: BackendDeploymentWithHash | null;
+    backendMetadata?: BackendDeploymentMetadata;
 }
 /**
  * Deployment configuration
@@ -783,6 +859,14 @@ interface EmbeddedSourcePaths {
     cliNodeModules: string;
 }
 
+/**
+ * Logger interface for embedding in other tools (e.g., vite plugin)
+ */
+interface PluginLogger {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+}
 interface DevServerOptions {
     port: number;
     /** Playcademy config. If not provided, will attempt to load from playcademy.config.js */
@@ -797,6 +881,8 @@ interface DevServerOptions {
     onReload?: (restart: () => Promise<void>) => void;
     /** URL for Playcademy platform/sandbox API (defaults to localhost:5174 platform) */
     platformUrl?: string;
+    /** Custom logger for embedding (e.g., from vite plugin) */
+    customLogger?: PluginLogger;
 }
 
 /**
@@ -852,69 +938,6 @@ interface PreviewResponse {
     qrCode?: string;
 }
 
-/**
- * Integration-related types
- */
-
-/**
- * Database integration scaffold options
- */
-interface DatabaseIntegrationOptions {
-    /** Directory for database files (e.g., 'db') */
-    directory: string;
-}
-/**
- * Custom API routes integration scaffold options
- */
-interface CustomRoutesIntegrationOptions {
-    /** Directory for custom routes (e.g., 'server/api') */
-    directory: string;
-}
-/**
- * Represents a change in integration configuration
- */
-interface IntegrationConfigChange {
-    /** Human-readable label for the change */
-    label: string;
-    /** Current value */
-    current: string;
-    /** New value */
-    next: string;
-    /** Field path (e.g., 'course.title') */
-    field: string;
-}
-/**
- * Interface for integration change detectors
- * Each integration can implement this to detect configuration changes
- */
-interface IntegrationChangeDetector<TConfig = unknown> {
-    /**
-     * Detect changes between current and new configuration
-     * @param currentConfig - Currently deployed integration config
-     * @param newConfig - New integration config from local file
-     * @returns Array of detected changes
-     */
-    detectChanges(currentConfig: TConfig, newConfig: TConfig): IntegrationConfigChange[];
-    /**
-     * Handle configuration changes
-     * Called automatically during deployment when metadata has changed
-     * Implementation should: fetch current config, detect changes, update if needed
-     *
-     * @param gameId - The game ID
-     * @param client - Playcademy API client
-     * @param localConfig - Full local PlaycademyConfig
-     * @param verbose - Verbose logging flag
-     */
-    onConfigChange?(gameId: string, client: PlaycademyClient, localConfig: unknown, verbose?: boolean): Promise<void>;
-}
-/**
- * Registry of integration change detectors
- * Maps to the same keys as IntegrationsConfig from SDK
- */
-type IntegrationChangeDetectors = {
-    [K in keyof IntegrationsConfig]: IntegrationChangeDetector;
-};
-
 /**
  * Configuration differences between existing and new game state
  */
@@ -967,6 +990,15 @@ interface BackendDiff {
 interface IntegrationsDiff {
     previousKeys?: string[];
     currentKeys?: string[];
+    metadata?: Array<{
+        name: string;
+        changes: Array<{
+            label: string;
+            current: string;
+            next: string;
+            field: string;
+        }>;
+    }>;
 }
 /**
  * Secret changes
@@ -1022,4 +1054,4 @@ interface KeyMetadata {
     valueType?: 'json' | 'string';
 }
 
-export type { ApiConfig, ApiErrorResponse, ApiKeyListItem, ApiKeyWithSecret, ApiRequestOptions, AuthProfile, AuthStore, BackendBundle, BackendDeploymentWithHash, BackendDiff, BackendFeatures, BucketBulkOptions, BucketDeleteOptions, BucketGetOptions, BucketListOptions, BucketPutOptions, BuildDiff, BulkCollectionResult, BundleOptions, CallbackServerResult, CollectedFile, ConfigDiff, CreateApiKeyResponse, CustomRoutesIntegrationOptions, DatabaseIntegrationOptions, DeployConfig, DeployNewGameOptions, DeployedGameInfo, DeploymentChanges, DeploymentContext, DeploymentDiffOptions, DeploymentPlan, DeploymentResult, DevServerOptions, EmbeddedSourcePaths, EnvironmentAuthProfiles, GameStore, IntegrationChangeDetector, IntegrationChangeDetectors, IntegrationConfigChange, IntegrationsConfig, IntegrationsDiff, KeyMetadata, KeyStats, LoginCredentials, LoginResponse, PlaycademyConfig, PreviewOptions, PreviewResponse, SecretsDiff, SignInResponse, SsoCallbackData, TimebackIntegrationConfig, TokenType, UpdateExistingGameOptions };
+export type { ApiConfig, ApiErrorResponse, ApiKeyListItem, ApiKeyWithSecret, ApiRequestOptions, AuthProfile, AuthStore, AuthStrategy, BackendBundle, BackendDeploymentMetadata, BackendDiff, BackendFeatures, BucketBulkOptions, BucketDeleteOptions, BucketGetOptions, BucketListOptions, BucketPutOptions, BuildDiff, BulkCollectionResult, BundleOptions, CallbackServerResult, CollectedFile, ConfigDiff, CreateApiKeyResponse, CustomRoutesIntegrationOptions, DatabaseIntegrationOptions, DeployConfig, DeployNewGameOptions, DeployedGameInfo, DeploymentChanges, DeploymentContext, DeploymentDiffOptions, DeploymentPlan, DeploymentResult, DevServerOptions, EmbeddedSourcePaths, EnvironmentAuthProfiles, GameStore, IntegrationChangeDetector, IntegrationChangeDetectors, IntegrationConfigChange, IntegrationsConfig, IntegrationsDiff, KeyMetadata, KeyStats, LoginCredentials, LoginResponse, PlaycademyConfig, PluginLogger, PreviewOptions, PreviewResponse, SecretsDiff, SignInResponse, SsoCallbackData, TimebackIntegrationConfig, TokenType, UpdateExistingGameOptions };