@memberjunction/interactive-component-types 2.132.0 → 3.0.0

package/dist/child-spec.d.ts

@@ -0,0 +1,67 @@
+import { ComponentEvent, ComponentProperty } from "./component-props-events";
+import { ComponentDataRequirements } from "./data-requirements";
+/**
+ * Represents a child component within a component hierarchy
+ */
+export interface ComponentChildSpec {
+    /**
+     * 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?: ComponentDataRequirements;
+    /**
+     * 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?: ComponentProperty[];
+    /**
+     * An optional array of events that the component emits.
+     * This allows consumers of the component to understand what events they can listen to.
+     */
+    events?: ComponentEvent[];
+    /**
+     * Technical design details for this child component.
+     * This should be in markdown format and describe the implementation approach.
+     * Includes:
+     * - How the component is structured
+     * - Properites/events
+     */
+    technicalDesign?: string;
+    /**
+     * An array of sub-components
+     */
+    components: ComponentChildSpec[];
+}
+//# 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,cAAc,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;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,yBAAyB,CAAC;IAE7C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEjC;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAE1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,kBAAkB,EAAE,CAAC;CACpC"}

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/root-spec.d.ts

@@ -0,0 +1,72 @@
+import { ComponentChildSpec } from "./child-spec";
+import { ComponentDataRequirements } from "./data-requirements";
+/**
+ * Represents a complete specification for a generated Skip component, including its structure,
+ * requirements, code, and nested component hierarchy
+ */
+export type ComponentRootSpec = {
+    /**
+     * 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?: ComponentDataRequirements;
+    /**
+     * 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: ComponentChildSpec[];
+    /**
+     * 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,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B;;;;;;;OAOG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;IAE7C;;;;;;;;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,kBAAkB,EAAE,CAAC;IAEtC;;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/interactive-component-types",
-  "version": "2.132.0",
+  "version": "3.0.0",
   "description": "MemberJunction: Interactive Component - Type specifications for MJ Interactive UI Componentry",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.132.0",
-    "@memberjunction/ai-vectors-memory": "2.132.0"
+    "@memberjunction/core": "3.0.0",
+    "@memberjunction/ai-vectors-memory": "3.0.0"
   },
   "repository": {
     "type": "git",