@memberjunction/skip-types 3.4.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/agent-types.d.ts +4 -4
  2. package/dist/agent-types.js +7 -17
  3. package/dist/agent-types.js.map +1 -1
  4. package/dist/api-types.d.ts +6 -6
  5. package/dist/api-types.js +6 -13
  6. package/dist/api-types.js.map +1 -1
  7. package/dist/artifact-types.js +1 -2
  8. package/dist/artifact-types.js.map +1 -1
  9. package/dist/auth-types.js +1 -5
  10. package/dist/auth-types.js.map +1 -1
  11. package/dist/child-spec.d.ts +72 -0
  12. package/dist/child-spec.d.ts.map +1 -0
  13. package/dist/child-spec.js +3 -0
  14. package/dist/child-spec.js.map +1 -0
  15. package/dist/component-option.d.ts +32 -0
  16. package/dist/component-option.d.ts.map +1 -0
  17. package/dist/component-option.js +3 -0
  18. package/dist/component-option.js.map +1 -0
  19. package/dist/component-props-events.d.ts +66 -0
  20. package/dist/component-props-events.d.ts.map +1 -0
  21. package/dist/component-props-events.js +3 -0
  22. package/dist/component-props-events.js.map +1 -0
  23. package/dist/conversation-types.d.ts +1 -1
  24. package/dist/conversation-types.js +3 -9
  25. package/dist/conversation-types.js.map +1 -1
  26. package/dist/data-requirements.d.ts +77 -0
  27. package/dist/data-requirements.d.ts.map +1 -0
  28. package/dist/data-requirements.js +3 -0
  29. package/dist/data-requirements.js.map +1 -0
  30. package/dist/entity-metadata-types.js +1 -2
  31. package/dist/index.d.ts +9 -9
  32. package/dist/index.js +9 -25
  33. package/dist/index.js.map +1 -1
  34. package/dist/query-types.js +7 -16
  35. package/dist/query-types.js.map +1 -1
  36. package/dist/response-types.d.ts +5 -5
  37. package/dist/response-types.js +7 -16
  38. package/dist/response-types.js.map +1 -1
  39. package/dist/root-spec.d.ts +72 -0
  40. package/dist/root-spec.d.ts.map +1 -0
  41. package/dist/root-spec.js +3 -0
  42. package/dist/root-spec.js.map +1 -0
  43. package/dist/runtime-types.d.ts +211 -0
  44. package/dist/runtime-types.d.ts.map +1 -0
  45. package/dist/runtime-types.js +3 -0
  46. package/dist/runtime-types.js.map +1 -0
  47. package/dist/shared.d.ts +44 -0
  48. package/dist/shared.d.ts.map +1 -0
  49. package/dist/shared.js +3 -0
  50. package/dist/shared.js.map +1 -0
  51. package/dist/util.d.ts +1 -1
  52. package/dist/util.js +18 -36
  53. package/dist/util.js.map +1 -1
  54. package/package.json +8 -7
@@ -20,10 +20,10 @@
20
20
  * Notes provide a way for Skip to store and retrieve organizational knowledge, user
21
21
  * preferences, and contextual information that improves future interactions.
22
22
  */
23
- import type { SkipConversation } from './conversation-types';
24
- import type { SkipEntityInfo } from './entity-metadata-types';
25
- import type { SkipQueryInfo, SkipLearningCycleQueryChange } from './query-types';
26
- import type { SkipAPIRequestAPIKey } from './auth-types';
23
+ import type { SkipConversation } from './conversation-types.js';
24
+ import type { SkipEntityInfo } from './entity-metadata-types.js';
25
+ import type { SkipQueryInfo, SkipLearningCycleQueryChange } from './query-types.js';
26
+ import type { SkipAPIRequestAPIKey } from './auth-types.js';
27
27
  /**
28
28
  * Type that defines a possible note type from the source system that invoked Skip
29
29
  */
