noodl-types - npm Package Compare versions

Comparing version 1.0.248 to 1.0.249

dist/__tests__/identify.test.d.ts

 export {};

dist/__tests__/identify.test.js

@@ -0,0 +0,0 @@ "use strict";

dist/_internal/constants.d.ts

 export declare const componentTypes: readonly ["button", "chart", "divider", "footer", "header", "image", "label", "list", "listItem", "page", "plugin", "pluginHead", "pluginBodyTail", "popUp", "register", "select", "scrollView", "textField", "textView", "video", "view"];
 export declare const minimalStyleKeys: string[];
 export declare const minimalBorderStyleKeys: string[];

dist/_internal/constants.js

@@ -0,0 +0,0 @@ "use strict";

dist/_internal/index.d.ts

 export * from './utils';

dist/_internal/index.js

@@ -0,0 +0,0 @@ "use strict";

dist/_internal/types.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @internal
+ */
 export declare type OrArray<V = any> = V | V[];

dist/_internal/types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=types.js.map

dist/_internal/utils.d.ts

@@ -0,0 +0,0 @@ import type { NameField, ReferenceString } from '../ecosTypes';

dist/_internal/utils.js

@@ -0,0 +0,0 @@ "use strict";

dist/actionTypes.d.ts

 import type { LiteralUnion } from 'type-fest';
 import type { OrArray } from './_internal/types';
-import type { EmitObject, EmitObjectFold, GotoObject, IfObject } from './uncategorizedTypes';
+import type { EmitObjectFold, GotoObject, IfObject } from './uncategorizedTypes';
 import type { BuiltInEvalObject, DataIn, ReferenceString } from './ecosTypes';
