@alterspective/foundry
v0.5.8
Published
Platform-agnostic TypeScript SDK for building UI extensions — base classes, managers, utilities, and test infrastructure. Sharedo is the first supported platform plugin.
Readme
@alterspective/foundry
Core SDK for building Sharedo platform extensions.
What's Included
| Module | Path | Purpose |
|---|---|---|
| Base classes | src/base/ | AltWidget, AltBlade, BaseAspect, BaseDesigner |
| Managers | src/managers/ | ErrorManager, EventBus, ChildWidgetManager, RefreshThrottle |
| Config | src/config/ | Defaults merging, schema migrations, KO hydration |
| Clients | src/clients/ | ApiClient, DataComposerClient, FindByQueryClient |
| Utils | src/utils/ | Date formatting, phase classification, serialization, observable helpers |
| Debug | src/debug/ | DebugLogger, instance registry, WidgetDebugPanel |
| Runtime | src/runtime/ | Global Include entry point + bridge pattern |
| CSS assets | css/ | Shared visual tokens and reusable base primitives |
| Typed platform globals | src/types/ | Supported ambient Sharedo globals and typed access helpers |
| Templates | src/templates/ | TemplateRenderer, RulesEngine |
| Test setup | test-setup.ts | KO, $ui, $ajax mocks for vitest/jsdom |
Usage
import { AltWidget, EventBus, ErrorManager } from '@alterspective/foundry';For supported access to ambient Sharedo globals:
import { getSharedoPlatformGlobals } from '@alterspective/foundry';
const { $ui, ko } = getSharedoPlatformGlobals();Shared CSS imports:
import '@alterspective/foundry/css/tokens.css';
import '@alterspective/foundry/css/base.css';License
Copyright (c) 2024-present Alterspective Pty Ltd. All rights reserved.