@comicrelief/lambda-wrapper 1.10.2 → 2.0.0-beta.10

package/dist/services/RequestService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestService.js","sourceRoot":"","sources":["../../src/services/RequestService.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAsC;AAGtC,0DAAkC;AAClC,oEAA4C;AAC5C,oDAA4B;AAE5B,wFAAgE;AAChE,4EAAoD;AACpD,oEAA4C;AAE/B,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;CACX,CAAC;AAEW,QAAA,6BAA6B,GAAG;IAC3C,qBAAa,CAAC,MAAM;IACpB,qBAAa,CAAC,GAAG;IACjB,qBAAa,CAAC,IAAI;IAClB,qBAAa,CAAC,OAAO;CACtB,CAAC;AAEW,QAAA,0BAA0B,GAAG;IACxC,qBAAa,CAAC,KAAK;IACnB,qBAAa,CAAC,IAAI;IAClB,qBAAa,CAAC,GAAG;CAClB,CAAC;AAEF,qCAAqC;AACxB,QAAA,WAAW,GAAG;IACzB,gBAAgB,EAAE,IAAI,uBAAa,CAAC,EAAE,EAAE,GAAG,EAAE,6BAA6B,CAAC;CAC5E,CAAC;AASF;;GAEG;AACH,MAAqB,cAAe,SAAQ,8BAAoB;IAC9D;;;;;;OAMG;IACH,GAAG,CAAC,SAAiB,EAAE,MAAsB,EAAE,WAAoB;QACjE,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,eAAe,KAAK,IAAI,EAAE;YAC5B,OAAO,MAAM,IAAI,IAAI,CAAC;SACvB;QAED,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAA0B,CAAC;QACrE,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,WAAW,CAAC;SACpB;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,CAAC;QAC5E,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,WAAW,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,IAAI,CAAC;SACb;QAED,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAEjC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,IAAI,UAAU,CAAC,EAAE;YAC7D,OAAO,IAAI,CAAC;SACb;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,SAAkB,EAAE,MAAM,GAAG,EAAE;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAA0B,CAAC;QAErE,iEAAiE;QACjE,IAAI,CAAC,SAAS,IAAI,OAAO,KAAK,CAAC,cAAc,KAAK,QAAQ,EAAE;YAC1D,OAAO,KAAK,CAAC,cAAc,CAAC;SAC7B;QAED,+EAA+E;QAC/E,IACE,SAAS;eACN,OAAO,KAAK,CAAC,cAAc,KAAK,QAAQ;eACxC,KAAK,CAAC,cAAc,KAAK,IAAI;eAC7B,OAAO,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,WAAW,EACzD;YACA,OAAO,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;SACxC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAoB;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAA0B,CAAC;QAErE,IACE,qCAA6B,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;eACrD,qCAA6B,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,EAC5D;YACA,wBAAwB;YACxB,MAAM,MAAM,GAAkD;gBAC5D,GAAG,KAAK,CAAC,qBAAqB;aAC/B,CAAC;YACF,iCAAiC;YACjC,IAAI,KAAK,CAAC,+BAA+B,KAAK,IAAI,EAAE;gBAClD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;qBAChB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;qBACnC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBACf,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,+BAA+B,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC7D,CAAC,CAAC,CAAC;aACN;YACD,OAAO,MAAM,CAAC;SACf;QAED,IACE,kCAA0B,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;eAClD,kCAA0B,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,EACzD;YACA,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YACnD,IAAI,eAAe,GAAG,EAAE,CAAC;YAEzB,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EAAE;gBAC7D,eAAe,GAAG,qBAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC;aAC3D;YAED,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE;gBAC5C,IAAI;oBACF,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC;iBACpD;gBAAC,MAAM;oBACN,eAAe,GAAG,EAAE,CAAC;iBACtB;aACF;YAED,IAAI,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;gBACpC,gBAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;oBACzD,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;gBACxC,CAAC,CAAC,CAAC;aACJ;YAED,IAAI,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE;gBAC/C,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxC;YAED,OAAO,OAAO,eAAe,KAAK,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;SACtE;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE7C,IACE,OAAO,KAAK,CAAC,cAAc,KAAK,WAAW;eACxC,OAAO,KAAK,CAAC,cAAc,CAAC,QAAQ,KAAK,WAAW;eACpD,OAAO,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,EAChE;YACA,OAAO,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC;SAC/C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,uBAAuB;QACrB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,IAAI,CAAC;SACb;QAED,IAAI;YACF,MAAM,KAAK,GAAG,mBAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;YAE7B,OAAO;gBACL,cAAc,EAAE,KAAK,CAAC,MAAM;gBAC5B,iBAAiB,EAAE,KAAK,CAAC,SAAS,EAAE;gBACpC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;gBAClC,kBAAkB,EAAE,EAAE,CAAC,MAAM;gBAC7B,0BAA0B,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE;aACjD,CAAC;SACH;QAAC,MAAM;YACN,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,uBAAa,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED;;;;;;OAMG;IACH,0BAA0B,CAAC,WAAmB;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,uBAAa,CAAC,CAAC;QAE1C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,UAAU,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;YAExD,IAAI,OAAO,UAAU,KAAK,WAAW,EAAE;gBACrC,OAAO,EAAE,CAAC;aACX;iBAAM;gBACL,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBAC1C,MAAM,uBAAuB,GAAG,mBAAW,CAAC,gBAAgB,CAAC;gBAC7D,uBAAuB,CAAC,eAAe,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;gBACzE,MAAM,CAAC,uBAAuB,CAAC,CAAC;aACjC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,SAAkB;QAC1B,uEAAuE;QACvE,6DAA6D;QAE7D,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAA0B,CAAC;QACrE,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC,KAAK,CAAW,CAAC;QAE7D,MAAM,IAAI,GAAG,KAAK,CAAC,eAAe;YAChC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAc,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE;YACvE,CAAC,CAAC,KAAK,CAAC,IAAc,CAAC;QAEzB,MAAM,MAAM,GAAyC,EAAE,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACpC,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACxD,MAAM,CAAC,IAAI,CAAC,GAAG;oBACb,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;oBACxD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3D,OAAO,EAAE,SAAS;wBAChB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;wBAC5H,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;iBACxG,CAAC;aACH;iBAAM,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aACzI;QACH,CAAC,CAAC,CAAC;QAEH,4DAA4D;QAE5D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,aAAa;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEtD,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,WAAW,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,WAAW,IAAI,OAAO,WAAW,CAAC,WAAW,KAAK,WAAW,EAAE;YACrI,OAAO,WAAW,CAAC;SACpB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,MAA0C,EAAE,GAAW;QACpF,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aACjC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9E,OAAO,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,KAA2B;QAC5C,OAAO,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtF,CAAC;CACF;AAtSD,iCAsSC"}

