@memberjunction/skip-types 2.67.0 → 2.69.0

package/dist/child-spec.d.ts

@@ -1,3 +1,4 @@
+import { SkipComponentEvent, SkipComponentProperty } from "./component-props-events";
 import { SkipComponentDataRequirements } from "./data-requirements";
 /**
  * Represents a child component within a component hierarchy
@@ -36,13 +37,28 @@ export interface SkipComponentChildSpec {
      */
     functionalRequirements?: string;
     /**
-     * Data requirements for this child component.
-     * Child components inherit static data from their parent component's data context.
-     * However, they can define their own dynamic data requirements for entities they need to access at runtime.
+     * 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`
+     *
+     * This is **not** the same as the dataProps array shown below which is the manifest of the possible
+     * sub-properties that can be passed into the component in its `data` property.
      *
      * @since 2.1.0 - Enhanced documentation for clarity
      */
     dataRequirements?: SkipComponentDataRequirements;
+    /**
+     * 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?: SkipComponentProperty[];
+    /**
+     * An optional array of events that the component emits.
+     * This allows consumers of the component to understand what events they can listen to.
+     * Each event should have a name and a description of what it does.
+     */
+    events?: SkipComponentEvent[];
     /**
      * Technical design details for this child component.
      * This should be in markdown format and describe the implementation approach.

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

@@ -1 +1 @@
-{"version":3,"file":"child-spec.d.ts","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,sBAAsB,EAAE,CAAC;CACxC"}
+{"version":3,"file":"child-spec.d.ts","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE9B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,sBAAsB,EAAE,CAAC;CACxC"}

package/dist/component-props-events.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Definition of a single property of a component.
+ */
+export interface SkipComponentProperty {
+    /**
+     * The name of the property
+     */
+    name: string;
+    /**
+     * A description of what this property is used for
+     */
+    description: string;
+    /**
+     * The type of the property.
+     * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
+     * These types are for aligning users of the component. Components are in JavaScript and do not
+     * actually enforce types at runtime, but this is used to provide guidance for users (AI and Human)
+     */
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
+    /**
+     * Indicates if this property is required for the component to function correctly.
+     * If true, the component will not work without this property being set.
+     */
+    required: boolean;
+    /**
+     * The default value, if any, for this property if it is not provided.
+     */
+    defaultValue?: any;
+    /**
+     * Optional list of possible values for this property.
+     */
+    possibleValues?: string[];
+}
+/**
+ * Definition of a single event of a component.
+ */
+export interface SkipComponentEvent {
+    /**
+     * The name of the event
+     */
+    name: string;
+    /**
+     * A description of what this event does
+     */
+    description: string;
+    /**
+     * An array of parameters that this event can emit.
+     */
+    parameters?: SkipComponentEventParameter[];
+}
+export interface SkipComponentEventParameter {
+    /**
+     * The name of the parameter
+     */
+    name: string;
+    /**
+     * A description of what this parameter is used for
+     */
+    description: string;
+    /**
+     * The type of the parameter.
+     * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
+     */
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
+}
+//# sourceMappingURL=component-props-events.d.ts.map

package/dist/component-props-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-props-events.d.ts","sourceRoot":"","sources":["../src/component-props-events.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,CAAC;IAChF;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,2BAA2B,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,CAAC;CACnF"}

package/dist/component-props-events.js

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

package/dist/component-props-events.js.map

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

package/dist/data-requirements.d.ts

@@ -7,9 +7,9 @@ import { DataContext } from "@memberjunction/data-context";
 export interface SkipComponentDataRequirements {
     /**
      * The primary data access mode for this component.
-     * - 'static': Data is pre-loaded and passed to the component during initialization
      * - 'dynamic': Component fetches data at runtime using MJ utilities
-     * - 'hybrid': Component uses both static and dynamic data access patterns
+     * - 'static': Static is deprecated, use dynamic. Data is pre-loaded and passed to the component during initialization
+     * - 'hybrid': Hybrid is deprecated, use dynamic. Uses both static and dynamic data access patterns
      */
     mode: 'static' | 'dynamic' | 'hybrid';
     /**
@@ -19,6 +19,7 @@ export interface SkipComponentDataRequirements {
      * - Reports with fixed datasets
      * - Components where users don't need entity-level permissions
      * - Scenarios requiring reduced database load
+     * @deprecated Use dynamicData instead
      */
     staticData?: {
         /**
@@ -51,33 +52,11 @@ export interface SkipComponentDataRequirements {
          */
         description?: string;
     };
-    /**
-     * For hybrid mode: Components can use both static and dynamic data access.
-     * Both staticData and dynamicData sections should be populated.
-     * Hybrid mode is useful for:
-     * - Components with both summary (static) and detail (dynamic) views
-     * - Optimizing performance while maintaining interactivity
-     */
-    hybridStrategy?: {
-        /**
-         * Description of how the component decides when to use static vs dynamic data
-         */
-        description: string;
-        /**
-         * Optional performance considerations for the hybrid approach
-         */
-        performanceNotes?: string;
-    };
     /**
      * General description of the component's data requirements and access patterns.
      * This should provide a high-level overview of the data strategy.
      */
     description?: string;
-    /**
-     * Security considerations for data access
-     * @since 2.1.0
-     */
-    securityNotes?: string;
 }
 /**
  * Specifications for the use of a single entity within a Skip component.

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;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEtC;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE;QACT;;;WAGG;QACH,WAAW,EAAE,WAAW,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE;QACV;;;;WAIG;QACH,gBAAgB,EAAE,kCAAkC,EAAE,CAAC;QAEvD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QACb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAA"}
+{"version":3,"file":"data-requirements.d.ts","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEtC;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE;QACT;;;WAGG;QACH,WAAW,EAAE,WAAW,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE;QACV;;;;WAIG;QACH,gBAAgB,EAAE,kCAAkC,EAAE,CAAC;QAEvD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAA"}

package/dist/index.d.ts

@@ -12,5 +12,6 @@ export * from './data-requirements';
 export * from './component-option';
 export * from './runtime-types';
 export * from './shared';
+export * from './component-props-events';
 export * from './util';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -29,5 +29,6 @@ __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);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/skip-types",
-  "version": "2.67.0",
+  "version": "2.69.0",
   "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/core": "2.67.0",
-    "@memberjunction/core-entities": "2.67.0",
-    "@memberjunction/data-context": "2.67.0"
+    "@memberjunction/core": "2.69.0",
+    "@memberjunction/core-entities": "2.69.0",
+    "@memberjunction/data-context": "2.69.0"
   }
 }