@tsdoctor/bundle 0.3.0 → 0.3.1

package/index.d.ts

@@ -20,7 +20,7 @@ import { JsoncCanonicalizeError } from "@effected/jsonc";
  *
  * @public
  */
-declare const KNOWN_REGISTRY_TYPES: readonly ["npm", "jsr"];
+export declare const KNOWN_REGISTRY_TYPES: readonly ["npm", "jsr"];
 /**
  * A registry protocol family this reader recognizes.
  *
@@ -34,7 +34,7 @@ type KnownRegistryType = (typeof KNOWN_REGISTRY_TYPES)[number];
  *
  * @public
  */
-declare function isKnownRegistryType(type: string): type is KnownRegistryType;
+export declare function isKnownRegistryType(type: string): type is KnownRegistryType;
 /**
  * One registry the documented package is published to.
  *
@@ -46,7 +46,7 @@ declare function isKnownRegistryType(type: string): type is KnownRegistryType;
  *
  * @public
  */
-declare const RegistryRef: Schema.Struct<{
+export 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"`. */
@@ -59,7 +59,7 @@ declare const RegistryRef: Schema.Struct<{
  *
  * @public
  */
-type RegistryRef = typeof RegistryRef.Type;
+export type RegistryRef = typeof RegistryRef.Type;
 /**
  * One Open Graph image declared by the manifest.
  *
@@ -73,7 +73,7 @@ type RegistryRef = typeof RegistryRef.Type;
  *
  * @public
  */
-declare const OpenGraphImage: Schema.Struct<{
+export 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`. */
@@ -92,7 +92,7 @@ declare const OpenGraphImage: Schema.Struct<{
  *
  * @public
  */
-type OpenGraphImage = typeof OpenGraphImage.Type;
+export 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.
@@ -103,7 +103,7 @@ type OpenGraphImage = typeof OpenGraphImage.Type;
  *
  * @public
  */
-declare const OpenGraphConfig: Schema.Struct<{
+export 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`. */
@@ -127,14 +127,14 @@ declare const OpenGraphConfig: Schema.Struct<{
  *
  * @public
  */
-type OpenGraphConfig = typeof OpenGraphConfig.Type;
+export 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<{
+export 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. */
@@ -145,7 +145,7 @@ declare const SbomRef: Schema.Struct<{
  *
  * @public
  */
-type SbomRef = typeof SbomRef.Type;
+export 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 —
@@ -154,7 +154,7 @@ type SbomRef = typeof SbomRef.Type;
  *
  * @public
  */
-declare const ProjectIdentity: Schema.Struct<{
+export 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. */
@@ -165,7 +165,7 @@ declare const ProjectIdentity: Schema.Struct<{
  *
  * @public
  */
-type ProjectIdentity = typeof ProjectIdentity.Type;
+export type ProjectIdentity = typeof ProjectIdentity.Type;
 /**
  * The versioned `tsdoctor.json` sidecar manifest — bundle layer 3.
  *
@@ -178,7 +178,7 @@ type ProjectIdentity = typeof ProjectIdentity.Type;
  *
  * @public
  */
-declare const BundleManifest: Schema.Struct<{
+export 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). */
@@ -236,7 +236,7 @@ declare const BundleManifest: Schema.Struct<{
  *
  * @public
  */
-type BundleManifest = typeof BundleManifest.Type;
+export 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>;
@@ -253,7 +253,7 @@ declare const BundleManifestError_base: Schema.Class<BundleManifestError, Schema
  *
  * @public
  */
-declare class BundleManifestError extends BundleManifestError_base {
+export declare class BundleManifestError extends BundleManifestError_base {
   get message(): string;
 }
 /**
@@ -266,19 +266,19 @@ declare class BundleManifestError extends BundleManifestError_base {
  *
  * @public
  */
-declare function decodeBundleManifest(input: unknown, path?: string): Effect.Effect<BundleManifest, BundleManifestError>;
+export 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;
+export declare const MANIFEST_SPEC: 1;
 /**
  * The sidecar manifest's file name inside a bundle folder.
  *
  * @public
  */
-declare const TSDOCTOR_MANIFEST_FILENAME = "tsdoctor.json";
+export declare const TSDOCTOR_MANIFEST_FILENAME = "tsdoctor.json";
 /**
  * Encode a {@link (BundleManifest:type)} into the JSON-ready value a writer
  * serializes as `tsdoctor.json`.
@@ -290,7 +290,7 @@ declare const TSDOCTOR_MANIFEST_FILENAME = "tsdoctor.json";
  *
  * @public
  */
-declare function encodeBundleManifest(manifest: BundleManifest): Effect.Effect<unknown, BundleManifestError>;
+export declare function encodeBundleManifest(manifest: BundleManifest): Effect.Effect<unknown, BundleManifestError>;
 //#endregion
 //#region src/ManifestSource.d.ts
 /**
@@ -305,7 +305,7 @@ declare function encodeBundleManifest(manifest: BundleManifest): Effect.Effect<u
  *
  * @public
  */
-declare const ManifestSource: Schema.Struct<{
+export declare const ManifestSource: Schema.Struct<{
   readonly name: Schema.optionalKey<Schema.String>;
   readonly tagline: Schema.optionalKey<Schema.String>;
   readonly description: Schema.optionalKey<Schema.String>;
@@ -335,13 +335,13 @@ declare const ManifestSource: Schema.Struct<{
  *
  * @public
  */
-type ManifestSource = typeof ManifestSource.Type;
+export 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>;
+export declare function decodeManifestSource(input: unknown, path?: string): Effect.Effect<ManifestSource, BundleManifestError>;
 //#endregion
 //#region src/Bundle.d.ts
 /**
@@ -380,7 +380,7 @@ declare const BundleLayerError_base: Schema.Class<BundleLayerError, Schema.Tagge
  *
  * @public
  */
-declare class BundleLayerError extends BundleLayerError_base {
+export declare class BundleLayerError extends BundleLayerError_base {
   get message(): string;
 }
 /**
@@ -441,7 +441,7 @@ interface Bundle {
  *
  * @public
  */
-declare function readApiModelInfo(modelPath: string): Effect.Effect<ApiModelInfo, BundleLayerError, FileSystem.FileSystem>;
+export declare function readApiModelInfo(modelPath: string): Effect.Effect<ApiModelInfo, BundleLayerError, FileSystem.FileSystem>;
 /**
  * Read all four layers of a discovered bundle into a {@link Bundle}.
  *
@@ -455,7 +455,7 @@ declare function readApiModelInfo(modelPath: string): Effect.Effect<ApiModelInfo
  *
  * @public
  */
-declare function readBundle(descriptor: BundleDescriptor): Effect.Effect<Bundle, BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
+export declare function readBundle(descriptor: BundleDescriptor): Effect.Effect<Bundle, BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
 //#endregion
 //#region src/PlatformOverrides.d.ts
 /**
@@ -472,7 +472,7 @@ declare function readBundle(descriptor: BundleDescriptor): Effect.Effect<Bundle,
  *
  * @public
  */
-declare const PlatformOverrides: Schema.Struct<{
+export declare const PlatformOverrides: Schema.Struct<{
   /** Human display name override. */
   readonly name: Schema.optionalKey<Schema.String>;
   /** Tagline override. */
@@ -508,7 +508,7 @@ declare const PlatformOverrides: Schema.Struct<{
  *
  * @public
  */
-type PlatformOverrides = typeof PlatformOverrides.Type;
+export type PlatformOverrides = typeof PlatformOverrides.Type;
 /**
  * Decode an unknown value into a {@link (PlatformOverrides:type)}.
  *
@@ -519,7 +519,7 @@ type PlatformOverrides = typeof PlatformOverrides.Type;
  *
  * @public
  */
-declare function decodePlatformOverrides(input: unknown): Effect.Effect<PlatformOverrides, BundleManifestError>;
+export declare function decodePlatformOverrides(input: unknown): Effect.Effect<PlatformOverrides, BundleManifestError>;
 //#endregion
 //#region src/BundleResolver.d.ts
 /**
@@ -652,13 +652,13 @@ interface ResolveBundleInput {
  *
  * @public
  */
-declare function resolveBundle(input: ResolveBundleInput): ResolvedBundle;
+export declare function resolveBundle(input: ResolveBundleInput): ResolvedBundle;
 /**
  * Resolve a read {@link Bundle}, unwrapping its `Option` layers.
  *
  * @public
  */
-declare function resolveBundleFrom(bundle: Bundle, platform?: PlatformOverrides): ResolvedBundle;
+export declare function resolveBundleFrom(bundle: Bundle, platform?: PlatformOverrides): ResolvedBundle;
 //#endregion
 //#region src/BundleAssets.d.ts
 declare const BundleAssetError_base: Schema.Class<BundleAssetError, Schema.TaggedStruct<"BundleAssetError", {
@@ -672,7 +672,7 @@ declare const BundleAssetError_base: Schema.Class<BundleAssetError, Schema.Tagge
  *
  * @public
  */
-declare class BundleAssetError extends BundleAssetError_base {
+export declare class BundleAssetError extends BundleAssetError_base {
   get message(): string;
 }
 /**
@@ -732,7 +732,7 @@ interface PublishBundleAssetsInput {
  *
  * @public
  */
-declare const publishBundleAssets: (input: PublishBundleAssetsInput) => Effect.Effect<readonly PublishedOpenGraphImage[], BundleAssetError, FileSystem.FileSystem | Path.Path>;
+export declare const publishBundleAssets: (input: PublishBundleAssetsInput) => Effect.Effect<readonly PublishedOpenGraphImage[], BundleAssetError, FileSystem.FileSystem | Path.Path>;
 //#endregion
 //#region src/BundleDiscovery.d.ts
 declare const BundleDiscoveryError_base: Schema.Class<BundleDiscoveryError, Schema.TaggedStruct<"BundleDiscoveryError", {
@@ -755,7 +755,7 @@ declare const BundleDiscoveryError_base: Schema.Class<BundleDiscoveryError, Sche
  *
  * @public
  */
-declare class BundleDiscoveryError extends BundleDiscoveryError_base {
+export declare class BundleDiscoveryError extends BundleDiscoveryError_base {
   get message(): string;
 }
 /**
@@ -807,7 +807,7 @@ interface DiscoverBundlesOptions {
  *
  * @public
  */
-declare function discoverBundle(dir: string, options?: DiscoverBundleOptions): Effect.Effect<BundleDescriptor, BundleDiscoveryError | BundleLayerError, FileSystem.FileSystem | Path.Path>;
+export declare function discoverBundle(dir: string, options?: DiscoverBundleOptions): Effect.Effect<BundleDescriptor, BundleDiscoveryError | BundleLayerError, FileSystem.FileSystem | Path.Path>;
 /**
  * Strictly scan a parent directory and discover one bundle per subfolder.
  *
@@ -821,19 +821,19 @@ declare function discoverBundle(dir: string, options?: DiscoverBundleOptions): E
  *
  * @public
  */
-declare function discoverBundles(parentDir: string, options?: DiscoverBundlesOptions): Effect.Effect<ReadonlyArray<BundleDescriptor>, BundleDiscoveryError | BundleLayerError, FileSystem.FileSystem | Path.Path>;
+export declare function discoverBundles(parentDir: string, options?: DiscoverBundlesOptions): Effect.Effect<ReadonlyArray<BundleDescriptor>, BundleDiscoveryError | BundleLayerError, FileSystem.FileSystem | Path.Path>;
 /**
  * Discover and read a single bundle in one call.
  *
  * @public
  */
-declare function loadBundle(dir: string, options?: DiscoverBundleOptions): Effect.Effect<Bundle, BundleDiscoveryError | BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
+export declare function loadBundle(dir: string, options?: DiscoverBundleOptions): Effect.Effect<Bundle, BundleDiscoveryError | BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
 /**
  * Discover and read every bundle under a parent directory in one call.
  *
  * @public
  */
-declare function loadBundles(parentDir: string, options?: DiscoverBundlesOptions): Effect.Effect<ReadonlyArray<Bundle>, BundleDiscoveryError | BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
+export declare function loadBundles(parentDir: string, options?: DiscoverBundlesOptions): Effect.Effect<ReadonlyArray<Bundle>, BundleDiscoveryError | BundleLayerError | BundleManifestError, FileSystem.FileSystem | Path.Path>;
 //#endregion
 //#region src/BundleFetch.d.ts
 declare const BundleFetchError_base: Schema.Class<BundleFetchError, Schema.TaggedStruct<"BundleFetchError", {
@@ -860,7 +860,7 @@ declare const BundleFetchError_base: Schema.Class<BundleFetchError, Schema.Tagge
  *
  * @public
  */
-declare class BundleFetchError extends BundleFetchError_base {
+export declare class BundleFetchError extends BundleFetchError_base {
   get message(): string;
 }
 /**
@@ -929,7 +929,7 @@ interface FetchGitHubReleaseBundleOptions {
  *
  * @public
  */
-declare function fetchNpmBundle(options: FetchNpmBundleOptions): Effect.Effect<Bundle, BundleFetchError | BundleLayerError | BundleManifestError, NpmRegistry | PackageTarball | Cache | AppDirs | FileSystem.FileSystem | Path.Path>;
+export declare function fetchNpmBundle(options: FetchNpmBundleOptions): Effect.Effect<Bundle, BundleFetchError | BundleLayerError | BundleManifestError, NpmRegistry | PackageTarball | Cache | AppDirs | FileSystem.FileSystem | Path.Path>;
 /**
  * Fetch a bundle attached to a GitHub release as a `*.npm.meta.tgz`-style
  * asset, through the durable XDG cache.
@@ -951,7 +951,7 @@ declare function fetchNpmBundle(options: FetchNpmBundleOptions): Effect.Effect<B
  *
  * @public
  */
-declare function fetchGitHubReleaseBundle(options: FetchGitHubReleaseBundleOptions): Effect.Effect<Bundle, BundleFetchError | BundleLayerError | BundleManifestError, GitHubRelease | PackageTarball | Cache | AppDirs | FileSystem.FileSystem | Path.Path>;
+export declare function fetchGitHubReleaseBundle(options: FetchGitHubReleaseBundleOptions): Effect.Effect<Bundle, BundleFetchError | BundleLayerError | BundleManifestError, GitHubRelease | PackageTarball | Cache | AppDirs | FileSystem.FileSystem | Path.Path>;
 //#endregion
 //#region src/BundleHash.d.ts
 /**
@@ -967,7 +967,7 @@ declare function fetchGitHubReleaseBundle(options: FetchGitHubReleaseBundleOptio
  *
  * @public
  */
-declare function normalizeText(text: string): string;
+export declare function normalizeText(text: string): string;
 /**
  * Hash text content: {@link normalizeText} then SHA-256 (lowercase hex).
  *
@@ -979,7 +979,7 @@ declare function normalizeText(text: string): string;
  *
  * @public
  */
-declare function hashText(text: string): Effect.Effect<string, PlatformError.PlatformError, Crypto.Crypto>;
+export declare function hashText(text: string): Effect.Effect<string, PlatformError.PlatformError, Crypto.Crypto>;
 /**
  * Hash a JSON-shaped value: RFC 8785 (JCS) canonicalization then SHA-256.
  *
@@ -992,7 +992,7 @@ declare function hashText(text: string): Effect.Effect<string, PlatformError.Pla
  *
  * @public
  */
-declare function hashJsonValue(value: unknown): Effect.Effect<string, JsoncCanonicalizeError | PlatformError.PlatformError, Crypto.Crypto>;
+export declare function hashJsonValue(value: unknown): Effect.Effect<string, JsoncCanonicalizeError | PlatformError.PlatformError, Crypto.Crypto>;
 /**
  * Hash one bundle layer file's raw text — the COARSE half of change
  * detection (all layer hashes match → skip resolution entirely).
@@ -1008,7 +1008,7 @@ declare function hashJsonValue(value: unknown): Effect.Effect<string, JsoncCanon
  *
  * @public
  */
-declare function hashLayerText(text: string): Effect.Effect<string, PlatformError.PlatformError, Crypto.Crypto>;
+export declare function hashLayerText(text: string): Effect.Effect<string, PlatformError.PlatformError, Crypto.Crypto>;
 /**
  * Fingerprint every present field of a {@link ResolvedBundle} — the FINE
  * half of change detection, hashing each field's `{ value, source }` pair.
@@ -1027,7 +1027,7 @@ declare function hashLayerText(text: string): Effect.Effect<string, PlatformErro
  *
  * @public
  */
-declare function fingerprintResolvedBundle(resolved: ResolvedBundle): Effect.Effect<Readonly<Record<string, string>>, PlatformError.PlatformError, Crypto.Crypto>;
+export declare function fingerprintResolvedBundle(resolved: ResolvedBundle): Effect.Effect<Readonly<Record<string, string>>, PlatformError.PlatformError, Crypto.Crypto>;
 //#endregion
-export { type ApiModelInfo, type Bundle, BundleAssetError, type BundleDescriptor, BundleDiscoveryError, BundleFetchError, BundleLayerError, BundleManifest, BundleManifestError, type BundleOverrides, type DiscoverBundleOptions, type DiscoverBundlesOptions, type FetchGitHubReleaseBundleOptions, type FetchNpmBundleOptions, KNOWN_REGISTRY_TYPES, type KnownRegistryType, MANIFEST_SPEC, ManifestSource, OpenGraphConfig, OpenGraphImage, PlatformOverrides, ProjectIdentity, type ProvenanceSource, type Provenanced, type PublishBundleAssetsInput, type PublishedOpenGraphImage, RegistryRef, type ResolveBundleInput, type ResolvedBundle, type ResolvedOpenGraph, type ResolvedOpenGraphImage, SbomRef, TSDOCTOR_MANIFEST_FILENAME, decodeBundleManifest, decodeManifestSource, decodePlatformOverrides, discoverBundle, discoverBundles, encodeBundleManifest, fetchGitHubReleaseBundle, fetchNpmBundle, fingerprintResolvedBundle, hashJsonValue, hashLayerText, hashText, isKnownRegistryType, loadBundle, loadBundles, normalizeText, publishBundleAssets, readApiModelInfo, readBundle, resolveBundle, resolveBundleFrom };
+export type { ApiModelInfo, Bundle, BundleDescriptor, BundleOverrides, DiscoverBundleOptions, DiscoverBundlesOptions, FetchGitHubReleaseBundleOptions, FetchNpmBundleOptions, KnownRegistryType, ProvenanceSource, Provenanced, PublishBundleAssetsInput, PublishedOpenGraphImage, ResolveBundleInput, ResolvedBundle, ResolvedOpenGraph, ResolvedOpenGraphImage };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tsdoctor/bundle",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"private": false,
 	"description": "The tsdoctor bundle spec: layered bundle discovery, the versioned tsdoctor.json sidecar manifest, provenance-carrying resolution and canonical input hashing for API documentation bundles.",
 	"keywords": [
@@ -39,17 +39,17 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/github": "^0.8.0",
-		"@effected/glob": "^0.4.0",
-		"@effected/jsonc": "^0.8.1",
-		"@effected/npm": "^0.12.1",
-		"@effected/package-json": "^0.13.0",
-		"@effected/store": "^0.6.0",
-		"@effected/tsconfig-json": "^0.7.0",
-		"@effected/walker": "^0.5.0",
-		"@effected/xdg": "^0.3.0",
-		"@tsdoctor/manifest": "0.1.0",
-		"effect": "4.0.0-rc.109",
+		"@effected/github": "^0.9.0",
+		"@effected/glob": "^0.5.0",
+		"@effected/jsonc": "^0.9.0",
+		"@effected/npm": "^0.13.0",
+		"@effected/package-json": "^0.14.0",
+		"@effected/store": "^0.7.0",
+		"@effected/tsconfig-json": "^0.8.0",
+		"@effected/walker": "^0.6.0",
+		"@effected/xdg": "^0.4.0",
+		"@tsdoctor/manifest": "0.1.1",
+		"effect": "4.0.0-rc.112",
 		"image-size": "^2.0.2"
 	},
 	"engines": {