@effect-aws/client-sqs 1.7.0 → 1.9.0

package/src/SQSService.ts

@@ -0,0 +1,603 @@
+/**
+ * @since 1.0.0
+ */
+import {
+  AddPermissionCommand,
+  type AddPermissionCommandInput,
+  type AddPermissionCommandOutput,
+  CancelMessageMoveTaskCommand,
+  type CancelMessageMoveTaskCommandInput,
+  type CancelMessageMoveTaskCommandOutput,
+  ChangeMessageVisibilityBatchCommand,
+  type ChangeMessageVisibilityBatchCommandInput,
+  type ChangeMessageVisibilityBatchCommandOutput,
+  ChangeMessageVisibilityCommand,
+  type ChangeMessageVisibilityCommandInput,
+  type ChangeMessageVisibilityCommandOutput,
+  CreateQueueCommand,
+  type CreateQueueCommandInput,
+  type CreateQueueCommandOutput,
+  DeleteMessageBatchCommand,
+  type DeleteMessageBatchCommandInput,
+  type DeleteMessageBatchCommandOutput,
+  DeleteMessageCommand,
+  type DeleteMessageCommandInput,
+  type DeleteMessageCommandOutput,
+  DeleteQueueCommand,
+  type DeleteQueueCommandInput,
+  type DeleteQueueCommandOutput,
+  GetQueueAttributesCommand,
+  type GetQueueAttributesCommandInput,
+  type GetQueueAttributesCommandOutput,
+  GetQueueUrlCommand,
+  type GetQueueUrlCommandInput,
+  type GetQueueUrlCommandOutput,
+  ListDeadLetterSourceQueuesCommand,
+  type ListDeadLetterSourceQueuesCommandInput,
+  type ListDeadLetterSourceQueuesCommandOutput,
+  ListMessageMoveTasksCommand,
+  type ListMessageMoveTasksCommandInput,
+  type ListMessageMoveTasksCommandOutput,
+  ListQueuesCommand,
+  type ListQueuesCommandInput,
+  type ListQueuesCommandOutput,
+  ListQueueTagsCommand,
+  type ListQueueTagsCommandInput,
+  type ListQueueTagsCommandOutput,
+  PurgeQueueCommand,
+  type PurgeQueueCommandInput,
+  type PurgeQueueCommandOutput,
+  ReceiveMessageCommand,
+  type ReceiveMessageCommandInput,
+  type ReceiveMessageCommandOutput,
+  RemovePermissionCommand,
+  type RemovePermissionCommandInput,
+  type RemovePermissionCommandOutput,
+  SendMessageBatchCommand,
+  type SendMessageBatchCommandInput,
+  type SendMessageBatchCommandOutput,
+  SendMessageCommand,
+  type SendMessageCommandInput,
+  type SendMessageCommandOutput,
+  SetQueueAttributesCommand,
+  type SetQueueAttributesCommandInput,
+  type SetQueueAttributesCommandOutput,
+  type SQSClient,
+  type SQSClientConfig,
+  StartMessageMoveTaskCommand,
+  type StartMessageMoveTaskCommandInput,
+  type StartMessageMoveTaskCommandOutput,
+  TagQueueCommand,
+  type TagQueueCommandInput,
+  type TagQueueCommandOutput,
+  UntagQueueCommand,
+  type UntagQueueCommandInput,
+  type UntagQueueCommandOutput,
+} from "@aws-sdk/client-sqs";
+import type { HttpHandlerOptions, SdkError, ServiceLogger } from "@effect-aws/commons";
+import { Service } from "@effect-aws/commons";
+import { Effect, Layer } from "effect";
+import type {
+  BatchEntryIdsNotDistinctError,
+  BatchRequestTooLongError,
+  EmptyBatchRequestError,
+  InvalidAddressError,
+  InvalidAttributeNameError,
+  InvalidAttributeValueError,
+  InvalidBatchEntryIdError,
+  InvalidIdFormatError,
+  InvalidMessageContentsError,
+  InvalidSecurityError,
+  KmsAccessDeniedError,
+  KmsDisabledError,
+  KmsInvalidKeyUsageError,
+  KmsInvalidStateError,
+  KmsNotFoundError,
+  KmsOptInRequiredError,
+  KmsThrottledError,
+  MessageNotInflightError,
+  OverLimitError,
+  PurgeQueueInProgressError,
+  QueueDeletedRecentlyError,
+  QueueDoesNotExistError,
+  QueueNameExistsError,
+  ReceiptHandleIsInvalidError,
+  RequestThrottledError,
+  ResourceNotFoundError,
+  TooManyEntriesInBatchRequestError,
+  UnsupportedOperationError,
+} from "./Errors.js";
+import { AllServiceErrors } from "./Errors.js";
+import * as Instance from "./SQSClientInstance.js";
+import * as SQSServiceConfig from "./SQSServiceConfig.js";
+
+const commands = {
+  AddPermissionCommand,
+  CancelMessageMoveTaskCommand,
+  ChangeMessageVisibilityCommand,
+  ChangeMessageVisibilityBatchCommand,
+  CreateQueueCommand,
+  DeleteMessageCommand,
+  DeleteMessageBatchCommand,
+  DeleteQueueCommand,
+  GetQueueAttributesCommand,
+  GetQueueUrlCommand,
+  ListDeadLetterSourceQueuesCommand,
+  ListMessageMoveTasksCommand,
+  ListQueueTagsCommand,
+  ListQueuesCommand,
+  PurgeQueueCommand,
+  ReceiveMessageCommand,
+  RemovePermissionCommand,
+  SendMessageCommand,
+  SendMessageBatchCommand,
+  SetQueueAttributesCommand,
+  StartMessageMoveTaskCommand,
+  TagQueueCommand,
+  UntagQueueCommand,
+};
+
+interface SQSService$ {
+  readonly _: unique symbol;
+
+  /**
+   * @see {@link AddPermissionCommand}
+   */
+  addPermission(
+    args: AddPermissionCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    AddPermissionCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | OverLimitError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link CancelMessageMoveTaskCommand}
+   */
+  cancelMessageMoveTask(
+    args: CancelMessageMoveTaskCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    CancelMessageMoveTaskCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | RequestThrottledError
+    | ResourceNotFoundError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ChangeMessageVisibilityCommand}
+   */
+  changeMessageVisibility(
+    args: ChangeMessageVisibilityCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ChangeMessageVisibilityCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | MessageNotInflightError
+    | QueueDoesNotExistError
+    | ReceiptHandleIsInvalidError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ChangeMessageVisibilityBatchCommand}
+   */
+  changeMessageVisibilityBatch(
+    args: ChangeMessageVisibilityBatchCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ChangeMessageVisibilityBatchCommandOutput,
+    | SdkError
+    | BatchEntryIdsNotDistinctError
+    | EmptyBatchRequestError
+    | InvalidAddressError
+    | InvalidBatchEntryIdError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | TooManyEntriesInBatchRequestError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link CreateQueueCommand}
+   */
+  createQueue(
+    args: CreateQueueCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    CreateQueueCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidAttributeNameError
+    | InvalidAttributeValueError
+    | InvalidSecurityError
+    | QueueDeletedRecentlyError
+    | QueueNameExistsError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link DeleteMessageCommand}
+   */
+  deleteMessage(
+    args: DeleteMessageCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    DeleteMessageCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidIdFormatError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | ReceiptHandleIsInvalidError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link DeleteMessageBatchCommand}
+   */
+  deleteMessageBatch(
+    args: DeleteMessageBatchCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    DeleteMessageBatchCommandOutput,
+    | SdkError
+    | BatchEntryIdsNotDistinctError
+    | EmptyBatchRequestError
+    | InvalidAddressError
+    | InvalidBatchEntryIdError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | TooManyEntriesInBatchRequestError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link DeleteQueueCommand}
+   */
+  deleteQueue(
+    args: DeleteQueueCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    DeleteQueueCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link GetQueueAttributesCommand}
+   */
+  getQueueAttributes(
+    args: GetQueueAttributesCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    GetQueueAttributesCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidAttributeNameError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link GetQueueUrlCommand}
+   */
+  getQueueUrl(
+    args: GetQueueUrlCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    GetQueueUrlCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ListDeadLetterSourceQueuesCommand}
+   */
+  listDeadLetterSourceQueues(
+    args: ListDeadLetterSourceQueuesCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ListDeadLetterSourceQueuesCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ListMessageMoveTasksCommand}
+   */
+  listMessageMoveTasks(
+    args: ListMessageMoveTasksCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ListMessageMoveTasksCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | RequestThrottledError
+    | ResourceNotFoundError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ListQueueTagsCommand}
+   */
+  listQueueTags(
+    args: ListQueueTagsCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ListQueueTagsCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ListQueuesCommand}
+   */
+  listQueues(
+    args: ListQueuesCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ListQueuesCommandOutput,
+    SdkError | InvalidAddressError | InvalidSecurityError | RequestThrottledError | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link PurgeQueueCommand}
+   */
+  purgeQueue(
+    args: PurgeQueueCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    PurgeQueueCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | PurgeQueueInProgressError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link ReceiveMessageCommand}
+   */
+  receiveMessage(
+    args: ReceiveMessageCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    ReceiveMessageCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | KmsAccessDeniedError
+    | KmsDisabledError
+    | KmsInvalidKeyUsageError
+    | KmsInvalidStateError
+    | KmsNotFoundError
+    | KmsOptInRequiredError
+    | KmsThrottledError
+    | OverLimitError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link RemovePermissionCommand}
+   */
+  removePermission(
+    args: RemovePermissionCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    RemovePermissionCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link SendMessageCommand}
+   */
+  sendMessage(
+    args: SendMessageCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    SendMessageCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidMessageContentsError
+    | InvalidSecurityError
+    | KmsAccessDeniedError
+    | KmsDisabledError
+    | KmsInvalidKeyUsageError
+    | KmsInvalidStateError
+    | KmsNotFoundError
+    | KmsOptInRequiredError
+    | KmsThrottledError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link SendMessageBatchCommand}
+   */
+  sendMessageBatch(
+    args: SendMessageBatchCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    SendMessageBatchCommandOutput,
+    | SdkError
+    | BatchEntryIdsNotDistinctError
+    | BatchRequestTooLongError
+    | EmptyBatchRequestError
+    | InvalidAddressError
+    | InvalidBatchEntryIdError
+    | InvalidSecurityError
+    | KmsAccessDeniedError
+    | KmsDisabledError
+    | KmsInvalidKeyUsageError
+    | KmsInvalidStateError
+    | KmsNotFoundError
+    | KmsOptInRequiredError
+    | KmsThrottledError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | TooManyEntriesInBatchRequestError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link SetQueueAttributesCommand}
+   */
+  setQueueAttributes(
+    args: SetQueueAttributesCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    SetQueueAttributesCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidAttributeNameError
+    | InvalidAttributeValueError
+    | InvalidSecurityError
+    | OverLimitError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link StartMessageMoveTaskCommand}
+   */
+  startMessageMoveTask(
+    args: StartMessageMoveTaskCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    StartMessageMoveTaskCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | RequestThrottledError
+    | ResourceNotFoundError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link TagQueueCommand}
+   */
+  tagQueue(
+    args: TagQueueCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    TagQueueCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+
+  /**
+   * @see {@link UntagQueueCommand}
+   */
+  untagQueue(
+    args: UntagQueueCommandInput,
+    options?: HttpHandlerOptions,
+  ): Effect.Effect<
+    UntagQueueCommandOutput,
+    | SdkError
+    | InvalidAddressError
+    | InvalidSecurityError
+    | QueueDoesNotExistError
+    | RequestThrottledError
+    | UnsupportedOperationError
+  >;
+}
+
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const makeSQSService = Effect.gen(function*() {
+  const client = yield* Instance.SQSClientInstance;
+
+  return Service.fromClientAndCommands<SQSService$>(client, commands, AllServiceErrors);
+});
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export class SQSService extends Effect.Tag("@effect-aws/client-sqs/SQSService")<
+  SQSService,
+  SQSService$
+>() {
+  static readonly defaultLayer = Layer.effect(this, makeSQSService).pipe(Layer.provide(Instance.layer));
+  static readonly layer = (config: SQSService.Config) =>
+    Layer.effect(this, makeSQSService).pipe(
+      Layer.provide(Instance.layer),
+      Layer.provide(SQSServiceConfig.setSQSServiceConfig(config)),
+    );
+  static readonly baseLayer = (
+    evaluate: (defaultConfig: SQSClientConfig) => SQSClient,
+  ) =>
+    Layer.effect(this, makeSQSService).pipe(
+      Layer.provide(
+        Layer.effect(
+          Instance.SQSClientInstance,
+          Effect.map(SQSServiceConfig.toSQSClientConfig, evaluate),
+        ),
+      ),
+    );
+}
+
+/**
+ * @since 1.0.0
+ */
+export declare namespace SQSService {
+  /**
+   * @since 1.0.0
+   */
+  export interface Config extends Omit<SQSClientConfig, "logger"> {
+    readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true;
+  }
+}

package/src/SQSServiceConfig.ts

@@ -0,0 +1,51 @@
+/**
+ * @since 1.0.0
+ */
+import type { SQSClientConfig } from "@aws-sdk/client-sqs";
+import { ServiceLogger } from "@effect-aws/commons";
+import { Effect, FiberRef, Layer } from "effect";
+import { dual } from "effect/Function";
+import { globalValue } from "effect/GlobalValue";
+import type { SQSService } from "./SQSService.js";
+
+/**
+ * @since 1.0.0
+ * @category sqs service config
+ */
+const currentSQSServiceConfig = globalValue(
+  "@effect-aws/client-sqs/currentSQSServiceConfig",
+  () => FiberRef.unsafeMake<SQSService.Config>({}),
+);
+
+/**
+ * @since 1.0.0
+ * @category sqs service config
+ */
+export const withSQSServiceConfig: {
+  (config: SQSService.Config): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>;
+  <A, E, R>(effect: Effect.Effect<A, E, R>, config: SQSService.Config): Effect.Effect<A, E, R>;
+} = dual(
+  2,
+  <A, E, R>(effect: Effect.Effect<A, E, R>, config: SQSService.Config): Effect.Effect<A, E, R> =>
+    Effect.locally(effect, currentSQSServiceConfig, config),
+);
+
+/**
+ * @since 1.0.0
+ * @category sqs service config
+ */
+export const setSQSServiceConfig = (config: SQSService.Config) => Layer.locallyScoped(currentSQSServiceConfig, config);
+
+/**
+ * @since 1.0.0
+ * @category adapters
+ */
+export const toSQSClientConfig: Effect.Effect<SQSClientConfig> = Effect.gen(function*() {
+  const { logger: serviceLogger, ...config } = yield* FiberRef.get(currentSQSServiceConfig);
+
+  const logger = serviceLogger === true
+    ? yield* ServiceLogger.toClientLogger(ServiceLogger.defaultServiceLogger)
+    : (serviceLogger ? yield* ServiceLogger.toClientLogger(ServiceLogger.make(serviceLogger)) : undefined);
+
+  return { logger, ...config };
+});

package/src/index.ts

@@ -0,0 +1,44 @@
+/**
+ * @since 1.0.0
+ */
+import { SQSService } from "./SQSService.js";
+
+/**
+ * @since 1.0.0
+ */
+export * from "./Errors.js";
+
+/**
+ * @since 1.0.0
+ */
+export * as SQSClientInstance from "./SQSClientInstance.js";
+
+/**
+ * @since 1.0.0
+ */
+export * as SQSServiceConfig from "./SQSServiceConfig.js";
+
+/**
+ * @since 1.0.0
+ */
+export * from "./SQSService.js";
+
+/**
+ * @since 1.0.0
+ * @category exports
+ * @alias SQSService
+ */
+export declare namespace SQS {
+  /**
+   * @since 1.0.0
+   * @alias SQSService.Config
+   */
+  export type Config = SQSService.Config;
+}
+
+/**
+ * @since 1.0.0
+ * @category exports
+ * @alias SQSService
+ */
+export const SQS = SQSService;