@gestaltrun/dsh-workspace-bundle 0.0.0-stage → 0.1.1

package/lib/types/types.d.ts

@@ -0,0 +1,126 @@
+/** Client-safe types of the WorkspaceBundles seam; importing them loads no Host code. */
+import type { Branded } from '@deepseek-ai/dsh-brand';
+import type { WorkspaceBundleId, WorkspaceBundleKey, WorkspaceId, WorkspaceOrigin } from '@deepseek-ai/dsh-workspace/types';
+import type { BundledAgentConfigReceipt } from './bundled-agent-config.ts';
+export type { WorkspaceBundleId, WorkspaceBundleKey, WorkspaceId, WorkspaceOrigin };
+/** SHA-256 hex digest of one template file. */
+export type WorkspaceTemplateFileDigest = Branded<'WorkspaceTemplateFileDigest'>;
+/** SHA-256 hex digest of the ordered path+file-digest catalog. */
+export type WorkspaceTemplateDigest = Branded<'WorkspaceTemplateDigest'>;
+/** One file listed in a template manifest. */
+export interface WorkspaceTemplateFile {
+    readonly path: string;
+    readonly bytes: number;
+    readonly digest: WorkspaceTemplateFileDigest;
+}
+/** Repository and commit of the packaged customer-service instruction files. */
+export interface WorkspaceTemplateSource {
+    readonly repository: string;
+    readonly commit: string;
+}
+/** Verified catalog of a packaged Workspace template. */
+export interface WorkspaceTemplateManifest {
+    readonly formatVersion: 1;
+    readonly pluginVersion: string;
+    readonly source?: WorkspaceTemplateSource;
+    readonly files: readonly WorkspaceTemplateFile[];
+    readonly digest: WorkspaceTemplateDigest;
+}
+/** A registered template the Host can materialize. */
+export interface WorkspaceTemplate {
+    readonly bundleId: WorkspaceBundleId;
+    readonly workspaceKey: WorkspaceBundleKey;
+    readonly title: string;
+    readonly sourceRoot: string;
+    readonly manifest: WorkspaceTemplateManifest;
+    /** Published gzip digest for downloaded or bundled content; absent for repository templates. */
+    readonly agentConfigSha256?: string;
+    /** Publication receipt adjacent to a shipped template, outside its file catalog. */
+    readonly agentConfigReceipt?: BundledAgentConfigReceipt;
+}
+/** Deployment settings the Provider resolves once at load. */
+export interface WorkspaceBundlesSpec {
+    /** Parent of each `{bundleId}/{workspaceKey}` Workspace root. */
+    readonly materializeRoot: string;
+    /** Parent of the immutable template copies used when the package source is gone. */
+    readonly templateCacheRoot: string;
+    /** Parent of per-Workspace journal files. */
+    readonly journalRoot: string;
+    /** How long upgrade waits for acquired leases to drain, in milliseconds. */
+    readonly quiesceTimeoutMs: number;
+    /** How long a successful upgrade waits before deleting the backup, in milliseconds. */
+    readonly recycleTimeoutMs: number;
+    /** 内容分配查询间隔，单位毫秒。 */
+    readonly agentConfigPollIntervalMs: number;
+    /** 每次查询和下载共享的超时，单位毫秒。 */
+    readonly agentConfigRequestTimeoutMs: number;
+    /** 压缩Agent 配置字节上限。 */
+    readonly agentConfigMaxDownloadBytes: number;
+    /** 解压 JSON 和文件总字节上限。 */
+    readonly agentConfigMaxExpandedBytes: number;
+    /** 仅允许显式配置的本地测试文件服务使用 HTTP。 */
+    readonly allowLoopbackAgentConfigHttp: boolean;
+}
+/** Named configuration failure. */
+export type WorkspaceBundlesConfigErrorCode = 'WORKSPACE_BUNDLES_MATERIALIZE_ROOT_MISSING' | 'WORKSPACE_BUNDLES_TEMPLATE_CACHE_ROOT_MISSING' | 'WORKSPACE_BUNDLES_JOURNAL_ROOT_MISSING' | 'WORKSPACE_BUNDLES_PATH_INVALID' | 'WORKSPACE_BUNDLES_TIMEOUT_INVALID';
+/** Named runtime failure of template access, materialize, or upgrade. */
+export type WorkspaceBundleErrorCode = 'WORKSPACE_BUNDLE_NOT_REGISTERED' | 'WORKSPACE_BUNDLE_TEMPLATE_INVALID' | 'WORKSPACE_BUNDLE_PATH_TRAVERSAL' | 'WORKSPACE_BUNDLE_SYMLINK_REJECTED' | 'WORKSPACE_BUNDLE_MISSING_ASSET' | 'WORKSPACE_BUNDLE_DIGEST_MISMATCH' | 'WORKSPACE_BUNDLE_QUIESCE_TIMEOUT' | 'WORKSPACE_BUNDLE_CRASH_INJECTED' | 'WORKSPACE_BUNDLE_IDENTITY_INVALID';
+/** Observable upgrade barrier: consumers must not read a half-replaced tree. */
+export type WorkspaceBundleBarrier = 'open' | 'updating';
+/** Durable upgrade journal. `updating` means consumers are barred. */
+export interface WorkspaceBundleJournal {
+    readonly phase: 'idle' | 'updating';
+    readonly fromDigest: WorkspaceTemplateDigest | null;
+    readonly toDigest: WorkspaceTemplateDigest | null;
+    readonly pluginVersion: string | null;
+    readonly stagingPath: string | null;
+    readonly backupPath: string | null;
+    readonly swapComplete: boolean;
+    /** 新Agent 配置身份；旧 journal 没有此字段。 */
+    readonly agentConfigSha256?: string | null;
+}
+/** Durable product record for one bundled Workspace. */
+export interface WorkspaceBundleRecord {
+    readonly version: 1;
+    readonly bundleId: WorkspaceBundleId;
+    readonly workspaceKey: WorkspaceBundleKey;
+    readonly workspaceId: WorkspaceId | null;
+    readonly path: string;
+    readonly pluginVersion: string;
+    readonly templateDigest: WorkspaceTemplateDigest;
+    /** 已提交Agent 配置身份；旧 record 缺失时表示内置模板。 */
+    readonly agentConfigSha256?: string | null;
+    readonly registered: boolean;
+    readonly journal: WorkspaceBundleJournal;
+    readonly lastFailure: {
+        readonly code: WorkspaceBundleErrorCode;
+        readonly message: string;
+        readonly at: string;
+    } | null;
+}
+/** Points where tests inject a crash; production never sets them. */
+export type WorkspaceBundleCrashPoint = 'after-staging' | 'after-journal-updating' | 'after-quiesce' | 'after-rename-backup' | 'after-rename-staging' | 'after-verify' | 'after-journal-commit';
+/** Filesystem operations the materializer uses so tests can inject crashes. */
+export interface WorkspaceBundleFs {
+    mkdir(path: string): Promise<void>;
+    writeFile(path: string, data: Uint8Array | string): Promise<void>;
+    readFile(path: string): Promise<Buffer>;
+    rename(from: string, to: string): Promise<void>;
+    rm(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    lstat(path: string): Promise<{
+        isFile(): boolean;
+        isDirectory(): boolean;
+        isSymbolicLink(): boolean;
+    }>;
+    readdir(path: string): Promise<readonly string[]>;
+    realpath(path: string): Promise<string>;
+    copyFile(from: string, to: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+}
+/** Identity of one bundled Workspace. */
+export interface WorkspaceBundleIdentity {
+    readonly bundleId: WorkspaceBundleId;
+    readonly workspaceKey: WorkspaceBundleKey;
+}

package/lib/types/types.js

@@ -0,0 +1 @@
+export {};

package/locale/en.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "Workspace templates",
+    "description": "Create, set up, and update built-in workspace templates"
+  }
+}

