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

Comparing version 0.9.0-alpha.21 to 0.10.0

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

 import { StringParameter } from '../../Parameters/types';
 import { DockerImageShape } from '../exports/DockerImage';
-import { AnyResourceClass } from './Executor.types';
+import { AnyResourceClassBase } from './Executor.types';
 /**
@@ -16,3 +16,3 @@ * A JSON representation of the Docker Executor Schema
  */
-export declare type DockerResourceClass = AnyResourceClass;
+export declare type DockerResourceClass = AnyResourceClassBase;
 //# sourceMappingURL=DockerExecutor.types.d.ts.map

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

@@ -8,2 +8,4 @@ import { Executor } from '..';
 import { ExecutableProperties } from './ExecutorParameters.types';
+import { MachineResourceClassArm, MachineResourceClassGPU } from './MachineExecutor.types';
+import { MacOSResourceClassAdvanced } from './MacOSExecutor.types';
 import { ReusedExecutorShape } from './ReusableExecutor.types';
@@ -22,6 +24,14 @@ export declare type UnknownExecutableShape = {
 /**
- * The valid resource classes found for an executor object
+ * All valid resource classes found for an executor object for standard use cases
  */
-export declare type AnyResourceClass = 'small' | 'medium' | 'medium+' | 'large' | 'xlarge' | '2xlarge' | '2xlarge+';
+export declare type AnyResourceClassBase = 'small' | 'medium' | 'medium+' | 'large' | 'xlarge' | '2xlarge' | '2xlarge+';
 /**
+ * The valid resource classes for advanced use cases
+ */
+export declare type AnyResourceClassExtended = MachineResourceClassArm | MachineResourceClassGPU | MacOSResourceClassAdvanced;
+/**
+ * All valid resource classes found for an executor object
+ */
+export declare type AnyResourceClass = AnyResourceClassBase | AnyResourceClassExtended;
+/**
  * The valid executors found on an executor object
@@ -28,0 +38,0 @@ * Windows is covered by the machine literal

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

@@ -8,6 +8,16 @@ import { BooleanParameter, StringParameter } from '../../Parameters/types';
 /**
- * The available Machine(Linux) Resource Classes.
- * @see {@link https://circleci.com/docs/2.0/configuration-reference/#machine-executor-linux} for specifications of each class.
+ * The available GPU Machine (Linux) Resource Classes.
+ * @see {@link https://circleci.com/docs/configuration-reference#arm-execution-environment-linux} for specifications of each class.
  */
-export declare type MachineResourceClass = Extract<AnyResourceClass, 'medium' | 'large' | 'xlarge' | '2xlarge'>;
+export declare type MachineResourceClassArm = 'arm.medium' | 'arm.large' | 'arm.xlarge' | 'arm.2xlarge';
+/**
+ * The available Machine (Linux) Resource Classes.
+ * @see {@link https://circleci.com/docs/configuration-reference#gpu-execution-environment-linux} for specifications of each class.
+ */
+export declare type MachineResourceClassGPU = 'gpu.nvidia.small' | 'gpu.nvidia.medium' | 'gpu.nvidia.large';
+/**
+ * The available Arm Machine (Linux) Resource Classes.
+ * @see {@link https://circleci.com/docs/configuration-reference#linuxvm-execution-environment} for specifications of each class.
+ */
+export declare type MachineResourceClass = Extract<AnyResourceClass, 'medium' | 'large' | 'xlarge' | '2xlarge' | MachineResourceClassArm | MachineResourceClassGPU>;
 //# sourceMappingURL=MachineExecutor.types.d.ts.map

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

@@ -14,3 +14,4 @@ import { StringParameter } from '../../Parameters/types';
  */
-export declare type MacOSResourceClass = Extract<AnyResourceClass, 'medium' | 'large'>;
+export declare type MacOSResourceClass = Extract<AnyResourceClass, 'medium' | 'large' | MacOSResourceClassAdvanced>;
+export declare type MacOSResourceClassAdvanced = 'macos.x86.metal.gen1' | 'macos.x86.medium.gen2';
 //# sourceMappingURL=MacOSExecutor.types.d.ts.map

dist/src/lib/Components/Job/exports/ParameterizedJob.d.ts

@@ -6,3 +6,3 @@ import { Job } from '..';
 import { JobParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
-import { AnyExecutor, ParameterizedJobContents } from '../types/Job.types';
+import { AnyExecutor, JobOptionalProperties, ParameterizedJobContents } from '../types/Job.types';
 /**
@@ -18,3 +18,3 @@ * Parameterized jobs are a type of Job which defines the parameters it can accept.
     parameters: CustomParametersList<JobParameterLiteral>;
-    constructor(name: string, executor: AnyExecutor, parameters?: CustomParametersList<JobParameterLiteral>, steps?: Command[]);
+    constructor(name: string, executor: AnyExecutor, parameters?: CustomParametersList<JobParameterLiteral>, steps?: Command[], properties?: JobOptionalProperties);
     /**
@@ -21,0 +21,0 @@ * Generate the internal contents of this job.

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

@@ -5,4 +5,4 @@ import { GenerableType } from '../../Config/exports/Mapping';
 import { Generable } from '../index';
-import { EnvironmentParameter, StringParameter } from '../Parameters/types';
-import { AnyExecutor, JobContentsShape, JobExtraProperties, JobsShape } from './types/Job.types';
+import { EnvironmentParameter, IntegerParameter, StringParameter } from '../Parameters/types';
+import { AnyExecutor, JobContentsShape, JobOptionalProperties, JobsShape } from './types/Job.types';
 /**
@@ -25,5 +25,5 @@ * Jobs define a collection of steps to be run within a given executor, and are orchestrated using Workflows.
     /**
-     * Number of parallel instances of this job to run (default: 1)
+     * Number of parallel instances of this job to run (defaults to 1 if undefined)
      */
-    parallelism: number;
+    parallelism: IntegerParameter | undefined;
     environment?: EnvironmentParameter;
@@ -37,5 +37,6 @@ shell?: StringParameter;
      * @param steps - A list of Commands to execute within the job in the order which they were added.
+     * @param properties - Additional optional properties to further configure the job.
      * @see {@link https://circleci.com/docs/2.0/configuration-reference/?section=configuration#jobs}
      */
-    constructor(name: string, executor: AnyExecutor, steps?: Command[], properties?: JobExtraProperties);
+    constructor(name: string, executor: AnyExecutor, steps?: Command[], properties?: JobOptionalProperties);
     /**
@@ -42,0 +43,0 @@ * Generates the contents of the Job.

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

@@ -8,6 +8,6 @@ import { Command } from '../../Commands/exports/Command';
 import { JobParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
-export declare type JobStepsShape = {
+export declare type JobContentsShape = {
     steps: unknown[];
-};
-export declare type JobContentsShape = JobStepsShape & AnyExecutorShape & JobEnvironmentShape;
+    parallelism?: number;
+} & AnyExecutorShape & JobEnvironmentShape;
 export declare type JobsShape = {
@@ -28,3 +28,3 @@ [key: string]: JobContentsShape;
 };
-export declare type JobExtraProperties = {
+export declare type JobOptionalProperties = {
     parallelism?: number;
@@ -31,0 +31,0 @@ } & ExecutableProperties;

package.json

 {
   "name": "@circleci/circleci-config-sdk",
-  "version": "v0.9.0-alpha.21",
+  "version": "v0.10.0",
   "description": "An SDK for building CircleCI Configuration files with JavaScript.",
@@ -5,0 +5,0 @@ "main": "dist/index.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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

868912

increased by0.28%

Lines of code

2748

increased by0.81%

Worsened metrics

Number of downloads

21013

decreased by-40.03%

No dependency changes