@objectstack/spec 0.1.2 → 0.3.0

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.
Files changed (152) hide show
  1. package/README.md +127 -5
  2. package/dist/ai/index.d.ts +14 -0
  3. package/dist/ai/index.d.ts.map +1 -0
  4. package/dist/ai/index.js +29 -0
  5. package/dist/ai/model-registry.zod.d.ts +1389 -0
  6. package/dist/ai/model-registry.zod.d.ts.map +1 -0
  7. package/dist/ai/model-registry.zod.js +164 -0
  8. package/dist/ai/nlq.zod.d.ts +1126 -0
  9. package/dist/ai/nlq.zod.d.ts.map +1 -0
  10. package/dist/ai/nlq.zod.js +246 -0
  11. package/dist/ai/rag-pipeline.zod.d.ts +1034 -0
  12. package/dist/ai/rag-pipeline.zod.d.ts.map +1 -0
  13. package/dist/ai/rag-pipeline.zod.js +244 -0
  14. package/dist/api/index.d.ts +9 -0
  15. package/dist/api/index.d.ts.map +1 -0
  16. package/dist/api/index.js +24 -0
  17. package/dist/data/filter.zod.d.ts +295 -0
  18. package/dist/data/filter.zod.d.ts.map +1 -0
  19. package/dist/data/filter.zod.js +226 -0
  20. package/dist/data/index.d.ts +21 -0
  21. package/dist/data/index.d.ts.map +1 -0
  22. package/dist/data/index.js +36 -0
  23. package/dist/data/query.zod.d.ts +386 -3
  24. package/dist/data/query.zod.d.ts.map +1 -1
  25. package/dist/data/query.zod.js +386 -3
  26. package/dist/data/validation.zod.d.ts +349 -0
  27. package/dist/data/validation.zod.d.ts.map +1 -1
  28. package/dist/data/validation.zod.js +395 -0
  29. package/dist/index.d.ts +36 -39
  30. package/dist/index.d.ts.map +1 -1
  31. package/dist/index.js +64 -47
  32. package/dist/system/auth-protocol.d.ts +175 -0
  33. package/dist/system/auth-protocol.d.ts.map +1 -0
  34. package/dist/system/auth-protocol.js +60 -0
  35. package/dist/system/auth.zod.d.ts +3319 -0
  36. package/dist/system/auth.zod.d.ts.map +1 -0
  37. package/dist/system/auth.zod.js +499 -0
  38. package/dist/system/datasource.zod.d.ts +118 -38
  39. package/dist/system/datasource.zod.d.ts.map +1 -1
  40. package/dist/system/datasource.zod.js +25 -6
  41. package/dist/system/driver.zod.d.ts +106 -0
  42. package/dist/system/driver.zod.d.ts.map +1 -1
  43. package/dist/system/driver.zod.js +47 -0
  44. package/dist/system/identity.zod.d.ts +234 -180
  45. package/dist/system/identity.zod.d.ts.map +1 -1
  46. package/dist/system/identity.zod.js +168 -51
  47. package/dist/system/index.d.ts +28 -0
  48. package/dist/system/index.d.ts.map +1 -0
  49. package/dist/system/index.js +43 -0
  50. package/dist/system/manifest.zod.d.ts +10 -10
  51. package/dist/system/organization.zod.d.ts +179 -0
  52. package/dist/system/organization.zod.d.ts.map +1 -0
  53. package/dist/system/organization.zod.js +129 -0
  54. package/dist/system/policy.zod.d.ts +10 -10
  55. package/dist/ui/action.zod.d.ts +2 -2
  56. package/dist/ui/dashboard.zod.d.ts +10 -10
  57. package/dist/ui/dashboard.zod.d.ts.map +1 -1
  58. package/dist/ui/dashboard.zod.js +3 -2
  59. package/dist/ui/index.d.ts +17 -0
  60. package/dist/ui/index.d.ts.map +1 -0
  61. package/dist/ui/index.js +32 -0
  62. package/dist/ui/report.zod.d.ts +4 -32
  63. package/dist/ui/report.zod.d.ts.map +1 -1
  64. package/dist/ui/report.zod.js +3 -8
  65. package/dist/ui/theme.zod.d.ts +6 -6
  66. package/json-schema/Account.json +87 -0
  67. package/json-schema/AccountLinkingConfig.json +27 -0
  68. package/json-schema/AuthConfig.json +841 -0
  69. package/json-schema/AuthPluginConfig.json +28 -0
  70. package/json-schema/AuthStrategy.json +17 -0
  71. package/json-schema/AuthenticationConfig.json +601 -0
  72. package/json-schema/AuthenticationProvider.json +617 -0
  73. package/json-schema/CSRFConfig.json +31 -0
  74. package/json-schema/ChunkingStrategy.json +133 -0
  75. package/json-schema/ComparisonOperator.json +56 -0
  76. package/json-schema/Dashboard.json +20 -0
  77. package/json-schema/DashboardWidget.json +20 -0
  78. package/json-schema/DatabaseAdapter.json +38 -0
  79. package/json-schema/DatabaseMapping.json +48 -0
  80. package/json-schema/Datasource.json +25 -5
  81. package/json-schema/DatasourceCapabilities.json +25 -5
  82. package/json-schema/DocumentChunk.json +97 -0
  83. package/json-schema/DocumentLoaderConfig.json +69 -0
  84. package/json-schema/DocumentMetadata.json +61 -0
  85. package/json-schema/DriverCapabilities.json +30 -0
  86. package/json-schema/DriverDefinition.json +25 -5
  87. package/json-schema/DriverInterface.json +30 -0
  88. package/json-schema/EmailPasswordConfig.json +43 -0
  89. package/json-schema/EmbeddingModel.json +57 -0
  90. package/json-schema/EnterpriseAuthConfig.json +172 -0
  91. package/json-schema/Entity.json +55 -0
  92. package/json-schema/EqualityOperator.json +14 -0
  93. package/json-schema/FieldOperators.json +108 -0
  94. package/json-schema/FieldSynonymConfig.json +39 -0
  95. package/json-schema/FilterCondition.json +28 -0
  96. package/json-schema/Invitation.json +69 -0
  97. package/json-schema/InvitationStatus.json +15 -0
  98. package/json-schema/LDAPConfig.json +22 -5
  99. package/json-schema/MagicLinkConfig.json +21 -0
  100. package/json-schema/Member.json +46 -0
  101. package/json-schema/ModelCapability.json +47 -0
  102. package/json-schema/ModelConfig.json +181 -0
  103. package/json-schema/ModelLimits.json +45 -0
  104. package/json-schema/ModelPricing.json +28 -0
  105. package/json-schema/ModelProvider.json +19 -0
  106. package/json-schema/ModelRegistry.json +427 -0
  107. package/json-schema/ModelRegistryEntry.json +239 -0
  108. package/json-schema/ModelSelectionCriteria.json +50 -0
  109. package/json-schema/NLQAnalytics.json +106 -0
  110. package/json-schema/NLQFieldMapping.json +40 -0
  111. package/json-schema/NLQModelConfig.json +78 -0
  112. package/json-schema/NLQParseResult.json +252 -0
  113. package/json-schema/NLQRequest.json +110 -0
  114. package/json-schema/NLQResponse.json +288 -0
  115. package/json-schema/NLQTrainingExample.json +120 -0
  116. package/json-schema/NormalizedFilter.json +348 -0
  117. package/json-schema/OAuthProvider.json +66 -0
  118. package/json-schema/OIDCConfig.json +18 -3
  119. package/json-schema/Organization.json +52 -0
  120. package/json-schema/PasskeyConfig.json +54 -0
  121. package/json-schema/PromptTemplate.json +163 -0
  122. package/json-schema/PromptVariable.json +56 -0
  123. package/json-schema/QueryContext.json +72 -0
  124. package/json-schema/QueryFilter.json +34 -0
  125. package/json-schema/QueryIntent.json +21 -0
  126. package/json-schema/QueryTemplate.json +81 -0
  127. package/json-schema/RAGPipelineConfig.json +552 -0
  128. package/json-schema/RAGPipelineStatus.json +66 -0
  129. package/json-schema/RAGQueryRequest.json +64 -0
  130. package/json-schema/RAGQueryResponse.json +108 -0
  131. package/json-schema/RangeOperator.json +41 -0
  132. package/json-schema/RateLimitConfig.json +36 -0
  133. package/json-schema/Report.json +20 -26
  134. package/json-schema/RerankingConfig.json +34 -0
  135. package/json-schema/RetrievalStrategy.json +121 -0
  136. package/json-schema/SAMLConfig.json +17 -3
  137. package/json-schema/Session.json +63 -0
  138. package/json-schema/SessionConfig.json +56 -0
  139. package/json-schema/SetOperator.json +18 -0
  140. package/json-schema/SpecialOperator.json +18 -0
  141. package/json-schema/StandardAuthProvider.json +857 -0
  142. package/json-schema/StringOperator.json +21 -0
  143. package/json-schema/Timeframe.json +68 -0
  144. package/json-schema/TwoFactorConfig.json +40 -0
  145. package/json-schema/User.json +51 -0
  146. package/json-schema/UserFieldMapping.json +47 -0
  147. package/json-schema/VectorStoreConfig.json +82 -0
  148. package/json-schema/VectorStoreProvider.json +21 -0
  149. package/json-schema/VerificationToken.json +36 -0
  150. package/package.json +27 -1
  151. package/json-schema/AuthProtocol.json +0 -17
  152. package/json-schema/AuthProvider.json +0 -171
