@tsdoctor/manifest 0.1.0

package/BundleManifest.js

@@ -0,0 +1,209 @@
+import { Effect, Schema } from "effect";
+
+//#region src/BundleManifest.ts
+/**
+* The registry protocol families this reader knows how to do more than link
+* to. `"npm"` means an npm-compatible registry — install commands and tarball
+* fetching work against any instance of it — and `"jsr"` the jsr protocol.
+*
+* @remarks
+* The manifest's `type` field is deliberately NOT constrained to these
+* values: unknown future types must degrade to link-only rendering, not
+* reject the manifest. Use {@link isKnownRegistryType} to branch.
+*
+* @public
+*/
+const KNOWN_REGISTRY_TYPES = ["npm", "jsr"];
+/**
+* Whether a registry `type` value is a protocol family this reader
+* recognizes. `false` means the registry entry should degrade to link-only
+* rendering — it is never a validation failure.
+*
+* @public
+*/
+function isKnownRegistryType(type) {
+	return KNOWN_REGISTRY_TYPES.includes(type);
+}
+/**
+* One registry the documented package is published to.
+*
+* @remarks
+* `type` is the PROTOCOL FAMILY (`"npm"` covers every npm-compatible
+* registry), `name` the human instance label, `url` the package's page on
+* that instance. Unknown `type` values decode successfully and degrade to
+* link-only rendering (see {@link isKnownRegistryType}).
+*
+* @public
+*/
+const RegistryRef = Schema.Struct({
+	/** The protocol family, e.g. `"npm"` or `"jsr"`. Unknown values are accepted. */
+	type: Schema.String,
+	/** The human instance label, e.g. `"npm"` or `"Savvy Web Registry"`. */
+	name: Schema.String,
+	/** The package's URL on that registry instance. */
+	url: Schema.String
+});
+/**
+* One Open Graph image declared by the manifest.
+*
+* @remarks
+* Exactly ONE of `path` (a bundle-relative asset the consuming platform
+* publishes and resolves to a URL) or `url` (an absolute external URL used
+* verbatim) must be present — the schema enforces the XOR. `type` is a MIME
+* type, inferred from the file extension by the resolver when omitted; `alt`
+* has a documented inference chain (tagline → description →
+* `"<name> API documentation"`).
+*
+* @public
+*/
+const OpenGraphImage = Schema.Struct({
+	/** Bundle-relative asset path. Mutually exclusive with `url`. */
+	path: Schema.optionalKey(Schema.String),
+	/** Absolute external URL, used verbatim. Mutually exclusive with `path`. */
+	url: Schema.optionalKey(Schema.String),
+	/** MIME type; inferred from the extension when omitted. */
+	type: Schema.optionalKey(Schema.String),
+	/** Pixel width; 1200×630 (1.91:1) is the cross-platform safe default. */
+	width: Schema.optionalKey(Schema.Int),
+	/** Pixel height. */
+	height: Schema.optionalKey(Schema.Int),
+	/** Alt text; inferred (tagline → description → fallback) when omitted. */
+	alt: Schema.optionalKey(Schema.String)
+}).check(Schema.makeFilter((image) => image.path === void 0 !== (image.url === void 0) ? void 0 : "exactly one of \"path\" or \"url\" must be present", { title: "openGraph image source" }));
+/**
+* The manifest's Open Graph block: the asset-ish pieces only — most OG tags
+* are page-level and derive at render time in the consuming platform.
+*
+* @remarks
+* Multiple images follow OG array semantics: the first declared wins, extras
+* are alternates (e.g. a portrait 1000×1500 variant).
+*
+* @public
+*/
+const OpenGraphConfig = Schema.Struct({
+	/** Declared images, first-wins per OG array semantics. */
+	images: Schema.optionalKey(Schema.Array(OpenGraphImage)),
+	/** Embed accent color (e.g. Discord), a CSS color string. */
+	themeColor: Schema.optionalKey(Schema.String)
+});
+/**
+* A pointer to the bundle's SBOM, computed by the bundler at publish and
+* served as a downloadable static asset.
+*
+* @public
+*/
+const SbomRef = Schema.Struct({
+	/** Bundle-relative path to the SBOM file. */
+	path: Schema.String,
+	/** SBOM format label, e.g. `"spdx-json"`. Unknown values are accepted. */
+	format: Schema.optionalKey(Schema.String)
+});
+/**
+* The inherited project tier, flattened into the emitted manifest by the
+* bundler (a fetched bundle has no parent directory to walk). Kept nested —
+* structurally distinguishable from the leaf fields — because provenance is
+* load-bearing for override detection.
+*
+* @public
+*/
+const ProjectIdentity = Schema.Struct({
+	/** The project display name, e.g. `"Effected"` over leaf `@effected/store`. */
+	name: Schema.optionalKey(Schema.String),
+	/** The project tagline. */
+	tagline: Schema.optionalKey(Schema.String)
+});
+/**
+* The versioned `tsdoctor.json` sidecar manifest — bundle layer 3.
+*
+* @remarks
+* `spec` is the only required field; every other field enriches. Unknown
+* top-level fields are ignored on decode (additive fields are minor spec
+* revisions) and unknown enum-ish values (registry `type`, sbom `format`)
+* degrade gracefully instead of rejecting — an old reader must be able to
+* consume a new bundle.
+*
+* @public
+*/
+const BundleManifest = Schema.Struct({
+	/** The integer spec version. This reader understands spec 1. */
+	spec: Schema.Literal(1),
+	/** Human display name (the npm name is dry; this one is SEO-friendly). */
+	name: Schema.optionalKey(Schema.String),
+	/** Short tagline. */
+	tagline: Schema.optionalKey(Schema.String),
+	/** Long description; overrides the package.json description when present. */
+	description: Schema.optionalKey(Schema.String),
+	/** The inherited project tier, flattened in at emit time. */
+	project: Schema.optionalKey(ProjectIdentity),
+	/** Open Graph assets. */
+	openGraph: Schema.optionalKey(OpenGraphConfig),
+	/** SBOM pointer. */
+	sbom: Schema.optionalKey(SbomRef),
+	/** Registries the package is published to. */
+	registries: Schema.optionalKey(Schema.Array(RegistryRef))
+});
+/**
+* Raised when a present `tsdoctor.json` cannot be parsed or does not satisfy
+* the {@link (BundleManifest:variable)} schema.
+*
+* @remarks
+* Absence of the manifest is NEVER this error — layers enrich, never gate,
+* so a missing sidecar is the normal case and reads as `Option.none()`.
+*
+* @public
+*/
+var BundleManifestError = class extends Schema.TaggedError()("BundleManifestError", {
+	/** The manifest file path, when the failure is tied to a file on disk. */
+	path: Schema.optionalKey(Schema.String),
+	/** The underlying failure (JSON syntax or schema decode), preserved structurally. */
+	cause: Schema.Defect()
+}) {
+	get message() {
+		return `Invalid tsdoctor.json manifest${this.path !== void 0 ? ` at ${this.path}` : ""}`;
+	}
+};
+/**
+* Decode an unknown value into a {@link (BundleManifest:type)}.
+*
+* @remarks
+* The typed boundary for manifest input that has already been parsed from
+* JSON (plugin options, fetched payloads). File-based reading lives in
+* `readBundle`, which routes through this after parsing.
+*
+* @public
+*/
+function decodeBundleManifest(input, path) {
+	return Schema.decodeUnknownEffect(BundleManifest)(input).pipe(Effect.mapError((cause) => new BundleManifestError({
+		...path !== void 0 ? { path } : {},
+		cause
+	})));
+}
+/**
+* The manifest spec version this package reads and writes.
+*
+* @public
+*/
+const MANIFEST_SPEC = 1;
+/**
+* The sidecar manifest's file name inside a bundle folder.
+*
+* @public
+*/
+const TSDOCTOR_MANIFEST_FILENAME = "tsdoctor.json";
+/**
+* Encode a {@link (BundleManifest:type)} into the JSON-ready value a writer
+* serializes as `tsdoctor.json`.
+*
+* @remarks
+* The writer's boundary. Going through the schema rather than
+* `JSON.stringify` means an emitted file is by construction what
+* {@link decodeBundleManifest} accepts.
+*
+* @public
+*/
+function encodeBundleManifest(manifest) {
+	return Schema.encodeEffect(BundleManifest)(manifest).pipe(Effect.mapError((cause) => new BundleManifestError({ cause })));
+}
+
+//#endregion
+export { BundleManifest, BundleManifestError, KNOWN_REGISTRY_TYPES, MANIFEST_SPEC, OpenGraphConfig, OpenGraphImage, ProjectIdentity, RegistryRef, SbomRef, TSDOCTOR_MANIFEST_FILENAME, decodeBundleManifest, encodeBundleManifest, isKnownRegistryType };

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 C. Spencer Beggs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/ManifestSource.js

