@model-ts/dynamodb 2.0.0 → 3.0.1

package/src/pagination.ts

@@ -1,5 +1,6 @@
 import crypto from "crypto"
 import { PaginationError } from "./errors"
+import { GSI, GSI_NAMES, GSIPK, GSISK } from "./gsi"
 
 const SIV = "Q05yyCR+0tyWl6glrZhlNw=="
 const ENCRYPTION_ALG = "aes-256-ctr"
@@ -33,13 +34,27 @@ export interface PaginationInput {
   after?: string | null
 }
 
-// TODO: make configurable
+export interface PaginationOptions {
+  /**
+   * Maximum number of items to return.
+   */
+  limit?: number
+
+  /**
+   * Default number of items to return if no limit is provided.
+   */
+  default?: number
+}
+
 const DEFAULT_OPTIONS = {
   limit: 50,
   default: 20,
 }
 
-export function decodePagination(pagination: PaginationInput): {
+export function decodePagination(
+  pagination: PaginationInput,
+  paginationOptions: PaginationOptions = DEFAULT_OPTIONS
+): {
   cursor?: string
   limit: number
   direction: PaginationDirection
@@ -65,8 +80,8 @@ export function decodePagination(pagination: PaginationInput): {
   return {
     cursor: before ?? after ?? undefined,
     limit: Math.min(
-      first ?? last ?? DEFAULT_OPTIONS.default,
-      DEFAULT_OPTIONS.limit
+      first ?? last ?? paginationOptions.default ?? DEFAULT_OPTIONS.default,
+      paginationOptions.limit ?? DEFAULT_OPTIONS.limit
     ),
     direction:
       before || last
@@ -117,43 +132,21 @@ const decryptCursor = (key: Buffer, encryptedCursor: string) => {
 }
 
 export const encodeDDBCursor = (
-  {
-    PK,
-    SK,
-    GSI2PK,
-    GSI2SK,
-    GSI3PK,
-    GSI3SK,
-    GSI4PK,
-    GSI4SK,
-    GSI5PK,
-    GSI5SK,
-  }: {
+  item: {
     PK: string
     SK: string
-    GSI2PK?: string
-    GSI2SK?: string
-    GSI3PK?: string
-    GSI3SK?: string
-    GSI4PK?: string
-    GSI4SK?: string
-    GSI5PK?: string
-    GSI5SK?: string
-  },
+  } & { [key in GSIPK]?: string } &
+    { [key in GSISK]?: string },
   encryptionKey?: Buffer
 ) => {
   const cursor = Buffer.from(
     JSON.stringify({
-      PK,
-      SK,
-      GSI2PK,
-      GSI2SK,
-      GSI3PK,
-      GSI3SK,
-      GSI4PK,
-      GSI4SK,
-      GSI5PK,
-      GSI5SK,
+      PK: item.PK,
+      SK: item.SK,
+      ...GSI_NAMES.map((GSI) => ({
+        [`${GSI}PK`]: item[`${GSI}PK` as const],
+        [`${GSI}SK`]: item[`${GSI}SK` as const],
+      })).reduce((acc, cur) => Object.assign(acc, cur), {}),
     })
   ).toString("base64")
 
@@ -164,7 +157,7 @@ export const encodeDDBCursor = (
 
 export const decodeDDBCursor = (
   encoded: string,
-  index?: "GSI2" | "GSI3" | "GSI4" | "GSI5",
+  index?: GSI,
   encryptionKey?: Buffer
 ) => {
   try {
@@ -173,26 +166,20 @@ export const decodeDDBCursor = (
 
     if (!json) throw new Error("Couldn't decrypt cursor")
 
-    const {
-      PK,
-      SK,
-      GSI2PK,
-      GSI2SK,
-      GSI3PK,
-      GSI3SK,
-      GSI4PK,
-      GSI4SK,
-      GSI5PK,
-      GSI5SK,
-    } = JSON.parse(Buffer.from(json, "base64").toString())
+    const { PK, SK, ...values } = JSON.parse(
+      Buffer.from(json, "base64").toString()
+    )
 
     if (typeof PK !== "string" || typeof SK !== "string") throw new Error()
 
     if (!index) return { PK, SK }
-    if (index === "GSI2") return { PK, SK, GSI2PK, GSI2SK }
-    if (index === "GSI3") return { PK, SK, GSI3PK, GSI3SK }
-    if (index === "GSI4") return { PK, SK, GSI4PK, GSI4SK }
-    if (index === "GSI5") return { PK, SK, GSI5PK, GSI5SK }
+
+    return {
+      PK,
+      SK,
+      [`${index}PK`]: values[`${index}PK`],
+      [`${index}SK`]: values[`${index}SK`],
+    }
   } catch (error) {
     throw new PaginationError("Couldn't decode cursor")
   }

package/src/provider.ts

@@ -18,6 +18,7 @@ import { OutputOf, TypeOf, ModelOf } from "@model-ts/core"
 import { RaceConditionError } from "./errors"
 import { absurd } from "fp-ts/lib/function"
 import { encodeDDBCursor, PaginationInput } from "./pagination"
+import { GSI_NAMES, GSIPK, GSISK } from "./gsi"
 
 export interface DynamoDBInternals<M extends Decodable> {
   __dynamoDBDecode(
@@ -512,18 +513,17 @@ export const getProvider = (client: Client) => {
     },
     instanceProps: {
       dynamodb: client,
-      keys<T extends DynamoDBModelInstance>(this: T) {
+      keys<T extends DynamoDBModelInstance>(
+        this: T
+      ): { PK: string; SK: string } & { [key in GSIPK]?: string } &
+        { [key in GSISK]?: string } {
         return {
           PK: this.PK,
           SK: this.SK,
-          GSI2PK: this.GSI2PK,
-          GSI2SK: this.GSI2SK,
-          GSI3PK: this.GSI3PK,
-          GSI3SK: this.GSI3SK,
-          GSI4PK: this.GSI4PK,
-          GSI4SK: this.GSI4SK,
-          GSI5PK: this.GSI5PK,
-          GSI5SK: this.GSI5SK,
+          ...GSI_NAMES.map((GSI) => ({
+            [`${GSI}PK`]: this[`${GSI}PK`],
+            [`${GSI}SK`]: this[`${GSI}SK`],
+          })).reduce((acc, cur) => Object.assign(acc, cur), {}),
         }
       },
       cursor<T extends DynamoDBModelInstance>(this: T) {

package/src/sandbox.ts

@@ -3,6 +3,7 @@ import { chunksOf } from "fp-ts/lib/Array"
 import DynamoDB from "aws-sdk/clients/dynamodb"
 import diff from "snapshot-diff"
 import { Client } from "./client"
+import { GSI_NAMES } from "./gsi"
 
 const ddb = new DynamoDB({
   accessKeyId: "xxx",
@@ -27,14 +28,10 @@ export const createTable = async () => {
       AttributeDefinitions: [
         { AttributeName: "PK", AttributeType: "S" },
         { AttributeName: "SK", AttributeType: "S" },
-        { AttributeName: "GSI2PK", AttributeType: "S" },
-        { AttributeName: "GSI2SK", AttributeType: "S" },
-        { AttributeName: "GSI3PK", AttributeType: "S" },
-        { AttributeName: "GSI3SK", AttributeType: "S" },
-        { AttributeName: "GSI4PK", AttributeType: "S" },
-        { AttributeName: "GSI4SK", AttributeType: "S" },
-        { AttributeName: "GSI5PK", AttributeType: "S" },
-        { AttributeName: "GSI5SK", AttributeType: "S" },
+        ...GSI_NAMES.flatMap((GSI) => [
+          { AttributeName: `${GSI}PK`, AttributeType: "S" },
+          { AttributeName: `${GSI}SK`, AttributeType: "S" },
+        ]),
       ],
       KeySchema: [
         { AttributeName: "PK", KeyType: "HASH" },
@@ -51,46 +48,16 @@ export const createTable = async () => {
             ProjectionType: "ALL",
           },
         },
-        {
-          IndexName: "GSI2",
-          KeySchema: [
-            { AttributeName: "GSI2PK", KeyType: "HASH" },
-            { AttributeName: "GSI2SK", KeyType: "RANGE" },
-          ],
-          Projection: {
-            ProjectionType: "ALL",
-          },
-        },
-        {
-          IndexName: "GSI3",
+        ...GSI_NAMES.map((GSI) => ({
+          IndexName: GSI,
           KeySchema: [
-            { AttributeName: "GSI3PK", KeyType: "HASH" },
-            { AttributeName: "GSI3SK", KeyType: "RANGE" },
+            { AttributeName: `${GSI}PK`, KeyType: "HASH" },
+            { AttributeName: `${GSI}SK`, KeyType: "RANGE" },
           ],
           Projection: {
             ProjectionType: "ALL",
           },
-        },
-        {
-          IndexName: "GSI4",
-          KeySchema: [
-            { AttributeName: "GSI4PK", KeyType: "HASH" },
-            { AttributeName: "GSI4SK", KeyType: "RANGE" },
-          ],
-          Projection: {
-            ProjectionType: "ALL",
-          },
-        },
-        {
-          IndexName: "GSI5",
-          KeySchema: [
-            { AttributeName: "GSI5PK", KeyType: "HASH" },
-            { AttributeName: "GSI5SK", KeyType: "RANGE" },
-          ],
-          Projection: {
-            ProjectionType: "ALL",
-          },
-        },
+        })),
       ],
       BillingMode: "PAY_PER_REQUEST",
     })

package/tsconfig.esm.json

@@ -5,9 +5,19 @@
     "module": "ES2015",
     "outDir": "./dist/esm",
     "paths": {
-      "@model-ts/core": ["../core"]
+      "@model-ts/core": [
+        "../core"
+      ]
     }
   },
-  "references": [{ "path": "../core/tsconfig.esm.json" }],
-  "exclude": ["__test__", "test-utils"]
-}
+  "references": [
+    {
+      "path": "../core/tsconfig.esm.json"
+    }
+  ],
+  "exclude": [
+    "dist",
+    "__test__",
+    "test-utils"
+  ]
+}

package/tsconfig.json

@@ -4,9 +4,19 @@
     "rootDir": "./src",
     "outDir": "./dist/cjs",
     "paths": {
-      "@model-ts/core": ["../core"]
+      "@model-ts/core": [
+        "../core"
+      ]
     }
   },
-  "references": [{ "path": "../core" }],
-  "exclude": ["__test__", "test-utils"]
-}
+  "references": [
+    {
+      "path": "../core"
+    }
+  ],
+  "exclude": [
+    "dist",
+    "__test__",
+    "test-utils"
+  ]
+}