@memberjunction/skip-types 2.133.0 → 3.0.0

package/dist/child-spec.d.ts

@@ -0,0 +1,72 @@
+import { SkipComponentEvent, SkipComponentProperty } from "./component-props-events";
+import { SkipComponentDataRequirements } from "./data-requirements";
+/**
+ * Represents a child component within a component hierarchy
+ */
+export interface SkipComponentChildSpec {
+    /**
+     * The programmatic name of the component
+     */
+    componentName: string;
+    /**
+     * Example of the component being used in JSX format. This is used to provide a clear example on the properties and
+     * event handling that the component supports. This is used to teach the next AI exactly what we want it to generate for the
+     * child component.
+     */
+    exampleUsage: string;
+    /**
+     * The code for the child component. This is generated LATER by a separate process after the parent
+     * component generation is complete. When the parent component generates this is undefined.
+     */
+    componentCode?: string;
+    /**
+     * A summary of what this child component does that a user would understand.
+     * This should be a high-level, user-friendly description suitable for end users.
+     */
+    description: string;
+    /**
+     * Functional requirements for this child component.
+     * This should be in markdown format and describe what the component should do from a functional perspective.
+     * Includes:
+     * - Component-specific functionality
+     * - How it integrates with the parent component
+     * - User interactions within this component
+     * - Business rules specific to this component
+     */
+    functionalRequirements?: string;
+    /**
+     * Data requirements for this child component. This section defines where a child component
+     * will **directly** access data as required using utilities methods like `rv.runView` and `rq.runQuery`
+     */
+    dataRequirements?: SkipComponentDataRequirements;
+    /**
+     * An optional array of properties that the component uses. The names and descriptions
+     * allow consumers of the component to understand what is accepted by the component and the
+     * component. This can be used for shared data shared between components or for configuration
+     * settings.
+     */
+    properties?: SkipComponentProperty[];
+    /**
+     * An optional array of events that the component emits.
+     * This allows consumers of the component to understand what events they can listen to.
+     */
+    events?: SkipComponentEvent[];
+    /**
+     * Technical design details for this child component.
+     * This should be in markdown format and describe the implementation approach.
+     * Includes:
+     * - How the component is structured
+     * - State within the component
+     * - Properites/events
+     */
+    technicalDesign?: string;
+    /**
+     * The path in the state tree where this component's state is stored
+     */
+    statePath: string;
+    /**
+     * An array of sub-components
+     */
+    components: SkipComponentChildSpec[];
+}
+//# sourceMappingURL=child-spec.d.ts.map

package/dist/child-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"child-spec.d.ts","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE9B;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,sBAAsB,EAAE,CAAC;CACxC"}

package/dist/child-spec.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=child-spec.js.map

package/dist/child-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"child-spec.js","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":""}

package/dist/component-option.d.ts

@@ -0,0 +1,32 @@
+import { SkipComponentRootSpec } from "./root-spec";
+/**
+ * Defines a given option for a generated component that the user can choose. The code/componentObjectName properties are used to render the component in the UI.
+ */
+export type SkipComponentOption = {
+    /**
+     * Full details of the generated component option including functional, technical, code, and child componentry.
+     */
+    option: SkipComponentRootSpec;
+    /**
+     * If multiple component options are provided for a given @interface SkipAPIAnalysisCompleteResponse, a "judge" AI will evaluate all the functional
+     * responses and will rank order them with an explanation of why they were each ranked that way. Rankings are not absolute, they are relative to the
+     * # of components contained within an array of SkipComponentOption types.
+     */
+    AIRank: number | undefined;
+    /**
+     * The AI's explanation of why it ranked the component the way it did. This is useful for understanding the AI's reasoning and can be used to improve future components
+     * as well as provide context to the user about why a particular component was chosen as the best option.
+     */
+    AIRankExplanation: string | undefined;
+    /**
+     * The user's provided feedback on the component option. Unlike the AIRank, this is a subjective rating provided by the user and is
+     * a number between 1 and 10, where 1 is the lowest rating and 10 is the highest rating.
+     */
+    UserRank: number | undefined;
+    /**
+     * If the host application provides a way for the user to provide feedback on the component option,
+     * this is the explanation of why the user rated the component the way they did if they provided feedback.
+     */
+    UserRankExplanation: string | undefined;
+};
+//# sourceMappingURL=component-option.d.ts.map

