@jskit-ai/console-web 0.1.1

package/package.descriptor.mjs

@@ -0,0 +1,103 @@
+export default Object.freeze({
+  packageVersion: 1,
+  packageId: "@jskit-ai/console-web",
+  version: "0.1.1",
+  kind: "runtime",
+  description: "Authenticated console surface scaffold and surface policy wiring.",
+  dependsOn: [
+    "@jskit-ai/auth-web",
+    "@jskit-ai/shell-web",
+    "@jskit-ai/users-core"
+  ],
+  capabilities: {
+    provides: [
+      "console.web"
+    ],
+    requires: [
+      "users.core"
+    ]
+  },
+  runtime: {
+    server: {
+      providers: []
+    },
+    client: {
+      providers: []
+    }
+  },
+  metadata: {
+    apiSummary: {
+      surfaces: [
+        {
+          subpath: "./client",
+          summary: "Exports no runtime API today (reserved console surface package entrypoint)."
+        }
+      ],
+      containerTokens: {
+        server: [],
+        client: []
+      }
+    }
+  },
+  mutations: {
+    dependencies: {
+      runtime: {
+        "@jskit-ai/auth-web": "0.1.35",
+        "@jskit-ai/shell-web": "0.1.33",
+        "@jskit-ai/users-core": "0.1.44"
+      },
+      dev: {}
+    },
+    packageJson: {
+      scripts: {
+        "server:console": "SERVER_SURFACE=console node ./bin/server.js",
+        "dev:console": "VITE_SURFACE=console vite",
+        "build:console": "VITE_SURFACE=console vite build"
+      }
+    },
+    procfile: {},
+    files: [
+      {
+        from: "templates/src/pages/console.vue",
+        toSurface: "console",
+        toSurfaceRoot: true,
+        ownership: "app",
+        reason: "Install shell-driven console wrapper page.",
+        category: "console-web",
+        id: "console-web-page-console-wrapper"
+      },
+      {
+        from: "templates/src/pages/console/index.vue",
+        toSurface: "console",
+        toSurfacePath: "index.vue",
+        ownership: "app",
+        reason: "Install shell-driven console page starter.",
+        category: "console-web",
+        id: "console-web-page-console"
+      }
+    ],
+    text: [
+      {
+        op: "append-text",
+        file: "config/surfaceAccessPolicies.js",
+        position: "bottom",
+        skipIfContains: "surfaceAccessPolicies.console_owner = {",
+        value: "\nsurfaceAccessPolicies.console_owner = {\n  requireAuth: true,\n  requireFlagsAll: [\"console_owner\"]\n};\n",
+        reason: "Register console-owner surface access policy for the console surface.",
+        category: "console-web",
+        id: "console-web-surface-access-policies-console-owner"
+      },
+      {
+        op: "append-text",
+        file: "config/public.js",
+        position: "bottom",
+        skipIfContains: "config.surfaceDefinitions.console = {",
+        value:
+          "\nconfig.surfaceDefinitions.console = {\n  id: \"console\",\n  label: \"Console\",\n  pagesRoot: \"console\",\n  enabled: true,\n  requiresAuth: true,\n  requiresWorkspace: false,\n  accessPolicyId: \"console_owner\",\n  origin: \"\"\n};\n",
+        reason: "Register console surface definition once console-web is installed.",
+        category: "console-web",
+        id: "console-web-surface-config-console"
+      }
+    ]
+  }
+});

package/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@jskit-ai/console-web",
+  "version": "0.1.1",
+  "type": "module",
+  "scripts": {
+    "test": "node --test"
+  }
+}

package/templates/src/pages/console/index.vue

