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

Comparing version 0.6.0 to 0.7.0

dist/src/lib/Components/Commands/exports/Native/Run.d.ts

@@ -13,4 +13,3 @@ import { GenerableType } from '../../../../Config/exports/Mapping';
     /**
-     * Generate Run Command shape.
-     * @returns The generated JSON for the Run Commands.
+     * Generate Run Command shape.* @returns The generated JSON for the Run Commands.
      */
@@ -17,0 +16,0 @@ generate(): RunCommandShape | RunCommandShorthandShape;

dist/src/lib/Components/Executors/exports/Executor.d.ts

 import { GenerableType } from '../../../Config/exports/Mapping';
 import { Generable } from '../../index';
+import { CustomParametersList } from '../../Parameters';
+import { ExecutorParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
 import { AnyResourceClass, ExecutorLiteral, ExecutorShape } from '../types/Executor.types';
 import { ExecutableParameters } from '../types/ExecutorParameters.types';
+import { ReusableExecutor } from './ReusableExecutor';
 /**
@@ -21,3 +24,4 @@ * A generic reusable Executor
     generate(): ExecutorShape;
+    asReusable(name: string, parameters?: CustomParametersList<ExecutorParameterLiteral>): ReusableExecutor;
 }
 //# sourceMappingURL=Executor.d.ts.map

dist/src/lib/Components/Executors/exports/ReusableExecutor.d.ts

@@ -5,5 +5,7 @@ import { Generable } from '../..';
 import { Parameterized } from '../../Parameters/exports/Parameterized';
+import { ExecutorParameterTypes } from '../../Parameters/types/ComponentParameters.types';
 import { ExecutorParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
 import { ReusableExecutorJobRefShape, ReusableExecutorsShape } from '../types/ReusableExecutor.types';
 import { Executor } from './Executor';
+import { ReusedExecutor } from './ReusedExecutor';
 /**
@@ -35,3 +37,4 @@ * A 2.1 wrapper for reusing CircleCI executor.
     get generableType(): GenerableType;
+    reuse(parameters?: Record<string, ExecutorParameterTypes>): ReusedExecutor;
 }
 //# sourceMappingURL=ReusableExecutor.d.ts.map

dist/src/lib/Components/Executors/parsers/index.d.ts

@@ -1,2 +0,2 @@
-import { Executor } from '../exports/Executor';
+import { AnyExecutor } from '../../Job/types/Job.types';
 import { ReusableExecutor } from '../exports/ReusableExecutor';
@@ -16,3 +16,3 @@ import { UnknownExecutableShape } from '../types/Executor.types';
  */
-export declare function parseExecutor(executableIn: unknown, reusableExecutors?: ReusableExecutor[]): Executor | ReusableExecutor;
+export declare function parseExecutor(executableIn: unknown, reusableExecutors?: ReusableExecutor[]): AnyExecutor;
 /**
@@ -19,0 +19,0 @@ * Parses a config's list of reusable executors.

dist/src/lib/Components/Executors/types/Executor.types.d.ts

 import { GenerableType } from '../../../Config/exports/Mapping';
+import { AnyExecutor } from '../../Job/types/Job.types';
 import { CustomParametersList } from '../../Parameters';
@@ -7,2 +8,3 @@ import { ExecutorParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
 import { ExecutableProperties } from './ExecutorParameters.types';
+import { ReusedExecutorShape } from './ReusableExecutor.types';
 export declare type UnknownExecutableShape = {
@@ -18,2 +20,3 @@ resource_class: AnyResourceClass;
 } & Partial<Record<ExecutorLiteral, unknown>> & ExecutableProperties;
+export declare type AnyExecutorShape = ExecutorShape | ReusedExecutorShape;
 /**
@@ -47,5 +50,6 @@ * The valid resource classes found for an executor object
         generableType: GenerableType;
-        parse: (args: unknown, resourceClass: AnyResourceClass, properties?: ExecutableProperties, reusableExecutors?: ReusableExecutor[]) => Executor | ReusableExecutor;
+        parse: ExecutorSubtypeParser;
     };
 };
+export declare type ExecutorSubtypeParser = (args: unknown, resourceClass: AnyResourceClass, properties?: ExecutableProperties, reusableExecutors?: ReusableExecutor[]) => AnyExecutor;
 //# sourceMappingURL=Executor.types.d.ts.map

dist/src/lib/Components/Executors/types/ReusableExecutor.types.d.ts

@@ -17,2 +17,15 @@ import { AnyParameterType, CustomParametersListShape, StringParameter } from '../../Parameters/types';
 };
+/**
+ * The shape output when a reusable executor is generated for a job
+ */
+export declare type ReusedExecutorShapeContents = {
+    name: StringParameter;
+    [key: string]: AnyParameterType;
+} | StringParameter;
+/**
+ * The shape output when a reusable executor is generated for a job
+ */
+export declare type ReusedExecutorShape = {
+    executor: ReusedExecutorShapeContents;
+};
 //# sourceMappingURL=ReusableExecutor.types.d.ts.map

dist/src/lib/Components/Job/index.d.ts

 import { GenerableType } from '../../Config/exports/Mapping';
 import { Command } from '../Commands/exports/Command';
 import { Generable } from '../index';
-import { ParameterizedJob } from './exports/ParameterizedJob';
 import { AnyExecutor, JobContentsShape, JobsShape } from './types/Job.types';
@@ -57,3 +56,2 @@ /**
 };
-export { ParameterizedJob };
 //# sourceMappingURL=index.d.ts.map

dist/src/lib/Components/Job/types/Job.types.d.ts

 import { Command } from '../../Commands/exports/Command';
 import { Executor } from '../../Executors';
-import { ExecutorShape } from '../../Executors/types/Executor.types';
+import { ReusedExecutor } from '../../Executors/exports/ReusedExecutor';
+import { AnyExecutorShape } from '../../Executors/types/Executor.types';
 import { CustomParametersList } from '../../Parameters';
 import { CustomParametersListShape } from '../../Parameters/types';
 import { JobParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
-import { ReusableExecutor } from '../../Reusable';
 export declare type JobStepsShape = {
     steps: unknown[];
 };
-export declare type JobContentsShape = JobStepsShape & ExecutorShape;
+export declare type JobContentsShape = JobStepsShape & AnyExecutorShape;
 export declare type JobsShape = {
     [key: string]: JobContentsShape;
 };
-export declare type AnyExecutor = ReusableExecutor | Executor;
+export declare type AnyExecutor = ReusedExecutor | Executor;
 export declare type ParameterizedJobContents = JobContentsShape & {
@@ -20,3 +20,3 @@ parameters: CustomParametersListShape;
 export declare type JobDependencies = {
-    executor: Executor | ReusableExecutor;
+    executor: AnyExecutor;
     steps: Command[];
@@ -23,0 +23,0 @@ parametersList?: CustomParametersList<JobParameterLiteral>;

dist/src/lib/Components/Logic/index.d.ts

@@ -1,5 +0,2 @@
-import { And } from './exports/conditions/And';
-import { Equal } from './exports/conditions/Equal';
-import { Not } from './exports/conditions/Not';
-import { Or } from './exports/conditions/Or';
+import { And, Equal, Not, Or } from './exports/conditions/';
 import { ConditionOrValue, ConditionValue } from './types';
@@ -6,0 +3,0 @@ export declare function and(...conditions: ConditionOrValue[]): And;

dist/src/lib/Components/Logic/types/index.d.ts

@@ -1,2 +0,2 @@
-import { Condition } from '../exports/Condition';
+import { Condition } from '../exports/conditions';
 export declare type AndConditionShape = {
@@ -3,0 +3,0 @@ and: AnyConditionShape[];

dist/src/lib/Components/Parameters/exports/CustomParameterList.d.ts

@@ -28,5 +28,4 @@ import { CustomParameter } from '..';
     define(name: string, type: ParameterTypeLiteral, defaultValue?: unknown, description?: string, enumValues?: string[]): CustomParameter<ParameterTypeLiteral>;
-    remove(name: string): void;
     get generableType(): GenerableType;
 }
 //# sourceMappingURL=CustomParameterList.d.ts.map

dist/src/lib/Config/exports/Mapping.d.ts

@@ -25,3 +25,3 @@ export declare enum GenerableType {
     WINDOWS_EXECUTOR = "windows_executor",
-    REUSABLE_EXECUTOR_USAGE = "reusable_executor_usage",
+    REUSED_EXECUTOR = "reused_executor",
     REUSABLE_EXECUTOR = "reusable_executor",
@@ -28,0 +28,0 @@ REUSABLE_EXECUTOR_LIST = "reusable_executors_list",

package.json

 {
   "name": "@circleci/circleci-config-sdk",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "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

2652155

increased by0.25%

Number of package files

484

increased by0.41%

Lines of code

20147

increased by0.26%

No dependency changes