@trackunit/iris-app-runtime-core 0.3.20 → 0.3.21

package/index.cjs

@@ -30,6 +30,12 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * Setup using the subscribedMethods to subscribe to events from the host.
+ *
+ * @param subscribedMethods the methods to subscribe to
+ * @returns { Connection<HostConnectorApi> } the connection to the host
+ */
 const setupHostConnector = (subscribedMethods) => {
     var _a;
     const methods = Object.assign({ onGlobalSelectionChanged: () => { }, onTokenChanged: () => { }, onAssetSortingStateChanged: () => { } }, subscribedMethods);
@@ -42,6 +48,11 @@ const setupHostConnector = (subscribedMethods) => {
     return connection;
 };
 const hostConnector = setupHostConnector({});
+/**
+ * Gets the host connector.
+ *
+ * @returns { Promise<HostConnectorApi> } the connection to the host
+ */
 const getHostConnector = () => {
     return hostConnector.promise;
 };
@@ -75,6 +86,13 @@ const CurrentUserRuntime = {
     }),
 };
 
+/**
+ * Get the value of a custom field from a raw value.
+ *
+ * @param customFieldDefinition the definition of the custom field
+ * @param newValue the new value to set
+ * @returns { CustomFieldValue } an updated CustomFieldValue
+ */
 const getCustomFieldValueFromRawValue = (customFieldDefinition, newValue) => {
     if (customFieldDefinition.type === irisAppRuntimeCoreApi.CustomFieldType.BOOLEAN) {
         return {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@trackunit/iris-app-runtime-core",
-  "version": "0.3.20",
+  "version": "0.3.21",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./index.cjs",
   "type": "commonjs",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core-api": "0.3.18",
+    "@trackunit/iris-app-runtime-core-api": "0.3.19",
     "@trackunit/react-core-contexts-api": "0.2.18"
   },
   "peerDependencies": {}

package/src/CustomFieldRuntime.d.ts

@@ -2,6 +2,13 @@ import { CustomFieldDefinition, CustomFieldError, CustomFieldValue, EntityIdenti
 export interface DropdownSelection {
     value: string;
 }
+/**
+ * Get the value of a custom field from a raw value.
+ *
+ * @param customFieldDefinition the definition of the custom field
+ * @param newValue the new value to set
+ * @returns { CustomFieldValue } an updated CustomFieldValue
+ */
 export declare const getCustomFieldValueFromRawValue: (customFieldDefinition: CustomFieldDefinition, newValue: boolean | string | string[] | DropdownSelection[] | DropdownSelection | number) => CustomFieldValue;
 export interface ICustomFieldRuntime {
     getCustomFieldsFor: (entity: EntityIdentity) => Promise<ValueAndDefinition[]>;

package/src/HostConnector.d.ts

@@ -1,7 +1,18 @@
 import { ChildConnectorApi, HostConnectorApi } from "@trackunit/iris-app-runtime-core-api";
 import { Methods } from "penpal";
+/**
+ * Setup using the subscribedMethods to subscribe to events from the host.
+ *
+ * @param subscribedMethods the methods to subscribe to
+ * @returns { Connection<HostConnectorApi> } the connection to the host
+ */
 export declare const setupHostConnector: (subscribedMethods: Partial<ChildConnectorApi> & Methods) => {
     promise: Promise<import("penpal").AsyncMethodReturns<HostConnectorApi>>;
     destroy: Function;
 };
+/**
+ * Gets the host connector.
+ *
+ * @returns { Promise<HostConnectorApi> } the connection to the host
+ */
 export declare const getHostConnector: () => Promise<import("penpal").AsyncMethodReturns<HostConnectorApi>>;