@memberjunction/interactive-component-types 2.73.0 → 2.75.0

package/dist/component-option.d.ts

@@ -1,12 +1,12 @@
-import { ComponentRootSpec } from "./root-spec";
+import { ComponentSpec } from "./component-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 ComponentOption = {
     /**
-     * Full details of the generated component option including functional, technical, code, and child componentry.
+     * Full details of the generated component option including functional, technical, code, dependencies and libraries
      */
-    option: ComponentRootSpec;
+    option: ComponentSpec;
     /**
      * If multiple component options are provided 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

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

@@ -1 +1 @@
-{"version":3,"file":"component-option.d.ts","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;;;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"}
+{"version":3,"file":"component-option.d.ts","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;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-spec-runtime.d.ts

@@ -0,0 +1,130 @@
+import { ComponentSpec } from "./component-spec";
+import { ComponentEntitySimplePermission } from "./data-requirements";
+import { ComponentLibraryDependency } from "./library-dependency";
+import { UserInfo } from "@memberjunction/core";
+/**
+ * Runtime extension of ComponentSpec that provides helper methods for permission checking,
+ * validation, and other runtime operations. This class is not included in AI prompts
+ * to keep token usage efficient.
+ */
+export declare class ComponentSpecRuntime extends ComponentSpec {
+    /**
+     * Get all unique permissions required by this component across all entities.
+     * This aggregates permissions from all entity data requirements to provide
+     * a complete picture of what the component needs.
+     *
+     * @returns Array of unique permission types required by the component
+     */
+    GetRequiredPermissions(): ComponentEntitySimplePermission[];
+    /**
+     * Check if the component only requires read permissions across all entities.
+     * This is useful for determining if a component is effectively read-only
+     * from a permissions perspective.
+     *
+     * @returns true if the component only requires 'read' permissions
+     */
+    IsEffectivelyReadOnly(): boolean;
+    /**
+     * Get all entity names that this component accesses.
+     * Useful for pre-loading permissions or understanding component data dependencies.
+     *
+     * @returns Array of entity names accessed by the component
+     */
+    GetAccessedEntities(): string[];
+    /**
+     * Check if the component has any write capabilities (create, update, or delete).
+     * This helps determine if the component can modify data or is purely read-only.
+     *
+     * @returns true if the component requires any write permissions
+     */
+    HasWriteCapabilities(): boolean;
+    /**
+     * Convert component permission types to MemberJunction EntityPermissionType.
+     * This enables integration with MJ's permission system.
+     *
+     * @param permission - Component permission type
+     * @returns MemberJunction EntityPermissionType
+     */
+    private convertToEntityPermissionType;
+    /**
+     * Validate that a user has all required permissions to use this component.
+     * This method checks each entity's permission requirements against the user's
+     * actual permissions in MemberJunction using the Metadata system.
+     *
+     * @param user - The MemberJunction UserInfo object
+     * @returns Validation result with details about any missing permissions
+     */
+    ValidateUserPermissions(user: UserInfo): Promise<{
+        canRender: boolean;
+        missingPermissions: Array<{
+            entity: string;
+            permission: ComponentEntitySimplePermission;
+        }>;
+        degradedPermissions: Array<{
+            entity: string;
+            permission: ComponentEntitySimplePermission;
+            reason: string;
+        }>;
+    }>;
+    /**
+     * Get a summary of all data access patterns for this component.
+     * Useful for documentation and understanding component behavior.
+     *
+     * @returns Object describing all data access patterns
+     */
+    GetDataAccessSummary(): {
+        mode: string;
+        entityCount: number;
+        queryCount: number;
+        requiresWrite: boolean;
+        entities: Array<{
+            name: string;
+            permissions: string[];
+        }>;
+        queries: Array<{
+            name: string;
+            category: string;
+        }>;
+    };
+    /**
+     * Create a ComponentSpecRuntime instance from a plain object.
+     * Useful when deserializing from JSON or database storage.
+     *
+     * @param obj - Plain object with ComponentSpec properties
+     * @returns New ComponentSpecRuntime instance
+     */
+    static FromObject(obj: ComponentSpec): ComponentSpecRuntime;
+    /**
+     * Create a ComponentSpecRuntime instance from JSON string.
+     * Handles parsing and object conversion in one step.
+     *
+     * @param json - JSON string representation of a ComponentSpec
+     * @returns New ComponentSpecRuntime instance
+     */
+    static FromJSON(json: string): ComponentSpecRuntime;
+    /**
+     * Get all external library dependencies for this component.
+     * Returns both the library names and their global variables.
+     *
+     * @returns Array of library dependencies with details
+     */
+    GetLibraryDependencies(): ComponentLibraryDependency[];
+    /**
+     * Check if this component depends on a specific library.
+     * Can check by either library name or global variable.
+     *
+     * @param libraryNameOrGlobal - Library name or global variable to check
+     * @returns true if the component depends on the specified library
+     */
+    DependsOnLibrary(libraryNameOrGlobal: string): boolean;
+    /**
+     * Get all component dependencies recursively.
+     * Traverses the entire dependency tree to return a flat list of all
+     * components this one depends on, directly or indirectly.
+     *
+     * @param visitedNames - Set of already visited component names (for cycle detection)
+     * @returns Array of all component dependencies
+     */
+    GetAllDependencies(visitedNames?: Set<string>): ComponentSpec[];
+}
+//# sourceMappingURL=component-spec-runtime.d.ts.map

