OptionalchangeCurrent change request being processed, if any. Populated by Impact Assessor at the start of a modification flow. Updated by each agent as it processes the request.
This field is only present during active modification flows and for embedded components (never on registry components).
JavaScript code
OptionalcomponentDeclares the contract this component implements.
Distinct from type (which is descriptive): componentRole is a commitment that the
component's props, events, and methods conform to a role-specific contract, letting hosts
mount it generically and letting authoring agents target a known shape.
form: implements FormHostProps + standard form events/methods (see @memberjunction/interactivecomponents/forms).
Hosted by InteractiveFormComponent against a BaseEntity record.dashboard | widget | report | detail-pane: reserved for future role contracts.Unset = a generic component, mounted directly. No behavior change for existing components.
OptionalcreateWhen an architect decides to use an existing component as a base for a new version, they can set this flag to true. This indicates that the new version will be created based on the existing component based on the namespace/name/version specified above
OptionaldataDescribes the entities and queries a component requires to function.
OptionaldependenciesDescribes any other components this one depends on, if any
End-user friendly description of what the component does
OptionaldiagramsOptional array of diagrams that use Mermaid syntax to illustrate component design. When provided each entry in the array specifies a title, optional description and the mermaid content itself. Examples of diagrams include:
OptionaleventsEvents that the component emits, if any
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.
A functional description of what the component should do in markdown.
Describes:
OptionallatestResult of the most recent test harness execution. Tells downstream agents whether the current code is working or broken.
Only populated for embedded components after code generation completes. Registry components do not have test results as they are pre-tested.
Optionallibraries3rd party lib dependencies, if any
Components can be embedded or registry. Registry means we don't have the code directly here nor do we generate the code, we simply use the component from its registry
OptionalmethodsMetadata about methods the component supports, if any
OptionalnamespaceUsed when location === "registry", a hierarchical namespace such as "crm/analytics/accounts". The combination of the namespace and name are how a registry component is loaded. Registry components might have a root level segment that starts with @ such as "@memberjunction/examples/entities" or if the root segment doesn't have @ that means the component is local to that registry
OptionalpropertiesProperties the component accepts, if any
OptionalreadinessSelf-declared maturity level of the component. When a component is "in progress" and is not yet complete but is partially done, it can be marked as "incomplete". When it is functionally complete but not yet widely tested, it can be marked as "beta". When it is fully complete and tested, it can be marked as "production". This is intended to help architects and developers understand the readiness of a component for use in production systems.
OptionalregistryUsed when location === 'registry' - the unique name of a given registry without the @ sign for example MJ or Skip would be valid globally unique registry names (as registered with MemberJunction.org) You would not include @ here. Fully qualified component identifiers would be @Registry/Namespace/Name/Version but in the context of this field it is just the registry name.
OptionalrelevantRelevant examples of components intended to inspire this component's creation
OptionalselectionOnly used when location === 'registry', logic explaining why this component is being selected to serve a specific use case or requirement
Technical explanation of the component in markdown.
User-friendly name
Self-declared type - some common options below, can be any string if the standard ones aren't sufficient
OptionaltypeOptional: Custom type definitions for complex prop types (e.g., ColumnDef, FieldDefinition). Similar to TypeScript interfaces, used for lint-time validation of object literals.
OptionalversionUsed when location === "registry", a semantic versioning string such as "1.0.0" "^1.0.0" "~1.0.0" Follows conventions documented here: https://semver.org/ and https://docs.npmjs.com/about-semantic-versioning
OptionalworkIf a component isn't complete or encounters problems in testing, this field can be used to track a work plan for completing or fixing the component. Generally this work plan string will contain a markdown formatted list of tasks to be done with rich explanations to allow developers (human+AI) to collaborate on completing the component.
Optional metadata provider override. Callers should set
instance.Provider = providerToUse before invoking permission-checking methods
in multi-provider contexts. Falls back to the global default provider when unset.
Check if this component depends on a specific library. Can check by either library name or global variable.
Library name or global variable to check
true if the component depends on the specified library
Get all entity names that this component accesses. Useful for pre-loading permissions or understanding component data dependencies.
Array of entity names accessed by the component
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.
Set of already visited component names (for cycle detection)
Array of all component dependencies
Get a summary of all data access patterns for this component. Useful for documentation and understanding component behavior.
Object describing all data access patterns
Get all external library dependencies for this component. Returns both the library names and their global variables.
Array of library dependencies with details
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.
Array of unique permission types required by the component
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.
true if the component requires any write 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.
true if the component only requires 'read' permissions
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.
The MemberJunction UserInfo object
Validation result with details about any missing permissions
StaticFromCreate a ComponentSpecRuntime instance from JSON string. Handles parsing and object conversion in one step.
JSON string representation of a ComponentSpec
New ComponentSpecRuntime instance
StaticFromCreate a ComponentSpecRuntime instance from a plain object. Useful when deserializing from JSON or database storage.
Plain object with ComponentSpec properties
New ComponentSpecRuntime instance
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.