@engenty/wizards 0.0.0-stage → 0.7.9

package/LICENSE

@@ -0,0 +1,110 @@
+# Functional Source License, Version 1.1, MIT Future License
+
+## Abbreviation
+
+FSL-1.1-MIT
+
+## Notice
+
+Copyright 2026 - Thru The Heart Creative GmbH - Matthias Platzer
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the MIT license that is effective on the second anniversary of the date we make
+the Software available. On or after that date, you may use the Software under
+the MIT license, in which case the following will apply:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,59 @@
-# Temporary Holding Version
+# @engenty/wizards
 
-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.
+What code outside engenty wizards imports, one subpath per use. The runtime and the studio of
+engenty wizards are not in it.
+
+| Import | What it is | Docs |
+|---|---|---|
+| `@engenty/wizards/plugin` | A plugin's server half: `definePlugin` and its types | `docs/content/dev/plugins` |
+| `@engenty/wizards/plugin/studio` | A plugin's studio half: `defineStudioPlugin` | `docs/content/dev/plugins/studio.md` |
+| `@engenty/wizards/plugin/thread` | A messenger channel: `ThreadDoor` | `docs/content/dev/plugins/runners.md` |
+| `@engenty/wizards/openui` | Wizards in [OpenUI](https://github.com/thesysdev/openui) chats: the `Wizard` component | `docs/content/dev/integration/openui.md` |
+| `@engenty/wizards/openui/server` | Its server half: the rules and the list of wizards for the chat's prompt | |
+| `@engenty/wizards/openui/styles.css` | The styles the `Wizard` component draws with | |
+
+## Wizards in OpenUI chats
+
+The chat's model decides that a wizard runs and what it already knows. The wizard then runs
+inside the conversation as its author defined it, drawn by the runner (`packages/runner`) in
+the chat's own page.
+
+```tsx
+// The browser
+import "@engenty/wizards/openui/styles.css";
+import { addWizard, configureWizards, Wizard } from "@engenty/wizards/openui";
+import { openuiChatLibrary } from "@openuidev/react-ui/genui-lib";
+
+configureWizards({ runtime: "/wizards-runtime" }); // where the runtime answers
+const library = addWizard(openuiChatLibrary, Wizard);
+```
+
+```ts
+// The server that builds the system prompt
+import { addWizard, loadWizards, wizardRules } from "@engenty/wizards/openui/server";
+
+const wizards = await loadWizards("http://localhost:24368", ["<token>"]);
+const prompt = addWizard(openuiChatLibrary).prompt({
+  ...openuiChatPromptOptions,
+  additionalRules: [...(openuiChatPromptOptions.additionalRules ?? []), ...wizardRules(wizards)],
+});
+```
+
+What the model writes: `Wizard("<token>", "<note>", {plate: "W-12345"})`. The prefill starts
+the page's fields, and the person still sees and sends each page. When the run is done, the
+component sends a `continue_conversation` action with the result's texts as its context, and
+the chat goes on with it. A chat to try it with: `examples/openui-chat`.
+
+## The package
+
+Every release publishes it to npm (`scripts/npm-package.mjs`, `.github/workflows/release.yml`).
+`pnpm --filter @engenty/wizards build` writes `dist/` as it ships (`scripts/build.mjs`):
+`/openui` with the runner and the shared modules it uses bundled in, their types inlined, and the
+runner's `runner.css` as `styles.css`; every other package stays an import, the libraries as
+`dependencies`, React, OpenUI, zod and drizzle as peers. Inside this repo everything imports the
+sources.
+
+## Licences
+
+FSL-1.1-MIT, like the repository. `dist/openui` bundles the runner (`packages/runner`), which is
+MIT: its licence ships beside it as `dist/openui/LICENSE-MIT`.

package/dist/openui/LICENSE-MIT

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2026 Thru The Heart Creative GmbH - Matthias Platzer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+The built package (dist/) also contains these modules of @engenty-wizards/shared,
+which are under FSL-1.1-MIT OR MIT (packages/shared/LICENSE-MIT) and are included
+here under the MIT licence above: definition, fit, run, store, surface and
+engenty/data-tables/columns, columns-format.