stentor-models 1.59.86 → 1.59.89

package/lib/Display/MultistepForm.d.ts

@@ -0,0 +1,20 @@
+/*! Copyright (c) 2024, XAPP AI */
+import { FormStep } from "../Form";
+import { BaseDisplay } from "./Types";
+/**
+ * This is for the top header. The "step" is the name of the step the click should take to.
+ */
+export interface FormHeaderItem {
+    label: string;
+    step: string;
+}
+/**
+ * FORM Display type
+ */
+export interface MultistepForm extends BaseDisplay {
+    type: "FORM";
+    name: string;
+    header: FormHeaderItem[];
+    labelHeader: boolean;
+    steps: FormStep[];
+}

package/lib/Display/MultistepForm.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MultistepForm.js.map

package/lib/Display/MultistepForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultistepForm.js","sourceRoot":"","sources":["../../src/Display/MultistepForm.ts"],"names":[],"mappings":""}

package/lib/Display/Types.d.ts

@@ -1,10 +1,11 @@
 /*! Copyright (c) 2019, XAPPmedia */
 import { Card } from "./Card";
 import { List } from "./List";
+import { MultistepForm } from "./MultistepForm";
 import { SimpleDisplay } from "./SimpleDisplay";
 export interface BaseDisplay {
     type: string;
     token?: string;
     title?: string;
 }
-export type Display = Card | List | SimpleDisplay | object;
+export type Display = Card | List | SimpleDisplay | MultistepForm | object;

package/lib/Display/index.d.ts

@@ -2,6 +2,7 @@
 export * from "./Card";
 export * from "./Image";
 export * from "./List";
+export * from "./MultistepForm";
 export * from "./SimpleDisplay";
 export * from "./TextContent";
 export * from "./Types";

package/lib/Display/index.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Card"), exports);
 __exportStar(require("./Image"), exports);
 __exportStar(require("./List"), exports);
+__exportStar(require("./MultistepForm"), exports);
 __exportStar(require("./SimpleDisplay"), exports);
 __exportStar(require("./TextContent"), exports);
 __exportStar(require("./Types"), exports);

package/lib/Display/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Display/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,yCAAuB;AACvB,0CAAwB;AACxB,yCAAuB;AACvB,kDAAgC;AAChC,gDAA8B;AAC9B,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Display/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,yCAAuB;AACvB,0CAAwB;AACxB,yCAAuB;AACvB,kDAAgC;AAChC,kDAAgC;AAChC,gDAA8B;AAC9B,0CAAwB"}

package/lib/Form/FormField.d.ts

