@addev-be/ui 0.11.7 → 0.12.0

package/src/services/smartQueries.ts

@@ -0,0 +1,122 @@
+import { useWebSocketRequestHandler } from './hooks';
+
+export type FieldDTO<T extends string = string> = {
+  fieldName?: T;
+  fieldAlias?: string;
+  operator?:
+    | 'add'
+    | 'avg'
+    | 'concat'
+    | 'count'
+    | 'divide'
+    | 'groupConcat'
+    | 'if'
+    | 'ifNull'
+    | 'jsonObject'
+    | 'length'
+    | 'max'
+    | 'min'
+    | 'modulo'
+    | 'multiply'
+    | 'subtract'
+    | 'sum'
+    | 'trim';
+  operands?: FieldDTO[];
+  constantValue?: string | number | boolean | null;
+  groupBy?: boolean;
+};
+
+export type ConditionOperator =
+  | 'lessThan'
+  | 'lessThanOrEqual'
+  | 'lessThanOrEquals'
+  | 'equals'
+  | 'notEquals'
+  | 'greaterThanOrEqual'
+  | 'greaterThanOrEquals'
+  | 'greaterThan'
+  | 'like'
+  | 'contains'
+  | 'notContains'
+  | 'startsWith'
+  | 'endsWith'
+  | 'notLike'
+  | 'inRange'
+  | 'between'
+  | 'isNull'
+  | 'isNotNull'
+  | 'inArray'
+  | 'in'
+  | 'not'
+  | 'and'
+  | 'or';
+
+export type HavingDTO = {
+  operator: ConditionOperator;
+  value?:
+    | string
+    | number
+    | boolean
+    | null
+    | (string | number | boolean | null)[];
+};
+
+export type ConditionDTO = HavingDTO & {
+  field: string | FieldDTO;
+  children?: boolean;
+};
+
+export type OrderByDirection = 'ascending' | 'descending';
+
+export type FooterFunction = 'sum' | 'avg' | 'count' | 'max' | 'min';
+
+export type ColumnDTO = {
+  key: string;
+  field: FieldDTO;
+  having?: HavingDTO;
+  orderBy?: OrderByDirection;
+  groupBy?: boolean;
+  footer?: FooterFunction;
+};
+
+export type ColumnWithHavingDTO = ColumnDTO &
+  Required<Pick<ColumnDTO, 'having'>>;
+export type ColumnWithFooterDTO = ColumnDTO &
+  Required<Pick<ColumnDTO, 'footer'>>;
+
+export type QueryDTO = {
+  type: string;
+  columns?: ColumnDTO[];
+  filterColumn?: ColumnDTO;
+  where?: ConditionDTO[];
+  offset?: number;
+  limit?: number;
+  getCount?: boolean;
+  unique?: boolean;
+};
+
+export type RequestRow<R> = {
+  [K in keyof R]: R[K] extends string | number | null | undefined
+    ? R[K]
+    : string | number | null | undefined;
+};
+
+export type ResponseDTO<T = unknown> = {
+  data: RequestRow<T>[];
+  count?: number;
+  totals?: Record<string, string | number | null | undefined>;
+};
+
+export type RequestHandler<T> = (request: QueryDTO) => Promise<ResponseDTO<T>>;
+
+export const useSmartQueryHandler = <T = unknown>(
+  name: string
+): [
+  RequestHandler<T>,
+  RequestHandler<{ id: string }>,
+  RequestHandler<Partial<T>>
+] => [
+  useWebSocketRequestHandler<QueryDTO, ResponseDTO<T>>(name),
+  useWebSocketRequestHandler<QueryDTO, ResponseDTO<{ id: string }>>(name),
+  useWebSocketRequestHandler<QueryDTO, ResponseDTO<Partial<T>>>(name),
+];

package/src/services/sqlRequests.ts

