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

Comparing version 0.9.0-alpha.1 to 0.9.0-alpha.2

dist/src/index.d.ts

 /**
+ * All schemas used to validate the components.
+ */
+export * as schemas from './lib/Schemas';
+/**
  * Reusable components are an extension of base components
@@ -39,2 +43,6 @@ * which implement functionality to make them configurable
 export * as workflow from './lib/Components/Workflow';
+/**
+ * All imports pertaining to orbs
+ */
+export * as orb from './lib/Orb';
 export { Job } from './lib/Components/Job';
@@ -41,0 +49,0 @@ export { Config, Validator } from './lib/Config';

dist/src/lib/Components/Commands/exports/Native/Cache/Restore.d.ts

@@ -26,3 +26,4 @@ import { GenerableType } from '../../../../../Config/exports/Mapping';
      */
-    readonly keys: ListParameter;
+    readonly keys?: ListParameter;
+    readonly key?: StringParameter;
 }
@@ -29,0 +30,0 @@ /**

dist/src/lib/Components/Commands/exports/Reusable/ReusableCommand.d.ts

 import { GenerableType } from '../../../../Config/exports/Mapping';
+import { OrbRef } from '../../../../Orb';
 import { StringParameter } from '../../../Parameters/types';
+import { CommandParameterLiteral } from '../../../Parameters/types/CustomParameterLiterals.types';
 import { CommandParameters, CommandShape } from '../../types/Command.types';
@@ -19,3 +21,3 @@ import { Command } from '../Command';
      */
-    constructor(command: CustomCommand | string, parameters?: CommandParameters);
+    constructor(command: CustomCommand | string | OrbRef<CommandParameterLiteral>, parameters?: CommandParameters);
     /**
@@ -22,0 +24,0 @@ * @returns JSON representation of the reusable command being called

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

 import { Generable } from '../..';
 import { GenerableType } from '../../../Config/exports/Mapping';
+import { OrbRef } from '../../../Orb';
 import { ExecutorParameterTypes } from '../../Parameters/types/ComponentParameters.types';
+import { ExecutorParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
 import { ReusedExecutorShape, ReusedExecutorShapeContents } from '../types/ReusableExecutor.types';
@@ -20,3 +22,3 @@ import { ReusableExecutor } from './ReusableExecutor';
     private _parameters?;
-    constructor(executor: ReusableExecutor, parameters?: Record<string, ExecutorParameterTypes>);
+    constructor(executor: ReusableExecutor | OrbRef<ExecutorParameterLiteral>, parameters?: Record<string, ExecutorParameterTypes>);
     /**
@@ -33,5 +35,5 @@ * Generate Reused Executor schema.
     get generableType(): GenerableType;
-    get executor(): ReusableExecutor;
+    get executor(): ReusableExecutor | OrbRef<ExecutorParameterLiteral>;
     get parameters(): Record<string, ExecutorParameterTypes> | undefined;
 }
 //# sourceMappingURL=ReusedExecutor.d.ts.map

dist/src/lib/Components/Parameters/schemas/index.d.ts

@@ -1,4 +0,8 @@
-import { SchemaObject } from 'ajv';
-declare const genParameterListSchema: (type: string) => SchemaObject;
-export { genParameterListSchema };
+import ExecutorParametersSchema from './ExecutorParameters.schema';
+import JobParametersSchema from './JobParameters.schema';
+import CommandParametersSchema from './CommandParameters.schema';
+import PipelineParametersSchema from './PipelineParameters.schema';
+import * as lists from './ComponentParameterLists.schema';
+import * as types from './ParameterTypes.schema';
+export { lists, types, ExecutorParametersSchema, JobParametersSchema, CommandParametersSchema, PipelineParametersSchema, };
 //# sourceMappingURL=index.d.ts.map

dist/src/lib/Components/Workflow/exports/WorkflowJob.d.ts

@@ -0,2 +1,4 @@
+import { OrbRef } from '../../../Orb/exports/OrbRef';
 import { Job } from '../../Job';
+import { JobParameterLiteral } from '../../Parameters/types/CustomParameterLiterals.types';
 import { WorkflowJobParameters, WorkflowJobShape } from '../types/WorkflowJob.types';
@@ -11,4 +13,4 @@ import { WorkflowJobAbstract } from './WorkflowJobAbstract';
 export declare class WorkflowJob extends WorkflowJobAbstract {
-    job: Job;
-    constructor(job: Job, parameters?: Exclude<WorkflowJobParameters, 'type'>);
+    job: Job | OrbRef<JobParameterLiteral>;
+    constructor(job: Job | OrbRef<JobParameterLiteral>, parameters?: Exclude<WorkflowJobParameters, 'type'>);
     generate(): WorkflowJobShape;
@@ -15,0 +17,0 @@ get name(): string;

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

 export declare enum GenerableType {
     CONFIG = "config",
+    ORB = "orb",
+    ORB_IMPORT = "orb_import",
+    ORB_REF = "orb_ref",
     REUSABLE_COMMAND = "reusable_command",
@@ -4,0 +7,0 @@ CUSTOM_COMMAND = "custom_command",

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

@@ -9,2 +9,3 @@ import { Generable } from '../Components';
 import { Workflow } from '../Components/Workflow/exports/Workflow';
+import { OrbImport } from '../Orb/exports/OrbImport';
 import { GenerableType } from './exports/Mapping';
@@ -50,2 +51,3 @@ import { Validator } from './exports/Validator';
     setup: boolean;
+    orbs?: OrbImport[];
     /**
@@ -57,3 +59,3 @@ * Instantiate a new CircleCI config. Build up your config by adding components.
      */
