@elliemae/pui-scripting-object 1.46.4 → 1.48.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.46.4",
+  "version": "1.48.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -66,8 +66,8 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.10.0",
-    "@elliemae/pui-cli": "~8.39.0",
-    "@elliemae/pui-doc-gen": "~3.0.0",
+    "@elliemae/pui-cli": "~8.40.1",
+    "@elliemae/pui-doc-gen": "~3.1.1",
     "@elliemae/pui-theme": "~2.10.0",
     "@types/styled-components": "~5.1.34",
     "history": "~5.3.0",

package/dist/cjs/objects/route.js

@@ -1,16 +0,0 @@
-"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 route_exports = {};
-module.exports = __toCommonJS(route_exports);

package/dist/cjs/objects/transactionv2.js

@@ -1,29 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-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 transactionv2_exports = {};
-__export(transactionv2_exports, {
-  CompleteReason: () => CompleteReason
-});
-module.exports = __toCommonJS(transactionv2_exports);
-var CompleteReason = /* @__PURE__ */ ((CompleteReason2) => {
-  CompleteReason2["CLOSE"] = "close";
-  CompleteReason2["CANCEL"] = "cancel";
-  CompleteReason2["ERROR"] = "error";
-  return CompleteReason2;
-})(CompleteReason || {});

package/dist/cjs/objects/view.js

@@ -1,16 +0,0 @@
-"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 view_exports = {};
-module.exports = __toCommonJS(view_exports);

package/dist/esm/objects/transactionv2.js

@@ -1,9 +0,0 @@
-var CompleteReason = /* @__PURE__ */ ((CompleteReason2) => {
-  CompleteReason2["CLOSE"] = "close";
-  CompleteReason2["CANCEL"] = "cancel";
-  CompleteReason2["ERROR"] = "error";
-  return CompleteReason2;
-})(CompleteReason || {});
-export {
-  CompleteReason
-};

package/dist/types/lib/objects/route.d.ts

@@ -1,13 +0,0 @@
-import { To } from 'history';
-import { IScriptingObject } from '../scriptingObject.js';
-/**
- * Methods to view, modify & get notified about parent window url navigation
- */
-export interface IRoute extends IScriptingObject {
-    /**
-     * navigate to a new url
-     * @param path path to navigate to
-     * @param state state to be passed to the new path
-     */
-    navigate(path: To, state?: unknown): Promise<void>;
-}

package/dist/types/lib/objects/transactionv2.d.ts

@@ -1,80 +0,0 @@
-import { IScriptingObject } from '../scriptingObject.js';
-import { OriginDetails, TransactionDetails, TransactionEvent, ResourceDetails, ResourceOptions } from './shared.js';
-/**
- * reason for completing the user interaction with the transaction
- */
-export declare enum CompleteReason {
-    /**
-     * user completed interaction with the transaction
-     */
-    CLOSE = "close",
-    /**
-     * user cancelled the interaction with transaction
-     */
-    CANCEL = "cancel",
-    /**
-     * interaction with the transaction errored out
-     */
-    ERROR = "error"
-}
-/**
- * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
- * transactional interaction with the EPC platform.
- * Allows access to an interactive session's origination context,
- * create a new transaction,
- * update an existing transaction,
- * create events/messages for a transaction, and more.
- */
-export interface ITransactionV2 extends IScriptingObject {
-    /**
-     * notify host on completion of user interaction with the transaction
-     * so that host can perform any necessary post user interaction processing / cleanup.
-     * @param id - unique identifier for the transaction
-     * @param reason reason for completing the transaction user interaction
-     */
-    completeUserInteraction(id: string, reason: CompleteReason): Promise<void>;
-    /**
-     * create new transaction
-     * @param options details of the transaction to be created
-     * @returns transaction id
-     * @throws error when transaction creation fails
-     */
-    create(options: TransactionDetails): Promise<string>;
-    /**
-     * send event for the subject transaction
-     * @param id - unique identifier for the transaction
-     * @param options details of the event/message to be initiated
-     * @returns transaction event id
-     * @throws error when event creation fails, TransactionNotFound error for invalid transaction id
-     */
-    createEvent(id: string, options: TransactionEvent): Promise<string>;
-    /**
-     * Creates new origin and context.
-     * @param withLoanData - include loan data in the origin cache
-     * @returns service setup origination information
-     * @throws OriginNotFound error when origin is not found
-     */
-    createOrigin(withLoanData: boolean): Promise<OriginDetails>;
-    /**
-     * get necessary details to upload document for specific transaction
-     * @param id - unique identifier for the transaction
-     * @param options details of the document to be uploaded
-     * @returns details about the location where to upload the document
-     * @throws error when resource can not be created, TransactionNotFound error for invalid transaction id
-     */
-    createResource(id: string, options: ResourceOptions): Promise<ResourceDetails>;
-    /**
-     * get details about the transaction
-     * @param id - unique identifier for the transaction
-     * @returns transaction details
-     * @throws TransactionNotFound error for invalid transaction id
-     */
-    get(id: string): Promise<TransactionDetails>;
-    /**
-     * update existing transaction.
-     * @param id - unique identifier for the transaction
-     * @param options transaction details to be updated
-     * @throws error when transaction update fails, TransactionNotFound error for invalid transaction id
-     */
-    update(id: string, options: TransactionDetails): Promise<void>;
-}