package/dist/component-spec-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-spec-runtime.d.ts","sourceRoot":"","sources":["../src/component-spec-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAwB,QAAQ,EAAY,MAAM,sBAAsB,CAAC;AAEhF;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,aAAa;IACnD;;;;;;OAMG;IACI,sBAAsB,IAAI,+BAA+B,EAAE;IAUlE;;;;;;OAMG;IACI,qBAAqB,IAAI,OAAO;IAKvC;;;;;OAKG;IACI,mBAAmB,IAAI,MAAM,EAAE;IAItC;;;;;OAKG;IACI,oBAAoB,IAAI,OAAO;IAMtC;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAUrC;;;;;;;OAOG;IACU,uBAAuB,CAChC,IAAI,EAAE,QAAQ,GACf,OAAO,CAAC;QACP,SAAS,EAAE,OAAO,CAAC;QACnB,kBAAkB,EAAE,KAAK,CAAC;YACtB,MAAM,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,+BAA+B,CAAC;SAC/C,CAAC,CAAC;QACH,mBAAmB,EAAE,KAAK,CAAC;YACvB,MAAM,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,+BAA+B,CAAC;YAC5C,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC,CAAC;KACN,CAAC;IA8CF;;;;;OAKG;IACI,oBAAoB,IAAI;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,aAAa,EAAE,OAAO,CAAC;QACvB,QAAQ,EAAE,KAAK,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,EAAE,CAAA;SAAC,CAAC,CAAC;QACvD,OAAO,EAAE,KAAK,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAC,CAAC,CAAC;KACpD;IAqBD;;;;;;OAMG;WACW,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,oBAAoB;IAMlE;;;;;;OAMG;WACW,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB;IAK1D;;;;;OAKG;IACI,sBAAsB,IAAI,0BAA0B,EAAE;IAI7D;;;;;;OAMG;IACI,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO;IAO7D;;;;;;;OAOG;IACI,kBAAkB,CAAC,YAAY,cAAoB,GAAG,aAAa,EAAE;CAqB/E"}

