@static-suite/static-suite-data-server 0.0.8 → 0.0.9

package/src/lib/utils/module/__tests__/moduleHandler.test.ts

@@ -2,7 +2,7 @@
 /* eslint-disable global-require */
 import fs from 'fs';
 import path from 'path';
-import { logger } from '@lib/utils/logger';
+import { logger } from '../../logger';
 import { moduleManager } from '../moduleManager';
 
 // This works in conjunction with "__mocks__/clear-module.js"
@@ -12,6 +12,11 @@ const dummyModulePath = fs.realpathSync(
   path.resolve(path.join(__dirname, '../__mocks__/dummyModule.query.js')),
 );
 
+type DummyModule = {
+  dummyModule(): void;
+  dummyObject: { key: string };
+};
+
 beforeEach(() => {
   logger.error = jest.fn();
 });
@@ -20,7 +25,7 @@ describe('moduleHandler test', () => {
   describe('get', () => {
     describe('when a module exists', () => {
       it('gets a module without logging any error', () => {
-        const { dummyObject } = moduleManager.get(dummyModulePath);
+        const { dummyObject } = moduleManager.get<DummyModule>(dummyModulePath);
 
         expect(dummyObject.key).toBe('dummyModuleValue');
         expect(logger.error).not.toHaveBeenCalled();
@@ -28,11 +33,11 @@ describe('moduleHandler test', () => {
 
       it('gets a module twice without reloading it', () => {
         const { dummyObject: firstDummyObject } =
-          moduleManager.get(dummyModulePath);
+          moduleManager.get<DummyModule>(dummyModulePath);
         expect(firstDummyObject.key).toBe('dummyModuleValue');
         firstDummyObject.key = 'updatedDummyModuleValue';
         const { dummyObject: secondDummyObject } =
-          moduleManager.get(dummyModulePath);
+          moduleManager.get<DummyModule>(dummyModulePath);
         expect(secondDummyObject.key).toBe('updatedDummyModuleValue');
       });
     });
@@ -48,16 +53,17 @@ describe('moduleHandler test', () => {
   describe('load', () => {
     describe('when a module exists', () => {
       it('loads a module without logging any error', () => {
-        const { dummyObject } = moduleManager.load(dummyModulePath);
+        const { dummyObject } =
+          moduleManager.load<DummyModule>(dummyModulePath);
         expect(dummyObject.key).toBe('dummyModuleValue');
         expect(logger.error).not.toHaveBeenCalled();
       });
 
       it('loads a module twice reloading it from scratch', () => {
         const { dummyObject: firstDummyObject } =
-          moduleManager.load(dummyModulePath);
+          moduleManager.load<DummyModule>(dummyModulePath);
         const { dummyObject: secondDummyObject } =
-          moduleManager.load(dummyModulePath);
+          moduleManager.load<DummyModule>(dummyModulePath);
 
         firstDummyObject.key = 'updatedDummyModuleValue';
 
@@ -76,10 +82,10 @@ describe('moduleHandler test', () => {
   describe('remove', () => {
     it('removes a single module from Node.js cache', () => {
       const { dummyObject: firstDummyObject } =
-        moduleManager.get(dummyModulePath);
+        moduleManager.get<DummyModule>(dummyModulePath);
       moduleManager.remove(dummyModulePath);
       const { dummyObject: secondDummyObject } =
-        moduleManager.get(dummyModulePath);
+        moduleManager.get<DummyModule>(dummyModulePath);
       firstDummyObject.key = 'updatedDummyModuleValue';
       expect(firstDummyObject.key).toBe('updatedDummyModuleValue');
       expect(secondDummyObject.key).toBe('dummyModuleValue');
@@ -88,10 +94,12 @@ describe('moduleHandler test', () => {
 
   describe('removeAll', () => {
     it('removes several modules from Node.js cache', () => {
-      const { dummyObject: dummyObject1 } = moduleManager.get(dummyModulePath);
+      const { dummyObject: dummyObject1 } =
+        moduleManager.get<DummyModule>(dummyModulePath);
       dummyObject1.key = 'updatedDummyModuleValue';
       moduleManager.removeAll(/dummyModule/);
-      const { dummyObject: dummyObject2 } = moduleManager.get(dummyModulePath);
+      const { dummyObject: dummyObject2 } =
+        moduleManager.get<DummyModule>(dummyModulePath);
 
       expect(dummyObject1.key).toBe('updatedDummyModuleValue');
       expect(dummyObject2.key).toBe('dummyModuleValue');

package/src/lib/utils/module/dirBasedModuleGroupManager.ts

@@ -1,7 +1,7 @@
 import path from 'path';
-import { config } from '@lib/config';
-import { findFilesInDir } from '@lib/utils/fs';
-import { cache } from '@lib/utils/cache';
+import { config } from '../../config';
+import { findFilesInDir } from '../fs';
+import { cache } from '../cache';
 import { moduleManager } from './moduleManager';
 import { ModuleGroupManager, ModuleInfo } from './module.types';
 

package/src/lib/utils/module/moduleManager.ts

@@ -1,9 +1,9 @@
 /* eslint-disable global-require */
 /* eslint-disable import/no-dynamic-require */
 import clearModule from 'clear-module';
-import { logger } from '@lib/utils/logger';
-import { config } from '@lib/config';
-import { store } from '@lib/store';
+import { logger } from '../logger';
+import { config } from '../../config';
+import { store } from '../../store';
 
 /**
  * Internal module cache.

package/src/lib/utils/object/objectUtils.ts

@@ -18,7 +18,10 @@ export const isEmptyObject = (object: ObjectType): boolean =>
  *
  * @returns True if the object has the given key, false otherwise.
  */
-export const hasKey = <O>(object: O, key: PropertyKey): key is keyof O => {
+export const hasKey = <T extends object>(
+  object: T,
+  key: PropertyKey,
+): key is keyof T => {
   return key in object;
 };
 

package/src/lib/utils/string/__tests__/stringUtils.test.ts

@@ -1,4 +1,4 @@
-import { logger } from '@lib/utils/logger';
+import { logger } from '../../logger';
 import {
   isUniqueId,
   parseJsonString,
@@ -36,7 +36,9 @@ describe('String utils test', () => {
   describe('parseUniqueId', () => {
     it('parses a valid unique id and returns a date', () => {
       const uniqueIdDate = parseUniqueId('2022-09-28_11-42-00.001712__7220');
-      expect(uniqueIdDate?.getTime()).toEqual(1664365320001);
+      // Depending on the time of year (Daylight saving time or not), parsing
+      // a unique id returns a different date. This test checks both possible values.
+      expect([1664365320001, 1664361720001]).toContain(uniqueIdDate?.getTime());
     });
 
     it('parses a non valid unique id and returns null', () => {

package/src/lib/utils/string/stringUtils.ts

@@ -1,4 +1,4 @@
-import { logger } from '@lib/utils/logger';
+import { logger } from '../logger';
 import { URLSearchParamsObject } from './string.types';
 
 /**
@@ -87,7 +87,7 @@ export const parseUniqueId = (uniqueId: string): Date | null => {
 /**
  * Checks that a string is a unique id.
  *
- * @param uniqueId - A unique id t be checked
+ * @param uniqueId - A unique id to be checked
  */
 export const isUniqueId = (uniqueId: string): boolean =>
   /(\d{4})-(\d{2})-(\d{2})_(\d{2})-(\d{2})-(\d{2})\.(\d{3}).*/.test(uniqueId);

package/src/lib/watcher/watcher.ts

@@ -1,11 +1,11 @@
-import { config } from '@lib/config';
-import { dataDirManager } from '@lib/store/dataDir/dataDirManager';
-import { logger } from '@lib/utils/logger';
-import { cache } from '@lib/utils/cache';
-import { watch } from '@lib/utils/fs';
-import { hookManager } from '@lib/store/hook';
-import { queryManager } from '@lib/query';
-import { taskManager } from '@lib/task';
+import { config } from '../config';
+import { dataDirManager } from '../store/dataDir/dataDirManager';
+import { logger } from '../utils/logger';
+import { cache } from '../utils/cache';
+import { watch } from '../utils/fs';
+import { hookManager } from '../store/hook';
+import { queryManager } from '../query';
+import { taskManager } from '../task';
 
 /**
  * Initializes a watcher on any file inside queryDir, hookDir and taskDir.

package/tsconfig.json

@@ -51,10 +51,6 @@
     // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
     "baseUrl": "./src" /* Base directory to resolve non-absolute module names. */,
     "paths": {
-      "@bin/*": ["bin/*"],
-      "@http/*": ["http/*"],
-      "@lib/*": ["lib/*"],
-      "@__tests__/*": ["__tests__/*"]
     } /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */,
     // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                             /* List of folders to include type definitions from. */