@ambler/circleci-config-sdk 0.12.15 → 0.12.16

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

@@ -0,0 +1,111 @@
+import * as YAML from 'yaml';
+import { Generable } from '../Components';
+import { ReusableExecutor } from '../Components/Executors/exports/ReusableExecutor';
+import { Job } from '../Components/Job';
+import { CustomParametersList } from '../Components/Parameters';
+import { Parameterized } from '../Components/Parameters/exports/Parameterized';
+import { PipelineParameterLiteral } from '../Components/Parameters/types/CustomParameterLiterals.types';
+import { ReusableCommand } from '../Components/Reusable';
+import { Workflow } from '../Components/Workflow/exports/Workflow';
+import { OrbImport } from '../Orb/exports/OrbImport';
+import { GenerableType } from './exports/Mapping';
+import { Pipeline } from './Pipeline';
+import { CircleCIConfigObject, CircleCIConfigShape, ConfigVersion } from './types';
+/**
+ * A CircleCI configuration. Instantiate a new config and add CircleCI config elements.
+ */
+export declare class Config implements CircleCIConfigObject, Parameterized<PipelineParameterLiteral>, Generable {
+    /**
+     * The version field is intended to be used in order to issue warnings for deprecation or breaking changes.
+     */
+    version: ConfigVersion;
+    /**
+     * Reusable executors to be referenced from jobs.
+     */
+    executors?: ReusableExecutor[];
+    /**
+     * Jobs are collections of steps. All of the steps in the job are executed in a single unit, either within a fresh container or VM.
+     */
+    jobs: Job[];
+    /**
+     * A command definition defines a sequence of steps as a map to be executed in a job, enabling you to reuse a single command definition across multiple jobs.
+     */
+    commands?: ReusableCommand[];
+    /**
+     * A Workflow is comprised of one or more uniquely named jobs.
+     */
+    workflows: Workflow[];
+    /**
+     * A parameter allows custom data to be passed to a pipeline.
+     */
+    parameters?: CustomParametersList<PipelineParameterLiteral>;
+    /**
+     * Access information about the current pipeline.
+     */
+    pipeline: Pipeline;
+    /**
+     * Designates the config.yaml for use of CircleCI’s dynamic configuration feature.
+     */
+    setup: boolean;
+    orbs?: OrbImport[];
+    /**
+     * Instantiate a new CircleCI config. Build up your config by adding components.
+     * @param jobs - Instantiate with pre-defined Jobs.
+     * @param workflows - Instantiate with pre-defined Workflows.
+     * @param commands - Instantiate with pre-defined reusable Commands.
+     */
+    constructor(setup?: boolean, jobs?: Job[], workflows?: Workflow[], executors?: ReusableExecutor[], commands?: ReusableCommand[], parameters?: CustomParametersList<PipelineParameterLiteral>, orbs?: OrbImport[]);
+    /**
+     * Add a Workflow to the current Config. Chainable
+     * @param workflow - Injectable Workflow
+     */
+    addWorkflow(workflow: Workflow): this;
+    /**
+     * Add a Custom Command to the current Config. Chainable
+     * @param command - Injectable command
+     */
+    addReusableCommand(command: ReusableCommand): this;
+    /**
+     * Add a Workflow to the current Config. Chainable
+     * @param workflow - Injectable Workflow
+     */
+    addReusableExecutor(executor: ReusableExecutor): this;
+    /**
+     * Add a Job to the current Config. Chainable
+     * @param job - Injectable Job
+     */
+    addJob(job: Job): this;
+    importOrb(orb: OrbImport): 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: PipelineParameterLiteral, defaultValue?: unknown, description?: string, enumValues?: string[]): Config;
+    private _prependVersionComment;
+    /**
+     * @param flatten - Attempt to remove unnecessary parameters when possible.
+     * @returns the CircleCI config as a JSON string
+     */
+    generate(flatten?: boolean): CircleCIConfigShape;
+    /**
+     *
+     * @param flatten - Attempt to remove unnecessary parameters when possible.
+     * @param options - Modify the YAML output options.
+     * @returns the CircleCI config as a YAML string
+     */
+    stringify(flatten?: boolean, options?: YAML.ToStringOptions): string;
+    get generableType(): GenerableType;
+    /**
+     * Agnostic method to save a config file to disk via Node or the Browser.
+     * Note: If you are accessing this method from the browser, it must be triggered by a user action.
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/showSaveFilePicker#security}
+     * @param path - The path to write the config to. ONLY USED IN NODE.JS
+     */
+    writeFile(path?: string): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/Config/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AAEpF,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAExC,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,8DAA8D,CAAC;AACxG,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,yCAAyC,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACd,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,MACX,YACE,oBAAoB,EACpB,aAAa,CAAC,wBAAwB,CAAC,EACvC,SAAS;IAEX;;OAEG;IACH,OAAO,EAAE,aAAa,CAAO;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAM;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAM;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;IAC5D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAkB;IACpC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IAEnB;;;;;OAKG;gBAED,KAAK,UAAQ,EACb,IAAI,CAAC,EAAE,GAAG,EAAE,EACZ,SAAS,CAAC,EAAE,QAAQ,EAAE,EACtB,SAAS,CAAC,EAAE,gBAAgB,EAAE,EAC9B,QAAQ,CAAC,EAAE,eAAe,EAAE,EAC5B,UAAU,CAAC,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,EAC3D,IAAI,CAAC,EAAE,SAAS,EAAE;IAWpB;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAKrC;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAUlD;;;OAGG;IACH,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAUrD;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAMtB,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAU/B;;;;;;;;OAQG;IACH,eAAe,CACb,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,wBAAwB,EAC9B,YAAY,CAAC,EAAE,OAAO,EACtB,WAAW,CAAC,EAAE,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,EAAE,GACpB,MAAM;IAUT,OAAO,CAAC,sBAAsB;IAQ9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,mBAAmB;IAgChD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,GAAG,MAAM;IAcpE,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED;;;;;OAKG;IACG,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;CA2B9B"}