@@ -1,111 +1,111 @@
-import { useWebSocketRequestHandler } from './hooks';
-
-export type FieldDTO<T extends string = string> = {
-  fieldName?: T;
-  fieldAlias?: string;
-  operator?:
-    | 'add'
-    | 'concat'
-    | 'divide'
-    | 'groupConcat'
-    | 'if'
-    | 'ifNull'
-    | 'jsonObject'
-    | 'length'
-    | 'modulo'
-    | 'multiply'
-    | 'subtract'
-    | 'sum'
-    | 'trim';
-  operands?: FieldDTO[];
-  constantValue?: string | number | boolean | null;
-  groupBy?: boolean;
-};
-
-export type ConditionDTO = {
-  field: string;
-  operator:
-    | 'lessThan'
-    | 'lessThanOrEqual'
-    | 'lessThanOrEquals'
-    | 'equals'
-    | 'notEquals'
-    | 'greaterThanOrEqual'
-    | 'greaterThanOrEquals'
-    | 'greaterThan'
-    | 'like'
-    | 'contains'
-    | 'notContains'
-    | 'startsWith'
-    | 'endsWith'
-    | 'notLike'
-    | 'inRange'
-    | 'between'
-    | 'isNull'
-    | 'isNotNull'
-    | 'inArray'
-    | 'in'
-    | 'not'
-    | 'and'
-    | 'or';
-  value?:
-    | string
-    | number
-    | boolean
-    | null
-    | (string | number | boolean | null)[];
-  children?: boolean;
-};
-
-export type OrderByDTO = {
-  field: string;
-  type: string;
-  direction?: 'ASC' | 'DESC';
-};
-
-export type SqlRequestFooterFunction = 'sum' | 'avg' | 'count' | 'max' | 'min';
-
-export type SqlRequestDTO = {
-  columns?: string[];
-  returnColumns?: string[];
-  columnTypes?: string[];
-  totalColumns?: Record<string, SqlRequestFooterFunction>;
-  conditions?: ConditionDTO[];
-  orderBy?: OrderByDTO[];
-  start?: number;
-  length?: number;
-  getCount?: boolean;
-  unique?: boolean;
-};
-
-export type SqlRequestRow<R> = {
-  [K in keyof R]: R[K] extends string | number | null | undefined
-    ? R[K]
-    : string | number | null | undefined;
-};
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type SqlResponseDTO<T = any> = {
-  data: SqlRequestRow<T>[];
-  count?: number;
-  totals?: Record<string, string | number | null | undefined>;
-};
-
-type SqlRequestHandler<T> = (
-  request: SqlRequestDTO
-) => Promise<SqlResponseDTO<T>>;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const useSqlRequestHandler = <T = any>(
-  name: string
-): [
-  SqlRequestHandler<T>,
-  SqlRequestHandler<{ Id: string }>,
-  SqlRequestHandler<Partial<T>>
-] => [
-  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<T>>(name),
-  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<{ Id: string }>>(
-    name
-  ),
-  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<Partial<T>>>(name),
-];
+import { useWebSocketRequestHandler } from './hooks';
+
+export type FieldDTO<T extends string = string> = {
+  fieldName?: T;
+  fieldAlias?: string;
+  operator?:
+    | 'add'
+    | 'concat'
+    | 'divide'
+    | 'groupConcat'
+    | 'if'
+    | 'ifNull'
+    | 'jsonObject'
+    | 'length'
+    | 'modulo'
+    | 'multiply'
+    | 'subtract'
+    | 'sum'
+    | 'trim';
+  operands?: FieldDTO[];
+  constantValue?: string | number | boolean | null;
+  groupBy?: boolean;
+};
+
+export type ConditionDTO = {
+  field: string;
+  operator:
+    | 'lessThan'
+    | 'lessThanOrEqual'
+    | 'lessThanOrEquals'
+    | 'equals'
+    | 'notEquals'
+    | 'greaterThanOrEqual'
+    | 'greaterThanOrEquals'
+    | 'greaterThan'
+    | 'like'
+    | 'contains'
+    | 'notContains'
+    | 'startsWith'
+    | 'endsWith'
+    | 'notLike'
+    | 'inRange'
+    | 'between'
+    | 'isNull'
+    | 'isNotNull'
+    | 'inArray'
+    | 'in'
+    | 'not'
+    | 'and'
+    | 'or';
+  value?:
+    | string
+    | number
+    | boolean
+    | null
+    | (string | number | boolean | null)[];
+  children?: boolean;
+};
+
+export type OrderByDTO = {
+  field: string;
+  type: string;
+  direction?: 'ASC' | 'DESC';
+};
+
+export type SqlRequestFooterFunction = 'sum' | 'avg' | 'count' | 'max' | 'min';
+
+export type SqlRequestDTO = {
+  columns?: string[];
+  returnColumns?: string[];
+  columnTypes?: string[];
+  totalColumns?: Record<string, SqlRequestFooterFunction>;
+  conditions?: ConditionDTO[];
+  orderBy?: OrderByDTO[];
+  start?: number;
+  length?: number;
+  getCount?: boolean;
+  unique?: boolean;
+};
+
+export type SqlRequestRow<R> = {
+  [K in keyof R]: R[K] extends string | number | null | undefined
+    ? R[K]
+    : string | number | null | undefined;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type SqlResponseDTO<T = any> = {
+  data: SqlRequestRow<T>[];
+  count?: number;
+  totals?: Record<string, string | number | null | undefined>;
+};
+
+type SqlRequestHandler<T> = (
+  request: SqlRequestDTO
+) => Promise<SqlResponseDTO<T>>;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const useSqlRequestHandler = <T = any>(
+  name: string
+): [
+  SqlRequestHandler<T>,
+  SqlRequestHandler<{ Id: string }>,
+  SqlRequestHandler<Partial<T>>
+] => [
+  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<T>>(name),
+  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<{ Id: string }>>(
+    name
+  ),
+  useWebSocketRequestHandler<SqlRequestDTO, SqlResponseDTO<Partial<T>>>(name),
+];

package/src/services/types/auth.ts

@@ -1,131 +1,131 @@
-import * as t from 'io-ts';
-
-import { userDtoCodec } from './users';
-
-export const loginRequestDtoCodec = t.type(
-  {
-    username: t.string,
-    password: t.string,
-  },
-  'LoginRequestDTO'
-);
-
-export const loginResponseDtoCodec = t.type(
-  {
-    status: t.number,
-    token: t.string,
-    user: t.union([userDtoCodec, t.null]),
-  },
-  'LoginResponseDTO'
-);
-
-export type LoginRequestDTO = t.TypeOf<typeof loginRequestDtoCodec>;
-export type LoginResponseDTO = t.TypeOf<typeof loginResponseDtoCodec>;
-
-/*****/
-
-export const logoutRequestDtoCodec = t.type({}, 'LogoutRequestDTO');
-
-export const logoutResponseDtoCodec = t.type(
-  {
-    status: t.number,
-  },
-  'LogoutResponseDTO'
-);
-
-export type LogoutRequestDTO = t.TypeOf<typeof logoutRequestDtoCodec>;
-export type LogoutResponseDTO = t.TypeOf<typeof logoutResponseDtoCodec>;
-
-/*****/
-
-export const authenticateRequestDtoCodec = t.type(
-  {
-    token: t.string,
-  },
-  'AuthenticateRequestDTO'
-);
-
-export const authenticateResponseDtoCodec = t.type(
-  {
-    status: t.number,
-    user: t.union([userDtoCodec, t.null]),
-  },
-  'AuthenticateResponseDTO'
-);
-
-export type AuthenticateRequestDTO = t.TypeOf<
-  typeof authenticateRequestDtoCodec
->;
-export type AuthenticateResponseDTO = t.TypeOf<
-  typeof authenticateResponseDtoCodec
->;
-
-/*****/
-
-export const sendRecoveryKeyRequestDtoCodec = t.type(
-  {
-    email: t.string,
-  },
-  'SendRecoveryKeyRequestDTO'
-);
-
-export const sendRecoveryKeyResponseDtoCodec = t.type(
-  {
-    status: t.number,
-  },
-  'SendRecoveryKeyResponseDTO'
-);
-
-export type SendRecoveryKeyRequestDTO = t.TypeOf<
-  typeof sendRecoveryKeyRequestDtoCodec
->;
-export type SendRecoveryKeyResponseDTO = t.TypeOf<
-  typeof sendRecoveryKeyResponseDtoCodec
->;
-
-/*****/
-
-export const checkRecoveryKeyRequestDtoCodec = t.type(
-  {
-    key: t.string,
-  },
-  'CheckRecoveryKeyRequestDTO'
-);
-
-export const checkRecoveryKeyResponseDtoCodec = t.type(
-  {
-    status: t.number,
-  },
-  'CheckRecoveryKeyResponseDTO'
-);
-
-export type CheckRecoveryKeyRequestDTO = t.TypeOf<
-  typeof checkRecoveryKeyRequestDtoCodec
->;
-export type CheckRecoveryKeyResponseDTO = t.TypeOf<
-  typeof checkRecoveryKeyResponseDtoCodec
->;
-
-/*****/
-
-export const resetPasswordRequestDtoCodec = t.type(
-  {
-    key: t.string,
-    password: t.string,
-  },
-  'ResetPasswordRequestDTO'
-);
-
-export const resetPasswordResponseDtoCodec = t.type(
-  {
-    status: t.number,
-  },
-  'ResetPasswordResponseDTO'
-);
-
-export type ResetPasswordRequestDTO = t.TypeOf<
-  typeof resetPasswordRequestDtoCodec
->;
-export type ResetPasswordResponseDTO = t.TypeOf<
-  typeof resetPasswordResponseDtoCodec
->;
+import * as t from 'io-ts';
+
+import { userDtoCodec } from './users';
+
+export const loginRequestDtoCodec = t.type(
+  {
+    username: t.string,
+    password: t.string,
+  },
+  'LoginRequestDTO'
+);
+
+export const loginResponseDtoCodec = t.type(
+  {
+    status: t.number,
+    token: t.string,
+    user: t.union([userDtoCodec, t.null]),
+  },
+  'LoginResponseDTO'
+);
+
+export type LoginRequestDTO = t.TypeOf<typeof loginRequestDtoCodec>;
+export type LoginResponseDTO = t.TypeOf<typeof loginResponseDtoCodec>;
+
+/*****/
+
+export const logoutRequestDtoCodec = t.type({}, 'LogoutRequestDTO');
+
+export const logoutResponseDtoCodec = t.type(
+  {
+    status: t.number,
+  },
+  'LogoutResponseDTO'
+);
+
+export type LogoutRequestDTO = t.TypeOf<typeof logoutRequestDtoCodec>;
+export type LogoutResponseDTO = t.TypeOf<typeof logoutResponseDtoCodec>;
+
+/*****/
+
+export const authenticateRequestDtoCodec = t.type(
+  {
+    token: t.string,
+  },
+  'AuthenticateRequestDTO'
+);
+
+export const authenticateResponseDtoCodec = t.type(
+  {
+    status: t.number,
+    user: t.union([userDtoCodec, t.null]),
+  },
+  'AuthenticateResponseDTO'
+);
+
+export type AuthenticateRequestDTO = t.TypeOf<
+  typeof authenticateRequestDtoCodec
+>;
+export type AuthenticateResponseDTO = t.TypeOf<
+  typeof authenticateResponseDtoCodec
+>;
+
+/*****/
+
+export const sendRecoveryKeyRequestDtoCodec = t.type(
+  {
+    email: t.string,
+  },
+  'SendRecoveryKeyRequestDTO'
+);
+
+export const sendRecoveryKeyResponseDtoCodec = t.type(
+  {
+    status: t.number,
+  },
+  'SendRecoveryKeyResponseDTO'
+);
+
+export type SendRecoveryKeyRequestDTO = t.TypeOf<
+  typeof sendRecoveryKeyRequestDtoCodec
+>;
+export type SendRecoveryKeyResponseDTO = t.TypeOf<
+  typeof sendRecoveryKeyResponseDtoCodec
+>;
+
+/*****/
+
+export const checkRecoveryKeyRequestDtoCodec = t.type(
+  {
+    key: t.string,
+  },
+  'CheckRecoveryKeyRequestDTO'
+);
+
+export const checkRecoveryKeyResponseDtoCodec = t.type(
+  {
+    status: t.number,
+  },
+  'CheckRecoveryKeyResponseDTO'
+);
+
+export type CheckRecoveryKeyRequestDTO = t.TypeOf<
+  typeof checkRecoveryKeyRequestDtoCodec
+>;
+export type CheckRecoveryKeyResponseDTO = t.TypeOf<
+  typeof checkRecoveryKeyResponseDtoCodec
+>;
+
+/*****/
+
+export const resetPasswordRequestDtoCodec = t.type(
+  {
+    key: t.string,
+    password: t.string,
+  },
+  'ResetPasswordRequestDTO'
+);
+
+export const resetPasswordResponseDtoCodec = t.type(
+  {
+    status: t.number,
+  },
+  'ResetPasswordResponseDTO'
+);
+
+export type ResetPasswordRequestDTO = t.TypeOf<
+  typeof resetPasswordRequestDtoCodec
+>;
+export type ResetPasswordResponseDTO = t.TypeOf<
+  typeof resetPasswordResponseDtoCodec
+>;

package/src/services/types/base.ts

@@ -1,10 +1,10 @@
-import * as t from 'io-ts';
-
-export const baseModelDtoCodec = t.type({
-  id: t.union([t.string, t.null]),
-});
-
-export type BaseModelDTO = t.TypeOf<typeof baseModelDtoCodec>;
-
-export const UUID_REGEX =
-  /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+import * as t from 'io-ts';
+
+export const baseModelDtoCodec = t.type({
+  id: t.union([t.string, t.null]),
+});
+
+export type BaseModelDTO = t.TypeOf<typeof baseModelDtoCodec>;
+
+export const UUID_REGEX =
+  /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i;