@circleci/circleci-config-sdk - npm Package Compare versions

Comparing version 0.5.0-alpha.2 to 0.5.0-alpha.3

dist/src/lib/Components/Commands/Reusable/index.d.ts

@@ -6,3 +6,3 @@ import { Component } from '../..';
 import { Command, CommandSchema } from '../Command';
-declare type CustomCommandSchema = {
+export declare type CustomCommandSchema = {
     [name: string]: {
@@ -25,3 +25,2 @@ parameters: CustomParametersSchema;
 }
-export {};
 //# sourceMappingURL=index.d.ts.map

dist/src/lib/Config/index.d.ts

@@ -1,2 +0,2 @@
-import { Command } from '../Components/Commands/Command';
+import { CustomCommand } from '../Components/Commands/Reusable';
 import { ReusableExecutor } from '../Components/Executor';
@@ -27,3 +27,3 @@ import { Job } from '../Components/Job';
      */
-    commands: Command[];
+    commands: CustomCommand[];
     /**
@@ -51,3 +51,3 @@ * A Workflow is comprised of one or more uniquely named jobs.
      */
-    constructor(setup?: boolean, jobs?: Job[], workflows?: Workflow[], executors?: ReusableExecutor[], commands?: Command[], parameters?: CustomParametersList<PrimitiveParameterLiteral>);
+    constructor(setup?: boolean, jobs?: Job[], workflows?: Workflow[], executors?: ReusableExecutor[], commands?: CustomCommand[], parameters?: CustomParametersList<PrimitiveParameterLiteral>);
     /**
@@ -59,2 +59,7 @@ * Add a Workflow to the current Config. Chainable
     /**
+     * Add a Custom Command to the current Config. Chainable
+     * @param command - Injectable command
+     */
+    addCustomCommand(command: CustomCommand): this;
+    /**
      * Add a Workflow to the current Config. Chainable
@@ -69,2 +74,11 @@ * @param workflow - Injectable Workflow
     addJob(job: Job): this;
+    /**
+     * Define a pipeline parameter for the current Config. Chainable
+     *
+     * @param name - The name of the parameter
+     * @param type - The type of parameter
+     * @param defaultValue - The default value of the parameter
+     * @param description - A description of the parameter
+     * @param enumValues - An array of possible values for parameters of enum type
+     */
     defineParameter(name: string, type: PrimitiveParameterLiteral, defaultValue?: unknown, description?: string, enumValues?: string[]): Config;
@@ -87,3 +101,3 @@ private prependVersionComment;
     jobs?: Job[];
-    commands?: Command[];
+    commands?: CustomCommand[];
     workflows?: Workflow[];
@@ -90,0 +104,0 @@ }

package.json

 {
   "name": "@circleci/circleci-config-sdk",
-  "version": "0.5.0-alpha.2",
+  "version": "0.5.0-alpha.3",
   "description": "An SDK for building CircleCI Configuration files with JavaScript.",
@@ -5,0 +5,0 @@ "main": "dist/circleci-config-sdk.js",

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

1002981

increased by0.14%

Lines of code

14913

increased by0.09%

No dependency changes