@@ -0,0 +1,24 @@
+<template>
+  <v-card rounded="lg" elevation="1" border>
+    <v-card-item>
+      <template #prepend>
+        <v-chip color="primary" size="small" label>Console</v-chip>
+      </template>
+      <v-card-title class="text-h5">Operations Console</v-card-title>
+      <v-card-subtitle>Operator tools, scripts, and diagnostics.</v-card-subtitle>
+    </v-card-item>
+    <v-divider />
+    <v-card-text class="d-flex flex-column ga-4">
+      <div class="d-flex flex-wrap ga-3">
+        <v-chip color="secondary" variant="tonal" label>Route: /console</v-chip>
+        <v-chip color="info" variant="tonal" label>Surface status: enabled</v-chip>
+      </div>
+      <p class="text-medium-emphasis mb-0">
+        Ideal for operator actions, scripts, and technical insights not meant for end users.
+      </p>
+      <div>
+        <v-btn color="primary" variant="flat" to="/home">Back to home</v-btn>
+      </div>
+    </v-card-text>
+  </v-card>
+</template>

package/templates/src/pages/console.vue

@@ -0,0 +1,20 @@
+<route lang="json">
+{
+  "meta": {
+    "jskit": {
+      "surface": "console"
+    }
+  }
+}
+</route>
+
+<script setup>
+import ShellLayout from "@/components/ShellLayout.vue";
+import { RouterView } from "vue-router";
+</script>
+
+<template>
+  <ShellLayout title="" subtitle="">
+    <RouterView />
+  </ShellLayout>
+</template>

package/test/packageDescriptor.test.js

@@ -0,0 +1,67 @@
+import assert from "node:assert/strict";
+import path from "node:path";
+import test from "node:test";
+import { readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import descriptor from "../package.descriptor.mjs";
+
+const TEST_DIRECTORY = path.dirname(fileURLToPath(import.meta.url));
+const PACKAGE_DIR = path.resolve(TEST_DIRECTORY, "..");
+
+function findFileMutation(id) {
+  const files = descriptor?.mutations?.files;
+  return Array.isArray(files)
+    ? files.find((entry) => String(entry?.id || "").trim() === id) || null
+    : null;
+}
+
+function findTextMutation(id) {
+  const text = descriptor?.mutations?.text;
+  return Array.isArray(text)
+    ? text.find((entry) => String(entry?.id || "").trim() === id) || null
+    : null;
+}
+
+test("console-web installs console surface scripts and files", () => {
+  assert.deepEqual(descriptor?.mutations?.packageJson?.scripts, {
+    "server:console": "SERVER_SURFACE=console node ./bin/server.js",
+    "dev:console": "VITE_SURFACE=console vite",
+    "build:console": "VITE_SURFACE=console vite build"
+  });
+  assert.deepEqual(findFileMutation("console-web-page-console-wrapper"), {
+    from: "templates/src/pages/console.vue",
+    toSurface: "console",
+    toSurfaceRoot: true,
+    ownership: "app",
+    reason: "Install shell-driven console wrapper page.",
+    category: "console-web",
+    id: "console-web-page-console-wrapper"
+  });
+  assert.deepEqual(findFileMutation("console-web-page-console"), {
+    from: "templates/src/pages/console/index.vue",
+    toSurface: "console",
+    toSurfacePath: "index.vue",
+    ownership: "app",
+    reason: "Install shell-driven console page starter.",
+    category: "console-web",
+    id: "console-web-page-console"
+  });
+});
+
+test("console-web wires console surface policy into app config", () => {
+  assert.equal(
+    findTextMutation("console-web-surface-access-policies-console-owner")?.file,
+    "config/surfaceAccessPolicies.js"
+  );
+  assert.equal(findTextMutation("console-web-surface-config-console")?.file, "config/public.js");
+  assert.match(findTextMutation("console-web-surface-config-console")?.value || "", /accessPolicyId: "console_owner"/);
+});
+
+test("console-web console templates stay shell-driven", async () => {
+  const wrapperSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console.vue"), "utf8");
+  const indexSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console", "index.vue"), "utf8");
+
+  assert.match(wrapperSource, /ShellLayout/);
+  assert.match(wrapperSource, /"surface": "console"/);
+  assert.match(indexSource, /Operations Console/);
+});