@ghcrawl/api-contract 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,18 @@
+# @ghcrawl/api-contract
+
+Internal shared API contract package for `ghcrawl`.
+
+This package contains transport schemas, DTOs, and the typed client used by the `ghcrawl` CLI and related tooling.
+
+Most users should not install this package directly.
+
+Use the main CLI package instead:
+
+```bash
+npm install -g ghcrawl
+```
+
+Project docs:
+
+- [GitHub repository](https://github.com/pwrdrvr/ghcrawl)
+- [Project README](https://github.com/pwrdrvr/ghcrawl#readme)

package/dist/client.d.ts

@@ -0,0 +1,41 @@
+import { type ActionRequest, type ActionResponse, type ClusterDetailResponse, type ClusterSummariesResponse, type ClustersResponse, type HealthResponse, type RefreshRequest, type RefreshResponse, type RepositoriesResponse, type SearchMode, type SearchResponse, type ThreadsResponse } from './contracts.js';
+export type GitcrawlClient = {
+    health: () => Promise<HealthResponse>;
+    listRepositories: () => Promise<RepositoriesResponse>;
+    listThreads: (params: {
+        owner: string;
+        repo: string;
+        kind?: 'issue' | 'pull_request';
+    }) => Promise<ThreadsResponse>;
+    search: (params: {
+        owner: string;
+        repo: string;
+        query: string;
+        mode?: SearchMode;
+    }) => Promise<SearchResponse>;
+    listClusters: (params: {
+        owner: string;
+        repo: string;
+    }) => Promise<ClustersResponse>;
+    listClusterSummaries: (params: {
+        owner: string;
+        repo: string;
+        minSize?: number;
+        limit?: number;
+        sort?: 'recent' | 'size';
+        search?: string;
+    }) => Promise<ClusterSummariesResponse>;
+    getClusterDetail: (params: {
+        owner: string;
+        repo: string;
+        clusterId: number;
+        memberLimit?: number;
+        bodyChars?: number;
+    }) => Promise<ClusterDetailResponse>;
+    refresh: (request: RefreshRequest) => Promise<RefreshResponse>;
+    rerun: (request: ActionRequest) => Promise<ActionResponse>;
+};
+type FetchLike = typeof fetch;
+export declare function createGitcrawlClient(baseUrl: string, fetchImpl?: FetchLike): GitcrawlClient;
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,EACrB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IACtC,gBAAgB,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACtD,WAAW,EAAE,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,GAAG,cAAc,CAAA;KAAE,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IACpH,MAAM,EAAE,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,UAAU,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/G,YAAY,EAAE,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrF,oBAAoB,EAAE,CAAC,MAAM,EAAE;QAC7B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACxC,gBAAgB,EAAE,CAAC,MAAM,EAAE;QACzB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/D,KAAK,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5D,CAAC;AAEF,KAAK,SAAS,GAAG,OAAO,KAAK,CAAC;AAW9B,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,GAAE,SAAiB,GAAG,cAAc,CAwElG"}

package/dist/client.js

@@ -0,0 +1,90 @@
+import { actionRequestSchema, actionResponseSchema, clusterDetailResponseSchema, clusterSummariesResponseSchema, clustersResponseSchema, healthResponseSchema, refreshRequestSchema, refreshResponseSchema, repositoriesResponseSchema, searchResponseSchema, threadsResponseSchema, } from './contracts.js';
+async function readJson(res, schema) {
+    if (!res.ok) {
+        const text = await res.text().catch(() => '');
+        throw new Error(`API request failed ${res.status} ${res.statusText}: ${text.slice(0, 2000)}`);
+    }
+    const value = (await res.json());
+    return schema.parse(value);
+}
+export function createGitcrawlClient(baseUrl, fetchImpl = fetch) {
+    const normalized = baseUrl.replace(/\/+$/, '');
+    return {
+        async health() {
+            const res = await fetchImpl(`${normalized}/health`);
+            return readJson(res, healthResponseSchema);
+        },
+        async listRepositories() {
+            const res = await fetchImpl(`${normalized}/repositories`);
+            return readJson(res, repositoriesResponseSchema);
+        },
+        async listThreads(params) {
+            const search = new URLSearchParams({ owner: params.owner, repo: params.repo });
+            if (params.kind)
+                search.set('kind', params.kind);
+            const res = await fetchImpl(`${normalized}/threads?${search.toString()}`);
+            return readJson(res, threadsResponseSchema);
+        },
+        async search(params) {
+            const search = new URLSearchParams({
+                owner: params.owner,
+                repo: params.repo,
+                query: params.query,
+            });
+            if (params.mode)
+                search.set('mode', params.mode);
+            const res = await fetchImpl(`${normalized}/search?${search.toString()}`);
+            return readJson(res, searchResponseSchema);
+        },
+        async listClusters(params) {
+            const search = new URLSearchParams({ owner: params.owner, repo: params.repo });
+            const res = await fetchImpl(`${normalized}/clusters?${search.toString()}`);
+            return readJson(res, clustersResponseSchema);
+        },
+        async listClusterSummaries(params) {
+            const search = new URLSearchParams({ owner: params.owner, repo: params.repo });
+            if (params.minSize !== undefined)
+                search.set('minSize', String(params.minSize));
+            if (params.limit !== undefined)
+                search.set('limit', String(params.limit));
+            if (params.sort)
+                search.set('sort', params.sort);
+            if (params.search)
+                search.set('search', params.search);
+            const res = await fetchImpl(`${normalized}/cluster-summaries?${search.toString()}`);
+            return readJson(res, clusterSummariesResponseSchema);
+        },
+        async getClusterDetail(params) {
+            const search = new URLSearchParams({
+                owner: params.owner,
+                repo: params.repo,
+                clusterId: String(params.clusterId),
+            });
+            if (params.memberLimit !== undefined)
+                search.set('memberLimit', String(params.memberLimit));
+            if (params.bodyChars !== undefined)
+                search.set('bodyChars', String(params.bodyChars));
+            const res = await fetchImpl(`${normalized}/cluster-detail?${search.toString()}`);
+            return readJson(res, clusterDetailResponseSchema);
+        },
+        async refresh(request) {
+            const body = refreshRequestSchema.parse(request);
+            const res = await fetchImpl(`${normalized}/actions/refresh`, {
+                method: 'POST',
+                headers: { 'content-type': 'application/json' },
+                body: JSON.stringify(body),
+            });
+            return readJson(res, refreshResponseSchema);
+        },
+        async rerun(request) {
+            const body = actionRequestSchema.parse(request);
+            const res = await fetchImpl(`${normalized}/actions/rerun`, {
+                method: 'POST',
+                headers: { 'content-type': 'application/json' },
+                body: JSON.stringify(body),
+            });
+            return readJson(res, actionResponseSchema);
+        },
+    };
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,8BAA8B,EAC9B,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,EAC1B,oBAAoB,EACpB,qBAAqB,GAatB,MAAM,gBAAgB,CAAC;AA6BxB,KAAK,UAAU,QAAQ,CAAI,GAAa,EAAE,MAAwC;IAChF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,sBAAsB,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAChG,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAY,CAAC;IAC5C,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAe,EAAE,YAAuB,KAAK;IAChF,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAE/C,OAAO;QACL,KAAK,CAAC,MAAM;YACV,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,SAAS,CAAC,CAAC;YACpD,OAAO,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,gBAAgB;YACpB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,eAAe,CAAC,CAAC;YAC1D,OAAO,QAAQ,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,CAAC,WAAW,CAAC,MAAM;YACtB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/E,IAAI,MAAM,CAAC,IAAI;gBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YACjD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,YAAY,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC1E,OAAO,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;gBACjC,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,IAAI;gBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YACjD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,WAAW,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACzE,OAAO,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,YAAY,CAAC,MAAM;YACvB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/E,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,aAAa,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC3E,OAAO,QAAQ,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,CAAC,oBAAoB,CAAC,MAAM;YAC/B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/E,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;gBAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAChF,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;gBAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1E,IAAI,MAAM,CAAC,IAAI;gBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,MAAM;gBAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACvD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,sBAAsB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACpF,OAAO,QAAQ,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC;QACvD,CAAC;QACD,KAAK,CAAC,gBAAgB,CAAC,MAAM;YAC3B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;gBACjC,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;aACpC,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS;gBAAE,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;YAC5F,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS;gBAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACtF,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,mBAAmB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACjF,OAAO,QAAQ,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAAO;YACnB,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,kBAAkB,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,OAAO;YACjB,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,UAAU,gBAAgB,EAAE;gBACzD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC"}