@kizenapps/cli 1.11.0 → 1.13.0-1bb4c57
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -2
- package/dist/THIRD-PARTY-NOTICES.txt +1 -1
- package/dist/index.js +145 -175
- package/dist/index.js.map +1 -1
- package/dist/viewer/assets/{AppDetailPage-D9xr-bY8.js → AppDetailPage-CGrukEIj.js} +1 -1
- package/dist/viewer/assets/{CodeStepsPage-D_kTMpRO.js → CodeStepsPage-Cu9UiRy9.js} +1 -1
- package/dist/viewer/assets/ConfigurationPage-CI0pRNJ0.js +1 -0
- package/dist/viewer/assets/{DevSidebar-zX-4CWYv.js → DevSidebar-BFsoIbMt.js} +1 -1
- package/dist/viewer/assets/{SandboxPage-DuCHX1FY.js → SandboxPage-Dyb8i7vf.js} +1 -1
- package/dist/viewer/assets/{SecretsPage-Da55-e_S.js → SecretsPage-g2FF7d-B.js} +1 -1
- package/dist/viewer/assets/{WhenBadge-B7s7fns2.js → WhenBadge-DKz8ukwo.js} +1 -1
- package/dist/viewer/assets/api--pW2v3sH.js +11 -0
- package/dist/viewer/assets/{bootstrapQuery-CyYWFe68.js → bootstrapQuery-DTAPKOf-.js} +1 -1
- package/dist/viewer/assets/{calendarSource.worker-CTgMuhqr.js → calendarSource.worker-DjLHW14n.js} +1 -1
- package/dist/viewer/assets/{floatingFrame.worker-zn66fKUA.js → floatingFrame.worker-Cy3ysIc7.js} +1 -1
- package/dist/viewer/assets/{generic.worker-gJPrf_ED.js → generic.worker-DKCeuXG7.js} +1 -1
- package/dist/viewer/assets/{index-BF1Fk_v0.js → index-GvAPdgKb.js} +3 -3
- package/dist/viewer/assets/{recordDetail.worker-CGLG0Evq.js → recordDetail.worker-DrTKYLJc.js} +1 -1
- package/dist/viewer/assets/storageKeys-BDp-0diL.js +1 -0
- package/dist/viewer/assets/useCompleteSetup-QS3W9RRO.js +40 -0
- package/dist/viewer/assets/usePluginConfig--4sAyik4.js +1 -0
- package/dist/viewer/index.html +4 -4
- package/package.json +3 -3
- package/dist/viewer/assets/ConfigurationPage-5qOX-sx0.js +0 -1
- package/dist/viewer/assets/api--Ax6VWLq.js +0 -11
- package/dist/viewer/assets/storageKeys-DPq6kaaE.js +0 -1
- package/dist/viewer/assets/useCompleteSetup-DUHoBgca.js +0 -40
- package/dist/viewer/assets/usePluginConfig-C8d13THZ.js +0 -1
package/README.md
CHANGED
|
@@ -57,7 +57,9 @@ The wizard first asks where the plugin should live (the current directory, or a
|
|
|
57
57
|
|
|
58
58
|
> **Fill in Description and Business ID.** Both are labelled optional in the wizard, but `create` writes them into `kizen.json` as empty strings and the bundler rejects an empty `description` or `developer_business_id` — so a plugin created with those fields skipped fails `appbuilder build` until you edit `kizen.json` by hand. This is tracked internally (KZN-17594); until that fix lands, treat both as required.
|
|
59
59
|
|
|
60
|
-
`
|
|
60
|
+
It then asks which artifacts to scaffold — Floating frame, Block, Data adornment, Routable page, Toolbar item, Object settings item, JS action — with all seven selected by default (Space toggles, `a` selects all, `n` none). Each selected type gets a working `hello*` directory under `src/`, holding a `config.json` and a script that runs as-is.
|
|
61
|
+
|
|
62
|
+
`create` writes `kizen.json`, `src/`, `releaseNotes/`, a placeholder `src/thumbnail.png` (512×512, colored from the `api_name`), the templates for the artifacts you picked, and the Copilot review files described under [`appbuilder create`](#appbuilder-create). It adds both `.kizenapp/` and `.copilot-docs/` to `.gitignore`.
|
|
61
63
|
|
|
62
64
|
### 2. Set up credentials
|
|
63
65
|
|
|
@@ -102,7 +104,19 @@ Writes `.kizenapp/bundle.json` — the same artifact `dev` serves — after runn
|
|
|
102
104
|
|
|
103
105
|
### `appbuilder create`
|
|
104
106
|
|
|
105
|
-
Scaffolds a new Kizen plugin project. Interactive;
|
|
107
|
+
Scaffolds a new Kizen plugin project. Interactive by default; passing any flag switches it to a non-interactive run, including `--artifacts` to choose the artifact templates up front (`appbuilder create --help` lists them all). See [Quickstart](#1-scaffold-a-plugin) for the fields it collects, the artifact picker, and everything it writes.
|
|
108
|
+
|
|
109
|
+
The scaffold also includes `.github/copilot-instructions.md`, two path-scoped instruction files under `.github/instructions/`, and `.github/workflows/copilot-code-review.yml`. That workflow fetches the Kizen plugin docs from `kizen/app-engine` into `.copilot-docs/` before Copilot code review runs, so reviews cite the current documentation instead of rules copied into the plugin repo. It only takes effect once it is on the repository's default branch, and `.copilot-docs/` is gitignored. Plugins scaffolded before this setup existed can pick it up with `appbuilder setup-copilot`.
|
|
110
|
+
|
|
111
|
+
### `appbuilder setup-copilot`
|
|
112
|
+
|
|
113
|
+
Writes the same Copilot review files into an existing plugin repo — run it from the repo root (a `kizen.json` must be there). The four files are CLI-owned, so the command overwrites them and prints `created`, `updated`, or `unchanged` per file; a clobbered local customization is recoverable from git. It also adds `.kizenapp/` and `.copilot-docs/` to `.gitignore` if they are missing.
|
|
114
|
+
|
|
115
|
+
| Flag | Default | Purpose |
|
|
116
|
+
| ----------- | ------- | ----------------------------------------------- |
|
|
117
|
+
| `--dry-run` | off | Print the per-file statuses without writing any |
|
|
118
|
+
|
|
119
|
+
As with `create`, the workflow only runs once it has reached the repository's default branch.
|
|
106
120
|
|
|
107
121
|
### `appbuilder build`
|
|
108
122
|
|
|
@@ -110,6 +124,8 @@ Reads the plugin in the current directory, validates it against the same rules e
|
|
|
110
124
|
|
|
111
125
|
If validation finds any errors (for example an `api_name` containing hyphens, which the platform rejects) the build fails and prints each issue grouped by file. Fix the reported issues and re-run.
|
|
112
126
|
|
|
127
|
+
Automation step configs are validated the same way — parameter data types, secrets that must be declared in the manifest's `base_config.secrets`, fields removed from the publish contract, and `runtime` — against the list of automation data types bundled in `@kizenapps/packager`. The Plugin Wizard applies the same rules at publish, against the live list read from the target environment, so a build that passes locally is expected to publish clean.
|
|
128
|
+
|
|
113
129
|
### `appbuilder dev`
|
|
114
130
|
|
|
115
131
|
Starts the dev server and opens the viewer. Watches your plugin directory and rebuilds + hot-reloads the viewer on every change. Each rebuild runs the same validation as `build`.
|
|
@@ -520,7 +520,7 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
|
520
520
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
521
521
|
|
|
522
522
|
================================================================================
|
|
523
|
-
@kizenapps/engine@1.
|
|
523
|
+
@kizenapps/engine@1.10.0
|
|
524
524
|
License: GPL-3.0
|
|
525
525
|
================================================================================
|
|
526
526
|
|