flare-plugin-sdk 0.1.0-beta.5 → 0.1.0-beta.6

package/README.md

@@ -33,6 +33,11 @@ them. The command uses bundled files only and does not install dependencies,
 initialize Git, contact your website, or publish anything. Run
 `npx flare-plugin-sdk@next --help` for usage.
 
+The generated `manifest.json` includes a `$schema` URL pinned to the SDK version
+used to create it. Open it in VS Code or another JSON Schema editor for property
+completion, descriptions, enum choices, and static validation. The complete schema
+is bundled at `skill/flare-plugin/manifest.schema.json` inside the SDK.
+
 Edit `plugin.js` to use your website's real authentication, endpoints, response
 mapping, and pagination. The starter's `/api/me` and `/api/posts` are illustrative;
 no demonstration server is included. Update the description, login methods and
@@ -141,6 +146,15 @@ registration, permissions, and behavior. File installs have no GitHub update tra
 
 ## Optional: editor types and TypeScript
 
+For JSON Schema use without network access, install the SDK below and set the
+manifest's `$schema` to `./node_modules/flare-plugin-sdk/skill/flare-plugin/manifest.schema.json`.
+Keep these development files outside the optional `.fpp` staging directory.
+Flare treats `$schema` as editor metadata and never downloads it. With an older
+Flare build that rejects this field, remove it and use a VS Code `json.schemas`
+association in workspace settings instead. See the
+[manifest editor guide](https://github.com/DimensionDev/Flare/blob/feature/plugin/feature/plugin/sdk/skill/flare-plugin/references/manifest.md#json-schema-and-editor-support)
+and [VS Code schema settings](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings).
+
 Install editor types in your authoring project:
 
 ```sh
@@ -182,6 +196,9 @@ Initializer tests cover valid unique IDs, empty/nested/Unicode paths, invalid
 arguments, and preserving existing directories, files, and symlinks. They do not
 contact a website or publish to npm. Flare's Host and platform acceptance checks are
 documented in `skill/flare-plugin/references/testing.md`.
+The draft-07 schema is compiled with Ajv in strict mode. Shared manifest cases
+exercise both Schema and Host validation; Host tests also compare every field,
+required property, enum, and known capability operation against Kotlin descriptors.
 
 To try the SDK from a checkout before npm publication, run
 `npm pack --pack-destination /tmp` after those checks, then install the resulting `.tgz` in

package/bin/cli.mjs

@@ -32,6 +32,8 @@ async function main() {
   const template = fileURLToPath(new URL("../skill/flare-plugin/assets/github-template/", import.meta.url));
   const manifestPath = join(template, "manifest.json");
   const manifest = JSON.parse(await readFile(manifestPath, "utf8"));
+  const { version } = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8"));
+  manifest.$schema = `https://unpkg.com/flare-plugin-sdk@${version}/skill/flare-plugin/manifest.schema.json`;
   const identity = randomUUID().replaceAll("-", "");
   manifest.id = `local.plugin.p${identity}`;
   manifest.name = name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flare-plugin-sdk",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0-beta.6",
   "description": "Types, tooling, templates and authoring references for Flare plugins",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://github.com/DimensionDev/Flare#plugins-beta",
@@ -32,6 +32,7 @@
     "test": "node --test scripts/*.test.mjs"
   },
   "devDependencies": {
+    "ajv": "8.20.0",
     "typescript": "6.0.3"
   }
 }

package/skill/flare-plugin/README.md

@@ -204,6 +204,7 @@ is not a plugin installation URL. A GitHub Release or `.fpp` upload is unnecessa
 | Boundary contract and registration | [ABI.md](ABI.md) |
 | Exact JavaScript signatures and field comments | [flare-plugin.d.ts](flare-plugin.d.ts) |
 | Manifest fields, defaults, enums, and validation | [Manifest](references/manifest.md) |
+| JSON editor completion and static manifest checks | [JSON Schema](manifest.schema.json), [editor setup](references/manifest.md#json-schema-and-editor-support) |
 | All twelve capabilities, minimum methods, and UI requirements | [Capabilities](references/capabilities.md) |
 | Platform engines, async completion, HTTP, permissions, credentials, and state | [Runtime and HTTP](references/runtime-http.md) |
 | Detection and all five login methods | [Authentication](references/authentication.md) |

package/skill/flare-plugin/assets/github-template/README.md

@@ -13,6 +13,13 @@ inside `my-plugin` and keep its generated plugin/platform IDs. If you copied the
 template manually, first copy its contents to your repository root and replace
 the example `manifest.id`, `platform.id`, and names. Keep IDs stable for updates.
 
+The generated manifest's `$schema` is pinned to the SDK version that created it.
+Open `manifest.json` in VS Code or another JSON Schema editor for completion,
+field descriptions, enum choices and static errors. Flare treats the URL as
+metadata and never downloads it; actual registration and behavior are checked in
+Flare. See the [manifest editor guide](https://github.com/DimensionDev/Flare/blob/feature/plugin/feature/plugin/sdk/skill/flare-plugin/references/manifest.md#json-schema-and-editor-support)
+for offline use and older Flare builds that reject `$schema`.
+
 1. Update the description, login methods, and declared capabilities in
    `manifest.json`. Replace the one-pixel placeholder PNG with your own icon.
 2. Adapt `plugin.js` using the

package/skill/flare-plugin/assets/github-template/manifest.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://unpkg.com/flare-plugin-sdk@next/skill/flare-plugin/manifest.schema.json",
   "schemaVersion": 1,
   "apiVersion": 1,
   "id": "dev.example.flare.feed",

package/skill/flare-plugin/examples/pixelfed/manifest.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://unpkg.com/flare-plugin-sdk@next/skill/flare-plugin/manifest.schema.json",
   "schemaVersion": 1,
   "apiVersion": 1,
   "id": "dev.dimension.flare.sample.pixelfed",