package/dist/component-option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-option.d.ts","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;IAE9B;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C,CAAA"}

package/dist/component-option.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=component-option.js.map

package/dist/component-option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-option.js","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":""}

package/dist/component-props-events.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Definition of a single property of a component.
+ */
+export interface SkipComponentProperty {
+    /**
+     * The name of the property
+     */
+    name: string;
+    /**
+     * A description of what this property is used for
+     */
+    description: string;
+    /**
+     * The type of the property.
+     * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
+     * These types are for aligning users of the component. Components are in JavaScript and do not
+     * actually enforce types at runtime, but this is used to provide guidance for users (AI and Human)
+     */
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
+    /**
+     * Indicates if this property is required for the component to function correctly.
+     * If true, the component will not work without this property being set.
+     */
+    required: boolean;
+    /**
+     * The default value, if any, for this property if it is not provided.
+     */
+    defaultValue?: any;
+    /**
+     * Optional list of possible values for this property.
+     */
+    possibleValues?: string[];
+}
+/**
+ * Definition of a single event of a component.
+ */
+export interface SkipComponentEvent {
+    /**
+     * The name of the event
+     */
+    name: string;
+    /**
+     * A description of what this event does
+     */
+    description: string;
+    /**
+     * An array of parameters that this event can emit.
+     */
+    parameters?: SkipComponentEventParameter[];
+}
+export interface SkipComponentEventParameter {
+    /**
+     * The name of the parameter
+     */
+    name: string;
+    /**
+     * A description of what this parameter is used for
+     */
+    description: string;
+    /**
+     * The type of the parameter.
+     * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
+     */
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
+}
+//# sourceMappingURL=component-props-events.d.ts.map

package/dist/component-props-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-props-events.d.ts","sourceRoot":"","sources":["../src/component-props-events.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,CAAC;IAChF;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,2BAA2B,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,CAAC;CACnF"}

package/dist/component-props-events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=component-props-events.js.map

package/dist/component-props-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-props-events.js","sourceRoot":"","sources":["../src/component-props-events.ts"],"names":[],"mappings":""}

package/dist/data-requirements.d.ts

@@ -0,0 +1,77 @@
+import { DataContext } from "@memberjunction/data-context";
+/**
+ * This interface is critical for understanding how components interact with MemberJunction data
+ */
+export interface SkipComponentDataRequirements {
+    /**
+     * The primary data access mode for this component.
+     * - 'dynamic': Component fetches data at runtime using MJ utilities
+     * - 'static': Deprecated, use dynamic.
+     * - 'hybrid': Deprecated, use dynamic.
+     */
+    mode: 'static' | 'dynamic' | 'hybrid';
+    /**
+     * For static mode: References to data context items that this component uses.
+     * These are pre-loaded data snapshots that are passed to the component during initialization.
+     * @deprecated Use dynamicData instead
+     */
+    staticData?: {
+        /**
+         * Reference to the data context that this component uses.
+         */
+        dataContext: DataContext;
+        /**
+         * Description of how the static data is used by the component
+         */
+        description?: string;
+    };
+    /**
+     * For dynamic mode: Defines which MemberJunction entities this component needs access to.
+     * The component will use the RunView/RunQuery utilities to fetch data at runtime.
+     */
+    dynamicData?: {
+        /**
+         * Describes the entities and fields the component will
+         * need to fulfill user requirements.
+         */
+        requiredEntities: SkipComponentEntityDataRequirement[];
+        /**
+         * Description of data access patterns
+         */
+        description?: string;
+    };
+    /**
+     * General description of data requirements
+     */
+    description?: string;
+}
+/**
+ * Describes use of a single entity
+ */
+export type SkipComponentEntityDataRequirement = {
+    /**
+     * Name of the entity (unique system-wide)
+     */
+    entityName: string;
+    /**
+     * Description of data in the entity
+     */
+    entityDescription?: string;
+    /**
+     * Fields to show the user
+     */
+    displayFields: string[];
+    /**
+     * Fields to filter on initially or via user interaction.
+     */
+    filterFields?: string[];
+    /**
+     * Fields to use when sorting
+     */
+    sortFields?: string[];
+    /**
+     * When/Where/How components should use this data
+     */
+    usageContext?: string;
+};
+//# sourceMappingURL=data-requirements.d.ts.map

