@objectstack/plugin-dev 2.0.6
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/.turbo/turbo-build.log +26 -0
- package/LICENSE +202 -0
- package/README.md +117 -0
- package/dist/index.d.mts +158 -0
- package/dist/index.d.ts +158 -0
- package/dist/index.js +735 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +698 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +67 -0
- package/src/dev-plugin.test.ts +267 -0
- package/src/dev-plugin.ts +779 -0
- package/src/index.ts +41 -0
- package/tsconfig.json +8 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
|
|
2
|
+
> @objectstack/plugin-dev@2.0.6 build /home/runner/work/spec/spec/packages/plugins/plugin-dev
|
|
3
|
+
> tsup --config ../../../tsup.config.ts
|
|
4
|
+
|
|
5
|
+
[34mCLI[39m Building entry: src/index.ts
|
|
6
|
+
[34mCLI[39m Using tsconfig: tsconfig.json
|
|
7
|
+
[34mCLI[39m tsup v8.5.1
|
|
8
|
+
[34mCLI[39m Using tsup config: /home/runner/work/spec/spec/tsup.config.ts
|
|
9
|
+
[34mCLI[39m Target: es2020
|
|
10
|
+
[34mCLI[39m Cleaning output folder
|
|
11
|
+
[34mESM[39m Build start
|
|
12
|
+
[34mCJS[39m Build start
|
|
13
|
+
[32mESM[39m [1mdist/index.mjs [22m[32m19.87 KB[39m
|
|
14
|
+
[32mESM[39m [1mdist/index.mjs.map [22m[32m43.39 KB[39m
|
|
15
|
+
[32mESM[39m ⚡️ Build success in 70ms
|
|
16
|
+
[32mCJS[39m [1mdist/index.js [22m[32m21.45 KB[39m
|
|
17
|
+
[32mCJS[39m [1mdist/index.js.map [22m[32m44.84 KB[39m
|
|
18
|
+
[32mCJS[39m ⚡️ Build success in 73ms
|
|
19
|
+
[34mDTS[39m Build start
|
|
20
|
+
error TS18003: No inputs were found in config file 'tsconfig.json'. Specified 'include' paths were '["src"]' and 'exclude' paths were '["../../../node_modules","../../../packages","../../../apps","../../../examples"]'.
|
|
21
|
+
|
|
22
|
+
error TS18003: No inputs were found in config file 'tsconfig.json'. Specified 'include' paths were '["src"]' and 'exclude' paths were '["../../../node_modules","../../../packages","../../../apps","../../../examples"]'.
|
|
23
|
+
|
|
24
|
+
[32mDTS[39m ⚡️ Build success in 9100ms
|
|
25
|
+
[32mDTS[39m [1mdist/index.d.mts [22m[32m5.57 KB[39m
|
|
26
|
+
[32mDTS[39m [1mdist/index.d.ts [22m[32m5.57 KB[39m
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute
|
|
108
|
+
must include a readable copy of the attribution notices
|
|
109
|
+
contained within such NOTICE file, excluding those notices
|
|
110
|
+
that do not pertain to any part of the Derivative Works,
|
|
111
|
+
in at least one of the following places: within a NOTICE
|
|
112
|
+
text file distributed as part of the Derivative Works; within
|
|
113
|
+
the Source form or documentation, if provided along with
|
|
114
|
+
the Derivative Works; or, within a display generated by the
|
|
115
|
+
Derivative Works, if and wherever such third-party notices
|
|
116
|
+
normally appear. The contents of the NOTICE file are for
|
|
117
|
+
informational purposes only and do not modify the License.
|
|
118
|
+
You may add Your own attribution notices within Derivative
|
|
119
|
+
Works that You distribute, alongside or as an addendum to
|
|
120
|
+
the NOTICE text from the Work, provided that such additional
|
|
121
|
+
attribution notices cannot be construed as modifying the
|
|
122
|
+
License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 ObjectStack
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# @objectstack/plugin-dev
|
|
2
|
+
|
|
3
|
+
> Development Mode Plugin for ObjectStack — auto-enables **all 17+ kernel services** for a full-featured API development environment.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Instead of manually wiring up ObjectQL, drivers, auth, HTTP server, REST endpoints, dispatcher, security, and metadata for local development, use `DevPlugin` to get a fully functional stack in one line.
|
|
8
|
+
|
|
9
|
+
The dev environment simulates **all kernel services** so you can:
|
|
10
|
+
- CRUD business objects via REST API
|
|
11
|
+
- Read, modify, and save views/apps/dashboards via metadata API (`PUT /api/v1/meta/:type/:name`)
|
|
12
|
+
- Use GraphQL, analytics, storage, and automation endpoints
|
|
13
|
+
- Authenticate with dev credentials (no real auth provider needed)
|
|
14
|
+
- Test UI permissions, workflows, and notifications with dev stubs
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
### Zero-config
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { defineStack } from '@objectstack/spec';
|
|
22
|
+
import { DevPlugin } from '@objectstack/plugin-dev';
|
|
23
|
+
|
|
24
|
+
export default defineStack({
|
|
25
|
+
manifest: {
|
|
26
|
+
id: 'com.example.myapp',
|
|
27
|
+
name: 'My App',
|
|
28
|
+
version: '0.1.0',
|
|
29
|
+
type: 'app',
|
|
30
|
+
},
|
|
31
|
+
plugins: [new DevPlugin()],
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Full-stack dev with project metadata
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import config from './objectstack.config';
|
|
39
|
+
import { DevPlugin } from '@objectstack/plugin-dev';
|
|
40
|
+
|
|
41
|
+
// Load all project metadata (objects, views, etc.) into the dev server
|
|
42
|
+
export default defineStack({
|
|
43
|
+
...config,
|
|
44
|
+
plugins: [new DevPlugin({ stack: config })],
|
|
45
|
+
});
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### With options
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
plugins: [
|
|
52
|
+
new DevPlugin({
|
|
53
|
+
port: 4000,
|
|
54
|
+
seedAdminUser: true,
|
|
55
|
+
services: {
|
|
56
|
+
auth: false, // Skip auth for quick prototyping
|
|
57
|
+
dispatcher: false, // Skip extended API routes
|
|
58
|
+
},
|
|
59
|
+
}),
|
|
60
|
+
]
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## What it auto-configures
|
|
64
|
+
|
|
65
|
+
### Real plugin implementations
|
|
66
|
+
|
|
67
|
+
| Service | Package | Description |
|
|
68
|
+
|---------|---------|-------------|
|
|
69
|
+
| ObjectQL | `@objectstack/objectql` | Data engine (query, CRUD, hooks, metadata) |
|
|
70
|
+
| InMemoryDriver | `@objectstack/driver-memory` | In-memory database (no DB install) |
|
|
71
|
+
| App/Metadata | `@objectstack/runtime` | Project metadata (objects, views, apps, dashboards) |
|
|
72
|
+
| Auth | `@objectstack/plugin-auth` | Authentication with dev credentials |
|
|
73
|
+
| Security | `@objectstack/plugin-security` | RBAC, RLS, field-level masking |
|
|
74
|
+
| Hono Server | `@objectstack/plugin-hono-server` | HTTP server on configured port |
|
|
75
|
+
| REST API | `@objectstack/rest` | Auto-generated CRUD + metadata endpoints |
|
|
76
|
+
| Dispatcher | `@objectstack/runtime` | Auth routes, GraphQL, analytics, packages, storage |
|
|
77
|
+
|
|
78
|
+
### Dev stubs (in-memory / no-op)
|
|
79
|
+
|
|
80
|
+
Any core kernel service not provided by a real plugin is automatically registered as a dev stub. This ensures the **full kernel service map** is populated and features like UI permissions, automation, etc. don't crash:
|
|
81
|
+
|
|
82
|
+
`cache`, `queue`, `job`, `file-storage`, `search`, `automation`, `graphql`, `analytics`, `realtime`, `notification`, `ai`, `i18n`, `ui`, `workflow`, `security.permissions`, `security.rls`, `security.fieldMasker`
|
|
83
|
+
|
|
84
|
+
All services are **optional** — if a peer package isn't installed, it is silently skipped and a stub takes its place.
|
|
85
|
+
|
|
86
|
+
## API Endpoints (when all services enabled)
|
|
87
|
+
|
|
88
|
+
| Endpoint | Description |
|
|
89
|
+
|----------|-------------|
|
|
90
|
+
| `GET /api/v1/data/:object` | List records |
|
|
91
|
+
| `POST /api/v1/data/:object` | Create record |
|
|
92
|
+
| `GET /api/v1/data/:object/:id` | Get record |
|
|
93
|
+
| `PUT /api/v1/data/:object/:id` | Update record |
|
|
94
|
+
| `DELETE /api/v1/data/:object/:id` | Delete record |
|
|
95
|
+
| `GET /api/v1/meta` | List metadata types |
|
|
96
|
+
| `GET /api/v1/meta/:type` | List metadata of type |
|
|
97
|
+
| `GET /api/v1/meta/:type/:name` | Get metadata item |
|
|
98
|
+
| `PUT /api/v1/meta/:type/:name` | Save metadata item |
|
|
99
|
+
| `POST /api/v1/graphql` | GraphQL endpoint |
|
|
100
|
+
| `GET /.well-known/objectstack` | Service discovery |
|
|
101
|
+
|
|
102
|
+
## Options
|
|
103
|
+
|
|
104
|
+
| Option | Type | Default | Description |
|
|
105
|
+
|--------|------|---------|-------------|
|
|
106
|
+
| `port` | `number` | `3000` | HTTP server port |
|
|
107
|
+
| `seedAdminUser` | `boolean` | `true` | Create `admin@dev.local` on startup |
|
|
108
|
+
| `authSecret` | `string` | dev default | JWT secret for auth sessions |
|
|
109
|
+
| `authBaseUrl` | `string` | `http://localhost:{port}` | Auth callback URL |
|
|
110
|
+
| `verbose` | `boolean` | `true` | Enable verbose logging |
|
|
111
|
+
| `services` | `Record<string, boolean>` | all `true` | Enable/disable individual services |
|
|
112
|
+
| `extraPlugins` | `Plugin[]` | `[]` | Additional plugins to load |
|
|
113
|
+
| `stack` | `object` | — | Stack definition to load as project metadata |
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
Apache-2.0
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
import { Plugin, PluginContext } from '@objectstack/core';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Dev Plugin Options
|
|
5
|
+
*
|
|
6
|
+
* Configuration for the development-mode plugin.
|
|
7
|
+
* All options have sensible defaults — zero-config works out of the box.
|
|
8
|
+
*/
|
|
9
|
+
interface DevPluginOptions {
|
|
10
|
+
/**
|
|
11
|
+
* Port for the HTTP server.
|
|
12
|
+
* @default 3000
|
|
13
|
+
*/
|
|
14
|
+
port?: number;
|
|
15
|
+
/**
|
|
16
|
+
* Whether to seed a default admin user for development.
|
|
17
|
+
* Creates `admin@dev.local` / `admin` so devs can skip login.
|
|
18
|
+
* @default true
|
|
19
|
+
*/
|
|
20
|
+
seedAdminUser?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Auth secret for development sessions.
|
|
23
|
+
* @default 'objectstack-dev-secret-DO-NOT-USE-IN-PRODUCTION!!'
|
|
24
|
+
*/
|
|
25
|
+
authSecret?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Auth base URL.
|
|
28
|
+
* @default 'http://localhost:{port}'
|
|
29
|
+
*/
|
|
30
|
+
authBaseUrl?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Whether to enable verbose logging.
|
|
33
|
+
* @default true
|
|
34
|
+
*/
|
|
35
|
+
verbose?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Override which services to enable. By default all core services are enabled.
|
|
38
|
+
* Set a service name to `false` to skip it.
|
|
39
|
+
*
|
|
40
|
+
* Available services: 'objectql', 'driver', 'auth', 'server', 'rest',
|
|
41
|
+
* 'dispatcher', 'security', plus any of the 17 CoreServiceName values
|
|
42
|
+
* (e.g. 'cache', 'queue', 'job', 'ui', 'automation', 'workflow', …).
|
|
43
|
+
*/
|
|
44
|
+
services?: Partial<Record<string, boolean>>;
|
|
45
|
+
/**
|
|
46
|
+
* Additional plugins to load alongside the auto-configured ones.
|
|
47
|
+
* Useful for adding custom project plugins while still getting the dev defaults.
|
|
48
|
+
*/
|
|
49
|
+
extraPlugins?: Plugin[];
|
|
50
|
+
/**
|
|
51
|
+
* Stack definition to load as a project.
|
|
52
|
+
* When provided, the DevPlugin wraps it in an AppPlugin so that all
|
|
53
|
+
* metadata (objects, views, apps, dashboards, etc.) is registered with
|
|
54
|
+
* the kernel and exposed through the REST/metadata APIs.
|
|
55
|
+
*
|
|
56
|
+
* This is what makes `new DevPlugin({ stack: config })` equivalent to
|
|
57
|
+
* a full `os serve --dev` environment: views can be read, modified, and
|
|
58
|
+
* saved through the API.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* import config from './objectstack.config';
|
|
63
|
+
* plugins: [new DevPlugin({ stack: config })]
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
stack?: Record<string, any>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Development Mode Plugin for ObjectStack
|
|
70
|
+
*
|
|
71
|
+
* A convenience plugin that auto-configures the **entire** platform stack
|
|
72
|
+
* for local development, simulating **all 17+ kernel services** so developers
|
|
73
|
+
* can work in a full-featured API environment without external dependencies.
|
|
74
|
+
*
|
|
75
|
+
* Instead of manually wiring:
|
|
76
|
+
*
|
|
77
|
+
* ```ts
|
|
78
|
+
* plugins: [
|
|
79
|
+
* new ObjectQLPlugin(),
|
|
80
|
+
* new DriverPlugin(new InMemoryDriver()),
|
|
81
|
+
* new AuthPlugin({ secret: '...', baseUrl: '...' }),
|
|
82
|
+
* new HonoServerPlugin({ port: 3000 }),
|
|
83
|
+
* createRestApiPlugin(),
|
|
84
|
+
* createDispatcherPlugin(),
|
|
85
|
+
* new SecurityPlugin(),
|
|
86
|
+
* new AppPlugin(config),
|
|
87
|
+
* ]
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* You can simply use:
|
|
91
|
+
*
|
|
92
|
+
* ```ts
|
|
93
|
+
* plugins: [new DevPlugin()]
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* ## Core services (real implementations)
|
|
97
|
+
*
|
|
98
|
+
* | Service | Package | Description |
|
|
99
|
+
* |--------------|-----------------------------------|-------------------------------------------|
|
|
100
|
+
* | ObjectQL | `@objectstack/objectql` | Data engine (query, CRUD, hooks) |
|
|
101
|
+
* | Driver | `@objectstack/driver-memory` | In-memory database (no DB install) |
|
|
102
|
+
* | Auth | `@objectstack/plugin-auth` | Authentication with dev credentials |
|
|
103
|
+
* | Security | `@objectstack/plugin-security` | RBAC, RLS, field-level masking |
|
|
104
|
+
* | HTTP Server | `@objectstack/plugin-hono-server` | HTTP server on configured port |
|
|
105
|
+
* | REST API | `@objectstack/rest` | Auto-generated CRUD + metadata endpoints |
|
|
106
|
+
* | Dispatcher | `@objectstack/runtime` | Auth, GraphQL, analytics, packages, etc. |
|
|
107
|
+
* | App/Metadata | `@objectstack/runtime` | Project metadata (objects, views, apps) |
|
|
108
|
+
*
|
|
109
|
+
* ## Stub services (contract-compliant in-memory implementations)
|
|
110
|
+
*
|
|
111
|
+
* Any core service not provided by a real plugin is automatically registered
|
|
112
|
+
* as a contract-compliant dev stub that implements the interface from
|
|
113
|
+
* `packages/spec/src/contracts/`. Each stub returns correct types:
|
|
114
|
+
*
|
|
115
|
+
* `cache` (Map-backed), `queue` (in-memory pub/sub), `job` (no-op scheduler),
|
|
116
|
+
* `file-storage` (Map-backed), `search` (in-memory text search),
|
|
117
|
+
* `automation` (no-op flows), `graphql` (placeholder), `analytics` (empty results),
|
|
118
|
+
* `realtime` (in-memory pub/sub), `notification` (log), `ai` (placeholder),
|
|
119
|
+
* `i18n` (Map-backed translations), `ui` (Map-backed views/dashboards),
|
|
120
|
+
* `workflow` (Map-backed state machine)
|
|
121
|
+
*
|
|
122
|
+
* All services can be individually disabled via `options.services`.
|
|
123
|
+
* Peer packages are loaded via dynamic import and silently skipped if missing.
|
|
124
|
+
*/
|
|
125
|
+
declare class DevPlugin implements Plugin {
|
|
126
|
+
name: string;
|
|
127
|
+
type: string;
|
|
128
|
+
version: string;
|
|
129
|
+
private options;
|
|
130
|
+
private childPlugins;
|
|
131
|
+
constructor(options?: DevPluginOptions);
|
|
132
|
+
/**
|
|
133
|
+
* Init Phase
|
|
134
|
+
*
|
|
135
|
+
* Dynamically imports and instantiates all core plugins.
|
|
136
|
+
* Uses dynamic imports so that peer dependencies remain optional —
|
|
137
|
+
* if a package isn't installed the service is silently skipped.
|
|
138
|
+
*/
|
|
139
|
+
init(ctx: PluginContext): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Start Phase
|
|
142
|
+
*
|
|
143
|
+
* Starts all child plugins and optionally seeds the dev admin user.
|
|
144
|
+
*/
|
|
145
|
+
start(ctx: PluginContext): Promise<void>;
|
|
146
|
+
/**
|
|
147
|
+
* Destroy Phase
|
|
148
|
+
*
|
|
149
|
+
* Cleans up all child plugins in reverse order.
|
|
150
|
+
*/
|
|
151
|
+
destroy(): Promise<void>;
|
|
152
|
+
/**
|
|
153
|
+
* Seed a default admin user for development.
|
|
154
|
+
*/
|
|
155
|
+
private seedAdmin;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export { DevPlugin, type DevPluginOptions };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
import { Plugin, PluginContext } from '@objectstack/core';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Dev Plugin Options
|
|
5
|
+
*
|
|
6
|
+
* Configuration for the development-mode plugin.
|
|
7
|
+
* All options have sensible defaults — zero-config works out of the box.
|
|
8
|
+
*/
|
|
9
|
+
interface DevPluginOptions {
|
|
10
|
+
/**
|
|
11
|
+
* Port for the HTTP server.
|
|
12
|
+
* @default 3000
|
|
13
|
+
*/
|
|
14
|
+
port?: number;
|
|
15
|
+
/**
|
|
16
|
+
* Whether to seed a default admin user for development.
|
|
17
|
+
* Creates `admin@dev.local` / `admin` so devs can skip login.
|
|
18
|
+
* @default true
|
|
19
|
+
*/
|
|
20
|
+
seedAdminUser?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Auth secret for development sessions.
|
|
23
|
+
* @default 'objectstack-dev-secret-DO-NOT-USE-IN-PRODUCTION!!'
|
|
24
|
+
*/
|
|
25
|
+
authSecret?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Auth base URL.
|
|
28
|
+
* @default 'http://localhost:{port}'
|
|
29
|
+
*/
|
|
30
|
+
authBaseUrl?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Whether to enable verbose logging.
|
|
33
|
+
* @default true
|
|
34
|
+
*/
|
|
35
|
+
verbose?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Override which services to enable. By default all core services are enabled.
|
|
38
|
+
* Set a service name to `false` to skip it.
|
|
39
|
+
*
|
|
40
|
+
* Available services: 'objectql', 'driver', 'auth', 'server', 'rest',
|
|
41
|
+
* 'dispatcher', 'security', plus any of the 17 CoreServiceName values
|
|
42
|
+
* (e.g. 'cache', 'queue', 'job', 'ui', 'automation', 'workflow', …).
|
|
43
|
+
*/
|
|
44
|
+
services?: Partial<Record<string, boolean>>;
|
|
45
|
+
/**
|
|
46
|
+
* Additional plugins to load alongside the auto-configured ones.
|
|
47
|
+
* Useful for adding custom project plugins while still getting the dev defaults.
|
|
48
|
+
*/
|
|
49
|
+
extraPlugins?: Plugin[];
|
|
50
|
+
/**
|
|
51
|
+
* Stack definition to load as a project.
|
|
52
|
+
* When provided, the DevPlugin wraps it in an AppPlugin so that all
|
|
53
|
+
* metadata (objects, views, apps, dashboards, etc.) is registered with
|
|
54
|
+
* the kernel and exposed through the REST/metadata APIs.
|
|
55
|
+
*
|
|
56
|
+
* This is what makes `new DevPlugin({ stack: config })` equivalent to
|
|
57
|
+
* a full `os serve --dev` environment: views can be read, modified, and
|
|
58
|
+
* saved through the API.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* import config from './objectstack.config';
|
|
63
|
+
* plugins: [new DevPlugin({ stack: config })]
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
stack?: Record<string, any>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Development Mode Plugin for ObjectStack
|
|
70
|
+
*
|
|
71
|
+
* A convenience plugin that auto-configures the **entire** platform stack
|
|
72
|
+
* for local development, simulating **all 17+ kernel services** so developers
|
|
73
|
+
* can work in a full-featured API environment without external dependencies.
|
|
74
|
+
*
|
|
75
|
+
* Instead of manually wiring:
|
|
76
|
+
*
|
|
77
|
+
* ```ts
|
|
78
|
+
* plugins: [
|
|
79
|
+
* new ObjectQLPlugin(),
|
|
80
|
+
* new DriverPlugin(new InMemoryDriver()),
|
|
81
|
+
* new AuthPlugin({ secret: '...', baseUrl: '...' }),
|
|
82
|
+
* new HonoServerPlugin({ port: 3000 }),
|
|
83
|
+
* createRestApiPlugin(),
|
|
84
|
+
* createDispatcherPlugin(),
|
|
85
|
+
* new SecurityPlugin(),
|
|
86
|
+
* new AppPlugin(config),
|
|
87
|
+
* ]
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* You can simply use:
|
|
91
|
+
*
|
|
92
|
+
* ```ts
|
|
93
|
+
* plugins: [new DevPlugin()]
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* ## Core services (real implementations)
|
|
97
|
+
*
|
|
98
|
+
* | Service | Package | Description |
|
|
99
|
+
* |--------------|-----------------------------------|-------------------------------------------|
|
|
100
|
+
* | ObjectQL | `@objectstack/objectql` | Data engine (query, CRUD, hooks) |
|
|
101
|
+
* | Driver | `@objectstack/driver-memory` | In-memory database (no DB install) |
|
|
102
|
+
* | Auth | `@objectstack/plugin-auth` | Authentication with dev credentials |
|
|
103
|
+
* | Security | `@objectstack/plugin-security` | RBAC, RLS, field-level masking |
|
|
104
|
+
* | HTTP Server | `@objectstack/plugin-hono-server` | HTTP server on configured port |
|
|
105
|
+
* | REST API | `@objectstack/rest` | Auto-generated CRUD + metadata endpoints |
|
|
106
|
+
* | Dispatcher | `@objectstack/runtime` | Auth, GraphQL, analytics, packages, etc. |
|
|
107
|
+
* | App/Metadata | `@objectstack/runtime` | Project metadata (objects, views, apps) |
|
|
108
|
+
*
|
|
109
|
+
* ## Stub services (contract-compliant in-memory implementations)
|
|
110
|
+
*
|
|
111
|
+
* Any core service not provided by a real plugin is automatically registered
|
|
112
|
+
* as a contract-compliant dev stub that implements the interface from
|
|
113
|
+
* `packages/spec/src/contracts/`. Each stub returns correct types:
|
|
114
|
+
*
|
|
115
|
+
* `cache` (Map-backed), `queue` (in-memory pub/sub), `job` (no-op scheduler),
|
|
116
|
+
* `file-storage` (Map-backed), `search` (in-memory text search),
|
|
117
|
+
* `automation` (no-op flows), `graphql` (placeholder), `analytics` (empty results),
|
|
118
|
+
* `realtime` (in-memory pub/sub), `notification` (log), `ai` (placeholder),
|
|
119
|
+
* `i18n` (Map-backed translations), `ui` (Map-backed views/dashboards),
|
|
120
|
+
* `workflow` (Map-backed state machine)
|
|
121
|
+
*
|
|
122
|
+
* All services can be individually disabled via `options.services`.
|
|
123
|
+
* Peer packages are loaded via dynamic import and silently skipped if missing.
|
|
124
|
+
*/
|
|
125
|
+
declare class DevPlugin implements Plugin {
|
|
126
|
+
name: string;
|
|
127
|
+
type: string;
|
|
128
|
+
version: string;
|
|
129
|
+
private options;
|
|
130
|
+
private childPlugins;
|
|
131
|
+
constructor(options?: DevPluginOptions);
|
|
132
|
+
/**
|
|
133
|
+
* Init Phase
|
|
134
|
+
*
|
|
135
|
+
* Dynamically imports and instantiates all core plugins.
|
|
136
|
+
* Uses dynamic imports so that peer dependencies remain optional —
|
|
137
|
+
* if a package isn't installed the service is silently skipped.
|
|
138
|
+
*/
|
|
139
|
+
init(ctx: PluginContext): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Start Phase
|
|
142
|
+
*
|
|
143
|
+
* Starts all child plugins and optionally seeds the dev admin user.
|
|
144
|
+
*/
|
|
145
|
+
start(ctx: PluginContext): Promise<void>;
|
|
146
|
+
/**
|
|
147
|
+
* Destroy Phase
|
|
148
|
+
*
|
|
149
|
+
* Cleans up all child plugins in reverse order.
|
|
150
|
+
*/
|
|
151
|
+
destroy(): Promise<void>;
|
|
152
|
+
/**
|
|
153
|
+
* Seed a default admin user for development.
|
|
154
|
+
*/
|
|
155
|
+
private seedAdmin;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export { DevPlugin, type DevPluginOptions };
|