@onlyworlds/sdk 2.2.2 → 2.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -50,7 +50,7 @@ await client.characters.delete('element-id');
50
50
  ## Features
51
51
 
52
52
  - ✅ **Full Type Safety** - Complete TypeScript definitions for all 22 OnlyWorlds element types
53
- - ✅ **Auto-Generated Types** - Types synchronized with the latest OnlyWorlds schema
53
+ - ✅ **Schema-Aligned Types** - Type definitions track the OnlyWorlds schema
54
54
  - ✅ **CRUD Operations** - Create, read, update, and delete operations for all elements
55
55
  - ✅ **Token Management** - Built-in support for OnlyWorlds token rating system
56
56
  - ✅ **Branded Types** - Compile-time safety for element relationships
package/dist/index.d.mts CHANGED
@@ -915,6 +915,7 @@ interface FieldInfo {
915
915
  type: FieldType;
916
916
  target?: string;
917
917
  max?: number;
918
+ required?: boolean;
918
919
  }
919
920
  /**
920
921
  * Comprehensive field schema - provides complete metadata for all fields
@@ -1949,22 +1950,27 @@ declare const FIELD_SCHEMA: {
1949
1950
  readonly map: {
1950
1951
  readonly type: "single_link";
1951
1952
  readonly target: "map";
1953
+ readonly required: true;
1952
1954
  };
1953
1955
  readonly zone: {
1954
1956
  readonly type: "single_link";
1955
1957
  readonly target: "zone";
1958
+ readonly required: true;
1956
1959
  };
1957
1960
  readonly x: {
1958
1961
  readonly type: "number";
1962
+ readonly required: true;
1959
1963
  };
1960
1964
  readonly y: {
1961
1965
  readonly type: "number";
1966
+ readonly required: true;
1962
1967
  };
1963
1968
  readonly z: {
1964
1969
  readonly type: "number";
1965
1970
  };
1966
1971
  readonly order: {
1967
1972
  readonly type: "number";
1973
+ readonly required: true;
1968
1974
  };
1969
1975
  };
1970
1976
  readonly narrative: {
@@ -2251,19 +2257,24 @@ declare const FIELD_SCHEMA: {
2251
2257
  readonly map: {
2252
2258
  readonly type: "single_link";
2253
2259
  readonly target: "map";
2260
+ readonly required: true;
2254
2261
  };
2255
2262
  readonly element_type: {
2256
2263
  readonly type: "text";
2264
+ readonly required: true;
2257
2265
  };
2258
2266
  readonly element_id: {
2259
2267
  readonly type: "single_link";
2260
2268
  readonly target: "any";
2269
+ readonly required: true;
2261
2270
  };
2262
2271
  readonly x: {
2263
2272
  readonly type: "number";
2273
+ readonly required: true;
2264
2274
  };
2265
2275
  readonly y: {
2266
2276
  readonly type: "number";
2277
+ readonly required: true;
2267
2278
  };
2268
2279
  readonly z: {
2269
2280
  readonly type: "number";
package/dist/index.d.ts CHANGED
@@ -915,6 +915,7 @@ interface FieldInfo {
915
915
  type: FieldType;
916
916
  target?: string;
917
917
  max?: number;
918
+ required?: boolean;
918
919
  }
919
920
  /**
920
921
  * Comprehensive field schema - provides complete metadata for all fields
@@ -1949,22 +1950,27 @@ declare const FIELD_SCHEMA: {
1949
1950
  readonly map: {
1950
1951
  readonly type: "single_link";
1951
1952
  readonly target: "map";
1953
+ readonly required: true;
1952
1954
  };
1953
1955
  readonly zone: {
1954
1956
  readonly type: "single_link";
1955
1957
  readonly target: "zone";
1958
+ readonly required: true;
1956
1959
  };
1957
1960
  readonly x: {
1958
1961
  readonly type: "number";
1962
+ readonly required: true;
1959
1963
  };
1960
1964
  readonly y: {
1961
1965
  readonly type: "number";
1966
+ readonly required: true;
1962
1967
  };
1963
1968
  readonly z: {
1964
1969
  readonly type: "number";
1965
1970
  };
1966
1971
  readonly order: {
1967
1972
  readonly type: "number";
1973
+ readonly required: true;
1968
1974
  };
1969
1975
  };
1970
1976
  readonly narrative: {
@@ -2251,19 +2257,24 @@ declare const FIELD_SCHEMA: {
2251
2257
  readonly map: {
2252
2258
  readonly type: "single_link";
2253
2259
  readonly target: "map";
2260
+ readonly required: true;
2254
2261
  };
2255
2262
  readonly element_type: {
2256
2263
  readonly type: "text";
2264
+ readonly required: true;
2257
2265
  };
2258
2266
  readonly element_id: {
2259
2267
  readonly type: "single_link";
2260
2268
  readonly target: "any";
2269
+ readonly required: true;
2261
2270
  };
2262
2271
  readonly x: {
2263
2272
  readonly type: "number";
2273
+ readonly required: true;
2264
2274
  };
2265
2275
  readonly y: {
2266
2276
  readonly type: "number";
2277
+ readonly required: true;
2267
2278
  };
2268
2279
  readonly z: {
2269
2280
  readonly type: "number";
package/dist/index.js CHANGED
@@ -568,12 +568,12 @@ var FIELD_SCHEMA = {
568
568
  subtype: { type: "text", required: false },
569
569
  image_url: { type: "text", required: false },
570
570
  // Details
571
- map: { type: "single_link", target: "map" },
572
- zone: { type: "single_link", target: "zone" },
573
- x: { type: "number" },
574
- y: { type: "number" },
571
+ map: { type: "single_link", target: "map", required: true },
572
+ zone: { type: "single_link", target: "zone", required: true },
573
+ x: { type: "number", required: true },
574
+ y: { type: "number", required: true },
575
575
  z: { type: "number" },
576
- order: { type: "number" }
576
+ order: { type: "number", required: true }
577
577
  },
578
578
  narrative: {
579
579
  // Base fields (shared by all elements)
@@ -666,13 +666,13 @@ var FIELD_SCHEMA = {
666
666
  subtype: { type: "text", required: false },
667
667
  image_url: { type: "text", required: false },
668
668
  // Details
669
- map: { type: "single_link", target: "map" },
670
- element_type: { type: "text" },
671
- // ElementType enum value
672
- element_id: { type: "single_link", target: "any" },
669
+ map: { type: "single_link", target: "map", required: true },
670
+ element_type: { type: "text", required: true },
671
+ // ElementType enum value; YAML 'element' generic-link is split into _type + _id
672
+ element_id: { type: "single_link", target: "any", required: true },
673
673
  // Can reference any element
674
- x: { type: "number" },
675
- y: { type: "number" },
674
+ x: { type: "number", required: true },
675
+ y: { type: "number", required: true },
676
676
  z: { type: "number" }
677
677
  },
678
678
  relation: {
package/dist/index.mjs CHANGED
@@ -529,12 +529,12 @@ var FIELD_SCHEMA = {
529
529
  subtype: { type: "text", required: false },
530
530
  image_url: { type: "text", required: false },
531
531
  // Details
532
- map: { type: "single_link", target: "map" },
533
- zone: { type: "single_link", target: "zone" },
534
- x: { type: "number" },
535
- y: { type: "number" },
532
+ map: { type: "single_link", target: "map", required: true },
533
+ zone: { type: "single_link", target: "zone", required: true },
534
+ x: { type: "number", required: true },
535
+ y: { type: "number", required: true },
536
536
  z: { type: "number" },
537
- order: { type: "number" }
537
+ order: { type: "number", required: true }
538
538
  },
539
539
  narrative: {
540
540
  // Base fields (shared by all elements)
@@ -627,13 +627,13 @@ var FIELD_SCHEMA = {
627
627
  subtype: { type: "text", required: false },
628
628
  image_url: { type: "text", required: false },
629
629
  // Details
630
- map: { type: "single_link", target: "map" },
631
- element_type: { type: "text" },
632
- // ElementType enum value
633
- element_id: { type: "single_link", target: "any" },
630
+ map: { type: "single_link", target: "map", required: true },
631
+ element_type: { type: "text", required: true },
632
+ // ElementType enum value; YAML 'element' generic-link is split into _type + _id
633
+ element_id: { type: "single_link", target: "any", required: true },
634
634
  // Can reference any element
635
- x: { type: "number" },
636
- y: { type: "number" },
635
+ x: { type: "number", required: true },
636
+ y: { type: "number", required: true },
637
637
  z: { type: "number" }
638
638
  },
639
639
  relation: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onlyworlds/sdk",
3
- "version": "2.2.2",
3
+ "version": "2.2.3",
4
4
  "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",