@ohos-ports/stacksjs-stx 0.2.287-beta.0

package/dist/index.d.ts

@@ -0,0 +1,365 @@
+/// <reference path="./stx.d.ts" />
+export type { Store, StoreOptions, PersistOptions, DefineStoreOptions } from './state-management';
+export type { StxComponentInstance, EmitFn } from './composition-api';
+export type { VNode } from './jsx-runtime';
+export type { StxApp, StxApp as App, StxAppPlugin, StxPluginInput, StxAppConfig } from './app';
+export type { StxPlugin, PluginContext, PluginSetupContext } from './plugin-system';
+export type { DoctorCheck, DoctorReport, DoctorOptions, CheckStatus } from './doctor';
+export type { StxStrictDiagnostic, StxStrictOptions, StxStrictRuleId } from './strict-lint';
+export type {
+  ExtractPropTypes,
+  PropOptions,
+  PropsDefinition,
+  PropValidationError,
+  PropValidationResult,
+} from './props';
+// ============================================================
+// STX Core Exports
+// Note: Some modules have overlapping exports. If you need specific
+// items, import directly from the module (e.g., import { x } from 'stx/reactivity')
+// ============================================================
+// Explicit re-exports to resolve wildcard ambiguities
+export { type BuildResult } from './build-optimizer';
+// Exported for servers as well as the static build: SSR inlines the runtime
+// once per *request*, which is the same waste in a worse form.
+export { EXTERNALIZED_ASSET_DIR, externalizeHtml, externalizeSharedAssets, type ExternalizedAsset, type ExternalizeHtmlResult, type ExternalizeResult } from './build-externalize';
+export { externalizeRepeatedAssets } from './build-externalize-repeated';
+export { type ComponentInstance } from './reactivity';
+export { type HydrationOptions } from './hydration';
+// `CookieOptions` is the user-facing type for the `useCookie()` composable —
+// the most common consumer path. The route-middleware module (re-exported from
+// stx-router) and the SSR module each have their own internal `CookieOptions`
+// shapes with different field sets; those are kept private to their modules
+// to avoid silently shadowing the user-facing one. Surfaced by stacksjs/stx#1707.
+export { type CookieOptions } from './composables/use-cookie';
+// Storage composables were reachable ONLY via the './composables' subpath, so
+// `import { useLocalStorage } from '@stacksjs/stx'` failed with TS2614 while
+// `state`/`derived` imported fine — and a `functions/` composable (which the
+// docs recommend for anything with persistence) had to reach for the subpath,
+// where the same identifier used to return a different shape. See #1797.
+export {
+  clearStorage,
+  getStorageKeys,
+  getStorageSize,
+  type StorageRef,
+  type StorageType,
+  useLocalStorage,
+  useSessionStorage,
+  useStorage,
+  type UseStorageOptions,
+} from './composables/use-storage';
+// View composers were unreachable: `runComposers` is wired into the render
+// pipeline (process.ts:1206) and runs on every render, but the two functions that
+// PUT anything in the registry were never exported, so the registry was always
+// empty and the whole layer was dead weight. The module's own docblock tells you
+// to `import { composer } from 'stx'`, which threw. The existing test suite
+// imported from './view-composers' directly, so nothing exercised the public
+// surface and the gap stayed invisible. See #1860.
+export {
+  clearComposers,
+  composer,
+  composerPattern,
+  runComposers,
+  type ViewComposerCallback,
+} from './view-composers';
+// useForm and the `v` validator builder shipped unreachable: the module's
+// docblock says `import { useForm, v } from 'stx'` (forms-validation.ts:9),
+// and that import threw. process.ts reached the module lazily for directive
+// processing only, so the form primitive itself had no way in. See #1856.
+//
+// `defineForm` is the deprecated pre-#1843 spelling, exported alongside so an
+// app does not have to rename in the same release it upgrades in.
+export {
+  defineForm,
+  useForm,
+  v,
+  Validator,
+  type ValidatorFn,
+  type AsyncValidatorFn,
+  type ValidatorRule,
+  type FieldState,
+  type FormState,
+} from './forms-validation';
+export { formatSize, getTotalSize } from './deploy/index';
+export { type ImageRenderResult, type ImageVariant, type ProcessedImage, clearImageCache, getFallbackVariant, getMimeType, groupVariantsByFormat, optimizeImage, processImage } from './image-optimization/index';
+export { type AnalysisResult } from './analyzer';
+export { type AnalyzeOptions, type ChunkInfo } from './production-build';
+// generateReport moved to stx/visual-testing
+export { fileExists } from './utils';
+// `CompressionOptions` is declared twice — the response compressor's options
+// (`./compression`, what a server tunes) and the production build's
+// (`./production-build`). A wildcard collision exports NEITHER, so the
+// user-facing one is named explicitly here; the build's is reachable from the
+// `stx/production-build` subpath.
+export { type CompressionOptions } from './compression';
+export { type StreamingConfig } from './types';
+export { type Middleware } from './ssr';
+// Re-export the Icon-collection preloader so dev servers (e.g.
+// bun-plugin-stx/serve) can warm the @iconify/json cache at boot. Without
+// it the IconBuiltin returns a "collection not loaded" placeholder on
+// the first render of every page after server start.
+export { preloadIconCollection } from './builtins/index';
+// Build-time image placeholders for <StxImage>. Exported so a build (or a
+// long-lived server) can warm them before anything renders.
+export {
+  clearImagePlaceholders,
+  getImagePlaceholder,
+  placeholdersWarmed,
+  setImagePlaceholder,
+  warmImagePlaceholders,
+  type ImagePlaceholder,
+} from './builtins/image-placeholder';
+export {
+  clearImageDeliveryCatalog,
+  getImageDelivery,
+  prepareImageDelivery,
+} from './builtins/image-delivery';
+// Core functionality - these are the primary modules
+export * from './reactivity';
+export * from './head';
+export * from './page-response';
+export * from './route-middleware';
+export * from './runtime';
+export * from './forms';
+// Core modules
+export * from './env';
+export { getPublicEnv, getPublicEnvDefine } from './public-env';
+export * from './a11y';
+export * from './analytics';
+export * from './analyzer';
+export * from './animation';
+export * from './appearance-bootstrap';
+export * from './assets';
+export * from './app-shell';
+export * from './async-components';
+export * from './auth';
+export * from './build';
+export * from './build-assets';
+export * from './build-id';
+export * from './build-mode-detector';
+export * from './build-optimizer';
+export * from './broadcasting';
+export * from './caching';
+export * from './components';
+export * from './component-library';
+export * from './color-mode-boot';
+export * from './config';
+// craft-bridge, craft-compiler, craft-components, craft-ssr, native-build
+// moved to stx/craft
+export * from './csp';
+export * from './custom-directives';
+// database moved to stx/database
+export * from './defer';
+export * from './deploy/index';
+export * from './compression';
+export * from './dev-server';
+export * from './document-shell';
+export * from './fragment-container';
+// DevTools entry points. Exported selectively rather than with a wildcard:
+// devtools.ts also exports registerStore, which would collide with
+// state-management's function of the same name. Their own docblock says
+// `import { enableDevTools } from 'stx'`, and that import threw — so devtools
+// could not be turned on from the package entry at all. See #1873.
+export { disableDevTools, enableDevTools } from './devtools';
+// composables.ts:161 documents `import { onUpdate } from 'stx'`; it was
+// reachable only through the stx/composables subpath.
+export { onUpdate } from './composables';
+export * from './directive-api';
+export * from './docs';
+export * from './edge-runtime';
+export * from './screenshot';
+export * from './error-handling';
+export * from './events';
+export * from './expressions';
+export * from './formatter';
+export * from './heatmap';
+export * from './hot-reload';
+export * from './i18n';
+export * from './includes';
+export * from './init';
+export * from './interactive';
+export * from './keep-alive';
+export * from './loops';
+export * from './markdown';
+export * from './middleware';
+export * from './page-action';
+export * from './parser/index';
+export * from './manifest';
+export * from './placeholder';
+export * from './process';
+export * from './production-build';
+export * from './production-builder';
+export * from './production-server';
+export * from './release';
+export * from './router';
+export * from './scaffolding';
+export * from './script-classifier';
+export * from './seo';
+export * from './serve';
+export * from './spa-nav';
+// Where stx keeps its generated state (`.stx/` by default, configurable)
+export * from './state-dir';
+export * from './style-scoping';
+export * from './template-compiler';
+export * from './template-hydrator';
+export * from './streaming';
+export * from './suspense';
+export * from './teleport';
+export * from './transitions';
+export * from './type-checker';
+// Type-checking the TypeScript inside .stx script blocks, and the CLI behind
+// `stx typecheck` (#1852). Distinct from ./type-checker, which is a bespoke
+// checker for template EXPRESSIONS.
+export * from './typecheck';
+export * from './web-components';
+export * from './virtual-scrolling';
+export * from './partial-hydration';
+export * from './hydration-runtime';
+export * from './client';
+export * from './loading-indicator';
+export * from './reactive-bindings';
+export * from './client-helpers';
+export * from './client-script';
+/*
+ * The authoring surface, as data.
+ *
+ * `STX_RUNTIME_GLOBALS` is what a client script gets as bare identifiers, and
+ * it is the answer to "which names are ambient in an stx template" - a question
+ * every consuming framework has to answer to type its own templates. It was
+ * reachable only by deep path, so consumers kept their own copies of the list
+ * and those copies drifted: Stacks shipped a declaration naming 405 browser
+ * globals of which 291 did not exist, because the tool that wrote it had been
+ * run once and never again.
+ *
+ * The list is already the single source of truth in here, guarded by
+ * `runtime-globals.test.ts` against the real `window.stx`. Exporting it means a
+ * consumer can derive from the same guarded list instead of transcribing it.
+ */
+export * from './runtime-globals';
+export * from './strip-literals';
+export * from './resolve-stx-targets';
+export * from './cookie-serialize';
+export * from './cli-flags';
+export * from './component-hmr';
+export * from './hydration';
+// ssg moved to stx/ssg
+export * from './ssr';
+// State management — explicit exports to avoid conflicts with runtime.ts and reactivity.ts
+export {
+  createStore,
+  defineStore,
+  getStore,
+  getStoreNames,
+  hasStore,
+  registerStoresClient,
+  useStore,
+} from './state-management';
+// visual-testing moved to stx/visual-testing
+export * from './image-optimization/index';
+export * from './media/index';
+// bundle-analyzer moved to stx/bundle-analyzer
+export * from './build-views';
+export * from './signals';
+export * from './spa-shell';
+// Vue compatibility, server bindings, and JSX support
+export * from './vue-template';
+export { processServerBindings } from './server-bindings';
+export { provide, inject, setGlobalProvide, defineEmits, defineExpose, defineSlots, nextTick, onErrorCaptured, handleError, useSlots, useAttrs, createProvideContext, generateCompositionRuntime } from './composition-api';
+export { jsx, jsxs, jsxDEV, Fragment, renderToString, renderToStream, renderToDOM, Show, For, Portal, h } from './jsx-runtime';
+export { createApp, createApp as createStxApp, defineCustomElement } from './app';
+export * from './dynamic-components';
+export { definePlugin, pluginManager } from './plugin-system';
+// These modules are exported first to establish their types
+export * from './render';
+export { extractClassNames, generateCss, getCssServeAsset, injectCss } from './dev-server/ts-css';
+// One css merge shared by every render path (#1867)
+export { deepMergeThemes, mergeCssConfig, type MergedCssConfig } from './ts-css-config';
+// Dev-mode invalidation for the store/composable bundles (#1877)
+export { clearStoreCache, getStoreScript } from './store-loader';
+export { clearComposableCache } from './composable-loader';
+// Generated union of layouts on disk (#1879)
+export { discoverLayoutNames, generateLayoutTypes, LAYOUT_TYPES_FILE, renderLayoutTypes } from './layout-types';
+// Typed route paths (#1887). Without this export the generated augmentation is
+// dangling again, for exactly the reason `stx/routes` was.
+export {
+  $path,
+  type CheckHref,
+  type KnownRoutes,
+  type RouteHref,
+  type RouteParams,
+  type RoutePath,
+  type RoutePattern,
+  type RoutePatternUsedAsHref,
+  type UnknownRoute,
+} from './route-types';
+export { runDoctor, formatDoctorReport, findPantryPackage } from './doctor';
+export {
+  applyTranslations,
+  buildAlternateLinks,
+  buildLangPickerScript,
+  buildStaticSite,
+  defineSiteConfig,
+  generateRobots,
+  generateSitemap,
+  // injectRouterScript intentionally NOT re-exported here — it would collide
+  // with the canonical runtime-injection one (re-exported via `./render` →
+  // `./process` → `./runtime-injection`). The site-builder version hardcodes
+  // `container:'body'` for static-site builds and would silently override
+  // the dev-server's main-container injection. Static-site callers should
+  // import it directly from '@stacksjs/stx/site-builder' or the explicit
+  // module path if needed.
+  injectSeo,
+  injectThemeBootstrap,
+  localizePath,
+  resolveI18n,
+  stampLocaleLayoutGroup,
+  stripLocalePrefix,
+  translate,
+  type BuildOptions,
+  type BuildResult as SiteBuildResult,
+  type PageMeta,
+  type ResolvedI18n,
+  type RouterOptions,
+  type SiteConfig,
+  type SiteI18nOptions,
+  type SiteRouterOptions,
+  type SiteSeo,
+  type SiteSocial,
+  type SiteThemeOptions,
+  type SitemapEntry,
+  type ThemeOptions,
+} from './site-builder/index';
+export * from './utils';
+export * from './slots';
+// Testing module - has overlapping 'render' export with ssr
+// Import from stx/testing directly if needed
+// export * from './testing'
+// Server components - has overlapping exports (RenderResult, clearComponentCache)
+// Import from stx/server-components directly if needed
+// export * from './server-components'
+// stx-strict footgun linter (stacksjs/stx#1744)
+export { lintStxStrict } from './strict-lint';
+// Types module - note: PropType is also in props, import from stx/props if needed
+export * from './types';
+// Props module — surfaces the user-facing typed-props API (stacksjs/stx#1740).
+// Selective re-export avoids overlap with `./types`' string-union `PropType`
+// (different shape) and `./composition-api`'s `defineEmits` / `EmitFn` (the
+// canonical events API — props.ts has dead duplicates kept only for
+// internal back-compat). For `PropType<T>` (constructor union) and the props
+// flavour of `defineEmits` / `EmitFn`, import from 'stx/props' directly.
+export {
+  arrayOf,
+  defineProps,
+  definePropsWithValidation,
+  oneOf,
+  optional,
+  processComponentProps,
+  prop,
+  required,
+  shape,
+  validated,
+  withDefaults,
+} from './props';
+export { isMarkdownPath, type MarkdownRenderer, type MarkdownView, protectCodeBlocks, renderMarkdownView } from './markdown-view';
+// Default export for the stx module
+export default {};

