feat: simplify layers (#80)

* feat: prepare new layers * feat: simplify s3 service layers * feat: update codegen * chore: update codegen and generate all clients * fix: bug in iam service
floydspace · Nov 10, 2024 · 4b16fbe · 4b16fbe
1 parent d7976b1
commit 4b16fbe
Show file tree

Hide file tree

Showing 99 changed files with 5,777 additions and 4,921 deletions.
diff --git a/.changeset/polite-avocados-move.md b/.changeset/polite-avocados-move.md
@@ -0,0 +1,35 @@
+---
+"@effect-aws/client-api-gateway-management-api": minor
+"@effect-aws/client-cognito-identity-provider": minor
+"@effect-aws/client-opensearch-serverless": minor
+"@effect-aws/client-cloudwatch-events": minor
+"@effect-aws/client-cloudwatch-logs": minor
+"@effect-aws/client-secrets-manager": minor
+"@effect-aws/client-cloudsearch": minor
+"@effect-aws/client-elasticache": minor
+"@effect-aws/client-eventbridge": minor
+"@effect-aws/client-cloudtrail": minor
+"@effect-aws/client-cloudwatch": minor
+"@effect-aws/client-codedeploy": minor
+"@effect-aws/client-opensearch": minor
+"@effect-aws/client-scheduler": minor
+"@effect-aws/client-dynamodb": minor
+"@effect-aws/client-textract": minor
+"@effect-aws/client-account": minor
+"@effect-aws/client-bedrock": minor
+"@effect-aws/client-kinesis": minor
+"@effect-aws/client-lambda": minor
+"@effect-aws/client-ec2": minor
+"@effect-aws/client-iam": minor
+"@effect-aws/client-kms": minor
+"@effect-aws/client-rds": minor
+"@effect-aws/client-sfn": minor
+"@effect-aws/client-sns": minor
+"@effect-aws/client-sqs": minor
+"@effect-aws/client-ssm": minor
+"@effect-aws/client-sts": minor
+"@effect-aws/client-mq": minor
+"@effect-aws/client-s3": minor
+---
+
+simplify layers configuration (closes #78)
diff --git a/packages/client-account/README.md b/packages/client-account/README.md
@@ -14,72 +14,45 @@ npm install --save @effect-aws/client-account
 With default AccountClient instance:
 
 ```typescript
-import { AccountService, DefaultAccountServiceLayer } from "@effect-aws/client-account";
+import { Account } from "@effect-aws/client-account";
 
-const program = AccountService.listRegions(args);
+const program = Account.listRegions(args);
 
 const result = pipe(
   program,
-  Effect.provide(DefaultAccountServiceLayer),
+  Effect.provide(Account.defaultLayer),
   Effect.runPromise,
 );
 ```
 
 With custom AccountClient instance:
 
 ```typescript
-import {
-  AccountService,
-  BaseAccountServiceLayer,
-  AccountClientInstance,
-} from "@effect-aws/client-account";
+import { Account } from "@effect-aws/client-account";
 
-const program = AccountService.listRegions(args);
-
-const AccountClientInstanceLayer = Layer.succeed(
-  AccountClientInstance,
-  new AccountClient({ region: "eu-central-1" }),
-);
+const program = Account.listRegions(args);
 
 const result = await pipe(
   program,
-  Effect.provide(BaseAccountServiceLayer),
-  Effect.provide(AccountClientInstanceLayer),
+  Effect.provide(
+    Account.baseLayer(() => new AccountClient({ region: "eu-central-1" })),
+  ),
   Effect.runPromise,
 );
 ```
 
 With custom AccountClient configuration:
 
 ```typescript
-import {
-  AccountService,
-  BaseAccountServiceLayer,
-  DefaultAccountClientConfigLayer,
-  AccountClientInstance,
-  AccountClientInstanceConfig,
-} from "@effect-aws/client-account";
-
-const program = AccountService.listRegions(args);
-
-const AccountClientInstanceLayer = Layer.provide(
-  Layer.effect(
-    AccountClientInstance,
-    AccountClientInstanceConfig.pipe(
-      Effect.map(
-        (config) => new AccountClient({ ...config, region: "eu-central-1" }),
-      ),
-    ),
-  ),
-  DefaultAccountClientConfigLayer,
-);
+import { Account } from "@effect-aws/client-account";
+
+const program = Account.listRegions(args);
 
 const result = await pipe(
   program,
-  Effect.provide(BaseAccountServiceLayer),
-  Effect.provide(AccountClientInstanceLayer),
+  Effect.provide(Account.layer({ region: "eu-central-1" })),
   Effect.runPromiseExit,
 );
 ```
 
-or map over `DefaultAccountClientConfigLayer` layer context and update the configuration...
+or use `Account.baseLayer((default) => new AccountClient({ ...default, region: "eu-central-1" }))`
diff --git a/packages/client-account/src/AccountService.ts b/packages/client-account/src/AccountService.ts
@@ -3,6 +3,8 @@
  */
 import {
   AccountServiceException,
+  type AccountClient,
+  type AccountClientConfig,
   AcceptPrimaryEmailUpdateCommand,
   type AcceptPrimaryEmailUpdateCommandInput,
   type AcceptPrimaryEmailUpdateCommandOutput,
@@ -45,7 +47,11 @@ import {
   AccountClientInstance,
   AccountClientInstanceLayer,
 } from "./AccountClientInstance";
-import { DefaultAccountClientConfigLayer } from "./AccountClientInstanceConfig";
+import {
+  DefaultAccountClientConfigLayer,
+  makeDefaultAccountClientInstanceConfig,
+  AccountClientInstanceConfig,
+} from "./AccountClientInstanceConfig";
 import {
   AllServiceErrors,
   AccessDeniedError,
@@ -59,7 +65,7 @@ import {
 } from "./Errors";
 
 /**
- * @since 1.0.1
+ * @since 1.0.0
  */
 export interface HttpHandlerOptions {
   /**
@@ -278,14 +284,6 @@ interface AccountService$ {
   >;
 }
 
-/**
- * @since 1.0.0
- * @category models
- */
-export class AccountService extends Effect.Tag(
-  "@effect-aws/client-account/AccountService",
-)<AccountService, AccountService$>() {}
-
 /**
  * @since 1.0.0
  * @category constructors
@@ -336,9 +334,53 @@ export const makeAccountService = Effect.gen(function* (_) {
   }, {}) as AccountService$;
 });
 
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export class AccountService extends Effect.Tag(
+  "@effect-aws/client-account/AccountService",
+)<AccountService, AccountService$>() {
+  static readonly defaultLayer = Layer.effect(this, makeAccountService).pipe(
+    Layer.provide(AccountClientInstanceLayer),
+    Layer.provide(DefaultAccountClientConfigLayer),
+  );
+  static readonly layer = (config: AccountClientConfig) =>
+    Layer.effect(this, makeAccountService).pipe(
+      Layer.provide(AccountClientInstanceLayer),
+      Layer.provide(
+        Layer.effect(
+          AccountClientInstanceConfig,
+          makeDefaultAccountClientInstanceConfig.pipe(
+            Effect.map((defaultConfig) => ({ ...defaultConfig, ...config })),
+          ),
+        ),
+      ),
+    );
+  static readonly baseLayer = (
+    evaluate: (defaultConfig: AccountClientConfig) => AccountClient,
+  ) =>
+    Layer.effect(this, makeAccountService).pipe(
+      Layer.provide(
+        Layer.effect(
+          AccountClientInstance,
+          Effect.map(makeDefaultAccountClientInstanceConfig, evaluate),
+        ),
+      ),
+    );
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ * @alias AccountService
+ */
+export const Account = AccountService;
+
 /**
  * @since 1.0.0
  * @category layers
+ * @deprecated use Account.baseLayer instead
  */
 export const BaseAccountServiceLayer = Layer.effect(
   AccountService,
@@ -348,6 +390,7 @@ export const BaseAccountServiceLayer = Layer.effect(
 /**
  * @since 1.0.0
  * @category layers
+ * @deprecated use Account.layer instead
  */
 export const AccountServiceLayer = BaseAccountServiceLayer.pipe(
   Layer.provide(AccountClientInstanceLayer),
@@ -356,7 +399,6 @@ export const AccountServiceLayer = BaseAccountServiceLayer.pipe(
 /**
  * @since 1.0.0
  * @category layers
+ * @deprecated use Account.defaultLayer instead
  */
-export const DefaultAccountServiceLayer = AccountServiceLayer.pipe(
-  Layer.provide(DefaultAccountClientConfigLayer),
-);
+export const DefaultAccountServiceLayer = AccountService.defaultLayer;