@storyshelf/notify-git 0.0.0-stage → 0.6.2

package/dist/review-comment.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-comment.mjs","names":[],"sources":["../src/review-comment.ts"],"sourcesContent":["import type { Logger } from \"@storyshelf/core/logger\";\nimport { commentMarker } from \"./describe.ts\";\n\n/** A review thread (PR or MR) hosting a single StoryShelf comment. */\nexport interface ReviewThread {\n  /** List existing comments as id/body pairs. */\n  list(): Promise<{ id: string | number; body: string }[]>;\n  /** Replace the body of an existing comment, returning its id. */\n  update(id: string | number, body: string): Promise<string>;\n  /** Create a comment, returning its id. */\n  create(body: string): Promise<string>;\n}\n\n/** Dependencies for an idempotent review-comment upsert. */\nexport interface UpsertReviewCommentOptions {\n  /** Canonical build/review URL — anchors the idempotency marker. */\n  url: string;\n  /** Markdown body appended below the marker. */\n  markdown: string;\n  /** Known thread number, skipping the lookup when provided. */\n  prNumber?: number;\n  /** Commit SHA used for the thread lookup and log context. */\n  sha: string;\n  logger?: Logger;\n  /** Resolve the thread number for the commit (PR number or MR iid). */\n  resolveNumber: () => Promise<number | undefined>;\n  /** Open the thread's comment store once the number is known. */\n  thread: (number: number) => ReviewThread;\n}\n\n/** Resolve the thread number, preferring the explicit value. */\nasync function resolveThreadNumber(opts: UpsertReviewCommentOptions): Promise<number | undefined> {\n  return opts.prNumber ?? (await opts.resolveNumber());\n}\n\n/** Update the marked comment if present, else create it. */\nasync function findOrCreateComment(\n  thread: ReviewThread,\n  marker: string,\n  body: string,\n  prNumber: number,\n  logger?: Logger,\n): Promise<string> {\n  const existing = (await thread.list()).find((comment) => comment.body.includes(marker));\n  if (existing) {\n    const id = await thread.update(existing.id, body);\n    logger?.info({ prNumber, commentId: id }, \"review comment updated\");\n    return id;\n  }\n  const id = await thread.create(body);\n  logger?.info({ prNumber, commentId: id }, \"review comment created\");\n  return id;\n}\n\n/**\n * Create or update the single StoryShelf review comment for a build,\n * idempotent via the url marker. Returns the comment id, or `\"\"` when no\n * review thread exists for the commit.\n */\nexport async function upsertReviewComment(opts: UpsertReviewCommentOptions): Promise<string> {\n  const marker = commentMarker(opts.url);\n  const body = `${marker}\\n${opts.markdown}`;\n  const number = await resolveThreadNumber(opts);\n  if (number === undefined) {\n    opts.logger?.debug({ sha: opts.sha }, \"no review thread found for comment, skipping\");\n    return \"\";\n  }\n  try {\n    return await findOrCreateComment(opts.thread(number), marker, body, number, opts.logger);\n  } catch (error) {\n    opts.logger?.error({ err: error, prNumber: number }, \"failed to upsert review comment\");\n    throw error;\n  }\n}\n"],"mappings":";;;;;;AA+BA,eAAe,oBAAoB,MAA+D;CAChG,OAAO,KAAK,YAAa,MAAM,KAAK,cAAc;AACpD;;AAGA,eAAe,oBACb,QACA,QACA,MACA,UACA,QACiB;CACjB,MAAM,YAAY,MAAM,OAAO,KAAK,EAAA,CAAG,MAAM,YAAY,QAAQ,KAAK,SAAS,MAAM,CAAC;CACtF,IAAI,UAAU;EACZ,MAAM,KAAK,MAAM,OAAO,OAAO,SAAS,IAAI,IAAI;EAChD,QAAQ,KAAK;GAAE;GAAU,WAAW;EAAG,GAAG,wBAAwB;EAClE,OAAO;CACT;CACA,MAAM,KAAK,MAAM,OAAO,OAAO,IAAI;CACnC,QAAQ,KAAK;EAAE;EAAU,WAAW;CAAG,GAAG,wBAAwB;CAClE,OAAO;AACT;;;;;;AAOA,eAAsB,oBAAoB,MAAmD;CAC3F,MAAM,SAAS,cAAc,KAAK,GAAG;CACrC,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK;CAChC,MAAM,SAAS,MAAM,oBAAoB,IAAI;CAC7C,IAAI,WAAW,KAAA,GAAW;EACxB,KAAK,QAAQ,MAAM,EAAE,KAAK,KAAK,IAAI,GAAG,8CAA8C;EACpF,OAAO;CACT;CACA,IAAI;EACF,OAAO,MAAM,oBAAoB,KAAK,OAAO,MAAM,GAAG,QAAQ,MAAM,QAAQ,KAAK,MAAM;CACzF,SAAS,OAAO;EACd,KAAK,QAAQ,MAAM;GAAE,KAAK;GAAO,UAAU;EAAO,GAAG,iCAAiC;EACtF,MAAM;CACR;AACF"}