package/dist/component-spec-runtime.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentSpecRuntime = void 0;
+const component_spec_1 = require("./component-spec");
+const core_1 = require("@memberjunction/core");
+/**
+ * Runtime extension of ComponentSpec that provides helper methods for permission checking,
+ * validation, and other runtime operations. This class is not included in AI prompts
+ * to keep token usage efficient.
+ */
+class ComponentSpecRuntime extends component_spec_1.ComponentSpec {
+    /**
+     * Get all unique permissions required by this component across all entities.
+     * This aggregates permissions from all entity data requirements to provide
+     * a complete picture of what the component needs.
+     *
+     * @returns Array of unique permission types required by the component
+     */
+    GetRequiredPermissions() {
+        const permissions = new Set();
+        this.dataRequirements?.entities.forEach(entity => {
+            entity.permissionLevelNeeded.forEach(perm => permissions.add(perm));
+        });
+        return Array.from(permissions);
+    }
+    /**
+     * Check if the component only requires read permissions across all entities.
+     * This is useful for determining if a component is effectively read-only
+     * from a permissions perspective.
+     *
+     * @returns true if the component only requires 'read' permissions
+     */
+    IsEffectivelyReadOnly() {
+        const perms = this.GetRequiredPermissions();
+        return perms.length === 1 && perms[0] === 'read';
+    }
+    /**
+     * Get all entity names that this component accesses.
+     * Useful for pre-loading permissions or understanding component data dependencies.
+     *
+     * @returns Array of entity names accessed by the component
+     */
+    GetAccessedEntities() {
+        return this.dataRequirements?.entities.map(e => e.name) || [];
+    }
+    /**
+     * Check if the component has any write capabilities (create, update, or delete).
+     * This helps determine if the component can modify data or is purely read-only.
+     *
+     * @returns true if the component requires any write permissions
+     */
+    HasWriteCapabilities() {
+        return this.GetRequiredPermissions().some(p => p === 'create' || p === 'update' || p === 'delete');
+    }
+    /**
+     * Convert component permission types to MemberJunction EntityPermissionType.
+     * This enables integration with MJ's permission system.
+     *
+     * @param permission - Component permission type
+     * @returns MemberJunction EntityPermissionType
+     */
+    convertToEntityPermissionType(permission) {
+        switch (permission) {
+            case 'read': return core_1.EntityPermissionType.Read;
+            case 'create': return core_1.EntityPermissionType.Create;
+            case 'update': return core_1.EntityPermissionType.Update;
+            case 'delete': return core_1.EntityPermissionType.Delete;
+            default: return core_1.EntityPermissionType.Read; // Safe default
+        }
+    }
+    /**
+     * Validate that a user has all required permissions to use this component.
+     * This method checks each entity's permission requirements against the user's
+     * actual permissions in MemberJunction using the Metadata system.
+     *
+     * @param user - The MemberJunction UserInfo object
+     * @returns Validation result with details about any missing permissions
+     */
+    async ValidateUserPermissions(user) {
+        const missing = [];
+        const degraded = [];
+        // Get metadata instance to access entity information
+        const md = new core_1.Metadata();
+        // Check each entity's required permissions
+        for (const entityReq of this.dataRequirements?.entities || []) {
+            // Find the entity in the metadata
+            const entityInfo = md.Entities.find(e => e.Name === entityReq.name);
+            if (!entityInfo) {
+                // Entity not found - add to missing with special reason
+                for (const requiredPerm of entityReq.permissionLevelNeeded) {
+                    missing.push({ entity: entityReq.name, permission: requiredPerm });
+                }
+                continue;
+            }
+            // Get user permissions for this entity
+            const userPerms = entityInfo.GetUserPermisions(user);
+            for (const requiredPerm of entityReq.permissionLevelNeeded) {
+                let hasPermission = false;
+                switch (requiredPerm) {
+                    case 'read':
+                        hasPermission = userPerms.CanRead;
+                        break;
+                    case 'create':
+                        hasPermission = userPerms.CanCreate;
+                        break;
+                    case 'update':
+                        hasPermission = userPerms.CanUpdate;
+                        break;
+                    case 'delete':
+                        hasPermission = userPerms.CanDelete;
+                        break;
+                }
+                if (!hasPermission) {
+                    missing.push({ entity: entityReq.name, permission: requiredPerm });
+                }
+            }
+        }
+        return {
+            canRender: missing.length === 0,
+            missingPermissions: missing,
+            degradedPermissions: degraded
+        };
+    }
+    /**
+     * Get a summary of all data access patterns for this component.
+     * Useful for documentation and understanding component behavior.
+     *
+     * @returns Object describing all data access patterns
+     */
+    GetDataAccessSummary() {
+        const entitySummary = this.dataRequirements?.entities.map(e => ({
+            name: e.name,
+            permissions: e.permissionLevelNeeded
+        })) || [];
+        const querySummary = this.dataRequirements?.queries.map(q => ({
+            name: q.name,
+            category: q.categoryPath
+        })) || [];
+        return {
+            mode: this.dataRequirements?.mode || 'none',
+            entityCount: entitySummary.length,
+            queryCount: querySummary.length,
+            requiresWrite: this.HasWriteCapabilities(),
+            entities: entitySummary,
+            queries: querySummary
+        };
+    }
+    /**
+     * Create a ComponentSpecRuntime instance from a plain object.
+     * Useful when deserializing from JSON or database storage.
+     *
+     * @param obj - Plain object with ComponentSpec properties
+     * @returns New ComponentSpecRuntime instance
+     */
+    static FromObject(obj) {
+        const instance = new ComponentSpecRuntime();
+        Object.assign(instance, obj);
+        return instance;
+    }
+    /**
+     * Create a ComponentSpecRuntime instance from JSON string.
+     * Handles parsing and object conversion in one step.
+     *
+     * @param json - JSON string representation of a ComponentSpec
+     * @returns New ComponentSpecRuntime instance
+     */
+    static FromJSON(json) {
+        const obj = JSON.parse(json);
+        return ComponentSpecRuntime.FromObject(obj);
+    }
+    /**
+     * Get all external library dependencies for this component.
+     * Returns both the library names and their global variables.
+     *
+     * @returns Array of library dependencies with details
+     */
+    GetLibraryDependencies() {
+        return this.libraries || [];
+    }
+    /**
+     * Check if this component depends on a specific library.
+     * Can check by either library name or global variable.
+     *
+     * @param libraryNameOrGlobal - Library name or global variable to check
+     * @returns true if the component depends on the specified library
+     */
+    DependsOnLibrary(libraryNameOrGlobal) {
+        return this.libraries?.some(lib => lib.name === libraryNameOrGlobal ||
+            lib.globalVariable === libraryNameOrGlobal) || false;
+    }
+    /**
+     * Get all component dependencies recursively.
+     * Traverses the entire dependency tree to return a flat list of all
+     * components this one depends on, directly or indirectly.
+     *
+     * @param visitedNames - Set of already visited component names (for cycle detection)
+     * @returns Array of all component dependencies
+     */
+    GetAllDependencies(visitedNames = new Set()) {
+        const allDeps = [];
+        // Avoid cycles
+        if (visitedNames.has(this.name)) {
+            return allDeps;
+        }
+        visitedNames.add(this.name);
+        // Process direct dependencies
+        for (const dep of this.dependencies || []) {
+            allDeps.push(dep);
+            // Recursively get subdependencies if it's a runtime instance
+            if (dep instanceof ComponentSpecRuntime) {
+                allDeps.push(...dep.GetAllDependencies(visitedNames));
+            }
+        }
+        return allDeps;
+    }
+}
+exports.ComponentSpecRuntime = ComponentSpecRuntime;
+//# sourceMappingURL=component-spec-runtime.js.map

