@yadsh/dsh-qa-integrations 0.5.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 +617 -0
- package/compatibility.json +10 -0
- package/cordis.patch.yml +5 -0
- package/lib/broker.js +239 -0
- package/lib/broker.js.map +1 -0
- package/lib/client/bitrix24.js +33 -0
- package/lib/client/bitrix24.js.map +1 -0
- package/lib/client/card.js +33 -0
- package/lib/client/card.js.map +1 -0
- package/lib/client/confluence.js +148 -0
- package/lib/client/confluence.js.map +1 -0
- package/lib/client/copy.js +18 -0
- package/lib/client/copy.js.map +1 -0
- package/lib/client/gitlab.js +64 -0
- package/lib/client/gitlab.js.map +1 -0
- package/lib/client/index.js +71 -0
- package/lib/client/index.js.map +1 -0
- package/lib/client/integrations.js +34 -0
- package/lib/client/integrations.js.map +1 -0
- package/lib/client/jira.js +150 -0
- package/lib/client/jira.js.map +1 -0
- package/lib/client/provider-card.js +143 -0
- package/lib/client/provider-card.js.map +1 -0
- package/lib/client/styles.js +35 -0
- package/lib/client/styles.js.map +1 -0
- package/lib/client/teamcity.js +55 -0
- package/lib/client/teamcity.js.map +1 -0
- package/lib/client.js +8069 -0
- package/lib/client.js.map +1 -0
- package/lib/coerce.js +69 -0
- package/lib/coerce.js.map +1 -0
- package/lib/config.js +51 -0
- package/lib/config.js.map +1 -0
- package/lib/errors.js +14 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.js +510 -0
- package/lib/index.js.map +1 -0
- package/lib/providers/bitrix24/catalog.js +245 -0
- package/lib/providers/bitrix24/catalog.js.map +1 -0
- package/lib/providers/bitrix24/config.js +40 -0
- package/lib/providers/bitrix24/config.js.map +1 -0
- package/lib/providers/bitrix24/index.js +128 -0
- package/lib/providers/bitrix24/index.js.map +1 -0
- package/lib/providers/bitrix24/operations.js +491 -0
- package/lib/providers/bitrix24/operations.js.map +1 -0
- package/lib/providers/bitrix24/tools.js +1035 -0
- package/lib/providers/bitrix24/tools.js.map +1 -0
- package/lib/providers/bitrix24/transport.js +142 -0
- package/lib/providers/bitrix24/transport.js.map +1 -0
- package/lib/providers/confluence/adf.js +348 -0
- package/lib/providers/confluence/adf.js.map +1 -0
- package/lib/providers/confluence/catalog.js +135 -0
- package/lib/providers/confluence/catalog.js.map +1 -0
- package/lib/providers/confluence/config.js +196 -0
- package/lib/providers/confluence/config.js.map +1 -0
- package/lib/providers/confluence/cql.js +78 -0
- package/lib/providers/confluence/cql.js.map +1 -0
- package/lib/providers/confluence/index.js +319 -0
- package/lib/providers/confluence/index.js.map +1 -0
- package/lib/providers/confluence/operations.js +653 -0
- package/lib/providers/confluence/operations.js.map +1 -0
- package/lib/providers/confluence/tools.js +282 -0
- package/lib/providers/confluence/tools.js.map +1 -0
- package/lib/providers/confluence/transport.js +247 -0
- package/lib/providers/confluence/transport.js.map +1 -0
- package/lib/providers/contract.js +2 -0
- package/lib/providers/contract.js.map +1 -0
- package/lib/providers/gitlab/catalog.js +171 -0
- package/lib/providers/gitlab/catalog.js.map +1 -0
- package/lib/providers/gitlab/config.js +141 -0
- package/lib/providers/gitlab/config.js.map +1 -0
- package/lib/providers/gitlab/index.js +227 -0
- package/lib/providers/gitlab/index.js.map +1 -0
- package/lib/providers/gitlab/operations.js +794 -0
- package/lib/providers/gitlab/operations.js.map +1 -0
- package/lib/providers/gitlab/tools.js +859 -0
- package/lib/providers/gitlab/tools.js.map +1 -0
- package/lib/providers/gitlab/transport.js +140 -0
- package/lib/providers/gitlab/transport.js.map +1 -0
- package/lib/providers/jira/adf.js +235 -0
- package/lib/providers/jira/adf.js.map +1 -0
- package/lib/providers/jira/catalog.js +145 -0
- package/lib/providers/jira/catalog.js.map +1 -0
- package/lib/providers/jira/config.js +198 -0
- package/lib/providers/jira/config.js.map +1 -0
- package/lib/providers/jira/index.js +301 -0
- package/lib/providers/jira/index.js.map +1 -0
- package/lib/providers/jira/jql.js +299 -0
- package/lib/providers/jira/jql.js.map +1 -0
- package/lib/providers/jira/operations.js +617 -0
- package/lib/providers/jira/operations.js.map +1 -0
- package/lib/providers/jira/tools.js +341 -0
- package/lib/providers/jira/tools.js.map +1 -0
- package/lib/providers/jira/transport.js +227 -0
- package/lib/providers/jira/transport.js.map +1 -0
- package/lib/providers/registry.js +21 -0
- package/lib/providers/registry.js.map +1 -0
- package/lib/providers/shared/account.js +20 -0
- package/lib/providers/shared/account.js.map +1 -0
- package/lib/providers/shared/host.js +15 -0
- package/lib/providers/shared/host.js.map +1 -0
- package/lib/providers/shared/http.js +148 -0
- package/lib/providers/shared/http.js.map +1 -0
- package/lib/providers/teamcity/artifacts.js +155 -0
- package/lib/providers/teamcity/artifacts.js.map +1 -0
- package/lib/providers/teamcity/catalog.js +155 -0
- package/lib/providers/teamcity/catalog.js.map +1 -0
- package/lib/providers/teamcity/config.js +262 -0
- package/lib/providers/teamcity/config.js.map +1 -0
- package/lib/providers/teamcity/index.js +228 -0
- package/lib/providers/teamcity/index.js.map +1 -0
- package/lib/providers/teamcity/locators.js +95 -0
- package/lib/providers/teamcity/locators.js.map +1 -0
- package/lib/providers/teamcity/logs.js +113 -0
- package/lib/providers/teamcity/logs.js.map +1 -0
- package/lib/providers/teamcity/network.js +160 -0
- package/lib/providers/teamcity/network.js.map +1 -0
- package/lib/providers/teamcity/operations.js +625 -0
- package/lib/providers/teamcity/operations.js.map +1 -0
- package/lib/providers/teamcity/tools.js +480 -0
- package/lib/providers/teamcity/tools.js.map +1 -0
- package/lib/providers/teamcity/transport.js +126 -0
- package/lib/providers/teamcity/transport.js.map +1 -0
- package/lib/redaction.js +38 -0
- package/lib/redaction.js.map +1 -0
- package/lib/repository.js +414 -0
- package/lib/repository.js.map +1 -0
- package/lib/secrets/key-provider.js +76 -0
- package/lib/secrets/key-provider.js.map +1 -0
- package/lib/secrets/secret-store.js +93 -0
- package/lib/secrets/secret-store.js.map +1 -0
- package/lib/shared/settings.js +19 -0
- package/lib/shared/settings.js.map +1 -0
- package/lib/tool-kit.js +55 -0
- package/lib/tool-kit.js.map +1 -0
- package/lib/tools.js +28 -0
- package/lib/tools.js.map +1 -0
- package/lib/typert.host.d.ts +3 -0
- package/lib/typert.host.js +1689 -0
- package/lib/typert.remote-client.d.ts +84 -0
- package/lib/typert.remote-client.js +1429 -0
- package/lib/types/broker.d.ts +30 -0
- package/lib/types/client/bitrix24.d.ts +18 -0
- package/lib/types/client/card.d.ts +13 -0
- package/lib/types/client/confluence.d.ts +17 -0
- package/lib/types/client/copy.d.ts +7 -0
- package/lib/types/client/gitlab.d.ts +15 -0
- package/lib/types/client/index.d.ts +13 -0
- package/lib/types/client/integrations.d.ts +28 -0
- package/lib/types/client/jira.d.ts +17 -0
- package/lib/types/client/provider-card.d.ts +63 -0
- package/lib/types/client/styles.d.ts +7 -0
- package/lib/types/client/teamcity.d.ts +19 -0
- package/lib/types/coerce.d.ts +18 -0
- package/lib/types/config.d.ts +48 -0
- package/lib/types/errors.d.ts +26 -0
- package/lib/types/index.d.ts +170 -0
- package/lib/types/providers/bitrix24/catalog.d.ts +48 -0
- package/lib/types/providers/bitrix24/config.d.ts +43 -0
- package/lib/types/providers/bitrix24/index.d.ts +31 -0
- package/lib/types/providers/bitrix24/operations.d.ts +13 -0
- package/lib/types/providers/bitrix24/tools.d.ts +9 -0
- package/lib/types/providers/bitrix24/transport.d.ts +26 -0
- package/lib/types/providers/confluence/adf.d.ts +22 -0
- package/lib/types/providers/confluence/catalog.d.ts +59 -0
- package/lib/types/providers/confluence/config.d.ts +68 -0
- package/lib/types/providers/confluence/cql.d.ts +43 -0
- package/lib/types/providers/confluence/index.d.ts +73 -0
- package/lib/types/providers/confluence/operations.d.ts +92 -0
- package/lib/types/providers/confluence/tools.d.ts +15 -0
- package/lib/types/providers/confluence/transport.d.ts +77 -0
- package/lib/types/providers/contract.d.ts +33 -0
- package/lib/types/providers/gitlab/catalog.d.ts +49 -0
- package/lib/types/providers/gitlab/config.d.ts +50 -0
- package/lib/types/providers/gitlab/index.d.ts +49 -0
- package/lib/types/providers/gitlab/operations.d.ts +40 -0
- package/lib/types/providers/gitlab/tools.d.ts +15 -0
- package/lib/types/providers/gitlab/transport.d.ts +52 -0
- package/lib/types/providers/jira/adf.d.ts +27 -0
- package/lib/types/providers/jira/catalog.d.ts +74 -0
- package/lib/types/providers/jira/config.d.ts +73 -0
- package/lib/types/providers/jira/index.d.ts +79 -0
- package/lib/types/providers/jira/jql.d.ts +51 -0
- package/lib/types/providers/jira/operations.d.ts +58 -0
- package/lib/types/providers/jira/tools.d.ts +17 -0
- package/lib/types/providers/jira/transport.d.ts +65 -0
- package/lib/types/providers/registry.d.ts +9 -0
- package/lib/types/providers/shared/account.d.ts +10 -0
- package/lib/types/providers/shared/host.d.ts +9 -0
- package/lib/types/providers/shared/http.d.ts +51 -0
- package/lib/types/providers/teamcity/artifacts.d.ts +45 -0
- package/lib/types/providers/teamcity/catalog.d.ts +55 -0
- package/lib/types/providers/teamcity/config.d.ts +66 -0
- package/lib/types/providers/teamcity/index.d.ts +62 -0
- package/lib/types/providers/teamcity/locators.d.ts +47 -0
- package/lib/types/providers/teamcity/logs.d.ts +31 -0
- package/lib/types/providers/teamcity/network.d.ts +32 -0
- package/lib/types/providers/teamcity/operations.d.ts +84 -0
- package/lib/types/providers/teamcity/tools.d.ts +15 -0
- package/lib/types/providers/teamcity/transport.d.ts +53 -0
- package/lib/types/redaction.d.ts +3 -0
- package/lib/types/repository.d.ts +48 -0
- package/lib/types/secrets/key-provider.d.ts +30 -0
- package/lib/types/secrets/secret-store.d.ts +12 -0
- package/lib/types/shared/settings.d.ts +19 -0
- package/lib/types/tool-kit.d.ts +26 -0
- package/lib/types/tools.d.ts +16 -0
- package/lib/types/types.d.ts +138 -0
- package/lib/types.js +2 -0
- package/lib/types.js.map +1 -0
- package/package.json +143 -0
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
export const CONFLUENCE_CAPABILITIES = Object.freeze([
|
|
2
|
+
{
|
|
3
|
+
capability: "identity.read",
|
|
4
|
+
flag: "identityRead",
|
|
5
|
+
label: "Свой профиль",
|
|
6
|
+
hint: "Подключённый пользователь Confluence: имя, accountId и адрес сайта",
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
capability: "spaces.read",
|
|
10
|
+
flag: "spacesRead",
|
|
11
|
+
label: "Читать пространства",
|
|
12
|
+
hint: "Список пространств, карточка пространства и его описание",
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
capability: "search.read",
|
|
16
|
+
flag: "searchRead",
|
|
17
|
+
label: "Искать по Confluence",
|
|
18
|
+
hint: "Поиск страниц по тексту, пространству, меткам и дате изменения (CQL собирает провайдер)",
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
capability: "content.read",
|
|
22
|
+
flag: "contentRead",
|
|
23
|
+
label: "Читать страницы",
|
|
24
|
+
hint: "Страница целиком: текст в виде markdown-подобной разметки, метки, версия, родитель",
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
capability: "comments.read",
|
|
28
|
+
flag: "commentsRead",
|
|
29
|
+
label: "Читать комментарии",
|
|
30
|
+
hint: "Комментарии страницы: подвал и inline, с ответами и статусом резолва",
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
capability: "attachments.read",
|
|
34
|
+
flag: "attachmentsRead",
|
|
35
|
+
label: "Читать вложения",
|
|
36
|
+
hint: "Только метаданные вложений страницы: имя, тип, размер, версия",
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
capability: "versions.read",
|
|
40
|
+
flag: "versionsRead",
|
|
41
|
+
label: "Читать версии страниц",
|
|
42
|
+
hint: "История версий: номер, автор, дата и комментарий к версии",
|
|
43
|
+
},
|
|
44
|
+
]);
|
|
45
|
+
/**
|
|
46
|
+
* Every model-reachable operation. The provider refuses any operation that is
|
|
47
|
+
* not listed here, so this table — together with `capability` — is the
|
|
48
|
+
* permission surface. Only GET: the catalog carries no operation that could
|
|
49
|
+
* change Confluence state, and the confirmation framework does not exist yet.
|
|
50
|
+
*
|
|
51
|
+
* The mix of REST versions is deliberate. Confluence Cloud v2 covers pages,
|
|
52
|
+
* comments, attachments, versions and spaces, and that is where the reads go;
|
|
53
|
+
* the CQL search and the "who am I" call exist only in v1. Tools never see the
|
|
54
|
+
* difference — an operation answers a normalized object either way.
|
|
55
|
+
*/
|
|
56
|
+
export const CONFLUENCE_OPERATIONS = Object.freeze({
|
|
57
|
+
/**
|
|
58
|
+
* The connected Atlassian account. v2 has no "current user" endpoint, so this
|
|
59
|
+
* is the one v1 call outside search.
|
|
60
|
+
*/
|
|
61
|
+
"connection.get": {
|
|
62
|
+
capability: "identity.read",
|
|
63
|
+
method: "GET",
|
|
64
|
+
path: "/wiki/rest/api/user/current",
|
|
65
|
+
},
|
|
66
|
+
/** CQL search: the only read Confluence offers for free-text lookup. */
|
|
67
|
+
"search.run": {
|
|
68
|
+
capability: "search.read",
|
|
69
|
+
method: "GET",
|
|
70
|
+
path: "/wiki/rest/api/search",
|
|
71
|
+
list: true,
|
|
72
|
+
cursor: "offset",
|
|
73
|
+
},
|
|
74
|
+
"spaces.list": {
|
|
75
|
+
capability: "spaces.read",
|
|
76
|
+
method: "GET",
|
|
77
|
+
path: "/wiki/api/v2/spaces",
|
|
78
|
+
list: true,
|
|
79
|
+
cursor: "upstream",
|
|
80
|
+
},
|
|
81
|
+
/**
|
|
82
|
+
* v2 addresses a space by numeric id only; a key is resolved through
|
|
83
|
+
* `spaces.list` first, inside the handler, and never by the model.
|
|
84
|
+
*/
|
|
85
|
+
"spaces.get": {
|
|
86
|
+
capability: "spaces.read",
|
|
87
|
+
method: "GET",
|
|
88
|
+
path: "/wiki/api/v2/spaces/:spaceId",
|
|
89
|
+
},
|
|
90
|
+
"pages.get": {
|
|
91
|
+
capability: "content.read",
|
|
92
|
+
method: "GET",
|
|
93
|
+
path: "/wiki/api/v2/pages/:pageId",
|
|
94
|
+
},
|
|
95
|
+
/**
|
|
96
|
+
* The catalog names the footer collection; inline comments live at the same
|
|
97
|
+
* path with `inline-comments`, chosen by the handler from a validated `kind`,
|
|
98
|
+
* never from a caller-supplied path.
|
|
99
|
+
*/
|
|
100
|
+
"pages.comments": {
|
|
101
|
+
capability: "comments.read",
|
|
102
|
+
method: "GET",
|
|
103
|
+
path: "/wiki/api/v2/pages/:pageId/footer-comments",
|
|
104
|
+
list: true,
|
|
105
|
+
cursor: "upstream",
|
|
106
|
+
},
|
|
107
|
+
"pages.attachments": {
|
|
108
|
+
capability: "attachments.read",
|
|
109
|
+
method: "GET",
|
|
110
|
+
path: "/wiki/api/v2/pages/:pageId/attachments",
|
|
111
|
+
list: true,
|
|
112
|
+
cursor: "upstream",
|
|
113
|
+
},
|
|
114
|
+
"pages.versions": {
|
|
115
|
+
capability: "versions.read",
|
|
116
|
+
method: "GET",
|
|
117
|
+
path: "/wiki/api/v2/pages/:pageId/versions",
|
|
118
|
+
list: true,
|
|
119
|
+
cursor: "upstream",
|
|
120
|
+
},
|
|
121
|
+
});
|
|
122
|
+
/** Capabilities this deployment allows, in catalog order. */
|
|
123
|
+
export function enabledCapabilities(flags) {
|
|
124
|
+
return CONFLUENCE_CAPABILITIES.filter((item) => flags[item.flag]).map((item) => item.capability);
|
|
125
|
+
}
|
|
126
|
+
/** Label and hint per capability, for clients that render what we declare. */
|
|
127
|
+
export const CONFLUENCE_CAPABILITY_INFO = Object.freeze(Object.fromEntries(CONFLUENCE_CAPABILITIES.map((item) => [
|
|
128
|
+
item.capability,
|
|
129
|
+
{ label: item.label, hint: item.hint },
|
|
130
|
+
])));
|
|
131
|
+
/** Capability an operation needs, or undefined when the catalog has none. */
|
|
132
|
+
export function confluenceOperationCapability(operation) {
|
|
133
|
+
return CONFLUENCE_OPERATIONS[operation]?.capability;
|
|
134
|
+
}
|
|
135
|
+
//# sourceMappingURL=catalog.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../../src/providers/confluence/catalog.ts"],"names":[],"mappings":"AA4CA,MAAM,CAAC,MAAM,uBAAuB,GAClC,MAAM,CAAC,MAAM,CAAC;IACZ;QACE,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,oEAAoE;KAC3E;IACD;QACE,UAAU,EAAE,aAAa;QACzB,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,0DAA0D;KACjE;IACD;QACE,UAAU,EAAE,aAAa;QACzB,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,yFAAyF;KAChG;IACD;QACE,UAAU,EAAE,cAAc;QAC1B,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,oFAAoF;KAC3F;IACD;QACE,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,sEAAsE;KAC7E;IACD;QACE,UAAU,EAAE,kBAAkB;QAC9B,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,+DAA+D;KACtE;IACD;QACE,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,uBAAuB;QAC9B,IAAI,EAAE,2DAA2D;KAClE;CACF,CAAC,CAAC;AAsBL;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAE9B,MAAM,CAAC,MAAM,CAAC;IAChB;;;OAGG;IACH,gBAAgB,EAAE;QAChB,UAAU,EAAE,eAAe;QAC3B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,6BAA6B;KACpC;IACD,wEAAwE;IACxE,YAAY,EAAE;QACZ,UAAU,EAAE,aAAa;QACzB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,QAAQ;KACjB;IACD,aAAa,EAAE;QACb,UAAU,EAAE,aAAa;QACzB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,UAAU;KACnB;IACD;;;OAGG;IACH,YAAY,EAAE;QACZ,UAAU,EAAE,aAAa;QACzB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,8BAA8B;KACrC;IACD,WAAW,EAAE;QACX,UAAU,EAAE,cAAc;QAC1B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,4BAA4B;KACnC;IACD;;;;OAIG;IACH,gBAAgB,EAAE;QAChB,UAAU,EAAE,eAAe;QAC3B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,4CAA4C;QAClD,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,UAAU;KACnB;IACD,mBAAmB,EAAE;QACnB,UAAU,EAAE,kBAAkB;QAC9B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,wCAAwC;QAC9C,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,UAAU;KACnB;IACD,gBAAgB,EAAE;QAChB,UAAU,EAAE,eAAe;QAC3B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,qCAAqC;QAC3C,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,UAAU;KACnB;CACF,CAAC,CAAC;AAEH,6DAA6D;AAC7D,MAAM,UAAU,mBAAmB,CACjC,KAAsB;IAEtB,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CACnE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAC1B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,CAAC,MAAM,0BAA0B,GAEnC,MAAM,CAAC,MAAM,CACf,MAAM,CAAC,WAAW,CAChB,uBAAuB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IACpC,IAAI,CAAC,UAAU;IACf,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;CACvC,CAAC,CACwD,CAC7D,CAAC;AAEF,6EAA6E;AAC7E,MAAM,UAAU,6BAA6B,CAC3C,SAAiB;IAEjB,OAAO,qBAAqB,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;AACtD,CAAC"}
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
import z from "@deepseek-ai/schemastery";
|
|
2
|
+
export const CONFLUENCE_DEFAULTS = Object.freeze({
|
|
3
|
+
enabled: true,
|
|
4
|
+
allowInsecureHttp: false,
|
|
5
|
+
instances: Object.freeze([]),
|
|
6
|
+
identityRead: true,
|
|
7
|
+
spacesRead: true,
|
|
8
|
+
searchRead: true,
|
|
9
|
+
contentRead: true,
|
|
10
|
+
commentsRead: true,
|
|
11
|
+
attachmentsRead: true,
|
|
12
|
+
versionsRead: true,
|
|
13
|
+
allowedSpaces: Object.freeze([]),
|
|
14
|
+
defaultBodyChars: 20_000,
|
|
15
|
+
maxBodyChars: 60_000,
|
|
16
|
+
maxResults: 50,
|
|
17
|
+
maxReplyParents: 10,
|
|
18
|
+
retries: 2,
|
|
19
|
+
});
|
|
20
|
+
const INSTANCE_ID = /^[a-z0-9][a-z0-9-]{0,31}$/u;
|
|
21
|
+
const SPACE_KEY = /^[A-Z0-9][A-Z0-9_-]{0,254}$/u;
|
|
22
|
+
const MAX_INSTANCES = 16;
|
|
23
|
+
const MAX_ALLOWED_SPACES = 64;
|
|
24
|
+
function configError(message) {
|
|
25
|
+
return new Error(`confluence integration config: ${message}`);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Canonicalize one configured site. Everything here is operator input, so a
|
|
29
|
+
* typo must fail loudly at load: a silently dropped instance would leave users
|
|
30
|
+
* with a provider they cannot connect to and no explanation.
|
|
31
|
+
*/
|
|
32
|
+
function normalizeInstance(input, index, allowInsecureHttp, seen) {
|
|
33
|
+
if (typeof input !== "object" || input === null || Array.isArray(input)) {
|
|
34
|
+
throw configError(`instances[${index}] must be a mapping`);
|
|
35
|
+
}
|
|
36
|
+
const record = input;
|
|
37
|
+
const id = typeof record["id"] === "string" ? record["id"].trim() : "";
|
|
38
|
+
if (!INSTANCE_ID.test(id)) {
|
|
39
|
+
throw configError(`instances[${index}].id must be lowercase latin, digits or dashes`);
|
|
40
|
+
}
|
|
41
|
+
if (seen.has(id))
|
|
42
|
+
throw configError(`instances[${index}].id is a duplicate`);
|
|
43
|
+
seen.add(id);
|
|
44
|
+
const raw = typeof record["baseUrl"] === "string" ? record["baseUrl"] : "";
|
|
45
|
+
let url;
|
|
46
|
+
try {
|
|
47
|
+
url = new URL(raw.trim());
|
|
48
|
+
}
|
|
49
|
+
catch {
|
|
50
|
+
throw configError(`instances[${index}].baseUrl must be an absolute URL`);
|
|
51
|
+
}
|
|
52
|
+
if (url.protocol !== "https:" && url.protocol !== "http:") {
|
|
53
|
+
throw configError(`instances[${index}].baseUrl must use HTTP or HTTPS`);
|
|
54
|
+
}
|
|
55
|
+
if (url.protocol === "http:" && !allowInsecureHttp) {
|
|
56
|
+
throw configError(`instances[${index}].baseUrl needs HTTPS; set allowInsecureHttp for a development instance`);
|
|
57
|
+
}
|
|
58
|
+
if (url.username !== "" || url.password !== "" || url.search !== "") {
|
|
59
|
+
throw configError(`instances[${index}].baseUrl must carry no credentials or query`);
|
|
60
|
+
}
|
|
61
|
+
// A trailing slash would double up when the API root is appended; the WHATWG
|
|
62
|
+
// URL parser has already folded away any `..` segments.
|
|
63
|
+
const path = url.pathname.replace(/\/+$/u, "");
|
|
64
|
+
const label = typeof record["label"] === "string" ? record["label"].trim() : "";
|
|
65
|
+
return Object.freeze({
|
|
66
|
+
id,
|
|
67
|
+
label: label === "" ? url.host : label,
|
|
68
|
+
baseUrl: `${url.origin}${path}`,
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
function normalizeInstances(input, allowInsecureHttp) {
|
|
72
|
+
if (input === undefined || input === null)
|
|
73
|
+
return CONFLUENCE_DEFAULTS.instances;
|
|
74
|
+
if (!Array.isArray(input))
|
|
75
|
+
throw configError("instances must be a list");
|
|
76
|
+
if (input.length > MAX_INSTANCES) {
|
|
77
|
+
throw configError(`instances accepts at most ${MAX_INSTANCES} entries`);
|
|
78
|
+
}
|
|
79
|
+
const seen = new Set();
|
|
80
|
+
return Object.freeze(input.map((entry, index) => normalizeInstance(entry, index, allowInsecureHttp, seen)));
|
|
81
|
+
}
|
|
82
|
+
/** Space keys are upper-cased once, so a policy comparison is a plain equality. */
|
|
83
|
+
function normalizeAllowedSpaces(input) {
|
|
84
|
+
if (input === undefined || input === null) {
|
|
85
|
+
return CONFLUENCE_DEFAULTS.allowedSpaces;
|
|
86
|
+
}
|
|
87
|
+
if (!Array.isArray(input))
|
|
88
|
+
throw configError("allowedSpaces must be a list");
|
|
89
|
+
if (input.length > MAX_ALLOWED_SPACES) {
|
|
90
|
+
throw configError(`allowedSpaces accepts at most ${MAX_ALLOWED_SPACES} entries`);
|
|
91
|
+
}
|
|
92
|
+
const seen = new Set();
|
|
93
|
+
for (const entry of input) {
|
|
94
|
+
const key = typeof entry === "string" ? entry.trim().toUpperCase() : "";
|
|
95
|
+
if (!SPACE_KEY.test(key)) {
|
|
96
|
+
throw configError("allowedSpaces entries must be space keys");
|
|
97
|
+
}
|
|
98
|
+
seen.add(key);
|
|
99
|
+
}
|
|
100
|
+
return Object.freeze([...seen]);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Config slice of this provider, as it appears under `confluence:` in YAML. The
|
|
104
|
+
* instance list is validated and canonicalized by `resolveConfluenceConfig`,
|
|
105
|
+
* which is where a deployment typo fails loudly.
|
|
106
|
+
*/
|
|
107
|
+
export const confluenceConfigSchema = z.object({
|
|
108
|
+
enabled: z.boolean().default(CONFLUENCE_DEFAULTS.enabled),
|
|
109
|
+
allowInsecureHttp: z.boolean().default(CONFLUENCE_DEFAULTS.allowInsecureHttp),
|
|
110
|
+
instances: z
|
|
111
|
+
.array(z.object({
|
|
112
|
+
id: z.string(),
|
|
113
|
+
label: z.string(),
|
|
114
|
+
baseUrl: z.string(),
|
|
115
|
+
}))
|
|
116
|
+
.default([]),
|
|
117
|
+
identityRead: z.boolean().default(CONFLUENCE_DEFAULTS.identityRead),
|
|
118
|
+
spacesRead: z.boolean().default(CONFLUENCE_DEFAULTS.spacesRead),
|
|
119
|
+
searchRead: z.boolean().default(CONFLUENCE_DEFAULTS.searchRead),
|
|
120
|
+
contentRead: z.boolean().default(CONFLUENCE_DEFAULTS.contentRead),
|
|
121
|
+
commentsRead: z.boolean().default(CONFLUENCE_DEFAULTS.commentsRead),
|
|
122
|
+
attachmentsRead: z.boolean().default(CONFLUENCE_DEFAULTS.attachmentsRead),
|
|
123
|
+
versionsRead: z.boolean().default(CONFLUENCE_DEFAULTS.versionsRead),
|
|
124
|
+
allowedSpaces: z.array(z.string()).default([]),
|
|
125
|
+
defaultBodyChars: z
|
|
126
|
+
.number()
|
|
127
|
+
.step(1)
|
|
128
|
+
.min(512)
|
|
129
|
+
.max(1_000_000)
|
|
130
|
+
.default(CONFLUENCE_DEFAULTS.defaultBodyChars),
|
|
131
|
+
maxBodyChars: z
|
|
132
|
+
.number()
|
|
133
|
+
.step(1)
|
|
134
|
+
.min(512)
|
|
135
|
+
.max(1_000_000)
|
|
136
|
+
.default(CONFLUENCE_DEFAULTS.maxBodyChars),
|
|
137
|
+
maxResults: z
|
|
138
|
+
.number()
|
|
139
|
+
.step(1)
|
|
140
|
+
.min(1)
|
|
141
|
+
.max(250)
|
|
142
|
+
.default(CONFLUENCE_DEFAULTS.maxResults),
|
|
143
|
+
maxReplyParents: z
|
|
144
|
+
.number()
|
|
145
|
+
.step(1)
|
|
146
|
+
.min(0)
|
|
147
|
+
.max(25)
|
|
148
|
+
.default(CONFLUENCE_DEFAULTS.maxReplyParents),
|
|
149
|
+
retries: z
|
|
150
|
+
.number()
|
|
151
|
+
.step(1)
|
|
152
|
+
.min(0)
|
|
153
|
+
.max(5)
|
|
154
|
+
.default(CONFLUENCE_DEFAULTS.retries),
|
|
155
|
+
});
|
|
156
|
+
export function resolveConfluenceConfig(input = {}) {
|
|
157
|
+
const allowInsecureHttp = input.allowInsecureHttp ?? CONFLUENCE_DEFAULTS.allowInsecureHttp;
|
|
158
|
+
const defaultBodyChars = input.defaultBodyChars ?? CONFLUENCE_DEFAULTS.defaultBodyChars;
|
|
159
|
+
const maxBodyChars = input.maxBodyChars ?? CONFLUENCE_DEFAULTS.maxBodyChars;
|
|
160
|
+
if (maxBodyChars < defaultBodyChars) {
|
|
161
|
+
// A ceiling below the default would make every page read answer with a
|
|
162
|
+
// budget the deployment contradicts itself about.
|
|
163
|
+
throw configError("maxBodyChars must be at least defaultBodyChars");
|
|
164
|
+
}
|
|
165
|
+
return Object.freeze({
|
|
166
|
+
enabled: input.enabled ?? CONFLUENCE_DEFAULTS.enabled,
|
|
167
|
+
allowInsecureHttp,
|
|
168
|
+
instances: normalizeInstances(input.instances, allowInsecureHttp),
|
|
169
|
+
identityRead: input.identityRead ?? CONFLUENCE_DEFAULTS.identityRead,
|
|
170
|
+
spacesRead: input.spacesRead ?? CONFLUENCE_DEFAULTS.spacesRead,
|
|
171
|
+
searchRead: input.searchRead ?? CONFLUENCE_DEFAULTS.searchRead,
|
|
172
|
+
contentRead: input.contentRead ?? CONFLUENCE_DEFAULTS.contentRead,
|
|
173
|
+
commentsRead: input.commentsRead ?? CONFLUENCE_DEFAULTS.commentsRead,
|
|
174
|
+
attachmentsRead: input.attachmentsRead ?? CONFLUENCE_DEFAULTS.attachmentsRead,
|
|
175
|
+
versionsRead: input.versionsRead ?? CONFLUENCE_DEFAULTS.versionsRead,
|
|
176
|
+
allowedSpaces: normalizeAllowedSpaces(input.allowedSpaces),
|
|
177
|
+
defaultBodyChars,
|
|
178
|
+
maxBodyChars,
|
|
179
|
+
maxResults: input.maxResults ?? CONFLUENCE_DEFAULTS.maxResults,
|
|
180
|
+
maxReplyParents: input.maxReplyParents ?? CONFLUENCE_DEFAULTS.maxReplyParents,
|
|
181
|
+
retries: input.retries ?? CONFLUENCE_DEFAULTS.retries,
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
/** The configured site a stored credential names, or a fail-closed error. */
|
|
185
|
+
export function confluenceInstance(flags, instanceId) {
|
|
186
|
+
return flags.instances.find((item) => item.id === instanceId);
|
|
187
|
+
}
|
|
188
|
+
/** Whether a space key passes the operator allowlist; an empty list allows all. */
|
|
189
|
+
export function spaceAllowed(flags, key) {
|
|
190
|
+
if (flags.allowedSpaces.length === 0)
|
|
191
|
+
return true;
|
|
192
|
+
if (key === undefined)
|
|
193
|
+
return false;
|
|
194
|
+
return flags.allowedSpaces.includes(key.trim().toUpperCase());
|
|
195
|
+
}
|
|
196
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/providers/confluence/config.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,0BAA0B,CAAC;AA0DzC,MAAM,CAAC,MAAM,mBAAmB,GAAoB,MAAM,CAAC,MAAM,CAAC;IAChE,OAAO,EAAE,IAAI;IACb,iBAAiB,EAAE,KAAK;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAC5B,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,eAAe,EAAE,IAAI;IACrB,YAAY,EAAE,IAAI;IAClB,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAChC,gBAAgB,EAAE,MAAM;IACxB,YAAY,EAAE,MAAM;IACpB,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,EAAE;IACnB,OAAO,EAAE,CAAC;CACX,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,4BAA4B,CAAC;AACjD,MAAM,SAAS,GAAG,8BAA8B,CAAC;AACjD,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,SAAS,WAAW,CAAC,OAAe;IAClC,OAAO,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CACxB,KAAc,EACd,KAAa,EACb,iBAA0B,EAC1B,IAAiB;IAEjB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,MAAM,WAAW,CAAC,aAAa,KAAK,qBAAqB,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,MAAM,EAAE,GAAG,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QAC1B,MAAM,WAAW,CACf,aAAa,KAAK,gDAAgD,CACnE,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAAE,MAAM,WAAW,CAAC,aAAa,KAAK,qBAAqB,CAAC,CAAC;IAC7E,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACb,MAAM,GAAG,GAAG,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,WAAW,CAAC,aAAa,KAAK,mCAAmC,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QAC1D,MAAM,WAAW,CAAC,aAAa,KAAK,kCAAkC,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACnD,MAAM,WAAW,CACf,aAAa,KAAK,yEAAyE,CAC5F,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACpE,MAAM,WAAW,CACf,aAAa,KAAK,8CAA8C,CACjE,CAAC;IACJ,CAAC;IACD,6EAA6E;IAC7E,wDAAwD;IACxD,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC/C,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,EAAE;QACF,KAAK,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QACtC,OAAO,EAAE,GAAG,GAAG,CAAC,MAAM,GAAG,IAAI,EAAE;KAChC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAc,EACd,iBAA0B;IAE1B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QACvC,OAAO,mBAAmB,CAAC,SAAS,CAAC;IACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,WAAW,CAAC,0BAA0B,CAAC,CAAC;IACzE,IAAI,KAAK,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;QACjC,MAAM,WAAW,CAAC,6BAA6B,aAAa,UAAU,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,MAAM,CAAC,MAAM,CAClB,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACzB,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,CACzD,CACF,CAAC;AACJ,CAAC;AAED,mFAAmF;AACnF,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,mBAAmB,CAAC,aAAa,CAAC;IAC3C,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,WAAW,CAAC,8BAA8B,CAAC,CAAC;IAC7E,IAAI,KAAK,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;QACtC,MAAM,WAAW,CACf,iCAAiC,kBAAkB,UAAU,CAC9D,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,WAAW,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AAClC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC;IACzD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,iBAAiB,CAAC;IAC7E,SAAS,EAAE,CAAC;SACT,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,OAAO,CAAC,EAAE,CAAC;IACd,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC;IACnE,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC;IAC/D,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC;IAC/D,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC;IACjE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC;IACnE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC;IACzE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC;IACnE,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9C,gBAAgB,EAAE,CAAC;SAChB,MAAM,EAAE;SACR,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,GAAG,CAAC;SACR,GAAG,CAAC,SAAS,CAAC;SACd,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC;IAChD,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,GAAG,CAAC;SACR,GAAG,CAAC,SAAS,CAAC;SACd,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC;IAC5C,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC;IAC1C,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,EAAE,CAAC;SACP,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC;IAC/C,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,IAAI,CAAC,CAAC,CAAC;SACP,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC;CACxC,CAA2C,CAAC;AAE7C,MAAM,UAAU,uBAAuB,CACrC,KAAK,GAA6B,EAAE;IAEpC,MAAM,iBAAiB,GACrB,KAAK,CAAC,iBAAiB,IAAI,mBAAmB,CAAC,iBAAiB,CAAC;IACnE,MAAM,gBAAgB,GACpB,KAAK,CAAC,gBAAgB,IAAI,mBAAmB,CAAC,gBAAgB,CAAC;IACjE,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,mBAAmB,CAAC,YAAY,CAAC;IAC5E,IAAI,YAAY,GAAG,gBAAgB,EAAE,CAAC;QACpC,uEAAuE;QACvE,kDAAkD;QAClD,MAAM,WAAW,CAAC,gDAAgD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC,OAAO;QACrD,iBAAiB;QACjB,SAAS,EAAE,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,iBAAiB,CAAC;QACjE,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,mBAAmB,CAAC,YAAY;QACpE,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,mBAAmB,CAAC,UAAU;QAC9D,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,mBAAmB,CAAC,UAAU;QAC9D,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,mBAAmB,CAAC,WAAW;QACjE,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,mBAAmB,CAAC,YAAY;QACpE,eAAe,EACb,KAAK,CAAC,eAAe,IAAI,mBAAmB,CAAC,eAAe;QAC9D,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,mBAAmB,CAAC,YAAY;QACpE,aAAa,EAAE,sBAAsB,CAAC,KAAK,CAAC,aAAa,CAAC;QAC1D,gBAAgB;QAChB,YAAY;QACZ,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,mBAAmB,CAAC,UAAU;QAC9D,eAAe,EACb,KAAK,CAAC,eAAe,IAAI,mBAAmB,CAAC,eAAe;QAC9D,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC,OAAO;KACtD,CAAC,CAAC;AACL,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,kBAAkB,CAChC,KAAsB,EACtB,UAAkB;IAElB,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;AAChE,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAC1B,KAAsB,EACtB,GAAuB;IAEvB,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAClD,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpC,OAAO,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;AAChE,CAAC"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Typed CQL builder. The model never sends CQL: it sends fields, and this
|
|
3
|
+
* module turns them into one query, quoting every literal itself. That is the
|
|
4
|
+
* whole reason the provider can keep searching without shipping a
|
|
5
|
+
* `confluence_search_cql` tool.
|
|
6
|
+
*/
|
|
7
|
+
/** Content types the model may ask for; CQL spells the blog post `blogpost`. */
|
|
8
|
+
export const CONTENT_TYPES = Object.freeze(["page", "blogpost"]);
|
|
9
|
+
/** Orderings the builder knows. `relevance` leaves ordering to Confluence. */
|
|
10
|
+
export const ORDER_BY = Object.freeze({
|
|
11
|
+
lastmodified: "lastmodified",
|
|
12
|
+
created: "created",
|
|
13
|
+
});
|
|
14
|
+
/**
|
|
15
|
+
* Control characters carry no meaning in CQL and would break the one-line query,
|
|
16
|
+
* so they become spaces. Lint refuses a control-character range in a regular
|
|
17
|
+
* expression, hence the plain walk.
|
|
18
|
+
*/
|
|
19
|
+
function withoutControlChars(value) {
|
|
20
|
+
let result = "";
|
|
21
|
+
for (const char of value) {
|
|
22
|
+
const code = char.codePointAt(0) ?? 0;
|
|
23
|
+
result += code < 0x20 || code === 0x7f ? " " : char;
|
|
24
|
+
}
|
|
25
|
+
return result;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* One quoted CQL literal. Confluence escapes an embedded quote with a
|
|
29
|
+
* backslash, which is also the only escape its parser understands, so a
|
|
30
|
+
* backslash of our own is escaped first — otherwise a value ending in `\`
|
|
31
|
+
* would escape the closing quote and let the rest of the line be read as CQL.
|
|
32
|
+
*/
|
|
33
|
+
export function cqlLiteral(value) {
|
|
34
|
+
const flattened = withoutControlChars(value);
|
|
35
|
+
return `"${flattened.replaceAll("\\", "\\\\").replaceAll('"', '\\"')}"`;
|
|
36
|
+
}
|
|
37
|
+
function joinTerms(operator, values) {
|
|
38
|
+
return `${operator} (${values.join(", ")})`;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Build one CQL query out of typed fields. Clauses are ANDed in a fixed order,
|
|
42
|
+
* so the same filter always produces the same query — which is what the tests
|
|
43
|
+
* pin and what keeps a cached upstream response honest.
|
|
44
|
+
*/
|
|
45
|
+
export function buildCql(filter) {
|
|
46
|
+
const clauses = [];
|
|
47
|
+
const types = filter.contentTypes === undefined || filter.contentTypes.length === 0
|
|
48
|
+
? ["page"]
|
|
49
|
+
: filter.contentTypes;
|
|
50
|
+
clauses.push(joinTerms("type in", types));
|
|
51
|
+
if (filter.spaces !== undefined && filter.spaces.length > 0) {
|
|
52
|
+
clauses.push(joinTerms("space in", filter.spaces.map(cqlLiteral)));
|
|
53
|
+
}
|
|
54
|
+
if (filter.labels !== undefined && filter.labels.length > 0) {
|
|
55
|
+
clauses.push(joinTerms("label in", filter.labels.map(cqlLiteral)));
|
|
56
|
+
}
|
|
57
|
+
if (filter.query !== undefined && filter.query !== "") {
|
|
58
|
+
clauses.push(`text ~ ${cqlLiteral(filter.query)}`);
|
|
59
|
+
}
|
|
60
|
+
if (filter.modifiedAfter !== undefined) {
|
|
61
|
+
clauses.push(`lastmodified >= ${cqlLiteral(filter.modifiedAfter)}`);
|
|
62
|
+
}
|
|
63
|
+
if (filter.creator !== undefined) {
|
|
64
|
+
clauses.push(filter.creator === "me"
|
|
65
|
+
? "creator = currentUser()"
|
|
66
|
+
: `creator = ${cqlLiteral(filter.creator)}`);
|
|
67
|
+
}
|
|
68
|
+
if (filter.contributor !== undefined) {
|
|
69
|
+
clauses.push(filter.contributor === "me"
|
|
70
|
+
? "contributor = currentUser()"
|
|
71
|
+
: `contributor = ${cqlLiteral(filter.contributor)}`);
|
|
72
|
+
}
|
|
73
|
+
const query = clauses.join(" AND ");
|
|
74
|
+
if (filter.orderBy === undefined)
|
|
75
|
+
return query;
|
|
76
|
+
return `${query} ORDER BY ${ORDER_BY[filter.orderBy]} DESC`;
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=cql.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cql.js","sourceRoot":"","sources":["../../../src/providers/confluence/cql.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,gFAAgF;AAChF,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,UAAU,CAAU,CAAC,CAAC;AAE1E,8EAA8E;AAC9E,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE,cAAc;IAC5B,OAAO,EAAE,SAAS;CACV,CAAC,CAAC;AAoBZ;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,KAAa;IACxC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,MAAM,SAAS,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC;AAC1E,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB,EAAE,MAAyB;IAC5D,OAAO,GAAG,QAAQ,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,MAA8B;IACrD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,KAAK,GACT,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;QACnE,CAAC,CAAC,CAAC,MAAM,CAAC;QACV,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;QACtD,OAAO,CAAC,IAAI,CAAC,UAAU,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,mBAAmB,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,CACV,MAAM,CAAC,OAAO,KAAK,IAAI;YACrB,CAAC,CAAC,yBAAyB;YAC3B,CAAC,CAAC,aAAa,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAC9C,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CACV,MAAM,CAAC,WAAW,KAAK,IAAI;YACzB,CAAC,CAAC,6BAA6B;YAC/B,CAAC,CAAC,iBAAiB,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CACtD,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC/C,OAAO,GAAG,KAAK,aAAa,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;AAC9D,CAAC"}
|