objectstack/packages/spec/json-schema/system/PluginContext.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
  "$ref": "#/definitions/PluginContext",
  "definitions": {
    "PluginContext": {
      "type": "object",
      "properties": {
        "ql": {
          "type": "object",
          "properties": {},
          "additionalProperties": false,
          "description": "ObjectQL Data Access Client"
        },
        "os": {
          "type": "object",
          "properties": {},
          "additionalProperties": false,
          "description": "Access to System Core"
        },
        "logger": {
          "type": "object",
          "properties": {
            "debug": {
              "description": "(message: string, ...meta: any[]) => void"
            },
            "info": {
              "description": "(message: string, ...meta: any[]) => void"
            },
            "warn": {
              "description": "(message: string, ...meta: any[]) => void"
            },
            "error": {
              "description": "(message: string, ...meta: any[]) => void"
            }
          },
          "additionalProperties": false,
          "description": "Structured Logger"
        },
        "storage": {
          "type": "object",
          "properties": {},
          "additionalProperties": false,
          "description": "Plugin Scoped Data Storage (KV)"
        },
        "i18n": {
          "type": "object",
          "properties": {},
          "additionalProperties": false,
          "description": "Internationalization Helper"
        },
        "metadata": {
          "description": "Metadata registry"
        },
        "events": {
          "description": "Event bus"
        },
        "app": {
          "type": "object",
          "properties": {
            "router": {
              "type": "object",
              "properties": {},
              "additionalProperties": false,
              "description": "HTTP Router Interface"
            },
            "scheduler": {
              "type": "object",
              "properties": {},
              "additionalProperties": false,
              "description": "Job Scheduler Interface"
            }
          },
          "required": [
            "router"
          ],
          "additionalProperties": false,
          "description": "App Runtime Capabilities"
        }
      },
      "required": [
        "ql",
        "os",
        "logger",
        "storage",
        "i18n",
        "app"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}