+/**
+ * Known props contained in {@link ActionObject} objects
+ * @deprecated
+ */
 export interface UncommonActionObjectProps {
     actions?: any[];
     contentType?: string;
-    emit?: EmitObject;
+    emit?: EmitObjectFold;
     /**
@@ -19,3 +23,3 @@ * The path to a data object or value. It might provide a different behavior depending on where it is placed. For example, a dataKey set on a textField component will bind its value to the path in the dataKey, enabling it to mutate the value while updating textField's value
     dataKey?: string | EmitObjectFold | IfObject;
-    dataIn?: any;
+    dataIn?: DataIn;
     /**
@@ -146,2 +150,4 @@ * An object that contains data.
 /**
+ * An action to handle navigating to different pages
+ *
  * @example
@@ -154,2 +160,4 @@ * ```json
  * ```
+ *
+ * @deprecated
  */
@@ -161,2 +169,4 @@ export interface PageJumpActionObject extends ActionObject, Pick<UncommonActionObjectProps, 'destination'> {
 /**
+ * An action to handle showing a {@link PopUpComponentObject}
+ *
  * @example
@@ -175,2 +185,4 @@ * ```json
 /**
+ * An action to handle dismissing a {@link PopUpComponentObject}
+ *
  * @example
@@ -189,2 +201,4 @@ * ```json
 /**
+ * An action to handle refreshing of the current page
+ *
  * @example
@@ -202,2 +216,4 @@ * ```json
 /**
+ * An action to handle removing signatures
+ *
  * @example
@@ -217,2 +233,4 @@ * ```json
 /**
+ * An action to handle saving data
+ *
  * @example
@@ -231,2 +249,4 @@ * ```json
 /**
+ * An action to handle saving signatures
+ *
  * @example
@@ -250,2 +270,4 @@ * ```json
 /**
+ * An action to handle data mutation/updates
+ *
  * @example
@@ -252,0 +274,0 @@ * ```json

dist/actionTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=actionTypes.js.map

dist/componentTypes.d.ts

@@ -6,2 +6,6 @@ import type { ActionObject } from './actionTypes';
 import type { ActionChain, EmitObject, EmitObjectFold, GotoObject, IfObject, Path, TextBoardObject } from './uncategorizedTypes';
+/**
+ * Known props contained in components
+ * @deprecated
+ */
 export declare type UncommonComponentObjectProps = {
@@ -40,9 +44,27 @@ [key in EventType]: ActionChain;
 };
+/**
+ * The root generic component object. Implementations of component objects derive from this interface
+ */
 export interface ComponentObject<T extends string = any> extends Partial<Record<EventType, ActionChain>> {
+    /**
+     * Component type
+     */
     type: T;
+    /**
+     * Component {@link StyleObject}
+     */
     style?: StyleObject;
+    /**
+     * A list of {@link ComponentObject}
+     */
     children?: any[];
+    /**
+     * Identifier commonly used in the app level to retrieve the pointer to the component
+     */
     viewTag?: string;
     [key: string]: any;
 }
+/**
+ * Component implementing chat room interfaces
+ */
 export interface ChatListComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'chatItem' | 'contentType' | 'iteratorVar' | 'listObject'> {
@@ -52,2 +74,5 @@ type: 'chatList';
 }
+/**
+ * Component implementing charts
+ */
 export interface ChartComponentObject extends ComponentObject {
@@ -57,2 +82,5 @@ type: 'chart';
 }
+/**
+ * Component implementing buttons
+ */
 export interface ButtonComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'text'> {
@@ -62,2 +90,5 @@ type: 'button';
 }
+/**
+ * Component implementing canvases. An example would be an implementation of a signature pad.
+ */
 export interface CanvasComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'dataKey'> {
@@ -67,2 +98,5 @@ type: 'canvas';
 }
+/**
+ * Component implementing dividers. A divider is a component signaling the separation of contents
+ */
 export interface DividerComponentObject extends ComponentObject {
@@ -72,2 +106,5 @@ type: 'divider';
 }
+/**
+ * Component containing a reference to a {@link EcosDocument} on the `ecosObj` property
+ */
 export interface EcosDocComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'ecosObj'> {
@@ -77,2 +114,5 @@ type: 'ecosDoc';
 }
+/**
+ * Component implementing footers
+ */
 export interface FooterComponentObject extends ComponentObject {
@@ -82,2 +122,5 @@ type: 'footer';
 }
+/**
+ * Component implementing headers
+ */
 export interface HeaderComponentObject extends ComponentObject {
@@ -87,2 +130,5 @@ type: 'header';
 }
+/**
+ * Component implementing display of an image
+ */
 export interface ImageComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'dataKey' | 'path' | 'pathSelected'> {
@@ -92,2 +138,5 @@ type: 'image';
 }
+/**
+ * Component implementing basic text display
+ */
 export interface LabelComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'dataKey' | 'placeholder' | 'text' | 'textBoard' | 'text=func'> {
@@ -97,2 +146,5 @@ type: 'label';
 }
+/**
+ * Component implementing list components surrounding {@link ListItemComponentObject} components
+ */
 export interface ListComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'iteratorVar' | 'listObject'> {
@@ -102,2 +154,5 @@ type: 'list';
 }
+/**
+ * Component implementing a list item which are direct children of {@link ListComponentObject} components
+ */
 export interface ListItemComponentObject extends ComponentObject {
@@ -107,2 +162,5 @@ type: 'listItem';
 }
+/**
+ * Component implementing maps
+ */
 export interface MapComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'dataKey'> {
@@ -112,2 +170,5 @@ type: 'map';
 }
+/**
+ * Component implementing a detached page. Detached pages render a separate noodl page **independently**
+ */
 export interface PageComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path'> {
@@ -117,2 +178,5 @@ type: 'page';
 }
+/**
+ * Component implementing a generic plugin
+ */
 export interface PluginComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path'> {
@@ -122,2 +186,5 @@ type: 'plugin';
 }
+/**
+ * Component implementing plugins that should be injected into the head (Example: the **head** element of the DOM)
+ */
 export interface PluginHeadComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path'> {
@@ -127,2 +194,5 @@ type: 'pluginHead';
 }
