@stacksjs/stx 0.2.571 → 0.2.573
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/a11y.d.ts +51 -111
- package/dist/animation.d.ts +131 -74
- package/dist/api-client.d.ts +11 -21
- package/dist/api-handler.d.ts +4 -4
- package/dist/appearance-bootstrap.d.ts +16 -77
- package/dist/application-layers.d.ts +11 -20
- package/dist/asset-roots.d.ts +7 -27
- package/dist/assets.d.ts +7 -9
- package/dist/async-components.d.ts +56 -78
- package/dist/auth.d.ts +0 -3
- package/dist/browser-core-imports.d.ts +2 -2
- package/dist/build-externalize-repeated.d.ts +0 -25
- package/dist/build-externalize.d.ts +18 -53
- package/dist/build-id.d.ts +40 -28
- package/dist/build-message.d.ts +20 -44
- package/dist/builtins/attrs.d.ts +0 -14
- package/dist/builtins/drawer.d.ts +3 -22
- package/dist/builtins/icon.d.ts +17 -19
- package/dist/builtins/image-alpha.d.ts +8 -8
- package/dist/builtins/image-delivery.d.ts +38 -40
- package/dist/builtins/image-placeholder.d.ts +12 -50
- package/dist/builtins/image-warmup-worker.d.ts +1 -1
- package/dist/builtins/image-worker.d.ts +6 -32
- package/dist/builtins/index.d.ts +16 -6
- package/dist/builtins/modal.d.ts +13 -23
- package/dist/builtins/safe-image.d.ts +2 -42
- package/dist/builtins/stx-image.d.ts +44 -24
- package/dist/builtins/stx-link.d.ts +5 -8
- package/dist/builtins/stx-loading-indicator.d.ts +11 -10
- package/dist/builtins/suspense.d.ts +6 -27
- package/dist/builtins/toast.d.ts +15 -16
- package/dist/builtins/transition-group.d.ts +1 -25
- package/dist/caching.d.ts +24 -21
- package/dist/{chunk-f4jh9vrj.js → chunk-0s647d0b.js} +53 -53
- package/dist/{chunk-09gtbb1w.js → chunk-1bsafdnt.js} +1 -1
- package/dist/{chunk-m6mxqepz.js → chunk-1btr5tme.js} +1 -1
- package/dist/{chunk-01mxer9s.js → chunk-2g6wcnna.js} +1 -1
- package/dist/{chunk-rrj5m9xv.js → chunk-2hg2bqtj.js} +1 -1
- package/dist/{chunk-xckzvbvn.js → chunk-4f0fh2a9.js} +1 -1
- package/dist/chunk-557wtdps.js +2 -0
- package/dist/{chunk-vr36s2en.js → chunk-58vrf6kh.js} +1 -1
- package/dist/{chunk-qzbzn1yf.js → chunk-6tsnz28m.js} +1 -1
- package/dist/{chunk-cvswrbzw.js → chunk-6x8cwscv.js} +1 -1
- package/dist/{chunk-1n64749x.js → chunk-74ew8ajw.js} +1 -1
- package/dist/{chunk-jqefcghh.js → chunk-78d6yyxz.js} +2 -2
- package/dist/{chunk-83fdt4yj.js → chunk-824cnbac.js} +1 -1
- package/dist/{chunk-ntgy4e1q.js → chunk-864xm0jy.js} +1 -1
- package/dist/{chunk-nn174xjh.js → chunk-9fbkdrm8.js} +1 -1
- package/dist/{chunk-kzjrgh0b.js → chunk-a3gvw1q2.js} +1 -1
- package/dist/{chunk-pqcvh9pp.js → chunk-amtrg7pn.js} +1 -1
- package/dist/{chunk-pw9verqx.js → chunk-b5fpsp5n.js} +1 -1
- package/dist/{chunk-5afw7z6v.js → chunk-bcjr3fw7.js} +1 -1
- package/dist/{chunk-n6qp05t9.js → chunk-bkj0j5se.js} +1 -1
- package/dist/{chunk-mzqyv7s5.js → chunk-cf97xdqa.js} +1 -1
- package/dist/{chunk-cgwyd9aq.js → chunk-cr67dpx4.js} +1 -1
- package/dist/{chunk-f1apaqfk.js → chunk-dpqvacd1.js} +1 -1
- package/dist/{chunk-ghy82tsc.js → chunk-et8726at.js} +1 -1
- package/dist/{chunk-4bgfpkwx.js → chunk-ev8t5cxk.js} +1 -1
- package/dist/{chunk-4ssg5xpq.js → chunk-fynh3bkq.js} +12 -2
- package/dist/{chunk-gzgc8zk5.js → chunk-g8757f97.js} +2 -2
- package/dist/{chunk-3gft8zng.js → chunk-hm4j4d8q.js} +1 -1
- package/dist/{chunk-0bt0fbs1.js → chunk-j9qy9t3t.js} +5 -5
- package/dist/{chunk-2a1q5y6r.js → chunk-jhc47xzj.js} +1 -1
- package/dist/{chunk-79vdkvhf.js → chunk-kns5m52j.js} +1 -1
- package/dist/{chunk-2cqbyb8w.js → chunk-mjpewk4r.js} +1 -1
- package/dist/{chunk-2jjff8kv.js → chunk-nj488tj2.js} +2 -2
- package/dist/{chunk-dcpf6kas.js → chunk-q9chv68c.js} +1 -1
- package/dist/{chunk-xq2ck69k.js → chunk-qm280dp3.js} +1 -1
- package/dist/{chunk-ymawe0y5.js → chunk-sjcstv33.js} +1 -1
- package/dist/{chunk-tc5r2vmw.js → chunk-t0zdz8kd.js} +1 -1
- package/dist/{chunk-jwvzvapp.js → chunk-t3dnak1j.js} +1 -1
- package/dist/{chunk-2jsnrfc8.js → chunk-t64nnmmj.js} +1 -1
- package/dist/{chunk-m2a1fxpb.js → chunk-tvb8p7c0.js} +1 -1
- package/dist/{chunk-6f4qrd0s.js → chunk-tyhgq6rw.js} +1 -1
- package/dist/{chunk-4wfr074d.js → chunk-vn7tc8hm.js} +1 -1
- package/dist/{chunk-y4ajd836.js → chunk-xy6g8zb9.js} +1 -1
- package/dist/{chunk-zddzjd60.js → chunk-ya7xks9t.js} +1 -1
- package/dist/chunk-zpz6q2fh.js +2 -0
- package/dist/chunk-zxt94g45.js +2 -0
- package/dist/{chunk-cyg9w31a.js → chunk-zz7tw07b.js} +1 -1
- package/dist/{chunk-ta8bhz27.js → chunk-zzcxacjf.js} +1 -1
- package/dist/cli.js +7 -7
- package/dist/client/directive.d.ts +0 -7
- package/dist/client/index.d.ts +1 -0
- package/dist/client/signals-appearance-runtime.d.ts +1 -1
- package/dist/client/signals-binding-utils-runtime.d.ts +1 -1
- package/dist/client/signals-bootstrap-runtime.d.ts +2 -2
- package/dist/client/signals-class-runtime.d.ts +1 -1
- package/dist/client/signals-component-api-runtime.d.ts +1 -1
- package/dist/client/signals-component-hydration-runtime.d.ts +1 -1
- package/dist/client/signals-component-props-runtime.d.ts +1 -1
- package/dist/client/signals-conditional-chain-runtime.d.ts +1 -1
- package/dist/client/signals-conditional-component-runtime.d.ts +1 -1
- package/dist/client/signals-container-cleanup-runtime.d.ts +1 -1
- package/dist/client/signals-context-runtime.d.ts +1 -1
- package/dist/client/signals-cookie-runtime.d.ts +1 -1
- package/dist/client/signals-devtools-runtime.d.ts +1 -1
- package/dist/client/signals-dialog-runtime.d.ts +1 -1
- package/dist/client/signals-dom-ready-runtime.d.ts +1 -1
- package/dist/client/signals-drawer-runtime.d.ts +1 -1
- package/dist/client/signals-effect-runtime.d.ts +1 -1
- package/dist/client/signals-event-shorthand-runtime.d.ts +1 -1
- package/dist/client/signals-expression-compiler-runtime.d.ts +1 -1
- package/dist/client/signals-expression-runtime.d.ts +1 -1
- package/dist/client/signals-fetch-transport-runtime.d.ts +1 -1
- package/dist/client/signals-for-runtime.d.ts +1 -1
- package/dist/client/signals-globals-runtime.d.ts +1 -1
- package/dist/client/signals-handler-runtime.d.ts +1 -1
- package/dist/client/signals-head-runtime.d.ts +1 -1
- package/dist/client/signals-helpers-runtime.d.ts +1 -1
- package/dist/client/signals-host-runtime.d.ts +1 -1
- package/dist/client/signals-hydration-audit-runtime.d.ts +1 -1
- package/dist/client/signals-hydration-runtime.d.ts +1 -1
- package/dist/client/signals-if-chain-runtime.d.ts +1 -1
- package/dist/client/signals-if-runtime.d.ts +1 -1
- package/dist/client/signals-lazy-hydration-runtime.d.ts +1 -1
- package/dist/client/signals-lifecycle-runtime.d.ts +1 -1
- package/dist/client/signals-loop-component-remap-runtime.d.ts +1 -1
- package/dist/client/signals-loop-conditional-runtime.d.ts +1 -1
- package/dist/client/signals-loop-row-runtime.d.ts +1 -1
- package/dist/client/signals-manifest-hydration-runtime.d.ts +1 -1
- package/dist/client/signals-model-runtime.d.ts +1 -1
- package/dist/client/signals-mount-runtime.d.ts +1 -1
- package/dist/client/signals-navigation-runtime.d.ts +1 -1
- package/dist/client/signals-notify-runtime.d.ts +1 -1
- package/dist/client/signals-optimistic-runtime.d.ts +1 -1
- package/dist/client/signals-overlay-runtime.d.ts +1 -1
- package/dist/client/signals-pipe-runtime.d.ts +1 -1
- package/dist/client/signals-proxy-runtime.d.ts +1 -1
- package/dist/client/signals-query-runtime.d.ts +1 -1
- package/dist/client/signals-reactive-runtime.d.ts +1 -1
- package/dist/client/signals-ref-runtime.d.ts +1 -1
- package/dist/client/signals-scope-disposal-runtime.d.ts +1 -1
- package/dist/client/signals-scope-traversal-runtime.d.ts +1 -1
- package/dist/client/signals-show-runtime.d.ts +1 -1
- package/dist/client/signals-spa-load-control-runtime.d.ts +1 -1
- package/dist/client/signals-spa-load-runtime.d.ts +1 -1
- package/dist/client/signals-state-runtime.d.ts +1 -1
- package/dist/client/signals-storage-runtime.d.ts +1 -1
- package/dist/client/signals-store-registry-runtime.d.ts +1 -1
- package/dist/client/signals-style-runtime.d.ts +1 -1
- package/dist/client/signals-suspense-runtime.d.ts +1 -1
- package/dist/client/signals-timer-runtime.d.ts +1 -1
- package/dist/client/signals-toast-runtime.d.ts +1 -1
- package/dist/client/signals-tooltip-runtime.d.ts +1 -1
- package/dist/client/signals-transition-group-runtime.d.ts +1 -1
- package/dist/client/signals-websocket-runtime.d.ts +1 -1
- package/dist/client-helpers.d.ts +1 -312
- package/dist/client-module-registry.d.ts +4 -27
- package/dist/client-parameter-bindings.d.ts +1 -4
- package/dist/client-script-bundler.d.ts +55 -103
- package/dist/client-script.d.ts +69 -127
- package/dist/color-mode-boot.d.ts +21 -58
- package/dist/component-client-factories.d.ts +8 -9
- package/dist/component-contract-checks.d.ts +15 -18
- package/dist/component-contract.d.ts +6 -6
- package/dist/component-hmr.d.ts +8 -7
- package/dist/component-model.d.ts +14 -20
- package/dist/component-processing.d.ts +51 -59
- package/dist/component-registry.d.ts +28 -99
- package/dist/component-renderer.d.ts +19 -16
- package/dist/component-resolution.d.ts +8 -8
- package/dist/component-tags.d.ts +1 -1
- package/dist/composable-loader.d.ts +6 -41
- package/dist/composables/use-fetch.d.ts +45 -114
- package/dist/composables/use-form.d.ts +2 -56
- package/dist/composables/use-intersection-observer.d.ts +1 -1
- package/dist/composables.d.ts +75 -74
- package/dist/composition-api.d.ts +19 -43
- package/dist/computed.d.ts +93 -86
- package/dist/conditionals.d.ts +0 -24
- package/dist/config.d.ts +30 -24
- package/dist/config.js +3 -0
- package/dist/craft-bridge.d.ts +1 -467
- package/dist/craft-components.d.ts +234 -680
- package/dist/craft-entry.js +1 -1
- package/dist/craft.js +1 -1
- package/dist/csp.d.ts +41 -107
- package/dist/database.d.ts +1 -1
- package/dist/defer.d.ts +0 -24
- package/dist/dev-server/terminal-colors.d.ts +32 -32
- package/dist/dev-server/ts-css.d.ts +26 -35
- package/dist/dev-server/types.d.ts +33 -29
- package/dist/directive-api.d.ts +42 -85
- package/dist/directive-arguments.d.ts +14 -39
- package/dist/document-shell.d.ts +49 -81
- package/dist/dynamic-components.d.ts +0 -9
- package/dist/engine-bindings.d.ts +1 -1
- package/dist/env.d.ts +26 -0
- package/dist/error-boundaries.d.ts +36 -43
- package/dist/error-handling.d.ts +1 -1
- package/dist/errors/codes.d.ts +43 -51
- package/dist/errors/formatter.d.ts +38 -58
- package/dist/errors/index.d.ts +61 -5
- package/dist/errors/logger.d.ts +40 -114
- package/dist/errors/sanitizer.d.ts +28 -53
- package/dist/errors/types.d.ts +31 -44
- package/dist/events.d.ts +32 -94
- package/dist/expressions.d.ts +57 -62
- package/dist/find-body-tag.d.ts +5 -34
- package/dist/first-script-tag.d.ts +0 -23
- package/dist/forms-validation.d.ts +117 -149
- package/dist/forms.d.ts +161 -120
- package/dist/framework-composables.d.ts +0 -32
- package/dist/head-injection.d.ts +30 -32
- package/dist/head-keys.d.ts +12 -15
- package/dist/head.d.ts +110 -139
- package/dist/heatmap.d.ts +76 -152
- package/dist/html-masking.d.ts +38 -62
- package/dist/hydration-runtime.d.ts +24 -20
- package/dist/hydration.d.ts +11 -10
- package/dist/i18n.d.ts +34 -95
- package/dist/image-optimization/auto-sibling.d.ts +4 -32
- package/dist/imported-signals.d.ts +0 -36
- package/dist/includes.d.ts +6 -69
- package/dist/index.d.ts +2 -1
- package/dist/init.d.ts +12 -20
- package/dist/internal-markdown.d.ts +8 -12
- package/dist/interpolation-context.d.ts +15 -15
- package/dist/island-chunking.d.ts +13 -30
- package/dist/keep-alive.d.ts +52 -72
- package/dist/layout-types.d.ts +2 -27
- package/dist/lazy-module.d.ts +0 -10
- package/dist/loading-indicator.d.ts +8 -5
- package/dist/loop-binding.d.ts +4 -7
- package/dist/loops.d.ts +25 -67
- package/dist/markdown.d.ts +1 -0
- package/dist/media/image/component.d.ts +9 -25
- package/dist/media/image/directive.d.ts +1 -15
- package/dist/media/image/placeholder.d.ts +9 -20
- package/dist/media/image/processor/cache.d.ts +18 -40
- package/dist/media/image/processor/index.d.ts +10 -1
- package/dist/media/image/processor/optimizer.d.ts +1 -12
- package/dist/media/image/processor/responsive.d.ts +6 -16
- package/dist/media/image/srcset.d.ts +49 -47
- package/dist/media/shared/cache.d.ts +31 -51
- package/dist/media/shared/hash.d.ts +0 -7
- package/dist/media/types.d.ts +754 -1235
- package/dist/media/video/directive.d.ts +1 -15
- package/dist/media/video/index.d.ts +17 -39
- package/dist/media/video/processor/cache.d.ts +19 -42
- package/dist/media/video/processor/index.d.ts +18 -1
- package/dist/media/video/processor/streaming.d.ts +10 -17
- package/dist/media/video/processor/thumbnail.d.ts +15 -21
- package/dist/media/video/processor/transcoder.d.ts +1 -11
- package/dist/meta-arguments.d.ts +14 -39
- package/dist/method-spoofing.d.ts +0 -7
- package/dist/middleware.d.ts +0 -60
- package/dist/native/bridge/protocol.d.ts +2 -1
- package/dist/native/compiler/bundle.js +11 -1
- package/dist/native/compiler/headwind-to-style.d.ts +383 -359
- package/dist/native/compiler/icons.d.ts +249 -243
- package/dist/native/compiler/svg.d.ts +35 -24
- package/dist/native/runtime/jsc-globals.d.ts +1 -1
- package/dist/native/runtime/native-host.d.ts +1 -1
- package/dist/native/runtime/native-host.js +3 -0
- package/dist/offline/app-service-worker.d.ts +50 -114
- package/dist/offline/kept-store.d.ts +23 -37
- package/dist/offline/query-cache.d.ts +55 -126
- package/dist/owned-routes.d.ts +0 -31
- package/dist/page-response.d.ts +8 -39
- package/dist/parser/directive-parser.d.ts +45 -57
- package/dist/parser/expression-parser.d.ts +35 -33
- package/dist/parser/index.d.ts +39 -4
- package/dist/parser/tokenizer.d.ts +49 -61
- package/dist/partial-hydration.d.ts +51 -82
- package/dist/performance-utils.d.ts +115 -255
- package/dist/placeholder.d.ts +9 -18
- package/dist/plugin-system.d.ts +115 -264
- package/dist/process.d.ts +4 -9
- package/dist/process.js +6 -4
- package/dist/prop-sentinels.d.ts +11 -11
- package/dist/public-env.d.ts +0 -14
- package/dist/pwa/directives.d.ts +20 -12
- package/dist/pwa/inject.d.ts +0 -10
- package/dist/pwa/precache.d.ts +16 -22
- package/dist/pwa/service-worker.d.ts +0 -12
- package/dist/pwa.js +1 -1
- package/dist/reactive-bindings.d.ts +11 -34
- package/dist/reactive-tracking.d.ts +0 -36
- package/dist/reactive.d.ts +41 -58
- package/dist/render-memo.d.ts +5 -23
- package/dist/resolve-stx-targets.d.ts +6 -44
- package/dist/route-middleware.d.ts +35 -2
- package/dist/route-rules.d.ts +10 -13
- package/dist/router.d.ts +9 -8
- package/dist/routes.d.ts +3 -1
- package/dist/runtime-config-server.d.ts +14 -17
- package/dist/runtime-config.d.ts +2 -3
- package/dist/runtime-globals.d.ts +90 -122
- package/dist/runtime-injection.d.ts +0 -8
- package/dist/scaffolding.d.ts +30 -26
- package/dist/script-emit.d.ts +0 -30
- package/dist/script-validation.d.ts +6 -12
- package/dist/seo.d.ts +75 -153
- package/dist/server-api.d.ts +9 -12
- package/dist/server-bindings.d.ts +1 -26
- package/dist/server-data.d.ts +4 -5
- package/dist/sfc-template.d.ts +8 -8
- package/dist/signal-processing.d.ts +37 -53
- package/dist/signals-api.d.ts +58 -135
- package/dist/signals.d.ts +18 -24
- package/dist/site-url.d.ts +31 -28
- package/dist/slots.d.ts +20 -86
- package/dist/source-signature.d.ts +5 -28
- package/dist/ssg.d.ts +158 -337
- package/dist/ssg.js +2 -2
- package/dist/state-dir.d.ts +4 -4
- package/dist/store-loader.d.ts +0 -10
- package/dist/story/analytics.d.ts +60 -138
- package/dist/story/bookmarks.d.ts +34 -87
- package/dist/story/cli.d.ts +69 -123
- package/dist/story/collect/scanner.d.ts +0 -4
- package/dist/story/collect/tree.d.ts +1 -8
- package/dist/story/commands/build.d.ts +6 -11
- package/dist/story/commands/dev.d.ts +8 -15
- package/dist/story/commands/preview.d.ts +7 -13
- package/dist/story/config-watcher.d.ts +13 -20
- package/dist/story/config.d.ts +8 -11
- package/dist/story/context.d.ts +8 -14
- package/dist/story/hmr.d.ts +26 -24
- package/dist/story/hot-swap.d.ts +23 -34
- package/dist/story/keyboard-shortcuts.d.ts +18 -23
- package/dist/story/output.d.ts +44 -46
- package/dist/story/performance.d.ts +45 -107
- package/dist/story/presets.d.ts +41 -107
- package/dist/story/renderer.d.ts +27 -41
- package/dist/story/search.d.ts +12 -23
- package/dist/story/server.d.ts +11 -21
- package/dist/story/setup.d.ts +15 -23
- package/dist/story/testing.d.ts +40 -65
- package/dist/story/types.d.ts +160 -262
- package/dist/streaming.d.ts +57 -119
- package/dist/strip-literals.d.ts +1 -25
- package/dist/stx-module-imports.d.ts +7 -0
- package/dist/stx-virtual-ts.d.ts +102 -253
- package/dist/style-scoping.d.ts +8 -21
- package/dist/suspense.d.ts +52 -67
- package/dist/teleport.d.ts +0 -22
- package/dist/template-syntax-escape.d.ts +8 -8
- package/dist/template-tag-balance.d.ts +6 -22
- package/dist/testing.d.ts +26 -11
- package/dist/theme-tokens.d.ts +388 -134
- package/dist/transitions.d.ts +55 -66
- package/dist/ts-css-config.d.ts +12 -70
- package/dist/types/component-types.d.ts +122 -187
- package/dist/types/config-types.d.ts +341 -956
- package/dist/types/context-types.d.ts +24 -46
- package/dist/types/csp-types.d.ts +66 -70
- package/dist/types/directive-types.d.ts +156 -223
- package/dist/types/index.d.ts +110 -6
- package/dist/types/pwa-types.d.ts +148 -273
- package/dist/types.d.ts +1 -0
- package/dist/unresolved-identifiers.d.ts +22 -24
- package/dist/url-safety.d.ts +32 -32
- package/dist/utils.d.ts +21 -36
- package/dist/validator.d.ts +26 -28
- package/dist/variable-extractor.d.ts +19 -49
- package/dist/view-composers.d.ts +81 -80
- package/dist/virtual-scrolling.d.ts +82 -101
- package/dist/visual-testing.d.ts +10 -9
- package/dist/vue-template.d.ts +0 -23
- package/dist/web-components/css-scoping.d.ts +11 -21
- package/dist/web-components.d.ts +58 -81
- package/dist/x-element.d.ts +1 -0
- package/package.json +6 -6
- package/stx.d.ts +2 -2
- package/dist/app-service-worker.d.ts +0 -165
- package/dist/chunk-49gwmcrn.js +0 -2
- package/dist/chunk-6va5pe2m.js +0 -2
- package/dist/chunk-bm2q1srp.js +0 -2
- package/dist/signals-context-runtime.d.ts +0 -2
- package/dist/signals-drawer-runtime.d.ts +0 -2
- package/dist/signals-host-runtime.d.ts +0 -9
- package/dist/signals-loop-conditional-runtime.d.ts +0 -2
- package/dist/signals-manifest-hydration-runtime.d.ts +0 -2
- package/dist/signals-notify-runtime.d.ts +0 -2
- package/dist/signals-optimistic-runtime.d.ts +0 -2
- package/dist/signals-overlay-runtime.d.ts +0 -2
- package/dist/signals-scope-disposal-runtime.d.ts +0 -2
- package/dist/signals-spa-load-control-runtime.d.ts +0 -2
- package/dist/signals-storage-runtime.d.ts +0 -2
|
@@ -1,59 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Runtime Globals
|
|
3
|
-
*
|
|
4
|
-
* The single source of truth for the stx APIs destructured off `window.stx` at
|
|
5
|
-
* the top of every generated client script, so user code can write `state(...)`
|
|
6
|
-
* or `onMount(...)` without importing anything.
|
|
7
|
-
*
|
|
8
|
-
* This list used to be hardcoded separately in three places — the `@include`
|
|
9
|
-
* component wrapper, the page setup function, and the `<Component />` client
|
|
10
|
-
* script wrapper. They drifted, so which APIs existed depended on which kind of
|
|
11
|
-
* script you happened to be writing, and the failure was a bare `ReferenceError`
|
|
12
|
-
* at runtime with nothing at build time: `nextTick()` resolved in a component
|
|
13
|
-
* script but threw in a page, `onMounted()` resolved in a page but threw in an
|
|
14
|
-
* `@include`d component. See #1785.
|
|
15
|
-
*
|
|
16
|
-
* Two entries were also phantoms - `inject` and `nextTick` were destructured by
|
|
17
|
-
* one site but never defined on `window.stx` at all, so they silently evaluated
|
|
18
|
-
* to `undefined` and threw "is not a function" when called. Both are now
|
|
19
|
-
* implemented by the signals runtime (`inject` as of #1804).
|
|
20
|
-
*
|
|
21
|
-
* This list is also the source of `STX_AUTO_IMPORTS` (client-script.ts), which
|
|
22
|
-
* used to be a fourth hand-maintained copy for the classic `<script client>`
|
|
23
|
-
* path. It had drifted to 82 names against a runtime surface of 66, so 16 names
|
|
24
|
-
* — `h`, `Fragment`, `createStore`, `useMeta`, `getCurrentInstance` and others —
|
|
25
|
-
* were destructured off `window.stx` for every client script and silently bound
|
|
26
|
-
* to `undefined`, failing at the call site as "undefined is not a function" with
|
|
27
|
-
* nothing pointing at the missing name. One list, one guard (#1804).
|
|
28
|
-
*
|
|
29
|
-
* Adding a runtime global is now a one-line change here. `runtime-globals.test.ts`
|
|
30
|
-
* asserts every name actually exists on `window.stx` and that all three call
|
|
31
|
-
* sites emit the same set, which is what keeps this from drifting again.
|
|
32
|
-
*
|
|
33
|
-
* @module runtime-globals
|
|
34
|
-
*/
|
|
35
|
-
/**
|
|
36
|
-
* Public stx APIs made available as bare identifiers inside client scripts.
|
|
37
|
-
*
|
|
38
|
-
* Sorted for a stable diff. Internal `window.stx` members (`_scopes`,
|
|
39
|
-
* `_cleanupContainer`, …) are deliberately excluded — they are runtime
|
|
40
|
-
* plumbing, not part of the authoring surface.
|
|
41
|
-
*/
|
|
42
|
-
export declare const STX_RUNTIME_GLOBALS: readonly string[];
|
|
43
|
-
/**
|
|
44
|
-
* Names a call site declares itself and therefore must NOT also destructure.
|
|
45
|
-
*
|
|
46
|
-
* The `<Component />` wrapper defines scope-aware `onMount`/`onDestroy` that
|
|
47
|
-
* push into that component's own callback arrays:
|
|
48
|
-
*
|
|
49
|
-
* const onMount = (fn) => __scopeVars.__mountCallbacks.push(fn)
|
|
50
|
-
*
|
|
51
|
-
* Destructuring the same names first makes that a duplicate `const` — a
|
|
52
|
-
* SyntaxError, which surfaces as the whole chunk silently failing to minify (and
|
|
53
|
-
* failing to run). This omission is deliberate, unlike the accidental drift
|
|
54
|
-
* #1785 fixed, so it is declared here rather than left implicit.
|
|
55
|
-
*/
|
|
56
|
-
export declare const COMPONENT_SCOPE_LOCAL_GLOBALS: readonly string[];
|
|
57
1
|
/**
|
|
58
2
|
* Build the destructuring statement that pulls {@link STX_RUNTIME_GLOBALS} into
|
|
59
3
|
* a generated client script's scope.
|
|
@@ -70,55 +14,6 @@ export declare const COMPONENT_SCOPE_LOCAL_GLOBALS: readonly string[];
|
|
|
70
14
|
* surface.
|
|
71
15
|
*/
|
|
72
16
|
export declare function buildRuntimeGlobalsDestructure(declaration?: 'const' | 'var', exclude?: readonly string[], source?: string): string;
|
|
73
|
-
/**
|
|
74
|
-
* Runtime globals that are COMPILE-TIME macros rather than reactive APIs.
|
|
75
|
-
*
|
|
76
|
-
* Calling one of these does not make a script reactive — they are consumed by
|
|
77
|
-
* the compiler and produce no runtime subscription — so the auto-mount test
|
|
78
|
-
* below must not treat them as evidence that a block needs mounting.
|
|
79
|
-
*/
|
|
80
|
-
export declare const COMPILE_TIME_ONLY_GLOBALS: readonly string[];
|
|
81
|
-
/**
|
|
82
|
-
* Public authoring primitives that are NOT reachable as a bare identifier in a
|
|
83
|
-
* `<script client>` block, each tagged with WHY — so the client/server boundary
|
|
84
|
-
* is discoverable in source instead of inferred from a `ReferenceError` at
|
|
85
|
-
* runtime (stacksjs/stx#1846).
|
|
86
|
-
*
|
|
87
|
-
* Paired with the export-side guard in `authoring-surface.test.ts`: a newly
|
|
88
|
-
* exported composable that is reachable by neither client path — a bare global
|
|
89
|
-
* in {@link STX_RUNTIME_GLOBALS} (path 1), nor the demand-bundle allowlist
|
|
90
|
-
* `SERVER_ONLY_COMPOSABLES` (path 2) — must be classified here, or the test
|
|
91
|
-
* fails. Same "force a decision" contract that COMPILE_TIME_ONLY_GLOBALS and
|
|
92
|
-
* DELIBERATELY_NOT_GLOBAL already apply in their own directions.
|
|
93
|
-
*
|
|
94
|
-
* `client-gap` is deliberately distinct from `server-only`: it marks a primitive
|
|
95
|
-
* that SHOULD be callable from a client script but is not yet wired into either
|
|
96
|
-
* client path — a tracked gap, not a boundary.
|
|
97
|
-
*
|
|
98
|
-
* `isomorphic-import` is distinct again: the primitive is pure and WOULD run in a
|
|
99
|
-
* browser, but the project has decided it is not part of the auto-delivered
|
|
100
|
-
* client surface — an app imports it explicitly. Not a gap to close; a boundary
|
|
101
|
-
* drawn on purpose.
|
|
102
|
-
*/
|
|
103
|
-
export type NonClientCategory = 'server-only' | 'builtin-component' | 'compile-time-directive' | 'browser-composable' | 'client-gap' | 'isomorphic-import';
|
|
104
|
-
export declare const NON_CLIENT_PRIMITIVES: Readonly<Record<string, {
|
|
105
|
-
category: NonClientCategory;
|
|
106
|
-
reason: string;
|
|
107
|
-
}>>;
|
|
108
|
-
/**
|
|
109
|
-
* Names whose presence in a client script means it needs the signals runtime
|
|
110
|
-
* and an `stx.mount()` wrapper.
|
|
111
|
-
*
|
|
112
|
-
* DERIVED, not hand-maintained (stacksjs/stx#1819). This was a literal regex
|
|
113
|
-
* alternation of 36 names against 71 runtime globals, so a block built out of
|
|
114
|
-
* the newer reactive composables — `useStore`, `useQuery`, `useMutation`,
|
|
115
|
-
* `useCookie`, `watchMultiple` and a dozen more — was classified as "not using
|
|
116
|
-
* signals", skipped mounting, and fell through to the legacy IIFE path with no
|
|
117
|
-
* reactivity at all.
|
|
118
|
-
*
|
|
119
|
-
* Exactly the drift #1804 removed for STX_AUTO_IMPORTS, one file away.
|
|
120
|
-
*/
|
|
121
|
-
export declare const REACTIVE_RUNTIME_GLOBALS: readonly string[];
|
|
122
17
|
/**
|
|
123
18
|
* Does this script call anything that needs the reactive runtime?
|
|
124
19
|
*
|
|
@@ -168,6 +63,71 @@ export declare function templateHasReactiveContext(template: string, filePath?:
|
|
|
168
63
|
* signal-processing.ts would close a cycle through client-script.ts.
|
|
169
64
|
*/
|
|
170
65
|
export declare function templateNeedsRuntime(template: string, filePath?: string): boolean;
|
|
66
|
+
/** Is this colon attribute a directive rather than something to resolve? */
|
|
67
|
+
export declare function isRuntimeOwnedColonAttr(name: string): boolean;
|
|
68
|
+
/** The `X_HANDLED` lookup the generated runtime embeds, as JS source. */
|
|
69
|
+
export declare function runtimeHandledXAttrsLiteral(): string;
|
|
70
|
+
/** The `DIRECTIVE_NAMES` lookup the generated runtime embeds, as JS source. */
|
|
71
|
+
export declare function runtimeDirectiveNamesLiteral(): string;
|
|
72
|
+
/** The `EVENT_RE` the generated runtime embeds, as JS source. */
|
|
73
|
+
export declare function runtimeEventRegexLiteral(): string;
|
|
74
|
+
/** Does this name begin with an event the runtime binds as a listener? */
|
|
75
|
+
export declare function isRuntimeEventName(name: string): boolean;
|
|
76
|
+
/**
|
|
77
|
+
* Drop cached blanked documents.
|
|
78
|
+
*
|
|
79
|
+
* Nothing in the framework calls this, and nothing needs to. Entries are keyed
|
|
80
|
+
* on the input document itself, so an edited template is a different key and
|
|
81
|
+
* can never be answered with a stale result -- there is no invalidation to
|
|
82
|
+
* perform. It exists for callers that want a cold cache, such as tests.
|
|
83
|
+
*/
|
|
84
|
+
export declare function clearBlankCache(): void;
|
|
85
|
+
export declare function blankInertHtmlRegions(html: string): string;
|
|
86
|
+
/**
|
|
87
|
+
* Public stx APIs made available as bare identifiers inside client scripts.
|
|
88
|
+
*
|
|
89
|
+
* Sorted for a stable diff. Internal `window.stx` members (`_scopes`,
|
|
90
|
+
* `_cleanupContainer`, …) are deliberately excluded — they are runtime
|
|
91
|
+
* plumbing, not part of the authoring surface.
|
|
92
|
+
*/
|
|
93
|
+
export declare const STX_RUNTIME_GLOBALS: readonly string[];
|
|
94
|
+
/**
|
|
95
|
+
* Names a call site declares itself and therefore must NOT also destructure.
|
|
96
|
+
*
|
|
97
|
+
* The `<Component />` wrapper defines scope-aware `onMount`/`onDestroy` that
|
|
98
|
+
* push into that component's own callback arrays:
|
|
99
|
+
*
|
|
100
|
+
* const onMount = (fn) => __scopeVars.__mountCallbacks.push(fn)
|
|
101
|
+
*
|
|
102
|
+
* Destructuring the same names first makes that a duplicate `const` — a
|
|
103
|
+
* SyntaxError, which surfaces as the whole chunk silently failing to minify (and
|
|
104
|
+
* failing to run). This omission is deliberate, unlike the accidental drift
|
|
105
|
+
* #1785 fixed, so it is declared here rather than left implicit.
|
|
106
|
+
*/
|
|
107
|
+
export declare const COMPONENT_SCOPE_LOCAL_GLOBALS: readonly string[];
|
|
108
|
+
/**
|
|
109
|
+
* Runtime globals that are COMPILE-TIME macros rather than reactive APIs.
|
|
110
|
+
*
|
|
111
|
+
* Calling one of these does not make a script reactive — they are consumed by
|
|
112
|
+
* the compiler and produce no runtime subscription — so the auto-mount test
|
|
113
|
+
* below must not treat them as evidence that a block needs mounting.
|
|
114
|
+
*/
|
|
115
|
+
export declare const COMPILE_TIME_ONLY_GLOBALS: readonly string[];
|
|
116
|
+
export declare const NON_CLIENT_PRIMITIVES: Readonly<Record<string, { category: NonClientCategory, reason: string }>>;
|
|
117
|
+
/**
|
|
118
|
+
* Names whose presence in a client script means it needs the signals runtime
|
|
119
|
+
* and an `stx.mount()` wrapper.
|
|
120
|
+
*
|
|
121
|
+
* DERIVED, not hand-maintained (stacksjs/stx#1819). This was a literal regex
|
|
122
|
+
* alternation of 36 names against 71 runtime globals, so a block built out of
|
|
123
|
+
* the newer reactive composables — `useStore`, `useQuery`, `useMutation`,
|
|
124
|
+
* `useCookie`, `watchMultiple` and a dozen more — was classified as "not using
|
|
125
|
+
* signals", skipped mounting, and fell through to the legacy IIFE path with no
|
|
126
|
+
* reactivity at all.
|
|
127
|
+
*
|
|
128
|
+
* Exactly the drift #1804 removed for STX_AUTO_IMPORTS, one file away.
|
|
129
|
+
*/
|
|
130
|
+
export declare const REACTIVE_RUNTIME_GLOBALS: readonly string[];
|
|
171
131
|
/**
|
|
172
132
|
* Colon attributes that are DIRECTIVES, not attribute bindings.
|
|
173
133
|
*
|
|
@@ -190,8 +150,6 @@ export declare function templateNeedsRuntime(template: string, filePath?: string
|
|
|
190
150
|
* attributes, and `processServerBindings` has specific handling for them.
|
|
191
151
|
*/
|
|
192
152
|
export declare const RUNTIME_OWNED_COLON_ATTRS: readonly string[];
|
|
193
|
-
/** Is this colon attribute a directive rather than something to resolve? */
|
|
194
|
-
export declare function isRuntimeOwnedColonAttr(name: string): boolean;
|
|
195
153
|
/**
|
|
196
154
|
* `x-` attributes the signals runtime consumes itself.
|
|
197
155
|
*
|
|
@@ -222,8 +180,6 @@ export declare const ALPINE_BRIDGE_X_ATTRS: readonly string[];
|
|
|
222
180
|
* it is written on a component, rather than being captured as a prop binding.
|
|
223
181
|
*/
|
|
224
182
|
export declare const COMPONENT_PASSTHROUGH_X_ATTRS: readonly string[];
|
|
225
|
-
/** The `X_HANDLED` lookup the generated runtime embeds, as JS source. */
|
|
226
|
-
export declare function runtimeHandledXAttrsLiteral(): string;
|
|
227
183
|
/**
|
|
228
184
|
* The colon names that route to their own binder rather than to the generic
|
|
229
185
|
* attribute binding: `:text` is a text binding, `:title` is an attribute.
|
|
@@ -234,8 +190,6 @@ export declare function runtimeHandledXAttrsLiteral(): string;
|
|
|
234
190
|
* this list, and two copies of it disagree eventually.
|
|
235
191
|
*/
|
|
236
192
|
export declare const RUNTIME_DIRECTIVE_NAMES: readonly string[];
|
|
237
|
-
/** The `DIRECTIVE_NAMES` lookup the generated runtime embeds, as JS source. */
|
|
238
|
-
export declare function runtimeDirectiveNamesLiteral(): string;
|
|
239
193
|
/**
|
|
240
194
|
* Event names a bare `:name` or `@name` is read as a listener for.
|
|
241
195
|
*
|
|
@@ -243,17 +197,31 @@ export declare function runtimeDirectiveNamesLiteral(): string;
|
|
|
243
197
|
* remains an attribute binding.
|
|
244
198
|
*/
|
|
245
199
|
export declare const RUNTIME_EVENT_NAMES: readonly string[];
|
|
246
|
-
/** The `EVENT_RE` the generated runtime embeds, as JS source. */
|
|
247
|
-
export declare function runtimeEventRegexLiteral(): string;
|
|
248
|
-
/** Does this name begin with an event the runtime binds as a listener? */
|
|
249
|
-
export declare function isRuntimeEventName(name: string): boolean;
|
|
250
200
|
/**
|
|
251
|
-
*
|
|
201
|
+
* Public authoring primitives that are NOT reachable as a bare identifier in a
|
|
202
|
+
* `<script client>` block, each tagged with WHY — so the client/server boundary
|
|
203
|
+
* is discoverable in source instead of inferred from a `ReferenceError` at
|
|
204
|
+
* runtime (stacksjs/stx#1846).
|
|
252
205
|
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
206
|
+
* Paired with the export-side guard in `authoring-surface.test.ts`: a newly
|
|
207
|
+
* exported composable that is reachable by neither client path — a bare global
|
|
208
|
+
* in {@link STX_RUNTIME_GLOBALS} (path 1), nor the demand-bundle allowlist
|
|
209
|
+
* `SERVER_ONLY_COMPOSABLES` (path 2) — must be classified here, or the test
|
|
210
|
+
* fails. Same "force a decision" contract that COMPILE_TIME_ONLY_GLOBALS and
|
|
211
|
+
* DELIBERATELY_NOT_GLOBAL already apply in their own directions.
|
|
212
|
+
*
|
|
213
|
+
* `client-gap` is deliberately distinct from `server-only`: it marks a primitive
|
|
214
|
+
* that SHOULD be callable from a client script but is not yet wired into either
|
|
215
|
+
* client path — a tracked gap, not a boundary.
|
|
216
|
+
*
|
|
217
|
+
* `isomorphic-import` is distinct again: the primitive is pure and WOULD run in a
|
|
218
|
+
* browser, but the project has decided it is not part of the auto-delivered
|
|
219
|
+
* client surface — an app imports it explicitly. Not a gap to close; a boundary
|
|
220
|
+
* drawn on purpose.
|
|
257
221
|
*/
|
|
258
|
-
export
|
|
259
|
-
|
|
222
|
+
export type NonClientCategory = | 'server-only'
|
|
223
|
+
| 'builtin-component'
|
|
224
|
+
| 'compile-time-directive'
|
|
225
|
+
| 'browser-composable'
|
|
226
|
+
| 'client-gap'
|
|
227
|
+
| 'isomorphic-import';
|
|
@@ -1,11 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Runtime Injection Module
|
|
3
|
-
*
|
|
4
|
-
* Handles injecting the signals runtime, browser runtime, and SPA router
|
|
5
|
-
* script into rendered HTML templates.
|
|
6
|
-
*
|
|
7
|
-
* @module runtime-injection
|
|
8
|
-
*/
|
|
9
1
|
import type { StxOptions } from './types';
|
|
10
2
|
/**
|
|
11
3
|
* Inject an @stacksjs/browser initialization input into a template that will
|
package/dist/scaffolding.d.ts
CHANGED
|
@@ -20,33 +20,37 @@ export declare function addStore(name: string, options?: AddStoreOptions): Promi
|
|
|
20
20
|
export declare function addLayout(name: string, options?: AddLayoutOptions): Promise<ScaffoldResult>;
|
|
21
21
|
/**
|
|
22
22
|
* Project template definitions
|
|
23
|
+
* @defaultValue
|
|
24
|
+
* ```ts
|
|
25
|
+
* {
|
|
26
|
+
* default: {
|
|
27
|
+
* description: 'Standard stx project with pages, components, and stores',
|
|
28
|
+
* features: ['Pages', 'Components', 'Layouts', 'Stores', 'Dev server']
|
|
29
|
+
* },
|
|
30
|
+
* minimal: {
|
|
31
|
+
* description: 'Minimal setup with just the essentials',
|
|
32
|
+
* features: ['Single page', 'Basic styles']
|
|
33
|
+
* },
|
|
34
|
+
* full: {
|
|
35
|
+
* description: 'Full-featured project with all stx capabilities',
|
|
36
|
+
* features: ['Pages', 'Components', 'Layouts', 'Stores', 'API routes', 'PWA', 'i18n', 'Testing']
|
|
37
|
+
* },
|
|
38
|
+
* blog: {
|
|
39
|
+
* description: 'Blog template with markdown support',
|
|
40
|
+
* features: ['Blog layout', 'Post pages', 'Tags', 'RSS feed', 'Markdown']
|
|
41
|
+
* },
|
|
42
|
+
* dashboard: {
|
|
43
|
+
* description: 'Admin dashboard template',
|
|
44
|
+
* features: ['Sidebar', 'Charts', 'Tables', 'Forms', 'Auth pages']
|
|
45
|
+
* },
|
|
46
|
+
* landing: {
|
|
47
|
+
* description: 'Marketing landing page template',
|
|
48
|
+
* features: ['Hero section', 'Features', 'Pricing', 'CTA', 'Contact form']
|
|
49
|
+
* }
|
|
50
|
+
* }
|
|
51
|
+
* ```
|
|
23
52
|
*/
|
|
24
|
-
export declare const PROJECT_TEMPLATES: {
|
|
25
|
-
default: {
|
|
26
|
-
description: 'Standard stx project with pages, components, and stores';
|
|
27
|
-
features: readonly ['Pages', 'Components', 'Layouts', 'Stores', 'Dev server']
|
|
28
|
-
};
|
|
29
|
-
minimal: {
|
|
30
|
-
description: 'Minimal setup with just the essentials';
|
|
31
|
-
features: readonly ['Single page', 'Basic styles']
|
|
32
|
-
};
|
|
33
|
-
full: {
|
|
34
|
-
description: 'Full-featured project with all stx capabilities';
|
|
35
|
-
features: readonly ['Pages', 'Components', 'Layouts', 'Stores', 'API routes', 'PWA', 'i18n', 'Testing']
|
|
36
|
-
};
|
|
37
|
-
blog: {
|
|
38
|
-
description: 'Blog template with markdown support';
|
|
39
|
-
features: readonly ['Blog layout', 'Post pages', 'Tags', 'RSS feed', 'Markdown']
|
|
40
|
-
};
|
|
41
|
-
dashboard: {
|
|
42
|
-
description: 'Admin dashboard template';
|
|
43
|
-
features: readonly ['Sidebar', 'Charts', 'Tables', 'Forms', 'Auth pages']
|
|
44
|
-
};
|
|
45
|
-
landing: {
|
|
46
|
-
description: 'Marketing landing page template';
|
|
47
|
-
features: readonly ['Hero section', 'Features', 'Pricing', 'CTA', 'Contact form']
|
|
48
|
-
}
|
|
49
|
-
};
|
|
53
|
+
export declare const PROJECT_TEMPLATES: Record<ProjectTemplate, { description: string, features: string[] }>;
|
|
50
54
|
/**
|
|
51
55
|
* Project creation options
|
|
52
56
|
*/
|
package/dist/script-emit.d.ts
CHANGED
|
@@ -1,33 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Escape script bodies at EMIT time (stacksjs/stx#1792, part one item 2).
|
|
3
|
-
*
|
|
4
|
-
* A `</script>` anywhere inside a script body — in a string, a comment, or a
|
|
5
|
-
* runtime value — ends the element as far as the HTML parser is concerned. The
|
|
6
|
-
* rest of the script is then painted onto the page as text, and everything
|
|
7
|
-
* defined below the offending line silently does not exist.
|
|
8
|
-
*
|
|
9
|
-
* The documented workaround is to write `<\/script>` in the source. It does not
|
|
10
|
-
* work, and that is the crux of the report: `transpileTypeScript` runs every
|
|
11
|
-
* non-server block through Bun's transpiler, which NORMALISES the escape away
|
|
12
|
-
* before the browser ever sees it.
|
|
13
|
-
*
|
|
14
|
-
* in : const s = "<\/script>"
|
|
15
|
-
* out: const s = "</script>";
|
|
16
|
-
*
|
|
17
|
-
* So the escape protects the source from stx's own scanners and is then
|
|
18
|
-
* stripped, leaving the HTML parser to apply exactly the rule it was meant to
|
|
19
|
-
* dodge. Escaping on emit is the only place the protection can survive, because
|
|
20
|
-
* it happens after the transpiler.
|
|
21
|
-
*
|
|
22
|
-
* The transform is semantically inert for JavaScript: `\/` inside a string, a
|
|
23
|
-
* template literal, a regex literal or a comment parses as `/`. It is also
|
|
24
|
-
* valid inside JSON, where `\/` is an explicit escape — so a JSON-LD or
|
|
25
|
-
* importmap body would survive it, though those bodies are excluded upstream
|
|
26
|
-
* and never reach here.
|
|
27
|
-
*
|
|
28
|
-
* This is a leaf module on purpose: no stx imports, so every emit site can use
|
|
29
|
-
* it without creating a cycle.
|
|
30
|
-
*/
|
|
31
1
|
/**
|
|
32
2
|
* Neutralise closing script tags in a JavaScript body about to be embedded in
|
|
33
3
|
* an HTML `<script>` element.
|
|
@@ -1,19 +1,13 @@
|
|
|
1
1
|
import type { StrictModeConfig } from './types';
|
|
2
|
+
/** Rules suppressed per 1-based line. An empty set means "every rule". */
|
|
3
|
+
export declare function parseStrictIgnores(content: string): Map<number, Set<string>>;
|
|
4
|
+
export declare function validateClientScript(content: string, filePath: string, strict?: boolean | StrictModeConfig, originFilePath?: string): void;
|
|
2
5
|
/**
|
|
3
6
|
* Prohibited DOM API patterns in client scripts.
|
|
4
7
|
* STX provides Vue-style alternatives via the STX global object.
|
|
5
8
|
*/
|
|
6
9
|
export declare const PROHIBITED_DOM_PATTERNS: Array<{
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
+
pattern: RegExp
|
|
11
|
+
message: string
|
|
12
|
+
suggestion: string
|
|
10
13
|
}>;
|
|
11
|
-
/** Rules suppressed per 1-based line. An empty set means "every rule". */
|
|
12
|
-
export declare function parseStrictIgnores(content: string): Map<number, Set<string>>;
|
|
13
|
-
export declare function validateClientScript(content: string, filePath: string, strict?: boolean | StrictModeConfig,
|
|
14
|
-
/**
|
|
15
|
-
* The view this script was authored in, when `filePath` is a layout that view
|
|
16
|
-
* was composed into. Reported alongside, because naming only the layout sends
|
|
17
|
-
* the reader to a file that does not contain the offending code (#1836).
|
|
18
|
-
*/
|
|
19
|
-
originFilePath?: string): void;
|
package/dist/seo.d.ts
CHANGED
|
@@ -1,64 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* SEO (Search Engine Optimization) Module
|
|
3
|
-
*
|
|
4
|
-
* Provides directives and utilities for generating SEO-related HTML:
|
|
5
|
-
* - `@meta('name', 'content')` / `@meta('name', expression)` - Generate meta tags
|
|
6
|
-
* - `@metaTag({ name, property, content })` - Meta tags with full control
|
|
7
|
-
* - `@structuredData({ ... })` / `@structuredData(expression)` - JSON-LD structured data
|
|
8
|
-
* - `@seo({ title, description, ... })` / `@seo(expression)` - Comprehensive SEO generation
|
|
9
|
-
*
|
|
10
|
-
* Every argument is an expression evaluated against the template's context, so
|
|
11
|
-
* a variable, a spread or a function call works wherever a literal does. A
|
|
12
|
-
* directive that cannot produce its tag says so: an inline comment where the
|
|
13
|
-
* tag would have been and a console warning naming the file.
|
|
14
|
-
*
|
|
15
|
-
* Also provides:
|
|
16
|
-
* - Automatic SEO tag injection via `injectSeoTags()`
|
|
17
|
-
* - Sitemap generation via `generateSitemap()`, `scanForSitemapEntries()`
|
|
18
|
-
* - robots.txt generation via `generateRobotsTxt()`
|
|
19
|
-
*
|
|
20
|
-
* ## Sitemap Generation
|
|
21
|
-
*
|
|
22
|
-
* ```typescript
|
|
23
|
-
* import { generateSitemap, scanForSitemapEntries } from 'stx'
|
|
24
|
-
*
|
|
25
|
-
* // Manual entries
|
|
26
|
-
* const sitemap = generateSitemap([
|
|
27
|
-
* { loc: '/', priority: 1.0 },
|
|
28
|
-
* { loc: '/about', priority: 0.8 },
|
|
29
|
-
* ], { baseUrl: 'https://example.com' })
|
|
30
|
-
*
|
|
31
|
-
* // Auto-scan directory
|
|
32
|
-
* const entries = await scanForSitemapEntries('./pages', {
|
|
33
|
-
* baseUrl: 'https://example.com'
|
|
34
|
-
* })
|
|
35
|
-
* ```
|
|
36
|
-
*
|
|
37
|
-
* ## Robots.txt Generation
|
|
38
|
-
*
|
|
39
|
-
* ```typescript
|
|
40
|
-
* import { generateRobotsTxt } from 'stx'
|
|
41
|
-
*
|
|
42
|
-
* const robotsTxt = generateRobotsTxt({
|
|
43
|
-
* rules: [{ userAgent: '*', allow: ['/'], disallow: ['/admin'] }],
|
|
44
|
-
* sitemap: 'https://example.com/sitemap.xml'
|
|
45
|
-
* })
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* ## Configuration
|
|
49
|
-
*
|
|
50
|
-
* Default SEO values can be set in `stx.config.ts`:
|
|
51
|
-
* ```typescript
|
|
52
|
-
* export default {
|
|
53
|
-
* defaultTitle: 'My Site',
|
|
54
|
-
* defaultDescription: 'Site description',
|
|
55
|
-
* seo: {
|
|
56
|
-
* enabled: true,
|
|
57
|
-
* defaultConfig: { ... }
|
|
58
|
-
* }
|
|
59
|
-
* }
|
|
60
|
-
* ```
|
|
61
|
-
*/
|
|
62
1
|
import type { CustomDirective, StxOptions } from './types';
|
|
63
2
|
/**
|
|
64
3
|
* Process `@meta(...)` and `@metaTag({...})` in place, emitting the tags where
|
|
@@ -71,6 +10,14 @@ import type { CustomDirective, StxOptions } from './types';
|
|
|
71
10
|
* `@meta('og:title', post.title)`, and the one-argument `@meta('og:title')`.
|
|
72
11
|
*/
|
|
73
12
|
export declare function processMetaDirectives(template: string, context: Record<string, any>, filePath: string, _options: StxOptions): string;
|
|
13
|
+
/**
|
|
14
|
+
* The JSON-LD `<script>` for `data`.
|
|
15
|
+
*
|
|
16
|
+
* `</` is escaped so a value containing `</script>` cannot close the block and
|
|
17
|
+
* open markup of its own; `</` would do too, but `<\/` is what every
|
|
18
|
+
* existing page already ships.
|
|
19
|
+
*/
|
|
20
|
+
declare function jsonLdScript(data: unknown): string;
|
|
74
21
|
/**
|
|
75
22
|
* Process `@structuredData(...)` for JSON-LD.
|
|
76
23
|
*
|
|
@@ -96,74 +43,10 @@ export declare function processSeoDirective(template: string, context: Record<st
|
|
|
96
43
|
* Respects seo.enabled config and skipDefaultSeoTags option.
|
|
97
44
|
*/
|
|
98
45
|
export declare function injectSeoTags(html: string, context: Record<string, any>, options: StxOptions): string;
|
|
99
|
-
/**
|
|
100
|
-
* SEO meta directive.
|
|
101
|
-
*
|
|
102
|
-
* Stages the tag on the render's head rather than returning markup. A `<meta>`
|
|
103
|
-
* emitted where the directive happens to sit lands in the `<body>`, where no
|
|
104
|
-
* crawler reads it: the tag is present in the HTML, the page looks correct, and
|
|
105
|
-
* the description silently never applies. Staging it lets the document shell
|
|
106
|
-
* put it in `<head>`, which is the only place it means anything.
|
|
107
|
-
*
|
|
108
|
-
* This directive shadows `processMetaDirective` in head.ts, since custom
|
|
109
|
-
* directives run first. It therefore has to do that function's job, which is
|
|
110
|
-
* why it takes its arguments as written (`rawParams`) and resolves them with
|
|
111
|
-
* the same `resolveMetaArguments` the other two @meta passes use: a quoted
|
|
112
|
-
* value is text, anything else is an expression.
|
|
113
|
-
*/
|
|
114
|
-
export declare const metaDirective: CustomDirective;
|
|
115
|
-
/**
|
|
116
|
-
* SEO structured data directive for JSON-LD generation, the block form:
|
|
117
|
-
* `@structuredData { ... } @endstructuredData`. The body is JSON, not an
|
|
118
|
-
* expression; `@structuredData(expression)` is the form that reads variables.
|
|
119
|
-
*/
|
|
120
|
-
export declare const structuredDataDirective: CustomDirective;
|
|
121
46
|
/**
|
|
122
47
|
* Register SEO directives
|
|
123
48
|
*/
|
|
124
49
|
export declare function registerSeoDirectives(): CustomDirective[];
|
|
125
|
-
/**
|
|
126
|
-
* URL entry for sitemap
|
|
127
|
-
*/
|
|
128
|
-
export interface SitemapEntry {
|
|
129
|
-
/** Full URL of the page */
|
|
130
|
-
loc: string;
|
|
131
|
-
/** Last modification date (ISO 8601 format) */
|
|
132
|
-
lastmod?: string;
|
|
133
|
-
/** Change frequency */
|
|
134
|
-
changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
|
|
135
|
-
/** Priority (0.0 to 1.0) */
|
|
136
|
-
priority?: number;
|
|
137
|
-
/**
|
|
138
|
-
* The page in other languages, written as `<xhtml:link rel="alternate">`
|
|
139
|
-
* on this `<url>`. List every version, this one included, plus an
|
|
140
|
-
* `x-default` when there is one: Google ignores a set that is not
|
|
141
|
-
* reciprocal. An `href` that is a path is resolved like `loc`.
|
|
142
|
-
*
|
|
143
|
-
* @example [{ hreflang: 'en', href: '/pricing' }, { hreflang: 'de', href: '/de/pricing' }, { hreflang: 'x-default', href: '/pricing' }]
|
|
144
|
-
*/
|
|
145
|
-
alternates?: SitemapAlternate[];
|
|
146
|
-
}
|
|
147
|
-
/** One language version of a sitemap entry. */
|
|
148
|
-
export interface SitemapAlternate {
|
|
149
|
-
/** A language (`de`), a language and region (`en-GB`), or `x-default`. */
|
|
150
|
-
hreflang: string;
|
|
151
|
-
/** A path or an absolute URL. */
|
|
152
|
-
href: string;
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* Sitemap generation options
|
|
156
|
-
*/
|
|
157
|
-
export interface SitemapOptions {
|
|
158
|
-
/** Base URL for the site (e.g., 'https://example.com') */
|
|
159
|
-
baseUrl: string;
|
|
160
|
-
/** Default change frequency */
|
|
161
|
-
defaultChangefreq?: SitemapEntry['changefreq'];
|
|
162
|
-
/** Default priority */
|
|
163
|
-
defaultPriority?: number;
|
|
164
|
-
/** Whether to include lastmod for all entries */
|
|
165
|
-
includeLastmod?: boolean;
|
|
166
|
-
}
|
|
167
50
|
/**
|
|
168
51
|
* Generate an XML sitemap from a list of URL entries.
|
|
169
52
|
*
|
|
@@ -200,34 +83,10 @@ export declare function generateSitemapIndex(sitemaps: string[], baseUrl: string
|
|
|
200
83
|
* @returns Array of sitemap entries
|
|
201
84
|
*/
|
|
202
85
|
export declare function scanForSitemapEntries(directory: string, options: {
|
|
203
|
-
extensions?: string[]
|
|
204
|
-
ignore?: string[]
|
|
205
|
-
baseUrl: string
|
|
206
|
-
}): Promise<SitemapEntry[]>;
|
|
207
|
-
/**
|
|
208
|
-
* Robots.txt rule
|
|
209
|
-
*/
|
|
210
|
-
export interface RobotsRule {
|
|
211
|
-
/** User agent (e.g., '*', 'Googlebot', 'Bingbot') */
|
|
212
|
-
userAgent: string;
|
|
213
|
-
/** Allowed paths */
|
|
214
|
-
allow?: string[];
|
|
215
|
-
/** Disallowed paths */
|
|
216
|
-
disallow?: string[];
|
|
217
|
-
/** Crawl delay in seconds */
|
|
218
|
-
crawlDelay?: number;
|
|
219
|
-
}
|
|
220
|
-
/**
|
|
221
|
-
* Robots.txt generation options
|
|
222
|
-
*/
|
|
223
|
-
export interface RobotsOptions {
|
|
224
|
-
/** Array of rules */
|
|
225
|
-
rules: RobotsRule[];
|
|
226
|
-
/** Sitemap URL(s) */
|
|
227
|
-
sitemap?: string | string[];
|
|
228
|
-
/** Host directive (for Yandex) */
|
|
229
|
-
host?: string;
|
|
230
|
-
}
|
|
86
|
+
extensions?: string[]
|
|
87
|
+
ignore?: string[]
|
|
88
|
+
baseUrl: string
|
|
89
|
+
}): Promise<SitemapEntry[]>;
|
|
231
90
|
/**
|
|
232
91
|
* Generate a robots.txt file content.
|
|
233
92
|
*
|
|
@@ -261,3 +120,66 @@ export declare function generateRobotsTxt(options: RobotsOptions): string;
|
|
|
261
120
|
* @returns robots.txt content string
|
|
262
121
|
*/
|
|
263
122
|
export declare function generateDefaultRobotsTxt(sitemapUrl?: string): string;
|
|
123
|
+
/**
|
|
124
|
+
* SEO meta directive.
|
|
125
|
+
*
|
|
126
|
+
* Stages the tag on the render's head rather than returning markup. A `<meta>`
|
|
127
|
+
* emitted where the directive happens to sit lands in the `<body>`, where no
|
|
128
|
+
* crawler reads it: the tag is present in the HTML, the page looks correct, and
|
|
129
|
+
* the description silently never applies. Staging it lets the document shell
|
|
130
|
+
* put it in `<head>`, which is the only place it means anything.
|
|
131
|
+
*
|
|
132
|
+
* This directive shadows `processMetaDirective` in head.ts, since custom
|
|
133
|
+
* directives run first. It therefore has to do that function's job, which is
|
|
134
|
+
* why it takes its arguments as written (`rawParams`) and resolves them with
|
|
135
|
+
* the same `resolveMetaArguments` the other two @meta passes use: a quoted
|
|
136
|
+
* value is text, anything else is an expression.
|
|
137
|
+
*/
|
|
138
|
+
export declare const metaDirective: CustomDirective;
|
|
139
|
+
/**
|
|
140
|
+
* SEO structured data directive for JSON-LD generation, the block form:
|
|
141
|
+
* `@structuredData { ... } @endstructuredData`. The body is JSON, not an
|
|
142
|
+
* expression; `@structuredData(expression)` is the form that reads variables.
|
|
143
|
+
*/
|
|
144
|
+
export declare const structuredDataDirective: CustomDirective;
|
|
145
|
+
/**
|
|
146
|
+
* URL entry for sitemap
|
|
147
|
+
*/
|
|
148
|
+
export declare interface SitemapEntry {
|
|
149
|
+
loc: string
|
|
150
|
+
lastmod?: string
|
|
151
|
+
changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never'
|
|
152
|
+
priority?: number
|
|
153
|
+
alternates?: SitemapAlternate[]
|
|
154
|
+
}
|
|
155
|
+
/** One language version of a sitemap entry. */
|
|
156
|
+
export declare interface SitemapAlternate {
|
|
157
|
+
hreflang: string
|
|
158
|
+
href: string
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Sitemap generation options
|
|
162
|
+
*/
|
|
163
|
+
export declare interface SitemapOptions {
|
|
164
|
+
baseUrl: string
|
|
165
|
+
defaultChangefreq?: SitemapEntry['changefreq']
|
|
166
|
+
defaultPriority?: number
|
|
167
|
+
includeLastmod?: boolean
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Robots.txt rule
|
|
171
|
+
*/
|
|
172
|
+
export declare interface RobotsRule {
|
|
173
|
+
userAgent: string
|
|
174
|
+
allow?: string[]
|
|
175
|
+
disallow?: string[]
|
|
176
|
+
crawlDelay?: number
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Robots.txt generation options
|
|
180
|
+
*/
|
|
181
|
+
export declare interface RobotsOptions {
|
|
182
|
+
rules: RobotsRule[]
|
|
183
|
+
sitemap?: string | string[]
|
|
184
|
+
host?: string
|
|
185
|
+
}
|