@johnmorrisdotca/kuni 1.2.0 → 1.4.0

package/dist/facts.d.cts

@@ -1,5 +1,5 @@
-import { C as CountryFacts, L as LatLon } from './types-ChquRAZM.cjs';
-export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-ChquRAZM.cjs';
+import { C as CountryFacts, L as LatLon } from './types-C7CG02m1.cjs';
+export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-C7CG02m1.cjs';
 
 /**
  * The day the Wikidata snapshot was read: every figure in /facts is as Wikidata gave it on this day.
@@ -22,12 +22,12 @@ declare const FACTS_READ = "2026-10-09";
  * ```ts
  * import { facts } from "@johnmorrisdotca/kuni/facts";
  *
- * facts("JP")?.population;    // 123802000
- * facts("JP")?.populationYear; // 2024
- * facts("FR")?.borders;        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
- * facts("GB")?.drivingSide;    // "left"
- * facts("US")?.weekStart;      // "sun"
- * facts("XX");                 // null
+ * console.log(facts("JP")?.population);    // 123802000
+ * console.log(facts("JP")?.populationYear); // 2024
+ * console.log(facts("FR")?.borders);        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
+ * console.log(facts("GB")?.drivingSide);    // "left"
+ * console.log(facts("US")?.weekStart);      // "sun"
+ * console.log(facts("XX"));                 // null
  * ```
  */
 declare const facts: (code: string) => CountryFacts | null;
@@ -57,7 +57,7 @@ declare const allFacts: () => readonly CountryFacts[];
  * ```ts
  * import { distanceKm, facts } from "@johnmorrisdotca/kuni/facts";
  *
- * Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!)); // 9558
+ * console.log(Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!))); // 9558
  * ```
  */
 declare const distanceKm: (from: LatLon, to: LatLon) => number;

package/dist/facts.d.ts

@@ -1,5 +1,5 @@
-import { C as CountryFacts, L as LatLon } from './types-ChquRAZM.js';
-export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-ChquRAZM.js';
+import { C as CountryFacts, L as LatLon } from './types-C7CG02m1.js';
+export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-C7CG02m1.js';
 
 /**
  * The day the Wikidata snapshot was read: every figure in /facts is as Wikidata gave it on this day.
@@ -22,12 +22,12 @@ declare const FACTS_READ = "2026-10-09";
  * ```ts
  * import { facts } from "@johnmorrisdotca/kuni/facts";
  *
- * facts("JP")?.population;    // 123802000
- * facts("JP")?.populationYear; // 2024
- * facts("FR")?.borders;        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
- * facts("GB")?.drivingSide;    // "left"
- * facts("US")?.weekStart;      // "sun"
- * facts("XX");                 // null
+ * console.log(facts("JP")?.population);    // 123802000
+ * console.log(facts("JP")?.populationYear); // 2024
+ * console.log(facts("FR")?.borders);        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
+ * console.log(facts("GB")?.drivingSide);    // "left"
+ * console.log(facts("US")?.weekStart);      // "sun"
+ * console.log(facts("XX"));                 // null
  * ```
  */
 declare const facts: (code: string) => CountryFacts | null;
@@ -57,7 +57,7 @@ declare const allFacts: () => readonly CountryFacts[];
  * ```ts
  * import { distanceKm, facts } from "@johnmorrisdotca/kuni/facts";
  *
- * Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!)); // 9558
+ * console.log(Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!))); // 9558
  * ```
  */
 declare const distanceKm: (from: LatLon, to: LatLon) => number;

package/dist/groupings.d.cts

@@ -1,7 +1,16 @@
-import { G as GroupingKind, a as GroupingStatus } from './types-ChquRAZM.cjs';
-export { b as GROUPING_KINDS } from './types-ChquRAZM.cjs';
+import { G as GroupingKind, a as GroupingStatus } from './types-C7CG02m1.cjs';
+export { b as GROUPING_KINDS } from './types-C7CG02m1.cjs';
 