package/dist/state-adapter.mjs

@@ -0,0 +1,43 @@
+import "node:path";
+import "node:url";
+import.meta.url;
+import { describeState } from "./describe.mjs";
+//#region src/state-adapter.ts
+/** Build the runtime adapter that routes a target kind to the writer. */
+function createStateAdapter(metadata, writer, logger) {
+	return {
+		metadata,
+		async setState({ target, state, url }) {
+			if (target.kind === "status") {
+				await writer.status({
+					sha: target.sha,
+					context: target.context,
+					state,
+					description: target.description ?? describeState(state),
+					url,
+					progress: target.progress,
+					informational: target.informational,
+					annotations: target.annotations,
+					omitted: target.omitted
+				});
+				return;
+			}
+			if (url === void 0) return;
+			logger?.debug({ sha: target.sha }, "upserting review comment");
+			await writer.comment({
+				sha: target.sha,
+				url,
+				markdown: target.markdown
+			});
+		}
+	};
+}
+/** The channel's secret (token or private key), or an error naming the provider when the channel has none. */
+function requireToken(secret, provider, what = "a token") {
+	if (!secret) throw new Error(`${provider} channel needs ${what}`);
+	return secret;
+}
+//#endregion
+export { createStateAdapter, requireToken };
+
+//# sourceMappingURL=state-adapter.mjs.map

package/dist/state-adapter.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-adapter.mjs","names":[],"sources":["../src/state-adapter.ts"],"sourcesContent":["/** Shared `setState` routing for providers that write commit statuses and review comments. */\nimport type {\n  NotifierState,\n  StateAnnotation,\n  StateNotifierAdapter,\n  StateNotifierMetadata,\n} from \"@storyshelf/core/adapter/notifier\";\nimport type { Logger } from \"@storyshelf/core/logger\";\nimport { describeState } from \"./describe.ts\";\n\n/** What a host-specific writer does for each target kind. */\nexport interface StateWriter {\n  /** Set the commit status `context` on `sha`. */\n  status(input: {\n    sha: string;\n    context: string;\n    state: NotifierState;\n    description: string;\n    /** Absent while no public origin is known: the status has no link. */\n    url?: string | undefined;\n    /** For a `pending` state: not started (`queued`) or under way. */\n    progress?: \"queued\" | \"running\" | undefined;\n    /** Never a gate: a host with a neutral outcome shows a failure as neutral. */\n    informational?: boolean | undefined;\n    annotations?: StateAnnotation[] | undefined;\n    /** Changed snapshots left out of `annotations`. */\n    omitted?: number | undefined;\n  }): Promise<void>;\n  /** Create or update the single review comment of the build keyed by `url`. */\n  comment(input: { sha: string; url: string; markdown: string }): Promise<unknown>;\n}\n\n/** Build the runtime adapter that routes a target kind to the writer. */\nexport function createStateAdapter(\n  metadata: StateNotifierMetadata,\n  writer: StateWriter,\n  logger?: Logger,\n): StateNotifierAdapter {\n  return {\n    metadata,\n    async setState({ target, state, url }): Promise<void> {\n      if (target.kind === \"status\") {\n        await writer.status({\n          sha: target.sha,\n          context: target.context,\n          state,\n          description: target.description ?? describeState(state),\n          url,\n          progress: target.progress,\n          informational: target.informational,\n          annotations: target.annotations,\n          omitted: target.omitted,\n        });\n        return;\n      }\n      if (url === undefined) {\n        // The comment is keyed by the build's link; without a public origin there is none.\n        return;\n      }\n      logger?.debug({ sha: target.sha }, \"upserting review comment\");\n      await writer.comment({ sha: target.sha, url, markdown: target.markdown });\n    },\n  };\n}\n\n/** The channel's secret (token or private key), or an error naming the provider when the channel has none. */\nexport function requireToken(\n  secret: string | undefined,\n  provider: string,\n  what = \"a token\",\n): string {\n  if (!secret) {\n    throw new Error(`${provider} channel needs ${what}`);\n  }\n  return secret;\n}\n"],"mappings":";;;;;;AAiCA,SAAgB,mBACd,UACA,QACA,QACsB;CACtB,OAAO;EACL;EACA,MAAM,SAAS,EAAE,QAAQ,OAAO,OAAsB;GACpD,IAAI,OAAO,SAAS,UAAU;IAC5B,MAAM,OAAO,OAAO;KAClB,KAAK,OAAO;KACZ,SAAS,OAAO;KAChB;KACA,aAAa,OAAO,eAAe,cAAc,KAAK;KACtD;KACA,UAAU,OAAO;KACjB,eAAe,OAAO;KACtB,aAAa,OAAO;KACpB,SAAS,OAAO;IAClB,CAAC;IACD;GACF;GACA,IAAI,QAAQ,KAAA,GAEV;GAEF,QAAQ,MAAM,EAAE,KAAK,OAAO,IAAI,GAAG,0BAA0B;GAC7D,MAAM,OAAO,QAAQ;IAAE,KAAK,OAAO;IAAK;IAAK,UAAU,OAAO;GAAS,CAAC;EAC1E;CACF;AACF;;AAGA,SAAgB,aACd,QACA,UACA,OAAO,WACC;CACR,IAAI,CAAC,QACH,MAAM,IAAI,MAAM,GAAG,SAAS,iBAAiB,MAAM;CAErD,OAAO;AACT"}

