@jay-framework/compiler-jay-html 0.25.1 → 0.25.2

package/dist/index.d.cts

@@ -49,6 +49,31 @@ interface Contract {
     params?: Array<ContractParam>;
 }
 
+/**
+ * Built-in contracts the compiler recognizes without any plugin/module resolution (Design Log #218).
+ *
+ * The Error contract backs error pages: a page declares
+ * `<script type="application/jay-headless" plugin="jay-stack" contract="error" key="error">`
+ * and the compiler special-cases this pair to {@link ERROR_CONTRACT} (no filesystem lookup),
+ * giving the page a typed `error?: ErrorViewState` field. The matching `ErrorViewState` /
+ * `ErrorRefs` types are shipped (hand-written, type-only) from {@link ERROR_CONTRACT_MODULE}
+ * so the generated page imports resolve against a real, stable specifier.
+ */
+declare const ERROR_CONTRACT_PLUGIN = "jay-stack";
+declare const ERROR_CONTRACT_NAME = "error";
+/** The bare module specifier the generated `error` types are imported from. */
+declare const ERROR_CONTRACT_MODULE = "@jay-framework/fullstack-component";
+/**
+ * The built-in Error contract (Design Log #218).
+ *
+ * All fields are `fast` — the error data is a request-time pass-through injected at render,
+ * not build-time slow data. `details` is a repeated sub-contract so a page can
+ * `forEach="error.details"` over `{ key, value }` pairs.
+ */
+declare const ERROR_CONTRACT: Contract;
+/** True when a headless import's plugin/contract pair is the built-in Error contract. */
+declare function isBuiltInErrorContract(plugin: string | null | undefined, contract: string | null | undefined): boolean;
+
 declare function compileContract(contractWithValidations: WithValidations<Contract>, contractFilePath: string, jayImportResolver: JayImportResolver): Promise<WithValidations<string>>;
 
 declare function parseContract(contractYaml: string, fileName: string): WithValidations<Contract>;
