@stacksjs/stx 0.0.9 → 0.1.6

package/dist/streaming.d.ts

@@ -1,14 +1,30 @@
-import type { CustomDirective, StreamRenderer, StreamingConfig, StxOptions } from './types';
-
-declare const defaultStreamingConfig: StreamingConfig;
-export declare function streamTemplate(templatePath: string,
-  data: Record<string, any> = {},
-  options: StxOptions = {},): Promise<ReadableStream<string>>;
-export declare function createStreamRenderer(templatePath: string,
-  options: StxOptions = {},): Promise<StreamRenderer>;
-export declare const islandDirective: CustomDirective;
-export declare function registerStreamingDirectives(options: StxOptions = {}): CustomDirective[];
-export declare function processSectionDirectives(content: string,
-  context: Record<string, any>,
-  filePath: string,
-  options: StxOptions = {},): Promise<string>;
+import type { CustomDirective, StreamRenderer, StxOptions } from './types';
+/**
+ * Stream a template with data
+ * @param templatePath Path to the template
+ * @param data Data to render with the template
+ * @param options stx options
+ */
+export declare function streamTemplate(templatePath: string, data?: Record<string, any>, options?: StxOptions): Promise<ReadableStream<string>>;
+/**
+ * Create a stream renderer for progressive loading
+ * @param templatePath Path to the template
+ * @param options stx options
+ */
+export declare function createStreamRenderer(templatePath: string, options?: StxOptions): Promise<StreamRenderer>;
+/**
+ * Register streaming and hydration directives
+ */
+export declare function registerStreamingDirectives(options?: StxOptions): CustomDirective[];
+/**
+ * Process section directives
+ * @param content Template content
+ * @param context Data context
+ * @param filePath Template file path
+ * @param _options stx options
+ */
+export declare function processSectionDirectives(content: string, context: Record<string, any>, filePath: string, _options?: StxOptions): Promise<string>;
+/**
+ * Custom directive for creating islands (for partial hydration)
+ */
+export declare const islandDirective: CustomDirective;

package/dist/types.d.ts

