@cheezmil/coraek 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,60 @@
-# Temporary Holding Version
+---
+description: "AEK base identity layer — rebrands the dsh web UI sidebar and startup announcement for AEK deployments."
+kind: "package-reference"
+---
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @cheezmil/coraek
+
+The AEK base identity layer. It rebrands two user-visible surfaces of a dsh web
+profile so they read as AEK instead of DeepSeek Harness:
+
+- the **sidebar brand** — fills the `sidebar.brand.mark` and `sidebar.brand.name`
+  slots with the AEK orange-slice mark and the `AEK` name, replacing the shell's
+  fish-mark and `brand.localBuild` fallback;
+- the **startup announcement** — prints the `aek web: <url>` readiness line,
+  replacing the dsh web-app bundle's own `dsh web:` line (which the web profile
+  suppresses with `printUrl: false`).
+
+The document title is rebranded separately through the `DSH_CLIENT_TITLE` build
+environment value, which `AppFrame` already reads. This package has no runtime
+state and does not affect model requests.
+
+## Use this package
+
+Install it into a dsh web profile and register it in the profile's coraek patch:
+
+```yaml
+- id: coraek
+  name: '@cheezmil/coraek'
+```
+
+Suppress the dsh bundle's own URL line so only the AEK line prints:
+
+```yaml
+- id: web-app
+  name: '@deepseek-ai/dsh-web-app'
+  config:
+    printUrl: false
+```
+
+## Understand the implementation
+
+The host half (`src/index.ts`) injects the `connection` service and prints
+`aek web: <authenticatedUrl>` once, mirroring the web-app bundle's readiness
+line. The client half (`src/client/index.ts`) injects the `slots` service and
+registers the AEK mark and name into the sidebar brand slots as one
+declaration-aware set, the same pattern as `@deepseek-ai/dsh-client-ui-brand-official`.
+
+## Model Experience
+
+No effect on model requests, token usage, or KV-cache behavior. The package
+changes only browser presentation and process stdout.
+
+## Known Limitations and Deferred Work
+
+- The AEK name is plain localized text, not an SVG wordmark; a designed
+  wordmark can replace `AekBrandName` later.
+- The host half prints as soon as the `connection` service mounts; it does not
+  wait for the full Loader tree to settle (sufficient for a human-readable
+  readiness line; a supervisor that RPCs on seeing the line should wait for
+  the dsh bundle's own loader-gated signal).

package/lib/client.js

@@ -0,0 +1,19 @@
+window.__ModuleLoader__.load({
+	id: "@cheezmil/coraek",
+	factory: (require) => {
+		var module = { exports: {} };
+		var exports = module.exports;
+		Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+		//#region src/client/index.ts
+		/** aek-home owns the surface; coraek contributes no client UI. */
+		const inject = [];
+		/** Identity no-op: the AEK brand now lives in aek-home's own surface. */
+		function apply(_ctx) {}
+		//#endregion
+		exports.apply = apply;
+		exports.inject = inject;
+		return module.exports;
+	}
+});
+
+//# sourceMappingURL=client.js.map

package/lib/index.js

@@ -0,0 +1,59 @@
+import { Args, Command, Command as Command$1, Flags, run } from "@oclif/core";
+//#region lib/types/cli.js
+/**
+* Base command class for all AEK CLI commands.
+*/
+var AEKCommand = class extends Command$1 {};
+//#endregion
+//#region lib/types/coraek.js
+/**
+* AEK framework layer identity.
+*
+* "cor" = Latin heart, "aek" = Agent Enhance Kit. Coraek is the heart of AEK.
+* Coraek is the heart of AEK — the runtime layer that gives agents life.
+*/
+const CORAEK_VERSION = "1.0.0";
+const CORAEK_NAME = "coraek";
+/** Print the framework identity line. */
+function announceCoraek() {
+	console.log(`coraek ${CORAEK_VERSION}`);
+}
+//#endregion
+//#region lib/types/index.js
+/**
+* AEK base identity layer, host half. Prints the `aek web:` readiness line.
+* The dsh web-app bundle's own `dsh web:` line is suppressed via
+* `printUrl: false` in the web profile's cordis patch, so AEK surfaces the
+* AEK-prefixed URL instead. Set `DSH_CLIENT_TITLE` at build time to rebrand
+* the document title; this host half owns the process-stdout announcement.
+*
+* 类型 re-export 说明：
+*   所有 AEK 插件通过 `@cheezmil/coraek/types` 导入 Context/Volatile/ClientContext，
+*   而不是直接 import `@deepseek-ai/cordis`（框架底层，保持不变）。这做了两件事：
+*     1. AEK 插件和 dsh 插件在 import 来源上一眼可辨（对话中 AI 能区分）
+*     2. 未来若切换框架底层，只需改 coraek 一处，所有插件自动跟随
+*
+*   - AEK 插件导入：`import type { Context } from '@cheezmil/coraek/types'`
+*   - dsh 插件导入：`import type { Context } from '@deepseek-ai/cordis'`（框架底层，保持不变）
+*
+* @module @cheezmil/coraek
+*/
+/** Stable Coraek plugin name. */
+const name = "coraek";
+/** Services required before the AEK URL line can print. */
+const inject = ["webServer"];
+const ANNOUNCED_ROOTS = /* @__PURE__ */ new WeakSet();
+/**
+* Print the `aek web:` readiness line once the connection service mounts.
+* @param ctx - plugin context carrying the webServer service.
+*/
+function apply(ctx) {
+	ctx.inject(["connection"], (connectionCtx) => {
+		if (ANNOUNCED_ROOTS.has(connectionCtx.root)) return;
+		const url = connectionCtx.connection.authenticatedUrl(ctx.webServer.getOrigin());
+		ANNOUNCED_ROOTS.add(connectionCtx.root);
+		console.log(`aek web: ${url}`);
+	});
+}
+//#endregion
+export { AEKCommand, Args, CORAEK_NAME, CORAEK_VERSION, Command, Flags, announceCoraek, apply, inject, name, run };

package/lib/types/cli.d.ts

@@ -0,0 +1,22 @@
+/**
+ * AEK CLI layer — re-exports oclif core plus AEK-specific conventions.
+ *
+ * All AEK plugins should import CLI primitives from here instead of
+ * importing @oclif/core directly.
+ *
+ * @module @cheezmil/coraek/cli
+ */
+export { Command, Args, Flags, run } from '@oclif/core';
+import { Command } from '@oclif/core';
+declare module '@oclif/core' {
+    class ExitError extends Error {
+        code: number;
+        constructor(code: number | undefined, message?: string);
+    }
+}
+/**
+ * Base command class for all AEK CLI commands.
+ */
+export declare abstract class AEKCommand extends Command {
+}
+//# sourceMappingURL=cli.d.ts.map

package/lib/types/client/Brand.d.ts

@@ -0,0 +1,13 @@
+import type { SidebarBrandMarkOwnerProps } from '@deepseek-ai/dsh-client-ui-sidebar/client';
+/**
+ * The AEK brand mark — an orange slice, at the requested square edge.
+ * @param props.size - square edge in pixels.
+ * @returns the orange-slice svg (aria-hidden; pair with the name for accessibility).
+ */
+export declare function AekBrandMark({ size }: SidebarBrandMarkOwnerProps): import("react").JSX.Element;
+/**
+ * The AEK brand name wordmark.
+ * @returns the AEK name as localized text.
+ */
+export declare function AekBrandName(): import("react").JSX.Element;
+//# sourceMappingURL=Brand.d.ts.map

package/lib/types/client/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * AEK base identity layer, client half. With aek-home as the direct-render
+ * application root and the dsh sidebar/shell disabled, there are no sidebar
+ * brand slots to fill; the client half is an identity no-op. The host half
+ * still prints `aek web:` and pins the AEK home dir.
+ * @module @cheezmil/coraek/src/client/index
+ */
+import type { Context as ClientContext } from '@deepseek-ai/cordis';
+export type { Context as ClientContext } from '@deepseek-ai/cordis';
+/** aek-home owns the surface; coraek contributes no client UI. */
+export declare const inject: readonly string[];
+/** Identity no-op: the AEK brand now lives in aek-home's own surface. */
+export declare function apply(_ctx: ClientContext): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/coraek.d.ts

@@ -0,0 +1,11 @@
+/**
+ * AEK framework layer identity.
+ *
+ * "cor" = Latin heart, "aek" = Agent Enhance Kit. Coraek is the heart of AEK.
+ * Coraek is the heart of AEK — the runtime layer that gives agents life.
+ */
+export declare const CORAEK_VERSION = "1.0.0";
+export declare const CORAEK_NAME = "coraek";
+/** Print the framework identity line. */
+export declare function announceCoraek(): void;
+//# sourceMappingURL=coraek.d.ts.map

package/lib/types/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * AEK base identity layer, host half. Prints the `aek web:` readiness line.
+ * The dsh web-app bundle's own `dsh web:` line is suppressed via
+ * `printUrl: false` in the web profile's cordis patch, so AEK surfaces the
+ * AEK-prefixed URL instead. Set `DSH_CLIENT_TITLE` at build time to rebrand
+ * the document title; this host half owns the process-stdout announcement.
+ *
+ * 类型 re-export 说明：
+ *   所有 AEK 插件通过 `@cheezmil/coraek/types` 导入 Context/Volatile/ClientContext，
+ *   而不是直接 import `@deepseek-ai/cordis`（框架底层，保持不变）。这做了两件事：
+ *     1. AEK 插件和 dsh 插件在 import 来源上一眼可辨（对话中 AI 能区分）
+ *     2. 未来若切换框架底层，只需改 coraek 一处，所有插件自动跟随
+ *
+ *   - AEK 插件导入：`import type { Context } from '@cheezmil/coraek/types'`
+ *   - dsh 插件导入：`import type { Context } from '@deepseek-ai/cordis'`（框架底层，保持不变）
+ *
+ * @module @cheezmil/coraek
+ */
+import type { Context } from '@deepseek-ai/cordis';
+export type { Context } from '@deepseek-ai/cordis';
+export type { Volatile } from '@deepseek-ai/cosmokit';
+/** Stable Coraek plugin name. */
+export declare const name = "coraek";
+/** Services required before the AEK URL line can print. */
+export declare const inject: string[];
+/**
+ * Print the `aek web:` readiness line once the connection service mounts.
+ * @param ctx - plugin context carrying the webServer service.
+ */
+export declare function apply(ctx: Context): void;
+export * from './cli.ts';
+export * from './coraek.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,68 @@
 {
   "name": "@cheezmil/coraek",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "AEK base identity layer: pins the AEK home dir and prints the `aek web:` startup line; the client half is an identity no-op (aek-home owns the surface)",
+  "version": "1.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "types": "./lib/types/client/index.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./types": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "client": {
+      "inject": [],
+      "platform": "web"
+    }
+  },
+  "scripts": {
+    "bundle": "tsdown",
+    "watch": "tsdown --watch",
+    "build": "tsdown",
+    "build:cli": "tsdown -c tsdown.cli.config.ts",
+    "prepack": "pnpm run build && pnpm run build:cli"
+  },
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@deepseek-ai/cordis": ">=4.0.0",
+    "@deepseek-ai/cosmokit": ">=1.8.0"
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "^4.0.5",
+    "@deepseek-ai/cosmokit": "^1.8.6",
+    "@deepseek-ai/dsh-client-connection": "workspace:*",
+    "@deepseek-ai/dsh-client-ui-primitives": "workspace:*",
+    "@deepseek-ai/dsh-client-ui-renderer": "workspace:*",
+    "@deepseek-ai/dsh-client-ui-sidebar": "workspace:*",
+    "@deepseek-ai/dsh-host-webserver": "workspace:*",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "files": [
+    "lib/index.js",
+    "lib/client.js",
+    "lib/types/**/*.d.ts"
+  ],
+  "aek": {
+    "type": "dsh-bundle",
+    "description": "AEK identity layer: re-exports Context/Volatile/ClientContext types and prints the aek web: readiness line"
+  },
+  "dependencies": {
+    "@oclif/core": "^5.1.11"
+  }
 }