-    constructor(setup?: boolean, jobs?: Job[], workflows?: Workflow[], executors?: ReusableExecutor[], commands?: CustomCommand[], parameters?: CustomParametersList<PipelineParameterLiteral>);
+    constructor(setup?: boolean, jobs?: Job[], workflows?: Workflow[], executors?: ReusableExecutor[], commands?: CustomCommand[], parameters?: CustomParametersList<PipelineParameterLiteral>, orbs?: OrbImport[]);
     /**
@@ -79,2 +81,3 @@ * Add a Workflow to the current Config. Chainable
     addJob(job: Job): this;
+    importOrb(orb: OrbImport): this;
     /**
@@ -81,0 +84,0 @@ * Define a pipeline parameter for the current Config. Chainable

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

@@ -12,2 +12,4 @@ import { CustomCommandShape } from '../../Components/Commands/types/Command.types';
 import { WorkflowsShape } from '../../Components/Workflow/types/Workflow.types';
+import { OrbImport } from '../../Orb';
+import { OrbImportsShape } from '../../Orb/types/Orb.types';
 import * as mapping from './Mapping.types';
@@ -22,6 +24,3 @@ import * as validator from './Validator.types';
  */
-export declare type ConfigOrbImport = {
-    orbAlias: string;
-    orbImport: string;
-};
+export declare type ConfigOrbImport = Record<string, string>;
 /**
@@ -36,2 +35,3 @@ * CircleCI configuration object
     workflows?: Workflow[];
+    orbs?: OrbImport[];
 };
@@ -46,3 +46,3 @@ /**
     executors?: ReusableExecutorsShape;
-    orbs?: ConfigOrbImport[];
+    orbs?: OrbImportsShape;
     jobs: JobsShape;
@@ -49,0 +49,0 @@ commands?: CustomCommandShape;

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

@@ -1,7 +0,8 @@
-export * as parameter from '../Components/Parameters/types';
+export * as command from '../Components/Commands/types/Command.types';
 export * as executor from '../Components/Executors/types';
-export * as command from '../Components/Commands/types/Command.types';
-export * as config from '../Config/types';
 export * as job from '../Components/Job/types/Job.types';
+export * as parameter from '../Components/Parameters/types';
 export * as workflow from '../Components/Workflow/types';
+export * as config from '../Config/types';
+export * as orb from '../Orb/types/Orb.types';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@circleci/circleci-config-sdk",
-  "version": "v0.9.0-alpha.1",
+  "version": "v0.9.0-alpha.2",
   "description": "An SDK for building CircleCI Configuration files with JavaScript.",
@@ -8,3 +8,3 @@ "main": "dist/circleci-config-sdk.js",
   "scripts": {
-    "test": "npx jest && npm run build:docs",
+    "test": "npx jest",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx --max-warnings 0",
@@ -11,0 +11,0 @@ "prettier": "prettier --write .",

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

2693249

increased by1.21%

Number of package files

516

increased by5.31%

Lines of code

20355

increased by0.83%

No dependency changes