Skip to content

Commit ee3cc00

Browse files
Copilothotlong
Copilot
and
hotlong
committed
Fix code review issues - add parameter descriptions and correct extension point IDs
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 401344c commit ee3cc00

File tree

4 files changed

+37
-6
lines changed

4 files changed

+37
-6
lines changed

‎packages/plugins/driver-memory/objectstack.config.ts‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ const MemoryDriverPlugin: ObjectStackManifest = {
8484
// Interfaces This Driver Provides
8585
provides: [
8686
{
87-
id: 'com.objectstack.driver.interface.driver',
87+
id: 'com.objectstack.driver.memory.interface.driver',
8888
name: 'DriverInterface',
8989
description: 'Standard ObjectStack driver interface for data operations',
9090
version: { major: 1, minor: 0, patch: 0 },
@@ -93,12 +93,14 @@ const MemoryDriverPlugin: ObjectStackManifest = {
9393
{
9494
name: 'connect',
9595
description: 'Initialize driver connection',
96+
parameters: [],
9697
returnType: 'Promise<void>',
9798
async: true,
9899
},
99100
{
100101
name: 'disconnect',
101102
description: 'Close driver connection',
103+
parameters: [],
102104
returnType: 'Promise<void>',
103105
async: true,
104106
},
@@ -150,11 +152,13 @@ const MemoryDriverPlugin: ObjectStackManifest = {
150152
name: 'object',
151153
type: 'string',
152154
required: true,
155+
description: 'Object name',
153156
},
154157
{
155158
name: 'id',
156159
type: 'string',
157160
required: true,
161+
description: 'Record ID',
158162
},
159163
],
160164
returnType: 'Promise<any>',
@@ -168,16 +172,19 @@ const MemoryDriverPlugin: ObjectStackManifest = {
168172
name: 'object',
169173
type: 'string',
170174
required: true,
175+
description: 'Object name',
171176
},
172177
{
173178
name: 'id',
174179
type: 'string',
175180
required: true,
181+
description: 'Record ID',
176182
},
177183
{
178184
name: 'data',
179185
type: 'Record<string, any>',
180186
required: true,
187+
description: 'Updated record data',
181188
},
182189
],
183190
returnType: 'Promise<any>',
@@ -191,11 +198,13 @@ const MemoryDriverPlugin: ObjectStackManifest = {
191198
name: 'object',
192199
type: 'string',
193200
required: true,
201+
description: 'Object name',
194202
},
195203
{
196204
name: 'id',
197205
type: 'string',
198206
required: true,
207+
description: 'Record ID',
199208
},
200209
],
201210
returnType: 'Promise<boolean>',
@@ -209,11 +218,13 @@ const MemoryDriverPlugin: ObjectStackManifest = {
209218
name: 'object',
210219
type: 'string',
211220
required: true,
221+
description: 'Object name',
212222
},
213223
{
214224
name: 'query',
215225
type: 'QueryInput',
216226
required: false,
227+
description: 'Query parameters',
217228
},
218229
],
219230
returnType: 'Promise<number>',