@@ -1,4 +1,3 @@
1
- "use strict";
2
1
  /**
3
2
  * @fileoverview AI Agent and learning cycle types for Skip API
4
3
  *
@@ -21,53 +20,44 @@
21
20
  * Notes provide a way for Skip to store and retrieve organizational knowledge, user
22
21
  * preferences, and contextual information that improves future interactions.
23
22
  */
24
- Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.SkipAPILearningCycleResponse = exports.SkipAPILearningCycleRequest = exports.SkipLearningCycleRequestChange = exports.SkipLearningCycleNoteChange = exports.SkipAPIAgentRequest = exports.SkipAPIAgentNote = exports.SkipAPIAgentNoteType = void 0;
26
23
  /**
27
24
  * Type that defines a possible note type from the source system that invoked Skip
28
25
  */
29
- class SkipAPIAgentNoteType {
26
+ export class SkipAPIAgentNoteType {
30
27
  }
31
- exports.SkipAPIAgentNoteType = SkipAPIAgentNoteType;
32
28
  /**
33
29
  * Defines the shape of an individual Agent note that is stored in MJ that can be passed to Skip for additional context.
34
30
  */
35
- class SkipAPIAgentNote {
31
+ export class SkipAPIAgentNote {
36
32
  }
37
- exports.SkipAPIAgentNote = SkipAPIAgentNote;
38
33
  /**
39
34
  * Whenever an agent is interested in getting human-in-the-loop style feedback/approval, this type is used
40
35
  */
41
- class SkipAPIAgentRequest {
36
+ export class SkipAPIAgentRequest {
42
37
  }
43
- exports.SkipAPIAgentRequest = SkipAPIAgentRequest;
44
38
  /**
45
39
  * Represents a change to agent notes during the learning cycle process, allowing Skip
46
40
  * to add new notes, update existing ones, or mark notes for deletion based on
47
41
  * its analysis of conversation patterns and organizational learning.
48
42
  */
49
- class SkipLearningCycleNoteChange {
43
+ export class SkipLearningCycleNoteChange {
50
44
  }
51
- exports.SkipLearningCycleNoteChange = SkipLearningCycleNoteChange;
52
45
  /**
53
46
  * Represents a change to agent requests during the learning cycle process, allowing Skip
54
47
  * to add new requests, update existing ones, or mark requests for deletion based on
55
48
  * its analysis of conversation patterns and user feedback.
56
49
  */
57
- class SkipLearningCycleRequestChange {
50
+ export class SkipLearningCycleRequestChange {
58
51
  }
59
- exports.SkipLearningCycleRequestChange = SkipLearningCycleRequestChange;
60
52
  /**
61
53
  * API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests
62
54
  */
63
- class SkipAPILearningCycleRequest {
55
+ export class SkipAPILearningCycleRequest {
64
56
  }
65
- exports.SkipAPILearningCycleRequest = SkipAPILearningCycleRequest;
66
57
  /**
67
58
  * API Response shape to ask the /learn end point to learn from conversation history and pass back "notes", an array of notes are provided that should be stored in the database
68
59
  * to then be passed into future Skip API requests for analysis/etc.
69
60
  */
70
- class SkipAPILearningCycleResponse {
61
+ export class SkipAPILearningCycleResponse {
71
62
  }
72
- exports.SkipAPILearningCycleResponse = SkipAPILearningCycleResponse;
73
63
  //# sourceMappingURL=agent-types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"agent-types.js","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAOH;;GAEG;AACH,MAAa,oBAAoB;CAIhC;AAJD,oDAIC;AAED;;GAEG;AACH,MAAa,gBAAgB;CAqC5B;AArCD,4CAqCC;AAED;;GAEG;AACH,MAAa,mBAAmB;CA8D/B;AA9DD,kDA8DC;AAED;;;;GAIG;AACH,MAAa,2BAA2B;CAGvC;AAHD,kEAGC;AAED;;;;GAIG;AACH,MAAa,8BAA8B;CAG1C;AAHD,wEAGC;AAED;;GAEG;AACH,MAAa,2BAA2B;CA6DvC;AA7DD,kEA6DC;AAED;;;GAGG;AACH,MAAa,4BAA4B;CAmCxC;AAnCD,oEAmCC"}
1
+ {"version":3,"file":"agent-types.js","sourceRoot":"","sources":["../src/agent-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAOH;;GAEG;AACH,MAAM,OAAO,oBAAoB;CAIhC;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;CAqC5B;AAED;;GAEG;AACH,MAAM,OAAO,mBAAmB;CA8D/B;AAED;;;;GAIG;AACH,MAAM,OAAO,2BAA2B;CAGvC;AAED;;;;GAIG;AACH,MAAM,OAAO,8BAA8B;CAG1C;AAED;;GAEG;AACH,MAAM,OAAO,2BAA2B;CA6DvC;AAED;;;GAGG;AACH,MAAM,OAAO,4BAA4B;CAmCxC"}
@@ -12,12 +12,12 @@
12
12
  * across all Skip API interactions regardless of the specific functionality being invoked.
13
13
  */
14
14
  import { DataContext } from '@memberjunction/data-context';
15
- import type { SkipMessage } from './conversation-types';
16
- import type { SkipEntityInfo } from './entity-metadata-types';
17
- import type { SkipQueryInfo } from './query-types';
18
- import type { SkipAPIRequestAPIKey } from './auth-types';
19
- import type { SkipAPIArtifact } from './artifact-types';
20
- import type { SkipAPIAgentNote, SkipAPIAgentNoteType } from './agent-types';
15
+ import type { SkipMessage } from './conversation-types.js';
16
+ import type { SkipEntityInfo } from './entity-metadata-types.js';
17
+ import type { SkipQueryInfo } from './query-types.js';
18
+ import type { SkipAPIRequestAPIKey } from './auth-types.js';
19
+ import type { SkipAPIArtifact } from './artifact-types.js';
20
+ import type { SkipAPIAgentNote, SkipAPIAgentNoteType } from './agent-types.js';
21
21
  /**
22
22
  * Describes the different request phases that are used to communicate with the Skip API Server
23
23
  * The phase of the conversation, defined as follows:
package/dist/api-types.js CHANGED
@@ -1,4 +1,3 @@
1
- "use strict";
2
1
  /**
3
2
  * This file contains the fundamental API request and response types used for communication
4
3
  * between client applications and the Skip API server. These types define the core data
@@ -12,8 +11,6 @@
12
11
  * These types form the foundation of the Skip API communication protocol and are used
13
12
  * across all Skip API interactions regardless of the specific functionality being invoked.
14
13
  */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.SkipAPIRunScriptRequest = exports.SkipAPIResponse = exports.SkipAPIRequest = exports.MJAPISkipResult = exports.SkipResponsePhase = exports.SkipRequestPhase = void 0;
17
14
  /**
18
15
  * Describes the different request phases that are used to communicate with the Skip API Server
19
16
  * The phase of the conversation, defined as follows:
@@ -24,7 +21,7 @@ exports.SkipAPIRunScriptRequest = exports.SkipAPIResponse = exports.SkipAPIReque
24
21
  * * run_existing_script: Use this to run an existing script that was already processed. When this option is used, the script provided is run and the results are provided in the response.
25
22
  * * chat_with_a_record: This is used for the simple record chatting feature that is separate from other Skip API features. This is used for having a chat conversation with Skip about a specific record in the database that the user is typically looking at in a UI.
26
23
  */
27
- exports.SkipRequestPhase = {
24
+ export const SkipRequestPhase = {
28
25
  initial_request: 'initial_request',
29
26
  clarify_question_response: 'clarify_question_response',
30
27
  data_gathering_response: 'data_gathering_response',
@@ -42,7 +39,7 @@ exports.SkipRequestPhase = {
42
39
  * * analysis_complete: The Skip API server has completed the analysis and is providing the results - typecast the response to SkipAPIAnalysisCompleteResponse for all of the additional properties that are available in this response phase
43
40
  * * chat_with_a_record_complete: The Skip API server has completed the chat with a record and is providing the results - typecast the response to SkipAPIChatWithRecordResponse for all of the additional properties that are available in this response phase
44
41
  */
45
- exports.SkipResponsePhase = {
42
+ export const SkipResponsePhase = {
46
43
  queued: "queued",
47
44
  status_update: "status_update",
48
45
  clarifying_question: "clarifying_question",
@@ -53,26 +50,22 @@ exports.SkipResponsePhase = {
53
50
  /**
54
51
  * This type defines the shape of data that is passed back from the MJ API server to callers, typically the MJ Explorer UI
55
52
  */
56
- class MJAPISkipResult {
53
+ export class MJAPISkipResult {
57
54
  }
58
- exports.MJAPISkipResult = MJAPISkipResult;
59
55
  /**
60
56
  * Defines the shape of the data that is expected by the Skip API Server when making a request
61
57
  */
62
- class SkipAPIRequest {
58
+ export class SkipAPIRequest {
63
59
  }
64
- exports.SkipAPIRequest = SkipAPIRequest;
65
60
  /**
66
61
  * Defines the shape of the data that is returned by the Skip API Server
67
62
  */
68
- class SkipAPIResponse {
63
+ export class SkipAPIResponse {
69
64
  }
70
- exports.SkipAPIResponse = SkipAPIResponse;
71
65
  /**
72
66
  * Special API request type that extends the base SkipAPIRequest to include script execution capabilities.
73
67
  * Used when the requestPhase is 'run_existing_script' to execute pre-defined script text.
74
68
  */
75
- class SkipAPIRunScriptRequest extends SkipAPIRequest {
69
+ export class SkipAPIRunScriptRequest extends SkipAPIRequest {
76
70
  }
77
- exports.SkipAPIRunScriptRequest = SkipAPIRunScriptRequest;
78
71
  //# sourceMappingURL=api-types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAUH;;;;;;;;;GASG;AACU,QAAA,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;;;;;;;;GASG;AACU,QAAA,iBAAiB,GAAG;IAC7B,MAAM,EAAE,QAAQ;IAChB,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAa,eAAe;CAgD3B;AAhDD,0CAgDC;AAED;;GAEG;AACH,MAAa,cAAc;CAgG1B;AAhGD,wCAgGC;AAED;;GAEG;AACH,MAAa,eAAe;CA8B3B;AA9BD,0CA8BC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,cAAc;CAK1D;AALD,0DAKC"}
1
+ {"version":3,"file":"api-types.js","sourceRoot":"","sources":["../src/api-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAUH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,uBAAuB,EAAE,yBAAyB;IAClD,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;CAClC,CAAC;AAGX;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC7B,MAAM,EAAE,QAAQ;IAChB,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,cAAc;IAC5B,iBAAiB,EAAE,mBAAmB;IACtC,2BAA2B,EAAE,6BAA6B;CACpD,CAAC;AAGX;;GAEG;AACH,MAAM,OAAO,eAAe;CAgD3B;AAED;;GAEG;AACH,MAAM,OAAO,cAAc;CAgG1B;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;CA8B3B;AAED;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;CAK1D"}
@@ -1,4 +1,3 @@
1
- "use strict";
2
1
  /**
3
2
  * This file contains types related to artifacts - persistent objects created and managed
4
3
  * through Skip conversations. These types define the structure for:
@@ -17,5 +16,5 @@
17
16
  * AI-generated content and compare different iterations. It also includes sharing
18
17
  * capabilities and user feedback mechanisms to improve future artifact generation.
19
18
  */
20
- Object.defineProperty(exports, "__esModule", { value: true });
19
+ export {};
21
20
  //# sourceMappingURL=artifact-types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"artifact-types.js","sourceRoot":"","sources":["../src/artifact-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG"}
1
+ {"version":3,"file":"artifact-types.js","sourceRoot":"","sources":["../src/artifact-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}
@@ -1,4 +1,3 @@
1
- "use strict";
2
1
  /**
3
2
  * This file contains types related to authentication and API key management
4
3
  * within the Skip API system. These types define the structure for:
@@ -14,14 +13,11 @@
14
13
  * AI namespace that provide standardized interfaces to different AI providers
15
14
  * such as OpenAI, Anthropic, Google, and others.
16
15
  */
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.SkipAPIRequestAPIKey = void 0;
19
16
  /**
20
17
  * Defines the API key information for AI service providers that Skip will use
21
18
  * on behalf of the client. Skip never stores these credentials - they are only
22
19
  * used for the duration of the request to access the specified AI services.
23
20
  */
24
- class SkipAPIRequestAPIKey {
21
+ export class SkipAPIRequestAPIKey {
25
22
  }
26
- exports.SkipAPIRequestAPIKey = SkipAPIRequestAPIKey;
27
23
  //# sourceMappingURL=auth-types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"auth-types.js","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AACH,MAAa,oBAAoB;CAYhC;AAZD,oDAYC"}
1
+ {"version":3,"file":"auth-types.js","sourceRoot":"","sources":["../src/auth-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;CAYhC"}
@@ -0,0 +1,72 @@
1
+ import { SkipComponentEvent, SkipComponentProperty } from "./component-props-events.js";
2
+ import { SkipComponentDataRequirements } from "./data-requirements.js";
3
+ /**
4
+ * Represents a child component within a component hierarchy
5
+ */
6
+ export interface SkipComponentChildSpec {
7
+ /**
8
+ * The programmatic name of the component
9
+ */
10
+ componentName: string;
11
+ /**
12
+ * Example of the component being used in JSX format. This is used to provide a clear example on the properties and
13
+ * event handling that the component supports. This is used to teach the next AI exactly what we want it to generate for the
14
+ * child component.
15
+ */
16
+ exampleUsage: string;
17
+ /**
18
+ * The code for the child component. This is generated LATER by a separate process after the parent
19
+ * component generation is complete. When the parent component generates this is undefined.
20
+ */
21
+ componentCode?: string;
22
+ /**
23
+ * A summary of what this child component does that a user would understand.
24
+ * This should be a high-level, user-friendly description suitable for end users.
25
+ */
26
+ description: string;
27
+ /**
28
+ * Functional requirements for this child component.
29
+ * This should be in markdown format and describe what the component should do from a functional perspective.
30
+ * Includes:
31
+ * - Component-specific functionality
32
+ * - How it integrates with the parent component
33
+ * - User interactions within this component
34
+ * - Business rules specific to this component
35
+ */
36
+ functionalRequirements?: string;
37
+ /**
38
+ * Data requirements for this child component. This section defines where a child component
39
+ * will **directly** access data as required using utilities methods like `rv.runView` and `rq.runQuery`
40
+ */
41
+ dataRequirements?: SkipComponentDataRequirements;
42
+ /**
43
+ * An optional array of properties that the component uses. The names and descriptions
44
+ * allow consumers of the component to understand what is accepted by the component and the
45
+ * component. This can be used for shared data shared between components or for configuration
46
+ * settings.
47
+ */
48
+ properties?: SkipComponentProperty[];
49
+ /**
50
+ * An optional array of events that the component emits.
51
+ * This allows consumers of the component to understand what events they can listen to.
52
+ */
53
+ events?: SkipComponentEvent[];
54
+ /**
55
+ * Technical design details for this child component.
56
+ * This should be in markdown format and describe the implementation approach.
57
+ * Includes:
58
+ * - How the component is structured
59
+ * - State within the component
60
+ * - Properites/events
61
+ */
62
+ technicalDesign?: string;
63
+ /**
64
+ * The path in the state tree where this component's state is stored
65
+ */
66
+ statePath: string;
67
+ /**
68
+ * An array of sub-components
69
+ */
70
+ components: SkipComponentChildSpec[];
71
+ }
72
+ //# sourceMappingURL=child-spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"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;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE9B;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,sBAAsB,EAAE,CAAC;CACxC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=child-spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"child-spec.js","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,32 @@
1
+ import { SkipComponentRootSpec } from "./root-spec.js";
2
+ /**
3
+ * 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.
4
+ */
5
+ export type SkipComponentOption = {
6
+ /**
7
+ * Full details of the generated component option including functional, technical, code, and child componentry.
8
+ */
9
+ option: SkipComponentRootSpec;
10
+ /**
11
+ * If multiple component options are provided for a given @interface SkipAPIAnalysisCompleteResponse, a "judge" AI will evaluate all the functional
12
+ * 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
13
+ * # of components contained within an array of SkipComponentOption types.
14
+ */
15
+ AIRank: number | undefined;
16
+ /**
17
+ * 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
18
+ * as well as provide context to the user about why a particular component was chosen as the best option.
19
+ */
20
+ AIRankExplanation: string | undefined;
21
+ /**
22
+ * The user's provided feedback on the component option. Unlike the AIRank, this is a subjective rating provided by the user and is
23
+ * a number between 1 and 10, where 1 is the lowest rating and 10 is the highest rating.
24
+ */
25
+ UserRank: number | undefined;
26
+ /**
27
+ * If the host application provides a way for the user to provide feedback on the component option,
28
+ * this is the explanation of why the user rated the component the way they did if they provided feedback.
29
+ */
30
+ UserRankExplanation: string | undefined;
31
+ };
32
+ //# sourceMappingURL=component-option.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component-option.d.ts","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEpD;;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"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=component-option.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component-option.js","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":""}
@@ -0,0 +1,66 @@
1
+ /**
2
+ * Definition of a single property of a component.
3
+ */
4
+ export interface SkipComponentProperty {
5
+ /**
6
+ * The name of the property
7
+ */
8
+ name: string;
9
+ /**
10
+ * A description of what this property is used for
11
+ */
12
+ description: string;
13
+ /**
14
+ * The type of the property.
15
+ * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
16
+ * These types are for aligning users of the component. Components are in JavaScript and do not
17
+ * actually enforce types at runtime, but this is used to provide guidance for users (AI and Human)
18
+ */
19
+ type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
20
+ /**
21
+ * Indicates if this property is required for the component to function correctly.
22
+ * If true, the component will not work without this property being set.
23
+ */
24
+ required: boolean;
25
+ /**
26
+ * The default value, if any, for this property if it is not provided.
27
+ */
28
+ defaultValue?: any;
29
+ /**
30
+ * Optional list of possible values for this property.
31
+ */
32
+ possibleValues?: string[];
33
+ }
34
+ /**
35
+ * Definition of a single event of a component.
36
+ */
37
+ export interface SkipComponentEvent {
38
+ /**
39
+ * The name of the event
40
+ */
41
+ name: string;
42
+ /**
43
+ * A description of what this event does
44
+ */
45
+ description: string;
46
+ /**
47
+ * An array of parameters that this event can emit.
48
+ */
49
+ parameters?: SkipComponentEventParameter[];
50
+ }
51
+ export interface SkipComponentEventParameter {
52
+ /**
53
+ * The name of the parameter
54
+ */
55
+ name: string;
56
+ /**
57
+ * A description of what this parameter is used for
58
+ */
59
+ description: string;
60
+ /**
61
+ * The type of the parameter.
62
+ * It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'.
63
+ */
64
+ type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'any';
65
+ }
66
+ //# sourceMappingURL=component-props-events.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=component-props-events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component-props-events.js","sourceRoot":"","sources":["../src/component-props-events.ts"],"names":[],"mappings":""}
@@ -14,7 +14,7 @@
14
14
  * Sub-process responses are used when Skip executes code in a sandboxed environment and needs
15
15
  * to communicate the results back to the main API server.
16
16
  */
17
- import type { SkipAPIArtifact } from './artifact-types';
17
+ import type { SkipAPIArtifact } from './artifact-types.js';
18
18
  /**
19
19
  * Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
20
20
  * this shape of data is used to communicate the results of that sub-process back to the Skip API server.
@@ -1,4 +1,3 @@
1
- "use strict";
2
1
  /**
3
2
  * This file contains types related to conversations and messaging within the Skip API system.
4
3
  * These types define the structure for:
@@ -15,27 +14,22 @@
15
14
  * Sub-process responses are used when Skip executes code in a sandboxed environment and needs
16
15
  * to communicate the results back to the main API server.
17
16
  */
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.SkipMessage = exports.SkipConversation = exports.SkipSubProcessResponse = void 0;
20
17
  /**
21
18
  * Whenever Skip executes it's analysis phase, it uses a sandboxed sub-process to execute code securely and
22
19
  * this shape of data is used to communicate the results of that sub-process back to the Skip API server.
23
20
  * This data type is in turn used within the SkipAPIAnalysisCompleteResponse type.
24
21
  */
25
- class SkipSubProcessResponse {
22
+ export class SkipSubProcessResponse {
26
23
  }
27
- exports.SkipSubProcessResponse = SkipSubProcessResponse;
28
24
  /**
29
25
  * Defines the shape of the conversations that can be passed back and forth with the Skip API Server - primarily used for the learning cycle process
30
26
  */
31
- class SkipConversation {
27
+ export class SkipConversation {
32
28
  }
33
- exports.SkipConversation = SkipConversation;
34
29
  /**
35
30
  * Defines the shape of the individual message that makes up the messages array that is passed back and
36
31
  * forth with the Skip API Server
37
32
  */
38
- class SkipMessage {
33
+ export class SkipMessage {
39
34
  }
40
- exports.SkipMessage = SkipMessage;
41
35
  //# sourceMappingURL=conversation-types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"conversation-types.js","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAIH;;;;GAIG;AACH,MAAa,sBAAsB;CAclC;AAdD,wDAcC;AAED;;GAEG;AACH,MAAa,gBAAgB;CA0C5B;AA1CD,4CA0CC;AAED;;;GAGG;AACH,MAAa,WAAW;CAuDvB;AAvDD,kCAuDC"}
1
+ {"version":3,"file":"conversation-types.js","sourceRoot":"","sources":["../src/conversation-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH;;;;GAIG;AACH,MAAM,OAAO,sBAAsB;CAclC;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;CA0C5B;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;CAuDvB"}
@@ -0,0 +1,77 @@
1
+ import { DataContext } from "@memberjunction/data-context";
2
+ /**
3
+ * This interface is critical for understanding how components interact with MemberJunction data
4
+ */
5
+ export interface SkipComponentDataRequirements {
6
+ /**
7
+ * The primary data access mode for this component.
8
+ * - 'dynamic': Component fetches data at runtime using MJ utilities
9
+ * - 'static': Deprecated, use dynamic.
10
+ * - 'hybrid': Deprecated, use dynamic.
11
+ */
12
+ mode: 'static' | 'dynamic' | 'hybrid';
13
+ /**
14
+ * For static mode: References to data context items that this component uses.
15
+ * These are pre-loaded data snapshots that are passed to the component during initialization.
16
+ * @deprecated Use dynamicData instead
17
+ */
18
+ staticData?: {
19
+ /**
20
+ * Reference to the data context that this component uses.
21
+ */
22
+ dataContext: DataContext;
23
+ /**
24
+ * Description of how the static data is used by the component
25
+ */
26
+ description?: string;
27
+ };
28
+ /**
29
+ * For dynamic mode: Defines which MemberJunction entities this component needs access to.
30
+ * The component will use the RunView/RunQuery utilities to fetch data at runtime.
31
+ */
32
+ dynamicData?: {
33
+ /**
34
+ * Describes the entities and fields the component will
35
+ * need to fulfill user requirements.
36
+ */
37
+ requiredEntities: SkipComponentEntityDataRequirement[];
38
+ /**
39
+ * Description of data access patterns
40
+ */
41
+ description?: string;
42
+ };
43
+ /**
44
+ * General description of data requirements
45
+ */
46
+ description?: string;
47
+ }
48
+ /**
49
+ * Describes use of a single entity
50
+ */
51
+ export type SkipComponentEntityDataRequirement = {
52
+ /**
53
+ * Name of the entity (unique system-wide)
54
+ */
55
+ entityName: string;
56
+ /**
57
+ * Description of data in the entity
58
+ */
59
+ entityDescription?: string;
60
+ /**
61
+ * Fields to show the user
62
+ */
63
+ displayFields: string[];
64
+ /**
65
+ * Fields to filter on initially or via user interaction.
66
+ */
67
+ filterFields?: string[];
68
+ /**
69
+ * Fields to use when sorting
70
+ */
71
+ sortFields?: string[];
72
+ /**
73
+ * When/Where/How components should use this data
74
+ */
75
+ usageContext?: string;
76
+ };
77
+ //# sourceMappingURL=data-requirements.d.ts.map
@@ -0,0 +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,6BAA6B;IAC1C;;;;;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,kCAAkC,EAAE,CAAC;QAEvD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IAEF;;OAEG;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"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=data-requirements.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"data-requirements.js","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":""}
@@ -1,3 +1,2 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
3
2
  //# sourceMappingURL=entity-metadata-types.js.map
package/dist/index.d.ts CHANGED
@@ -1,10 +1,10 @@
1
- export * from './api-types';
2
- export * from './conversation-types';
3
- export * from './response-types';
4
- export * from './entity-metadata-types';
5
- export * from './query-types';
6
- export * from './agent-types';
7
- export * from './artifact-types';
8
- export * from './auth-types';
9
- export * from './util';
1
+ export * from './api-types.js';
2
+ export * from './conversation-types.js';
3
+ export * from './response-types.js';
4
+ export * from './entity-metadata-types.js';
5
+ export * from './query-types.js';
6
+ export * from './agent-types.js';
7
+ export * from './artifact-types.js';
8
+ export * from './auth-types.js';
9
+ export * from './util.js';
10
10
  //# sourceMappingURL=index.d.ts.map
package/dist/index.js CHANGED
@@ -1,27 +1,11 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
1
  // Re-export all types from organized modules
18
- __exportStar(require("./api-types"), exports);
19
- __exportStar(require("./conversation-types"), exports);
20
- __exportStar(require("./response-types"), exports);
21
- __exportStar(require("./entity-metadata-types"), exports);
22
- __exportStar(require("./query-types"), exports);
23
- __exportStar(require("./agent-types"), exports);
24
- __exportStar(require("./artifact-types"), exports);
25
- __exportStar(require("./auth-types"), exports);
26
- __exportStar(require("./util"), exports);
2
+ export * from './api-types.js';
3
+ export * from './conversation-types.js';
4
+ export * from './response-types.js';
5
+ export * from './entity-metadata-types.js';
6
+ export * from './query-types.js';
7
+ export * from './agent-types.js';
8
+ export * from './artifact-types.js';
9
+ export * from './auth-types.js';
10
+ export * from './util.js';
27
11
  //# sourceMappingURL=index.js.map