@cypress/json-schemas - npm Package Compare versions

Comparing version 2.1.8 to 3.0.0

dist/ci/index.d.ts

 import { PlainObject, ObjectSchema } from '@cypress/schema-tools';
-export declare type CiInformation = {
+export declare type CiExample100 = {
     url: string | null;
@@ -8,6 +8,6 @@ provider: string | null;
 };
-export declare const ciInformationExample: CiInformation;
-export declare const CiInformation100: ObjectSchema;
-export declare const CiInformation: {
+export declare const ciExample100: CiExample100;
+export declare const Ci100: ObjectSchema;
+export declare const Ci: {
     [key: string]: ObjectSchema;
 };

dist/ci/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_tools_1 = require("@cypress/schema-tools");
-exports.ciInformationExample = {
+exports.ciExample100 = {
     url: null,
@@ -12,3 +12,3 @@ provider: 'CircelCI',
 };
-exports.CiInformation100 = {
+exports.Ci100 = {
     version: {
@@ -20,3 +20,3 @@ major: 1,
     schema: {
-        title: 'CiInformation',
+        title: 'testRunner.ci',
         type: 'object',
@@ -45,4 +45,4 @@ description: 'CI information',
     },
-    example: exports.ciInformationExample,
+    example: exports.ciExample100,
 };
-exports.CiInformation = schema_tools_1.versionSchemas(exports.CiInformation100);
+exports.Ci = schema_tools_1.versionSchemas(exports.Ci100);

dist/commit/index.d.ts

 import { email, commitSha, uri } from '../objects';
 import { ObjectSchema } from '@cypress/schema-tools';
-export declare type CommitInformation = {
+export declare type CommitExample100 = {
     authorEmail: email | null;
@@ -12,6 +12,6 @@ authorName: string | null;
 };
-export declare const commitInformationExample: CommitInformation;
-export declare const CommitInformation100: ObjectSchema;
-export declare const CommitInformation: {
+export declare const commitExample100: CommitExample100;
+export declare const Commit100: ObjectSchema;
+export declare const Commit: {
     [key: string]: ObjectSchema;
 };

dist/commit/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_tools_1 = require("@cypress/schema-tools");
-exports.commitInformationExample = {
+exports.commitExample100 = {
     authorEmail: '[e-mail]',
@@ -13,3 +13,3 @@ authorName: 'Joe Doe',
 };
-exports.CommitInformation100 = {
+exports.Commit100 = {
     version: {
@@ -21,3 +21,3 @@ major: 1,
     schema: {
-        title: 'CommitInformation',
+        title: 'testRunner.commit',
         type: 'object',
@@ -66,4 +66,4 @@ description: 'Commit information',
     },
-    example: exports.commitInformationExample,
+    example: exports.commitExample100,
 };
-exports.CommitInformation = schema_tools_1.versionSchemas(exports.CommitInformation100);
+exports.Commit = schema_tools_1.versionSchemas(exports.Commit100);

dist/hook/index.js

@@ -17,3 +17,3 @@ "use strict";
     schema: {
-        title: 'Hook',
+        title: 'testRunner.hook',
         description: 'Hook function running before or after test',
@@ -20,0 +20,0 @@ type: 'object',

dist/instance/cypress-stats.d.ts

 import { ObjectSchema } from '@cypress/schema-tools';
+import { ISODateString, milliseconds } from '..';
+export declare type CypressStatsExample100 = {
+    suites: number;
+    tests: number;
+    passes: number;
+    pending: number;
+    failures: number;
+    skipped: number;
+    start: ISODateString;
+    end: ISODateString;
+    duration: milliseconds;
+};
+export declare const cypressStatsExample100: CypressStatsExample100;
 export declare const CypressStats100: ObjectSchema;
@@ -3,0 +16,0 @@ export declare const CypressStats: {

dist/instance/cypress-stats.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_tools_1 = require("@cypress/schema-tools");
+exports.cypressStatsExample100 = {
+    suites: 5,
+    tests: 6,
+    passes: 1,
+    pending: 1,
+    failures: 3,
+    skipped: 0,
+    start: '2018-02-01T20:14:19.323Z',
+    end: '2018-02-01T20:14:19.323Z',
+    duration: 1234,
+};
 exports.CypressStats100 = {
@@ -11,3 +22,3 @@ version: {
     schema: {
-        title: 'CypressStats',
+        title: 'testRunner.cypressStats',
         type: 'object',
@@ -68,14 +79,4 @@ description: 'Test stats Cypress test runner collects and sends',
     },
-    example: {
-        suites: 5,
-        tests: 6,
-        passes: 1,
-        pending: 1,
-        failures: 3,
-        skipped: 0,
-        start: '2018-02-01T20:14:19.323Z',
-        end: '2018-02-01T20:14:19.323Z',
-        duration: 1234,
-    },
+    example: exports.cypressStatsExample100,
 };
 exports.CypressStats = schema_tools_1.versionSchemas(exports.CypressStats100);

dist/instance/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_tools_1 = require("@cypress/schema-tools");
-var put_response_1 = require("./put-response");
-var put_request_1 = require("./put-request");
-exports.PutInstanceRequest = schema_tools_1.versionSchemas(put_request_1.PutInstanceRequest100);
-exports.PutInstanceResponse = schema_tools_1.versionSchemas(put_response_1.PutInstanceResponse100);
+var response_1 = require("./put/response");
+var request_1 = require("./put/request");
+exports.PutInstanceRequest = schema_tools_1.versionSchemas(request_1.PutInstanceRequest100);
+exports.PutInstanceResponse = schema_tools_1.versionSchemas(response_1.PutInstanceResponse100);

dist/instance/mocha-stats.js

@@ -11,3 +11,3 @@ "use strict";
     schema: {
-        title: 'MochaReporterStats',
+        title: 'testRunner.mochaReporterStats',
         type: 'object',
@@ -14,0 +14,0 @@ description: 'Stats from Mocha reporter - really dynamic and depends on the reporter',

dist/platform/index.d.ts

 import { osName } from '../objects';
 import { ObjectSchema } from '@cypress/schema-tools';
-export declare type PlatformInformation = {
+export declare type PlatformExample100 = {
     osName: osName;
@@ -10,6 +10,6 @@ osVersion: string;
 };
-export declare const platformInformationExample: PlatformInformation;
-export declare const PlatformInformation100: ObjectSchema;
-export declare const PlatformInformation: {
+export declare const platformExample100: PlatformExample100;
+export declare const Platform100: ObjectSchema;
+export declare const Platform: {
     [key: string]: ObjectSchema;
 };

dist/platform/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_tools_1 = require("@cypress/schema-tools");
-exports.platformInformationExample = {
+exports.platformExample100 = {
     osName: 'linux',
@@ -11,3 +11,3 @@ osVersion: '14.04',
 };
-exports.PlatformInformation100 = {
+exports.Platform100 = {
     version: {
@@ -19,3 +19,3 @@ major: 1,
     schema: {
-        title: 'PlatformInformation',
+        title: 'testRunner.platform',
         type: 'object',
@@ -49,4 +49,4 @@ description: 'Browser and OS information',
     },
-    example: exports.platformInformationExample,
+    example: exports.platformExample100,
 };
-exports.PlatformInformation = schema_tools_1.versionSchemas(exports.PlatformInformation100);
+exports.Platform = schema_tools_1.versionSchemas(exports.Platform100);

dist/post-run-instance/request.js

@@ -35,3 +35,3 @@ "use strict";
         properties: {
-            platform: __assign({}, platform_1.PlatformInformation100.schema, { see: 'PlatformInformation' }),
+            platform: __assign({}, platform_1.Platform100.schema, { see: platform_1.Platform100.schema.title }),
             spec: {
@@ -38,0 +38,0 @@ type: 'string',

dist/runs/get/index.js

@@ -87,4 +87,4 @@ "use strict";
             },
-            commit: __assign({}, commit_1.CommitInformation100.schema, { type: ['object', 'null'], see: 'CommitInformation' }),
-            ci: __assign({}, ci_1.CiInformation100.schema, { type: ['object', 'null'], see: 'CiInformation' }),
+            commit: __assign({}, commit_1.Commit100.schema, { type: ['object', 'null'], see: commit_1.Commit100.schema.title }),
+            ci: __assign({}, ci_1.Ci100.schema, { type: ['object', 'null'], see: ci_1.Ci100.schema.title }),
             passed: {
@@ -163,3 +163,3 @@ type: 'integer',
                 items: __assign({}, instance_1.Instance300.schema),
-                see: 'Instance[]',
+                see: instance_1.Instance300.schema.title,
             },
@@ -169,3 +169,3 @@ failedTests: {
                 items: __assign({}, test_information_1.TestInformation100.schema),
-                see: 'TestInformation[]',
+                see: test_information_1.TestInformation100.schema.title,
             },
@@ -172,0 +172,0 @@ orgId: {

dist/runs/get/instance.d.ts

@@ -6,5 +6,5 @@ import { ObjectSchema } from '@cypress/schema-tools';
 import { VideoExample100 } from '../../video';
-import { PlatformInformation } from '../../platform';
+import { PlatformExample100 } from '../../platform';
 export declare type InstanceExample300 = {
-    platform?: PlatformInformation;
+    platform?: PlatformExample100;
     osMemory: {
@@ -11,0 +11,0 @@ free: number;

dist/runs/get/instance.js

@@ -57,3 +57,3 @@ "use strict";
         properties: {
-            platform: __assign({}, platform_1.PlatformInformation100.schema, { see: 'PlatformInformation' }),
+            platform: __assign({}, platform_1.Platform100.schema, { see: platform_1.Platform100.schema.title }),
             createdAt: {
@@ -138,3 +138,3 @@ type: 'string',
                 items: __assign({}, video_1.Video100.schema),
-                see: 'Video[]',
+                see: video_1.Video100.schema.title,
             },
@@ -144,3 +144,3 @@ screenshots: {
                 items: __assign({}, test_screenshot_1.TestScreenshot100.schema),
-                see: 'TestScreenshot[]',
+                see: test_screenshot_1.TestScreenshot100.schema.title,
             },
@@ -147,0 +147,0 @@ },

dist/runs/post/request/index.js

@@ -140,4 +140,4 @@ "use strict";
             },
-            commit: __assign({}, commit_1.CommitInformation100.schema, { type: ['object', 'null'], see: 'CommitInformation' }),
-            ci: __assign({}, ci_1.CiInformation100.schema, { type: ['object', 'null'], see: 'CiInformation' }),
+            commit: __assign({}, commit_1.Commit100.schema, { type: ['object', 'null'], see: commit_1.Commit100.schema.title }),
+            ci: __assign({}, ci_1.Ci100.schema, { type: ['object', 'null'], see: ci_1.Ci100.schema.title }),
             specs: {
@@ -154,3 +154,3 @@ type: 'array',
             },
-            platform: __assign({}, platform_1.PlatformInformation100.schema, { see: 'PlatformInformation' }),
+            platform: __assign({}, platform_1.Platform100.schema, { see: platform_1.Platform100.schema.title }),
         },
@@ -157,0 +157,0 @@ required: [

dist/schemas.js

@@ -21,2 +21,3 @@ "use strict";
 var ci_1 = require("./ci");
-exports.schemas = schema_tools_1.combineSchemas(commit_1.CommitInformation, cypress_stats_1.CypressStats, index_1.GetRunResponse, hook_1.Hook, instance_1.Instance, instance_1.GetInstanceResponse, mocha_stats_1.MochaReporterStats, platform_1.PlatformInformation, request_2.PostRunInstanceRequest, request_1.PostRunRequest, response_1.PostRunResponse, instance_2.PutInstanceRequest, instance_2.PutInstanceResponse, screenshot_1.Screenshot, screenshot_upload_url_1.ScreenshotUploadUrl, test_information_1.TestFromRunner, test_information_1.TestInformation, test_screenshot_1.TestScreenshot, video_1.Video, ci_1.CiInformation);
+var put_request_1 = require("./instance-stdout/put-request");
+exports.schemas = schema_tools_1.combineSchemas(ci_1.Ci, commit_1.Commit, cypress_stats_1.CypressStats, instance_1.GetInstanceResponse, index_1.GetRunResponse, hook_1.Hook, instance_1.Instance, mocha_stats_1.MochaReporterStats, platform_1.Platform, request_2.PostRunInstanceRequest, request_1.PostRunRequest, response_1.PostRunResponse, instance_2.PutInstanceRequest, instance_2.PutInstanceResponse, put_request_1.PutInstanceStdoutRequest, screenshot_1.Screenshot, screenshot_upload_url_1.ScreenshotUploadUrl, test_information_1.TestFromRunner, test_information_1.TestInformation, test_screenshot_1.TestScreenshot, video_1.Video);

dist/screenshot/index.d.ts

@@ -5,4 +5,3 @@ import { ObjectSchema } from '@cypress/schema-tools';
     testId: testId;
-    title?: string;
-    testTitle: string[];
+    name: string | null;
     height: pixels;
@@ -9,0 +8,0 @@ width: pixels;

dist/screenshot/index.js

@@ -7,8 +7,3 @@ "use strict";
     testId: 'r4',
-    testTitle: [
-        'simple failing hook spec',
-        'beforeEach hooks',
-        'never gets here',
-        '"before each" hook',
-    ],
+    name: 'some screenshot name',
     height: 720,
@@ -25,3 +20,3 @@ width: 1280,
     schema: {
-        title: 'Screenshot',
+        title: 'testRunner.Screenshot',
         description: 'Image taken during the test and uploaded by the test runner',
@@ -35,9 +30,2 @@ type: 'object',
             },
-            testTitle: {
-                type: 'array',
-                items: {
-                    type: 'string',
-                },
-                description: 'Parts of the full test name',
-            },
             height: {
@@ -58,8 +46,8 @@ type: 'integer',
             },
-            title: {
-                type: 'string',
-                description: 'Deprecated, use testTitle',
+            name: {
+                type: ['string', 'null'],
+                description: 'Name of the screenshot',
             },
         },
-        required: ['testId', 'testTitle', 'height', 'width', 'takenAt'],
+        required: ['testId', 'height', 'width', 'takenAt', 'name'],
         additionalProperties: false,
@@ -66,0 +54,0 @@ },

dist/test-information/index.js

@@ -35,3 +35,3 @@ "use strict";
     schema: {
-        title: 'TestFromRunner',
+        title: 'testRunner.test',
         description: 'Test information uploaded by the test runner',
@@ -154,3 +154,3 @@ type: 'object',
     schema: {
-        title: 'TestInformation',
+        title: 'Test',
         description: 'Test run information returned by the API',
@@ -157,0 +157,0 @@ type: 'object',

package.json

 {
   "name": "@cypress/json-schemas",
-  "version": "2.1.8",
+  "version": "3.0.0",
   "description": "Cypress JSON schemas",
@@ -5,0 +5,0 @@ "main": "dist",

No alert changes

Improved metrics

Total package byte prevSize

70593

increased by2.62%

Number of package files

50

increased by4.17%

Lines of code

2103

increased by2.29%

No dependency changes