@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
@@ -0,0 +1,69 @@
1
+ {
2
+ "$ref": "#/definitions/Invitation",
3
+ "definitions": {
4
+ "Invitation": {
5
+ "type": "object",
6
+ "properties": {
7
+ "id": {
8
+ "type": "string",
9
+ "description": "Unique invitation identifier"
10
+ },
11
+ "organizationId": {
12
+ "type": "string",
13
+ "description": "Organization ID"
14
+ },
15
+ "email": {
16
+ "type": "string",
17
+ "format": "email",
18
+ "description": "Invitee email address"
19
+ },
20
+ "role": {
21
+ "type": "string",
22
+ "description": "Role to assign upon acceptance"
23
+ },
24
+ "status": {
25
+ "type": "string",
26
+ "enum": [
27
+ "pending",
28
+ "accepted",
29
+ "rejected",
30
+ "expired"
31
+ ],
32
+ "default": "pending",
33
+ "description": "Invitation status"
34
+ },
35
+ "expiresAt": {
36
+ "type": "string",
37
+ "format": "date-time",
38
+ "description": "Invitation expiry timestamp"
39
+ },
40
+ "inviterId": {
41
+ "type": "string",
42
+ "description": "User ID of the inviter"
43
+ },
44
+ "createdAt": {
45
+ "type": "string",
46
+ "format": "date-time",
47
+ "description": "Invitation creation timestamp"
48
+ },
49
+ "updatedAt": {
50
+ "type": "string",
51
+ "format": "date-time",
52
+ "description": "Last update timestamp"
53
+ }
54
+ },
55
+ "required": [
56
+ "id",
57
+ "organizationId",
58
+ "email",
59
+ "role",
60
+ "expiresAt",
61
+ "inviterId",
62
+ "createdAt",
63
+ "updatedAt"
64
+ ],
65
+ "additionalProperties": false
66
+ }
67
+ },
68
+ "$schema": "http://json-schema.org/draft-07/schema#"
69
+ }
@@ -0,0 +1,15 @@
1
+ {
2
+ "$ref": "#/definitions/InvitationStatus",
3
+ "definitions": {
4
+ "InvitationStatus": {
5
+ "type": "string",
6
+ "enum": [
7
+ "pending",
8
+ "accepted",
9
+ "rejected",
10
+ "expired"
11
+ ]
12
+ }
13
+ },
14
+ "$schema": "http://json-schema.org/draft-07/schema#"
15
+ }
@@ -4,25 +4,42 @@
4
4
  "LDAPConfig": {
5
5
  "type": "object",
6
6
  "properties": {
7
+ "enabled": {
8
+ "type": "boolean",
9
+ "default": false
10
+ },
7
11
  "url": {
8
12
  "type": "string",
9
13
  "format": "uri",
10
14
  "description": "LDAP Server URL (ldap:// or ldaps://)"
11
15
  },
12
16
  "bindDn": {
13
- "type": "string"
17
+ "type": "string",
18
+ "description": "Bind DN for LDAP authentication"
14
19
  },
15
20
  "bindCredentials": {
16
- "type": "string"
21
+ "type": "string",
22
+ "description": "Bind credentials"
17
23
  },
18
24
  "searchBase": {
19
- "type": "string"
25
+ "type": "string",
26
+ "description": "Search base DN"
20
27
  },
21
28
  "searchFilter": {
22
- "type": "string"
29
+ "type": "string",
30
+ "description": "Search filter"
23
31
  },
24
32
  "groupSearchBase": {
25
- "type": "string"
33
+ "type": "string",
34
+ "description": "Group search base DN"
35
+ },
36
+ "displayName": {
37
+ "type": "string",
38
+ "description": "Display name for the provider button"
39
+ },
40
+ "icon": {
41
+ "type": "string",
42
+ "description": "Icon URL or identifier"
26
43
  }
27
44
  },
28
45
  "required": [
@@ -0,0 +1,21 @@
1
+ {
2
+ "$ref": "#/definitions/MagicLinkConfig",
3
+ "definitions": {
4
+ "MagicLinkConfig": {
5
+ "type": "object",
6
+ "properties": {
7
+ "enabled": {
8
+ "type": "boolean",
9
+ "default": true
10
+ },
11
+ "expiryTime": {
12
+ "type": "number",
13
+ "default": 900,
14
+ "description": "Magic link expiry time in seconds (default 15 min)"
15
+ }
16
+ },
17
+ "additionalProperties": false
18
+ }
19
+ },
20
+ "$schema": "http://json-schema.org/draft-07/schema#"
21
+ }
@@ -0,0 +1,46 @@
1
+ {
2
+ "$ref": "#/definitions/Member",
3
+ "definitions": {
4
+ "Member": {
5
+ "type": "object",
6
+ "properties": {
7
+ "id": {
8
+ "type": "string",
9
+ "description": "Unique member identifier"
10
+ },
11
+ "organizationId": {
12
+ "type": "string",
13
+ "description": "Organization ID"
14
+ },
15
+ "userId": {
16
+ "type": "string",
17
+ "description": "User ID"
18
+ },
19
+ "role": {
20
+ "type": "string",
21
+ "description": "Member role (e.g., owner, admin, member, guest)"
22
+ },
23
+ "createdAt": {
24
+ "type": "string",
25
+ "format": "date-time",
26
+ "description": "Member creation timestamp"
27
+ },
28
+ "updatedAt": {
29
+ "type": "string",
30
+ "format": "date-time",
31
+ "description": "Last update timestamp"
32
+ }
33
+ },
34
+ "required": [
35
+ "id",
36
+ "organizationId",
37
+ "userId",
38
+ "role",
39
+ "createdAt",
40
+ "updatedAt"
41
+ ],
42
+ "additionalProperties": false
43
+ }
44
+ },
45
+ "$schema": "http://json-schema.org/draft-07/schema#"
46
+ }
@@ -0,0 +1,47 @@
1
+ {
2
+ "$ref": "#/definitions/ModelCapability",
3
+ "definitions": {
4
+ "ModelCapability": {
5
+ "type": "object",
6
+ "properties": {
7
+ "textGeneration": {
8
+ "type": "boolean",
9
+ "default": true,
10
+ "description": "Supports text generation"
11
+ },
12
+ "textEmbedding": {
13
+ "type": "boolean",
14
+ "default": false,
15
+ "description": "Supports text embedding"
16
+ },
17
+ "imageGeneration": {
18
+ "type": "boolean",
19
+ "default": false,
20
+ "description": "Supports image generation"
21
+ },
22
+ "imageUnderstanding": {
23
+ "type": "boolean",
24
+ "default": false,
25
+ "description": "Supports image understanding"
26
+ },
27
+ "functionCalling": {
28
+ "type": "boolean",
29
+ "default": false,
30
+ "description": "Supports function calling"
31
+ },
32
+ "codeGeneration": {
33
+ "type": "boolean",
34
+ "default": false,
35
+ "description": "Supports code generation"
36
+ },
37
+ "reasoning": {
38
+ "type": "boolean",
39
+ "default": false,
40
+ "description": "Supports advanced reasoning"
41
+ }
42
+ },
43
+ "additionalProperties": false
44
+ }
45
+ },
46
+ "$schema": "http://json-schema.org/draft-07/schema#"
47
+ }
@@ -0,0 +1,181 @@
1
+ {
2
+ "$ref": "#/definitions/ModelConfig",
3
+ "definitions": {
4
+ "ModelConfig": {
5
+ "type": "object",
6
+ "properties": {
7
+ "id": {
8
+ "type": "string",
9
+ "description": "Unique model identifier"
10
+ },
11
+ "name": {
12
+ "type": "string",
13
+ "description": "Model display name"
14
+ },
15
+ "version": {
16
+ "type": "string",
17
+ "description": "Model version (e.g., \"gpt-4-turbo-2024-04-09\")"
18
+ },
19
+ "provider": {
20
+ "type": "string",
21
+ "enum": [
22
+ "openai",
23
+ "azure_openai",
24
+ "anthropic",
25
+ "google",
26
+ "cohere",
27
+ "huggingface",
28
+ "local",
29
+ "custom"
30
+ ]
31
+ },
32
+ "capabilities": {
33
+ "type": "object",
34
+ "properties": {
35
+ "textGeneration": {
36
+ "type": "boolean",
37
+ "default": true,
38
+ "description": "Supports text generation"
39
+ },
40
+ "textEmbedding": {
41
+ "type": "boolean",
42
+ "default": false,
43
+ "description": "Supports text embedding"
44
+ },
45
+ "imageGeneration": {
46
+ "type": "boolean",
47
+ "default": false,
48
+ "description": "Supports image generation"
49
+ },
50
+ "imageUnderstanding": {
51
+ "type": "boolean",
52
+ "default": false,
53
+ "description": "Supports image understanding"
54
+ },
55
+ "functionCalling": {
56
+ "type": "boolean",
57
+ "default": false,
58
+ "description": "Supports function calling"
59
+ },
60
+ "codeGeneration": {
61
+ "type": "boolean",
62
+ "default": false,
63
+ "description": "Supports code generation"
64
+ },
65
+ "reasoning": {
66
+ "type": "boolean",
67
+ "default": false,
68
+ "description": "Supports advanced reasoning"
69
+ }
70
+ },
71
+ "additionalProperties": false
72
+ },
73
+ "limits": {
74
+ "type": "object",
75
+ "properties": {
76
+ "maxTokens": {
77
+ "type": "integer",
78
+ "exclusiveMinimum": 0,
79
+ "description": "Maximum tokens per request"
80
+ },
81
+ "contextWindow": {
82
+ "type": "integer",
83
+ "exclusiveMinimum": 0,
84
+ "description": "Context window size"
85
+ },
86
+ "maxOutputTokens": {
87
+ "type": "integer",
88
+ "exclusiveMinimum": 0,
89
+ "description": "Maximum output tokens"
90
+ },
91
+ "rateLimit": {
92
+ "type": "object",
93
+ "properties": {
94
+ "requestsPerMinute": {
95
+ "type": "integer",
96
+ "exclusiveMinimum": 0
97
+ },
98
+ "tokensPerMinute": {
99
+ "type": "integer",
100
+ "exclusiveMinimum": 0
101
+ }
102
+ },
103
+ "additionalProperties": false
104
+ }
105
+ },
106
+ "required": [
107
+ "maxTokens",
108
+ "contextWindow"
109
+ ],
110
+ "additionalProperties": false
111
+ },
112
+ "pricing": {
113
+ "type": "object",
114
+ "properties": {
115
+ "currency": {
116
+ "type": "string",
117
+ "default": "USD"
118
+ },
119
+ "inputCostPer1kTokens": {
120
+ "type": "number",
121
+ "description": "Cost per 1K input tokens"
122
+ },
123
+ "outputCostPer1kTokens": {
124
+ "type": "number",
125
+ "description": "Cost per 1K output tokens"
126
+ },
127
+ "embeddingCostPer1kTokens": {
128
+ "type": "number",
129
+ "description": "Cost per 1K embedding tokens"
130
+ }
131
+ },
132
+ "additionalProperties": false
133
+ },
134
+ "endpoint": {
135
+ "type": "string",
136
+ "format": "uri",
137
+ "description": "Custom API endpoint"
138
+ },
139
+ "apiKey": {
140
+ "type": "string",
141
+ "description": "API key or reference to secret"
142
+ },
143
+ "region": {
144
+ "type": "string",
145
+ "description": "Deployment region (e.g., \"us-east-1\")"
146
+ },
147
+ "description": {
148
+ "type": "string"
149
+ },
150
+ "tags": {
151
+ "type": "array",
152
+ "items": {
153
+ "type": "string"
154
+ },
155
+ "description": "Tags for categorization"
156
+ },
157
+ "deprecated": {
158
+ "type": "boolean",
159
+ "default": false
160
+ },
161
+ "recommendedFor": {
162
+ "type": "array",
163
+ "items": {
164
+ "type": "string"
165
+ },
166
+ "description": "Use case recommendations"
167
+ }
168
+ },
169
+ "required": [
170
+ "id",
171
+ "name",
172
+ "version",
173
+ "provider",
174
+ "capabilities",
175
+ "limits"
176
+ ],
177
+ "additionalProperties": false
178
+ }
179
+ },
180
+ "$schema": "http://json-schema.org/draft-07/schema#"
181
+ }
@@ -0,0 +1,45 @@
1
+ {
2
+ "$ref": "#/definitions/ModelLimits",
3
+ "definitions": {
4
+ "ModelLimits": {
5
+ "type": "object",
6
+ "properties": {
7
+ "maxTokens": {
8
+ "type": "integer",
9
+ "exclusiveMinimum": 0,
10
+ "description": "Maximum tokens per request"
11
+ },
12
+ "contextWindow": {
13
+ "type": "integer",
14
+ "exclusiveMinimum": 0,
15
+ "description": "Context window size"
16
+ },
17
+ "maxOutputTokens": {
18
+ "type": "integer",
19
+ "exclusiveMinimum": 0,
20
+ "description": "Maximum output tokens"
21
+ },
22
+ "rateLimit": {
23
+ "type": "object",
24
+ "properties": {
25
+ "requestsPerMinute": {
26
+ "type": "integer",
27
+ "exclusiveMinimum": 0
28
+ },
29
+ "tokensPerMinute": {
30
+ "type": "integer",
31
+ "exclusiveMinimum": 0
32
+ }
33
+ },
34
+ "additionalProperties": false
35
+ }
36
+ },
37
+ "required": [
38
+ "maxTokens",
39
+ "contextWindow"
40
+ ],
41
+ "additionalProperties": false
42
+ }
43
+ },
44
+ "$schema": "http://json-schema.org/draft-07/schema#"
45
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "$ref": "#/definitions/ModelPricing",
3
+ "definitions": {
4
+ "ModelPricing": {
5
+ "type": "object",
6
+ "properties": {
7
+ "currency": {
8
+ "type": "string",
9
+ "default": "USD"
10
+ },
11
+ "inputCostPer1kTokens": {
12
+ "type": "number",
13
+ "description": "Cost per 1K input tokens"
14
+ },
15
+ "outputCostPer1kTokens": {
16
+ "type": "number",
17
+ "description": "Cost per 1K output tokens"
18
+ },
19
+ "embeddingCostPer1kTokens": {
20
+ "type": "number",
21
+ "description": "Cost per 1K embedding tokens"
22
+ }
23
+ },
24
+ "additionalProperties": false
25
+ }
26
+ },
27
+ "$schema": "http://json-schema.org/draft-07/schema#"
28
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ "$ref": "#/definitions/ModelProvider",
3
+ "definitions": {
4
+ "ModelProvider": {
5
+ "type": "string",
6
+ "enum": [
7
+ "openai",
8
+ "azure_openai",
9
+ "anthropic",
10
+ "google",
11
+ "cohere",
12
+ "huggingface",
13
+ "local",
14
+ "custom"
15
+ ]
16
+ }
17
+ },
18
+ "$schema": "http://json-schema.org/draft-07/schema#"
19
+ }