@memberjunction/skip-types 2.69.1 → 2.71.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 (69) hide show
  1. package/dist/agent-types.d.ts +0 -3
  2. package/dist/agent-types.d.ts.map +1 -1
  3. package/dist/agent-types.js +0 -3
  4. package/dist/agent-types.js.map +1 -1
  5. package/dist/api-types.d.ts +0 -5
  6. package/dist/api-types.d.ts.map +1 -1
  7. package/dist/api-types.js +0 -5
  8. package/dist/api-types.js.map +1 -1
  9. package/dist/artifact-types.d.ts +0 -5
  10. package/dist/artifact-types.d.ts.map +1 -1
  11. package/dist/artifact-types.js +0 -5
  12. package/dist/artifact-types.js.map +1 -1
  13. package/dist/auth-types.d.ts +0 -5
  14. package/dist/auth-types.d.ts.map +1 -1
  15. package/dist/auth-types.js +0 -5
  16. package/dist/auth-types.js.map +1 -1
  17. package/dist/conversation-types.d.ts +0 -5
  18. package/dist/conversation-types.d.ts.map +1 -1
  19. package/dist/conversation-types.js +0 -5
  20. package/dist/conversation-types.js.map +1 -1
  21. package/dist/entity-metadata-types.d.ts +5 -10
  22. package/dist/entity-metadata-types.d.ts.map +1 -1
  23. package/dist/entity-metadata-types.js +3 -8
  24. package/dist/entity-metadata-types.js.map +1 -1
  25. package/dist/index.d.ts +0 -7
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +0 -7
  28. package/dist/index.js.map +1 -1
  29. package/dist/query-types.d.ts +0 -5
  30. package/dist/query-types.d.ts.map +1 -1
  31. package/dist/query-types.js +0 -5
  32. package/dist/query-types.js.map +1 -1
  33. package/dist/response-types.d.ts +2 -8
  34. package/dist/response-types.d.ts.map +1 -1
  35. package/dist/response-types.js +0 -5
  36. package/dist/response-types.js.map +1 -1
  37. package/dist/util.d.ts +0 -20
  38. package/dist/util.d.ts.map +1 -1
  39. package/dist/util.js +1 -50
  40. package/dist/util.js.map +1 -1
  41. package/package.json +4 -4
  42. package/dist/child-spec.d.ts +0 -83
  43. package/dist/child-spec.d.ts.map +0 -1
  44. package/dist/child-spec.js +0 -3
  45. package/dist/child-spec.js.map +0 -1
  46. package/dist/component-option.d.ts +0 -32
  47. package/dist/component-option.d.ts.map +0 -1
  48. package/dist/component-option.js +0 -3
  49. package/dist/component-option.js.map +0 -1
  50. package/dist/component-props-events.d.ts +0 -66
  51. package/dist/component-props-events.d.ts.map +0 -1
  52. package/dist/component-props-events.js +0 -3
  53. package/dist/component-props-events.js.map +0 -1
  54. package/dist/data-requirements.d.ts +0 -90
  55. package/dist/data-requirements.d.ts.map +0 -1
  56. package/dist/data-requirements.js +0 -3
  57. package/dist/data-requirements.js.map +0 -1
  58. package/dist/root-spec.d.ts +0 -87
  59. package/dist/root-spec.d.ts.map +0 -1
  60. package/dist/root-spec.js +0 -3
  61. package/dist/root-spec.js.map +0 -1
  62. package/dist/runtime-types.d.ts +0 -219
  63. package/dist/runtime-types.d.ts.map +0 -1
  64. package/dist/runtime-types.js +0 -3
  65. package/dist/runtime-types.js.map +0 -1
  66. package/dist/shared.d.ts +0 -44
  67. package/dist/shared.d.ts.map +0 -1
  68. package/dist/shared.js +0 -3
  69. package/dist/shared.js.map +0 -1
