mapscreatr - npm Package Compare versions

Comparing version 0.8.1 to 0.8.3

lib/Actor.d.ts

@@ -26,3 +26,3 @@ /**
     /**
-     * Which type of Actor thisis.
+     * Which type of Actor this is.
      */
@@ -29,0 +29,0 @@ groupType: string;

lib/index.d.ts

@@ -0,0 +0,0 @@ export * from "./Actor";

lib/MapsCreatr.d.ts

@@ -52,5 +52,3 @@ import { ObjectMakr } from "objectmakr";
      */
-    getMacros(): {
-        [i: string]: Macro;
-    };
+    getMacros(): Record<string, Macro>;
     /**
@@ -63,11 +61,7 @@ * @returns Whether Locations must have an entrance Function.
      */
-    getMapsRaw(): {
-        [i: string]: MapRaw;
-    };
+    getMapsRaw(): Record<string, MapRaw>;
     /**
      * @returns The Object storing maps, keyed by name.
      */
-    getMaps(): {
-        [i: string]: Map;
-    };
+    getMaps(): Record<string, Map>;
     /**
@@ -93,5 +87,3 @@ * @param name   A key to find the map under.
      */
-    storeMaps(maps: {
-        [i: string]: MapRaw;
-    }): void;
+    storeMaps(maps: Record<string, MapRaw>): void;
     /**
@@ -126,3 +118,3 @@ * Creates and stores a new map. The internal ObjectMaker factory is used to
      */
-    analyzePreSwitch(reference: any, preactors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any;
+    analyzePreSwitch(reference: any, preActors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any;
     /**
@@ -138,3 +130,3 @@ * PreActor case: Macro instruction. This calls the macro on the same input,
      */
-    analyzePreMacro(reference: any, preactors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any[] | any;
+    analyzePreMacro(reference: any, preActors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any[] | any;
     /**
@@ -150,3 +142,3 @@ * Macro case: PreActor instruction. This creates a PreActor from the
      */
-    analyzePreActor(reference: any, preactors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any;
+    analyzePreActor(reference: any, preActors: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw): any;
     /**
@@ -175,3 +167,3 @@ * Parses the Areas and Locations in a map to make it ready for use.
      *
-     * @param preactor   The PreActor stretching the Area's boundaries.
+     * @param preActor   The PreActor stretching the Area's boundaries.
      * @param area   An Area containing the PreActor.
@@ -193,5 +185,5 @@ */
      * Creates an Object wrapper around a PreActors Object with versions of each
-     * child PreActor[] sorted by xloc and yloc, in increasing and decreasing order.
+     * child PreActor[] sorted by xLocation and yLocation, in increasing and decreasing order.
      *
-     * @param preactors   A raw container of PreActors.
+     * @param preActors   A raw container of PreActors.
      * @returns A PreActor wrapper with the keys "xInc", "xDec", "yInc", and "yDec".
@@ -198,0 +190,0 @@ */

lib/PreActor.d.ts

 import { ObjectMakr } from "objectmakr";
+import { Actor } from "./Actor";
 import { PreActorLike, PreActorSettings } from "./PreActorLike";
-import { Actor } from "./Actor";
 /**
@@ -5,0 +5,0 @@ * Basic storage container for a single Actor to be stored in an Area.

lib/PreActorLike.d.ts

@@ -0,0 +0,0 @@ import { Actor } from "./Actor";

lib/types.d.ts

 import { ObjectMakr } from "objectmakr";
+import { Actor } from "./Actor";
 import { PreActorLike, PreActorSettings } from "./PreActorLike";
@@ -14,13 +15,7 @@ /**
      */
-    locations: {
-        [i: string]: LocationRaw;
-        [i: number]: LocationRaw;
-    };
+    locations: Record<number | string, LocationRaw>;
     /**
      * Descriptions of areas in the map.
      */
-    areas: {
-        [i: string]: AreaRaw;
-        [i: number]: AreaRaw;
-    };
+    areas: Record<number | string, AreaRaw>;
 }
@@ -41,9 +36,9 @@ /**
     /**
+     * Which area this location is a part of.
+     */
+    area?: number | string;
+    /**
      * The entrance method used to enter the location.
      */
     entry?: string;
-    /**
-     * Which area this location is a part of.
-     */
-    area?: number | string;
 }
@@ -61,10 +56,7 @@ /**
      */
-    areas: {
-        [i: string]: Area;
-        [i: number]: Area;
-    };
+    areas: Record<number | string, Area>;
     /**
      * A listing of locations in the Map, keyed by name.
      */
-    locations: any;
+    locations: Record<number | string, Location>;
 }
@@ -135,2 +127,8 @@ /**
     entry?: Entrance;
+    /**
+     * The Actor the entrance is coming from (by default, the entering Actor).
+     */
+    entrance?: Actor;
+    xLocation?: number;
+    yLocation?: number;
 }
@@ -140,5 +138,3 @@ /**
  */
-export interface PreActorsRawContainer {
-    [i: string]: PreActorLike[];
-}
+export declare type PreActorsRawContainer = Record<string, PreActorLike[]>;
 /**
@@ -167,5 +163,5 @@ * A collection of PreActorLikes sorted in all four directions.
      *
-     * @param preactorLike   A PreactorLike to add.
+     * @param preActorLike   A PreActorLike to add.
      */
-    push(preactorLike: PreActorLike): void;
+    push(preActorLike: PreActorLike): void;
 }