@@ -0,0 +1,38 @@
+import { BundleManifest, BundleManifestError } from "./BundleManifest.js";
+import { Effect, Schema } from "effect";
+
+//#region src/ManifestSource.ts
+/**
+* The shape an author checks in as a `tsdoctor.json` SOURCE file, at a
+* package root (the leaf tier) or a workspace root (the project tier).
+*
+* @remarks
+* `BundleManifest` minus `spec` and `project`: a source file never declares
+* its own spec version, and it never declares its inherited tier — the
+* bundler supplies both when it flattens the hierarchy at emit time. Decoded
+* only by writers; readers never see this shape.
+*
+* @public
+*/
+const ManifestSource = Schema.Struct({
+	name: BundleManifest.fields.name,
+	tagline: BundleManifest.fields.tagline,
+	description: BundleManifest.fields.description,
+	openGraph: BundleManifest.fields.openGraph,
+	sbom: BundleManifest.fields.sbom,
+	registries: BundleManifest.fields.registries
+});
+/**
+* Decode an unknown value into a {@link (ManifestSource:type)}.
+*
+* @public
+*/
+function decodeManifestSource(input, path) {
+	return Schema.decodeUnknownEffect(ManifestSource)(input).pipe(Effect.mapError((cause) => new BundleManifestError({
+		...path !== void 0 ? { path } : {},
+		cause
+	})));
+}
+
+//#endregion
+export { ManifestSource, decodeManifestSource };