package/dist/util.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAAC,CAAa;IACvD,MAAM,EAAE,GAAmB;QACvB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,uCAAuC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,qDAAqD,CAAC,EAAE,CAAC,CAAC;KAC1G,CAAC;IACF,OAAO,EAAE,CAAC;AACd,CAAC;AAXD,sEAWC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,uCAAuC,CAAC,CAAa,EAAE,CAAkB;IACrF,MAAM,EAAE,GAAwB;QAC5B,QAAQ,EAAE,CAAC,CAAC,EAAE;QACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,kBAAkB,EAAE,CAAC,CAAC,kBAAkB;QACxC,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,eAAe,EAAE,CAAC,CAAC,eAAe;QAClC,sBAAsB,EAAE,CAAC,CAAC,sBAAsB;QAChD,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,uBAAuB,EAAE,CAAC,CAAC,uBAAuB;QAClD,qBAAqB,EAAE,CAAC,CAAC,qBAAqB;QAC9C,cAAc,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,iDAAiD,CAAC,EAAE,CAAC,CAAC;KACvG,CAAC;IACF,OAAO,EAAE,CAAC;AACd,CAAC;AA/BD,0FA+BC;AAED;;;;;;;;;GASG;AACH,SAAgB,iDAAiD,CAAC,EAAwB;IACtF,MAAM,KAAK,GAA6B;QACpC,KAAK,EAAE,EAAE,CAAC,KAAK;QACf,YAAY,EAAE,EAAE,CAAC,KAAK;KACzB,CAAC;IACF,OAAO,KAAK,CAAC;AACjB,CAAC;AAND,8GAMC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,qDAAqD,CAAC,EAA0B;IAC5F,MAAM,GAAG,GAA+B;QACpC,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,MAAM,EAAE,EAAE,CAAC,MAAM;QACjB,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,eAAe,EAAE,EAAE,CAAC,eAAe;QACnC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB;QACjD,qBAAqB,EAAE,EAAE,CAAC,qBAAqB;QAC/C,aAAa,EAAE,EAAE,CAAC,aAAa;QAC/B,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,0BAA0B,EAAE,EAAE,CAAC,0BAA0B;QACzD,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,mBAAmB,EAAE,EAAE,CAAC,mBAAmB;KAC9C,CAAA;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAhBD,sHAgBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,8BAA8B,CAAC,IAA2B;IACtE,kDAAkD;IAClD,IAAI,IAAI,GAAG,IAAI,CAAC,aAAa,IAAI,4DAA4D,CAAC;IAC9F,kFAAkF;IAClF,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,2BAA2B,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,gFAAgF;YAChF,IAAI,IAAI,MAAM,GAAG,SAAS,CAAC;QAC/B,CAAC;IACL,CAAC;IACD,8CAA8C;IAC9C,OAAO,IAAI,CAAC;AAChB,CAAC;AAbD,wEAaC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,KAA6B;IACrE,mDAAmD;IACnD,IAAI,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC;IAC/B,kFAAkF;IAClF,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrD,wEAAwE;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC;QAC7B,CAAC;IACL,CAAC;IACD,oDAAoD;IACpD,OAAO,IAAI,CAAC;AAChB,CAAC;AAjBD,kEAiBC"}
1
+ {"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAAC,CAAa;IACvD,MAAM,EAAE,GAAmB;QACvB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,uCAAuC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,qDAAqD,CAAC,EAAE,CAAC,CAAC;KAC1G,CAAC;IACF,OAAO,EAAE,CAAC;AACd,CAAC;AAXD,sEAWC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,uCAAuC,CAAC,CAAa,EAAE,CAAkB;IACrF,MAAM,EAAE,GAAwB;QAC5B,QAAQ,EAAE,CAAC,CAAC,EAAE;QACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,YAAY,EAAE,CAAC,CAAC,YAAY;QAC5B,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,kBAAkB,EAAE,CAAC,CAAC,kBAAkB;QACxC,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,eAAe,EAAE,CAAC,CAAC,eAAe;QAClC,sBAAsB,EAAE,CAAC,CAAC,sBAAsB;QAChD,aAAa,EAAE,CAAC,CAAC,aAAa;QAC9B,uBAAuB,EAAE,CAAC,CAAC,uBAAuB;QAClD,qBAAqB,EAAE,CAAC,CAAC,qBAAqB;QAC9C,cAAc,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,iDAAiD,CAAC,EAAE,CAAC,CAAC;KACvG,CAAC;IACF,OAAO,EAAE,CAAC;AACd,CAAC;AA/BD,0FA+BC;AAED;;;;;;;;;GASG;AACH,SAAgB,iDAAiD,CAAC,EAAwB;IACtF,MAAM,KAAK,GAA6B;QACpC,KAAK,EAAE,EAAE,CAAC,KAAK;QACf,YAAY,EAAE,EAAE,CAAC,KAAK;KACzB,CAAC;IACF,OAAO,KAAK,CAAC;AACjB,CAAC;AAND,8GAMC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,qDAAqD,CAAC,EAA0B;IAC5F,MAAM,GAAG,GAA+B;QACpC,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,MAAM,EAAE,EAAE,CAAC,MAAM;QACjB,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,cAAc,EAAE,EAAE,CAAC,cAAc;QACjC,eAAe,EAAE,EAAE,CAAC,eAAe;QACnC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB;QACjD,qBAAqB,EAAE,EAAE,CAAC,qBAAqB;QAC/C,aAAa,EAAE,EAAE,CAAC,aAAa;QAC/B,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,0BAA0B,EAAE,EAAE,CAAC,0BAA0B;QACzD,QAAQ,EAAE,EAAE,CAAC,QAAQ;QACrB,mBAAmB,EAAE,EAAE,CAAC,mBAAmB;KAC9C,CAAA;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAhBD,sHAgBC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/skip-types",
3
- "version": "2.69.1",
3
+ "version": "2.71.0",
4
4
  "description": "MemberJunction: Skip AI Assistant - Types that are used between the MJAPI and the Skip API as well as the UI within MemberJunction Explorer",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
19
19
  "typescript": "^5.4.5"
20
20
  },
