@every-app/sdk 0.3.0-rc.10 → 0.3.0-rc.11
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 +62 -64
- package/dist/cloudflare/catalogSettings.generated.d.ts +7 -4
- package/dist/cloudflare/catalogSettings.generated.d.ts.map +1 -1
- package/dist/cloudflare/catalogSettings.generated.js +7 -6
- package/dist/cloudflare/index.d.ts +1 -1
- package/dist/cloudflare/index.d.ts.map +1 -1
- package/dist/cloudflare/worker.d.ts +35 -1
- package/dist/cloudflare/worker.d.ts.map +1 -1
- package/dist/cloudflare/worker.js +31 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/internal/aiDefault.d.ts +4 -3
- package/dist/internal/aiDefault.d.ts.map +1 -1
- package/dist/internal/aiDefault.js +6 -5
- package/dist/internal/aiProviders.d.ts.map +1 -1
- package/dist/internal/aiProviders.js +2 -2
- package/dist/internal/capabilities.d.ts +97 -481
- package/dist/internal/capabilities.d.ts.map +1 -1
- package/dist/internal/capabilities.js +47 -548
- package/dist/internal/catalog/index.d.ts +35 -0
- package/dist/internal/catalog/index.d.ts.map +1 -1
- package/dist/internal/catalog/infra.d.ts +35 -0
- package/dist/internal/catalog/infra.d.ts.map +1 -1
- package/dist/internal/catalog/infra.js +65 -0
- package/dist/internal/events.d.ts +52 -1
- package/dist/internal/events.d.ts.map +1 -1
- package/dist/internal/events.js +65 -3
- package/dist/internal/oauthBuiltIns.d.ts +101 -0
- package/dist/internal/oauthBuiltIns.d.ts.map +1 -0
- package/dist/internal/oauthBuiltIns.js +122 -0
- package/dist/internal/oauthClient.d.ts +7 -47
- package/dist/internal/oauthClient.d.ts.map +1 -1
- package/dist/internal/oauthClient.js +1 -115
- package/dist/internal/oauthPresets.d.ts +14 -15
- package/dist/internal/oauthPresets.d.ts.map +1 -1
- package/dist/internal/oauthPresets.js +42 -853
- package/dist/internal/oauthScopes.d.ts +43 -155
- package/dist/internal/oauthScopes.d.ts.map +1 -1
- package/dist/internal/oauthScopes.js +82 -475
- package/dist/internal/oauthSpec.d.ts +72 -71
- package/dist/internal/oauthSpec.d.ts.map +1 -1
- package/dist/internal/oauthSpec.js +178 -447
- package/dist/internal/protocol.d.ts +42 -13
- package/dist/internal/protocol.d.ts.map +1 -1
- package/dist/internal/protocol.js +45 -7
- package/dist/internal/providerRegistry.d.ts +1 -61
- package/dist/internal/providerRegistry.d.ts.map +1 -1
- package/dist/internal/providerRegistry.js +8 -115
- package/dist/internal/providerSpec.d.ts.map +1 -1
- package/dist/internal/providerSpec.js +14 -36
- package/dist/internal/remoteMcp.d.ts.map +1 -1
- package/dist/internal/remoteMcp.js +1 -5
- package/dist/internal/tools.d.ts +5 -4
- package/dist/internal/tools.d.ts.map +1 -1
- package/dist/internal/tools.js +4 -3
- package/dist/manifest.d.ts +34 -5
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +1 -1
- package/dist/server/attribution.d.ts +9 -0
- package/dist/server/attribution.d.ts.map +1 -1
- package/dist/server/attribution.js +7 -1
- package/dist/server/connectUrl.d.ts +4 -9
- package/dist/server/connectUrl.d.ts.map +1 -1
- package/dist/server/connectUrl.js +17 -14
- package/dist/server/eventsEndpoint.d.ts +48 -0
- package/dist/server/eventsEndpoint.d.ts.map +1 -0
- package/dist/server/eventsEndpoint.js +145 -0
- package/dist/server/everyApp.d.ts +15 -6
- package/dist/server/everyApp.d.ts.map +1 -1
- package/dist/server/everyApp.js +12 -3
- package/dist/server/index.d.ts +4 -3
- package/dist/server/index.d.ts.map +1 -1
- package/dist/server/index.js +2 -2
- package/dist/server/integrationFetch.d.ts +59 -71
- package/dist/server/integrationFetch.d.ts.map +1 -1
- package/dist/server/integrationFetch.js +117 -392
- package/dist/server/tools.d.ts +7 -2
- package/dist/server/tools.d.ts.map +1 -1
- package/dist/server/tools.js +2 -1
- package/dist/server/toolsEndpoint.d.ts +3 -1
- package/dist/server/toolsEndpoint.d.ts.map +1 -1
- package/dist/server/toolsEndpoint.js +9 -3
- package/dist/server/webhooks.d.ts +56 -0
- package/dist/server/webhooks.d.ts.map +1 -0
- package/dist/server/webhooks.js +205 -0
- package/package.json +1 -1
- package/dist/server/authorizeUrl.d.ts +0 -43
- package/dist/server/authorizeUrl.d.ts.map +0 -1
- package/dist/server/authorizeUrl.js +0 -106
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
2
|
+
* An OAuth provider's client as the gateway holds it in its settings
|
|
3
|
+
* (`everyapp secret set <CLIENT_ID> <CLIENT_SECRET>`); one an owner or
|
|
4
|
+
* admin pasted under Manage workspace → Providers is the gateway's own
|
|
5
|
+
* D1 row instead.
|
|
6
6
|
*/
|
|
7
|
-
import {
|
|
8
|
-
/** The largest token
|
|
7
|
+
import type { CapabilitySettings, OAuthClientCapability } from "./capabilities.js";
|
|
8
|
+
/** The largest token answer the gateway reads: real ones are a few kilobytes. */
|
|
9
9
|
export declare const OAUTH_TOKEN_BODY_LIMIT: number;
|
|
10
|
-
/** An OAuth client as the gateway
|
|
10
|
+
/** An OAuth client as the gateway holds it. */
|
|
11
11
|
export interface OAuthClientCredentials {
|
|
12
12
|
clientId: string;
|
|
13
13
|
/** Absent for a public client. */
|
|
@@ -18,44 +18,4 @@ export interface OAuthClientCredentials {
|
|
|
18
18
|
* it needs is set: the id, and the secret unless it is a public client.
|
|
19
19
|
*/
|
|
20
20
|
export declare function oauthClientCredentials(capability: OAuthClientCapability, settings: CapabilitySettings): OAuthClientCredentials | null;
|
|
21
|
-
/** A token request: where it goes, its headers, its (buffered) body. */
|
|
22
|
-
export interface TokenRequest {
|
|
23
|
-
url: URL;
|
|
24
|
-
headers: Headers;
|
|
25
|
-
body: string | null;
|
|
26
|
-
}
|
|
27
|
-
export type InjectedTokenRequest = ({
|
|
28
|
-
ok: true;
|
|
29
|
-
} & TokenRequest) | {
|
|
30
|
-
ok: false;
|
|
31
|
-
problem: string;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* `request` with `client` put where `rule` says (the form body or HTTP
|
|
35
|
-
* Basic), and every client credential the app sent removed wherever it
|
|
36
|
-
* was: the `Authorization` header, and `client_id`/`client_secret` (in any
|
|
37
|
-
* case) in the query string and the body. The body is re-serialised from
|
|
38
|
-
* its parsed values, so a crafted body can't carry a second secret past
|
|
39
|
-
* the parser. Token requests are form-encoded; anything else is refused.
|
|
40
|
-
*/
|
|
41
|
-
export declare function injectClientCredentials(request: TokenRequest, rule: OAuthTokenEndpoint, client: OAuthClientCredentials): InjectedTokenRequest;
|
|
42
|
-
/**
|
|
43
|
-
* The grants the gateway completes: each ends in a user's own tokens. The
|
|
44
|
-
* client-credentials grant, and anything else a network serves on the same
|
|
45
|
-
* endpoint, would mint a token for the gateway's own application instead,
|
|
46
|
-
* which on many providers manages the application's settings, its
|
|
47
|
-
* webhooks and every tenant's tokens.
|
|
48
|
-
*/
|
|
49
|
-
export declare const USER_BOUND_GRANT_TYPES: ReadonlySet<string>;
|
|
50
|
-
/**
|
|
51
|
-
* A token request's `grant_type` as the app sent it, from its body or query
|
|
52
|
-
* string, or null when it names none (Slack's code exchange). Never the
|
|
53
|
-
* request's other fields.
|
|
54
|
-
*/
|
|
55
|
-
export declare function requestedGrantType(request: TokenRequest): string | null;
|
|
56
|
-
/**
|
|
57
|
-
* A token request's `grant_type` for logs: one of the known grant types,
|
|
58
|
-
* `other`, or null when it names none.
|
|
59
|
-
*/
|
|
60
|
-
export declare function tokenGrantType(request: TokenRequest): string | null;
|
|
61
21
|
//# sourceMappingURL=oauthClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oauthClient.d.ts","sourceRoot":"","sources":["../../src/internal/oauthClient.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,
|
|
1
|
+
{"version":3,"file":"oauthClient.d.ts","sourceRoot":"","sources":["../../src/internal/oauthClient.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,iFAAiF;AACjF,eAAO,MAAM,sBAAsB,QAAY,CAAC;AAEhD,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,qBAAqB,EACjC,QAAQ,EAAE,kBAAkB,GAC3B,sBAAsB,GAAG,IAAI,CAQ/B"}
|
|
@@ -1,11 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The `oauth_client` capability's wire rules (docs/capabilities.md "OAuth
|
|
3
|
-
* clients"), shared by the gateway, which puts the operator's client on an
|
|
4
|
-
* app's token request, and the SDK's local-dev fallback, which puts the
|
|
5
|
-
* developer's own on it the same way.
|
|
6
|
-
*/
|
|
7
|
-
import { base64Utf8, } from "./capabilities.js";
|
|
8
|
-
/** The largest token request body the gateway reads: real ones are a few hundred bytes. */
|
|
1
|
+
/** The largest token answer the gateway reads: real ones are a few kilobytes. */
|
|
9
2
|
export const OAUTH_TOKEN_BODY_LIMIT = 64 * 1024;
|
|
10
3
|
/**
|
|
11
4
|
* The client `settings` hold for `capability`, or null until every setting
|
|
@@ -24,110 +17,3 @@ export function oauthClientCredentials(capability, settings) {
|
|
|
24
17
|
function settingValue(value) {
|
|
25
18
|
return typeof value === "string" && value.trim() ? value.trim() : undefined;
|
|
26
19
|
}
|
|
27
|
-
const FORM = "application/x-www-form-urlencoded";
|
|
28
|
-
const isCredential = (name) => ["client_id", "client_secret"].includes(name.toLowerCase());
|
|
29
|
-
/**
|
|
30
|
-
* `request` with `client` put where `rule` says (the form body or HTTP
|
|
31
|
-
* Basic), and every client credential the app sent removed wherever it
|
|
32
|
-
* was: the `Authorization` header, and `client_id`/`client_secret` (in any
|
|
33
|
-
* case) in the query string and the body. The body is re-serialised from
|
|
34
|
-
* its parsed values, so a crafted body can't carry a second secret past
|
|
35
|
-
* the parser. Token requests are form-encoded; anything else is refused.
|
|
36
|
-
*/
|
|
37
|
-
export function injectClientCredentials(request, rule, client) {
|
|
38
|
-
const fields = [
|
|
39
|
-
["client_id", client.clientId],
|
|
40
|
-
...(client.clientSecret
|
|
41
|
-
? [["client_secret", client.clientSecret]]
|
|
42
|
-
: []),
|
|
43
|
-
];
|
|
44
|
-
// The query keeps the app's other fields as they were sent.
|
|
45
|
-
const url = new URL(request.url);
|
|
46
|
-
url.search = url.search
|
|
47
|
-
.slice(1)
|
|
48
|
-
.split("&")
|
|
49
|
-
.filter((pair) => {
|
|
50
|
-
const [name] = new URLSearchParams(pair).keys();
|
|
51
|
-
return pair !== "" && !(name !== undefined && isCredential(name));
|
|
52
|
-
})
|
|
53
|
-
.join("&");
|
|
54
|
-
const headers = new Headers(request.headers);
|
|
55
|
-
headers.delete("authorization");
|
|
56
|
-
headers.delete("content-length");
|
|
57
|
-
if (rule.inject === "basic") {
|
|
58
|
-
headers.set("authorization", `Basic ${base64Utf8(`${client.clientId}:${client.clientSecret ?? ""}`)}`);
|
|
59
|
-
}
|
|
60
|
-
let body = request.body;
|
|
61
|
-
if (body === null || body === "") {
|
|
62
|
-
// Nothing the app sent; the form rule makes the body.
|
|
63
|
-
if (rule.inject === "form") {
|
|
64
|
-
headers.set("content-type", FORM);
|
|
65
|
-
body = new URLSearchParams(fields).toString();
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
else if (mediaType(headers.get("content-type")) === FORM) {
|
|
69
|
-
const params = new URLSearchParams(body);
|
|
70
|
-
for (const name of new Set([...params.keys()].filter(isCredential))) {
|
|
71
|
-
params.delete(name);
|
|
72
|
-
}
|
|
73
|
-
if (rule.inject === "form") {
|
|
74
|
-
for (const [name, value] of fields)
|
|
75
|
-
params.set(name, value);
|
|
76
|
-
}
|
|
77
|
-
body = params.toString();
|
|
78
|
-
}
|
|
79
|
-
else {
|
|
80
|
-
return {
|
|
81
|
-
ok: false,
|
|
82
|
-
problem: `A token request's body is form-encoded (${FORM}).`,
|
|
83
|
-
};
|
|
84
|
-
}
|
|
85
|
-
return { ok: true, url, headers, body };
|
|
86
|
-
}
|
|
87
|
-
/** The grant types logs may name; anything else is logged as `other`. */
|
|
88
|
-
const GRANT_TYPES = new Set([
|
|
89
|
-
"authorization_code",
|
|
90
|
-
"refresh_token",
|
|
91
|
-
"client_credentials",
|
|
92
|
-
"urn:ietf:params:oauth:grant-type:token-exchange",
|
|
93
|
-
]);
|
|
94
|
-
/**
|
|
95
|
-
* The grants the gateway completes: each ends in a user's own tokens. The
|
|
96
|
-
* client-credentials grant, and anything else a network serves on the same
|
|
97
|
-
* endpoint, would mint a token for the gateway's own application instead,
|
|
98
|
-
* which on many providers manages the application's settings, its
|
|
99
|
-
* webhooks and every tenant's tokens.
|
|
100
|
-
*/
|
|
101
|
-
export const USER_BOUND_GRANT_TYPES = new Set([
|
|
102
|
-
"authorization_code",
|
|
103
|
-
"refresh_token",
|
|
104
|
-
"urn:ietf:params:oauth:grant-type:token-exchange",
|
|
105
|
-
]);
|
|
106
|
-
/**
|
|
107
|
-
* A token request's `grant_type` as the app sent it, from its body or query
|
|
108
|
-
* string, or null when it names none (Slack's code exchange). Never the
|
|
109
|
-
* request's other fields.
|
|
110
|
-
*/
|
|
111
|
-
export function requestedGrantType(request) {
|
|
112
|
-
let value = null;
|
|
113
|
-
const type = mediaType(request.headers.get("content-type"));
|
|
114
|
-
if (request.body && type === FORM) {
|
|
115
|
-
value = new URLSearchParams(request.body).get("grant_type");
|
|
116
|
-
}
|
|
117
|
-
value ??= request.url.searchParams.get("grant_type");
|
|
118
|
-
return typeof value === "string" && value ? value : null;
|
|
119
|
-
}
|
|
120
|
-
/**
|
|
121
|
-
* A token request's `grant_type` for logs: one of the known grant types,
|
|
122
|
-
* `other`, or null when it names none.
|
|
123
|
-
*/
|
|
124
|
-
export function tokenGrantType(request) {
|
|
125
|
-
const value = requestedGrantType(request);
|
|
126
|
-
if (value === null)
|
|
127
|
-
return null;
|
|
128
|
-
return GRANT_TYPES.has(value) ? value : "other";
|
|
129
|
-
}
|
|
130
|
-
/** A Content-Type's media type, lowercased and without parameters. */
|
|
131
|
-
function mediaType(contentType) {
|
|
132
|
-
return (contentType ?? "").split(";")[0].trim().toLowerCase();
|
|
133
|
-
}
|
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* OAuth presets
|
|
3
|
-
* `
|
|
4
|
-
* for
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* social networks' presets carry the tag `social`.
|
|
2
|
+
* OAuth presets: ready `oauth2-user` specs, in the JSON shape `everyapp
|
|
3
|
+
* provider add` takes, for providers people most often want a "Connect"
|
|
4
|
+
* button for. A preset becomes a `providers` row when added (`everyapp
|
|
5
|
+
* provider add --oauth github-oauth`, the Admin dialog,
|
|
6
|
+
* `everyapp_provider_add` with `preset`), so an operator may `provider
|
|
7
|
+
* show` and edit a copy; nothing here is a hidden catalog entry, and no
|
|
8
|
+
* gateway reserves a preset's setting names until it is added. Google,
|
|
9
|
+
* Microsoft and Slack are built in (./oauthBuiltIns.ts) and are offered
|
|
10
|
+
* in the same picker.
|
|
12
11
|
*
|
|
13
|
-
* Each preset parses with `parseProviderSpec` (oauthPresets.test.ts)
|
|
12
|
+
* Each preset parses with `parseProviderSpec` (oauthPresets.test.ts) and
|
|
14
13
|
* names a console where the client is made, the API hosts the token is
|
|
15
|
-
* sent to, and
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
14
|
+
* sent to, and how the provider spells scopes. Which scopes a connection
|
|
15
|
+
* holds is each app's `everyapp.config.ts`, never the preset. Endpoints
|
|
16
|
+
* were checked against the providers' docs on 2026-10-25; only GitHub's
|
|
17
|
+
* and Google's have been tried against a live connect.
|
|
19
18
|
*/
|
|
20
19
|
import { type RegistrableCapability } from "./providerSpec.js";
|
|
21
20
|
/** A preset's spec as JSON: the shape of ./oauthSpec.ts. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oauthPresets.d.ts","sourceRoot":"","sources":["../../src/internal/oauthPresets.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"oauthPresets.d.ts","sourceRoot":"","sources":["../../src/internal/oauthPresets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAE3B,4DAA4D;AAC5D,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEhE,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAwNnE,CAAC;AAEF,0DAA0D;AAC1D,wBAAgB,cAAc,IAAI,MAAM,EAAE,CAEzC;AAED,sHAAsH;AACtH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,IAAI,CAUpE;AAED,+EAA+E;AAC/E,wBAAgB,eAAe,CAC7B,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,GACvD,OAAO,CAET"}
|