package/dist/data-requirements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-requirements.d.ts","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEtC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QACT;;WAEG;QACH,WAAW,EAAE,WAAW,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,WAAW,CAAC,EAAE;QACV;;;WAGG;QACH,gBAAgB,EAAE,kCAAkC,EAAE,CAAC;QAEvD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAA"}

package/dist/data-requirements.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data-requirements.js.map

package/dist/data-requirements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-requirements.js","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":""}

package/dist/root-spec.d.ts

@@ -0,0 +1,72 @@
+import { SkipComponentChildSpec } from "./child-spec";
+import { SkipComponentDataRequirements } from "./data-requirements";
+/**
+ * Represents a complete specification for a generated Skip component, including its structure,
+ * requirements, code, and nested component hierarchy
+ */
+export type SkipComponentRootSpec = {
+    /**
+     * A description of what the component should do from a functional perspective.
+     * This should be in markdown format and include:
+     * - Core functionality
+     * - Business rules
+     * - Expected outcomes
+     * - UX considerations
+     */
+    functionalRequirements: string;
+    /**
+     * Detailed data requirements, including how the component accesses and uses data.
+     */
+    dataRequirements?: SkipComponentDataRequirements;
+    /**
+     * A technical description of how the component is designed and implemented.
+     * This should be in markdown format and include:
+     * - Architecture and design patterns
+     * - Key technical decisions
+     * - Component structure
+     * - State management
+     * - Integration points with parent/child components
+     */
+    technicalDesign: string;
+    /**
+     * The code for the main component.
+     */
+    componentCode: string;
+    /**
+     * Name of the component
+     */
+    componentName: string;
+    /**
+     * The type of component: report, dashboard, form, or other.
+     */
+    componentType: "report" | "dashboard" | "form" | "other";
+    /**
+     * A summary of what the component does that a user would understand.
+     */
+    description: string;
+    /**
+     * The callback strategy used by this component (e.g., "hybrid", "direct", "none")
+     */
+    callbackStrategy: string;
+    /**
+     * Describes the state structure managed by this component
+     */
+    stateStructure: Record<string, string>;
+    /**
+     * An array of child component specifications
+     */
+    childComponents: SkipComponentChildSpec[];
+    /**
+     * User-friendly name
+     */
+    title: string;
+    /**
+     * A user-friendly explanation of what the component does
+     */
+    userExplanation: string;
+    /**
+     * Summary of technical design
+     */
+    techExplanation: string;
+};
+//# sourceMappingURL=root-spec.d.ts.map

package/dist/root-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-spec.d.ts","sourceRoot":"","sources":["../src/root-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;;;;OAOG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;;;;OAQG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC;IAEzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,eAAe,EAAE,sBAAsB,EAAE,CAAC;IAE1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/root-spec.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=root-spec.js.map

package/dist/root-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-spec.js","sourceRoot":"","sources":["../src/root-spec.ts"],"names":[],"mappings":""}

package/dist/runtime-types.d.ts

