@kb-labs/scaffold-contracts 2.29.0

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @module @kb-labs/scaffold-contracts
+ *
+ * Public types for the scaffold engine. The engine is entity-agnostic —
+ * entities (plugin, adapter, etc.) are described declaratively via
+ * `entity.yaml` + block directories. These types form the shape that
+ * YAML is parsed into.
+ */
+type VariableType = 'string' | 'boolean' | 'select' | 'multiselect';
+type VariableValidator = 'identifier' | 'npmName' | 'semver' | 'npmScope';
+interface VariableChoice {
+    value: string;
+    label: string;
+}
+interface Variable {
+    name: string;
+    type: VariableType;
+    describe: string;
+    default?: unknown;
+    choices?: VariableChoice[];
+    /** Simple boolean expression, e.g. `blocks.includes("rest")`. */
+    when?: string;
+    validate?: VariableValidator;
+}
+interface BlockDefinition {
+    id: string;
+    describe: string;
+    requires?: string[];
+    conflicts?: string[];
+    variables?: Variable[];
+    /** Absolute path to the block's `files/` directory. */
+    filesDir: string;
+    /** Absolute path to `manifest.patch.yaml`, if the block contributes one. */
+    manifestPatch?: string;
+    /** Absolute path to `manifest.snippets.yaml`, for TS-string contributions. */
+    snippetsPath?: string;
+}
+interface EntityDefinition {
+    id: string;
+    displayName: string;
+    description?: string;
+    variables: Variable[];
+    blocks: BlockDefinition[];
+    defaults?: {
+        blocks?: string[];
+    };
+    /**
+     * Output path template evaluated with entity + user variables.
+     * Example: `.kb/plugins/{{name}}` or `plugins/{{name}}`.
+     */
+    output?: string;
+    /**
+     * Relative path inside the scaffolded output where the generated
+     * `manifest.ts` should land. Template-evaluated. Defaults to
+     * `src/manifest.ts` (suitable for flat adapter layouts).
+     */
+    manifestTarget?: string;
+}
+type ScaffoldMode = 'in-workspace' | 'standalone';
+interface RenderContext {
+    name: string;
+    scope: string;
+    vars: Record<string, unknown>;
+    blocks: string[];
+    mode: ScaffoldMode;
+    versions: Record<string, string>;
+}
+interface RenderedFile {
+    /** Path relative to the scaffold output root. */
+    path: string;
+    contents: string;
+    /** If true, preserve executable bit on unix. */
+    executable?: boolean;
+}
+/**
+ * Deep-mergeable patch applied on top of the V3 manifest skeleton produced
+ * by the `base` block. Arrays of objects with `id` or `name` are merged as
+ * unions by key; primitive arrays are Set-deduped.
+ */
+type ManifestPatch = Record<string, unknown>;
+interface PatchContext {
+    vars: Record<string, unknown>;
+    blocks: string[];
+}
+/**
+ * TS-string snippets contributed by blocks and composed into the final
+ * `src/manifest.ts` (imports, permissions fragments, etc.).
+ */
+interface ManifestSnippets {
+    imports?: string[];
+    permissions?: string[];
+    extras?: Record<string, string[]>;
+}
+
+export type { BlockDefinition, EntityDefinition, ManifestPatch, ManifestSnippets, PatchContext, RenderContext, RenderedFile, ScaffoldMode, Variable, VariableChoice, VariableType, VariableValidator };

package/dist/index.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@kb-labs/scaffold-contracts",
+  "version": "2.29.0",
+  "type": "module",
+  "description": "Public types for the KB Labs scaffold engine (entity, block, manifest patch).",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./dist/*": "./dist/*"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^24.3.3",
+    "eslint": "^9",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.6.3",
+    "vitest": "^3.2.4",
+    "@kb-labs/devkit": "2.29.0"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "pnpm": ">=9.0.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsup --config tsup.config.ts",
+    "dev": "tsup --config tsup.config.ts --watch",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint . --fix",
+    "type-check": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest"
+  }
+}