@sprucelabs/spruce-heartwood-utils 6.2.0 → 6.3.0

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

@@ -1 +1,2 @@
-export { default as RemoteViewControllerFactory } from './RemoteViewControllerFactory';
+export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory';
+export { default as CardRegistrar } from './viewControllers/CardRegistrar';

package/build/esm/index-module.js

@@ -1 +1,2 @@
-export { default as RemoteViewControllerFactory } from './RemoteViewControllerFactory.js';
+export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory.js';
+export { default as CardRegistrar } from './viewControllers/CardRegistrar.js';

package/build/esm/viewControllers/CardRegistrar.d.ts

@@ -0,0 +1,28 @@
+import { AbstractViewController, ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
+import { MercuryClient } from '@sprucelabs/mercury-client';
+import { EventContract, EventNames, SkillEventContract, SpruceSchemas } from '@sprucelabs/mercury-types';
+import { Schema, SchemaValues } from '@sprucelabs/schema';
+declare type Card = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+declare type ResponsePayload<Contract extends EventContract, Name extends EventNames<Contract>> = Contract['eventSignatures'][Name]['responsePayloadSchema'] extends Schema ? SchemaValues<Contract['eventSignatures'][Name]['responsePayloadSchema']> : never;
+declare type EmitPayload<Contract extends EventContract, Name extends EventNames<Contract>> = Contract['eventSignatures'][Name]['emitPayloadSchema'] extends Schema ? SchemaValues<Contract['eventSignatures'][Name]['emitPayloadSchema']> : never;
+export interface CardRegistrarOptions<Contract extends EventContract, Name extends EventNames<Contract>> {
+    client: MercuryClient;
+    eventName: Name;
+    vcFactory: ViewControllerFactory;
+    vcIdsTransformer: (payload: ResponsePayload<Contract, Name>) => string[];
+}
+export declare type EachCardHandler = (vcs: AbstractViewController<any>[]) => Promise<void> | void;
+export declare type CardFetchOptions<Contract extends EventContract, Name extends EventNames<Contract>> = {
+    each: EachCardHandler;
+} & EmitPayload<Contract, Name>;
+export default class CardRegistrar<
+/** @ts-ignore */
+Contract extends EventContract = SkillEventContract, Name extends EventNames<Contract> = EventNames<Contract>> {
+    private client;
+    private eventName;
+    private vcIdsTransformer;
+    private remoteVcFactory;
+    constructor(options: CardRegistrarOptions<Contract, Name>);
+    fetch(options?: CardFetchOptions<Contract, Name>): Promise<AbstractViewController<Card>[]>;
+}
+export {};

package/build/esm/viewControllers/CardRegistrar.js

@@ -0,0 +1,61 @@
+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 { assertOptions } from '@sprucelabs/schema';
+import RemoteViewControllerFactory from './RemoteViewControllerFactory.js';
+export default class CardRegistrar {
+    constructor(options) {
+        assertOptions(options, [
+            'client',
+            'eventName',
+            'vcFactory',
+            'vcIdsTransformer',
+        ]);
+        this.client = options.client;
+        this.eventName = options.eventName;
+        this.vcIdsTransformer = options.vcIdsTransformer;
+        this.remoteVcFactory = RemoteViewControllerFactory.Factory({
+            //@ts-ignore
+            connectToApi: () => options.client,
+            vcFactory: options.vcFactory,
+        });
+    }
+    fetch(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                //@ts-ignore
+                const { each, target, payload } = options !== null && options !== void 0 ? options : {};
+                const targetAndPayload = target || payload ? { target, payload } : undefined;
+                const cards = [];
+                yield this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, ({ payload }) => __awaiter(this, void 0, void 0, function* () {
+                    const vcIds = this.vcIdsTransformer(payload);
+                    const responseCards = [];
+                    for (const id of vcIds) {
+                        try {
+                            const vc = yield this.remoteVcFactory.RemoteController(id, {});
+                            responseCards.push(vc);
+                        }
+                        catch (err) {
+                            console.error(err);
+                        }
+                    }
+                    if (responseCards.length > 0) {
+                        each === null || each === void 0 ? void 0 : each(responseCards);
+                    }
+                    cards.push(...responseCards);
+                }));
+                return cards;
+            }
+            catch (err) {
+                console.error(err);
+                return [this.remoteVcFactory.Controller('heartwood.error-card', {})];
+            }
+        });
+    }
+}

