@onlyworlds/sdk 1.5.0 → 2.0.0

package/dist/index.mjs

@@ -332,93 +332,96 @@ function getElementIcon(elementType) {
 function getElementUnicodeIcon(elementType) {
   return ELEMENT_UNICODE_ICONS[elementType];
 }
-var ELEMENT_MATERIAL_ICONS = ELEMENT_ICONS;
-var getElementMaterialIcon = getElementIcon;
 var FIELD_SCHEMA = {
   ability: {
-    // Text fields
+    // Mechanics
     activation: { type: "text" },
-    duration: { type: "text" },
-    potency: { type: "text" },
-    range: { type: "text" },
+    duration: { type: "number" },
+    potency: { type: "number" },
+    range: { type: "number" },
+    effects: { type: "multi_link", target: "phenomenon" },
     challenges: { type: "text" },
+    talents: { type: "multi_link", target: "trait" },
+    requisites: { type: "multi_link", target: "construct" },
+    // World
     prevalence: { type: "text" },
-    // Link fields
     tradition: { type: "single_link", target: "construct" },
     source: { type: "single_link", target: "phenomenon" },
     locus: { type: "single_link", target: "location" },
-    effects: { type: "multi_link", target: "phenomenon" },
-    talents: { type: "multi_link", target: "trait" },
-    requisites: { type: "multi_link", target: "construct" },
     instruments: { type: "multi_link", target: "object" },
     systems: { type: "multi_link", target: "construct" }
   },
   character: {
-    // Text fields
+    // Constitution
     physicality: { type: "text" },
     mentality: { type: "text" },
-    height: { type: "text" },
-    weight: { type: "text" },
-    background: { type: "text" },
-    motivations: { type: "text" },
-    birth_date: { type: "text" },
-    reputation: { type: "text" },
-    charisma: { type: "text" },
-    coercion: { type: "text" },
-    competence: { type: "text" },
-    compassion: { type: "text" },
-    creativity: { type: "text" },
-    courage: { type: "text" },
-    level: { type: "text" },
-    hit_points: { type: "text" },
-    STR: { type: "text" },
-    DEX: { type: "text" },
-    CON: { type: "text" },
-    INT: { type: "text" },
-    WIS: { type: "text" },
-    CHA: { type: "text" },
-    // Link fields
-    birthplace: { type: "single_link", target: "location" },
-    location: { type: "single_link", target: "location" },
+    height: { type: "number" },
+    weight: { type: "number" },
     species: { type: "multi_link", target: "species" },
     traits: { type: "multi_link", target: "trait" },
     abilities: { type: "multi_link", target: "ability" },
+    // Origins
+    background: { type: "text" },
+    motivations: { type: "text" },
+    birth_date: { type: "number" },
+    birthplace: { type: "single_link", target: "location" },
     languages: { type: "multi_link", target: "language" },
+    // World
+    reputation: { type: "text" },
+    location: { type: "single_link", target: "location" },
     objects: { type: "multi_link", target: "object" },
     institutions: { type: "multi_link", target: "institution" },
+    // Personality
+    charisma: { type: "number" },
+    coercion: { type: "number" },
+    competence: { type: "number" },
+    compassion: { type: "number" },
+    creativity: { type: "number" },
+    courage: { type: "number" },
+    // Social
     family: { type: "multi_link", target: "family" },
     friends: { type: "multi_link", target: "character" },
-    rivals: { type: "multi_link", target: "character" }
+    rivals: { type: "multi_link", target: "character" },
+    // TTRPG
+    level: { type: "number" },
+    hit_points: { type: "number" },
+    STR: { type: "number" },
+    DEX: { type: "number" },
+    CON: { type: "number" },
+    INT: { type: "number" },
+    WIS: { type: "number" },
+    CHA: { type: "number" }
   },
   collective: {
-    // Text fields
+    // Formation
     composition: { type: "text" },
-    count: { type: "text" },
-    formation_date: { type: "text" },
+    count: { type: "number" },
+    formation_date: { type: "number" },
+    operator: { type: "single_link", target: "institution" },
+    equipment: { type: "multi_link", target: "construct" },
+    // Dynamics
     activity: { type: "text" },
     disposition: { type: "text" },
     state: { type: "text" },
-    // Link fields
-    operator: { type: "single_link", target: "institution" },
-    equipment: { type: "multi_link", target: "construct" },
     abilities: { type: "multi_link", target: "ability" },
     symbolism: { type: "multi_link", target: "construct" },
+    // World
     species: { type: "multi_link", target: "species" },
     characters: { type: "multi_link", target: "character" },
     creatures: { type: "multi_link", target: "creature" },
     phenomena: { type: "multi_link", target: "phenomenon" }
   },
   construct: {
-    // Text fields
+    // Nature
     rationale: { type: "text" },
     history: { type: "text" },
     status: { type: "text" },
     reach: { type: "text" },
-    start_date: { type: "text" },
-    end_date: { type: "text" },
-    // Link fields
+    start_date: { type: "number" },
+    end_date: { type: "number" },
     founder: { type: "single_link", target: "character" },
     custodian: { type: "single_link", target: "institution" },
+    // Involves
     characters: { type: "multi_link", target: "character" },
     objects: { type: "multi_link", target: "object" },
     locations: { type: "multi_link", target: "location" },
@@ -439,36 +442,38 @@ var FIELD_SCHEMA = {
     narratives: { type: "multi_link", target: "narrative" }
   },
   creature: {
-    // Text fields
+    // Biology
     appearance: { type: "text" },
-    weight: { type: "text" },
-    height: { type: "text" },
+    weight: { type: "number" },
+    height: { type: "number" },
+    species: { type: "multi_link", target: "species" },
+    // Behaviour
     habits: { type: "text" },
     demeanor: { type: "text" },
-    status: { type: "text" },
-    birth_date: { type: "text" },
-    challenge_rating: { type: "text" },
-    hit_points: { type: "text" },
-    armor_class: { type: "text" },
-    speed: { type: "text" },
-    // Link fields
-    location: { type: "single_link", target: "location" },
-    zone: { type: "single_link", target: "zone" },
-    species: { type: "multi_link", target: "species" },
     traits: { type: "multi_link", target: "trait" },
     abilities: { type: "multi_link", target: "ability" },
     languages: { type: "multi_link", target: "language" },
+    // World
+    status: { type: "text" },
+    birth_date: { type: "number" },
+    location: { type: "single_link", target: "location" },
+    zone: { type: "single_link", target: "zone" },
+    // TTRPG
+    challenge_rating: { type: "number" },
+    hit_points: { type: "number" },
+    armor_class: { type: "number" },
+    speed: { type: "number" },
     actions: { type: "multi_link", target: "ability" }
   },
   event: {
-    // Text fields
+    // Nature
     history: { type: "text" },
     challenges: { type: "text" },
     consequences: { type: "text" },
-    start_date: { type: "text" },
-    end_date: { type: "text" },
-    // Link fields
-    triggers: { type: "multi_link", target: "event" },
+    start_date: { type: "number" },
+    end_date: { type: "number" },
+    triggers: { type: "multi_link", target: "construct" },
+    // Involves
     characters: { type: "multi_link", target: "character" },
     objects: { type: "multi_link", target: "object" },
     locations: { type: "multi_link", target: "location" },
@@ -487,56 +492,57 @@ var FIELD_SCHEMA = {
     constructs: { type: "multi_link", target: "construct" }
   },
   family: {
-    // Text fields
+    // Identity
     spirit: { type: "text" },
     history: { type: "text" },
-    reputation: { type: "text" },
-    // Link fields
     traditions: { type: "multi_link", target: "construct" },
     traits: { type: "multi_link", target: "trait" },
     abilities: { type: "multi_link", target: "ability" },
     languages: { type: "multi_link", target: "language" },
     ancestors: { type: "multi_link", target: "character" },
+    // World
+    reputation: { type: "text" },
     estates: { type: "multi_link", target: "location" },
     governs: { type: "multi_link", target: "institution" },
     heirlooms: { type: "multi_link", target: "object" },
     creatures: { type: "multi_link", target: "creature" }
   },
   institution: {
-    // Text fields
+    // Foundation
     doctrine: { type: "text" },
-    founding_date: { type: "text" },
-    status: { type: "text" },
-    // Link fields
+    founding_date: { type: "number" },
     parent_institution: { type: "single_link", target: "institution" },
+    // Claims
     zones: { type: "multi_link", target: "zone" },
     objects: { type: "multi_link", target: "object" },
     creatures: { type: "multi_link", target: "creature" },
+    // World
+    status: { type: "text" },
     allies: { type: "multi_link", target: "institution" },
     adversaries: { type: "multi_link", target: "institution" },
     constructs: { type: "multi_link", target: "construct" }
   },
   language: {
-    // Text fields
+    // Structure
     phonology: { type: "text" },
     grammar: { type: "text" },
     lexicon: { type: "text" },
     writing: { type: "text" },
-    status: { type: "text" },
-    // Link fields
     classification: { type: "single_link", target: "construct" },
+    // World
+    status: { type: "text" },
     spread: { type: "multi_link", target: "location" },
     dialects: { type: "multi_link", target: "language" }
   },
   law: {
-    // Text fields
+    // Code
     declaration: { type: "text" },
     purpose: { type: "text" },
-    date: { type: "text" },
-    // Link fields
+    date: { type: "number" },
     parent_law: { type: "single_link", target: "law" },
-    author: { type: "single_link", target: "institution" },
     penalties: { type: "multi_link", target: "construct" },
+    // World
+    author: { type: "single_link", target: "institution" },
     locations: { type: "multi_link", target: "location" },
     zones: { type: "multi_link", target: "zone" },
     prohibitions: { type: "multi_link", target: "construct" },
@@ -544,73 +550,76 @@ var FIELD_SCHEMA = {
     enforcers: { type: "multi_link", target: "title" }
   },
   location: {
-    // Text fields
+    // Setting
     form: { type: "text" },
     function: { type: "text" },
-    founding_date: { type: "text" },
-    political_climate: { type: "text" },
-    customs: { type: "text" },
-    infrastructure: { type: "text" },
-    architecture: { type: "text" },
-    defensibility: { type: "text" },
-    elevation: { type: "text" },
-    // Link fields
+    founding_date: { type: "number" },
     parent_location: { type: "single_link", target: "location" },
+    populations: { type: "multi_link", target: "collective" },
+    // Politics
+    political_climate: { type: "text" },
     primary_power: { type: "single_link", target: "institution" },
     governing_title: { type: "single_link", target: "title" },
+    secondary_powers: { type: "multi_link", target: "institution" },
     zone: { type: "single_link", target: "zone" },
     rival: { type: "single_link", target: "location" },
     partner: { type: "single_link", target: "location" },
-    populations: { type: "multi_link", target: "collective" },
-    secondary_powers: { type: "multi_link", target: "institution" },
+    // World
+    customs: { type: "text" },
     founders: { type: "multi_link", target: "character" },
     cults: { type: "multi_link", target: "construct" },
     delicacies: { type: "multi_link", target: "species" },
+    // Production
     extraction_methods: { type: "multi_link", target: "construct" },
     extraction_goods: { type: "multi_link", target: "construct" },
     industry_methods: { type: "multi_link", target: "construct" },
     industry_goods: { type: "multi_link", target: "construct" },
+    // Commerce
+    infrastructure: { type: "text" },
     extraction_markets: { type: "multi_link", target: "location" },
     industry_markets: { type: "multi_link", target: "location" },
     currencies: { type: "multi_link", target: "construct" },
+    // Construction
+    architecture: { type: "text" },
     buildings: { type: "multi_link", target: "object" },
     building_methods: { type: "multi_link", target: "construct" },
+    // Defense
+    defensibility: { type: "text" },
+    elevation: { type: "number" },
     fighters: { type: "multi_link", target: "construct" },
     defensive_objects: { type: "multi_link", target: "object" }
   },
   map: {
-    // Text fields
+    // Details
     background_color: { type: "text" },
-    hierarchy: { type: "text" },
-    width: { type: "text" },
-    height: { type: "text" },
-    depth: { type: "text" },
-    // Link fields
+    hierarchy: { type: "number" },
+    width: { type: "number" },
+    height: { type: "number" },
+    depth: { type: "number" },
     parent_map: { type: "single_link", target: "map" },
     location: { type: "single_link", target: "location" }
   },
   marker: {
-    // Integer fields
+    // Details
+    map: { type: "single_link", target: "map" },
+    zone: { type: "single_link", target: "zone" },
     x: { type: "integer" },
     y: { type: "integer" },
-    z: { type: "integer" },
-    // Link fields
-    map: { type: "single_link", target: "map" },
-    zone: { type: "single_link", target: "zone" }
+    z: { type: "integer" }
   },
   narrative: {
-    // Text fields
+    // Context
     story: { type: "text" },
     consequences: { type: "text" },
-    start_date: { type: "text" },
-    end_date: { type: "text" },
-    order: { type: "text" },
-    // Link fields
+    start_date: { type: "number" },
+    end_date: { type: "number" },
+    order: { type: "number" },
     parent_narrative: { type: "single_link", target: "narrative" },
     protagonist: { type: "single_link", target: "character" },
     antagonist: { type: "single_link", target: "character" },
     narrator: { type: "single_link", target: "character" },
     conservator: { type: "single_link", target: "institution" },
+    // Involves
     events: { type: "multi_link", target: "event" },
     characters: { type: "multi_link", target: "character" },
     objects: { type: "multi_link", target: "object" },
@@ -631,58 +640,58 @@ var FIELD_SCHEMA = {
     laws: { type: "multi_link", target: "law" }
   },
   object: {
-    // Text fields
+    // Form
     aesthetics: { type: "text" },
-    weight: { type: "text" },
-    amount: { type: "text" },
-    utility: { type: "text" },
-    origins: { type: "text" },
-    // Link fields
+    weight: { type: "number" },
+    amount: { type: "number" },
     parent_object: { type: "single_link", target: "object" },
-    location: { type: "single_link", target: "location" },
-    language: { type: "single_link", target: "language" },
     materials: { type: "multi_link", target: "construct" },
     technology: { type: "multi_link", target: "construct" },
+    // Function
+    utility: { type: "text" },
     effects: { type: "multi_link", target: "phenomenon" },
     abilities: { type: "multi_link", target: "ability" },
     consumes: { type: "multi_link", target: "construct" },
+    // World
+    origins: { type: "text" },
+    location: { type: "single_link", target: "location" },
+    language: { type: "single_link", target: "language" },
     affinities: { type: "multi_link", target: "trait" }
   },
   phenomenon: {
-    // Text fields
+    // Mechanics
     expression: { type: "text" },
     effects: { type: "text" },
-    duration: { type: "text" },
-    mythology: { type: "text" },
-    // Link fields
-    system: { type: "single_link", target: "phenomenon" },
+    duration: { type: "number" },
     catalysts: { type: "multi_link", target: "object" },
     empowerments: { type: "multi_link", target: "ability" },
+    // World
+    mythology: { type: "text" },
+    system: { type: "single_link", target: "phenomenon" },
     triggers: { type: "multi_link", target: "construct" },
     wielders: { type: "multi_link", target: "character" },
     environments: { type: "multi_link", target: "location" }
   },
   pin: {
-    // Special fields
+    // Details
+    map: { type: "single_link", target: "map" },
     element_type: { type: "text" },
     // ElementType enum value
-    // Integer fields
+    element_id: { type: "single_link", target: "any" },
+    // Can reference any element
     x: { type: "integer" },
     y: { type: "integer" },
-    z: { type: "integer" },
-    // Link fields
-    map: { type: "single_link", target: "map" },
-    element_id: { type: "single_link", target: "any" }
-    // Can reference any element
+    z: { type: "integer" }
   },
   relation: {
-    // Text fields
+    // Nature
     background: { type: "text" },
-    start_date: { type: "text" },
-    end_date: { type: "text" },
-    intensity: { type: "text" },
-    // Link fields
+    start_date: { type: "number" },
+    end_date: { type: "number" },
+    intensity: { type: "number" },
     actor: { type: "single_link", target: "character" },
+    events: { type: "multi_link", target: "event" },
+    // Involves
     characters: { type: "multi_link", target: "character" },
     objects: { type: "multi_link", target: "object" },
     locations: { type: "multi_link", target: "location" },
@@ -696,46 +705,47 @@ var FIELD_SCHEMA = {
     phenomena: { type: "multi_link", target: "phenomenon" },
     languages: { type: "multi_link", target: "language" },
     families: { type: "multi_link", target: "family" },
+    relations: { type: "multi_link", target: "relation" },
     titles: { type: "multi_link", target: "title" },
     constructs: { type: "multi_link", target: "construct" },
-    events: { type: "multi_link", target: "event" },
     narratives: { type: "multi_link", target: "narrative" }
   },
   species: {
-    // Text fields
+    // Biology
     appearance: { type: "text" },
-    life_span: { type: "text" },
-    weight: { type: "text" },
+    life_span: { type: "number" },
+    weight: { type: "number" },
+    nourishment: { type: "multi_link", target: "species" },
+    reproduction: { type: "multi_link", target: "construct" },
+    adaptations: { type: "multi_link", target: "ability" },
+    // Psychology
     instincts: { type: "text" },
     sociality: { type: "text" },
     temperament: { type: "text" },
     communication: { type: "text" },
-    aggression: { type: "text" },
+    aggression: { type: "number" },
+    traits: { type: "multi_link", target: "trait" },
+    // World
     role: { type: "text" },
-    // Link fields
     parent_species: { type: "single_link", target: "species" },
-    nourishment: { type: "multi_link", target: "species" },
-    reproduction: { type: "multi_link", target: "construct" },
-    adaptations: { type: "multi_link", target: "ability" },
-    traits: { type: "multi_link", target: "trait" },
     locations: { type: "multi_link", target: "location" },
     zones: { type: "multi_link", target: "zone" },
     affinities: { type: "multi_link", target: "phenomenon" }
   },
   title: {
-    // Text fields
+    // Mandate
     authority: { type: "text" },
     eligibility: { type: "text" },
-    grant_date: { type: "text" },
-    revoke_date: { type: "text" },
-    status: { type: "text" },
-    history: { type: "text" },
-    // Link fields
+    grant_date: { type: "number" },
+    revoke_date: { type: "number" },
     issuer: { type: "single_link", target: "institution" },
     body: { type: "single_link", target: "institution" },
     superior_title: { type: "single_link", target: "title" },
     holders: { type: "multi_link", target: "character" },
     symbols: { type: "multi_link", target: "object" },
+    // World
+    status: { type: "text" },
+    history: { type: "text" },
     characters: { type: "multi_link", target: "character" },
     institutions: { type: "multi_link", target: "institution" },
     families: { type: "multi_link", target: "family" },
@@ -751,45 +761,38 @@ var FIELD_SCHEMA = {
     languages: { type: "multi_link", target: "language" }
   },
   trait: {
-    // Text fields
+    // Qualitative
     social_effects: { type: "text" },
     physical_effects: { type: "text" },
     functional_effects: { type: "text" },
     personality_effects: { type: "text" },
     behaviour_effects: { type: "text" },
-    charisma: { type: "text" },
-    coercion: { type: "text" },
-    competence: { type: "text" },
-    compassion: { type: "text" },
-    creativity: { type: "text" },
-    courage: { type: "text" },
+    // Quantitative
+    charisma: { type: "number" },
+    coercion: { type: "number" },
+    competence: { type: "number" },
+    compassion: { type: "number" },
+    creativity: { type: "number" },
+    courage: { type: "number" },
+    // World
     significance: { type: "text" },
-    // Link fields
     anti_trait: { type: "single_link", target: "trait" },
     empowered_abilities: { type: "multi_link", target: "ability" }
   },
   zone: {
-    // Text fields
+    // Scope
     role: { type: "text" },
-    start_date: { type: "text" },
-    end_date: { type: "text" },
-    context: { type: "text" },
-    // Link fields
+    start_date: { type: "number" },
+    end_date: { type: "number" },
     phenomena: { type: "multi_link", target: "phenomenon" },
     linked_zones: { type: "multi_link", target: "zone" },
+    // World
+    context: { type: "text" },
     populations: { type: "multi_link", target: "collective" },
     titles: { type: "multi_link", target: "title" },
     principles: { type: "multi_link", target: "construct" }
   }
 };
-var FIELD_MAPPINGS = Object.fromEntries(
-  Object.entries(FIELD_SCHEMA).map(([elementType, fields]) => [
-    elementType,
-    Object.fromEntries(
-      Object.entries(fields).filter(([_, fieldInfo]) => ["single_link", "multi_link"].includes(fieldInfo.type)).map(([fieldName, fieldInfo]) => [fieldName, fieldInfo.target])
-    )
-  ])
-);
 function createElementId(id) {
   return id;
 }
@@ -802,11 +805,9 @@ function createAnyElementId(id) {
 export {
   ELEMENT_ICONS,
   ELEMENT_LABELS,
-  ELEMENT_MATERIAL_ICONS,
   ELEMENT_SECTIONS,
   ELEMENT_UNICODE_ICONS,
   ElementType,
-  FIELD_MAPPINGS,
   FIELD_SCHEMA,
   ONLYWORLDS_VERSION,
   OnlyWorldsClient,
@@ -815,7 +816,6 @@ export {
   createElementIds,
   getElementIcon,
   getElementLabel,
-  getElementMaterialIcon,
   getElementSections,
   getElementUnicodeIcon
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlyworlds/sdk",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
   "main": "dist/index.js",
   "module": "dist/index.mjs",