@webda/aws 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/deployers/awsdeployer.d.ts

@@ -0,0 +1,340 @@
+import { CertificateDetail } from "@aws-sdk/client-acm";
+import { HostedZone, RRType } from "@aws-sdk/client-route-53";
+import { S3 } from "@aws-sdk/client-s3";
+import { GetCallerIdentityResponse } from "@aws-sdk/client-sts";
+import { Service, ServiceParameters } from "@webda/core";
+/**
+ * Tags as an AWS array or as a map
+ */
+export type TagsDefinition = {
+    Key: string;
+    Value: string;
+}[] | {
+    [key: string]: string;
+};
+/**
+ * AWS clients a deployer can target with a custom endpoint
+ */
+export type AWSDeployerEndpoint = "ACM" | "S3" | "STS" | "EC2" | "Route53" | "CloudFormation" | "APIGateway" | "CloudFront";
+/**
+ * Common parameters of the AWS deployers
+ *
+ * A deployer is declared as a unit of a deployment (`deployments/<name>.json`),
+ * its parameters can use the `${...}` deployment variables ({@link getDeploymentVariables})
+ */
+export declare class AWSDeployerParameters extends ServiceParameters {
+    /**
+     * Name of the unit
+     */
+    name?: string;
+    /**
+     * AWS_ACCESS_KEY_ID to use
+     *
+     * Using static key is not recommended
+     */
+    accessKeyId?: string;
+    /**
+     * AWS_SECRET_ACCESS_KEY to use
+     *
+     * Using static key is not recommended
+     */
+    secretAccessKey?: string;
+    /**
+     * AWS_SESSION_TOKEN Token
+     *
+     * Even if it is possible to add it here
+     * It is not sustainable as this token at its best will
+     * have a lifetime of 12 hours
+     */
+    sessionToken?: string;
+    /**
+     * AWS_REGION to use
+     *
+     * @default "us-east-1"
+     */
+    region?: string;
+    /**
+     * AWS Account Id
+     */
+    AWSAccountId?: string;
+    /**
+     * Endpoints to use by differents services
+     * Usefull to test with localstack or other AWS emulations
+     */
+    endpoints?: {
+        [key in AWSDeployerEndpoint]?: string;
+    };
+    /**
+     * Default Tags to use with resources created by deployers
+     */
+    Tags?: TagsDefinition;
+    /**
+     * SSL certificates to create
+     *
+     * Sample
+     * ```
+     * Certificates: {
+     *   "test.webda.io": {
+     *      SubjectAlternativeNames: ["test2.webda.io"]
+     *   }
+     * }
+     * ```
+     */
+    Certificates?: {
+        [key: string]: {
+            /**
+             * Any alternative names to add to the certificate
+             */
+            SubjectAlternativeNames?: string[];
+            Tags?: TagsDefinition;
+            [key: string]: any;
+        };
+    };
+}
+/**
+ * Plain resources of a deployer: its parameters with the deployment variables replaced
+ */
+export type DeployerResources<T> = Omit<T, "load" | "update" | "with" | "watch">;
+/**
+ * Abstract AWS Deployer
+ *
+ * It includes some basic utilities methods to be used by
+ * final deployers. A final deployer declares `implements Deployer` itself.
+ */
+export declare abstract class AWSDeployer<T extends AWSDeployerParameters = AWSDeployerParameters> extends Service<T> {
+    /**
+     * Parameters of the deployer with the deployment variables replaced and the defaults applied
+     *
+     * Computed by {@link AWSDeployer.prepare}
+     */
+    resources: DeployerResources<T> & {
+        [key: string]: any;
+    };
+    /**
+     * Compute the resources from the parameters
+     *
+     * @param extra - additional deployment variables
+     * @returns the resources
+     */
+    prepare(extra?: Record<string, any>): Promise<this["resources"]>;
+    /**
+     * Parameters as a plain object
+     * @returns a copy of the parameters
+     */
+    protected getRawParameters(): any;
+    /**
+     * Apply the default resources
+     */
+    defaultResources(): Promise<void>;
+    /**
+     * Configuration of an AWS client
+     *
+     * @param endpoint - the client, to use its custom endpoint
+     * @param region - force a region
+     * @returns the client configuration
+     */
+    getClientConfig(endpoint?: AWSDeployerEndpoint, region?: string): any;
+    /**
+     * Return AWS region
+     * @returns the region
+     */
+    getRegion(): string;
+    /**
+     * Return the current AWS Identity used
+     * @returns the identity
+     */
+    getAWSIdentity(): Promise<GetCallerIdentityResponse>;
+    /**
+     * Return the default VPC for the current region
+     * @returns the VPC id and its subnets, undefined if there is no default VPC
+     */
+    getDefaultVpc(): Promise<{
+        Id: string;
+        Subnets: any[];
+    } | undefined>;
+    /**
+     * Generate a MD5 in hex
+     * @param str - to hash
+     * @returns the hash
+     */
+    protected md5(str: string): string;
+    /**
+     * Hash the string
+     *
+     * @param str - to hash
+     * @param type - of hash
+     * @param format - hex or b64
+     * @returns the hash
+     */
+    protected hash(str: string | Buffer, type?: string, format?: "hex" | "base64"): string;
+    /**
+     * Replace / by _ as theses ID are not allowed in AWS
+     *
+     * @param id - to replace
+     * @returns the AWS compatible id
+     */
+    _replaceForAWS(id: string): string;
+    /**
+     * Get a certificate or create it
+     *
+     * @param domain - to get certificate for
+     * @param region - of the certificate
+     * @returns the certificate
+     */
+    getCertificate(domain: string, region?: string): Promise<any>;
+    /**
+     * Get the closest zone to the domain
+     *
+     * @param domain - to get zone for
+     * @returns the zone
+     */
+    getZoneForDomainName(domain: string): Promise<HostedZone>;
+    /**
+     * Transform a tag map into a tag array
+     *
+     * @param tags - to transform
+     * @returns the tags array
+     */
+    transformMapTagsToArray(tags: TagsDefinition): {
+        Key: string;
+        Value: string;
+    }[];
+    /**
+     * Transform a tag array into a tag map
+     *
+     * @param tags - to transform
+     * @returns the tags map
+     */
+    transformArrayTagsToMap(tags: TagsDefinition): {
+        [key: string]: string;
+    };
+    /**
+     * Take this.resources[key].Tags and add all remaining Tags from this.resources.Tags
+     *
+     * @param key - of the resources to add, or the tags themselves
+     * @returns the tags array
+     */
+    getDefaultTags(key?: string | TagsDefinition): {
+        Key: string;
+        Value: string;
+    }[];
+    /**
+     * Take this.resources[key].Tags and add all remaining Tags from this.resources.Tags
+     *
+     * @param key - of the resources to add
+     * @returns the tags map
+     */
+    getDefaultTagsAsMap(key?: string | TagsDefinition): {
+        [key: string]: string;
+    };
+    /**
+     * Return the S3 Tagging string
+     * @param key - of the resources to add
+     * @returns the url encoded tags
+     */
+    getDefaultTagsAsS3Tagging(key?: string | TagsDefinition): string;
+    /**
+     * Wait for a condition with a linear delay
+     *
+     * @param callback - resolve when done, return true to stop
+     * @param retries - maximum number of tries
+     * @param title - of the wait
+     * @param delay - between tries in ms
+     * @returns the resolved value
+     */
+    waitFor(callback: (resolve?: (value?: any) => void, reject?: (reason?: any) => void) => Promise<boolean>, retries: number, title: string, delay: number): Promise<any>;
+    /**
+     * Create a certificate for a domain
+     * Will use Route 53 to do the validation
+     *
+     * @param domain - to create the certificate for
+     * @param zone - to create the validation record in
+     * @param region - of the certificate
+     * @returns the certificate
+     */
+    doCreateCertificate(domain: string, zone: HostedZone, region?: string): Promise<CertificateDetail>;
+    /**
+     * Create DNS entry
+     *
+     * @param domain - to create
+     * @param type - of DNS
+     * @param value - the value of the record
+     * @param targetZone - the zone, found from the domain if not provided
+     */
+    createDNSEntry(domain: string, type: RRType, value: string, targetZone?: HostedZone): Promise<void>;
+    /**
+     * Permissions needed by the deployed application itself
+     *
+     * @param accountId - the account
+     * @param region - the region
+     * @returns the policy statements
+     */
+    getARNPolicy(accountId: string, region: string): any[];
+    /**
+     * Generate the `PolicyDocument`
+     *
+     * It will browse all services for a method `getARNPolicy`
+     * Allowing you to write some specific Service or Bean that
+     * requires specific AWS permissions
+     *
+     * @param additionalStatements - statements to add
+     * @returns the optimized policy document
+     */
+    getPolicyDocument(additionalStatements?: any[]): Promise<any>;
+    /**
+     * Services of the application, the deployers excluded
+     *
+     * @returns the services
+     */
+    getApplicationServices(): Service[];
+    /**
+     * Create a bucket if it does not exist
+     *
+     * @param Bucket - to create
+     */
+    createBucket(Bucket: string): Promise<void>;
+    /**
+     * S3 client
+     * @returns the client
+     */
+    protected getS3(): S3;
+    /**
+     * Send a full folder (recursive) on bucket
+     *
+     * @param bucket - to send data to
+     * @param folder - path to local folder to send
+     * @param prefix - prefix on the bucket
+     */
+    putFolderOnBucket(bucket: string, folder: string, prefix?: string): Promise<void>;
+    /**
+     * Find the common prefix between two strings
+     *
+     * Example
+     * ```
+     * commonPrefix("/test/plop1", "/templates/") => "/te"
+     * ```
+     *
+     * @param str1 - to compare
+     * @param str2 - to compare
+     * @returns the common prefix
+     */
+    commonPrefix(str1: string, str2: string): string;
+    /**
+     * Add files to a bucket
+     *
+     * It uses hash and ETag to avoid uploading files already present
+     *
+     * The files src can be either:
+     *  - a string representing the local path
+     *  - a Buffer with the dynamic content
+     *
+     * @param bucket - to send bucket
+     * @param files - to send
+     */
+    putFilesOnBucket(bucket: string, files: {
+        key?: string;
+        src: any;
+        mimetype?: string;
+    }[]): Promise<void>;
+}
+//# sourceMappingURL=awsdeployer.d.ts.map

