Merge pull request #2529 from kuzzleio/feature/expose-store-repository

Author: fmauNeko

.eslintc-ts.json

@@ -1,13 +1,14 @@
 {
-  "plugins": [
-    "kuzzle"
-  ],
-  "extends": [
-    "plugin:kuzzle/default",
-    "plugin:kuzzle/node"
-  ],
+  "plugins": ["kuzzle"],
+  "extends": ["plugin:kuzzle/default", "plugin:kuzzle/node"],
   "rules": {
     "sort-keys": "warn",
     "kuzzle/array-foreach": "warn"
-  }
-}
+  },
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": ["plugin:kuzzle/typescript"]
+    }
+  ]
+}

.eslintrc.json

@@ -1,21 +1,29 @@
-export * from './lib/core/backend';
+export * from "./lib/core/backend";
 
-export * from './lib/types';
+export * from "./lib/types";
 
-export * from './lib/core/plugin/pluginContext';
+export * from "./lib/core/plugin/pluginContext";
 
-export * from './lib/core/shared/sdk/embeddedSdk';
+export * from "./lib/core/shared/sdk/embeddedSdk";
 
-export * from './lib/api/request';
+export * from "./lib/api/request";
 
-export * from './lib/kerror/errors';
+export * from "./lib/kerror/errors";
 
-export * from './lib/util/mutex';
+export * from "./lib/util/mutex";
 
-export * from './lib/util/Inflector';
+export * from "./lib/util/Inflector";
 
-export { NameGenerator } from './lib/util/name-generator';
+export { NameGenerator } from "./lib/util/name-generator";
 
-export * from 'kuzzle-sdk';
+export * from "kuzzle-sdk";
 
-export * from './lib/core/shared/KoncordeWrapper';
+export * from "./lib/core/shared/KoncordeWrapper";
+
+export * from "./lib/core/shared/ObjectRepository";
+
+export * from "./lib/core/shared/store";
+
+export * from "./lib/core/cache/cacheDbEnum";
+
+export * from "./lib/core/storage/storeScopeEnum";

index.ts

@@ -19,22 +19,12 @@
  * limitations under the License.
  */
 
-"use strict";
-
-/**
- * @typedef {string} cacheDbEnum
- */
-
 /**
  * Enum for the cache engine target (used by classes using either the
  * internal or the public DB)
- * @readOnly
- * @enum {cacheDbEnum}
  */
-const cacheDbEnum = Object.freeze({
-  INTERNAL: "internal",
-  NONE: "none",
-  PUBLIC: "public",
-});
-
-module.exports = cacheDbEnum;
+export enum cacheDbEnum {
+  INTERNAL = "internal",
+  NONE = "none",
+  PUBLIC = "public",
+}

lib/core/cache/cacheDbEnum.js lib/core/cache/cacheDbEnum.ts

@@ -19,27 +19,25 @@
  * limitations under the License.
  */
 
-import Bluebird from "bluebird";
-import { Koncorde } from "../shared/KoncordeWrapper";
 import { Client } from "@elastic/elasticsearch";
+import Bluebird from "bluebird";
 import { JSONObject } from "kuzzle-sdk";
+import { Koncorde } from "../shared/KoncordeWrapper";
 
-import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
-import PluginRepository from "./pluginRepository";
-import Store from "../shared/store";
-import Elasticsearch from "../../service/storage/elasticsearch";
-import { isPlainObject } from "../../util/safeObject";
-import Promback from "../../util/promback";
-import { Mutex } from "../../util/mutex";
+import {
+  KuzzleRequest,
+  Request,
+  RequestContext,
+  RequestInput,
+} from "../../../index";
 import * as kerror from "../../kerror";
