fix(types): moved all types to separated folder for better maintainability of the client

index.ts

@@ -1,8 +1,4 @@
+export { ConstraintType, EntityType } from './src/enums';
+
 export { default as Graph } from './src/graph';
-export { ConstraintType, EntityType } from './src/graph';
 export { default as FalkorDB } from './src/falkordb';
-
-
-
-
-

src/clients/client.ts

@@ -1,9 +1,7 @@
 import { RedisCommandArgument } from "@redis/client/dist/lib/commands";
-import { QueryOptions } from "../commands";
-import { ConstraintType, EntityType } from "../graph";
 import FalkorDB from "../falkordb";
-import { SingleGraphConnection } from "./single";
-import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { ConstraintType, EntityType } from "../enums";
+import { MemoryUsageOptions, MemoryUsageReply, QueryOptions, SingleGraphConnection } from "../types";
 
 // A generic client interface for Redis clients
 export interface Client {

src/clients/cluster.ts

@@ -1,22 +1,24 @@
 import { Client } from "./client";
-import { ConstraintType, EntityType } from "../graph";
+
 import {
   RedisCommandArgument,
   RedisFunctions,
   RedisScripts,
 } from "@redis/client/dist/lib/commands";
-import commands, { QueryOptions } from "../commands";
-import { createCluster, RedisClusterType } from "@redis/client";
-import FalkorDB, { TypedRedisClusterClientOptions } from "../falkordb";
-import { SingleGraphConnection } from "./single";
+import commands from "../commands";
+import { createCluster } from "@redis/client";
+import FalkorDB from "../falkordb";
 import { RedisClusterClientOptions } from "@redis/client/dist/lib/cluster";
 import * as lodash from "lodash";
-import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
-export type ClusterGraphConnection = RedisClusterType<
-  { falkordb: typeof commands },
-  RedisFunctions,
-  RedisScripts
->;
+import {
+  ClusterGraphConnection,
+  MemoryUsageOptions,
+  MemoryUsageReply,
+  QueryOptions,
+  SingleGraphConnection,
+  TypedRedisClusterClientOptions
+} from "../types";
+import { ConstraintType, EntityType } from "../enums";
 
 /**
  * A client that connects to a Redis Cluster.

src/clients/nullClient.ts

@@ -1,10 +1,8 @@
 import { RedisCommandArgument } from "@redis/client/dist/lib/commands";
-import { QueryOptions } from "../commands";
 import FalkorDB from "../falkordb";
-import { ConstraintType, EntityType } from "../graph";
 import { Client } from "./client";
-import { SingleGraphConnection } from "./single";
-import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { ConstraintType, EntityType } from "../enums";
+import { MemoryUsageOptions, MemoryUsageReply, QueryOptions, SingleGraphConnection } from "../types";
 
 /**
  * The `NullClient` class is a placeholder implementation of the `Client` interface.

src/clients/sentinel.ts

@@ -1,8 +1,9 @@
 import * as tls from "tls";
-import { Single, SingleGraphConnection } from "./single";
-import FalkorDB, { TypedRedisClientOptions } from "../falkordb";
+import { Single } from "./single";
+import FalkorDB from "../falkordb";
 import { createClient, RedisFunctions, RedisScripts } from "@redis/client";
 import commands from "../commands";
+import { SingleGraphConnection, TypedRedisClientOptions } from "../types";
 
 function extractDetails(masters: Array<Array<string>>) {
   const allDetails: Record<string, string>[] = [];

src/clients/single.ts

@@ -1,20 +1,10 @@
 import { Client } from "./client";
-import { ConstraintType, EntityType } from "../graph";
 import {
   RedisCommandArgument,
-  RedisFunctions,
-  RedisScripts,
 } from "@redis/client/dist/lib/commands";
-import commands, { QueryOptions } from "../commands";
-import { RedisClientType } from "@redis/client";
 import FalkorDB from "../falkordb";
-import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
-
-export type SingleGraphConnection = RedisClientType<
-  { falkordb: typeof commands },
-  RedisFunctions,
-  RedisScripts
->;
+import { ConstraintType, EntityType } from "../enums";
+import { MemoryUsageOptions, MemoryUsageReply, QueryOptions, SingleGraphConnection } from "../types";
 
 export class Single implements Client {
   protected client: SingleGraphConnection;

src/commands/CONFIG_GET.ts

@@ -1,12 +1,9 @@
+import { ConfigItem } from "../types";
+
 export const IS_READ_ONLY = true;
 
 export function transformArguments(configKey: string): Array<string> {
     return ['GRAPH.CONFIG', 'GET', configKey];
 }
 
-type ConfigItem = [
-    configKey: string,
-    value: number
-];
-
 export declare function transformReply(): ConfigItem | Array<ConfigItem>;

src/commands/CONSTRAINT_CREATE.ts

@@ -1,13 +1,4 @@
-
-export enum ConstraintType {
-    MANDATORY = "MANDATORY",
-    UNIQUE = "UNIQUE" 
-}
-
-export enum EntityType {
-    NODE = "NODE",
-    RELATIONSHIP = "RELATIONSHIP"
-}
+import { ConstraintType, EntityType } from "../enums";
 
 // GRAPH.CONSTRAINT CREATE key constraintType {NODE label | RELATIONSHIP reltype} PROPERTIES propCount prop [prop...]
 export function transformArguments(

src/commands/CONSTRAINT_DROP.ts

@@ -1,4 +1,4 @@
-import { ConstraintType, EntityType } from "./CONSTRAINT_CREATE";
+import { ConstraintType, EntityType } from "../enums";
 
 // GRAPH.CONSTRAINT DROP key constraintType {NODE label | RELATIONSHIP reltype} PROPERTIES propCount prop [prop...]
 export function transformArguments(

src/commands/MEMORY_USAGE.ts

@@ -1,6 +1,4 @@
-export interface MemoryUsageOptions {
-  SAMPLES?: number 
-}
+import { MemoryUsageOptions, MemoryUsageReply } from "../types";
 
 export function transformArguments(
   key: string,
@@ -10,6 +8,4 @@ export function transformArguments(
   return options?.SAMPLES ? [...args, String(options.SAMPLES)] : [...args];
 }
 
-export type MemoryUsageReply = Array<string | number | MemoryUsageReply>;
-
 export declare function transformReply(): MemoryUsageReply;

src/commands/QUERY.ts

@@ -1,5 +1,6 @@
 import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
-import { pushQueryArguments, QueryOptionsBackwardCompatible } from '.';
+import { pushQueryArguments } from '.';
+import { QueryOptionsBackwardCompatible, QueryRawReply, QueryReply } from '../types';
 
 export const FIRST_KEY_INDEX = 1;
 
@@ -18,30 +19,6 @@ export function transformArguments(
     );
 }
 
-type Headers = Array<string>;
-
-type Data = Array<string | number | null | Data>;
-
-type Metadata = Array<string>;
-
-type QueryRawReply = [
-    headers: Headers,
-    data: Data,
-    metadata: Metadata
-] | [
-    metadata: Metadata
-];
-
-export type QueryReply = {
-    headers: undefined;
-    data: undefined;
-    metadata: Metadata;
-} | {
-    headers: Headers;
-    data: Data;
-    metadata: Metadata;
-};
-
 export function transformReply(reply: QueryRawReply): QueryReply {
     return reply.length === 1 ? {
         headers: undefined,

src/commands/SLOWLOG.ts

@@ -1,3 +1,5 @@
+import { SlowLogRawReply, SlowLogReply } from "../types";
+
 export const IS_READ_ONLY = true;
 
 export const FIRST_KEY_INDEX = 1;
@@ -6,20 +8,6 @@ export function transformArguments(key: string) {
     return ['GRAPH.SLOWLOG', key];
 }
 
-type SlowLogRawReply = Array<[
-    timestamp: string,
-    command: string,
-    query: string,
-    took: string
-]>;
-
-type SlowLogReply = Array<{
-    timestamp: Date;
-    command: string;
-    query: string;
-    took: number;
-}>;
-
 export function transformReply(logs: SlowLogRawReply): SlowLogReply {
     return logs.map(([timestamp, command, query, took]) => ({
         timestamp: new Date(Number(timestamp) * 1000),

src/commands/index.ts

@@ -16,6 +16,7 @@ import * as SENTINEL_MASTERS from './SENTINEL_MASTERS';
 import * as MEMORY_USAGE from './MEMORY_USAGE';
 
 import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
+import { QueryOptionsBackwardCompatible, QueryParam, QueryParams } from '../types';
 
 export default {
     CONFIG_GET,
@@ -52,19 +53,6 @@ export default {
     memoryUsage: MEMORY_USAGE,
 };
 
-type QueryParam = null | string | number | boolean | QueryParams | Array<QueryParam>;
-
-type QueryParams = {
-    [key: string]: QueryParam;
-};
-
-export interface QueryOptions {
-    params?: QueryParams;
-    TIMEOUT?: number;
-}
-
-export type QueryOptionsBackwardCompatible = QueryOptions | number;
-
 export function pushQueryArguments(
     args: RedisCommandArguments,
     graph: RedisCommandArgument,

src/enums/constraint-type.ts

@@ -0,0 +1,5 @@
+export enum ConstraintType {
+    MANDATORY = "MANDATORY",
+    UNIQUE = "UNIQUE" 
+}
+

src/enums/entity-type.ts

@@ -0,0 +1,4 @@
+export enum EntityType {
+    NODE = "NODE",
+    RELATIONSHIP = "RELATIONSHIP"
+}

src/enums/graph-value-types.ts

@@ -0,0 +1,20 @@
+// https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h#L20
+export enum GraphValueTypes {
+  UNKNOWN = 0,
+  NULL = 1,
+  STRING = 2,
+  INTEGER = 3,
+  BOOLEAN = 4,
+  DOUBLE = 5,
+  ARRAY = 6,
+  EDGE = 7,
+  NODE = 8,
+  PATH = 9,
+  MAP = 10,
+  POINT = 11,
+  VECTORF32 = 12,
+  DATETIME = 13,
+  DATE = 14,
+  TIME = 15,
+  DURATION = 16,
+}

src/enums/index.ts

@@ -0,0 +1,3 @@
+export * from './graph-value-types'
+export * from './entity-type'
+export * from './constraint-type'