@visulima/vis 1.0.0-alpha.36 → 1.0.0-alpha.38

package/dist/release/plugin-sdk.d.ts

@@ -0,0 +1,127 @@
+import { C as ChangelogFormatter } from "../packem_shared/api.d-BPftyU9r.js";
+export type { b as ChangelogContext, c as ChangelogFormatterModule, d as ChangelogTarget } from "../packem_shared/api.d-BPftyU9r.js";
+import { V as VersionActions } from "../packem_shared/interface.d-Cezzifoh.js";
+export { A as AfterAllProjectsVersioned, type a as AfterAllVersionedContext, type b as AfterAllVersionedResult, type P as PublishContext } from "../packem_shared/interface.d-Cezzifoh.js";
+export type { e as PublishResult } from "../packem_shared/interface.d-B7VK2rcH.js";
+import "./types.js";
+interface NotificationPackage {
+  /** Package name. */
+  name: string;
+  /** dist-tag / channel name (`latest`, `alpha`, …). */
+  tag?: string;
+  /**
+  * URL of the published artifact (npm package page, GH release URL,
+  * etc.). Populated by `publishContext` after `createRemoteReleases`.
+  * May be absent when the registry has no canonical URL (e.g. a
+  * shell-publish target with no `checkPublished` lookup).
+  */
+  url?: string;
+  /** Resolved version. */
+  version: string;
+}
+interface NotificationContext {
+  /** Active channel name (`main`, `alpha`, …). Absent when no channel matched. */
+  channel?: string;
+  /** ISO-8601 wave-completion timestamp. */
+  completedAt: string;
+  /** Workspace name pulled from root `package.json#name`, when present. */
+  monorepoName?: string;
+  /** Packages that successfully published in this wave. */
+  published: ReadonlyArray<NotificationPackage>;
+  /** Repo slug (`owner/name`) for URL composition. */
+  repo?: string;
+  /**
+  * Packages skipped at the publish gate (stage-rejected / stage-timeout /
+  * already-published / etc.). Channel implementations decide whether to
+  * surface them.
+  */
+  skipped: ReadonlyArray<{
+    name: string;
+    reason: string;
+  }>;
+}
+/**
+* The contract a notification channel implements. Built-in channels
+* (slack, discord, webhook) implement this; custom plugins do too.
+*
+* Implementations MUST be idempotent — `dispatchNotifications` may be
+* retried after a partial failure, and posting the same release twice
+* is annoying.
+*/
+interface NotificationChannel {
+  /** Stable id used in log messages: `"slack"`, `"discord"`, `"webhook"`, …. */
+  readonly id: string;
+  /**
+  * Send the notification. Throw on hard failure (HTTP non-2xx,
+  * network error). The dispatcher catches and logs as a warn-level
+  * message; it does NOT propagate.
+  */
+  send: (context: NotificationContext) => Promise<void>;
+}
+/**
+* Re-export of {@link NotificationChannel} so plugin authors get the
+* full type from a single import path.
+*/
+/**
+* Identity wrapper that constrains its argument to a
+* {@link NotificationChannel}. Use as the default export of a custom
+* channel module so the type-system catches missing fields (e.g. no
+* `id` / no `send`) at the import site.
+*
+* ```ts
+* export default defineNotificationChannel({
+*     id: "teams",
+*     async send(context) {
+*         await fetch(WEBHOOK, { body: JSON.stringify(context) });
+*     },
+* });
+* ```
+*/
+declare const defineNotificationChannel: (channel: NotificationChannel) => NotificationChannel;
+/**
+* Re-export the shapes a `VersionActions` implementation interacts
+* with. `PublishContext` carries everything you need at publish time
+* (the package, the resolved version, workspace + per-package config);
+* `PublishResult` is the typed return shape.
+*/
+/**
+* Identity wrapper that constrains its argument to a concrete
+* {@link VersionActions} subclass instance.
+*
+* Most authors will subclass `VersionActions` directly because it's an
+* abstract class with two abstract methods. `defineVersionActions` is
+* still useful as a type-narrowed default-export wrapper that surfaces
+* a clearer compile error when the subclass forgets `id` /
+* `readPublishedVersion` / `publish`:
+*
+* ```ts
+* class TeamsActions extends VersionActions {
+*     readonly id = "teams";
+*     async readPublishedVersion() { return undefined; }
+*     async publish(context: PublishContext): Promise&lt;PublishResult> { ... }
+* }
+*
+* export default defineVersionActions(new TeamsActions());
+* ```
+*/
+declare const defineVersionActions: (actions: VersionActions) => VersionActions;
+/**
+* Re-export of the changelog formatter contract — same shape as
+* `@visulima/vis/release/types` exposes, surfaced here so plugin authors
+* never need a second import path.
+*/
+/**
+* Identity wrapper around a {@link ChangelogFormatter}.
+*
+* ```ts
+* export default defineChangelogFormatter(async (context) => {
+*     return `### ${context.release.name} ${context.release.newVersion}\n…`;
+* });
+* ```
+*
+* Aliased to the historical `defineFormatter` export from
+* `core/changelog/api` so existing user code continues to type-check;
+* future plugin authors should prefer the SDK name for clarity.
+*/
+declare const defineChangelogFormatter: (formatter: ChangelogFormatter) => ChangelogFormatter;
+export { type ChangelogFormatter, type NotificationChannel, type NotificationContext, type NotificationPackage, VersionActions, defineChangelogFormatter, defineNotificationChannel, defineVersionActions };