package/json-schema/NormalizedFilter.json ADDED
@@ -0,0 +1,348 @@
1
+ {
2
+ "$ref": "#/definitions/NormalizedFilter",
3
+ "definitions": {
4
+ "NormalizedFilter": {
5
+ "type": "object",
6
+ "properties": {
7
+ "$and": {
8
+ "type": "array",
9
+ "items": {
10
+ "anyOf": [
11
+ {
12
+ "type": "object",
13
+ "additionalProperties": {
14
+ "type": "object",
15
+ "properties": {
16
+ "$eq": {},
17
+ "$ne": {},
18
+ "$gt": {
19
+ "anyOf": [
20
+ {
21
+ "type": "number"
22
+ },
23
+ {
24
+ "type": "string",
25
+ "format": "date-time"
26
+ }
27
+ ]
28
+ },
29
+ "$gte": {
30
+ "anyOf": [
31
+ {
32
+ "type": "number"
33
+ },
34
+ {
35
+ "type": "string",
36
+ "format": "date-time"
37
+ }
38
+ ]
39
+ },
40
+ "$lt": {
41
+ "anyOf": [
42
+ {
43
+ "type": "number"
44
+ },
45
+ {
46
+ "type": "string",
47
+ "format": "date-time"
48
+ }
49
+ ]
50
+ },
51
+ "$lte": {
52
+ "anyOf": [
53
+ {
54
+ "type": "number"
55
+ },
56
+ {
57
+ "type": "string",
58
+ "format": "date-time"
59
+ }
60
+ ]
61
+ },
62
+ "$in": {
63
+ "type": "array"
64
+ },
65
+ "$nin": {
66
+ "type": "array"
67
+ },
68
+ "$between": {
69
+ "type": "array",
70
+ "minItems": 2,
71
+ "maxItems": 2,
72
+ "items": [
73
+ {
74
+ "anyOf": [
75
+ {
76
+ "type": "number"
77
+ },
78
+ {
79
+ "type": "string",
80
+ "format": "date-time"
81
+ }
82
+ ]
83
+ },
84
+ {
85
+ "anyOf": [
86
+ {
87
+ "type": "number"
88
+ },
89
+ {
90
+ "type": "string",
91
+ "format": "date-time"
92
+ }
93
+ ]
94
+ }
95
+ ]
96
+ },
97
+ "$contains": {
98
+ "type": "string"
99
+ },
100
+ "$startsWith": {
101
+ "type": "string"
102
+ },
103
+ "$endsWith": {
104
+ "type": "string"
105
+ },
106
+ "$null": {
107
+ "type": "boolean"
108
+ },
109
+ "$exist": {
110
+ "type": "boolean"
111
+ }
112
+ },
113
+ "additionalProperties": false
114
+ }
115
+ },
116
+ {}
117
+ ]
118
+ }
119
+ },
120
+ "$or": {
121
+ "type": "array",
122
+ "items": {
123
+ "anyOf": [
124
+ {
125
+ "type": "object",
126
+ "additionalProperties": {
127
+ "type": "object",
128
+ "properties": {
129
+ "$eq": {},
130
+ "$ne": {},
131
+ "$gt": {
132
+ "anyOf": [
133
+ {
134
+ "type": "number"
135
+ },
136
+ {
137
+ "type": "string",
138
+ "format": "date-time"
139
+ }
140
+ ]
141
+ },
142
+ "$gte": {
143
+ "anyOf": [
144
+ {
145
+ "type": "number"
146
+ },
147
+ {
148
+ "type": "string",
149
+ "format": "date-time"
150
+ }
151
+ ]
152
+ },
153
+ "$lt": {
154
+ "anyOf": [
155
+ {
156
+ "type": "number"
157
+ },
158
+ {
159
+ "type": "string",
160
+ "format": "date-time"
161
+ }
162
+ ]
163
+ },
164
+ "$lte": {
165
+ "anyOf": [
166
+ {
167
+ "type": "number"
168
+ },
169
+ {
170
+ "type": "string",
171
+ "format": "date-time"
172
+ }
173
+ ]
174
+ },
175
+ "$in": {
176
+ "type": "array"
177
+ },
178
+ "$nin": {
179
+ "type": "array"
180
+ },
181
+ "$between": {
182
+ "type": "array",
183
+ "minItems": 2,
184
+ "maxItems": 2,
185
+ "items": [
186
+ {
187
+ "anyOf": [
188
+ {
189
+ "type": "number"
190
+ },
191
+ {
192
+ "type": "string",
193
+ "format": "date-time"
194
+ }
195
+ ]
196
+ },
197
+ {
198
+ "anyOf": [
199
+ {
200
+ "type": "number"
201
+ },
202
+ {
203
+ "type": "string",
204
+ "format": "date-time"
205
+ }
206
+ ]
207
+ }
208
+ ]
209
+ },
210
+ "$contains": {
211
+ "type": "string"
212
+ },
213
+ "$startsWith": {
214
+ "type": "string"
215
+ },
216
+ "$endsWith": {
217
+ "type": "string"
218
+ },
219
+ "$null": {
220
+ "type": "boolean"
221
+ },
222
+ "$exist": {
223
+ "type": "boolean"
224
+ }
225
+ },
226
+ "additionalProperties": false
227
+ }
228
+ },
229
+ {}
230
+ ]
231
+ }
232
+ },
233
+ "$not": {
234
+ "anyOf": [
235
+ {
236
+ "type": "object",
237
+ "additionalProperties": {
238
+ "type": "object",
239
+ "properties": {
240
+ "$eq": {},
241
+ "$ne": {},
242
+ "$gt": {
243
+ "anyOf": [
244
+ {
245
+ "type": "number"
246
+ },
247
+ {
248
+ "type": "string",
249
+ "format": "date-time"
250
+ }
251
+ ]
252
+ },
253
+ "$gte": {
254
+ "anyOf": [
255
+ {
256
+ "type": "number"
257
+ },
258
+ {
259
+ "type": "string",
260
+ "format": "date-time"
261
+ }
262
+ ]
263
+ },
264
+ "$lt": {
265
+ "anyOf": [
266
+ {
267
+ "type": "number"
268
+ },
269
+ {
270
+ "type": "string",
271
+ "format": "date-time"
272
+ }
273
+ ]
274
+ },
275
+ "$lte": {
276
+ "anyOf": [
277
+ {
278
+ "type": "number"
279
+ },
280
+ {
281
+ "type": "string",
282
+ "format": "date-time"
283
+ }
284
+ ]
285
+ },
286
+ "$in": {
287
+ "type": "array"
288
+ },
289
+ "$nin": {
290
+ "type": "array"
291
+ },
292
+ "$between": {
293
+ "type": "array",
294
+ "minItems": 2,
295
+ "maxItems": 2,
296
+ "items": [
297
+ {
298
+ "anyOf": [
299
+ {
300
+ "type": "number"
301
+ },
302
+ {
303
+ "type": "string",
304
+ "format": "date-time"
305
+ }
306
+ ]
307
+ },
308
+ {
309
+ "anyOf": [
310
+ {
311
+ "type": "number"
312
+ },
313
+ {
314
+ "type": "string",
315
+ "format": "date-time"
316
+ }
317
+ ]
318
+ }
319
+ ]
320
+ },
321
+ "$contains": {
322
+ "type": "string"
323
+ },
324
+ "$startsWith": {
325
+ "type": "string"
326
+ },
327
+ "$endsWith": {
328
+ "type": "string"
329
+ },
330
+ "$null": {
331
+ "type": "boolean"
332
+ },
333
+ "$exist": {
334
+ "type": "boolean"
335
+ }
336
+ },
337
+ "additionalProperties": false
338
+ }
339
+ },
340
+ {}
341
+ ]
342
+ }
343
+ },
344
+ "additionalProperties": false
345
+ }
346
+ },
347
+ "$schema": "http://json-schema.org/draft-07/schema#"
348
+ }
package/json-schema/OAuthProvider.json ADDED
@@ -0,0 +1,66 @@
1
+ {
2
+ "$ref": "#/definitions/OAuthProvider",
3
+ "definitions": {
4
+ "OAuthProvider": {
5
+ "type": "object",
6
+ "properties": {
7
+ "provider": {
8
+ "type": "string",
9
+ "enum": [
10
+ "google",
11
+ "github",
12
+ "facebook",
13
+ "twitter",
14
+ "linkedin",
15
+ "microsoft",
16
+ "apple",
17
+ "discord",
18
+ "gitlab",
19
+ "custom"
20
+ ],
21
+ "description": "OAuth provider type"
22
+ },
23
+ "clientId": {
24
+ "type": "string",
25
+ "description": "OAuth client ID"
26
+ },
27
+ "clientSecret": {
28
+ "type": "string",
29
+ "description": "OAuth client secret (typically from ENV)"
30
+ },
31
+ "scopes": {
32
+ "type": "array",
33
+ "items": {
34
+ "type": "string"
35
+ },
36
+ "description": "Requested OAuth scopes"
37
+ },
38
+ "redirectUri": {
39
+ "type": "string",
40
+ "format": "uri",
41
+ "description": "OAuth callback URL"
42
+ },
43
+ "enabled": {
44
+ "type": "boolean",
45
+ "default": true,
46
+ "description": "Whether this provider is enabled"
47
+ },
48
+ "displayName": {
49
+ "type": "string",
50
+ "description": "Display name for the provider button"
51
+ },
52
+ "icon": {
53
+ "type": "string",
54
+ "description": "Icon URL or identifier"
55
+ }
56
+ },
57
+ "required": [
58
+ "provider",
59
+ "clientId",
60
+ "clientSecret"
61
+ ],
62
+ "additionalProperties": false
63
+ }
64
+ },
65
+ "$schema": "http://json-schema.org/draft-07/schema#"
66
+ }
package/json-schema/OIDCConfig.json CHANGED
@@ -4,16 +4,22 @@
4
4
  "OIDCConfig": {
5
5
  "type": "object",
6
6
  "properties": {
7
+ "enabled": {
8
+ "type": "boolean",
9
+ "default": false
10
+ },
7
11
  "issuer": {
8
12
  "type": "string",
9
13
  "format": "uri",
10
14
  "description": "OIDC Issuer URL (.well-known/openid-configuration)"
11
15
  },
12
16
  "clientId": {
13
- "type": "string"
17
+ "type": "string",
18
+ "description": "OIDC client ID"
14
19
  },
15
20
  "clientSecret": {
16
- "type": "string"
21
+ "type": "string",
22
+ "description": "OIDC client secret"
17
23
  },
18
24
  "scopes": {
19
25
  "type": "array",
@@ -24,7 +30,8 @@
24
30
  "openid",
25
31
  "profile",
26
32
  "email"
27
- ]
33
+ ],
34
+ "description": "OIDC scopes"
28
35
  },
