@onlyworlds/sdk 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -72,62 +72,74 @@ interface WorldInput {
 }
 /**
  * Ability element type
+ * Fields organized by sections: Mechanics, World
  */
 interface Ability extends BaseElement {
     activation?: string;
     duration?: string;
     potency?: string;
     range?: string;
+    effects?: ElementIds<ElementType.Phenomenon>;
     challenges?: string;
+    talents?: ElementIds<ElementType.Trait>;
+    requisites?: ElementIds<ElementType.Construct>;
     prevalence?: string;
     tradition?: ElementId<ElementType.Construct>;
     source?: ElementId<ElementType.Phenomenon>;
     locus?: ElementId<ElementType.Location>;
-    effects?: ElementIds<ElementType.Phenomenon>;
-    talents?: ElementIds<ElementType.Trait>;
-    requisites?: ElementIds<ElementType.Construct>;
     instruments?: ElementIds<ElementType.Object>;
     systems?: ElementIds<ElementType.Construct>;
 }
 /**
  * Object element type
+ * Fields organized by sections: Form, Function, World
  */
 interface Object$1 extends BaseElement {
     aesthetics?: string;
     weight?: string;
     amount?: string;
     parent_object?: ElementId<ElementType.Object>;
-    utility?: string;
-    origins?: string;
-    location?: ElementId<ElementType.Location>;
-    language?: ElementId<ElementType.Language>;
     materials?: ElementIds<ElementType.Construct>;
     technology?: ElementIds<ElementType.Construct>;
+    utility?: string;
     effects?: ElementIds<ElementType.Phenomenon>;
     abilities?: ElementIds<ElementType.Ability>;
     consumes?: ElementIds<ElementType.Construct>;
+    origins?: string;
+    location?: ElementId<ElementType.Location>;
+    language?: ElementId<ElementType.Language>;
     affinities?: ElementIds<ElementType.Trait>;
 }
 /**
  * Character element type
+ * Fields organized by sections: Constitution, Origins, World, Personality, Social, TTRPG
  */
 interface Character extends BaseElement {
     physicality?: string;
     mentality?: string;
     height?: string;
     weight?: string;
+    species?: ElementIds<ElementType.Species>;
+    traits?: ElementIds<ElementType.Trait>;
+    abilities?: ElementIds<ElementType.Ability>;
     background?: string;
     motivations?: string;
     birth_date?: string;
     birthplace?: ElementId<ElementType.Location>;
+    languages?: ElementIds<ElementType.Language>;
     reputation?: string;
     location?: ElementId<ElementType.Location>;
+    objects?: ElementIds<ElementType.Object>;
+    institutions?: ElementIds<ElementType.Institution>;
     charisma?: string;
     coercion?: string;
     competence?: string;
     compassion?: string;
     creativity?: string;
     courage?: string;
+    family?: ElementIds<ElementType.Family>;
+    friends?: ElementIds<ElementType.Character>;
+    rivals?: ElementIds<ElementType.Character>;
     level?: string;
     hit_points?: string;
     STR?: string;
@@ -136,28 +148,20 @@ interface Character extends BaseElement {
     INT?: string;
     WIS?: string;
     CHA?: string;
-    species?: ElementIds<ElementType.Species>;
-    traits?: ElementIds<ElementType.Trait>;
-    abilities?: ElementIds<ElementType.Ability>;
-    languages?: ElementIds<ElementType.Language>;
-    objects?: ElementIds<ElementType.Object>;
-    institutions?: ElementIds<ElementType.Institution>;
-    family?: ElementIds<ElementType.Family>;
-    friends?: ElementIds<ElementType.Character>;
-    rivals?: ElementIds<ElementType.Character>;
 }
 /**
  * Collective element type
+ * Fields organized by sections: Formation, Dynamics, World
  */
 interface Collective extends BaseElement {
     composition?: string;
     count?: string;
     formation_date?: string;
     operator?: ElementId<ElementType.Institution>;
+    equipment?: ElementIds<ElementType.Construct>;
     activity?: string;
     disposition?: string;
     state?: string;
-    equipment?: ElementIds<ElementType.Construct>;
     abilities?: ElementIds<ElementType.Ability>;
     symbolism?: ElementIds<ElementType.Construct>;
     species?: ElementIds<ElementType.Species>;
@@ -167,6 +171,7 @@ interface Collective extends BaseElement {
 }
 /**
  * Construct element type
+ * Fields organized by sections: Nature, Involves
  */
 interface Construct extends BaseElement {
     rationale?: string;
@@ -198,13 +203,18 @@ interface Construct extends BaseElement {
 }
 /**
  * Creature element type
+ * Fields organized by sections: Biology, Behaviour, World, TTRPG
  */
 interface Creature extends BaseElement {
     appearance?: string;
     weight?: string;
     height?: string;
+    species?: ElementIds<ElementType.Species>;
     habits?: string;
     demeanor?: string;
+    traits?: ElementIds<ElementType.Trait>;
+    abilities?: ElementIds<ElementType.Ability>;
+    languages?: ElementIds<ElementType.Language>;
     status?: string;
     birth_date?: string;
     location?: ElementId<ElementType.Location>;
@@ -213,14 +223,11 @@ interface Creature extends BaseElement {
     hit_points?: string;
     armor_class?: string;
     speed?: string;
-    species?: ElementIds<ElementType.Species>;
-    traits?: ElementIds<ElementType.Trait>;
-    abilities?: ElementIds<ElementType.Ability>;
-    languages?: ElementIds<ElementType.Language>;
     actions?: ElementIds<ElementType.Ability>;
 }
 /**
  * Event element type
+ * Fields organized by sections: Nature, Involves
  */
 interface Event extends BaseElement {
     history?: string;
@@ -248,16 +255,17 @@ interface Event extends BaseElement {
 }
 /**
  * Family element type
+ * Fields organized by sections: Identity, World
  */
 interface Family extends BaseElement {
     spirit?: string;
     history?: string;
-    reputation?: string;
     traditions?: ElementIds<ElementType.Construct>;
     traits?: ElementIds<ElementType.Trait>;
     abilities?: ElementIds<ElementType.Ability>;
     languages?: ElementIds<ElementType.Language>;
     ancestors?: ElementIds<ElementType.Character>;
+    reputation?: string;
     estates?: ElementIds<ElementType.Location>;
     governs?: ElementIds<ElementType.Institution>;
     heirlooms?: ElementIds<ElementType.Object>;
@@ -265,21 +273,23 @@ interface Family extends BaseElement {
 }
 /**
  * Institution element type
+ * Fields organized by sections: Foundation, Claims, World
  */
 interface Institution extends BaseElement {
     doctrine?: string;
     founding_date?: string;
     parent_institution?: ElementId<ElementType.Institution>;
-    status?: string;
     zones?: ElementIds<ElementType.Zone>;
     objects?: ElementIds<ElementType.Object>;
     creatures?: ElementIds<ElementType.Creature>;
+    status?: string;
     allies?: ElementIds<ElementType.Institution>;
     adversaries?: ElementIds<ElementType.Institution>;
     constructs?: ElementIds<ElementType.Construct>;
 }
 /**
  * Language element type
+ * Fields organized by sections: Structure, World
  */
 interface Language extends BaseElement {
     phonology?: string;
@@ -293,14 +303,15 @@ interface Language extends BaseElement {
 }
 /**
  * Law element type
+ * Fields organized by sections: Code, World
  */
 interface Law extends BaseElement {
     declaration?: string;
     purpose?: string;
     date?: string;
     parent_law?: ElementId<ElementType.Law>;
-    author?: ElementId<ElementType.Institution>;
     penalties?: ElementIds<ElementType.Construct>;
+    author?: ElementId<ElementType.Institution>;
     locations?: ElementIds<ElementType.Location>;
     zones?: ElementIds<ElementType.Zone>;
     prohibitions?: ElementIds<ElementType.Construct>;
@@ -309,25 +320,22 @@ interface Law extends BaseElement {
 }
 /**
  * Location element type
+ * Fields organized by sections: Setting, Politics, World, Production, Commerce, Construction, Defense
  */
 interface Location extends BaseElement {
     form?: string;
     function?: string;
     founding_date?: string;
     parent_location?: ElementId<ElementType.Location>;
+    populations?: ElementIds<ElementType.Collective>;
     political_climate?: string;
     primary_power?: ElementId<ElementType.Institution>;
     governing_title?: ElementId<ElementType.Title>;
+    secondary_powers?: ElementIds<ElementType.Institution>;
     zone?: ElementId<ElementType.Zone>;
     rival?: ElementId<ElementType.Location>;
     partner?: ElementId<ElementType.Location>;
     customs?: string;
-    infrastructure?: string;
-    architecture?: string;
-    defensibility?: string;
-    elevation?: string;
-    populations?: ElementIds<ElementType.Collective>;
-    secondary_powers?: ElementIds<ElementType.Institution>;
     founders?: ElementIds<ElementType.Character>;
     cults?: ElementIds<ElementType.Construct>;
     delicacies?: ElementIds<ElementType.Species>;
@@ -335,31 +343,37 @@ interface Location extends BaseElement {
     extraction_goods?: ElementIds<ElementType.Construct>;
     industry_methods?: ElementIds<ElementType.Construct>;
     industry_goods?: ElementIds<ElementType.Construct>;
+    infrastructure?: string;
     extraction_markets?: ElementIds<ElementType.Location>;
     industry_markets?: ElementIds<ElementType.Location>;
     currencies?: ElementIds<ElementType.Construct>;
+    architecture?: string;
     buildings?: ElementIds<ElementType.Object>;
     building_methods?: ElementIds<ElementType.Construct>;
+    defensibility?: string;
+    elevation?: string;
     fighters?: ElementIds<ElementType.Construct>;
     defensive_objects?: ElementIds<ElementType.Object>;
 }
 /**
  * Phenomenon element type
+ * Fields organized by sections: Mechanics, World
  */
 interface Phenomenon extends BaseElement {
     expression?: string;
     effects?: string;
     duration?: string;
-    mythology?: string;
-    system?: ElementId<ElementType.Phenomenon>;
     catalysts?: ElementIds<ElementType.Object>;
     empowerments?: ElementIds<ElementType.Ability>;
+    mythology?: string;
+    system?: ElementId<ElementType.Phenomenon>;
     triggers?: ElementIds<ElementType.Construct>;
     wielders?: ElementIds<ElementType.Character>;
     environments?: ElementIds<ElementType.Location>;
 }
 /**
  * Relation element type
+ * Fields organized by sections: Nature, Involves
  */
 interface Relation extends BaseElement {
     background?: string;
@@ -367,6 +381,7 @@ interface Relation extends BaseElement {
     end_date?: string;
     intensity?: string;
     actor?: ElementId<ElementType.Character>;
+    events?: ElementIds<ElementType.Event>;
     characters?: ElementIds<ElementType.Character>;
     objects?: ElementIds<ElementType.Object>;
     locations?: ElementIds<ElementType.Location>;
@@ -382,47 +397,49 @@ interface Relation extends BaseElement {
     families?: ElementIds<ElementType.Family>;
     titles?: ElementIds<ElementType.Title>;
     constructs?: ElementIds<ElementType.Construct>;
-    events?: ElementIds<ElementType.Event>;
     narratives?: ElementIds<ElementType.Narrative>;
 }
 /**
  * Species element type
+ * Fields organized by sections: Biology, Psychology, World
  */
 interface Species extends BaseElement {
     appearance?: string;
     life_span?: string;
     weight?: string;
+    nourishment?: ElementIds<ElementType.Species>;
+    reproduction?: ElementIds<ElementType.Construct>;
+    adaptations?: ElementIds<ElementType.Ability>;
     instincts?: string;
     sociality?: string;
     temperament?: string;
     communication?: string;
     aggression?: string;
+    traits?: ElementIds<ElementType.Trait>;
     role?: string;
     parent_species?: ElementId<ElementType.Species>;
-    nourishment?: ElementIds<ElementType.Species>;
-    reproduction?: ElementIds<ElementType.Construct>;
-    adaptations?: ElementIds<ElementType.Ability>;
-    traits?: ElementIds<ElementType.Trait>;
     locations?: ElementIds<ElementType.Location>;
     zones?: ElementIds<ElementType.Zone>;
     affinities?: ElementIds<ElementType.Phenomenon>;
 }
 /**
  * Zone element type
+ * Fields organized by sections: Scope, World
  */
 interface Zone extends BaseElement {
     role?: string;
     start_date?: string;
     end_date?: string;
-    context?: string;
     phenomena?: ElementIds<ElementType.Phenomenon>;
     linked_zones?: ElementIds<ElementType.Zone>;
+    context?: string;
     populations?: ElementIds<ElementType.Collective>;
     titles?: ElementIds<ElementType.Title>;
     principles?: ElementIds<ElementType.Construct>;
 }
 /**
  * Title element type
+ * Fields organized by sections: Mandate, World
  */
 interface Title extends BaseElement {
     authority?: string;
@@ -432,10 +449,10 @@ interface Title extends BaseElement {
     issuer?: ElementId<ElementType.Institution>;
     body?: ElementId<ElementType.Institution>;
     superior_title?: ElementId<ElementType.Title>;
-    status?: string;
-    history?: string;
     holders?: ElementIds<ElementType.Character>;
     symbols?: ElementIds<ElementType.Object>;
+    status?: string;
+    history?: string;
     characters?: ElementIds<ElementType.Character>;
     institutions?: ElementIds<ElementType.Institution>;
     families?: ElementIds<ElementType.Family>;
@@ -452,6 +469,7 @@ interface Title extends BaseElement {
 }
 /**
  * Trait element type
+ * Fields organized by sections: Qualitative, Quantitative, World
  */
 interface Trait extends BaseElement {
     social_effects?: string;
@@ -471,6 +489,7 @@ interface Trait extends BaseElement {
 }
 /**
  * Narrative element type
+ * Fields organized by sections: Context, Involves
  */
 interface Narrative extends BaseElement {
     story?: string;
@@ -504,6 +523,7 @@ interface Narrative extends BaseElement {
 }
 /**
  * Map element type
+ * Fields organized by sections: Details
  */
 interface Map extends BaseElement {
     background_color?: string;
@@ -516,6 +536,7 @@ interface Map extends BaseElement {
 }
 /**
  * Marker element type
+ * Fields organized by sections: Details
  */
 interface Marker extends BaseElement {
     map?: ElementId<ElementType.Map>;
@@ -526,6 +547,7 @@ interface Marker extends BaseElement {
 }
 /**
  * Pin element type
+ * Fields organized by sections: Details
  */
 interface Pin extends BaseElement {
     map?: ElementId<ElementType.Map>;
@@ -835,6 +857,26 @@ declare const ELEMENT_LABELS: Record<ElementType, string>;
  * @returns The plural label string
  */
 declare function getElementLabel(elementType: ElementType): string;
+/**
+ * Section metadata for OnlyWorlds elements
+ * Source: sectioned_schema.json
+ */
+interface SectionInfo {
+    name: string;
+    order: number;
+    fields: string[];
+}
+/**
+ * Element section definitions - provides organized field groupings for each element type
+ * Enables UI components to display fields in logical sections with proper ordering
+ */
+declare const ELEMENT_SECTIONS: Record<ElementType, SectionInfo[]>;
+/**
+ * Get sections for an element type
+ * @param elementType The element type
+ * @returns Array of section information for the element type
+ */
+declare function getElementSections(elementType: ElementType): SectionInfo[];
 /**
  * Current OnlyWorlds version
  * Synced with https://github.com/OnlyWorlds/OnlyWorlds/blob/main/VERSION
@@ -842,37 +884,30 @@ declare function getElementLabel(elementType: ElementType): string;
 declare const ONLYWORLDS_VERSION: "00.30.00";
 /**
  * Material Design icons for element types
+ * These are the uniform, monochrome icons used in the OnlyWorlds frontend
  * Compatible with Google Material Icons font
  */
-declare const ELEMENT_MATERIAL_ICONS: Record<ElementType, string>;
-/**
- * Font Awesome icons for element types
- * Compatible with Font Awesome 6.0+
- */
-declare const ELEMENT_FONTAWESOME_ICONS: Record<ElementType, string>;
+declare const ELEMENT_ICONS: Record<ElementType, string>;
 /**
- * Unicode emoji icons for element types
- * Universal compatibility across platforms
+ * Simple Unicode icons for element types
+ * Minimalist symbols used as fallbacks
  */
 declare const ELEMENT_UNICODE_ICONS: Record<ElementType, string>;
 /**
  * Get Material Design icon for an element type
+ * Returns the uniform monochrome icon used in OnlyWorlds frontend
  * @param elementType The element type
  * @returns Material icon name
  */
-declare function getElementMaterialIcon(elementType: ElementType): string;
-/**
- * Get Font Awesome icon for an element type
- * @param elementType The element type
- * @returns Font Awesome icon class
- */
-declare function getElementFontAwesomeIcon(elementType: ElementType): string;
+declare function getElementIcon(elementType: ElementType): string;
 /**
- * Get Unicode emoji for an element type
+ * Get Unicode icon for an element type
  * @param elementType The element type
- * @returns Unicode emoji string
+ * @returns Unicode symbol string
  */
 declare function getElementUnicodeIcon(elementType: ElementType): string;
+declare const ELEMENT_MATERIAL_ICONS: Record<ElementType, string>;
+declare const getElementMaterialIcon: typeof getElementIcon;
 /**
  * Field type definitions for OnlyWorlds elements
  */
@@ -2327,4 +2362,4 @@ declare class OnlyWorldsClient {
     static prepareInput<T extends Record<string, any>>(data: T): any;
 }
 
-export { type Ability, type AbilityInput, type AnyElementId, type ApiResponse, type BaseElement, type Character, type CharacterInput, type Collective, type CollectiveInput, type Construct, type ConstructInput, type Creature, type CreatureInput, ELEMENT_FONTAWESOME_ICONS, ELEMENT_LABELS, ELEMENT_MATERIAL_ICONS, ELEMENT_UNICODE_ICONS, type ElementId, type ElementIds, ElementType, type Event, type EventInput, FIELD_MAPPINGS, FIELD_SCHEMA, type Family, type FamilyInput, type FieldInfo, type FieldMappingsType, type FieldType, type Institution, type InstitutionInput, type Language, type LanguageInput, type Law, type LawInput, type ListOptions, type Location, type LocationInput, type Map, type MapInput, type Marker, type MarkerInput, type Narrative, type NarrativeInput, ONLYWORLDS_VERSION, type Object$1 as Object, type ObjectInput, OnlyWorldsClient, type OnlyWorldsConfig, type Phenomenon, type PhenomenonInput, type Pin, type PinInput, type Relation, type RelationInput, type Species, type SpeciesInput, type Title, type TitleInput, type Trait, type TraitInput, type World, type WorldInput, type Zone, type ZoneInput, createAnyElementId, createElementId, createElementIds, getElementFontAwesomeIcon, getElementLabel, getElementMaterialIcon, getElementUnicodeIcon };
+export { type Ability, type AbilityInput, type AnyElementId, type ApiResponse, type BaseElement, type Character, type CharacterInput, type Collective, type CollectiveInput, type Construct, type ConstructInput, type Creature, type CreatureInput, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_MATERIAL_ICONS, ELEMENT_SECTIONS, ELEMENT_UNICODE_ICONS, type ElementId, type ElementIds, ElementType, type Event, type EventInput, FIELD_MAPPINGS, FIELD_SCHEMA, type Family, type FamilyInput, type FieldInfo, type FieldMappingsType, type FieldType, type Institution, type InstitutionInput, type Language, type LanguageInput, type Law, type LawInput, type ListOptions, type Location, type LocationInput, type Map, type MapInput, type Marker, type MarkerInput, type Narrative, type NarrativeInput, ONLYWORLDS_VERSION, type Object$1 as Object, type ObjectInput, OnlyWorldsClient, type OnlyWorldsConfig, type Phenomenon, type PhenomenonInput, type Pin, type PinInput, type Relation, type RelationInput, type SectionInfo, type Species, type SpeciesInput, type Title, type TitleInput, type Trait, type TraitInput, type World, type WorldInput, type Zone, type ZoneInput, createAnyElementId, createElementId, createElementIds, getElementIcon, getElementLabel, getElementMaterialIcon, getElementSections, getElementUnicodeIcon };