@tramvai/test-integration 2.112.0 → 2.117.0

package/README.md

@@ -16,7 +16,7 @@ npm i --save-dev @tramvai/test-integration
 
 For testing requests to the tramvai app libraries [superagent](https://github.com/visionmedia/superagent) and [node-html-parser](https://github.com/taoqf/node-html-parser) are used under hood.
 
-Call of `app.request` sends requests to the app. All of the features of `superagent` are available.
+Call of `app.request` sends requests to the app. All features of `superagent` are available.
 
 Call of `app.render` resolves to the HTML render that is returned from server while serving the request.
 
@@ -77,3 +77,35 @@ it('should work with mocker', async () => {
   await app.request('/api/').expect(500);
 });
 ```
+
+### Papi methods
+
+All papi methods can be used in tests, for example:
+
+```ts
+import { startCli } from '@tramvai/test-integration';
+
+it('environment list', async () => {
+  const { papi } = await startCli('papi-example');
+
+  const response = await papi.apiList();
+});
+```
+
+Available methods are:
+
+- clearCache;
+- bundleInfo;
+- apiList;
+
+Also, you can use `publicPapi` (passes to `${serverUrl}/${appName}/papi/`) and `privatePapi` (passes to `${serverUrl}/${appName}/private/papi/`) properties to work with your own papi methods:
+
+```ts
+import { startCli } from '@tramvai/test-integration';
+
+it('custom method', async () => {
+  const { papi } = await startCli('papi-example');
+
+  const response = await papi.publicPapi('whatever');
+});
+```

package/lib/app/papi.d.ts

@@ -17,5 +17,6 @@ export declare const wrapPapi: ({ serverUrl, appName }: Options) => {
     } | undefined) => import("supertest").Test;
     clearCache: () => import("supertest").Test;
     bundleInfo: () => import("supertest").Test;
+    apiList: () => import("supertest").Test;
 };
 export {};

package/lib/app/papi.es.js

@@ -12,6 +12,9 @@ const wrapPapi = ({ serverUrl, appName }) => {
         bundleInfo: () => {
             return publicPapi('bundleInfo').expect(200);
         },
+        apiList: () => {
+            return publicPapi('apiList').expect(200);
+        },
     };
 };
 

package/lib/app/papi.js

@@ -16,6 +16,9 @@ const wrapPapi = ({ serverUrl, appName }) => {
         bundleInfo: () => {
             return publicPapi('bundleInfo').expect(200);
         },
+        apiList: () => {
+            return publicPapi('apiList').expect(200);
+        },
     };
 };
 

package/lib/app/startCli.d.ts

@@ -42,6 +42,7 @@ export declare const startCli: (targetOrConfig: StartOptions['target'] | StartOp
         } | undefined) => import("supertest").Test;
         clearCache: () => import("supertest").Test;
         bundleInfo: () => import("supertest").Test;
+        apiList: () => import("supertest").Test;
     };
     mocker: {
         addMocks(api: string, mocks: Record<string, import("@tinkoff/mocker").MockConfig>): Promise<any>;

package/lib/app/startCliFakeApp.d.ts

@@ -36,6 +36,7 @@ export declare const runFakeApp: (config: Partial<StartOptions['config']>, optio
         } | undefined) => import("supertest").Test;
         clearCache: () => import("supertest").Test;
         bundleInfo: () => import("supertest").Test;
+        apiList: () => import("supertest").Test;
     };
     mocker: {
         addMocks(api: string, mocks: Record<string, import("@tinkoff/mocker").MockConfig>): Promise<any>;

package/lib/app/startCliRealApp.d.ts

@@ -35,6 +35,7 @@ export declare const runRealApp: (tramvaiConfigRoot: string, appName: string, op
         } | undefined) => import("supertest").Test;
         clearCache: () => import("supertest").Test;
         bundleInfo: () => import("supertest").Test;
+        apiList: () => import("supertest").Test;
     };
     mocker: {
         addMocks(api: string, mocks: Record<string, import("@tinkoff/mocker").MockConfig>): Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/test-integration",
-  "version": "2.112.0",
+  "version": "2.117.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -20,15 +20,15 @@
     "@types/wait-on": "^5.2.0"
   },
   "dependencies": {
-    "@tinkoff/mocker": "2.1.5",
-    "@tramvai/test-helpers": "2.112.0",
+    "@tinkoff/mocker": "2.1.6",
+    "@tramvai/test-helpers": "2.117.0",
     "env-ci": "^5.0.2",
     "utility-types": "^3.10.0",
     "wait-on": "^5.3.0"
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/cli": "2.112.0",
+    "@tramvai/cli": "2.117.0",
     "tslib": "^2.4.0"
   },
   "license": "Apache-2.0",