@effected/package-json 0.5.1 → 0.6.0

package/Package.js

@@ -5,6 +5,7 @@ import { renderJson, resolveIndent } from "./internal/format.js";
 import { PackageManager } from "./PackageManager.js";
 import { InvalidPackageNameError, PackageName } from "./PackageName.js";
 import { Person } from "./Person.js";
+import { Bugs, Repository } from "./Repository.js";
 import { CatalogResolver, DependencySpecifier, WorkspaceResolver } from "@effected/npm";
 import { Effect, Function, HashMap, Option, Pipeable, Schema, SchemaTransformation } from "effect";
 import { SemVer } from "@effected/semver";
@@ -60,9 +61,12 @@ const PublishConfigField = Schema.Record(Schema.String, Schema.Unknown);
 */
 const PeerDependenciesMetaField = Schema.Record(Schema.String, Schema.Struct({ optional: Schema.optionalKey(Schema.Boolean) }));
 /**
-* The `repository` field: a shorthand string or an object (with `type` / `url` /
-* `directory` and any extensions preserved). Not meant to be referenced
-* directly.
+* The `repository` field's raw wire shape: a shorthand string or an object.
+*
+* @deprecated Superseded by {@link Repository.FromValue}, which decodes both
+* encodings into a typed {@link Repository} with normalization getters and
+* round-trips the original form. Kept as a named type for consumers that were
+* matching on the raw union; it is no longer what `Package.repository` uses.
 *
 * @public
 */
