@game_engine/scene 0.1.0-alpha

package/dist/index.d.ts

@@ -0,0 +1,381 @@
+import { AssetDefinition, SceneEntity, MapGenerationConfigDocument, GeneratedMapDocument, SceneDocument, PatchDocument, PrefabDocument, ProjectDocument, AssetManifestDocument } from '@game_engine/contracts';
+export { AddAnimationFrameOperation, AddComponentOperation, AddEntityOperation, AnimationFrameUpdate, AssetDefinition, AssetManifestDocument, ClearParentOperation, DuplicateEntityOperation, GeneratedMapDocument, GeneratedMapEntity, InstantiatePrefabOperation, MapGenerationConfigDocument, MapPrefabRef, MapPrefabRole, PatchDocument, PatchOperation, PrefabDocument, ProjectDocument, RemoveAnimationFrameOperation, RemoveComponentOperation, RemoveEntityOperation, RenameEntityAtSourceOperation, RenameEntityOperation, ReplaceReferenceOperation, SceneDocument, SceneEntity, SetAnimatorClipOperation, SetComponentFieldOperation, SetParentOperation, SpriteFrame, UpdateAnimationFrameOperation, UpdateComponentOperation, assetManifestSchema, componentSchemas, generatedMapSchema, mapGenerationConfigSchema, patchSchema, prefabSchema, projectSchema, sceneSchema } from '@game_engine/contracts';
+
+type DiagnosticSeverity = "error" | "warning";
+interface Diagnostic {
+    severity: DiagnosticSeverity;
+    code: string;
+    file: string;
+    path: string;
+    message: string;
+    suggestion?: string;
+}
+interface ValidationResult<TDocument = unknown> {
+    file: string;
+    document?: TDocument;
+    diagnostics: Diagnostic[];
+}
+interface SceneInspection {
+    scenePath: string;
+    name: string;
+    entityCount: number;
+    hierarchy: SceneHierarchySummary;
+    animations: SceneAnimationSummary;
+    assets: SceneAssetSummary;
+    entities: Array<{
+        id: string;
+        prefab?: string;
+        components: string[];
+        overrides?: string[];
+        parent?: string;
+        children: string[];
+        worldTransform?: TransformSummary;
+    }>;
+}
+interface EntityInspection {
+    scenePath: string;
+    entity: SceneEntity;
+    hierarchy: EntityHierarchySummary;
+}
+interface ProjectInspection {
+    projectPath: string;
+    rootPath: string;
+    name?: string;
+    defaultScene?: string;
+    scenes: Array<{
+        path: string;
+        name?: string;
+        entityCount?: number;
+    }>;
+    assetManifests: Array<{
+        path: string;
+        assetCount?: number;
+    }>;
+    diagnostics: Diagnostic[];
+}
+interface AssetManifestInspection {
+    assetManifestPath: string;
+    assetManifest?: string;
+    assetCount: number;
+    assetsByType: Record<string, number>;
+    assets: Array<{
+        id: string;
+        type: string;
+        path: string;
+        texture?: string;
+        rect?: [number, number, number, number];
+        atlas?: string;
+        frame?: string;
+        frameCount?: number;
+        frames?: Array<{
+            id: string;
+            rect: [number, number, number, number];
+        }>;
+    }>;
+}
+interface PrefabInspection {
+    prefabPath: string;
+    prefab: string;
+    components: string[];
+}
+interface FormatResult {
+    files: string[];
+    diagnostics: Diagnostic[];
+}
+interface EntityReference {
+    entityId: string;
+    component: string;
+    field: string;
+    path: string;
+    value: string;
+}
+interface HierarchyNodeSummary {
+    entityId: string;
+    parent?: string;
+    children: string[];
+    depth: number;
+}
+interface SceneHierarchySummary {
+    roots: string[];
+    nodes: HierarchyNodeSummary[];
+}
+interface AnimationClipSummary {
+    id: string;
+    entityId: string;
+    frameCount: number;
+    durationFrames: number;
+    fps?: number;
+    frameOrder?: string[];
+    orderedFrameIds: string[];
+    spriteAssetIds: string[];
+    frames: AnimationFrameSummary[];
+}
+interface AnimationFrameSummary {
+    id: string;
+    durationFrames: number;
+    order: number;
+    playbackOrder: number;
+    sprite?: string;
+    rect?: [number, number, number, number];
+    assetResolved?: boolean;
+    assetType?: string;
+    assetPath?: string;
+    texture?: string;
+    assetRect?: [number, number, number, number];
+    assetAtlas?: string;
+    assetFrame?: string;
+    assetFrameRect?: [number, number, number, number];
+}
+interface AnimatorSummary {
+    entityId: string;
+    clips: string[];
+    defaultClip?: string;
+    currentClip: string;
+    activeClip?: string;
+    activeFrameId?: string;
+    currentFrameIndex?: number;
+    elapsedFrames?: number;
+    elapsedSeconds?: number;
+}
+interface SceneAnimationSummary {
+    clips: AnimationClipSummary[];
+    animators: AnimatorSummary[];
+}
+interface SceneAssetReferenceSummary {
+    assetId: string;
+    expectedType: string;
+    path: string;
+    entityId: string;
+    component: string;
+    field: string;
+    resolved: boolean;
+    actualType?: string;
+}
+interface SceneAssetSummary {
+    manifestCount: number;
+    assetCount: number;
+    atlasCount: number;
+    atlasFrameCount: number;
+    referencedAssets: SceneAssetReferenceSummary[];
+    unresolvedReferences: SceneAssetReferenceSummary[];
+}
+interface EntityHierarchySummary {
+    parent?: string;
+    children: string[];
+    depth: number;
+    worldTransform?: TransformSummary;
+}
+interface TransformSummary {
+    position: [number, number];
+    rotation: number;
+    scale: [number, number];
+}
+interface HierarchyDerivation {
+    roots: string[];
+    childrenByEntityId: Record<string, string[]>;
+    parentByEntityId: Record<string, string>;
+    depthByEntityId: Record<string, number>;
+    diagnostics: Diagnostic[];
+}
+interface WorldTransformResult {
+    transforms: Record<string, TransformSummary>;
+    diagnostics: Diagnostic[];
+}
+interface ReferenceChange extends EntityReference {
+    from: string;
+    to: string;
+}
+interface PatchApplicationSummary {
+    changedReferences: ReferenceChange[];
+}
+interface PatchApplicationResult {
+    patchPath: string;
+    scenePath?: string;
+    diagnostics: Diagnostic[];
+    changed: boolean;
+    summary?: PatchApplicationSummary;
+}
+interface AssetRecord {
+    id: string;
+    type: string;
+    path: string;
+    texture?: string;
+    rect?: [number, number, number, number];
+    atlas?: string;
+    frame?: string;
+    frames?: AssetAtlasFrameRecord[];
+    manifestFile: string;
+    dataPath: string;
+}
+interface AssetAtlasFrameRecord {
+    id: string;
+    rect: [number, number, number, number];
+    dataPath: string;
+}
+interface AssetManifestContext {
+    manifestFiles: string[];
+    assets: AssetDefinition[];
+    assetsById: Map<string, AssetRecord>;
+    diagnostics: Diagnostic[];
+}
+interface ProjectAssetManifestLoadResult {
+    projectFile: string;
+    rootPath: string;
+    manifestFiles: string[];
+    assets: AssetDefinition[];
+    assetsById: Map<string, AssetRecord>;
+    diagnostics: Diagnostic[];
+}
+interface MapGenerationSummary {
+    generator: "procedural-map-v0";
+    seed: number;
+    width: number;
+    height: number;
+    platformCount: number;
+    enemyCount: number;
+    entityCount: number;
+    configHash: string;
+}
+interface MapGenerationResult {
+    configPath: string;
+    diagnostics: Diagnostic[];
+    config?: MapGenerationConfigDocument;
+    map?: GeneratedMapDocument;
+    scene?: SceneDocument;
+    summary?: MapGenerationSummary;
+}
+interface MapGenerationFileResult extends MapGenerationResult {
+    outPath?: string;
+    mapOutPath?: string;
+}
+declare function parseProjectSource(source: string, file?: string): ValidationResult<ProjectDocument>;
+declare function parseSceneSource(source: string, file?: string): ValidationResult<SceneDocument>;
+declare function parsePrefabSource(source: string, file?: string): ValidationResult<PrefabDocument>;
+declare function parseAssetManifestSource(source: string, file?: string): ValidationResult<AssetManifestDocument>;
+declare function parseMapGenerationConfigSource(source: string, file?: string): ValidationResult<MapGenerationConfigDocument>;
+declare function parseGeneratedMapSource(source: string, file?: string): ValidationResult<GeneratedMapDocument>;
+declare function parsePatchSource(source: string, file?: string): ValidationResult<PatchDocument>;
+declare function loadProjectFile(projectPath?: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<ProjectDocument>>;
+declare function loadSceneFile(scenePath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<SceneDocument>>;
+declare function loadPrefabFile(prefabPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<PrefabDocument>>;
+declare function loadAssetManifestFile(assetManifestPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<AssetManifestDocument>>;
+declare function loadMapGenerationConfigFile(configPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<MapGenerationConfigDocument>>;
+declare function loadGeneratedMapFile(generatedMapPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<GeneratedMapDocument>>;
+declare function loadPatchFile(patchPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<PatchDocument>>;
+declare function validateProjectDocument(project: unknown, file?: string): Diagnostic[];
+declare function validateAssetManifestDocument(assetManifest: unknown, file?: string): Diagnostic[];
+declare function validateMapGenerationConfigDocument(config: unknown, file?: string): Diagnostic[];
+declare function validateGeneratedMapDocument(map: unknown, file?: string): Diagnostic[];
+declare function validatePatchDocument(patch: unknown, file?: string): Diagnostic[];
+declare function validatePrefabDocument(prefab: unknown, file?: string): Diagnostic[];
+declare function validatePrefabFile(prefabPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<PrefabDocument>>;
+declare function validateAssetManifestFile(assetManifestPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<AssetManifestDocument>>;
+declare function validateMapGenerationConfigFile(configPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<MapGenerationConfigDocument>>;
+declare function validateGeneratedMapFile(generatedMapPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<GeneratedMapDocument>>;
+declare function loadProjectAssetManifests(projectPath?: string, options?: {
+    cwd?: string;
+}): Promise<ProjectAssetManifestLoadResult>;
+declare function loadProjectAssetManifestContext(projectFile: string, project: ProjectDocument): Promise<AssetManifestContext>;
+declare function validateSceneDocument(scene: unknown, file?: string, options?: {
+    assets?: AssetManifestContext;
+}): Diagnostic[];
+declare function validateProjectFile(projectPath?: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<ProjectDocument>>;
+declare function validateSceneFile(scenePath: string, options?: {
+    cwd?: string;
+    assets?: AssetManifestContext;
+}): Promise<ValidationResult<SceneDocument>>;
+declare function loadExpandedSceneFile(scenePath: string, options?: {
+    cwd?: string;
+    assets?: AssetManifestContext;
+}): Promise<ValidationResult<SceneDocument>>;
+declare function expandSceneDocument(scene: SceneDocument, options?: {
+    sceneFile?: string;
+    assets?: AssetManifestContext;
+}): Promise<ValidationResult<SceneDocument>>;
+declare function formatProject(project: ProjectDocument): string;
+declare function formatScene(scene: SceneDocument): string;
+declare function formatPrefab(prefab: PrefabDocument): string;
+declare function formatMapGenerationConfig(config: MapGenerationConfigDocument): string;
+declare function formatGeneratedMap(map: GeneratedMapDocument): string;
+declare function generateMapFromConfigFile(configPath: string, options?: {
+    cwd?: string;
+}): Promise<MapGenerationResult>;
+declare function generateMapDocument(config: MapGenerationConfigDocument, options?: {
+    configFile?: string;
+}): ValidationResult<GeneratedMapDocument>;
+declare function generatedMapToScene(map: GeneratedMapDocument, options?: {
+    configFile?: string;
+    sceneFile?: string;
+}): SceneDocument;
+declare function generateMapSceneFile(configPath: string, outPath: string, options?: {
+    cwd?: string;
+    mapOutPath?: string;
+}): Promise<MapGenerationFileResult>;
+declare function createMapGenerationSummary(map: GeneratedMapDocument): MapGenerationSummary;
+declare function formatProjectFiles(projectPath?: string, options?: {
+    cwd?: string;
+}): Promise<FormatResult>;
+declare function applyPatchDocument(scene: SceneDocument, patch: PatchDocument, options?: {
+    patchFile?: string;
+    sceneFile?: string;
+}): ValidationResult<SceneDocument> & {
+    summary: PatchApplicationSummary;
+};
+declare function applyPatchDocumentWithFileValidation(scene: SceneDocument, patch: PatchDocument, options: {
+    patchFile?: string;
+    sceneFile: string;
+}): Promise<ValidationResult<SceneDocument> & {
+    summary: PatchApplicationSummary;
+}>;
+declare function applyPatchFile(patchPath: string, options?: {
+    cwd?: string;
+}): Promise<PatchApplicationResult>;
+declare function inspectSceneDocument(scene: SceneDocument, scenePath?: string, expandedScene?: SceneDocument, assets?: AssetManifestContext): SceneInspection;
+declare function inspectSceneFile(scenePath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<SceneInspection>>;
+declare function inspectEntityFile(scenePath: string, entityId: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<EntityInspection>>;
+declare function inspectPrefabDocument(prefab: PrefabDocument, prefabPath?: string): PrefabInspection;
+declare function inspectPrefabFile(prefabPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<PrefabInspection>>;
+declare function inspectAssetManifestDocument(assetManifest: AssetManifestDocument, assetManifestPath?: string): AssetManifestInspection;
+declare function inspectAssetManifestFile(assetManifestPath: string, options?: {
+    cwd?: string;
+}): Promise<ValidationResult<AssetManifestInspection>>;
+declare function inspectProjectFile(projectPath?: string, options?: {
+    cwd?: string;
+}): Promise<ProjectInspection>;
+declare function deriveHierarchy(scene: SceneDocument, file?: string): HierarchyDerivation;
+declare function computeWorldTransforms(scene: SceneDocument, file?: string): WorldTransformResult;
+declare function inspectSceneAnimations(scene: SceneDocument, assets?: AssetManifestContext): SceneAnimationSummary;
+declare function hasErrors(diagnostics: Diagnostic[]): boolean;
+declare function resolveProjectFile(projectPath?: string, cwd?: string): string;
+
+export { type AnimationClipSummary, type AnimationFrameSummary, type AnimatorSummary, type AssetAtlasFrameRecord, type AssetManifestContext, type AssetManifestInspection, type AssetRecord, type Diagnostic, type DiagnosticSeverity, type EntityHierarchySummary, type EntityInspection, type EntityReference, type FormatResult, type HierarchyDerivation, type HierarchyNodeSummary, type MapGenerationFileResult, type MapGenerationResult, type MapGenerationSummary, type PatchApplicationResult, type PatchApplicationSummary, type PrefabInspection, type ProjectAssetManifestLoadResult, type ProjectInspection, type ReferenceChange, type SceneAnimationSummary, type SceneAssetReferenceSummary, type SceneAssetSummary, type SceneHierarchySummary, type SceneInspection, type TransformSummary, type ValidationResult, type WorldTransformResult, applyPatchDocument, applyPatchDocumentWithFileValidation, applyPatchFile, computeWorldTransforms, createMapGenerationSummary, deriveHierarchy, expandSceneDocument, formatGeneratedMap, formatMapGenerationConfig, formatPrefab, formatProject, formatProjectFiles, formatScene, generateMapDocument, generateMapFromConfigFile, generateMapSceneFile, generatedMapToScene, hasErrors, inspectAssetManifestDocument, inspectAssetManifestFile, inspectEntityFile, inspectPrefabDocument, inspectPrefabFile, inspectProjectFile, inspectSceneAnimations, inspectSceneDocument, inspectSceneFile, loadAssetManifestFile, loadExpandedSceneFile, loadGeneratedMapFile, loadMapGenerationConfigFile, loadPatchFile, loadPrefabFile, loadProjectAssetManifestContext, loadProjectAssetManifests, loadProjectFile, loadSceneFile, parseAssetManifestSource, parseGeneratedMapSource, parseMapGenerationConfigSource, parsePatchSource, parsePrefabSource, parseProjectSource, parseSceneSource, resolveProjectFile, validateAssetManifestDocument, validateAssetManifestFile, validateGeneratedMapDocument, validateGeneratedMapFile, validateMapGenerationConfigDocument, validateMapGenerationConfigFile, validatePatchDocument, validatePrefabDocument, validatePrefabFile, validateProjectDocument, validateProjectFile, validateSceneDocument, validateSceneFile };