@octalmesh/seagull-core 0.0.2 → 0.1.1

package/src/test-support/fixtures.ts

@@ -0,0 +1,65 @@
+import type {
+  ResolvedArtifact,
+  ResolvedContract,
+  ResolvedPublishing,
+} from "../config/types";
+
+/**
+ * Builds a {@link ResolvedPublishing} fixture with sensible defaults,
+ * overridable per-field - used across generator/readme/patcher tests so each
+ * test only has to spell out the fields it actually cares about.
+ */
+export function makePublishing(
+  overrides: Partial<ResolvedPublishing> = {},
+): ResolvedPublishing {
+  return {
+    branch: "sdk/svc-auth/ts-client",
+    tagTemplate: "svc-{service}-{id}-v{version}",
+    repositoryUrl: "https://github.com/OctalMesh/ows-contracts",
+    npmRegistry: "https://npm.pkg.github.com",
+    npmAccess: "public",
+    mavenRepositoryId: "github",
+    mavenRepositoryUrl: "https://maven.pkg.github.com/OctalMesh/ows-contracts",
+    ...overrides,
+  };
+}
+
+/**
+ * Builds a {@link ResolvedArtifact} fixture, defaulting to a TypeScript
+ * client artifact - overridable per-field for other lang/kind/tool
+ * combinations.
+ */
+export function makeArtifact(
+  overrides: Partial<ResolvedArtifact> = {},
+): ResolvedArtifact {
+  return {
+    id: "ts-client",
+    tool: "openapi-generator",
+    lang: "typescript",
+    kind: "client",
+    generator: "typescript-fetch",
+    outputDir: "/tmp/dist/sdk/auth/ts-client",
+    branch: "sdk/svc-auth/ts-client",
+    publishing: makePublishing(),
+    additionalProperties: {},
+    package: "@octalmesh/auth-client",
+    ...overrides,
+  };
+}
+
+/**
+ * Builds a {@link ResolvedContract} fixture containing a single artifact by
+ * default.
+ */
+export function makeContract(
+  overrides: Partial<ResolvedContract> = {},
+): ResolvedContract {
+  return {
+    name: "auth",
+    title: "Auth Service API",
+    entrypoint: "/repo/specs/auth/openapi.yaml",
+    entrypointRelative: "specs/auth/openapi.yaml",
+    artifacts: [makeArtifact()],
+    ...overrides,
+  };
+}

package/src/version/version.test.ts

@@ -0,0 +1,93 @@
+import { createHash } from "node:crypto";
+
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+import { hashSpec, resolveVersion } from "./version";
+
+describe("resolveVersion", () => {
+  const originalOverride = process.env.SDK_VERSION_OVERRIDE;
+
+  beforeEach(() => {
+    delete process.env.SDK_VERSION_OVERRIDE;
+  });
+
+  afterEach(() => {
+    if (originalOverride === undefined) {
+      delete process.env.SDK_VERSION_OVERRIDE;
+    } else {
+      process.env.SDK_VERSION_OVERRIDE = originalOverride;
+    }
+  });
+
+  it("returns info.version from the spec, stripped of a leading 'v'", () => {
+    expect(resolveVersion({ info: { version: "1.2.3" } }, "auth")).toBe(
+      "1.2.3",
+    );
+    expect(resolveVersion({ info: { version: "v1.2.3" } }, "auth")).toBe(
+      "1.2.3",
+    );
+  });
+
+  it("trims whitespace around info.version", () => {
+    expect(resolveVersion({ info: { version: "  1.0.0  " } }, "auth")).toBe(
+      "1.0.0",
+    );
+  });
+
+  it("throws a descriptive error when info.version is missing", () => {
+    expect(() => resolveVersion({}, "auth")).toThrow(
+      /specs\/auth\/openapi\.yaml is missing "info\.version"/,
+    );
+  });
+
+  it("throws when info.version is present but empty/whitespace-only", () => {
+    expect(() =>
+      resolveVersion({ info: { version: "   " } }, "catalog"),
+    ).toThrow(/specs\/catalog\/openapi\.yaml is missing "info\.version"/);
+  });
+
+  it("SDK_VERSION_OVERRIDE bypasses info.version entirely", () => {
+    process.env.SDK_VERSION_OVERRIDE = "9.9.9";
+
+    expect(resolveVersion({}, "auth")).toBe("9.9.9");
+    expect(resolveVersion({ info: { version: "1.0.0" } }, "auth")).toBe(
+      "9.9.9",
+    );
+  });
+
+  it("strips a leading 'v' from SDK_VERSION_OVERRIDE too", () => {
+    process.env.SDK_VERSION_OVERRIDE = "v2.0.0";
+
+    expect(resolveVersion({}, "auth")).toBe("2.0.0");
+  });
+
+  it("treats a blank SDK_VERSION_OVERRIDE as unset", () => {
+    process.env.SDK_VERSION_OVERRIDE = "   ";
+
+    expect(() => resolveVersion({}, "auth")).toThrow(
+      /is missing "info\.version"/,
+    );
+  });
+});
+
+describe("hashSpec", () => {
+  it("computes a stable sha256 hex digest of the raw content", () => {
+    const raw = '{"info":{"version":"1.0.0"}}';
+
+    expect(hashSpec(raw)).toBe(createHash("sha256").update(raw).digest("hex"));
+  });
+
+  it("is deterministic for the same input", () => {
+    const raw = '{"a":1}';
+
+    expect(hashSpec(raw)).toBe(hashSpec(raw));
+  });
+
+  it("produces different hashes for different content", () => {
+    expect(hashSpec('{"a":1}')).not.toBe(hashSpec('{"a":2}'));
+  });
+
+  it("is sensitive to whitespace differences (raw text, not semantic JSON)", () => {
+    expect(hashSpec('{"a":1}')).not.toBe(hashSpec('{ "a": 1 }'));
+  });
+});

package/src/version/version.ts

@@ -54,12 +54,14 @@ export function resolveVersion(
 }
 
 /**
- * Computes a stable content hash of a bundled OpenAPI document's raw JSON text.
+ * Computes a stable content hash of a bundled OpenAPI document's raw file
+ * contents (JSON or YAML, whichever `paths.specFormat` produced).
+ *
  * Stamped alongside `VERSION` into every generated SDK package so
  * `publish-sdk.ts` can tell a genuine no-op republish (same spec, same version)
  * apart from a spec that changed without its `info.version` being bumped.
  *
- * @param raw - The raw bundled spec file contents (JSON text).
+ * @param raw - The raw bundled spec file contents.
  * @returns A `sha256` hex digest of the raw contents.
  */
 export function hashSpec(raw: string): string {