@elliemae/pui-scripting-object 1.9.0 → 1.10.1

package/dist/cjs/index.js

@@ -27,6 +27,7 @@ __reExport(lib_exports, require("./objects/loanv2.js"), module.exports);
 __reExport(lib_exports, require("./objects/memStorage.js"), module.exports);
 __reExport(lib_exports, require("./objects/module.js"), module.exports);
 __reExport(lib_exports, require("./objects/route.js"), module.exports);
+__reExport(lib_exports, require("./objects/service.js"), module.exports);
 __reExport(lib_exports, require("./objects/session.js"), module.exports);
 __reExport(lib_exports, require("./objects/transaction.js"), module.exports);
 __reExport(lib_exports, require("./objects/transactionTemplate.js"), module.exports);

package/dist/cjs/objects/service.js

@@ -0,0 +1,20 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var service_exports = {};
+module.exports = __toCommonJS(service_exports);
+var ServiceSetupCategory = /* @__PURE__ */ ((ServiceSetupCategory2) => {
+  ServiceSetupCategory2["APPRAISAL"] = "Appraisal";
+  return ServiceSetupCategory2;
+})(ServiceSetupCategory || {});

package/dist/esm/index.js

@@ -10,6 +10,7 @@ export * from "./objects/loanv2.js";
 export * from "./objects/memStorage.js";
 export * from "./objects/module.js";
 export * from "./objects/route.js";
+export * from "./objects/service.js";
 export * from "./objects/session.js";
 export * from "./objects/transaction.js";
 export * from "./objects/transactionTemplate.js";

package/dist/esm/objects/service.js

@@ -0,0 +1,4 @@
+var ServiceSetupCategory = /* @__PURE__ */ ((ServiceSetupCategory2) => {
+  ServiceSetupCategory2["APPRAISAL"] = "Appraisal";
+  return ServiceSetupCategory2;
+})(ServiceSetupCategory || {});

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './objects/loanv2.js';
 export * from './objects/memStorage.js';
 export * from './objects/module.js';
 export * from './objects/route.js';
+export * from './objects/service.js';
 export * from './objects/session.js';
 export * from './objects/transaction.js';
 export * from './objects/transactionTemplate.js';

package/dist/types/objects/service.d.ts

@@ -0,0 +1,60 @@
+/**
+ * type of service setup categories
+ */
+declare enum ServiceSetupCategory {
+    APPRAISAL = "Appraisal"
+}
+/**
+ * details of a service setup
+ */
+declare type ServiceSetup = {
+    /**
+     * service setup id
+     */
+    serviceSetupId: string;
+    /**
+     * unique provider id
+     */
+    providerId: string;
+    /**
+     * product listing name
+     */
+    productListingName: string;
+    /**
+     * service setup category
+     */
+    category: ServiceSetupCategory;
+};
+/**
+ * options to open the service order integration
+ */
+declare type OpenOptions = {
+    /**
+     * context of the application that is opening the service order integration
+     * urn patterned string
+     * example: urn:elli:services:getpricing
+     */
+    target: string;
+};
+/**
+ * Methods for interacting with the Service orders
+ */
+export interface IService {
+    /**
+     * Get the service setup for the current user and loan
+     *
+     * @param category - The category of the service setup
+     * @param providerId - The provider id of the service setup
+     * @returns list of service setups matching the input criteria. Empty list if no service setups are found
+     */
+    getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
+    /**
+     * open default or specific service intergration to place an order
+     *
+     * @param serviceSetupId - id of the service setup
+     * @param options - options for opening the service integration
+     * @throws Error if the service setup is not found or user is not authorized to open the integration
+     */
+    createOrder: (serviceSetupId: string, options: OpenOptions) => Promise<void>;
+}
+export {};

package/dist/types/scriptingObjectTypes.d.ts

@@ -12,6 +12,8 @@ import { IAnalytics } from './objects/analytics.js';
 import { IMemStorage } from './objects/memStorage.js';
 import { IView } from './objects/view.js';
 import { IRoute } from './objects/route.js';
+import { IModule } from './objects/module.js';
+import { IService } from './objects/service.js';
 export declare type ScriptingObjectTypes = {
     Analytics: IAnalytics;
     Application: IApplication;
@@ -22,7 +24,9 @@ export declare type ScriptingObjectTypes = {
     Loan: ILoan;
     LoanV2: ILoanV2;
     MemStorage: IMemStorage;
+    Module: IModule;
     Route: IRoute;
+    Service: IService;
     Session: ISession;
     Transaction: ITransaction;
     TransactionTemplate: ITransactionTemplate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.9.0",
+  "version": "1.10.1",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",