@dependabit/monitor 0.1.1
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/CHANGELOG.md +9 -0
- package/LICENSE +21 -0
- package/README.md +33 -0
- package/dist/checkers/github-repo.d.ts +17 -0
- package/dist/checkers/github-repo.d.ts.map +1 -0
- package/dist/checkers/github-repo.js +115 -0
- package/dist/checkers/github-repo.js.map +1 -0
- package/dist/checkers/index.d.ts +7 -0
- package/dist/checkers/index.d.ts.map +1 -0
- package/dist/checkers/index.js +7 -0
- package/dist/checkers/index.js.map +1 -0
- package/dist/checkers/openapi.d.ts +24 -0
- package/dist/checkers/openapi.d.ts.map +1 -0
- package/dist/checkers/openapi.js +221 -0
- package/dist/checkers/openapi.js.map +1 -0
- package/dist/checkers/url-content.d.ts +16 -0
- package/dist/checkers/url-content.d.ts.map +1 -0
- package/dist/checkers/url-content.js +66 -0
- package/dist/checkers/url-content.js.map +1 -0
- package/dist/comparator.d.ts +16 -0
- package/dist/comparator.d.ts.map +1 -0
- package/dist/comparator.js +53 -0
- package/dist/comparator.js.map +1 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -0
- package/dist/monitor.d.ts +43 -0
- package/dist/monitor.d.ts.map +1 -0
- package/dist/monitor.js +85 -0
- package/dist/monitor.js.map +1 -0
- package/dist/normalizer.d.ts +24 -0
- package/dist/normalizer.d.ts.map +1 -0
- package/dist/normalizer.js +97 -0
- package/dist/normalizer.js.map +1 -0
- package/dist/scheduler.d.ts +64 -0
- package/dist/scheduler.d.ts.map +1 -0
- package/dist/scheduler.js +132 -0
- package/dist/scheduler.js.map +1 -0
- package/dist/severity.d.ts +22 -0
- package/dist/severity.d.ts.map +1 -0
- package/dist/severity.js +87 -0
- package/dist/severity.js.map +1 -0
- package/dist/types.d.ts +36 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +39 -0
- package/src/checkers/github-repo.ts +150 -0
- package/src/checkers/index.ts +7 -0
- package/src/checkers/openapi.ts +310 -0
- package/src/checkers/url-content.ts +78 -0
- package/src/comparator.ts +68 -0
- package/src/index.ts +20 -0
- package/src/monitor.ts +120 -0
- package/src/normalizer.ts +122 -0
- package/src/scheduler.ts +175 -0
- package/src/severity.ts +112 -0
- package/src/types.ts +40 -0
- package/test/checkers/github-repo.test.ts +124 -0
- package/test/checkers/openapi.test.ts +352 -0
- package/test/checkers/url-content.test.ts +99 -0
- package/test/comparator.test.ts +108 -0
- package/test/monitor.test.ts +177 -0
- package/test/normalizer.test.ts +66 -0
- package/test/scheduler.test.ts +674 -0
- package/test/severity.test.ts +122 -0
- package/tsconfig.json +10 -0
- package/tsconfig.tsbuildinfo +1 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024-present Pradeep Mouli
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @dependabit/monitor
|
|
2
|
+
|
|
3
|
+
Change detection and monitoring logic for external dependencies.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This package implements the monitoring and change detection logic for tracking updates to external dependencies.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- Multi-strategy dependency checking
|
|
12
|
+
- GitHub repository monitoring
|
|
13
|
+
- Documentation URL content tracking
|
|
14
|
+
- OpenAPI spec semantic diffing
|
|
15
|
+
- Severity classification
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm add @dependabit/monitor
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { monitor } from '@dependabit/monitor';
|
|
27
|
+
|
|
28
|
+
// Coming soon in Phase 5
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
MIT
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GitHub Repository Checker
|
|
3
|
+
* Monitors GitHub repositories for new releases and changes
|
|
4
|
+
*/
|
|
5
|
+
import type { Checker, DependencySnapshot, ChangeDetection, AccessConfig } from '../types.js';
|
|
6
|
+
export declare class GitHubRepoChecker implements Checker {
|
|
7
|
+
/**
|
|
8
|
+
* Fetches latest release information from a GitHub repository
|
|
9
|
+
*/
|
|
10
|
+
fetch(config: AccessConfig): Promise<DependencySnapshot>;
|
|
11
|
+
private fetchLatestCommit;
|
|
12
|
+
/**
|
|
13
|
+
* Compares two snapshots to detect version/state changes
|
|
14
|
+
*/
|
|
15
|
+
compare(prev: DependencySnapshot, curr: DependencySnapshot): Promise<ChangeDetection>;
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=github-repo.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"github-repo.d.ts","sourceRoot":"","sources":["../../src/checkers/github-repo.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG9F,qBAAa,iBAAkB,YAAW,OAAO;IAC/C;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA+D7D;YAKa,iBAAiB;IA4C/B;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAqB1F;CACF"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GitHub Repository Checker
|
|
3
|
+
* Monitors GitHub repositories for new releases and changes
|
|
4
|
+
*/
|
|
5
|
+
import crypto from 'node:crypto';
|
|
6
|
+
export class GitHubRepoChecker {
|
|
7
|
+
/**
|
|
8
|
+
* Fetches latest release information from a GitHub repository
|
|
9
|
+
*/
|
|
10
|
+
async fetch(config) {
|
|
11
|
+
const { url } = config;
|
|
12
|
+
// Extract owner and repo from GitHub URL
|
|
13
|
+
const match = url.match(/github\.com\/([^/]+)\/([^/]+)/);
|
|
14
|
+
if (!match || !match[1] || !match[2]) {
|
|
15
|
+
throw new Error(`Invalid GitHub URL: ${url}`);
|
|
16
|
+
}
|
|
17
|
+
const owner = match[1];
|
|
18
|
+
const repo = match[2];
|
|
19
|
+
const cleanRepo = repo.replace(/\.git$/, '');
|
|
20
|
+
try {
|
|
21
|
+
// Fetch latest release from GitHub API
|
|
22
|
+
const apiUrl = `https://api.github.com/repos/${owner}/${cleanRepo}/releases/latest`;
|
|
23
|
+
const response = await fetch(apiUrl, {
|
|
24
|
+
headers: {
|
|
25
|
+
Accept: 'application/vnd.github+json',
|
|
26
|
+
'User-Agent': 'dependabit',
|
|
27
|
+
...(config.auth?.secret && { Authorization: `Bearer ${config.auth.secret}` })
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
if (response.status === 404) {
|
|
31
|
+
// No releases found, fall back to latest commit
|
|
32
|
+
return this.fetchLatestCommit(owner, cleanRepo, config.auth?.secret);
|
|
33
|
+
}
|
|
34
|
+
if (!response.ok) {
|
|
35
|
+
throw new Error(`GitHub API error: ${response.status} ${response.statusText}`);
|
|
36
|
+
}
|
|
37
|
+
const release = (await response.json());
|
|
38
|
+
// Create state hash from release info
|
|
39
|
+
const stateContent = JSON.stringify({
|
|
40
|
+
tagName: release.tag_name,
|
|
41
|
+
name: release.name,
|
|
42
|
+
publishedAt: release.published_at
|
|
43
|
+
});
|
|
44
|
+
const stateHash = crypto.createHash('sha256').update(stateContent).digest('hex');
|
|
45
|
+
return {
|
|
46
|
+
version: release.tag_name,
|
|
47
|
+
stateHash,
|
|
48
|
+
fetchedAt: new Date(),
|
|
49
|
+
metadata: {
|
|
50
|
+
name: release.name,
|
|
51
|
+
publishedAt: release.published_at,
|
|
52
|
+
body: release.body,
|
|
53
|
+
htmlUrl: release.html_url
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
catch (error) {
|
|
58
|
+
throw new Error(`Failed to fetch GitHub release: ${error.message}`);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Fallback: Fetch latest commit when no releases exist
|
|
63
|
+
*/
|
|
64
|
+
async fetchLatestCommit(owner, repo, token) {
|
|
65
|
+
const apiUrl = `https://api.github.com/repos/${owner}/${repo}/commits?per_page=1`;
|
|
66
|
+
const response = await fetch(apiUrl, {
|
|
67
|
+
headers: {
|
|
68
|
+
Accept: 'application/vnd.github+json',
|
|
69
|
+
'User-Agent': 'dependabit',
|
|
70
|
+
...(token && { Authorization: `Bearer ${token}` })
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
if (!response.ok) {
|
|
74
|
+
throw new Error(`GitHub API error: ${response.status} ${response.statusText}`);
|
|
75
|
+
}
|
|
76
|
+
const commits = (await response.json());
|
|
77
|
+
if (commits.length === 0 || !commits[0]) {
|
|
78
|
+
throw new Error('No commits found in repository');
|
|
79
|
+
}
|
|
80
|
+
const latestCommit = commits[0];
|
|
81
|
+
const stateHash = latestCommit.sha;
|
|
82
|
+
return {
|
|
83
|
+
stateHash,
|
|
84
|
+
fetchedAt: new Date(),
|
|
85
|
+
metadata: {
|
|
86
|
+
sha: latestCommit.sha,
|
|
87
|
+
message: latestCommit.commit.message,
|
|
88
|
+
date: latestCommit.commit.author.date
|
|
89
|
+
}
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Compares two snapshots to detect version/state changes
|
|
94
|
+
*/
|
|
95
|
+
async compare(prev, curr) {
|
|
96
|
+
const changes = [];
|
|
97
|
+
// Check version change
|
|
98
|
+
if (prev.version !== curr.version) {
|
|
99
|
+
if (prev.version && curr.version) {
|
|
100
|
+
changes.push('version');
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
// Check state hash change
|
|
104
|
+
if (prev.stateHash !== curr.stateHash) {
|
|
105
|
+
changes.push('stateHash');
|
|
106
|
+
}
|
|
107
|
+
return {
|
|
108
|
+
hasChanged: changes.length > 0,
|
|
109
|
+
changes,
|
|
110
|
+
oldVersion: prev.version,
|
|
111
|
+
newVersion: curr.version
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=github-repo.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"github-repo.js","sourceRoot":"","sources":["../../src/checkers/github-repo.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,MAAM,OAAO,iBAAiB;IAC5B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAoB,EAA+B;QAC7D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QAEvB,yCAAyC;QACzC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,EAAE,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAE7C,IAAI,CAAC;YACH,uCAAuC;YACvC,MAAM,MAAM,GAAG,gCAAgC,KAAK,IAAI,SAAS,kBAAkB,CAAC;YACpF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;gBACnC,OAAO,EAAE;oBACP,MAAM,EAAE,6BAA6B;oBACrC,YAAY,EAAE,YAAY;oBAC1B,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;iBAC9E;aACF,CAAC,CAAC;YAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,gDAAgD;gBAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACvE,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YACjF,CAAC;YAED,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAMrC,CAAC;YAEF,sCAAsC;YACtC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;gBAClC,OAAO,EAAE,OAAO,CAAC,QAAQ;gBACzB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,WAAW,EAAE,OAAO,CAAC,YAAY;aAClC,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEjF,OAAO;gBACL,OAAO,EAAE,OAAO,CAAC,QAAQ;gBACzB,SAAS;gBACT,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,QAAQ,EAAE;oBACR,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,WAAW,EAAE,OAAO,CAAC,YAAY;oBACjC,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,OAAO,CAAC,QAAQ;iBAC1B;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAoC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,CAAC;IAAA,CACF;IAED;;OAEG;IACK,KAAK,CAAC,iBAAiB,CAC7B,KAAa,EACb,IAAY,EACZ,KAAc,EACe;QAC7B,MAAM,MAAM,GAAG,gCAAgC,KAAK,IAAI,IAAI,qBAAqB,CAAC;QAClF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;YACnC,OAAO,EAAE;gBACP,MAAM,EAAE,6BAA6B;gBACrC,YAAY,EAAE,YAAY;gBAC1B,GAAG,CAAC,KAAK,IAAI,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;aACnD;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAMpC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;QAEnC,OAAO;YACL,SAAS;YACT,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,QAAQ,EAAE;gBACR,GAAG,EAAE,YAAY,CAAC,GAAG;gBACrB,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO;gBACpC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;aACtC;SACF,CAAC;IAAA,CACH;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,IAAwB,EAAE,IAAwB,EAA4B;QAC1F,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,uBAAuB;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,0BAA0B;QAC1B,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO;YACL,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC;YAC9B,OAAO;YACP,UAAU,EAAE,IAAI,CAAC,OAAO;YACxB,UAAU,EAAE,IAAI,CAAC,OAAO;SACzB,CAAC;IAAA,CACH;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/checkers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/checkers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAPI Spec Checker
|
|
3
|
+
* Monitors OpenAPI/Swagger specifications for changes with semantic diffing
|
|
4
|
+
*/
|
|
5
|
+
import type { Checker, DependencySnapshot, ChangeDetection, AccessConfig } from '../types.js';
|
|
6
|
+
export declare class OpenAPIChecker implements Checker {
|
|
7
|
+
/**
|
|
8
|
+
* Fetches and parses OpenAPI specification
|
|
9
|
+
*/
|
|
10
|
+
fetch(config: AccessConfig): Promise<DependencySnapshot>;
|
|
11
|
+
/**
|
|
12
|
+
* Extract endpoints from OpenAPI spec
|
|
13
|
+
*/
|
|
14
|
+
private extractEndpoints;
|
|
15
|
+
/**
|
|
16
|
+
* Extract schemas from OpenAPI spec
|
|
17
|
+
*/
|
|
18
|
+
private extractSchemas;
|
|
19
|
+
/**
|
|
20
|
+
* Compares two OpenAPI snapshots with semantic diffing
|
|
21
|
+
*/
|
|
22
|
+
compare(prev: DependencySnapshot, curr: DependencySnapshot): Promise<ChangeDetection>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=openapi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/checkers/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA2D9F,qBAAa,cAAe,YAAW,OAAO;IAC5C;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAqE7D;IAED;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAgCxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CA4H1F;CACF"}
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAPI Spec Checker
|
|
3
|
+
* Monitors OpenAPI/Swagger specifications for changes with semantic diffing
|
|
4
|
+
*/
|
|
5
|
+
import crypto from 'node:crypto';
|
|
6
|
+
import { parse as parseYAML } from 'yaml';
|
|
7
|
+
export class OpenAPIChecker {
|
|
8
|
+
/**
|
|
9
|
+
* Fetches and parses OpenAPI specification
|
|
10
|
+
*/
|
|
11
|
+
async fetch(config) {
|
|
12
|
+
const { url } = config;
|
|
13
|
+
try {
|
|
14
|
+
const headers = {
|
|
15
|
+
Accept: 'application/json, application/yaml, text/yaml, */*',
|
|
16
|
+
'User-Agent': 'dependabit-monitor/1.0'
|
|
17
|
+
};
|
|
18
|
+
if (config.auth?.secret) {
|
|
19
|
+
if (config.auth.type === 'token' || config.auth.type === 'oauth') {
|
|
20
|
+
headers['Authorization'] = `Bearer ${config.auth.secret}`;
|
|
21
|
+
}
|
|
22
|
+
else if (config.auth.type === 'basic') {
|
|
23
|
+
headers['Authorization'] = `Basic ${config.auth.secret}`;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
const response = await fetch(url, {
|
|
27
|
+
headers
|
|
28
|
+
});
|
|
29
|
+
if (!response.ok) {
|
|
30
|
+
throw new Error(`HTTP error: ${response.status} ${response.statusText}`);
|
|
31
|
+
}
|
|
32
|
+
const contentType = response.headers.get('content-type') || '';
|
|
33
|
+
const content = await response.text();
|
|
34
|
+
// Parse the OpenAPI spec
|
|
35
|
+
let spec;
|
|
36
|
+
if (contentType.includes('yaml') || url.endsWith('.yaml') || url.endsWith('.yml')) {
|
|
37
|
+
// Parse YAML using standard yaml library
|
|
38
|
+
spec = parseYAML(content);
|
|
39
|
+
}
|
|
40
|
+
else {
|
|
41
|
+
spec = JSON.parse(content);
|
|
42
|
+
}
|
|
43
|
+
// Extract key information for semantic comparison
|
|
44
|
+
const endpoints = this.extractEndpoints(spec);
|
|
45
|
+
const schemas = this.extractSchemas(spec);
|
|
46
|
+
const version = spec.info?.version;
|
|
47
|
+
// Create a deterministic hash from the semantic content
|
|
48
|
+
const semanticContent = JSON.stringify({
|
|
49
|
+
version,
|
|
50
|
+
endpoints: Object.keys(endpoints).sort(),
|
|
51
|
+
schemas: Object.keys(schemas).sort(),
|
|
52
|
+
endpointDetails: endpoints,
|
|
53
|
+
schemaDetails: schemas
|
|
54
|
+
});
|
|
55
|
+
const stateHash = crypto.createHash('sha256').update(semanticContent).digest('hex');
|
|
56
|
+
return {
|
|
57
|
+
version,
|
|
58
|
+
stateHash,
|
|
59
|
+
fetchedAt: new Date(),
|
|
60
|
+
metadata: {
|
|
61
|
+
title: spec.info?.title,
|
|
62
|
+
description: spec.info?.description,
|
|
63
|
+
specVersion: spec.openapi || spec.swagger,
|
|
64
|
+
endpointCount: Object.keys(endpoints).length,
|
|
65
|
+
schemaCount: Object.keys(schemas).length,
|
|
66
|
+
endpoints,
|
|
67
|
+
schemas
|
|
68
|
+
}
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
catch (error) {
|
|
72
|
+
throw new Error(`Failed to fetch OpenAPI spec: ${error.message}`);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Extract endpoints from OpenAPI spec
|
|
77
|
+
*/
|
|
78
|
+
extractEndpoints(spec) {
|
|
79
|
+
const endpoints = {};
|
|
80
|
+
if (!spec.paths)
|
|
81
|
+
return endpoints;
|
|
82
|
+
for (const [path, pathItem] of Object.entries(spec.paths)) {
|
|
83
|
+
const methods = [];
|
|
84
|
+
const httpMethods = [
|
|
85
|
+
'get',
|
|
86
|
+
'post',
|
|
87
|
+
'put',
|
|
88
|
+
'patch',
|
|
89
|
+
'delete',
|
|
90
|
+
'options',
|
|
91
|
+
'head',
|
|
92
|
+
'trace'
|
|
93
|
+
];
|
|
94
|
+
for (const method of httpMethods) {
|
|
95
|
+
if (pathItem[method]) {
|
|
96
|
+
methods.push(method.toUpperCase());
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
if (methods.length > 0) {
|
|
100
|
+
endpoints[path] = methods;
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
return endpoints;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Extract schemas from OpenAPI spec
|
|
107
|
+
*/
|
|
108
|
+
extractSchemas(spec) {
|
|
109
|
+
return spec.components?.schemas || {};
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Compares two OpenAPI snapshots with semantic diffing
|
|
113
|
+
*/
|
|
114
|
+
async compare(prev, curr) {
|
|
115
|
+
const changes = [];
|
|
116
|
+
let severity = 'minor';
|
|
117
|
+
// Extract endpoints and schemas from metadata
|
|
118
|
+
let prevEndpoints = prev.metadata?.['endpoints'] || {};
|
|
119
|
+
let currEndpoints = curr.metadata?.['endpoints'] || {};
|
|
120
|
+
let prevSchemas = prev.metadata?.['schemas'] || {};
|
|
121
|
+
let currSchemas = curr.metadata?.['schemas'] || {};
|
|
122
|
+
// If the state hashes match but previous metadata is missing, avoid spurious diffs
|
|
123
|
+
if (prev.stateHash !== undefined &&
|
|
124
|
+
curr.stateHash !== undefined &&
|
|
125
|
+
prev.stateHash === curr.stateHash) {
|
|
126
|
+
prevEndpoints = currEndpoints;
|
|
127
|
+
prevSchemas = currSchemas;
|
|
128
|
+
}
|
|
129
|
+
const diff = {
|
|
130
|
+
addedEndpoints: [],
|
|
131
|
+
removedEndpoints: [],
|
|
132
|
+
modifiedEndpoints: [],
|
|
133
|
+
addedSchemas: [],
|
|
134
|
+
removedSchemas: [],
|
|
135
|
+
modifiedSchemas: [],
|
|
136
|
+
versionChanged: prev.version !== curr.version
|
|
137
|
+
};
|
|
138
|
+
if (prev.version !== undefined) {
|
|
139
|
+
diff.oldVersion = prev.version;
|
|
140
|
+
}
|
|
141
|
+
if (curr.version !== undefined) {
|
|
142
|
+
diff.newVersion = curr.version;
|
|
143
|
+
}
|
|
144
|
+
// Compare endpoints
|
|
145
|
+
const prevEndpointKeys = Object.keys(prevEndpoints);
|
|
146
|
+
const currEndpointKeys = Object.keys(currEndpoints);
|
|
147
|
+
for (const path of currEndpointKeys) {
|
|
148
|
+
if (!prevEndpointKeys.includes(path)) {
|
|
149
|
+
diff.addedEndpoints.push(path);
|
|
150
|
+
}
|
|
151
|
+
else if (JSON.stringify(prevEndpoints[path]) !== JSON.stringify(currEndpoints[path])) {
|
|
152
|
+
diff.modifiedEndpoints.push(path);
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
for (const path of prevEndpointKeys) {
|
|
156
|
+
if (!currEndpointKeys.includes(path)) {
|
|
157
|
+
diff.removedEndpoints.push(path);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
// Compare schemas
|
|
161
|
+
const prevSchemaKeys = Object.keys(prevSchemas);
|
|
162
|
+
const currSchemaKeys = Object.keys(currSchemas);
|
|
163
|
+
for (const schema of currSchemaKeys) {
|
|
164
|
+
if (!prevSchemaKeys.includes(schema)) {
|
|
165
|
+
diff.addedSchemas.push(schema);
|
|
166
|
+
}
|
|
167
|
+
else if (JSON.stringify(prevSchemas[schema]) !== JSON.stringify(currSchemas[schema])) {
|
|
168
|
+
diff.modifiedSchemas.push(schema);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
for (const schema of prevSchemaKeys) {
|
|
172
|
+
if (!currSchemaKeys.includes(schema)) {
|
|
173
|
+
diff.removedSchemas.push(schema);
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
// Determine changes and severity
|
|
177
|
+
if (diff.removedEndpoints.length > 0) {
|
|
178
|
+
changes.push('endpoints_removed');
|
|
179
|
+
severity = 'breaking';
|
|
180
|
+
}
|
|
181
|
+
if (diff.removedSchemas.length > 0) {
|
|
182
|
+
changes.push('schemas_removed');
|
|
183
|
+
severity = 'breaking';
|
|
184
|
+
}
|
|
185
|
+
if (diff.modifiedEndpoints.length > 0) {
|
|
186
|
+
changes.push('endpoints_modified');
|
|
187
|
+
if (severity !== 'breaking')
|
|
188
|
+
severity = 'major';
|
|
189
|
+
}
|
|
190
|
+
if (diff.modifiedSchemas.length > 0) {
|
|
191
|
+
changes.push('schemas_modified');
|
|
192
|
+
if (severity !== 'breaking')
|
|
193
|
+
severity = 'major';
|
|
194
|
+
}
|
|
195
|
+
if (diff.addedEndpoints.length > 0) {
|
|
196
|
+
changes.push('endpoints_added');
|
|
197
|
+
}
|
|
198
|
+
if (diff.addedSchemas.length > 0) {
|
|
199
|
+
changes.push('schemas_added');
|
|
200
|
+
}
|
|
201
|
+
if (diff.versionChanged) {
|
|
202
|
+
changes.push('version');
|
|
203
|
+
}
|
|
204
|
+
// Check overall hash change
|
|
205
|
+
if (prev.stateHash !== curr.stateHash && changes.length === 0) {
|
|
206
|
+
changes.push('content');
|
|
207
|
+
}
|
|
208
|
+
const result = {
|
|
209
|
+
hasChanged: changes.length > 0,
|
|
210
|
+
changes,
|
|
211
|
+
oldVersion: prev.version,
|
|
212
|
+
newVersion: curr.version,
|
|
213
|
+
diff
|
|
214
|
+
};
|
|
215
|
+
if (changes.length > 0) {
|
|
216
|
+
result.severity = severity;
|
|
217
|
+
}
|
|
218
|
+
return result;
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
//# sourceMappingURL=openapi.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../../src/checkers/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAyD1C,MAAM,OAAO,cAAc;IACzB;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAoB,EAA+B;QAC7D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,OAAO,GAA2B;gBACtC,MAAM,EAAE,oDAAoD;gBAC5D,YAAY,EAAE,wBAAwB;aACvC,CAAC;YAEF,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;gBACxB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBACjE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC5D,CAAC;qBAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBACxC,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3D,CAAC;YACH,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAChC,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YAC3E,CAAC;YAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEtC,yBAAyB;YACzB,IAAI,IAAqB,CAAC;YAC1B,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClF,yCAAyC;gBACzC,IAAI,GAAG,SAAS,CAAC,OAAO,CAAoB,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAoB,CAAC;YAChD,CAAC;YAED,kDAAkD;YAClD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC;YAEnC,wDAAwD;YACxD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC;gBACrC,OAAO;gBACP,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE;gBACxC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE;gBACpC,eAAe,EAAE,SAAS;gBAC1B,aAAa,EAAE,OAAO;aACvB,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEpF,OAAO;gBACL,OAAO;gBACP,SAAS;gBACT,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,QAAQ,EAAE;oBACR,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK;oBACvB,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW;oBACnC,WAAW,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;oBACzC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM;oBAC5C,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM;oBACxC,SAAS;oBACT,OAAO;iBACR;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iCAAkC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/E,CAAC;IAAA,CACF;IAED;;OAEG;IACK,gBAAgB,CAAC,IAAqB,EAA4B;QACxE,MAAM,SAAS,GAA6B,EAAE,CAAC;QAE/C,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAElC,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAG;gBAClB,KAAK;gBACL,MAAM;gBACN,KAAK;gBACL,OAAO;gBACP,QAAQ;gBACR,SAAS;gBACT,MAAM;gBACN,OAAO;aACC,CAAC;YAEX,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;gBACjC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACrB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IAAA,CAClB;IAED;;OAEG;IACK,cAAc,CAAC,IAAqB,EAA2B;QACrE,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,EAAE,CAAC;IAAA,CACvC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,IAAwB,EAAE,IAAwB,EAA4B;QAC1F,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,QAAQ,GAAmC,OAAO,CAAC;QAEvD,8CAA8C;QAC9C,IAAI,aAAa,GAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,CAA8B,IAAI,EAAE,CAAC;QACrF,IAAI,aAAa,GAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,CAA8B,IAAI,EAAE,CAAC;QACrF,IAAI,WAAW,GAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,CAA6B,IAAI,EAAE,CAAC;QAChF,IAAI,WAAW,GAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,CAA6B,IAAI,EAAE,CAAC;QAEhF,mFAAmF;QACnF,IACE,IAAI,CAAC,SAAS,KAAK,SAAS;YAC5B,IAAI,CAAC,SAAS,KAAK,SAAS;YAC5B,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,EACjC,CAAC;YACD,aAAa,GAAG,aAAa,CAAC;YAC9B,WAAW,GAAG,WAAW,CAAC;QAC5B,CAAC;QACD,MAAM,IAAI,GAAgB;YACxB,cAAc,EAAE,EAAE;YAClB,gBAAgB,EAAE,EAAE;YACpB,iBAAiB,EAAE,EAAE;YACrB,YAAY,EAAE,EAAE;YAChB,cAAc,EAAE,EAAE;YAClB,eAAe,EAAE,EAAE;YACnB,cAAc,EAAE,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;SAC9C,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,CAAC;QAED,oBAAoB;QACpB,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpD,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;YACpC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC;iBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBACvF,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;YACpC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhD,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;YACpC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjC,CAAC;iBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACvF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;YACpC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,iCAAiC;QACjC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAClC,QAAQ,GAAG,UAAU,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAChC,QAAQ,GAAG,UAAU,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACnC,IAAI,QAAQ,KAAK,UAAU;gBAAE,QAAQ,GAAG,OAAO,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjC,IAAI,QAAQ,KAAK,UAAU;gBAAE,QAAQ,GAAG,OAAO,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,4BAA4B;QAC5B,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9D,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,MAAM,MAAM,GAAoB;YAC9B,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC;YAC9B,OAAO;YACP,UAAU,EAAE,IAAI,CAAC,OAAO;YACxB,UAAU,EAAE,IAAI,CAAC,OAAO;YACxB,IAAI;SACL,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,CAAC;QAED,OAAO,MAAM,CAAC;IAAA,CACf;CACF"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* URL Content Checker
|
|
3
|
+
* Monitors documentation URLs for content changes using SHA256 hashing
|
|
4
|
+
*/
|
|
5
|
+
import type { Checker, DependencySnapshot, ChangeDetection, AccessConfig } from '../types.js';
|
|
6
|
+
export declare class URLContentChecker implements Checker {
|
|
7
|
+
/**
|
|
8
|
+
* Fetches and hashes URL content
|
|
9
|
+
*/
|
|
10
|
+
fetch(config: AccessConfig): Promise<DependencySnapshot>;
|
|
11
|
+
/**
|
|
12
|
+
* Compares two snapshots to detect content changes
|
|
13
|
+
*/
|
|
14
|
+
compare(prev: DependencySnapshot, curr: DependencySnapshot): Promise<ChangeDetection>;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=url-content.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"url-content.d.ts","sourceRoot":"","sources":["../../src/checkers/url-content.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAI9F,qBAAa,iBAAkB,YAAW,OAAO;IAC/C;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA8C7D;IAED;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAY1F;CACF"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* URL Content Checker
|
|
3
|
+
* Monitors documentation URLs for content changes using SHA256 hashing
|
|
4
|
+
*/
|
|
5
|
+
import { normalizeHTML } from '../normalizer.js';
|
|
6
|
+
import crypto from 'node:crypto';
|
|
7
|
+
export class URLContentChecker {
|
|
8
|
+
/**
|
|
9
|
+
* Fetches and hashes URL content
|
|
10
|
+
*/
|
|
11
|
+
async fetch(config) {
|
|
12
|
+
const { url } = config;
|
|
13
|
+
try {
|
|
14
|
+
const response = await fetch(url, {
|
|
15
|
+
headers: {
|
|
16
|
+
'User-Agent': 'dependabit-monitor/1.0'
|
|
17
|
+
}
|
|
18
|
+
});
|
|
19
|
+
if (!response.ok) {
|
|
20
|
+
throw new Error(`HTTP error: ${response.status} ${response.statusText}`);
|
|
21
|
+
}
|
|
22
|
+
const contentType = response.headers.get('content-type') || '';
|
|
23
|
+
const content = await response.text();
|
|
24
|
+
let normalizedContent;
|
|
25
|
+
// Apply HTML normalization if content is HTML
|
|
26
|
+
if (contentType.includes('text/html') ||
|
|
27
|
+
content.trim().startsWith('<!DOCTYPE') ||
|
|
28
|
+
content.trim().startsWith('<html')) {
|
|
29
|
+
normalizedContent = normalizeHTML(content);
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
// For non-HTML content (markdown, plain text, etc.), just normalize whitespace
|
|
33
|
+
normalizedContent = content.replace(/\s+/g, ' ').trim();
|
|
34
|
+
}
|
|
35
|
+
// Generate SHA256 hash of normalized content
|
|
36
|
+
const stateHash = crypto.createHash('sha256').update(normalizedContent).digest('hex');
|
|
37
|
+
return {
|
|
38
|
+
stateHash,
|
|
39
|
+
fetchedAt: new Date(),
|
|
40
|
+
metadata: {
|
|
41
|
+
contentType,
|
|
42
|
+
contentLength: content.length,
|
|
43
|
+
normalizedLength: normalizedContent.length
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
catch (error) {
|
|
48
|
+
throw new Error(`Failed to fetch URL content: ${error.message}`);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Compares two snapshots to detect content changes
|
|
53
|
+
*/
|
|
54
|
+
async compare(prev, curr) {
|
|
55
|
+
const changes = [];
|
|
56
|
+
// Content changed if hashes differ
|
|
57
|
+
if (prev.stateHash !== curr.stateHash) {
|
|
58
|
+
changes.push('content');
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
hasChanged: changes.length > 0,
|
|
62
|
+
changes
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=url-content.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"url-content.js","sourceRoot":"","sources":["../../src/checkers/url-content.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,MAAM,OAAO,iBAAiB;IAC5B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAoB,EAA+B;QAC7D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAChC,OAAO,EAAE;oBACP,YAAY,EAAE,wBAAwB;iBACvC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YAC3E,CAAC;YAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEtC,IAAI,iBAAyB,CAAC;YAE9B,8CAA8C;YAC9C,IACE,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;gBACjC,OAAO,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;gBACtC,OAAO,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAClC,CAAC;gBACD,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,+EAA+E;gBAC/E,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAC1D,CAAC;YAED,6CAA6C;YAC7C,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEtF,OAAO;gBACL,SAAS;gBACT,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,QAAQ,EAAE;oBACR,WAAW;oBACX,aAAa,EAAE,OAAO,CAAC,MAAM;oBAC7B,gBAAgB,EAAE,iBAAiB,CAAC,MAAM;iBAC3C;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,gCAAiC,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9E,CAAC;IAAA,CACF;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,IAAwB,EAAE,IAAwB,EAA4B;QAC1F,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,mCAAmC;QACnC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO;YACL,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC;YAC9B,OAAO;SACR,CAAC;IAAA,CACH;CACF"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* State Comparator
|
|
3
|
+
* Generic comparison logic for dependency state snapshots
|
|
4
|
+
*/
|
|
5
|
+
import type { DependencySnapshot, ChangeDetection } from './types.js';
|
|
6
|
+
export declare class StateComparator {
|
|
7
|
+
/**
|
|
8
|
+
* Compares two dependency snapshots to detect changes
|
|
9
|
+
*/
|
|
10
|
+
compare(oldState: DependencySnapshot, newState: DependencySnapshot): ChangeDetection;
|
|
11
|
+
/**
|
|
12
|
+
* Checks if metadata has changed (shallow comparison)
|
|
13
|
+
*/
|
|
14
|
+
private hasMetadataChanges;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=comparator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"comparator.d.ts","sourceRoot":"","sources":["../src/comparator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEtE,qBAAa,eAAe;IAC1B;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,kBAAkB,GAAG,eAAe,CAwBnF;IAED;;OAEG;IACH,OAAO,CAAC,kBAAkB;CA2B3B"}
|