@model-ts/dynamodb 0.1.0 → 0.2.0

package/src/dynamodb-model.ts

@@ -15,17 +15,20 @@ export interface DynamoDBModelInstance extends ModelInstance<string, any> {
 
   PK: string
   SK: string
-  GSI2PK?: string // | null
-  GSI2SK?: string // | null
-  GSI3PK?: string // | null
-  GSI3SK?: string // | null
+  GSI2PK?: string
+  GSI2SK?: string
+  GSI3PK?: string
+  GSI3SK?: string
+  GSI4PK?: string
+  GSI4SK?: string
+  GSI5PK?: string
+  GSI5SK?: string
 }
 
 // export interface DynamoDBModel {}
 
-export type DynamoDBModelConstructor<
-  T extends DynamoDBModelInstance
-> = ModelConstructor<T>
+export type DynamoDBModelConstructor<T extends DynamoDBModelInstance> =
+  ModelConstructor<T>
 
 export type DynamoDBUnion = Union<
   [
@@ -37,10 +40,9 @@ export type DynamoDBUnion = Union<
 
 export type Decodable = DynamoDBModelConstructor<any> | DynamoDBUnion
 
-export type DecodableInstance<
-  M extends Decodable
-> = M extends DynamoDBModelConstructor<any>
-  ? InstanceType<M>
-  : M extends DynamoDBUnion
-  ? InstanceType<M["_models"][number]>
-  : never
+export type DecodableInstance<M extends Decodable> =
+  M extends DynamoDBModelConstructor<any>
+    ? InstanceType<M>
+    : M extends DynamoDBUnion
+    ? InstanceType<M["_models"][number]>
+    : never

package/src/operations.ts

@@ -62,6 +62,10 @@ export interface UpdateRawOperation<M extends DynamoDBModelConstructor<any>>
     GSI2SK?: string | null
     GSI3PK?: string | null
     GSI3SK?: string | null
+    GSI4PK?: string | null
+    GSI4SK?: string | null
+    GSI5PK?: string | null
+    GSI5SK?: string | null
   }
 }
 

package/src/pagination.ts

@@ -35,9 +35,11 @@ const DEFAULT_OPTIONS = {
   default: 20,
 }
 
-export function decodePagination(
-  pagination: PaginationInput
-): { cursor?: string; limit: number; direction: PaginationDirection } {
+export function decodePagination(pagination: PaginationInput): {
+  cursor?: string
+  limit: number
+  direction: PaginationDirection
+} {
   const { after, before, first, last } = pagination
 
   if (before && after)
@@ -77,6 +79,10 @@ export const encodeDDBCursor = (
     GSI2SK,
     GSI3PK,
     GSI3SK,
+    GSI4PK,
+    GSI4SK,
+    GSI5PK,
+    GSI5SK,
   }: {
     PK: string
     SK: string
@@ -84,24 +90,52 @@ export const encodeDDBCursor = (
     GSI2SK?: string
     GSI3PK?: string
     GSI3SK?: string
+    GSI4PK?: string
+    GSI4SK?: string
+    GSI5PK?: string
+    GSI5SK?: string
   },
-  index?: "GSI2" | "GSI3"
+  index?: "GSI2" | "GSI3" | "GSI4" | "GSI5"
 ) =>
   index === "GSI2"
     ? Buffer.from(JSON.stringify({ PK, SK, GSI2PK, GSI2SK })).toString("base64")
     : index === "GSI3"
     ? Buffer.from(JSON.stringify({ PK, SK, GSI3PK, GSI3SK })).toString("base64")
+    : index === "GSI4"
+    ? Buffer.from(JSON.stringify({ PK, SK, GSI4PK, GSI4SK })).toString("base64")
+    : index === "GSI5"
+    ? Buffer.from(JSON.stringify({ PK, SK, GSI5PK, GSI5SK })).toString("base64")
     : Buffer.from(JSON.stringify({ PK, SK })).toString("base64")
 
 export const decodeDDBCursor = (encoded: string) => {
   try {
-    const { PK, SK, GSI2PK, GSI2SK, GSI3PK, GSI3SK } = JSON.parse(
-      Buffer.from(encoded, "base64").toString()
-    )
+    const {
+      PK,
+      SK,
+      GSI2PK,
+      GSI2SK,
+      GSI3PK,
+      GSI3SK,
+      GSI4PK,
+      GSI4SK,
+      GSI5PK,
+      GSI5SK,
+    } = JSON.parse(Buffer.from(encoded, "base64").toString())
 
     if (typeof PK !== "string" || typeof SK !== "string") throw new Error()
 
-    return { PK, SK, GSI2PK, GSI2SK, GSI3PK, GSI3SK }
+    return {
+      PK,
+      SK,
+      GSI2PK,
+      GSI2SK,
+      GSI3PK,
+      GSI3SK,
+      GSI4PK,
+      GSI4SK,
+      GSI5PK,
+      GSI5SK,
+    }
   } catch (error) {
     throw new PaginationError("Couldn't decode cursor")
   }

package/src/provider.ts

@@ -295,7 +295,7 @@ export const getProvider = (client: Client) => {
   ): DeleteOperation<ModelOf<T>>
   function instanceOperation<T extends DynamoDBModelInstance>(
     this: T,
-    operation: "softDelete",
+    operation: "softDelete"
   ): [
     {
       action: PutOperation<T, ModelOf<T>>
@@ -518,6 +518,10 @@ export const getProvider = (client: Client) => {
           GSI2SK: this.GSI2SK,
           GSI3PK: this.GSI3PK,
           GSI3SK: this.GSI3SK,
+          GSI4PK: this.GSI4PK,
+          GSI4SK: this.GSI4SK,
+          GSI5PK: this.GSI5PK,
+          GSI5SK: this.GSI5SK,
         }
       },
       put<T extends DynamoDBModelInstance>(

package/src/sandbox.ts

@@ -31,6 +31,10 @@ export const createTable = async () => {
         { 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" },
       ],
       KeySchema: [
         { AttributeName: "PK", KeyType: "HASH" },
@@ -67,6 +71,26 @@ export const createTable = async () => {
             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",
     })