package/dist/release/plugin-sdk.js

@@ -0,0 +1 @@
+import{AfterAllProjectsVersioned as s,VersionActions as f}from"../packem_shared/AfterAllProjectsVersioned-CAKI2nWf.js";const o=e=>e,n=e=>e,i=e=>e;export{s as AfterAllProjectsVersioned,f as VersionActions,i as defineChangelogFormatter,o as defineNotificationChannel,n as defineVersionActions};

package/dist/release/presets.d.ts

@@ -0,0 +1,225 @@
+import { ExtraFileRule, PerPackageReleaseConfig } from "./types.js";
+interface CargoPresetOptions {
+  /** Crate directory (containing Cargo.toml). Default: package root. */
+  crateDir?: string;
+  /** Additional extra-files rules merged with the Cargo.toml bump. */
+  extraFiles?: ExtraFileRule[];
+}
+/**
+* Bump `version = "..."` in the `[package]` section of Cargo.toml AND
+* default `versionActions: "cargo"` so vis drives `cargo publish`
+* natively (TOML parse + crates.io API + OIDC trusted publishing).
+*
+* The `[dependencies]`, `[workspace.dependencies]` sections, etc.,
+* are deliberately not touched by the extra-files rule — those
+* reference SemVer ranges of other crates and need explicit operator
+* opt-in to mutate.
+*
+* Operators who want to override the publish behaviour (e.g. push to a
+* private registry via a wrapper script) can set
+* `versionActions: "shell"` and supply their own `publishCommand`
+* downstream — the preset is a default, not a hard wire.
+*/
+declare const cargo: (options?: CargoPresetOptions) => PerPackageReleaseConfig;
+interface PyprojectPresetOptions {
+  /** Optional dynamic-version source line we should NOT touch (e.g. `__init__.py`). */
+  extraFiles?: ExtraFileRule[];
+  /** Project root (containing pyproject.toml). Default: package root. */
+  projectDir?: string;
+  /**
+  * Relative path (from the package directory) to `uv.lock`. Recorded
+  * on the per-package config so doctor can warn when the lockfile
+  * is missing despite the operator configuring uv-aware tooling.
+  *
+  * vis does NOT mutate `uv.lock` itself — uv regenerates it on
+  * `uv sync` / `uv build`. Operators who want the lockfile in the
+  * release commit should run `uv lock` between `vis release version`
+  * and the commit step (typically via `postVersionCommand`).
+  *
+  * release-please parity: #2561.
+  */
+  uvLockPath?: string;
+  /**
+  * Mark this package as a uv workspace member. `root` is the
+  * relative path (from the package directory) to the workspace root
+  * containing the `[tool.uv.workspace]` pyproject.toml — typically
+  * `".."` or higher. When set, doctor verifies the root's
+  * `[tool.uv.workspace] members` lists this package.
+  *
+  * release-please parity: #2560.
+  */
+  uvWorkspace?: {
+    root: string;
+  };
+}
+/**
+* Bump `version = "..."` under `[project]` (PEP 621) AND default
+* `versionActions: "python"` so vis drives the publish step natively
+* (PyPI version detection via JSON API + `python -m build` / `uv build`
+* + `twine upload` / `uv publish` + OIDC trusted-publishing support).
+*
+* Modern packaging (poetry / hatch / pdm / setuptools-with-pyproject)
+* all read this field. Legacy `setup.py` projects can pair this with
+* an explicit `extra-files` rule against `setup.py`.
+*
+* Operators on a dynamic-version path (setuptools-scm / hatch-vcs /
+* poetry-dynamic-versioning) should override `versionActions: "shell"`
+* — `PythonVersionActions` refuses dynamic versioning to avoid running
+* arbitrary build-backend code just to read a literal version.
+*/
+declare const pyproject: (options?: PyprojectPresetOptions) => PerPackageReleaseConfig;
+interface GradlePropertiesPresetOptions {
+  extraFiles?: ExtraFileRule[];
+  /** Path to gradle.properties. Default: package root. */
+  projectDir?: string;
+  /** Property name to bump. Default `"version"`. */
+  property?: string;
+}
+/**
+* Bump a `version=...` line in `gradle.properties`. The default
+* property name matches the Gradle convention for the root project
+* version. Submodule versions typically live in `build.gradle` /
+* `build.gradle.kts` — use a custom extra-files rule for those.
+*/
+declare const gradleProperties: (options?: GradlePropertiesPresetOptions) => PerPackageReleaseConfig;
+interface PomXmlPresetOptions {
+  extraFiles?: ExtraFileRule[];
+  /** Path to the pom.xml. Default: package root. */
+  pomDir?: string;
+}
+/**
+* Bump `<version>...</version>` directly under `<project>` in a Maven
+* `pom.xml`. ⚠ XML doesn't lend itself to surgical regex — this
+* preset matches the FIRST `<version>...</version>` tag in the file,
+* which is the convention for the project version. If your pom has
+* `<parent><version>` ahead of the project version, write an explicit
+* rule instead.
+*
+* Defaults `versionActions: "maven"` so vis can read the currently-
+* published version from Maven Central. Native publishing is not yet
+* implemented — Stage 3 ships the skeleton (read + already-published
+* detection); see `docs/guides/release-maven.mdx` for the shell-path
+* workaround (`mvn deploy`) until the Sonatype Central Portal client
+* lands.
+*/
+declare const pomXml: (options?: PomXmlPresetOptions) => PerPackageReleaseConfig;
+interface ContainerPresetOptions {
+  /**
+  * Extra `--build-arg KEY=VALUE` pairs forwarded to buildx. Useful
+  * for stamping the version literal into the image at build time.
+  */
+  buildArgs?: Record<string, string>;
+  /**
+  * Build context passed to `docker buildx build` (the final positional
+  * argument). Defaults to the package directory.
+  */
+  buildContext?: string;
+  extraFiles?: ExtraFileRule[];
+  /** Fully-qualified image reference, e.g. `"ghcr.io/scope/foo"`. */
+  image: string;
+  /**
+  * Target platforms for the multi-arch build. Defaults to
+  * `["linux/amd64", "linux/arm64"]`.
+  */
+  platforms?: ReadonlyArray<string>;
+  /**
+  * Signing scheme to apply after a successful push. `"cosign"` runs
+  * `cosign sign --yes &lt;image>:&lt;version>` post-push. Default: no signing.
+  */
+  signing?: "cosign";
+  /**
+  * Skip the conventional `:latest` tag. Useful for pre-release /
+  * channel-specific images that shouldn't float `latest`.
+  */
+  skipLatest?: boolean;
+}
+/**
+* OCI container preset — wires the `container` versionActions plus a
+* package-specific `containerImage` declaration.
+*
+* Example:
+*
+*     release.packages["@scope/app-image"] = container({
+*         image: "ghcr.io/scope/app",
+*         platforms: ["linux/amd64", "linux/arm64"],
+*         signing: "cosign",
+*     });
+*
+* Pair with `releaseTagPattern: "{name}@{version}"` (the default) for
+* a parallel git tag, plus `docker login &lt;registry>` before running
+* `vis release publish`. The published image gets both `:&lt;version>`
+* (immutable pointer) and `:latest` (mutable, disable via
+* `skipLatest: true`).
+*/
+declare const container: (options: ContainerPresetOptions) => PerPackageReleaseConfig;
+interface JsrPresetOptions {
+  /**
+  * Convenience for adding `--allow-slow-types` to `jsr publish`. JSR
+  * rejects packages whose exported API has types it can't statically infer
+  * unless this flag is set. Default `false`.
+  */
+  allowSlowTypes?: boolean;
+  /**
+  * When `true`, also write the version literal into `deno.json` (in
+  * addition to `jsr.json`). Useful for Deno-flavoured packages that
+  * keep their full Deno config in `deno.json` and use `jsr.json` only
+  * for the JSR manifest itself. Default `false`.
+  *
+  * When the package uses `deno.json` as its sole JSR manifest, pass
+  * `manifestPath: "deno.json"` instead — that points the
+  * versionActions reader and the extra-files rule at the same file.
+  */
+  deno?: boolean;
+  extraFiles?: ExtraFileRule[];
+  /**
+  * Relative path to the JSR manifest. Default `"jsr.json"`. Pass
+  * `"deno.json"` for Deno-flavoured packages that use it as the
+  * primary JSR manifest.
+  */
+  manifestPath?: string;
+  /**
+  * Extra arguments forwarded verbatim to `jsr publish` (e.g.
+  * `["--allow-slow-types"]`). `--allow-dirty` is always passed by vis and
+  * need not be listed. Merged after the `allowSlowTypes` shorthand.
+  */
+  publishArgs?: string[];
+}
+/**
+* Bump `"version": "..."` in a JSR manifest (`jsr.json` or `deno.json`)
+* AND default `versionActions: "jsr"` so vis drives `npx jsr publish`
+* natively (jsr.io metadata lookup + OIDC trusted publishing + JSR's
+* scoped-name validation).
+*
+* JSR is Deno's package registry (jsr.io). Operators publish via
+* `npx jsr publish` after authoring `jsr.json` (or `deno.json` for
+* Deno-flavoured packages); the manifest uses PEP 621-style fields
+* (`name`, `version`, `exports`).
+*
+* The default rule matches the FIRST `"version": "..."` line in the
+* JSON file, which is the convention for the project version under
+* `name`. If your manifest has nested objects with their own
+* `"version"` keys, write a more specific rule.
+*
+* Operators who need to bump BOTH `jsr.json` AND `deno.json` (because
+* the package keeps a separate Deno config) can pass `deno: true` —
+* the preset emits an extra rule against `deno.json` alongside the
+* primary `jsr.json` bump.
+*/
+declare const jsr: (options?: JsrPresetOptions) => PerPackageReleaseConfig;
+interface GoModPresetOptions {
+  extraFiles?: ExtraFileRule[];
+  /** Path to go.mod. Default: package root. */
+  modDir?: string;
+}
+/**
+* Go doesn't carry a version in `go.mod` — versions are SemVer git
+* tags exclusively (`v1.2.3`). This preset is a no-op for the
+* manifest; pair it with `releaseTagPattern: "v{version}"` for proper
+* Go module compatibility. The helper still exists so the config
+* shape is symmetric with the other ecosystems.
+*
+* If you need to update a `pkg.Version` constant in `version.go`,
+* pass it via `extraFiles`.
+*/
+declare const goMod: (options?: GoModPresetOptions) => PerPackageReleaseConfig;
+export { CargoPresetOptions, ContainerPresetOptions, GoModPresetOptions, GradlePropertiesPresetOptions, JsrPresetOptions, PomXmlPresetOptions, PyprojectPresetOptions, cargo, container, goMod, gradleProperties, jsr, pomXml, pyproject };

