@qikdev/mcp 6.6.11 → 6.6.13

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.
@@ -1,193 +0,0 @@
1
- /**
2
- * Qik API Documentation Integration
3
- *
4
- * This module provides comprehensive documentation understanding capabilities
5
- * for the Qik MCP server, integrating the full API documentation to provide
6
- * context-aware help, examples, and troubleshooting assistance.
7
- */
8
- export interface QikDocumentation {
9
- authentication: AuthenticationDocs;
10
- endpoints: EndpointDocs;
11
- contentTypes: ContentTypeDocs;
12
- filterSyntax: FilterSyntaxDocs;
13
- concepts: ConceptsDocs;
14
- widgetTypes: WidgetTypeDocs;
15
- examples: ExamplesDocs;
16
- troubleshooting: TroubleshootingDocs;
17
- }
18
- export interface AuthenticationDocs {
19
- tokenTypes: {
20
- user: {
21
- description: string;
22
- prefix: string;
23
- useCase: string;
24
- example: string;
25
- };
26
- persona: {
27
- description: string;
28
- prefix: string;
29
- useCase: string;
30
- example: string;
31
- };
32
- application: {
33
- description: string;
34
- prefix: string;
35
- useCase: string;
36
- example: string;
37
- };
38
- };
39
- methods: {
40
- bearer: {
41
- description: string;
42
- example: string;
43
- };
44
- queryString: {
45
- description: string;
46
- example: string;
47
- };
48
- };
49
- errorCodes: {
50
- [code: string]: {
51
- description: string;
52
- commonCauses: string[];
53
- solutions: string[];
54
- };
55
- };
56
- }
57
- export interface EndpointDocs {
58
- [endpoint: string]: {
59
- method: string;
60
- description: string;
61
- parameters: {
62
- [param: string]: {
63
- type: string;
64
- required: boolean;
65
- description: string;
66
- example?: any;
67
- };
68
- };
69
- examples: {
70
- request: any;
71
- response: any;
72
- description: string;
73
- }[];
74
- commonErrors: string[];
75
- relatedEndpoints: string[];
76
- };
77
- }
78
- export interface ContentTypeDocs {
79
- [contentType: string]: {
80
- description: string;
81
- useCase: string;
82
- fieldStructure: {
83
- rootLevel: string[];
84
- dataObject: string[];
85
- };
86
- examples: {
87
- creation: any;
88
- update: any;
89
- query: any;
90
- };
91
- commonPatterns: string[];
92
- troubleshooting: string[];
93
- };
94
- }
95
- export interface FilterSyntaxDocs {
96
- operators: {
97
- [operator: string]: {
98
- description: string;
99
- examples: any[];
100
- commonUse: string;
101
- };
102
- };
103
- comparators: {
104
- [comparator: string]: {
105
- description: string;
106
- valueTypes: string[];
107
- examples: any[];
108
- relatedComparators: string[];
109
- };
110
- };
111
- patterns: {
112
- [pattern: string]: {
113
- description: string;
114
- example: any;
115
- useCase: string;
116
- };
117
- };
118
- }
119
- export interface ConceptsDocs {
120
- [concept: string]: {
121
- title: string;
122
- description: string;
123
- keyPoints: string[];
124
- examples: any[];
125
- relatedConcepts: string[];
126
- commonMisunderstandings: string[];
127
- };
128
- }
129
- export interface WidgetTypeDocs {
130
- [widget: string]: {
131
- description: string;
132
- expectedInput: any;
133
- examples: any[];
134
- validation: string[];
135
- commonErrors: string[];
136
- relatedWidgets: string[];
137
- };
138
- }
139
- export interface ExamplesDocs {
140
- [category: string]: {
141
- [example: string]: {
142
- title: string;
143
- description: string;
144
- code: any;
145
- explanation: string;
146
- variations: any[];
147
- };
148
- };
149
- }
150
- export interface TroubleshootingDocs {
151
- [issue: string]: {
152
- symptoms: string[];
153
- causes: string[];
154
- solutions: string[];
155
- prevention: string[];
156
- relatedIssues: string[];
157
- };
158
- }
159
- /**
160
- * Comprehensive Qik API Documentation
161
- * Based on the full API documentation PDF
162
- */
163
- export declare const QIK_DOCUMENTATION: QikDocumentation;
164
- /**
165
- * Helper functions for documentation integration
166
- */
167
- export declare class QikDocumentationHelper {
168
- /**
169
- * Get documentation for a specific topic
170
- */
171
- static getTopicDocumentation(topic: string): any;
172
- /**
173
- * Search documentation for relevant information
174
- */
175
- static searchDocumentation(query: string): any[];
176
- private static searchInObject;
177
- /**
178
- * Get troubleshooting information for a specific error
179
- */
180
- static getTroubleshootingInfo(errorMessage: string): any;
181
- /**
182
- * Get examples for a specific use case
183
- */
184
- static getExamples(category: string, example?: string): any;
185
- /**
186
- * Validate field placement based on content type
187
- */
188
- static validateFieldPlacement(contentType: string, payload: any): {
189
- valid: boolean;
190
- errors: string[];
191
- };
192
- }
193
- //# sourceMappingURL=documentation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"documentation.d.ts","sourceRoot":"","sources":["../../src/documentation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,kBAAkB,CAAC;IACnC,SAAS,EAAE,YAAY,CAAC;IACxB,YAAY,EAAE,eAAe,CAAC;IAC9B,YAAY,EAAE,gBAAgB,CAAC;IAC/B,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,YAAY,CAAC;IACvB,eAAe,EAAE,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,OAAO,EAAE;YACP,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,WAAW,EAAE;YACX,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;IACF,OAAO,EAAE;QACP,MAAM,EAAE;YACN,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,WAAW,EAAE;YACX,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;IACF,UAAU,EAAE;QACV,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC;YACpB,YAAY,EAAE,MAAM,EAAE,CAAC;YACvB,SAAS,EAAE,MAAM,EAAE,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,QAAQ,EAAE,MAAM,GAAG;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE;YACV,CAAC,KAAK,EAAE,MAAM,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC;gBACb,QAAQ,EAAE,OAAO,CAAC;gBAClB,WAAW,EAAE,MAAM,CAAC;gBACpB,OAAO,CAAC,EAAE,GAAG,CAAC;aACf,CAAC;SACH,CAAC;QACF,QAAQ,EAAE;YACR,OAAO,EAAE,GAAG,CAAC;YACb,QAAQ,EAAE,GAAG,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;SACrB,EAAE,CAAC;QACJ,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC5B,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,WAAW,EAAE,MAAM,GAAG;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,EAAE;YACd,SAAS,EAAE,MAAM,EAAE,CAAC;YACpB,UAAU,EAAE,MAAM,EAAE,CAAC;SACtB,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,GAAG,CAAC;YACd,MAAM,EAAE,GAAG,CAAC;YACZ,KAAK,EAAE,GAAG,CAAC;SACZ,CAAC;QACF,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB,eAAe,EAAE,MAAM,EAAE,CAAC;KAC3B,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE;QACT,CAAC,QAAQ,EAAE,MAAM,GAAG;YAClB,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,GAAG,EAAE,CAAC;YAChB,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;IACF,WAAW,EAAE;QACX,CAAC,UAAU,EAAE,MAAM,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC;YACpB,UAAU,EAAE,MAAM,EAAE,CAAC;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC;YAChB,kBAAkB,EAAE,MAAM,EAAE,CAAC;SAC9B,CAAC;KACH,CAAC;IACF,QAAQ,EAAE;QACR,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,EAAE,GAAG,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,OAAO,EAAE,MAAM,GAAG;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,uBAAuB,EAAE,MAAM,EAAE,CAAC;KACnC,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,MAAM,EAAE,MAAM,GAAG;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,GAAG,CAAC;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,cAAc,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,QAAQ,EAAE,MAAM,GAAG;QAClB,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;YACpB,IAAI,EAAE,GAAG,CAAC;YACV,WAAW,EAAE,MAAM,CAAC;YACpB,UAAU,EAAE,GAAG,EAAE,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,KAAK,EAAE,MAAM,GAAG;QACf,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,aAAa,EAAE,MAAM,EAAE,CAAC;KACzB,CAAC;CACH;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBA2jC/B,CAAC;AAEF;;GAEG;AACH,qBAAa,sBAAsB;IACjC;;OAEG;IACH,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG;IAehD;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE;IAUhD,OAAO,CAAC,MAAM,CAAC,cAAc;IAiB7B;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG;IAgBxD;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG;IAW3D;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE;CA+BvG"}