stacktape 2.23.0-alpha.8 → 2.23.0-beta.0

package/index.d.ts

@@ -98,7 +98,7 @@ import type {
  * Helper function to define a config with automatic transformation
  * Use this when exporting your config for the Stacktape CLI
  */
-export declare const defineConfig: (configFn: (params: GetConfigParams) => any) => ((params: GetConfigParams) => any);
+export declare const defineConfig: (configFn: (params: GetConfigParams) => StacktapeConfig) => (params: GetConfigParams) => any;
 /**
  * Transforms a config with resource instances into a plain config object
  */
@@ -109,85 +109,78 @@ export {};
 // ==========================================
 // ESSENTIAL BASE TYPES
 // ==========================================
-
 declare const getParamReferenceSymbol: unique symbol;
+
 declare const getTypeSymbol: unique symbol;
+
 declare const getPropertiesSymbol: unique symbol;
+
 declare const getOverridesSymbol: unique symbol;
 
-/**
- * A reference to a resource parameter that will be resolved at runtime
- */
 export declare class ResourceParamReference {
-  private __resourceName: string;
-  private __param: string;
-  constructor(resourceName: string, param: string);
-  toString(): string;
-  toJSON(): string;
-  valueOf(): string;
+    private __resourceName;
+    private __param;
+    constructor(resourceName: string, param: string);
+    toString(): string;
+    toJSON(): string;
+    valueOf(): string;
 }
 
-/**
- * Base class for type/properties structures (engines, packaging, events, etc.)
- */
 export declare class BaseTypeProperties {
-  readonly type: string;
-  readonly properties: any;
-  constructor(type: string, properties: any);
+    readonly type: string;
+    readonly properties: any;
+    constructor(type: string, properties: any);
 }
 
-/**
- * Base resource class that provides common functionality
- */
 export declare class BaseResource {
-  private readonly _type: string;
-  private readonly _properties: any;
-  private readonly _overrides?: any;
-  private readonly _resourceName: string;
-  constructor(name: string, type: string, properties: any, overrides?: any);
-  get resourceName(): string;
-  [getParamReferenceSymbol](paramName: string): ResourceParamReference;
-  [getTypeSymbol](): string;
-  [getPropertiesSymbol](): any;
-  [getOverridesSymbol](): any | undefined;
+    private readonly _type;
+    private readonly _properties;
+    private readonly _overrides?;
+    private readonly _resourceName;
+    constructor(name: string, type: string, properties: any, overrides?: any);
+    get resourceName(): string;
+    [getParamReferenceSymbol](paramName: string): ResourceParamReference;
+    [getTypeSymbol](): string;
+    [getPropertiesSymbol](): any;
+    [getOverridesSymbol](): any | undefined;
 }
 
-/**
- * Parameters passed to the config function
- */
 export type GetConfigParams = {
-  /**
-   * Stage ("environment") used for this operation
-   */
-  stage: string;
-  /**
-   * AWS region used for this operation
-   * The list of available regions is available at https://www.aws-services.info/regions.html
-   */
-  region: string;
-  /**
-   * List of arguments passed to the operation
-   */
-  cliArgs: Record<string, boolean | number | string | string[]>;
-  /**
-   * Stacktape command used to perform this operation (can be either deploy, codebuild:deploy, delete, etc.)
-   */
-  command: string;
-  /**
-   * Locally-configured AWS profile used to execute the operation.
-   * Doesn't apply if you have your AWS account connected in "automatic" mode.
-   */
-  awsProfile: string;
-  /**
-   * Information about the user performing the stack operation
-   */
-  user: {
-    id: string;
-    name: string;
-    email: string;
-  };
-};
-
+    /**
+     * Project name used for this operation
+     */
+    projectName: string;
+    /**
+     * Stage ("environment") used for this operation
+     */
+    stage: string;
+    /**
+     * AWS region used for this operation
+     * The list of available regions is available at https://www.aws-services.info/regions.html
+     */
+    region: string;
+    /**
+     * List of arguments passed to the operation
+     */
+    cliArgs: StacktapeArgs;
+    /**
+     * Stacktape command used to perform this operation (can be either deploy, codebuild:deploy, delete, etc.)
+     */
+    command: string;
+    /**
+     * Locally-configured AWS profile used to execute the operation.
+     * Doesn't apply if you have your AWS account connected in "automatic" mode.
+     */
+    awsProfile: string;
+    /**
+     * Information about the user performing the stack operation
+     */
+    user: {
+        id: string;
+        name: string;
+        email: string;
+    };
+}
 
 // ==========================================
 // AUGMENTED PROPS TYPES