package/dist/src/lib/Config/types/Mapping.types.d.ts

@@ -0,0 +1,25 @@
+import { Generable } from '../../Components';
+import { GenerableType, ParameterizedComponent, ParameterSubtype } from '../exports/Mapping';
+interface _SchemaObject {
+    $id?: string;
+    $schema?: string;
+    [x: string]: unknown;
+}
+export interface SchemaObject extends _SchemaObject {
+    $id?: string;
+    $schema?: string;
+    $async?: false;
+    [x: string]: unknown;
+}
+export declare type GenerableSubtypes = ParameterSubtype | ParameterizedComponent;
+export declare type GenerableSubTypesMap = {
+    [GenerableType.CUSTOM_PARAMETER]: {
+        [key in GenerableSubtypes]: SchemaObject;
+    };
+    [GenerableType.CUSTOM_PARAMETERS_LIST]: {
+        [key in ParameterizedComponent]: SchemaObject;
+    };
+};
+export declare type OneOrMoreGenerable = Generable | Generable[];
+export {};
+//# sourceMappingURL=Mapping.types.d.ts.map

package/dist/src/lib/Config/types/Mapping.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mapping.types.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Config/types/Mapping.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAI5B,UAAU,aAAa;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG,sBAAsB,CAAC;AAE1E,oBAAY,oBAAoB,GAAG;IACjC,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE;SAC/B,GAAG,IAAI,iBAAiB,GAAG,YAAY;KACzC,CAAC;IACF,CAAC,aAAa,CAAC,sBAAsB,CAAC,EAAE;SACrC,GAAG,IAAI,sBAAsB,GAAG,YAAY;KAC9C,CAAC;CACH,CAAC;AAEF,oBAAY,kBAAkB,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC"}

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

