@sprucelabs/spruce-location-utils 9.2.0 → 9.4.0

package/build/esm/index-module.d.ts

@@ -1,3 +1,5 @@
 export { default as organizationAssert } from './tests/organizationAssert';
 export { default as LocationListCardViewController } from './viewControllers/LocationListCard.vc';
+export { default as locationListCardAssert } from './tests/locationListCardAssert';
+export * from './tests/locationListCardAssert';
 export * from './types-module';

package/build/esm/index-module.js

@@ -1,3 +1,5 @@
 export { default as organizationAssert } from './tests/organizationAssert.js';
 export { default as LocationListCardViewController } from './viewControllers/LocationListCard.vc.js';
+export { default as locationListCardAssert } from './tests/locationListCardAssert.js';
+export * from './tests/locationListCardAssert.js';
 export * from './types-module.js';

package/build/esm/tests/locationListCardAssert.d.ts

@@ -0,0 +1,16 @@
+import { Card, SpruceSchemas, ViewController, ViewControllerOptions } from '@sprucelabs/heartwood-view-controllers';
+import { ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+import LocationListCardViewController, { LocationListCardViewControllerOptions as LocationListCardOptions } from '../viewControllers/LocationListCard.vc';
+declare const locationListCardAssert: {
+    beforeEach(views: Pick<ViewFixture, 'setController'>): void;
+    loadsWithTargetAndPayload(options: LoadsWithTargetAndPayloadOptions): Promise<void>;
+    configurationEquals(vc: ViewController<Card>, options: LocationListCardOptions): void;
+};
+export declare class SpyLocationListCard extends LocationListCardViewController {
+    constructorOptions: LocationListCardOptions;
+    constructor(options: ViewControllerOptions & LocationListCardOptions);
+}
+export type LoadsWithTargetAndPayloadOptions = Partial<SpruceSchemas.Mercury.v2020_12_25.ListLocationsEmitTargetAndPayload> & {
+    action: () => Promise<void> | void;
+};
+export default locationListCardAssert;

package/build/esm/tests/locationListCardAssert.js

@@ -0,0 +1,52 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { eventFaker } from '@sprucelabs/spruce-test-fixtures';
+import { assert } from '@sprucelabs/test-utils';
+import LocationListCardViewController from '../viewControllers/LocationListCard.vc.js';
+const locationListCardAssert = {
+    beforeEach(views) {
+        views.setController('locations.list-card', SpyLocationListCard);
+    },
+    loadsWithTargetAndPayload(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { action, target, payload } = options;
+            let passedTarget;
+            let passedPayload;
+            yield eventFaker.on('list-locations::v2020_12_25', ({ target, payload }) => {
+                passedPayload = payload;
+                passedTarget = target;
+                return {
+                    locations: [],
+                };
+            });
+            yield action();
+            if (target) {
+                assert.isEqualDeep(passedTarget, target, 'Target missmatch');
+            }
+            if (payload) {
+                assert.isEqualDeep(passedPayload, payload, 'Payload missmatch');
+            }
+        });
+    },
+    configurationEquals(vc, options) {
+        const spyVc = vc;
+        const keys = Object.keys(options);
+        for (const key of keys) {
+            assert.isEqualDeep(spyVc.constructorOptions[key], options[key], 'Missmatch on ' + key);
+        }
+    },
+};
+export class SpyLocationListCard extends LocationListCardViewController {
+    constructor(options) {
+        super(options);
+        this.constructorOptions = options;
+    }
+}
+export default locationListCardAssert;

package/build/esm/viewControllers/LocationListCard.vc.d.ts

@@ -10,14 +10,15 @@ export default class LocationListCardViewController extends AbstractViewControll
     constructor(options: LocationListCardViewControllerOptions & ViewControllerOptions);
     private ActiveRecordCardVc;
     private renderRow;