@@ -0,0 +1,211 @@
+import { CompositeKey } from "@memberjunction/core";
+import { SimpleDataContext } from "./shared";
+import { SimpleMetadata, SimpleRunQuery, SimpleRunView } from "./shared";
+/**
+ * Available callbacks a component can call.
+ */
+export interface SkipComponentCallbacks {
+    /**
+     * When data is provided by the parent, this request results in the parent restarting the component. Only relevant for static/hybrid data, not for dynamic.
+     * @deprecated
+     */
+    RefreshData: () => void;
+    /**
+     * If an action occurs inside a component where it would be desirable for the containing UI to open a specific
+     * record, if supported, this event can be listened to and the container UI can then open the record.
+     * @param entityName - this is the Entity NAME from the Entity metadata, not the table name or base view name. Use Entity Metadata to provide the entity name here
+     * @param key - this is an array of key/value pairs representing the primary key. The format of a Composite Key is an array of KeyValuePair objects and KeyValuePair objects simply have FieldName and Value properties. In most cases entities have single-valued primary keys but this structure is here for complex entity types that have composite primary keys
+     */
+    OpenEntityRecord: (entityName: string, key: CompositeKey) => void;
+    /**
+     * This event should be raised whenever something changes within the component that should be tracked as a change in state
+     * that will persist. userState is any valid serializable JavaScript object. This state is passed to the component when it
+     * initializes.
+     */
+    UpdateUserState: (userState: any) => void;
+    /**
+     * Other notifications that a component might want to send to the parent.
+     */
+    NotifyEvent: (eventName: string, eventData: any) => void;
+}
+/**
+ * Function signature for the initialization function of each component.
+ * This function is called when the component is loaded by its container. The function receives the data context, an optional userState property, and a set of callbacks that can be used to interact with the parent component.
+ * userState is an optional parameter that can be used to pass in any state information that the parent component wants to provide to the component that is specific
+ * to the CURRENT user. If the component modifies the userState, it should notify the parent component via the UserStateChanged event in the callbacks object so that the parent component can handle storage.
+ */
+export type SkipComponentInitFunction = (params: SkipComponentInitParams) => void;
+/**
+ * This is the function signature for the print function that is provided by the component via the SkipComponentObject
+ */
+export type SkipComponentPrintFunction = () => void;
+/**
+ * This is the function signature for the refresh function that is provided by the component via the SkipComponentObject
+ */
+export type SkipComponentRefreshFunction = () => void;
+/**
+ * Parameters that are passed to the SkipComponentInitFunction when it is called by the parent component.
+ */
+export interface SkipComponentInitParams {
+    /**
+     * Contains the static data specified by the root component specification. This data is pre-loaded and passed to
+     * the component during initialization and anytime the component is refreshed.
+     */
+    staticData: SimpleDataContext;
+    /**
+     * Contains the dynamic data utilities that the component can use to access MemberJunction data. This includes
+     * the metadata, run view, and run query utilities that the component can use to access data dynamically at runtime.
+     * The component can use these utilities to fetch data at runtime based on the user's interactions with the component.
+     */
+    utilities?: SkipComponentUtilities;
+    /**
+     * Any valid serializable JavaScript object that represents the user-specific state for the component.
+     */
+    userState?: any;
+    /**
+     * Callbacks that the component can use to interact with the parent component. These callbacks allow the component to refresh data, open records, update user state, and send custom events.
+     */
+    callbacks?: SkipComponentCallbacks;
+    /**
+     * The default styles the component should use as specified by its parent (the container in the case of a root component, or a parent component in the case
+     * of a child component). The component can alter these styles based on the requirements specified by the user in its design documentation.
+     */
+    styles?: SkipComponentStyles;
+}
+/**
+ * This interface defines styles that can be applied to the component. The container can provide
+ * styles to the top level component. The top level component can alter these styles based on
+ * the prompting of the user, learned notes, etc, and adjust the styles of the component accordingly. In addition
+ * the top level component will pass in its computed styles to each sub-component so that the sub-components
+ * can do the same recursively down to any level of depth. This allows sub-components to inherit styles but
+ * also make adjustments as required based on functional needs and user input.
+ */
+export interface SkipComponentStyles {
+    colors: {
+        primary: string;
+        primaryHover: string;
+        primaryLight?: string;
+        secondary: string;
+        secondaryHover?: string;
+        success: string;
+        successLight?: string;
+        warning?: string;
+        warningLight?: string;
+        error?: string;
+        errorLight?: string;
+        info?: string;
+        infoLight?: string;
+        background: string;
+        surface: string;
+        surfaceHover?: string;
+        text: string;
+        textSecondary: string;
+        textTertiary?: string;
+        textInverse?: string;
+        border: string;
+        borderLight?: string;
+        borderFocus?: string;
+        shadow?: string;
+        shadowMedium?: string;
+        shadowLarge?: string;
+        [key: string]: string | undefined;
+    };
+    spacing: {
+        xs: string;
+        sm: string;
+        md: string;
+        lg: string;
+        xl: string;
+        xxl?: string;
+        xxxl?: string;
+        [key: string]: string | undefined;
+    };
+    typography: {
+        fontFamily: string;
+        fontSize: {
+            xs?: string;
+            sm: string;
+            md: string;
+            lg: string;
+            xl: string;
+            xxl?: string;
+            xxxl?: string;
+            [key: string]: string | undefined;
+        };
+        fontWeight?: {
+            light?: string;
+            regular?: string;
+            medium?: string;
+            semibold?: string;
+            bold?: string;
+            [key: string]: string | undefined;
+        };
+        lineHeight?: {
+            tight?: string;
+            normal?: string;
+            relaxed?: string;
+            [key: string]: string | undefined;
+        };
+    };
+    borders: {
+        radius: string | {
+            sm?: string;
+            md?: string;
+            lg?: string;
+            xl?: string;
+            full?: string;
+            [key: string]: string | undefined;
+        };
+        width: string | {
+            thin?: string;
+            medium?: string;
+            thick?: string;
+            [key: string]: string | undefined;
+        };
+    };
+    shadows?: {
+        sm?: string;
+        md?: string;
+        lg?: string;
+        xl?: string;
+        inner?: string;
+        [key: string]: string | undefined;
+    };
+    transitions?: {
+        fast?: string;
+        normal?: string;
+        slow?: string;
+        [key: string]: string | undefined;
+    };
+    overflow: string;
+}
+/**
+ * This is the interface that each Skip component will expose to the parent component and assign it a name globally on the window object so that the parent component can call it.
+ * The component will create this object and it will include the members defined in this interface.
+ */
+export interface SkipComponentObject {
+    /**
+     * The React component that Angular will render directly using ReactDOM.
+     * This component receives props including data, userState, callbacks, utilities, and styles.
+     */
+    component: any;
+    /**
+     * The optional print function that is called when the user clicks on the print button in the parent of the component. This function will never be called by the parent before the init function so the print function
+     * can assume the component has been initialized;
+     */
+    print?: SkipComponentPrintFunction;
+    /**
+     * The optional refresh function that is called when the user clicks on the refresh button in the parent of the component. This function will never be called by the parent before the init function so the refresh function
+     */
+    refresh?: SkipComponentRefreshFunction;
+}
+/**
+ * This interface defines the utilities that are available to the Skip component. These utilities are used to interact with the host MemberJunction system to
+ * retrieve metadata, run views, and run queries. The utilities are passed into the SkipComponentInitFunction by the container.
+ */
+export interface SkipComponentUtilities {
+    md: SimpleMetadata;
+    rv: SimpleRunView;
+    rq: SimpleRunQuery;
+}
+//# sourceMappingURL=runtime-types.d.ts.map

