@onlyworlds/sdk 1.3.1 → 1.4.0

package/dist/index.d.mts

@@ -835,6 +835,44 @@ declare const ELEMENT_LABELS: Record<ElementType, string>;
  * @returns The plural label string
  */
 declare function getElementLabel(elementType: ElementType): string;
+/**
+ * Current OnlyWorlds version
+ * Synced with https://github.com/OnlyWorlds/OnlyWorlds/blob/main/VERSION
+ */
+declare const ONLYWORLDS_VERSION: "00.30.00";
+/**
+ * Material Design icons for element types
+ * 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>;
+/**
+ * Unicode emoji icons for element types
+ * Universal compatibility across platforms
+ */
+declare const ELEMENT_UNICODE_ICONS: Record<ElementType, string>;
+/**
+ * Get Material Design icon for an element type
+ * @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;
+/**
+ * Get Unicode emoji for an element type
+ * @param elementType The element type
+ * @returns Unicode emoji string
+ */
+declare function getElementUnicodeIcon(elementType: ElementType): string;
 /**
  * Field type definitions for OnlyWorlds elements
  */
@@ -2289,4 +2327,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_LABELS, 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, 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, getElementLabel };
+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 };

package/dist/index.d.ts

@@ -835,6 +835,44 @@ declare const ELEMENT_LABELS: Record<ElementType, string>;
  * @returns The plural label string
  */
 declare function getElementLabel(elementType: ElementType): string;
+/**
+ * Current OnlyWorlds version
+ * Synced with https://github.com/OnlyWorlds/OnlyWorlds/blob/main/VERSION
+ */
+declare const ONLYWORLDS_VERSION: "00.30.00";
+/**
+ * Material Design icons for element types
+ * 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>;
+/**
+ * Unicode emoji icons for element types
+ * Universal compatibility across platforms
+ */
+declare const ELEMENT_UNICODE_ICONS: Record<ElementType, string>;
+/**
+ * Get Material Design icon for an element type
+ * @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;
+/**
+ * Get Unicode emoji for an element type
+ * @param elementType The element type
+ * @returns Unicode emoji string
+ */
+declare function getElementUnicodeIcon(elementType: ElementType): string;
 /**
  * Field type definitions for OnlyWorlds elements
  */
@@ -2289,4 +2327,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_LABELS, 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, 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, getElementLabel };
+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 };

package/dist/index.js

@@ -20,15 +20,22 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ELEMENT_FONTAWESOME_ICONS: () => ELEMENT_FONTAWESOME_ICONS,
   ELEMENT_LABELS: () => ELEMENT_LABELS,
+  ELEMENT_MATERIAL_ICONS: () => ELEMENT_MATERIAL_ICONS,
+  ELEMENT_UNICODE_ICONS: () => ELEMENT_UNICODE_ICONS,
   ElementType: () => ElementType,
   FIELD_MAPPINGS: () => FIELD_MAPPINGS,
   FIELD_SCHEMA: () => FIELD_SCHEMA,
+  ONLYWORLDS_VERSION: () => ONLYWORLDS_VERSION,
   OnlyWorldsClient: () => OnlyWorldsClient,
   createAnyElementId: () => createAnyElementId,
   createElementId: () => createElementId,
   createElementIds: () => createElementIds,