@@ -621,4 +646,4 @@ declare function resolveHeadlessInstances(preRenderedJayHtml: string, instanceDa
  */
 declare function hasSlowPhaseProperties(contract: Contract | undefined): boolean;
 
-export { type ActionDefinition, type AssignCoordinatesOptions, type AssignCoordinatesResult, type Contract, type ContractImportInfo, type ContractParam, type ContractParamKind, type ContractProp, type ContractResolver, type ContractTag, ContractTagType, type DiscoveredHeadlessInstance, type EnumToImport, type ForEachHeadlessInstance, type HeadlessContractInfo, type HeadlessInstanceDiscoveryResult, type HeadlessInstanceResolvedData, JAY_IMPORT_RESOLVER, type JayContractImportLink, type JayHeadlessImports, type JayHtmlScript, type JayHtmlSourceFile, type JayImportResolver, type PhaseViewStates, type RenderingPhase, type ServerElementOptions, type SlowRenderInput, type SlowRenderOutput, assignCoordinates, assignCoordinatesToJayHtml, buildInstanceCoordinateKey, compileAction, compileContract, contractToAllPhaseViewStates, contractToImportsViewStateAndRefs, contractToPhaseViewState, createPhaseContract, defaultContractResolver, discoverHeadlessInstances, filterTagsByPhase, generateElementBridgeFile, generateElementDefinitionFile, generateElementFile, generateElementFileReactTarget, generateElementHydrateFile, generateSandboxRootFile, generateServerElementFile, generateTypes, getEffectivePhase, getJayHtmlImports, getLinkedContractDir, hasSlowPhaseProperties, htmlElementTagNameMap, isTagInPhase, loadLinkedContract, parseAction, parseContract, parseEnumValues, parseIsEnum, parseJayFile, parseTemplateParts, renderRefsType, resolveHeadlessInstances, slowRenderTransform, validateContractPhases };
+export { type ActionDefinition, type AssignCoordinatesOptions, type AssignCoordinatesResult, type Contract, type ContractImportInfo, type ContractParam, type ContractParamKind, type ContractProp, type ContractResolver, type ContractTag, ContractTagType, type DiscoveredHeadlessInstance, ERROR_CONTRACT, ERROR_CONTRACT_MODULE, ERROR_CONTRACT_NAME, ERROR_CONTRACT_PLUGIN, type EnumToImport, type ForEachHeadlessInstance, type HeadlessContractInfo, type HeadlessInstanceDiscoveryResult, type HeadlessInstanceResolvedData, JAY_IMPORT_RESOLVER, type JayContractImportLink, type JayHeadlessImports, type JayHtmlScript, type JayHtmlSourceFile, type JayImportResolver, type PhaseViewStates, type RenderingPhase, type ServerElementOptions, type SlowRenderInput, type SlowRenderOutput, assignCoordinates, assignCoordinatesToJayHtml, buildInstanceCoordinateKey, compileAction, compileContract, contractToAllPhaseViewStates, contractToImportsViewStateAndRefs, contractToPhaseViewState, createPhaseContract, defaultContractResolver, discoverHeadlessInstances, filterTagsByPhase, generateElementBridgeFile, generateElementDefinitionFile, generateElementFile, generateElementFileReactTarget, generateElementHydrateFile, generateSandboxRootFile, generateServerElementFile, generateTypes, getEffectivePhase, getJayHtmlImports, getLinkedContractDir, hasSlowPhaseProperties, htmlElementTagNameMap, isBuiltInErrorContract, isTagInPhase, loadLinkedContract, parseAction, parseContract, parseEnumValues, parseIsEnum, parseJayFile, parseTemplateParts, renderRefsType, resolveHeadlessInstances, slowRenderTransform, validateContractPhases };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { camelCase as camelCase$1, JayImportedType, JayString, JayUnknown, isObjectType as isObjectType$1, isImportedType, isRecursiveType, Imports, Import, RenderFragment, WithValidations, isArrayType as isArrayType$1, isAtomicType, isPromiseType, isEnumType, GenerateTarget, hasRefs, JayTypeAlias, JayUnionType, mkRefsTree, equalJayTypes, mkRef, JayComponentType, JayHTMLType, getModeFileExtension, isHtmlStringType, RuntimeMode, nestRefs, mergeRefsTrees, SourceFileFormat, JayEnumType, JayObjectType, JayArrayType, JayPromiseType, resolvePrimitiveType, JayRecursiveType, JAY_CONTRACT_EXTENSION as JAY_CONTRACT_EXTENSION$1, ImportsFor, JAY_FULLSTACK_COMPONENTS, hoistFreeRefs, freeRefsAugmentedRefType, isComponentType as isComponentType$1, JayErrorType, JayOptionalType, JayRecordType, isOptionalType, isRecordType, resolvePluginManifest, resolvePluginComponent } from "@jay-framework/compiler-shared";
+import { camelCase as camelCase$1, JayImportedType, JayString, JayUnknown, isObjectType as isObjectType$1, isImportedType, isRecursiveType, Imports, Import, RenderFragment, WithValidations, isArrayType as isArrayType$1, isAtomicType, isPromiseType, isEnumType, GenerateTarget, hasRefs, JayTypeAlias, JayUnionType, mkRefsTree, equalJayTypes, mkRef, JayComponentType, JayHTMLType, getModeFileExtension, isHtmlStringType, RuntimeMode, nestRefs, mergeRefsTrees, JayNumber, SourceFileFormat, JayEnumType, JayObjectType, JayArrayType, JayPromiseType, resolvePrimitiveType, JayRecursiveType, JAY_CONTRACT_EXTENSION as JAY_CONTRACT_EXTENSION$1, ImportsFor, JAY_FULLSTACK_COMPONENTS, hoistFreeRefs, freeRefsAugmentedRefType, isComponentType as isComponentType$1, JayErrorType, JayOptionalType, JayRecordType, isOptionalType, isRecordType, resolvePluginManifest, resolvePluginComponent } from "@jay-framework/compiler-shared";
 import path from "path";
 import { getLogger } from "@jay-framework/logger";
 import fs from "fs/promises";
@@ -15375,6 +15375,34 @@ ${renderedRefsManager}
     renderedBridge.refs
   );
 }
+const ERROR_CONTRACT_PLUGIN = "jay-stack";
+const ERROR_CONTRACT_NAME = "error";
+const ERROR_CONTRACT_MODULE = "@jay-framework/fullstack-component";
+const ERROR_CONTRACT = {
+  name: "Error",
+  description: "Built-in error information injected into error pages (Design Log #218).",
+  tags: [
+    { tag: "status", type: [ContractTagType.data], dataType: JayNumber, phase: "fast" },
+    { tag: "title", type: [ContractTagType.data], dataType: JayString, phase: "fast" },
+    { tag: "message", type: [ContractTagType.data], dataType: JayString, phase: "fast" },
+    { tag: "url", type: [ContractTagType.data], dataType: JayString, phase: "fast" },
+    { tag: "code", type: [ContractTagType.data], dataType: JayString, phase: "fast" },
+    {
+      tag: "details",
+      type: [ContractTagType.subContract],
+      repeated: true,
+      trackBy: "key",
+      phase: "fast",
+      tags: [
+        { tag: "key", type: [ContractTagType.data], dataType: JayString },
+        { tag: "value", type: [ContractTagType.data], dataType: JayString }
+      ]
+    }
+  ]
+};
+function isBuiltInErrorContract(plugin, contract) {
+  return plugin === ERROR_CONTRACT_PLUGIN && contract === ERROR_CONTRACT_NAME;
+}
 function getDefaultExportFromCjs(x) {
   return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;
 }
