fix: type definition

Author: yutak23

index.d.ts

@@ -1,65 +1,69 @@
-import session, { Store } from "express-session";
+import * as express from "express";
+import * as session from "express-session";
 import {
   DynamoDBClient,
   GetItemCommandOutput,
   ProvisionedThroughput,
   ScalarAttributeType,
 } from "@aws-sdk/client-dynamodb";
 
+export = ConnectDynamoDB;
+
 declare function ConnectDynamoDB<Session extends Record<string, unknown>>(
-  connect: typeof session
-): DynamoDBStore<Session>;
-export default ConnectDynamoDB;
+  connect: (options?: session.SessionOptions) => express.RequestHandler
+): ConnectDynamoDB.DynamoDBStore<Session>;
 
-export interface DynamoDBStoreOptions {
-  /** A preconfigured client. If not supplied standard SDK environmental variables will be used. */
-  client?: DynamoDBClient;
-  /** Defaults to 'sessions' */
-  table?: string;
-  /** Defaults to 'sess:' */
-  prefix?: string;
-  /** Defaults to 'id' */
-  hashKey?: string;
-  readCapacityUnits?: ProvisionedThroughput["ReadCapacityUnits"];
-  writeCapacityUnits?: ProvisionedThroughput["WriteCapacityUnits"];
-  specialKeys?: DynamoDBStoreOptionsSpecialKey[];
-  skipThrowMissingSpecialKeys?: boolean;
-  /**
-   * @deprecated
-   * Upgrade to DynamoDB's TimeToLive configuration.
-   */
-  reapInterval?: number;
-}
+declare namespace ConnectDynamoDB {
+  interface DynamoDBStoreOptions {
+    /** A preconfigured client. If not supplied standard SDK environmental variables will be used. */
+    client?: DynamoDBClient;
+    /** Defaults to 'sessions' */
+    table?: string;
+    /** Defaults to 'sess:' */
+    prefix?: string;
+    /** Defaults to 'id' */
+    hashKey?: string;
+    readCapacityUnits?: ProvisionedThroughput["ReadCapacityUnits"];
+    writeCapacityUnits?: ProvisionedThroughput["WriteCapacityUnits"];
+    specialKeys?: DynamoDBStoreOptionsSpecialKey[];
+    skipThrowMissingSpecialKeys?: boolean;
+    /**
+     * @deprecated
+     * Upgrade to DynamoDB's TimeToLive configuration.
+     */
+    reapInterval?: number;
+  }
 
-interface DynamoDBStoreOptionsSpecialKey {
-  name: string; // The session key
-  type: ScalarAttributeType | "B" | "N" | "S";
-}
+  interface DynamoDBStoreOptionsSpecialKey {
+    name: string; // The session key
+    type: ScalarAttributeType | "B" | "N" | "S";
+  }
 
-export type DynamoDBStore<
-  Session extends Record<string, unknown> = Record<string, unknown>
-> = Store & {
-  readonly client: DynamoDBClient;
-  new (options?: DynamoDBStoreOptions): DynamoDBStore<Session>;
-  initialize(): Promise<void>;
-  describeSessionsTable(): Promise<void>;
-  createSessionsTable(): Promise<void>;
-  get(
-    id: string,
-    callback: (err: CallbackError, session?: Session | null) => void
-  ): void;
-  getParsedSession(
-    output: Pick<GetItemCommandOutput, "Item">
-  ): Record<string, unknown>;
-  set(id: string, callback: (err: CallbackError) => void): void;
-  reap(callback?: (err: CallbackError) => void): void;
-  destroy(id: string, callback?: (err: CallbackError) => void): void;
-  getExpiresValue(): number;
-  touch(
-    id: string,
-    callback?: (err: CallbackError, results: { expires: number }) => void
-  ): void;
-  clearInterval(): void;
-};
+  type DynamoDBStore<
+    Session extends Record<string, unknown> = Record<string, unknown>
+  > = session.Store & {
+    readonly client: DynamoDBClient;
+    new (options?: DynamoDBStoreOptions): DynamoDBStore<Session>;
+    initialize(): Promise<void>;
+    describeSessionsTable(): Promise<void>;
+    createSessionsTable(): Promise<void>;
+    get(
+      id: string,
+      callback: (err: CallbackError, session?: Session | null) => void
+    ): void;
+    getParsedSession(
+      output: Pick<GetItemCommandOutput, "Item">
+    ): Record<string, unknown>;
+    set(id: string, callback: (err: CallbackError) => void): void;
+    reap(callback?: (err: CallbackError) => void): void;
+    destroy(id: string, callback?: (err: CallbackError) => void): void;
+    getExpiresValue(): number;
+    touch(
+      id: string,
+      callback?: (err: CallbackError, results: { expires: number }) => void
+    ): void;
+    clearInterval(): void;
+  };
 
-type CallbackError = Error | undefined | null;
+  type CallbackError = Error | undefined | null;
+}

index.test-d.ts

@@ -0,0 +1,52 @@
+import { expectType } from "tsd";
+
+import connectDynamoDB, {
+  DynamoDBStore,
+  DynamoDBStoreOptions,
+  DynamoDBStoreOptionsSpecialKey,
+} from ".";
+import expressSession from "express-session";
+import express from "express";
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+
+expectType<DynamoDBStore>(connectDynamoDB(expressSession));
+expectType<connectDynamoDB.DynamoDBStore>(connectDynamoDB(expressSession));
+
+type SessionData = {
+  name: string;
+  animal: "cow" | "pig";
+};
+const DynamoDBStore: DynamoDBStore =
+  connectDynamoDB<SessionData>(expressSession);
+
+const specialKeysOption: DynamoDBStoreOptionsSpecialKey = {
+  name: "userId",
+  type: "S",
+};
+const specialKeysOptions: connectDynamoDB.DynamoDBStoreOptionsSpecialKey[] = [
+  specialKeysOption,
+];
+const options: DynamoDBStoreOptions = {
+  table: "myapp-sessions",
+  client: new DynamoDBClient({ endpoint: "http://localhost:8000" }),
+  readCapacityUnits: 25,
+  writeCapacityUnits: 25,
+  specialKeys: specialKeysOptions,
+  skipThrowMissingSpecialKeys: true,
+};
+
+expectType<express.RequestHandler>(
+  expressSession({ store: new DynamoDBStore(), secret: "keyboard cat" })
+);
+expectType<express.RequestHandler>(
+  expressSession({
+    store: new DynamoDBStore({ table: "myapp-sessions" }),
+    secret: "keyboard cat",
+  })
+);
+expectType<express.RequestHandler>(
+  expressSession({
+    store: new DynamoDBStore(options),
+    secret: "keyboard cat",
+  })
+);