Skip to content

profile

What a member may write on their page, checked once, and the sh.unset.profile record built from those fields. Package @unset/domains-profile. The module is ADR 0037, Accepted.

Owns

Product rules for those fields. This folder does not open a socket.

ModuleWhat it holds
domains/profile/index.tsPackage root. Re-exports the names below.
domains/profile/profile.tsparseProfileFields, readProfileRecord, toProfileRecord, PROFILE_FIELDS, EMPTY_PROFILE.
domains/profile/cards.tsReading cards (ADR 0051): parseCardKey, readCard, orderCards and the card view types.
domains/profile/card-edit.tsWriting cards: parseCardInput, toCardRecord, reorderCards.
domains/profile/web-address.tswithScheme and isWebAddress, shared by the website field and card addresses.

PROFILE_FIELDS is displayName, headline, location, website; links live on Links cards (ADR 0051). EMPTY_PROFILE sets each of them to "".

FunctionResult
parseProfileFieldsThe keys that were sent, after the checks below, or the first bad field. A key absent from the input is absent from the result. null and undefined become "". A non-string is profile.invalid.
readProfileRecordProfileFields. A value that is not a non-array object is EMPTY_PROFILE. Each field is checked on its own, and a bad one reads as "".
toProfileRecordA record whose $type is sh.unset.profile, or a refusal. Sent fields replace what was stored. An empty string removes that key. Other keys on the stored object stay. createdAt stays when the stored value is a string, and otherwise is the now argument.
CodeWhen
profile.invalidA non-string, a line break in a one-line field, or validateRecord("sh.unset.profile", record, "read") refuses the built record (profile.ts): a defined field is invalid. A stored field the lexicon does not define is kept, never refused (ADR 0038).
profile.too_longOver a grapheme or byte bound.
profile.url_invalidwebsite or a link is not an http or https URL with a host and no user or password.
profile.name_requiredThe record to write has no display name.

Edits are bounded by APP_LIMITS in profile.ts, never above the lexicon’s LIMITS.profile (ADR 0051). A stored record is read against the lexicon’s own limits, so a field another client wrote validly still shows. displayName, headline and location are counted in graphemes; website in bytes. A value with no scheme is prefixed with https:// (withScheme in web-address.ts).

Cards

A card is one sh.unset.card record holding one sh.unset.block.* block (ADR 0086). readCard validates the stored record in read mode and returns null, so the card is hidden, when it does not validate or its kind is unknown. A link, entry address or button that is not plain http or https (or an email button whose address does not look like one) is dropped, and the rest of the card still shows. An unknown width, layout or preset reads as the default: full, list for links, carousel for collections, custom for a link button.

A list block (links, showcase, buttons) with no row left to show is hidden too; the editor never writes one.

orderCards keeps only the cards the profile’s cards list names, in its order, skipping entries with no card and showing a repeat once, at its first place. A card the list does not name is not on the page (ADR 0086 point 3). withCardListed adds a new card at the end of the list and withCardUnlisted takes a deleted one out; both keep every other stored entry as it is. withCardOrder writes the shown cards in their new order, then every entry the order does not name, unchanged.

parseCardInput reads the editor’s JSON (kind, optional width, the kind’s fields). toCardRecord builds the record over the stored one: content is replaced, createdAt and fields this version does not know are kept, inside the content too while its kind is unchanged. reorderCards accepts only a list naming each existing card exactly once.

CodeWhen
card.kind_unknownkind is not readme, links, collection or buttons.
card.requiredREADME text, a buttons heading, an entry title or a link address is empty.
card.invalidA wrong type, an unknown width, layout or preset, or a line break in a one-line field.
card.too_longA list over the lexicon’s count, or text past a lexicon limit.
card.url_invalidAn address is not http or https with a host and no user or password.
card.email_invalidAn email button’s address does not look like one.
card.order_invalidA reorder does not name each existing card exactly once.

May import

The Domains domain row, and the narrowing rules on that page.

domains/profile/profile.ts imports LIMITS and validateRecord from @unset/shared-lexicons. domains/profile/package.json declares that one dependency. The package export . of @unset/shared-lexicons is shared/lexicons/index.ts.

Entry points

RolePath
Package export .domains/profile/index.ts
Form parseinterfaces/web/src/routes/profile/save.server.ts calls parseProfileFields
Record buildinterfaces/web/src/routes/profile/+page.server.ts calls toProfileRecord and saveProfileRecord in infrastructure/pds/profile-record.ts
Readdomains/profile/profile.test.ts calls readProfileRecord

There is no main.ts.

Re-exports from index.ts, all from profile.ts:

Names
EMPTY_PROFILE, PROFILE_FIELDS, parseProfileFields, readProfileRecord, toProfileRecord
ParsedProfile, ProfileEdit, ProfileError, ProfileField, ProfileFields, ProfileRecord

Data

No schema, role, table or event type. Nothing in this folder writes Postgres. Where the record is kept is ADR 0037.