package/lib/deployers/awsdeployer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"awsdeployer.d.ts","sourceRoot":"","sources":["../../src/deployers/awsdeployer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,iBAAiB,EAA4D,MAAM,qBAAqB,CAAC;AAEvH,OAAO,EAAE,UAAU,EAAE,MAAM,EAAW,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAY,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,yBAAyB,EAAO,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAIL,OAAO,EACP,iBAAiB,EAGlB,MAAM,aAAa,CAAC;AAWrB;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC7B,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,gBAAgB,GAAG,YAAY,GAAG,YAAY,CAAC;AAE5F;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE;SAAG,GAAG,IAAI,mBAAmB,CAAC,CAAC,EAAE,MAAM;KAAE,CAAC;IACtD;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG;YACb;;eAEG;YACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,EAAE,cAAc,CAAC;YACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;SACpB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,8BAAsB,WAAW,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IAC3G;;;;OAIG;IACH,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEzD;;;;;OAKG;IACG,OAAO,CAAC,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAUzE;IAED;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,GAAG,CAIhC;IAED;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAOtC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,GAAG,CAepE;IAED;;;OAGG;IACH,SAAS,IAAI,MAAM,CAElB;IAED;;;OAGG;IAEG,cAAc,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAGzD;IAED;;;OAGG;IAEG,aAAa,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,EAAE,CAAA;KAAE,GAAG,SAAS,CAAC,CA0BzE;IAED;;;;OAIG;IACH,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,GAAE,MAAc,EAAE,MAAM,GAAE,KAAK,GAAG,QAAgB,GAAG,MAAM,CAEnG;IAED;;;;;OAKG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEjC;IAED;;;;;;OAMG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAuB7E;IAED;;;;;OAKG;IAEG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAE9D;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAS9E;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAOvE;IAED;;;;;OAKG;IACH,cAAc,CAAC,GAAG,GAAE,MAAM,GAAG,cAA0B,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAazF;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,GAAG,GAAE,MAAM,GAAG,cAA0B,GAAG;QAC7D,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAEA;IAED;;;;OAIG;IACH,yBAAyB,CAAC,GAAG,GAAE,MAAM,GAAG,cAA0B,GAAG,MAAM,CAI1E;IAED;;;;;;;;OAQG;IACG,OAAO,CACX,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,EAChG,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,GAAG,CAAC,CAEd;IAED;;;;;;;;OAQG;IACG,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA8DvG;IAED;;;;;;;OAOG;IACU,cAAc,CACzB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,GAAE,UAAsB,GACjC,OAAO,CAAC,IAAI,CAAC,CA+Bf;IAED;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE,CASrD;IAED;;;;;;;;;OASG;IAEG,iBAAiB,CAAC,oBAAoB,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAsBtE;IAED;;;;OAIG;IACH,sBAAsB,IAAI,OAAO,EAAE,CAIlC;IAED;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBhD;IAED;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,EAAE,CAKpB;IAED;;;;;;OAMG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAa1F;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ/C;IAED;;;;;;;;;;;OAWG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,GAAG,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAyE5G;CACF"}