package/dist/services/SQSService.d.ts

@@ -0,0 +1,263 @@
+import AWS from 'aws-sdk';
+import DependencyAwareClass from '../core/DependencyAwareClass';
+import DependencyInjection from '../core/DependencyInjection';
+import { LambdaWrapperConfig } from '../core/config';
+import SQSMessageModel from '../models/SQSMessageModel';
+import { ServiceStatus } from '../types/Status';
+export interface SQSServiceConfig {
+    /**
+     * Maps short friendly queue names to the full SQS queue name.
+     *
+     * Usually we define queue names in our `serverless.yml` and provide them to
+     * the application via environment variables. If you haven't defined types
+     * for your env vars, you'll need to coerce them to `string`.
+     *
+     * Example:
+     *
+     * ```ts
+     * {
+     *   queues: {
+     *     submissions: process.env.SQS_QUEUE_SUBMISSIONS as string,
+     *   }
+     * }
+     * ```
+     */
+    queues?: object;
+    /**
+     * Maps short friendly queue names to the queue consumer function name, for
+     * use with offline SQS emulation. Example:
+     *
+     * ```ts
+     * {
+     *   queueConsumers: {
+     *     submissions: 'SubmissionConsumer',
+     *   }
+     * }
+     * ```
+     *
+     * See the [SQSService docs](../../docs/services/SQSService.md) for details
+     * about how this works.
+     */
+    queueConsumers?: Record<string, string>;
+}
+export interface WithSQSServiceConfig {
+    sqs?: SQSServiceConfig;
+}
+/**
+ * Type of a queue name taken from the Lambda Wrapper config type.
+ *
+ * If the `sqs` config key is absent, the resulting type is `never` (since no
+ * queues are defined).
+ */
+export declare type QueueName<TConfig extends WithSQSServiceConfig> = TConfig extends {
+    sqs: {
+        queues: Record<infer Key, string>;
+    };
+} ? string & Key : never;
+/**
+ * Allowed values for `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`.
+ */
+export declare const SQS_OFFLINE_MODES: {
+    /**
+     * When running offline, messages will trigger the consumer function directly
+     * via a Lambda endpoint, set using `process.env.SERVICE_LAMBDA_URL`. This is
+     * the default.
+     */
+    DIRECT: string;
+    /**
+     * When running offline, send messages to an offline SQS service defined by
+     * `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_HOST`.
+     */
+    LOCAL: string;
+    /**
+     * When running offline, send messages to AWS as normal.
+     */
+    AWS: string;
+};
+/**
+ * Defines the preferred behaviour for `SQSService.prototype.send` in case the
+ * AWS SQS call fails.
+ */
+export declare const SQS_PUBLISH_FAILURE_MODES: {
+    /**
+     * Catch the exception and logs it.
+     *
+     * This is the default behaviour for Lambda Wrapper v1.8.0 and below and for
+     * Lambda Wrapper v1.8.2 and above.
+     */
+    readonly CATCH: "catch";
+    /**
+     * Throw the exception so that the caller can handle it directly.
+     */
+    readonly THROW: "throw";
+};
+/**
+ * Helper service for working with SQS.
+ *
+ * Config for this service goes in the `sqs` key of your Lambda Wrapper config.
+ * The `queues` key maps short friendly names to the full SQS queue name.
+ * Usually we define queue names in our `serverless.yml` and provide them to
+ * the application via environment variables.
+ *
+ * ```ts
+ * const lambdaWrapper = lw.configure({
+ *   sqs: {
+ *     queues: {
+ *       // add an entry for each queue mapping to its AWS name
+ *       submissions: process.env.SQS_QUEUE_SUBMISSIONS as string,
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * You can then send messages to a queue within your Lambda handler using the
+ * `publish` method.
+ *
+ * ```ts
+ * export default lambdaWrapper.wrap(async (di) => {
+ *   const sqs = di.get(SQSService);
+ *   const message = { data: 'Hello SQS!' };
+ *   await sqs.publish('submissions', message);
+ * });
+ * ```
+ *
+ * When using TypeScript, queue names are inferred from your Lambda Wrapper
+ * config so that IntelliSense can provide hints and TypeScript will tell you
+ * at compile-time if you try to publish to an undefined queue.
+ *
+ * ```ts
+ * // ok
+ * await sqs.publish('submissions', message);
+ *
+ * // error: Argument of type '"submission"' is not assignable to parameter of
+ * // type '"submissions"'.
+ * await sqs.publish('submission', message);
+ * ```
+ *
+ * Note that if you're passing the queue name in as a variable, you'll need to
+ * ensure the variable type is specific enough and not simply `string`. If you
+ * have a list of queue names you will need to declare it `as const`. Otherwise,
+ * use string literal types, or the `QueueName` generic type which extracts the
+ * type of all queue names from your Lambda Wrapper config.
+ *
+ * ```ts
+ * const myQueues = ['queue1', 'queue2'];
+ * for (const queue of myQueues) {
+ *   // won't compile because `queue` is of type `string`
+ *   await sqs.publish(queue, message);
+ * }
+ *
+ * const myQueues = ['queue1', 'queue2'] as const;
+ * for (const queue of myQueues) {
+ *   // ok now because `queue` is of type `"queue1" | "queue2"`
+ *   await sqs.publish(queue, message);
+ * }
+ *
+ * // you can also simply use string literal types
+ * let queue: "queue1" | "queue2";
+ *
+ * // or accept any queue defined in the config using `QueueName`
+ * let queue: QueueName<typeof lambdaWrapper.config>;
+ * ```
+ *
+ * This is all pretty cool, but the current implementation has a caveat: the
+ * `WithSQSServiceConfig` type has to be a little vague about `sqs.queues` in
+ * order to get TypeScript to infer its keys. The following config will not
+ * raise any errors itself, but is invalid and will make the `QueueName` type
+ * `never`.
+ *
+ * ```ts
+ * lambdaWrapper.configure<WithSQSServiceConfig>({
+ *   sqs: {
+ *     queues: {
+ *       good: 'good-queue',
+ *       bad: 0, // oops, not a string, but no errors here!
+ *     },
+ *   },
+ * });
+ *
+ * // even though this is queue has valid config, the invalid one breaks it:
+ * // Argument of type 'string' is not assignable to parameter of type 'never'.
+ * await sqs.publish('good', message);
+ * ```
+ *
+ * If you start getting _not assignable to parameter of type 'never'_ errors on
+ * all your `SQSService` method calls, double-check that your config is correct.
+ * Be particularly careful with environment variables – by default they have
+ * type `string | undefined`. In the first example at the top of this page, a
+ * type assertion was used to coerce this to `string`.
+ */
+export default class SQSService<TConfig extends LambdaWrapperConfig & WithSQSServiceConfig = any> extends DependencyAwareClass {
+    readonly queues: Record<QueueName<TConfig>, string>;
+    readonly queueConsumers: Record<QueueName<TConfig>, string>;
+    readonly queueUrls: Record<QueueName<TConfig>, string>;
+    private $sqs?;
+    private $lambda?;
+    constructor(di: DependencyInjection<TConfig>);
+    /**
+     * Returns an SQS client instance
+     */
+    get sqs(): AWS.SQS;
+    /**
+     * Returns a Lambda client instance
+     */
+    get lambda(): AWS.Lambda;
+    /**
+     * Returns the mode to use for offline SQS.
+     *
+     * This is configured by `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`. The
+     * default is `SQS_OFFLINE_MODES.LAMBDA`.
+     */
+    static get offlineMode(): string;
+    /**
+     * Batch delete messages.
+     *
+     * @param queue
+     * @param messageModels
+     */
+    batchDelete(queue: QueueName<TConfig>, messageModels: SQSMessageModel[]): Promise<void>;
+    /**
+     * Check SQS status.
+     */
+    checkStatus(): Promise<ServiceStatus>;
+    /**
+     * Get the approximate number of messages in a queue.
+     *
+     * @param queue
+     */
+    getMessageCount(queue: QueueName<TConfig>): Promise<number>;
+    /**
+     * Publish to message queue.
+     *
+     * When running within serverless-offline, messages can be published to a
+     * local Lambda or SQS service instead of to AWS, depending on the offline
+     * mode specified by `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`.
+     *
+     * @param queue          string
+     * @param messageObject  object
+     * @param messageGroupId string
+     * @param failureMode Choose how failures are handled:
+     *   - `catch`: errors will be caught and logged. This is the default.
+     *   - `throw`: errors will be thrown, causing promise to reject.
+     */
+    publish(queue: QueueName<TConfig>, messageObject: object, messageGroupId?: null, failureMode?: 'catch' | 'throw'): Promise<QueueName<TConfig> | null>;
+    /**
+     * Sends a message to a queue consumer running in serverless-offline.
+     *
+     * This method invokes the consumer function directly instead of sending the
+     * message to SQS, which requires a real or emulated SQS service not provided
+     * by serverless-offline. This works very well for local testing.
+     *
+     * @param queue
+     * @param messageParameters
+     */
+    publishOffline(queue: QueueName<TConfig>, messageParameters: AWS.SQS.SendMessageRequest): Promise<void>;
+    /**
+     * Receive from message queue
+     *
+     * @param queue string
+     * @param timeout number
+     */
+    receive(queue: QueueName<TConfig>, timeout?: number): Promise<SQSMessageModel[]>;
+}
+//# sourceMappingURL=SQSService.d.ts.map

