@gryt/core 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { getAccentColor, getLinkProvider, getProviderDetail, hostnameOf, LINK_PR
 export { getProviderLogo, LINK_PROVIDER_LOGOS, LOGO_VIEW_BOX, } from "./links/logos.js";
 export { describePreviewFailure, extractUrls, getCardSubtitle, getLinkCardLayout, type LinkCardLayout, type LinkPreviewData, } from "./links/preview.js";
 export { conversationTitle, type DirectConversation, } from "./conversations/title.js";
-export { normalizeCode, normalizeHost, parseServerInput, type ServerInput, } from "./servers/address.js";
+export { inviteLink, isPublicHost, normalizeCode, normalizeHost, parseServerInput, type ServerInput, } from "./servers/address.js";
 export { NAME_POOL, pickRandomName } from "./profile/randomName.js";
 export { cellState, CUSTOM_VALUE, describeRules, EVERYONE_VALUE, indexRules, nextCellState, scopeChoiceFromValue, scopeChoiceValue, scopeOptions, scopeSetPayload, withCell, type CellState, type ChannelRule, type RuleEffect, type ScopeChoice, } from "./permissions/channelRules.js";
 export { groupMembersByRole, OFFLINE_GROUP_KEY, UNGROUPED_GROUP_KEY, type GroupableMember, type GroupableRole, type MemberGroup, } from "./members/groups.js";

package/dist/index.js

@@ -1,12 +1,11 @@
-/* What belongs here: it must compile with no DOM and no React Native, and both
-   apps must otherwise need a copy. The barrel is flat and named because
-   `check-public-surface.mjs` asserts against it. */
+/* What belongs here: it must compile with no DOM and no React Native, and both apps must
+   otherwise need a copy. The barrel is flat and named, because the surface check reads it. */
 export { buildReport, describeAttached, MESSAGE_MAX, TITLE_MAX, } from "./reports/report.js";
 export { getAccentColor, getLinkProvider, getProviderDetail, hostnameOf, LINK_PROVIDERS, } from "./links/providers.js";
 export { getProviderLogo, LINK_PROVIDER_LOGOS, LOGO_VIEW_BOX, } from "./links/logos.js";
 export { describePreviewFailure, extractUrls, getCardSubtitle, getLinkCardLayout, } from "./links/preview.js";
 export { conversationTitle, } from "./conversations/title.js";
-export { normalizeCode, normalizeHost, parseServerInput, } from "./servers/address.js";
+export { inviteLink, isPublicHost, normalizeCode, normalizeHost, parseServerInput, } from "./servers/address.js";
 export { NAME_POOL, pickRandomName } from "./profile/randomName.js";
 export { cellState, CUSTOM_VALUE, describeRules, EVERYONE_VALUE, indexRules, nextCellState, scopeChoiceFromValue, scopeChoiceValue, scopeOptions, scopeSetPayload, withCell, } from "./permissions/channelRules.js";
 export { groupMembersByRole, OFFLINE_GROUP_KEY, UNGROUPED_GROUP_KEY, } from "./members/groups.js";

package/dist/links/logos.js

@@ -1,18 +1,5 @@
-/* The artwork for the providers in providers.ts, as raw SVG path data.
-
-   It used to live in the desktop client as react-icons components, which meant
-   the phone had no logos at all and the client carried an 82MB dependency to
-   draw 73 of them. Path data is not DOM, so it can sit here with the hostnames
-   and brand colours it belongs with, and each app draws it with whatever it
-   has: <path> in the browser, <Path> from react-native-svg on the phone.
-
-   Every one is a single path on a 24x24 canvas, which is Simple Icons' own
-   format and is asserted in logos.test.ts. A provider with no logo here falls
-   back to the site's favicon, so adding a provider without adding artwork
-   degrades rather than breaks.
-
-   The marks belong to the companies they identify. Being here is so Gryt can
-   point at those sites, not a claim on them. */
+/* The artwork for the providers in providers.ts, as raw SVG path data, so both apps draw it
+   with what they have. The marks belong to the companies they identify. */
 /** Every logo below is drawn on this canvas. */
 export const LOGO_VIEW_BOX = "0 0 24 24";
 /** Provider id, as in {@link LINK_PROVIDERS}, to its SVG path data. */

package/dist/links/preview.d.ts

@@ -20,35 +20,23 @@ export interface LinkPreviewData {
     status?: number | null;
 }
 /**
- * The links in a message, minus the ones that are already something else.
- *
- * Code spans and fences are stripped first: a URL inside backticks is being
- * quoted rather than shared, and a card under it would be noise. Markdown
- * images are stripped because the picture is already drawn.
+ * The links in a message, minus the ones that are already something else: a URL in backticks
+ * is being quoted rather than shared, and a markdown image is already drawn.
  */
 export declare function extractUrls(text: string | null): string[];
 /**
- * How much of a card a preview can fill.
- *
- * A wide image wants to sit under the text at full width. A small or square one
- * wants to be a thumbnail beside it. No image wants no space set aside for a
- * picture at all. Drawing all three the same way is what produced a hostname
- * next to an empty grey rectangle.
+ * How much of a card a preview can fill. A wide image sits under the text, a small one
+ * beside it, and no image takes no space — drawing all three alike gave a grey rectangle.
  */
 export type LinkCardLayout = "large" | "thumbnail" | "text" | "bare";
 export declare function getLinkCardLayout(data: LinkPreviewData): LinkCardLayout;
 /**
- * Why a page gave us nothing, in words worth showing somebody.
- *
- * Only for statuses that mean something to a reader. A 500 is the site's
- * problem and saying so helps nobody, so it returns null and the card falls
- * back to showing the link on its own.
+ * Why a page gave us nothing, in words worth showing somebody. Only for statuses that mean
+ * something to a reader: a 500 is the site's problem, so it returns null.
  */
 export declare function describePreviewFailure(status: number | null | undefined): string | null;
 /**
- * The line under the title, where the path says something the title does not.
- *
- * Wikipedia titles its WebRTC page "WebRTC" and the detail read out of
- * `/wiki/WebRTC` is "WebRTC", so showing both printed the word twice.
+ * The line under the title, where the path says something the title does not. Wikipedia
+ * titles its WebRTC page "WebRTC", and `/wiki/WebRTC` printed the word twice.
  */
 export declare function getCardSubtitle(title: string | null, detail: string | null): string | null;

package/dist/links/preview.js

@@ -2,11 +2,8 @@
    the two apps reach a server differently. */
 const URL_REGEX = /https?:\/\/[^\s<>[\](){}'"`,]+[^\s<>[\](){}'"`,.:;!?)]/gi;
 /**
- * The links in a message, minus the ones that are already something else.
- *
- * Code spans and fences are stripped first: a URL inside backticks is being
- * quoted rather than shared, and a card under it would be noise. Markdown
- * images are stripped because the picture is already drawn.
+ * The links in a message, minus the ones that are already something else: a URL in backticks
+ * is being quoted rather than shared, and a markdown image is already drawn.
  */
 export function extractUrls(text) {
     if (!text)
@@ -28,10 +25,8 @@ export function getLinkCardLayout(data) {
         return hasText ? "text" : "bare";
     const w = data.imageWidth;
     const h = data.imageHeight;
-    /* Unknown dimensions count as large. A site that sets og:image and says
-       nothing about its size has almost always set a share card, and the ones
-       that have not lose less by being drawn big than a real share card loses by
-       being shrunk into a corner. */
+    /* Unknown dimensions count as large: a site that sets og:image and says nothing about its
+       size has almost always set a share card, and those lose most by being shrunk. */
     if (!w || !h)
         return "large";
     if (w >= LARGE_IMAGE_MIN_WIDTH && w / h >= LARGE_IMAGE_MIN_ASPECT)
@@ -39,21 +34,16 @@ export function getLinkCardLayout(data) {
     return hasText ? "thumbnail" : "large";
 }
 /**
- * Why a page gave us nothing, in words worth showing somebody.
- *
- * Only for statuses that mean something to a reader. A 500 is the site's
- * problem and saying so helps nobody, so it returns null and the card falls
- * back to showing the link on its own.
+ * Why a page gave us nothing, in words worth showing somebody. Only for statuses that mean
+ * something to a reader: a 500 is the site's problem, so it returns null.
  */
 export function describePreviewFailure(status) {
     if (status == null)
         return null;
     if (status === 401)
         return "Sign-in only";
-    /* Not "private": a 403 is as often a site refusing our fetcher as it is a
-       page somebody is not allowed to see. Stack Overflow answers 403 to the
-       preview fetch and 200 to a browser. A private GitHub repository answers
-       404 and is covered below. */
+    /* Not "private": a 403 is as often a site refusing our fetcher as a page somebody may not
+       see. Stack Overflow answers 403 to the fetch and 200 to a browser. */
     if (status === 403)
         return "The site would not let us look";
     if (status === 404 || status === 410)
@@ -63,10 +53,8 @@ export function describePreviewFailure(status) {
     return null;
 }
 /**
- * The line under the title, where the path says something the title does not.
- *
- * Wikipedia titles its WebRTC page "WebRTC" and the detail read out of
- * `/wiki/WebRTC` is "WebRTC", so showing both printed the word twice.
+ * The line under the title, where the path says something the title does not. Wikipedia
+ * titles its WebRTC page "WebRTC", and `/wiki/WebRTC` printed the word twice.
  */
 export function getCardSubtitle(title, detail) {
     if (!detail || !title)

package/dist/links/providers.d.ts

@@ -16,8 +16,7 @@ export declare function getLinkProvider(url: string): LinkProvider | null;
 /** The line a provider can read out of the path, if it knows how. */
 export declare function getProviderDetail(url: string): string | null;
 /**
- * The accent a card is drawn with: the brand where we know it, the colour the
- * page declared where we do not, and null for the app's own accent when
- * neither is on offer.
+ * The accent a card is drawn with: the brand where we know it, the colour the page declared
+ * where we do not, and null for the app's own accent when neither is on offer.
  */
 export declare function getAccentColor(url: string, themeColor: string | null | undefined, appearance: "light" | "dark"): string | null;

package/dist/links/providers.js

@@ -1,10 +1,5 @@
-/* Not the list of sites that work — any site with OpenGraph gets a full card
-   without being here. Being here buys a real logo and a brand colour.
-
-   The logos are in logos.ts, as path data rather than components, because that
-   is the part both apps can share without this package touching a DOM. They
-   used to be react-icons components in the desktop client and nothing at all
-   on the phone. */
+/* Not the list of sites that work — any site with OpenGraph gets a full card. Being here
+   buys a real logo and a brand colour, and the logos are path data in logos.ts. */
 const seg = (url) => url.pathname.split("/").filter(Boolean);
 function githubDetail(url) {
     const p = seg(url);
@@ -65,13 +60,8 @@ function wikipediaDetail(url) {
     }
 }
 /**
- * The model's name out of `/models/1642496-old-vikings-jewelry-box`.
- *
- * The number is the id their API takes and means nothing to a reader, so the
- * slug behind it is what the line says. A link with the slug stripped —
- * `/models/1642496`, which is what their own copy button produces — has
- * nothing to add, and null leaves the card to its title rather than printing
- * an id at somebody.
+ * The model's name out of `/models/1642496-old-vikings-jewelry-box`: the number is an id
+ * that says nothing, and a link with the slug stripped gets null rather than the id.
  */
 function makerWorldDetail(url) {
     const p = seg(url);
@@ -219,9 +209,8 @@ export function getProviderDetail(url) {
     }
 }
 /**
- * The accent a card is drawn with: the brand where we know it, the colour the
- * page declared where we do not, and null for the app's own accent when
- * neither is on offer.
+ * The accent a card is drawn with: the brand where we know it, the colour the page declared
+ * where we do not, and null for the app's own accent when neither is on offer.
  */
 export function getAccentColor(url, themeColor, appearance) {
     const provider = getLinkProvider(url);

package/dist/members/groups.d.ts

@@ -1,31 +1,10 @@
 /**
- * The member list, cut into role groups.
- *
- * Both apps drew this and both got it right, separately, which is the shape of
- * duplicate that goes wrong quietly: nothing fails when the two drift, the
- * lists just stop matching, and a moderator has to re-learn the sidebar on
- * whichever device they are holding.
- *
- * **Offline leaves its role** — the question the list answers is "who is
- * around", so they go to one group at the end in one alphabet rather than to
- * the bottom of each role.
- *
- * Roles run highest rank first, and roles nobody holds are left out rather than
- * drawn empty. A member whose role the server did not describe lands in one
- * unnamed group after the named ones, which is also what a server too old to
- * send roles looks like.
+ * The member list, cut into role groups. Offline leaves its role and goes to one group at
+ * the end: the question the list answers is who is around.
  */
 /**
- * What this needs to know about a member, and no more.
- *
- * Structural rather than a type the apps have to adopt: the desktop's
- * `MemberInfo` and the phone's `Member` carry different fields for different
- * screens, and both already satisfy this.
- *
- * **A `status` this does not recognise counts as present, `undefined`
- * included.** The server always sends one — `clients.ts` defaults it to
- * `offline` — so the absent case is a server too old to have the field, and on
- * one of those every member reading as offline would blank the whole list.
+ * What this needs to know about a member, and no more, structurally. A `status` this does
+ * not recognise counts as present, `undefined` included — that is an old server.
  */
 export interface GroupableMember {
     nickname?: string | null;
@@ -40,12 +19,8 @@ export interface GroupableRole {
     color?: string | null;
 }
 /**
- * One block of the member list: a heading and the people under it.
- *
- * Generic over the member so a caller gets its own type back and can draw
- * whatever it stores. `color` is the role's own colour, straight from the
- * server, or null for a role that has none and for the two groups that are not
- * roles.
+ * One block of the member list: a heading and the people under it. Generic over the member,
+ * so a caller gets its own type back. `color` is the role's own, or null.
  */
 export interface MemberGroup<M> {
     key: string;

package/dist/members/groups.js

@@ -1,19 +1,6 @@
 /**
- * The member list, cut into role groups.
- *
- * Both apps drew this and both got it right, separately, which is the shape of
- * duplicate that goes wrong quietly: nothing fails when the two drift, the
- * lists just stop matching, and a moderator has to re-learn the sidebar on
- * whichever device they are holding.
- *
- * **Offline leaves its role** — the question the list answers is "who is
- * around", so they go to one group at the end in one alphabet rather than to
- * the bottom of each role.
- *
- * Roles run highest rank first, and roles nobody holds are left out rather than
- * drawn empty. A member whose role the server did not describe lands in one
- * unnamed group after the named ones, which is also what a server too old to
- * send roles looks like.
+ * The member list, cut into role groups. Offline leaves its role and goes to one group at
+ * the end: the question the list answers is who is around.
  */
 /**
  * The key on the group holding anybody not offline, when the server named no

package/dist/permissions/channelRules.d.ts

@@ -18,44 +18,30 @@ export type ScopeChoice = {
 /** The dropdown value that means "this channel has its own rules". */
 export declare const CUSTOM_VALUE = "custom";
 /**
- * The dropdown value that means "no rules at all".
- *
- * A word rather than an empty string: the Select reads "" as "nothing chosen"
- * and paints its placeholder over the label, so a channel open to everyone
- * showed "Select" instead of "Everyone". See [[base-ui-select-empty-value]] —
- * the Max Bitrate control in the same dialog already used "default" for this.
+ * The dropdown value that means "no rules at all". A word rather than an empty string: the
+ * Select reads "" as "nothing chosen" and paints its placeholder over the label.
  */
 export declare const EVERYONE_VALUE = "everyone";
 /** Look up one cell without scanning the whole list per cell. */
 export declare function indexRules(rules: ChannelRule[]): Map<string, RuleEffect>;
 export declare function cellState(index: Map<string, RuleEffect>, roleId: string, permission: string): CellState;
 /**
- * The next state when somebody clicks a cell.
- *
- * inherit to deny to allow and back to inherit. Deny comes first deliberately:
- * taking something away is what people open this to do, and it puts the
- * dangerous state one click from neutral rather than two.
+ * The next state when somebody clicks a cell: inherit, deny, allow, inherit. Deny first,
+ * because taking something away is what people open this to do.
  */
 export declare function nextCellState(current: CellState): CellState;
 /** Set one cell, dropping the row entirely when it goes back to inherit. */
 export declare function withCell(rules: ChannelRule[], roleId: string, permission: string, state: CellState): ChannelRule[];
 /**
- * Which dropdown value a channel is showing.
- *
- * The server sends the scope id plus whether it is a template. A scope that is
- * not a template is this channel's own, which is Custom; no scope at all is
- * Everyone.
+ * Which dropdown value a channel is showing. A scope that is not a template is this
+ * channel's own, which is Custom; no scope at all is Everyone.
  */
 export declare function scopeChoiceValue(scopeId: string | null, isTemplate: boolean): string;
 /** Turn the dropdown value back into what the server event wants. */
 export declare function scopeChoiceFromValue(value: string): ScopeChoice;
 /**
- * The payload for `server:channels:scope:set`.
- *
- * Custom sends its rules; the other two send none. Templates deliberately do
- * not carry rules here — editing a template from a channel would change every
- * other channel using it, which is the opposite of what somebody expects from
- * a screen titled with one channel's name.
+ * The payload for `server:channels:scope:set`. Templates deliberately do not carry rules:
+ * editing one from a channel would change every other channel using it.
  */
 export declare function scopeSetPayload(choice: ScopeChoice, rules: ChannelRule[]): {
     templateId?: string | null;
@@ -63,11 +49,8 @@ export declare function scopeSetPayload(choice: ScopeChoice, rules: ChannelRule[
     rules?: ChannelRule[];
 };
 /**
- * The dropdown options: Everyone, then each template, then Custom.
- *
- * Custom last because it is the escape hatch. Somebody scanning the list should
- * meet the shared answers first — the whole point of templates is that reaching
- * for Custom is the uncommon choice.
+ * The dropdown options: Everyone, then each template, then Custom. Custom last, because it
+ * is the escape hatch and reaching for it is the uncommon choice.
  */
 export declare function scopeOptions(templates: {
     id: string;
@@ -77,11 +60,7 @@ export declare function scopeOptions(templates: {
     value: string;
 }[];
 /**
- * A one-line summary of what a set of rules does, for the note under the
- * dropdown.
- *
- * Reading is called out on its own because it is the rule with a different
- * consequence: a role denied `read_messages` is not shown a locked channel,
- * it is shown nothing at all, and somebody setting that deserves to be told.
+ * A one-line summary of what a set of rules does. Reading is called out on its own: a role
+ * denied `read_messages` is shown nothing at all rather than a locked channel.
  */
 export declare function describeRules(rules: ChannelRule[], roleNames: Map<string, string>): string;

package/dist/permissions/channelRules.js

@@ -1,18 +1,10 @@
-/* Inherit is the absence of a row, so a cell has three states and only two are
-   ever written.
-
-   `indexRules` keys on role and permission joined by NUL, because NUL cannot
-   appear in either half. Written as `\u0000` rather than a raw byte: literal
-   NULs make git treat the file as binary and stop showing diffs. */
+/* Inherit is the absence of a row, so a cell has three states and only two are written.
+   `indexRules` keys on NUL, written as `\u0000` or git treats the file as binary. */
 /** The dropdown value that means "this channel has its own rules". */
 export const CUSTOM_VALUE = "custom";
 /**
- * The dropdown value that means "no rules at all".
- *
- * A word rather than an empty string: the Select reads "" as "nothing chosen"
- * and paints its placeholder over the label, so a channel open to everyone
- * showed "Select" instead of "Everyone". See [[base-ui-select-empty-value]] —
- * the Max Bitrate control in the same dialog already used "default" for this.
+ * The dropdown value that means "no rules at all". A word rather than an empty string: the
+ * Select reads "" as "nothing chosen" and paints its placeholder over the label.
  */
 export const EVERYONE_VALUE = "everyone";
 /** Look up one cell without scanning the whole list per cell. */
@@ -26,11 +18,8 @@ export function cellState(index, roleId, permission) {
     return index.get(`${roleId}\u0000${permission}`) ?? "inherit";
 }
 /**
- * The next state when somebody clicks a cell.
- *
- * inherit to deny to allow and back to inherit. Deny comes first deliberately:
- * taking something away is what people open this to do, and it puts the
- * dangerous state one click from neutral rather than two.
+ * The next state when somebody clicks a cell: inherit, deny, allow, inherit. Deny first,
+ * because taking something away is what people open this to do.
  */
 export function nextCellState(current) {
     if (current === "inherit")
@@ -47,11 +36,8 @@ export function withCell(rules, roleId, permission, state) {
     return [...without, { roleId, permission, effect: state }];
 }
 /**
- * Which dropdown value a channel is showing.
- *
- * The server sends the scope id plus whether it is a template. A scope that is
- * not a template is this channel's own, which is Custom; no scope at all is
- * Everyone.
+ * Which dropdown value a channel is showing. A scope that is not a template is this
+ * channel's own, which is Custom; no scope at all is Everyone.
  */
 export function scopeChoiceValue(scopeId, isTemplate) {
     if (!scopeId)
@@ -67,12 +53,8 @@ export function scopeChoiceFromValue(value) {
     return { kind: "template", templateId: value };
 }
 /**
- * The payload for `server:channels:scope:set`.
- *
- * Custom sends its rules; the other two send none. Templates deliberately do
- * not carry rules here — editing a template from a channel would change every
- * other channel using it, which is the opposite of what somebody expects from
- * a screen titled with one channel's name.
+ * The payload for `server:channels:scope:set`. Templates deliberately do not carry rules:
+ * editing one from a channel would change every other channel using it.
  */
 export function scopeSetPayload(choice, rules) {
     if (choice.kind === "custom")
@@ -82,11 +64,8 @@ export function scopeSetPayload(choice, rules) {
     return { templateId: null };
 }
 /**
- * The dropdown options: Everyone, then each template, then Custom.
- *
- * Custom last because it is the escape hatch. Somebody scanning the list should
- * meet the shared answers first — the whole point of templates is that reaching
- * for Custom is the uncommon choice.
+ * The dropdown options: Everyone, then each template, then Custom. Custom last, because it
+ * is the escape hatch and reaching for it is the uncommon choice.
  */
 export function scopeOptions(templates) {
     return [
@@ -98,12 +77,8 @@ export function scopeOptions(templates) {
     ];
 }
 /**
- * A one-line summary of what a set of rules does, for the note under the
- * dropdown.
- *
- * Reading is called out on its own because it is the rule with a different
- * consequence: a role denied `read_messages` is not shown a locked channel,
- * it is shown nothing at all, and somebody setting that deserves to be told.
+ * A one-line summary of what a set of rules does. Reading is called out on its own: a role
+ * denied `read_messages` is shown nothing at all rather than a locked channel.
  */
 export function describeRules(rules, roleNames) {
     if (rules.length === 0)

package/dist/profile/randomName.d.ts

@@ -1,16 +1,10 @@
 /**
- * Gems, metals, animals, weather, sky, and a few playful roles.
- *
- * Long enough that a room of thirty rarely doubles up, which is the whole
- * reason for the size — two people called Ruby in a member list is exactly the
- * confusion the old shared placeholder caused.
+ * Gems, metals, animals, weather, sky, and a few playful roles. Long enough that a room of
+ * thirty rarely doubles up, which is the whole reason for the size.
  */
 export declare const NAME_POOL: readonly ["Ruby", "Emerald", "Diamond", "Sapphire", "Topaz", "Opal", "Amber", "Jade", "Onyx", "Pearl", "Quartz", "Garnet", "Amethyst", "Turquoise", "Obsidian", "Marble", "Granite", "Flint", "Slate", "Crystal", "Gold", "Silver", "Copper", "Bronze", "Iron", "Steel", "Cobalt", "Pewter", "Platinum", "Titanium", "Brass", "Nickel", "Shark", "Turtle", "Otter", "Falcon", "Heron", "Badger", "Lynx", "Bison", "Walrus", "Puffin", "Osprey", "Marten", "Ibex", "Tapir", "Gecko", "Manta", "Narwhal", "Pelican", "Raven", "Magpie", "Sparrow", "Kestrel", "Weasel", "Beaver", "Moose", "Elk", "Stoat", "Hedgehog", "Mongoose", "Meerkat", "Albatross", "Barnacle", "Urchin", "Cuttlefish", "Seal", "Puma", "Ocelot", "Caribou", "Wombat", "Numbat", "Quokka", "Capybara", "Sheriff", "Bandit", "Captain", "Ranger", "Scout", "Pilot", "Sailor", "Miner", "Baker", "Cooper", "Mason", "Tinker", "Herald", "Envoy", "Courier", "Gardener", "Lookout", "Skipper", "Wrangler", "Drifter", "Comet", "Nebula", "Quasar", "Aurora", "Meteor", "Eclipse", "Zenith", "Thunder", "Cyclone", "Monsoon", "Blizzard", "Drizzle", "Gale", "Frost", "Ember", "Cinder", "Vapour", "Mistral", "Zephyr", "Squall", "Canyon", "Fjord", "Glacier", "Delta", "Mesa", "Tundra", "Prairie", "Dune", "Reef", "Atoll", "Summit", "Ridge", "Hollow", "Meadow", "Thicket", "Bramble", "Harbour", "Lagoon", "Cove", "Cascade", "Cedar", "Juniper", "Willow", "Birch", "Aspen", "Alder", "Hazel", "Bracken", "Clover", "Fennel", "Sorrel", "Nettle", "Thistle", "Heather", "Saffron", "Cardamom", "Chicory", "Marigold"];
 /**
- * One name from the pool.
- *
- * `Math.random` on purpose. This picks something to be called, not a secret —
- * the identity is a keypair, and the name has never been part of it. Reaching
- * for the crypto RNG here would suggest otherwise.
+ * One name from the pool. `Math.random` on purpose: this picks something to be called, not a
+ * secret, and the crypto RNG here would suggest otherwise.
  */
 export declare function pickRandomName(): string;

package/dist/profile/randomName.js

@@ -1,13 +1,8 @@
-/* Adding to this list: only nouns, only English, nothing that reads as a real
-   person's name. These go in front of strangers and are read aloud in voice,
-   and whoever gets one did not choose it. "Marcus" looks like a claim about
-   who somebody is; "Bandit" looks like the placeholder it is. */
+/* Adding to this list: only nouns, only English, nothing that reads as a real person's name.
+   Whoever gets one did not choose it, and "Marcus" looks like a claim. */
 /**
- * Gems, metals, animals, weather, sky, and a few playful roles.
- *
- * Long enough that a room of thirty rarely doubles up, which is the whole
- * reason for the size — two people called Ruby in a member list is exactly the
- * confusion the old shared placeholder caused.
+ * Gems, metals, animals, weather, sky, and a few playful roles. Long enough that a room of
+ * thirty rarely doubles up, which is the whole reason for the size.
  */
 export const NAME_POOL = [
     // Gems and minerals
@@ -42,11 +37,8 @@ export const NAME_POOL = [
     "Cardamom", "Chicory", "Marigold",
 ];
 /**
- * One name from the pool.
- *
- * `Math.random` on purpose. This picks something to be called, not a secret —
- * the identity is a keypair, and the name has never been part of it. Reaching
- * for the crypto RNG here would suggest otherwise.
+ * One name from the pool. `Math.random` on purpose: this picks something to be called, not a
+ * secret, and the crypto RNG here would suggest otherwise.
  */
 export function pickRandomName() {
     return NAME_POOL[Math.floor(Math.random() * NAME_POOL.length)];

package/dist/reports/report.d.ts

@@ -48,11 +48,8 @@ export interface Report {
     extra?: Record<string, unknown>;
 }
 /**
- * What an app knows about itself when somebody opens the form.
- *
- * Passed in rather than read here, so the assembly below stays readable and
- * testable: every one of these comes from somewhere that needs a running app —
- * the Electron bridge, `expo-constants`, `Platform`, the socket layer.
+ * What an app knows about itself when somebody opens the form. Passed in rather than read
+ * here: every one of these comes from somewhere that needs a running app.
  */
 export interface Diagnostics {
     version?: string | null;
@@ -90,21 +87,14 @@ export interface Diagnostics {
     logs?: string[];
 }
 /**
- * The service truncates, but an app should not send a novel either.
- *
- * Generous rather than tight: somebody describing a bug properly is the good
- * case, and cutting them off at a tweet is how you get "it broke" instead. The
- * desktop's 8000 wins over the phone's 4000 on exactly that argument, which
- * both files made and only one of them followed.
+ * The service truncates, but an app should not send a novel either. Generous rather than
+ * tight: cutting somebody off at a tweet is how you get "it broke".
  */
 export declare const MESSAGE_MAX = 8000;
 export declare const TITLE_MAX = 120;
 /**
- * Assemble what gets sent.
- *
- * `type` and `message` always; every diagnostic only if it is actually known.
- * An empty `device` object says "this app does not collect device
- * information", which is a different and wronger claim than leaving it off.
+ * Assemble what gets sent: `type` and `message` always, and a diagnostic only if it is
+ * known. An empty `device` claims the app collects none, which is wronger than leaving it off.
  */
 export declare function buildReport(type: ReportType, input: {
     message: string;

package/dist/reports/report.js

@@ -1,14 +1,8 @@
-/* `POST /v1/reports`. Only `type` and `message` are required; the service
-   truncates or drops a bad field rather than rejecting the report. So nothing
-   here throws, and a diagnostic an app cannot work out is left off rather than
-   guessed — a wrong Electron version is worse than no Electron version. */
+/* `POST /v1/reports`. Only `type` and `message` are required and the service truncates
+   rather than rejecting, so nothing throws and an unknown diagnostic is left off. */
 /**
- * The service truncates, but an app should not send a novel either.
- *
- * Generous rather than tight: somebody describing a bug properly is the good
- * case, and cutting them off at a tweet is how you get "it broke" instead. The
- * desktop's 8000 wins over the phone's 4000 on exactly that argument, which
- * both files made and only one of them followed.
+ * The service truncates, but an app should not send a novel either. Generous rather than
+ * tight: cutting somebody off at a tweet is how you get "it broke".
  */
 export const MESSAGE_MAX = 8000;
 export const TITLE_MAX = 120;
@@ -37,18 +31,12 @@ function count(value) {
     return typeof value === "number" && Number.isFinite(value) ? value : undefined;
 }
 /**
- * Assemble what gets sent.
- *
- * `type` and `message` always; every diagnostic only if it is actually known.
- * An empty `device` object says "this app does not collect device
- * information", which is a different and wronger claim than leaving it off.
+ * Assemble what gets sent: `type` and `message` always, and a diagnostic only if it is
+ * known. An empty `device` claims the app collects none, which is wronger than leaving it off.
  */
 export function buildReport(type, input, diagnostics = {}) {
-    /* The embedded server is two fields on the wire rather than one, because
-     * "running its own server" and "which version that server is" answer
-     * different questions and the second is often the one that matters. Neither
-     * has a column on the service, so they go in `extra`, which is what it is
-     * for. Only the desktop can run one, and the phone simply never sets them. */
+    /* The embedded server is two fields on the wire, because "running one" and "which version"
+     * answer different questions. Neither has a column, so they go in `extra`. */
     const extra = some({
         embeddedServer: bool(diagnostics.embeddedServer),
         embeddedServerVersion: str(diagnostics.embeddedServerVersion),

package/dist/servers/address.d.ts

@@ -9,3 +9,11 @@ export interface ServerInput {
 export declare function parseServerInput(input: string, opts?: {
     defaultLegacyHost?: string;
 }): ServerInput;
+/** The link that opens an invite in whichever app somebody has. Leave out the code for a
+    server anyone can join. */
+export declare function inviteLink(host: string, code?: string): string;
+/**
+ * Whether an address works for somebody on another network. Loopback, private and
+ * link-local ranges, CGNAT, and names like `nas` or `box.local` do not.
+ */
+export declare function isPublicHost(host: string): boolean;

package/dist/servers/address.js

@@ -14,16 +14,12 @@ export function normalizeCode(input) {
         .toLowerCase();
 }
 /**
- * The default host for a legacy `/invite/<code>` link.
- *
- * Those links carry no host, and the only client ever served from a path like
- * that is the hosted one.
+ * The default host for a legacy `/invite/<code>` link. Those carry no host, and the only
+ * client ever served from a path like that is the hosted one.
  */
 const DEFAULT_LEGACY_HOST = "app.gryt.chat";
-/* Three shapes: a full invite link, a legacy /invite/<code>, and a plain
-   address. `normalizeHost` alone is wrong for the first two — it returns the
-   link's host, so you would join gryt.chat instead of the server named in the
-   query. Anything that does not parse as a link falls through to an address. */
+/* Four shapes: an invite link with a code, one with only a host, a legacy /invite/<code>,
+   and a plain address. `normalizeHost` alone returns the link's host, so you'd join gryt.chat. */
 export function parseServerInput(input, opts) {
     const raw = String(input || "").trim();
     if (!raw)
@@ -35,9 +31,8 @@ export function parseServerInput(input, opts) {
         try {
             const url = new URL(raw);
             const path = url.pathname || "/";
-            // gryt://invite?host=…&code=… puts "invite" in the authority rather than
-            // the path, because the scheme is not one the URL parser treats as
-            // special. Both spellings mean the same thing.
+            // gryt://invite?host=…&code=… puts "invite" in the authority rather than the path,
+            // because the scheme is not one the URL parser treats as special. Both mean the same.
             const isInvite = path.startsWith("/invite") || url.hostname === "invite";
             if (isInvite) {
                 const host = normalizeHost(url.searchParams.get("host") || "");
@@ -48,6 +43,9 @@ export function parseServerInput(input, opts) {
                 if (parts[0] === "invite" && parts[1]) {
                     return { host: legacyHost, code: normalizeCode(parts[1]) };
                 }
+                // A server anyone can join needs no code, so its link names only the host.
+                if (host)
+                    return { host, code: "" };
             }
         }
         catch {
@@ -56,3 +54,66 @@ export function parseServerInput(input, opts) {
     }
     return { host: normalizeHost(raw), code: "" };
 }
+/** The link that opens an invite in whichever app somebody has. Leave out the code for a
+    server anyone can join. */
+export function inviteLink(host, code) {
+    const cleanCode = normalizeCode(code ?? "");
+    const query = `host=${encodeURIComponent(normalizeHost(host))}`;
+    return `https://gryt.chat/invite?${query}${cleanCode ? `&code=${encodeURIComponent(cleanCode)}` : ""}`;
+}
+/** Names that only mean something on one network. A bare name with no dot is one too. */
+const LOCAL_SUFFIXES = ["localhost", "local", "localdomain", "lan", "home", "internal", "home.arpa"];
+/** Lowercased, with any port, brackets and trailing dot removed. */
+function bareHostname(host) {
+    const trimmed = normalizeHost(host).toLowerCase();
+    const bracketed = /^\[([^\]]+)\](?::\d+)?$/.exec(trimmed);
+    if (bracketed)
+        return bracketed[1];
+    const colons = (trimmed.match(/:/g) || []).length;
+    const withoutPort = colons === 1 ? trimmed.replace(/:\d*$/, "") : trimmed;
+    return withoutPort.replace(/\.$/, "");
+}
+function ipv4Octets(name) {
+    if (!/^\d{1,3}(\.\d{1,3}){3}$/.test(name))
+        return null;
+    const octets = name.split(".").map(Number);
+    return octets.every((n) => n <= 255) ? octets : null;
+}
+function isPublicIpv4([a, b]) {
+    if (a === 0 || a === 10 || a === 127 || a >= 224)
+        return false;
+    if (a === 100 && b >= 64 && b <= 127)
+        return false; // CGNAT, and Tailscale
+    if (a === 169 && b === 254)
+        return false;
+    if (a === 172 && b >= 16 && b <= 31)
+        return false;
+    return !(a === 192 && b === 168);
+}
+/**
+ * Whether an address works for somebody on another network. Loopback, private and
+ * link-local ranges, CGNAT, and names like `nas` or `box.local` do not.
+ */
+export function isPublicHost(host) {
+    const name = bareHostname(host);
+    if (!name)
+        return false;
+    const v4 = ipv4Octets(name);
+    if (v4)
+        return isPublicIpv4(v4);
+    if (name.includes(":")) {
+        const mapped = /^::ffff:(\d{1,3}(?:\.\d{1,3}){3})$/.exec(name);
+        if (mapped) {
+            const octets = ipv4Octets(mapped[1]);
+            return !!octets && isPublicIpv4(octets);
+        }
+        if (name === "::" || name === "::1")
+            return false;
+        // fc00::/7 is private, fe80::/10 is link-local.
+        return !/^f[cd]/.test(name) && !/^fe[89ab]/.test(name);
+    }
+    // No top-level domain is all digits, so `999.1.1.1` is a broken address rather than a name.
+    if (!name.includes(".") || /\.\d+$/.test(name))
+        return false;
+    return !LOCAL_SUFFIXES.some((suffix) => name === suffix || name.endsWith(`.${suffix}`));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gryt/core",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Gryt's shared application logic: one implementation of the things the desktop and mobile apps both do.",
   "license": "AGPL-3.0-only",
   "repository": {
@@ -22,6 +22,7 @@
   "scripts": {
     "build": "node -e \"fs.rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json && node scripts/add-esm-extensions.mjs",
     "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test:comment-length": "node scripts/check-comment-length.mjs",
     "test": "node --test \"src/**/*.test.ts\"",
     "check-surface": "node scripts/check-public-surface.mjs",
     "prepublishOnly": "npm run build && npm run test && npm run check-surface"