package/dist/index.js

@@ -0,0 +1,202 @@
+export { EXTERNALIZED_ASSET_DIR, externalizeHtml, externalizeSharedAssets } from "./build-externalize.js";
+export { externalizeRepeatedAssets } from "./build-externalize-repeated.js";
+export {
+  clearStorage,
+  getStorageKeys,
+  getStorageSize,
+  useLocalStorage,
+  useSessionStorage,
+  useStorage
+} from "./composables/use-storage.js";
+export {
+  clearComposers,
+  composer,
+  composerPattern,
+  runComposers
+} from "./view-composers.js";
+export {
+  defineForm,
+  useForm,
+  v,
+  Validator
+} from "./forms-validation.js";
+export { formatSize, getTotalSize } from "./deploy/index.js";
+export { clearImageCache, getFallbackVariant, getMimeType, groupVariantsByFormat, optimizeImage, processImage } from "./image-optimization/index.js";
+export { fileExists } from "./utils.js";
+export { preloadIconCollection } from "./builtins/index.js";
+export {
+  clearImagePlaceholders,
+  getImagePlaceholder,
+  placeholdersWarmed,
+  setImagePlaceholder,
+  warmImagePlaceholders
+} from "./builtins/image-placeholder.js";
+export {
+  clearImageDeliveryCatalog,
+  getImageDelivery,
+  prepareImageDelivery
+} from "./builtins/image-delivery.js";
+export * from "./reactivity.js";
+export * from "./head.js";
+export * from "./page-response.js";
+export * from "./route-middleware.js";
+export * from "./runtime.js";
+export * from "./forms.js";
+export * from "./env.js";
+export { getPublicEnv, getPublicEnvDefine } from "./public-env.js";
+export * from "./a11y.js";
+export * from "./analytics.js";
+export * from "./analyzer.js";
+export * from "./animation.js";
+export * from "./appearance-bootstrap.js";
+export * from "./assets.js";
+export * from "./app-shell.js";
+export * from "./async-components.js";
+export * from "./auth.js";
+export * from "./build.js";
+export * from "./build-assets.js";
+export * from "./build-id.js";
+export * from "./build-mode-detector.js";
+export * from "./build-optimizer.js";
+export * from "./broadcasting.js";
+export * from "./caching.js";
+export * from "./components.js";
+export * from "./component-library.js";
+export * from "./color-mode-boot.js";
+export * from "./config.js";
+export * from "./csp.js";
+export * from "./custom-directives.js";
+export * from "./defer.js";
+export * from "./deploy/index.js";
+export * from "./compression.js";
+export * from "./dev-server.js";
+export * from "./document-shell.js";
+export * from "./fragment-container.js";
+export { disableDevTools, enableDevTools } from "./devtools.js";
+export { onUpdate } from "./composables.js";
+export * from "./directive-api.js";
+export * from "./docs.js";
+export * from "./edge-runtime.js";
+export * from "./screenshot.js";
+export * from "./error-handling.js";
+export * from "./events.js";
+export * from "./expressions.js";
+export * from "./formatter.js";
+export * from "./heatmap.js";
+export * from "./hot-reload.js";
+export * from "./i18n.js";
+export * from "./includes.js";
+export * from "./init.js";
+export * from "./interactive.js";
+export * from "./keep-alive.js";
+export * from "./loops.js";
+export * from "./markdown.js";
+export * from "./middleware.js";
+export * from "./page-action.js";
+export * from "./parser/index.js";
+export * from "./manifest.js";
+export * from "./placeholder.js";
+export * from "./process.js";
+export * from "./production-build.js";
+export * from "./production-builder.js";
+export * from "./production-server.js";
+export * from "./release.js";
+export * from "./router.js";
+export * from "./scaffolding.js";
+export * from "./script-classifier.js";
+export * from "./seo.js";
+export * from "./serve.js";
+export * from "./spa-nav.js";
+export * from "./state-dir.js";
+export * from "./style-scoping.js";
+export * from "./template-compiler.js";
+export * from "./template-hydrator.js";
+export * from "./streaming.js";
+export * from "./suspense.js";
+export * from "./teleport.js";
+export * from "./transitions.js";
+export * from "./type-checker.js";
+export * from "./typecheck.js";
+export * from "./web-components.js";
+export * from "./virtual-scrolling.js";
+export * from "./partial-hydration.js";
+export * from "./hydration-runtime.js";
+export * from "./client.js";
+export * from "./loading-indicator.js";
+export * from "./reactive-bindings.js";
+export * from "./client-helpers.js";
+export * from "./client-script.js";
+export * from "./runtime-globals.js";
+export * from "./strip-literals.js";
+export * from "./resolve-stx-targets.js";
+export * from "./cookie-serialize.js";
+export * from "./cli-flags.js";
+export * from "./component-hmr.js";
+export * from "./hydration.js";
+export * from "./ssr.js";
+export {
+  createStore,
+  defineStore,
+  getStore,
+  getStoreNames,
+  hasStore,
+  registerStoresClient,
+  useStore
+} from "./state-management.js";
+export * from "./image-optimization/index.js";
+export * from "./media/index.js";
+export * from "./build-views.js";
+export * from "./signals.js";
+export * from "./spa-shell.js";
+export * from "./vue-template.js";
+export { processServerBindings } from "./server-bindings.js";
+export { provide, inject, setGlobalProvide, defineEmits, defineExpose, defineSlots, nextTick, onErrorCaptured, handleError, useSlots, useAttrs, createProvideContext, generateCompositionRuntime } from "./composition-api.js";
+export { jsx, jsxs, jsxDEV, Fragment, renderToString, renderToStream, renderToDOM, Show, For, Portal, h } from "./jsx-runtime.js";
+export { createApp, createApp as createStxApp, defineCustomElement } from "./app.js";
+export * from "./dynamic-components.js";
+export { definePlugin, pluginManager } from "./plugin-system.js";
+export * from "./render.js";
+export { extractClassNames, generateCss, getCssServeAsset, injectCss } from "./dev-server/ts-css.js";
+export { deepMergeThemes, mergeCssConfig } from "./ts-css-config.js";
+export { clearStoreCache, getStoreScript } from "./store-loader.js";
+export { clearComposableCache } from "./composable-loader.js";
+export { discoverLayoutNames, generateLayoutTypes, LAYOUT_TYPES_FILE, renderLayoutTypes } from "./layout-types.js";
+export {
+  $path
+} from "./route-types.js";
+export { runDoctor, formatDoctorReport, findPantryPackage } from "./doctor.js";
+export {
+  applyTranslations,
+  buildAlternateLinks,
+  buildLangPickerScript,
+  buildStaticSite,
+  defineSiteConfig,
+  generateRobots,
+  generateSitemap,
+  injectSeo,
+  injectThemeBootstrap,
+  localizePath,
+  resolveI18n,
+  stampLocaleLayoutGroup,
+  stripLocalePrefix,
+  translate
+} from "./site-builder/index.js";
+export * from "./utils.js";
+export * from "./slots.js";
+export { lintStxStrict } from "./strict-lint.js";
+export * from "./types.js";
+export {
+  arrayOf,
+  defineProps,
+  definePropsWithValidation,
+  oneOf,
+  optional,
+  processComponentProps,
+  prop,
+  required,
+  shape,
+  validated,
+  withDefaults
+} from "./props.js";
+export default {};
+export { isMarkdownPath, protectCodeBlocks, renderMarkdownView } from "./markdown-view.js";

package/dist/init.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Initialize a new stx file with the specified name
+ */
+export declare function initFile(fileName?: string, options?: InitOptions): Promise<boolean>;
+/**
+ * Available template presets with descriptions
+ */
+export declare const TEMPLATE_PRESETS: {
+  basic: {
+  description: 'Simple page with script, style, and template sections'
+};
+  component: {
+  description: 'Reusable component with props and slots'
+};
+  layout: {
+  description: 'Layout template with sections and yields'
+};
+  blog: {
+  description: 'Blog post with frontmatter-style variables'
+};
+  api: {
+  description: 'API endpoint template with JSON response'
+};
+  app: {
+  description: 'Full app with stores and components'
+}
+};
+/**
+ * Options for initializing a new stx file
+ */
+declare interface InitOptions {
+  force?: boolean
+  template?: string
+  preset?: TemplatePreset
+}
+/**
+ * Built-in template presets
+ */
+declare type TemplatePreset = 'basic' | 'component' | 'layout' | 'blog' | 'api' | 'app';