-/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`. */
+/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingMember } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingMember = {code:"DE",since:"1958-01-01",until:null};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingMember {
     /** The member's alpha-2 code: "DE". */
     code: string;
@@ -10,7 +19,16 @@ interface GroupingMember {
     /** The day it left, "2020-01-31"; `null` while it is a member. */
     until: string | null;
 }
-/** Another name a grouping goes by, in English and Japanese. */
+/** Another name a grouping goes by, in English and Japanese.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingName } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingName = {en:"Kansai region",ja:"関西地方",reading:"かんさいちほう"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingName {
     /** In English: "Kansai region". */
     en: string;
@@ -19,14 +37,33 @@ interface GroupingName {
     /** The Japanese in hiragana, where it has kanji: "かんさいちほう". */
     reading?: string;
 }
-/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended. */
+/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingOther } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingOther = {code:"UA",status:"candidate"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingOther {
     /** The country's alpha-2 code. */
     code: string;
     /** How it stands. */
     status: GroupingStatus;
 }
-/** Where a grouping's definition comes from, and the terms its list is under. */
+/** Where a grouping's definition comes from, and the terms its list is under.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingSource } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingSource = grouping("eu")!.source;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingSource {
     /** The source's name: "European Union, Countries". */
     name: string;
@@ -35,7 +72,17 @@ interface GroupingSource {
     /** The terms of the list as it is shipped here. */
     licence: string;
 }
-/** A grouping of countries, or of the subdivisions inside one country. */
+/** A grouping of countries, or of the subdivisions inside one country.
+ *
+ * @example
+ * ```ts
+ * import type { Grouping } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: Grouping = grouping("eu")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Grouping {
     /** A stable id in kebab case: "eu", "m49-030", "continent-as", "jp-kanto". */
     id: string;
@@ -78,14 +125,33 @@ interface Grouping {
     /** The day the list was true, "2026-10-09". */
     asOf: string;
 }
-/** What `groupings()` may be narrowed to. */
+/** What `groupings()` may be narrowed to.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingsOptions } from "@johnmorrisdotca/kuni/groupings";
+ * import { country } from "@johnmorrisdotca/kuni";
+ *
+ * const value: GroupingsOptions = {country:"JP"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingsOptions {
     /** Only groupings of this kind. */
     kind?: GroupingKind;
     /** Only groupings of the subdivisions inside this country (alpha-2, either case). */
     country?: string;
 }
-/** What `groupingsOf()` and `membersOf()` may be asked. */
+/** What `groupingsOf()` and `membersOf()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingDateOptions } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingDateOptions = {on:"2015-06-30"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingDateOptions {
     /**
      * A day, "2015-06-30": an international body's members on that day rather than now. A member whose start Wikidata
@@ -105,8 +171,8 @@ interface GroupingDateOptions {
  * ```ts
  * import { groupings } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupings({ kind: "continent" }).map((one) => one.name.en); // ["Africa", "Antarctica", "Asia", "Europe", ...]
- * groupings({ country: "JP" }).length;                         // 10: the eight 地方, and the nine-region variant's two
+ * console.log(groupings({ kind: "continent" }).map((one) => one.name.en)); // ["Africa", "Antarctica", "Asia", "Europe", ...]
+ * console.log(groupings({ country: "JP" }).length);                         // 10: the eight 地方, and the nine-region variant's two
  * ```
  */
 declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
@@ -119,10 +185,10 @@ declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
  * ```ts
  * import { grouping } from "@johnmorrisdotca/kuni/groupings";
  *
- * grouping("eu")?.members.length;    // 27
- * grouping("eu")?.name.ja;           // "欧州連合"
- * grouping("jp-kanto")?.members[5];  // "JP-13"
- * grouping("atlantis");              // null
+ * console.log(grouping("eu")?.members.length);    // 27
+ * console.log(grouping("eu")?.name.ja);           // "欧州連合"
+ * console.log(grouping("jp-kanto")?.members[5]);  // "JP-13"
+ * console.log(grouping("atlantis"));              // null
  * ```
  */
 declare const grouping: (id: string) => Grouping | null;