package/locale/zh.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "工作区模板",
+    "description": "管理内置工作区模板的创建、初始化与版本升级"
+  }
+}

package/package.json

@@ -1,6 +1,72 @@
 {
   "name": "@gestaltrun/dsh-workspace-bundle",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "WorkspaceBundles Service Definition and Provider: packaged templates, stable hidden Workspaces, and whole-tree upgrades",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./types": {
+      "types": "./lib/types/types.d.ts",
+      "default": "./lib/types/types.js"
+    },
+    "./package.json": "./package.json",
+    "./locale/*.json": "./locale/*.json"
+  },
+  "files": [
+    "lib/index.js",
+    "lib/types/**/*.js",
+    "lib/types/**/*.d.ts",
+    "locale/*.json",
+    "README.md",
+    "README.zh.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gestaltrun/deepseek-harness.git",
+    "directory": "product/workspace-bundle"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "candidate"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "4.0.6-alpha.1",
+    "@deepseek-ai/dsh-brand": "0.2.2-alpha.2",
+    "@deepseek-ai/dsh-workspace": "0.2.2-alpha.2",
+    "@deepseek-ai/schemastery": "3.18.6-alpha.1",
+    "@deepseek-ai/dsh-session": "0.2.2-alpha.2",
+    "@deepseek-ai/dsh-atomic-write": "0.2.2-alpha.2",
+    "@gestaltrun/dsh-merchant-account": ">=0.1.0-gestaltrun.0"
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "4.0.6-alpha.1",
+    "@deepseek-ai/dsh-brand": "0.2.2-alpha.2",
+    "@deepseek-ai/dsh-workspace": "0.2.2-alpha.2",
+    "@deepseek-ai/schemastery": "3.18.6-alpha.1",
+    "@types/node": "22.20.0",
+    "typescript": "6.0.3",
+    "tsdown": "0.22.2",
+    "vitest": "4.1.8",
+    "@deepseek-ai/dsh-session": "0.2.2-alpha.2",
+    "@types/semver": "7.7.1",
+    "@deepseek-ai/dsh-atomic-write": "0.2.2-alpha.2",
+    "@gestaltrun/dsh-merchant-account": "0.1.5"
+  },
+  "dependencies": {
+    "semver": "7.8.5",
+    "zod": "4.4.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.host.json && tsdown --config tsdown.host.config.ts",
+    "typecheck": "tsc -p tsconfig.host.json --noEmit && tsc -p tsconfig.test.host.json --noEmit",
+    "test": "vitest run && node --test tests/*.test.mjs"
+  }
 }