+/**
+ * Component implementing plugins that should be injected into the beginning of a body (Example: the beginning of a **body** element of the DOM)
+ */
 export interface PluginBodyTopComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path'> {
@@ -132,2 +202,5 @@ type: 'pluginBodyTop';
 }
+/**
+ * Component implementing plugins that should be injected into the end of a body (Example: the end of a **body** element of the DOM)
+ */
 export interface PluginBodyTailComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path'> {
@@ -137,2 +210,5 @@ type: 'pluginBodyTail';
 }
+/**
+ * Component implementing popUp alerts. A common way to grab a pointer to popUp components are using the `viewTag` between the component and an {@link ActionObject}
+ */
 export interface PopUpComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'popUpView'> {
@@ -142,2 +218,5 @@ type: 'popUp';
 }
+/**
+ * Component that behave as observers for a specific event reference via `onEvent`
+ */
 export interface RegisterComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'actions' | 'dataKey' | 'emit' | 'onEvent'> {
@@ -147,2 +226,5 @@ type: 'register';
 }
+/**
+ * Component allowing users to select from a list of options
+ */
 export interface SelectComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'optionKey' | 'options' | 'placeholder' | 'required'> {
@@ -152,2 +234,5 @@ type: 'select';
 }
+/**
+ * Component that contain further content contained in its own content area. All of its content should be visually accessed by users by a scrolling mechanism
+ */
 export interface ScrollViewComponentObject extends ComponentObject {
@@ -157,2 +242,5 @@ type: 'scrollView';
 }
+/**
+ * Component allowing users to input a keyword value
+ */
 export interface TextFieldComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'dataKey' | 'placeholder' | 'required'> {
@@ -162,2 +250,5 @@ type: 'textField';
 }
+/**
+ * Component displaying an editable text view
+ */
 export interface TextViewComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'contentType' | 'dataKey' | 'isEditable' | 'placeholder' | 'required'> {
@@ -167,2 +258,5 @@ type: 'textView';
 }
+/**
+ * Component implementing videos being played to the user
+ */
 export interface VideoComponentObject extends ComponentObject, Pick<UncommonComponentObjectProps, 'path' | 'poster' | 'videoFormat'> {
@@ -172,2 +266,5 @@ type: 'video';
 }
+/**
+ * The most basic component which behaves as a basic view layer
+ */
 export interface ViewComponentObject extends ComponentObject {
@@ -177,2 +274,5 @@ type: 'view';
 }
+/**
+ * URLs that link to {@link PageComponentObject}. Useful when there are multiple {@link PageComponentObject} components active
+ */
 export declare type PageComponentUrl<S extends string = string> = S extends `${string}@${string}#${string}` ? S : string;

dist/componentTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=componentTypes.js.map

dist/constants.d.ts

@@ -0,1 +1,4 @@
+/**
+ * An object of commonly known action types
+ */
 export declare const action: {
@@ -19,3 +22,9 @@ readonly builtIn: "builtIn";
 };
+/**
+ * An array of commonly known action types
+ */
 export declare const actionTypes: ("builtIn" | "evalObject" | "openCamera" | "openPhotoLibrary" | "openDocumentManager" | "pageJump" | "popUp" | "popUpDismiss" | "refresh" | "removeSignature" | "saveObject" | "saveSignature" | "getLocationAddress" | "scanCamera" | "register" | "updateObject")[];
+/**
+ * An object of commonly known component types
+ */
 export declare const component: {
@@ -48,8 +57,29 @@ readonly button: "button";
     readonly rotation: "rotation";
+    readonly checkbox: "checkbox";
 };
+/**
+ * An array of commonly known component keys
+ * @deprecated
+ */
 export declare const componentKeys: readonly ["backgroundColor", "borderRadius", "chatItem", "children", "contentType", "dataId", "dataIn", "dataKey", "dataModel", "ecosObj", "height", "isEditable", "itemObject", "iteratorVar", "itmeObject", "listObject", "onChange", "onClick", "onInput", "optionKey", "options", "path", "pathSelected", "placeHolder", "placeholder", "refresh", "required", "style", "text", "text=func", "textAlign", "textBoard", "type", "viewTag", "width", "zIndex", "chatItem"];
