Skip to content

SDK changelog

The six SDK packages (@plenary/core, @plenary/client, @plenary/react, @plenary/next, @plenary/nuxt, @plenary/cli) are released together under one version number. This page lists what changed in each release, newest first. Entries marked Breaking need a change on your side when you upgrade.

  • @plenary/client: new graphql(query, variables?, { operationName?, tags? }) runs an operation against the GraphQL API and resolves with its data. A declared $locale variable left unset is filled from the client’s locale. A response with errors rejects with the new PlenaryGraphQLError (code and vars from the first error’s extensions, plus the whole errors array and the partial data). tags goes out as next.tags on the request, since createTaggedFetch passes a GraphQL read through untagged.
  • @plenary/cli: new graphql <query> runs a query (inline, @file, or -) with --var name=value, --variables <json>, and --operation <name>, printing data and any errors as JSON; graphql schema prints the site’s SDL for code generators.
  • Breaking (server): the one-release GET /api/v1/content/{model_key}/entries/deleted alias is gone, and archived-entry rows no longer carry deleted_at. Read the list at …/entries/archived and the time from archived_at.
  • Breaking (server): the import-only messaging.email.* and messaging.sms.* blocks in plenary.yaml, and secrets.aws_credentials_file, are no longer read. A file that still carries them loads, and the keys are ignored. Email and SMS bindings are configured in Global Settings; the setup wizard still stores the email binding it collects. An installation whose bindings were never seeded from the file (one that has not booted on 0.10.0 or later) should enter them in Global Settings after upgrading.
  • @plenary/cli: Breaking. entries delete <id> no longer takes --permanent; it was the one-release guard and is now an unknown option. The command deletes permanently with or without it: check scripts that call entries delete and switch the ones that mean archive to entries archive.
  • Breaking (server): the one-release sites shims are gone. API key responses and GET /auth/me for a key no longer carry sites or site_count; read site_key. A key write that sends sites in place of site_key has it ignored: a public key is refused with api_key_sites_required, a private key becomes instance-wide (a super user’s alone). api_key_sites_multiple no longer exists. A model YAML file with a sites: list is refused as an unknown key (422 metadata_invalid); write site_key.
  • Server: the archived-entries list moved from GET /api/v1/content/{model_key}/entries/deleted to …/entries/archived, and each row now carries archived_at. Same gate, query, and rows otherwise. The old path and the old deleted_at field still answer in this release and go away in the next.
  • @plenary/cli: Breaking. entries delete <id> now deletes permanently (DELETE …?permanent=true: the entry and its revision history go, on a live or an archived entry, and cannot be restored). What it did before, archive the entry, is the new entries archive <id> [--note <text>] [-y]. For this release entries delete requires --permanent and exits 2 without it, with a hint to use entries archive, so a script written against the old command fails rather than purging; the flag goes away in the next release. entries delete no longer takes --note.
  • @plenary/cli: new entries archived <model> lists a model’s archived entries, and entries restore <id> brings one back as a draft.
  • New package @plenary/nuxt: a Nuxt module plus createRevalidateHandler from @plenary/nuxt/server, which turns entry webhooks into purges of Nitro’s response cache (swr/cache route rules and defineCachedEventHandler) for the entry’s paths. Same secret, paths, entryUrl, and events options as the Next.js handler; no tags, since Nitro’s cache has none.
  • @plenary/client: entryUrl and planRevalidation (with the RevalidateOptions, RevalidatePaths, and RevalidationPlan types) moved here from @plenary/next, which re-exports them unchanged. The client’s RevalidateOptions has no tags and its plan has no tags array; the @plenary/next versions still do.
  • @plenary/client: Entry gains draft — a published entry’s pending changes ({ data, slug, updated_at }) or null, present on reads through a private key. data and slug stay the live copy. A public key never sets it; a key with Include draft content reads the pending content in data and slug instead.
  • @plenary/cli: entries update on a published entry saves pending changes instead of changing the live copy, merges --data into the pending copy when there is one, and takes --publish to make the change live in a second call. entries publish on a published entry publishes its pending changes.
  • @plenary/cli: entries unpublish --draft merge|discard says what an entry with pending changes keeps when it leaves the site; without it the server refuses with entry_draft_pending.
  • @plenary/cli: new entries discard <id> drops a published entry’s pending changes.
  • @plenary/cli: entries list prints published* in the STATUS column for an entry with pending changes; get and export carry the draft subdocument.
  • @plenary/cli: entries import --upsert updates the entry each line’s slug names instead of failing with entry_slug_taken, so a seed file can be imported again.
  • @plenary/cli: new folders and media folders commands list, get, create, and delete content and media folders by id or path, and entries create/update and media upload take --folder-path in place of a folder id.
  • @plenary/cli: media upload --skip-existing skips a file whose name is already in the target folder and prints the existing asset’s id.
  • @plenary/react: image and file sub-fields inside a list prop’s items are resolved like top-level media props, in published renders and in the live preview, instead of arriving as a bare { media_id }.
  • @plenary/next: a read of one entry (getEntry, or listEntries with where: { slug } naming one slug) is tagged with that entry and the new plenary:model-entries:{model} tag instead of the model tag, so editing one entry no longer revalidates every entry’s page. The revalidate handler refreshes plenary:model-entries:{model} when an edit changes an entry’s slug or folder. A "use cache" function that reads one entry should tag it with modelEntriesTag(model) and entryTag(slug).
  • @plenary/client: where: { path: { $under: "/blog" } } now works. $under was not recognized inside a condition object, so the query was sent as a plain value and matched nothing.
  • @plenary/next: the default entryUrl revalidates / for a root-folder entry slugged home, instead of /home.
  • @plenary/cli: media upload sends each file’s MIME type, taken from its extension, instead of application/octet-stream.
  • @plenary/cli: entries list --include no longer fails in table mode when the included fields leave out a printed column; the column prints blank.
  • @plenary/cli: entries list on a singleton model says to use entries get <model> instead of failing.
  • @plenary/cli: api-keys create --site <key> reaches the server, and a public key falls back to the configured site when --site is absent.
  • @plenary/cli: Breaking. In api-keys create --grant, model= takes a model key, not a model id. It was silently ignored before, so a key created with it had no model filter: check existing keys with plenary api-keys get <id>.
  • @plenary/cli: media upload sends the configured site, so uploads work on instances with more than one site.
  • @plenary/cli: Breaking. The CLI reads its API key from PLENARY_CLI_API_KEY, no longer from PLENARY_API_KEY, so a site’s own key in the environment is never picked up by the CLI by accident.
  • @plenary/client, @plenary/next: Breaking. Webhook verification and both revalidate handlers refuse every delivery with 500 when the webhook secret is empty or unset, instead of accepting an empty header.
  • @plenary/cli: metadata pull, diff, and push work on the configured site; pass --all-sites for the whole instance (roles need it). --prune stays within that site.
  • @plenary/cli: models and forms commands are scoped to the configured site, since a model key is unique only within its site.
  • @plenary/cli: Breaking. api-keys create --site names the one site a key belongs to and is no longer repeatable.

Releases before 1.0.0 have no changelog.