ElectroDB Issue#239

package.json

{
  "name": "electro-test-2023-04-08",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "ts-node src/index.ts"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@aws-sdk/client-dynamodb": "^3.309.0",
    "@types/uuid": "^9.0.1",
    "aws-sdk": "^2.1353.0",
    "electrodb": "^2.5.1",
    "ts-node": "^10.9.1",
    "typescript": "^5.0.4",
    "uuid": "^9.0.0"
  }
}

test.ts

import { DynamoDBClient, ListTablesCommand, DeleteTableCommand, CreateTableCommand, UpdateItemCommand } from '@aws-sdk/client-dynamodb';
import { DocumentClient } from 'aws-sdk/clients/dynamodb';
import { Entity, Service } from 'electrodb';

const v3Client = new DynamoDBClient({
  endpoint: 'http://localhost:8000',
  region: 'us-east-1',
});

const v2Client = new DocumentClient({
  endpoint: 'http://localhost:8000',
  region: 'us-east-1',
});

const table = "paren-test";

const dynamodb = v3Client;

export function createTableManager(tableName: string) {
    return {
        async exists() {
          let tables = await dynamodb.send(new ListTablesCommand({}));
          return !!tables.TableNames?.includes(tableName);
        },
        async drop() {
            return dynamodb.send(new DeleteTableCommand({TableName: tableName}));
        },
        async create() {
            return dynamodb.send(new CreateTableCommand({
              "KeySchema":[
                  {
                      "AttributeName":"pk",
                      "KeyType":"HASH"
                  },
                  {
                      "AttributeName":"sk",
                      "KeyType":"RANGE"
                  }
              ],
              "AttributeDefinitions":[
                  {
                      "AttributeName":"pk",
                      "AttributeType":"S"
                  },
                  {
                      "AttributeName":"sk",
                      "AttributeType":"S"
                  },
                  {
                      "AttributeName":"gsi1pk",
                      "AttributeType":"S"
                  },
                  {
                      "AttributeName":"gsi1sk",
                      "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"
                  }
              ],
              "GlobalSecondaryIndexes":[
                  {
                      "IndexName":"gsi1pk-gsi1sk-index",
                      "KeySchema":[
                          {
                              "AttributeName":"gsi1pk",
                              "KeyType":"HASH"
                          },
                          {
                              "AttributeName":"gsi1sk",
                              "KeyType":"RANGE"
                          }
                      ],
                      "Projection":{
                          "ProjectionType":"ALL"
                      },
                      "ProvisionedThroughput": {       // Only specified if using provisioned mode
                        "ReadCapacityUnits": 1,
                        "WriteCapacityUnits": 1
                      },
                  },
                  {
                      "IndexName":"gsi2pk-gsi2sk-index",
                      "KeySchema":[
                          {
                              "AttributeName":"gsi2pk",
                              "KeyType":"HASH"
                          },
                          {
                              "AttributeName":"gsi2sk",
                              "KeyType":"RANGE"
                          }
                      ],
                      "Projection":{
                          "ProjectionType":"ALL"
                      },
                      "ProvisionedThroughput": {       // Only specified if using provisioned mode
                        "ReadCapacityUnits": 1,
                        "WriteCapacityUnits": 1
                      },
                  },
                  {
                      "IndexName":"gsi3pk-gsi3sk-index",
                      "KeySchema":[
                          {
                              "AttributeName":"gsi3pk",
                              "KeyType":"HASH"
                          },
                          {
                              "AttributeName":"gsi3sk",
                              "KeyType":"RANGE"
                          }
                      ],
                      "Projection":{
                          "ProjectionType":"ALL"
                      },
                      "ProvisionedThroughput": {       // Only specified if using provisioned mode
                        "ReadCapacityUnits": 1,
                        "WriteCapacityUnits": 1
                      },
                  },
                  {
                      "IndexName":"gsi4pk-gsi4sk-index",
                      "KeySchema":[
                          {
                              "AttributeName":"gsi4pk",
                              "KeyType":"HASH"
                          },
                          {
                              "AttributeName":"gsi4sk",
                              "KeyType":"RANGE"
                          }
                      ],
                      "Projection":{
                          "ProjectionType":"ALL"
                      },
                      "ProvisionedThroughput": {       // Only specified if using provisioned mode
                        "ReadCapacityUnits": 1,
                        "WriteCapacityUnits": 1
                      },
                  },
                  {
                      "IndexName":"gsi5pk-gsi5sk-index",
                      "KeySchema":[
                          {
                              "AttributeName":"gsi5pk",
                              "KeyType":"HASH"
                          },
                          {
                              "AttributeName":"gsi5sk",
                              "KeyType":"RANGE"
                          }
                      ],
                      "Projection":{
                          "ProjectionType":"ALL"
                      },
                      "ProvisionedThroughput": {       // Only specified if using provisioned mode
                        "ReadCapacityUnits": 1,
                        "WriteCapacityUnits": 1
                      },
                  }
              ],
              "ProvisionedThroughput": {       // Only specified if using provisioned mode
                "ReadCapacityUnits": 1,
                "WriteCapacityUnits": 1
              },
              TableName: tableName,
              BillingMode: ''
            }));
        }
    }
}
async function initializeTable() {
  const tableManager = createTableManager(table);
  const exists = await tableManager.exists();
  if (!exists) {
    await tableManager.create();
  }
}



