feat(core): wip: initial attribute aliasing support

typedorm · May 20, 2021 · b6d05dc · b6d05dc
1 parent 33fe5cb
commit b6d05dc
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 34 deletions.
diff --git a/packages/common/private-api.ts b/packages/common/private-api.ts
@@ -2,3 +2,4 @@ export * from './src/metadata/metadata-manager';
 export * from './src/metadata/metadata-storage';
 export * from './src/logger/debug-logger';
 export * from './src/error';
+export * from './src/index-options';
diff --git a/packages/common/src/decorators/entity.decorator.ts b/packages/common/src/decorators/entity.decorator.ts
@@ -1,22 +1,24 @@
 import {MetadataManager} from '../metadata/metadata-manager';
 import {EntityRawMetadataOptions} from '../metadata/metadata-storage';
 
-export function Entity({
+type Constructor = {new (...args: any[]): {}};
+
+export function Entity<E>({
   table,
   primaryKey,
   indexes,
   name,
 }: Pick<
-  EntityRawMetadataOptions,
+  EntityRawMetadataOptions<E>,
   'name' | 'table' | 'indexes' | 'primaryKey'
->): ClassDecorator {
-  return target => {
+>) {
+  return function <E extends Constructor>(target: E) {
     const originalTarget = target;
 
     MetadataManager.metadataStorage.addRawEntity({
       name,
       table,
-      target,
+      target: target as any,
       primaryKey,
       indexes,
     });

diff --git a/packages/common/src/index-options.ts b/packages/common/src/index-options.ts
@@ -0,0 +1,41 @@
+import {INDEX_TYPE} from './enums';
+import {Replace} from './helpers/replace-type';
+
+export interface GSIIndexOptions {
+  type: INDEX_TYPE.GSI;
+  partitionKey: string;
+  sortKey: string;
+  /**
+   * DynamoDB only adds item to index if both Partition Key and Sort Key defined
+   * for any given GSI contains value
+   *
+   * Indexes missing sort key value will not be added to index.
+   */
+  isSparse?: boolean;
+}
+
+export interface LSIIndexOptions {
+  type: INDEX_TYPE.LSI;
+  sortKey: string;
+  isSparse?: boolean;
+}
+export type IndexOptions = GSIIndexOptions | LSIIndexOptions;
+
+type EntityAliasOrString<Entity> = string | {$alias: keyof Entity};
+
+export type IndexOptionsWithAlias<Entity> =
+  | Replace<
+      GSIIndexOptions,
+      'partitionKey' | 'sortKey',
+      {
+        partitionKey: EntityAliasOrString<Entity>;
+        sortKey: EntityAliasOrString<Entity>;
+      }
+    >
+  | Replace<
+      LSIIndexOptions,
+      'sortKey',
+      {
+        sortKey: string;
+      }
+    >;
diff --git a/packages/common/src/metadata/metadata-storage.ts b/packages/common/src/metadata/metadata-storage.ts
@@ -1,7 +1,8 @@
 import {AUTO_GENERATE_ATTRIBUTE_STRATEGY, EntityTarget} from '@typedorm/common';
-import {IndexOptions, Table} from '../table';
+import {Table} from '../table';
 import {AttributeOptionsUniqueType} from '../decorators/attribute.decorator';
 import {ScalarType} from '../helpers/scalar-type';
+import {IndexOptionsWithAlias} from '../index-options';
 
 export const IsAutoGenerateAttributeRawMetadataOptions = (
   attr: any
@@ -17,15 +18,15 @@ export type CompositePrimaryKey = {
   sortKey: string;
 };
 
-export type Indexes = {
-  [key: string]: IndexOptions;
+export type Indexes<Entity = any> = {
+  [key: string]: IndexOptionsWithAlias<Entity>;
 };
 
-export interface EntityRawMetadataOptions {
+export interface EntityRawMetadataOptions<Entity = any> {
   name: string;
-  target: EntityTarget<any>;
+  target: EntityTarget<Entity>;
   primaryKey: PrimaryKey;
-  indexes?: Indexes;
+  indexes?: Indexes<Entity>;
   table?: Table;
 }
 

diff --git a/packages/common/src/table.ts b/packages/common/src/table.ts
@@ -1,4 +1,4 @@
-import {INDEX_TYPE} from './enums';
+import {IndexOptions} from './index-options';
 import {CompositePrimaryKey} from './metadata/metadata-storage';
 
 export const IsCompositePrimaryKey = (
@@ -18,27 +18,6 @@ export interface TableOptions {
   };
 }
 
-export interface GSIIndexOptions {
-  type: INDEX_TYPE.GSI;
-  partitionKey: string;
-  sortKey: string;
-  /**
-   * DynamoDB only adds item to index if both Partition Key and Sort Key defined
-   * for any given GSI contains value
-   *
-   * Indexes missing sort key value will not be added to index.
-   */
-  isSparse?: boolean;
-}
-
-export interface LSIIndexOptions {
-  type: INDEX_TYPE.LSI;
-  sortKey: string;
-  isSparse?: boolean;
-}
-
-export type IndexOptions = GSIIndexOptions | LSIIndexOptions;
-
 export class Table {
   constructor(private options: TableOptions) {}
 

diff --git a/packages/core/src/classes/metadata/entity-metadata.ts b/packages/core/src/classes/metadata/entity-metadata.ts
@@ -135,6 +135,7 @@ export class EntityMetadata extends BaseMetadata {
 
       const currentIndex = indexes[key];
 
+      // FIXME: check for index type before trying to parse it.
       validateKey(currentIndex.sortKey, attributes);
       // validates and gets and fill set indexes interpolations of sort key
       const sortKeyInterpolations = getInterpolatedKeys(currentIndex.sortKey);

diff --git a/packages/core/src/classes/transformer/document-client-request-transformer.ts b/packages/core/src/classes/transformer/document-client-request-transformer.ts
@@ -1,13 +1,13 @@
 import {
   EntityTarget,
-  IndexOptions,
   INDEX_TYPE,
   QUERY_ORDER,
   Replace,
   RETURN_VALUES,
   Table,
   UpdateAttributes,
   TRANSFORM_TYPE,
+  IndexOptions,
 } from '@typedorm/common';
 import {DynamoDB} from 'aws-sdk';
 import {dropProp} from '../../helpers/drop-prop';