@elliemae/pui-scripting-object 1.32.2 → 1.32.3

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

@@ -17,7 +17,13 @@ export declare enum LogLevel {
  * metadata about the application
  */
 export type AppInfo = {
+    /**
+     * unique id of the application
+     */
     id: string;
+    /**
+     * name of the application
+     */
     name: string;
 };
 /**
@@ -48,6 +54,19 @@ export type ApplicationExtension = {
      */
     options?: Record<string, string>;
 };
+/**
+ * set of query options to get company settings
+ */
+export type CompanySettingsQueryOptions = {
+    /**
+     * category name
+     */
+    category: string;
+    /**
+     * attribute name
+     */
+    attribute?: string;
+};
 /**
  * Types of navigations
  */
@@ -63,12 +82,27 @@ export declare enum NavigationType {
  * navigation options
  */
 export type NavigationOptions = {
+    /**
+     * target url
+     */
     target: string;
+    /**
+     * type of the navigation
+     */
     type: NavigationType;
+    /**
+     * context for the navigation
+     */
     context?: Record<string, string>;
 };
 export type OpenOptions = {
+    /**
+     * target item
+     */
     target: string;
+    /**
+     * type of the item
+     */
     type?: string;
 };
 /**
@@ -140,11 +174,26 @@ export type Route = {
      */
     id: string;
 };
+/**
+ * environment details
+ */
 export type Environment = {
+    /**
+     * api domain
+     */
     apiHost: string;
 };
+/**
+ * application context
+ */
 export type ApplicationContext = {
+    /**
+     * environment details
+     */
     env: Environment;
+    /**
+     * current route
+     */
     route: Route;
 };
 /**
@@ -297,9 +346,9 @@ export interface IApplication extends IScriptingObject {
     log(message: string, logLevel: LogLevel): Promise<void>;
     /**
      * get company settings for a particular category
-     * @param category category name
+     * @param options {CompanySettingsQueryOptions} options to query company settings
      * @returns company settings as key value pairs. Null if category is not found
      */
-    getCompanySettings(category: string): Promise<Record<string, any> | null>;
+    getCompanySettings(options: CompanySettingsQueryOptions): Promise<Record<string, any> | null>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.32.2",
+  "version": "1.32.3",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",
@@ -68,7 +68,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
-    "@elliemae/pui-cli": "~8.29.0",
+    "@elliemae/pui-cli": "~8.30.0",
     "@elliemae/pui-doc-gen": "~2.0.1",
     "@elliemae/pui-theme": "~2.7.0",
     "@types/styled-components": "~5.1.34",