@@ -19205,7 +19233,13 @@ async function parseHeadlessImports(elements, validations, filePath, importResol
     let structural = false;
     let contractTagName = contractAttr;
     try {
-      if (pluginAttr) {
+      if (isBuiltInErrorContract(pluginAttr, contractAttr)) {
+        loadedContract = ERROR_CONTRACT;
+        contractFile = ERROR_CONTRACT_MODULE;
+        name = pascalCase(ERROR_CONTRACT.name);
+        module = ERROR_CONTRACT_MODULE;
+        contractTagName = paramCase(ERROR_CONTRACT.name);
+      } else if (pluginAttr) {
         const resolveResult = importResolver.resolvePluginComponent(
           pluginAttr,
           contractAttr,
@@ -19292,7 +19326,7 @@ async function parseHeadlessImports(elements, validations, filePath, importResol
             declaringModule: toRelativeModule(enumsToImport2.declaringModule)
           })
         );
-        const relativeContractPath = toRelativeModule(contractFile);
+        const relativeContractPath = contractFile === ERROR_CONTRACT_MODULE ? contractFile : toRelativeModule(contractFile);
         const enumsFromContract = enumsToImportRelativeToJayHtml.filter((_) => _.declaringModule === relativeContractPath).map((_) => _.type);
         const nestedTypeNames = collectNestedTypeNames(type2);
         const nestedTypeImports = nestedTypeNames.filter((name2) => name2 !== type2.name).map((name2) => ({ name: name2, type: JayUnknown }));
@@ -19383,6 +19417,16 @@ function validateAndCollectScripts(root, validations) {
     const src = script.getAttribute("src");
     const inline = script.textContent?.trim();
     const isInHead = !!script.closest("head");
+    if (type2 === "application/ld+json" && !src) {
+      const attributes2 = { ...script.attributes };
+      delete attributes2["jay-script"];
+      scripts.push({
+        inline: inline ?? "",
+        attributes: attributes2,
+        position: isInHead ? "head" : "body"
+      });
+      continue;
+    }
     if (src && isLocalSrc(src)) {
       validations.push(
         `Local script imports are not supported in jay-html. Move the script logic into page.ts with makeJayStackComponent. See designer/script-tags.md.`
@@ -31438,6 +31482,10 @@ function hasSlowPhaseProperties(contract) {
 }
 export {
   ContractTagType,
+  ERROR_CONTRACT,
+  ERROR_CONTRACT_MODULE,
+  ERROR_CONTRACT_NAME,
+  ERROR_CONTRACT_PLUGIN,
   JAY_IMPORT_RESOLVER,
   assignCoordinates,
   assignCoordinatesToJayHtml,
@@ -31464,6 +31512,7 @@ export {
   getLinkedContractDir,
   hasSlowPhaseProperties,
   htmlElementTagNameMap,
+  isBuiltInErrorContract,
   isTagInPhase,
   loadLinkedContract,
   parseAction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jay-framework/compiler-jay-html",
-  "version": "0.25.1",
+  "version": "0.25.2",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -34,12 +34,12 @@
   },
   "author": "",
   "dependencies": {
-    "@jay-framework/compiler-analyze-exported-types": "^0.25.1",
-    "@jay-framework/compiler-shared": "^0.25.1",
-    "@jay-framework/component": "^0.25.1",
-    "@jay-framework/logger": "^0.25.1",
-    "@jay-framework/runtime": "^0.25.1",
-    "@jay-framework/secure": "^0.25.1",
+    "@jay-framework/compiler-analyze-exported-types": "^0.25.2",
+    "@jay-framework/compiler-shared": "^0.25.2",
+    "@jay-framework/component": "^0.25.2",
+    "@jay-framework/logger": "^0.25.2",
+    "@jay-framework/runtime": "^0.25.2",
+    "@jay-framework/secure": "^0.25.2",
     "@types/js-yaml": "^4.0.9",
     "change-case": "^4.1.2",
     "he": "^1.2.0",
@@ -52,8 +52,8 @@
   },
   "devDependencies": {
     "@caiogondim/strip-margin": "^1.0.0",
-    "@jay-framework/4-react": "^0.25.1",
-    "@jay-framework/dev-environment": "^0.25.1",
+    "@jay-framework/4-react": "^0.25.2",
+    "@jay-framework/dev-environment": "^0.25.2",
     "@testing-library/jest-dom": "^6.2.0",
     "@types/js-beautify": "^1",
     "@types/node": "^20.11.5",