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

package/lib/services/secretsmanager.service.d.ts

@@ -0,0 +1,102 @@
+import { SecretsManager } from "@aws-sdk/client-secrets-manager";
+import { ConfigurationProvider, Service, ServiceParameters } from "@webda/core";
+import { AWSServiceParameters } from "./aws-parameters.js";
+/**
+ * AWS SecretsManager parameters
+ */
+export declare class AWSSecretsManagerParameters extends ServiceParameters implements AWSServiceParameters {
+    /**
+     * Custom endpoint (localstack, minio, ...)
+     */
+    endpoint?: string;
+    /**
+     * Static credentials, default to the AWS environment variables
+     */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        sessionToken?: string;
+    };
+    /**
+     * AWS region
+     * @default "us-east-1"
+     */
+    region?: string;
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params?: any): this;
+}
+/**
+ * Use AWS SecretsManager as a configuration provider and secret storage
+ *
+ * @WebdaModda
+ */
+export default class AWSSecretsManager<T extends AWSSecretsManagerParameters = AWSSecretsManagerParameters> extends Service<T> implements ConfigurationProvider {
+    _client: SecretsManager;
+    /**
+     * Create the AWS client
+     * @override
+     */
+    computeParameters(): void;
+    /**
+     * SecretsManager cannot notify changes
+     * @param _id - configuration id
+     * @param _callback - change callback
+     * @returns false
+     */
+    canTriggerConfiguration(_id: string, _callback: () => void): boolean;
+    /**
+     * Retrieve the configuration stored in a secret
+     * @param id - secret id
+     * @returns the secret content
+     */
+    getConfiguration(id: string): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Create a new secret on AWS SecretsManager
+     *
+     * @param id - secret name
+     * @param values - secret content
+     * @param params - additional createSecret parameters
+     */
+    create(id: string, values?: any, params?: any): Promise<void>;
+    /**
+     * Delete a secret
+     *
+     * @param SecretId to delete
+     * @param RecoveryWindowInDays - days before the secret is deleted
+     * @param ForceDeleteWithoutRecovery - delete immediately
+     */
+    delete(SecretId: string, RecoveryWindowInDays?: number, ForceDeleteWithoutRecovery?: boolean): Promise<void>;
+    /**
+     * Store data in a AWS secret
+     *
+     * @param SecretId - secret id
+     * @param value - secret content
+     */
+    put(SecretId: string, value: any): Promise<void>;
+    /**
+     * Return SecretValue
+     *
+     * @param SecretId - secret id
+     * @returns JSON.parse of SecretString
+     */
+    get(SecretId: string): Promise<any>;
+    /**
+     * IAM policy required by the service
+     * @param accountId - AWS account id
+     * @returns the policy statement
+     */
+    getARNPolicy(accountId: string): {
+        Sid: string;
+        Effect: string;
+        Action: string[];
+        Resource: string[];
+    };
+}
+export { AWSSecretsManager };
+//# sourceMappingURL=secretsmanager.service.d.ts.map

package/lib/services/secretsmanager.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secretsmanager.service.d.ts","sourceRoot":"","sources":["../../src/services/secretsmanager.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAqB,MAAM,qBAAqB,CAAC;AAE9E;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,iBAAkB,YAAW,oBAAoB;IAChG;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAI3B;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB,CAAC,CAAC,SAAS,2BAA2B,GAAG,2BAA2B,CACxG,SAAQ,OAAO,CAAC,CAAC,CACjB,YAAW,qBAAqB;IAEhC,OAAO,EAAE,cAAc,CAAC;IAExB;;;OAGG;IACH,iBAAiB,SAGhB;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI,WAEzD;IAED;;;;OAIG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAElE;IAED;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,GAAQ,EAAE,MAAM,GAAE,GAAQ,iBAI1D;IAED;;;;;;OAMG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,oBAAoB,GAAE,MAAU,EAAE,0BAA0B,GAAE,OAAe,iBAY3G;IAED;;;;;OAKG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,iBAKrC;IAED;;;;;OAKG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,gBAKzB;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM;QAG1B,GAAG;QACH,MAAM;QACN,MAAM;QACN,QAAQ;MAEX;CACF;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/lib/services/{secretsmanager.js → secretsmanager.service.js}

