@karmaniverous/jeeves-server-core 0.3.0 → 0.5.0

package/dist/src/catalog/runnerEntries.d.ts

@@ -0,0 +1,145 @@
+/**
+ * The runner proxy entries of the server catalog (Decision 28): the fixed set of jeeves-runner routes the server forwards (the 3.15.0 set, with enable and disable as `PATCH`), each with a fixed path and an opaque response so the runner's answers aren't re-described and strict response validation passes whatever the runner returns. Any other `/api/runner/*` path is no entry, so the server answers it 404 and never forwards it. Pure.
+ *
+ * @packageDocumentation
+ */
+import { z } from 'zod';
+/** The runner proxy entries. */
+export declare const RUNNER_ENTRIES: readonly [{
+    readonly kind: "read";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly name: "runnerListJobs";
+    readonly method: "GET";
+    readonly path: "/api/runner/jobs";
+    readonly description: "List the jeeves-runner jobs (runner GET /jobs).";
+}, {
+    readonly kind: "read";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly params: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly name: "runnerGetJob";
+    readonly method: "GET";
+    readonly path: "/api/runner/jobs/:id";
+    readonly description: "One jeeves-runner job (runner GET /jobs/:id).";
+}, {
+    readonly kind: "read";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly params: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly query: z.ZodObject<{
+        limit: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly name: "runnerListRuns";
+    readonly method: "GET";
+    readonly path: "/api/runner/jobs/:id/runs";
+    readonly description: "A jeeves-runner job's recent runs (runner GET /jobs/:id/runs).";
+}, {
+    readonly kind: "write";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly params: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly name: "runnerRunJob";
+    readonly method: "POST";
+    readonly path: "/api/runner/jobs/:id/run";
+    readonly description: "Run a jeeves-runner job now (runner POST /jobs/:id/run).";
+}, {
+    readonly kind: "write";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly params: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly name: "runnerEnableJob";
+    readonly method: "PATCH";
+    readonly path: "/api/runner/jobs/:id/enable";
+    readonly description: "Enable a jeeves-runner job (runner PATCH /jobs/:id/enable).";
+}, {
+    readonly kind: "write";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly params: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    readonly name: "runnerDisableJob";
+    readonly method: "PATCH";
+    readonly path: "/api/runner/jobs/:id/disable";
+    readonly description: "Disable a jeeves-runner job (runner PATCH /jobs/:id/disable).";
+}, {
+    readonly kind: "read";
+    readonly response: z.ZodUnknown;
+    readonly auth: {
+        readonly schemes: readonly [{
+            readonly in: "query";
+            readonly name: "k";
+        }, {
+            readonly in: "cookie";
+            readonly name: "jeeves_session";
+        }];
+        readonly insiderOnly: true;
+    };
+    readonly name: "runnerStatus";
+    readonly method: "GET";
+    readonly path: "/api/runner/status";
+    readonly description: "jeeves-runner status (runner GET /status).";
+}];

package/dist/src/catalog/runnerEntries.js

@@ -0,0 +1,69 @@
+import { z } from 'zod';
+import { INSIDER_ONLY, route } from './route.js';
+
+/**
+ * The runner proxy entries of the server catalog (Decision 28): the fixed set of jeeves-runner routes the server forwards (the 3.15.0 set, with enable and disable as `PATCH`), each with a fixed path and an opaque response so the runner's answers aren't re-described and strict response validation passes whatever the runner returns. Any other `/api/runner/*` path is no entry, so the server answers it 404 and never forwards it. Pure.
+ *
+ * @packageDocumentation
+ */
+/** `:id`: the runner job; never `.`, `..`, a slash or a control character, so its runner path stays `/jobs/<id>`. */
+const jobParams = z.object({
+    id: z
+        .string()
+        .regex(/^(?!\.{1,2}$)[^/\\\p{Cc}]+$/u)
+        .describe('Runner job ID: not `.` or `..`, no `/` or `\\`, and no control characters.'),
+});
+/** Query of the job runs entry. */
+const runsQuery = z.object({
+    limit: z.string().optional().describe('Maximum number of runs (default 20).'),
+});
+/** Whatever the runner answers. */
+const runnerResponse = z.unknown();
+/** Fields every runner entry shares. */
+const RUNNER = { response: runnerResponse, auth: INSIDER_ONLY };
+/** The runner proxy entries. */
+const RUNNER_ENTRIES = [
+    {
+        ...route('runnerListJobs', 'GET', '/api/runner/jobs'),
+        ...RUNNER,
+        kind: 'read',
+    },
+    {
+        ...route('runnerGetJob', 'GET', '/api/runner/jobs/:id'),
+        params: jobParams,
+        ...RUNNER,
+        kind: 'read',
+    },
+    {
+        ...route('runnerListRuns', 'GET', '/api/runner/jobs/:id/runs'),
+        params: jobParams,
+        query: runsQuery,
+        ...RUNNER,
+        kind: 'read',
+    },
+    {
+        ...route('runnerRunJob', 'POST', '/api/runner/jobs/:id/run'),
+        params: jobParams,
+        ...RUNNER,
+        kind: 'write',
+    },
+    {
+        ...route('runnerEnableJob', 'PATCH', '/api/runner/jobs/:id/enable'),
+        params: jobParams,
+        ...RUNNER,
+        kind: 'write',
+    },
+    {
+        ...route('runnerDisableJob', 'PATCH', '/api/runner/jobs/:id/disable'),
+        params: jobParams,
+        ...RUNNER,
+        kind: 'write',
+    },
+    {
+        ...route('runnerStatus', 'GET', '/api/runner/status'),
+        ...RUNNER,
+        kind: 'read',
+    },
+];
+
+export { RUNNER_ENTRIES };

package/dist/src/catalog/schemas.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Request and response schemas of `SERVER_CATALOG` that carry rules of their own: the `fileMutate` per-action refinement, `receiveEvent` objects only (Decision 14), the opaque runner entries, the `status` health block (Decision 22 and the 3.16.0 additions), `browse` unions and the share query.
+ */
+export {};