-  getElementLabel: () => getElementLabel
+  getElementFontAwesomeIcon: () => getElementFontAwesomeIcon,
+  getElementLabel: () => getElementLabel,
+  getElementMaterialIcon: () => getElementMaterialIcon,
+  getElementUnicodeIcon: () => getElementUnicodeIcon
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -205,6 +212,88 @@ var ELEMENT_LABELS = {
 function getElementLabel(elementType) {
   return ELEMENT_LABELS[elementType];
 }
+var ONLYWORLDS_VERSION = "00.30.00";
+var ELEMENT_MATERIAL_ICONS = {
+  ["ability" /* Ability */]: "auto_fix_normal",
+  ["character" /* Character */]: "person",
+  ["collective" /* Collective */]: "groups_3",
+  ["construct" /* Construct */]: "api",
+  ["creature" /* Creature */]: "bug_report",
+  ["event" /* Event */]: "saved_search",
+  ["family" /* Family */]: "supervisor_account",
+  ["institution" /* Institution */]: "business",
+  ["language" /* Language */]: "edit_road",
+  ["law" /* Law */]: "gpp_bad",
+  ["location" /* Location */]: "castle",
+  ["map" /* Map */]: "map",
+  ["marker" /* Marker */]: "place",
+  ["narrative" /* Narrative */]: "menu_book",
+  ["object" /* Object */]: "webhook",
+  ["phenomenon" /* Phenomenon */]: "thunderstorm",
+  ["pin" /* Pin */]: "push_pin",
+  ["relation" /* Relation */]: "link",
+  ["species" /* Species */]: "crib",
+  ["title" /* Title */]: "military_tech",
+  ["trait" /* Trait */]: "flaky",
+  ["zone" /* Zone */]: "architecture"
+};
+var ELEMENT_FONTAWESOME_ICONS = {
+  ["ability" /* Ability */]: "fa-wand-magic-sparkles",
+  ["character" /* Character */]: "fa-user",
+  ["collective" /* Collective */]: "fa-people-group",
+  ["construct" /* Construct */]: "fa-gear",
+  ["creature" /* Creature */]: "fa-dragon",
+  ["event" /* Event */]: "fa-calendar-days",
+  ["family" /* Family */]: "fa-users",
+  ["institution" /* Institution */]: "fa-building",
+  ["language" /* Language */]: "fa-language",
+  ["law" /* Law */]: "fa-gavel",
+  ["location" /* Location */]: "fa-location-dot",
+  ["map" /* Map */]: "fa-map",
+  ["marker" /* Marker */]: "fa-map-marker-alt",
+  ["narrative" /* Narrative */]: "fa-book",
+  ["object" /* Object */]: "fa-cube",
+  ["phenomenon" /* Phenomenon */]: "fa-bolt",
+  ["pin" /* Pin */]: "fa-thumbtack",
+  ["relation" /* Relation */]: "fa-link",
+  ["species" /* Species */]: "fa-dna",
+  ["title" /* Title */]: "fa-crown",
+  ["trait" /* Trait */]: "fa-snowflake",
+  ["zone" /* Zone */]: "fa-layer-group"
+};
+var ELEMENT_UNICODE_ICONS = {
+  ["ability" /* Ability */]: "\u2728",
+  ["character" /* Character */]: "\u{1F464}",
+  ["collective" /* Collective */]: "\u{1F465}",
+  ["construct" /* Construct */]: "\u2699\uFE0F",
+  ["creature" /* Creature */]: "\u{1F43E}",
+  ["event" /* Event */]: "\u{1F4C5}",
+  ["family" /* Family */]: "\u{1F468}\u200D\u{1F469}\u200D\u{1F467}\u200D\u{1F466}",
+  ["institution" /* Institution */]: "\u{1F3DB}\uFE0F",
+  ["language" /* Language */]: "\u{1F4AC}",
+  ["law" /* Law */]: "\u2696\uFE0F",
+  ["location" /* Location */]: "\u{1F3F0}",
+  ["map" /* Map */]: "\u{1F5FA}\uFE0F",
+  ["marker" /* Marker */]: "\u{1F4CD}",
+  ["narrative" /* Narrative */]: "\u{1F4D6}",
+  ["object" /* Object */]: "\u{1F4E6}",
+  ["phenomenon" /* Phenomenon */]: "\u26A1",
+  ["pin" /* Pin */]: "\u{1F4CC}",
+  ["relation" /* Relation */]: "\u{1F517}",
+  ["species" /* Species */]: "\u{1F9EC}",
+  ["title" /* Title */]: "\u{1F451}",
+  ["trait" /* Trait */]: "\u2744\uFE0F",
+  ["zone" /* Zone */]: "\u{1F5FA}\uFE0F"
+};
+function getElementMaterialIcon(elementType) {
+  return ELEMENT_MATERIAL_ICONS[elementType];
+}
+function getElementFontAwesomeIcon(elementType) {
+  return ELEMENT_FONTAWESOME_ICONS[elementType];
+}
+function getElementUnicodeIcon(elementType) {
+  return ELEMENT_UNICODE_ICONS[elementType];
+}
 var FIELD_SCHEMA = {
   ability: {
     // Text fields
@@ -672,13 +761,20 @@ function createAnyElementId(id) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ELEMENT_FONTAWESOME_ICONS,
   ELEMENT_LABELS,
+  ELEMENT_MATERIAL_ICONS,
+  ELEMENT_UNICODE_ICONS,
   ElementType,
   FIELD_MAPPINGS,
   FIELD_SCHEMA,
+  ONLYWORLDS_VERSION,
   OnlyWorldsClient,
   createAnyElementId,
   createElementId,
   createElementIds,
-  getElementLabel
+  getElementFontAwesomeIcon,
+  getElementLabel,
+  getElementMaterialIcon,
+  getElementUnicodeIcon
 });

package/dist/index.mjs

@@ -171,6 +171,88 @@ var ELEMENT_LABELS = {
 function getElementLabel(elementType) {
   return ELEMENT_LABELS[elementType];
 }
+var ONLYWORLDS_VERSION = "00.30.00";
+var ELEMENT_MATERIAL_ICONS = {
+  ["ability" /* Ability */]: "auto_fix_normal",
+  ["character" /* Character */]: "person",
+  ["collective" /* Collective */]: "groups_3",
+  ["construct" /* Construct */]: "api",
+  ["creature" /* Creature */]: "bug_report",
+  ["event" /* Event */]: "saved_search",
+  ["family" /* Family */]: "supervisor_account",
+  ["institution" /* Institution */]: "business",
+  ["language" /* Language */]: "edit_road",
+  ["law" /* Law */]: "gpp_bad",
+  ["location" /* Location */]: "castle",
+  ["map" /* Map */]: "map",
+  ["marker" /* Marker */]: "place",
+  ["narrative" /* Narrative */]: "menu_book",
+  ["object" /* Object */]: "webhook",
+  ["phenomenon" /* Phenomenon */]: "thunderstorm",
+  ["pin" /* Pin */]: "push_pin",
+  ["relation" /* Relation */]: "link",
+  ["species" /* Species */]: "crib",
+  ["title" /* Title */]: "military_tech",
+  ["trait" /* Trait */]: "flaky",
+  ["zone" /* Zone */]: "architecture"
+};
+var ELEMENT_FONTAWESOME_ICONS = {
+  ["ability" /* Ability */]: "fa-wand-magic-sparkles",
+  ["character" /* Character */]: "fa-user",
+  ["collective" /* Collective */]: "fa-people-group",
+  ["construct" /* Construct */]: "fa-gear",
+  ["creature" /* Creature */]: "fa-dragon",
+  ["event" /* Event */]: "fa-calendar-days",
+  ["family" /* Family */]: "fa-users",
+  ["institution" /* Institution */]: "fa-building",
+  ["language" /* Language */]: "fa-language",
+  ["law" /* Law */]: "fa-gavel",
+  ["location" /* Location */]: "fa-location-dot",
+  ["map" /* Map */]: "fa-map",
+  ["marker" /* Marker */]: "fa-map-marker-alt",
+  ["narrative" /* Narrative */]: "fa-book",
+  ["object" /* Object */]: "fa-cube",
+  ["phenomenon" /* Phenomenon */]: "fa-bolt",
+  ["pin" /* Pin */]: "fa-thumbtack",
+  ["relation" /* Relation */]: "fa-link",
+  ["species" /* Species */]: "fa-dna",
+  ["title" /* Title */]: "fa-crown",
+  ["trait" /* Trait */]: "fa-snowflake",
+  ["zone" /* Zone */]: "fa-layer-group"
+};
+var ELEMENT_UNICODE_ICONS = {
+  ["ability" /* Ability */]: "\u2728",
+  ["character" /* Character */]: "\u{1F464}",
+  ["collective" /* Collective */]: "\u{1F465}",
+  ["construct" /* Construct */]: "\u2699\uFE0F",
+  ["creature" /* Creature */]: "\u{1F43E}",
+  ["event" /* Event */]: "\u{1F4C5}",
+  ["family" /* Family */]: "\u{1F468}\u200D\u{1F469}\u200D\u{1F467}\u200D\u{1F466}",
+  ["institution" /* Institution */]: "\u{1F3DB}\uFE0F",
+  ["language" /* Language */]: "\u{1F4AC}",
+  ["law" /* Law */]: "\u2696\uFE0F",
+  ["location" /* Location */]: "\u{1F3F0}",
+  ["map" /* Map */]: "\u{1F5FA}\uFE0F",
+  ["marker" /* Marker */]: "\u{1F4CD}",
+  ["narrative" /* Narrative */]: "\u{1F4D6}",
+  ["object" /* Object */]: "\u{1F4E6}",
+  ["phenomenon" /* Phenomenon */]: "\u26A1",
+  ["pin" /* Pin */]: "\u{1F4CC}",
+  ["relation" /* Relation */]: "\u{1F517}",
+  ["species" /* Species */]: "\u{1F9EC}",
+  ["title" /* Title */]: "\u{1F451}",
+  ["trait" /* Trait */]: "\u2744\uFE0F",
+  ["zone" /* Zone */]: "\u{1F5FA}\uFE0F"
+};
+function getElementMaterialIcon(elementType) {
+  return ELEMENT_MATERIAL_ICONS[elementType];
+}
+function getElementFontAwesomeIcon(elementType) {
+  return ELEMENT_FONTAWESOME_ICONS[elementType];
+}
+function getElementUnicodeIcon(elementType) {
+  return ELEMENT_UNICODE_ICONS[elementType];
+}
 var FIELD_SCHEMA = {
   ability: {
     // Text fields
@@ -637,13 +719,20 @@ function createAnyElementId(id) {
   return id;
 }
 export {
+  ELEMENT_FONTAWESOME_ICONS,
   ELEMENT_LABELS,
+  ELEMENT_MATERIAL_ICONS,
+  ELEMENT_UNICODE_ICONS,
   ElementType,
   FIELD_MAPPINGS,
   FIELD_SCHEMA,
+  ONLYWORLDS_VERSION,
   OnlyWorldsClient,
   createAnyElementId,
   createElementId,
   createElementIds,
-  getElementLabel
+  getElementFontAwesomeIcon,
+  getElementLabel,
+  getElementMaterialIcon,
+  getElementUnicodeIcon
 };

package/package.json

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