@@ -0,0 +1,158 @@
+/*! Copyright (c) 2024, XAPP AI */
+export interface AddressAutocompleteParameters {
+    /**
+     * This will look like components=country:us or components=country:us|country:ca
+     *
+     * @see https://developers.google.com/maps/documentation/places/web-service/autocomplete#components
+     */
+    components?: string;
+    /**
+     * The text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.
+     */
+    language?: string;
+    /**
+     * A text that is the lat & long of the location to use as the center of the search.
+     *
+     * For example, location=37.76999,-122.44696
+     */
+    location?: string;
+    locationbias?: string;
+    locationrestriction?: string;
+    /**
+     * When using location with a specific lat & long, this must be provided.
+     *
+     * This is in meters
+     */
+    radius?: string;
+    /**
+     * The API key, only required when using the official Google Maps API.
+     */
+    key?: string;
+}
+export type FormField = FormCardInput | FormTextInput | FormDropdownInput | FormChipsInput | FormDateInput | FormDateRangeInput;
+/**
+ * Form field base class
+ */
+export interface FormInput {
+    /**
+     * Name of the form input, this is not human readable and is used to identify the field.
+     *
+     * For example: "SERVICE" or "FULL_NAME"
+     */
+    name: string;
+    /**
+     * Optional title used to display on the input
+     */
+    title?: string;
+    /**
+     * Type of the input
+     */
+    type: "TEXT" | "DROPDOWN" | "CHECK" | "CHIPS" | "DATE" | "DATERANGE" | "CARD";
+    shape?: "ROUND" | "SQUARE";
+    condition?: string;
+    mandatory?: boolean;
+    mandatoryError?: string;
+    style?: object;
+}
+export interface FormFieldTextAddressInput extends FormTextInput {
+    format: "ADDRESS";
+    /**
+     * Base URL of an endpoint that adheres to the Google Maps Location Autocomplete API.
+     */
+    mapsBaseUrl?: string;
+    /**
+     * Optional query parameters to help limit the results returned by the Google Maps Autocomplete API.
+     */
+    mapsUrlQueryParams?: AddressAutocompleteParameters;
+    /**
+     * Required when you are using the official Google Maps Autocomplete API.
+     */
+    googleMapsApiKey?: string;
+}
+/**
+ * Text input. Validate according to the format.
+ */
+export interface FormTextInput extends FormInput {
+    multiline?: boolean;
+    format?: "PHONE" | "EMAIL" | "ADDRESS";
+    placeholder?: string;
+    label?: string;
+    rows?: number;
+    rowsMax?: number;
+}
+/**
+ * Dropdown
+ */
+export interface FormDropdownInput extends FormInput {
+    items: SelectableItem[];
+}
+/**
+ * Close/Open style chips selection. Header plus open symbol reveals the chips.
+ */
+export interface FormChipsInput extends FormInput {
+    type: "CHIPS";
+    radio?: boolean;
+    defaultOpen?: boolean;
+    minRequired?: number;
+    maxAllowed?: number;
+    items: SelectableItem[];
+}
+/**
+ * Like chips but with checkboxes
+ */
+export interface FormSelectInput extends FormInput {
+    radio?: boolean;
+    defaultOpen?: boolean;
+    items: SelectableItem[];
+}
+/**
+ * Card (text/image)
+ */
+export interface FormCardInput extends FormInput {
+    header?: {
+        title: string;
+        subheader?: string;
+    };
+    media?: {
+        height?: number;
+        width?: number;
+        imageUrl: string;
+        alt?: string;
+    };
+    text?: string;
+    variant?: string;
+    color?: string;
+    align?: string;
+}
+/**
+ * Single date
+ */
+export interface FormDateInput extends FormInput {
+    preselecteDate?: Date;
+}
+/**
+ * Date range
+ */
+export interface FormDateRangeInput extends FormInput {
+    preselecteDates?: {
+        from?: Date;
+        to?: Date;
+    };
+}
+/**
+ * Basically a name value pair for dropdowns or chips
+ */
+export interface SelectableItem {
+    /**
+     * Display label
+     */
+    label: string;
+    /**
+     * ID of the item. This is what is sent to the server and should be a form of the label that is human readable.
+     */
+    id: string;
+    /**
+     * Option to show the item as selected
+     */
+    selected?: boolean;
+}

package/lib/Form/FormField.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2024, XAPP AI */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FormField.js.map

package/lib/Form/FormField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormField.js","sourceRoot":"","sources":["../../src/Form/FormField.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/Form/FormStep.d.ts

@@ -0,0 +1,18 @@
+/*! Copyright (c) 2024, XAPP AI */
+import { FormField } from "./FormField";
+/**
+ * A step is partial form. Fields plus next/prev/submit buttons as needed.
+ * We are going through these "mini screens".
+ */
+export interface FormStep {
+    name: string;
+    title?: string;
+    fields: FormField[];
+    condition?: string;
+    nextAction?: "next" | "submit" | "omit";
+    previousAction?: "previous" | "submit" | "omit";
+    nextLabel?: string;
+    previousLabel?: string;
+    final?: boolean;
+    crmSubmit?: boolean;
+}

package/lib/Form/FormStep.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2024, XAPP AI */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FormStep.js.map

package/lib/Form/FormStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormStep.js","sourceRoot":"","sources":["../../src/Form/FormStep.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/Form/index.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2024, XAPP AI */
+export * from "./FormField";
+export * from "./FormStep";

package/lib/Form/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/*! Copyright (c) 2024, XAPP AI */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FormField"), exports);
+__exportStar(require("./FormStep"), exports);
+//# sourceMappingURL=index.js.map

package/lib/Form/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Form/index.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;;;;;AAElC,8CAA4B;AAC5B,6CAA2B"}

package/lib/index.d.ts

@@ -14,6 +14,7 @@ export type * from "./Display";
 export type * from "./Email";
 export type * from "./Entity";
 export type * from "./Events";
+export type * from "./Form";
 export type * from "./Handler";
 export type * from "./History";
 export type * from "./Intent";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,wCAAsB;AAGtB,4CAA0B;AA2B1B,6CAA2B;AAE3B,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,wCAAsB;AAGtB,4CAA0B;AA4B1B,6CAA2B;AAE3B,6CAA2B"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.59.86",
+  "version": "1.59.89",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.2"
   },
-  "gitHead": "e2ca7660879047a377dbe6393777eb45ded99077"
+  "gitHead": "3ac00dc6cb41671fea9f046e2a64cb0795dbf317"
 }