@newhomestar/sdk 0.4.6 → 0.4.7
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/dist/index.d.ts +66 -14
- package/dist/index.js +211 -36
- package/dist/parseSpec.d.ts +76 -0
- package/dist/parseSpec.js +101 -0
- package/dist/workerSchema.d.ts +46 -0
- package/dist/workerSchema.js +38 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,18 @@
|
|
|
1
|
-
import { z, ZodTypeAny } from "zod";
|
|
1
|
+
import { z, type ZodTypeAny } from "zod";
|
|
2
|
+
import type { IncomingMessage, ServerResponse } from "node:http";
|
|
2
3
|
export interface ActionDef<I extends ZodTypeAny, O extends ZodTypeAny> {
|
|
3
4
|
name: string;
|
|
4
5
|
input: I;
|
|
5
6
|
output: O;
|
|
6
7
|
handler: (input: z.infer<I>, ctx: ActionCtx) => Promise<z.infer<O>>;
|
|
8
|
+
fga?: {
|
|
9
|
+
resourceType: string;
|
|
10
|
+
relation: string;
|
|
11
|
+
resourceIdKey?: string;
|
|
12
|
+
policy?: string;
|
|
13
|
+
};
|
|
14
|
+
method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
15
|
+
path?: string;
|
|
7
16
|
}
|
|
8
17
|
export interface ActionCtx {
|
|
9
18
|
jobId: string;
|
|
@@ -13,28 +22,71 @@ export declare function action<I extends ZodTypeAny, O extends ZodTypeAny>(cfg:
|
|
|
13
22
|
name?: string;
|
|
14
23
|
input: I;
|
|
15
24
|
output: O;
|
|
25
|
+
fga?: {
|
|
26
|
+
resourceType: string;
|
|
27
|
+
relation: string;
|
|
28
|
+
resourceIdKey?: string;
|
|
29
|
+
policy?: string;
|
|
30
|
+
};
|
|
31
|
+
method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
32
|
+
path?: string;
|
|
16
33
|
handler: (input: z.infer<I>, ctx: ActionCtx) => Promise<z.infer<O>>;
|
|
17
34
|
}): ActionDef<I, O>;
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
}
|
|
35
|
+
import type { NovaSpec } from './parseSpec.js';
|
|
36
|
+
/**
|
|
37
|
+
* FGA policy hints embedded in nova.yaml
|
|
38
|
+
*/
|
|
39
|
+
export type FgaSpec = NovaSpec['fga'];
|
|
40
|
+
import { type WorkerDef } from './workerSchema.js';
|
|
41
|
+
/**
|
|
42
|
+
* Register a worker definition - SAME API as before
|
|
43
|
+
*/
|
|
28
44
|
export declare function defineWorker<T extends WorkerDef>(def: T): T;
|
|
29
45
|
/** Enqueue an async action and receive `{ job_id }` */
|
|
30
46
|
export declare function enqueue<P extends object>(actionPath: `${string}.${string}`, payload: P): Promise<{
|
|
31
47
|
job_id: string;
|
|
32
48
|
}>;
|
|
49
|
+
/**
|
|
50
|
+
* Create an oRPC router from a WorkerDef, mapping each action to an oRPC procedure
|
|
51
|
+
*/
|
|
52
|
+
export declare function createORPCRouter<T extends WorkerDef>(def: T): Record<string, any>;
|
|
53
|
+
export interface ORPCServerOptions {
|
|
54
|
+
port?: number;
|
|
55
|
+
plugins?: any[];
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Run an official oRPC server - fully compliant with oRPC standards!
|
|
59
|
+
*/
|
|
60
|
+
export declare function runORPCServer<T extends WorkerDef>(def: T, options?: ORPCServerOptions): import("http").Server<typeof IncomingMessage, typeof ServerResponse>;
|
|
33
61
|
export declare function runWorker(def: WorkerDef): Promise<void>;
|
|
34
|
-
export
|
|
62
|
+
export declare function generateOpenAPISpec<T extends WorkerDef>(def: T): Promise<{
|
|
63
|
+
openapi: string;
|
|
64
|
+
info: {
|
|
65
|
+
title: string;
|
|
66
|
+
version: string;
|
|
67
|
+
description: string;
|
|
68
|
+
};
|
|
69
|
+
paths: any;
|
|
70
|
+
}>;
|
|
35
71
|
/**
|
|
36
|
-
*
|
|
72
|
+
* Enhanced HTTP server exposing each action under configurable routes
|
|
37
73
|
*/
|
|
38
|
-
export declare function runHttpServer(def:
|
|
74
|
+
export declare function runHttpServer<T extends WorkerDef>(def: T, opts?: {
|
|
39
75
|
port?: number;
|
|
40
76
|
}): void;
|
|
77
|
+
export type { ZodTypeAny as SchemaAny, ZodTypeAny };
|
|
78
|
+
export { parseNovaSpec } from "./parseSpec.js";
|
|
79
|
+
export type { NovaSpec } from "./parseSpec.js";
|
|
80
|
+
import { parseNovaSpec as parseNovaSpecFunction } from "./parseSpec.js";
|
|
81
|
+
declare const _default: {
|
|
82
|
+
defineWorker: typeof defineWorker;
|
|
83
|
+
action: typeof action;
|
|
84
|
+
enqueue: typeof enqueue;
|
|
85
|
+
runHttpServer: typeof runHttpServer;
|
|
86
|
+
runORPCServer: typeof runORPCServer;
|
|
87
|
+
runWorker: typeof runWorker;
|
|
88
|
+
generateOpenAPISpec: typeof generateOpenAPISpec;
|
|
89
|
+
createORPCRouter: typeof createORPCRouter;
|
|
90
|
+
parseNovaSpec: typeof parseNovaSpecFunction;
|
|
91
|
+
};
|
|
92
|
+
export default _default;
|
package/dist/index.js
CHANGED
|
@@ -1,37 +1,44 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
};
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
exports.runWorker = runWorker;
|
|
10
|
-
exports.runHttpServer = runHttpServer;
|
|
11
|
-
const dotenv_1 = __importDefault(require("dotenv"));
|
|
12
|
-
const supabase_js_1 = require("@supabase/supabase-js");
|
|
1
|
+
import dotenv from "dotenv";
|
|
2
|
+
import { createClient } from "@supabase/supabase-js";
|
|
3
|
+
import { OpenFgaClient } from "@openfga/sdk";
|
|
4
|
+
import { createServer } from "node:http";
|
|
5
|
+
// Full oRPC imports now working with ESM
|
|
6
|
+
import { os } from "@orpc/server";
|
|
7
|
+
import { RPCHandler } from "@orpc/server/node";
|
|
8
|
+
import { CORSPlugin } from "@orpc/server/plugins";
|
|
13
9
|
if (!process.env.RUNTIME_SUPABASE_URL) {
|
|
14
10
|
// local dev – read .env.local
|
|
15
|
-
|
|
11
|
+
dotenv.config({ path: ".env.local", override: true });
|
|
16
12
|
}
|
|
17
|
-
function action(cfg) {
|
|
18
|
-
return {
|
|
13
|
+
export function action(cfg) {
|
|
14
|
+
return {
|
|
15
|
+
name: cfg.name ?? "unnamed",
|
|
16
|
+
method: cfg.method ?? 'POST',
|
|
17
|
+
path: cfg.path,
|
|
18
|
+
...cfg
|
|
19
|
+
};
|
|
19
20
|
}
|
|
20
|
-
|
|
21
|
-
|
|
21
|
+
// WorkerDef represents the code-level definition passed into defineWorker()
|
|
22
|
+
import { WorkerDefSchema } from './workerSchema.js';
|
|
23
|
+
/**
|
|
24
|
+
* Register a worker definition - SAME API as before
|
|
25
|
+
*/
|
|
26
|
+
export function defineWorker(def) {
|
|
27
|
+
// Runtime validation of the worker definition
|
|
28
|
+
WorkerDefSchema.parse(def);
|
|
29
|
+
return def;
|
|
22
30
|
}
|
|
23
|
-
/*──────────────────────* Client‑side enqueue() *──────────────────*/
|
|
24
|
-
// CLIENT_SUPABASE_… vars exist in gateways / other services
|
|
31
|
+
/*──────────────────────* Client‑side enqueue() (UNCHANGED) *──────────────────*/
|
|
25
32
|
const CLIENT_SUPABASE_URL = process.env.CLIENT_SUPABASE_PUBLIC_URL;
|
|
26
33
|
const CLIENT_SUPABASE_KEY = process.env.CLIENT_SUPABASE_SERVICE_ROLE_KEY;
|
|
27
34
|
let clientSupabase;
|
|
28
35
|
function getClient() {
|
|
29
36
|
if (!CLIENT_SUPABASE_URL || !CLIENT_SUPABASE_KEY)
|
|
30
37
|
throw new Error("CLIENT_SUPABASE_* env vars not set");
|
|
31
|
-
return (clientSupabase
|
|
38
|
+
return (clientSupabase ??= createClient(CLIENT_SUPABASE_URL, CLIENT_SUPABASE_KEY));
|
|
32
39
|
}
|
|
33
40
|
/** Enqueue an async action and receive `{ job_id }` */
|
|
34
|
-
async function enqueue(actionPath, payload) {
|
|
41
|
+
export async function enqueue(actionPath, payload) {
|
|
35
42
|
const [pipeline, action] = actionPath.split(".");
|
|
36
43
|
const { data, error } = await getClient().rpc("nova_enqueue", {
|
|
37
44
|
pipeline_name: pipeline,
|
|
@@ -42,13 +49,70 @@ async function enqueue(actionPath, payload) {
|
|
|
42
49
|
throw error;
|
|
43
50
|
return data;
|
|
44
51
|
}
|
|
45
|
-
/*────────────────
|
|
52
|
+
/*──────────────── Full oRPC Integration (NOW WORKING!) ───────────────*/
|
|
53
|
+
/**
|
|
54
|
+
* Create an oRPC router from a WorkerDef, mapping each action to an oRPC procedure
|
|
55
|
+
*/
|
|
56
|
+
export function createORPCRouter(def) {
|
|
57
|
+
const procedures = {};
|
|
58
|
+
for (const [actionName, actionDef] of Object.entries(def.actions)) {
|
|
59
|
+
// Create oRPC procedure - convert Nova action to oRPC procedure
|
|
60
|
+
const procedure = os
|
|
61
|
+
.input(actionDef.input)
|
|
62
|
+
.output(actionDef.output)
|
|
63
|
+
.handler(async ({ input, context }) => {
|
|
64
|
+
const ctx = {
|
|
65
|
+
jobId: context?.jobId || `orpc-${Date.now()}`,
|
|
66
|
+
progress: (percent, meta) => {
|
|
67
|
+
console.log(`[${actionName}] Progress: ${percent}%`, meta);
|
|
68
|
+
}
|
|
69
|
+
};
|
|
70
|
+
return await actionDef.handler(input, ctx);
|
|
71
|
+
})
|
|
72
|
+
.callable(); // Make the procedure callable like a regular function
|
|
73
|
+
procedures[actionName] = procedure;
|
|
74
|
+
}
|
|
75
|
+
return procedures;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Run an official oRPC server - fully compliant with oRPC standards!
|
|
79
|
+
*/
|
|
80
|
+
export function runORPCServer(def, options = {}) {
|
|
81
|
+
const router = createORPCRouter(def);
|
|
82
|
+
console.log(`[nova] Starting official oRPC server "${def.name}"`);
|
|
83
|
+
// Use official oRPC serving pattern
|
|
84
|
+
const handler = new RPCHandler(router, {
|
|
85
|
+
plugins: [new CORSPlugin(), ...(options.plugins || [])]
|
|
86
|
+
});
|
|
87
|
+
const server = createServer(async (req, res) => {
|
|
88
|
+
const result = await handler.handle(req, res, {
|
|
89
|
+
context: {
|
|
90
|
+
headers: req.headers,
|
|
91
|
+
jobId: `orpc-${Date.now()}`,
|
|
92
|
+
// Add any other Nova-specific context
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
if (!result.matched) {
|
|
96
|
+
res.statusCode = 404;
|
|
97
|
+
res.end('No procedure matched');
|
|
98
|
+
}
|
|
99
|
+
});
|
|
100
|
+
const port = options.port ?? (process.env.PORT ? parseInt(process.env.PORT) : 8000);
|
|
101
|
+
server.listen(port, () => {
|
|
102
|
+
console.log(`[nova] Official oRPC server listening on http://localhost:${port}`);
|
|
103
|
+
console.log(`[nova] Available procedures: ${Object.keys(def.actions).join(', ')}`);
|
|
104
|
+
console.log(`[nova] 🔥 RPC protocol: ACTIVE (not HTTP fallback)`);
|
|
105
|
+
console.log(`[nova] 🌐 CORS: Enabled via CORSPlugin`);
|
|
106
|
+
});
|
|
107
|
+
return server;
|
|
108
|
+
}
|
|
109
|
+
/*──────────────── Runtime harness (Supabase RPC) - UNCHANGED ───────────────*/
|
|
46
110
|
const RUNTIME_SUPABASE_URL = process.env.RUNTIME_SUPABASE_URL;
|
|
47
111
|
const RUNTIME_SUPABASE_KEY = process.env.RUNTIME_SUPABASE_SERVICE_ROLE_KEY;
|
|
48
112
|
const runtime = RUNTIME_SUPABASE_URL && RUNTIME_SUPABASE_KEY
|
|
49
|
-
?
|
|
113
|
+
? createClient(RUNTIME_SUPABASE_URL, RUNTIME_SUPABASE_KEY)
|
|
50
114
|
: undefined;
|
|
51
|
-
async function runWorker(def) {
|
|
115
|
+
export async function runWorker(def) {
|
|
52
116
|
if (!runtime)
|
|
53
117
|
throw new Error("RUNTIME_SUPABASE_* env vars not configured");
|
|
54
118
|
console.log(`[nova] worker '${def.name}' polling ${def.queue}`);
|
|
@@ -77,6 +141,47 @@ async function runWorker(def) {
|
|
|
77
141
|
await nack(msg.msg_id, def.queue);
|
|
78
142
|
continue;
|
|
79
143
|
}
|
|
144
|
+
// FGA enforcement (unchanged from original)
|
|
145
|
+
const hints = act.fga ? (Array.isArray(act.fga) ? act.fga : [act.fga]) : [];
|
|
146
|
+
if (hints.length) {
|
|
147
|
+
const apiEndpoint = process.env.OPENFGA_API_ENDPOINT;
|
|
148
|
+
const storeId = process.env.OPENFGA_STORE_ID;
|
|
149
|
+
const authToken = process.env.OPENFGA_AUTH_TOKEN;
|
|
150
|
+
if (!apiEndpoint || !storeId || !authToken) {
|
|
151
|
+
throw new Error('Missing OPENFGA_API_ENDPOINT, OPENFGA_STORE_ID, or OPENFGA_AUTH_TOKEN for FGA enforcement');
|
|
152
|
+
}
|
|
153
|
+
const fgaClient = new OpenFgaClient({ apiUrl: apiEndpoint, storeId });
|
|
154
|
+
let authorized = true;
|
|
155
|
+
for (const hint of hints) {
|
|
156
|
+
const key = hint.resourceIdKey;
|
|
157
|
+
if (!key) {
|
|
158
|
+
throw new Error(`Missing resourceIdKey for FGA hint on action '${actName}'`);
|
|
159
|
+
}
|
|
160
|
+
const id = payload[key];
|
|
161
|
+
if (!id) {
|
|
162
|
+
throw new Error(`Payload field '${key}' required for FGA hint on action '${actName}'`);
|
|
163
|
+
}
|
|
164
|
+
const tupleKey = {
|
|
165
|
+
user: `user:${user_id}`,
|
|
166
|
+
relation: hint.relation,
|
|
167
|
+
object: `${hint.resourceType}:${id}`
|
|
168
|
+
};
|
|
169
|
+
const result = await fgaClient.check({
|
|
170
|
+
user: tupleKey.user,
|
|
171
|
+
relation: tupleKey.relation,
|
|
172
|
+
object: tupleKey.object
|
|
173
|
+
});
|
|
174
|
+
if (!result.allowed) {
|
|
175
|
+
authorized = false;
|
|
176
|
+
break;
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
if (!authorized) {
|
|
180
|
+
await runtime.from("jobs").update({ status: "failed", error: "Unauthorized" }).eq("id", jobId);
|
|
181
|
+
await ack(msg.msg_id, def.queue);
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
80
185
|
try {
|
|
81
186
|
const parsedInput = act.input.parse(payload);
|
|
82
187
|
const ctx = {
|
|
@@ -103,20 +208,64 @@ async function nack(id, q) {
|
|
|
103
208
|
await runtime.schema("pgmq_public").rpc("nack", { queue_name: q, message_id: id });
|
|
104
209
|
}
|
|
105
210
|
function delay(ms) { return new Promise(r => setTimeout(r, ms)); }
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
211
|
+
/*──────────────── NEW: OpenAPI Spec Generation ───────────────*/
|
|
212
|
+
export async function generateOpenAPISpec(def) {
|
|
213
|
+
// This would use oRPC's built-in OpenAPI generation
|
|
214
|
+
// For now, return a basic spec structure
|
|
215
|
+
return {
|
|
216
|
+
openapi: "3.0.0",
|
|
217
|
+
info: {
|
|
218
|
+
title: `${def.name} API`,
|
|
219
|
+
version: "1.0.0",
|
|
220
|
+
description: `OpenAPI specification for Nova worker: ${def.name}`
|
|
221
|
+
},
|
|
222
|
+
paths: Object.entries(def.actions).reduce((paths, [actionName, actionDef]) => {
|
|
223
|
+
const method = (actionDef.method || 'POST').toLowerCase();
|
|
224
|
+
const path = actionDef.path || `/${actionName}`;
|
|
225
|
+
paths[path] = {
|
|
226
|
+
[method]: {
|
|
227
|
+
operationId: actionName,
|
|
228
|
+
summary: `Execute ${actionName} action`,
|
|
229
|
+
requestBody: {
|
|
230
|
+
content: {
|
|
231
|
+
'application/json': {
|
|
232
|
+
schema: { type: 'object' } // Would be generated from Zod schema
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
responses: {
|
|
237
|
+
'200': {
|
|
238
|
+
description: 'Success',
|
|
239
|
+
content: {
|
|
240
|
+
'application/json': {
|
|
241
|
+
schema: { type: 'object' } // Would be generated from Zod schema
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
};
|
|
248
|
+
return paths;
|
|
249
|
+
}, {})
|
|
250
|
+
};
|
|
251
|
+
}
|
|
252
|
+
/*──────────────── HTTP Server Harness (Enhanced) ───────────────*/
|
|
253
|
+
import express from "express";
|
|
254
|
+
import bodyParser from "body-parser";
|
|
109
255
|
/**
|
|
110
|
-
*
|
|
256
|
+
* Enhanced HTTP server exposing each action under configurable routes
|
|
111
257
|
*/
|
|
112
|
-
function runHttpServer(def, opts = {}) {
|
|
113
|
-
const app = (
|
|
114
|
-
app.use(
|
|
258
|
+
export function runHttpServer(def, opts = {}) {
|
|
259
|
+
const app = express();
|
|
260
|
+
app.use(bodyParser.json());
|
|
115
261
|
for (const [actionName, act] of Object.entries(def.actions)) {
|
|
116
|
-
const
|
|
117
|
-
|
|
262
|
+
const method = (act.method || 'POST').toLowerCase();
|
|
263
|
+
const route = act.path || `/${def.name}/${actionName}`;
|
|
264
|
+
// unified handler: parse JSON body or default to empty object
|
|
265
|
+
const handler = async (req, res) => {
|
|
118
266
|
try {
|
|
119
|
-
const
|
|
267
|
+
const payload = req.body && typeof req.body === 'object' ? req.body : {};
|
|
268
|
+
const input = act.input.parse(payload);
|
|
120
269
|
const ctx = { jobId: `http-${Date.now()}`, progress: () => { } };
|
|
121
270
|
const out = await act.handler(input, ctx);
|
|
122
271
|
act.output.parse(out);
|
|
@@ -125,10 +274,36 @@ function runHttpServer(def, opts = {}) {
|
|
|
125
274
|
catch (err) {
|
|
126
275
|
res.status(400).json({ error: err.message });
|
|
127
276
|
}
|
|
128
|
-
}
|
|
277
|
+
};
|
|
278
|
+
// Register route with specified HTTP method
|
|
279
|
+
app[method](route, handler);
|
|
280
|
+
// Special case: expose health checks under GET /health for liveness checks
|
|
281
|
+
if (actionName === 'health' && method !== 'get') {
|
|
282
|
+
app.get('/health', handler);
|
|
283
|
+
}
|
|
129
284
|
}
|
|
130
|
-
const port = opts.port ?? (process.env.PORT ? parseInt(process.env.PORT) :
|
|
285
|
+
const port = opts.port ?? (process.env.PORT ? parseInt(process.env.PORT) : 8000);
|
|
131
286
|
app.listen(port, () => {
|
|
132
287
|
console.log(`[nova] HTTP server listening on http://localhost:${port}`);
|
|
288
|
+
Object.entries(def.actions).forEach(([actionName, actionDef]) => {
|
|
289
|
+
const method = (actionDef.method || 'POST').toUpperCase();
|
|
290
|
+
const path = actionDef.path || `/${def.name}/${actionName}`;
|
|
291
|
+
console.log(`[nova] ${method} ${path} -> ${actionName}`);
|
|
292
|
+
});
|
|
133
293
|
});
|
|
134
294
|
}
|
|
295
|
+
// YAML spec parsing utility
|
|
296
|
+
export { parseNovaSpec } from "./parseSpec.js";
|
|
297
|
+
// Default export for compatibility
|
|
298
|
+
import { parseNovaSpec as parseNovaSpecFunction } from "./parseSpec.js";
|
|
299
|
+
export default {
|
|
300
|
+
defineWorker,
|
|
301
|
+
action,
|
|
302
|
+
enqueue,
|
|
303
|
+
runHttpServer,
|
|
304
|
+
runORPCServer,
|
|
305
|
+
runWorker,
|
|
306
|
+
generateOpenAPISpec,
|
|
307
|
+
createORPCRouter,
|
|
308
|
+
parseNovaSpec: parseNovaSpecFunction
|
|
309
|
+
};
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
export declare const NovaSpecSchema: z.ZodObject<{
|
|
3
|
+
apiVersion: z.ZodString;
|
|
4
|
+
kind: z.ZodString;
|
|
5
|
+
metadata: z.ZodObject<{
|
|
6
|
+
name: z.ZodString;
|
|
7
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
8
|
+
description: z.ZodOptional<z.ZodString>;
|
|
9
|
+
icon: z.ZodOptional<z.ZodString>;
|
|
10
|
+
tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
11
|
+
}, z.core.$strip>;
|
|
12
|
+
spec: z.ZodObject<{
|
|
13
|
+
runtime: z.ZodObject<{
|
|
14
|
+
type: z.ZodString;
|
|
15
|
+
image: z.ZodString;
|
|
16
|
+
resources: z.ZodObject<{
|
|
17
|
+
cpu: z.ZodString;
|
|
18
|
+
memory: z.ZodString;
|
|
19
|
+
}, z.core.$strip>;
|
|
20
|
+
command: z.ZodArray<z.ZodString>;
|
|
21
|
+
queue: z.ZodString;
|
|
22
|
+
port: z.ZodNumber;
|
|
23
|
+
envSpec: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
24
|
+
name: z.ZodString;
|
|
25
|
+
value: z.ZodOptional<z.ZodString>;
|
|
26
|
+
secret: z.ZodOptional<z.ZodBoolean>;
|
|
27
|
+
default: z.ZodOptional<z.ZodString>;
|
|
28
|
+
}, z.core.$strip>>>;
|
|
29
|
+
}, z.core.$strip>;
|
|
30
|
+
actions: z.ZodArray<z.ZodObject<{
|
|
31
|
+
name: z.ZodString;
|
|
32
|
+
displayName: z.ZodOptional<z.ZodString>;
|
|
33
|
+
description: z.ZodOptional<z.ZodString>;
|
|
34
|
+
icon: z.ZodOptional<z.ZodString>;
|
|
35
|
+
async: z.ZodOptional<z.ZodBoolean>;
|
|
36
|
+
input: z.ZodOptional<z.ZodUnknown>;
|
|
37
|
+
output: z.ZodOptional<z.ZodUnknown>;
|
|
38
|
+
schema: z.ZodOptional<z.ZodObject<{
|
|
39
|
+
input: z.ZodString;
|
|
40
|
+
output: z.ZodString;
|
|
41
|
+
}, z.core.$strip>>;
|
|
42
|
+
fga: z.ZodOptional<z.ZodObject<{
|
|
43
|
+
resourceType: z.ZodString;
|
|
44
|
+
relation: z.ZodString;
|
|
45
|
+
}, z.core.$strip>>;
|
|
46
|
+
}, z.core.$strip>>;
|
|
47
|
+
}, z.core.$strip>;
|
|
48
|
+
build: z.ZodOptional<z.ZodObject<{
|
|
49
|
+
dockerfile: z.ZodString;
|
|
50
|
+
context: z.ZodString;
|
|
51
|
+
}, z.core.$strip>>;
|
|
52
|
+
ui: z.ZodOptional<z.ZodObject<{
|
|
53
|
+
category: z.ZodOptional<z.ZodString>;
|
|
54
|
+
color: z.ZodOptional<z.ZodString>;
|
|
55
|
+
}, z.core.$strip>>;
|
|
56
|
+
fga: z.ZodOptional<z.ZodObject<{
|
|
57
|
+
types: z.ZodArray<z.ZodObject<{
|
|
58
|
+
name: z.ZodString;
|
|
59
|
+
relations: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodObject<{
|
|
60
|
+
computedUserset: z.ZodObject<{
|
|
61
|
+
object: z.ZodString;
|
|
62
|
+
relation: z.ZodString;
|
|
63
|
+
}, z.core.$strip>;
|
|
64
|
+
}, z.core.$strip>]>>;
|
|
65
|
+
}, z.core.$strip>>;
|
|
66
|
+
}, z.core.$strip>>;
|
|
67
|
+
}, z.core.$strict>;
|
|
68
|
+
export type NovaSpec = z.infer<typeof NovaSpecSchema>;
|
|
69
|
+
/**
|
|
70
|
+
* Parse nova.yaml content and validate against the NovaSpec schema.
|
|
71
|
+
* Unknown fields are stripped; missing required fields throw an error.
|
|
72
|
+
* @param yamlContent String contents of a nova.yaml specification
|
|
73
|
+
* @returns Parsed NovaSpec object
|
|
74
|
+
* @throws Error with validation details if parsing or validation fail
|
|
75
|
+
*/
|
|
76
|
+
export declare function parseNovaSpec(yamlContent: string): NovaSpec;
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { parse as parseYAML } from "yaml";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
// Zod schema for nova.yaml
|
|
4
|
+
export const NovaSpecSchema = z.object({
|
|
5
|
+
apiVersion: z.string(),
|
|
6
|
+
kind: z.string(),
|
|
7
|
+
metadata: z.object({
|
|
8
|
+
name: z.string(),
|
|
9
|
+
displayName: z.string().optional(),
|
|
10
|
+
description: z.string().optional(),
|
|
11
|
+
icon: z.string().optional(),
|
|
12
|
+
tags: z.array(z.string()).optional(),
|
|
13
|
+
}),
|
|
14
|
+
spec: z.object({
|
|
15
|
+
runtime: z.object({
|
|
16
|
+
type: z.string(),
|
|
17
|
+
image: z.string(),
|
|
18
|
+
resources: z.object({
|
|
19
|
+
cpu: z.string(),
|
|
20
|
+
memory: z.string(),
|
|
21
|
+
}),
|
|
22
|
+
command: z.array(z.string()),
|
|
23
|
+
queue: z.string(),
|
|
24
|
+
port: z.number(),
|
|
25
|
+
envSpec: z.array(z.object({
|
|
26
|
+
name: z.string(),
|
|
27
|
+
value: z.string().optional(),
|
|
28
|
+
secret: z.boolean().optional(),
|
|
29
|
+
default: z.string().optional(),
|
|
30
|
+
})).optional(),
|
|
31
|
+
}),
|
|
32
|
+
actions: z.array(z.object({
|
|
33
|
+
name: z.string(),
|
|
34
|
+
displayName: z.string().optional(),
|
|
35
|
+
description: z.string().optional(),
|
|
36
|
+
icon: z.string().optional(),
|
|
37
|
+
async: z.boolean().optional(),
|
|
38
|
+
input: z.unknown().optional(), // JSON schema object
|
|
39
|
+
output: z.unknown().optional(), // JSON schema object
|
|
40
|
+
schema: z.object({
|
|
41
|
+
input: z.string(),
|
|
42
|
+
output: z.string(),
|
|
43
|
+
}).optional(),
|
|
44
|
+
fga: z.object({
|
|
45
|
+
resourceType: z.string(),
|
|
46
|
+
relation: z.string(),
|
|
47
|
+
}).optional(),
|
|
48
|
+
})),
|
|
49
|
+
}),
|
|
50
|
+
build: z.object({
|
|
51
|
+
dockerfile: z.string(),
|
|
52
|
+
context: z.string(),
|
|
53
|
+
}).optional(),
|
|
54
|
+
ui: z.object({
|
|
55
|
+
category: z.string().optional(),
|
|
56
|
+
color: z.string().optional(),
|
|
57
|
+
}).optional(),
|
|
58
|
+
// OpenFGA policy hints embedded in nova.yaml
|
|
59
|
+
fga: z.object({
|
|
60
|
+
types: z.array(z.object({
|
|
61
|
+
name: z.string(),
|
|
62
|
+
relations: z.record(z.string(), z.union([
|
|
63
|
+
z.array(z.string()),
|
|
64
|
+
z.object({
|
|
65
|
+
computedUserset: z.object({
|
|
66
|
+
object: z.string(),
|
|
67
|
+
relation: z.string(),
|
|
68
|
+
}),
|
|
69
|
+
}),
|
|
70
|
+
])),
|
|
71
|
+
})),
|
|
72
|
+
}).optional(),
|
|
73
|
+
}).strict();
|
|
74
|
+
/**
|
|
75
|
+
* Parse nova.yaml content and validate against the NovaSpec schema.
|
|
76
|
+
* Unknown fields are stripped; missing required fields throw an error.
|
|
77
|
+
* @param yamlContent String contents of a nova.yaml specification
|
|
78
|
+
* @returns Parsed NovaSpec object
|
|
79
|
+
* @throws Error with validation details if parsing or validation fail
|
|
80
|
+
*/
|
|
81
|
+
export function parseNovaSpec(yamlContent) {
|
|
82
|
+
let parsed;
|
|
83
|
+
try {
|
|
84
|
+
parsed = parseYAML(yamlContent);
|
|
85
|
+
}
|
|
86
|
+
catch (e) {
|
|
87
|
+
throw new Error(`Failed to parse YAML content: ${e.message}`);
|
|
88
|
+
}
|
|
89
|
+
try {
|
|
90
|
+
return NovaSpecSchema.parse(parsed);
|
|
91
|
+
}
|
|
92
|
+
catch (e) {
|
|
93
|
+
if (e instanceof z.ZodError) {
|
|
94
|
+
const details = e.issues
|
|
95
|
+
.map((issue) => `Path '${issue.path.join(".")}': ${issue.message}`)
|
|
96
|
+
.join("; ");
|
|
97
|
+
throw new Error(`nova.yaml validation error(s): ${details}`);
|
|
98
|
+
}
|
|
99
|
+
throw e;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Schema for code-level defineWorker() argument.
|
|
4
|
+
* This enforces worker metadata, actions, envSpec, and optional FGA hints.
|
|
5
|
+
*/
|
|
6
|
+
export declare const WorkerDefSchema: z.ZodObject<{
|
|
7
|
+
name: z.ZodString;
|
|
8
|
+
queue: z.ZodString;
|
|
9
|
+
envSpec: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
10
|
+
name: z.ZodString;
|
|
11
|
+
secret: z.ZodBoolean;
|
|
12
|
+
default: z.ZodOptional<z.ZodString>;
|
|
13
|
+
}, z.core.$strip>>>;
|
|
14
|
+
fga: z.ZodOptional<z.ZodObject<{
|
|
15
|
+
types: z.ZodArray<z.ZodObject<{
|
|
16
|
+
name: z.ZodString;
|
|
17
|
+
relations: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodObject<{
|
|
18
|
+
computedUserset: z.ZodObject<{
|
|
19
|
+
object: z.ZodString;
|
|
20
|
+
relation: z.ZodString;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
}, z.core.$strip>]>>;
|
|
23
|
+
}, z.core.$strip>>;
|
|
24
|
+
}, z.core.$strip>>;
|
|
25
|
+
actions: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
26
|
+
name: z.ZodOptional<z.ZodString>;
|
|
27
|
+
input: z.ZodAny;
|
|
28
|
+
output: z.ZodAny;
|
|
29
|
+
method: z.ZodOptional<z.ZodEnum<{
|
|
30
|
+
GET: "GET";
|
|
31
|
+
POST: "POST";
|
|
32
|
+
PUT: "PUT";
|
|
33
|
+
DELETE: "DELETE";
|
|
34
|
+
PATCH: "PATCH";
|
|
35
|
+
}>>;
|
|
36
|
+
path: z.ZodOptional<z.ZodString>;
|
|
37
|
+
fga: z.ZodOptional<z.ZodObject<{
|
|
38
|
+
resourceType: z.ZodString;
|
|
39
|
+
relation: z.ZodString;
|
|
40
|
+
resourceIdKey: z.ZodOptional<z.ZodString>;
|
|
41
|
+
policy: z.ZodOptional<z.ZodString>;
|
|
42
|
+
}, z.core.$strip>>;
|
|
43
|
+
handler: z.ZodAny;
|
|
44
|
+
}, z.core.$strip>>;
|
|
45
|
+
}, z.core.$strip>;
|
|
46
|
+
export type WorkerDef = z.infer<typeof WorkerDefSchema>;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Schema for code-level defineWorker() argument.
|
|
4
|
+
* This enforces worker metadata, actions, envSpec, and optional FGA hints.
|
|
5
|
+
*/
|
|
6
|
+
export const WorkerDefSchema = z.object({
|
|
7
|
+
name: z.string(),
|
|
8
|
+
queue: z.string(),
|
|
9
|
+
// Optional environment variable spec for nova.yaml generation
|
|
10
|
+
envSpec: z.array(z.object({ name: z.string(), secret: z.boolean(), default: z.string().optional() })).optional(),
|
|
11
|
+
// Optional top-level FGA policy types
|
|
12
|
+
fga: z.object({
|
|
13
|
+
types: z.array(z.object({
|
|
14
|
+
name: z.string(),
|
|
15
|
+
relations: z.record(z.string(), z.union([
|
|
16
|
+
z.array(z.string()),
|
|
17
|
+
z.object({ computedUserset: z.object({ object: z.string(), relation: z.string() }) })
|
|
18
|
+
])),
|
|
19
|
+
}))
|
|
20
|
+
}).optional(),
|
|
21
|
+
// Map of action definitions
|
|
22
|
+
actions: z.record(z.string(), z.object({
|
|
23
|
+
name: z.string().optional(),
|
|
24
|
+
input: z.any(), // Zod schema instance expected
|
|
25
|
+
output: z.any(), // Zod schema instance expected
|
|
26
|
+
// NEW: HTTP routing support for oRPC
|
|
27
|
+
method: z.enum(['GET', 'POST', 'PUT', 'DELETE', 'PATCH']).optional(),
|
|
28
|
+
path: z.string().optional(),
|
|
29
|
+
// Optional per-action OpenFGA hints: resource type, relation, ID key, and optional policy caveat
|
|
30
|
+
fga: z.object({
|
|
31
|
+
resourceType: z.string(),
|
|
32
|
+
relation: z.string(),
|
|
33
|
+
resourceIdKey: z.string().optional(),
|
|
34
|
+
policy: z.string().optional(),
|
|
35
|
+
}).optional(),
|
|
36
|
+
handler: z.any(), // function with signature (input, ctx) => Promise<…>
|
|
37
|
+
})),
|
|
38
|
+
});
|
package/package.json
CHANGED