package/dist/component-spec-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-spec-runtime.js","sourceRoot":"","sources":["../src/component-spec-runtime.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AAGjD,+CAAgF;AAEhF;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,8BAAa;IACnD;;;;;;OAMG;IACI,sBAAsB;QACzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmC,CAAC;QAE/D,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC7C,MAAM,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACI,mBAAmB;QACtB,OAAO,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,oBAAoB;QACvB,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAC1C,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,QAAQ,CACrD,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACK,6BAA6B,CAAC,UAA2C;QAC7E,QAAQ,UAAU,EAAE,CAAC;YACjB,KAAK,MAAM,CAAC,CAAC,OAAO,2BAAoB,CAAC,IAAI,CAAC;YAC9C,KAAK,QAAQ,CAAC,CAAC,OAAO,2BAAoB,CAAC,MAAM,CAAC;YAClD,KAAK,QAAQ,CAAC,CAAC,OAAO,2BAAoB,CAAC,MAAM,CAAC;YAClD,KAAK,QAAQ,CAAC,CAAC,OAAO,2BAAoB,CAAC,MAAM,CAAC;YAClD,OAAO,CAAC,CAAC,OAAO,2BAAoB,CAAC,IAAI,CAAC,CAAC,eAAe;QAC9D,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,uBAAuB,CAChC,IAAc;QAad,MAAM,OAAO,GAAyE,EAAE,CAAC;QACzF,MAAM,QAAQ,GAAyF,EAAE,CAAC;QAE1G,qDAAqD;QACrD,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAE1B,2CAA2C;QAC3C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,gBAAgB,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;YAC5D,kCAAkC;YAClC,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;YAEpE,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,wDAAwD;gBACxD,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,qBAAqB,EAAE,CAAC;oBACzD,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;gBACvE,CAAC;gBACD,SAAS;YACb,CAAC;YAED,uCAAuC;YACvC,MAAM,SAAS,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAErD,KAAK,MAAM,YAAY,IAAI,SAAS,CAAC,qBAAqB,EAAE,CAAC;gBACzD,IAAI,aAAa,GAAG,KAAK,CAAC;gBAE1B,QAAQ,YAAY,EAAE,CAAC;oBACnB,KAAK,MAAM;wBAAE,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC;wBAAC,MAAM;oBACtD,KAAK,QAAQ;wBAAE,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC;wBAAC,MAAM;oBAC1D,KAAK,QAAQ;wBAAE,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC;wBAAC,MAAM;oBAC1D,KAAK,QAAQ;wBAAE,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC;wBAAC,MAAM;gBAC9D,CAAC;gBAED,IAAI,CAAC,aAAa,EAAE,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;gBACvE,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO;YACH,SAAS,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC;YAC/B,kBAAkB,EAAE,OAAO;YAC3B,mBAAmB,EAAE,QAAQ;SAChC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,oBAAoB;QAQvB,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,WAAW,EAAE,CAAC,CAAC,qBAAqB;SACvC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEV,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC1D,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,QAAQ,EAAE,CAAC,CAAC,YAAY;SAC3B,CAAC,CAAC,IAAI,EAAE,CAAC;QAEV,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,IAAI,MAAM;YAC3C,WAAW,EAAE,aAAa,CAAC,MAAM;YACjC,UAAU,EAAE,YAAY,CAAC,MAAM;YAC/B,aAAa,EAAE,IAAI,CAAC,oBAAoB,EAAE;YAC1C,QAAQ,EAAE,aAAa;YACvB,OAAO,EAAE,YAAY;SACxB,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,GAAkB;QACvC,MAAM,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,sBAAsB;QACzB,OAAO,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,mBAA2B;QAC/C,OAAO,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAC9B,GAAG,CAAC,IAAI,KAAK,mBAAmB;YAChC,GAAG,CAAC,cAAc,KAAK,mBAAmB,CAC7C,IAAI,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,eAAe,IAAI,GAAG,EAAU;QACtD,MAAM,OAAO,GAAoB,EAAE,CAAC;QAEpC,eAAe;QACf,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC;QACnB,CAAC;QACD,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5B,8BAA8B;QAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAElB,6DAA6D;YAC7D,IAAI,GAAG,YAAY,oBAAoB,EAAE,CAAC;gBACtC,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC1D,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AAxPD,oDAwPC"}

