caprover-api 0.0.18 → 0.0.20

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish npm package
+
+on:
+    push:
+        branches:
+            - release
+
+permissions:
+    contents: read
+    id-token: write
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v4
+
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 24
+                  registry-url: https://registry.npmjs.org
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Run tests
+              run: npm test
+
+            - name: Publish package
+              run: npm publish --access public

package/dist/api/ApiManager.d.ts

@@ -124,7 +124,7 @@ export default class ApiManager {
     addNewCustomOneClickRepo(repositoryUrl: string): Promise<void>;
     deleteCustomOneClickRepo(repositoryUrl: string): Promise<void>;
     addDockerNode(nodeType: string, privateKey: string, remoteNodeIpAddress: string, sshPort: string, sshUser: string, captainIpAddress: string): Promise<void>;
-    startOneClickAppDeploy(template: any, values?: any): Promise<{
+    startOneClickAppDeploy(template: any, values?: any, templateName?: string): Promise<{
         jobId: string;
     }>;
     getOneClickAppDeployProgress(jobId: string): Promise<OneClickAppDeploymentState>;

package/dist/api/ApiManager.js

@@ -172,7 +172,7 @@ class ApiManager {
         let formData = new FormData();
         formData.append('sourceFile', file);
         return Promise.resolve() //
-            .then(http.fetch(http.POST, `/user/apps/appData/${appName}?detached=1`, formData));
+            .then(http.fetch(http.POST, `/user/apps/appData/${appName}?detached=1`, formData, http.FORM_DATA));
     }
     registerProject(selectedProject) {
         const http = this.http;
@@ -507,12 +507,13 @@ class ApiManager {
             captainIpAddress,
         }));
     }