@@ -141,7 +145,11 @@ var Package = class Package extends Schema.Class("Package")({
 	license: Schema.optionalKey(SpdxLicense),
 	author: Schema.optionalKey(Person.FromValue),
 	contributors: Schema.optionalKey(Schema.Array(Person.FromValue)),
-	repository: Schema.optionalKey(RepositoryField),
+	maintainers: Schema.optionalKey(Schema.Array(Person.FromValue)),
+	keywords: Schema.optionalKey(Schema.Array(Schema.String)),
+	repository: Schema.optionalKey(Repository.FromValue),
+	bugs: Schema.optionalKey(Bugs.FromValue),
+	homepage: Schema.optionalKey(Schema.String),
 	dependencies: DependencyMapField,
 	devDependencies: DependencyMapField,
 	peerDependencies: DependencyMapField,

package/Person.js

@@ -31,10 +31,11 @@ const KNOWN_KEYS = /* @__PURE__ */ new Set([
 	"url"
 ]);
 const sameRest = (a, b) => JSON.stringify(a ?? {}) === JSON.stringify(b ?? {});
+const isShorthandExpressible = (person) => person.rest === void 0 || Object.keys(person.rest).length === 0;
 const isFaithful = (wire, person) => {
 	if (typeof wire === "string") {
 		const parsed = parsePersonString(wire);
-		return parsed.name === person.name && parsed.email === person.email && parsed.url === person.url;
+		return parsed.name === person.name && parsed.email === person.email && parsed.url === person.url && isShorthandExpressible(person);
 	}
 	const rest = restOf(wire);
 	return wire.name === person.name && wire.email === person.email && wire.url === person.url && sameRest(rest, person.rest);
@@ -123,7 +124,9 @@ var Person = class Person extends Schema.Class("Person")({
 		decode: (input) => typeof input === "string" ? rememberWire(parsePersonString(input), input) : input,
 		encode: (person) => {
 			const wire = wireForms.get(person);
-			return typeof wire === "string" && isFaithful(wire, person) ? wire : person;
+			if (typeof wire !== "string") return person;
+			if (isFaithful(wire, person)) return wire;
+			return isShorthandExpressible(person) ? serializePerson(person) : person;
 		}
 	})));
 	/**

package/Repository.js

@@ -0,0 +1,179 @@
+import { Option, Schema, SchemaTransformation } from "effect";
+
+//#region src/Repository.ts
+/** The shorthand hosts npm resolves without a scheme. */
+const SHORTHAND_HOSTS = /* @__PURE__ */ new Map([
+	["github", "https://github.com"],
+	["gitlab", "https://gitlab.com"],
+	["bitbucket", "https://bitbucket.org"]
+]);
+/** `owner/name`, the bare GitHub shorthand. Deliberately strict about segment shape. */
+const BARE_SHORTHAND = /^[\w.-]+\/[\w.-]+$/;
+/** `github:owner/name`, `gist:id`, … */
+const PREFIXED_SHORTHAND = /^([a-z]+):(.+)$/;
+/** The scp-like form git accepts: `git@host:owner/name.git`. */
+const SCP_LIKE = /^(?:([\w.-]+)@)?([\w.-]+):(.+)$/;
+const stripGitSuffix = (value) => value.endsWith(".git") ? value.slice(0, -4) : value;
+/**
+* The browsable `https://host/path` form of a repository reference, or none
+* when the value is not one this model recognizes.
+*
+* Total by construction: `repository` is caller data, and a value we cannot
+* interpret is a missing answer rather than a failure.
+*/
+const browseUrlOf = (raw) => {
+	const url = raw.trim();
+	if (url === "") return Option.none();
+	if (BARE_SHORTHAND.test(url)) return Option.some(`https://github.com/${url}`);
+	const prefixed = PREFIXED_SHORTHAND.exec(url);
+	if (prefixed !== null) {
+		const [, scheme, rest] = prefixed;
+		if (scheme === "gist") return Option.some(`https://gist.github.com/${stripGitSuffix(rest ?? "")}`);
+		const host = SHORTHAND_HOSTS.get(scheme ?? "");
+		if (host !== void 0) return Option.some(`${host}/${stripGitSuffix(rest ?? "")}`);
+	}
+	const withoutGitPlus = url.startsWith("git+") ? url.slice(4) : url;
+	const schemeMatch = /^([a-z][a-z0-9+.-]*):\/\/(.*)$/i.exec(withoutGitPlus);
+	if (schemeMatch !== null) {
+		const withoutCredentials = (schemeMatch[2] ?? "").replace(/^[^/@]+@/, "");
+		return withoutCredentials === "" ? Option.none() : Option.some(`https://${stripGitSuffix(withoutCredentials)}`);
+	}
+	const scp = SCP_LIKE.exec(withoutGitPlus);
+	if (scp !== null) {
+		const [, , host, path] = scp;
+		if (host !== void 0 && path !== void 0 && path !== "") return Option.some(`https://${host}/${stripGitSuffix(path)}`);
+	}
+	return Option.none();
+};
+const repositoryWires = /* @__PURE__ */ new WeakMap();
+const bugsWires = /* @__PURE__ */ new WeakMap();
+const KNOWN_REPOSITORY_KEYS = /* @__PURE__ */ new Set([
+	"type",
+	"url",
+	"directory"
+]);
+const KNOWN_BUGS_KEYS = /* @__PURE__ */ new Set(["url", "email"]);
+/**
+* Where a package's source lives.
+*
+* @remarks
+* `url` is **verbatim** — exactly the string the manifest carried, shorthand
+* and all. Normalization is offered through {@link Repository.browseUrl} and
+* {@link Repository.gitUrl}, so reading a manifest never rewrites it and a
+* caller that wants the original still has it.
+*
+* @example
+* ```ts
+* // "effected/kit" → https://github.com/effected/kit
+* // "git@github.com:effected/kit.git" → https://github.com/effected/kit
+* ```
+*
+* @public
+*/
+var Repository = class Repository extends Schema.Class("Repository")({
+	/** The `type` field, when the object form carried one (`"git"`, …). */
+	type: Schema.optionalKey(Schema.String),
+	/** The reference exactly as written: a shorthand, a git URL, or an https URL. */
+	url: Schema.String,
+	/** The subdirectory within the repository, for a monorepo member. */
+	directory: Schema.optionalKey(Schema.String),
+	/** Keys outside the documented set, preserved so encoding does not drop them. */
+	rest: Schema.optionalKey(Schema.Record(Schema.String, Schema.Unknown))
+}) {
+	/**
+	* The browsable `https://` URL, or `Option.none()` when `url` is not a form
+	* this model recognizes.
+	*/
+	get browseUrl() {
+		return browseUrlOf(this.url);
+	}
+	/** The canonical https clone URL, or none when it cannot be derived. */
+	get gitUrl() {
+		return Option.map(this.browseUrl, (url) => `${url}.git`);
+	}
+	/**
+	* The `repository` field: the shorthand string or the object form, always
+	* decoded to a {@link Repository}, and always re-encoded in the form it was
+	* read from.
+	*/
+	static FromValue = Schema.Union([Schema.Record(Schema.String, Schema.Unknown), Schema.String]).pipe(Schema.decodeTo(Schema.instanceOf(Repository), SchemaTransformation.transform({
+		decode: (input) => {
+			if (typeof input === "string") {
+				const repository = Repository.make({ url: input });
+				repositoryWires.set(repository, input);
+				return repository;
+			}
+			const rest = {};
+			for (const [key, value] of Object.entries(input)) if (!KNOWN_REPOSITORY_KEYS.has(key)) rest[key] = value;
+			const repository = Repository.make({
+				url: typeof input.url === "string" ? input.url : "",
+				...typeof input.type === "string" && { type: input.type },
+				...typeof input.directory === "string" && { directory: input.directory },
+				...Object.keys(rest).length > 0 && { rest }
+			});
+			repositoryWires.set(repository, input);
+			return repository;
+		},
+		encode: (repository) => {
+			const wire = repositoryWires.get(repository);
+			if (typeof wire === "string" && wire === repository.url) return wire;
+			if (wire !== void 0 && typeof wire !== "string") return wire;
+			return {
+				...repository.type !== void 0 && { type: repository.type },
+				url: repository.url,
+				...repository.directory !== void 0 && { directory: repository.directory },
+				...repository.rest
+			};
+		}
+	})));
+};
+/**
+* Where to report problems with a package.
+*
+* @remarks
+* npm permits a bare URL string, or an object with `url`, `email`, or both —
+* an email-only entry is legal, which is why `url` is optional.
+*
+* @public
+*/
+var Bugs = class Bugs extends Schema.Class("Bugs")({
+	/** The issue-tracker URL. */
+	url: Schema.optionalKey(Schema.String),
+	/** The address to mail instead of, or alongside, filing an issue. */
+	email: Schema.optionalKey(Schema.String),
+	/** Keys outside the documented set, preserved so encoding does not drop them. */
+	rest: Schema.optionalKey(Schema.Record(Schema.String, Schema.Unknown))
+}) {
+	/** The `bugs` field: a URL string or the object form. */
+	static FromValue = Schema.Union([Schema.Record(Schema.String, Schema.Unknown), Schema.String]).pipe(Schema.decodeTo(Schema.instanceOf(Bugs), SchemaTransformation.transform({
+		decode: (input) => {
+			if (typeof input === "string") {
+				const bugs = Bugs.make({ url: input });
+				bugsWires.set(bugs, input);
+				return bugs;
+			}
+			const rest = {};
+			for (const [key, value] of Object.entries(input)) if (!KNOWN_BUGS_KEYS.has(key)) rest[key] = value;
+			const bugs = Bugs.make({
+				...typeof input.url === "string" && { url: input.url },
+				...typeof input.email === "string" && { email: input.email },
+				...Object.keys(rest).length > 0 && { rest }
+			});
+			bugsWires.set(bugs, input);
+			return bugs;
+		},
+		encode: (bugs) => {
+			const wire = bugsWires.get(bugs);
+			if (typeof wire === "string" && wire === bugs.url && bugs.email === void 0) return wire;
+			if (wire !== void 0 && typeof wire !== "string") return wire;
+			return {
+				...bugs.url !== void 0 && { url: bugs.url },
+				...bugs.email !== void 0 && { email: bugs.email },
+				...bugs.rest
+			};
+		}
+	})));
+};
+
+//#endregion
+export { Bugs, Repository };

package/index.d.ts

@@ -292,6 +292,75 @@ declare class Person extends Person_base {
   static wireStringOf(person: Person): Option.Option<string>;
 }
 //#endregion
+//#region src/Repository.d.ts
+declare const Repository_base: Schema.Class<Repository, Schema.Struct<{
+  /** The `type` field, when the object form carried one (`"git"`, …). */
+  readonly type: Schema.optionalKey<Schema.String>;
+  /** The reference exactly as written: a shorthand, a git URL, or an https URL. */
+  readonly url: Schema.String;
+  /** The subdirectory within the repository, for a monorepo member. */
+  readonly directory: Schema.optionalKey<Schema.String>;
+  /** Keys outside the documented set, preserved so encoding does not drop them. */
+  readonly rest: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
+}>, {}>;
+/**
+ * Where a package's source lives.
+ *
+ * @remarks
+ * `url` is **verbatim** — exactly the string the manifest carried, shorthand
+ * and all. Normalization is offered through {@link Repository.browseUrl} and
+ * {@link Repository.gitUrl}, so reading a manifest never rewrites it and a
+ * caller that wants the original still has it.
+ *
+ * @example
+ * ```ts
+ * // "effected/kit" → https://github.com/effected/kit
+ * // "git@github.com:effected/kit.git" → https://github.com/effected/kit
+ * ```
+ *
+ * @public
+ */
+declare class Repository extends Repository_base {
+  /**
+   * The browsable `https://` URL, or `Option.none()` when `url` is not a form
+   * this model recognizes.
+   */
+  get browseUrl(): Option.Option<string>;
+  /** The canonical https clone URL, or none when it cannot be derived. */
+  get gitUrl(): Option.Option<string>;
+  /**
+   * The `repository` field: the shorthand string or the object form, always
+   * decoded to a {@link Repository}, and always re-encoded in the form it was
+   * read from.
+   */
+  static readonly FromValue: Schema.Codec<Repository, string | {
+    readonly [k: string]: unknown;
+  }>;
+}
+declare const Bugs_base: Schema.Class<Bugs, Schema.Struct<{
+  /** The issue-tracker URL. */
+  readonly url: Schema.optionalKey<Schema.String>;
+  /** The address to mail instead of, or alongside, filing an issue. */
+  readonly email: Schema.optionalKey<Schema.String>;
+  /** Keys outside the documented set, preserved so encoding does not drop them. */
+  readonly rest: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>;
+}>, {}>;
+/**
+ * Where to report problems with a package.
+ *
+ * @remarks
+ * npm permits a bare URL string, or an object with `url`, `email`, or both —
+ * an email-only entry is legal, which is why `url` is optional.
+ *
+ * @public
+ */
+declare class Bugs extends Bugs_base {
+  /** The `bugs` field: a URL string or the object form. */
+  static readonly FromValue: Schema.Codec<Bugs, string | {
+    readonly [k: string]: unknown;
+  }>;
+}
+//#endregion
 //#region src/Package.d.ts
 /**
  * A string→string map field decoding a plain JSON object to a `HashMap`,
@@ -341,9 +410,12 @@ declare const PeerDependenciesMetaField: Schema.$Record<Schema.String, Schema.St
   readonly optional: Schema.optionalKey<Schema.Boolean>;
 }>>;
 /**
- * The `repository` field: a shorthand string or an object (with `type` / `url` /
- * `directory` and any extensions preserved). Not meant to be referenced
- * directly.
+ * The `repository` field's raw wire shape: a shorthand string or an object.
+ *
+ * @deprecated Superseded by {@link Repository.FromValue}, which decodes both
+ * encodings into a typed {@link Repository} with normalization getters and
+ * round-trips the original form. Kept as a named type for consumers that were
+ * matching on the raw union; it is no longer what `Package.repository` uses.
  *
  * @public
  */
@@ -422,7 +494,17 @@ declare const Package_base: Schema.Class<Package, Schema.Struct<{
   readonly contributors: Schema.optionalKey<Schema.$Array<Schema.Codec<Person, string | {
     readonly [k: string]: unknown;
   }, never, never>>>;
-  readonly repository: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.$Record<Schema.String, Schema.Unknown>]>>;
+  readonly maintainers: Schema.optionalKey<Schema.$Array<Schema.Codec<Person, string | {
+    readonly [k: string]: unknown;
+  }, never, never>>>;
+  readonly keywords: Schema.optionalKey<Schema.$Array<Schema.String>>;
+  readonly repository: Schema.optionalKey<Schema.Codec<Repository, string | {
+    readonly [k: string]: unknown;
+  }, never, never>>;
+  readonly bugs: Schema.optionalKey<Schema.Codec<Bugs, string | {
+    readonly [k: string]: unknown;
+  }, never, never>>;
+  readonly homepage: Schema.optionalKey<Schema.String>;
   readonly dependencies: Schema.decodeTo<Schema.HashMap<Schema.String, Schema.String>, Schema.withDecodingDefaultKey<Schema.$Record<Schema.String, Schema.String>, never>, never, never>;
   readonly devDependencies: Schema.decodeTo<Schema.HashMap<Schema.String, Schema.String>, Schema.withDecodingDefaultKey<Schema.$Record<Schema.String, Schema.String>, never>, never, never>;
   readonly peerDependencies: Schema.decodeTo<Schema.HashMap<Schema.String, Schema.String>, Schema.withDecodingDefaultKey<Schema.$Record<Schema.String, Schema.String>, never>, never, never>;
@@ -960,5 +1042,5 @@ declare class PackageValidator extends PackageValidator_base {
   }): Layer.Layer<PackageValidator>;
 }
 //#endregion