function createService(client: DynamoDBClient | DocumentClient) {
  const ClientEntity = new Entity(
    {
      model: {
        version: "1",
        entity: "Client",
        service: "app"
      },
      attributes: {
        clientId: {
          type: "string",
          readOnly: true,
          //default: () => uuidv4()
        },
        practitionerId: {
          type: "string",
          required: true,
          readOnly: true
        },
        // and more various attributes
        createdAt: {
          type: "number",
          readOnly: true,
          set: () => Date.now()
        },
        updatedAt: {
          type: "number",
          readOnly: true,
          watch: "*",
          set: () => Date.now()
        }
      },
      indexes: {
        primary: {
          collection: "bookings",
          pk: {
            field: "pk",
            composite: ["practitionerId"]
          },
          sk: {
            field: "sk",
            composite: ["clientId"]
          }
        },
        byPractitioner: {
          collection: "contacts",
          index: "gsi1pk-gsi1sk-index",
          pk: {
            field: "gsi1pk",
            composite: ["practitionerId"]
          },
          sk: {
            field: "gsi1sk",
            composite: ["createdAt"]
          }
        },
        byClient: {
          index: "gsi2pk-gsi2sk-index",
          pk: {
            field: "gsi2pk",
            composite: ["clientId"]
          },
          sk: {
            field: "gsi2sk",
            composite: ["createdAt"]
          }
        }
      }
    },
    {table}
  );

  const SessionEntity = new Entity(
    {
      model: {
        version: "1",
        entity: "Session",
        service: "app"
      },
      attributes: {
        sessionId: {
          type: "string",
          readOnly: true,
          //default: () => uuidv4()
        },
        practitionerId: {
          type: "string",
          required: true,
          readOnly: true
        },
        clientId: {
          type: "string",
          required: true,
          readOnly: true
        },
      
        createdAt: {
          type: "number",
          readOnly: true,
          set: () => Date.now()
        },
        updatedAt: {
          type: "number",
          readOnly: true,
          watch: "*",
          set: () => Date.now()
        }
      },
      indexes: {
        primary: {
          collection: "bookings",
          pk: {
            field: "pk",
            composite: ["practitionerId"]
          },
          sk: {
            field: "sk",
            composite: ["clientId", "sessionId"]
          }
        },
        byClient: {
          index: "gsi2pk-gsi2sk-index",
          pk: {
            field: "gsi2pk",
            composite: ["clientId"]
          },
          sk: {
            field: "gsi2sk",
            composite: ["createdAt"]
          }
        }
      }
    },
    {table, client}
  );

  return new Service(
    {
      client: ClientEntity,
      session: SessionEntity
    },
    {table, client}
  );
}

const run = async () => {
  try {
    const clients = [
      v2Client,
      v3Client,
    ];

    for (const client of clients) {
      const service = createService(client);
      // does not throw
      const results = await service.collections
      .bookings({
        practitionerId: "123"
      })
      .go()	

      console.log('successfully retrieved results %o', results);
    }

  } catch(err) {
    console.log('err %o', err);
  }
};


initializeTable().then(run).catch(console.log);

tsconfig.json

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig to read more about this file */

    /* Projects */
    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

    /* Modules */
    "module": "commonjs",                                /* Specify what module code is generated. */
    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
    // "resolveJsonModule": true,                        /* Enable importing .json files. */
    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

    /* Emit */
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
    // "removeComments": true,                           /* Disable emitting comments. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */

    /* Type Checking */
    "strict": true,                                      /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

    /* Completeness */
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
}