package/dist/services/SQSService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SQSService.d.ts","sourceRoot":"","sources":["../../src/services/SQSService.ts"],"names":[],"mappings":"AAEA,OAAO,GAAG,MAAM,SAAS,CAAC;AAG1B,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,eAAe,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAU,MAAM,iBAAiB,CAAC;AAIxD,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,CAAC,EAAE,gBAAgB,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,SAAS,CAAC,OAAO,SAAS,oBAAoB,IACxD,OAAO,SAAS;IAAE,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC1D,MAAM,GAAG,GAAG,GACZ,KAAK,CAAC;AAEZ;;GAEG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;;;OAIG;;IAGH;;;OAGG;;IAGH;;OAEG;;CAEJ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB;IACpC;;;;;OAKG;;IAGH;;OAEG;;CAEK,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+FG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU,CAC7B,OAAO,SAAS,mBAAmB,GAAG,oBAAoB,GAAG,GAAG,CAChE,SAAQ,oBAAoB;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IAEpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IAE5D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IAEvD,OAAO,CAAC,IAAI,CAAC,CAAU;IAEvB,OAAO,CAAC,OAAO,CAAC,CAAa;gBAEjB,EAAE,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAiC5C;;OAEG;IACH,IAAI,GAAG,YAcN;IAED;;OAEG;IACH,IAAI,MAAM,eAgBT;IAED;;;;;OAKG;IACH,MAAM,KAAK,WAAW,WAErB;IAED;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDvF;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC;IA8BrC;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA6B3D;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,OAAO,EAAE,WAAW,GAAE,OAAO,GAAG,OAAyC;IAsCvJ;;;;;;;;;OASG;IACG,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,iBAAiB,EAAE,GAAG,CAAC,GAAG,CAAC,kBAAkB;IA6B7F;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAgC7E"}