@dotcom-tool-kit/types - npm Package Compare versions

Comparing version 2.6.2 to 2.7.0

lib/circleci.d.ts

 export declare const automatedComment = "# CONFIG GENERATED BY DOTCOM-TOOL-KIT, DO NOT EDIT BY HAND\n";
 export declare type JobConfig = {
+    docker?: {
+        image: string;
+        environment?: Record<string, string>;
+    }[];
     context?: string | string[];
@@ -14,2 +18,3 @@ requires?: string[];
     };
+    executor?: string;
 };
@@ -27,9 +32,11 @@ declare type TriggerConfig = {
 };
+export declare type Job = string | {
+    [job: string]: JobConfig;
+};
+export declare type Trigger = string | {
+    [trigger: string]: TriggerConfig;
+};
 export declare type Workflow = {
-    jobs?: (string | {
-        [job: string]: JobConfig;
-    })[];
-    triggers?: (string | {
-        [trigger: string]: TriggerConfig;
-    })[];
+    jobs?: Job[];
+    triggers?: Trigger[];
 };
@@ -36,0 +43,0 @@ export interface CircleConfig {

lib/index.d.ts

@@ -40,3 +40,3 @@ import type { Logger } from 'winston';
 } & typeof Task;
-export declare abstract class Hook extends Base {
+export declare abstract class Hook<State = void> extends Base {
     id?: string;
@@ -46,2 +46,3 @@ plugin?: Plugin;
     static description?: string;
+    installGroup?: string;
     static get [typeSymbol](): symbol;
@@ -51,6 +52,7 @@ get [typeSymbol](): symbol;
     abstract check(): Promise<boolean>;
-    abstract install(): Promise<void>;
+    abstract install(state?: State): Promise<State>;
+    commitInstall(_state: State): Promise<void>;
 }
 export declare type HookClass = {
-    new (logger: Logger): Hook;
+    new (logger: Logger): Hook<void>;
 } & typeof Hook;
@@ -57,0 +59,0 @@ export declare type RCFile = {

lib/index.js

@@ -146,3 +146,6 @@ "use strict";
     }
+    async commitInstall(_state) {
+        return;
+    }
 }
 exports.Hook = Hook;

lib/schema.d.ts

@@ -32,2 +32,3 @@ import type prompts from 'prompts';
 import type { CircleCIOptions } from './schema/circleci';
+import type { CypressOptions } from './schema/cypress';
 export declare type Options = {
@@ -48,4 +49,5 @@ '@dotcom-tool-kit/eslint'?: ESLintOptions;
     '@dotcom-tool-kit/circleci'?: CircleCIOptions;
+    '@dotcom-tool-kit/cypress'?: CypressOptions;
 };
 export {};
 //# sourceMappingURL=schema.d.ts.map

lib/schema/circleci.d.ts

 import { SchemaOutput } from '../schema';
 export declare const CircleCISchema: {
     readonly nodeVersion: "string?";
+    readonly cypressImage: "string?";
 };
@@ -8,3 +9,4 @@ export declare type CircleCIOptions = SchemaOutput<typeof CircleCISchema>;
     readonly nodeVersion: "string?";
+    readonly cypressImage: "string?";
 };
 //# sourceMappingURL=circleci.d.ts.map

lib/schema/circleci.js

@@ -5,4 +5,5 @@ "use strict";
 exports.CircleCISchema = {
-    nodeVersion: 'string?'
+    nodeVersion: 'string?',
+    cypressImage: 'string?'
 };
 exports.Schema = exports.CircleCISchema;

lib/schema/upload-assets-to-s3.d.ts

 import { SchemaOutput } from '../schema';
 export declare const UploadAssetsToS3Schema: {
-    readonly accessKeyId: "string";
-    readonly secretAccessKey: "string";
+    readonly accessKeyIdEnvVar: "string?";
+    readonly secretAccessKeyEnvVar: "string?";
+    readonly accessKeyId: "string?";
+    readonly secretAccessKey: "string?";
     readonly directory: "string";
@@ -14,4 +16,6 @@ readonly reviewBucket: "array.string";
 export declare const Schema: {
-    readonly accessKeyId: "string";
-    readonly secretAccessKey: "string";
+    readonly accessKeyIdEnvVar: "string?";
+    readonly secretAccessKeyEnvVar: "string?";
+    readonly accessKeyId: "string?";
+    readonly secretAccessKey: "string?";
     readonly directory: "string";
@@ -18,0 +22,0 @@ readonly reviewBucket: "array.string";

lib/schema/upload-assets-to-s3.js

@@ -5,4 +5,6 @@ "use strict";
 exports.UploadAssetsToS3Schema = {
-    accessKeyId: 'string',
-    secretAccessKey: 'string',
+    accessKeyIdEnvVar: 'string?',
+    secretAccessKeyEnvVar: 'string?',
+    accessKeyId: 'string?',
+    secretAccessKey: 'string?',
     directory: 'string',
@@ -9,0 +11,0 @@ reviewBucket: 'array.string',

package.json

 {
   "name": "@dotcom-tool-kit/types",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "description": "",
@@ -26,6 +26,4 @@ "main": "lib",
   "dependencies": {
-    "@dotcom-tool-kit/error": "^2.0.1",
-    "@dotcom-tool-kit/logger": "^2.1.2",
-    "lodash.isplainobject": "^4.0.6",
-    "lodash.mapvalues": "^4.6.0",
+    "@dotcom-tool-kit/error": "^2.0.0",
+    "@dotcom-tool-kit/logger": "^2.1.1",
     "semver": "^7.3.7",
@@ -36,4 +34,2 @@ "tslib": "^2.3.1"
     "@jest/globals": "^27.4.6",
-    "@types/lodash.isplainobject": "^4.0.6",
-    "@types/lodash.mapvalues": "^4.6.6",
     "@types/prompts": "^2.0.14",
@@ -40,0 +36,0 @@ "@types/semver": "^7.3.9",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44012

increased by4.41%

Dependency count

4

decreased by-33.33%

Dev dependency count

4

decreased by-33.33%

Number of package files

65

increased by4.84%

Lines of code

732

increased by5.48%

Dependency changes

• - Removedlodash.isplainobject@^4.0.6

• - Removedlodash.mapvalues@^4.6.0

• - Removedlodash.isplainobject@4.0.6(transitive)

• - Removedlodash.mapvalues@4.6.0(transitive)

• Updated@dotcom-tool-kit/error@^2.0.0

• Updated@dotcom-tool-kit/logger@^2.1.1