@memberjunction/skip-types 2.69.1 → 2.71.0

package/dist/runtime-types.d.ts

@@ -1,219 +0,0 @@
-import { CompositeKey } from "@memberjunction/core";
-import { SimpleDataContext } from "./shared";
-import { SimpleMetadata, SimpleRunQuery, SimpleRunView } from "./shared";
-/**
- * This interface defines the available callback functions that a Skip component might call in the parent.
- */
-export interface SkipComponentCallbacks {
-    /**
-     * The component can invoke this method in the callbacks object, when provided, to refresh the data context
-     * and that will in turn result in the component's init function being called again with the new data context.
-     * @returns
-     */
-    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
-     * @returns
-     */
-    OpenEntityRecord: (entityName: string, key: CompositeKey) => void;
-    /**
-     * This event should be raised by the HTML component whenever something changes within the component that should be tracked as a change in state
-     * that will persist. userState is any valid, simple JavaScript object, meaning it can have scalars, arrays, objects, etc, it must be an object that
-     * can be serialized to JSON, but otherwise has no special requirements. The parent component will be responsible for tracking the user-specific states
-     * and passing them back to the HTML component each time it is loaded or if the user changes via the init function.
-     * @param userState
-     * @returns
-     */
-    UpdateUserState: (userState: any) => void;
-    /**
-     * Used for any other type of event notification that a component might want to send to the parent component.
-     * @param eventName
-     * @param eventData
-     * @returns
-     */
-    NotifyEvent: (eventName: string, eventData: any) => void;
-}
-/**
- * This is the function signature for the initialization function provided by each Skip component via the SkipComponentObject so that a container can interact with it.
- * 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

@@ -1 +0,0 @@
-{"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;;;;OAIG;IACH,WAAW,EAAE,MAAM,IAAI,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,KAAK,IAAI,CAAC;IAElE;;;;;;;OAOG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,IAAI,CAAC;IAE1C;;;;;OAKG;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

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

package/dist/runtime-types.js.map

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

package/dist/shared.d.ts

@@ -1,44 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

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

package/dist/shared.js.map

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