Merge pull request #707 from dolsem/master

Index decorators

Author: RobinBuschmann

README.md

@@ -73,6 +73,9 @@ export * from './model/shared/model-class-getter';
 export * from './model/shared/model-service';
 export * from './model/table/table';
 export * from './model/table/table-options';
+export * from './model/index/create-index-decorator';
+export * from './model/index/index-decorator';
+export * from './model/index/index-service';
 
 export * from './scopes/default-scope';
 export * from './scopes/scope-options';

src/index.ts

@@ -0,0 +1,25 @@
+import {addFieldToIndex, IndexOptions, IndexFieldOptions} from './index-service';
+
+interface IndexDecorator {
+  (fieldOptions: Pick<IndexFieldOptions, Exclude<keyof IndexFieldOptions, 'name'>>): Function;
+  (target: any, propertyName: string, propertyDescriptor?: PropertyDescriptor): void;
+}
+
+export function createIndexDecorator(options: IndexOptions = {}): IndexDecorator {
+  let indexId: string | number;
+  return ((...args: any[]) => {
+    if (args.length >= 2) {
+
+      const [target, propertyName] = args;
+
+      const fieldOptions = { name: propertyName };
+      indexId = addFieldToIndex(target, fieldOptions, options, indexId);
+      return;
+    }
+
+    return (target: any, propertyName: string) => {
+      const fieldOptions = { name: propertyName, ...args[0] };
+      indexId = addFieldToIndex(target, fieldOptions, options, indexId);
+    };
+  }) as IndexDecorator;
+}

src/model/index/create-index-decorator.ts

@@ -0,0 +1,46 @@
+import {addFieldToIndex, IndexOptions, IndexFieldOptions} from './index-service';
+
+type IndexDecoratorOptions =
+  IndexOptions & Pick<IndexFieldOptions, Exclude<keyof IndexFieldOptions, 'name'>>;
+
+export function Index(name: string): Function;
+export function Index(options: IndexDecoratorOptions): Function;
+export function Index(target: any, propertyName: string, propertyDescriptor?: PropertyDescriptor): void;
+export function Index(...args: any[]): Function | void {
+
+  if (args.length >= 2) {
+
+    const [target, propertyName] = args;
+
+    annotateModelWithIndex(target, propertyName);
+    return;
+  }
+
+  return (target: any, propertyName: string) => {
+    annotateModelWithIndex(target, propertyName, args[0]);
+  };
+}
+
+export function annotateModelWithIndex(target: any,
+                                       propertyName: string,
+                                       optionsOrName: IndexDecoratorOptions | string = {},
+                                       indexId?: string | number): string | number {
+
+  let indexOptions: IndexOptions;
+  let fieldOptions: IndexFieldOptions;
+  if (typeof optionsOrName === 'string') {
+    indexOptions = { name: optionsOrName };
+    fieldOptions = { name: propertyName };
+  } else {
+    const { length, order, collate, ...rest } = optionsOrName;
+    indexOptions = rest;
+    fieldOptions = {
+      name: propertyName,
+      length,
+      order,
+      collate,
+    };
+  }
+
+  return addFieldToIndex(target, fieldOptions, indexOptions, indexId);
+}

src/model/index/index-decorator.ts

@@ -0,0 +1,64 @@
+import 'reflect-metadata';
+import {IndexesOptions as SequelizeIndexOptions} from 'sequelize';
+
+const INDEXES_KEY = 'sequelize:indexes';
+
+// https://github.com/sequelize/sequelize/blob/beeff96f/types/lib/query-interface.d.ts#L169
+export interface IndexFieldOptions {
+  name: string;
+  length?: number;
+  order?: 'ASC' | 'DESC';
+  collate?: string;
+}
+
+export interface IndexesMeta {
+  named: { [name: string]: IndexOptions };
+  unnamed: IndexOptions[];
+}
+
+export type IndexOptions = Pick<SequelizeIndexOptions, Exclude<keyof SequelizeIndexOptions, 'fields'>>;
+
+/**
+ * Returns model indexes from class by restoring this
+ * information from reflect metadata
+ */
+export function getIndexes(target: any): IndexesMeta {
+  const { named = {}, unnamed = [] }: IndexesMeta =
+    Reflect.getMetadata(INDEXES_KEY, target) || {};
+
+  return { named: {...named}, unnamed: [...unnamed] };
+}
+
+/**
+ * Sets indexes
+ */
+export function setIndexes(target: any, indexes: IndexesMeta): void {
+  Reflect.defineMetadata(INDEXES_KEY, indexes, target);
+}
+
+/**
+ * Adds field to index by sequelize index and index field options,
+ * and stores this information through reflect metadata. Returns index ID.
+ */
+export function addFieldToIndex(target: any,
+                                fieldOptions: IndexFieldOptions,
+                                indexOptions: IndexOptions,
+                                indexId?: string | number): string | number {
+  const indexes = getIndexes(target);
+
+  const chosenId = typeof indexId !== 'undefined'
+    ? indexId
+    : indexOptions.name || indexes.unnamed.length;
+  const indexStore = typeof chosenId === 'string'
+    ? indexes.named
+    : indexes.unnamed;
+  if (!indexStore[chosenId]) indexStore[chosenId] = {...indexOptions};
+
+  const index = indexStore[chosenId];
+  if (!index.fields) index.fields = [];
+  index.fields.push(fieldOptions);
+
+  setIndexes(target, indexes);
+
+  return chosenId;
+}

src/model/index/index-service.ts

@@ -8,6 +8,7 @@ import {resolveScopes} from "../../scopes/scope-service";
 import {installHooks} from "../../hooks/shared/hooks-service";
 import {getAssociations} from "../../associations/shared/association-service";
 import {getAttributes} from "../../model/column/attribute-service";
+import {getIndexes} from "../../model/index/index-service";
 import {Repository} from "../..";
 
 export class Sequelize extends OriginSequelize {
@@ -84,11 +85,16 @@ export class Sequelize extends OriginSequelize {
     return models.map(model => {
       const modelName = getModelName(model.prototype);
       const attributes = getAttributes(model.prototype);
+      const indexes = getIndexes(model.prototype);
       const modelOptions = getOptions(model.prototype);
 
       if (!modelOptions) throw new Error(`@Table annotation is missing on class "${model['name']}"`);
 
+      const indexArray = Object.keys(indexes.named)
+        .map(key => indexes.named[key])
+        .concat(indexes.unnamed);
       const initOptions: InitOptions & { modelName } = {
+        ...(indexArray.length > 0 && { indexes: indexArray }),
         ...modelOptions,
         modelName,
         sequelize: this,