@eforge-build/eforge-playbooks 0.8.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Schaake Solutions, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,179 @@
+# eforge-playbooks Extension
+
+`eforge-playbooks` is the first-party extension that owns reusable playbook management and playbook execution handoff. It exposes playbook inventory, CRUD-style management, validation, scope moves, planning-mode handoff metadata, and autonomous build-queue enqueue through generic extension actions.
+
+The extension owns its playbook parser, serializer, validation, scope-aware storage, compiler, and planning-seed extraction locally. `@eforge-build/input` remains a dependency only for domain-neutral acceptance-criteria quality helpers. The extension does not add direct daemon playbook routes, Console core sections, queue internals, or host-specific command implementations. Hosts discover and invoke the extension through normal extension action, integration-command, capability, and Console contribution metadata.
+
+## Trust model
+
+Extensions run as project-team code. Install and enable `eforge-playbooks` only in repositories where you trust the extension source and the team-maintained playbook content.
+
+`eforge-playbooks` is not a sandbox boundary. Actions can read and write playbook files in project-local, project-team, and user scopes, and `run-playbook` can enqueue autonomous builds through the generic build queue. Review extension changes with the same care as build tooling, scripts, or other automation that runs in the repository.
+
+Playbooks are reusable build-input artifacts. Treat them as executable workflow intent: a playbook can define normalized build source, profile defaults, post-merge commands, and a planning or autonomous mode.
+
+## Install and manage
+
+`eforge-playbooks` is published as the first-party npm package `@eforge-build/eforge-playbooks`. The package declares `eforge.extension.name: "eforge-playbooks"` and loads from the compiled runtime entrypoint `./dist/index.js`.
+
+```bash
+# Install from npm into the default local scope (.eforge/extensions/)
+eforge extension install @eforge-build/eforge-playbooks
+
+# Install from a local package directory or packed tarball after building
+eforge extension install ./eforge/extensions/eforge-playbooks
+eforge extension install ./eforge/extensions/eforge-playbooks/eforge-build-eforge-playbooks-<version>.tgz
+
+# Install into the project/team scope and trust the reviewed artifact
+eforge extension install @eforge-build/eforge-playbooks --scope project --trust
+```
+
+Scope behavior follows normal extension management rules:
+
+- `local` (default) installs under `.eforge/extensions/` and loads without a project/team trust record.
+- `project` installs under `eforge/extensions/`; each user must inspect and run `eforge extension trust eforge-playbooks`, or install/update with `--trust`, before it loads.
+- `user` installs under the user eforge config directory and is trusted for that user.
+
+Common lifecycle commands:
+
+```bash
+eforge extension validate eforge-playbooks
+eforge extension trust eforge-playbooks
+eforge extension reload
+eforge extension show eforge-playbooks
+
+eforge extension update eforge-playbooks
+eforge extension update eforge-playbooks --version latest
+eforge extension remove eforge-playbooks
+```
+
+The npm artifact contains the compiled runtime in `dist/`, `README.md`, `LICENSE`, and package metadata. Tests and development config are not part of the runtime artifact.
+
+## Declared capabilities
+
+The package manifest declares two stable first-party capabilities:
+
+- `eforge.playbooks.management` version `1.0.0` — the extension owns playbook inventory, validation, copy, save, promote, and demote actions.
+- `eforge.playbooks.run` version `1.0.0` — the extension owns playbook execution handoff for autonomous and planning-mode playbooks.
+
+The extension declares an optional dependency on provider `eforge-plan` with capability `eforge.plan.planning-workstation` satisfying `>=1.0.0`. Planning-mode playbooks use that generic planning workstation capability when available, but the extension still loads without it and returns diagnostics instead of enqueueing a build.
+
+## Extension-owned playbook domain
+
+`eforge-playbooks` is the implementation owner for playbook domain behavior:
+
+- `model.ts` defines the playbook frontmatter and body model, schemas, parsing, serialization, validation, and mode mismatch errors.
+- `storage-core.ts` resolves named-set storage locations, lists and loads playbooks, writes scoped files, and performs copy, promote, and demote moves while preserving existing shadowing behavior.
+- `compile.ts` converts autonomous playbooks to normalized build source and planning playbooks to JSON-safe planning seeds.
+
+The package entrypoint exposes the extension contribution surface, not these domain helpers as host-facing APIs. Runtime imports from `@eforge-build/input` are limited to `analyzeAcceptanceCriteria`, `analyzeAcceptanceCriteriaInBody`, and `formatAcDiagnostics`.
+
+## Actions
+
+Registered action IDs are local to the extension and are exposed with effective IDs such as `eforge-playbooks:run-playbook`. Integration commands mirror the same eight local IDs so hosts can discover the same capabilities through command metadata.
+
+| Action | Purpose | Side effects |
+| --- | --- | --- |
+| `list-playbooks` | List playbooks from project-local, project-team, and user scopes. Supports optional `scope`, `mode`, and `includeShadowed`; shadowed entries are included by default. | `local-read` |
+| `show-playbook` | Show the highest-precedence playbook by name, or an exact scoped copy when `scope` is supplied. | `local-read` |
+| `save-playbook` | Save a playbook from raw Markdown, nested `{ playbook: { frontmatter, body } }`, or flattened fields. Defaults `overwrite` to `true` and validates acceptance criteria before writing. | `local-write` |
+| `validate-playbook` | Validate raw playbook Markdown without filesystem writes. This preserves raw validation semantics and does not run the save/run acceptance-criteria quality gate. | `none` |
+| `copy-playbook` | Copy a playbook to another scope, updating frontmatter `scope`; `overwrite` defaults to `true` (set `false` to reject existing destinations). | `local-read`, `local-write` |
+| `promote-playbook` | Move a playbook from `project-local` to `project-team`; `overwrite` defaults to `true` (set `false` to reject existing destinations). | `local-write` |
+| `demote-playbook` | Move a playbook from `project-team` to `project-local`; `overwrite` defaults to `true` (set `false` to reject existing destinations). | `local-write` |
+| `run-playbook` | Resolve and run a playbook. Autonomous playbooks compile to normalized build source and enqueue through the generic build queue. Planning-mode playbooks return eforge-plan planning entry metadata or diagnostics and never enqueue. | `local-read`, `daemon-state`, `build-queue` |
+
+Common action input forms:
+
+```json
+{ "scope": "project-team", "mode": "autonomous", "includeShadowed": false }
+```
+
+```json
+{ "name": "weekly-maintenance", "scope": "project-local" }
+```
+
+```json
+{
+  "scope": "project-team",
+  "playbook": {
+    "frontmatter": {
+      "name": "weekly-maintenance",
+      "description": "Run routine maintenance",
+      "mode": "autonomous",
+      "profile": "excursion"
+    },
+    "body": {
+      "goal": "Update routine maintenance checks.",
+      "acceptanceCriteria": "Maintenance checks are documented and pass."
+    }
+  },
+  "overwrite": true
+}
+```
+
+```json
+{
+  "name": "weekly-maintenance",
+  "mode": "autonomous",
+  "profile": "excursion",
+  "afterQueueId": "session_123",
+  "landingAction": "pr",
+  "landingAutoMerge": false
+}
+```
+
+`save-playbook` accepts exactly one payload shape: `raw` Markdown, the nested `{ "playbook": { "frontmatter", "body" } }` form, or flattened playbook fields (`name`, `description`, `mode`, `profile`, `postMerge`, `goal`, `outOfScope`, `acceptanceCriteria`, and `plannerNotes`). When a top-level `name` is supplied, it must match the parsed or structured playbook name. `run-playbook` rejects a supplied `mode` when it differs from the playbook frontmatter mode.
+
+## Planning-mode behavior
+
+A playbook whose frontmatter mode is `planning` is an investigation-first handoff. `run-playbook` converts the playbook to a JSON-safe planning seed and checks:
+
+```text
+eforge.plan.planning-workstation >=1.0.0
+```
+
+When the optional `eforge-plan` provider is available, the action returns `kind: "requires-agent"` with planning entry metadata for `eforge-plan:open-planning-entry`, workstation `eforge-plan:planning-workstation`, and workstation URL `/console/workstations/eforge-plan%3Aplanning-workstation`.
+
+When the provider is unavailable, the action returns `kind: "planning-unavailable"` with diagnostics and guidance to install, trust, and reload `eforge-plan`. It does not create session plans, enqueue PRDs, or call the build queue.
+
+Planning seed output is JSON-safe: section maps are projected to plain objects, and undefined values are omitted.
+
+## Autonomous queue handoff
+
+A playbook whose frontmatter mode is `autonomous` compiles to normalized build source using the extension-local compiler. Before enqueueing, `run-playbook` runs the existing domain-neutral acceptance-criteria quality gate from `@eforge-build/input` against the compiled source. Invalid criteria fail as user-visible invalid input.
+
+Autonomous handoff uses only the generic build queue API:
+
+```ts
+ctx.buildQueue.enqueue({
+  source,
+  profile,
+  postMerge,
+  afterQueueId,
+  landingAction,
+  landingAutoMerge,
+});
+```
+
+`profile` defaults to the compiled playbook profile when the action input does not override it. `postMerge`, `afterQueueId`, `landingAction`, and `landingAutoMerge` are passed through to generic queue validation. Queue validation failures remain invalid-input action failures; unexpected daemon/runtime enqueue errors propagate as handler errors.
+
+The success result is `kind: "enqueued"` and aliases `id` to `sessionId`.
+
+## Console contribution
+
+`eforge-playbooks` contributes playbook management declaratively through extension Console metadata rather than a core Console section or a packaged workstation bundle. The contribution includes a Markdown summary plus action controls for listing, showing, saving, validating, copying, promoting, demoting, and running playbooks.
+
+Console action bindings reference the canonical effective action IDs owned by this extension, such as `eforge-playbooks:list-playbooks` and `eforge-playbooks:run-playbook`.
+
+## Storage model
+
+Playbook storage is resolved by the extension-local storage layer through `@eforge-build/scopes` named-set APIs with the daemon-provided project root and config directory:
+
+- project-local playbooks live under `.eforge/playbooks/`;
+- project-team playbooks live under `eforge/playbooks/`;
+- user playbooks live under the user's eforge config directory.
+
+Higher-precedence scopes shadow lower-precedence copies with the same playbook name. `show-playbook` without a scope returns the highest-precedence copy; exact-scope actions fail with a not-found user error when that scope lacks the requested playbook.
+
+The extension imports public `@eforge-build/extension-sdk` APIs, `@eforge-build/scopes` named-set helpers, and only the domain-neutral acceptance-criteria helpers from `@eforge-build/input` for runtime behavior. It does not import playbook-specific input symbols, the legacy playbook workflow adapter, or use `builtin:playbooks`.

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import * as _eforge_build_extension_sdk from '@eforge-build/extension-sdk';
+
+declare const ACTION_IDS: readonly ["list-playbooks", "show-playbook", "save-playbook", "validate-playbook", "copy-playbook", "promote-playbook", "demote-playbook", "run-playbook"];
+
+declare const EFORGE_PLAN_DRIFT_CONSTANTS: {
+    readonly capability: "eforge.plan.planning-workstation";
+    readonly version: "1.0.0";
+    readonly actionId: "eforge-plan:open-planning-entry";
+    readonly integrationCommandId: "eforge-plan:open-planning-entry";
+    readonly deepLinkId: "eforge-plan:planning-workstation";
+    readonly workstationId: "eforge-plan:planning-workstation";
+    readonly workstationUrl: "/console/workstations/eforge-plan%3Aplanning-workstation";
+};
+
+declare const _default: _eforge_build_extension_sdk.EforgeExtensionFactory;
+
+export { ACTION_IDS, EFORGE_PLAN_DRIFT_CONSTANTS, _default as default };