@yadsh/dsh-qa-integrations 0.5.0 → 0.7.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/README.md +636 -202
- package/compatibility.json +1 -1
- package/lib/broker.js +468 -9
- package/lib/broker.js.map +1 -1
- package/lib/client/bitrix24.js +67 -5
- package/lib/client/bitrix24.js.map +1 -1
- package/lib/client/card.js +8 -1
- package/lib/client/card.js.map +1 -1
- package/lib/client/confluence.js +98 -129
- package/lib/client/confluence.js.map +1 -1
- package/lib/client/gitlab.js +41 -5
- package/lib/client/gitlab.js.map +1 -1
- package/lib/client/index.js +33 -11
- package/lib/client/index.js.map +1 -1
- package/lib/client/integrations.js +40 -3
- package/lib/client/integrations.js.map +1 -1
- package/lib/client/jira.js +96 -127
- package/lib/client/jira.js.map +1 -1
- package/lib/client/operator-card.js +537 -0
- package/lib/client/operator-card.js.map +1 -0
- package/lib/client/operator-controls.js +232 -0
- package/lib/client/operator-controls.js.map +1 -0
- package/lib/client/provider-card.js +138 -4
- package/lib/client/provider-card.js.map +1 -1
- package/lib/client/styles.js +68 -5
- package/lib/client/styles.js.map +1 -1
- package/lib/client/teamcity.js +31 -4
- package/lib/client/teamcity.js.map +1 -1
- package/lib/client/testit.js +101 -0
- package/lib/client/testit.js.map +1 -0
- package/lib/client/weblate.js +105 -0
- package/lib/client/weblate.js.map +1 -0
- package/lib/client.js +5214 -1054
- package/lib/client.js.map +1 -1
- package/lib/coerce.js +16 -7
- package/lib/coerce.js.map +1 -1
- package/lib/config.js +12 -0
- package/lib/config.js.map +1 -1
- package/lib/errors.js.map +1 -1
- package/lib/index.js +444 -57
- package/lib/index.js.map +1 -1
- package/lib/providers/bitrix24/catalog.js +151 -8
- package/lib/providers/bitrix24/catalog.js.map +1 -1
- package/lib/providers/bitrix24/config.js +87 -13
- package/lib/providers/bitrix24/config.js.map +1 -1
- package/lib/providers/bitrix24/credential-help.js +24 -0
- package/lib/providers/bitrix24/credential-help.js.map +1 -0
- package/lib/providers/bitrix24/index.js +122 -0
- package/lib/providers/bitrix24/index.js.map +1 -1
- package/lib/providers/bitrix24/operations.js +60 -1
- package/lib/providers/bitrix24/operations.js.map +1 -1
- package/lib/providers/bitrix24/tools.js +95 -3
- package/lib/providers/bitrix24/tools.js.map +1 -1
- package/lib/providers/confluence/catalog.js +51 -3
- package/lib/providers/confluence/catalog.js.map +1 -1
- package/lib/providers/confluence/credential-help.js +29 -0
- package/lib/providers/confluence/credential-help.js.map +1 -0
- package/lib/providers/confluence/index.js +302 -35
- package/lib/providers/confluence/index.js.map +1 -1
- package/lib/providers/confluence/operations.js +1 -1
- package/lib/providers/confluence/operations.js.map +1 -1
- package/lib/providers/gitlab/catalog.js +108 -15
- package/lib/providers/gitlab/catalog.js.map +1 -1
- package/lib/providers/gitlab/config.js +11 -3
- package/lib/providers/gitlab/config.js.map +1 -1
- package/lib/providers/gitlab/credential-help.js +33 -0
- package/lib/providers/gitlab/credential-help.js.map +1 -0
- package/lib/providers/gitlab/index.js +337 -6
- package/lib/providers/gitlab/index.js.map +1 -1
- package/lib/providers/jira/catalog.js +73 -3
- package/lib/providers/jira/catalog.js.map +1 -1
- package/lib/providers/jira/credential-help.js +31 -0
- package/lib/providers/jira/credential-help.js.map +1 -0
- package/lib/providers/jira/index.js +275 -12
- package/lib/providers/jira/index.js.map +1 -1
- package/lib/providers/registry.js +4 -0
- package/lib/providers/registry.js.map +1 -1
- package/lib/providers/shared/credential-help.js +29 -0
- package/lib/providers/shared/credential-help.js.map +1 -0
- package/lib/providers/shared/service-boundary.js +44 -0
- package/lib/providers/shared/service-boundary.js.map +1 -0
- package/lib/providers/teamcity/catalog.js +56 -2
- package/lib/providers/teamcity/catalog.js.map +1 -1
- package/lib/providers/teamcity/credential-help.js +25 -0
- package/lib/providers/teamcity/credential-help.js.map +1 -0
- package/lib/providers/teamcity/index.js +254 -2
- package/lib/providers/teamcity/index.js.map +1 -1
- package/lib/providers/testit/attachments.js +131 -0
- package/lib/providers/testit/attachments.js.map +1 -0
- package/lib/providers/testit/catalog.js +302 -0
- package/lib/providers/testit/catalog.js.map +1 -0
- package/lib/providers/testit/config.js +175 -0
- package/lib/providers/testit/config.js.map +1 -0
- package/lib/providers/testit/credential-help.js +29 -0
- package/lib/providers/testit/credential-help.js.map +1 -0
- package/lib/providers/testit/index.js +458 -0
- package/lib/providers/testit/index.js.map +1 -0
- package/lib/providers/testit/operations.js +1070 -0
- package/lib/providers/testit/operations.js.map +1 -0
- package/lib/providers/testit/tools.js +717 -0
- package/lib/providers/testit/tools.js.map +1 -0
- package/lib/providers/testit/transport.js +158 -0
- package/lib/providers/testit/transport.js.map +1 -0
- package/lib/providers/weblate/catalog.js +279 -0
- package/lib/providers/weblate/catalog.js.map +1 -0
- package/lib/providers/weblate/config.js +147 -0
- package/lib/providers/weblate/config.js.map +1 -0
- package/lib/providers/weblate/credential-help.js +26 -0
- package/lib/providers/weblate/credential-help.js.map +1 -0
- package/lib/providers/weblate/index.js +419 -0
- package/lib/providers/weblate/index.js.map +1 -0
- package/lib/providers/weblate/operations.js +703 -0
- package/lib/providers/weblate/operations.js.map +1 -0
- package/lib/providers/weblate/query.js +80 -0
- package/lib/providers/weblate/query.js.map +1 -0
- package/lib/providers/weblate/tools.js +408 -0
- package/lib/providers/weblate/tools.js.map +1 -0
- package/lib/providers/weblate/transport.js +179 -0
- package/lib/providers/weblate/transport.js.map +1 -0
- package/lib/repository.js +197 -13
- package/lib/repository.js.map +1 -1
- package/lib/service-credentials/config.js +179 -0
- package/lib/service-credentials/config.js.map +1 -0
- package/lib/service-credentials/policy.js +92 -0
- package/lib/service-credentials/policy.js.map +1 -0
- package/lib/service-credentials/registry.js +142 -0
- package/lib/service-credentials/registry.js.map +1 -0
- package/lib/service-credentials/state.js +30 -0
- package/lib/service-credentials/state.js.map +1 -0
- package/lib/service-credentials/types.js +20 -0
- package/lib/service-credentials/types.js.map +1 -0
- package/lib/shared/settings.js +8 -13
- package/lib/shared/settings.js.map +1 -1
- package/lib/tools.js +27 -2
- package/lib/tools.js.map +1 -1
- package/lib/typert.host.js +1340 -100
- package/lib/typert.remote-client.d.ts +45 -11
- package/lib/typert.remote-client.js +1101 -38
- package/lib/types/broker.d.ts +79 -5
- package/lib/types/client/bitrix24.d.ts +24 -2
- package/lib/types/client/card.d.ts +3 -1
- package/lib/types/client/confluence.d.ts +19 -3
- package/lib/types/client/gitlab.d.ts +15 -2
- package/lib/types/client/index.d.ts +7 -5
- package/lib/types/client/integrations.d.ts +12 -3
- package/lib/types/client/jira.d.ts +20 -3
- package/lib/types/client/operator-card.d.ts +22 -0
- package/lib/types/client/operator-controls.d.ts +135 -0
- package/lib/types/client/provider-card.d.ts +50 -8
- package/lib/types/client/styles.d.ts +4 -3
- package/lib/types/client/teamcity.d.ts +15 -2
- package/lib/types/client/testit.d.ts +28 -0
- package/lib/types/client/weblate.d.ts +28 -0
- package/lib/types/coerce.d.ts +2 -2
- package/lib/types/config.d.ts +21 -0
- package/lib/types/errors.d.ts +9 -1
- package/lib/types/index.d.ts +183 -18
- package/lib/types/providers/bitrix24/catalog.d.ts +9 -1
- package/lib/types/providers/bitrix24/config.d.ts +23 -22
- package/lib/types/providers/bitrix24/credential-help.d.ts +8 -0
- package/lib/types/providers/bitrix24/index.d.ts +41 -1
- package/lib/types/providers/bitrix24/tools.d.ts +4 -0
- package/lib/types/providers/confluence/catalog.d.ts +11 -3
- package/lib/types/providers/confluence/credential-help.d.ts +9 -0
- package/lib/types/providers/confluence/index.d.ts +66 -7
- package/lib/types/providers/confluence/operations.d.ts +2 -0
- package/lib/types/providers/contract.d.ts +62 -1
- package/lib/types/providers/gitlab/catalog.d.ts +20 -5
- package/lib/types/providers/gitlab/config.d.ts +14 -3
- package/lib/types/providers/gitlab/credential-help.d.ts +9 -0
- package/lib/types/providers/gitlab/index.d.ts +51 -1
- package/lib/types/providers/jira/catalog.d.ts +13 -0
- package/lib/types/providers/jira/credential-help.d.ts +8 -0
- package/lib/types/providers/jira/index.d.ts +53 -1
- package/lib/types/providers/registry.d.ts +2 -0
- package/lib/types/providers/shared/credential-help.d.ts +17 -0
- package/lib/types/providers/shared/service-boundary.d.ts +25 -0
- package/lib/types/providers/teamcity/catalog.d.ts +18 -2
- package/lib/types/providers/teamcity/credential-help.d.ts +8 -0
- package/lib/types/providers/teamcity/index.d.ts +53 -2
- package/lib/types/providers/testit/attachments.d.ts +20 -0
- package/lib/types/providers/testit/catalog.d.ts +87 -0
- package/lib/types/providers/testit/config.d.ts +61 -0
- package/lib/types/providers/testit/credential-help.d.ts +8 -0
- package/lib/types/providers/testit/index.d.ts +119 -0
- package/lib/types/providers/testit/operations.d.ts +95 -0
- package/lib/types/providers/testit/tools.d.ts +15 -0
- package/lib/types/providers/testit/transport.d.ts +67 -0
- package/lib/types/providers/weblate/catalog.d.ts +60 -0
- package/lib/types/providers/weblate/config.d.ts +57 -0
- package/lib/types/providers/weblate/credential-help.d.ts +9 -0
- package/lib/types/providers/weblate/index.d.ts +92 -0
- package/lib/types/providers/weblate/operations.d.ts +77 -0
- package/lib/types/providers/weblate/query.d.ts +37 -0
- package/lib/types/providers/weblate/tools.d.ts +15 -0
- package/lib/types/providers/weblate/transport.d.ts +60 -0
- package/lib/types/repository.d.ts +38 -3
- package/lib/types/service-credentials/config.d.ts +73 -0
- package/lib/types/service-credentials/policy.d.ts +44 -0
- package/lib/types/service-credentials/registry.d.ts +43 -0
- package/lib/types/service-credentials/state.d.ts +14 -0
- package/lib/types/service-credentials/types.d.ts +97 -0
- package/lib/types/shared/settings.d.ts +8 -13
- package/lib/types/tools.d.ts +10 -1
- package/lib/types/types.d.ts +114 -10
- package/package.json +7 -7
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { OperationSecurityMetadata } from "../../service-credentials/types.js";
|
|
1
2
|
import type { IntegrationCapability, IntegrationCapabilityInfo } from "../../types.js";
|
|
2
3
|
import type { ConfluenceFlags } from "./config.js";
|
|
3
4
|
/**
|
|
@@ -37,12 +38,17 @@ export interface ConfluenceOperationDefinition {
|
|
|
37
38
|
* the two a `nextCursor` belongs to.
|
|
38
39
|
*/
|
|
39
40
|
readonly cursor?: "offset" | "upstream";
|
|
41
|
+
/** What this operation does, how sensitive it is, who may reach it. */
|
|
42
|
+
readonly security: OperationSecurityMetadata;
|
|
40
43
|
}
|
|
44
|
+
/** The resource kind every space-scoped operation of this provider is bounded by. */
|
|
45
|
+
export declare const CONFLUENCE_RESOURCE_KIND = "spaces";
|
|
41
46
|
/**
|
|
42
47
|
* Every model-reachable operation. The provider refuses any operation that is
|
|
43
|
-
* not listed here, so this table — together with `capability`
|
|
44
|
-
* permission surface. Only GET: the catalog carries no operation that
|
|
45
|
-
* change Confluence state, and the confirmation framework does not exist
|
|
48
|
+
* not listed here, so this table — together with `capability` and `security`
|
|
49
|
+
* — is the permission surface. Only GET: the catalog carries no operation that
|
|
50
|
+
* could change Confluence state, and the confirmation framework does not exist
|
|
51
|
+
* yet.
|
|
46
52
|
*
|
|
47
53
|
* The mix of REST versions is deliberate. Confluence Cloud v2 covers pages,
|
|
48
54
|
* comments, attachments, versions and spaces, and that is where the reads go;
|
|
@@ -56,4 +62,6 @@ export declare function enabledCapabilities(flags: ConfluenceFlags): readonly Co
|
|
|
56
62
|
export declare const CONFLUENCE_CAPABILITY_INFO: Readonly<Record<ConfluenceCapability, IntegrationCapabilityInfo>>;
|
|
57
63
|
/** Capability an operation needs, or undefined when the catalog has none. */
|
|
58
64
|
export declare function confluenceOperationCapability(operation: string): IntegrationCapability | undefined;
|
|
65
|
+
/** Security classification of an operation, or undefined when it is unknown. */
|
|
66
|
+
export declare function confluenceOperationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
59
67
|
//# sourceMappingURL=catalog.d.ts.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
2
|
+
/**
|
|
3
|
+
* Confluence authenticates with an Atlassian API token next to the account
|
|
4
|
+
* e-mail, and the token is account-wide: the same one opens Jira and the other
|
|
5
|
+
* Atlassian Cloud products, so the scopes are about the account rather than
|
|
6
|
+
* about Confluence alone.
|
|
7
|
+
*/
|
|
8
|
+
export declare const CONFLUENCE_CREDENTIAL_HELP: CredentialHelp;
|
|
9
|
+
//# sourceMappingURL=credential-help.d.ts.map
|
|
@@ -1,7 +1,17 @@
|
|
|
1
|
+
import { type CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
1
2
|
import type { ResolvedQaIntegrationsConfig } from "../../config.js";
|
|
2
|
-
import type {
|
|
3
|
+
import type { OperationSecurityMetadata, ServiceCredentialHealth, ServiceResourceBoundary } from "../../service-credentials/types.js";
|
|
4
|
+
import type { CapabilityServiceState, IntegrationCapability, IntegrationCapabilityInfo, ProviderValidation } from "../../types.js";
|
|
3
5
|
import type { IntegrationProvider, ProviderContext } from "../contract.js";
|
|
4
6
|
export { credentialFromPlaintext, credentialInstance, type ConfluenceCredential, } from "./transport.js";
|
|
7
|
+
/**
|
|
8
|
+
* Whether one space key stays inside the deployment's boundary. The profile's
|
|
9
|
+
* `resources.spaces` lists space keys — the same vocabulary the deployment's
|
|
10
|
+
* own allowlist and the CQL speak — and keys are compared case-insensitively,
|
|
11
|
+
* because operator config, the v2 API and CQL spell the same key in different
|
|
12
|
+
* cases.
|
|
13
|
+
*/
|
|
14
|
+
export declare function spaceInBoundary(boundary: ServiceResourceBoundary, key: string | undefined): boolean;
|
|
5
15
|
/** Confluence provider: operator-configured sites over an Atlassian API token. */
|
|
6
16
|
export declare class ConfluenceProvider implements IntegrationProvider {
|
|
7
17
|
private readonly config;
|
|
@@ -15,6 +25,10 @@ export declare class ConfluenceProvider implements IntegrationProvider {
|
|
|
15
25
|
*/
|
|
16
26
|
readonly capabilities: readonly IntegrationCapability[];
|
|
17
27
|
readonly capabilityInfo: Readonly<Record<IntegrationCapability, IntegrationCapabilityInfo>>;
|
|
28
|
+
/** Where the settings card says this provider's credential comes from. */
|
|
29
|
+
readonly credentialHelp: CredentialHelp | null;
|
|
30
|
+
/** Overrides the deployment got wrong; reported once at startup, never fatal. */
|
|
31
|
+
readonly credentialHelpProblems: readonly string[];
|
|
18
32
|
private readonly transport;
|
|
19
33
|
constructor(config: ResolvedQaIntegrationsConfig, fetcher?: typeof fetch);
|
|
20
34
|
/**
|
|
@@ -23,20 +37,42 @@ export declare class ConfluenceProvider implements IntegrationProvider {
|
|
|
23
37
|
* from operator config, never from a tool argument, which is what keeps the
|
|
24
38
|
* broker from dialling any host the caller names or authenticating as any
|
|
25
39
|
* account the caller names.
|
|
40
|
+
*
|
|
41
|
+
* A deployment-managed secret cannot travel with a connect form, so it
|
|
42
|
+
* arrives as the Basic pair Atlassian documents (`email:token`). The two
|
|
43
|
+
* forms can never be confused: an API token contains neither `@` nor `:`.
|
|
26
44
|
*/
|
|
27
45
|
parseCredential(raw: string, options?: Readonly<Record<string, string>>): {
|
|
28
46
|
readonly credential: string;
|
|
29
47
|
readonly portal: string;
|
|
30
48
|
};
|
|
31
49
|
operationCapability(operation: string): IntegrationCapability | undefined;
|
|
50
|
+
operationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
51
|
+
/** Every space-scoped read is bounded by the profile's space keys. */
|
|
52
|
+
resourceBoundaryKind(operation: string): string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* Portal of a configured site. An empty id means "the only site", the same
|
|
55
|
+
* rule `parseCredential` applies, so deployment configuration and the
|
|
56
|
+
* connect form name sites alike.
|
|
57
|
+
*/
|
|
58
|
+
instancePortal(instanceId: string): string | undefined;
|
|
59
|
+
capabilityServiceState(capability: IntegrationCapability): CapabilityServiceState | undefined;
|
|
32
60
|
validate(context: ProviderContext): Promise<ProviderValidation>;
|
|
61
|
+
/**
|
|
62
|
+
* Health of a deployment-managed token. The probe reads only the identity
|
|
63
|
+
* endpoint the personal validation reads, so it never changes upstream state;
|
|
64
|
+
* Confluence exposes no token-scope introspection, so the answer is healthy
|
|
65
|
+
* with a warning — the local service ceiling stays the whole local boundary.
|
|
66
|
+
*/
|
|
67
|
+
validateServiceCredential(context: ProviderContext): Promise<ServiceCredentialHealth>;
|
|
33
68
|
execute(context: ProviderContext, operation: string, input: Readonly<Record<string, unknown>>): Promise<unknown>;
|
|
34
69
|
/** One list read, with its cursor and with the space policy re-applied. */
|
|
35
70
|
private readList;
|
|
36
71
|
/**
|
|
37
72
|
* A page read is answered with the page's space, because that is what the
|
|
38
73
|
* operator allowlist is written in — and a page whose space the policy does
|
|
39
|
-
* not allow is refused here, after the read and before the model sees it.
|
|
74
|
+
* not allow is refused here, after the read and before the model sees it. In
|
|
75
|
+
* service mode the boundary is verified on the same resolved space.
|
|
40
76
|
*/
|
|
41
77
|
private readPage;
|
|
42
78
|
/**
|
|
@@ -50,14 +86,37 @@ export declare class ConfluenceProvider implements IntegrationProvider {
|
|
|
50
86
|
private withReplies;
|
|
51
87
|
/** One space, by id or by the key the listing endpoint resolves. */
|
|
52
88
|
private readSpace;
|
|
89
|
+
/**
|
|
90
|
+
* A service search is narrowed to the boundary before the handler builds the
|
|
91
|
+
* CQL: an offset-paginated search whose out-of-boundary rows were dropped
|
|
92
|
+
* afterwards would answer pages that shrink and cursors that lose their
|
|
93
|
+
* place. A space the caller names outside the boundary is refused rather
|
|
94
|
+
* than dropped, and the filter in `readList` stays as the second lock.
|
|
95
|
+
*/
|
|
96
|
+
private boundedSearchInput;
|
|
97
|
+
/**
|
|
98
|
+
* The bounded space listing. A service profile names the spaces it covers,
|
|
99
|
+
* so the listing is built from that list instead of from whatever the shared
|
|
100
|
+
* account can reach; a space the service token cannot see is reported as
|
|
101
|
+
* unavailable rather than silently dropped. The answer does not page: its
|
|
102
|
+
* size is the boundary the administrator defined, not upstream's.
|
|
103
|
+
*/
|
|
104
|
+
private listBoundedSpaces;
|
|
53
105
|
/** The fields a space contributes to a page answer, plus its policy key. */
|
|
54
106
|
private readSpaceFields;
|
|
55
107
|
/**
|
|
56
|
-
* The space of a page the call is about.
|
|
57
|
-
*
|
|
58
|
-
*
|
|
108
|
+
* The space of a page the call is about. Asked for whenever a policy needs
|
|
109
|
+
* it: the deployment allowlist, or — in service mode — the boundary, which is
|
|
110
|
+
* always there. Without either there is no policy to enforce, and the extra
|
|
111
|
+
* reads would be spent for nothing.
|
|
112
|
+
*/
|
|
113
|
+
private assertPageReachable;
|
|
114
|
+
/**
|
|
115
|
+
* Both space policies of one read, in the order a refusal should name them:
|
|
116
|
+
* the deployment allowlist first, the service boundary — when the call runs
|
|
117
|
+
* on the managed credential — second.
|
|
59
118
|
*/
|
|
60
|
-
private
|
|
119
|
+
private assertSpaceReachable;
|
|
61
120
|
/**
|
|
62
121
|
* A space outside the operator allowlist is refused as a policy decision, not
|
|
63
122
|
* as a Confluence permission: the account may well be allowed to read it, and
|
|
@@ -65,7 +124,7 @@ export declare class ConfluenceProvider implements IntegrationProvider {
|
|
|
65
124
|
*/
|
|
66
125
|
private assertSpaceAllowed;
|
|
67
126
|
/** The space of one search row, as the projection resolved it. */
|
|
68
|
-
private
|
|
127
|
+
private itemSpaceReachable;
|
|
69
128
|
private projectionContext;
|
|
70
129
|
private resolveInstance;
|
|
71
130
|
}
|
|
@@ -8,6 +8,8 @@ export declare function numericId(value: unknown, field: string): string;
|
|
|
8
8
|
export declare function spaceRef(value: unknown, field?: string): string;
|
|
9
9
|
/** Whether a space reference is the numeric id v2 wants in a path. */
|
|
10
10
|
export declare function isNumericSpace(value: string): boolean;
|
|
11
|
+
/** Space keys the model named, upper-cased the way CQL and the policy spell them. */
|
|
12
|
+
export declare function spaceKeys(value: unknown, field: string): string[];
|
|
11
13
|
/**
|
|
12
14
|
* Rows per answer. A `limit` above the deployment cap is clamped rather than
|
|
13
15
|
* refused: the answer says how many rows it carries, so the model can page on
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
2
|
+
import type { ServiceCredentialHealth, ServiceResourceBoundary, CredentialSource, OperationSecurityMetadata } from "../service-credentials/types.js";
|
|
3
|
+
import type { CapabilityServiceState, IntegrationCapability, IntegrationCapabilityInfo, IntegrationProviderId, ProviderValidation } from "../types.js";
|
|
2
4
|
export interface ProviderContext {
|
|
3
5
|
readonly credential: string;
|
|
4
6
|
/**
|
|
@@ -6,6 +8,20 @@ export interface ProviderContext {
|
|
|
6
8
|
* Resolved server-side, never a model argument; it backs "mine" defaults.
|
|
7
9
|
*/
|
|
8
10
|
readonly externalUserId?: string | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* Which credential the broker resolved for this call. A provider that supports
|
|
13
|
+
* managed service credentials must treat `service` as a different upstream
|
|
14
|
+
* identity: answers may be attributed to the deployment, not to the user.
|
|
15
|
+
*/
|
|
16
|
+
readonly credentialSource?: CredentialSource | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* Boundary every resource this call touches has to stay inside. The broker
|
|
19
|
+
* sets it exactly when the call runs on a managed credential, and a provider
|
|
20
|
+
* that supports service mode fails closed rather than reading outside it —
|
|
21
|
+
* including when the operation is addressed by an opaque id that has to be
|
|
22
|
+
* mapped to a resource first.
|
|
23
|
+
*/
|
|
24
|
+
readonly resourceBoundary?: ServiceResourceBoundary | undefined;
|
|
9
25
|
}
|
|
10
26
|
export interface IntegrationProvider {
|
|
11
27
|
readonly id: IntegrationProviderId;
|
|
@@ -13,6 +29,17 @@ export interface IntegrationProvider {
|
|
|
13
29
|
readonly capabilities: readonly IntegrationCapability[];
|
|
14
30
|
/** Labels and hints for `capabilities`, so clients need no provider catalog. */
|
|
15
31
|
readonly capabilityInfo: Readonly<Record<IntegrationCapability, IntegrationCapabilityInfo>>;
|
|
32
|
+
/**
|
|
33
|
+
* Where this provider's credential comes from, as it declares it and the
|
|
34
|
+
* deployment may have overridden it; `null` when the deployment hid the help.
|
|
35
|
+
* Metadata only — a credential value never travels in this shape.
|
|
36
|
+
*/
|
|
37
|
+
readonly credentialHelp: CredentialHelp | null;
|
|
38
|
+
/**
|
|
39
|
+
* What the deployment got wrong while overriding the help. Non-fatal by
|
|
40
|
+
* design: a broken help address hides a link, it never disables a provider.
|
|
41
|
+
*/
|
|
42
|
+
readonly credentialHelpProblems?: readonly string[];
|
|
16
43
|
/** Capability a provider operation needs, or undefined when it is unknown. */
|
|
17
44
|
operationCapability(operation: string): IntegrationCapability | undefined;
|
|
18
45
|
/**
|
|
@@ -22,6 +49,10 @@ export interface IntegrationProvider {
|
|
|
22
49
|
* `options` carries the non-secret choices the connect form made next to the
|
|
23
50
|
* secret — today only which configured instance a token belongs to. It comes
|
|
24
51
|
* from the operator-facing RPC, never from a model tool call.
|
|
52
|
+
*
|
|
53
|
+
* The same method turns a deployment-managed secret into this provider's
|
|
54
|
+
* credential shape, which is why a managed credential and a personal one can
|
|
55
|
+
* never be spent against an instance the other names.
|
|
25
56
|
*/
|
|
26
57
|
parseCredential(raw: string, options?: Readonly<Record<string, string>>): {
|
|
27
58
|
readonly credential: string;
|
|
@@ -29,5 +60,35 @@ export interface IntegrationProvider {
|
|
|
29
60
|
};
|
|
30
61
|
validate(context: ProviderContext): Promise<ProviderValidation>;
|
|
31
62
|
execute(context: ProviderContext, operation: string, input: Readonly<Record<string, unknown>>): Promise<unknown>;
|
|
63
|
+
/**
|
|
64
|
+
* Security classification of one operation. Providers that omit it leave every
|
|
65
|
+
* operation unclassified, and an unclassified operation is unreachable through
|
|
66
|
+
* a managed credential — the default is deny, never guess.
|
|
67
|
+
*/
|
|
68
|
+
operationMetadata?(operation: string): OperationSecurityMetadata | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* How one capability behaves when the connection runs on the deployment's
|
|
71
|
+
* managed credential. A provider that omits this supports no managed
|
|
72
|
+
* credential at all, and nothing about the feature appears for it.
|
|
73
|
+
*/
|
|
74
|
+
capabilityServiceState?(capability: IntegrationCapability): CapabilityServiceState | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* Which kind of resource an operation reads, in the profile's vocabulary
|
|
77
|
+
* (`projects`, `groups`, …). Used to prove a boundary exists for the operation
|
|
78
|
+
* before it runs; a service-safe operation that declares none is refused.
|
|
79
|
+
*/
|
|
80
|
+
resourceBoundaryKind?(operation: string): string | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* Portal of one configured instance, so deployment configuration can name an
|
|
83
|
+
* instance the same way the connect form does and a typo fails at load.
|
|
84
|
+
*/
|
|
85
|
+
instancePortal?(instanceId: string): string | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* Probe a deployment-managed credential: is it accepted upstream, what
|
|
88
|
+
* identity does it carry, and is it narrower than read-only. No probe may
|
|
89
|
+
* change upstream state, so a write-capable credential is reported as
|
|
90
|
+
* `unsafe_scope` rather than exercised.
|
|
91
|
+
*/
|
|
92
|
+
validateServiceCredential?(context: ProviderContext): Promise<ServiceCredentialHealth>;
|
|
32
93
|
}
|
|
33
94
|
//# sourceMappingURL=contract.d.ts.map
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { OperationSecurityMetadata } from "../../service-credentials/types.js";
|
|
1
2
|
import type { IntegrationCapability, IntegrationCapabilityInfo } from "../../types.js";
|
|
2
3
|
import type { GitlabFlags } from "./config.js";
|
|
3
4
|
/**
|
|
@@ -10,11 +11,15 @@ import type { GitlabFlags } from "./config.js";
|
|
|
10
11
|
* intersects them with the scopes the connected token actually reports. A token
|
|
11
12
|
* with `read_api` satisfies everything readable, `read_repository` adds nothing
|
|
12
13
|
* on top of it, and `read_user` is enough only for the profile.
|
|
14
|
+
*
|
|
15
|
+
* CI is split in two because a job log is a different disclosure from a
|
|
16
|
+
* pipeline listing: the deployment-managed read-only credential may see which
|
|
17
|
+
* jobs ran and how they ended, never what they printed.
|
|
13
18
|
*/
|
|
14
|
-
export type GitlabCapability = "identity.read" | "projects.read" | "repository.read" | "search.read" | "issues.read" | "merge_requests.read" | "ci.read";
|
|
19
|
+
export type GitlabCapability = "identity.read" | "projects.read" | "repository.read" | "search.read" | "issues.read" | "merge_requests.read" | "ci.metadata.read" | "ci.logs.read";
|
|
15
20
|
export interface GitlabCapabilityDefinition {
|
|
16
21
|
readonly capability: GitlabCapability;
|
|
17
|
-
readonly flag: Exclude<keyof GitlabFlags, "instances" | "retries" | "enabled">;
|
|
22
|
+
readonly flag: Exclude<keyof GitlabFlags, "instances" | "retries" | "enabled" | "allowInsecureHttp">;
|
|
18
23
|
readonly scopes: readonly string[];
|
|
19
24
|
readonly label: string;
|
|
20
25
|
readonly hint: string;
|
|
@@ -30,12 +35,16 @@ export interface GitlabOperationDefinition {
|
|
|
30
35
|
readonly path: string;
|
|
31
36
|
/** Set when the operation answers with one page of a collection. */
|
|
32
37
|
readonly list?: boolean;
|
|
38
|
+
/** What this operation does, how sensitive it is, who may reach it. */
|
|
39
|
+
readonly security: OperationSecurityMetadata;
|
|
33
40
|
}
|
|
41
|
+
/** The resource kind every project-scoped operation of this provider is bounded by. */
|
|
42
|
+
export declare const GITLAB_RESOURCE_KIND = "projects";
|
|
34
43
|
/**
|
|
35
44
|
* Every model-reachable operation. The provider refuses any operation that is
|
|
36
|
-
* not listed here, so this table — together with `capability`
|
|
37
|
-
* permission surface. Only GET: the catalog carries no operation that
|
|
38
|
-
* change GitLab state, and the confirmation framework does not exist yet.
|
|
45
|
+
* not listed here, so this table — together with `capability` and `security` —
|
|
46
|
+
* is the permission surface. Only GET: the catalog carries no operation that
|
|
47
|
+
* could change GitLab state, and the confirmation framework does not exist yet.
|
|
39
48
|
*/
|
|
40
49
|
export declare const GITLAB_OPERATIONS: Readonly<Record<string, GitlabOperationDefinition>>;
|
|
41
50
|
/** Capabilities this deployment allows, in catalog order. */
|
|
@@ -44,6 +53,12 @@ export declare function enabledCapabilities(flags: GitlabFlags): readonly Gitlab
|
|
|
44
53
|
export declare const GITLAB_CAPABILITY_INFO: Readonly<Record<GitlabCapability, IntegrationCapabilityInfo>>;
|
|
45
54
|
/** Capability an operation needs, or undefined when the catalog has none. */
|
|
46
55
|
export declare function gitlabOperationCapability(operation: string): IntegrationCapability | undefined;
|
|
56
|
+
/** Security classification of an operation, or undefined when it is unknown. */
|
|
57
|
+
export declare function gitlabOperationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
47
58
|
/** Capabilities satisfied by the scopes a GitLab token reports. */
|
|
48
59
|
export declare function capabilitiesForScopes(scopes: readonly string[]): readonly GitlabCapability[];
|
|
60
|
+
/** Capability id this release split in two; kept for the store migration. */
|
|
61
|
+
export declare const GITLAB_LEGACY_CI_CAPABILITY = "ci.read";
|
|
62
|
+
/** The two capabilities that replaced it. */
|
|
63
|
+
export declare const GITLAB_CI_SPLIT_CAPABILITIES: readonly GitlabCapability[];
|
|
49
64
|
//# sourceMappingURL=catalog.d.ts.map
|
|
@@ -27,7 +27,10 @@ export interface GitlabFlags {
|
|
|
27
27
|
readonly searchRead: boolean;
|
|
28
28
|
readonly issuesRead: boolean;
|
|
29
29
|
readonly mergeRequestsRead: boolean;
|
|
30
|
-
|
|
30
|
+
/** Pipeline and job metadata; service-safe, unlike the job log below. */
|
|
31
|
+
readonly ciMetadataRead: boolean;
|
|
32
|
+
/** Job log contents: may carry secrets, never reachable by a service token. */
|
|
33
|
+
readonly ciLogsRead: boolean;
|
|
31
34
|
/** Largest file body handed to the model, in bytes. */
|
|
32
35
|
readonly maxFileBytes: number;
|
|
33
36
|
/** Largest CI job log handed to the model, in bytes. */
|
|
@@ -38,13 +41,21 @@ export interface GitlabFlags {
|
|
|
38
41
|
readonly retries: number;
|
|
39
42
|
}
|
|
40
43
|
export declare const GITLAB_DEFAULTS: GitlabFlags;
|
|
44
|
+
/**
|
|
45
|
+
* Operator input of this slice. `ciRead` is the single CI switch of earlier
|
|
46
|
+
* releases: deployments that set it are read as both halves of the split, so a
|
|
47
|
+
* deployment that had turned CI off does not silently get it back.
|
|
48
|
+
*/
|
|
49
|
+
export type GitlabConfigInput = Partial<GitlabFlags> & {
|
|
50
|
+
readonly ciRead?: boolean;
|
|
51
|
+
};
|
|
41
52
|
/**
|
|
42
53
|
* Config slice of this provider, as it appears under `gitlab:` in YAML. The
|
|
43
54
|
* instance list is validated and canonicalized by `resolveGitlabConfig`, which
|
|
44
55
|
* is where a deployment typo fails loudly.
|
|
45
56
|
*/
|
|
46
|
-
export declare const gitlabConfigSchema: z<
|
|
47
|
-
export declare function resolveGitlabConfig(input?:
|
|
57
|
+
export declare const gitlabConfigSchema: z<GitlabConfigInput>;
|
|
58
|
+
export declare function resolveGitlabConfig(input?: GitlabConfigInput): GitlabFlags;
|
|
48
59
|
/** The configured instance a stored credential names, or a fail-closed error. */
|
|
49
60
|
export declare function gitlabInstance(flags: GitlabFlags, instanceId: string): GitlabInstance | undefined;
|
|
50
61
|
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
2
|
+
/**
|
|
3
|
+
* A GitLab personal access token is minted on the instance the connection
|
|
4
|
+
* belongs to. The declared help points at gitlab.com, which is right for a
|
|
5
|
+
* hosted user and wrong for every self-hosted deployment — those replace the
|
|
6
|
+
* address (and their own token page) through `credentialHelp.gitlab`.
|
|
7
|
+
*/
|
|
8
|
+
export declare const GITLAB_CREDENTIAL_HELP: CredentialHelp;
|
|
9
|
+
//# sourceMappingURL=credential-help.d.ts.map
|
|
@@ -1,7 +1,19 @@
|
|
|
1
|
+
import { type CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
1
2
|
import type { ResolvedQaIntegrationsConfig } from "../../config.js";
|
|
2
|
-
import type {
|
|
3
|
+
import type { OperationSecurityMetadata, ServiceCredentialHealth, ServiceResourceBoundary } from "../../service-credentials/types.js";
|
|
4
|
+
import type { CapabilityServiceState, IntegrationCapability, IntegrationCapabilityInfo, ProviderValidation } from "../../types.js";
|
|
3
5
|
import type { IntegrationProvider, ProviderContext } from "../contract.js";
|
|
4
6
|
export { credentialFromPlaintext, credentialInstance, type GitlabCredential, } from "./transport.js";
|
|
7
|
+
/**
|
|
8
|
+
* Whether one caller-named project stays inside the deployment's boundary. A
|
|
9
|
+
* numeric reference is matched against the listed ids only: a group id cannot
|
|
10
|
+
* be expanded into project ids without another call, so it never widens a
|
|
11
|
+
* numeric read. A path reference matches an exact entry or sits under a listed
|
|
12
|
+
* group, which is how the same rule covers `group/subgroup/project`.
|
|
13
|
+
*/
|
|
14
|
+
export declare function projectAllowed(boundary: ServiceResourceBoundary, ref: string): boolean;
|
|
15
|
+
/** Whether a caller-named group stays inside the boundary. */
|
|
16
|
+
export declare function groupAllowed(boundary: ServiceResourceBoundary, ref: string): boolean;
|
|
5
17
|
/** GitLab provider: operator-configured instances over a personal access token. */
|
|
6
18
|
export declare class GitlabProvider implements IntegrationProvider {
|
|
7
19
|
private readonly config;
|
|
@@ -10,6 +22,10 @@ export declare class GitlabProvider implements IntegrationProvider {
|
|
|
10
22
|
/** What this deployment allows; the token scope probe narrows it per user. */
|
|
11
23
|
readonly capabilities: readonly IntegrationCapability[];
|
|
12
24
|
readonly capabilityInfo: Readonly<Record<IntegrationCapability, IntegrationCapabilityInfo>>;
|
|
25
|
+
/** Where the settings card says this provider's credential comes from. */
|
|
26
|
+
readonly credentialHelp: CredentialHelp | null;
|
|
27
|
+
/** Overrides the deployment got wrong; reported once at startup, never fatal. */
|
|
28
|
+
readonly credentialHelpProblems: readonly string[];
|
|
13
29
|
private readonly transport;
|
|
14
30
|
constructor(config: ResolvedQaIntegrationsConfig, fetcher?: typeof fetch);
|
|
15
31
|
/**
|
|
@@ -23,8 +39,42 @@ export declare class GitlabProvider implements IntegrationProvider {
|
|
|
23
39
|
readonly portal: string;
|
|
24
40
|
};
|
|
25
41
|
operationCapability(operation: string): IntegrationCapability | undefined;
|
|
42
|
+
operationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
43
|
+
/** Every project-scoped read may name a project id or a path under a group. */
|
|
44
|
+
resourceBoundaryKind(operation: string): string | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Portal of a configured instance. An empty id means "the only instance", the
|
|
47
|
+
* same rule `parseCredential` applies, so deployment configuration and the
|
|
48
|
+
* connect form name instances alike.
|
|
49
|
+
*/
|
|
50
|
+
instancePortal(instanceId: string): string | undefined;
|
|
51
|
+
capabilityServiceState(capability: IntegrationCapability): CapabilityServiceState | undefined;
|
|
26
52
|
validate(context: ProviderContext): Promise<ProviderValidation>;
|
|
53
|
+
/**
|
|
54
|
+
* Health of a deployment-managed token. The probe reads only the two
|
|
55
|
+
* self-inspection endpoints, so it never changes upstream state; a token that
|
|
56
|
+
* reaches beyond read-only scopes is reported as `unsafe_scope` and still
|
|
57
|
+
* bounded locally by the service ceiling.
|
|
58
|
+
*/
|
|
59
|
+
validateServiceCredential(context: ProviderContext): Promise<ServiceCredentialHealth>;
|
|
27
60
|
execute(context: ProviderContext, operation: string, input: Readonly<Record<string, unknown>>): Promise<unknown>;
|
|
61
|
+
/**
|
|
62
|
+
* Hold one call inside the deployment's boundary. Every service-safe
|
|
63
|
+
* operation of this provider reads one project (or one group), so the check is
|
|
64
|
+
* the same for all of them: name a resource that is inside the boundary, or
|
|
65
|
+
* nothing is read. A listing that names none is refused rather than answered
|
|
66
|
+
* with the service account's whole upstream view.
|
|
67
|
+
*/
|
|
68
|
+
private assertInsideBoundary;
|
|
69
|
+
/**
|
|
70
|
+
* The bounded project listing. A service profile names the projects (and
|
|
71
|
+
* groups) it covers, so the listing is built from that list instead of from
|
|
72
|
+
* whatever the shared account can reach; a project the service token cannot
|
|
73
|
+
* see is reported as unavailable rather than silently dropped.
|
|
74
|
+
*/
|
|
75
|
+
private listBoundedProjects;
|
|
76
|
+
/** Fail closed on an issue the shared account must not expose. */
|
|
77
|
+
private assertIssueNotConfidential;
|
|
28
78
|
/**
|
|
29
79
|
* A file read answers with metadata and content in one call. GitLab returns
|
|
30
80
|
* the body base64-encoded inside that JSON, so a file bigger than the
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { OperationSecurityMetadata } from "../../service-credentials/types.js";
|
|
1
2
|
import type { IntegrationCapability, IntegrationCapabilityInfo } from "../../types.js";
|
|
2
3
|
import type { JiraFlags } from "./config.js";
|
|
3
4
|
/**
|
|
@@ -38,7 +39,17 @@ export interface JiraOperationDefinition {
|
|
|
38
39
|
readonly method: "GET";
|
|
39
40
|
/** Set when the operation answers with one page of a collection. */
|
|
40
41
|
readonly list?: boolean;
|
|
42
|
+
/** What this operation does, how sensitive it is, who may reach it. */
|
|
43
|
+
readonly security: OperationSecurityMetadata;
|
|
41
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* The resource kind every project-scoped operation of this provider is bounded
|
|
47
|
+
* by. The entries of a `projects` boundary are Jira project keys — the form
|
|
48
|
+
* every operation addresses a project by (`projects.get` takes a key, an issue
|
|
49
|
+
* key embeds its project's key). A listed numeric project id is honoured where
|
|
50
|
+
* Jira reports one, in a filtered search; a key is what an operator lists.
|
|
51
|
+
*/
|
|
52
|
+
export declare const JIRA_RESOURCE_KIND = "projects";
|
|
42
53
|
/**
|
|
43
54
|
* Every model-reachable operation. The provider refuses any operation that is
|
|
44
55
|
* not listed here, so this table — together with `capability` — is the
|
|
@@ -71,4 +82,6 @@ export declare function enabledCapabilities(flags: JiraFlags): readonly JiraCapa
|
|
|
71
82
|
export declare const JIRA_CAPABILITY_INFO: Readonly<Record<JiraCapability, IntegrationCapabilityInfo>>;
|
|
72
83
|
/** Capability an operation needs, or undefined when the catalog has none. */
|
|
73
84
|
export declare function jiraOperationCapability(operation: string): IntegrationCapability | undefined;
|
|
85
|
+
/** Security classification of an operation, or undefined when it is unknown. */
|
|
86
|
+
export declare function jiraOperationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
74
87
|
//# sourceMappingURL=catalog.d.ts.map
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
2
|
+
/**
|
|
3
|
+
* Jira authenticates with an Atlassian API token next to the account e-mail.
|
|
4
|
+
* Scoped tokens are the ones to recommend: an unscoped token is account-wide,
|
|
5
|
+
* while a scoped one can be limited to the Jira scopes the agent actually uses.
|
|
6
|
+
*/
|
|
7
|
+
export declare const JIRA_CREDENTIAL_HELP: CredentialHelp;
|
|
8
|
+
//# sourceMappingURL=credential-help.d.ts.map
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import { type CredentialHelp } from "@yadsh/dsh-plugin-kit";
|
|
1
2
|
import type { ResolvedQaIntegrationsConfig } from "../../config.js";
|
|
2
|
-
import type {
|
|
3
|
+
import type { OperationSecurityMetadata, ServiceCredentialHealth, ServiceResourceBoundary } from "../../service-credentials/types.js";
|
|
4
|
+
import type { CapabilityServiceState, IntegrationCapability, IntegrationCapabilityInfo, ProviderValidation } from "../../types.js";
|
|
3
5
|
import type { IntegrationProvider, ProviderContext } from "../contract.js";
|
|
4
6
|
export { credentialFromPlaintext, credentialSite, type JiraCredential, } from "./transport.js";
|
|
5
7
|
/**
|
|
@@ -16,6 +18,10 @@ export declare class JiraProvider implements IntegrationProvider {
|
|
|
16
18
|
/** What this deployment allows; Jira's own permissions narrow it upstream. */
|
|
17
19
|
readonly capabilities: readonly IntegrationCapability[];
|
|
18
20
|
readonly capabilityInfo: Readonly<Record<IntegrationCapability, IntegrationCapabilityInfo>>;
|
|
21
|
+
/** Where the settings card says this provider's credential comes from. */
|
|
22
|
+
readonly credentialHelp: CredentialHelp | null;
|
|
23
|
+
/** Overrides the deployment got wrong; reported once at startup, never fatal. */
|
|
24
|
+
readonly credentialHelpProblems: readonly string[];
|
|
19
25
|
private readonly transport;
|
|
20
26
|
constructor(config: ResolvedQaIntegrationsConfig, fetcher?: typeof fetch);
|
|
21
27
|
/**
|
|
@@ -23,14 +29,52 @@ export declare class JiraProvider implements IntegrationProvider {
|
|
|
23
29
|
* Both non-secret choices come from the connect form and from operator config,
|
|
24
30
|
* never from a tool argument, which is what keeps the broker from dialling any
|
|
25
31
|
* host the caller names.
|
|
32
|
+
*
|
|
33
|
+
* The same method turns a deployment-managed secret into this credential
|
|
34
|
+
* shape. That secret is the whole Basic pair (`email:token`), because Jira
|
|
35
|
+
* cannot spend the token without the account and the pair must not be split
|
|
36
|
+
* across two records; the form path instead supplies the e-mail separately,
|
|
37
|
+
* and keeps refusing a pasted pair.
|
|
26
38
|
*/
|
|
27
39
|
parseCredential(raw: string, options?: Readonly<Record<string, string>>): {
|
|
28
40
|
readonly credential: string;
|
|
29
41
|
readonly portal: string;
|
|
30
42
|
};
|
|
31
43
|
operationCapability(operation: string): IntegrationCapability | undefined;
|
|
44
|
+
operationMetadata(operation: string): OperationSecurityMetadata | undefined;
|
|
45
|
+
/** Every project-scoped read names its project through a key or an issue key. */
|
|
46
|
+
resourceBoundaryKind(operation: string): string | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* Portal of a configured site. An empty id means "the only site", the same
|
|
49
|
+
* rule `parseCredential` applies, so deployment configuration and the connect
|
|
50
|
+
* form name sites alike.
|
|
51
|
+
*/
|
|
52
|
+
instancePortal(instanceId: string): string | undefined;
|
|
53
|
+
capabilityServiceState(capability: IntegrationCapability): CapabilityServiceState | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* Health of a deployment-managed token. The probe reads only the identity
|
|
56
|
+
* endpoint the personal validation reads, so it never changes upstream state;
|
|
57
|
+
* Jira reports no granted scopes for an API token, so the answer is healthy
|
|
58
|
+
* with a warning — the local service ceiling stays the whole local boundary.
|
|
59
|
+
*/
|
|
60
|
+
validateServiceCredential(context: ProviderContext): Promise<ServiceCredentialHealth>;
|
|
32
61
|
validate(context: ProviderContext): Promise<ProviderValidation>;
|
|
33
62
|
execute(context: ProviderContext, operation: string, input: Readonly<Record<string, unknown>>): Promise<unknown>;
|
|
63
|
+
/**
|
|
64
|
+
* Hold one call inside the deployment's boundary. A single-resource read
|
|
65
|
+
* names its project — a project key, or the key an issue key embeds — and
|
|
66
|
+
* must stay inside it, or nothing is read. A search names none by default, so
|
|
67
|
+
* it is not refused here but answered with the hits filtered to the boundary
|
|
68
|
+
* instead.
|
|
69
|
+
*/
|
|
70
|
+
private assertInsideBoundary;
|
|
71
|
+
/**
|
|
72
|
+
* Fail closed on an issue an issue-security level closes off. The service
|
|
73
|
+
* identity may be allowed to see it upstream, so the check is made here,
|
|
74
|
+
* before anything about it is returned, and it answers the same not-found a
|
|
75
|
+
* personal caller would see for an issue they cannot.
|
|
76
|
+
*/
|
|
77
|
+
private assertIssueNotRestricted;
|
|
34
78
|
/**
|
|
35
79
|
* Replace a custom field's alias with the instance id the operator mapped it
|
|
36
80
|
* to. The mapping lives in the deployment's config on purpose: which of an
|
|
@@ -75,5 +119,13 @@ export declare class JiraProvider implements IntegrationProvider {
|
|
|
75
119
|
private requireCloud;
|
|
76
120
|
private resolveSite;
|
|
77
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
* Whether one caller-named project stays inside the deployment's boundary. The
|
|
124
|
+
* boundary lists project keys, and a Jira project key compares case-insensitively
|
|
125
|
+
* upstream while an operator may type it in any case, so the match normalizes
|
|
126
|
+
* the case; a listed numeric id matches exactly. A project key that is not
|
|
127
|
+
* listed never widens into its issues: `PROJ` does not cover `PROJX`.
|
|
128
|
+
*/
|
|
129
|
+
export declare function projectAllowed(boundary: ServiceResourceBoundary, ref: string): boolean;
|
|
78
130
|
export default JiraProvider;
|
|
79
131
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -3,6 +3,8 @@ import type { IntegrationProvider } from "./contract.js";
|
|
|
3
3
|
export declare class IntegrationProviderRegistry {
|
|
4
4
|
private readonly providers;
|
|
5
5
|
register(provider: IntegrationProvider): void;
|
|
6
|
+
/** The provider, or undefined; used where absence is a configuration error. */
|
|
7
|
+
find(id: IntegrationProviderId): IntegrationProvider | undefined;
|
|
6
8
|
get(id: IntegrationProviderId): IntegrationProvider;
|
|
7
9
|
list(): readonly IntegrationProvider[];
|
|
8
10
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import z from "@deepseek-ai/schemastery";
|
|
2
|
+
import type { CredentialHelpOverride } from "@yadsh/dsh-plugin-kit";
|
|
3
|
+
/**
|
|
4
|
+
* Deployment replacement of one provider's credential help, as it appears under
|
|
5
|
+
* `credentialHelp.<provider>` in YAML. Every field is optional and replaces only
|
|
6
|
+
* itself: an internal gateway rewrites the obtain address, a corporate wiki
|
|
7
|
+
* replaces the documentation link, and a deployment that hides the help says
|
|
8
|
+
* `enabled: false`.
|
|
9
|
+
*
|
|
10
|
+
* The credential mechanism (`kind`) is the integration's own statement, so an
|
|
11
|
+
* override rarely names it; a value that is not a known mechanism degrades to
|
|
12
|
+
* `custom` with a startup warning rather than failing the provider.
|
|
13
|
+
*/
|
|
14
|
+
export declare const credentialHelpOverrideSchema: z<CredentialHelpOverride>;
|
|
15
|
+
/** The overrides of every provider, keyed by provider id. */
|
|
16
|
+
export declare const credentialHelpOverridesSchema: z<Record<string, CredentialHelpOverride>>;
|
|
17
|
+
//# sourceMappingURL=credential-help.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { IntegrationError } from "../../errors.js";
|
|
2
|
+
import { type OperationSecurityMetadata, type ServiceResourceBoundary } from "../../service-credentials/types.js";
|
|
3
|
+
import type { ProviderContext } from "../contract.js";
|
|
4
|
+
/**
|
|
5
|
+
* The resource boundary of a call that runs on the deployment's managed
|
|
6
|
+
* credential, or undefined for a personal one.
|
|
7
|
+
*
|
|
8
|
+
* Reaching service mode without a boundary means the broker had nothing to hand
|
|
9
|
+
* over, and reading without a boundary is what the whole feature forbids — so a
|
|
10
|
+
* supporting provider fails closed here instead of falling back to "no
|
|
11
|
+
* boundary, no restriction".
|
|
12
|
+
*/
|
|
13
|
+
export declare function serviceBoundaryOf(context: ProviderContext): ServiceResourceBoundary | undefined;
|
|
14
|
+
/** One refusal shape, so every service-mode denial reads the same. */
|
|
15
|
+
export declare function serviceResourceDenied(): IntegrationError;
|
|
16
|
+
/**
|
|
17
|
+
* Refuse an operation the provider's own catalog does not mark as service-safe.
|
|
18
|
+
* The broker decides this first and with the administrator's narrowing on top;
|
|
19
|
+
* this guard is the second lock, so a caller that reaches a provider directly —
|
|
20
|
+
* or a future bug in the broker — still cannot read a log through a shared
|
|
21
|
+
* credential. An operation the provider does not classify is denied, exactly as
|
|
22
|
+
* the broker's default is.
|
|
23
|
+
*/
|
|
24
|
+
export declare function assertServiceOperationAllowed(metadata: OperationSecurityMetadata | undefined, message: string): void;
|
|
25
|
+
//# sourceMappingURL=service-boundary.d.ts.map
|