package/build/{RemoteViewControllerFactory.d.ts → esm/viewControllers/RemoteViewControllerFactory.d.ts}

@@ -1,6 +1,6 @@
 import { ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
 import { MercuryClient } from '@sprucelabs/mercury-client';
-import { SkillTheme } from './ThemeManager';
+import { SkillTheme } from '../ThemeManager';
 declare type ConnectToApi = () => Promise<MercuryClient>;
 interface FactoryOptions {
     connectToApi: ConnectToApi;

package/build/index-module.d.ts

@@ -1 +1,2 @@
-export { default as RemoteViewControllerFactory } from './RemoteViewControllerFactory';
+export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory';
+export { default as CardRegistrar } from './viewControllers/CardRegistrar';

package/build/index-module.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteViewControllerFactory = void 0;
-var RemoteViewControllerFactory_1 = require("./RemoteViewControllerFactory");
+exports.CardRegistrar = exports.RemoteViewControllerFactory = void 0;
+var RemoteViewControllerFactory_1 = require("./viewControllers/RemoteViewControllerFactory");
 Object.defineProperty(exports, "RemoteViewControllerFactory", { enumerable: true, get: function () { return __importDefault(RemoteViewControllerFactory_1).default; } });
+var CardRegistrar_1 = require("./viewControllers/CardRegistrar");
+Object.defineProperty(exports, "CardRegistrar", { enumerable: true, get: function () { return __importDefault(CardRegistrar_1).default; } });
 //# sourceMappingURL=index-module.js.map

package/build/viewControllers/CardRegistrar.d.ts

@@ -0,0 +1,28 @@
+import { AbstractViewController, ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
+import { MercuryClient } from '@sprucelabs/mercury-client';
+import { EventContract, EventNames, SkillEventContract, SpruceSchemas } from '@sprucelabs/mercury-types';
+import { Schema, SchemaValues } from '@sprucelabs/schema';
+declare type Card = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+declare type ResponsePayload<Contract extends EventContract, Name extends EventNames<Contract>> = Contract['eventSignatures'][Name]['responsePayloadSchema'] extends Schema ? SchemaValues<Contract['eventSignatures'][Name]['responsePayloadSchema']> : never;
+declare type EmitPayload<Contract extends EventContract, Name extends EventNames<Contract>> = Contract['eventSignatures'][Name]['emitPayloadSchema'] extends Schema ? SchemaValues<Contract['eventSignatures'][Name]['emitPayloadSchema']> : never;
+export interface CardRegistrarOptions<Contract extends EventContract, Name extends EventNames<Contract>> {
+    client: MercuryClient;
+    eventName: Name;
+    vcFactory: ViewControllerFactory;
+    vcIdsTransformer: (payload: ResponsePayload<Contract, Name>) => string[];
+}
+export declare type EachCardHandler = (vcs: AbstractViewController<any>[]) => Promise<void> | void;
+export declare type CardFetchOptions<Contract extends EventContract, Name extends EventNames<Contract>> = {
+    each: EachCardHandler;
+} & EmitPayload<Contract, Name>;
+export default class CardRegistrar<
+/** @ts-ignore */
+Contract extends EventContract = SkillEventContract, Name extends EventNames<Contract> = EventNames<Contract>> {
+    private client;
+    private eventName;
+    private vcIdsTransformer;
+    private remoteVcFactory;
+    constructor(options: CardRegistrarOptions<Contract, Name>);
+    fetch(options?: CardFetchOptions<Contract, Name>): Promise<AbstractViewController<Card>[]>;
+}
+export {};

package/build/viewControllers/CardRegistrar.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const RemoteViewControllerFactory_1 = __importDefault(require("./RemoteViewControllerFactory"));
+class CardRegistrar {
+    constructor(options) {
+        (0, schema_1.assertOptions)(options, [
+            'client',
+            'eventName',
+            'vcFactory',
+            'vcIdsTransformer',
+        ]);
+        this.client = options.client;
+        this.eventName = options.eventName;
+        this.vcIdsTransformer = options.vcIdsTransformer;
+        this.remoteVcFactory = RemoteViewControllerFactory_1.default.Factory({
+            //@ts-ignore
+            connectToApi: () => options.client,
+            vcFactory: options.vcFactory,
+        });
+    }
+    async fetch(options) {
+        try {
+            //@ts-ignore
+            const { each, target, payload } = options !== null && options !== void 0 ? options : {};
+            const targetAndPayload = target || payload ? { target, payload } : undefined;
+            const cards = [];
+            await this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, async ({ payload }) => {
+                const vcIds = this.vcIdsTransformer(payload);
+                const responseCards = [];
+                for (const id of vcIds) {
+                    try {
+                        const vc = await this.remoteVcFactory.RemoteController(id, {});
+                        responseCards.push(vc);
+                    }
+                    catch (err) {
+                        console.error(err);
+                    }
+                }
+                if (responseCards.length > 0) {
+                    each === null || each === void 0 ? void 0 : each(responseCards);
+                }
+                cards.push(...responseCards);
+            });
+            return cards;
+        }
+        catch (err) {
+            console.error(err);
+            return [this.remoteVcFactory.Controller('heartwood.error-card', {})];
+        }
+    }
+}
+exports.default = CardRegistrar;
+//# sourceMappingURL=CardRegistrar.js.map

package/build/viewControllers/RemoteViewControllerFactory.d.ts

@@ -0,0 +1,25 @@
+import { ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
+import { MercuryClient } from '@sprucelabs/mercury-client';
+import { SkillTheme } from '../ThemeManager';
+declare type ConnectToApi = () => Promise<MercuryClient>;
+interface FactoryOptions {
+    connectToApi: ConnectToApi;
+    vcFactory: ViewControllerFactory;
+}
+declare type Factory = Pick<ViewControllerFactory, 'hasController'>;
+export default class RemoteViewControllerFactory implements Factory {
+    private connectToApi;
+    private vcFactory;
+    private themesByNamespace;
+    static Factory(options: FactoryOptions): RemoteViewControllerFactory;
+    private constructor();
+    hasController(name: string): boolean;
+    getTheme(namespace?: string): SkillTheme;
+    Controller(name: string, options: Record<string, any>): any;
+    private getNamespace;
+    getController(name: string): any;
+    fetchRemoteController(name: string): Promise<any>;
+    RemoteController(name: string, options: Record<string, any>): Promise<any>;
+    private optionallLoadController;
+}
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sprucelabs/spruce-heartwood-utils",
   "description": "Heartwood Utilities",
-  "version": "6.2.0",
+  "version": "6.3.0",
   "skill": {
     "namespace": "heartwood"
   },
@@ -18,10 +18,14 @@
     "build/index-module.d.ts",
     "build/esm/index-module.js",
     "build/esm/index-module.d.ts",
-    "build/RemoteViewControllerFactory.js",
-    "build/RemoteViewControllerFactory.d.ts",
-    "build/esm/RemoteViewControllerFactory.js",
-    "build/esm/romoteViewContorllerFactory.d.ts",
+    "build/viewControllers/RemoteViewControllerFactory.js",
+    "build/viewControllers/RemoteViewControllerFactory.d.ts",
+    "build/esm/viewControllers/RemoteViewControllerFactory.js",
+    "build/esm/viewControllers/RemoteViewControllerFactory.d.ts",
+    "build/viewControllers/CardRegistrar.js",
+    "build/viewControllers/CardRegistrar.d.ts",
+    "build/esm/viewControllers/CardRegistrar.js",
+    "build/esm/viewControllers/CardRegistrar.d.ts",
     "build/ThemeManager.js",
     "build/ThemeManager.d.ts",
     "build/esm/ThemeManager.js",