@memberjunction/skip-types 2.63.1 → 2.65.0

package/dist/child-spec.d.ts

@@ -0,0 +1,67 @@
+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
+     *
+     * @since 2.1.0 - Enhanced documentation for clarity
+     */
+    functionalRequirements?: string;
+    /**
+     * Data requirements for this child component.
+     * Child components inherit static data from their parent component's data context.
+     * However, they can define their own dynamic data requirements for entities they need to access at runtime.
+     *
+     * @since 2.1.0 - Enhanced documentation for clarity
+     */
+    dataRequirements?: SkipComponentDataRequirements;
+    /**
+     * 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 management within the component
+     * - Props interface and event handlers
+     * - Performance optimizations specific to this component
+     *
+     * @since 2.1.0 - Enhanced documentation for clarity
+     */
+    technicalDesign?: string;
+    /**
+     * The path in the state tree where this component's state is stored
+     */
+    statePath: string;
+    /**
+     * An array of sub-components (recursive structure)
+     */
+    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,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;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;;;;;;OAUG;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/data-requirements.d.ts

@@ -0,0 +1,111 @@
+import { DataContext } from "@memberjunction/data-context";
+/**
+ * Defines the data requirements for a Skip component, supporting three different data access modes.
+ * This interface is critical for understanding how components interact with MemberJunction data
+ * and helps optimize performance by clearly defining data access patterns.
+ */
+export interface SkipComponentDataRequirements {
+    /**
+     * The primary data access mode for this component.
+     * - 'static': Data is pre-loaded and passed to the component during initialization
+     * - 'dynamic': Component fetches data at runtime using MJ utilities
+     * - 'hybrid': Component uses both static and dynamic data access patterns
+     */
+    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.
+     * Static mode is preferred for:
+     * - Reports with fixed datasets
+     * - Components where users don't need entity-level permissions
+     * - Scenarios requiring reduced database load
+     */
+    staticData?: {
+        /**
+         * Reference to the data context that this component uses.
+         * Points to a DataContext object containing pre-loaded data.
+         */
+        dataContext: DataContext;
+        /**
+         * Optional 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.
+     * Dynamic mode is preferred for:
+     * - Interactive dashboards with drill-down capabilities
+     * - Components requiring real-time data
+     * - Scenarios where users need entity-level permission validation
+     */
+    dynamicData?: {
+        /**
+         * Array of objects specifying the exact entities and fields the component will
+         * need to fulfill user requirements. This detail also allows other components
+         * to not have to know the database schema.
+         */
+        requiredEntities: SkipComponentEntityDataRequirement[];
+        /**
+         * Optional description of the dynamic data access patterns
+         */
+        description?: string;
+    };
+    /**
+     * For hybrid mode: Components can use both static and dynamic data access.
+     * Both staticData and dynamicData sections should be populated.
+     * Hybrid mode is useful for:
+     * - Components with both summary (static) and detail (dynamic) views
+     * - Optimizing performance while maintaining interactivity
+     */
+    hybridStrategy?: {
+        /**
+         * Description of how the component decides when to use static vs dynamic data
+         */
+        description: string;
+        /**
+         * Optional performance considerations for the hybrid approach
+         */
+        performanceNotes?: string;
+    };
+    /**
+     * General description of the component's data requirements and access patterns.
+     * This should provide a high-level overview of the data strategy.
+     */
+    description?: string;
+    /**
+     * Security considerations for data access
+     * @since 2.1.0
+     */
+    securityNotes?: string;
+}
+/**
+ * Specifications for the use of a single entity within a Skip component.
+ */
+export type SkipComponentEntityDataRequirement = {
+    /**
+     * The name of the entity as defined in the metadata.
+     */
+    entityName: string;
+    /**
+     * Description of the entityt as defined in the metadata.
+     */
+    entityDescription?: string;
+    /**
+     * These fields can be shown to the user as determined by each component.
+     */
+    displayFields: string[];
+    /**
+     * These fields can be used when filtering data as appropriately determined by each component.
+     */
+    filterFields?: string[];
+    /**
+     * These fields can be used when sorting data as appropriately determined by each component.
+     */
+    sortFields?: string[];
+    /**
+     * Optional, description of when/where/how components should use this entity.
+     */
+    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;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEtC;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE;QACT;;;WAGG;QACH,WAAW,EAAE,WAAW,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE;QACV;;;;WAIG;QACH,gBAAgB,EAAE,kCAAkC,EAAE,CAAC;QAEvD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QACb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;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/index.d.ts

@@ -6,7 +6,11 @@ export * from './query-types';
 export * from './agent-types';
 export * from './artifact-types';
 export * from './auth-types';
-export * from './component-types';
+export * from './root-spec';
+export * from './child-spec';
+export * from './data-requirements';
+export * from './component-option';
+export * from './runtime-types';
 export * from './shared';
 export * from './util';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AAEzB,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB,cAAc,QAAQ,CAAC"}

package/dist/index.js

@@ -23,7 +23,11 @@ __exportStar(require("./query-types"), exports);
 __exportStar(require("./agent-types"), exports);
 __exportStar(require("./artifact-types"), exports);
 __exportStar(require("./auth-types"), exports);
-__exportStar(require("./component-types"), exports);
+__exportStar(require("./root-spec"), exports);
+__exportStar(require("./child-spec"), exports);
+__exportStar(require("./data-requirements"), exports);
+__exportStar(require("./component-option"), exports);
+__exportStar(require("./runtime-types"), exports);
 __exportStar(require("./shared"), exports);
 __exportStar(require("./util"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,8CAA4B;AAC5B,uDAAqC;AACrC,mDAAiC;AACjC,0DAAwC;AACxC,gDAA8B;AAC9B,gDAA8B;AAC9B,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,2CAAyB;AAEzB,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,8CAA4B;AAC5B,uDAAqC;AACrC,mDAAiC;AACjC,0DAAwC;AACxC,gDAA8B;AAC9B,gDAA8B;AAC9B,mDAAiC;AACjC,+CAA6B;AAC7B,8CAA4B;AAC5B,+CAA6B;AAC7B,sDAAoC;AACpC,qDAAmC;AACnC,kDAAgC;AAChC,2CAAyB;AAEzB,yCAAuB"}

package/dist/response-types.d.ts

@@ -26,7 +26,7 @@ import type { SkipColumnInfo } from './entity-metadata-types';
 import type { SkipDataRequest } from './query-types';
 import type { SkipAPIArtifactRequest } from './artifact-types';
 import { SimpleDataContext } from './shared';
-import { SkipComponentOption } from './component-types';
+import { SkipComponentOption } from './component-option';
 /**
  * Defines an individual filter that will be used to filter the data in the view to the specific row or rows that the user clicked on for a drill down
  */

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

@@ -1 +1 @@
-{"version":3,"file":"response-types.d.ts","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,qBAAa,8BAA8B;IACvC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,eAAe;IAChE;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC;IAC/B;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC;IACnD;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IAEjC;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;;;OAIG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC5C;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,eAAe;IAClE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,eAAe;IAC3D,WAAW,EAAE,eAAe,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,eAAe;IAC9D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"response-types.d.ts","sourceRoot":"","sources":["../src/response-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD;;GAEG;AACH,qBAAa,8BAA8B;IACvC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,8BAA8B,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,eAAe;IAChE;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC;IAC/B;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC;IACnD;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IAEjC;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;;;OAIG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC5C;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,eAAe;IAClE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,eAAe;IAC3D,WAAW,EAAE,eAAe,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,eAAe;IAC9D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACnB"}

package/dist/root-spec.d.ts

@@ -0,0 +1,87 @@
+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 and purpose
+     * - User interactions and behaviors
+     * - Business rules and logic
+     * - Expected outcomes and outputs
+     * - User experience considerations
+     * - Accessibility requirements
+     *
+     * @since 2.1.0 - Made required and enhanced documentation
+     */
+    functionalRequirements: string;
+    /**
+     * Detailed data requirements specification for the component.
+     * Defines how the component accesses and uses data, supporting static, dynamic, and hybrid modes.
+     * This field is critical for determining how the component will interact with MemberJunction data.
+     *
+     * @since 2.1.0 - Made required for better data architecture planning
+     */
+    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 used
+     * - Key technical decisions and rationale
+     * - Component structure and organization
+     * - State management approach
+     * - Performance considerations
+     * - Integration points with parent/child components
+     * - Error handling strategies
+     *
+     * @since 2.1.0 - Made required and enhanced documentation
+     */
+    technicalDesign: string;
+    /**
+     * The actual code for the main component, typically wrapped in an IIFE that returns
+     * the component object with component, print, and refresh properties
+     */
+    componentCode: string;
+    /**
+     * The name of the main component
+     */
+    componentName: string;
+    /**
+     * The type of component: report, dashboard, form, chart, table, or other. Over time this list
+     * might grow to include more types as Skip evolves and new component types are needed.
+     */
+    componentType: "report" | "dashboard" | "form" | "other";
+    /**
+     * A summary of what the component does that a user would understand.
+     * This should be a high-level, user-friendly description suitable for end users.
+     */
+    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[];
+    /**
+     * The title of the component
+     */
+    title: string;
+    /**
+     * A user-friendly explanation of what the component does
+     */
+    userExplanation: string;
+    /**
+     * A technical explanation of how the component works
+     */
+    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;;;;;;;;;;;OAWG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;;;;;;;;OAYG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,EAAE,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC;IAEzD;;;OAGG;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,219 @@
+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

@@ -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;;;;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

@@ -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":""}