diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentBareBonesClientGenerator.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentBareBonesClientGenerator.java index 7894de31522e..84884ee3e222 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentBareBonesClientGenerator.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentBareBonesClientGenerator.java @@ -71,6 +71,8 @@ public void run() { writer.addImport(serviceName, serviceName, "@aws-sdk/client-dynamodb"); writer.addImport(configType, configType, "@aws-sdk/client-dynamodb"); writer.addImport("Client", "__Client", "@aws-sdk/smithy-client"); + writer.writeDocs("@public"); + writer.write("export { __Client };"); generateInputOutputImports(serviceInputTypes, serviceOutputTypes); generateInputOutputTypeUnion(serviceInputTypes, @@ -80,7 +82,7 @@ public void run() { writer.write(""); generateConfiguration(); - writer.writeDocs(DocumentClientUtils.getClientDocs()); + writer.writeDocs(DocumentClientUtils.getClientDocs() + "\n\n@public"); writer.openBlock("export class $L extends __Client<$T, $L, $L, $L> {", "}", DocumentClientUtils.CLIENT_NAME, ApplicationProtocol.createDefaultHttpApplicationProtocol().getOptionsType(), @@ -124,6 +126,7 @@ private void generateInputOutputImports(String serviceInputTypes, String service } private void generateInputOutputTypeUnion(String typeName, Function mapper) { + writer.writeDocs("@public"); Set containedOperations = new TreeSet<>(TopDownIndex.of(model).getContainedOperations(service)); @@ -179,11 +182,13 @@ private void generateClientConstructor() { private void generateConfiguration() { writer.pushState(CLIENT_CONFIG_SECTION); String translateConfigType = DocumentClientUtils.CLIENT_TRANSLATE_CONFIG_TYPE; + writer.writeDocs("@public"); writer.openBlock("export type $L = {", "}", translateConfigType, () -> { generateTranslateConfigOption(DocumentClientUtils.CLIENT_MARSHALL_OPTIONS); generateTranslateConfigOption(DocumentClientUtils.CLIENT_UNMARSHALL_OPTIONS); }); writer.write(""); + writer.writeDocs("@public"); writer.openBlock("export type $L = $L & {", "};", DocumentClientUtils.CLIENT_CONFIG_NAME, configType, () -> { writer.write("$L?: $L;", DocumentClientUtils.CLIENT_TRANSLATE_CONFIG_KEY, translateConfigType); diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientCommandGenerator.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientCommandGenerator.java index 6a27705172f7..d1b848ce30d4 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientCommandGenerator.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientCommandGenerator.java @@ -99,6 +99,7 @@ public void run() { String servicePath = Paths.get(".", DocumentClientUtils.CLIENT_NAME).toString(); String configType = DocumentClientUtils.CLIENT_CONFIG_NAME; + // Add required imports. writer.addImport(configType, configType, servicePath); writer.addImport( @@ -106,6 +107,10 @@ public void run() { "DynamoDBDocumentClientCommand", "./baseCommand/DynamoDBDocumentClientCommand" ); + writer.addImport("Command", "$Command", "@aws-sdk/smithy-client"); + + writer.writeDocs("@public"); + writer.write("export { DynamoDBDocumentClientCommand, $$Command };"); generateInputAndOutputTypes(); @@ -117,7 +122,9 @@ public void run() { }); String name = DocumentClientUtils.getModifiedName(symbol.getName()); - writer.writeDocs(DocumentClientUtils.getCommandDocs(symbol.getName())); + writer.writeDocs(DocumentClientUtils.getCommandDocs(symbol.getName()) + + "\n\n@public" + ); writer.openBlock( "export class $L extends DynamoDBDocumentClientCommand<" + ioTypes + ", $L> {", "}", @@ -289,6 +296,7 @@ private void writeType( Optional optionalShape, List membersWithAttr ) { + writer.writeDocs("@public"); if (optionalShape.isPresent()) { writer.addImport(originalTypeName, "__" + originalTypeName, "@aws-sdk/client-dynamodb"); if (membersWithAttr.isEmpty()) { diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientPaginationGenerator.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientPaginationGenerator.java index 5714d6c54658..ce5141e69190 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientPaginationGenerator.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientPaginationGenerator.java @@ -95,6 +95,9 @@ public void run() { writer.addImport(paginationType, paginationType, Paths.get(".", getInterfaceFilelocation().replace(".ts", "")).toString()); + writer.writeDocs("@public"); + writer.write("export { Paginator }"); + writeCommandRequest(); writeMethodRequest(); writePager(); @@ -123,6 +126,11 @@ static void generateServicePaginationInterfaces(TypeScriptWriter writer) { DocumentClientUtils.CLIENT_FULL_NAME, Paths.get(".", DocumentClientUtils.CLIENT_FULL_NAME).toString()); + writer.writeDocs("@public"); + writer.write("export { PaginationConfiguration };"); + writer.write(""); + + writer.writeDocs("@public"); writer.openBlock("export interface $LPaginationConfiguration extends PaginationConfiguration {", "}", DocumentClientUtils.CLIENT_FULL_NAME, () -> { writer.write("client: $L | $L;", DocumentClientUtils.CLIENT_FULL_NAME, DocumentClientUtils.CLIENT_NAME); @@ -137,6 +145,10 @@ private void writePager() { String inputTokenName = paginatedInfo.getPaginatedTrait().getInputToken().get(); String outputTokenName = paginatedInfo.getPaginatedTrait().getOutputToken().get(); + writer.writeDocs("@public\n\n" + + String.format("@param %s - {@link %s}%n", inputTypeName, inputTypeName) + + String.format("@returns {@link %s}%n", outputTypeName) + ); writer.openBlock( "export async function* paginate$L(config: $L, input: $L, ...additionalArguments: any): Paginator<$L>{", "}", operationName, paginationType, inputTypeName, outputTypeName, () -> { @@ -188,7 +200,7 @@ private void writePager() { * exposes the entire service. */ private void writeMethodRequest() { - writer.writeDocs("@private"); + writer.writeDocs("@internal"); writer.openBlock( "const makePagedRequest = async (client: $L, input: $L, ...args: any): Promise<$L> => {", "}", DocumentClientUtils.CLIENT_FULL_NAME, inputTypeName, @@ -203,7 +215,7 @@ private void writeMethodRequest() { * environments and does not generally expose the entire service. */ private void writeCommandRequest() { - writer.writeDocs("@private"); + writer.writeDocs("@internal"); writer.openBlock( "const makePagedClientRequest = async (client: $L, input: $L, ...args: any): Promise<$L> => {", "}", DocumentClientUtils.CLIENT_NAME, inputTypeName, diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientUtils.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientUtils.java index e38b4891d7ee..dc882252fe64 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientUtils.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/DocumentClientUtils.java @@ -133,7 +133,9 @@ && containsAttributeValue(model, symbolProvider, unionMember, parents)) { static String getCommandDocs(String operationName) { return "Accepts native JavaScript types instead of `AttributeValue`s, and calls\n" + operationName + " operation from " - + "{@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}.\n\n" + + "{@link @aws-sdk/client-dynamodb#" + + operationName + + "}.\n\n" + "JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes \n" + "required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects."; } @@ -173,6 +175,6 @@ static String getClientDocs() { + "```json\n" + "[null, false, 1, \"two\"]\n" + "```\n\n" - + "@see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}"; + + "@see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb | @aws-sdk/client-dynamodb}"; } } diff --git a/lib/lib-dynamodb/src/DynamoDBDocument.ts b/lib/lib-dynamodb/src/DynamoDBDocument.ts index 5e3d91817d20..758e68ad63a9 100644 --- a/lib/lib-dynamodb/src/DynamoDBDocument.ts +++ b/lib/lib-dynamodb/src/DynamoDBDocument.ts @@ -77,7 +77,7 @@ import { DynamoDBDocumentClient, TranslateConfig } from "./DynamoDBDocumentClien * [null, false, 1, "two"] * ``` * - * @see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb} + * @see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb | @aws-sdk/client-dynamodb} */ export class DynamoDBDocument extends DynamoDBDocumentClient { static from(client: DynamoDBClient, translateConfig?: TranslateConfig) { @@ -86,7 +86,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchExecuteStatementCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchExecuteStatementCommand operation from {@link @aws-sdk/client-dynamodb#BatchExecuteStatementCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -122,7 +122,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchGetItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchGetItemCommand operation from {@link @aws-sdk/client-dynamodb#BatchGetItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -152,7 +152,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchWriteItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchWriteItemCommand operation from {@link @aws-sdk/client-dynamodb#BatchWriteItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -182,7 +182,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * DeleteItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * DeleteItemCommand operation from {@link @aws-sdk/client-dynamodb#DeleteItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -212,7 +212,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ExecuteStatementCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ExecuteStatementCommand operation from {@link @aws-sdk/client-dynamodb#ExecuteStatementCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -248,7 +248,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ExecuteTransactionCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ExecuteTransactionCommand operation from {@link @aws-sdk/client-dynamodb#ExecuteTransactionCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -284,7 +284,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * GetItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * GetItemCommand operation from {@link @aws-sdk/client-dynamodb#GetItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -314,7 +314,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * PutItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * PutItemCommand operation from {@link @aws-sdk/client-dynamodb#PutItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -344,7 +344,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * QueryCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * QueryCommand operation from {@link @aws-sdk/client-dynamodb#QueryCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -374,7 +374,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ScanCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ScanCommand operation from {@link @aws-sdk/client-dynamodb#ScanCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -404,7 +404,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * TransactGetItemsCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * TransactGetItemsCommand operation from {@link @aws-sdk/client-dynamodb#TransactGetItemsCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -434,7 +434,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * TransactWriteItemsCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * TransactWriteItemsCommand operation from {@link @aws-sdk/client-dynamodb#TransactWriteItemsCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. @@ -470,7 +470,7 @@ export class DynamoDBDocument extends DynamoDBDocumentClient { /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * UpdateItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * UpdateItemCommand operation from {@link @aws-sdk/client-dynamodb#UpdateItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. diff --git a/lib/lib-dynamodb/src/DynamoDBDocumentClient.ts b/lib/lib-dynamodb/src/DynamoDBDocumentClient.ts index ea3aec88f4b5..127100fafc99 100644 --- a/lib/lib-dynamodb/src/DynamoDBDocumentClient.ts +++ b/lib/lib-dynamodb/src/DynamoDBDocumentClient.ts @@ -26,6 +26,13 @@ import { TransactGetCommandInput, TransactGetCommandOutput } from "./commands/Tr import { TransactWriteCommandInput, TransactWriteCommandOutput } from "./commands/TransactWriteCommand"; import { UpdateCommandInput, UpdateCommandOutput } from "./commands/UpdateCommand"; +/** + * @public + */ +export { __Client }; +/** + * @public + */ export type ServiceInputTypes = | __ServiceInputTypes | BatchExecuteStatementCommandInput @@ -42,6 +49,9 @@ export type ServiceInputTypes = | TransactWriteCommandInput | UpdateCommandInput; +/** + * @public + */ export type ServiceOutputTypes = | __ServiceOutputTypes | BatchExecuteStatementCommandOutput @@ -58,11 +68,17 @@ export type ServiceOutputTypes = | TransactWriteCommandOutput | UpdateCommandOutput; +/** + * @public + */ export type TranslateConfig = { marshallOptions?: marshallOptions; unmarshallOptions?: unmarshallOptions; }; +/** + * @public + */ export type DynamoDBDocumentClientResolvedConfig = DynamoDBClientResolvedConfig & { translateConfig?: TranslateConfig; }; @@ -111,7 +127,9 @@ export type DynamoDBDocumentClientResolvedConfig = DynamoDBClientResolvedConfig * [null, false, 1, "two"] * ``` * - * @see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb} + * @see {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb | @aws-sdk/client-dynamodb} + * + * @public */ export class DynamoDBDocumentClient extends __Client< __HttpHandlerOptions, diff --git a/lib/lib-dynamodb/src/baseCommand/DynamoDBDocumentClientCommand.ts b/lib/lib-dynamodb/src/baseCommand/DynamoDBDocumentClientCommand.ts index e85673bcbbfe..a86d43775342 100644 --- a/lib/lib-dynamodb/src/baseCommand/DynamoDBDocumentClientCommand.ts +++ b/lib/lib-dynamodb/src/baseCommand/DynamoDBDocumentClientCommand.ts @@ -13,9 +13,14 @@ import { import { KeyNode, marshallInput, unmarshallOutput } from "../commands/utils"; import { DynamoDBDocumentClientResolvedConfig } from "../DynamoDBDocumentClient"; +// /** @public */ +// export { $Command, DynamoDBDocumentClientResolvedConfig }; + /** * Base class for Commands in lib-dynamodb used to pass middleware to * the underlying DynamoDBClient Commands. + * + * @public */ export abstract class DynamoDBDocumentClientCommand< Input extends object, diff --git a/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts b/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts index 26a412197d1d..78e25f47ddb3 100644 --- a/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts +++ b/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts @@ -6,12 +6,21 @@ import { BatchStatementRequest, BatchStatementResponse, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type BatchExecuteStatementCommandInput = Omit<__BatchExecuteStatementCommandInput, "Statements"> & { Statements: | (Omit & { @@ -20,6 +29,9 @@ export type BatchExecuteStatementCommandInput = Omit<__BatchExecuteStatementComm | undefined; }; +/** + * @public + */ export type BatchExecuteStatementCommandOutput = Omit<__BatchExecuteStatementCommandOutput, "Responses"> & { Responses?: (Omit & { Item?: Record; @@ -28,10 +40,12 @@ export type BatchExecuteStatementCommandOutput = Omit<__BatchExecuteStatementCom /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchExecuteStatementCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchExecuteStatementCommand operation from {@link @aws-sdk/client-dynamodb#BatchExecuteStatementCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class BatchExecuteStatementCommand extends DynamoDBDocumentClientCommand< BatchExecuteStatementCommandInput, diff --git a/lib/lib-dynamodb/src/commands/BatchGetCommand.ts b/lib/lib-dynamodb/src/commands/BatchGetCommand.ts index 7071449ea55d..19566ed968bd 100644 --- a/lib/lib-dynamodb/src/commands/BatchGetCommand.ts +++ b/lib/lib-dynamodb/src/commands/BatchGetCommand.ts @@ -5,12 +5,21 @@ import { BatchGetItemCommandOutput as __BatchGetItemCommandOutput, KeysAndAttributes, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type BatchGetCommandInput = Omit<__BatchGetItemCommandInput, "RequestItems"> & { RequestItems: | Record< @@ -22,6 +31,9 @@ export type BatchGetCommandInput = Omit<__BatchGetItemCommandInput, "RequestItem | undefined; }; +/** + * @public + */ export type BatchGetCommandOutput = Omit<__BatchGetItemCommandOutput, "Responses" | "UnprocessedKeys"> & { Responses?: Record[]>; UnprocessedKeys?: Record< @@ -34,10 +46,12 @@ export type BatchGetCommandOutput = Omit<__BatchGetItemCommandOutput, "Responses /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchGetItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchGetItemCommand operation from {@link @aws-sdk/client-dynamodb#BatchGetItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class BatchGetCommand extends DynamoDBDocumentClientCommand< BatchGetCommandInput, diff --git a/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts b/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts index 58a7fb410cc9..d1c3de12cc35 100644 --- a/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts +++ b/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts @@ -8,12 +8,21 @@ import { PutRequest, WriteRequest, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type BatchWriteCommandInput = Omit<__BatchWriteItemCommandInput, "RequestItems"> & { RequestItems: | Record< @@ -30,6 +39,9 @@ export type BatchWriteCommandInput = Omit<__BatchWriteItemCommandInput, "Request | undefined; }; +/** + * @public + */ export type BatchWriteCommandOutput = Omit< __BatchWriteItemCommandOutput, "UnprocessedItems" | "ItemCollectionMetrics" @@ -55,10 +67,12 @@ export type BatchWriteCommandOutput = Omit< /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * BatchWriteItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * BatchWriteItemCommand operation from {@link @aws-sdk/client-dynamodb#BatchWriteItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class BatchWriteCommand extends DynamoDBDocumentClientCommand< BatchWriteCommandInput, diff --git a/lib/lib-dynamodb/src/commands/DeleteCommand.ts b/lib/lib-dynamodb/src/commands/DeleteCommand.ts index a81ae623ac4b..ff6aeef9330e 100644 --- a/lib/lib-dynamodb/src/commands/DeleteCommand.ts +++ b/lib/lib-dynamodb/src/commands/DeleteCommand.ts @@ -6,12 +6,21 @@ import { ExpectedAttributeValue, ItemCollectionMetrics, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type DeleteCommandInput = Omit<__DeleteItemCommandInput, "Key" | "Expected" | "ExpressionAttributeValues"> & { Key: Record | undefined; Expected?: Record< @@ -24,6 +33,9 @@ export type DeleteCommandInput = Omit<__DeleteItemCommandInput, "Key" | "Expecte ExpressionAttributeValues?: Record; }; +/** + * @public + */ export type DeleteCommandOutput = Omit<__DeleteItemCommandOutput, "Attributes" | "ItemCollectionMetrics"> & { Attributes?: Record; ItemCollectionMetrics?: Omit & { @@ -33,10 +45,12 @@ export type DeleteCommandOutput = Omit<__DeleteItemCommandOutput, "Attributes" | /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * DeleteItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * DeleteItemCommand operation from {@link @aws-sdk/client-dynamodb#DeleteItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class DeleteCommand extends DynamoDBDocumentClientCommand< DeleteCommandInput, diff --git a/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts b/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts index 98f99fce9fb9..2f647794d7e7 100644 --- a/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts +++ b/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts @@ -4,16 +4,28 @@ import { ExecuteStatementCommandInput as __ExecuteStatementCommandInput, ExecuteStatementCommandOutput as __ExecuteStatementCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type ExecuteStatementCommandInput = Omit<__ExecuteStatementCommandInput, "Parameters"> & { Parameters?: NativeAttributeValue[]; }; +/** + * @public + */ export type ExecuteStatementCommandOutput = Omit<__ExecuteStatementCommandOutput, "Items" | "LastEvaluatedKey"> & { Items?: Record[]; LastEvaluatedKey?: Record; @@ -21,10 +33,12 @@ export type ExecuteStatementCommandOutput = Omit<__ExecuteStatementCommandOutput /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ExecuteStatementCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ExecuteStatementCommand operation from {@link @aws-sdk/client-dynamodb#ExecuteStatementCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class ExecuteStatementCommand extends DynamoDBDocumentClientCommand< ExecuteStatementCommandInput, diff --git a/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts b/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts index e5ef0798332f..da1454a83e35 100644 --- a/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts +++ b/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts @@ -6,12 +6,21 @@ import { ItemResponse, ParameterizedStatement, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type ExecuteTransactionCommandInput = Omit<__ExecuteTransactionCommandInput, "TransactStatements"> & { TransactStatements: | (Omit & { @@ -20,6 +29,9 @@ export type ExecuteTransactionCommandInput = Omit<__ExecuteTransactionCommandInp | undefined; }; +/** + * @public + */ export type ExecuteTransactionCommandOutput = Omit<__ExecuteTransactionCommandOutput, "Responses"> & { Responses?: (Omit & { Item?: Record; @@ -28,10 +40,12 @@ export type ExecuteTransactionCommandOutput = Omit<__ExecuteTransactionCommandOu /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ExecuteTransactionCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ExecuteTransactionCommand operation from {@link @aws-sdk/client-dynamodb#ExecuteTransactionCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class ExecuteTransactionCommand extends DynamoDBDocumentClientCommand< ExecuteTransactionCommandInput, diff --git a/lib/lib-dynamodb/src/commands/GetCommand.ts b/lib/lib-dynamodb/src/commands/GetCommand.ts index c6f046f7f7c5..3ae0a478e269 100644 --- a/lib/lib-dynamodb/src/commands/GetCommand.ts +++ b/lib/lib-dynamodb/src/commands/GetCommand.ts @@ -4,26 +4,40 @@ import { GetItemCommandInput as __GetItemCommandInput, GetItemCommandOutput as __GetItemCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type GetCommandInput = Omit<__GetItemCommandInput, "Key"> & { Key: Record | undefined; }; +/** + * @public + */ export type GetCommandOutput = Omit<__GetItemCommandOutput, "Item"> & { Item?: Record; }; /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * GetItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * GetItemCommand operation from {@link @aws-sdk/client-dynamodb#GetItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class GetCommand extends DynamoDBDocumentClientCommand< GetCommandInput, diff --git a/lib/lib-dynamodb/src/commands/PutCommand.ts b/lib/lib-dynamodb/src/commands/PutCommand.ts index c08e5d376c79..2d2ed9bb9f60 100644 --- a/lib/lib-dynamodb/src/commands/PutCommand.ts +++ b/lib/lib-dynamodb/src/commands/PutCommand.ts @@ -6,12 +6,21 @@ import { PutItemCommandInput as __PutItemCommandInput, PutItemCommandOutput as __PutItemCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type PutCommandInput = Omit<__PutItemCommandInput, "Item" | "Expected" | "ExpressionAttributeValues"> & { Item: Record | undefined; Expected?: Record< @@ -24,6 +33,9 @@ export type PutCommandInput = Omit<__PutItemCommandInput, "Item" | "Expected" | ExpressionAttributeValues?: Record; }; +/** + * @public + */ export type PutCommandOutput = Omit<__PutItemCommandOutput, "Attributes" | "ItemCollectionMetrics"> & { Attributes?: Record; ItemCollectionMetrics?: Omit & { @@ -33,10 +45,12 @@ export type PutCommandOutput = Omit<__PutItemCommandOutput, "Attributes" | "Item /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * PutItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * PutItemCommand operation from {@link @aws-sdk/client-dynamodb#PutItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class PutCommand extends DynamoDBDocumentClientCommand< PutCommandInput, diff --git a/lib/lib-dynamodb/src/commands/QueryCommand.ts b/lib/lib-dynamodb/src/commands/QueryCommand.ts index f5e6c1941822..fb52e5e65fca 100644 --- a/lib/lib-dynamodb/src/commands/QueryCommand.ts +++ b/lib/lib-dynamodb/src/commands/QueryCommand.ts @@ -5,12 +5,21 @@ import { QueryCommandInput as __QueryCommandInput, QueryCommandOutput as __QueryCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type QueryCommandInput = Omit< __QueryCommandInput, "KeyConditions" | "QueryFilter" | "ExclusiveStartKey" | "ExpressionAttributeValues" @@ -31,6 +40,9 @@ export type QueryCommandInput = Omit< ExpressionAttributeValues?: Record; }; +/** + * @public + */ export type QueryCommandOutput = Omit<__QueryCommandOutput, "Items" | "LastEvaluatedKey"> & { Items?: Record[]; LastEvaluatedKey?: Record; @@ -38,10 +50,12 @@ export type QueryCommandOutput = Omit<__QueryCommandOutput, "Items" | "LastEvalu /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * QueryCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * QueryCommand operation from {@link @aws-sdk/client-dynamodb#QueryCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class QueryCommand extends DynamoDBDocumentClientCommand< QueryCommandInput, diff --git a/lib/lib-dynamodb/src/commands/ScanCommand.ts b/lib/lib-dynamodb/src/commands/ScanCommand.ts index 9276722bf41a..6e8e162917f1 100644 --- a/lib/lib-dynamodb/src/commands/ScanCommand.ts +++ b/lib/lib-dynamodb/src/commands/ScanCommand.ts @@ -5,12 +5,21 @@ import { ScanCommandInput as __ScanCommandInput, ScanCommandOutput as __ScanCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type ScanCommandInput = Omit< __ScanCommandInput, "ScanFilter" | "ExclusiveStartKey" | "ExpressionAttributeValues" @@ -25,6 +34,9 @@ export type ScanCommandInput = Omit< ExpressionAttributeValues?: Record; }; +/** + * @public + */ export type ScanCommandOutput = Omit<__ScanCommandOutput, "Items" | "LastEvaluatedKey"> & { Items?: Record[]; LastEvaluatedKey?: Record; @@ -32,10 +44,12 @@ export type ScanCommandOutput = Omit<__ScanCommandOutput, "Items" | "LastEvaluat /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * ScanCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * ScanCommand operation from {@link @aws-sdk/client-dynamodb#ScanCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class ScanCommand extends DynamoDBDocumentClientCommand< ScanCommandInput, diff --git a/lib/lib-dynamodb/src/commands/TransactGetCommand.ts b/lib/lib-dynamodb/src/commands/TransactGetCommand.ts index f64175369e3b..7d4e937efcc2 100644 --- a/lib/lib-dynamodb/src/commands/TransactGetCommand.ts +++ b/lib/lib-dynamodb/src/commands/TransactGetCommand.ts @@ -7,12 +7,21 @@ import { TransactGetItemsCommandInput as __TransactGetItemsCommandInput, TransactGetItemsCommandOutput as __TransactGetItemsCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type TransactGetCommandInput = Omit<__TransactGetItemsCommandInput, "TransactItems"> & { TransactItems: | (Omit & { @@ -25,6 +34,9 @@ export type TransactGetCommandInput = Omit<__TransactGetItemsCommandInput, "Tran | undefined; }; +/** + * @public + */ export type TransactGetCommandOutput = Omit<__TransactGetItemsCommandOutput, "Responses"> & { Responses?: (Omit & { Item?: Record; @@ -33,10 +45,12 @@ export type TransactGetCommandOutput = Omit<__TransactGetItemsCommandOutput, "Re /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * TransactGetItemsCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * TransactGetItemsCommand operation from {@link @aws-sdk/client-dynamodb#TransactGetItemsCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class TransactGetCommand extends DynamoDBDocumentClientCommand< TransactGetCommandInput, diff --git a/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts b/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts index 7f5c05f9e2d1..5e0a8ae7bdf8 100644 --- a/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts +++ b/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts @@ -10,12 +10,21 @@ import { TransactWriteItemsCommandOutput as __TransactWriteItemsCommandOutput, Update, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type TransactWriteCommandInput = Omit<__TransactWriteItemsCommandInput, "TransactItems"> & { TransactItems: | (Omit & { @@ -39,6 +48,9 @@ export type TransactWriteCommandInput = Omit<__TransactWriteItemsCommandInput, " | undefined; }; +/** + * @public + */ export type TransactWriteCommandOutput = Omit<__TransactWriteItemsCommandOutput, "ItemCollectionMetrics"> & { ItemCollectionMetrics?: Record< string, @@ -50,10 +62,12 @@ export type TransactWriteCommandOutput = Omit<__TransactWriteItemsCommandOutput, /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * TransactWriteItemsCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * TransactWriteItemsCommand operation from {@link @aws-sdk/client-dynamodb#TransactWriteItemsCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class TransactWriteCommand extends DynamoDBDocumentClientCommand< TransactWriteCommandInput, diff --git a/lib/lib-dynamodb/src/commands/UpdateCommand.ts b/lib/lib-dynamodb/src/commands/UpdateCommand.ts index ef42d3a6c471..720e0103f9c3 100644 --- a/lib/lib-dynamodb/src/commands/UpdateCommand.ts +++ b/lib/lib-dynamodb/src/commands/UpdateCommand.ts @@ -7,12 +7,21 @@ import { UpdateItemCommandInput as __UpdateItemCommandInput, UpdateItemCommandOutput as __UpdateItemCommandOutput, } from "@aws-sdk/client-dynamodb"; +import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MiddlewareStack } from "@aws-sdk/types"; import { NativeAttributeValue } from "@aws-sdk/util-dynamodb"; import { DynamoDBDocumentClientCommand } from "../baseCommand/DynamoDBDocumentClientCommand"; import { DynamoDBDocumentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { DynamoDBDocumentClientCommand, $Command }; + +/** + * @public + */ export type UpdateCommandInput = Omit< __UpdateItemCommandInput, "Key" | "AttributeUpdates" | "Expected" | "ExpressionAttributeValues" @@ -34,6 +43,9 @@ export type UpdateCommandInput = Omit< ExpressionAttributeValues?: Record; }; +/** + * @public + */ export type UpdateCommandOutput = Omit<__UpdateItemCommandOutput, "Attributes" | "ItemCollectionMetrics"> & { Attributes?: Record; ItemCollectionMetrics?: Omit & { @@ -43,10 +55,12 @@ export type UpdateCommandOutput = Omit<__UpdateItemCommandOutput, "Attributes" | /** * Accepts native JavaScript types instead of `AttributeValue`s, and calls - * UpdateItemCommand operation from {@link https://www.npmjs.com/package/@aws-sdk/client-dynamodb @aws-sdk/client-dynamodb}. + * UpdateItemCommand operation from {@link @aws-sdk/client-dynamodb#UpdateItemCommand}. * * JavaScript objects passed in as parameters are marshalled into `AttributeValue` shapes * required by Amazon DynamoDB. Responses from DynamoDB are unmarshalled into plain JavaScript objects. + * + * @public */ export class UpdateCommand extends DynamoDBDocumentClientCommand< UpdateCommandInput, diff --git a/lib/lib-dynamodb/src/pagination/Interfaces.ts b/lib/lib-dynamodb/src/pagination/Interfaces.ts index 2144d40e102f..37ce2edd309a 100644 --- a/lib/lib-dynamodb/src/pagination/Interfaces.ts +++ b/lib/lib-dynamodb/src/pagination/Interfaces.ts @@ -4,6 +4,14 @@ import { PaginationConfiguration } from "@aws-sdk/types"; import { DynamoDBDocument } from "../DynamoDBDocument"; import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient"; +/** + * @public + */ +export { PaginationConfiguration }; + +/** + * @public + */ export interface DynamoDBDocumentPaginationConfiguration extends PaginationConfiguration { client: DynamoDBDocument | DynamoDBDocumentClient; } diff --git a/lib/lib-dynamodb/src/pagination/QueryPaginator.ts b/lib/lib-dynamodb/src/pagination/QueryPaginator.ts index 829915425a0a..9c3c09194911 100644 --- a/lib/lib-dynamodb/src/pagination/QueryPaginator.ts +++ b/lib/lib-dynamodb/src/pagination/QueryPaginator.ts @@ -7,7 +7,11 @@ import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient"; import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces"; /** - * @private + * @public + */ +export { Paginator }; +/** + * @internal */ const makePagedClientRequest = async ( client: DynamoDBDocumentClient, @@ -18,7 +22,7 @@ const makePagedClientRequest = async ( return await client.send(new QueryCommand(input), ...args); }; /** - * @private + * @internal */ const makePagedRequest = async ( client: DynamoDBDocument, @@ -28,6 +32,13 @@ const makePagedRequest = async ( // @ts-ignore return await client.query(input, ...args); }; +/** + * @public + * + * @param QueryCommandInput - {@link QueryCommandInput} + * @returns {@link QueryCommandOutput} + * + */ export async function* paginateQuery( config: DynamoDBDocumentPaginationConfiguration, input: QueryCommandInput, diff --git a/lib/lib-dynamodb/src/pagination/ScanPaginator.ts b/lib/lib-dynamodb/src/pagination/ScanPaginator.ts index 6b01fcfae8fb..3a9ff04fc40f 100644 --- a/lib/lib-dynamodb/src/pagination/ScanPaginator.ts +++ b/lib/lib-dynamodb/src/pagination/ScanPaginator.ts @@ -7,7 +7,11 @@ import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient"; import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces"; /** - * @private + * @public + */ +export { Paginator }; +/** + * @internal */ const makePagedClientRequest = async ( client: DynamoDBDocumentClient, @@ -18,7 +22,7 @@ const makePagedClientRequest = async ( return await client.send(new ScanCommand(input), ...args); }; /** - * @private + * @internal */ const makePagedRequest = async ( client: DynamoDBDocument, @@ -28,6 +32,13 @@ const makePagedRequest = async ( // @ts-ignore return await client.scan(input, ...args); }; +/** + * @public + * + * @param ScanCommandInput - {@link ScanCommandInput} + * @returns {@link ScanCommandOutput} + * + */ export async function* paginateScan( config: DynamoDBDocumentPaginationConfiguration, input: ScanCommandInput,