Models

Models are complex data structures representing real-world entities like users and addresses.

Each model combines multiple primitive generators to create rich, structured objects with properly related fields. For example, a User model generates consistent email addresses based on the person’s name, and birthdate that matches the specified age range.

Models are accessed through pseudo-arrays that provide $O(1)$ random access to infinite objects. Each array is seeded with a world seed for deterministic generation.

Each model type has a unique TypeSequence identifier used in PseudoIDs to distinguish object types.

Address

Address object following OpenID Connect (OIDC) Address Claim.

Represents a physical mailing address with components for street address, locality (city), region (state/province), postal code, country, and locale.

TypeSequence: 110

Fields

Field	Type	Description
id	string	Deterministic, sortable PseudoID for this address object.
formatted	string	Full mailing address, formatted for display or use on a mailing label.
street_address	string	Full street address component, may include house number, street name,
locality	string	City or locality component.
region	string	State, province, prefecture, or region component.
postal_code	string	Zip code or postal code component.
country	string	Country name or code component.
locale	string	Locale associated with the address.

---

AddressLink

The AddressLink class provides type-safe navigation methods for relationships between Address objects and related entities.

Methods:

• me(): Address - Returns the current Address object
• homeAddressFor(): User - Reverse of homeAddress() on User ($O(1)$ access)
• owner(): User - Reverse of addresses() on User ($O(1)$ access)

Usage:

Go

addresss := NewAddressArray(worldSeed)
link := addresss.LinkAt(index)
address := link.Me()
related := link.HomeAddressFor()

Java

AddressArray addresss = new AddressArray(worldSeed);
AddressLink link = addresss.linkAt(index);
Address address = link.me();
User related = link.homeAddressFor();

Python

addresss = AddressArray(world_seed)
link = addresss.link_at(index)
address = link.me()
related = link.homeAddressFor()

TypeScript

const addresss = new AddressArray(worldSeed);
const link = addresss.linkAt(index);
const address = link.me();
const related = link.homeAddressFor();

---

AddressArray

pseudo-array providing $O(1)$ access to infinite Address objects.

Usage:

Go

addresss := NewAddressArray(worldSeed)
address := addresss.At(index)

Java

AddressArray addresss = new AddressArray(worldSeed);
Address address = addresss.at(index);

Python

addresss = AddressArray(world_seed)
address = addresss.at(index)

TypeScript

const addresss = new AddressArray(worldSeed);
const address = addresss.at(index);

Methods:

• at(index: int): Address - Get Address at specified index ($O(1)$ access)
• constructor(worldSeed: uint64) - Create array with given world seed
• linkAt(index: int): AddressLink - Get AddressLink for relationship navigation at specified index
• linkFor(obj: Address): AddressLink - Get AddressLink for a given Address object

---

Group

Group object representing a simple named group.

Used to model collections of users, teams, or other entities with a single group name. The group name is generated as a deterministic, human-friendly nickname.

This model is intentionally minimal, but can be extended to include additional group attributes as needed.

TypeSequence: 102

Fields

Field	Type	Description
id	string	Deterministic, sortable pseudo-id for this group object.
name	string	Deterministic, human-friendly group name.

---

GroupLink

The GroupLink class provides type-safe navigation methods for relationships between Group objects and related entities.

Methods:

• me(): Group - Returns the current Group object
• members(): Generator<User> - Reverse of primaryGroup() on User (iterates through related objects, $O(connector\_bits)$)

Usage:

Go

groups := NewGroupArray(worldSeed)
link := groups.LinkAt(index)
group := link.Me()
related := link.Members()

Java

GroupArray groups = new GroupArray(worldSeed);
GroupLink link = groups.linkAt(index);
Group group = link.me();
User related = link.members();

Python

groups = GroupArray(world_seed)
link = groups.link_at(index)
group = link.me()
related = link.members()

TypeScript

const groups = new GroupArray(worldSeed);
const link = groups.linkAt(index);
const group = link.me();
const related = link.members();

---

GroupArray

pseudo-array providing $O(1)$ access to infinite Group objects.

Usage:

Go

groups := NewGroupArray(worldSeed)
group := groups.At(index)

Java

GroupArray groups = new GroupArray(worldSeed);
Group group = groups.at(index);

