@forumviriumhelsinki/podio-mcp 2.3.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.
- package/LICENSE +21 -0
- package/README.md +491 -0
- package/build/__tests__/integration/setup.integration.d.ts +104 -0
- package/build/__tests__/integration/setup.integration.d.ts.map +1 -0
- package/build/__tests__/integration/setup.integration.js +233 -0
- package/build/__tests__/integration/setup.integration.js.map +1 -0
- package/build/__tests__/mock-data/items-mock-data.d.ts +168 -0
- package/build/__tests__/mock-data/items-mock-data.d.ts.map +1 -0
- package/build/__tests__/mock-data/items-mock-data.js +370 -0
- package/build/__tests__/mock-data/items-mock-data.js.map +1 -0
- package/build/__tests__/mock-data/notification-mock-data.d.ts +55 -0
- package/build/__tests__/mock-data/notification-mock-data.d.ts.map +1 -0
- package/build/__tests__/mock-data/notification-mock-data.js +190 -0
- package/build/__tests__/mock-data/notification-mock-data.js.map +1 -0
- package/build/__tests__/mock-data/project-epic-mock-data.d.ts +45 -0
- package/build/__tests__/mock-data/project-epic-mock-data.d.ts.map +1 -0
- package/build/__tests__/mock-data/project-epic-mock-data.js +85 -0
- package/build/__tests__/mock-data/project-epic-mock-data.js.map +1 -0
- package/build/__tests__/mock-data/tasks-mock-data.d.ts +27 -0
- package/build/__tests__/mock-data/tasks-mock-data.d.ts.map +1 -0
- package/build/__tests__/mock-data/tasks-mock-data.js +104 -0
- package/build/__tests__/mock-data/tasks-mock-data.js.map +1 -0
- package/build/__tests__/mock-data/utility-mock-data.d.ts +19 -0
- package/build/__tests__/mock-data/utility-mock-data.d.ts.map +1 -0
- package/build/__tests__/mock-data/utility-mock-data.js +165 -0
- package/build/__tests__/mock-data/utility-mock-data.js.map +1 -0
- package/build/__tests__/setup.d.ts +8 -0
- package/build/__tests__/setup.d.ts.map +1 -0
- package/build/__tests__/setup.js +31 -0
- package/build/__tests__/setup.js.map +1 -0
- package/build/__tests__/utils/test-helpers.d.ts +110 -0
- package/build/__tests__/utils/test-helpers.d.ts.map +1 -0
- package/build/__tests__/utils/test-helpers.js +222 -0
- package/build/__tests__/utils/test-helpers.js.map +1 -0
- package/build/api/podio-api-client.d.ts +364 -0
- package/build/api/podio-api-client.d.ts.map +1 -0
- package/build/api/podio-api-client.js +696 -0
- package/build/api/podio-api-client.js.map +1 -0
- package/build/cache/app-cache.d.ts +77 -0
- package/build/cache/app-cache.d.ts.map +1 -0
- package/build/cache/app-cache.js +230 -0
- package/build/cache/app-cache.js.map +1 -0
- package/build/cache/base-cache-manager.d.ts +149 -0
- package/build/cache/base-cache-manager.d.ts.map +1 -0
- package/build/cache/base-cache-manager.js +312 -0
- package/build/cache/base-cache-manager.js.map +1 -0
- package/build/cache/cache-manager.d.ts +230 -0
- package/build/cache/cache-manager.d.ts.map +1 -0
- package/build/cache/cache-manager.js +362 -0
- package/build/cache/cache-manager.js.map +1 -0
- package/build/cache/cache-test.d.ts +9 -0
- package/build/cache/cache-test.d.ts.map +1 -0
- package/build/cache/cache-test.js +169 -0
- package/build/cache/cache-test.js.map +1 -0
- package/build/cache/index.d.ts +18 -0
- package/build/cache/index.d.ts.map +1 -0
- package/build/cache/index.js +20 -0
- package/build/cache/index.js.map +1 -0
- package/build/cache/migration-helper.d.ts +44 -0
- package/build/cache/migration-helper.d.ts.map +1 -0
- package/build/cache/migration-helper.js +235 -0
- package/build/cache/migration-helper.js.map +1 -0
- package/build/cache/project-epic-cache.d.ts +108 -0
- package/build/cache/project-epic-cache.d.ts.map +1 -0
- package/build/cache/project-epic-cache.js +278 -0
- package/build/cache/project-epic-cache.js.map +1 -0
- package/build/cache/space-members-cache.d.ts +99 -0
- package/build/cache/space-members-cache.d.ts.map +1 -0
- package/build/cache/space-members-cache.js +305 -0
- package/build/cache/space-members-cache.js.map +1 -0
- package/build/cache/storage-adapters.d.ts +100 -0
- package/build/cache/storage-adapters.d.ts.map +1 -0
- package/build/cache/storage-adapters.js +297 -0
- package/build/cache/storage-adapters.js.map +1 -0
- package/build/errors/api-errors.d.ts +52 -0
- package/build/errors/api-errors.d.ts.map +1 -0
- package/build/errors/api-errors.js +86 -0
- package/build/errors/api-errors.js.map +1 -0
- package/build/errors/auth-errors.d.ts +67 -0
- package/build/errors/auth-errors.d.ts.map +1 -0
- package/build/errors/auth-errors.js +114 -0
- package/build/errors/auth-errors.js.map +1 -0
- package/build/errors/base.d.ts +102 -0
- package/build/errors/base.d.ts.map +1 -0
- package/build/errors/base.js +131 -0
- package/build/errors/base.js.map +1 -0
- package/build/errors/cache-errors.d.ts +53 -0
- package/build/errors/cache-errors.d.ts.map +1 -0
- package/build/errors/cache-errors.js +83 -0
- package/build/errors/cache-errors.js.map +1 -0
- package/build/errors/config-errors.d.ts +58 -0
- package/build/errors/config-errors.d.ts.map +1 -0
- package/build/errors/config-errors.js +96 -0
- package/build/errors/config-errors.js.map +1 -0
- package/build/errors/index.d.ts +101 -0
- package/build/errors/index.d.ts.map +1 -0
- package/build/errors/index.js +135 -0
- package/build/errors/index.js.map +1 -0
- package/build/errors/structure-errors.d.ts +89 -0
- package/build/errors/structure-errors.d.ts.map +1 -0
- package/build/errors/structure-errors.js +182 -0
- package/build/errors/structure-errors.js.map +1 -0
- package/build/errors/validation-errors.d.ts +81 -0
- package/build/errors/validation-errors.d.ts.map +1 -0
- package/build/errors/validation-errors.js +169 -0
- package/build/errors/validation-errors.js.map +1 -0
- package/build/fields/field-mapper.d.ts +245 -0
- package/build/fields/field-mapper.d.ts.map +1 -0
- package/build/fields/field-mapper.js +404 -0
- package/build/fields/field-mapper.js.map +1 -0
- package/build/index.d.ts +550 -0
- package/build/index.d.ts.map +1 -0
- package/build/index.js +1527 -0
- package/build/index.js.map +1 -0
- package/build/oauth-helper.d.ts +189 -0
- package/build/oauth-helper.d.ts.map +1 -0
- package/build/oauth-helper.js +422 -0
- package/build/oauth-helper.js.map +1 -0
- package/build/services/app-structure-service.d.ts +49 -0
- package/build/services/app-structure-service.d.ts.map +1 -0
- package/build/services/app-structure-service.js +122 -0
- package/build/services/app-structure-service.js.map +1 -0
- package/build/services/code-execution-service.d.ts +88 -0
- package/build/services/code-execution-service.d.ts.map +1 -0
- package/build/services/code-execution-service.js +342 -0
- package/build/services/code-execution-service.js.map +1 -0
- package/build/services/comment-service.d.ts +66 -0
- package/build/services/comment-service.d.ts.map +1 -0
- package/build/services/comment-service.js +139 -0
- package/build/services/comment-service.js.map +1 -0
- package/build/services/index.d.ts +16 -0
- package/build/services/index.d.ts.map +1 -0
- package/build/services/index.js +15 -0
- package/build/services/index.js.map +1 -0
- package/build/services/item-service.d.ts +104 -0
- package/build/services/item-service.d.ts.map +1 -0
- package/build/services/item-service.js +368 -0
- package/build/services/item-service.js.map +1 -0
- package/build/services/notification-service.d.ts +125 -0
- package/build/services/notification-service.d.ts.map +1 -0
- package/build/services/notification-service.js +321 -0
- package/build/services/notification-service.js.map +1 -0
- package/build/services/project-epic-service.d.ts +73 -0
- package/build/services/project-epic-service.d.ts.map +1 -0
- package/build/services/project-epic-service.js +248 -0
- package/build/services/project-epic-service.js.map +1 -0
- package/build/services/response-formatter.d.ts +190 -0
- package/build/services/response-formatter.d.ts.map +1 -0
- package/build/services/response-formatter.js +1221 -0
- package/build/services/response-formatter.js.map +1 -0
- package/build/services/search-service.d.ts +103 -0
- package/build/services/search-service.d.ts.map +1 -0
- package/build/services/search-service.js +273 -0
- package/build/services/search-service.js.map +1 -0
- package/build/services/task-service.d.ts +70 -0
- package/build/services/task-service.d.ts.map +1 -0
- package/build/services/task-service.js +156 -0
- package/build/services/task-service.js.map +1 -0
- package/build/tools/index.d.ts +8 -0
- package/build/tools/index.d.ts.map +1 -0
- package/build/tools/index.js +8 -0
- package/build/tools/index.js.map +1 -0
- package/build/tools/tool-definitions.d.ts +89 -0
- package/build/tools/tool-definitions.d.ts.map +1 -0
- package/build/tools/tool-definitions.js +1167 -0
- package/build/tools/tool-definitions.js.map +1 -0
- package/build/types/api-types.d.ts +106 -0
- package/build/types/api-types.d.ts.map +1 -0
- package/build/types/api-types.js +11 -0
- package/build/types/api-types.js.map +1 -0
- package/build/types/cache-types.d.ts +52 -0
- package/build/types/cache-types.d.ts.map +1 -0
- package/build/types/cache-types.js +12 -0
- package/build/types/cache-types.js.map +1 -0
- package/build/types/index.d.ts +31 -0
- package/build/types/index.d.ts.map +1 -0
- package/build/types/index.js +25 -0
- package/build/types/index.js.map +1 -0
- package/build/types/notification-types.d.ts +154 -0
- package/build/types/notification-types.d.ts.map +1 -0
- package/build/types/notification-types.js +7 -0
- package/build/types/notification-types.js.map +1 -0
- package/build/types/podio-types.d.ts +250 -0
- package/build/types/podio-types.d.ts.map +1 -0
- package/build/types/podio-types.js +11 -0
- package/build/types/podio-types.js.map +1 -0
- package/build/types/search-types.d.ts +188 -0
- package/build/types/search-types.d.ts.map +1 -0
- package/build/types/search-types.js +43 -0
- package/build/types/search-types.js.map +1 -0
- package/build/utils/debug.d.ts +58 -0
- package/build/utils/debug.d.ts.map +1 -0
- package/build/utils/debug.js +147 -0
- package/build/utils/debug.js.map +1 -0
- package/examples/claude-config-example.json +13 -0
- package/package.json +87 -0
- package/scripts/generate-claude-config.js +107 -0
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Shared test utilities and helpers
|
|
3
|
+
*
|
|
4
|
+
* This module provides reusable testing utilities that can be used across
|
|
5
|
+
* all test suites to ensure consistency and reduce duplication.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Test assertion helpers for common validation patterns
|
|
9
|
+
*/
|
|
10
|
+
export class TestAssertions {
|
|
11
|
+
/**
|
|
12
|
+
* Assert that an MCP response has the expected structure
|
|
13
|
+
*/
|
|
14
|
+
static validateMcpResponse(response) {
|
|
15
|
+
expect(response).toBeDefined();
|
|
16
|
+
expect(response.content).toBeDefined();
|
|
17
|
+
expect(Array.isArray(response.content)).toBe(true);
|
|
18
|
+
expect(response.content.length).toBeGreaterThan(0);
|
|
19
|
+
expect(response.content[0]).toHaveProperty('type', 'text');
|
|
20
|
+
expect(response.content[0]).toHaveProperty('text');
|
|
21
|
+
expect(typeof response.content[0].text).toBe('string');
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Assert that response text does not contain error indicators
|
|
25
|
+
*/
|
|
26
|
+
static validateNoErrorIndicators(responseText) {
|
|
27
|
+
expect(responseText).not.toContain('undefined');
|
|
28
|
+
expect(responseText).not.toContain('null');
|
|
29
|
+
expect(responseText).not.toContain('NaN');
|
|
30
|
+
expect(responseText).not.toContain('Invalid Date');
|
|
31
|
+
expect(responseText).not.toContain('[object Object]');
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Assert that response contains expected formatting patterns
|
|
35
|
+
*/
|
|
36
|
+
static validateFormattingPatterns(responseText, patterns) {
|
|
37
|
+
if (patterns.shouldContain) {
|
|
38
|
+
patterns.shouldContain.forEach((pattern) => {
|
|
39
|
+
expect(responseText).toContain(pattern);
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
if (patterns.shouldNotContain) {
|
|
43
|
+
patterns.shouldNotContain.forEach((pattern) => {
|
|
44
|
+
expect(responseText).not.toContain(pattern);
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
if (patterns.shouldMatch) {
|
|
48
|
+
patterns.shouldMatch.forEach((pattern) => {
|
|
49
|
+
expect(responseText).toMatch(pattern);
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
if (patterns.shouldNotMatch) {
|
|
53
|
+
patterns.shouldNotMatch.forEach((pattern) => {
|
|
54
|
+
expect(responseText).not.toMatch(pattern);
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Assert that response handles pagination correctly
|
|
60
|
+
*/
|
|
61
|
+
static validatePaginationIndicators(responseText, options) {
|
|
62
|
+
expect(responseText).toContain(`(${options.currentCount}`);
|
|
63
|
+
if (options.totalCount && options.totalCount !== options.currentCount) {
|
|
64
|
+
expect(responseText).toContain(`of ${options.totalCount}`);
|
|
65
|
+
}
|
|
66
|
+
if (options.hasMore) {
|
|
67
|
+
expect(responseText).toContain('Showing first');
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Mock data generation utilities
|
|
73
|
+
*/
|
|
74
|
+
export class MockDataHelpers {
|
|
75
|
+
/**
|
|
76
|
+
* Generate a realistic timestamp in various formats
|
|
77
|
+
*/
|
|
78
|
+
static generateTimestamp(format = 'iso') {
|
|
79
|
+
const date = new Date('2024-01-15T10:30:00.000Z');
|
|
80
|
+
switch (format) {
|
|
81
|
+
case 'iso':
|
|
82
|
+
return date.toISOString();
|
|
83
|
+
case 'broken':
|
|
84
|
+
return date.toISOString().replace('T', ' ').replace('Z', '');
|
|
85
|
+
case 'european':
|
|
86
|
+
return date.toLocaleDateString('en-GB');
|
|
87
|
+
case 'malformed':
|
|
88
|
+
return 'invalid-date-format';
|
|
89
|
+
default:
|
|
90
|
+
return date.toISOString();
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Generate realistic Finnish text content
|
|
95
|
+
*/
|
|
96
|
+
static generateFinnishContent() {
|
|
97
|
+
const titles = [
|
|
98
|
+
'Lidar datan visualisointi',
|
|
99
|
+
'Mäkelänkatu lämpömittaukset 2025',
|
|
100
|
+
'Tutkan käyttöönotto pysäköinninmittauksiin',
|
|
101
|
+
'INRIX data retrieval & storage',
|
|
102
|
+
'Flasheye MQTT integraatio',
|
|
103
|
+
];
|
|
104
|
+
const descriptions = [
|
|
105
|
+
'Tänä aamuna lähtenyt tiedote pääsi Talouselämään',
|
|
106
|
+
'Esiteltiin @Jukka Alander kanssa Digikaksosta ja ihmisvirtamittauksia',
|
|
107
|
+
'ELABORATOR-hankkeen sähköpotkulautojen pysäköintikokeilu on alkamassa',
|
|
108
|
+
'Työfysioterapeutti Annukka Knuutinen tulee käymään toimistolla',
|
|
109
|
+
'ENOT seurantaraportoinnin tekninen materiaali',
|
|
110
|
+
];
|
|
111
|
+
const shortTexts = [
|
|
112
|
+
'Uusi tehtävä',
|
|
113
|
+
'Seuranta aloitettu',
|
|
114
|
+
'Testaus käynnissä',
|
|
115
|
+
'Dokumentaatio päivitetty',
|
|
116
|
+
'Kokous sovittu',
|
|
117
|
+
];
|
|
118
|
+
return {
|
|
119
|
+
title: MockDataHelpers.randomChoice(titles),
|
|
120
|
+
description: MockDataHelpers.randomChoice(descriptions),
|
|
121
|
+
shortText: MockDataHelpers.randomChoice(shortTexts),
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Generate edge case values for testing
|
|
126
|
+
*/
|
|
127
|
+
static generateEdgeCaseValues() {
|
|
128
|
+
return {
|
|
129
|
+
emptyString: '',
|
|
130
|
+
whitespace: ' ',
|
|
131
|
+
nullValue: null,
|
|
132
|
+
undefinedValue: undefined,
|
|
133
|
+
zeroValue: 0,
|
|
134
|
+
negativeValue: -1,
|
|
135
|
+
largeValue: 999999999999,
|
|
136
|
+
specialCharacters: '!@#$%^&*()_+-={}[]|\\:";\'<>?,./',
|
|
137
|
+
unicodeText: '🔴🟢🔄🛡️📅👤🔗🏢🚀💡⚡🎯🛠️',
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Generate realistic user information
|
|
142
|
+
*/
|
|
143
|
+
static generateUserInfo() {
|
|
144
|
+
const names = ['Lauri Gates', 'Jukka Alander', 'Annukka Knuutinen', 'Satu Reijonen'];
|
|
145
|
+
const domains = ['forumvirium.fi', 'test.com', 'example.org'];
|
|
146
|
+
const name = MockDataHelpers.randomChoice(names);
|
|
147
|
+
const email = `${name.toLowerCase().replace(' ', '.')}@${MockDataHelpers.randomChoice(domains)}`;
|
|
148
|
+
return {
|
|
149
|
+
id: Math.floor(Math.random() * 1000000),
|
|
150
|
+
name,
|
|
151
|
+
email,
|
|
152
|
+
};
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Generate realistic space/app information
|
|
156
|
+
*/
|
|
157
|
+
static generateSpaceInfo() {
|
|
158
|
+
const spaceNames = ['Forum Virium', 'Development Team', 'Test Space', 'Project Alpha'];
|
|
159
|
+
const orgLabels = ['forumvirium', 'testorg', 'development'];
|
|
160
|
+
const appLabels = ['tasks', 'projects', 'tracker', 'management'];
|
|
161
|
+
const name = MockDataHelpers.randomChoice(spaceNames);
|
|
162
|
+
return {
|
|
163
|
+
space_id: Math.floor(Math.random() * 10000),
|
|
164
|
+
name,
|
|
165
|
+
url: `https://podio.com/${name.toLowerCase().replace(' ', '-')}`,
|
|
166
|
+
org_label: MockDataHelpers.randomChoice(orgLabels),
|
|
167
|
+
app_label: MockDataHelpers.randomChoice(appLabels),
|
|
168
|
+
};
|
|
169
|
+
}
|
|
170
|
+
static randomChoice(array) {
|
|
171
|
+
return array[Math.floor(Math.random() * array.length)];
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Test scenario builders for integration testing
|
|
176
|
+
*/
|
|
177
|
+
export class ScenarioBuilders {
|
|
178
|
+
/**
|
|
179
|
+
* Build a complete CRUD workflow scenario
|
|
180
|
+
*/
|
|
181
|
+
static buildCrudWorkflow() {
|
|
182
|
+
const finnishContent = MockDataHelpers.generateFinnishContent();
|
|
183
|
+
const userInfo = MockDataHelpers.generateUserInfo();
|
|
184
|
+
return {
|
|
185
|
+
createData: {
|
|
186
|
+
title: finnishContent.title,
|
|
187
|
+
description: finnishContent.description,
|
|
188
|
+
responsible: userInfo.name,
|
|
189
|
+
},
|
|
190
|
+
updateData: {
|
|
191
|
+
title: `Updated: ${finnishContent.title}`,
|
|
192
|
+
description: `Updated: ${finnishContent.description}`,
|
|
193
|
+
status: 'In Progress',
|
|
194
|
+
},
|
|
195
|
+
expectedCreateResponse: ['✅ Successfully created item', finnishContent.title, userInfo.name],
|
|
196
|
+
expectedUpdateResponse: ['✅ Successfully updated item', 'Updated:', 'In Progress'],
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Build error handling scenarios
|
|
201
|
+
*/
|
|
202
|
+
static buildErrorScenarios() {
|
|
203
|
+
return [
|
|
204
|
+
{
|
|
205
|
+
scenario: 'Missing required field',
|
|
206
|
+
data: { description: 'Test without title' },
|
|
207
|
+
expectedError: 'Required field',
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
scenario: 'Invalid data type',
|
|
211
|
+
data: { item_id: 'not-a-number' },
|
|
212
|
+
expectedError: 'Invalid',
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
scenario: 'Non-existent resource',
|
|
216
|
+
data: { item_id: 999999999 },
|
|
217
|
+
expectedError: 'not found',
|
|
218
|
+
},
|
|
219
|
+
];
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
//# sourceMappingURL=test-helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test-helpers.js","sourceRoot":"","sources":["../../../src/__tests__/utils/test-helpers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,QAAqB;QAC9C,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,yBAAyB,CAAC,YAAoB;QACnD,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAC/B,YAAoB,EACpB,QAKC;QAED,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;YAC3B,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACzC,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC5C,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YACzB,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1C,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,4BAA4B,CACjC,YAAoB,EACpB,OAIC;QAED,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAE3D,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,KAAK,OAAO,CAAC,YAAY,EAAE,CAAC;YACtE,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IAC1B;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,SAAsD,KAAK;QAClF,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAElD,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC/D,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC1C,KAAK,WAAW;gBACd,OAAO,qBAAqB,CAAC;YAC/B;gBACE,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,sBAAsB;QAK3B,MAAM,MAAM,GAAG;YACb,2BAA2B;YAC3B,kCAAkC;YAClC,4CAA4C;YAC5C,gCAAgC;YAChC,2BAA2B;SAC5B,CAAC;QAEF,MAAM,YAAY,GAAG;YACnB,kDAAkD;YAClD,uEAAuE;YACvE,uEAAuE;YACvE,gEAAgE;YAChE,+CAA+C;SAChD,CAAC;QAEF,MAAM,UAAU,GAAG;YACjB,cAAc;YACd,oBAAoB;YACpB,mBAAmB;YACnB,0BAA0B;YAC1B,gBAAgB;SACjB,CAAC;QAEF,OAAO;YACL,KAAK,EAAE,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC;YAC3C,WAAW,EAAE,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC;YACvD,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC;SACpD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,sBAAsB;QAW3B,OAAO;YACL,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,IAAI;YACf,cAAc,EAAE,SAAS;YACzB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,CAAC,CAAC;YACjB,UAAU,EAAE,YAAY;YACxB,iBAAiB,EAAE,kCAAkC;YACrD,WAAW,EAAE,6BAA6B;SAC3C,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB;QAKrB,MAAM,KAAK,GAAG,CAAC,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC;QACrF,MAAM,OAAO,GAAG,CAAC,gBAAgB,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QAE9D,MAAM,IAAI,GAAG,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,eAAe,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAEjG,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC;YACvC,IAAI;YACJ,KAAK;SACN,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB;QAOtB,MAAM,UAAU,GAAG,CAAC,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QACvF,MAAM,SAAS,GAAG,CAAC,aAAa,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;QAEjE,MAAM,IAAI,GAAG,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAEtD,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC;YAC3C,IAAI;YACJ,GAAG,EAAE,qBAAqB,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YAChE,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,SAAS,CAAC;YAClD,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,SAAS,CAAC;SACnD,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,YAAY,CAAI,KAAU;QACvC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,iBAAiB;QAMtB,MAAM,cAAc,GAAG,eAAe,CAAC,sBAAsB,EAAE,CAAC;QAChE,MAAM,QAAQ,GAAG,eAAe,CAAC,gBAAgB,EAAE,CAAC;QAEpD,OAAO;YACL,UAAU,EAAE;gBACV,KAAK,EAAE,cAAc,CAAC,KAAK;gBAC3B,WAAW,EAAE,cAAc,CAAC,WAAW;gBACvC,WAAW,EAAE,QAAQ,CAAC,IAAI;aAC3B;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY,cAAc,CAAC,KAAK,EAAE;gBACzC,WAAW,EAAE,YAAY,cAAc,CAAC,WAAW,EAAE;gBACrD,MAAM,EAAE,aAAa;aACtB;YACD,sBAAsB,EAAE,CAAC,6BAA6B,EAAE,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC;YAC5F,sBAAsB,EAAE,CAAC,6BAA6B,EAAE,UAAU,EAAE,aAAa,CAAC;SACnF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,mBAAmB;QAKxB,OAAO;YACL;gBACE,QAAQ,EAAE,wBAAwB;gBAClC,IAAI,EAAE,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBAC3C,aAAa,EAAE,gBAAgB;aAChC;YACD;gBACE,QAAQ,EAAE,mBAAmB;gBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE;gBACjC,aAAa,EAAE,SAAS;aACzB;YACD;gBACE,QAAQ,EAAE,uBAAuB;gBACjC,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;gBAC5B,aAAa,EAAE,WAAW;aAC3B;SACF,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,364 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview PodioApiClient class for centralized Podio API communication
|
|
3
|
+
*
|
|
4
|
+
* This module provides a centralized, type-safe client for all Podio API operations,
|
|
5
|
+
* eliminating repeated fetch + auth + error handling patterns throughout the codebase.
|
|
6
|
+
*
|
|
7
|
+
* @module PodioApiClient
|
|
8
|
+
*/
|
|
9
|
+
import type { PodioOAuthHelper } from '../oauth-helper.js';
|
|
10
|
+
import { type PodioItem, type PodioTask, type PodioNotification, type NotificationsResponse, type NotificationFilters, type InboxNewCount, type NotificationSettings, type SearchFilters, type SearchResponse, type PodioComment, type PodioItemRevision, type PodioItemRevisionDiff } from '../types/index.js';
|
|
11
|
+
/**
|
|
12
|
+
* HTTP methods supported by the API client
|
|
13
|
+
*/
|
|
14
|
+
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
15
|
+
/**
|
|
16
|
+
* Configuration for API requests
|
|
17
|
+
*/
|
|
18
|
+
export interface ApiRequestConfig {
|
|
19
|
+
/** HTTP method to use */
|
|
20
|
+
method?: HttpMethod;
|
|
21
|
+
/** Request headers (auth will be added automatically) */
|
|
22
|
+
headers?: Record<string, string>;
|
|
23
|
+
/** Request body data */
|
|
24
|
+
body?: any;
|
|
25
|
+
/** Request timeout in milliseconds */
|
|
26
|
+
timeout?: number;
|
|
27
|
+
/** Number of retry attempts on failure */
|
|
28
|
+
retries?: number;
|
|
29
|
+
/** Whether to include auth header automatically */
|
|
30
|
+
includeAuth?: boolean;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Standard API response wrapper
|
|
34
|
+
*/
|
|
35
|
+
export interface ApiResponse<T = any> {
|
|
36
|
+
/** Response data */
|
|
37
|
+
data: T;
|
|
38
|
+
/** HTTP status code */
|
|
39
|
+
status: number;
|
|
40
|
+
/** Response headers */
|
|
41
|
+
headers: Headers;
|
|
42
|
+
/** Whether the request was successful */
|
|
43
|
+
success: boolean;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* PodioApiClient provides centralized API communication for all Podio operations.
|
|
47
|
+
*
|
|
48
|
+
* This class eliminates the repeated fetch + OAuth2 + error handling patterns
|
|
49
|
+
* by providing a consistent, type-safe interface for all API calls.
|
|
50
|
+
*
|
|
51
|
+
* Features:
|
|
52
|
+
* - Automatic OAuth2 authentication
|
|
53
|
+
* - Consistent error handling and retry logic
|
|
54
|
+
* - Request/response logging
|
|
55
|
+
* - Type-safe response handling
|
|
56
|
+
* - Rate limiting and timeout management
|
|
57
|
+
*
|
|
58
|
+
* @example Basic API calls
|
|
59
|
+
* ```typescript
|
|
60
|
+
* const client = new PodioApiClient(oauthHelper);
|
|
61
|
+
*
|
|
62
|
+
* // GET request
|
|
63
|
+
* const items = await client.get<PodioItem[]>('/item/app/12345/filter/');
|
|
64
|
+
*
|
|
65
|
+
* // POST request
|
|
66
|
+
* const newItem = await client.post<PodioItem>('/item/app/12345/', {
|
|
67
|
+
* fields: { title: 'New Task' }
|
|
68
|
+
* });
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
export declare class PodioApiClient {
|
|
72
|
+
/** Base URL for all Podio API endpoints */
|
|
73
|
+
private readonly baseUrl;
|
|
74
|
+
/** OAuth helper for authentication */
|
|
75
|
+
private readonly oauthHelper;
|
|
76
|
+
/** Default request timeout in milliseconds */
|
|
77
|
+
private readonly defaultTimeout;
|
|
78
|
+
/** Default number of retries */
|
|
79
|
+
private readonly defaultRetries;
|
|
80
|
+
constructor(oauthHelper: PodioOAuthHelper);
|
|
81
|
+
/**
|
|
82
|
+
* Make a GET request to the Podio API
|
|
83
|
+
*
|
|
84
|
+
* @param endpoint - API endpoint path (without base URL)
|
|
85
|
+
* @param config - Request configuration
|
|
86
|
+
* @returns Promise resolving to the API response
|
|
87
|
+
*/
|
|
88
|
+
get<T = any>(endpoint: string, config?: Omit<ApiRequestConfig, 'method' | 'body'>): Promise<ApiResponse<T>>;
|
|
89
|
+
/**
|
|
90
|
+
* Make a POST request to the Podio API
|
|
91
|
+
*
|
|
92
|
+
* @param endpoint - API endpoint path (without base URL)
|
|
93
|
+
* @param body - Request body data
|
|
94
|
+
* @param config - Request configuration
|
|
95
|
+
* @returns Promise resolving to the API response
|
|
96
|
+
*/
|
|
97
|
+
post<T = any>(endpoint: string, body?: any, config?: Omit<ApiRequestConfig, 'method' | 'body'>): Promise<ApiResponse<T>>;
|
|
98
|
+
/**
|
|
99
|
+
* Make a PUT request to the Podio API
|
|
100
|
+
*
|
|
101
|
+
* @param endpoint - API endpoint path (without base URL)
|
|
102
|
+
* @param body - Request body data
|
|
103
|
+
* @param config - Request configuration
|
|
104
|
+
* @returns Promise resolving to the API response
|
|
105
|
+
*/
|
|
106
|
+
put<T = any>(endpoint: string, body?: any, config?: Omit<ApiRequestConfig, 'method' | 'body'>): Promise<ApiResponse<T>>;
|
|
107
|
+
/**
|
|
108
|
+
* Make a DELETE request to the Podio API
|
|
109
|
+
*
|
|
110
|
+
* @param endpoint - API endpoint path (without base URL)
|
|
111
|
+
* @param config - Request configuration
|
|
112
|
+
* @returns Promise resolving to the API response
|
|
113
|
+
*/
|
|
114
|
+
delete<T = any>(endpoint: string, config?: Omit<ApiRequestConfig, 'method' | 'body'>): Promise<ApiResponse<T>>;
|
|
115
|
+
/**
|
|
116
|
+
* Core request method with automatic auth, retry, and error handling
|
|
117
|
+
*
|
|
118
|
+
* @param endpoint - API endpoint path (without base URL)
|
|
119
|
+
* @param config - Request configuration
|
|
120
|
+
* @returns Promise resolving to the API response
|
|
121
|
+
* @throws PodioApiError for API failures
|
|
122
|
+
* @throws PodioAuthError for authentication issues
|
|
123
|
+
*/
|
|
124
|
+
private request;
|
|
125
|
+
/**
|
|
126
|
+
* Parse successful API response
|
|
127
|
+
*
|
|
128
|
+
* @param response - Fetch response object
|
|
129
|
+
* @returns Parsed response data
|
|
130
|
+
*/
|
|
131
|
+
private parseResponse;
|
|
132
|
+
/**
|
|
133
|
+
* Parse error response for detailed error information
|
|
134
|
+
*
|
|
135
|
+
* @param response - Fetch response object
|
|
136
|
+
* @returns Error data object
|
|
137
|
+
*/
|
|
138
|
+
private parseErrorResponse;
|
|
139
|
+
/**
|
|
140
|
+
* Delay execution for specified milliseconds
|
|
141
|
+
*
|
|
142
|
+
* @param ms - Milliseconds to delay
|
|
143
|
+
*/
|
|
144
|
+
private delay;
|
|
145
|
+
/**
|
|
146
|
+
* Get app structure by app ID
|
|
147
|
+
*
|
|
148
|
+
* @param appId - Podio app ID
|
|
149
|
+
* @returns App structure data
|
|
150
|
+
*/
|
|
151
|
+
getAppStructure(appId: number): Promise<any>;
|
|
152
|
+
/**
|
|
153
|
+
* Filter items in an app
|
|
154
|
+
*
|
|
155
|
+
* @param appId - Podio app ID
|
|
156
|
+
* @param filters - Filter criteria
|
|
157
|
+
* @param limit - Maximum number of items to return
|
|
158
|
+
* @returns Filtered items
|
|
159
|
+
*/
|
|
160
|
+
filterItems(appId: number, filters?: any, limit?: number): Promise<{
|
|
161
|
+
items: PodioItem[];
|
|
162
|
+
}>;
|
|
163
|
+
/**
|
|
164
|
+
* Create a new item in an app
|
|
165
|
+
*
|
|
166
|
+
* @param appId - Podio app ID
|
|
167
|
+
* @param fields - Item field data
|
|
168
|
+
* @returns Created item
|
|
169
|
+
*/
|
|
170
|
+
createItem(appId: number, fields: Record<string, any>): Promise<PodioItem>;
|
|
171
|
+
/**
|
|
172
|
+
* Update an existing item
|
|
173
|
+
*
|
|
174
|
+
* @param itemId - Podio item ID
|
|
175
|
+
* @param fields - Updated field data
|
|
176
|
+
* @returns Updated item
|
|
177
|
+
*/
|
|
178
|
+
updateItem(itemId: number, fields: Record<string, any>): Promise<PodioItem>;
|
|
179
|
+
/**
|
|
180
|
+
* Delete an item
|
|
181
|
+
*
|
|
182
|
+
* @param itemId - Podio item ID
|
|
183
|
+
*/
|
|
184
|
+
deleteItem(itemId: number): Promise<void>;
|
|
185
|
+
/**
|
|
186
|
+
* Get item details by ID
|
|
187
|
+
*
|
|
188
|
+
* @param itemId - Podio item ID
|
|
189
|
+
* @returns Item details
|
|
190
|
+
*/
|
|
191
|
+
getItem(itemId: number): Promise<PodioItem>;
|
|
192
|
+
/**
|
|
193
|
+
* Get item details by app-specific item ID
|
|
194
|
+
*
|
|
195
|
+
* @param appId - App ID containing the item
|
|
196
|
+
* @param appItemId - App-specific item ID (ticket/item number)
|
|
197
|
+
* @returns Item details
|
|
198
|
+
*/
|
|
199
|
+
getItemByAppItemId(appId: number, appItemId: number): Promise<PodioItem>;
|
|
200
|
+
/**
|
|
201
|
+
* Get tasks for a space
|
|
202
|
+
*
|
|
203
|
+
* @param spaceId - Podio space ID
|
|
204
|
+
* @param filters - Task filters
|
|
205
|
+
* @returns Task list
|
|
206
|
+
*/
|
|
207
|
+
getTasks(spaceId: number, filters?: any): Promise<PodioTask[]>;
|
|
208
|
+
/**
|
|
209
|
+
* Create a new task
|
|
210
|
+
*
|
|
211
|
+
* @param taskData - Task creation data
|
|
212
|
+
* @returns Created task
|
|
213
|
+
*/
|
|
214
|
+
createTask(taskData: any): Promise<PodioTask>;
|
|
215
|
+
/**
|
|
216
|
+
* Update a task
|
|
217
|
+
*
|
|
218
|
+
* @param taskId - Task ID
|
|
219
|
+
* @param taskData - Updated task data
|
|
220
|
+
* @returns Updated task
|
|
221
|
+
*/
|
|
222
|
+
updateTask(taskId: number, taskData: any): Promise<PodioTask>;
|
|
223
|
+
/**
|
|
224
|
+
* Delete a task
|
|
225
|
+
*
|
|
226
|
+
* @param taskId - Task ID
|
|
227
|
+
*/
|
|
228
|
+
deleteTask(taskId: number): Promise<void>;
|
|
229
|
+
/**
|
|
230
|
+
* Get space members
|
|
231
|
+
*
|
|
232
|
+
* @param spaceId - Podio space ID
|
|
233
|
+
* @returns Space members
|
|
234
|
+
*/
|
|
235
|
+
getSpaceMembers(spaceId: number): Promise<any[]>;
|
|
236
|
+
/**
|
|
237
|
+
* Get notifications for the current user
|
|
238
|
+
*
|
|
239
|
+
* @param filters - Optional filters for notifications
|
|
240
|
+
* @returns List of notifications
|
|
241
|
+
*/
|
|
242
|
+
getNotifications(filters?: NotificationFilters): Promise<NotificationsResponse>;
|
|
243
|
+
/**
|
|
244
|
+
* Get a specific notification by ID
|
|
245
|
+
*
|
|
246
|
+
* @param notificationId - Notification ID
|
|
247
|
+
* @returns Notification details
|
|
248
|
+
*/
|
|
249
|
+
getNotification(notificationId: number): Promise<PodioNotification>;
|
|
250
|
+
/**
|
|
251
|
+
* Get inbox new count (number of unread notifications)
|
|
252
|
+
*
|
|
253
|
+
* @returns Inbox count information
|
|
254
|
+
*/
|
|
255
|
+
getInboxNewCount(): Promise<InboxNewCount>;
|
|
256
|
+
/**
|
|
257
|
+
* Get notification settings for the current user
|
|
258
|
+
*
|
|
259
|
+
* @returns Notification settings
|
|
260
|
+
*/
|
|
261
|
+
getNotificationSettings(): Promise<NotificationSettings>;
|
|
262
|
+
/**
|
|
263
|
+
* Perform a global search across all accessible Podio content
|
|
264
|
+
*
|
|
265
|
+
* @param filters - Search filters and parameters
|
|
266
|
+
* @returns Search results
|
|
267
|
+
*/
|
|
268
|
+
searchGlobal(filters: SearchFilters): Promise<SearchResponse>;
|
|
269
|
+
/**
|
|
270
|
+
* Search within a specific space
|
|
271
|
+
*
|
|
272
|
+
* @param spaceId - Space ID to search in
|
|
273
|
+
* @param filters - Search filters and parameters
|
|
274
|
+
* @returns Search results
|
|
275
|
+
*/
|
|
276
|
+
searchInSpace(spaceId: number, filters: SearchFilters): Promise<SearchResponse>;
|
|
277
|
+
/**
|
|
278
|
+
* Search within a specific app
|
|
279
|
+
*
|
|
280
|
+
* @param appId - App ID to search in
|
|
281
|
+
* @param filters - Search filters and parameters
|
|
282
|
+
* @returns Search results
|
|
283
|
+
*/
|
|
284
|
+
searchInApp(appId: number, filters: SearchFilters): Promise<SearchResponse>;
|
|
285
|
+
/**
|
|
286
|
+
* Search within a specific organization
|
|
287
|
+
*
|
|
288
|
+
* @param orgId - Organization ID to search in
|
|
289
|
+
* @param filters - Search filters and parameters
|
|
290
|
+
* @returns Search results
|
|
291
|
+
*/
|
|
292
|
+
searchInOrganization(orgId: number, filters: SearchFilters): Promise<SearchResponse>;
|
|
293
|
+
/**
|
|
294
|
+
* Transform raw Podio search API response to our standardized format
|
|
295
|
+
*
|
|
296
|
+
* @private
|
|
297
|
+
* @param rawResponse - Raw response from Podio API
|
|
298
|
+
* @param scope - Search scope used
|
|
299
|
+
* @param filters - Original search filters
|
|
300
|
+
* @returns Standardized search response
|
|
301
|
+
*/
|
|
302
|
+
private transformSearchResponse;
|
|
303
|
+
/**
|
|
304
|
+
* Get all comments for a specific item
|
|
305
|
+
*
|
|
306
|
+
* @param itemId - Podio item ID
|
|
307
|
+
* @returns List of comments on the item
|
|
308
|
+
*/
|
|
309
|
+
getItemComments(itemId: number): Promise<PodioComment[]>;
|
|
310
|
+
/**
|
|
311
|
+
* Create a new comment on an item
|
|
312
|
+
*
|
|
313
|
+
* @param itemId - Podio item ID
|
|
314
|
+
* @param text - Comment text content
|
|
315
|
+
* @returns Created comment
|
|
316
|
+
*/
|
|
317
|
+
createItemComment(itemId: number, text: string): Promise<PodioComment>;
|
|
318
|
+
/**
|
|
319
|
+
* Get a specific comment by ID
|
|
320
|
+
*
|
|
321
|
+
* @param commentId - Comment ID
|
|
322
|
+
* @returns Comment details
|
|
323
|
+
*/
|
|
324
|
+
getComment(commentId: number): Promise<PodioComment>;
|
|
325
|
+
/**
|
|
326
|
+
* Update an existing comment
|
|
327
|
+
*
|
|
328
|
+
* @param commentId - Comment ID
|
|
329
|
+
* @param text - Updated comment text
|
|
330
|
+
* @returns Updated comment
|
|
331
|
+
*/
|
|
332
|
+
updateComment(commentId: number, text: string): Promise<PodioComment>;
|
|
333
|
+
/**
|
|
334
|
+
* Delete a comment
|
|
335
|
+
*
|
|
336
|
+
* @param commentId - Comment ID
|
|
337
|
+
*/
|
|
338
|
+
deleteComment(commentId: number): Promise<void>;
|
|
339
|
+
/**
|
|
340
|
+
* Get all revisions/activity for a specific item
|
|
341
|
+
*
|
|
342
|
+
* @param itemId - Podio item ID
|
|
343
|
+
* @returns List of item revisions showing activity history
|
|
344
|
+
*/
|
|
345
|
+
getItemRevisions(itemId: number): Promise<PodioItemRevision[]>;
|
|
346
|
+
/**
|
|
347
|
+
* Get details of a specific item revision
|
|
348
|
+
*
|
|
349
|
+
* @param itemId - Podio item ID
|
|
350
|
+
* @param revisionId - Revision ID
|
|
351
|
+
* @returns Specific revision details
|
|
352
|
+
*/
|
|
353
|
+
getItemRevision(itemId: number, revisionId: number): Promise<PodioItemRevision>;
|
|
354
|
+
/**
|
|
355
|
+
* Get the difference between two item revisions
|
|
356
|
+
*
|
|
357
|
+
* @param itemId - Podio item ID
|
|
358
|
+
* @param fromRevision - Starting revision number
|
|
359
|
+
* @param toRevision - Ending revision number
|
|
360
|
+
* @returns Difference between the two revisions
|
|
361
|
+
*/
|
|
362
|
+
getItemRevisionDiff(itemId: number, fromRevision: number, toRevision: number): Promise<PodioItemRevisionDiff>;
|
|
363
|
+
}
|
|
364
|
+
//# sourceMappingURL=podio-api-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"podio-api-client.d.ts","sourceRoot":"","sources":["../../src/api/podio-api-client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,wBAAwB;IACxB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,oBAAoB;IACpB,IAAI,EAAE,CAAC,CAAC;IACR,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,cAAc;IACzB,2CAA2C;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD,sCAAsC;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,8CAA8C;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,gCAAgC;IAChC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAK;gBAExB,WAAW,EAAE,gBAAgB;IAOzC;;;;;;OAMG;IACU,GAAG,CAAC,CAAC,GAAG,GAAG,EACtB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACrD,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAI1B;;;;;;;OAOG;IACU,IAAI,CAAC,CAAC,GAAG,GAAG,EACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,MAAM,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACrD,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAI1B;;;;;;;OAOG;IACU,GAAG,CAAC,CAAC,GAAG,GAAG,EACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,MAAM,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACrD,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAI1B;;;;;;OAMG;IACU,MAAM,CAAC,CAAC,GAAG,GAAG,EACzB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACrD,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAI1B;;;;;;;;OAQG;YACW,OAAO;IAwHrB;;;;;OAKG;YACW,aAAa;IAU3B;;;;;OAKG;YACW,kBAAkB;IAchC;;;;OAIG;IACH,OAAO,CAAC,KAAK;IAMb;;;;;OAKG;IACU,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAKzD;;;;;;;OAOG;IACU,WAAW,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,GAAQ,EACjB,KAAK,SAAK,GACT,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,EAAE,CAAA;KAAE,CAAC;IAQlC;;;;;;OAMG;IACU,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAKvF;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAKxF;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAKxD;;;;;;OAMG;IACU,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAKrF;;;;;;OAMG;IACU,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,GAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAK/E;;;;;OAKG;IACU,UAAU,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAK1D;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAK1E;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD;;;;;OAKG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAS7D;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwBhG;;;;;OAKG;IACU,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKhF;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAKvD;;;;OAIG;IACU,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IASrE;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoB1E;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoB5F;;;;;;OAMG;IACU,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBxF;;;;;;OAMG;IACU,oBAAoB,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,cAAc,CAAC;IAoB1B;;;;;;;;OAQG;IACH,OAAO,CAAC,uBAAuB;IAiE/B;;;;;OAKG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAKrE;;;;;;OAMG;IACU,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKnF;;;;;OAKG;IACU,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKjE;;;;;;OAMG;IACU,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKlF;;;;OAIG;IACU,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5D;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAK3E;;;;;;OAMG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAK5F;;;;;;;OAOG;IACU,mBAAmB,CAC9B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,qBAAqB,CAAC;CAMlC"}
|