@aws-sdk/client-signer 3.1008.0 → 3.1010.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +34 -34
package/README.md CHANGED
@@ -26,8 +26,9 @@ integrity.</p>
26
26
  Guide</a>.</p>
27
27
 
28
28
  ## Installing
29
- To install this package, simply type add or install @aws-sdk/client-signer
30
- using your favorite package manager:
29
+
30
+ To install this package, use the CLI of your favorite package manager:
31
+
31
32
  - `npm install @aws-sdk/client-signer`
32
33
  - `yarn add @aws-sdk/client-signer`
33
34
  - `pnpm add @aws-sdk/client-signer`
@@ -52,15 +53,15 @@ import { SignerClient, ListSigningJobsCommand } from "@aws-sdk/client-signer";
52
53
 
53
54
  ### Usage
54
55
 
55
- To send a request, you:
56
+ To send a request:
56
57
 
57
- - Initiate client with configuration (e.g. credentials, region).
58
- - Initiate command with input parameters.
59
- - Call `send` operation on client with command object as input.
60
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
58
+ - Instantiate a client with configuration (e.g. credentials, region).
59
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
60
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
61
+ - Instantiate a command with input parameters.
62
+ - Call the `send` operation on the client, providing the command object as input.
61
63
 
62
64
  ```js
63
- // a client can be shared by different commands.
64
65
  const client = new SignerClient({ region: "REGION" });
65
66
 
66
67
  const params = { /** input parameters */ };
@@ -69,7 +70,7 @@ const command = new ListSigningJobsCommand(params);
69
70
 
70
71
  #### Async/await
71
72
 
72
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
73
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
73
74
  operator to wait for the promise returned by send operation as follows:
74
75
 
75
76
  ```js
@@ -84,26 +85,9 @@ try {
84
85
  }
85
86
  ```
86
87
 
87
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
88
- as compared to using Promise chains or callbacks.
89
-
90
88
  #### Promises
91
89
 
92
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
93
- to execute send operation.
94
-
95
- ```js
96
- client.send(command).then(
97
- (data) => {
98
- // process data.
99
- },
100
- (error) => {
101
- // error handling.
102
- }
103
- );
104
- ```
105
-
106
- Promises can also be called using `.catch()` and `.finally()` as follows:
90
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
107
91
 
108
92
  ```js
109
93
  client
@@ -119,27 +103,21 @@ client
119
103
  });
120
104
  ```
121
105
 
122
- #### Callbacks
123
-
124
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
125
- but they are supported by the send operation.
106
+ #### Aggregated client
126
107
 
127
- ```js
128
- // callbacks.
129
- client.send(command, (err, data) => {
130
- // process err and data.
131
- });
132
- ```
108
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
133
109
 
134
- #### v2 compatible style
110
+ `Signer` extends `SignerClient` and additionally supports all operations, waiters, and paginators as methods.
111
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
135
112
 
136
- The client can also send requests using v2 compatible style.
137
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
138
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
113
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SignerClient`).
114
+ More details are in the blog post on
115
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
139
116
 
140
117
  ```ts
141
- import * as AWS from "@aws-sdk/client-signer";
142
- const client = new AWS.Signer({ region: "REGION" });
118
+ import { Signer } from "@aws-sdk/client-signer";
119
+
120
+ const client = new Signer({ region: "REGION" });
143
121
 
144
122
  // async/await.
145
123
  try {
@@ -159,7 +137,7 @@ client
159
137
  // error handling.
160
138
  });
161
139
 
162
- // callbacks.
140
+ // callbacks (not recommended).
163
141
  client.listSigningJobs(params, (err, data) => {
164
142
  // process err and data.
165
143
  });
@@ -187,12 +165,14 @@ try {
187
165
  }
188
166
  ```
189
167
 
168
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
169
+
190
170
  ## Getting Help
191
171
 
192
172
  Please use these community resources for getting help.
193
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
173
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
194
174
 
195
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
175
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
196
176
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
197
177
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
198
178
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-signer",
3
3
  "description": "AWS SDK for JavaScript Signer Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1010.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-signer",
@@ -21,43 +21,43 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.20",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.6",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
- "@smithy/util-waiter": "^4.2.12",
60
+ "@smithy/util-waiter": "^4.2.13",
61
61
  "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {