Mirror 2b8c398 (2026-03-17)

Author: Prompsit CI

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## What
+
+<!-- Brief description of what this PR does. -->
+
+## Why
+
+<!-- Motivation: what problem does this solve? -->
+
+## How
+
+<!-- Key implementation details, trade-offs. -->
+
+## Checklist
+
+- [ ] `npm run lint:all` passes
+- [ ] `npm run test` passes
+- [ ] Changes follow [CONTRIBUTING.md](CONTRIBUTING.md) guidelines
+- [ ] Documentation updated (if applicable)
+
+## Related Issues
+
+<!-- Closes #123, Related to #456 -->

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    name: Lint & Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - run: npm ci
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Format check
+        run: npm run format:check
+
+      - name: Unit tests
+        run: npm run test:unit
+
+      - name: Build
+        run: npm run build

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: npm
+
+      - run: npm ci
+
+      - name: Typecheck
+        run: npm run typecheck
+
+      - name: Unit tests
+        run: npm run test:unit
+
+      - run: npm run build
+
+      - name: Set version from release tag
+        run: npm version --no-git-tag-version "${GITHUB_REF_NAME#v}" --allow-same-version
+
+      - run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,10 +1,11 @@
 # Prompsit CLI
 
+[![CI](https://github.com/Prompsit/prompsit-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/Prompsit/prompsit-cli/actions/workflows/ci.yml)
 [![npm version](https://img.shields.io/npm/v/prompsit-cli)](https://www.npmjs.com/package/prompsit-cli)
 [![license](https://img.shields.io/npm/l/prompsit-cli)](https://www.npmjs.com/package/prompsit-cli)
 [![node](https://img.shields.io/node/v/prompsit-cli)](https://nodejs.org/)
 
-One CLI for many services from the Prompsit API. Translate text and documents, evaluate translation quality, score parallel corpora with Bicleaner-AI, and annotate monolingual data with Monotextor — from your terminal or an interactive REPL.
+One CLI for the entire Prompsit Translation API. Translate text and documents, evaluate translation quality, score parallel corpora with Bicleaner-AI, and annotate monolingual data with Monotextor — from your terminal or an interactive REPL.
 
 ## Quick Start
 

package-lock.json

@@ -3,7 +3,10 @@
 // Pattern: public fallback -> proactive refresh -> request -> reactive 401 retry
 
 import type { Method, Options as GotOptions } from "got";
+import type { Progress } from "./transport.ts";
 import type { HttpTransport, RawResponse } from "./transport.ts";
+
+export type { Progress } from "./transport.ts";
 import { AuthResource } from "./resources/auth.ts";
 import { AuthenticationError, NetworkError, ServerError } from "./errors.ts";
 import {
@@ -43,10 +46,12 @@ export class AuthSession {
     method: Method,
     url: string,
     options: Partial<GotOptions> = {},
-    signal?: AbortSignal
+    signal?: AbortSignal,
+    onUploadProgress?: (progress: Progress) => void
   ): Promise<T> {
     return this.withAuth(
-      (publicFlag, sig) => this.transport.request<T>(method, url, options, publicFlag, sig),
+      (publicFlag, sig) =>
+        this.transport.request<T>(method, url, options, publicFlag, sig, onUploadProgress),
       signal
     );
   }
@@ -70,11 +75,20 @@ export class AuthSession {
     url: string,
     outputPath: string,
     options: Partial<GotOptions> = {},
-    signal?: AbortSignal
+    signal?: AbortSignal,
+    onDownloadProgress?: (progress: Progress) => void
   ): Promise<string> {
     return this.withAuth(
       (publicFlag, sig) =>
-        this.transport.requestToFile(method, url, outputPath, options, publicFlag, sig),
+        this.transport.requestToFile(
+          method,
+          url,
+          outputPath,
+          options,
+          publicFlag,
+          sig,
+          onDownloadProgress
+        ),
       signal
     );
   }

src/api/auth-session.ts

@@ -4,7 +4,7 @@
 
 import { openAsBlob } from "node:fs";
 import { basename } from "node:path";
-import type { AuthSession } from "../auth-session.ts";
+import type { AuthSession, Progress } from "../auth-session.ts";
 import {
   DataJobCreateResponseSchema,
   type DataJobCreateResponse,
@@ -35,7 +35,10 @@ export class DataResource {
    * @param params - Annotation parameters (file, lang, pipeline, optional filters)
    * @returns DataJobCreateResponse with job_id for tracking
    */
-  async annotate(params: AnnotateParams): Promise<DataJobCreateResponse> {
+  async annotate(
+    params: AnnotateParams,
+    onUploadProgress?: (progress: Progress) => void
+  ): Promise<DataJobCreateResponse> {
     const { filePath, lang, pipeline, minLen, minAvgWords, lidModel } = params;
     const fileBlob = await openAsBlob(filePath);
     const fileName = basename(filePath);
@@ -51,7 +54,9 @@ export class DataResource {
     const data = await this.session.request<unknown>(
       "POST",
       `${this.baseUrl}${Endpoint.DATA_ANNOTATE}`,
-      { body: formData }
+      { body: formData },
+      undefined,
+      onUploadProgress
     );
 
     return DataJobCreateResponseSchema.parse(data);
@@ -70,7 +75,10 @@ export class DataResource {
    * @throws ZodError if response schema mismatch
    * @throws APIError on API errors
    */
-  async score(params: ScoreParams): Promise<DataJobCreateResponse> {
+  async score(
+    params: ScoreParams,
+    onUploadProgress?: (progress: Progress) => void
+  ): Promise<DataJobCreateResponse> {
     const { sourceFile, targetFile, outputFormat, sourceLang } = params;
     const baseUrl = this.baseUrl;
     const sourceBlob = await openAsBlob(sourceFile);
@@ -91,9 +99,13 @@ export class DataResource {
       formData.append("source_lang", sourceLang);
     }
 
-    const data = await this.session.request<unknown>("POST", `${baseUrl}${Endpoint.DATA_SCORE}`, {
-      body: formData,
-    });
+    const data = await this.session.request<unknown>(
+      "POST",
+      `${baseUrl}${Endpoint.DATA_SCORE}`,
+      { body: formData },
+      undefined,
+      onUploadProgress
+    );
 
     return DataJobCreateResponseSchema.parse(data);
   }

src/api/resources/data.ts

@@ -2,7 +2,7 @@
 // Used by translate file and data commands for job lifecycle.
 // All methods go through AuthSession for auth, retry, hooks, and error classification.
 
-import type { AuthSession } from "../auth-session.ts";
+import type { AuthSession, Progress } from "../auth-session.ts";
 import { JobStatusResponseSchema, type JobStatusResponse } from "../models.ts";
 import { Endpoint } from "../../shared/constants.ts";
 
@@ -54,9 +54,14 @@ export class JobsResource {
    * @param signal - Optional abort signal for cancellation
    * @returns The output path
    */
-  async download(resultUrl: string, outputPath: string, signal?: AbortSignal): Promise<string> {
+  async download(
+    resultUrl: string,
+    outputPath: string,
+    signal?: AbortSignal,
+    onDownloadProgress?: (progress: Progress) => void
+  ): Promise<string> {
     const url = `${this.baseUrl}${resultUrl}`;
 
-    return this.session.requestToFile("GET", url, outputPath, {}, signal);
+    return this.session.requestToFile("GET", url, outputPath, {}, signal, onDownloadProgress);
   }
 }

src/api/resources/jobs.ts

@@ -1,7 +1,7 @@
 // See API-469, API-494: Translation resource - text translation + document upload
 // Uses AuthSession (authenticated requests with auto-refresh).
 
-import type { AuthSession } from "../auth-session.ts";
+import type { AuthSession, Progress } from "../auth-session.ts";
 import {
   TranslationResponseSchema,
   type TranslationResponse,
@@ -72,7 +72,10 @@ export class TranslationResource {
    * @throws AuthenticationError if not authenticated
    * @throws APIError on API errors (422 unsupported format, 413 file too large)
    */
-  async uploadDocument(params: UploadDocumentParams): Promise<DocJobCreateResponse> {
+  async uploadDocument(
+    params: UploadDocumentParams,
+    onUploadProgress?: (progress: Progress) => void
+  ): Promise<DocJobCreateResponse> {
     const { filePath, sourceLang, targetLang, outputFormat } = params;
     const baseUrl = this.baseUrl;
 
@@ -91,7 +94,9 @@ export class TranslationResource {
     const data = await this.session.request<unknown>(
       "POST",
       `${baseUrl}${Endpoint.DOCUMENT_TRANSLATE}`,
-      { body: formData }
+      { body: formData },
+      undefined,
+      onUploadProgress
     );
 
     return DocJobCreateResponseSchema.parse(data);

src/api/resources/translation.ts

@@ -9,6 +9,7 @@ import got, {
   type Got,
   type Method,
   type Options as GotOptions,
+  type Progress,
   type Response,
   type RetryObject,
   HTTPError,
@@ -18,6 +19,8 @@ import got, {
   type BeforeErrorHook,
   type BeforeRetryHook,
 } from "got";
+
+export type { Progress } from "got";
 import { getSettings } from "../config/settings.ts";
 import { getAccessToken } from "../config/credentials.ts";
 import { generateTraceId } from "./trace.ts";
@@ -228,7 +231,8 @@ export class HttpTransport {
     url: string,
     options: Partial<GotOptions> = {},
     publicFlag = false,
-    signal?: AbortSignal
+    signal?: AbortSignal,
+    onUploadProgress?: (progress: Progress) => void
   ): Promise<T> {
     const gotInstance = publicFlag ? this.publicClient : this.client;
 
@@ -241,7 +245,15 @@ export class HttpTransport {
         ...(effectiveSignal ? { signal: effectiveSignal } : {}),
       } as GotOptions;
 
-      const response = (await gotInstance(url, mergedOptions)) as Response<T>;
+      const request = gotInstance(url, mergedOptions);
+      // got's CancelableRequest has conflicting .on() overloads (PCancelable + RequestEvents);
+      // narrow via type assertion to resolve the union.
+      if (onUploadProgress)
+        (request as { on(e: "uploadProgress", l: (p: Progress) => void): unknown }).on(
+          "uploadProgress",
+          onUploadProgress
+        );
+      const response = (await request) as Response<T>;
 
       return response.body;
     } catch (error: unknown) {
@@ -299,7 +311,8 @@ export class HttpTransport {
     outputPath: string,
     options: Partial<GotOptions> = {},
     publicFlag = false,
-    signal?: AbortSignal
+    signal?: AbortSignal,
+    onDownloadProgress?: (progress: Progress) => void
   ): Promise<string> {
     const gotInstance = publicFlag ? this.publicClient : this.client;
 
@@ -311,6 +324,8 @@ export class HttpTransport {
         ...(effectiveSignal ? { signal: effectiveSignal } : {}),
       } as GotOptions & { isStream: true });
 
+      if (onDownloadProgress) stream.on("downloadProgress", onDownloadProgress);
+
       const fileStream = createWriteStream(outputPath);
       await pipeline(stream, fileStream, ...(effectiveSignal ? [{ signal: effectiveSignal }] : []));