🤖 Merge PR DefinitelyTyped#65805 [@types/aws-param-store] Add type de…

…finitions for put methods by @mattbford * [aws-param-store] Add type definitions for put methods * Add tests * Add legacy type and add put to query return types * Add missing semicolon
catlan · Jun 20, 2023 · c04d34a · c04d34a
1 parent 4f9cb49
commit c04d34a
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git 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<SSM.Types.Parameter>;
 declare let promiseParamsResult: Promise<SSM.Types.GetParametersResult>;
 declare let promiseParamsByPathResult: Promise<SSM.Types.ParameterList>;
 declare let promiseAllParamResults: Promise<typeof allParamResults>;
+declare let promisePutParamResult: Promise<SSM.Types.PutParameterResult>;
+declare let promiseNewQuery: Promise<SSM.Types.ParameterList>;
 
 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
@@ -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 <https://github.com/jasonthomasgray>, Nathan Oertel <https://github.com/nathanoertel>
 // 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<SSM.Types.PutParameterResult>;
+
+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<SSM.Types.ParameterList>;
+
 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<SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult>;
-    executeSync(): SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult;
+    execute(): Promise<SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult | SSM.Types.PutParameterResult>;
+    executeSync(): SSM.Types.ParameterList | SSM.Types.Parameter | SSM.Types.GetParametersResult | SSM.Types.PutParameterResult;
 }
 
 export function parameterQuery(options?: SSM.Types.ClientConfiguration): ParameterQuery;