@@ -136,9 +202,9 @@ declare const grouping: (id: string) => Grouping | null;
  * ```ts
  * import { groupingsOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupingsOf("GB", { kind: "membership" }).map((one) => one.id);                    // ["un", "nato", "g7", ...]
- * groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu"); // true
- * groupingsOf("JP-13").map((one) => one.id);                                          // ["jp-kanto"]
+ * console.log(groupingsOf("GB", { kind: "membership" }).map((one) => one.id));                    // ["un", "nato", "g7", ...]
+ * console.log(groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu")); // true
+ * console.log(groupingsOf("JP-13").map((one) => one.id));                                          // ["jp-kanto"]
  * ```
  */
 declare const groupingsOf: (code: string, options?: GroupingDateOptions) => readonly Grouping[];
@@ -152,9 +218,9 @@ declare const groupingsOf: (code: string, options?: GroupingDateOptions) => read
  * ```ts
  * import { membersOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * membersOf("eu")?.includes("GB");                       // false
- * membersOf("eu", { on: "2019-06-30" })?.includes("GB"); // true
- * membersOf("us-pacific");                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
+ * console.log(membersOf("eu")?.includes("GB"));                       // false
+ * console.log(membersOf("eu", { on: "2019-06-30" })?.includes("GB")); // true
+ * console.log(membersOf("us-pacific"));                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
  * ```
  */
 declare const membersOf: (id: string, options?: GroupingDateOptions) => readonly string[] | null;

package/dist/groupings.d.ts

@@ -1,7 +1,16 @@
-import { G as GroupingKind, a as GroupingStatus } from './types-ChquRAZM.js';
-export { b as GROUPING_KINDS } from './types-ChquRAZM.js';
+import { G as GroupingKind, a as GroupingStatus } from './types-C7CG02m1.js';
+export { b as GROUPING_KINDS } from './types-C7CG02m1.js';
 
-/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`. */
+/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingMember } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingMember = {code:"DE",since:"1958-01-01",until:null};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingMember {
     /** The member's alpha-2 code: "DE". */
     code: string;
@@ -10,7 +19,16 @@ interface GroupingMember {
     /** The day it left, "2020-01-31"; `null` while it is a member. */
     until: string | null;
 }
-/** Another name a grouping goes by, in English and Japanese. */
+/** Another name a grouping goes by, in English and Japanese.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingName } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingName = {en:"Kansai region",ja:"関西地方",reading:"かんさいちほう"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingName {
     /** In English: "Kansai region". */
     en: string;
@@ -19,14 +37,33 @@ interface GroupingName {
     /** The Japanese in hiragana, where it has kanji: "かんさいちほう". */
     reading?: string;
 }
-/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended. */
+/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingOther } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingOther = {code:"UA",status:"candidate"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingOther {
     /** The country's alpha-2 code. */
     code: string;
     /** How it stands. */
     status: GroupingStatus;
 }
-/** Where a grouping's definition comes from, and the terms its list is under. */
+/** Where a grouping's definition comes from, and the terms its list is under.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingSource } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingSource = grouping("eu")!.source;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingSource {
     /** The source's name: "European Union, Countries". */
     name: string;
@@ -35,7 +72,17 @@ interface GroupingSource {
     /** The terms of the list as it is shipped here. */
     licence: string;
 }
-/** A grouping of countries, or of the subdivisions inside one country. */
+/** A grouping of countries, or of the subdivisions inside one country.
+ *
+ * @example
+ * ```ts
+ * import type { Grouping } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: Grouping = grouping("eu")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Grouping {
     /** A stable id in kebab case: "eu", "m49-030", "continent-as", "jp-kanto". */
     id: string;
@@ -78,14 +125,33 @@ interface Grouping {
     /** The day the list was true, "2026-10-09". */
     asOf: string;
 }
-/** What `groupings()` may be narrowed to. */
+/** What `groupings()` may be narrowed to.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingsOptions } from "@johnmorrisdotca/kuni/groupings";
+ * import { country } from "@johnmorrisdotca/kuni";
+ *
+ * const value: GroupingsOptions = {country:"JP"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingsOptions {
     /** Only groupings of this kind. */
     kind?: GroupingKind;
     /** Only groupings of the subdivisions inside this country (alpha-2, either case). */
     country?: string;
 }
