@onlyworlds/sdk 1.0.0 → 1.2.0

package/dist/index.js

@@ -21,7 +21,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   ElementType: () => ElementType,
-  OnlyWorldsClient: () => OnlyWorldsClient
+  FIELD_MAPPINGS: () => FIELD_MAPPINGS,
+  OnlyWorldsClient: () => OnlyWorldsClient,
+  createAnyElementId: () => createAnyElementId,
+  createElementId: () => createElementId,
+  createElementIds: () => createElementIds
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -55,6 +59,7 @@ var OnlyWorldsClient = class {
       "API-Key": config.apiKey,
       "API-Pin": config.apiPin
     };
+    this.worlds = new Resource(this, "world");
     this.abilities = new Resource(this, "ability");
     this.characters = new Resource(this, "character");
     this.collectives = new Resource(this, "collective");
@@ -121,9 +126,10 @@ var OnlyWorldsClient = class {
   }
   /**
    * Get all worlds accessible with current credentials
+   * @deprecated Use client.worlds.list() instead for consistent API
    */
   async getWorlds() {
-    return this.request("GET", "/worlds/");
+    return this.request("GET", "/world/");
   }
   /**
    * Helper to convert nested objects to _id/_ids format
@@ -169,8 +175,282 @@ var ElementType = /* @__PURE__ */ ((ElementType2) => {
   ElementType2["Zone"] = "zone";
   return ElementType2;
 })(ElementType || {});
+var FIELD_MAPPINGS = {
+  ability: {
+    tradition: "construct",
+    source: "phenomenon",
+    locus: "location",
+    effects: "phenomenon",
+    talents: "trait",
+    requisites: "construct",
+    instruments: "object",
+    systems: "construct"
+  },
+  character: {
+    birthplace: "location",
+    location: "location",
+    species: "species",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    objects: "object",
+    institutions: "institution",
+    family: "family",
+    friends: "character",
+    rivals: "character"
+  },
+  collective: {
+    operator: "institution",
+    equipment: "construct",
+    abilities: "ability",
+    symbolism: "construct",
+    species: "species",
+    characters: "character",
+    creatures: "creature",
+    phenomena: "phenomenon"
+  },
+  construct: {
+    founder: "character",
+    custodian: "institution",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct",
+    events: "event",
+    narratives: "narrative"
+  },
+  creature: {
+    location: "location",
+    zone: "zone",
+    species: "species",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    actions: "ability"
+  },
+  event: {
+    triggers: "event",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct"
+  },
+  family: {
+    traditions: "construct",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    ancestors: "character",
+    estates: "location",
+    governs: "institution",
+    heirlooms: "object",
+    creatures: "creature"
+  },
+  institution: {
+    parent_institution: "institution",
+    zones: "zone",
+    objects: "object",
+    creatures: "creature",
+    allies: "institution",
+    adversaries: "institution",
+    constructs: "construct"
+  },
+  language: {
+    classification: "construct",
+    spread: "location",
+    dialects: "language"
+  },
+  law: {
+    parent_law: "law",
+    author: "institution",
+    penalties: "construct",
+    locations: "location",
+    zones: "zone",
+    prohibitions: "construct",
+    adjudicators: "title",
+    enforcers: "title"
+  },
+  location: {
+    parent_location: "location",
+    primary_power: "institution",
+    governing_title: "title",
+    zone: "zone",
+    rival: "location",
+    partner: "location",
+    populations: "collective",
+    secondary_powers: "institution",
+    founders: "character",
+    cults: "construct",
+    delicacies: "species",
+    extraction_methods: "construct",
+    extraction_goods: "construct",
+    industry_methods: "construct",
+    industry_goods: "construct",
+    extraction_markets: "location",
+    industry_markets: "location",
+    currencies: "construct",
+    buildings: "object",
+    building_methods: "construct",
+    fighters: "construct",
+    defensive_objects: "object"
+  },
+  map: {
+    parent_map: "map",
+    location: "location"
+  },
+  marker: {
+    map: "map",
+    zone: "zone"
+  },
+  narrative: {
+    parent_narrative: "narrative",
+    protagonist: "character",
+    antagonist: "character",
+    narrator: "character",
+    conservator: "institution",
+    events: "event",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct",
+    laws: "law"
+  },
+  object: {
+    parent_object: "object",
+    location: "location",
+    language: "language",
+    materials: "construct",
+    technology: "construct",
+    effects: "phenomenon",
+    abilities: "ability",
+    consumes: "construct",
+    affinities: "trait"
+  },
+  phenomenon: {
+    system: "phenomenon",
+    catalysts: "object",
+    empowerments: "ability",
+    triggers: "construct",
+    wielders: "character",
+    environments: "location"
+  },
+  pin: {
+    map: "map",
+    element_id: "any_element"
+  },
+  relation: {
+    actor: "character",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    titles: "title",
+    constructs: "construct",
+    events: "event",
+    narratives: "narrative"
+  },
+  species: {
+    parent_species: "species",
+    nourishment: "species",
+    reproduction: "construct",
+    adaptations: "ability",
+    traits: "trait",
+    locations: "location",
+    zones: "zone",
+    affinities: "phenomenon"
+  },
+  title: {
+    issuer: "institution",
+    body: "institution",
+    superior_title: "title",
+    holders: "character",
+    symbols: "object",
+    characters: "character",
+    institutions: "institution",
+    families: "family",
+    zones: "zone",
+    locations: "location",
+    objects: "object",
+    constructs: "construct",
+    laws: "law",
+    collectives: "collective",
+    creatures: "creature",
+    phenomena: "phenomenon",
+    species: "species",
+    languages: "language"
+  },
+  trait: {
+    anti_trait: "trait",
+    empowered_abilities: "ability"
+  },
+  zone: {
+    phenomena: "phenomenon",
+    linked_zones: "zone",
+    populations: "collective",
+    titles: "title",
+    principles: "construct"
+  }
+};
+function createElementId(id) {
+  return id;
+}
+function createElementIds(ids) {
+  return ids;
+}
+function createAnyElementId(id) {
+  return id;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ElementType,
-  OnlyWorldsClient
+  FIELD_MAPPINGS,
+  OnlyWorldsClient,
+  createAnyElementId,
+  createElementId,
+  createElementIds
 });