-export declare const componentTypes: ("page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation")[];
+/**
+ * An array of commonly known action types
+ */
+export declare const componentTypes: ("page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox")[];
+/**
+ * An array of commonly known content types
+ */
 export declare const contentTypes: readonly ["countryCode", "email", "file", "formattedDate", "formattedDuration", "hidden", "listObject", "messageHidden", "number", "password", "passwordHidden", "phone", "phoneNumber", "tel", "text", "timer", "videoSubStream"];
+/**
+ * An array of DeviceType
+ */
 export declare const deviceTypes: readonly ["web", "ios", "android"];
+/**
+ * An array of known StyleObject keys
+ * @deprecated
+ */
 export declare const styleKeys: readonly ["FontSize", "axis", "background", "backgroundColor", "border", "borderColor", "borderRadius", "borderRaduis", "borderWidth", "boxShadow", "boxSizing", "color", "contentSize", "diaplay", "display", "filter", "float", "flex", "flexFlow", "fontColor", "fontFamily", "fontSize", "fontStyle", "fontWeight", "foontWeight", "height", "hieght", "isHidden", "justifyContent", "left", "letterSpacing", "lineHeight", "marginLeft", "marginTop", "onClick", "padding", "paddingBottom", "paddingLeft", "placeholder", "position", "required", "shadow", "text-align", "textAlign", "textDecoration", "textIndent", "top", "width", "zIndex"];
+/**
+ * An array of known user event names
+ */
 export declare const userEvent: readonly ["onBlur", "onClick", "onChange", "onFocus", "onHover", "onInput", "onMouseEnter", "onMouseLeave", "onMouseOut", "onMouseOver", "onLazyLoading"];

dist/constants.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.userEvent = exports.styleKeys = exports.deviceTypes = exports.contentTypes = exports.componentTypes = exports.componentKeys = exports.component = exports.actionTypes = exports.action = void 0;
+/**
+ * An object of commonly known action types
+ */
 exports.action = {
@@ -22,3 +25,9 @@ builtIn: 'builtIn',
 };
+/**
+ * An array of commonly known action types
+ */
 exports.actionTypes = Object.values(exports.action);
+/**
+ * An object of commonly known component types
+ */
 exports.component = {
@@ -51,3 +60,8 @@ button: 'button',
     rotation: 'rotation',
+    checkbox: 'checkbox',
 };
+/**
+ * An array of commonly known component keys
+ * @deprecated
+ */
 exports.componentKeys = [
@@ -92,3 +106,9 @@ 'backgroundColor',
 ];
+/**
+ * An array of commonly known action types
+ */
 exports.componentTypes = Object.values(exports.component);
+/**
+ * An array of commonly known content types
+ */
 exports.contentTypes = [
@@ -113,3 +133,10 @@ 'countryCode',
 ];
+/**
+ * An array of DeviceType
+ */
 exports.deviceTypes = ['web', 'ios', 'android'];
+/**
+ * An array of known StyleObject keys
+ * @deprecated
+ */
 exports.styleKeys = [
@@ -166,2 +193,5 @@ 'FontSize',
 ];