@@ -0,0 +1,65 @@
+import { ReusableCommandShape } from '../../Components/Commands/types/Command.types';
+import { ReusableExecutor } from '../../Components/Executors/exports/ReusableExecutor';
+import { ReusableExecutorsShape } from '../../Components/Executors/types/ReusableExecutor.types';
+import { Job } from '../../Components/Job';
+import { JobsShape } from '../../Components/Job/types/Job.types';
+import { CustomParametersList } from '../../Components/Parameters';
+import { ParameterShape } from '../../Components/Parameters/types';
+import { AnyParameterLiteral } from '../../Components/Parameters/types/CustomParameterLiterals.types';
+import { Workflow } from '../../Components/Workflow/exports/Workflow';
+import { WorkflowsShape } from '../../Components/Workflow/types/Workflow.types';
+import { OrbImport } from '../../Orb';
+import { OrbImportsShape } from '../../Orb/types/Orb.types';
+import { Generable } from '../../Components';
+import { ReusableCommand } from '../../Components/Reusable';
+import * as mapping from './Mapping.types';
+/**
+ * Selected config version
+ */
+export declare type ConfigVersion = 2 | 2.1;
+/**
+ * Orb import object
+ */
+export declare type ConfigOrbImport = Record<string, string>;
+/**
+ * CircleCI configuration object
+ */
+export declare type CircleCIConfigObject = {
+    version: ConfigVersion;
+    jobs?: Job[];
+    executors?: ReusableExecutor[];
+    commands?: ReusableCommand[];
+    workflows?: Workflow[];
+    orbs?: OrbImport[];
+};
+/**
+ * Generated Shape of the CircleCI config.
+ */
+export declare type CircleCIConfigShape = {
+    version: ConfigVersion;
+    setup: boolean;
+    parameters?: Record<string, ParameterShape>;
+    executors?: ReusableExecutorsShape;
+    orbs?: OrbImportsShape;
+    jobs: JobsShape;
+    commands?: ReusableCommandShape;
+    workflows: WorkflowsShape;
+};
+export declare type UnknownConfigShape = {
+    setup: boolean;
+    orbs?: Record<string, unknown>;
+    executors?: Record<string, unknown>;
+    jobs: Record<string, unknown>;
+    commands?: Record<string, unknown>;
+    parameters?: Record<string, unknown>;
+    workflows: Record<string, unknown>;
+};
+export declare type ConfigDependencies = {
+    jobList: Job[];
+    workflows: Workflow[];
+    executorList?: ReusableExecutor[];
+    commandList?: ReusableCommand[];
+    parameterList?: CustomParametersList<AnyParameterLiteral>;
+};
+export { mapping, Generable };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Config/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AACvF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAC;AACjG,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iEAAiE,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAE3C;;GAEG;AACH,oBAAY,aAAa,GAAG,CAAC,GAAG,GAAG,CAAC;AAEpC;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAErD;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC,OAAO,EAAE,aAAa,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,SAAS,EAAE,cAAc,CAAC;CAC3B,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAC3D,CAAC;AAEF,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/src/lib/Orb/exports/OrbDefinition.d.ts

@@ -0,0 +1,21 @@
+import { OrbDisplayMeta } from '../types/Orb.types';
+export interface OrbDefinition {
+    /**
+     * The name of this orb.
+     */
+    name: string;
+    /**
+     * The namespace this orb belongs to.
+     */
+    namespace: string;
+    /**
+     * The version of this orb.
+     */
+    version: string;
+    description?: string;
+    /**
+     * The display metadata for this orb.
+     */
+    display?: OrbDisplayMeta;
+}
+//# sourceMappingURL=OrbDefinition.d.ts.map

package/dist/src/lib/Orb/exports/OrbDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrbDefinition.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Orb/exports/OrbDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAKhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}

package/dist/src/lib/Orb/exports/OrbImport.d.ts

@@ -0,0 +1,24 @@
+import { Generable } from '../../Components';
+import { CommandParameterLiteral, ExecutorParameterLiteral, JobParameterLiteral } from '../../Components/Parameters/types/CustomParameterLiterals.types';
+import { GenerableType } from '../../Config/exports/Mapping';
+import { OrbDisplayMeta, OrbImportManifest } from '../types/Orb.types';
+import { OrbRef } from './OrbRef';
+/**
+ * A reference to an imported Orb.
+ * {@label STATIC_2.1}
+ */
+export declare class OrbImport implements Generable {
+    alias: string;
+    namespace: string;
+    name: string;
+    version: string;
+    jobs: Record<string, OrbRef<JobParameterLiteral>>;
+    commands: Record<string, OrbRef<CommandParameterLiteral>>;
+    executors: Record<string, OrbRef<ExecutorParameterLiteral>>;
+    description?: string;
+    display?: OrbDisplayMeta;
+    constructor(alias: string, namespace: string, orb: string, version: string, description?: string, manifest?: OrbImportManifest, display?: OrbDisplayMeta);
+    generate(): Record<string, string>;
+    get generableType(): GenerableType;
+}
+//# sourceMappingURL=OrbImport.d.ts.map

package/dist/src/lib/Orb/exports/OrbImport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrbImport.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Orb/exports/OrbImport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAEL,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,iEAAiE,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,qBAAa,SAAU,YAAW,SAAS;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAM;IACvD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAM;IAC/D,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAM;IAEjE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,cAAc,CAAC;gBAGvB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,iBAAiB,EAC5B,OAAO,CAAC,EAAE,cAAc;IAgB1B,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAMlC,IAAI,aAAa,IAAI,aAAa,CAEjC;CACF"}

package/dist/src/lib/Orb/exports/OrbRef.d.ts