@@ -1,32 +1,48 @@
 import { SecretsManager } from "@aws-sdk/client-secrets-manager";
 import { Service, ServiceParameters } from "@webda/core";
-import { AWSServiceParameters } from "./aws-mixin.js";
-export class AWSSecretsManagerParameters extends AWSServiceParameters(ServiceParameters) {
-}
+import { loadAWSParameters } from "./aws-parameters.js";
 /**
- * @WebdaModda
+ * AWS SecretsManager parameters
  */
-export default class AWSSecretsManager extends Service {
+export class AWSSecretsManagerParameters extends ServiceParameters {
     /**
-     * @inheritdoc
+     * @override
+     * @param params - raw parameters
+     * @returns this
      */
-    loadParameters(params) {
-        return new AWSSecretsManagerParameters(params);
+    load(params = {}) {
+        super.load(params);
+        loadAWSParameters(this);
+        return this;
     }
+}
+/**
+ * Use AWS SecretsManager as a configuration provider and secret storage
+ *
+ * @WebdaModda
+ */
+export default class AWSSecretsManager extends Service {
     /**
-     * @inheritdoc
+     * Create the AWS client
+     * @override
      */
     computeParameters() {
+        super.computeParameters();
         this._client = new SecretsManager(this.parameters);
     }
     /**
-     * @inheritdoc
+     * SecretsManager cannot notify changes
+     * @param _id - configuration id
+     * @param _callback - change callback
+     * @returns false
      */
     canTriggerConfiguration(_id, _callback) {
         return false;
     }
     /**
-     * @inheritdoc
+     * Retrieve the configuration stored in a secret
+     * @param id - secret id
+     * @returns the secret content
      */
     async getConfiguration(id) {
         return this.get(id);
@@ -34,9 +50,9 @@ export default class AWSSecretsManager extends Service {
     /**
      * Create a new secret on AWS SecretsManager
      *
-     * @param id
-     * @param values
-     * @param params
+     * @param id - secret name
+     * @param values - secret content
+     * @param params - additional createSecret parameters
      */
     async create(id, values = {}, params = {}) {
         params.Name = id;
@@ -47,8 +63,8 @@ export default class AWSSecretsManager extends Service {
      * Delete a secret
      *
      * @param SecretId to delete
-     * @param RecoveryWindowInDays
-     * @param ForceDeleteWithoutRecovery
+     * @param RecoveryWindowInDays - days before the secret is deleted
+     * @param ForceDeleteWithoutRecovery - delete immediately
      */
     async delete(SecretId, RecoveryWindowInDays = 7, ForceDeleteWithoutRecovery = false) {
         let params = {
@@ -66,8 +82,8 @@ export default class AWSSecretsManager extends Service {
     /**
      * Store data in a AWS secret
      *
-     * @param SecretId
-     * @param value
+     * @param SecretId - secret id
+     * @param value - secret content
      */
     async put(SecretId, value) {
         await this._client.putSecretValue({
@@ -78,22 +94,24 @@ export default class AWSSecretsManager extends Service {
     /**
      * Return SecretValue
      *
-     * @param SecretId
+     * @param SecretId - secret id
      * @returns JSON.parse of SecretString
      */
     async get(SecretId) {
-        let res = await this._client.getSecretValue({
+        const res = await this._client.getSecretValue({
             SecretId
         });
         return JSON.parse(res.SecretString);
     }
     /**
-     * @inheritdoc
+     * IAM policy required by the service
+     * @param accountId - AWS account id
+     * @returns the policy statement
      */
     getARNPolicy(accountId) {
-        let region = this.parameters.region || "us-east-1";
+        const region = this.parameters.region || "us-east-1";
         return {
-            Sid: this.constructor.name + this._name,
+            Sid: this.constructor.name + this.getName(),
             Effect: "Allow",
             Action: ["secretsmanager:*"],
             Resource: ["arn:aws:secretsmanager:" + region + ":" + accountId + ":secret:*"]
@@ -101,4 +119,4 @@ export default class AWSSecretsManager extends Service {
     }
 }
 export { AWSSecretsManager };
-//# sourceMappingURL=secretsmanager.js.map
+//# sourceMappingURL=secretsmanager.service.js.map

package/lib/services/secretsmanager.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secretsmanager.service.js","sourceRoot":"","sources":["../../src/services/secretsmanager.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtF,OAAO,EAAyB,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAwB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE9E;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,iBAAiB;IAehE;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,iBACnB,SAAQ,OAAU;IAKlB;;;OAGG;IACH,iBAAiB;QACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,GAAW,EAAE,SAAqB;QACxD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,MAAM,GAAQ,EAAE,EAAE,MAAM,GAAQ,EAAE;QACzD,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;QACjB,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,oBAAoB,GAAW,CAAC,EAAE,0BAA0B,GAAY,KAAK;QAC1G,IAAI,MAAM,GAAwB;YAChC,oBAAoB;YACpB,QAAQ;SACT,CAAC;QACF,IAAI,0BAA0B,EAAE,CAAC;YAC/B,MAAM,GAAG;gBACP,QAAQ;gBACR,0BAA0B;aAC3B,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,QAAgB,EAAE,KAAU;QACpC,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;YAChC,QAAQ;YACR,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SACpC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,QAAgB;QACxB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;YAC5C,QAAQ;SACT,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,WAAW,CAAC;QACrD,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;YAC3C,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,CAAC,kBAAkB,CAAC;YAC5B,QAAQ,EAAE,CAAC,yBAAyB,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,GAAG,WAAW,CAAC;SAC/E,CAAC;IACJ,CAAC;CACF;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/lib/services/{sqsqueue.d.ts → sqsqueue.service.d.ts}

@@ -1,32 +1,33 @@
 import { SQS } from "@aws-sdk/client-sqs";
 import { MessageReceipt, Queue, QueueParameters } from "@webda/core";
-import CloudFormationDeployer from "../deployers/cloudformation.js";
-import { CloudFormationContributor } from "./index.js";
-declare const SQSQueueParameters_base: {
-    new (...args: any[]): {
-        endpoint?: string;
-        credentials?: {
-            accessKeyId: string;
-            secretAccessKey: string;
-            sessionToken?: string;
-        };
-        region?: string;
-        type: string;
-        url?: string;
-        openapi?: import("@webda/core/lib/router").OpenAPIWebdaDefinition;
+import { AWSServiceParameters } from "./aws-parameters.js";
+import type { CloudFormationContributor, CloudFormationDeployerInfo } from "./contributors.js";
+/**
+ * SQS Queue parameters
+ */
+export declare class SQSQueueParameters extends QueueParameters implements AWSServiceParameters {
+    /**
+     * Custom endpoint (localstack, minio, ...)
+     */
+    endpoint?: string;
+    /**
+     * Static credentials, default to the AWS environment variables
+     */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        sessionToken?: string;
     };
-} & typeof QueueParameters;
-export declare class SQSQueueParameters extends SQSQueueParameters_base {
+    /**
+     * AWS region
+     * @default "us-east-1"
+     */
+    region?: string;
     /**
      * Time to wait pending for an item
      * @default 20
      */
     WaitTimeSeconds?: number;
-    /**
-     * Endpoint to pass to the AWS client
-     * Useful for localstack
-     */
-    endpoint?: string;
     /**
      * Queue URL
      * @default ""
@@ -45,7 +46,12 @@ export declare class SQSQueueParameters extends SQSQueueParameters_base {
      * Any additional CloudFormation parameters
      */
     CloudFormation?: any;
-    constructor(params: any);
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params?: any): this;
 }
 /**
  * Implement SQS as queue for Webda
@@ -58,23 +64,24 @@ export default class SQSQueue<T = any, K extends SQSQueueParameters = SQSQueuePa
      */
     sqs: SQS;
     /**
-     * @inheritdoc
-     */
-    loadParameters(params: any): SQSQueueParameters;
-    /**
-     * @inheritdoc
+     * Create the SQS client
+     * @returns this
      */
     init(): Promise<this>;
     /**
-     * @inheritdoc
+     * @override
+     * @returns approximate number of messages in the queue
      */
     size(): Promise<number>;
     /**
-     * @inheritdoc
+     * @override
+     * @param params - the message to send
      */
     sendMessage(params: T): Promise<void>;
     /**
-     * @inheritdoc
+     * @override
+     * @param proto - optional prototype to rehydrate the payload into
+     * @returns the received messages
      */
     receiveMessage<L>(proto?: {
         new (): L;
@@ -84,29 +91,48 @@ export default class SQSQueue<T = any, K extends SQSQueueParameters = SQSQueuePa
      * therefore we need to divide by 10 (the max number of group messaged) to get the number
      * of consumers
      *
-     * @returns
+     * @returns the number of consumers
      */
     getMaxConsumers(): number;
     /**
-     * @inheritdoc
+     * @override
+     * @param receipt - the message receipt handle
      */
     deleteMessage(receipt: string): Promise<void>;
     /**
-     * @inheritdoc
+     * Purge the queue (used in tests)
      */
     __clean(): Promise<void>;
+    /**
+     * Purge the queue, retrying once if a purge is already in progress
+     * @param fail - throw on any error
+     */
     private __cleanWithRetry;
+    /**
+     * Parse the queue url
+     * @returns the account id, region and queue name
+     */
     _getQueueInfosFromUrl(): {
         accountId: string;
         region: string;
         name: string;
     };
+    /**
+     * IAM policy required by the service
+     * @returns the policy statement
+     */
     getARNPolicy(): {
         Sid: string;
         Effect: string;
         Action: string[];
         Resource: string[];
     };
-    getCloudFormation(deployer: CloudFormationDeployer): {};
+    /**
+     * CloudFormation resources for the queue
+     * @param deployer - the deployer requesting the resources
+     * @returns the resources
+     */
+    getCloudFormation(deployer: CloudFormationDeployerInfo): {};
 }
 export { SQSQueue };
+//# sourceMappingURL=sqsqueue.service.d.ts.map

package/lib/services/sqsqueue.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqsqueue.service.d.ts","sourceRoot":"","sources":["../../src/services/sqsqueue.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAc,MAAM,aAAa,CAAC;AAEjF,OAAO,EAAE,oBAAoB,EAAqB,MAAM,qBAAqB,CAAC;AAC9E,OAAO,KAAK,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE/F;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,eAAgB,YAAW,oBAAoB;IACrF;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAM3B;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,CACtF,SAAQ,KAAK,CAAC,CAAC,EAAE,CAAC,CAClB,YAAW,yBAAyB;IAEpC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAI1B;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAS5B;IAED;;;OAGG;IACG,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAa1C;IAED;;;;OAIG;IACG,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAY3E;IAED;;;;;;OAMG;IACH,eAAe,IAAI,MAAM,CAExB;IAED;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlD;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAE7B;IAED;;;OAGG;YACW,gBAAgB;IAgB9B;;;OAGG;IACH,qBAAqB;QAWjB,SAAS;QACT,MAAM;QACN,IAAI;MAEP;IAED;;;OAGG;IACH,YAAY;QAIR,GAAG;QACH,MAAM;QACN,MAAM;QAON,QAAQ;MAEX;IAED;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,0BAA0B,MAkBrD;CACF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/lib/services/{sqsqueue.js → sqsqueue.service.js}

@@ -1,12 +1,22 @@
 import { SQS } from "@aws-sdk/client-sqs";
 import { Queue, QueueParameters, WebdaError } from "@webda/core";
 import { createHash } from "crypto";
-import { AWSServiceParameters } from "./index.js";
-export class SQSQueueParameters extends AWSServiceParameters(QueueParameters) {
-    constructor(params) {
-        super(params);
-        this.WaitTimeSeconds = this.WaitTimeSeconds ?? 20;
-        this.queue = this.queue ?? "";
+import { loadAWSParameters } from "./aws-parameters.js";
+/**
+ * SQS Queue parameters
+ */
+export class SQSQueueParameters extends QueueParameters {
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params = {}) {
+        super.load(params);
+        loadAWSParameters(this);
+        this.WaitTimeSeconds ?? (this.WaitTimeSeconds = 20);
+        this.queue ?? (this.queue = "");
+        return this;
     }
 }
 /**
@@ -16,13 +26,8 @@ export class SQSQueueParameters extends AWSServiceParameters(QueueParameters) {
  */
 export default class SQSQueue extends Queue {
     /**
-     * @inheritdoc
-     */
-    loadParameters(params) {
-        return new SQSQueueParameters(params);
-    }
-    /**
-     * @inheritdoc
+     * Create the SQS client
+     * @returns this
      */
     async init() {
         await super.init();
@@ -30,10 +35,11 @@ export default class SQSQueue extends Queue {
         return this;
     }
     /**
-     * @inheritdoc
+     * @override
+     * @returns approximate number of messages in the queue
      */
     async size() {
-        let res = await this.sqs.getQueueAttributes({
+        const res = await this.sqs.getQueueAttributes({
             AttributeNames: ["ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible"],
             QueueUrl: this.parameters.queue
         });
@@ -41,9 +47,11 @@ export default class SQSQueue extends Queue {
             parseInt(res["Attributes"]["ApproximateNumberOfMessagesNotVisible"]));
     }
     /**
-     * @inheritdoc
+     * @override
+     * @param params - the message to send
      */
     async sendMessage(params) {
+        this.metrics.messages_sent.inc();
         const sqsParams = {
             QueueUrl: this.parameters.queue,
             MessageBody: JSON.stringify(params)
@@ -57,15 +65,17 @@ export default class SQSQueue extends Queue {
         await this.sqs.sendMessage(sqsParams);
     }
     /**
-     * @inheritdoc
+     * @override
+     * @param proto - optional prototype to rehydrate the payload into
+     * @returns the received messages
      */
     async receiveMessage(proto) {
-        let queueArg = {
+        const queueArg = {
             QueueUrl: this.parameters.queue,
             WaitTimeSeconds: this.parameters.WaitTimeSeconds,
             MaxNumberOfMessages: this.parameters.maxConsumers > 10 ? 10 : this.parameters.maxConsumers
         };
-        let data = await this.sqs.receiveMessage(queueArg);
+        const data = await this.sqs.receiveMessage(queueArg);
         data.Messages ?? (data.Messages = []);
         return data.Messages.map(m => ({
             ReceiptHandle: m.ReceiptHandle,
@@ -77,13 +87,14 @@ export default class SQSQueue extends Queue {
      * therefore we need to divide by 10 (the max number of group messaged) to get the number
      * of consumers
      *
-     * @returns
+     * @returns the number of consumers
      */
     getMaxConsumers() {
         return Math.ceil(this.parameters.maxConsumers / 10);
     }
     /**
-     * @inheritdoc
+     * @override
+     * @param receipt - the message receipt handle
      */
     async deleteMessage(receipt) {
         await this.sqs.deleteMessage({
@@ -92,11 +103,15 @@ export default class SQSQueue extends Queue {
         });
     }
     /**
-     * @inheritdoc
+     * Purge the queue (used in tests)
      */
     async __clean() {
-        return this.__cleanWithRetry(false);
+        await this.__cleanWithRetry(false);
     }
+    /**
+     * Purge the queue, retrying once if a purge is already in progress
+     * @param fail - throw on any error
+     */
     async __cleanWithRetry(fail) {
         try {
             await this.sqs.purgeQueue({
@@ -107,15 +122,16 @@ export default class SQSQueue extends Queue {
             if (fail || err.name !== "AWS.SimpleQueueService.PurgeQueueInProgress") {
                 throw err;
             }
-            let delay = Math.floor(err.retryDelay * 1100);
+            const delay = Math.floor(err.retryDelay * 1100);
             // 10% of margin
-            return new Promise(resolve => {
-                setTimeout(() => {
-                    resolve(this.__cleanWithRetry(true));
-                }, delay);
-            });
+            await new Promise(resolve => setTimeout(resolve, delay));
+            await this.__cleanWithRetry(true);
         }
     }
+    /**
+     * Parse the queue url
+     * @returns the account id, region and queue name
+     */
     _getQueueInfosFromUrl() {
         let found = this.parameters.queue.match(/.*sqs\.(.*)\.amazonaws.com\/(\d+)\/(.*)/i);
         if (!found) {
@@ -132,11 +148,15 @@ export default class SQSQueue extends Queue {
             name: found[3]
         };
     }
+    /**
+     * IAM policy required by the service
+     * @returns the policy statement
+     */
     getARNPolicy() {
         // Parse this._params.queue;
-        let queue = this._getQueueInfosFromUrl();
+        const queue = this._getQueueInfosFromUrl();
         return {
-            Sid: this.constructor.name + this._name,
+            Sid: this.constructor.name + this.getName(),
             Effect: "Allow",
             Action: [
                 "sqs:DeleteMessage",
@@ -148,15 +168,20 @@ export default class SQSQueue extends Queue {
             Resource: ["arn:aws:sqs:" + queue.region + ":" + queue.accountId + ":" + queue.name]
         };
     }
+    /**
+     * CloudFormation resources for the queue
+     * @param deployer - the deployer requesting the resources
+     * @returns the resources
+     */
     getCloudFormation(deployer) {
         if (this.parameters.CloudFormationSkip) {
             return {};
         }
-        let { name: QueueName } = this._getQueueInfosFromUrl();
-        let resources = {};
+        const { name: QueueName } = this._getQueueInfosFromUrl();
+        const resources = {};
         this.parameters.CloudFormation = this.parameters.CloudFormation || {};
         this.parameters.CloudFormation.Queue = this.parameters.CloudFormation.Queue || {};
-        resources[this._name + "Queue"] = {
+        resources[this.getName() + "Queue"] = {
             Type: "AWS::SQS::Queue",
             Properties: {
                 ...this.parameters.CloudFormation.Queue,
@@ -169,4 +194,4 @@ export default class SQSQueue extends Queue {
     }
 }
 export { SQSQueue };
-//# sourceMappingURL=sqsqueue.js.map
+//# sourceMappingURL=sqsqueue.service.js.map

package/lib/services/sqsqueue.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqsqueue.service.js","sourceRoot":"","sources":["../../src/services/sqsqueue.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAkB,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAwB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG9E;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IAuCrD;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,EAAE,EAAC;QAC5B,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,EAAE,EAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QACnB,SAAQ,KAAW;IAQnB;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC;YAC5C,cAAc,EAAE,CAAC,6BAA6B,EAAE,uCAAuC,CAAC;YACxF,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;SAChC,CAAC,CAAC;QACH,OAAO,CACL,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,6BAA6B,CAAC,CAAC;YAC1D,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,uCAAuC,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,MAAS;QACzB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QACjC,MAAM,SAAS,GAA4B;YACzC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;YAC/B,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SACpC,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;YACnC,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QAC5D,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,SAAS,CAAC,sBAAsB,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtG,CAAC;QACD,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAI,KAAqB;QAC3C,MAAM,QAAQ,GAA0B;YACtC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;YAC/B,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe;YAChD,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY;SAC3F,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,EAAE,EAAC;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC7B,aAAa,EAAE,CAAC,CAAC,aAAa;YAC9B,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC;SACzC,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,OAAe;QACjC,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;YAC3B,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;YAC/B,aAAa,EAAE,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,gBAAgB,CAAC,IAAa;QAC1C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;gBACxB,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;aAChC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,IAAI,IAAI,GAAG,CAAC,IAAI,KAAK,6CAA6C,EAAE,CAAC;gBACvE,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;YAChD,gBAAgB;YAChB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YACzD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,IAAI,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,uBAAuB;YACvB,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC7E,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC;YACvF,CAAC;YACD,KAAK,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;QACzB,CAAC;QACD,OAAO;YACL,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;YACnB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;SACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,4BAA4B;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3C,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;YAC3C,MAAM,EAAE,OAAO;YACf,MAAM,EAAE;gBACN,mBAAmB;gBACnB,wBAAwB;gBACxB,oBAAoB;gBACpB,iBAAiB;gBACjB,sBAAsB;aACvB;YACD,QAAQ,EAAE,CAAC,cAAc,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;SACrF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,QAAoC;QACpD,IAAI,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACvC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,IAAI,EAAE,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;QAClF,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG;YACpC,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE;gBACV,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK;gBACvC,SAAS;gBACT,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC;aACzE;SACF,CAAC;QACF,qDAAqD;QACrD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}