-export { BinField, Dependency, type DependencyKind, DependencyMapField, type DependencyProtocol, DependencySpecifier, type DependencySpecifierBrand, DevEngine, DevEngineOrArray, type DevEngines, DevEnginesSchema, ExportsField, InvalidDependencySpecifierError, InvalidPackageNameError, InvalidSpdxLicenseError, Package, PackageDecodeError, type PackageFormatOptions, type PackageFormatTextOptions, type PackageIndent, PackageJsonFile, type PackageJsonFileShape, PackageJsonFormat, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonSyntaxError, PackageJsonWriteError, PackageManager, PackageName, type PackagePatch, PackageValidationError, PackageValidator, PeerDependenciesMetaField, Person, PublishConfigField, RepositoryField, type RuleFailure, ScopedPackageName, SpdxLicense, StringMapField, type UnresolvedDependency, UnscopedPackageName, type ValidationRule, defaultRules, isUnresolvedDependency, isValidDependencySpecifier, isValidSpdx, noLocalDepsRule, noUnresolvedDepsRule };
+export { BinField, Bugs, Dependency, type DependencyKind, DependencyMapField, type DependencyProtocol, DependencySpecifier, type DependencySpecifierBrand, DevEngine, DevEngineOrArray, type DevEngines, DevEnginesSchema, ExportsField, InvalidDependencySpecifierError, InvalidPackageNameError, InvalidSpdxLicenseError, Package, PackageDecodeError, type PackageFormatOptions, type PackageFormatTextOptions, type PackageIndent, PackageJsonFile, type PackageJsonFileShape, PackageJsonFormat, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonSyntaxError, PackageJsonWriteError, PackageManager, PackageName, type PackagePatch, PackageValidationError, PackageValidator, PeerDependenciesMetaField, Person, PublishConfigField, Repository, RepositoryField, type RuleFailure, ScopedPackageName, SpdxLicense, StringMapField, type UnresolvedDependency, UnscopedPackageName, type ValidationRule, defaultRules, isUnresolvedDependency, isValidDependencySpecifier, isValidSpdx, noLocalDepsRule, noUnresolvedDepsRule };
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -4,10 +4,11 @@ import { InvalidSpdxLicenseError, SpdxLicense, isValidSpdx } from "./License.js"
 import { PackageManager } from "./PackageManager.js";
 import { InvalidPackageNameError, PackageName, ScopedPackageName, UnscopedPackageName } from "./PackageName.js";
 import { Person } from "./Person.js";