21
21
  "dependencies": {
22
- "@memberjunction/core": "2.69.1",
23
- "@memberjunction/core-entities": "2.69.1",
24
- "@memberjunction/data-context": "2.69.1"
22
+ "@memberjunction/core": "2.71.0",
23
+ "@memberjunction/interactive-component-types": "2.71.0",
24
+ "@memberjunction/data-context": "2.71.0"
25
25
  }
26
26
  }
@@ -1,83 +0,0 @@
1
- import { SkipComponentEvent, SkipComponentProperty } from "./component-props-events";
2
- import { SkipComponentDataRequirements } from "./data-requirements";
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
- * @since 2.1.0 - Enhanced documentation for clarity
37
- */
38
- functionalRequirements?: string;
39
- /**
40
- * Data requirements for this child component. This section defines where a child component
41
- * will **directly** access data as required using utilities methods like `rv.runView` and `rq.runQuery`
42
- *
43
- * This is **not** the same as the dataProps array shown below which is the manifest of the possible
44
- * sub-properties that can be passed into the component in its `data` property.
45
- *
46
- * @since 2.1.0 - Enhanced documentation for clarity
47
- */
48
- dataRequirements?: SkipComponentDataRequirements;
49
- /**
50
- * An optional array of properties that the component uses. The names and descriptions
51
- * allow consumers of the component to understand what is accepted by the component and the
52
- * component. This can be used for shared data shared between components or for configuration
53
- * settings.
54
- */
55
- properties?: SkipComponentProperty[];
56
- /**
57
- * An optional array of events that the component emits.
58
- * This allows consumers of the component to understand what events they can listen to.
59
- * Each event should have a name and a description of what it does.
60
- */
61
- events?: SkipComponentEvent[];
62
- /**
63
- * Technical design details for this child component.
64
- * This should be in markdown format and describe the implementation approach.
65
- * Includes:
66
- * - How the component is structured
67
- * - State management within the component
68
- * - Props interface and event handlers
69
- * - Performance optimizations specific to this component
70
- *
71
- * @since 2.1.0 - Enhanced documentation for clarity
72
- */
73
- technicalDesign?: string;
74
- /**
75
- * The path in the state tree where this component's state is stored
76
- */
77
- statePath: string;
78
- /**
79
- * An array of sub-components (recursive structure)
80
- */
81
- components: SkipComponentChildSpec[];
82
- }
83
- //# sourceMappingURL=child-spec.d.ts.map
@@ -1 +0,0 @@
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;;;;;;;;;;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"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=child-spec.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"child-spec.js","sourceRoot":"","sources":["../src/child-spec.ts"],"names":[],"mappings":""}
@@ -1,32 +0,0 @@
1
- import { SkipComponentRootSpec } from "./root-spec";
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
@@ -1 +0,0 @@
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"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=component-option.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"component-option.js","sourceRoot":"","sources":["../src/component-option.ts"],"names":[],"mappings":""}
@@ -1,66 +0,0 @@
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
@@ -1 +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"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=component-props-events.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"component-props-events.js","sourceRoot":"","sources":["../src/component-props-events.ts"],"names":[],"mappings":""}
@@ -1,90 +0,0 @@
1
- import { DataContext } from "@memberjunction/data-context";
2
- /**
3
- * Defines the data requirements for a Skip component, supporting three different data access modes.
4
- * This interface is critical for understanding how components interact with MemberJunction data
5
- * and helps optimize performance by clearly defining data access patterns.
6
- */
7
- export interface SkipComponentDataRequirements {
8
- /**
9
- * The primary data access mode for this component.
10
- * - 'dynamic': Component fetches data at runtime using MJ utilities
11
- * - 'static': Static is deprecated, use dynamic. Data is pre-loaded and passed to the component during initialization
12
- * - 'hybrid': Hybrid is deprecated, use dynamic. Uses both static and dynamic data access patterns
13
- */
14
- mode: 'static' | 'dynamic' | 'hybrid';
15
- /**
16
- * For static mode: References to data context items that this component uses.
17
- * These are pre-loaded data snapshots that are passed to the component during initialization.
18
- * Static mode is preferred for:
19
- * - Reports with fixed datasets
20
- * - Components where users don't need entity-level permissions
21
- * - Scenarios requiring reduced database load
22
- * @deprecated Use dynamicData instead
23
- */
24
- staticData?: {
25
- /**
26
- * Reference to the data context that this component uses.
27
- * Points to a DataContext object containing pre-loaded data.
28
- */
29
- dataContext: DataContext;
30
- /**
31
- * Optional description of how the static data is used by the component
32
- */
33
- description?: string;
34
- };
35
- /**
36
- * For dynamic mode: Defines which MemberJunction entities this component needs access to.
37
- * The component will use the RunView/RunQuery utilities to fetch data at runtime.
38
- * Dynamic mode is preferred for:
39
- * - Interactive dashboards with drill-down capabilities
40
- * - Components requiring real-time data
41
- * - Scenarios where users need entity-level permission validation
42
- */
43
- dynamicData?: {
44
- /**
45
- * Array of objects specifying the exact entities and fields the component will
46
- * need to fulfill user requirements. This detail also allows other components
47
- * to not have to know the database schema.
48
- */
49
- requiredEntities: SkipComponentEntityDataRequirement[];
50
- /**
51
- * Optional description of the dynamic data access patterns
52
- */
53
- description?: string;
54
- };
55
- /**
56
- * General description of the component's data requirements and access patterns.
57
- * This should provide a high-level overview of the data strategy.
58
- */
59
- description?: string;
60
- }
61
- /**
62
- * Specifications for the use of a single entity within a Skip component.
63
- */
64
- export type SkipComponentEntityDataRequirement = {
65
- /**
66
- * The name of the entity as defined in the metadata.
67
- */
68
- entityName: string;
69
- /**
70
- * Description of the entityt as defined in the metadata.
71
- */
72
- entityDescription?: string;
73
- /**
74
- * These fields can be shown to the user as determined by each component.
75
- */
76
- displayFields: string[];
77
- /**
78
- * These fields can be used when filtering data as appropriately determined by each component.
79
- */
80
- filterFields?: string[];
81
- /**
82
- * These fields can be used when sorting data as appropriately determined by each component.
83
- */
84
- sortFields?: string[];
85
- /**
86
- * Optional, description of when/where/how components should use this entity.
87
- */
88
- usageContext?: string;
89
- };
90
- //# sourceMappingURL=data-requirements.d.ts.map
@@ -1 +0,0 @@
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;;;;;;;;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"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=data-requirements.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"data-requirements.js","sourceRoot":"","sources":["../src/data-requirements.ts"],"names":[],"mappings":""}
@@ -1,87 +0,0 @@
1
- import { SkipComponentChildSpec } from "./child-spec";
2
- import { SkipComponentDataRequirements } from "./data-requirements";
3
- /**
4
- * Represents a complete specification for a generated Skip component, including its structure,
5
- * requirements, code, and nested component hierarchy
6
- */
7
- export type SkipComponentRootSpec = {
8
- /**
9
- * A description of what the component should do from a functional perspective.
10
- * This should be in markdown format and include:
11
- * - Core functionality and purpose
12
- * - User interactions and behaviors
13
- * - Business rules and logic
14
- * - Expected outcomes and outputs
15
- * - User experience considerations
16
- * - Accessibility requirements
17
- *
18
- * @since 2.1.0 - Made required and enhanced documentation
19
- */
20
- functionalRequirements: string;
21
- /**
22
- * Detailed data requirements specification for the component.
23
- * Defines how the component accesses and uses data, supporting static, dynamic, and hybrid modes.
24
- * This field is critical for determining how the component will interact with MemberJunction data.
25
- *
26
- * @since 2.1.0 - Made required for better data architecture planning
27
- */
28
- dataRequirements?: SkipComponentDataRequirements;
29
- /**
30
- * A technical description of how the component is designed and implemented.
31
- * This should be in markdown format and include:
32
- * - Architecture and design patterns used
33
- * - Key technical decisions and rationale
34
- * - Component structure and organization
35
- * - State management approach
36
- * - Performance considerations
37
- * - Integration points with parent/child components
38
- * - Error handling strategies
39
- *
40
- * @since 2.1.0 - Made required and enhanced documentation
41
- */
42
- technicalDesign: string;
43
- /**
44
- * The actual code for the main component, typically wrapped in an IIFE that returns
45
- * the component object with component, print, and refresh properties
46
- */
47
- componentCode: string;
48
- /**
49
- * The name of the main component
50
- */
51
- componentName: string;
52
- /**
53
- * The type of component: report, dashboard, form, chart, table, or other. Over time this list
54
- * might grow to include more types as Skip evolves and new component types are needed.
55
- */
56
- componentType: "report" | "dashboard" | "form" | "other";
57
- /**
58
- * A summary of what the component does that a user would understand.
59
- * This should be a high-level, user-friendly description suitable for end users.
60
- */
61
- description: string;
62
- /**
63
- * The callback strategy used by this component (e.g., "hybrid", "direct", "none")
64
- */
65
- callbackStrategy: string;
66
- /**
67
- * Describes the state structure managed by this component
68
- */
69
- stateStructure: Record<string, string>;
70
- /**
71
- * An array of child component specifications
72
- */
73
- childComponents: SkipComponentChildSpec[];
74
- /**
75
- * The title of the component
76
- */
77
- title: string;
78
- /**
79
- * A user-friendly explanation of what the component does
80
- */
81
- userExplanation: string;
82
- /**
83
- * A technical explanation of how the component works
84
- */
85
- techExplanation: string;
86
- };
87
- //# sourceMappingURL=root-spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"root-spec.d.ts","sourceRoot":"","sources":["../src/root-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;;;;;;;;OAWG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;IAEjD;;;;;;;;;;;;OAYG;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;;;OAGG;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"}
package/dist/root-spec.js DELETED
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=root-spec.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"root-spec.js","sourceRoot":"","sources":["../src/root-spec.ts"],"names":[],"mappings":""}