29
36
  "attributeMapping": {
30
37
  "type": "object",
@@ -32,6 +39,14 @@
32
39
  "type": "string"
33
40
  },
34
41
  "description": "Map IdP claims to User fields"
42
+ },
43
+ "displayName": {
44
+ "type": "string",
45
+ "description": "Display name for the provider button"
46
+ },
47
+ "icon": {
48
+ "type": "string",
49
+ "description": "Icon URL or identifier"
35
50
  }
36
51
  },
37
52
  "required": [
package/json-schema/Organization.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "$ref": "#/definitions/Organization",
3
+ "definitions": {
4
+ "Organization": {
5
+ "type": "object",
6
+ "properties": {
7
+ "id": {
8
+ "type": "string",
9
+ "description": "Unique organization identifier"
10
+ },
11
+ "name": {
12
+ "type": "string",
13
+ "description": "Organization display name"
14
+ },
15
+ "slug": {
16
+ "type": "string",
17
+ "pattern": "^[a-z0-9_-]+$",
18
+ "description": "Unique URL-friendly slug (lowercase alphanumeric, hyphens, underscores)"
19
+ },
20
+ "logo": {
21
+ "type": "string",
22
+ "format": "uri",
23
+ "description": "Organization logo URL"
24
+ },
25
+ "metadata": {
26
+ "type": "object",
27
+ "additionalProperties": {},
28
+ "description": "Custom metadata"
29
+ },
30
+ "createdAt": {
31
+ "type": "string",
32
+ "format": "date-time",
33
+ "description": "Organization creation timestamp"
34
+ },
35
+ "updatedAt": {
36
+ "type": "string",
37
+ "format": "date-time",
38
+ "description": "Last update timestamp"
39
+ }
40
+ },
41
+ "required": [
42
+ "id",
43
+ "name",
44
+ "slug",
45
+ "createdAt",
46
+ "updatedAt"
47
+ ],
48
+ "additionalProperties": false
49
+ }
50
+ },
51
+ "$schema": "http://json-schema.org/draft-07/schema#"
52
+ }
package/json-schema/PasskeyConfig.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "$ref": "#/definitions/PasskeyConfig",
3
+ "definitions": {
4
+ "PasskeyConfig": {
5
+ "type": "object",
6
+ "properties": {
7
+ "enabled": {
8
+ "type": "boolean",
9
+ "default": false
10
+ },
11
+ "rpName": {
12
+ "type": "string",
13
+ "description": "Relying Party name"
14
+ },
15
+ "rpId": {
16
+ "type": "string",
17
+ "description": "Relying Party ID (defaults to domain)"
18
+ },
19
+ "allowedOrigins": {
20
+ "type": "array",
21
+ "items": {
22
+ "type": "string",
23
+ "format": "uri"
24
+ },
25
+ "description": "Allowed origins for WebAuthn"
26
+ },
27
+ "userVerification": {
28
+ "type": "string",
29
+ "enum": [
30
+ "required",
31
+ "preferred",
32
+ "discouraged"
33
+ ],
34
+ "default": "preferred"
35
+ },
36
+ "attestation": {
37
+ "type": "string",
38
+ "enum": [
39
+ "none",
40
+ "indirect",
41
+ "direct",
42
+ "enterprise"
43
+ ],
44
+ "default": "none"
45
+ }
46
+ },
47
+ "required": [
48
+ "rpName"
49
+ ],
50
+ "additionalProperties": false
51
+ }
52
+ },
53
+ "$schema": "http://json-schema.org/draft-07/schema#"
54
+ }