package/dist/component-spec.d.ts

@@ -0,0 +1,65 @@
+import { ComponentEvent, ComponentProperty } from "./component-props-events";
+import { ComponentDataRequirements } from "./data-requirements";
+import { ComponentLibraryDependency } from "./library-dependency";
+/**
+ * Specification for an interactive component
+ */
+export declare class ComponentSpec {
+    name: string;
+    /**
+     * End-user friendly description of what the component does
+     */
+    description: string;
+    /**
+     * User-friendly name
+     */
+    title: string;
+    /**
+     * Self-declared type - some common options below, can be any string if the standard ones aren't sufficient
+     */
+    type: "report" | "dashboard" | "form" | "table" | "chart" | "navigation" | "search" | string;
+    /**
+     * JavaScript code
+     */
+    code: string;
+    /**
+     * A functional description of what the component should do in markdown.
+     *
+     * Describes:
+     * - Core functionality
+     * - Any business rules
+     * - Expected outcomes
+     * - UX considerations
+     */
+    functionalRequirements: string;
+    /**
+     * Describes the entities and queries a component requires to function.
+     */
+    dataRequirements?: ComponentDataRequirements;
+    /**
+     * Technical explanation of the component in markdown.
+     */
+    technicalDesign: string;
+    /**
+     * Properties the component accepts, if any
+     */
+    properties?: ComponentProperty[];
+    /**
+     * Events that the component emits, if any
+     */
+    events?: ComponentEvent[];
+    /**
+     * 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.
+     */
+    exampleUsage: string;
+    /**
+     * Describes any other components this one depends on, if any
+     */
+    dependencies?: ComponentSpec[];
+    /**
+     * 3rd party lib dependencies, if any
+     */
+    libraries?: ComponentLibraryDependency[];
+}
+//# sourceMappingURL=component-spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"component-spec.d.ts","sourceRoot":"","sources":["../src/component-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAElE;;GAEG;AACH,qBAAa,aAAa;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE7F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;IAE7C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAE1B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,EAAE,CAAC;CAC5C"}

package/dist/component-spec.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentSpec = void 0;
+/**
+ * Specification for an interactive component
+ */
+class ComponentSpec {
+}
+exports.ComponentSpec = ComponentSpec;
+;
+//# sourceMappingURL=component-spec.js.map

package/dist/component-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-spec.js","sourceRoot":"","sources":["../src/component-spec.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,MAAa,aAAa;CAqEzB;AArED,sCAqEC;AAAA,CAAC"}

package/dist/data-requirements.d.ts

@@ -1,50 +1,77 @@
-import { DataContext } from "@memberjunction/data-context";
-/**
- * This interface is critical for understanding how components interact with MemberJunction data
- */
 export interface ComponentDataRequirements {
     /**
-     * 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: ComponentEntityDataRequirement[];
-        /**
-         * Description of data access patterns
-         */
-        description?: string;
-    };
-    /**
-     * General description of data requirements
+     * How the component gets its data
+     * - 'views': Fetches data at runtime using MJ RunView()
+     * - 'queries': Fetches data at runtime using MJ RunQuery()
+     * - 'hybrid': Uses both views and queries, depending on the context
+     */
+    mode: 'views' | 'queries' | 'hybrid';
+    /**
+     * Describes the entities and fields the component will access to fulfill user requirements.
+     */
+    entities: ComponentEntityDataRequirement[];
+    /**
+     * Stored Queries that the component will use to fetch data.
+     */
+    queries: ComponentQueryDataRequirement[];
+    /**
+     * Description of data access patterns
      */
     description?: string;
 }