-    selectLocation(id: string): void;
+    selectLocation(id: string): Promise<void>;
     private handleClickLocation;
     private handleDeleteLocation;
     getCardVc(): import("@sprucelabs/heartwood-view-controllers").CardViewController;
     getActiveRecordVc(): ActiveRecordCardViewController;
     getSelectedLocationId(): string | undefined;
     getListVc(): import("@sprucelabs/heartwood-view-controllers").ListViewController;
-    load(): Promise<void>;
+    load(targetAndPayload?: LocationListLoadOptions): Promise<void>;
+    getIsLoaded(): boolean;
     render(): SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
 }
 type OnDeleteHandler = (location: Location) => void;
@@ -25,10 +26,11 @@ type OnEditHandler = (location: Location) => void;
 export type LocationListCardViewControllerOptions = {
     onDelete?: OnDeleteHandler;
     onClick?: OnEditHandler;
-    currentOrganizationId: string;
+    currentOrganizationId?: string;
     selectedLocationId?: string;
     footerButtons?: Button[];
     shouldRenderDeleteButtons?: boolean;
     id?: string;
 };
+export type LocationListLoadOptions = SpruceSchemas.Mercury.v2020_12_25.ListLocationsEmitTargetAndPayload;
 export {};

package/build/esm/viewControllers/LocationListCard.vc.js

@@ -55,6 +55,15 @@ class LocationListCardViewController extends AbstractViewController {
                 },
             },
         ];
+        if (!this.onClickHandler) {
+            cells.unshift({
+                id: 'checkbox',
+                checkboxInput: {
+                    name: 'isSelected',
+                    isInteractive: false,
+                },
+            });
+        }
         if (this.shouldRenderDeleteButtons) {
             cells.push({
                 button: {
@@ -75,8 +84,19 @@ class LocationListCardViewController extends AbstractViewController {
         };
     }
     selectLocation(id) {
-        this.selectedLocationId = id;
-        this.activeRecordCardVc.setSelectedRows([id]);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.selectedLocationId === id) {
+                return;
+            }
+            if (this.selectedLocationId) {
+                const rowVc = this.activeRecordCardVc.getRowVc(this.selectedLocationId);
+                yield rowVc.setValue('isSelected', false);
+            }
+            this.selectedLocationId = id;
+            this.activeRecordCardVc.setSelectedRows([id]);
+            const rowVc = this.activeRecordCardVc.getRowVc(id);
+            yield rowVc.setValue('isSelected', true);
+        });
     }
     handleClickLocation(location) {
         var _a;
@@ -85,7 +105,7 @@ class LocationListCardViewController extends AbstractViewController {
                 (_a = this.onClickHandler) === null || _a === void 0 ? void 0 : _a.call(this, location);
                 return;
             }
-            this.selectLocation(location.id);
+            yield this.selectLocation(location.id);
         });
     }
     handleDeleteLocation(location) {
@@ -130,11 +150,21 @@ class LocationListCardViewController extends AbstractViewController {
     getListVc() {
         return this.activeRecordCardVc.getListVc();
     }
-    load() {
+    load(targetAndPayload) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { target, payload } = targetAndPayload !== null && targetAndPayload !== void 0 ? targetAndPayload : {};
+            if (target) {
+                this.activeRecordCardVc.setTarget(target);
+            }
+            if (payload) {
+                this.activeRecordCardVc.setPayload(payload);
+            }
             yield this.activeRecordCardVc.load();
         });
     }
+    getIsLoaded() {
+        return this.activeRecordCardVc.getIsLoaded();
+    }
     render() {
         return this.activeRecordCardVc.render();
     }

package/build/index-module.d.ts

@@ -1,3 +1,5 @@
 export { default as organizationAssert } from './tests/organizationAssert';
 export { default as LocationListCardViewController } from './viewControllers/LocationListCard.vc';
+export { default as locationListCardAssert } from './tests/locationListCardAssert';
+export * from './tests/locationListCardAssert';
 export * from './types-module';

package/build/index-module.js