@@ -0,0 +1,19 @@
+import { CustomParametersList } from '../../Components/Parameters';
+import { AnyParameterLiteral } from '../../Components/Parameters/types/CustomParameterLiterals.types';
+import { GenerableType } from '../../Config/exports/Mapping';
+import { OrbImport } from './OrbImport';
+/**
+ * An abstract reference to an orb component.
+ * {@label STATIC_2.1}
+ */
+export declare class OrbRef<Literal extends AnyParameterLiteral> {
+    private _parameters;
+    private _name;
+    private _orb;
+    constructor(name: string, parameters: CustomParametersList<Literal>, orb: OrbImport);
+    get generableType(): GenerableType;
+    get name(): string;
+    get parameters(): CustomParametersList<Literal>;
+    get orb(): OrbImport;
+}
+//# sourceMappingURL=OrbRef.d.ts.map

package/dist/src/lib/Orb/exports/OrbRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrbRef.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Orb/exports/OrbRef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iEAAiE,CAAC;AACtG,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,qBAAa,MAAM,CAAC,OAAO,SAAS,mBAAmB;IACrD,OAAO,CAAC,WAAW,CAAgC;IACnD,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,IAAI,CAAY;gBAGtB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACzC,GAAG,EAAE,SAAS;IAOhB,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,UAAU,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAE9C;IAED,IAAI,GAAG,IAAI,SAAS,CAEnB;CACF"}

package/dist/src/lib/Orb/index.d.ts

@@ -0,0 +1,4 @@
+import { OrbImport } from './exports/OrbImport';
+import { OrbRef } from './exports/OrbRef';
+export { OrbImport, OrbRef };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/lib/Orb/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/Orb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC"}

package/dist/src/lib/Orb/types/Orb.types.d.ts

@@ -0,0 +1,18 @@
+import { CustomParametersList } from '../../Components/Parameters';
+import { Parameterized } from '../../Components/Parameters/exports/Parameterized';
+import { AnyParameterLiteral, CommandParameterLiteral, ExecutorParameterLiteral, JobParameterLiteral } from '../../Components/Parameters/types/CustomParameterLiterals.types';
+export declare type OrbDisplayMeta = {
+    home_url: string;
+    source_url: string;
+};
+export declare type OrbImportShape = {
+    [importName: string]: string;
+};
+export declare type OrbImportsShape = Record<string, OrbImportShape>;
+export declare type OrbComponent = Parameterized<AnyParameterLiteral>;
+export declare type OrbImportManifest = {
+    jobs: Record<string, CustomParametersList<JobParameterLiteral>>;
+    executors: Record<string, CustomParametersList<ExecutorParameterLiteral>>;
+    commands: Record<string, CustomParametersList<CommandParameterLiteral>>;
+};
+//# sourceMappingURL=Orb.types.d.ts.map

package/dist/src/lib/Orb/types/Orb.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Orb.types.d.ts","sourceRoot":"","sources":["../../../../../src/lib/Orb/types/Orb.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,mDAAmD,CAAC;AAClF,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,iEAAiE,CAAC;AAEzE,oBAAY,cAAc,GAAG;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAC7D,oBAAY,YAAY,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAC9D,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAChE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAC1E,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,CAAC;CACzE,CAAC"}

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

@@ -0,0 +1,8 @@
+export * as command from '../Components/Commands/types/Command.types';
+export * as executors from '../Components/Executors/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/dist/src/lib/Types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/Types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,4CAA4C,CAAC;AACtE,OAAO,KAAK,SAAS,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,mCAAmC,CAAC;AACzD,OAAO,KAAK,SAAS,MAAM,gCAAgC,CAAC;AAC5D,OAAO,KAAK,QAAQ,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,GAAG,MAAM,wBAAwB,CAAC"}

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@ambler/circleci-config-sdk",
-  "version": "0.12.15",
+  "version": "0.12.16",
   "description": "An SDK for building CircleCI Configuration files with JavaScript.",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "npx jest",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx --max-warnings 0",
     "prettier": "prettier --write .",
     "prettier:ci": "prettier --check .",
-    "build": "rm -rf ./dist && npx webpack --mode production",
+    "build": "rm -rf ./dist && npx webpack --mode production && npx tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig ./tsconfig.json --logLevel Verbose --excludeInternal --internalNamespace internalTypes"
   },
   "repository": {

package/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at community-partner@circleci.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

package/commitlint.config.js

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };

package/package-version.json

@@ -1 +0,0 @@
-{ "version": "0.0.0-development" }

package/tsconfig.webpack.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "**/*.d.ts", "**/*.test.ts"]
-}