@visulima/vis 2.0.0 → 2.0.2

package/dist/release/index.d.ts

@@ -16,12 +16,12 @@ interface ReleaseOptionsBase {
   /** Skip writes / network calls. */
   dryRun?: boolean;
   /**
-  * Greenfield bootstrap. Forces `currentVersionResolver: "disk"` and
-  * skips remote tag-collision checks so the very first release on a
-  * fresh repo (no prior git tag, no published version) can proceed
-  * without errors. Maps to `nx release --first-release` and
-  * release-please's `bootstrap-sha`.
-  */
+   * Greenfield bootstrap. Forces `currentVersionResolver: "disk"` and
+   * skips remote tag-collision checks so the very first release on a
+   * fresh repo (no prior git tag, no published version) can proceed
+   * without errors. Maps to `nx release --first-release` and
+   * release-please's `bootstrap-sha`.
+   */
   firstRelease?: boolean;
   /** Limit to packages matching these globs. */
   projects?: string[];
@@ -105,37 +105,37 @@ interface SnapshotResult {
 }
 declare const releaseVersion: (options?: VersionOptions) => Promise<VersionResult>;
 /**
-* Standalone changelog rendering — produces the per-package CHANGELOG.md
-* entries WITHOUT writing them to disk. Useful for previewing the
-* changelog output, or for downstream tooling (e.g. release-notes for
-* GH Releases) that needs the rendered content separately from the
-* version-apply pass.
-*
-* The default `releaseVersion` path also writes changelog entries
-* automatically (formatter is invoked inside `applyReleasePlan`); this
-* function is for read-only access to the same rendered output.
-*/
+ * Standalone changelog rendering — produces the per-package CHANGELOG.md
+ * entries WITHOUT writing them to disk. Useful for previewing the
+ * changelog output, or for downstream tooling (e.g. release-notes for
+ * GH Releases) that needs the rendered content separately from the
+ * version-apply pass.
+ *
+ * The default `releaseVersion` path also writes changelog entries
+ * automatically (formatter is invoked inside `applyReleasePlan`); this
+ * function is for read-only access to the same rendered output.
+ */
 declare const releaseChangelog: (options?: ChangelogOptions) => Promise<ChangelogResult>;
 declare const releasePublish: (options?: PublishOptions) => Promise<PublishResult>;
 /**
-* A computed-but-not-yet-applied release. Holds the resolved {@link ReleasePlan}
-* so callers can inspect what *would* happen, then either {@link ReleaseDraft.apply}
-* it (write versions + changelogs, consume change files) or {@link ReleaseDraft.discard}
-* it.
-*
-* Implements `Symbol.asyncDispose`, so the idiomatic form is:
-*
-* ```ts
-* await using draft = await releaseDraft({ cwd });
-* console.log(draft.plan.releases);
-* // draft.apply() runs automatically when the block exits — unless you
-* // called draft.discard() first.
-* ```
-*
-* Disposal fires on *any* scope exit, including thrown errors. If you need
-* apply-only-on-success semantics, call {@link ReleaseDraft.apply} explicitly
-* and `discard()` on the error path instead of relying on disposal.
-*/
+ * A computed-but-not-yet-applied release. Holds the resolved {@link ReleasePlan}
+ * so callers can inspect what *would* happen, then either {@link ReleaseDraft.apply}
+ * it (write versions + changelogs, consume change files) or {@link ReleaseDraft.discard}
+ * it.
+ *
+ * Implements `Symbol.asyncDispose`, so the idiomatic form is:
+ *
+ * ```ts
+ * await using draft = await releaseDraft({ cwd });
+ * console.log(draft.plan.releases);
+ * // draft.apply() runs automatically when the block exits — unless you
+ * // called draft.discard() first.
+ * ```
+ *
+ * Disposal fires on *any* scope exit, including thrown errors. If you need
+ * apply-only-on-success semantics, call {@link ReleaseDraft.apply} explicitly
+ * and `discard()` on the error path instead of relying on disposal.
+ */
 interface ReleaseDraft {
   /** Auto-apply on `await using` scope exit unless already applied or discarded. */
   [Symbol.asyncDispose]: () => Promise<void>;
@@ -163,43 +163,43 @@ declare class ReleaseClient {
   releaseSnapshot(options: Omit<SnapshotOptions, "config">): Promise<SnapshotResult>;
 }
 /**
-* Identity function for type-narrowing a `VisReleaseConfig` defined in
-* a separate file (e.g. `release.config.ts`). Use vis's top-level
-* `defineConfig` from `@visulima/vis/config` when defining the whole
-* `vis.config.ts` instead.
-*/
+ * Identity function for type-narrowing a `VisReleaseConfig` defined in
+ * a separate file (e.g. `release.config.ts`). Use vis's top-level
+ * `defineConfig` from `@visulima/vis/config` when defining the whole
+ * `vis.config.ts` instead.
+ */
 declare const defineReleaseConfig: (config: VisReleaseConfig) => VisReleaseConfig;
 /**
-* Built-in defaults. Used by the loader when a key is not set by the user
-* and must be in the resolved config.
-*/
+ * Built-in defaults. Used by the loader when a key is not set by the user
+ * and must be in the resolved config.
+ */
 declare const DEFAULT_CONFIG: Required<Pick<VisReleaseConfig, "baseBranch" | "changesDir" | "access" | "changelog" | "changedFilePatterns" | "updateInternalDependencies" | "fixed" | "linked" | "ignore" | "include" | "privatePackages" | "aggregateRelease" | "defaultManaged" | "allowCustomCommands" | "preVersionCommand" | "postVersionCommand" | "prePublishCommand" | "postPublishCommand">>;
 declare const DEFAULT_DEPENDENCY_BUMP_RULES: Required<DependencyBumpRules>;
 /**
-* Default fields stripped from `package.json` on publish (RFC §20.4).
-* Match `@anolilab/semantic-release-clean-package-json` behaviour.
-*/
+ * Default fields stripped from `package.json` on publish (RFC §20.4).
+ * Match `@anolilab/semantic-release-clean-package-json` behaviour.
+ */
 declare const DEFAULT_CLEAN_STRIP: ReadonlyArray<string>;
 /**
-* Default fields preserved on publish — informational, used only by `--dry-run` rendering.
-* The actual publish step strips by deny-list (`DEFAULT_CLEAN_STRIP`), not by allow-list.
-*/
+ * Default fields preserved on publish — informational, used only by `--dry-run` rendering.
+ * The actual publish step strips by deny-list (`DEFAULT_CLEAN_STRIP`), not by allow-list.
+ */
 declare const DEFAULT_CLEAN_KEEP: ReadonlyArray<string>;
 /**
-* Resolve user-supplied `cleanPackageJson` to a concrete strip list.
-* `false` → empty (don't strip anything).
-* `true` / undefined → defaults.
-* Object form → defaults + extra strip, minus anything in `keep`.
-*/
+ * Resolve user-supplied `cleanPackageJson` to a concrete strip list.
+ * `false` → empty (don't strip anything).
+ * `true` / undefined → defaults.
+ * Object form → defaults + extra strip, minus anything in `keep`.
+ */
 declare const resolveCleanStripList: (cfg: boolean | CleanPackageJsonConfig | undefined) => string[];
 /**
-* Typed errors for the release subsystem (RFC §19.4).
-*
-* Modeled on nx's `CreateNxReleaseConfigError`. Every failure path throws
-* a `VisReleaseError` with a stable `code` from `VisReleaseErrorCode`.
-* Codes are part of the public API surface — additions are minor, removals
-* are major (RFC §21.1).
-*/
+ * Typed errors for the release subsystem (RFC §19.4).
+ *
+ * Modeled on nx's `CreateNxReleaseConfigError`. Every failure path throws
+ * a `VisReleaseError` with a stable `code` from `VisReleaseErrorCode`.
+ * Codes are part of the public API surface — additions are minor, removals
+ * are major (RFC §21.1).
+ */
 type VisReleaseErrorCode = "AUTH_MISSING" | "DUPLICATE_PACKAGE_NAME" | "CYCLIC_DEPENDENCY" | "TAG_COLLISION" | "BUMP_FILE_INVALID" | "CONFIG_INVALID" | "GIT_OPERATION_FAILED" | "PM_VERSION_TOO_LOW" | "NATIVE_ADDON_VERSION_MISMATCH" | "PUBLISH_FAILED" | "STAGE_PENDING" | "TAG_PUSH_FAILED" | "STATE_FILE_CORRUPT";
 interface VisReleaseErrorOptions {
   /** Original error for stack-trace continuity. */

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

@@ -1,8 +1,8 @@
 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 { V as VersionActions } from "../packem_shared/interface.d-CrHOtJc1.js";
+export { A as AfterAllProjectsVersioned, type a as AfterAllVersionedContext, type b as AfterAllVersionedResult, type P as PublishContext } from "../packem_shared/interface.d-CrHOtJc1.js";
+export type { e as PublishResult } from "../packem_shared/interface.d-CRqRz4jt.js";
 export { d as defineReleasePlugin } from "../packem_shared/plugins.d-ND23R9I3.js";
 export type { PluginPackageInfo, PluginPublishSummary, ReleasePlugin, ReleasePluginContext } from "./types.js";
 interface NotificationPackage {
@@ -11,11 +11,11 @@ interface NotificationPackage {
   /** 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 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;
@@ -32,97 +32,97 @@ interface NotificationContext {
   /** 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.
-  */
+   * 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.
-*/
+ * 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 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.
-*/
+ * 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) });
-*     },
-* });
-* ```
-*/
+ * 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.
-*/
+ * 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());
-* ```
-*/
+ * 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.
-*/
+ * 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.
-*/
+ * 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 };