@@ -17,9 +17,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocationListCardViewController = exports.organizationAssert = void 0;
+exports.locationListCardAssert = exports.LocationListCardViewController = exports.organizationAssert = void 0;
 var organizationAssert_1 = require("./tests/organizationAssert");
 Object.defineProperty(exports, "organizationAssert", { enumerable: true, get: function () { return __importDefault(organizationAssert_1).default; } });
 var LocationListCard_vc_1 = require("./viewControllers/LocationListCard.vc");
 Object.defineProperty(exports, "LocationListCardViewController", { enumerable: true, get: function () { return __importDefault(LocationListCard_vc_1).default; } });
+var locationListCardAssert_1 = require("./tests/locationListCardAssert");
+Object.defineProperty(exports, "locationListCardAssert", { enumerable: true, get: function () { return __importDefault(locationListCardAssert_1).default; } });
+__exportStar(require("./tests/locationListCardAssert"), exports);
 __exportStar(require("./types-module"), exports);

package/build/tests/locationListCardAssert.d.ts

@@ -0,0 +1,16 @@
+import { Card, SpruceSchemas, ViewController, ViewControllerOptions } from '@sprucelabs/heartwood-view-controllers';
+import { ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+import LocationListCardViewController, { LocationListCardViewControllerOptions as LocationListCardOptions } from '../viewControllers/LocationListCard.vc';
+declare const locationListCardAssert: {
+    beforeEach(views: Pick<ViewFixture, 'setController'>): void;
+    loadsWithTargetAndPayload(options: LoadsWithTargetAndPayloadOptions): Promise<void>;
+    configurationEquals(vc: ViewController<Card>, options: LocationListCardOptions): void;
+};
+export declare class SpyLocationListCard extends LocationListCardViewController {
+    constructorOptions: LocationListCardOptions;
+    constructor(options: ViewControllerOptions & LocationListCardOptions);
+}
+export type LoadsWithTargetAndPayloadOptions = Partial<SpruceSchemas.Mercury.v2020_12_25.ListLocationsEmitTargetAndPayload> & {
+    action: () => Promise<void> | void;
+};
+export default locationListCardAssert;

package/build/tests/locationListCardAssert.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpyLocationListCard = void 0;
+const spruce_test_fixtures_1 = require("@sprucelabs/spruce-test-fixtures");
+const test_utils_1 = require("@sprucelabs/test-utils");
+const LocationListCard_vc_1 = __importDefault(require("../viewControllers/LocationListCard.vc"));
+const locationListCardAssert = {
+    beforeEach(views) {
+        views.setController('locations.list-card', SpyLocationListCard);
+    },
+    async loadsWithTargetAndPayload(options) {
+        const { action, target, payload } = options;
+        let passedTarget;
+        let passedPayload;
+        await spruce_test_fixtures_1.eventFaker.on('list-locations::v2020_12_25', ({ target, payload }) => {
+            passedPayload = payload;
+            passedTarget = target;
+            return {
+                locations: [],
+            };
+        });
+        await action();
+        if (target) {
+            test_utils_1.assert.isEqualDeep(passedTarget, target, 'Target missmatch');
+        }
+        if (payload) {
+            test_utils_1.assert.isEqualDeep(passedPayload, payload, 'Payload missmatch');
+        }
+    },
+    configurationEquals(vc, options) {
+        const spyVc = vc;
+        const keys = Object.keys(options);
+        for (const key of keys) {
+            test_utils_1.assert.isEqualDeep(spyVc.constructorOptions[key], options[key], 'Missmatch on ' + key);
+        }
+    },
+};
+class SpyLocationListCard extends LocationListCard_vc_1.default {
+    constructor(options) {
+        super(options);
+        this.constructorOptions = options;
+    }
+}
+exports.SpyLocationListCard = SpyLocationListCard;
+exports.default = locationListCardAssert;

package/build/viewControllers/LocationListCard.vc.d.ts

@@ -10,14 +10,15 @@ export default class LocationListCardViewController extends AbstractViewControll
     constructor(options: LocationListCardViewControllerOptions & ViewControllerOptions);
     private ActiveRecordCardVc;
     private renderRow;
-    selectLocation(id: string): void;
+    selectLocation(id: string): Promise<void>;
     private handleClickLocation;
     private handleDeleteLocation;
     getCardVc(): import("@sprucelabs/heartwood-view-controllers").CardViewController;
     getActiveRecordVc(): ActiveRecordCardViewController;
     getSelectedLocationId(): string | undefined;
     getListVc(): import("@sprucelabs/heartwood-view-controllers").ListViewController;
-    load(): Promise<void>;
+    load(targetAndPayload?: LocationListLoadOptions): Promise<void>;
+    getIsLoaded(): boolean;
     render(): SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
 }
 type OnDeleteHandler = (location: Location) => void;
