@tanqory/plugin-sdk 0.6.0 → 0.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/schema/tanqory-app.schema.json +39 -14
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
3
|
"$id": "https://unpkg.com/@tanqory/plugin-sdk/schema/tanqory-app.schema.json",
|
|
4
4
|
"title": "Tanqory app manifest",
|
|
5
|
-
"description": "tanqory.app.json
|
|
5
|
+
"description": "tanqory.app.json \u2014 the contract a merchant consents to. Hand-maintained alongside parseAppManifest; manifest.schema.spec.ts asserts the two agree on every case.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"required": ["handle", "name", "appUrl", "scopes"],
|
|
8
8
|
"additionalProperties": false,
|
|
@@ -36,7 +36,9 @@
|
|
|
36
36
|
"additionalProperties": false,
|
|
37
37
|
"required": ["enabled"],
|
|
38
38
|
"properties": {
|
|
39
|
-
"enabled": {
|
|
39
|
+
"enabled": {
|
|
40
|
+
"type": "boolean"
|
|
41
|
+
},
|
|
40
42
|
"path": {
|
|
41
43
|
"type": "string",
|
|
42
44
|
"pattern": "^/",
|
|
@@ -65,13 +67,25 @@
|
|
|
65
67
|
"additionalProperties": false,
|
|
66
68
|
"required": ["topic", "path"],
|
|
67
69
|
"properties": {
|
|
68
|
-
"topic": {
|
|
69
|
-
|
|
70
|
+
"topic": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"minLength": 1
|
|
73
|
+
},
|
|
74
|
+
"path": {
|
|
75
|
+
"type": "string",
|
|
76
|
+
"pattern": "^/"
|
|
77
|
+
}
|
|
70
78
|
}
|
|
71
79
|
}
|
|
72
80
|
},
|
|
73
|
-
"supportUrl": {
|
|
74
|
-
|
|
81
|
+
"supportUrl": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"pattern": "^https://"
|
|
84
|
+
},
|
|
85
|
+
"privacyPolicyUrl": {
|
|
86
|
+
"type": "string",
|
|
87
|
+
"pattern": "^https://"
|
|
88
|
+
},
|
|
75
89
|
"appType": {
|
|
76
90
|
"enum": ["embed", "external"],
|
|
77
91
|
"description": "external means open in a new tab, not iframe."
|
|
@@ -83,7 +97,7 @@
|
|
|
83
97
|
"properties": {
|
|
84
98
|
"placement": {
|
|
85
99
|
"type": "string",
|
|
86
|
-
"description": "Which dashboard menu the app appears under. Shape-checked here and resolved server-side, so the
|
|
100
|
+
"description": "Which dashboard menu the app appears under, or `root` for its own top-level entry. Shape-checked here and resolved server-side against the live list, so the vocabulary can grow without an SDK release.",
|
|
87
101
|
"examples": [
|
|
88
102
|
"apps",
|
|
89
103
|
"orders",
|
|
@@ -96,7 +110,8 @@
|
|
|
96
110
|
"store-automation",
|
|
97
111
|
"online-store",
|
|
98
112
|
"subscriptions",
|
|
99
|
-
"markets"
|
|
113
|
+
"markets",
|
|
114
|
+
"root"
|
|
100
115
|
]
|
|
101
116
|
},
|
|
102
117
|
"items": {
|
|
@@ -106,7 +121,10 @@
|
|
|
106
121
|
"additionalProperties": false,
|
|
107
122
|
"required": ["label", "path"],
|
|
108
123
|
"properties": {
|
|
109
|
-
"label": {
|
|
124
|
+
"label": {
|
|
125
|
+
"type": "string",
|
|
126
|
+
"minLength": 1
|
|
127
|
+
},
|
|
110
128
|
"path": {
|
|
111
129
|
"type": "string",
|
|
112
130
|
"pattern": "^/",
|
|
@@ -121,8 +139,13 @@
|
|
|
121
139
|
"type": "object",
|
|
122
140
|
"additionalProperties": false,
|
|
123
141
|
"properties": {
|
|
124
|
-
"minHeight": {
|
|
125
|
-
|
|
142
|
+
"minHeight": {
|
|
143
|
+
"type": "number",
|
|
144
|
+
"exclusiveMinimum": 0
|
|
145
|
+
},
|
|
146
|
+
"width": {
|
|
147
|
+
"enum": ["full", "centered"]
|
|
148
|
+
}
|
|
126
149
|
}
|
|
127
150
|
},
|
|
128
151
|
"provides": {
|
|
@@ -141,14 +164,14 @@
|
|
|
141
164
|
"dispatchUrl": {
|
|
142
165
|
"type": "string",
|
|
143
166
|
"pattern": "^https://",
|
|
144
|
-
"description": "Where Tanqory posts a message you took over. Must be reachable from the platform
|
|
167
|
+
"description": "Where Tanqory posts a message you took over. Must be reachable from the platform \u2014 not localhost, because Tanqory calls it, your browser does not."
|
|
145
168
|
}
|
|
146
169
|
}
|
|
147
170
|
}
|
|
148
171
|
},
|
|
149
172
|
"allOf": [
|
|
150
173
|
{
|
|
151
|
-
"$comment": "provides naming a notification capability requires notifications.dispatchUrl
|
|
174
|
+
"$comment": "provides naming a notification capability requires notifications.dispatchUrl \u2014 otherwise the messages you took over have nowhere to go.",
|
|
152
175
|
"if": {
|
|
153
176
|
"properties": {
|
|
154
177
|
"provides": {
|
|
@@ -161,7 +184,9 @@
|
|
|
161
184
|
},
|
|
162
185
|
"required": ["provides"]
|
|
163
186
|
},
|
|
164
|
-
"then": {
|
|
187
|
+
"then": {
|
|
188
|
+
"required": ["notifications"]
|
|
189
|
+
}
|
|
165
190
|
}
|
|
166
191
|
]
|
|
167
192
|
}
|