@mcoda/integrations 0.1.7 → 0.1.8

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 CHANGED
@@ -3,5 +3,5 @@
3
3
  ## Unreleased
4
4
  - Initial public packaging for @mcoda/integrations.
5
5
 
6
- ## 0.1.7
6
+ ## 0.1.8
7
7
  - Initial release.
package/README.md CHANGED
@@ -1,9 +1,33 @@
1
1
  # @mcoda/integrations
2
2
 
3
- External integrations for mcoda (vcs, QA, telemetry).
3
+ External integrations for mcoda (docdex, telemetry, VCS, QA runners, update checks).
4
4
 
5
- ## Usage
6
- This package is primarily an internal dependency of `mcoda`.
5
+ ## Install
6
+ - Requires Node.js >= 20.
7
+ - Install: `npm i @mcoda/integrations`
8
+
9
+ ## What it provides
10
+ - DocdexClient for local or remote docdex queries.
11
+ - TelemetryClient for token usage reporting.
12
+ - VcsClient for Git operations.
13
+ - SystemClient for update checks.
14
+ - QA adapters (Chromium, Maestro, CLI) and types.
15
+
16
+ ## Example
17
+ ```ts
18
+ import { DocdexClient } from "@mcoda/integrations";
19
+
20
+ const client = new DocdexClient({
21
+ workspaceRoot: process.cwd(),
22
+ baseUrl: process.env.MCODA_DOCDEX_URL,
23
+ });
24
+
25
+ const docs = await client.search({ docType: "rfp", query: "payments" });
26
+ ```
27
+
28
+ ## Notes
29
+ - Some integrations call external services; configure base URLs and tokens as needed.
30
+ - Primarily used by the mcoda CLI; APIs may evolve.
7
31
 
8
32
  ## License
9
33
  MIT - see `LICENSE`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mcoda/integrations",
3
- "version": "0.1.7",
3
+ "version": "0.1.8",
4
4
  "description": "External integrations for mcoda (vcs, QA, telemetry).",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -37,7 +37,7 @@
37
37
  "access": "public"
38
38
  },
39
39
  "dependencies": {
40
- "@mcoda/shared": "0.1.7"
40
+ "@mcoda/shared": "0.1.8"
41
41
  },
42
42
  "scripts": {
43
43
  "build": "tsc -p tsconfig.json",