From c04d34a236bab83e8cac761fbaa08b50af459242 Mon Sep 17 00:00:00 2001 From: Matt Belford <47286642+mattbford@users.noreply.github.com> Date: Tue, 20 Jun 2023 11:30:42 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#65805=20[@types/aw?= =?UTF-8?q?s-param-store]=20Add=20type=20definitions=20for=20put=20methods?= =?UTF-8?q?=20by=20@mattbford?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [aws-param-store] Add type definitions for put methods * Add tests * Add legacy type and add put to query return types * Add missing semicolon --- .../aws-param-store/aws-param-store-tests.ts | 18 +++++++++++++ types/aws-param-store/index.d.ts | 25 ++++++++++++++++--- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/types/aws-param-store/aws-param-store-tests.ts b/types/aws-param-store/aws-param-store-tests.ts index 6c8faf10e9..5711af7189 100644 --- a/types/aws-param-store/aws-param-store-tests.ts +++ b/types/aws-param-store/aws-param-store-tests.ts @@ -8,21 +8,29 @@ import { getParameterSync, getParametersSync, getParametersByPathSync, + putParameter, + putParameterSync, + newQuery, } from 'aws-param-store'; declare let bool: boolean; declare let query: ParameterQuery; declare let psName: SSM.Types.PSParameterName; declare let psNames: SSM.Types.ParameterNameList; +declare let value: SSM.Types.ParameterValue; +declare let type: SSM.Types.ParameterType; declare let options: SSM.Types.ClientConfiguration; declare let paramResult: SSM.Types.Parameter; declare let paramsResult: SSM.Types.GetParametersResult; declare let paramsByPathResult: SSM.Types.ParameterList; +declare let putParamResult: SSM.Types.PutParameterResult; declare let allParamResults: SSM.Types.Parameter | SSM.Types.GetParametersByPathResult | SSM.Types.ParameterList; declare let promiseParamResult: Promise; declare let promiseParamsResult: Promise; declare let promiseParamsByPathResult: Promise; declare let promiseAllParamResults: Promise; +declare let promisePutParamResult: Promise; +declare let promiseNewQuery: Promise; query = parameterQuery(); @@ -76,3 +84,13 @@ paramsResult = getParametersSync(psNames, options); paramsByPathResult = getParametersByPathSync(psName); paramsByPathResult = getParametersByPathSync(psName, options); + +promisePutParamResult = putParameter(psName, value, type); +promisePutParamResult = putParameter(psName, value, type, options); + +putParamResult = putParameterSync(psName, value, type); +putParamResult = putParameterSync(psName, value, type, options); + +promiseNewQuery = newQuery(); +promiseNewQuery = newQuery(psName); +promiseNewQuery = newQuery(psName, options); diff --git a/types/aws-param-store/index.d.ts b/types/aws-param-store/index.d.ts index 97ae73a200..31fdae8f78 100644 --- a/types/aws-param-store/index.d.ts +++ b/types/aws-param-store/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for aws-param-store 2.1 +// Type definitions for aws-param-store 3.2 // Project: https://github.com/vandium-io/aws-param-store#readme // Definitions by: Jason Gray , Nathan Oertel // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -36,13 +36,32 @@ export function getParametersByPathSync( options?: SSM.Types.ClientConfiguration ): SSM.Types.ParameterList; +export function putParameter( + path: SSM.Types.PSParameterName, + value: SSM.Types.ParameterValue, + type: SSM.Types.ParameterType, + options?: SSM.Types.ClientConfiguration +): Promise; + +export function putParameterSync( + names: SSM.Types.PSParameterName, + value: SSM.Types.ParameterValue, + type: SSM.Types.ParameterType, + options?: SSM.Types.ClientConfiguration +): SSM.Types.PutParameterResult; + +export function newQuery( + path?: SSM.Types.PSParameterName, + options?: SSM.Types.ClientConfiguration +): Promise; + export interface ParameterQuery { path(path: SSM.Types.PSParameterName): ParameterQuery; named(nameOrNames: SSM.Types.PSParameterName | SSM.Types.ParameterNameList): ParameterQuery; decryption(enabled: boolean): ParameterQuery; recursive(enabled: boolean): ParameterQuery; - execute(): Promise; - executeSync(): SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult; + execute(): Promise; + executeSync(): SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult | SSM.Types.PutParameterResult; } export function parameterQuery(options?: SSM.Types.ClientConfiguration): ParameterQuery;