‎packages/plugins/plugin-hono-server/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ capabilities: {
174174
extensions: [
175175
{
176176
targetPluginId: 'com.objectstack.server.hono',
177-
extensionPointId: 'com.objectstack.server.extension.middleware',
177+
extensionPointId: 'com.objectstack.server.hono.extension.middleware',
178178
implementation: './middleware/auth.ts',
179179
priority: 10
180180
}
@@ -190,7 +190,7 @@ capabilities: {
190190
extensions: [
191191
{
192192
targetPluginId: 'com.objectstack.server.hono',
193-
extensionPointId: 'com.objectstack.server.extension.route',
193+
extensionPointId: 'com.objectstack.server.hono.extension.route',
194194
implementation: './routes/webhooks.ts',
195195
priority: 50
196196
}

‎packages/plugins/plugin-hono-server/objectstack.config.ts‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ const HonoServerPlugin: ObjectStackManifest = {
7474
// Interfaces This Plugin Provides
7575
provides: [
7676
{
77-
id: 'com.objectstack.server.interface.http_server',
77+
id: 'com.objectstack.server.hono.interface.http_server',
7878
name: 'IHttpServer',
7979
description: 'HTTP server service interface',
8080
version: { major: 1, minor: 0, patch: 0 },
@@ -108,11 +108,13 @@ const HonoServerPlugin: ObjectStackManifest = {
108108
name: 'path',
109109
type: 'string',
110110
required: true,
111+
description: 'Route path pattern',
111112
},
112113
{
113114
name: 'handler',
114115
type: 'Function',
115116
required: true,
117+
description: 'Route handler function',
116118
},
117119
],
118120
returnType: 'void',
@@ -126,11 +128,13 @@ const HonoServerPlugin: ObjectStackManifest = {
126128
name: 'path',
127129
type: 'string',
128130
required: true,
131+
description: 'Route path pattern',
129132
},
130133
{
131134
name: 'handler',
132135
type: 'Function',
133136
required: true,
137+
description: 'Route handler function',
134138
},
135139
],
136140
returnType: 'void',
@@ -144,11 +148,13 @@ const HonoServerPlugin: ObjectStackManifest = {
144148
name: 'path',
145149
type: 'string',
146150
required: true,
151+
description: 'Route path pattern',
147152
},
148153
{
149154
name: 'handler',
150155
type: 'Function',
151156
required: true,
157+
description: 'Route handler function',
152158
},
153159
],
154160
returnType: 'void',
@@ -171,6 +177,7 @@ const HonoServerPlugin: ObjectStackManifest = {
171177
{
172178
name: 'close',
173179
description: 'Stop the HTTP server',
180+
parameters: [],
174181
returnType: 'void',
175182
async: false,
176183
},
@@ -194,7 +201,7 @@ const HonoServerPlugin: ObjectStackManifest = {
194201
// Extension Points This Plugin Defines
195202
extensionPoints: [
196203
{
197-
id: 'com.objectstack.server.extension.middleware',
204+
id: 'com.objectstack.server.hono.extension.middleware',
198205
name: 'HTTP Middleware',
199206
description: 'Register custom HTTP middleware',
200207
type: 'hook',
@@ -204,7 +211,7 @@ const HonoServerPlugin: ObjectStackManifest = {
204211
},
205212
},
206213
{
207-
id: 'com.objectstack.server.extension.route',
214+
id: 'com.objectstack.server.hono.extension.route',
208215
name: 'Custom Routes',
209216
description: 'Register custom API routes',
210217
type: 'action',

‎packages/plugins/plugin-msw/objectstack.config.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,13 @@ const MSWPlugin: ObjectStackManifest = {
111111
name: 'protocol',
112112
type: 'IObjectStackProtocol',
113113
required: true,
114+
description: 'ObjectStack protocol implementation instance',
114115
},
115116
{
116117
name: 'logger',
117118
type: 'Logger',
118119
required: false,
120+
description: 'Optional logger instance',
119121
},
120122
],
121123
returnType: 'void',
@@ -129,11 +131,13 @@ const MSWPlugin: ObjectStackManifest = {
129131
name: 'object',
130132
type: 'string',
131133
required: true,
134+
description: 'Object name',
132135
},
133136
{
134137
name: 'params',
135138
type: 'any',
136139
required: false,
140+
description: 'Query parameters',
137141
},
138142
],
139143
returnType: 'Promise<{ status: number; data: any }>',
@@ -147,11 +151,13 @@ const MSWPlugin: ObjectStackManifest = {
147151
name: 'object',
148152
type: 'string',
149153
required: true,
154+
description: 'Object name',
150155
},
151156
{
152157
name: 'id',
153158
type: 'string',
154159
required: true,
160+
description: 'Record ID',
155161
},
156162
],
157163
returnType: 'Promise<{ status: number; data: any }>',
@@ -165,11 +171,13 @@ const MSWPlugin: ObjectStackManifest = {
165171
name: 'object',
166172
type: 'string',
167173
required: true,
174+
description: 'Object name',
168175
},
169176
{
170177
name: 'data',
171178
type: 'any',
172179
required: true,
180+
description: 'Record data',
173181
},
174182
],
175183
returnType: 'Promise<{ status: number; data: any }>',
@@ -183,16 +191,19 @@ const MSWPlugin: ObjectStackManifest = {
183191
name: 'object',
184192
type: 'string',
185193
required: true,
194+
description: 'Object name',
186195
},
187196
{
188197
name: 'id',
189198
type: 'string',
190199
required: true,
200+
description: 'Record ID',
191201
},
192202
{
193203
name: 'data',
194204
type: 'any',
195205
required: true,
206+
description: 'Updated record data',
196207
},
197208
],
198209
returnType: 'Promise<{ status: number; data: any }>',
@@ -206,11 +217,13 @@ const MSWPlugin: ObjectStackManifest = {
206217
name: 'object',
207218
type: 'string',
208219
required: true,
220+
description: 'Object name',
209221
},
210222
{
211223
name: 'id',
212224
type: 'string',
213225
required: true,
226+
description: 'Record ID',
214227
},
215228
],
216229
returnType: 'Promise<{ status: number; data: any }>',

0 commit comments

Comments
 (0)