@eventcatalog/connectors 0.0.1 → 0.1.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 +28 -0
- package/README.md +14 -14
- package/dist/index.d.mts +2 -4
- package/dist/index.d.ts +2 -4
- package/dist/index.js +23 -11
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +23 -11
- package/dist/index.mjs.map +1 -1
- package/package.json +10 -10
package/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022-2026 boyney123
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
Note: Source code within `packages/core/eventcatalog/src/enterprise/` is
|
|
26
|
+
licensed under the EventCatalog Commercial License and is NOT covered by the
|
|
27
|
+
MIT License above. See `packages/core/eventcatalog/src/enterprise/LICENSE`
|
|
28
|
+
for the full terms.
|
package/README.md
CHANGED
|
@@ -4,14 +4,14 @@ Connectors for syncing external systems into EventCatalog.
|
|
|
4
4
|
|
|
5
5
|
```js
|
|
6
6
|
// eventcatalog.config.js
|
|
7
|
-
import { githubDirectory } from
|
|
7
|
+
import { githubDirectory } from "@eventcatalog/connectors";
|
|
8
8
|
|
|
9
9
|
export default {
|
|
10
10
|
directory: {
|
|
11
11
|
sources: [
|
|
12
12
|
githubDirectory({
|
|
13
|
-
org:
|
|
14
|
-
teams:
|
|
13
|
+
org: "acme",
|
|
14
|
+
teams: ["platform", "architecture"],
|
|
15
15
|
users: true,
|
|
16
16
|
token: process.env.GITHUB_TOKEN,
|
|
17
17
|
}),
|
|
@@ -25,20 +25,20 @@ External directory sources require EventCatalog Scale when loaded by EventCatalo
|
|
|
25
25
|
Custom directory sources can use the same contract:
|
|
26
26
|
|
|
27
27
|
```js
|
|
28
|
-
import { defineDirectorySource } from
|
|
28
|
+
import { defineDirectorySource } from "@eventcatalog/connectors";
|
|
29
29
|
|
|
30
30
|
export const companyDirectory = defineDirectorySource({
|
|
31
|
-
type:
|
|
32
|
-
name:
|
|
31
|
+
type: "directory",
|
|
32
|
+
name: "company-directory",
|
|
33
33
|
|
|
34
34
|
async loadTeams() {
|
|
35
35
|
return [
|
|
36
36
|
{
|
|
37
|
-
id:
|
|
38
|
-
name:
|
|
39
|
-
members: [
|
|
37
|
+
id: "platform",
|
|
38
|
+
name: "Platform",
|
|
39
|
+
members: ["alice"],
|
|
40
40
|
source: {
|
|
41
|
-
provider:
|
|
41
|
+
provider: "company-directory",
|
|
42
42
|
},
|
|
43
43
|
},
|
|
44
44
|
];
|
|
@@ -47,11 +47,11 @@ export const companyDirectory = defineDirectorySource({
|
|
|
47
47
|
async loadUsers() {
|
|
48
48
|
return [
|
|
49
49
|
{
|
|
50
|
-
id:
|
|
51
|
-
name:
|
|
52
|
-
avatarUrl:
|
|
50
|
+
id: "alice",
|
|
51
|
+
name: "Alice",
|
|
52
|
+
avatarUrl: "https://example.com/alice.png",
|
|
53
53
|
source: {
|
|
54
|
-
provider:
|
|
54
|
+
provider: "company-directory",
|
|
55
55
|
},
|
|
56
56
|
},
|
|
57
57
|
];
|
package/dist/index.d.mts
CHANGED
|
@@ -53,11 +53,9 @@ type DirectoryTeam = {
|
|
|
53
53
|
* `.eventcatalog/store/directory.json` file for SDK/editor reads.
|
|
54
54
|
*/
|
|
55
55
|
type DirectorySource = {
|
|
56
|
-
type:
|
|
56
|
+
type: "directory";
|
|
57
57
|
/** Stable source identifier, usually `<provider>:<account-or-org>`. */
|
|
58
58
|
name: string;
|
|
59
|
-
/** Optional stable cache key for this source configuration. */
|
|
60
|
-
cacheKey?: string;
|
|
61
59
|
/** Load users from the external directory. */
|
|
62
60
|
loadUsers?: () => Promise<DirectoryUser[]>;
|
|
63
61
|
/** Load teams from the external directory. */
|
|
@@ -71,7 +69,7 @@ declare const defineDirectorySource: <TSource extends DirectorySource>(source: T
|
|
|
71
69
|
type GitHubDirectoryOptions = {
|
|
72
70
|
org: string;
|
|
73
71
|
token?: string;
|
|
74
|
-
teams
|
|
72
|
+
teams: string[];
|
|
75
73
|
users?: boolean;
|
|
76
74
|
baseUrl?: string;
|
|
77
75
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -53,11 +53,9 @@ type DirectoryTeam = {
|
|
|
53
53
|
* `.eventcatalog/store/directory.json` file for SDK/editor reads.
|
|
54
54
|
*/
|
|
55
55
|
type DirectorySource = {
|
|
56
|
-
type:
|
|
56
|
+
type: "directory";
|
|
57
57
|
/** Stable source identifier, usually `<provider>:<account-or-org>`. */
|
|
58
58
|
name: string;
|
|
59
|
-
/** Optional stable cache key for this source configuration. */
|
|
60
|
-
cacheKey?: string;
|
|
61
59
|
/** Load users from the external directory. */
|
|
62
60
|
loadUsers?: () => Promise<DirectoryUser[]>;
|
|
63
61
|
/** Load teams from the external directory. */
|
|
@@ -71,7 +69,7 @@ declare const defineDirectorySource: <TSource extends DirectorySource>(source: T
|
|
|
71
69
|
type GitHubDirectoryOptions = {
|
|
72
70
|
org: string;
|
|
73
71
|
token?: string;
|
|
74
|
-
teams
|
|
72
|
+
teams: string[];
|
|
75
73
|
users?: boolean;
|
|
76
74
|
baseUrl?: string;
|
|
77
75
|
};
|
package/dist/index.js
CHANGED
|
@@ -31,6 +31,11 @@ var defineDirectorySource = (source) => source;
|
|
|
31
31
|
// src/github-directory.ts
|
|
32
32
|
var GITHUB_API_VERSION = "2022-11-28";
|
|
33
33
|
var githubDirectory = (options) => {
|
|
34
|
+
if (!Array.isArray(options.teams) || options.teams.length === 0) {
|
|
35
|
+
throw new Error(
|
|
36
|
+
'GitHub directory connector requires at least one team slug. Set teams: ["platform"].'
|
|
37
|
+
);
|
|
38
|
+
}
|
|
34
39
|
let cachedData;
|
|
35
40
|
const load = () => {
|
|
36
41
|
cachedData = cachedData ?? loadGitHubDirectory(options);
|
|
@@ -39,7 +44,6 @@ var githubDirectory = (options) => {
|
|
|
39
44
|
return defineDirectorySource({
|
|
40
45
|
type: "directory",
|
|
41
46
|
name: `github:${options.org}`,
|
|
42
|
-
cacheKey: createGitHubDirectoryCacheKey(options),
|
|
43
47
|
loadTeams: async () => {
|
|
44
48
|
const data = await load();
|
|
45
49
|
return data.teams;
|
|
@@ -50,12 +54,6 @@ var githubDirectory = (options) => {
|
|
|
50
54
|
}
|
|
51
55
|
});
|
|
52
56
|
};
|
|
53
|
-
var createGitHubDirectoryCacheKey = (options) => {
|
|
54
|
-
const teams = options.teams === true || options.teams === void 0 ? "all" : [...options.teams].sort().join(",");
|
|
55
|
-
const users = options.users !== false ? "true" : "false";
|
|
56
|
-
const baseUrl = options.baseUrl ?? "https://api.github.com";
|
|
57
|
-
return `github:${baseUrl}:${options.org}:teams=${teams}:users=${users}`;
|
|
58
|
-
};
|
|
59
57
|
var loadGitHubDirectory = async (options) => {
|
|
60
58
|
const teams = await loadGitHubTeams(options);
|
|
61
59
|
const shouldLoadUsers = options.users !== false;
|
|
@@ -80,9 +78,11 @@ var loadGitHubDirectory = async (options) => {
|
|
|
80
78
|
};
|
|
81
79
|
};
|
|
82
80
|
var loadGitHubTeams = async (options) => {
|
|
83
|
-
const teams =
|
|
84
|
-
const
|
|
85
|
-
|
|
81
|
+
const teams = [];
|
|
82
|
+
for (const teamSlug of options.teams) {
|
|
83
|
+
teams.push(await loadGitHubTeam(options, teamSlug));
|
|
84
|
+
}
|
|
85
|
+
return teams.map((team) => ({
|
|
86
86
|
id: team.slug,
|
|
87
87
|
name: team.name,
|
|
88
88
|
summary: team.description ?? void 0,
|
|
@@ -94,6 +94,16 @@ var loadGitHubTeams = async (options) => {
|
|
|
94
94
|
}
|
|
95
95
|
}));
|
|
96
96
|
};
|
|
97
|
+
var loadGitHubTeam = async (options, teamSlug) => {
|
|
98
|
+
const response = await githubRequest(
|
|
99
|
+
options,
|
|
100
|
+
buildGitHubUrl(
|
|
101
|
+
options,
|
|
102
|
+
`/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}`
|
|
103
|
+
)
|
|
104
|
+
);
|
|
105
|
+
return response.data;
|
|
106
|
+
};
|
|
97
107
|
var loadGitHubTeamMembers = async (options, teamSlug) => {
|
|
98
108
|
const members = await paginate(
|
|
99
109
|
options,
|
|
@@ -154,7 +164,9 @@ var githubRequest = async (options, url) => {
|
|
|
154
164
|
});
|
|
155
165
|
if (!response.ok) {
|
|
156
166
|
const message = await response.text();
|
|
157
|
-
throw new Error(
|
|
167
|
+
throw new Error(
|
|
168
|
+
`GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`
|
|
169
|
+
);
|
|
158
170
|
}
|
|
159
171
|
return {
|
|
160
172
|
data: await response.json(),
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/types.ts","../src/github-directory.ts"],"sourcesContent":["export { githubDirectory } from './github-directory';\nexport { defineDirectorySource } from './types';\nexport type { DirectoryEntrySource, DirectorySource, DirectoryTeam, DirectoryUser } from './types';\n","/**\n * Describes where a generated directory entry came from.\n *\n * EventCatalog uses the provider to show source badges and to treat generated\n * resources as externally managed.\n */\nexport type DirectoryEntrySource = {\n /** Provider identifier, for example `github`, `okta`, or `ldap`. */\n provider: string;\n /** Optional provider-specific identifier for the external resource. */\n id?: string;\n /** Optional URL back to the resource in the external provider. */\n url?: string;\n [key: string]: unknown;\n};\n\n/**\n * User returned by a directory source.\n *\n * Directory users are synced as read-only EventCatalog users and can be\n * referenced by teams through their `id`.\n */\nexport type DirectoryUser = {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Team returned by a directory source.\n *\n * Directory teams are synced as read-only EventCatalog teams.\n */\nexport type DirectoryTeam = {\n id: string;\n name: string;\n summary?: string;\n /** User IDs for members of this team. */\n members?: string[];\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Loads users and/or teams from an external directory provider.\n *\n * EventCatalog calls these loaders during content sync, writes the returned\n * entries into Astro collections, and mirrors them into the generated\n * `.eventcatalog/store/directory.json` file for SDK/editor reads.\n */\nexport type DirectorySource = {\n type: 'directory';\n /** Stable source identifier, usually `<provider>:<account-or-org>`. */\n name: string;\n /** Optional stable cache key for this source configuration. */\n cacheKey?: string;\n /** Load users from the external directory. */\n loadUsers?: () => Promise<DirectoryUser[]>;\n /** Load teams from the external directory. */\n loadTeams?: () => Promise<DirectoryTeam[]>;\n};\n\n/**\n * Defines a custom directory source with type inference for connector authors.\n */\nexport const defineDirectorySource = <TSource extends DirectorySource>(source: TSource) => source;\n","import { defineDirectorySource, type DirectorySource, type DirectoryTeam, type DirectoryUser } from './types';\n\ntype GitHubDirectoryOptions = {\n org: string;\n token?: string;\n teams?: true | string[];\n users?: boolean;\n baseUrl?: string;\n};\n\ntype GitHubTeam = {\n id: number;\n name: string;\n slug: string;\n description: string | null;\n html_url: string;\n};\n\ntype GitHubUser = {\n id: number;\n login: string;\n avatar_url: string;\n html_url: string;\n};\n\ntype GitHubDirectoryData = {\n teams: DirectoryTeam[];\n users: DirectoryUser[];\n};\n\nconst GITHUB_API_VERSION = '2022-11-28';\n\nexport const githubDirectory = (options: GitHubDirectoryOptions): DirectorySource => {\n let cachedData: Promise<GitHubDirectoryData> | undefined;\n\n const load = () => {\n cachedData = cachedData ?? loadGitHubDirectory(options);\n return cachedData;\n };\n\n return defineDirectorySource({\n type: 'directory',\n name: `github:${options.org}`,\n cacheKey: createGitHubDirectoryCacheKey(options),\n loadTeams: async () => {\n const data = await load();\n return data.teams;\n },\n loadUsers: async () => {\n const data = await load();\n return data.users;\n },\n });\n};\n\nconst createGitHubDirectoryCacheKey = (options: GitHubDirectoryOptions) => {\n const teams = options.teams === true || options.teams === undefined ? 'all' : [...options.teams].sort().join(',');\n const users = options.users !== false ? 'true' : 'false';\n const baseUrl = options.baseUrl ?? 'https://api.github.com';\n\n return `github:${baseUrl}:${options.org}:teams=${teams}:users=${users}`;\n};\n\nconst loadGitHubDirectory = async (options: GitHubDirectoryOptions): Promise<GitHubDirectoryData> => {\n const teams = await loadGitHubTeams(options);\n const shouldLoadUsers = options.users !== false;\n\n if (!shouldLoadUsers) {\n return { teams, users: [] };\n }\n\n const usersById = new Map<string, DirectoryUser>();\n const teamsWithMembers: DirectoryTeam[] = [];\n\n for (const team of teams) {\n const members = await loadGitHubTeamMembers(options, team.id);\n\n for (const member of members) {\n usersById.set(member.id, member);\n }\n\n teamsWithMembers.push({\n ...team,\n members: members.map((member) => member.id),\n });\n }\n\n return {\n teams: teamsWithMembers,\n users: Array.from(usersById.values()),\n };\n};\n\nconst loadGitHubTeams = async (options: GitHubDirectoryOptions): Promise<DirectoryTeam[]> => {\n const teams = await paginate<GitHubTeam>(options, `/orgs/${encodeURIComponent(options.org)}/teams`);\n const configuredTeams = options.teams === undefined || options.teams === true ? undefined : new Set(options.teams);\n\n return teams\n .filter((team) => !configuredTeams || configuredTeams.has(team.slug))\n .map((team) => ({\n id: team.slug,\n name: team.name,\n summary: team.description ?? undefined,\n markdown: createGitHubSyncedMarkdown('team', team.html_url),\n source: {\n provider: 'github',\n id: String(team.id),\n url: team.html_url,\n },\n }));\n};\n\nconst loadGitHubTeamMembers = async (options: GitHubDirectoryOptions, teamSlug: string): Promise<DirectoryUser[]> => {\n const members = await paginate<GitHubUser>(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}/members`\n );\n\n return members.map((member) => ({\n id: member.login,\n name: member.login,\n avatarUrl: member.avatar_url,\n markdown: createGitHubSyncedMarkdown('user', member.html_url),\n source: {\n provider: 'github',\n id: String(member.id),\n url: member.html_url,\n },\n }));\n};\n\nconst createGitHubSyncedMarkdown = (type: 'team' | 'user', url: string) => {\n if (type === 'team') {\n return [\n ':::note',\n 'This team is synced from GitHub and is read-only in EventCatalog.',\n '',\n 'Manage the team and its members in GitHub.',\n '',\n `[View team on GitHub](${url})`,\n ':::',\n ].join('\\n');\n }\n\n return [\n ':::note',\n 'This user is synced from GitHub and is read-only in EventCatalog.',\n '',\n 'Manage profile details and team membership in GitHub.',\n '',\n `[View user on GitHub](${url})`,\n ':::',\n ].join('\\n');\n};\n\nconst paginate = async <T>(options: GitHubDirectoryOptions, pathname: string): Promise<T[]> => {\n const results: T[] = [];\n let url: string | undefined = buildGitHubUrl(options, pathname);\n\n while (url) {\n const response = await githubRequest<T[]>(options, url);\n results.push(...response.data);\n url = getNextPageUrl(response.headers.get('link'));\n }\n\n return results;\n};\n\nconst githubRequest = async <T>(\n options: GitHubDirectoryOptions,\n url: string\n): Promise<{ data: T; headers: Headers }> => {\n const response = await fetch(url, {\n headers: {\n accept: 'application/vnd.github+json',\n 'x-github-api-version': GITHUB_API_VERSION,\n 'user-agent': '@eventcatalog/connectors',\n ...(options.token ? { authorization: `Bearer ${options.token}` } : {}),\n },\n });\n\n if (!response.ok) {\n const message = await response.text();\n throw new Error(`GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`);\n }\n\n return {\n data: (await response.json()) as T,\n headers: response.headers,\n };\n};\n\nconst buildGitHubUrl = (options: GitHubDirectoryOptions, pathname: string) => {\n const baseUrl = options.baseUrl ?? 'https://api.github.com';\n const normalizedBaseUrl = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;\n const normalizedPathname = pathname.replace(/^\\//u, '');\n const url = new URL(normalizedPathname, normalizedBaseUrl);\n url.searchParams.set('per_page', '100');\n return url.toString();\n};\n\nconst getNextPageUrl = (linkHeader: string | null) => {\n if (!linkHeader) return undefined;\n\n const nextLink = linkHeader.split(',').find((link) => link.includes('rel=\"next\"'));\n const match = nextLink?.match(/<([^>]+)>/);\n\n return match?.[1];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACwEO,IAAM,wBAAwB,CAAkC,WAAoB;;;AC1C3F,IAAM,qBAAqB;AAEpB,IAAM,kBAAkB,CAAC,YAAqD;AACnF,MAAI;AAEJ,QAAM,OAAO,MAAM;AACjB,iBAAa,cAAc,oBAAoB,OAAO;AACtD,WAAO;AAAA,EACT;AAEA,SAAO,sBAAsB;AAAA,IAC3B,MAAM;AAAA,IACN,MAAM,UAAU,QAAQ,GAAG;AAAA,IAC3B,UAAU,8BAA8B,OAAO;AAAA,IAC/C,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,IACA,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,EACF,CAAC;AACH;AAEA,IAAM,gCAAgC,CAAC,YAAoC;AACzE,QAAM,QAAQ,QAAQ,UAAU,QAAQ,QAAQ,UAAU,SAAY,QAAQ,CAAC,GAAG,QAAQ,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG;AAChH,QAAM,QAAQ,QAAQ,UAAU,QAAQ,SAAS;AACjD,QAAM,UAAU,QAAQ,WAAW;AAEnC,SAAO,UAAU,OAAO,IAAI,QAAQ,GAAG,UAAU,KAAK,UAAU,KAAK;AACvE;AAEA,IAAM,sBAAsB,OAAO,YAAkE;AACnG,QAAM,QAAQ,MAAM,gBAAgB,OAAO;AAC3C,QAAM,kBAAkB,QAAQ,UAAU;AAE1C,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,OAAO,OAAO,CAAC,EAAE;AAAA,EAC5B;AAEA,QAAM,YAAY,oBAAI,IAA2B;AACjD,QAAM,mBAAoC,CAAC;AAE3C,aAAW,QAAQ,OAAO;AACxB,UAAM,UAAU,MAAM,sBAAsB,SAAS,KAAK,EAAE;AAE5D,eAAW,UAAU,SAAS;AAC5B,gBAAU,IAAI,OAAO,IAAI,MAAM;AAAA,IACjC;AAEA,qBAAiB,KAAK;AAAA,MACpB,GAAG;AAAA,MACH,SAAS,QAAQ,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAC5C,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAO;AAAA,IACP,OAAO,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,EACtC;AACF;AAEA,IAAM,kBAAkB,OAAO,YAA8D;AAC3F,QAAM,QAAQ,MAAM,SAAqB,SAAS,SAAS,mBAAmB,QAAQ,GAAG,CAAC,QAAQ;AAClG,QAAM,kBAAkB,QAAQ,UAAU,UAAa,QAAQ,UAAU,OAAO,SAAY,IAAI,IAAI,QAAQ,KAAK;AAEjH,SAAO,MACJ,OAAO,CAAC,SAAS,CAAC,mBAAmB,gBAAgB,IAAI,KAAK,IAAI,CAAC,EACnE,IAAI,CAAC,UAAU;AAAA,IACd,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,SAAS,KAAK,eAAe;AAAA,IAC7B,UAAU,2BAA2B,QAAQ,KAAK,QAAQ;AAAA,IAC1D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,KAAK,EAAE;AAAA,MAClB,KAAK,KAAK;AAAA,IACZ;AAAA,EACF,EAAE;AACN;AAEA,IAAM,wBAAwB,OAAO,SAAiC,aAA+C;AACnH,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,EAChF;AAEA,SAAO,QAAQ,IAAI,CAAC,YAAY;AAAA,IAC9B,IAAI,OAAO;AAAA,IACX,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,UAAU,2BAA2B,QAAQ,OAAO,QAAQ;AAAA,IAC5D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,OAAO,EAAE;AAAA,MACpB,KAAK,OAAO;AAAA,IACd;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,6BAA6B,CAAC,MAAuB,QAAgB;AACzE,MAAI,SAAS,QAAQ;AACnB,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,yBAAyB,GAAG;AAAA,MAC5B;AAAA,IACF,EAAE,KAAK,IAAI;AAAA,EACb;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,yBAAyB,GAAG;AAAA,IAC5B;AAAA,EACF,EAAE,KAAK,IAAI;AACb;AAEA,IAAM,WAAW,OAAU,SAAiC,aAAmC;AAC7F,QAAM,UAAe,CAAC;AACtB,MAAI,MAA0B,eAAe,SAAS,QAAQ;AAE9D,SAAO,KAAK;AACV,UAAM,WAAW,MAAM,cAAmB,SAAS,GAAG;AACtD,YAAQ,KAAK,GAAG,SAAS,IAAI;AAC7B,UAAM,eAAe,SAAS,QAAQ,IAAI,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEA,IAAM,gBAAgB,OACpB,SACA,QAC2C;AAC3C,QAAM,WAAW,MAAM,MAAM,KAAK;AAAA,IAChC,SAAS;AAAA,MACP,QAAQ;AAAA,MACR,wBAAwB;AAAA,MACxB,cAAc;AAAA,MACd,GAAI,QAAQ,QAAQ,EAAE,eAAe,UAAU,QAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtE;AAAA,EACF,CAAC;AAED,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,UAAU,MAAM,SAAS,KAAK;AACpC,UAAM,IAAI,MAAM,sCAAsC,SAAS,MAAM,IAAI,SAAS,UAAU,MAAM,OAAO,EAAE;AAAA,EAC7G;AAEA,SAAO;AAAA,IACL,MAAO,MAAM,SAAS,KAAK;AAAA,IAC3B,SAAS,SAAS;AAAA,EACpB;AACF;AAEA,IAAM,iBAAiB,CAAC,SAAiC,aAAqB;AAC5E,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,oBAAoB,QAAQ,SAAS,GAAG,IAAI,UAAU,GAAG,OAAO;AACtE,QAAM,qBAAqB,SAAS,QAAQ,QAAQ,EAAE;AACtD,QAAM,MAAM,IAAI,IAAI,oBAAoB,iBAAiB;AACzD,MAAI,aAAa,IAAI,YAAY,KAAK;AACtC,SAAO,IAAI,SAAS;AACtB;AAEA,IAAM,iBAAiB,CAAC,eAA8B;AACpD,MAAI,CAAC,WAAY,QAAO;AAExB,QAAM,WAAW,WAAW,MAAM,GAAG,EAAE,KAAK,CAAC,SAAS,KAAK,SAAS,YAAY,CAAC;AACjF,QAAM,QAAQ,UAAU,MAAM,WAAW;AAEzC,SAAO,QAAQ,CAAC;AAClB;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/types.ts","../src/github-directory.ts"],"sourcesContent":["export { githubDirectory } from \"./github-directory\";\nexport { defineDirectorySource } from \"./types\";\nexport type {\n DirectoryEntrySource,\n DirectorySource,\n DirectoryTeam,\n DirectoryUser,\n} from \"./types\";\n","/**\n * Describes where a generated directory entry came from.\n *\n * EventCatalog uses the provider to show source badges and to treat generated\n * resources as externally managed.\n */\nexport type DirectoryEntrySource = {\n /** Provider identifier, for example `github`, `okta`, or `ldap`. */\n provider: string;\n /** Optional provider-specific identifier for the external resource. */\n id?: string;\n /** Optional URL back to the resource in the external provider. */\n url?: string;\n [key: string]: unknown;\n};\n\n/**\n * User returned by a directory source.\n *\n * Directory users are synced as read-only EventCatalog users and can be\n * referenced by teams through their `id`.\n */\nexport type DirectoryUser = {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Team returned by a directory source.\n *\n * Directory teams are synced as read-only EventCatalog teams.\n */\nexport type DirectoryTeam = {\n id: string;\n name: string;\n summary?: string;\n /** User IDs for members of this team. */\n members?: string[];\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Loads users and/or teams from an external directory provider.\n *\n * EventCatalog calls these loaders during content sync, writes the returned\n * entries into Astro collections, and mirrors them into the generated\n * `.eventcatalog/store/directory.json` file for SDK/editor reads.\n */\nexport type DirectorySource = {\n type: \"directory\";\n /** Stable source identifier, usually `<provider>:<account-or-org>`. */\n name: string;\n /** Load users from the external directory. */\n loadUsers?: () => Promise<DirectoryUser[]>;\n /** Load teams from the external directory. */\n loadTeams?: () => Promise<DirectoryTeam[]>;\n};\n\n/**\n * Defines a custom directory source with type inference for connector authors.\n */\nexport const defineDirectorySource = <TSource extends DirectorySource>(\n source: TSource,\n) => source;\n","import {\n defineDirectorySource,\n type DirectorySource,\n type DirectoryTeam,\n type DirectoryUser,\n} from \"./types\";\n\ntype GitHubDirectoryOptions = {\n org: string;\n token?: string;\n teams: string[];\n users?: boolean;\n baseUrl?: string;\n};\n\ntype GitHubTeam = {\n id: number;\n name: string;\n slug: string;\n description: string | null;\n html_url: string;\n};\n\ntype GitHubUser = {\n id: number;\n login: string;\n avatar_url: string;\n html_url: string;\n};\n\ntype GitHubDirectoryData = {\n teams: DirectoryTeam[];\n users: DirectoryUser[];\n};\n\nconst GITHUB_API_VERSION = \"2022-11-28\";\n\nexport const githubDirectory = (\n options: GitHubDirectoryOptions,\n): DirectorySource => {\n if (!Array.isArray(options.teams) || options.teams.length === 0) {\n throw new Error(\n 'GitHub directory connector requires at least one team slug. Set teams: [\"platform\"].',\n );\n }\n\n let cachedData: Promise<GitHubDirectoryData> | undefined;\n\n const load = () => {\n cachedData = cachedData ?? loadGitHubDirectory(options);\n return cachedData;\n };\n\n return defineDirectorySource({\n type: \"directory\",\n name: `github:${options.org}`,\n loadTeams: async () => {\n const data = await load();\n return data.teams;\n },\n loadUsers: async () => {\n const data = await load();\n return data.users;\n },\n });\n};\n\nconst loadGitHubDirectory = async (\n options: GitHubDirectoryOptions,\n): Promise<GitHubDirectoryData> => {\n const teams = await loadGitHubTeams(options);\n const shouldLoadUsers = options.users !== false;\n\n if (!shouldLoadUsers) {\n return { teams, users: [] };\n }\n\n const usersById = new Map<string, DirectoryUser>();\n const teamsWithMembers: DirectoryTeam[] = [];\n\n for (const team of teams) {\n const members = await loadGitHubTeamMembers(options, team.id);\n\n for (const member of members) {\n usersById.set(member.id, member);\n }\n\n teamsWithMembers.push({\n ...team,\n members: members.map((member) => member.id),\n });\n }\n\n return {\n teams: teamsWithMembers,\n users: Array.from(usersById.values()),\n };\n};\n\nconst loadGitHubTeams = async (\n options: GitHubDirectoryOptions,\n): Promise<DirectoryTeam[]> => {\n const teams: GitHubTeam[] = [];\n\n for (const teamSlug of options.teams) {\n teams.push(await loadGitHubTeam(options, teamSlug));\n }\n\n return teams.map((team) => ({\n id: team.slug,\n name: team.name,\n summary: team.description ?? undefined,\n markdown: createGitHubSyncedMarkdown(\"team\", team.html_url),\n source: {\n provider: \"github\",\n id: String(team.id),\n url: team.html_url,\n },\n }));\n};\n\nconst loadGitHubTeam = async (\n options: GitHubDirectoryOptions,\n teamSlug: string,\n) => {\n const response = await githubRequest<GitHubTeam>(\n options,\n buildGitHubUrl(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}`,\n ),\n );\n\n return response.data;\n};\n\nconst loadGitHubTeamMembers = async (\n options: GitHubDirectoryOptions,\n teamSlug: string,\n): Promise<DirectoryUser[]> => {\n const members = await paginate<GitHubUser>(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}/members`,\n );\n\n return members.map((member) => ({\n id: member.login,\n name: member.login,\n avatarUrl: member.avatar_url,\n markdown: createGitHubSyncedMarkdown(\"user\", member.html_url),\n source: {\n provider: \"github\",\n id: String(member.id),\n url: member.html_url,\n },\n }));\n};\n\nconst createGitHubSyncedMarkdown = (type: \"team\" | \"user\", url: string) => {\n if (type === \"team\") {\n return [\n \":::note\",\n \"This team is synced from GitHub and is read-only in EventCatalog.\",\n \"\",\n \"Manage the team and its members in GitHub.\",\n \"\",\n `[View team on GitHub](${url})`,\n \":::\",\n ].join(\"\\n\");\n }\n\n return [\n \":::note\",\n \"This user is synced from GitHub and is read-only in EventCatalog.\",\n \"\",\n \"Manage profile details and team membership in GitHub.\",\n \"\",\n `[View user on GitHub](${url})`,\n \":::\",\n ].join(\"\\n\");\n};\n\nconst paginate = async <T>(\n options: GitHubDirectoryOptions,\n pathname: string,\n): Promise<T[]> => {\n const results: T[] = [];\n let url: string | undefined = buildGitHubUrl(options, pathname);\n\n while (url) {\n const response = await githubRequest<T[]>(options, url);\n results.push(...response.data);\n url = getNextPageUrl(response.headers.get(\"link\"));\n }\n\n return results;\n};\n\nconst githubRequest = async <T>(\n options: GitHubDirectoryOptions,\n url: string,\n): Promise<{ data: T; headers: Headers }> => {\n const response = await fetch(url, {\n headers: {\n accept: \"application/vnd.github+json\",\n \"x-github-api-version\": GITHUB_API_VERSION,\n \"user-agent\": \"@eventcatalog/connectors\",\n ...(options.token ? { authorization: `Bearer ${options.token}` } : {}),\n },\n });\n\n if (!response.ok) {\n const message = await response.text();\n throw new Error(\n `GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`,\n );\n }\n\n return {\n data: (await response.json()) as T,\n headers: response.headers,\n };\n};\n\nconst buildGitHubUrl = (options: GitHubDirectoryOptions, pathname: string) => {\n const baseUrl = options.baseUrl ?? \"https://api.github.com\";\n const normalizedBaseUrl = baseUrl.endsWith(\"/\") ? baseUrl : `${baseUrl}/`;\n const normalizedPathname = pathname.replace(/^\\//u, \"\");\n const url = new URL(normalizedPathname, normalizedBaseUrl);\n url.searchParams.set(\"per_page\", \"100\");\n return url.toString();\n};\n\nconst getNextPageUrl = (linkHeader: string | null) => {\n if (!linkHeader) return undefined;\n\n const nextLink = linkHeader\n .split(\",\")\n .find((link) => link.includes('rel=\"next\"'));\n const match = nextLink?.match(/<([^>]+)>/);\n\n return match?.[1];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACsEO,IAAM,wBAAwB,CACnC,WACG;;;ACrCL,IAAM,qBAAqB;AAEpB,IAAM,kBAAkB,CAC7B,YACoB;AACpB,MAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,KAAK,QAAQ,MAAM,WAAW,GAAG;AAC/D,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AAEJ,QAAM,OAAO,MAAM;AACjB,iBAAa,cAAc,oBAAoB,OAAO;AACtD,WAAO;AAAA,EACT;AAEA,SAAO,sBAAsB;AAAA,IAC3B,MAAM;AAAA,IACN,MAAM,UAAU,QAAQ,GAAG;AAAA,IAC3B,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,IACA,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,EACF,CAAC;AACH;AAEA,IAAM,sBAAsB,OAC1B,YACiC;AACjC,QAAM,QAAQ,MAAM,gBAAgB,OAAO;AAC3C,QAAM,kBAAkB,QAAQ,UAAU;AAE1C,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,OAAO,OAAO,CAAC,EAAE;AAAA,EAC5B;AAEA,QAAM,YAAY,oBAAI,IAA2B;AACjD,QAAM,mBAAoC,CAAC;AAE3C,aAAW,QAAQ,OAAO;AACxB,UAAM,UAAU,MAAM,sBAAsB,SAAS,KAAK,EAAE;AAE5D,eAAW,UAAU,SAAS;AAC5B,gBAAU,IAAI,OAAO,IAAI,MAAM;AAAA,IACjC;AAEA,qBAAiB,KAAK;AAAA,MACpB,GAAG;AAAA,MACH,SAAS,QAAQ,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAC5C,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAO;AAAA,IACP,OAAO,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,EACtC;AACF;AAEA,IAAM,kBAAkB,OACtB,YAC6B;AAC7B,QAAM,QAAsB,CAAC;AAE7B,aAAW,YAAY,QAAQ,OAAO;AACpC,UAAM,KAAK,MAAM,eAAe,SAAS,QAAQ,CAAC;AAAA,EACpD;AAEA,SAAO,MAAM,IAAI,CAAC,UAAU;AAAA,IAC1B,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,SAAS,KAAK,eAAe;AAAA,IAC7B,UAAU,2BAA2B,QAAQ,KAAK,QAAQ;AAAA,IAC1D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,KAAK,EAAE;AAAA,MAClB,KAAK,KAAK;AAAA,IACZ;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,iBAAiB,OACrB,SACA,aACG;AACH,QAAM,WAAW,MAAM;AAAA,IACrB;AAAA,IACA;AAAA,MACE;AAAA,MACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,IAChF;AAAA,EACF;AAEA,SAAO,SAAS;AAClB;AAEA,IAAM,wBAAwB,OAC5B,SACA,aAC6B;AAC7B,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,EAChF;AAEA,SAAO,QAAQ,IAAI,CAAC,YAAY;AAAA,IAC9B,IAAI,OAAO;AAAA,IACX,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,UAAU,2BAA2B,QAAQ,OAAO,QAAQ;AAAA,IAC5D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,OAAO,EAAE;AAAA,MACpB,KAAK,OAAO;AAAA,IACd;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,6BAA6B,CAAC,MAAuB,QAAgB;AACzE,MAAI,SAAS,QAAQ;AACnB,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,yBAAyB,GAAG;AAAA,MAC5B;AAAA,IACF,EAAE,KAAK,IAAI;AAAA,EACb;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,yBAAyB,GAAG;AAAA,IAC5B;AAAA,EACF,EAAE,KAAK,IAAI;AACb;AAEA,IAAM,WAAW,OACf,SACA,aACiB;AACjB,QAAM,UAAe,CAAC;AACtB,MAAI,MAA0B,eAAe,SAAS,QAAQ;AAE9D,SAAO,KAAK;AACV,UAAM,WAAW,MAAM,cAAmB,SAAS,GAAG;AACtD,YAAQ,KAAK,GAAG,SAAS,IAAI;AAC7B,UAAM,eAAe,SAAS,QAAQ,IAAI,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEA,IAAM,gBAAgB,OACpB,SACA,QAC2C;AAC3C,QAAM,WAAW,MAAM,MAAM,KAAK;AAAA,IAChC,SAAS;AAAA,MACP,QAAQ;AAAA,MACR,wBAAwB;AAAA,MACxB,cAAc;AAAA,MACd,GAAI,QAAQ,QAAQ,EAAE,eAAe,UAAU,QAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtE;AAAA,EACF,CAAC;AAED,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,UAAU,MAAM,SAAS,KAAK;AACpC,UAAM,IAAI;AAAA,MACR,sCAAsC,SAAS,MAAM,IAAI,SAAS,UAAU,MAAM,OAAO;AAAA,IAC3F;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAO,MAAM,SAAS,KAAK;AAAA,IAC3B,SAAS,SAAS;AAAA,EACpB;AACF;AAEA,IAAM,iBAAiB,CAAC,SAAiC,aAAqB;AAC5E,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,oBAAoB,QAAQ,SAAS,GAAG,IAAI,UAAU,GAAG,OAAO;AACtE,QAAM,qBAAqB,SAAS,QAAQ,QAAQ,EAAE;AACtD,QAAM,MAAM,IAAI,IAAI,oBAAoB,iBAAiB;AACzD,MAAI,aAAa,IAAI,YAAY,KAAK;AACtC,SAAO,IAAI,SAAS;AACtB;AAEA,IAAM,iBAAiB,CAAC,eAA8B;AACpD,MAAI,CAAC,WAAY,QAAO;AAExB,QAAM,WAAW,WACd,MAAM,GAAG,EACT,KAAK,CAAC,SAAS,KAAK,SAAS,YAAY,CAAC;AAC7C,QAAM,QAAQ,UAAU,MAAM,WAAW;AAEzC,SAAO,QAAQ,CAAC;AAClB;","names":[]}
|
package/dist/index.mjs
CHANGED
|
@@ -4,6 +4,11 @@ var defineDirectorySource = (source) => source;
|
|
|
4
4
|
// src/github-directory.ts
|
|
5
5
|
var GITHUB_API_VERSION = "2022-11-28";
|
|
6
6
|
var githubDirectory = (options) => {
|
|
7
|
+
if (!Array.isArray(options.teams) || options.teams.length === 0) {
|
|
8
|
+
throw new Error(
|
|
9
|
+
'GitHub directory connector requires at least one team slug. Set teams: ["platform"].'
|
|
10
|
+
);
|
|
11
|
+
}
|
|
7
12
|
let cachedData;
|
|
8
13
|
const load = () => {
|
|
9
14
|
cachedData = cachedData ?? loadGitHubDirectory(options);
|
|
@@ -12,7 +17,6 @@ var githubDirectory = (options) => {
|
|
|
12
17
|
return defineDirectorySource({
|
|
13
18
|
type: "directory",
|
|
14
19
|
name: `github:${options.org}`,
|
|
15
|
-
cacheKey: createGitHubDirectoryCacheKey(options),
|
|
16
20
|
loadTeams: async () => {
|
|
17
21
|
const data = await load();
|
|
18
22
|
return data.teams;
|
|
@@ -23,12 +27,6 @@ var githubDirectory = (options) => {
|
|
|
23
27
|
}
|
|
24
28
|
});
|
|
25
29
|
};
|
|
26
|
-
var createGitHubDirectoryCacheKey = (options) => {
|
|
27
|
-
const teams = options.teams === true || options.teams === void 0 ? "all" : [...options.teams].sort().join(",");
|
|
28
|
-
const users = options.users !== false ? "true" : "false";
|
|
29
|
-
const baseUrl = options.baseUrl ?? "https://api.github.com";
|
|
30
|
-
return `github:${baseUrl}:${options.org}:teams=${teams}:users=${users}`;
|
|
31
|
-
};
|
|
32
30
|
var loadGitHubDirectory = async (options) => {
|
|
33
31
|
const teams = await loadGitHubTeams(options);
|
|
34
32
|
const shouldLoadUsers = options.users !== false;
|
|
@@ -53,9 +51,11 @@ var loadGitHubDirectory = async (options) => {
|
|
|
53
51
|
};
|
|
54
52
|
};
|
|
55
53
|
var loadGitHubTeams = async (options) => {
|
|
56
|
-
const teams =
|
|
57
|
-
const
|
|
58
|
-
|
|
54
|
+
const teams = [];
|
|
55
|
+
for (const teamSlug of options.teams) {
|
|
56
|
+
teams.push(await loadGitHubTeam(options, teamSlug));
|
|
57
|
+
}
|
|
58
|
+
return teams.map((team) => ({
|
|
59
59
|
id: team.slug,
|
|
60
60
|
name: team.name,
|
|
61
61
|
summary: team.description ?? void 0,
|
|
@@ -67,6 +67,16 @@ var loadGitHubTeams = async (options) => {
|
|
|
67
67
|
}
|
|
68
68
|
}));
|
|
69
69
|
};
|
|
70
|
+
var loadGitHubTeam = async (options, teamSlug) => {
|
|
71
|
+
const response = await githubRequest(
|
|
72
|
+
options,
|
|
73
|
+
buildGitHubUrl(
|
|
74
|
+
options,
|
|
75
|
+
`/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}`
|
|
76
|
+
)
|
|
77
|
+
);
|
|
78
|
+
return response.data;
|
|
79
|
+
};
|
|
70
80
|
var loadGitHubTeamMembers = async (options, teamSlug) => {
|
|
71
81
|
const members = await paginate(
|
|
72
82
|
options,
|
|
@@ -127,7 +137,9 @@ var githubRequest = async (options, url) => {
|
|
|
127
137
|
});
|
|
128
138
|
if (!response.ok) {
|
|
129
139
|
const message = await response.text();
|
|
130
|
-
throw new Error(
|
|
140
|
+
throw new Error(
|
|
141
|
+
`GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`
|
|
142
|
+
);
|
|
131
143
|
}
|
|
132
144
|
return {
|
|
133
145
|
data: await response.json(),
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/types.ts","../src/github-directory.ts"],"sourcesContent":["/**\n * Describes where a generated directory entry came from.\n *\n * EventCatalog uses the provider to show source badges and to treat generated\n * resources as externally managed.\n */\nexport type DirectoryEntrySource = {\n /** Provider identifier, for example `github`, `okta`, or `ldap`. */\n provider: string;\n /** Optional provider-specific identifier for the external resource. */\n id?: string;\n /** Optional URL back to the resource in the external provider. */\n url?: string;\n [key: string]: unknown;\n};\n\n/**\n * User returned by a directory source.\n *\n * Directory users are synced as read-only EventCatalog users and can be\n * referenced by teams through their `id`.\n */\nexport type DirectoryUser = {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Team returned by a directory source.\n *\n * Directory teams are synced as read-only EventCatalog teams.\n */\nexport type DirectoryTeam = {\n id: string;\n name: string;\n summary?: string;\n /** User IDs for members of this team. */\n members?: string[];\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Loads users and/or teams from an external directory provider.\n *\n * EventCatalog calls these loaders during content sync, writes the returned\n * entries into Astro collections, and mirrors them into the generated\n * `.eventcatalog/store/directory.json` file for SDK/editor reads.\n */\nexport type DirectorySource = {\n type: 'directory';\n /** Stable source identifier, usually `<provider>:<account-or-org>`. */\n name: string;\n /** Optional stable cache key for this source configuration. */\n cacheKey?: string;\n /** Load users from the external directory. */\n loadUsers?: () => Promise<DirectoryUser[]>;\n /** Load teams from the external directory. */\n loadTeams?: () => Promise<DirectoryTeam[]>;\n};\n\n/**\n * Defines a custom directory source with type inference for connector authors.\n */\nexport const defineDirectorySource = <TSource extends DirectorySource>(source: TSource) => source;\n","import { defineDirectorySource, type DirectorySource, type DirectoryTeam, type DirectoryUser } from './types';\n\ntype GitHubDirectoryOptions = {\n org: string;\n token?: string;\n teams?: true | string[];\n users?: boolean;\n baseUrl?: string;\n};\n\ntype GitHubTeam = {\n id: number;\n name: string;\n slug: string;\n description: string | null;\n html_url: string;\n};\n\ntype GitHubUser = {\n id: number;\n login: string;\n avatar_url: string;\n html_url: string;\n};\n\ntype GitHubDirectoryData = {\n teams: DirectoryTeam[];\n users: DirectoryUser[];\n};\n\nconst GITHUB_API_VERSION = '2022-11-28';\n\nexport const githubDirectory = (options: GitHubDirectoryOptions): DirectorySource => {\n let cachedData: Promise<GitHubDirectoryData> | undefined;\n\n const load = () => {\n cachedData = cachedData ?? loadGitHubDirectory(options);\n return cachedData;\n };\n\n return defineDirectorySource({\n type: 'directory',\n name: `github:${options.org}`,\n cacheKey: createGitHubDirectoryCacheKey(options),\n loadTeams: async () => {\n const data = await load();\n return data.teams;\n },\n loadUsers: async () => {\n const data = await load();\n return data.users;\n },\n });\n};\n\nconst createGitHubDirectoryCacheKey = (options: GitHubDirectoryOptions) => {\n const teams = options.teams === true || options.teams === undefined ? 'all' : [...options.teams].sort().join(',');\n const users = options.users !== false ? 'true' : 'false';\n const baseUrl = options.baseUrl ?? 'https://api.github.com';\n\n return `github:${baseUrl}:${options.org}:teams=${teams}:users=${users}`;\n};\n\nconst loadGitHubDirectory = async (options: GitHubDirectoryOptions): Promise<GitHubDirectoryData> => {\n const teams = await loadGitHubTeams(options);\n const shouldLoadUsers = options.users !== false;\n\n if (!shouldLoadUsers) {\n return { teams, users: [] };\n }\n\n const usersById = new Map<string, DirectoryUser>();\n const teamsWithMembers: DirectoryTeam[] = [];\n\n for (const team of teams) {\n const members = await loadGitHubTeamMembers(options, team.id);\n\n for (const member of members) {\n usersById.set(member.id, member);\n }\n\n teamsWithMembers.push({\n ...team,\n members: members.map((member) => member.id),\n });\n }\n\n return {\n teams: teamsWithMembers,\n users: Array.from(usersById.values()),\n };\n};\n\nconst loadGitHubTeams = async (options: GitHubDirectoryOptions): Promise<DirectoryTeam[]> => {\n const teams = await paginate<GitHubTeam>(options, `/orgs/${encodeURIComponent(options.org)}/teams`);\n const configuredTeams = options.teams === undefined || options.teams === true ? undefined : new Set(options.teams);\n\n return teams\n .filter((team) => !configuredTeams || configuredTeams.has(team.slug))\n .map((team) => ({\n id: team.slug,\n name: team.name,\n summary: team.description ?? undefined,\n markdown: createGitHubSyncedMarkdown('team', team.html_url),\n source: {\n provider: 'github',\n id: String(team.id),\n url: team.html_url,\n },\n }));\n};\n\nconst loadGitHubTeamMembers = async (options: GitHubDirectoryOptions, teamSlug: string): Promise<DirectoryUser[]> => {\n const members = await paginate<GitHubUser>(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}/members`\n );\n\n return members.map((member) => ({\n id: member.login,\n name: member.login,\n avatarUrl: member.avatar_url,\n markdown: createGitHubSyncedMarkdown('user', member.html_url),\n source: {\n provider: 'github',\n id: String(member.id),\n url: member.html_url,\n },\n }));\n};\n\nconst createGitHubSyncedMarkdown = (type: 'team' | 'user', url: string) => {\n if (type === 'team') {\n return [\n ':::note',\n 'This team is synced from GitHub and is read-only in EventCatalog.',\n '',\n 'Manage the team and its members in GitHub.',\n '',\n `[View team on GitHub](${url})`,\n ':::',\n ].join('\\n');\n }\n\n return [\n ':::note',\n 'This user is synced from GitHub and is read-only in EventCatalog.',\n '',\n 'Manage profile details and team membership in GitHub.',\n '',\n `[View user on GitHub](${url})`,\n ':::',\n ].join('\\n');\n};\n\nconst paginate = async <T>(options: GitHubDirectoryOptions, pathname: string): Promise<T[]> => {\n const results: T[] = [];\n let url: string | undefined = buildGitHubUrl(options, pathname);\n\n while (url) {\n const response = await githubRequest<T[]>(options, url);\n results.push(...response.data);\n url = getNextPageUrl(response.headers.get('link'));\n }\n\n return results;\n};\n\nconst githubRequest = async <T>(\n options: GitHubDirectoryOptions,\n url: string\n): Promise<{ data: T; headers: Headers }> => {\n const response = await fetch(url, {\n headers: {\n accept: 'application/vnd.github+json',\n 'x-github-api-version': GITHUB_API_VERSION,\n 'user-agent': '@eventcatalog/connectors',\n ...(options.token ? { authorization: `Bearer ${options.token}` } : {}),\n },\n });\n\n if (!response.ok) {\n const message = await response.text();\n throw new Error(`GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`);\n }\n\n return {\n data: (await response.json()) as T,\n headers: response.headers,\n };\n};\n\nconst buildGitHubUrl = (options: GitHubDirectoryOptions, pathname: string) => {\n const baseUrl = options.baseUrl ?? 'https://api.github.com';\n const normalizedBaseUrl = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;\n const normalizedPathname = pathname.replace(/^\\//u, '');\n const url = new URL(normalizedPathname, normalizedBaseUrl);\n url.searchParams.set('per_page', '100');\n return url.toString();\n};\n\nconst getNextPageUrl = (linkHeader: string | null) => {\n if (!linkHeader) return undefined;\n\n const nextLink = linkHeader.split(',').find((link) => link.includes('rel=\"next\"'));\n const match = nextLink?.match(/<([^>]+)>/);\n\n return match?.[1];\n};\n"],"mappings":";AAwEO,IAAM,wBAAwB,CAAkC,WAAoB;;;AC1C3F,IAAM,qBAAqB;AAEpB,IAAM,kBAAkB,CAAC,YAAqD;AACnF,MAAI;AAEJ,QAAM,OAAO,MAAM;AACjB,iBAAa,cAAc,oBAAoB,OAAO;AACtD,WAAO;AAAA,EACT;AAEA,SAAO,sBAAsB;AAAA,IAC3B,MAAM;AAAA,IACN,MAAM,UAAU,QAAQ,GAAG;AAAA,IAC3B,UAAU,8BAA8B,OAAO;AAAA,IAC/C,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,IACA,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,EACF,CAAC;AACH;AAEA,IAAM,gCAAgC,CAAC,YAAoC;AACzE,QAAM,QAAQ,QAAQ,UAAU,QAAQ,QAAQ,UAAU,SAAY,QAAQ,CAAC,GAAG,QAAQ,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG;AAChH,QAAM,QAAQ,QAAQ,UAAU,QAAQ,SAAS;AACjD,QAAM,UAAU,QAAQ,WAAW;AAEnC,SAAO,UAAU,OAAO,IAAI,QAAQ,GAAG,UAAU,KAAK,UAAU,KAAK;AACvE;AAEA,IAAM,sBAAsB,OAAO,YAAkE;AACnG,QAAM,QAAQ,MAAM,gBAAgB,OAAO;AAC3C,QAAM,kBAAkB,QAAQ,UAAU;AAE1C,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,OAAO,OAAO,CAAC,EAAE;AAAA,EAC5B;AAEA,QAAM,YAAY,oBAAI,IAA2B;AACjD,QAAM,mBAAoC,CAAC;AAE3C,aAAW,QAAQ,OAAO;AACxB,UAAM,UAAU,MAAM,sBAAsB,SAAS,KAAK,EAAE;AAE5D,eAAW,UAAU,SAAS;AAC5B,gBAAU,IAAI,OAAO,IAAI,MAAM;AAAA,IACjC;AAEA,qBAAiB,KAAK;AAAA,MACpB,GAAG;AAAA,MACH,SAAS,QAAQ,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAC5C,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAO;AAAA,IACP,OAAO,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,EACtC;AACF;AAEA,IAAM,kBAAkB,OAAO,YAA8D;AAC3F,QAAM,QAAQ,MAAM,SAAqB,SAAS,SAAS,mBAAmB,QAAQ,GAAG,CAAC,QAAQ;AAClG,QAAM,kBAAkB,QAAQ,UAAU,UAAa,QAAQ,UAAU,OAAO,SAAY,IAAI,IAAI,QAAQ,KAAK;AAEjH,SAAO,MACJ,OAAO,CAAC,SAAS,CAAC,mBAAmB,gBAAgB,IAAI,KAAK,IAAI,CAAC,EACnE,IAAI,CAAC,UAAU;AAAA,IACd,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,SAAS,KAAK,eAAe;AAAA,IAC7B,UAAU,2BAA2B,QAAQ,KAAK,QAAQ;AAAA,IAC1D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,KAAK,EAAE;AAAA,MAClB,KAAK,KAAK;AAAA,IACZ;AAAA,EACF,EAAE;AACN;AAEA,IAAM,wBAAwB,OAAO,SAAiC,aAA+C;AACnH,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,EAChF;AAEA,SAAO,QAAQ,IAAI,CAAC,YAAY;AAAA,IAC9B,IAAI,OAAO;AAAA,IACX,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,UAAU,2BAA2B,QAAQ,OAAO,QAAQ;AAAA,IAC5D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,OAAO,EAAE;AAAA,MACpB,KAAK,OAAO;AAAA,IACd;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,6BAA6B,CAAC,MAAuB,QAAgB;AACzE,MAAI,SAAS,QAAQ;AACnB,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,yBAAyB,GAAG;AAAA,MAC5B;AAAA,IACF,EAAE,KAAK,IAAI;AAAA,EACb;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,yBAAyB,GAAG;AAAA,IAC5B;AAAA,EACF,EAAE,KAAK,IAAI;AACb;AAEA,IAAM,WAAW,OAAU,SAAiC,aAAmC;AAC7F,QAAM,UAAe,CAAC;AACtB,MAAI,MAA0B,eAAe,SAAS,QAAQ;AAE9D,SAAO,KAAK;AACV,UAAM,WAAW,MAAM,cAAmB,SAAS,GAAG;AACtD,YAAQ,KAAK,GAAG,SAAS,IAAI;AAC7B,UAAM,eAAe,SAAS,QAAQ,IAAI,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEA,IAAM,gBAAgB,OACpB,SACA,QAC2C;AAC3C,QAAM,WAAW,MAAM,MAAM,KAAK;AAAA,IAChC,SAAS;AAAA,MACP,QAAQ;AAAA,MACR,wBAAwB;AAAA,MACxB,cAAc;AAAA,MACd,GAAI,QAAQ,QAAQ,EAAE,eAAe,UAAU,QAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtE;AAAA,EACF,CAAC;AAED,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,UAAU,MAAM,SAAS,KAAK;AACpC,UAAM,IAAI,MAAM,sCAAsC,SAAS,MAAM,IAAI,SAAS,UAAU,MAAM,OAAO,EAAE;AAAA,EAC7G;AAEA,SAAO;AAAA,IACL,MAAO,MAAM,SAAS,KAAK;AAAA,IAC3B,SAAS,SAAS;AAAA,EACpB;AACF;AAEA,IAAM,iBAAiB,CAAC,SAAiC,aAAqB;AAC5E,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,oBAAoB,QAAQ,SAAS,GAAG,IAAI,UAAU,GAAG,OAAO;AACtE,QAAM,qBAAqB,SAAS,QAAQ,QAAQ,EAAE;AACtD,QAAM,MAAM,IAAI,IAAI,oBAAoB,iBAAiB;AACzD,MAAI,aAAa,IAAI,YAAY,KAAK;AACtC,SAAO,IAAI,SAAS;AACtB;AAEA,IAAM,iBAAiB,CAAC,eAA8B;AACpD,MAAI,CAAC,WAAY,QAAO;AAExB,QAAM,WAAW,WAAW,MAAM,GAAG,EAAE,KAAK,CAAC,SAAS,KAAK,SAAS,YAAY,CAAC;AACjF,QAAM,QAAQ,UAAU,MAAM,WAAW;AAEzC,SAAO,QAAQ,CAAC;AAClB;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/types.ts","../src/github-directory.ts"],"sourcesContent":["/**\n * Describes where a generated directory entry came from.\n *\n * EventCatalog uses the provider to show source badges and to treat generated\n * resources as externally managed.\n */\nexport type DirectoryEntrySource = {\n /** Provider identifier, for example `github`, `okta`, or `ldap`. */\n provider: string;\n /** Optional provider-specific identifier for the external resource. */\n id?: string;\n /** Optional URL back to the resource in the external provider. */\n url?: string;\n [key: string]: unknown;\n};\n\n/**\n * User returned by a directory source.\n *\n * Directory users are synced as read-only EventCatalog users and can be\n * referenced by teams through their `id`.\n */\nexport type DirectoryUser = {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Team returned by a directory source.\n *\n * Directory teams are synced as read-only EventCatalog teams.\n */\nexport type DirectoryTeam = {\n id: string;\n name: string;\n summary?: string;\n /** User IDs for members of this team. */\n members?: string[];\n email?: string;\n markdown?: string;\n source?: DirectoryEntrySource;\n [key: string]: unknown;\n};\n\n/**\n * Loads users and/or teams from an external directory provider.\n *\n * EventCatalog calls these loaders during content sync, writes the returned\n * entries into Astro collections, and mirrors them into the generated\n * `.eventcatalog/store/directory.json` file for SDK/editor reads.\n */\nexport type DirectorySource = {\n type: \"directory\";\n /** Stable source identifier, usually `<provider>:<account-or-org>`. */\n name: string;\n /** Load users from the external directory. */\n loadUsers?: () => Promise<DirectoryUser[]>;\n /** Load teams from the external directory. */\n loadTeams?: () => Promise<DirectoryTeam[]>;\n};\n\n/**\n * Defines a custom directory source with type inference for connector authors.\n */\nexport const defineDirectorySource = <TSource extends DirectorySource>(\n source: TSource,\n) => source;\n","import {\n defineDirectorySource,\n type DirectorySource,\n type DirectoryTeam,\n type DirectoryUser,\n} from \"./types\";\n\ntype GitHubDirectoryOptions = {\n org: string;\n token?: string;\n teams: string[];\n users?: boolean;\n baseUrl?: string;\n};\n\ntype GitHubTeam = {\n id: number;\n name: string;\n slug: string;\n description: string | null;\n html_url: string;\n};\n\ntype GitHubUser = {\n id: number;\n login: string;\n avatar_url: string;\n html_url: string;\n};\n\ntype GitHubDirectoryData = {\n teams: DirectoryTeam[];\n users: DirectoryUser[];\n};\n\nconst GITHUB_API_VERSION = \"2022-11-28\";\n\nexport const githubDirectory = (\n options: GitHubDirectoryOptions,\n): DirectorySource => {\n if (!Array.isArray(options.teams) || options.teams.length === 0) {\n throw new Error(\n 'GitHub directory connector requires at least one team slug. Set teams: [\"platform\"].',\n );\n }\n\n let cachedData: Promise<GitHubDirectoryData> | undefined;\n\n const load = () => {\n cachedData = cachedData ?? loadGitHubDirectory(options);\n return cachedData;\n };\n\n return defineDirectorySource({\n type: \"directory\",\n name: `github:${options.org}`,\n loadTeams: async () => {\n const data = await load();\n return data.teams;\n },\n loadUsers: async () => {\n const data = await load();\n return data.users;\n },\n });\n};\n\nconst loadGitHubDirectory = async (\n options: GitHubDirectoryOptions,\n): Promise<GitHubDirectoryData> => {\n const teams = await loadGitHubTeams(options);\n const shouldLoadUsers = options.users !== false;\n\n if (!shouldLoadUsers) {\n return { teams, users: [] };\n }\n\n const usersById = new Map<string, DirectoryUser>();\n const teamsWithMembers: DirectoryTeam[] = [];\n\n for (const team of teams) {\n const members = await loadGitHubTeamMembers(options, team.id);\n\n for (const member of members) {\n usersById.set(member.id, member);\n }\n\n teamsWithMembers.push({\n ...team,\n members: members.map((member) => member.id),\n });\n }\n\n return {\n teams: teamsWithMembers,\n users: Array.from(usersById.values()),\n };\n};\n\nconst loadGitHubTeams = async (\n options: GitHubDirectoryOptions,\n): Promise<DirectoryTeam[]> => {\n const teams: GitHubTeam[] = [];\n\n for (const teamSlug of options.teams) {\n teams.push(await loadGitHubTeam(options, teamSlug));\n }\n\n return teams.map((team) => ({\n id: team.slug,\n name: team.name,\n summary: team.description ?? undefined,\n markdown: createGitHubSyncedMarkdown(\"team\", team.html_url),\n source: {\n provider: \"github\",\n id: String(team.id),\n url: team.html_url,\n },\n }));\n};\n\nconst loadGitHubTeam = async (\n options: GitHubDirectoryOptions,\n teamSlug: string,\n) => {\n const response = await githubRequest<GitHubTeam>(\n options,\n buildGitHubUrl(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}`,\n ),\n );\n\n return response.data;\n};\n\nconst loadGitHubTeamMembers = async (\n options: GitHubDirectoryOptions,\n teamSlug: string,\n): Promise<DirectoryUser[]> => {\n const members = await paginate<GitHubUser>(\n options,\n `/orgs/${encodeURIComponent(options.org)}/teams/${encodeURIComponent(teamSlug)}/members`,\n );\n\n return members.map((member) => ({\n id: member.login,\n name: member.login,\n avatarUrl: member.avatar_url,\n markdown: createGitHubSyncedMarkdown(\"user\", member.html_url),\n source: {\n provider: \"github\",\n id: String(member.id),\n url: member.html_url,\n },\n }));\n};\n\nconst createGitHubSyncedMarkdown = (type: \"team\" | \"user\", url: string) => {\n if (type === \"team\") {\n return [\n \":::note\",\n \"This team is synced from GitHub and is read-only in EventCatalog.\",\n \"\",\n \"Manage the team and its members in GitHub.\",\n \"\",\n `[View team on GitHub](${url})`,\n \":::\",\n ].join(\"\\n\");\n }\n\n return [\n \":::note\",\n \"This user is synced from GitHub and is read-only in EventCatalog.\",\n \"\",\n \"Manage profile details and team membership in GitHub.\",\n \"\",\n `[View user on GitHub](${url})`,\n \":::\",\n ].join(\"\\n\");\n};\n\nconst paginate = async <T>(\n options: GitHubDirectoryOptions,\n pathname: string,\n): Promise<T[]> => {\n const results: T[] = [];\n let url: string | undefined = buildGitHubUrl(options, pathname);\n\n while (url) {\n const response = await githubRequest<T[]>(options, url);\n results.push(...response.data);\n url = getNextPageUrl(response.headers.get(\"link\"));\n }\n\n return results;\n};\n\nconst githubRequest = async <T>(\n options: GitHubDirectoryOptions,\n url: string,\n): Promise<{ data: T; headers: Headers }> => {\n const response = await fetch(url, {\n headers: {\n accept: \"application/vnd.github+json\",\n \"x-github-api-version\": GITHUB_API_VERSION,\n \"user-agent\": \"@eventcatalog/connectors\",\n ...(options.token ? { authorization: `Bearer ${options.token}` } : {}),\n },\n });\n\n if (!response.ok) {\n const message = await response.text();\n throw new Error(\n `GitHub directory connector failed (${response.status} ${response.statusText}): ${message}`,\n );\n }\n\n return {\n data: (await response.json()) as T,\n headers: response.headers,\n };\n};\n\nconst buildGitHubUrl = (options: GitHubDirectoryOptions, pathname: string) => {\n const baseUrl = options.baseUrl ?? \"https://api.github.com\";\n const normalizedBaseUrl = baseUrl.endsWith(\"/\") ? baseUrl : `${baseUrl}/`;\n const normalizedPathname = pathname.replace(/^\\//u, \"\");\n const url = new URL(normalizedPathname, normalizedBaseUrl);\n url.searchParams.set(\"per_page\", \"100\");\n return url.toString();\n};\n\nconst getNextPageUrl = (linkHeader: string | null) => {\n if (!linkHeader) return undefined;\n\n const nextLink = linkHeader\n .split(\",\")\n .find((link) => link.includes('rel=\"next\"'));\n const match = nextLink?.match(/<([^>]+)>/);\n\n return match?.[1];\n};\n"],"mappings":";AAsEO,IAAM,wBAAwB,CACnC,WACG;;;ACrCL,IAAM,qBAAqB;AAEpB,IAAM,kBAAkB,CAC7B,YACoB;AACpB,MAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,KAAK,QAAQ,MAAM,WAAW,GAAG;AAC/D,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AAEJ,QAAM,OAAO,MAAM;AACjB,iBAAa,cAAc,oBAAoB,OAAO;AACtD,WAAO;AAAA,EACT;AAEA,SAAO,sBAAsB;AAAA,IAC3B,MAAM;AAAA,IACN,MAAM,UAAU,QAAQ,GAAG;AAAA,IAC3B,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,IACA,WAAW,YAAY;AACrB,YAAM,OAAO,MAAM,KAAK;AACxB,aAAO,KAAK;AAAA,IACd;AAAA,EACF,CAAC;AACH;AAEA,IAAM,sBAAsB,OAC1B,YACiC;AACjC,QAAM,QAAQ,MAAM,gBAAgB,OAAO;AAC3C,QAAM,kBAAkB,QAAQ,UAAU;AAE1C,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,OAAO,OAAO,CAAC,EAAE;AAAA,EAC5B;AAEA,QAAM,YAAY,oBAAI,IAA2B;AACjD,QAAM,mBAAoC,CAAC;AAE3C,aAAW,QAAQ,OAAO;AACxB,UAAM,UAAU,MAAM,sBAAsB,SAAS,KAAK,EAAE;AAE5D,eAAW,UAAU,SAAS;AAC5B,gBAAU,IAAI,OAAO,IAAI,MAAM;AAAA,IACjC;AAEA,qBAAiB,KAAK;AAAA,MACpB,GAAG;AAAA,MACH,SAAS,QAAQ,IAAI,CAAC,WAAW,OAAO,EAAE;AAAA,IAC5C,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAO;AAAA,IACP,OAAO,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,EACtC;AACF;AAEA,IAAM,kBAAkB,OACtB,YAC6B;AAC7B,QAAM,QAAsB,CAAC;AAE7B,aAAW,YAAY,QAAQ,OAAO;AACpC,UAAM,KAAK,MAAM,eAAe,SAAS,QAAQ,CAAC;AAAA,EACpD;AAEA,SAAO,MAAM,IAAI,CAAC,UAAU;AAAA,IAC1B,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,SAAS,KAAK,eAAe;AAAA,IAC7B,UAAU,2BAA2B,QAAQ,KAAK,QAAQ;AAAA,IAC1D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,KAAK,EAAE;AAAA,MAClB,KAAK,KAAK;AAAA,IACZ;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,iBAAiB,OACrB,SACA,aACG;AACH,QAAM,WAAW,MAAM;AAAA,IACrB;AAAA,IACA;AAAA,MACE;AAAA,MACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,IAChF;AAAA,EACF;AAEA,SAAO,SAAS;AAClB;AAEA,IAAM,wBAAwB,OAC5B,SACA,aAC6B;AAC7B,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA,SAAS,mBAAmB,QAAQ,GAAG,CAAC,UAAU,mBAAmB,QAAQ,CAAC;AAAA,EAChF;AAEA,SAAO,QAAQ,IAAI,CAAC,YAAY;AAAA,IAC9B,IAAI,OAAO;AAAA,IACX,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,UAAU,2BAA2B,QAAQ,OAAO,QAAQ;AAAA,IAC5D,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,IAAI,OAAO,OAAO,EAAE;AAAA,MACpB,KAAK,OAAO;AAAA,IACd;AAAA,EACF,EAAE;AACJ;AAEA,IAAM,6BAA6B,CAAC,MAAuB,QAAgB;AACzE,MAAI,SAAS,QAAQ;AACnB,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,yBAAyB,GAAG;AAAA,MAC5B;AAAA,IACF,EAAE,KAAK,IAAI;AAAA,EACb;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,yBAAyB,GAAG;AAAA,IAC5B;AAAA,EACF,EAAE,KAAK,IAAI;AACb;AAEA,IAAM,WAAW,OACf,SACA,aACiB;AACjB,QAAM,UAAe,CAAC;AACtB,MAAI,MAA0B,eAAe,SAAS,QAAQ;AAE9D,SAAO,KAAK;AACV,UAAM,WAAW,MAAM,cAAmB,SAAS,GAAG;AACtD,YAAQ,KAAK,GAAG,SAAS,IAAI;AAC7B,UAAM,eAAe,SAAS,QAAQ,IAAI,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEA,IAAM,gBAAgB,OACpB,SACA,QAC2C;AAC3C,QAAM,WAAW,MAAM,MAAM,KAAK;AAAA,IAChC,SAAS;AAAA,MACP,QAAQ;AAAA,MACR,wBAAwB;AAAA,MACxB,cAAc;AAAA,MACd,GAAI,QAAQ,QAAQ,EAAE,eAAe,UAAU,QAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtE;AAAA,EACF,CAAC;AAED,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,UAAU,MAAM,SAAS,KAAK;AACpC,UAAM,IAAI;AAAA,MACR,sCAAsC,SAAS,MAAM,IAAI,SAAS,UAAU,MAAM,OAAO;AAAA,IAC3F;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAO,MAAM,SAAS,KAAK;AAAA,IAC3B,SAAS,SAAS;AAAA,EACpB;AACF;AAEA,IAAM,iBAAiB,CAAC,SAAiC,aAAqB;AAC5E,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,oBAAoB,QAAQ,SAAS,GAAG,IAAI,UAAU,GAAG,OAAO;AACtE,QAAM,qBAAqB,SAAS,QAAQ,QAAQ,EAAE;AACtD,QAAM,MAAM,IAAI,IAAI,oBAAoB,iBAAiB;AACzD,MAAI,aAAa,IAAI,YAAY,KAAK;AACtC,SAAO,IAAI,SAAS;AACtB;AAEA,IAAM,iBAAiB,CAAC,eAA8B;AACpD,MAAI,CAAC,WAAY,QAAO;AAExB,QAAM,WAAW,WACd,MAAM,GAAG,EACT,KAAK,CAAC,SAAS,KAAK,SAAS,YAAY,CAAC;AAC7C,QAAM,QAAQ,UAAU,MAAM,WAAW;AAEzC,SAAO,QAAQ,CAAC;AAClB;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,15 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eventcatalog/connectors",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Connectors for syncing external systems into EventCatalog Collections",
|
|
5
|
-
"scripts": {
|
|
6
|
-
"build": "tsup",
|
|
7
|
-
"build:bin": "tsup",
|
|
8
|
-
"test": "vitest --run",
|
|
9
|
-
"test:ci": "vitest --run",
|
|
10
|
-
"format": "prettier --write .",
|
|
11
|
-
"format:diff": "prettier --list-different ."
|
|
12
|
-
},
|
|
13
5
|
"publishConfig": {
|
|
14
6
|
"access": "public"
|
|
15
7
|
},
|
|
@@ -45,5 +37,13 @@
|
|
|
45
37
|
"repository": {
|
|
46
38
|
"type": "git",
|
|
47
39
|
"url": "https://github.com/event-catalog/eventcatalog"
|
|
40
|
+
},
|
|
41
|
+
"scripts": {
|
|
42
|
+
"build": "tsup",
|
|
43
|
+
"build:bin": "tsup",
|
|
44
|
+
"test": "vitest --run",
|
|
45
|
+
"test:ci": "vitest --run",
|
|
46
|
+
"format": "prettier --write .",
|
|
47
|
+
"format:diff": "prettier --list-different ."
|
|
48
48
|
}
|
|
49
|
-
}
|
|
49
|
+
}
|