stentor-models 1.72.3 → 1.73.0

package/lib/Form/FormField.d.ts

@@ -132,6 +132,11 @@ export interface FormFieldTextAddressInput extends FormTextInput {
      * Not needed if using a custom proxy endpoint that handles authentication.
      */
     googleMapsApiKey?: string;
+    /**
+     * When true, the user must select an address from the autocomplete suggestions.
+     * Free-text entry is not allowed. Defaults to false (free-text allowed).
+     */
+    requireSelection?: boolean;
 }
 /**
  * Text input field with optional validation and formatting.
@@ -317,9 +322,17 @@ export interface BusyDayDescription {
      */
     readonly blockCurrentDay?: boolean;
     /**
-     * Blocks the current day until the specified time. This is in the format of HH:MM.
+     * The current day stays available *until* the specified time, in HH:MM (24-hour) format.
+     *
+     * For example, "14:00" keeps today bookable up to 2:00 PM; after that, today is no longer offered.
+     *
+     * NOTE: the previous doc comment here described the inverse ("unavailable until 2:00 PM"). It was
+     * wrong: consumers disable the current day once the current time is past this value, and the Studio
+     * UI ("same-day booking allowed until…") has always matched that behavior rather than the old
+     * comment. Corrected here so the semantics cannot be implemented backwards downstream.
      *
-     * For example, "14:00" would make the current day unavailable until 2:00 PM.
+     * Same meaning as AvailabilityClass.currentDayAvailableUntil, which overrides this for jobs
+     * resolved to a class.
      */
     readonly currentDayAvailableUntil?: string;
     /**

package/lib/Services/CrmService.d.ts

@@ -34,6 +34,42 @@ export interface AvailabilityClass {
      * If true, this availability class is only for leads and not for appointments as they typically require more information and followup.
      */
     leadOnly?: boolean;
+    /**
+     * The current day stays available *until* this time, in HH:MM (24-hour) format, wall-clock in the
+     * business timezone.
+     *
+     * For example, "16:00" lets a job in this class still be booked for today up to 4:00 PM; at or after
+     * 4:00 PM, today is no longer offered. Same meaning as BusyDayDescription.currentDayAvailableUntil,
+     * which this overrides for jobs resolved to this class.
+     *
+     * Only meaningful when numberOfDaysOut is 0 or absent (i.e. same-day is possible at all).
+     */
+    currentDayAvailableUntil?: string;
+}
+/**
+ * A deterministic mapping from an FSM/CRM job type to an availability class.
+ *
+ * This is the symmetric counterpart to CrmServiceAvailabilitySettings.delayedJobTypes, which is
+ * also keyed on the FSM job-type id: delayedJobTypes pushes a job type further out, this maps a
+ * job type onto a class (which may pull it in — e.g. same-day for emergency work).
+ */
+export interface JobTypeAvailabilityClass {
+    /**
+     * The FSM/CRM job type id, stringified (ServiceTitan job type ids are numbers).
+     */
+    jobTypeId: string;
+    /**
+     * AvailabilityClass.id
+     */
+    classId: string;
+    /**
+     * Denormalized for display in Studio. Not used for matching.
+     */
+    jobTypeName?: string;
+    /**
+     * Provenance: "AI" = suggested by the class suggester, "USER" = confirmed/edited by a human.
+     */
+    source?: "AI" | "USER";
 }
 /**
  * Settings for the availability of the CRM service.
@@ -67,6 +103,18 @@ export interface CrmServiceAvailabilitySettings {
      * The default busy days for the business.  This is used when the FSM/Scheduling backend does not provide busy days
      */
     defaultBusyDays?: BusyDayDescription;