package/dist/runtime-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-types.d.ts","sourceRoot":"","sources":["../src/runtime-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;OAGG;IACH,WAAW,EAAE,MAAM,IAAI,CAAC;IAExB;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,KAAK,IAAI,CAAC;IAElE;;;;OAIG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,IAAI,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,IAAI,CAAC;AACpD;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,IAAI,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,UAAU,EAAE,iBAAiB,CAAC;IAC9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE;QAEJ,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,SAAS,EAAE,MAAM,CAAA;QACjB,cAAc,CAAC,EAAE,MAAM,CAAA;QAGvB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAGlB,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QAGrB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,EAAE,MAAM,CAAA;QACrB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,EAAE,MAAM,CAAA;QACd,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,WAAW,CAAC,EAAE,MAAM,CAAA;QAGpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,OAAO,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,EAAE,EAAE,MAAM,CAAA;QACV,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAC;IACF,UAAU,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE;YACR,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,EAAE,EAAE,MAAM,CAAA;YACV,GAAG,CAAC,EAAE,MAAM,CAAA;YACZ,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,QAAQ,CAAC,EAAE,MAAM,CAAA;YACjB,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,UAAU,CAAC,EAAE;YACX,KAAK,CAAC,EAAE,MAAM,CAAA;YACd,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,OAAO,CAAC,EAAE,MAAM,CAAA;YAGhB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAA;KACJ,CAAC;IACF,OAAO,EAAE;QACL,MAAM,EAAE,MAAM,GAAG;YACf,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,IAAI,CAAC,EAAE,MAAM,CAAA;YAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;QACF,KAAK,EAAE,MAAM,GAAG;YACd,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,KAAK,CAAC,EAAE,MAAM,CAAA;YAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;SACnC,CAAC;KACL,CAAA;IACD,OAAO,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,MAAM,CAAA;QAGd,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,WAAW,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;KACrC,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,cAAc,CAAC;IACnB,EAAE,EAAE,aAAa,CAAC;IAClB,EAAE,EAAE,cAAc,CAAA;CACrB"}

