caprover-api 0.0.23 → 0.0.25

package/dist/models/OneClickAppDefinitionResponse.d.ts

@@ -1,3 +1,4 @@
+import { IOneClickTemplate } from './IOneClickAppModels';
 export default interface OneClickAppDefinitionResponse {
-    appTemplate: string;
+    appTemplate: IOneClickTemplate;
 }

package/dist/models/RegistriesResponse.d.ts

@@ -1,5 +1,5 @@
 import { IRegistryInfo } from './IRegistryInfo';
 export default interface RegistriesResponse {
     registries: IRegistryInfo[];
-    defaultRegistryId?: string;
+    defaultPushRegistryId?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "caprover-api",
-    "version": "0.0.23",
+    "version": "0.0.25",
     "description": "API client for CapRover",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
@@ -9,7 +9,8 @@
         "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": "npm run build && node --test test/*.test.js",
+        "test": "npm run build && npm run test-types && node --test test/*.test.js",
+        "test-types": "npx tsc --noEmit --strict --skipLibCheck --target ES2020 --module commonjs --moduleResolution Node test/*.test.ts",
         "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/models/OneClickAppDefinitionResponse.ts

@@ -1,3 +1,5 @@
+import { IOneClickTemplate } from './IOneClickAppModels'
+
 export default interface OneClickAppDefinitionResponse {
-    appTemplate: string
+    appTemplate: IOneClickTemplate
 }

package/src/models/RegistriesResponse.ts

@@ -2,5 +2,5 @@ import { IRegistryInfo } from './IRegistryInfo'
 
 export default interface RegistriesResponse {
     registries: IRegistryInfo[]
-    defaultRegistryId?: string
+    defaultPushRegistryId?: string
 }

package/test/ApiManager.test.js

@@ -5,7 +5,7 @@ const ApiManagerModule = require('../dist/api/ApiManager')
 const ApiManager = ApiManagerModule.default
 const { SimpleAuthenticationProvider } = ApiManagerModule
 
-function createApiWithRequestRecorder() {
+function createApiWithRequestRecorder(response = {}) {
     const api = new ApiManager(
         'https://captain.example.com',
         new SimpleAuthenticationProvider(() =>
@@ -21,7 +21,7 @@ function createApiWithRequestRecorder() {
         FORM_DATA: 'form-data',
         fetch(method, endpoint, data, bodyType = 'json') {
             requests.push({ method, endpoint, data, bodyType })
-            return () => Promise.resolve({})
+            return () => Promise.resolve(response)
         },
     }
 
@@ -146,3 +146,55 @@ test('saveTheme omits unspecified optional theme fields', async () => {
     assert.equal('headEmbed' in requests[0].data, false)
     assert.equal(JSON.stringify(requests[0].data).includes('undefined'), false)
 })
+
+test('getOneClickAppByName returns the parsed template object', async () => {
+    const appTemplate = {
+        services: {
+            'srv-captain--demo': {
+                image: 'nginx:alpine',
+            },
+        },
+        captainVersion: 4,
+        caproverOneClickApp: {
+            instructions: {
+                start: 'Start instructions',
+                end: 'End instructions',
+            },
+            displayName: 'Demo',
+            variables: [],
+        },
+    }
+    const { api, requests } = createApiWithRequestRecorder({ appTemplate })
+
+    const response = await api.getOneClickAppByName(
+        'demo',
+        'https://repo.example.com'
+    )
+
+    assert.deepEqual(requests[0], {
+        method: 'GET',
+        endpoint: '/user/oneclick/template/app',
+        data: {
+            appName: 'demo',
+            baseDomain: 'https://repo.example.com',
+        },
+        bodyType: 'json',
+    })
+    assert.strictEqual(response.appTemplate, appTemplate)
+})
+
+test('getDockerRegistries exposes the backend default push registry ID', async () => {
+    const registries = [{ id: 'registry-1', registryDomain: 'ghcr.io' }]
+    const data = { registries, defaultPushRegistryId: 'registry-1' }
+    const { api, requests } = createApiWithRequestRecorder(data)
+
+    const response = await api.getDockerRegistries()
+
+    assert.deepEqual(requests, [{
+        method: 'GET',
+        endpoint: '/user/registries',
+        data: {},
+        bodyType: 'json',
+    }])
+    assert.strictEqual(response, data)
+})

package/test/OneClickAppDefinitionResponse.test.ts

@@ -0,0 +1,11 @@
+import type CapRoverAPI from '../dist'
+import type { CapRoverModels } from '../dist'
+
+type OneClickAppDefinitionResponse = Awaited<
+    ReturnType<CapRoverAPI['getOneClickAppByName']>
+>
+
+declare const response: OneClickAppDefinitionResponse
+const appTemplate: CapRoverModels.IOneClickTemplate = response.appTemplate
+
+void appTemplate

package/test/RegistriesResponse.test.ts

@@ -0,0 +1,11 @@
+import type CapRoverAPI from '../dist'
+
+type RegistriesResponse = Awaited<ReturnType<CapRoverAPI['getDockerRegistries']>>
+
+declare const response: RegistriesResponse
+const defaultPushRegistryId: string | undefined = response.defaultPushRegistryId
+
+// @ts-expect-error The backend never returns this old property.
+response.defaultRegistryId
+
+void defaultPushRegistryId