package/index.d.ts

@@ -0,0 +1,339 @@
+import { Effect, Schema } from "effect";
+//#region src/BundleManifest.d.ts
+/**
+ * The registry protocol families this reader knows how to do more than link
+ * to. `"npm"` means an npm-compatible registry — install commands and tarball
+ * fetching work against any instance of it — and `"jsr"` the jsr protocol.
+ *
+ * @remarks
+ * The manifest's `type` field is deliberately NOT constrained to these
+ * values: unknown future types must degrade to link-only rendering, not
+ * reject the manifest. Use {@link isKnownRegistryType} to branch.
+ *
+ * @public
+ */
+declare const KNOWN_REGISTRY_TYPES: readonly ["npm", "jsr"];
+/**
+ * A registry protocol family this reader recognizes.
+ *
+ * @public
+ */
+type KnownRegistryType = (typeof KNOWN_REGISTRY_TYPES)[number];
+/**
+ * Whether a registry `type` value is a protocol family this reader
+ * recognizes. `false` means the registry entry should degrade to link-only
+ * rendering — it is never a validation failure.
+ *
+ * @public
+ */
+declare function isKnownRegistryType(type: string): type is KnownRegistryType;
+/**
+ * One registry the documented package is published to.
+ *
+ * @remarks
+ * `type` is the PROTOCOL FAMILY (`"npm"` covers every npm-compatible
+ * registry), `name` the human instance label, `url` the package's page on
+ * that instance. Unknown `type` values decode successfully and degrade to
+ * link-only rendering (see {@link isKnownRegistryType}).
+ *
+ * @public
+ */
+declare const RegistryRef: Schema.Struct<{
+  /** The protocol family, e.g. `"npm"` or `"jsr"`. Unknown values are accepted. */
+  readonly type: Schema.String;
+  /** The human instance label, e.g. `"npm"` or `"Savvy Web Registry"`. */
+  readonly name: Schema.String;
+  /** The package's URL on that registry instance. */
+  readonly url: Schema.String;
+}>;
+/**
+ * The decoded type of {@link (RegistryRef:variable)}.
+ *
+ * @public
+ */
+type RegistryRef = typeof RegistryRef.Type;
+/**
+ * One Open Graph image declared by the manifest.
+ *
+ * @remarks
+ * Exactly ONE of `path` (a bundle-relative asset the consuming platform
+ * publishes and resolves to a URL) or `url` (an absolute external URL used
+ * verbatim) must be present — the schema enforces the XOR. `type` is a MIME
+ * type, inferred from the file extension by the resolver when omitted; `alt`
+ * has a documented inference chain (tagline → description →
+ * `"<name> API documentation"`).
+ *
+ * @public
+ */
+declare const OpenGraphImage: Schema.Struct<{
+  /** Bundle-relative asset path. Mutually exclusive with `url`. */
+  readonly path: Schema.optionalKey<Schema.String>;
+  /** Absolute external URL, used verbatim. Mutually exclusive with `path`. */
+  readonly url: Schema.optionalKey<Schema.String>;
+  /** MIME type; inferred from the extension when omitted. */
+  readonly type: Schema.optionalKey<Schema.String>;
+  /** Pixel width; 1200×630 (1.91:1) is the cross-platform safe default. */
+  readonly width: Schema.optionalKey<Schema.Int>;
+  /** Pixel height. */
+  readonly height: Schema.optionalKey<Schema.Int>;
+  /** Alt text; inferred (tagline → description → fallback) when omitted. */
+  readonly alt: Schema.optionalKey<Schema.String>;
+}>;
+/**
+ * The decoded type of {@link (OpenGraphImage:variable)}.
+ *
+ * @public
+ */
+type OpenGraphImage = typeof OpenGraphImage.Type;
+/**
+ * The manifest's Open Graph block: the asset-ish pieces only — most OG tags
+ * are page-level and derive at render time in the consuming platform.
+ *
+ * @remarks
+ * Multiple images follow OG array semantics: the first declared wins, extras
+ * are alternates (e.g. a portrait 1000×1500 variant).
+ *
+ * @public
+ */
+declare const OpenGraphConfig: Schema.Struct<{
+  /** Declared images, first-wins per OG array semantics. */
+  readonly images: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    /** Bundle-relative asset path. Mutually exclusive with `url`. */
+    readonly path: Schema.optionalKey<Schema.String>;
+    /** Absolute external URL, used verbatim. Mutually exclusive with `path`. */
+    readonly url: Schema.optionalKey<Schema.String>;
+    /** MIME type; inferred from the extension when omitted. */
+    readonly type: Schema.optionalKey<Schema.String>;
+    /** Pixel width; 1200×630 (1.91:1) is the cross-platform safe default. */
+    readonly width: Schema.optionalKey<Schema.Int>;
+    /** Pixel height. */
+    readonly height: Schema.optionalKey<Schema.Int>;
+    /** Alt text; inferred (tagline → description → fallback) when omitted. */
+    readonly alt: Schema.optionalKey<Schema.String>;
+  }>>>;
+  /** Embed accent color (e.g. Discord), a CSS color string. */
+  readonly themeColor: Schema.optionalKey<Schema.String>;
+}>;
+/**
+ * The decoded type of {@link (OpenGraphConfig:variable)}.
+ *
+ * @public
+ */
+type OpenGraphConfig = typeof OpenGraphConfig.Type;
+/**
+ * A pointer to the bundle's SBOM, computed by the bundler at publish and
+ * served as a downloadable static asset.
+ *
+ * @public
+ */
+declare const SbomRef: Schema.Struct<{
+  /** Bundle-relative path to the SBOM file. */
+  readonly path: Schema.String;
+  /** SBOM format label, e.g. `"spdx-json"`. Unknown values are accepted. */
+  readonly format: Schema.optionalKey<Schema.String>;
+}>;
+/**
+ * The decoded type of {@link (SbomRef:variable)}.
+ *
+ * @public
+ */
+type SbomRef = typeof SbomRef.Type;
+/**
+ * The inherited project tier, flattened into the emitted manifest by the
+ * bundler (a fetched bundle has no parent directory to walk). Kept nested —
+ * structurally distinguishable from the leaf fields — because provenance is
+ * load-bearing for override detection.
+ *
+ * @public
+ */
+declare const ProjectIdentity: Schema.Struct<{
+  /** The project display name, e.g. `"Effected"` over leaf `@effected/store`. */
+  readonly name: Schema.optionalKey<Schema.String>;
+  /** The project tagline. */
+  readonly tagline: Schema.optionalKey<Schema.String>;
+}>;
+/**
+ * The decoded type of {@link (ProjectIdentity:variable)}.
+ *
+ * @public
+ */
+type ProjectIdentity = typeof ProjectIdentity.Type;
+/**
+ * The versioned `tsdoctor.json` sidecar manifest — bundle layer 3.
+ *
+ * @remarks
+ * `spec` is the only required field; every other field enriches. Unknown
+ * top-level fields are ignored on decode (additive fields are minor spec
+ * revisions) and unknown enum-ish values (registry `type`, sbom `format`)
+ * degrade gracefully instead of rejecting — an old reader must be able to
+ * consume a new bundle.
+ *
+ * @public
+ */
+declare const BundleManifest: Schema.Struct<{
+  /** The integer spec version. This reader understands spec 1. */
+  readonly spec: Schema.Literal<1>;
+  /** Human display name (the npm name is dry; this one is SEO-friendly). */
+  readonly name: Schema.optionalKey<Schema.String>;
+  /** Short tagline. */
+  readonly tagline: Schema.optionalKey<Schema.String>;
+  /** Long description; overrides the package.json description when present. */
+  readonly description: Schema.optionalKey<Schema.String>;
+  /** The inherited project tier, flattened in at emit time. */
+  readonly project: Schema.optionalKey<Schema.Struct<{
+    /** The project display name, e.g. `"Effected"` over leaf `@effected/store`. */
+    readonly name: Schema.optionalKey<Schema.String>;
+    /** The project tagline. */
+    readonly tagline: Schema.optionalKey<Schema.String>;
+  }>>;
+  /** Open Graph assets. */
+  readonly openGraph: Schema.optionalKey<Schema.Struct<{
+    /** Declared images, first-wins per OG array semantics. */
+    readonly images: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+      /** Bundle-relative asset path. Mutually exclusive with `url`. */
+      readonly path: Schema.optionalKey<Schema.String>;
+      /** Absolute external URL, used verbatim. Mutually exclusive with `path`. */
+      readonly url: Schema.optionalKey<Schema.String>;
+      /** MIME type; inferred from the extension when omitted. */
+      readonly type: Schema.optionalKey<Schema.String>;
+      /** Pixel width; 1200×630 (1.91:1) is the cross-platform safe default. */
+      readonly width: Schema.optionalKey<Schema.Int>;
+      /** Pixel height. */
+      readonly height: Schema.optionalKey<Schema.Int>;
+      /** Alt text; inferred (tagline → description → fallback) when omitted. */
+      readonly alt: Schema.optionalKey<Schema.String>;
+    }>>>;
+    /** Embed accent color (e.g. Discord), a CSS color string. */
+    readonly themeColor: Schema.optionalKey<Schema.String>;
+  }>>;
+  /** SBOM pointer. */
+  readonly sbom: Schema.optionalKey<Schema.Struct<{
+    /** Bundle-relative path to the SBOM file. */
+    readonly path: Schema.String;
+    /** SBOM format label, e.g. `"spdx-json"`. Unknown values are accepted. */
+    readonly format: Schema.optionalKey<Schema.String>;
+  }>>;
+  /** Registries the package is published to. */
+  readonly registries: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    /** The protocol family, e.g. `"npm"` or `"jsr"`. Unknown values are accepted. */
+    readonly type: Schema.String;
+    /** The human instance label, e.g. `"npm"` or `"Savvy Web Registry"`. */
+    readonly name: Schema.String;
+    /** The package's URL on that registry instance. */
+    readonly url: Schema.String;
+  }>>>;
+}>;
+/**
+ * The decoded type of {@link (BundleManifest:variable)}.
+ *
+ * @public
+ */
+type BundleManifest = typeof BundleManifest.Type;
+declare const BundleManifestError_base: Schema.Class<BundleManifestError, Schema.TaggedStruct<"BundleManifestError", {
+  /** The manifest file path, when the failure is tied to a file on disk. */
+  readonly path: Schema.optionalKey<Schema.String>;
+  /** The underlying failure (JSON syntax or schema decode), preserved structurally. */
+  readonly cause: Schema.Defect;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * Raised when a present `tsdoctor.json` cannot be parsed or does not satisfy
+ * the {@link (BundleManifest:variable)} schema.
+ *
+ * @remarks
+ * Absence of the manifest is NEVER this error — layers enrich, never gate,
+ * so a missing sidecar is the normal case and reads as `Option.none()`.
+ *
+ * @public
+ */
+declare class BundleManifestError extends BundleManifestError_base {
+  get message(): string;
+}
+/**
+ * Decode an unknown value into a {@link (BundleManifest:type)}.
+ *
+ * @remarks
+ * The typed boundary for manifest input that has already been parsed from
+ * JSON (plugin options, fetched payloads). File-based reading lives in
+ * `readBundle`, which routes through this after parsing.
+ *
+ * @public
+ */
+declare function decodeBundleManifest(input: unknown, path?: string): Effect.Effect<BundleManifest, BundleManifestError>;
+/**
+ * The manifest spec version this package reads and writes.
+ *
+ * @public
+ */
+declare const MANIFEST_SPEC: 1;
+/**
+ * The sidecar manifest's file name inside a bundle folder.
+ *
+ * @public
+ */
+declare const TSDOCTOR_MANIFEST_FILENAME = "tsdoctor.json";
+/**
+ * Encode a {@link (BundleManifest:type)} into the JSON-ready value a writer
+ * serializes as `tsdoctor.json`.
+ *
+ * @remarks
+ * The writer's boundary. Going through the schema rather than
+ * `JSON.stringify` means an emitted file is by construction what
+ * {@link decodeBundleManifest} accepts.
+ *
+ * @public
+ */
+declare function encodeBundleManifest(manifest: BundleManifest): Effect.Effect<unknown, BundleManifestError>;
+//#endregion
+//#region src/ManifestSource.d.ts
+/**
+ * The shape an author checks in as a `tsdoctor.json` SOURCE file, at a
+ * package root (the leaf tier) or a workspace root (the project tier).
+ *
+ * @remarks
+ * `BundleManifest` minus `spec` and `project`: a source file never declares
+ * its own spec version, and it never declares its inherited tier — the
+ * bundler supplies both when it flattens the hierarchy at emit time. Decoded
+ * only by writers; readers never see this shape.
+ *
+ * @public
+ */
+declare const ManifestSource: Schema.Struct<{
+  readonly name: Schema.optionalKey<Schema.String>;
+  readonly tagline: Schema.optionalKey<Schema.String>;
+  readonly description: Schema.optionalKey<Schema.String>;
+  readonly openGraph: Schema.optionalKey<Schema.Struct<{
+    readonly images: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+      readonly path: Schema.optionalKey<Schema.String>;
+      readonly url: Schema.optionalKey<Schema.String>;
+      readonly type: Schema.optionalKey<Schema.String>;
+      readonly width: Schema.optionalKey<Schema.Int>;
+      readonly height: Schema.optionalKey<Schema.Int>;
+      readonly alt: Schema.optionalKey<Schema.String>;
+    }>>>;
+    readonly themeColor: Schema.optionalKey<Schema.String>;
+  }>>;
+  readonly sbom: Schema.optionalKey<Schema.Struct<{
+    readonly path: Schema.String;
+    readonly format: Schema.optionalKey<Schema.String>;
+  }>>;
+  readonly registries: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly type: Schema.String;
+    readonly name: Schema.String;
+    readonly url: Schema.String;
+  }>>>;
+}>;
+/**
+ * The decoded type of {@link (ManifestSource:variable)}.
+ *
+ * @public
+ */
+type ManifestSource = typeof ManifestSource.Type;
+/**
+ * Decode an unknown value into a {@link (ManifestSource:type)}.
+ *
+ * @public
+ */
+declare function decodeManifestSource(input: unknown, path?: string): Effect.Effect<ManifestSource, BundleManifestError>;
+//#endregion
+export { BundleManifest, BundleManifestError, KNOWN_REGISTRY_TYPES, type KnownRegistryType, MANIFEST_SPEC, ManifestSource, OpenGraphConfig, OpenGraphImage, ProjectIdentity, RegistryRef, SbomRef, TSDOCTOR_MANIFEST_FILENAME, decodeBundleManifest, decodeManifestSource, encodeBundleManifest, isKnownRegistryType };
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,4 @@
+import { BundleManifest, BundleManifestError, KNOWN_REGISTRY_TYPES, MANIFEST_SPEC, OpenGraphConfig, OpenGraphImage, ProjectIdentity, RegistryRef, SbomRef, TSDOCTOR_MANIFEST_FILENAME, decodeBundleManifest, encodeBundleManifest, isKnownRegistryType } from "./BundleManifest.js";
+import { ManifestSource, decodeManifestSource } from "./ManifestSource.js";
+
+export { BundleManifest, BundleManifestError, KNOWN_REGISTRY_TYPES, MANIFEST_SPEC, ManifestSource, OpenGraphConfig, OpenGraphImage, ProjectIdentity, RegistryRef, SbomRef, TSDOCTOR_MANIFEST_FILENAME, decodeBundleManifest, decodeManifestSource, encodeBundleManifest, isKnownRegistryType };

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@tsdoctor/manifest",
+	"version": "0.1.0",
+	"private": false,
+	"description": "The tsdoctor.json bundle manifest: the spec-1 schema, encode/decode boundaries and the authoring-file shape shared by bundlers that write it and readers that consume it.",
+	"keywords": [
+		"tsdoctor",
+		"manifest",
+		"api-extractor",
+		"effect"
+	],
+	"homepage": "https://github.com/spencerbeggs/tsdoctor#readme",
+	"bugs": {
+		"url": "https://github.com/spencerbeggs/tsdoctor/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/spencerbeggs/tsdoctor.git",
+		"directory": "packages/manifest"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "C. Spencer Beggs",
+		"email": "spencer@beggs.codes",
+		"url": "https://spencerbeg.gs"
+	},
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js",
+			"default": "./index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"peerDependencies": {
+		"effect": "4.0.0-rc.109"
+	},
+	"engines": {
+		"node": ">=24.11.0"
+	}
+}

package/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.59.0"
+    }
+  ]
+}