zog/pkgs/zss/schema/zss_document_schema.go at 6288d84badff4398724b1f8bd3f678b483b042ea · Oudwins/zog · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
package zssschema

import (
	z "github.com/Oudwins/zog"
	zsscore "github.com/Oudwins/zog/pkgs/zss/core"
	"github.com/Oudwins/zog/zconst"
)

// ZSSGoTypeSchema defines the schema for ZSSGoType
var ZSSGoTypeSchema = z.Struct(z.Shape{
	"pkgPath": z.String(),
	"name":    z.String(),
	"display": z.String().Required(),
})

var ZSSFieldMetaSchema = z.Struct(z.Shape{
	"tags": z.String(),
})

// ZSSTransformerSchema defines the schema for ZSSTransformer
var ZSSTransformerSchema = z.Struct(z.Shape{
	"id": z.String().Required(),
})

// ZSSTestSchema defines the schema for ZSSTest
var ZSSTestSchema = z.Struct(z.Shape{
	"id":        z.String().Required(),
	"message":   z.String().Required(),
	"issuePath": z.Slice(z.String()).Required(),
	"params":    z.EXPERIMENTAL_MAP[string, any](z.String(), z.EXPERIMENTAL_ANY()),
})

// ZSSProcessorSchema defines the schema for ZSSProcessor
var ZSSProcessorSchema = z.Struct(z.Shape{
	"kind":        z.String().Required(),
	"test":        z.Ptr(ZSSTestSchema),
	"transformer": z.Ptr(ZSSTransformerSchema),
})

// ZSSExtensionSchema defines the schema for ZSSExtension.
var ZSSExtensionSchema = z.Struct(z.Shape{
	"URI":     URISchema,
	"Content": z.EXPERIMENTAL_ANY(),
})

// ZSSSchemaSchema defines the schema for ZSSSchema.
// Note: defaultValue and catchValue are intentionally loose because ZSS allows arbitrary values.
var ZSSSchemaSchema = z.EXPERIMENTAL_RECURSIVE(func(self z.RecursiveSchema[*z.StructSchema]) *z.StructSchema {
	return z.Struct(z.Shape{
		"Ref":          z.Ptr(z.String()),
		"kind":         z.StringLike[zconst.ZogType]().OneOf(zconst.ZogTypeValues),
		"Extension":    z.Ptr(ZSSExtensionSchema),
		"goTypes":      z.Slice(ZSSGoTypeSchema),
		"format":       z.Ptr(z.String()),
		"processors":   z.Slice(ZSSProcessorSchema),
		"fields":       z.EXPERIMENTAL_MAP[string, *zsscore.ZSSSchema](z.String(), z.Ptr(self())),
		"fieldMeta":    z.EXPERIMENTAL_MAP[string, zsscore.ZSSFieldMeta](z.String(), ZSSFieldMetaSchema),
		"element":      z.Ptr(self()),
		"key":          z.Ptr(self()),
		"value":        z.Ptr(self()),
		"children":     z.Slice(z.Ptr(self())),
		"required":     z.Ptr(ZSSTestSchema),
		"defaultValue": z.EXPERIMENTAL_ANY(),
		"catchValue":   z.EXPERIMENTAL_ANY(),
	})
})

var URISchema = z.String().Match(zsscore.ZSS_URI_REGEX).Required()

// ZSSDocumentSchema defines the schema for ZSSDocument
var ZSSDocumentSchema = z.Struct(z.Shape{
	"URI":  URISchema, // $Schema
	"Root": z.Ptr(ZSSSchemaSchema).NotNil(),
	"Defs": z.EXPERIMENTAL_MAP[string, *zsscore.ZSSSchema](z.String(), z.Ptr(ZSSSchemaSchema)),
})