@@ -1,32 +1,25 @@
-export declare type CustomDirectiveHandler = (
-  content: string,
-  params: string[],
-  context: Record<string, any>,
-  filePath: string
-) => string | Promise<string>
-
-export interface CustomDirective {
+/**
+ * Custom directive definition
+ */
+export declare interface CustomDirective {
   name: string
   handler: CustomDirectiveHandler
   hasEndTag?: boolean
   description?: string
 }
-
-export type MiddlewareHandler = (
-  template: string,
-  context: Record<string, any>,
-  filePath: string,
-  options: StxOptions
-) => string | Promise<string>
-
-export interface Middleware {
+/**
+ * Middleware definition
+ */
+export declare interface Middleware {
   name: string
   handler: MiddlewareHandler
   timing: 'before' | 'after'
   description?: string
 }
-
-export interface I18nConfig {
+/**
+ * Internationalization (i18n) configuration
+ */
+export declare interface I18nConfig {
   defaultLocale: string
   locale: string
   translationsDir: string
@@ -34,8 +27,10 @@ export interface I18nConfig {
   fallbackToKey: boolean
   cache: boolean
 }
-
-export interface WebComponent {
+/**
+ * Web component definition
+ */
+export declare interface WebComponent {
   name: string
   tag: string
   file: string
@@ -46,24 +41,28 @@ export interface WebComponent {
   attributes?: string[]
   description?: string
 }
-
-export interface WebComponentConfig {
+/**
+ * Web components configuration
+ */
+export declare interface WebComponentConfig {
   enabled: boolean
   outputDir: string
   components: WebComponent[]
 }
-
-export type DocFormat = 'markdown' | 'html' | 'json'
-
-export interface ComponentPropDoc {
+/**
+ * Component property documentation
+ */
+export declare interface ComponentPropDoc {
   name: string
   type?: string
   required?: boolean
   default?: string
   description?: string
 }
-
-export interface ComponentDoc {
+/**
+ * Component documentation
+ */
+export declare interface ComponentDoc {
   name: string
   path: string
   description?: string
@@ -72,23 +71,29 @@ export interface ComponentDoc {
   isWebComponent?: boolean
   tag?: string
 }
-
-export interface TemplateDoc {
+/**
+ * Template documentation
+ */
+export declare interface TemplateDoc {
   name: string
   path: string
   description?: string
   components?: string[]
   directives?: string[]
 }
-
-export interface DirectiveDoc {
+/**
+ * Directive documentation
+ */
+export declare interface DirectiveDoc {
   name: string
   description?: string
   hasEndTag: boolean
   example?: string
 }
-
-export interface DocGeneratorConfig {
+/**
+ * Documentation generator configuration
+ */
+export declare interface DocGeneratorConfig {
   enabled: boolean
   outputDir: string
   format: DocFormat
@@ -98,45 +103,145 @@ export interface DocGeneratorConfig {
   extraContent?: string
   template?: string
 }
-
-export interface StreamingConfig {
+/**
+ * Streaming configuration
+ */
+export declare interface StreamingConfig {
   enabled: boolean
   bufferSize: number
   strategy: 'auto' | 'manual' | 'sections'
   timeout: number
 }
-
-export interface StreamRenderer {
+/**
+ * Stream renderer for progressive loading
+ */
+export declare interface StreamRenderer {
   renderShell: (data?: Record<string, any>) => Promise<string>
   renderSection: (section: string, data?: Record<string, any>) => Promise<string>
   getSections: () => string[]
   getTemplate: () => string
 }
-
-export interface HydrationConfig {
+/**
+ * Hydration configuration
+ */
+export declare interface HydrationConfig {
   enabled: boolean
   mode: 'progressive' | 'islands'
   clientEntry: string
   autoMarkers: boolean
   preload: 'none' | 'eager' | 'lazy'
 }
-
-export interface Island {
+/**
+ * Island definition for partial hydration
+ */
+export declare interface Island {
   id: string
   component: string
   props?: Record<string, any>
   priority?: 'eager' | 'lazy'
   shadowDOM?: boolean
 }
-
-export interface StxConfig {
+/**
+ * Accessibility configuration
+ */
+export declare interface A11yConfig {
+  enabled: boolean
+  addSrOnlyStyles: boolean
+  level: 'AA' | 'AAA'
+  ignoreChecks?: string[]
+  autoFix: boolean
+}
+/**
+ * SEO OpenGraph configuration
+ */
+export declare interface OpenGraphConfig {
+  type?: string
+  title?: string
+  description?: string
+  url?: string
+  image?: string
+  imageAlt?: string
+  imageWidth?: number
+  imageHeight?: number
+  siteName?: string
+}
+/**
+ * SEO Twitter card configuration
+ */
+export declare interface TwitterConfig {
+  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
+  title?: string
+  description?: string
+  image?: string
+  site?: string
+  creator?: string
+}
+/**
+ * SEO configuration
+ */
+export declare interface SeoConfig {
+  title?: string
+  description?: string
+  keywords?: string[] | string
+  robots?: string
+  canonical?: string
+  openGraph?: OpenGraphConfig
+  twitter?: TwitterConfig
+  structuredData?: Record<string, any>
+}
+/**
+ * SEO features configuration
+ */
+export declare interface SeoFeatureConfig {
+  enabled: boolean
+  defaultConfig?: SeoConfig
+  socialPreview?: boolean
+  defaultImage?: string
+}
+/**
+ * Animation configuration
+ */
+export declare interface AnimationConfig {
+  enabled: boolean
+  defaultDuration: number
+  defaultEase: string
+  respectMotionPreferences: boolean
+  staggerDelay: number
+}
+/**
+ * Syntax highlighting configuration
+ */
+export declare interface SyntaxHighlightingConfig {
+  enabled: boolean
+  serverSide: boolean
+  defaultTheme: SyntaxHighlightTheme
+  highlightUnknownLanguages: boolean
+  additionalThemes?: SyntaxHighlightTheme[]
+}
+/**
+ * Markdown configuration
+ */
+export declare interface MarkdownConfig {
+  enabled: boolean
+  dir?: string
+  syntaxHighlighting?: Partial<SyntaxHighlightingConfig>
+}
+/**
+ * stx configuration options
+ */
+export declare interface StxConfig {
+  templatesDir?: string
+  defaultTitle?: string
+  defaultDescription?: string
+  defaultImage?: string
+  cache?: boolean
+  cacheDir?: string
+  cacheVersion?: string
   enabled: boolean
   partialsDir: string
   componentsDir: string
   debug: boolean
-  cache: boolean
   cachePath: string
-  cacheVersion: string
   customDirectives?: CustomDirective[]
   middleware?: Middleware[]
   i18n?: Partial<I18nConfig>
@@ -144,6 +249,67 @@ export interface StxConfig {
   docs?: Partial<DocGeneratorConfig>
   streaming?: Partial<StreamingConfig>
   hydration?: Partial<HydrationConfig>
+  a11y?: Partial<A11yConfig>
+  seo?: Partial<SeoFeatureConfig>
+  animation?: Partial<AnimationConfig>
+  skipDefaultSeoTags?: boolean
+  markdown?: Partial<MarkdownConfig>
 }
-
+/**
+ * stx Config
+ */
+/**
+ * Custom directive handler function
+ */
+export type CustomDirectiveHandler = (
+  content: string,
+  params: string[],
+  context: Record<string, any>,
+  filePath: string
+) => string | Promise<string>
+/**
+ * Middleware handler function
+ */
+export type MiddlewareHandler = (
+  template: string,
+  context: Record<string, any>,
+  filePath: string,
+  options: StxOptions
+) => string | Promise<string>
+/**
+ * Documentation format options
+ */
+export type DocFormat = 'markdown' | 'html' | 'json'
+/**
+ * Available syntax highlighting themes
+ */
+export type SyntaxHighlightTheme = | 'css-variables'
+  | 'dark-plus'
+  | 'dracula'
+  | 'dracula-soft'
+  | 'github-dark'
+  | 'github-dark-dimmed'
+  | 'github-light'
+  | 'hc_light'
+  | 'light-plus'
+  | 'material-theme'
+  | 'material-theme-darker'
+  | 'material-theme-lighter'
+  | 'material-theme-ocean'
+  | 'material-theme-palenight'
+  | 'min-dark'
+  | 'min-light'
+  | 'monokai'
+  | 'nord'
+  | 'one-dark-pro'
+  | 'poimandres'
+  | 'rose-pine'
+  | 'rose-pine-dawn'
+  | 'rose-pine-moon'
+  | 'slack-dark'
+  | 'slack-ochin'
+  | 'solarized-dark'
+  | 'solarized-light'
+  | 'vitesse-dark'
+  | 'vitesse-light'
 export type StxOptions = Partial<StxConfig>

package/dist/utils.d.ts

@@ -1,9 +1,27 @@
 import type { StxOptions } from './types';
-
-declare const componentsCache: (...args: any[]) => unknown;
+/**
+ * Shared function to render a component with props and slot content
+ */
 export declare function renderComponent(componentPath: string, props: Record<string, any>, slotContent: string, componentsDir: string, parentContext: Record<string, any>, parentFilePath: string, options: StxOptions, processedComponents?: Set<string> | undefined, dependencies: Set<string>): Promise<string>;
+/**
+ * Check if a file exists
+ */
 export declare function fileExists(filePath: string): Promise<boolean>;
+/**
+ * Extract variables from script content
+ */
 export declare function extractVariables(scriptContent: string, context: Record<string, any>, filePath: string): Promise<void>;
+/**
+ * Resolve a template path based on the current file path
+ */
 export declare function resolveTemplatePath(templatePath: string, currentFilePath: string, options: StxOptions, dependencies?: Set<string>): Promise<string | null>;
-export declare function getSourceLineInfo(template: string, errorPosition?: number, errorPattern?: string): void;
+/**
+ * Get source line number from an error in a template
+ * This helps provide more precise error messages
+ * @param template The full template string
+ * @param errorPosition The character position of the error (if available)
+ * @param errorPattern The pattern to locate in the template (fallback if position not available)
+ * @returns Line number and context information
+ */
+export declare function getSourceLineInfo(template: string, errorPosition?: number, errorPattern?: string): { lineNumber: number, lineContent: string, context: string };
 export declare function createDetailedErrorMessage(errorType: string, errorMessage: string, filePath: string, template: string, errorPosition?: number, errorPattern?: string): string;

package/dist/view-composers.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Register a composer for a specific view
+ */
+export declare function composer(view: string, callback: ViewComposerCallback): void;
+/**
+ * Register a composer for all views matching a pattern
+ */
+export declare function composerPattern(pattern: string | RegExp, callback: ViewComposerCallback): void;
+/**
+ * Execute all composers for a given view
+ */
+export declare function runComposers(filePath: string, context: Record<string, any>): Promise<void>;
+/**
+ * Clear all registered composers
+ * (Mainly for testing purposes)
+ */
+export declare function clearComposers(): void;
+/**
+ * View Composers functionality for stx templating
+ * Similar to Laravel's View Composers, this allows registering
+ * callbacks that should run whenever a specific view is rendered.
+ */
+/**
+ * Type definition for view composer callback function
+ */
+export type ViewComposerCallback = (context: Record<string, any>, filePath: string) => void | Promise<void>

package/dist/web-components.d.ts

@@ -1,16 +1,9 @@
-import type { StxOptions, WebComponent } from './types';
-
+import type { StxOptions } from './types';
+/**
+ * Builds web components from stx components
+ */
 export declare function buildWebComponents(options: StxOptions, dependencies: Set<string>): Promise<string[]>;
-declare function buildWebComponent(component: WebComponent, options: StxOptions, dependencies: Set<string>): Promise<string | null>;
-declare interface WebComponentCodeOptions {
-  name: string
-  tag: string
-  baseElement?: string
-  source: string
-  shadowDOM: boolean
-  template: boolean
-  styleSource?: string
-  attributes?: string[]
-}
-declare function generateWebComponentCode(options: WebComponentCodeOptions): string;
+/**
+ * Directive handler for embedding web components in templates
+ */
 export declare function webComponentDirectiveHandler(content: string, params: string[], context: Record<string, any>, _filePath: string): string;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/stx",
   "type": "module",
-  "version": "0.0.9",
-  "description": "A Bun plugin that allows for using Laravel Blade-like syntax.",
+  "version": "0.1.6",
+  "description": "A performant UI Framework. Powered by Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",
   "homepage": "https://github.com/stacksjs/stx#readme",
@@ -26,13 +26,13 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/src/index.js"
     },
     "./*": {
       "import": "./dist/*"
     }
   },
-  "module": "./dist/index.js",
+  "module": "./dist/src/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
     "stx": "./dist/bin/cli.js"
@@ -43,7 +43,9 @@
     "dist"
   ],
   "scripts": {
-    "build": "bun --bun build.ts",
+    "build": "bun run build:css && bun --bun build.ts",
+    "build:css": "bun ./scripts/build-css.ts",
+    "css:watch": "bun ./scripts/watch-css.ts",
     "compile": "bun build ./bin/cli.ts --compile --minify --outfile ./bin/stx",
     "compile:all": "bun run compile:linux-x64 && bun run compile:linux-arm64 && bun run compile:windows-x64 && bun run compile:darwin-x64 && bun run compile:darwin-arm64",
     "compile:linux-x64": "bun build ./bin/cli.ts --compile --minify --target=bun-linux-x64 --outfile ./bin/stx-linux-x64",
@@ -62,13 +64,20 @@
     "lint:fix": "bunx eslint . --fix",
     "fresh": "bunx rimraf node_modules/ bun.lock && bun i",
     "changelog": "bunx changelogen --output CHANGELOG.md",
-    "prepublishOnly": "bun run build && bun run compile:all",
+    "prepublishOnly": "bun run build && bun ./scripts/update-git-hash.ts && bun run compile:all && bun run zip:all",
     "release": "bun run changelog && bunx bumpp package.json --all",
-    "test": "bun test",
+    "test": "bun test --preload ./happy-dom.ts",
+    "test:watch": "bun test --watch --preload ./happy-dom.ts",
+    "test:coverage": "bun test --coverage --preload ./happy-dom.ts",
     "typecheck": "bun tsc --noEmit"
   },
   "dependencies": {
-    "marked": "^15.0.11",
-    "yaml": "^2.7.1"
+    "@stacksjs/clapp": "^0.2.0",
+    "@stacksjs/headwind": "^0.1.3",
+    "@stacksjs/markdown": "0.0.1",
+    "@stacksjs/sanitizer": "0.0.1",
+    "bun-plugin-stx": "0.0.10",
+    "bunfig": "^0.15.0",
+    "ts-syntax-highlighter": "^0.1.0"
   }
 }