package/dist/types/lib/objects/view.d.ts

@@ -1,103 +0,0 @@
-import { BreakPoint } from '@elliemae/pui-theme';
-import { IEvent } from '../event.js';
-import { IScriptingObject } from '../scriptingObject.js';
-/**
- * window viewport size
- */
-export type ViewportSize = {
-    width: number;
-    height: number;
-};
-/**
- * window viewport size information
- */
-type ViewportSizeInfo = {
-    /**
-     * details about the resize event
-     */
-    entires: ResizeObserverEntry;
-};
-/**
- * parent window resize event handler
- * @param params event parameters
- * @param params.obj view object reference
- * @param params.eventName event name
- * @param params.eventParams view port info
- * @param params.eventOptions additional options related to the event
- */
-export type ViewResizeListener = (params: {
-    obj: IView;
-    eventName: string;
-    eventParams: ViewportSizeInfo;
-    eventOptions?: Record<string, unknown>;
-}) => void;
-/**
- * window breakpoint information
- */
-export type BreakpointInfo = {
-    /**
-     * current breakpoint of the parent window
-     */
-    breakpoint: BreakPoint;
-};
-/**
- * parent window breakpoint change event handler
- * @param params event parameters
- * @param params.obj view object reference
- * @param params.eventName event name
- * @param params.eventParams window breakpoint info
- * @param params.eventOptions additional options related to the event
- */
-export type BreakpointChangeListener = (params: {
-    obj: IView;
-    eventName: string;
-    eventParams: BreakpointInfo;
-    eventOptions?: Record<string, unknown>;
-}) => void;
-/**
- * events related to the window
- */
-export type ViewEvents = {
-    /**
-     * event is fired when the parent window's breakpoint changes
-     *
-     * Use {@link BreakpointChangeListener} to handle this event
-     */
-    'view.breakpointChange': BreakpointChangeListener;
-    /**
-     * eent is fired when the parent window is resized
-     *
-     * Use {@link ViewResizeListener} to handle this event
-     */
-    'view.resize': ViewResizeListener;
-};
-/**
- * APIs to interact with the window / viewport
- *
- * See {@link ViewEvents} for supported events
- */
-export interface IView extends IScriptingObject {
-    /**
-     * event fired when the window breakpoint changes
-     *
-     * Use {@link BreakpointChangeListener} to handle this event
-     */
-    readonly BreakpointChange: IEvent;
-    /**
-     * event fired when the window is resized
-     *
-     * Use {@link ViewResizeListener} to handle this event
-     */
-    readonly Resize: IEvent;
-    /**
-     * Get the current breakpoint of the parent window
-     * @returns current breakpoint
-     */
-    getBreakpoint(): Promise<BreakPoint>;
-    /**
-     * Get the current viewport size of the parent window
-     * @returns viewport size
-     */
-    getViewPortSize(): Promise<ViewportSize>;
-}
-export {};