+    /**
+     * Deterministic job type -> class mapping. Beats the LLM's guess.
+     */
+    jobTypeClasses?: JobTypeAvailabilityClass[];
+    /**
+     * Forces every booking in this scope into the given class, regardless of job type.
+     *
+     * This is deliberately NOT defaultAvailabilityClass: that field is a *fallback* (it loses to
+     * jobType.class), so it cannot express "force". Used by campaign booking widgets, which carry
+     * their own availability settings.
+     */
+    forceAvailabilityClass?: string;
 }
 export interface CrmServiceTimeAvailability {
     /**
@@ -165,8 +213,25 @@ export interface CrmService {
      * Returns the job type (id) for the free text job description (AI call usually)
      *
      * @param message
+     * @param externalLead
+     * @param options Availability settings in scope for this request (e.g. a widget's
+     * forceAvailabilityClass or jobTypeClasses), needed to resolve the job type's class.
+     *
+     * Deliberately typed as the settings-only CrmServiceAvailabilitySettings rather than
+     * CrmServiceAvailabilityOptions: this method *determines* the job type, so the `jobType` member of
+     * the Options type would be meaningless (and misleading) here.
+     */
+    getJobType?(message: string, externalLead?: ExternalLead, options?: CrmServiceAvailabilitySettings): Promise<CrmServiceJobType>;
+    /**
+     * Lists the tenant's job types from the FSM. Backs a Studio picker.
+     */
+    listJobTypes?(): Promise<CrmServiceJobType[]>;
+    /**
+     * Returns a suggested job-type -> class map. Does not persist anything.
+     *
+     * @param availabilityClasses
      */
-    getJobType(message: string, externalLead?: ExternalLead): Promise<CrmServiceJobType>;
+    suggestJobTypeClasses?(availabilityClasses?: AvailabilityClass[]): Promise<JobTypeAvailabilityClass[]>;
 }
 export type CrmServiceProps = CrmServiceAvailabilitySettings;
 export declare class AbstractCrmService implements CrmService {
@@ -177,6 +242,6 @@ export declare class AbstractCrmService implements CrmService {
     constructor(props: CrmServiceProps);
     send(externalLead: ExternalLead, extras?: Record<string, unknown>): Promise<CrmResponse>;
     getAvailability(range: DateTimeRange, options?: CrmServiceAvailabilityOptions): Promise<CrmServiceAvailability>;
-    getJobType(message: string, externalLead?: ExternalLead): Promise<CrmServiceJobType>;
+    getJobType(message: string, externalLead?: ExternalLead, options?: CrmServiceAvailabilitySettings): Promise<CrmServiceJobType>;
     update?(externalLead: ExternalLead, extras?: Record<string, unknown>): Promise<CrmResponse>;
 }

package/lib/Services/CrmService.js

@@ -23,7 +23,7 @@ class AbstractCrmService {
         if (typeof props.maxTotalDailyAppointments === "number") {
             this.maxTotalDailyAppointments = props.maxTotalDailyAppointments;
         }
-        if (typeof props.delayedJobTypes) {
+        if (props.delayedJobTypes) {
             this.delayedJobTypes = props.delayedJobTypes;
         }
     }
@@ -44,7 +44,7 @@ class AbstractCrmService {
             };
         });
     }
-    getJobType(message, externalLead) {
+    getJobType(message, externalLead, options) {
         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,sDAAsD;AACtD,oCAAoC;;;;;;;;;;;;AA6MpC,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,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAC1C,MAAM,QAAQ,GAAG,uCAAuC,WAAW,EAAE,CAAC;YAEtE,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,6DAA6D,CAAC,CAAC;YAEvF,4DAA4D;YAC5D,OAAO;gBACL,KAAK;gBACL,gBAAgB,EAAE,EAAE;aACrB,CAAC;QACJ,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;AA/DD,gDA+DC"}
+{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;;;;;;;;;;;;AAkRpC,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,KAAK,CAAC,eAAe,EAAE,CAAC;YAC1B,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,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAC1C,MAAM,QAAQ,GAAG,uCAAuC,WAAW,EAAE,CAAC;YAEtE,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,6DAA6D,CAAC,CAAC;YAEvF,4DAA4D;YAC5D,OAAO;gBACL,KAAK;gBACL,gBAAgB,EAAE,EAAE;aACrB,CAAC;QACJ,CAAC;KAAA;IAEY,UAAU,CACrB,OAAe,EACf,YAA2B,EAC3B,OAAwC;;YAExC,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;AAhED,gDAgEC"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.72.3",
+  "version": "1.73.0",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -17,7 +17,7 @@
     "node": "^12 || ^14 || ^16 || ^18 || ^20 || ^22 || ^24.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "7.58.7",
+    "@microsoft/api-extractor": "7.58.9",
     "@rollup/plugin-typescript": "12.3.0",
     "@xapp/config": "0.3.0",
     "rollup": "3.30.0",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.3"
   },
-  "gitHead": "738b0b77099bc3f8590257bc7ab9e0da2b41d502"
+  "gitHead": "179d4c04b58ab103248ac0c7d4d44f8ce4c7d2d4"
 }