+/**
+ * An array of known user event names
+ */
 exports.userEvent = [
@@ -168,0 +198,0 @@ 'onBlur',

dist/constantTypes.d.ts

 import * as c from './constants';
+/**
+ * Known action types
+ */
 export declare type ActionType = typeof c.actionTypes[number];
+/**
+ * Known component types
+ */
 export declare type ComponentType = typeof c.componentTypes[number];
+/**
+ * Known content types
+ */
 export declare type ContentType = typeof c.contentTypes[number];
+/**
+ * Known event types
+ */
 export declare type EventType = typeof c.userEvent[number];

dist/constantTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=constantTypes.js.map

dist/ecosTypes.d.ts

@@ -6,2 +6,3 @@ import type { LiteralUnion } from 'type-fest';
     /**
+     * The hostname
      * @example
@@ -14,2 +15,3 @@ * ```json
     /**
+     * The port
      * @example
@@ -42,10 +44,5 @@ * ```
     /**
-     * The file name/path will be the pathname used to grab the "app" config
-     * For example, if cadlMain is "cadlEndpoint.yml", the app should pick up
-     * "${cadlBaseUrl}/cadlEndpoint.yml" where ${cadlBaseUrl} is a placeholder
-     * for the cadlBaseUrl variable
-     * @example
-     * ```js
-     * const cadlMain = 'cadlEndpoint.yml'
-     * ```
+     * The filename appended to cadlBaseUrl to retrieve the **app** config
+     *
+     * For example, if _cadlMain_ is `'cadlEndpoint.yml'` and `cadlBaseUrl` is `'https://public.aitmed.com/cadl/www4.1/'`, the url to fetch the app config should resolve to `'https://public.aitmed.com/cadl/www4.1/cadlEndpoint.yml'`
      */
@@ -61,7 +58,7 @@ cadlMain: string;
     debug: string;
-    /** If this is specified the app should transform this to a plugin component */
+    /** Plugin resource. If this is specified the app should integrate this inside a plugin component */
     bodyTopPplugin?: string;
-    /** If this is specified the app should transform this to a plugin component */
+    /** Plugin resource. If this is specified the app should integrate this inside a plugin component */
     bodyTailPplugin?: string;
-    /** If this is specified the app should transform this to a plugin component */
+    /** Plugin resource. If this is specified the app should integrate this inside a plugin component */
     headPlugin?: string;
@@ -80,2 +77,4 @@ platform?: string;
     /**
+     * The config version configuration object for a specific mobile platform device
+     *
      * @example
@@ -93,9 +92,39 @@ * ```json
      */
-    web: RootConfigDeviceVersionObject;
-    ios: RootConfigDeviceVersionObject;
-    android: RootConfigDeviceVersionObject;
-    keywords: string[];
+    web?: RootConfigDeviceVersionObject;
     /**
+     * The config version configuration object for a specific mobile platform device
+     *
      * @example
      * ```json
+     * {
+     *   "web": {
+     *      "cadlVersion": {
+     *        "test": "0.7d",
+     *        "stable": "0.7d"
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    ios?: RootConfigDeviceVersionObject;
+    /**
+     * The config version configuration object for a specific mobile platform device
+     *
+     * @example
+     * ```json
+     * {
+     *   "web": {
+     *      "cadlVersion": {
+     *        "test": "0.7d",
+     *        "stable": "0.7d"
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    android?: RootConfigDeviceVersionObject;
+    keywords?: string[];
+    /**
+     * @example
+     * ```json
      * { "viewWidthHeightRatio": { "min": "7", "max": "8" } }
@@ -113,9 +142,16 @@ * ```
     /**
+     * The base url prepended to asset pathnames
      * @example
      * ```js
-     * const assetsUrl = `${baseUrl}assets
+     * const baseUrl = 'https://public.aitmed.com/cadl/www1.1/'
+     * const assetsUrl = `${baseUrl}assets`
+     * const imageComponent = { type: 'image', path: 'fruit.jpeg' }
+     *
+     * imageComponent.path = `${assetsUrl}${imageComponent.path}`
      * ```
      */
     assetsUrl: string;
-    /** The equivalent of "cadlBaseUrl" from the root config */
+    /**
+     * The equivalent of "cadlBaseUrl" from the root config
+     */
     baseUrl: string;
@@ -161,3 +197,3 @@ /**
     /**
-     * Pages to be loaded and treated as routes in the runtime
+     * Pages to be loaded and treated as routes
      * @example
@@ -173,4 +209,10 @@ * ```js
     cadlVersion: {
-        stable: number;
-        test: number;
+        /**
+         * The variable used to specify as the production environment
+         */
+        stable: number | string;
+        /**
+         * The variable used to specify as the development environment
+         */
+        test: number | string;
     };