package/dist/runtime-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=runtime-types.js.map

package/dist/runtime-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-types.js","sourceRoot":"","sources":["../src/runtime-types.ts"],"names":[],"mappings":""}

package/dist/shared.d.ts

@@ -0,0 +1,44 @@
+import { RunQueryParams, RunQueryResult, RunViewParams, RunViewResult } from "@memberjunction/core";
+import { SkipEntityInfo } from "./entity-metadata-types";
+/**
+ * This is a simple data context object that is passed into the SkipComponentInitFunction, it contains a property for each of the data context items and typically are named
+ * data_item_1, data_item_2, etc. The data context is a simple JavaScript object that contains properties that are in turn data objects which are typically arrays of things, but can be anything.
+ */
+export type SimpleDataContext = {
+    [key: string]: any;
+};
+/**
+ * Simple version of the @interface Metadata MemberJunction object that is passed to the Skip component.
+ */
+export interface SimpleMetadata {
+    entities: SkipEntityInfo[];
+}
+/**
+* Simple interface for running views in MemberJunction that can be used by components generated by Skip
+ */
+export interface SimpleRunView {
+    /**
+     * Run a single view and return the results. The view is run dynamically against the MemberJunction host environment.
+     * @param params
+     * @returns
+     */
+    runView: (params: RunViewParams) => Promise<RunViewResult>;
+    /**
+     * Runs multiple views and returns the results. This is useful for running multiple views in parallel and returning the results in a single call.
+     * @param params
+     * @returns
+     */
+    runViews: (params: RunViewParams[]) => Promise<RunViewResult[]>;
+}
+/**
+ * Simple interface for running predefined queries in MemberJunction that can be used by components generated by Skip
+ */
+export interface SimpleRunQuery {
+    /**
+     * Run a single predefined query and return the results. The query is run dynamically against the MemberJunction host environment.
+     * @param params
+     * @returns
+     */
+    runQuery: (params: RunQueryParams) => Promise<RunQueryResult>;
+}
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;IAC1D;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;CAChE"}

package/dist/shared.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/dist/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/skip-types",
-  "version": "2.133.0",
+  "version": "3.0.0",
   "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,10 +19,10 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.133.0",
-    "@memberjunction/interactive-component-types": "2.133.0",
-    "@memberjunction/ai-core-plus": "2.133.0",
-    "@memberjunction/data-context": "2.133.0"
+    "@memberjunction/core": "3.0.0",
+    "@memberjunction/interactive-component-types": "3.0.0",
+    "@memberjunction/ai-core-plus": "3.0.0",
+    "@memberjunction/data-context": "3.0.0"
   },
   "repository": {
     "type": "git",