stentor-models 1.60.1 → 1.60.5

package/lib/Form/FormField.d.ts

@@ -1,4 +1,5 @@
 /*! Copyright (c) 2024, XAPP AI */
+import { DayOfWeek } from "../Services";
 export interface AddressAutocompleteParameters {
     /**
      * This will look like components=country:us or components=country:us|country:ca
@@ -125,8 +126,14 @@ export interface FormCardInput extends FormInput {
     align?: string;
 }
 export interface BusyDayDescription {
+    /**
+     * The days of the week that are available for appointments.
+     */
+    readonly availableDays?: DayOfWeek[];
     /**
      * Blocks all weekends
+     *
+     * If provided, it will override the availableDays.
      */
     readonly blockWeekends?: boolean;
     /**
@@ -136,10 +143,16 @@ export interface BusyDayDescription {
      * If it is a weekend and weekends are blocked, the it will be disregarded.
      */
     readonly blockCurrentDay?: boolean;
+    /**
+     * Blocks the current day until the specified time.  This is in the format of HH:MM.
+     */
+    readonly currentDayAvailableUntil?: string;
     /**
      * Blocks the next number of business days.
      *
      * One business day will bock the next business day.
+     *
+     * If this is set, it will override the availableDays, blockWeekends, and blockCurrentDay.
      */
     readonly blockNextBusinessDays?: number;
 }

package/lib/Form/FormStep.d.ts

@@ -1,5 +1,25 @@
 /*! Copyright (c) 2024, XAPP AI */
 import { FormField } from "./FormField";
+export type FormSteps = FormStep | FormStepIFrame;
+export interface FormStepIFrame extends FormStep {
+    /**
+     * An iframe step is a form step that is rendered as an iframe.
+     */
+    iframe: {
+        /**
+         * The source of the iframe.
+         */
+        src: string;
+        /**
+         * Optional width, defaults to 100%
+         */
+        width?: string;
+        /**
+         * Optional height, defaults to 100%
+         */
+        height?: string;
+    };
+}
 /**
  * A step is partial form. Fields plus next/prev/submit buttons as needed.
  * We are going through these "mini screens".
@@ -7,11 +27,34 @@ import { FormField } from "./FormField";
 export interface FormStep {
     name: string;
     title?: string;
+    /**
+     * The fields that are part of the form.
+     */
     fields: FormField[];
     condition?: string;
+    /**
+     * The action to take when the user clicks the next button.
+     *
+     * "next": move to the next step
+     * "submit": force "Next" instead of "Submit" (server generated next step).
+     * "omit": don't show the next button (for instance final "Thank you screen")
+     */
     nextAction?: "next" | "submit" | "omit";
+    /**
+     * The action to take when the user clicks the previous button.
+     *
+     * "previous": move to the previous step
+     * "submit": force "Previous" instead of "Submit" (server generated previous step).
+     * "omit": don't show the previous button (for instance first step)
+     */
     previousAction?: "previous" | "submit" | "omit";
+    /**
+     * The label to use for the next button, defaults to "Next".
+     */
     nextLabel?: string;
+    /**
+     * The label to use for the previous button, defaults to "Previous".
+     */
     previousLabel?: string;
     final?: boolean;
     crmSubmit?: boolean;

package/lib/Services/CrmService.d.ts

@@ -1,6 +1,7 @@
 /*! Copyright (c) 2022, XAPPmedia */
 import { CrmResponse, ExternalLead } from "../Crm";
 import { DateTime, DateTimeRange } from "../DateTime";
+import { BusyDayDescription } from "../Form";
 export type DayOfWeek = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
 export interface AvailabilityClass {
     /**
@@ -62,6 +63,10 @@ export interface CrmServiceAvailabilitySettings {
      * The default availability class (when the AI cannot figure it out)
      */
     defaultAvailabilityClass?: string;
+    /**
+     * The default busy days for the business.  This is used when the FSM/Scheduling backend does not provide busy days
+     */
+    defaultBusyDays?: BusyDayDescription;
 }
 export interface CrmServiceTimeAvailability {
     /**

package/lib/Services/CrmService.js

@@ -1,4 +1,5 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-unused-vars */
 /*! Copyright (c) 2022, XAPPmedia */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -26,25 +27,21 @@ class AbstractCrmService {
             this.delayedJobTypes = props.delayedJobTypes;
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     send(externalLead, extras) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error("Method not implemented.");
         });
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     getAvailability(range, options) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error("Method not implemented.");
         });
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     getJobType(message, externalLead) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error("Method not implemented.");
         });
     }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     update(externalLead, extras) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error("Method not implemented.");

package/lib/Services/CrmService.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;AAmLpC,MAAa,kBAAkB;IAU3B,YAAmB,KAAsB;QAErC,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACtB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAC7C,CAAC;QAED,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACzC,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ,EAAE,CAAC;YACtD,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC,yBAAyB,CAAC;QACrE,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,eAAe,EAAE,CAAC;YAC/B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QACjD,CAAC;IACL,CAAC;IAED,6DAA6D;IAChD,IAAI,CAAC,YAA0B,EAAE,MAAgC;;YAC1E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,6DAA6D;IAChD,eAAe,CAAC,KAAoB,EAAE,OAAuC;;YACtF,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,6DAA6D;IAChD,UAAU,CAAC,OAAe,EAAE,YAA2B;;YAChE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,6DAA6D;IAChD,MAAM,CAAE,YAA0B,EAAE,MAAgC;;YAC7E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;CACJ;AAhDD,gDAgDC"}
+{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;;;;;;;;;;;;AA4MpC,MAAa,kBAAkB;IAS7B,YAAmB,KAAsB;QACvC,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAC3C,CAAC;QAED,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ,EAAE,CAAC;YACxD,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC,yBAAyB,CAAC;QACnE,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,eAAe,EAAE,CAAC;YACjC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC/C,CAAC;IACH,CAAC;IAEY,IAAI,CACf,YAA0B,EAC1B,MAAgC;;YAEhC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEY,eAAe,CAC1B,KAAoB,EACpB,OAAuC;;YAEvC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEY,UAAU,CACrB,OAAe,EACf,YAA2B;;YAE3B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEY,MAAM,CACjB,YAA0B,EAC1B,MAAgC;;YAEhC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;KAAA;CACF;AAtDD,gDAsDC"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.60.1",
+  "version": "1.60.5",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -22,7 +22,7 @@
     "@xapp/config": "0.2.3",
     "rollup": "3.29.5",
     "tslib": "2.8.1",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "scripts": {
     "api": "api-extractor run --local",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.2"
   },
-  "gitHead": "bc5a0a7d9e22f85d95fe3f8e21879839431a29f5"
+  "gitHead": "7e4b5e2deeff473ee0c38816b1cca7f431bd5ffc"
 }