-/** What `groupingsOf()` and `membersOf()` may be asked. */
+/** What `groupingsOf()` and `membersOf()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingDateOptions } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingDateOptions = {on:"2015-06-30"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingDateOptions {
     /**
      * A day, "2015-06-30": an international body's members on that day rather than now. A member whose start Wikidata
@@ -105,8 +171,8 @@ interface GroupingDateOptions {
  * ```ts
  * import { groupings } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupings({ kind: "continent" }).map((one) => one.name.en); // ["Africa", "Antarctica", "Asia", "Europe", ...]
- * groupings({ country: "JP" }).length;                         // 10: the eight 地方, and the nine-region variant's two
+ * console.log(groupings({ kind: "continent" }).map((one) => one.name.en)); // ["Africa", "Antarctica", "Asia", "Europe", ...]
+ * console.log(groupings({ country: "JP" }).length);                         // 10: the eight 地方, and the nine-region variant's two
  * ```
  */
 declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
@@ -119,10 +185,10 @@ declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
  * ```ts
  * import { grouping } from "@johnmorrisdotca/kuni/groupings";
  *
- * grouping("eu")?.members.length;    // 27
- * grouping("eu")?.name.ja;           // "欧州連合"
- * grouping("jp-kanto")?.members[5];  // "JP-13"
- * grouping("atlantis");              // null
+ * console.log(grouping("eu")?.members.length);    // 27
+ * console.log(grouping("eu")?.name.ja);           // "欧州連合"
+ * console.log(grouping("jp-kanto")?.members[5]);  // "JP-13"
+ * console.log(grouping("atlantis"));              // null
  * ```
  */
 declare const grouping: (id: string) => Grouping | null;
@@ -136,9 +202,9 @@ declare const grouping: (id: string) => Grouping | null;
  * ```ts
  * import { groupingsOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupingsOf("GB", { kind: "membership" }).map((one) => one.id);                    // ["un", "nato", "g7", ...]
- * groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu"); // true
- * groupingsOf("JP-13").map((one) => one.id);                                          // ["jp-kanto"]
+ * console.log(groupingsOf("GB", { kind: "membership" }).map((one) => one.id));                    // ["un", "nato", "g7", ...]
+ * console.log(groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu")); // true
+ * console.log(groupingsOf("JP-13").map((one) => one.id));                                          // ["jp-kanto"]
  * ```
  */
 declare const groupingsOf: (code: string, options?: GroupingDateOptions) => readonly Grouping[];
@@ -152,9 +218,9 @@ declare const groupingsOf: (code: string, options?: GroupingDateOptions) => read
  * ```ts
  * import { membersOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * membersOf("eu")?.includes("GB");                       // false
- * membersOf("eu", { on: "2019-06-30" })?.includes("GB"); // true
- * membersOf("us-pacific");                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
+ * console.log(membersOf("eu")?.includes("GB"));                       // false
+ * console.log(membersOf("eu", { on: "2019-06-30" })?.includes("GB")); // true
+ * console.log(membersOf("us-pacific"));                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
  * ```
  */
 declare const membersOf: (id: string, options?: GroupingDateOptions) => readonly string[] | null;