@memberjunction/skip-types 2.44.0 → 2.46.0

package/dist/artifact-types.d.ts

@@ -0,0 +1,142 @@
+/**
+ * @fileoverview Artifact management types for Skip API
+ *
+ * This file contains types related to artifacts - persistent objects created and managed
+ * through Skip conversations. These types define the structure for:
+ *
+ * - Artifact definitions and metadata (SkipAPIArtifact)
+ * - Artifact type specifications (SkipAPIArtifactType)
+ * - Artifact versioning (SkipAPIArtifactVersion)
+ * - Artifact creation requests (SkipAPIArtifactRequest)
+ *
+ * Artifacts in Skip represent persistent outputs from AI interactions that can be
+ * saved, versioned, shared, and iterated upon. They can contain various types of
+ * content including reports, code, documents, or other structured data that users
+ * want to preserve and refine over time.
+ *
+ * The artifact system supports versioning, allowing users to see the evolution of
+ * AI-generated content and compare different iterations. It also includes sharing
+ * capabilities and user feedback mechanisms to improve future artifact generation.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+/**
+ * Defines information about a single artifact type
+ */
+export type SkipAPIArtifactType = {
+    id: string;
+    name: string;
+    description: string;
+    /**
+     * MIME type or content identifier for this artifact type
+     */
+    contentType: string;
+    enabled: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * Represents a specific version of an artifact, containing the actual content,
+ * configuration, and user feedback for that version. Each artifact can have
+ * multiple versions as it evolves through user interactions.
+ */
+export type SkipAPIArtifactVersion = {
+    /**
+     * Primary key for the artifact version - globally unique
+     */
+    id: string;
+    /**
+     * Foreign key to the related artifact - not using a link to the object here to avoid circular references
+     */
+    artifactId: string;
+    /**
+     * Auto increment sequential version, start with 1 for each artifact
+     */
+    version: number;
+    /**
+     * The contents of this field are dependent on the artifact type, in some cases it might be unused, in others it might be JSON, plain text, or even base-64 encoded binary data for something like an image
+     */
+    configuration: string;
+    /**
+     * The contents of this field are dependent on the artifact type, in some cases it might be unused, in others it might be JSON, plain text, or even base-64 encoded binary data for something like an image
+     */
+    content: string;
+    /**
+     * User comments for this specific version of the artifact, used for user's own purposes and can be used as feedback loop for AI to learn from and improve future versions/responses.
+     */
+    comments: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * Complete artifact definition including metadata, type information, sharing settings,
+ * and all versions. Artifacts are the primary way to persist and version AI-generated
+ * content across conversations.
+ */
+export type SkipAPIArtifact = {
+    /**
+     * Primary key for the artifact
+     */
+    id: string;
+    /**
+     * AI generated name for the artifact
+     */
+    name: string;
+    /**
+     * AI generated description for the artifact
+     * This is a short description of the artifact that is generated by the AI system and is used to provide context for the artifact
+     */
+    description: string;
+    /**
+     * Foreign key to the related conversation
+     */
+    conversationId: string;
+    /**
+     * Related artifact type
+     */
+    artifactType: SkipAPIArtifactType;
+    /**
+     * Defines the level of sharing the owner of this artifact (which is the owner of the related conversation) has selected for this artifact
+     */
+    sharingScope: 'None' | 'SpecificUsers' | 'Everyone' | 'Public';
+    /**
+     * Comments from the user about the artifact
+     */
+    comments: string;
+    /**
+     * Array of versions of this artifact
+     * This is a one-to-many relationship, where each artifact can have multiple versions
+     */
+    versions: SkipAPIArtifactVersion[];
+    createdAt: Date;
+    updatedAt: Date;
+};
+/**
+ * Defines the shape of the data that is used to request an artifact from the Skip API Server
+ */
+export type SkipAPIArtifactRequest = {
+    /**
+     * The agent should request new_artifact if an entirely new artifact should be created. This should be selected if there are no existing artifacts in the
+     * conversation, OR if the user has asked for something that is not logically related to existing artifacts for the given conversation and it makes more
+     * sense to create a new artifact entirely.
+     *
+     * new_artifact_version, on the other hand, should be used when the user has asked for something that is logically related to an existing artifact and it is
+     * most logical to add a new version to that existing artifact for example iterating on various versions of a report over time.
+     */
+    action: "new_artifact" | "new_artifact_version";
+    /**
+     * This is only provided when action === 'new_artifact_version' and is used to indicate the artifact that a new version is being added to. When action == 'new_artifact'
+     * this property is not used.
+     */
+    artifactId?: string;
+    /**
+     * The name of the artifact or artifact version that is being created. Generated by the AI agent.
+     */
+    name: string;
+    /**
+     * The description of the artifact or artifact version that is being created. Generated by the AI agent.
+     */
+    description: string;
+};
+//# sourceMappingURL=artifact-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"artifact-types.d.ts","sourceRoot":"","sources":["../src/artifact-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,mBAAmB,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAE,eAAe,GAAE,UAAU,GAAE,QAAQ,CAAC;IAE5D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IAEnC,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC;;;;;;;OAOG;IACH,MAAM,EAAE,cAAc,GAAG,sBAAsB,CAAC;IAEhD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB,CAAA"}

package/dist/artifact-types.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * @fileoverview Artifact management types for Skip API
+ *
+ * This file contains types related to artifacts - persistent objects created and managed
+ * through Skip conversations. These types define the structure for:
+ *
+ * - Artifact definitions and metadata (SkipAPIArtifact)
+ * - Artifact type specifications (SkipAPIArtifactType)
+ * - Artifact versioning (SkipAPIArtifactVersion)
+ * - Artifact creation requests (SkipAPIArtifactRequest)
+ *
+ * Artifacts in Skip represent persistent outputs from AI interactions that can be
+ * saved, versioned, shared, and iterated upon. They can contain various types of
+ * content including reports, code, documents, or other structured data that users
+ * want to preserve and refine over time.
+ *
+ * The artifact system supports versioning, allowing users to see the evolution of
+ * AI-generated content and compare different iterations. It also includes sharing
+ * capabilities and user feedback mechanisms to improve future artifact generation.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=artifact-types.js.map

package/dist/artifact-types.js.map

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

package/dist/auth-types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @fileoverview Authentication and API key types for Skip API
+ *
+ * This file contains types related to authentication and API key management
+ * within the Skip API system. These types define the structure for:
+ *
+ * - API key specifications for different AI vendors (SkipAPIRequestAPIKey)
+ *
+ * The authentication system allows clients to provide API keys for various
+ * AI service providers that Skip will use on behalf of the client. This enables
+ * Skip to access different AI models and services while maintaining security
+ * by not storing these credentials permanently.
+ *
+ * The vendor driver names correspond to registered classes in the MemberJunction
+ * AI namespace that provide standardized interfaces to different AI providers
+ * such as OpenAI, Anthropic, Google, and others.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+/**
+ * Defines the API key information for AI service providers that Skip will use
+ * on behalf of the client. Skip never stores these credentials - they are only
+ * used for the duration of the request to access the specified AI services.
+ */
+export declare class SkipAPIRequestAPIKey {
+    /**
+     * These are the supported LLM vendors that Skip can use. These driver names map to the
+     * registered classes in the MemberJunction AI namespace for example the @memberjunction/ai-openai package includes
+     * a class called OpenAILLM that is registered with the MemberJunction AI system as a valid sub-class of BaseLLM
+     */
+    vendorDriverName: 'OpenAILLM' | 'MistralLLM' | 'GeminiLLM' | 'AnthropicLLM' | 'GroqLLM';
+    /**
+     * This is the actual API key for the specified vendor.
+     * NOTE: Skip NEVER stores this information, it is only used to make requests to the AI vendor of choice
+     */
+    apiKey: string;
+}
+//# sourceMappingURL=auth-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth-types.d.ts","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;GAIG;AACH,qBAAa,oBAAoB;IAC7B;;;;OAIG;IACH,gBAAgB,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,SAAS,CAAC;IACxF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/auth-types.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * @fileoverview Authentication and API key types for Skip API
+ *
+ * This file contains types related to authentication and API key management
+ * within the Skip API system. These types define the structure for:
+ *
+ * - API key specifications for different AI vendors (SkipAPIRequestAPIKey)
+ *
+ * The authentication system allows clients to provide API keys for various
+ * AI service providers that Skip will use on behalf of the client. This enables
+ * Skip to access different AI models and services while maintaining security
+ * by not storing these credentials permanently.
+ *
+ * The vendor driver names correspond to registered classes in the MemberJunction
+ * AI namespace that provide standardized interfaces to different AI providers
+ * such as OpenAI, Anthropic, Google, and others.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipAPIRequestAPIKey = void 0;
+/**
+ * Defines the API key information for AI service providers that Skip will use
+ * on behalf of the client. Skip never stores these credentials - they are only
+ * used for the duration of the request to access the specified AI services.
+ */
+class SkipAPIRequestAPIKey {
+}
+exports.SkipAPIRequestAPIKey = SkipAPIRequestAPIKey;
+//# sourceMappingURL=auth-types.js.map

package/dist/auth-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-types.js","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;AAEH;;;;GAIG;AACH,MAAa,oBAAoB;CAYhC;AAZD,oDAYC"}

package/dist/component-types.d.ts

@@ -0,0 +1,351 @@
+/**
+ * @fileoverview Component interface types for Skip API
+ *
+ * This file contains types that define the interface between Skip-generated components
+ * and their container applications. These types enable rich, interactive components that
+ * can communicate with the host MemberJunction environment. The types define:
+ *
+ * - Component callback interfaces for parent-child communication (SkipComponentCallbacks)
+ * - Component object interfaces that Skip components must implement (SkipComponentObject)
+ * - Initialization parameters and utility interfaces (SkipComponentInitParams, SkipComponentUtilities)
+ * - Styling and theming interfaces (SkipComponentStyles)
+ * - Simplified metadata and data access interfaces (SimpleMetadata, SimpleRunView, SimpleRunQuery)
+ *
+ * Components generated by Skip implement the SkipComponentObject interface and expose
+ * themselves globally on the window object, allowing container applications to initialize,
+ * refresh, and print them. The components can call back to the container through the provided
+ * callback functions to refresh data, open records, update user state, and send custom events.
+ *
+ * The utility interfaces provide Skip components with controlled access to the MemberJunction
+ * system for dynamic data access, metadata queries, and view execution without requiring
+ * full access to the underlying MJ APIs.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+import { CompositeKey } from "@memberjunction/core";
+import { SimpleDataContext } from "./shared";
+import { SimpleMetadata, SimpleRunQuery, SimpleRunView } from "./shared";
+/**
+ * This interface defines the available callback functions that a Skip component might call in the parent.
+ */
+export interface SkipComponentCallbacks {
+    /**
+     * The component can invoke this method in the callbacks object, when provided, to refresh the data context
+     * and that will in turn result in the component's init function being called again with the new data context.
+     * @returns
+     */
+    RefreshData: () => void;
+    /**
+     * If an action occurs inside a component where it would be desirable for the containing UI to open a specific
+     * record, if supported, this event can be listened to and the container UI can then open the record.
+     * @param entityName - this is the Entity NAME from the Entity metadata, not the table name or base view name. Use Entity Metadata to provide the entity name here
+     * @param key - this is an array of key/value pairs representing the primary key. The format of a Composite Key is an array of KeyValuePair objects and KeyValuePair objects simply have FieldName and Value properties. In most cases entities have single-valued primary keys but this structure is here for complex entity types that have composite primary keys
+     * @returns
+     */
+    OpenEntityRecord: (entityName: string, key: CompositeKey) => void;
+    /**
+     * This event should be raised by the HTML component whenever something changes within the component that should be tracked as a change in state
+     * that will persist. userState is any valid, simple JavaScript object, meaning it can have scalars, arrays, objects, etc, it must be an object that
+     * can be serialized to JSON, but otherwise has no special requirements. The parent component will be responsible for tracking the user-specific states
+     * and passing them back to the HTML component each time it is loaded or if the user changes via the init function.
+     * @param userState
+     * @returns
+     */
+    UpdateUserState: (userState: any) => void;
+    /**
+     * Used for any other type of event notification that a component might want to send to the parent component.
+     * @param eventName
+     * @param eventData
+     * @returns
+     */
+    NotifyEvent: (eventName: string, eventData: any) => void;
+}
+/**
+ * This is the function signature for the initialization function provided by each Skip component via the SkipComponentObject so that a container can interact with it.
+ * This function is called when the component is loaded by its container. The function receives the data context, an optional userState property, and a set of callbacks that can be used to interact with the parent component.
+ * userState is an optional parameter that can be used to pass in any state information that the parent component wants to provide to the component that is specific
+ * to the CURRENT user. If the component modifies the userState, it should notify the parent component via the UserStateChanged event in the callbacks object so that the parent component can handle storage.
+ */
+export type SkipComponentInitFunction = (params: SkipComponentInitParams) => void;
+/**
+ * This is the function signature for the print function that is provided by the component via the SkipComponentObject
+ */
+export type SkipComponentPrintFunction = () => void;
+/**
+ * This is the function signature for the refresh function that is provided by the component via the SkipComponentObject
+ */
+export type SkipComponentRefreshFunction = () => void;
+/**
+ * Parameters that are passed to the SkipComponentInitFunction when it is called by the parent component.
+ */
+export interface SkipComponentInitParams {
+    data: SimpleDataContext;
+    utilities?: SkipComponentUtilities;
+    userState?: any;
+    callbacks?: SkipComponentCallbacks;
+    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;
+}
+/**
+ * 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;
+};
+/**
+ * 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
+     */
+    functionalRequirements: string;
+    /**
+     * A technical description of how the component is designed and implemented
+     */
+    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";
+    /**
+     * The type of data access this component uses, static means that the data is provided to the component as static data during the initialization
+     * process described in the @interface SkipComponentObject interface, dynamic means that the component will use capabilities provided by
+     * the SkipComponentObject interface to dynamically access data from the MemberJunction instance that it is running within. 'both' means
+     * that the component can use both static and dynamic data access methods, and 'none' means that the component does not use any data (rare, but possible for example if
+     * a component does something other than show data or if it uses 3rd party data sources via API that are not related to the MJ instance it is running within).
+     */
+    dataAccessType: 'static' | 'dynamic' | 'both' | 'none';
+    /**
+     * A description of what this component does
+     */
+    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;
+};
+/**
+ * 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 detailed description of what this child component does
+     */
+    description: 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=component-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.d.ts","sourceRoot":"","sources":["../src/component-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,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,IAAI,EAAE,iBAAiB,CAAC;IACxB,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,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;AAED;;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;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;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;;;;;;OAMG;IACH,cAAc,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IAEvD;;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,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;AAGF;;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;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,sBAAsB,EAAE,CAAC;CACxC"}

package/dist/component-types.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @fileoverview Component interface types for Skip API
+ *
+ * This file contains types that define the interface between Skip-generated components
+ * and their container applications. These types enable rich, interactive components that
+ * can communicate with the host MemberJunction environment. The types define:
+ *
+ * - Component callback interfaces for parent-child communication (SkipComponentCallbacks)
+ * - Component object interfaces that Skip components must implement (SkipComponentObject)
+ * - Initialization parameters and utility interfaces (SkipComponentInitParams, SkipComponentUtilities)
+ * - Styling and theming interfaces (SkipComponentStyles)
+ * - Simplified metadata and data access interfaces (SimpleMetadata, SimpleRunView, SimpleRunQuery)
+ *
+ * Components generated by Skip implement the SkipComponentObject interface and expose
+ * themselves globally on the window object, allowing container applications to initialize,
+ * refresh, and print them. The components can call back to the container through the provided
+ * callback functions to refresh data, open records, update user state, and send custom events.
+ *
+ * The utility interfaces provide Skip components with controlled access to the MemberJunction
+ * system for dynamic data access, metadata queries, and view execution without requiring
+ * full access to the underlying MJ APIs.
+ *
+ * @author MemberJunction
+ * @since 2.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=component-types.js.map

package/dist/component-types.js.map

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