package/dist/release/presets.js

@@ -0,0 +1 @@
+const a=(r={})=>{const s=r.crateDir?`${r.crateDir}/Cargo.toml`:"Cargo.toml";return{cargoTomlPath:s,extraFiles:[{flags:"m",path:s,replace:"$1{version}$3",search:String.raw`^(version\s*=\s*")([^"]+)(")`},...r.extraFiles??[]],versionActions:"cargo"}},i=(r={})=>({extraFiles:[{flags:"m",path:r.projectDir?`${r.projectDir}/pyproject.toml`:"pyproject.toml",replace:"$1{version}$3",search:String.raw`^(version\s*=\s*")([^"]+)(")`},...r.extraFiles??[]],...r.projectDir?{pythonProjectDir:r.projectDir}:{},...r.uvLockPath?{uvLockPath:r.uvLockPath}:{},...r.uvWorkspace?{uvWorkspace:r.uvWorkspace}:{},versionActions:"python"}),n=(r={})=>{const s=r.projectDir?`${r.projectDir}/gradle.properties`:"gradle.properties",o=r.property??"version";return{extraFiles:[{flags:"m",path:s,replace:`${o}={version}`,search:String.raw`^${o}\s*=.*$`},...r.extraFiles??[]]}},l=(r={})=>({extraFiles:[{flags:"",path:r.pomDir?`${r.pomDir}/pom.xml`:"pom.xml",replace:"$1{version}$3",search:"(<version>)([^<]+)(</version>)"},...r.extraFiles??[]],versionActions:"maven"}),c=r=>({buildContext:r.buildContext,containerBuildArgs:r.buildArgs,containerImage:r.image,containerPlatforms:r.platforms,containerSigning:r.signing,containerSkipLatest:r.skipLatest,extraFiles:r.extraFiles??[],versionActions:"container"}),p=(r={})=>{const s=r.manifestPath??"jsr.json",o={flags:"m",path:s,replace:"$1{version}$3",search:String.raw`^(\s*"version"\s*:\s*")([^"]+)(")`},e=r.deno&&s!=="deno.json"?{flags:"m",path:"deno.json",replace:"$1{version}$3",search:String.raw`^(\s*"version"\s*:\s*")([^"]+)(")`}:void 0,t=[...r.allowSlowTypes?["--allow-slow-types"]:[],...r.publishArgs??[]];return{extraFiles:[o,...e?[e]:[],...r.extraFiles??[]],jsrConfigPath:s,...t.length>0?{jsrPublishArgs:t}:{},versionActions:"jsr"}},g=(r={})=>({extraFiles:r.extraFiles??[]});export{a as cargo,c as container,g as goMod,n as gradleProperties,p as jsr,l as pomXml,i as pyproject};