@@ -175,5 +171,3 @@ /**
  */
-export interface PreActorsContainers {
-    [i: string]: PreActorsContainer;
-}
+export declare type PreActorsContainers = Record<string, PreActorsContainer>;
 /**
@@ -192,5 +186,3 @@ * Containers that may be passed into analysis Functions.
  */
-export interface Macros {
-    [i: string]: Macro;
-}
+export declare type Macros = Record<string, Macro>;
 /**
@@ -200,3 +192,3 @@ * A Function to automate placing other PreActorLikes or macros in an Area.
  * @param reference   The JSON-friendly reference causing the macro.
- * @param preactorLikes   The container of PreActorLikes this is adding to.
+ * @param preActorLikes   The container of PreActorLikes this is adding to.
  * @param area   The container Area containing the PreActorLikes.
@@ -206,3 +198,3 @@ * @param map   The container Map containing the Area.
  */
-export declare type Macro = (reference: any, preactorLikes: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw) => PreActorLike | PreActorLike[] | any;
+export declare type Macro = (reference: any, preActorLikes: AnalysisContainer, area: Area | AreaRaw, map: Map | MapRaw) => PreActorLike | PreActorLike[] | any;
 /**
@@ -239,4 +231,4 @@ * Settings to initialize a new MapsCreatr.
      */
-    maps?: any;
+    maps?: Record<string, MapRaw>;
 }
 //# sourceMappingURL=types.d.ts.map

package.json

 {
     "author": {
-        "email": "[e-mail]",
+        "email": "[e-mail]",
         "name": "Josh Goldberg"
@@ -11,8 +11,17 @@ },
     "dependencies": {
-        "itemsholdr": "^0.8.1",
-        "objectmakr": "^0.8.1"
+        "itemsholdr": "^0.8.3",
+        "objectmakr": "^0.8.3"
     },
     "description": "Storage container and lazy loader for EightBittr maps.",
     "devDependencies": {
-        "shenanigans-manager": "^0.8.1"
+        "@types/chai": "^4.3.3",
+        "@types/mocha": "^9.1.1",
+        "@types/sinon": "^10.0.13",
+        "@types/sinon-chai": "^3.2.8",
+        "chai": "^4.3.6",
+        "mocha": "^10.0.0",
+        "mocha-headless-chrome": "^4.0.0",
+        "shenanigans-manager": "^0.8.3",
+        "sinon": "^14.0.0",
+        "sinon-chai": "^3.7.0"
     },
@@ -26,10 +35,10 @@ "license": "MIT",
     "scripts": {
-        "clean": "rm -rf lib *.tsbuildinfo",
+        "clean": "rm -rf dist lib *.tsbuildinfo",
         "compile": "tsc -b",
-        "hydrate": "shenanigans-manager hydrate",
+        "hydrate": "yarn shenanigans-manager hydrate",
         "link": "yarn link",
-        "publish:ci": "shenanigans-manager publish-if-updated",
+        "publish:ci": "yarn shenanigans-manager publish-if-updated",
         "test": "yarn run test:setup && yarn run test:run",
-        "test:run": "mocha-headless-chrome --file test/index.html",
-        "test:setup": "shenanigans-manager generate-tests"
+        "test:run": "yarn mocha-headless-chrome --file test/index.html",
+        "test:setup": "yarn shenanigans-manager generate-tests"
     },
@@ -40,3 +49,3 @@ "shenanigans": {
     "types": "./lib/index.d.ts",
-    "version": "0.8.1"
-}
+    "version": "0.8.3"
+}

No alert changes

Worsened metrics

Total package byte prevSize

22940

decreased by-87.27%

Dev dependency count

10

increased by900%

Number of package files

11

decreased by-73.81%

Lines of code

643

decreased by-54.14%

Dependency changes

• Updateditemsholdr@^0.8.3

• Updatedobjectmakr@^0.8.3