-import storeScopeEnum from "../storage/storeScopeEnum";
 import {
   BadRequestError,
   ExternalServiceError,
   ForbiddenError,
   GatewayTimeoutError,
-  InternalError as KuzzleInternalError,
   KuzzleError,
+  InternalError as KuzzleInternalError,
   NotFoundError,
   PartialError,
   PluginImplementationError,
@@ -49,13 +47,15 @@ import {
   TooManyRequestsError,
   UnauthorizedError,
 } from "../../kerror/errors";
-import {
-  RequestContext,
-  RequestInput,
-  KuzzleRequest,
-  Request,
-} from "../../../index";
+import Elasticsearch from "../../service/storage/elasticsearch";
+import { Mutex } from "../../util/mutex";
+import Promback from "../../util/promback";
+import { isPlainObject } from "../../util/safeObject";
 import { BackendCluster } from "../backend";
+import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
+import { Store } from "../shared/store";
+import { storeScopeEnum } from "../storage/storeScopeEnum";
+import PluginRepository from "./pluginRepository";
 
 const contextError = kerror.wrap("plugin", "context");
 

lib/core/plugin/pluginContext.ts

@@ -24,10 +24,10 @@
 const { merge } = require("lodash");
 
 const { NotFoundError } = require("../../kerror/errors");
-const { Repository } = require("../shared/repository");
-const cacheDbEnum = require("../cache/cacheDbEnum");
+const { ObjectRepository } = require("../shared/ObjectRepository");
+const { cacheDbEnum } = require("../cache/cacheDbEnum");
 
-class PluginRepository extends Repository {
+class PluginRepository extends ObjectRepository {
   constructor(store, collection) {
     super({ cache: cacheDbEnum.NONE, store });
 

lib/core/plugin/pluginRepository.js

@@ -19,15 +19,15 @@
  * limitations under the License.
  */
 
-import { omit } from "lodash";
 import Bluebird from "bluebird";
+import { omit } from "lodash";
 
-import { Profile } from "../../model/security/profile";
-import { Repository } from "../shared/repository";
-import * as kerror from "../../kerror";
-import cacheDbEnum from "../cache/cacheDbEnum";
 import { JSONObject } from "kuzzle-sdk";
-import { Policy, OptimizedPolicy } from "../../../index";
+import { OptimizedPolicy, Policy } from "../../../index";
+import * as kerror from "../../kerror";
+import { Profile } from "../../model/security/profile";
+import { cacheDbEnum } from "../cache/cacheDbEnum";
+import { ObjectRepository } from "../shared/ObjectRepository";
 
 /** @internal */
 type CreateOrReplaceOptions = {
@@ -55,9 +55,9 @@ type UpdateOptions = {
 
 /**
  * @class ProfileRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-export class ProfileRepository extends Repository<Profile> {
+export class ProfileRepository extends ObjectRepository<Profile> {
   private module: any;
   private profiles: Map<string, Profile>;
 

lib/core/security/profileRepository.ts

@@ -25,18 +25,18 @@ const Bluebird = require("bluebird");
 
 const kuzzleStateEnum = require("../../kuzzle/kuzzleStateEnum");
 const { Role } = require("../../model/security/role");
-const { Repository } = require("../shared/repository");
+const { ObjectRepository } = require("../shared/ObjectRepository");
 const kerror = require("../../kerror");
 const didYouMean = require("../../util/didYouMean");
-const cacheDbEnum = require("../cache/cacheDbEnum");
+const { cacheDbEnum } = require("../cache/cacheDbEnum");
 
 const roleRightsError = kerror.wrap("security", "role");
 
 /**
  * @class RoleRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-class RoleRepository extends Repository {
+class RoleRepository extends ObjectRepository {
   /**
    * @constructor
    * @param {SecurityModule} securityModule

lib/core/security/roleRepository.js

@@ -19,26 +19,26 @@
  * limitations under the License.
  */
 
-import _ from "lodash";
 import jwt from "jsonwebtoken";
-import ms from "ms";
 import { JSONObject } from "kuzzle-sdk";
+import _ from "lodash";
+import ms from "ms";
 
-import ApiKey from "../../model/storage/apiKey";
+import * as kerror from "../../kerror";
 import { UnauthorizedError } from "../../kerror/errors";
 import { Token } from "../../model/security/token";
-import * as kerror from "../../kerror";
+import { User } from "../../model/security/user";
+import ApiKey from "../../model/storage/apiKey";
 import debugFactory from "../../util/debug";
 import { Mutex } from "../../util/mutex";
-import { Repository } from "../shared/repository";
-import { User } from "../../model/security/user";
+import { ObjectRepository } from "../shared/ObjectRepository";
 
 const securityError = kerror.wrap("security", "token");
 const debug = debugFactory("kuzzle:bootstrap:tokens");
 
 const BOOTSTRAP_DONE_KEY = "token/bootstrap";
 
-export class TokenRepository extends Repository<Token> {
+export class TokenRepository extends ObjectRepository<Token> {
   private tokenGracePeriod: number;
   private anonymousToken: Token;
 

lib/core/security/tokenRepository.ts

@@ -23,16 +23,16 @@
 
 const { Request } = require("../../api/request");
 const debug = require("../../util/debug")("kuzzle:core:security:users");
-const { Repository } = require("../shared/repository");
+const { ObjectRepository } = require("../shared/ObjectRepository");
 const kerror = require("../../kerror");
 const { User } = require("../../model/security/user");
 const ApiKey = require("../../model/storage/apiKey");
 
 /**
  * @class UserRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-class UserRepository extends Repository {
+class UserRepository extends ObjectRepository {
   /**
    * @param {SecurityModule} securityModule
    * @constructor

lib/core/security/userRepository.js

@@ -19,17 +19,17 @@
  * limitations under the License.
  */
 
-import cacheDbEnum from "../cache/cacheDbEnum";
-import * as kerror from "../../kerror";
 import { JSONObject } from "kuzzle-sdk";
+import * as kerror from "../../kerror";
+import { cacheDbEnum } from "../cache/cacheDbEnum";
 
-export class Repository<TObject extends { _id: string }> {
+export class ObjectRepository<TObject extends { _id: string }> {
   protected ttl: number;
   protected index: string;
   protected collection: string;
   protected ObjectConstructor: any;
   protected store: any;
-  protected cacheDb: any;
+  protected cacheDb: cacheDbEnum;
 
   constructor({ cache = cacheDbEnum.INTERNAL, store = null } = {}) {
     this.ttl = global.kuzzle.config.repositories.common.cacheTTL;
@@ -142,7 +142,7 @@ export class Repository<TObject extends { _id: string }> {
         return null;
       }
 
-      return await this.fromDTO(Object.assign({}, JSON.parse(response)));
+      return await this.fromDTO({ ...JSON.parse(response) });
     } catch (err) {
       throw kerror.get("services", "cache", "read_failed", err.message);
     }
@@ -256,7 +256,7 @@ export class Repository<TObject extends { _id: string }> {
   ): Promise<TObject> {
     const key = options.key || this.getCacheKey(object._id);
     const value = JSON.stringify(this.serializeToCache(object));
-    const ttl = options.ttl !== undefined ? options.ttl : this.ttl;
+    const ttl = options.ttl ?? this.ttl;
 
     await global.kuzzle.ask(`core:cache:${this.cacheDb}:store`, key, value, {
       ttl,
@@ -359,7 +359,7 @@ export class Repository<TObject extends { _id: string }> {
    * @returns {object}
    */
   toDTO(o: TObject): any {
-    return Object.assign({}, o);
+    return { ...o };
   }
 
   /**