package/dist/version.mjs

@@ -0,0 +1,12 @@
+import "node:path";
+import "node:url";
+import.meta.url;
+//#region src/version.ts
+/** The package version injected at build time (tsdown `define`), `0.0.0` in tests. */
+function packageVersion() {
+	return "0.6.2";
+}
+//#endregion
+export { packageVersion };
+
+//# sourceMappingURL=version.mjs.map

package/dist/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["/** Package version for provider metadata. */\ndeclare const __PKG_VERSION__: string | undefined;\n\n/** The package version injected at build time (tsdown `define`), `0.0.0` in tests. */\nexport function packageVersion(): string {\n  return typeof __PKG_VERSION__ === \"string\" ? __PKG_VERSION__ : \"0.0.0\";\n}\n"],"mappings":";;;;;AAIA,SAAgB,iBAAyB;CACvC,OAAA;AACF"}

package/package.json

@@ -1,6 +1,82 @@
 {
   "name": "@storyshelf/notify-git",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.6.2",
+  "description": "Git notification providers for StoryShelf: commit statuses and pull-request comments on GitHub and GitLab.",
+  "keywords": [
+    "ci",
+    "github",
+    "gitlab",
+    "merge-gate",
+    "notifications",
+    "self-hosted",
+    "storybook"
+  ],
+  "homepage": "https://github.com/GuptaSiddhant/StoryShelf#readme",
+  "bugs": {
+    "url": "https://github.com/GuptaSiddhant/StoryShelf/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Siddhant Gupta",
+    "url": "https://guptasiddhant.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GuptaSiddhant/StoryShelf.git",
+    "directory": "packages/notify-git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": "./dist/index.mjs",
+      "./package.json": "./package.json"
+    },
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown -w",
+    "fmt": "oxfmt ./src",
+    "lint": "oxlint --type-aware --type-check ./src",
+    "test": "vitest run",
+    "prepublishOnly": "nub run build"
+  },
+  "dependencies": {
+    "@storyshelf/core": "0.6.2",
+    "zod": "^4.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "@vitest/coverage-v8": "^4.0.0",
+    "oxfmt": "^0.65.0",
+    "oxlint": "^1.80.0",
+    "oxlint-tsgolint": "^7.0.2001",
+    "tsdown": "^0.22.14",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "jsr": {
+    "runtimeCompat": {
+      "node": true,
+      "deno": true,
+      "browser": false,
+      "workerd": false,
+      "bun": true
+    }
+  }
+}