@@ -25,10 +26,11 @@ type OnEditHandler = (location: Location) => void;
 export type LocationListCardViewControllerOptions = {
     onDelete?: OnDeleteHandler;
     onClick?: OnEditHandler;
-    currentOrganizationId: string;
+    currentOrganizationId?: string;
     selectedLocationId?: string;
     footerButtons?: Button[];
     shouldRenderDeleteButtons?: boolean;
     id?: string;
 };
+export type LocationListLoadOptions = SpruceSchemas.Mercury.v2020_12_25.ListLocationsEmitTargetAndPayload;
 export {};

package/build/viewControllers/LocationListCard.vc.js

@@ -48,6 +48,15 @@ class LocationListCardViewController extends heartwood_view_controllers_1.Abstra
                 },
             },
         ];
+        if (!this.onClickHandler) {
+            cells.unshift({
+                id: 'checkbox',
+                checkboxInput: {
+                    name: 'isSelected',
+                    isInteractive: false,
+                },
+            });
+        }
         if (this.shouldRenderDeleteButtons) {
             cells.push({
                 button: {
@@ -67,9 +76,18 @@ class LocationListCardViewController extends heartwood_view_controllers_1.Abstra
             cells,
         };
     }
-    selectLocation(id) {
+    async selectLocation(id) {
+        if (this.selectedLocationId === id) {
+            return;
+        }
+        if (this.selectedLocationId) {
+            const rowVc = this.activeRecordCardVc.getRowVc(this.selectedLocationId);
+            await rowVc.setValue('isSelected', false);
+        }
         this.selectedLocationId = id;
         this.activeRecordCardVc.setSelectedRows([id]);
+        const rowVc = this.activeRecordCardVc.getRowVc(id);
+        await rowVc.setValue('isSelected', true);
     }
     async handleClickLocation(location) {
         var _a;
@@ -77,7 +95,7 @@ class LocationListCardViewController extends heartwood_view_controllers_1.Abstra
             (_a = this.onClickHandler) === null || _a === void 0 ? void 0 : _a.call(this, location);
             return;
         }
-        this.selectLocation(location.id);
+        await this.selectLocation(location.id);
     }
     async handleDeleteLocation(location) {
         var _a;
@@ -119,9 +137,19 @@ class LocationListCardViewController extends heartwood_view_controllers_1.Abstra
     getListVc() {
         return this.activeRecordCardVc.getListVc();
     }
-    async load() {
+    async load(targetAndPayload) {
+        const { target, payload } = targetAndPayload !== null && targetAndPayload !== void 0 ? targetAndPayload : {};
+        if (target) {
+            this.activeRecordCardVc.setTarget(target);
+        }
+        if (payload) {
+            this.activeRecordCardVc.setPayload(payload);
+        }
         await this.activeRecordCardVc.load();
     }
+    getIsLoaded() {
+        return this.activeRecordCardVc.getIsLoaded();
+    }
     render() {
         return this.activeRecordCardVc.render();
     }

package/package.json

@@ -1,47 +1,51 @@
 {
-  "name": "@sprucelabs/spruce-location-utils",
-  "description": "Location Utilities",
-  "version": "9.2.0",
-  "skill": {
-    "namespace": "locations"
-  },
-  "homepage": "https://github.com/sprucelabsai/spruce-locations-skill",
-  "bugs": {
-    "url": "https://github.com/sprucelabsai/spruce-locations-skill/issues"
-  },
-  "main": "./build/index-module.js",
-  "types": "./build/index-module.d.ts",
-  "module": "./build/esm/index-module.js",
-  "sideEffects": false,
-  "files": [
-    "build/index-module.js",
-    "build/index-module.d.ts",
-    "build/tests/organizationAssert.js",
-    "build/tests/organizationAssert.d.ts",
-    "build/viewControllers/LocationListCard.vc.js",
-    "build/viewControllers/LocationListCard.vc.d.ts",
-    "build/esm/index-module.js",
-    "build/esm/index-module.d.ts",
-    "build/esm/tests/organizationAssert.js",
-    "build/esm/tests/organizationAssert.d.ts",
-    "build/esm/viewControllers/LocationListCard.vc.js",
-    "build/esm/viewControllers/LocationListCard.vc.d.ts",
-    "build/types-module.js",
-    "build/types-module.d.ts",
-    "build/esm/types-module.js",
-    "build/esm/types-module.d.ts"
-  ],
-  "keywords": [],
-  "scripts": {
-    "release": "npm publish"
-  },
-  "dependencies": {
-    "@sprucelabs/heartwood-view-controllers": "latest",
-    "@sprucelabs/spruce-event-utils": "latest",
-    "@sprucelabs/spruce-test-fixtures": "latest",
-    "@sprucelabs/test-utils": "latest"
-  },
-  "engines": {
-    "yarn": "1.x"
-  }
-}
+	"name": "@sprucelabs/spruce-location-utils",
+	"description": "Location Utilities",
+	"version": "9.4.0",
+	"skill": {
+		"namespace": "locations"
+	},
+	"homepage": "https://github.com/sprucelabsai/spruce-locations-skill",
+	"bugs": {
+		"url": "https://github.com/sprucelabsai/spruce-locations-skill/issues"
+	},
+	"main": "./build/index-module.js",
+	"types": "./build/index-module.d.ts",
+	"module": "./build/esm/index-module.js",
+	"sideEffects": false,
+	"files": [
+		"build/index-module.js",
+		"build/index-module.d.ts",
+		"build/tests/organizationAssert.js",
+		"build/tests/organizationAssert.d.ts",
+		"build/esm/tests/organizationAssert.js",
+		"build/esm/tests/organizationAssert.d.ts",
+		"build/viewControllers/LocationListCard.vc.js",
+		"build/viewControllers/LocationListCard.vc.d.ts",
+		"build/esm/index-module.js",
+		"build/esm/index-module.d.ts",
+		"build/esm/viewControllers/LocationListCard.vc.js",
+		"build/esm/viewControllers/LocationListCard.vc.d.ts",
+		"build/types-module.js",
+		"build/types-module.d.ts",
+		"build/esm/types-module.js",
+		"build/esm/types-module.d.ts",
+		"build/tests/locationListCardAssert.js",
+		"build/tests/locationListCardAssert.d.ts",
+		"build/esm/tests/locationListCardAssert.js",
+		"build/esm/tests/locationListCardAssert.d.ts"
+	],
+	"keywords": [],
+	"scripts": {
+		"release": "npm publish"
+	},
+	"dependencies": {
+		"@sprucelabs/heartwood-view-controllers": "latest",
+		"@sprucelabs/spruce-event-utils": "latest",
+		"@sprucelabs/spruce-test-fixtures": "latest",
+		"@sprucelabs/test-utils": "latest"
+	},
+	"engines": {
+		"yarn": "1.x"
+	}
+}