Python

groups = GroupArray(world_seed)
group = groups.at(index)

TypeScript

const groups = new GroupArray(worldSeed);
const group = groups.at(index);

Methods:

• at(index: int): Group - Get Group at specified index ($O(1)$ access)
• constructor(worldSeed: uint64) - Create array with given world seed
• linkAt(index: int): GroupLink - Get GroupLink for relationship navigation at specified index
• linkFor(obj: Group): GroupLink - Get GroupLink for a given Group object

---

User

User object following OpenID Connect (OIDC) Standard Claims.

Represents a virtual user with identity information including name components, contact details, gender, locale, and profile picture.

TypeSequence: 101

Fields

Field	Type	Description
id	string	Deterministic, sortable pseudo-id for this user object.
sub	string	Subject identifier - a unique identifier for the user.
name	string	Full name in displayable form including all name parts.
given_name	string	Given name(s) or first name(s).
family_name	string	Family name(s) or last name(s).
middle_name	string	Middle name(s).
nickname	string	Casual name that may or may not be the same as given_name.
preferred_username	string	Shorthand name by which the user wishes to be referred to.
email	string	Email address.
gender	string	User’s gender.
locale	string	Locale of the user.
picture	string	URL of the user’s profile picture.
profile	string	URL of the End-User’s profile page.
website	string	URL of the End-User’s web page or blog.
email_verified	boolean	True if the End-User’s email address has been verified; otherwise false.
birthdate	string	End-User’s birthday.
zoneinfo	string	String from IANA Time Zone Database representing the End-User’s time zone.
phone_number	string	End-User’s preferred telephone number.
phone_number_verified	boolean	True if the End-User’s phone number has been verified; otherwise false.
updated_at	safeint	Time the End-User’s information was last updated.

---

UserLink

The UserLink class provides type-safe navigation methods for relationships between User objects and related entities.

Methods:

• me(): User - Returns the current User object
• manager(): User - Navigates to related User (many-to-one) ($O(1)$ access)
• directs(): Generator<User> - Reverse of manager() (iterates through related objects, $O(connector\_bits)$)
• primaryGroup(): Group - Navigates to related Group (many-to-one) ($O(1)$ access)
• members(): Generator<User> - Reverse of primaryGroup() (iterates through related objects, $O(connector\_bits)$)
• homeAddress(): Address - The primary residential location where the user lives and receives personal mail. ($O(1)$ access)
• homeAddressFor(): User - Reverse of homeAddress() ($O(1)$ access)
• workAddress(): Address - The professional office or job site location where the user is stationed during business hour. ($O(1)$ access)
• addresses(): Generator<Address> - A list of supplemental or miscellaneous locations associated with the user, such as temporary vacation rentals, secondary properties, or old historical records. (iterates through related objects, $O(connector\_bits)$)
• owner(): User - Reverse of addresses() ($O(1)$ access)
• directs(): Generator<User> - Reverse of manager() on User (iterates through related objects, $O(connector\_bits)$)

Usage:

Go

users := NewUserArray(worldSeed)
link := users.LinkAt(index)
user := link.Me()
related := link.Manager()

Java

UserArray users = new UserArray(worldSeed);
UserLink link = users.linkAt(index);
User user = link.me();
User related = link.manager();

Python

users = UserArray(world_seed)
link = users.link_at(index)
user = link.me()
related = link.manager()

TypeScript

const users = new UserArray(worldSeed);
const link = users.linkAt(index);
const user = link.me();
const related = link.manager();

---

UserArray

pseudo-array providing $O(1)$ access to infinite User objects.

Usage:

Go

users := NewUserArray(worldSeed)
user := users.At(index)

Java

UserArray users = new UserArray(worldSeed);
User user = users.at(index);

Python

users = UserArray(world_seed)
user = users.at(index)

TypeScript

const users = new UserArray(worldSeed);
const user = users.at(index);

Methods:

• at(index: int): User - Get User at specified index ($O(1)$ access)
• constructor(worldSeed: uint64) - Create array with given world seed
• linkAt(index: int): UserLink - Get UserLink for relationship navigation at specified index
• linkFor(obj: User): UserLink - Get UserLink for a given User object

---