-    startOneClickAppDeploy(template, values) {
+    startOneClickAppDeploy(template, values, templateName) {
         const http = this.http;
         return Promise.resolve() //
             .then(http.fetch(http.POST, '/user/oneclick/deploy', {
             template,
             values,
+            templateName,
         }));
     }
     getOneClickAppDeployProgress(jobId) {

package/dist/api/HttpClient.d.ts

@@ -1,15 +1,18 @@
+export type RequestBodyType = 'json' | 'form-data';
+export declare function createPostRequestInit(variables: any, headers: Record<string, string>, bodyType: RequestBodyType): RequestInit;
 export default class HttpClient {
     private baseUrl;
     private authTokenProvider;
     private onLoginRequested;
     readonly GET = "GET";
     readonly POST = "POST";
+    readonly FORM_DATA = "form-data";
     isDestroyed: boolean;
     constructor(baseUrl: string, authTokenProvider: () => Promise<string>, onLoginRequested: () => Promise<void>);
     createHeaders(): Promise<any>;
     destroy(): void;
-    fetch(method: 'GET' | 'POST', endpoint: string, variables: any): () => Promise<any>;
-    fetchInternal(method: 'GET' | 'POST', endpoint: string, variables: any): Promise<any>;
+    fetch(method: 'GET' | 'POST', endpoint: string, variables: any, bodyType?: RequestBodyType): () => Promise<any>;
+    fetchInternal(method: 'GET' | 'POST', endpoint: string, variables: any, bodyType?: RequestBodyType): Promise<any>;
     getReq(endpoint: string, variables: any): Promise<any>;
-    postReq(endpoint: string, variables: any): Promise<any>;
+    postReq(endpoint: string, variables: any, bodyType?: RequestBodyType): Promise<any>;
 }

package/dist/api/HttpClient.js

@@ -3,8 +3,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPostRequestInit = createPostRequestInit;
 const ErrorFactory_1 = __importDefault(require("./ErrorFactory"));
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
+function createPostRequestInit(variables, headers, bodyType) {
+    if (bodyType === 'form-data') {
+        return {
+            method: 'POST',
+            headers,
+            body: variables,
+        };
+    }
+    return {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            ...headers,
+        },
+        body: JSON.stringify(variables),
+    };
+}
 function buildQueryParams(params) {
     if (!params || Object.keys(params).length === 0)
         return '';
@@ -17,15 +35,8 @@ let TOKEN_HEADER = 'x-captain-auth';
 let NAMESPACE = 'x-namespace';
 let CAPTAIN = 'captain';
 class CrossFetchEngine {
-    static async post(url, variables, headers) {
-        const res = await (0, cross_fetch_1.default)(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                ...headers,
-            },
-            body: JSON.stringify(variables),
-        });
+    static async post(url, variables, headers, bodyType) {
+        const res = await (0, cross_fetch_1.default)(url, createPostRequestInit(variables, headers, bodyType));
         if (!res.ok) {
             const errBody = await res.text();
             throw new Error(`HTTP ${res.status}: ${errBody}`);
@@ -58,6 +69,7 @@ class HttpClient {
         this.onLoginRequested = onLoginRequested;
         this.GET = 'GET';
         this.POST = 'POST';
+        this.FORM_DATA = 'form-data';
         this.isDestroyed = false;
         //
     }
@@ -78,12 +90,12 @@ class HttpClient {
     destroy() {
         this.isDestroyed = true;
     }
-    fetch(method, endpoint, variables) {
+    fetch(method, endpoint, variables, bodyType = 'json') {
         const self = this;
         return function () {
             return Promise.resolve() //
                 .then(function () {
-                return self.fetchInternal(method, endpoint, variables); //
+                return self.fetchInternal(method, endpoint, variables, bodyType); //
             })
                 .then(function (fetchResponse) {
                 if (
@@ -94,7 +106,7 @@ class HttpClient {
                         .onLoginRequested() //
                         .then(function () {
                         return self
-                            .fetchInternal(method, endpoint, variables)
+                            .fetchInternal(method, endpoint, variables, bodyType)
                             .then(function (httpResponse) {
                             return httpResponse;
                         });
@@ -134,11 +146,11 @@ class HttpClient {
             });
         };
     }
-    fetchInternal(method, endpoint, variables) {
+    fetchInternal(method, endpoint, variables, bodyType = 'json') {
         if (method === this.GET)
             return this.getReq(endpoint, variables);
         if (method === this.POST)
-            return this.postReq(endpoint, variables);
+            return this.postReq(endpoint, variables, bodyType);
         throw new Error(`Unknown method: ${method}`);
     }
     getReq(endpoint, variables) {
@@ -155,14 +167,14 @@ class HttpClient {
             return data;
         });
     }
-    postReq(endpoint, variables) {
+    postReq(endpoint, variables, bodyType = 'json') {
         const self = this;
         return Promise.resolve() //
             .then(function () {
             return self.createHeaders();
         })
             .then(function (headers) {
-            return CrossFetchEngine.post(self.baseUrl + endpoint, variables, headers);
+            return CrossFetchEngine.post(self.baseUrl + endpoint, variables, headers, bodyType);
         })
             .then(function (data) {
             // console.log(data);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "caprover-api",
-    "version": "0.0.18",
+    "version": "0.0.20",
     "description": "API client for CapRover",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
@@ -9,7 +9,7 @@
         "formatter-write": "prettier --write './src/**/*.ts*'",
         "tslint": "tslint -c tslint.json -p tsconfig.json",
         "tslint-fix": "tslint --fix -c tslint.json -p tsconfig.json",
-        "test": "echo \"Error: no test specified\" && exit 1",
+        "test": "npm run build && node --test test/*.test.js",
         "build": "rm -rf ./dist && npm run tslint && npx tsc && chmod +x ./dist -R",
         "dev": "rm -rf ./dist && npx tsc && node ./dist/example.js",
         "generate-barrels": "rm ./src/models/index.ts && barrelsby --directory src/models"

package/src/api/ApiManager.ts

@@ -291,7 +291,8 @@ export default class ApiManager {
                 http.fetch(
                     http.POST,
                     `/user/apps/appData/${appName}?detached=1`,
-                    formData
+                    formData,
+                    http.FORM_DATA
                 )
             )
     }
@@ -865,7 +866,8 @@ export default class ApiManager {
 
     startOneClickAppDeploy(
         template: any,
-        values?: any
+        values?: any,
+        templateName?: string
     ): Promise<{ jobId: string }> {
         const http = this.http
 
@@ -874,6 +876,7 @@ export default class ApiManager {
                 http.fetch(http.POST, '/user/oneclick/deploy', {
                     template,
                     values,
+                    templateName,
                 })
             )
     }

package/src/api/HttpClient.ts

@@ -1,6 +1,31 @@
 import ErrorFactory from './ErrorFactory'
 import fetch from 'cross-fetch'
 
+export type RequestBodyType = 'json' | 'form-data'
+
+export function createPostRequestInit(
+    variables: any,
+    headers: Record<string, string>,
+    bodyType: RequestBodyType
+): RequestInit {
+    if (bodyType === 'form-data') {
+        return {
+            method: 'POST',
+            headers,
+            body: variables,
+        }
+    }
+
+    return {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            ...headers,
+        },
+        body: JSON.stringify(variables),
+    }
+}
+
 function buildQueryParams(params: Record<string, any>): string {
     if (!params || Object.keys(params).length === 0) return ''
     return (
@@ -20,17 +45,14 @@ let CAPTAIN = 'captain'
 class CrossFetchEngine {
     public static async post(
         url: string,
-        variables: Record<string, any>,
-        headers: Record<string, string>
+        variables: any,
+        headers: Record<string, string>,
+        bodyType: RequestBodyType
     ): Promise<any> {
-        const res = await fetch(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                ...headers,
-            },
-            body: JSON.stringify(variables),
-        })
+        const res = await fetch(
+            url,
+            createPostRequestInit(variables, headers, bodyType)
+        )
 
         if (!res.ok) {
             const errBody = await res.text()
@@ -69,6 +91,7 @@ class CrossFetchEngine {
 export default class HttpClient {
     public readonly GET = 'GET'
     public readonly POST = 'POST'
+    public readonly FORM_DATA = 'form-data'
     public isDestroyed = false
 
     constructor(
@@ -99,12 +122,22 @@ export default class HttpClient {
         this.isDestroyed = true
     }
 
-    fetch(method: 'GET' | 'POST', endpoint: string, variables: any) {
+    fetch(
+        method: 'GET' | 'POST',
+        endpoint: string,
+        variables: any,
+        bodyType: RequestBodyType = 'json'
+    ) {
         const self = this
         return function (): Promise<any> {
             return Promise.resolve() //
                 .then(function () {
-                    return self.fetchInternal(method, endpoint, variables) //
+                    return self.fetchInternal(
+                        method,
+                        endpoint,
+                        variables,
+                        bodyType
+                    ) //
                 })
                 .then(function (fetchResponse) {
                     if (
@@ -116,7 +149,12 @@ export default class HttpClient {
                             .onLoginRequested() //
                             .then(function () {
                                 return self
-                                    .fetchInternal(method, endpoint, variables)
+                                    .fetchInternal(
+                                        method,
+                                        endpoint,
+                                        variables,
+                                        bodyType
+                                    )
                                     .then(function (httpResponse) {
                                         return httpResponse
                                     })
@@ -159,10 +197,16 @@ export default class HttpClient {
         }
     }
 
-    fetchInternal(method: 'GET' | 'POST', endpoint: string, variables: any) {
+    fetchInternal(
+        method: 'GET' | 'POST',
+        endpoint: string,
+        variables: any,
+        bodyType: RequestBodyType = 'json'
+    ) {
         if (method === this.GET) return this.getReq(endpoint, variables)
 
-        if (method === this.POST) return this.postReq(endpoint, variables)
+        if (method === this.POST)
+            return this.postReq(endpoint, variables, bodyType)
 
         throw new Error(`Unknown method: ${method}`)
     }
@@ -186,7 +230,11 @@ export default class HttpClient {
             })
     }
 
-    postReq(endpoint: string, variables: any) {
+    postReq(
+        endpoint: string,
+        variables: any,
+        bodyType: RequestBodyType = 'json'
+    ) {
         const self = this
         return Promise.resolve() //
             .then(function () {
@@ -196,7 +244,8 @@ export default class HttpClient {
                 return CrossFetchEngine.post(
                     self.baseUrl + endpoint,
                     variables,
-                    headers
+                    headers,
+                    bodyType
                 )
             })
             .then(function (data) {

package/test/HttpClient.test.js

@@ -0,0 +1,61 @@
+const assert = require('node:assert/strict')
+const test = require('node:test')
+
+const ErrorFactory = require('../dist/api/ErrorFactory').default
+const HttpClientModule = require('../dist/api/HttpClient')
+const HttpClient = HttpClientModule.default
+const { createPostRequestInit } = HttpClientModule
+
+test('JSON requests preserve the existing serialization and content type', () => {
+    const payload = { appName: 'test-app' }
+    const request = createPostRequestInit(
+        payload,
+        { 'x-captain-auth': 'token' },
+        'json'
+    )
+
+    assert.deepEqual(request.headers, {
+        'Content-Type': 'application/json',
+        'x-captain-auth': 'token',
+    })
+    assert.equal(request.body, JSON.stringify(payload))
+})
+
+test('form data is passed through without setting a content type', () => {
+    const formData = { sourceFile: 'tar contents' }
+    const headers = { 'x-captain-auth': 'token' }
+    const request = createPostRequestInit(formData, headers, 'form-data')
+
+    assert.strictEqual(request.body, formData)
+    assert.deepEqual(request.headers, headers)
+    assert.equal(Object.hasOwn(request.headers, 'Content-Type'), false)
+})
+
+test('authentication retry preserves the form-data body type', async () => {
+    let loginRequests = 0
+    const bodyTypes = []
+    const client = new HttpClient(
+        'https://captain.example.com',
+        () => Promise.resolve('token'),
+        () => {
+            loginRequests++
+            return Promise.resolve()
+        }
+    )
+
+    client.fetchInternal = (_method, _endpoint, _variables, bodyType) => {
+        bodyTypes.push(bodyType)
+        if (bodyTypes.length === 1) {
+            return Promise.resolve({
+                status: ErrorFactory.STATUS_AUTH_TOKEN_INVALID,
+            })
+        }
+
+        return Promise.resolve({ status: ErrorFactory.OKAY, data: {} })
+    }
+
+    await client.fetch(client.POST, '/upload', {}, client.FORM_DATA)()
+
+    assert.equal(loginRequests, 1)
+    assert.deepEqual(bodyTypes, ['form-data', 'form-data'])
+})