package/dist/index.mjs

@@ -28,6 +28,7 @@ var OnlyWorldsClient = class {
       "API-Key": config.apiKey,
       "API-Pin": config.apiPin
     };
+    this.worlds = new Resource(this, "world");
     this.abilities = new Resource(this, "ability");
     this.characters = new Resource(this, "character");
     this.collectives = new Resource(this, "collective");
@@ -94,9 +95,10 @@ var OnlyWorldsClient = class {
   }
   /**
    * Get all worlds accessible with current credentials
+   * @deprecated Use client.worlds.list() instead for consistent API
    */
   async getWorlds() {
-    return this.request("GET", "/worlds/");
+    return this.request("GET", "/world/");
   }
   /**
    * Helper to convert nested objects to _id/_ids format
@@ -142,7 +144,281 @@ var ElementType = /* @__PURE__ */ ((ElementType2) => {
   ElementType2["Zone"] = "zone";
   return ElementType2;
 })(ElementType || {});
+var FIELD_MAPPINGS = {
+  ability: {
+    tradition: "construct",
+    source: "phenomenon",
+    locus: "location",
+    effects: "phenomenon",
+    talents: "trait",
+    requisites: "construct",
+    instruments: "object",
+    systems: "construct"
+  },
+  character: {
+    birthplace: "location",
+    location: "location",
+    species: "species",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    objects: "object",
+    institutions: "institution",
+    family: "family",
+    friends: "character",
+    rivals: "character"
+  },
+  collective: {
+    operator: "institution",
+    equipment: "construct",
+    abilities: "ability",
+    symbolism: "construct",
+    species: "species",
+    characters: "character",
+    creatures: "creature",
+    phenomena: "phenomenon"
+  },
+  construct: {
+    founder: "character",
+    custodian: "institution",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct",
+    events: "event",
+    narratives: "narrative"
+  },
+  creature: {
+    location: "location",
+    zone: "zone",
+    species: "species",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    actions: "ability"
+  },
+  event: {
+    triggers: "event",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct"
+  },
+  family: {
+    traditions: "construct",
+    traits: "trait",
+    abilities: "ability",
+    languages: "language",
+    ancestors: "character",
+    estates: "location",
+    governs: "institution",
+    heirlooms: "object",
+    creatures: "creature"
+  },
+  institution: {
+    parent_institution: "institution",
+    zones: "zone",
+    objects: "object",
+    creatures: "creature",
+    allies: "institution",
+    adversaries: "institution",
+    constructs: "construct"
+  },
+  language: {
+    classification: "construct",
+    spread: "location",
+    dialects: "language"
+  },
+  law: {
+    parent_law: "law",
+    author: "institution",
+    penalties: "construct",
+    locations: "location",
+    zones: "zone",
+    prohibitions: "construct",
+    adjudicators: "title",
+    enforcers: "title"
+  },
+  location: {
+    parent_location: "location",
+    primary_power: "institution",
+    governing_title: "title",
+    zone: "zone",
+    rival: "location",
+    partner: "location",
+    populations: "collective",
+    secondary_powers: "institution",
+    founders: "character",
+    cults: "construct",
+    delicacies: "species",
+    extraction_methods: "construct",
+    extraction_goods: "construct",
+    industry_methods: "construct",
+    industry_goods: "construct",
+    extraction_markets: "location",
+    industry_markets: "location",
+    currencies: "construct",
+    buildings: "object",
+    building_methods: "construct",
+    fighters: "construct",
+    defensive_objects: "object"
+  },
+  map: {
+    parent_map: "map",
+    location: "location"
+  },
+  marker: {
+    map: "map",
+    zone: "zone"
+  },
+  narrative: {
+    parent_narrative: "narrative",
+    protagonist: "character",
+    antagonist: "character",
+    narrator: "character",
+    conservator: "institution",
+    events: "event",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    relations: "relation",
+    titles: "title",
+    constructs: "construct",
+    laws: "law"
+  },
+  object: {
+    parent_object: "object",
+    location: "location",
+    language: "language",
+    materials: "construct",
+    technology: "construct",
+    effects: "phenomenon",
+    abilities: "ability",
+    consumes: "construct",
+    affinities: "trait"
+  },
+  phenomenon: {
+    system: "phenomenon",
+    catalysts: "object",
+    empowerments: "ability",
+    triggers: "construct",
+    wielders: "character",
+    environments: "location"
+  },
+  pin: {
+    map: "map",
+    element_id: "any_element"
+  },
+  relation: {
+    actor: "character",
+    characters: "character",
+    objects: "object",
+    locations: "location",
+    species: "species",
+    creatures: "creature",
+    institutions: "institution",
+    traits: "trait",
+    collectives: "collective",
+    zones: "zone",
+    abilities: "ability",
+    phenomena: "phenomenon",
+    languages: "language",
+    families: "family",
+    titles: "title",
+    constructs: "construct",
+    events: "event",
+    narratives: "narrative"
+  },
+  species: {
+    parent_species: "species",
+    nourishment: "species",
+    reproduction: "construct",
+    adaptations: "ability",
+    traits: "trait",
+    locations: "location",
+    zones: "zone",
+    affinities: "phenomenon"
+  },
+  title: {
+    issuer: "institution",
+    body: "institution",
+    superior_title: "title",
+    holders: "character",
+    symbols: "object",
+    characters: "character",
+    institutions: "institution",
+    families: "family",
+    zones: "zone",
+    locations: "location",
+    objects: "object",
+    constructs: "construct",
+    laws: "law",
+    collectives: "collective",
+    creatures: "creature",
+    phenomena: "phenomenon",
+    species: "species",
+    languages: "language"
+  },
+  trait: {
+    anti_trait: "trait",
+    empowered_abilities: "ability"
+  },
+  zone: {
+    phenomena: "phenomenon",
+    linked_zones: "zone",
+    populations: "collective",
+    titles: "title",
+    principles: "construct"
+  }
+};
+function createElementId(id) {
+  return id;
+}
+function createElementIds(ids) {
+  return ids;
+}
+function createAnyElementId(id) {
+  return id;
+}
 export {
   ElementType,
-  OnlyWorldsClient
+  FIELD_MAPPINGS,
+  OnlyWorldsClient,
+  createAnyElementId,
+  createElementId,
+  createElementIds
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlyworlds/sdk",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -28,7 +28,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/onlyworlds/sdk"
+    "url": "git+https://github.com/onlyworlds/sdk.git"
   },
   "devDependencies": {
     "tsup": "^8.0.1",
@@ -40,4 +40,4 @@
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}