+import { Bugs, Repository } from "./Repository.js";
 import { BinField, DependencyMapField, ExportsField, Package, PackageDecodeError, PeerDependenciesMetaField, PublishConfigField, RepositoryField, StringMapField } from "./Package.js";
 import { PackageJsonFile, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonWriteError } from "./PackageJsonFile.js";
 import { PackageJsonFormat, PackageJsonSyntaxError } from "./PackageJsonFormat.js";
 import { PackageValidationError, PackageValidator, defaultRules, noLocalDepsRule, noUnresolvedDepsRule } from "./PackageValidator.js";
 import { DependencySpecifier, InvalidDependencySpecifierError, isValidDependencySpecifier } from "@effected/npm";
 
-export { BinField, Dependency, DependencyMapField, DependencySpecifier, DevEngine, DevEngineOrArray, DevEnginesSchema, ExportsField, InvalidDependencySpecifierError, InvalidPackageNameError, InvalidSpdxLicenseError, Package, PackageDecodeError, PackageJsonFile, PackageJsonFormat, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonSyntaxError, PackageJsonWriteError, PackageManager, PackageName, PackageValidationError, PackageValidator, PeerDependenciesMetaField, Person, PublishConfigField, RepositoryField, ScopedPackageName, SpdxLicense, StringMapField, UnscopedPackageName, defaultRules, isUnresolvedDependency, isValidDependencySpecifier, isValidSpdx, noLocalDepsRule, noUnresolvedDepsRule };
+export { BinField, Bugs, Dependency, DependencyMapField, DependencySpecifier, DevEngine, DevEngineOrArray, DevEnginesSchema, ExportsField, InvalidDependencySpecifierError, InvalidPackageNameError, InvalidSpdxLicenseError, Package, PackageDecodeError, PackageJsonFile, PackageJsonFormat, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonSyntaxError, PackageJsonWriteError, PackageManager, PackageName, PackageValidationError, PackageValidator, PeerDependenciesMetaField, Person, PublishConfigField, Repository, RepositoryField, ScopedPackageName, SpdxLicense, StringMapField, UnscopedPackageName, defaultRules, isUnresolvedDependency, isValidDependencySpecifier, isValidSpdx, noLocalDepsRule, noUnresolvedDepsRule };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/package-json",
-	"version": "0.5.1",
+	"version": "0.6.0",
 	"private": false,
 	"description": "package.json parsing, editing, validation and file IO as Effect schemas.",
 	"keywords": [
@@ -38,7 +38,7 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@effected/npm": "~0.3.1",
+		"@effected/npm": "~0.5.0",
 		"@effected/semver": "~0.2.1",
 		"@effected/spdx": "~0.1.1"
 	},