@@ -181,20 +223,13 @@ }
  *
- * Built in eval objects are implemented in the application, making
- * it an app level implementation
+ * Built in eval objects are implemented in the application
  *
  * @example
  * ```json
- * {
- *   "=.builtIn.string.concat": [
- *      "+1",
- *      " ",
- *      "8882468442"
- *   ]
- * }
+ * { "=.builtIn.string.concat": ["+1", " ", "8882468442"] }
  * ```
- * becomes:
+ *
+ * may be implemented as:
+ *
  * ```js
- * const myBuiltIn = function(...strings) {
- *   return strings.reduce((acc, str) => acc.concat(str))
- * }
+ * const stringConcat = (...s) => s.reduce((acc, str) => acc.concat(str))
  * ```
@@ -204,11 +239,24 @@ */
 /**
- * Strings that represent data that may mutate a value depending on if it is referencing a path.
- * If the eval reference is an object then it is transformed into a function instead.
- *  - This function mutates the value at the referenced path (if any).
+ * **builtIn** eval strings may be placeholders for {@link BuiltInEvalObject} objects that behave as functions implemented in the app level
  */
 export declare type BuiltInEvalReference<S extends string> = ReferenceString<`builtIn${S}`, '=.'>;
+/**
+ * The input to {@link BuiltInEvalObject} functions
+ */
 export declare type DataIn = OrArray<EmitObjectFold | IfObject | PolymorphicObject | string>;
+/**
+ * The output from {@link BuiltInEvalObject} functions. If this is a reference the path contained in the reference should be set this value
+ */
 export declare type DataOut = OrArray<EmitObjectFold | IfObject | PolymorphicObject | string>;
+/**
+ * User device type. Used to retrieve the config version in {@link RootConfig}
+ */
 export declare type DeviceType = 'android' | 'ios' | 'web';
+/**
+ * Ecos environment. Also used in {@link RootConfig}
+ */
 export declare type Env = 'stable' | 'test';
+/**
+ * An eCOS document object. These objects are received via `rd` requests and created via `cd` requests
+ */
 export declare type EcosDocument<NF extends NameField = NameField, MT extends MediaType = MediaType> = {
@@ -233,2 +281,5 @@ id?: string | null;
 };
+/**
+ * a JSON serialized object usually containing sensitive information such as a user's information
+ */
 export interface NameField<Type extends MimeType.Options = MimeType.Options> {
@@ -242,2 +293,5 @@ tags?: string[];
 }
+/**
+ * Mime types we can expect from noodl apps
+ */
 export declare namespace MimeType {
@@ -252,2 +306,5 @@ type Options = Audio | Image | Json | Pdf | Text | Video;
 }
+/**
+ * Commonly found in {@link EcosDocument} objects
+ */
 export interface SubtypeObject<MT extends MediaType = MediaType> {
@@ -264,3 +321,9 @@ isOnServer?: boolean | null;
 }
+/**
+ * Commonly found in {@link EcosDocument} objects
+ */
 export declare type Deat = DeatObject | number;
