File: jsonschema.lua

package info (click to toggle)
rspamd 3.14.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 35,064 kB
  • sloc: ansic: 247,728; cpp: 107,741; javascript: 31,385; perl: 3,089; asm: 2,512; pascal: 1,625; python: 1,510; sh: 589; sql: 313; makefile: 195; xml: 74
file content (230 lines) | stat: -rw-r--r-- 5,859 bytes parent folder | download
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
--[[
Copyright (c) 2025, Vsevolod Stakhov <vsevolod@rspamd.com>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
]]--

-- Lua shape validation library - JSON Schema exporter
-- Converts lua_shape schemas to JSON Schema format

local exports = {}

-- Convert a schema node to JSON Schema
local function to_jsonschema_impl(schema, opts)
  opts = opts or {}

  if not schema or not schema.tag then
    return {}
  end

  local result = {}
  local schema_opts = schema.opts or {}

  -- Add description from doc
  if schema_opts.doc and schema_opts.doc.summary then
    result.description = schema_opts.doc.summary
  end

  local tag = schema.tag

  -- Scalar types
  if tag == "scalar" then
    local kind = schema.kind

    if kind == "string" then
      result.type = "string"

      if schema_opts.min_len then
        result.minLength = schema_opts.min_len
      end
      if schema_opts.max_len then
        result.maxLength = schema_opts.max_len
      end
      if schema_opts.pattern then
        result.pattern = schema_opts.pattern
      end

    elseif kind == "number" or kind == "integer" then
      result.type = kind == "integer" and "integer" or "number"

      if schema_opts.min then
        result.minimum = schema_opts.min
      end
      if schema_opts.max then
        result.maximum = schema_opts.max
      end

    elseif kind == "boolean" then
      result.type = "boolean"

    elseif kind == "enum" then
      if schema_opts.enum then
        result.enum = schema_opts.enum
      end

    elseif kind == "literal" then
      result.const = schema_opts.literal
    end

  -- Array type
  elseif tag == "array" then
    result.type = "array"

    if schema.item_schema then
      result.items = to_jsonschema_impl(schema.item_schema, opts)
    end

    if schema_opts.min_items then
      result.minItems = schema_opts.min_items
    end
    if schema_opts.max_items then
      result.maxItems = schema_opts.max_items
    end

  -- Table type
  elseif tag == "table" then
    result.type = "object"
    result.properties = {}
    result.required = {}

    -- Process fields
    for field_name, field_spec in pairs(schema.fields or {}) do
      result.properties[field_name] = to_jsonschema_impl(field_spec.schema, opts)

      -- Add to required if not optional
      if not field_spec.optional then
        table.insert(result.required, field_name)
      end

      -- Add default if present
      if field_spec.default ~= nil then
        result.properties[field_name].default = field_spec.default
      end

      -- Add origin metadata if present (for mixin tracking)
      if field_spec.origin and opts.include_origin then
        result.properties[field_name]["x-rspamd-origin"] = field_spec.origin
      end
    end

    -- Handle open/closed table
    if schema_opts.open == false then
      if schema_opts.extra then
        -- Allow additional properties matching extra schema
        result.additionalProperties = to_jsonschema_impl(schema_opts.extra, opts)
      else
        result.additionalProperties = false
      end
    else
      result.additionalProperties = true
    end

    -- Remove empty required array
    if #result.required == 0 then
      result.required = nil
    end

  -- one_of type
  elseif tag == "one_of" then
    result.oneOf = {}

    for _, variant in ipairs(schema.variants or {}) do
      local variant_schema = to_jsonschema_impl(variant.schema, opts)

      -- Add title if variant has a name
      if variant.name and opts.include_variant_names then
        variant_schema.title = variant.name
      end

      table.insert(result.oneOf, variant_schema)
    end

  -- Optional wrapper
  elseif tag == "optional" then
    result = to_jsonschema_impl(schema.inner, opts)

    -- Add null as allowed type
    if result.type then
      if type(result.type) == "string" then
        result.type = { result.type, "null" }
      else
        table.insert(result.type, "null")
      end
    end

    if schema.default ~= nil then
      result.default = schema.default
    end

  -- Transform wrapper
  elseif tag == "transform" then
    -- For JSON Schema, just export the inner schema
    -- Transform semantics don't apply to JSON Schema validation
    result = to_jsonschema_impl(schema.inner, opts)

  -- Reference
  elseif tag == "ref" then
    local ref_id = schema.ref_id
    result["$ref"] = "#/definitions/" .. ref_id
  end

  return result
end

-- Convert a schema to JSON Schema
function exports.from_schema(schema, opts)
  opts = opts or {}

  local result = {
    ["$schema"] = "http://json-schema.org/draft-07/schema#"
  }

  -- Add schema ID if provided
  if opts.id then
    result["$id"] = opts.id
  end

  -- Add title if provided
  if opts.title then
    result.title = opts.title
  end

  -- Convert schema
  local schema_json = to_jsonschema_impl(schema, opts)
  for k, v in pairs(schema_json) do
    result[k] = v
  end

  return result
end

-- Export all schemas from a registry
function exports.export_registry(registry, opts)
  opts = opts or {}
  -- local base_id = opts.base_id or "https://rspamd.com/schema/"

  local result = {
    ["$schema"] = "http://json-schema.org/draft-07/schema#",
    definitions = {}
  }

  local schemas = registry:export_all()

  for id, schema in pairs(schemas) do
    result.definitions[id] = to_jsonschema_impl(schema, opts)
  end

  return result
end

return exports