+/**
+ * Describes how a component will use a specific query in MemberJunction to fetch data
+ */
+export type ComponentQueryDataRequirement = {
+    /**
+     * Query name, used along with categoryPath to identify the query
+     */
+    name: string;
+    /**
+     * Full path of the category for the query. Categories can be hierarchical so a full path might be
+     * 'Membership/Users/ActiveUsers'. This helps in organizing queries and avoiding name collisions.
+     */
+    categoryPath: string;
+    /**
+     * Description of the query and how/why the component will use it
+     */
+    description?: string;
+    /**
+     * A list of the fields that the component will use out of the possible fields returned by the query.
+     * Uses the @see SimpleEntityFieldInfo type to describe each field. **NOTE** not all of the fields are actually
+     * directly related to entity fields as some might be computed/etc, but SimpleEntityFieldInfo helps define some key aspects
+     * like the data type of the column and a description of the field.
+     */
+    fields: SimpleEntityFieldInfo[];
+    /**
+     * Queries can have parameters (not all do). See @see ComponentQueryParameterValue for details.
+     */
+    parameters?: ComponentQueryParameterValue[];
+    /**
+     * This is only provided when requesting a NEW query be created. For existing queries, this will be undefined.
+     * This SQL can use Nunjucks syntax/templating for parameters including the custom filters defined in
+     */
+    newQuerySQL?: string;
+};
+/**
+ * Describes a single query parameter that a component will use when running a query.
+ */
+export type ComponentQueryParameterValue = {
+    /**
+     * Name of the parameter
+     */
+    name: string;
+    /**
+     * Value of the parameter. If the value is '@runtime', it indicates that the component will determine the value at runtime.
+     * If anything other than '@runtime' is specified, it is a hardcoded value that the component will use.
+     */
+    value: string;
+    /**
+     * Description of the parameter and how it is used in the query. This is particular important if
+     * the value is '@runtime' as it helps the component developer understand what the parameter is for and how to determine its value.
+     */
+    description?: string;
+};
 /**
  * Describes use of a single entity
  */
