@stonecrop/stonecrop 0.13.7 → 0.13.9

package/src/schema-validator.ts

@@ -4,7 +4,7 @@
  * @packageDocumentation
  */
 
-import type { SchemaTypes } from '@stonecrop/aform'
+import type { DoctypeField } from '@stonecrop/schema'
 import type { LinkDeclaration } from '@stonecrop/schema'
 import type { List, Map as ImmutableMap } from 'immutable'
 import type { AnyStateNodeConfig } from 'xstate'
@@ -47,7 +47,7 @@ export class SchemaValidator {
 	 */
 	validate(
 		doctype: string,
-		schema: List<SchemaTypes> | SchemaTypes[] | undefined,
+		schema: List<DoctypeField> | DoctypeField[] | undefined,
 		workflow?: AnyStateNodeConfig,
 		actions?: ImmutableMap<string, string[]> | Map<string, string[]>,
 		links?: Record<string, LinkDeclaration>
@@ -102,7 +102,7 @@ export class SchemaValidator {
 	 * Validates that required schema properties are present
 	 * @internal
 	 */
-	private validateRequiredProperties(doctype: string, schema: SchemaTypes[]): ValidationIssue[] {
+	private validateRequiredProperties(doctype: string, schema: DoctypeField[]): ValidationIssue[] {
 		const issues: ValidationIssue[] = []
 
 		for (const field of schema) {
@@ -118,8 +118,8 @@ export class SchemaValidator {
 				continue
 			}
 
-			// Check for component or fieldtype
-			if (!field.component && !('fieldtype' in field)) {
+			// ValueField requires fieldtype; fieldset/table have their own structural requirements
+			if (field.kind === 'field' && !field.component && !field.fieldtype) {
 				issues.push({
 					severity: ValidationSeverity.ERROR,
 					rule: 'required-component-or-fieldtype',
@@ -129,16 +129,9 @@ export class SchemaValidator {
 				})
 			}
 
-			// Validate nested schemas (recursively)
-			if ('schema' in field) {
-				// oxlint-disable-next-line typescript/no-unsafe-type-assertion -- 'schema' in field guard confirms property exists; SchemaTypes union narrowed at runtime
-				const nestedSchema = (field as { schema: unknown }).schema
-				// oxlint-disable typescript/no-unsafe-type-assertion -- Immutable List or plain array; toArray() returns SchemaTypes elements
-				const nestedArray = (
-					Array.isArray(nestedSchema) ? nestedSchema : (nestedSchema as { toArray?: () => unknown[] }).toArray?.() || []
-				) as SchemaTypes[]
-				// oxlint-enable typescript/no-unsafe-type-assertion
-				issues.push(...this.validateRequiredProperties(doctype, nestedArray))
+			// Validate nested schemas recursively (fieldset only; table columns are ColumnSchema not DoctypeField)
+			if (field.kind === 'fieldset') {
+				issues.push(...this.validateRequiredProperties(doctype, field.schema))
 			}
 		}
 
@@ -149,16 +142,12 @@ export class SchemaValidator {
 	 * Validates Link field targets exist in registry
 	 * @internal
 	 */
-	private validateLinkFields(doctype: string, schema: SchemaTypes[], registry: Registry): ValidationIssue[] {
+	private validateLinkFields(doctype: string, schema: DoctypeField[], registry: Registry): ValidationIssue[] {
 		const issues: ValidationIssue[] = []
 
 		for (const field of schema) {
-			// oxlint-disable-next-line typescript/no-unsafe-type-assertion -- 'fieldtype' in field guard confirms property exists; accessing unknown-typed fieldtype safely
-			const fieldtype = 'fieldtype' in field ? (field as { fieldtype: unknown }).fieldtype : undefined
-
-			// Check Link fields
-			if (fieldtype === 'Link') {
-				const options = 'options' in field ? (field as { options: unknown }).options : undefined
+			if (field.kind === 'field' && field.fieldtype === 'Link') {
+				const options = field.options
 				if (!options) {
 					issues.push({
 						severity: ValidationSeverity.ERROR,
@@ -170,8 +159,6 @@ export class SchemaValidator {
 					continue
 				}
 
-				// Check if target doctype exists in registry
-				// Options should be a string representing the target doctype name
 				const targetDoctype = typeof options === 'string' ? options : ''
 				if (!targetDoctype) {
 					issues.push({
@@ -197,16 +184,9 @@ export class SchemaValidator {
 				}
 			}
 
-			// Recursively check nested schemas
-			if ('schema' in field) {
-				// oxlint-disable-next-line typescript/no-unsafe-type-assertion -- 'schema' in field guard confirms property exists; SchemaTypes union narrowed at runtime
-				const nestedSchema = (field as { schema: unknown }).schema
-				// oxlint-disable typescript/no-unsafe-type-assertion -- Immutable List or plain array; toArray() returns SchemaTypes elements
-				const nestedArray = (
-					Array.isArray(nestedSchema) ? nestedSchema : (nestedSchema as { toArray?: () => unknown[] }).toArray?.() || []
-				) as SchemaTypes[]
-				// oxlint-enable typescript/no-unsafe-type-assertion
-				issues.push(...this.validateLinkFields(doctype, nestedArray, registry))
+			// Recursively check nested fieldset schemas
+			if (field.kind === 'fieldset') {
+				issues.push(...this.validateLinkFields(doctype, field.schema, registry))
 			}
 		}
 
@@ -220,15 +200,15 @@ export class SchemaValidator {
 	private validateLinkDeclarations(
 		doctype: string,
 		links: Record<string, LinkDeclaration>,
-		schema: SchemaTypes[],
+		schema: DoctypeField[],
 		registry: Registry
 	): ValidationIssue[] {
 		const issues: ValidationIssue[] = []
 
 		// Build a map of Link fields by fieldname for quick lookup
-		const linkFieldsByFieldname = new Map<string, SchemaTypes>()
+		const linkFieldsByFieldname = new Map<string, DoctypeField>()
 		for (const field of schema) {
-			if ('fieldtype' in field && field.fieldtype === 'Link') {
+			if (field.kind === 'field' && field.fieldtype === 'Link') {
 				linkFieldsByFieldname.set(field.fieldname, field)
 			}
 		}
@@ -288,9 +268,8 @@ export class SchemaValidator {
 			// Only check if link has fieldname set (otherwise it's a standalone link without a field)
 			if (link.fieldname) {
 				const linkField = linkFieldsByFieldname.get(link.fieldname)
-				if (linkField) {
-					const linkFieldOptions = 'options' in linkField ? (linkField as { options: unknown }).options : undefined
-					const linkFieldTarget = typeof linkFieldOptions === 'string' ? linkFieldOptions : undefined
+				if (linkField && linkField.kind === 'field') {
+					const linkFieldTarget = typeof linkField.options === 'string' ? linkField.options : undefined
 					if (linkFieldTarget && linkFieldTarget !== link.target) {
 						issues.push({
 							severity: ValidationSeverity.ERROR,
@@ -483,7 +462,7 @@ export function createValidator(registry: Registry, options?: Partial<ValidatorO
  */
 export function validateSchema(
 	doctype: string,
-	schema: List<SchemaTypes> | SchemaTypes[] | undefined,
+	schema: List<DoctypeField> | DoctypeField[] | undefined,
 	registry: Registry,
 	workflow?: AnyStateNodeConfig,
 	actions?: ImmutableMap<string, string[]> | Map<string, string[]>

package/src/stonecrop.ts

@@ -319,7 +319,6 @@ export class Stonecrop {
 		// TODO: For custom fetch handlers, this returns false (not blocking), but the custom handler
 		// may still be invoked by useLazyLink. Future: custom handlers should be able to declare they
 		// satisfy blockWorkflows, or validation should reject custom + blockWorkflows: true.
-		// See: relationships.md Phase 6 "Open Question: blockWorkflows + custom fetch"
 		return link.fetch?.method === 'sync'
 	}
 

package/src/types/composable.ts

@@ -1,4 +1,4 @@
-import type { SchemaTypes } from '@stonecrop/aform'
+import type { ResolvedField } from '@stonecrop/aform'
 import type { Ref, ComputedRef } from 'vue'
 
 import type Doctype from '../doctype'
@@ -177,7 +177,7 @@ export type HSTStonecropReturn = BaseStonecropReturn & {
 	 * Resolved schema with nested Doctype fields expanded.
 	 * Use this to iterate over fields for rendering, excluding nested doctypes handled separately.
 	 */
-	resolvedSchema: Ref<SchemaTypes[]>
+	resolvedSchema: Ref<ResolvedField[]>
 	/**
 	 * Scaffold empty descendant records from defaults for all descendant links.
 	 * @param path - The HST path where initialized data should be stored

package/src/types/doctype.ts

@@ -1,42 +1,21 @@
-import type { SchemaTypes } from '@stonecrop/aform'
-import type { FieldMeta, LinkDeclaration, WorkflowMeta } from '@stonecrop/schema'
+import type { DoctypeField, LinkDeclaration, WorkflowMeta } from '@stonecrop/schema'
 import { List, Map } from 'immutable'
 import type { AnyStateNodeConfig, UnknownMachineConfig } from 'xstate'
 
 /**
- * Immutable Doctype type for Stonecrop instances
+ * Immutable Doctype type for Stonecrop instances. App authors should use
+ * `Doctype.fromObject()` rather than constructing this shape manually.
  * @public
  */
 export type ImmutableDoctype = {
-	readonly schema?: List<SchemaTypes>
+	readonly schema?: List<DoctypeField>
 	readonly workflow?: UnknownMachineConfig | AnyStateNodeConfig | WorkflowMeta
 	readonly actions?: Map<string, string[]>
-	readonly links?: Record<string, LinkDeclaration>
-}
-
-/**
- * Mutable Doctype type for Stonecrop instances
- * @public
- */
-export type MutableDoctype = {
-	doctype?: string
-	schema?: SchemaTypes[]
-	workflow?: UnknownMachineConfig | AnyStateNodeConfig | WorkflowMeta
-	actions?: Record<string, string[]>
-}
-
-/**
- * Schema type for Stonecrop instances
- * @public
- */
-export type Schema = {
-	doctype: string
-	schema: List<SchemaTypes>
 }
 
 /**
  * Plain object representation of doctype configuration for serialization/API responses.
- * Compatible with the DoctypeMeta type from \@stonecrop/schema.
+ * Extends DoctypeMeta with Stonecrop-specific properties: actions, slug, inherits.
  * @public
  */
 export type DoctypeConfig = {
@@ -45,7 +24,7 @@ export type DoctypeConfig = {
 	/** URL-friendly slug (kebab-case) */
 	slug?: string
 	/** Field definitions (including link fields with fieldtype: 'Link') */
-	fields?: (SchemaTypes | FieldMeta)[]
+	fields?: DoctypeField[]
 	/** Relationship links to other doctypes */
 	links?: Record<string, LinkDeclaration>
 	/** Workflow configuration (XState format or simple WorkflowMeta) */