@pristine-ts/aws 0.0.209 → 0.0.210

package/dist/types/options/find-by-secondary-index.options.d.ts

@@ -1,12 +1,28 @@
 import { ListOptions } from "./list.options";
+/**
+ * Options object to use when using FindBySecondaryIndex Dynamodb query.
+ * It extends ListOptions because FindBySecondaryIndex returns a list.
+ */
 export interface FindBySecondaryIndexOptions<T> extends ListOptions<T> {
+    /**
+     * The key condition for the secondary index. (ie: {secondaryId: value}).
+     */
     keyCondition: {
         [propertyName: string]: string | boolean | number;
     };
+    /**
+     * The name of the secondary index in DynamoDb.
+     */
     secondaryIndexName: string;
+    /**
+     * A map containing the filters keys and values to apply when listing by secondary index. Every key in the map represents an AND and the values represent ORs.  (ie: {filterKey1: filterValue, filterKey2: [value1, value1]} means you need filterKey1 to equal filterValue AND filterKey2 to equal value1 OR value2)
+     */
     filterKeysAndValues?: {
         [key: string]: string | number | boolean | string[] | number[];
     };
+    /**
+     * A filter to get only the ones that the expiration is later then the value. Can either be a Date or a number representing the timestamp in seconds. (ie: {expiresAt: new Date()})
+     */
     expiresAtFilter?: {
         [key: string]: number | Date;
     };

package/dist/types/options/list.options.d.ts

@@ -1,6 +1,15 @@
 import { ZeroArgumentsConstructor } from "@awslabs-community-fork/dynamodb-data-marshaller";
 import { PaginationOptions } from "./pagination.options";
+/**
+ * Options to pass when using a Dynamodb query that returns a list.
+ */
 export interface ListOptions<T> {
+    /**
+     * The class type of the elements being returned.
+     */
     classType: ZeroArgumentsConstructor<T>;
+    /**
+     * The pagination options.
+     */
     pagination?: PaginationOptions;
 }

package/dist/types/options/pagination.options.d.ts

@@ -1,6 +1,21 @@
 import { DynamodbSortOrderEnum } from "../enums/dynamodb-sort-order.enum";
+/**
+ * Pagination options for Dynamodb queries.
+ */
 export interface PaginationOptions {
+    /**
+     * The number of items per page to return.
+     * If not specified, returns all the items.
+     */
     pageSize?: number;
+    /**
+     * The key where to start the new page.
+     * If not specified, starts at the first item.
+     */
     startKey?: any;
+    /**
+     * The order in which to list the items.
+     * By default, DESC, meaning the most recent item comes first.
+     */
     order?: DynamodbSortOrderEnum;
 }

package/dist/types/resolvers/ssm.resolver.d.ts

@@ -1,4 +1,8 @@
 import { ResolverInterface } from "@pristine-ts/common";
+/**
+ * The resolver to resolve a parameter from AWS SSM.
+ * Extends the resolver interface with the generic as a string
+ */
 export declare class SSMResolver implements ResolverInterface<string> {
     private readonly ssmParameterName;
     private readonly region;

package/dist/types/results/list.result.d.ts

@@ -1,9 +1,18 @@
 import { PaginationResult } from "./pagination.result";
+/**
+ * The list of items returned when a list query is called on DynamoDB.
+ * It implements IterableIterator so that you can iterate over the items as if they were in a regular list.
+ */
 export declare class ListResult<T> implements IterableIterator<T> {
     private _items;
     private _paginationResult?;
     private index;
     private done;
+    /**
+     * The list of items returned when a list query is called on DynamoDB.
+     * @param _items The items returned by the query.
+     * @param _paginationResult The pagination results of the query.
+     */
     constructor(_items: T[], _paginationResult?: PaginationResult | undefined);
     [Symbol.iterator](): ListResult<T>;
     next(): IteratorResult<T, T | undefined>;

package/dist/types/results/pagination.result.d.ts

@@ -1,4 +1,13 @@
+/**
+ * The result interface returned when pagination occurred for DynamoDb queries
+ */
 export interface PaginationResult {
+    /**
+     * The number of items returned in the page.
+     */
     count: number;
+    /**
+     * The key of the last item returned in the page.
+     */
     lastEvaluatedKey: any;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/aws",
-  "version": "0.0.209",
+  "version": "0.0.210",
   "description": "",
   "module": "dist/lib/esm/aws.module.js",
   "main": "dist/lib/cjs/aws.module.js",
@@ -26,11 +26,11 @@
     "@awslabs-community-fork/dynamodb-data-mapper": "^0.7.9",
     "@awslabs-community-fork/dynamodb-data-marshaller": "^0.7.9",
     "@awslabs-community-fork/dynamodb-expressions": "^0.7.9",
-    "@pristine-ts/common": "^0.0.209",
-    "@pristine-ts/core": "^0.0.209",
-    "@pristine-ts/logging": "^0.0.209",
-    "@pristine-ts/networking": "^0.0.209",
-    "@pristine-ts/security": "^0.0.209"
+    "@pristine-ts/common": "^0.0.210",
+    "@pristine-ts/core": "^0.0.210",
+    "@pristine-ts/logging": "^0.0.210",
+    "@pristine-ts/networking": "^0.0.210",
+    "@pristine-ts/security": "^0.0.210"
   },
   "publishConfig": {
     "access": "public"
@@ -69,5 +69,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "1192c6c2309e4b30e14e59c5915521aa6b0ee208"
+  "gitHead": "d45241388a15bd6b451079932c7e02e2cd792c44"
 }