@@ -52,11 +79,11 @@ export type ComponentEntityDataRequirement = {
     /**
      * Name of the entity (unique system-wide)
      */
-    entityName: string;
+    name: string;
     /**
      * Description of data in the entity
      */
-    entityDescription?: string;
+    description?: string;
     /**
      * Fields to show the user
      */
@@ -79,7 +106,12 @@ export type ComponentEntityDataRequirement = {
      * When/Where/How components should use this data
      */
     usageContext?: string;
+    /**
+     * Array of permissions required by the component
+     */
+    permissionLevelNeeded: ComponentEntitySimplePermission[];
 };
+export type ComponentEntitySimplePermission = 'read' | 'create' | 'update' | 'delete';
 /**
  * Simple type to share more information about the relevant fields
  * in an entity that are to be used in a component

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

@@ -1 +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,yBAAyB;IACtC;;;;;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,8BAA8B,EAAE,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC;;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;;;;OAIG;IACH,aAAa,EAAE,qBAAqB,EAAE,CAAA;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAA;AAED;;;IAGI;AACJ,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAA"}
+{"version":3,"file":"data-requirements.d.ts","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACtC;;;;;OAKG;IACH,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IAErC;;OAEG;IACH,QAAQ,EAAE,8BAA8B,EAAE,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,6BAA6B,EAAE,CAAC;IAEzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;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;;;;OAIG;IACH,aAAa,EAAE,qBAAqB,EAAE,CAAA;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,+BAA+B,EAAE,CAAC;CAC5D,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEtF;;;IAGI;AACJ,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAA"}

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-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 './component-props-events';
 export * from './util';
+export * from './component-spec';
+export * from './component-spec-runtime';
+export * from './library-dependency';
 //# 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":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,0BAA0B,CAAC;AACzC,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,0BAA0B,CAAC;AACzC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -14,12 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__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("./component-props-events"), exports);
 __exportStar(require("./util"), exports);
+__exportStar(require("./component-spec"), exports);
+__exportStar(require("./component-spec-runtime"), exports);
+__exportStar(require("./library-dependency"), 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,8CAA4B;AAC5B,+CAA6B;AAC7B,sDAAoC;AACpC,qDAAmC;AACnC,kDAAgC;AAChC,2CAAyB;AACzB,2DAAyC;AACzC,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,qDAAmC;AACnC,kDAAgC;AAChC,2CAAyB;AACzB,2DAAyC;AACzC,yCAAuB;AACvB,mDAAiC;AACjC,2DAAyC;AACzC,uDAAqC"}

package/dist/library-dependency.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Library dependency information for a component
+ */
+export interface ComponentLibraryDependency {
+    /**
+     * Unique name of the library from our registry. Typically
+     * reuses npm style package names such as
+     * "recharts", "lodash", "dayjs", "antd" or "@memberjunction/lib-name"
+     */
+    name: string;
+    /**
+     * The global variable name used by the component to access the library in code.
+     * When the component is bootstrapped, the library is loaded into a variable in a
+     * Factory/wrapper function around it by the host.
+     */
+    globalVariable: string;
+    /**
+     * SemVer string describing minimum version requirement
+     * Example: "2.5.0" for fixed version, "^1.0.0" for minimum version
+     */
+    minVersion?: string;
+}
+//# sourceMappingURL=library-dependency.d.ts.map

package/dist/library-dependency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"library-dependency.d.ts","sourceRoot":"","sources":["../src/library-dependency.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/{root-spec.js → library-dependency.js}

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

package/dist/library-dependency.js.map

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

package/dist/util.d.ts

@@ -1,21 +1,20 @@
-import { ComponentChildSpec } from "./child-spec";
-import { ComponentRootSpec } from "./root-spec";
+import { ComponentSpec } from "./component-spec";
 /**
  * Builds the complete code for a component based on the provided spec.
  *
  * This function generates the full code representation of a component, including
- * the root component code and recursively pulling in child components and also replacing
- * the placeholders for those child components in the parent component's code with the
- * actual code for those child components (which were generated after the parent component was generated).
+ * the root component code and recursively pulling in dependency components and also replacing
+ * the placeholders for those dependency components in the parent component's code with the
+ * actual code for those dependency components (which were generated after the parent component was generated).
  *
  * @param spec - The ComponentRootSpec defining the component structure and behavior
  * @returns A string containing the complete executable JavaScript code for the component
  */
-export declare function BuildComponentCompleteCode(spec: ComponentRootSpec): string;
+export declare function BuildComponentCompleteCode(spec: ComponentSpec): string;
 /**
- * Builds the code for a component child based on the provided spec including recursive child components.
- * @param spec - The ComponentChildSpec defining the child component structure and behavior
- * @returns A string containing the executable JavaScript code for the component child
+ * Builds the code for a component dependency based on the provided spec including recursive dependency components.
+ * @param spec - The ComponentSpec defining the dependency component structure and behavior
+ * @returns A string containing the executable JavaScript code for the component dependency
  */
-export declare function BuildComponentChildCode(child: ComponentChildSpec, path: string): string;
+export declare function BuildComponentCode(dep: ComponentSpec, path: string): string;
 //# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAiB1E;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAkBvF"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAkB3E"}

package/dist/util.js

@@ -1,30 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuildComponentChildCode = exports.BuildComponentCompleteCode = void 0;
+exports.BuildComponentCode = exports.BuildComponentCompleteCode = void 0;
 /**
  * Builds the complete code for a component based on the provided spec.
  *
  * This function generates the full code representation of a component, including
- * the root component code and recursively pulling in child components and also replacing
- * the placeholders for those child components in the parent component's code with the
- * actual code for those child components (which were generated after the parent component was generated).
+ * the root component code and recursively pulling in dependency components and also replacing
+ * the placeholders for those dependency components in the parent component's code with the
+ * actual code for those dependency components (which were generated after the parent component was generated).
  *
  * @param spec - The ComponentRootSpec defining the component structure and behavior
  * @returns A string containing the complete executable JavaScript code for the component
  */
 function BuildComponentCompleteCode(spec) {
     // Start with the base code for the root component
-    let code = spec.componentCode || '// Generation Error: No root component code provided! \n\n';
-    // Recursively replace placeholders for child components with their generated code
-    if (!spec.childComponents || spec.childComponents.length === 0) {
-        // If there are no child components, return the base code for this component
+    let code = spec.code || '// Generation Error: No root component code provided! \n\n';
+    // Recursively replace placeholders for dependency components with their generated code
+    if (!spec.dependencies || spec.dependencies.length === 0) {
+        // If there are no dependency components, return the base code for this component
         return code;
     }
-    for (const child of spec.childComponents) {
-        const childCode = BuildComponentChildCode(child, "");
-        if (childCode && childCode.length > 0) {
-            // Append the generated code for this child component to the root component code
-            code += '\n\n' + childCode;
+    for (const dep of spec.dependencies) {
+        const depCode = BuildComponentCode(dep, "");
+        if (depCode && depCode.length > 0) {
+            // Append the generated code for this dependency component to the root component code
+            code += '\n\n' + depCode;
         }
     }
     // Return the complete code for this component
@@ -32,27 +32,27 @@ function BuildComponentCompleteCode(spec) {
 }
 exports.BuildComponentCompleteCode = BuildComponentCompleteCode;
 /**
- * Builds the code for a component child based on the provided spec including recursive child components.
- * @param spec - The ComponentChildSpec defining the child component structure and behavior
- * @returns A string containing the executable JavaScript code for the component child
+ * Builds the code for a component dependency based on the provided spec including recursive dependency components.
+ * @param spec - The ComponentSpec defining the dependency component structure and behavior
+ * @returns A string containing the executable JavaScript code for the component dependency
  */
-function BuildComponentChildCode(child, path) {
-    // Start with the base code for the child component
-    let commentHeader = `/*******************************************************\n   ${path ? `${path} > ` : ''}${child.componentName}\n   ${child.description}\n*******************************************************/\n`;
-    let code = commentHeader + child.componentCode;
-    // Recursively replace placeholders for child components with their generated code
-    if (!child.components || child.components.length === 0) {
-        // If there are no child components, return the base code for this child
+function BuildComponentCode(dep, path) {
+    // Start with the base code for the component
+    let commentHeader = `/*******************************************************\n   ${path ? `${path} > ` : ''}${dep.name}\n   ${dep.description}\n*******************************************************/\n`;
+    let code = commentHeader + dep.code;
+    // Recursively replace placeholders for dependency components with their generated code
+    if (!dep.dependencies || dep.dependencies.length === 0) {
+        // If there are no dependency components, return the base code for this component
         return code;
     }
-    for (const sub of child.components) {
-        const subCode = BuildComponentChildCode(sub, path + (path ? ' > ' : '') + child.componentName);
+    for (const sub of dep.dependencies) {
+        const subCode = BuildComponentCode(sub, path + (path ? ' > ' : '') + sub.name);
         if (subCode && subCode.length > 0) {
             code += '\n\n' + subCode;
         }
     }
-    // Return the complete code for this child component
+    // Return the complete code for this dependency component
     return code;
 }
-exports.BuildComponentChildCode = BuildComponentChildCode;
+exports.BuildComponentCode = BuildComponentCode;
 //# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;;;GAUG;AACH,SAAgB,0BAA0B,CAAC,IAAuB;IAC9D,kDAAkD;IAClD,IAAI,IAAI,GAAG,IAAI,CAAC,aAAa,IAAI,4DAA4D,CAAC;IAC9F,kFAAkF;IAClF,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7D,4EAA4E;QAC5E,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,uBAAuB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrD,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,gFAAgF;YAChF,IAAI,IAAI,MAAM,GAAG,SAAS,CAAC;QAC/B,CAAC;IACL,CAAC;IACD,8CAA8C;IAC9C,OAAO,IAAI,CAAC;AAChB,CAAC;AAjBD,gEAiBC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,KAAyB,EAAE,IAAY;IAC3E,mDAAmD;IACnD,IAAI,aAAa,GAAG,gEAAgE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,aAAa,QAAQ,KAAK,CAAC,WAAW,8DAA8D,CAAA;IACzN,IAAI,IAAI,GAAG,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC/C,kFAAkF;IAClF,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrD,wEAAwE;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,uBAAuB,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAC/F,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC;QAC7B,CAAC;IACL,CAAC;IACD,oDAAoD;IACpD,OAAO,IAAI,CAAC;AAChB,CAAC;AAlBD,0DAkBC"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACH,SAAgB,0BAA0B,CAAC,IAAmB;IAC1D,kDAAkD;IAClD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,4DAA4D,CAAC;IACrF,uFAAuF;IACvF,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvD,iFAAiF;QACjF,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,qFAAqF;YACrF,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC;QAC7B,CAAC;IACL,CAAC;IACD,8CAA8C;IAC9C,OAAO,IAAI,CAAC;AAChB,CAAC;AAjBD,gEAiBC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,GAAkB,EAAE,IAAY;IAC/D,6CAA6C;IAC7C,IAAI,aAAa,GAAG,gEAAgE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,WAAW,8DAA8D,CAAA;IAC5M,IAAI,IAAI,GAAG,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC;IACpC,uFAAuF;IACvF,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrD,iFAAiF;QACjF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/E,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC;QAC7B,CAAC;IACL,CAAC;IACD,yDAAyD;IACzD,OAAO,IAAI,CAAC;AAChB,CAAC;AAlBD,gDAkBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/interactive-component-types",
-  "version": "2.73.0",
+  "version": "2.75.0",
   "description": "MemberJunction: Interactive Component - Type specifications for MJ Interactive UI Componentry",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,7 +19,7 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.73.0",
-    "@memberjunction/data-context": "2.73.0"
+    "@memberjunction/core": "2.75.0",
+    "@memberjunction/data-context": "2.75.0"
   }
 }

package/dist/child-spec.d.ts

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

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

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

package/dist/child-spec.js.map

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

package/dist/root-spec.d.ts

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

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

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