pw-js-api 0.3.14 → 0.3.15

package/README.md

@@ -33,18 +33,18 @@ NOTE: installing pw-js-api#dev is also available if you wish, there may be no di
 You could use a CDN like jsdelivr or unpkg. You can put this in your HTML page:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.1.1/browser/pw.prod.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.3.15/browser/pw.prod.js"></script>
 ```
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.1.1/browser/pw.dev.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/pw-js-api@0.3.15/browser/pw.dev.js"></script>
 ```
 
 When you have these scripts in your HTML file, you will be able to use the global variable PW which contains PWGameClient, PWApiClient and Constants.
 
 ## Example
 
-Feel free to take a look at the [source code for an example bot](https://github.com/doomestee/PW-JS-Api/blob/main/examples/) that only does snake and listen to certain chat commands (.ping, .say and .disconnect)
+Feel free to take a look at the [source code for an example bot](/examples/index.mjs) that only does snake and listen to certain chat commands (.ping, .say and .disconnect)
 
 ## Why?
 

package/esm/types/api.d.ts

@@ -177,16 +177,14 @@ export interface ListBlockResult {
      */
     MinimapColor?: number;
     /**
-     * EELVL ID.
-     */
-    LegacyId?: number;
-    /**
-     * Maps to a block in EE that might be identical, its value will either be null or a list of argument types.
+     * Maps to block(s) in EE that might be identical, its value will either be null or a list of argument types.
+     * 
+     * NOTE: The object will be empty if there isnt a corresponding block, it will not be undefined still.
      */
-    LegacyMorph?: { [blockId: number]: null | number[] }[];
+    LegacyMorphs: { [blockId: number]: null | number[] };
 }
 
-export interface BlockField<T extends string = string> {
+export interface BlockField<T extends string, TypeOf> {
     /**
      * Name of the field, used for identifying the field.
      */
@@ -199,20 +197,26 @@ export interface BlockField<T extends string = string> {
      * Description describing what this field is for.
      */
     Description: string;
+    /**
+     * The default value set for this field.
+     * 
+     * If applicable.
+     */
+    DefaultValue?: TypeOf;
     /**
      * Whether if this field is required.
      */
     Required: boolean
 }
 
-export interface TextBlockField extends BlockField<"String"> {
+export interface TextBlockField extends BlockField<"String", string> {
     /**
-     * May not be included, if so, this will be a regex string which validates the input.
+     * This will be a regex string which validates the input if not undefined.
      */
     Pattern?: string;
 }
 
-export interface NumberBlockField extends BlockField<"Int32" | "UInt32"> {
+export interface NumberBlockField extends BlockField<"Int32" | "UInt32", number> {
     /**
      * The minimum possible value for this field.
      */
@@ -221,39 +225,30 @@ export interface NumberBlockField extends BlockField<"Int32" | "UInt32"> {
      * The maximum possible value for this field.
      */
     MaxValue: number;
-    /**
-     * The default value set for this number field.
-     */
-    DefaultValue: number;
-
     /**
      * May not be included, if so, this will be a list of numbers whose values cannot be given for this field.
      */
     ExcludedValues?: number[]
 }
 
-export interface BoolBlockField extends BlockField<"Boolean"> {
-    /**
-     * The default value set for this boolean field.
-     */
-    DefaultValue: boolean;
+export interface BoolBlockField extends BlockField<"Boolean", boolean> {
 }
 
 /**
  * Block field special for Note blocks.
  */
-export interface NoteBlockField extends BlockField<"DrumNote[]" | "PianoNote[]" | "GuitarNote[]"> {
+export interface NoteBlockField extends BlockField<"DrumNote[]" | "PianoNote[]" | "GuitarNote[]", never> {
     /**
-     * Usually 1
+     * For note fields, it's currently just 1 for now.
      */
     MinLength: number;
     /**
-     * Usually 6
+     * For note fields, it's currently just 6 for now.
      */
     MaxLength: number;
 }
 
-export type AnyBlockField = BlockField | TextBlockField | NumberBlockField | BoolBlockField | NoteBlockField;
+export type AnyBlockField = TextBlockField | NumberBlockField | BoolBlockField | NoteBlockField;
 
 
 export interface ApiClientOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pw-js-api",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "description": "A PixelWalker Library, aims to be minimal with support for browsers.",
   "exports": {
     "types": "./esm/index.js",