Package APIs
This page summarizes the current public package surface in this monorepo.
@ptahjs/ui-vue
Main integration package for Vue.
createPtah(options)useRuntimeApp(args)useDesignerApp(args)- Built-in components:
DesignerRoot,Preview,WorkspaceWidget,ScenesWidget,ModulesWidget,EventsWidget,ParameterWidget,RendererModule,FpsWidget - Built-in renderers:
WebRenderer,SceneRenderer,FlowRenderer - Re-exports all APIs from
@ptahjs/runtimeand@ptahjs/designer
@ptahjs/runtime
Runtime layer based on Kernel.
- Classes:
Runtime,FlowRunner,ProgramLoader - Functions:
compilePageSchemaToSections,compilePageSchema,buildStackToTarget - Re-exports all APIs from
@ptahjs/kernel
@ptahjs/designer
Design-time layer.
- Class:
Designer - Schema factories:
createRootAppSchema,createSceneSchema,createModuleSchema,createPropsSchema,createEventsSchema,createSlotsSchema - Property helpers:
numberProp,stringProp,booleanProp,selectProp,objectProp,arrayProp,groupProp - Re-exports all APIs from
@ptahjs/dnd
@ptahjs/kernel
Core state layer.
- Classes:
Kernel,ResourceRepository,ModuleManager,LifecycleChain,SharedResource - IR helpers:
createEmptyIRGraph,clearIRGraph,IR_SECTIONS,RUNTIME_STATE_KEYS, selectors (getSceneById,getModuleById, ...) - Constants:
MODULE_TYPE,EVENT_TYPE,RESOURCE_TYPE,LIFECYCLE_TYPE,ROOT_SECTION - Compiler helper:
applyCompiledSectionsToKernel
@ptahjs/dnd
Drag-and-drop engine.
- Core:
Dnd - Services:
DropService,MirrorService,AutoScrollService,DropIndicatorService,ActiveSelectionService,TransformControllerService
@ptahjs/shared
Shared utilities package.
Contains utility functions (cloneDeep, debounce, orderBy, ...), event infrastructure (EventDispatcher), hotkeys, storage helpers, websocket helpers, and more.
@ptahjs/tri-core / @ptahjs/tri-extensions
3D engine and extension plugin packages.
@ptahjs/tri-core:defineTri(args)+ engine/plugins/features exports@ptahjs/tri-extensions: core plugins + feature plugins + default export plugin list
Build Tooling Packages
@ptahjs/build:buildConfig(options)@ptahjs/vite-plugin-json: Vite JSON plugin entry (src/main.js)