+/**
+ * Commonly found in {@link EcosDocument} objects
+ */
 export interface DeatObject {
@@ -283,5 +346,9 @@ url?: string;
 export declare type VideoMediaType = 9;
+/**
+ * All variations of reference symbols
+ */
 export declare type ReferenceSymbol = '.' | '..' | '=' | '~/' | '@';
 /**
- * Strings that behave like placeholders which in addition mutates the value at referenced path when updates occur.
+ * Strings that behave like placeholders which may in addition mutate the value at the referenced path.
+ *
  * They are prefixed with "=" followed by a reference symbol such as ".", "..", "~", etc.
@@ -292,3 +359,3 @@ *
  * const pageObject = { SignIn: { formData: { email: '[e-mail]' } } }
- * const refString = '.SignIn.formData.email' // Value should result to "[e-mail]" when parsed
+ * const refString = '.SignIn.formData.email' // Value should resolve to "[e-mail]"
  * ```
@@ -295,0 +362,0 @@ */

dist/ecosTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ecosTypes.js.map

dist/identify.d.ts

@@ -16,80 +16,83 @@ import isAwaitReference from './utils/isAwaitReference';
         } & {
-            page: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            page: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            popUp: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            popUp: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            register: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            register: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            button: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            button: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            canvas: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            canvas: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            chart: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            chart: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            chatList: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            chatList: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            ecosDoc: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            ecosDoc: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            divider: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            divider: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            footer: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            footer: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            header: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            header: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            image: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            image: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            label: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            label: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            list: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            list: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            listItem: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            listItem: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            map: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            map: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            plugin: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            plugin: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            pluginHead: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            pluginHead: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            pluginBodyTail: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            pluginBodyTail: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            select: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            select: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            scrollView: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            scrollView: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            textField: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            textField: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            textView: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            textView: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            video: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            video: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            view: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            view: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
-            rotation: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+            rotation: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
                 type: K;
             };
+            checkbox: <K extends "page" | "popUp" | "register" | "button" | "canvas" | "chart" | "chatList" | "ecosDoc" | "divider" | "footer" | "header" | "image" | "label" | "list" | "listItem" | "map" | "plugin" | "pluginHead" | "pluginBodyTail" | "select" | "scrollView" | "textField" | "textView" | "video" | "view" | "rotation" | "checkbox">(v: unknown) => v is Omit<t.ActionObject<string>, "type"> & {
+                type: K;
+            };
         };
@@ -96,0 +99,0 @@ emit: (v: any) => v is t.EmitObjectFold<Record<string, any>>;

dist/identify.js

@@ -0,0 +0,0 @@ "use strict";

dist/index.d.ts

@@ -0,0 +0,0 @@ export * from './actionTypes';

dist/index.js

@@ -0,0 +0,0 @@ "use strict";

dist/pageTypes.d.ts

 import type { ComponentObject } from './componentTypes';
+/**
+ * The page object that are nodes of the root object
+ */
 export interface PageObject {
@@ -3,0 +6,0 @@ components: ComponentObject[];

dist/pageTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=pageTypes.js.map

dist/styleTypes.d.ts

@@ -0,1 +1,6 @@
+/**
+ * Style object.
+ *
+ * Most commonly found in {@link ComponentObject} objects to describe their design implementation
+ */
 export interface StyleObject {
@@ -2,0 +7,0 @@ /**

dist/styleTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=styleTypes.js.map

dist/uncategorizedTypes.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from './ecosTypes';

dist/uncategorizedTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=uncategorizedTypes.js.map

dist/utils/isAwaitReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isAwaitReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isEvalLocalReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isEvalLocalReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isEvalReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isEvalReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isEvalRootReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isEvalRootReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isLocalReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isLocalReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isRootReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isRootReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isTildeReference.d.ts

@@ -0,0 +0,0 @@ import type { ReferenceString } from '../ecosTypes';

dist/utils/isTildeReference.js

@@ -0,0 +0,0 @@ "use strict";

dist/utils/isTraverseReference.d.ts

@@ -0,0 +0,0 @@ /**

dist/utils/isTraverseReference.js

@@ -0,0 +0,0 @@ "use strict";

package.json

@@ -14,3 +14,3 @@ {
   ],
-  "gitHead": "d7c96fe88daa3fd3245170245360eaa875fd8e6a",
+  "gitHead": "b802ef7f3cd42184fc7eb28c2f481966bba4d00e",
   "homepage": "",
@@ -34,3 +34,3 @@ "license": "ISC",
   "types": "dist/index.d.ts",
-  "version": "1.0.248"
+  "version": "1.0.249"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

122929

increased by4.33%

Lines of code

2599

increased by11.88%

No dependency changes