@things-factory/shell 6.2.84 → 6.2.96

package/dist-server/utils/get-times-for-period.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-times-for-period.js","sourceRoot":"","sources":["../../server/utils/get-times-for-period.ts"],"names":[],"mappings":";;;;AAAA,8EAAoC;AAE7B,KAAK,UAAU,iBAAiB,CACrC,MAAsE,EACtE,OAAY;IAEZ,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;IAChC,MAAM,OAAO,GAAG,yBAAM,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEtD,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACjD,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE5E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,YAAY,EAAE;QACjC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAEhF,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,SAAS,EAAE;QAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACrE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE5E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,WAAW,EAAE;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACjE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE9E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,WAAW,EAAE;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACxF,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAEhF,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;AACH,CAAC;AAjCD,8CAiCC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,MAAsE,EACtE,OAAY;IAEZ,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;IAChC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7D,OAAO;QACL,IAAI,EAAE,yBAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;QACpD,EAAE,EAAE,yBAAM,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;KACjD,CAAA;AACH,CAAC;AAXD,wDAWC","sourcesContent":["import moment from 'moment-timezone'\n\nexport async function getTimesForPeriod(\n  period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',\n  context: any\n): Promise<{ from: string; to: string }> {\n  const { domain } = context.state\n  const theDate = moment.tz(new Date(), domain.timezone)\n\n  if (period == 'today') {\n    const from = theDate.clone().format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == 'this month') {\n    const from = theDate.clone().startOf('month').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == '30 days') {\n    const from = theDate.clone().subtract(30, 'day').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == 'this year') {\n    const from = theDate.clone().startOf('year').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'year').startOf('year').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == '12 months') {\n    const from = theDate.clone().subtract(12, 'month').startOf('month').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')\n\n    return { from, to }\n  }\n}\n\nexport async function getISOStringsForPeriod(\n  period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',\n  context: any\n): Promise<{ from: string; to: string }> {\n  const { domain } = context.state\n  const { from, to } = await getTimesForPeriod(period, context)\n\n  return {\n    from: moment.tz(from, domain.timezone).toISOString(),\n    to: moment.tz(to, domain.timezone).toISOString()\n  }\n}\n"]}
+{"version":3,"file":"get-times-for-period.js","sourceRoot":"","sources":["../../server/utils/get-times-for-period.ts"],"names":[],"mappings":";;;;AAAA,8EAAoC;AAEpC;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAAC,MAAsE,EAAE,OAAY;IAC1H,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;IAChC,MAAM,OAAO,GAAG,yBAAM,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEtD,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACjD,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE5E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,YAAY,EAAE;QACjC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAEhF,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,SAAS,EAAE;QAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACrE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE5E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,WAAW,EAAE;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACjE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAE9E,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;SAAM,IAAI,MAAM,IAAI,WAAW,EAAE;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QACxF,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAEhF,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;KACpB;AACH,CAAC;AA9BD,8CA8BC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAC1C,MAAsE,EACtE,OAAY;IAEZ,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAA;IAChC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7D,OAAO;QACL,IAAI,EAAE,yBAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;QACpD,EAAE,EAAE,yBAAM,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;KACjD,CAAA;AACH,CAAC;AAXD,wDAWC","sourcesContent":["import moment from 'moment-timezone'\n\n/**\n * Get the time range for the specified period relative to the current moment in a specific domain's timezone.\n *\n * @param {string} period - The time period to calculate the range for. Valid options are 'today', 'this month', '30 days', 'this year', '12 months'.\n * @param {Object} context - The context object containing domain information.\n * @returns {Promise<{ from: string; to: string }>} - A Promise that resolves to an object containing 'from' and 'to' ISO date strings representing the time range.\n */\nexport async function getTimesForPeriod(period: 'today' | 'this month' | '30 days' | 'this year' | '12 months', context: any): Promise<{ from: string; to: string }> {\n  const { domain } = context.state\n  const theDate = moment.tz(new Date(), domain.timezone)\n\n  if (period == 'today') {\n    const from = theDate.clone().format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == 'this month') {\n    const from = theDate.clone().startOf('month').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == '30 days') {\n    const from = theDate.clone().subtract(30, 'day').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == 'this year') {\n    const from = theDate.clone().startOf('year').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'year').startOf('year').format('YYYY-MM-DD')\n\n    return { from, to }\n  } else if (period == '12 months') {\n    const from = theDate.clone().subtract(12, 'month').startOf('month').format('YYYY-MM-DD')\n    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')\n\n    return { from, to }\n  }\n}\n\n/**\n * Get the ISO date strings for the specified period relative to the current moment in a specific domain's timezone.\n *\n * @param {string} period - The time period to calculate the range for. Valid options are 'today', 'this month', '30 days', 'this year', '12 months'.\n * @param {Object} context - The context object containing domain information.\n * @returns {Promise<{ from: string; to: string }>} - A Promise that resolves to an object containing 'from' and 'to' ISO date strings representing the time range.\n */\nexport async function getISOStringsForPeriod(\n  period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',\n  context: any\n): Promise<{ from: string; to: string }> {\n  const { domain } = context.state\n  const { from, to } = await getTimesForPeriod(period, context)\n\n  return {\n    from: moment.tz(from, domain.timezone).toISOString(),\n    to: moment.tz(to, domain.timezone).toISOString()\n  }\n}\n"]}

package/dist-server/utils/list-param-adjuster.d.ts

@@ -1,2 +1,11 @@
 import { Filter } from '../service/common-types';
+/**
+ * Adjust the given array of filters based on the provided changes.
+ * If a filter with the same name exists in the original array, it will be replaced with the new filter;
+ * otherwise, the new filter will be added to the array.
+ *
+ * @param {Filter[]} filters - The original array of filters to be adjusted.
+ * @param {Filter[]} filtersChange - The array of filter changes to be applied.
+ * @returns {Filter[]} - The adjusted array of filters.
+ */
 export declare function adjustFilters(filters: Filter[], filtersChange: Filter[]): Filter[];

package/dist-server/utils/list-param-adjuster.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.adjustFilters = void 0;
+/**
+ * Adjust the given array of filters based on the provided changes.
+ * If a filter with the same name exists in the original array, it will be replaced with the new filter;
+ * otherwise, the new filter will be added to the array.
+ *
+ * @param {Filter[]} filters - The original array of filters to be adjusted.
+ * @param {Filter[]} filtersChange - The array of filter changes to be applied.
+ * @returns {Filter[]} - The adjusted array of filters.
+ */
 function adjustFilters(filters, filtersChange) {
     var filtersNew = [...filters];
     filtersChange.forEach(change => {

package/dist-server/utils/list-param-adjuster.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-param-adjuster.js","sourceRoot":"","sources":["../../server/utils/list-param-adjuster.ts"],"names":[],"mappings":";;;AAEA,SAAgB,aAAa,CAAC,OAAiB,EAAE,aAAuB;IACtE,IAAI,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAA;IAE7B,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC7B,MAAM,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAA;QACrE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC1E,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU,CAAA;AACnB,CAAC;AATD,sCASC","sourcesContent":["import { Filter } from '../service/common-types'\n\nexport function adjustFilters(filters: Filter[], filtersChange: Filter[]): Filter[] {\n  var filtersNew = [...filters]\n\n  filtersChange.forEach(change => {\n    const idx = (filtersNew || []).findIndex(f => f.name === change.name)\n    idx !== -1 ? filtersNew.splice(idx, 1, change) : filtersNew.push(change)\n  })\n\n  return filtersNew\n}\n"]}
+{"version":3,"file":"list-param-adjuster.js","sourceRoot":"","sources":["../../server/utils/list-param-adjuster.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,OAAiB,EAAE,aAAuB;IACtE,IAAI,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAA;IAE7B,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC7B,MAAM,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAA;QACrE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC1E,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU,CAAA;AACnB,CAAC;AATD,sCASC","sourcesContent":["import { Filter } from '../service/common-types'\n\n/**\n * Adjust the given array of filters based on the provided changes.\n * If a filter with the same name exists in the original array, it will be replaced with the new filter;\n * otherwise, the new filter will be added to the array.\n *\n * @param {Filter[]} filters - The original array of filters to be adjusted.\n * @param {Filter[]} filtersChange - The array of filter changes to be applied.\n * @returns {Filter[]} - The adjusted array of filters.\n */\nexport function adjustFilters(filters: Filter[], filtersChange: Filter[]): Filter[] {\n  var filtersNew = [...filters]\n\n  filtersChange.forEach(change => {\n    const idx = (filtersNew || []).findIndex(f => f.name === change.name)\n    idx !== -1 ? filtersNew.splice(idx, 1, change) : filtersNew.push(change)\n  })\n\n  return filtersNew\n}\n"]}

package/dist-server/utils/list-params-converter.d.ts

@@ -1,6 +1,12 @@
 import { FindOperator } from 'typeorm';
 import { ListParam } from '../service/common-types';
 import { Domain } from '../service/domain/domain';
+/**
+ * Convert ListParam object to TypeORM query parameters.
+ * @param {ListParam} params - The ListParam object containing pagination, sorting, and filtering options.
+ * @param {string | { domain?: string | Domain; searchables?: string[] }} options - Optional domain and searchables parameters.
+ * @returns {{ where?: { [name: string]: FindOperator<any> }; order?: { [name: string]: 'DESC' | 'ASC' }; skip?: number; take?: number }} - The TypeORM query parameters.
+ */
 export declare function convertListParams(params: ListParam, options?: string | {
     domain?: string | Domain;
     searchables?: string[];

package/dist-server/utils/list-params-converter.js

@@ -27,9 +27,19 @@ const OPERATION_FUNCTION_MAP = {
     is_empty_num_id: () => (0, typeorm_1.Raw)(alias => `${alias} IS EMPTY NUMERIC ID`),
     between: value => (0, typeorm_1.Between)(value[0], value[1])
 };
+/**
+ * Get the TypeORM FindOperator function for a given filter.
+ * @param {Filter} filter - The filter object containing operator and value.
+ * @returns {FindOperator<any>} - The corresponding FindOperator function.
+ */
 function getOperatorFunction({ operator, value }) {
     return OPERATION_FUNCTION_MAP[operator](value);
 }
+/**
+ * Create pagination parameters for a TypeORM query.
+ * @param {Pagination} pagination - The pagination object.
+ * @returns {{ skip?: number; take?: number }} - The pagination parameters.
+ */
 function makePaginationParams(pagination) {
     var result = {};
     if (pagination) {
@@ -47,6 +57,11 @@ function makePaginationParams(pagination) {
     }
     return result;
 }
+/**
+ * Create sorting parameters for a TypeORM query.
+ * @param {Sorting[]} sortings - The array of sorting objects.
+ * @returns {{ order?: { [name: string]: 'DESC' | 'ASC' } }} - The sorting parameters.
+ */
 function makeSortingParams(sortings) {
     var result = {};
     if (sortings) {
@@ -60,6 +75,12 @@ function makeSortingParams(sortings) {
     }
     return result;
 }
+/**
+ * Create filter parameters for a TypeORM query.
+ * @param {Filter[]} filters - The array of filter objects.
+ * @param {string[]} searchables - The array of searchable field names.
+ * @returns {{ where: { [name: string]: FindOperator<any> } | { [name: string]: FindOperator<any> }[] }} - The filter parameters.
+ */
 function makeFilterParams(filters, searchables) {
     /* for where AND clauses */
     const columnFilters = (filters === null || filters === void 0 ? void 0 : filters.filter(filter => {
@@ -100,6 +121,12 @@ function makeFilterParams(filters, searchables) {
         where: searchWheres
     };
 }
+/**
+ * Convert ListParam object to TypeORM query parameters.
+ * @param {ListParam} params - The ListParam object containing pagination, sorting, and filtering options.
+ * @param {string | { domain?: string | Domain; searchables?: string[] }} options - Optional domain and searchables parameters.
+ * @returns {{ where?: { [name: string]: FindOperator<any> }; order?: { [name: string]: 'DESC' | 'ASC' }; skip?: number; take?: number }} - The TypeORM query parameters.
+ */
 function convertListParams(params, options) {
     var domainId;
     if (options) {

package/dist-server/utils/list-params-converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-params-converter.js","sourceRoot":"","sources":["../../server/utils/list-params-converter.ts"],"names":[],"mappings":";;;AAAA,qCAAyF;AAIzF,+DAAqD;AAErD,MAAM,sBAAsB,GAA8D;IACxF,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IAC7B,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC;IACjC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,cAAI,EAAC,KAAK,CAAC;IAC1B,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,cAAI,EAAC,KAAK,CAAC,CAAC;IAChC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC;IACnC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAChG,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAChG,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAClG,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAClG,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,YAAE,EAAC,KAAK,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,YAAE,EAAC,KAAK,CAAC,CAAC;IAC9B,OAAO,EAAE,GAAG,EAAE,CAAC,IAAA,gBAAM,GAAE;IACvB,WAAW,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,gBAAM,GAAE,CAAC;IAChC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;IACjD,OAAO,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,UAAU,CAAC;IAC/C,WAAW,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,cAAc,CAAC;IACvD,UAAU,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC;IACrD,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;IACjD,eAAe,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,sBAAsB,CAAC;IACnE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAA;AAED,SAAS,mBAAmB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAU;IACtD,OAAO,sBAAsB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAA;AAChD,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAsB;IAClD,IAAI,MAAM,GAAG,EAAsC,CAAA;IACnD,IAAI,UAAU,EAAE;QACd,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,UAAU,CAAA;QACxC,IAAI,IAAI,GAAG,CAAC,CAAA;QACZ,IAAI,IAAI,GAAG,CAAC,CAAA;QAEZ,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAA;YACpC,IAAI,GAAG,KAAK,CAAA;YACZ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;gBACpB,IAAI;gBACJ,IAAI;aACL,CAAC,CAAA;SACH;KACF;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAmB;IAC5C,IAAI,MAAM,GAAG,EAAoD,CAAA;IACjE,IAAI,QAAQ,EAAE;QACZ,IAAI,KAAK,GAAG,EAAwC,CAAA;QACpD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACnB,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAA;QACzC,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACpB,KAAK;SACN,CAAC,CAAA;KACH;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAiB,EACjB,WAAsB;IAItB,2BAA2B;IAC3B,MAAM,aAAa,GACjB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;QACvB,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,OAAO,KAAK,CAAA;SACb;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;YAC1G,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,KAAI,EAAE,CAAA;IAEV,MAAM,aAAa,GACjB,WAAW,YAAY,KAAK;QAC1B,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YACvB,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAChC,OAAO,KAAK,CAAA;aACb;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACtC,OAAO,CAAC,IAAI,CACV,sFAAsF,EACtF,MAAM,CAAC,IAAI,CACZ,CAAA;gBACD,OAAO,KAAK,CAAA;aACb;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,KAAI,EAAE;QACV,CAAC,CAAC,EAAE,CAAA;IAER,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QACpD,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAA;QACtC,OAAO,KAAK,CAAA;IACd,CAAC,EAAE,EAA2C,CAAC,CAAA;IAE/C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,OAAO;YACL,KAAK,EAAE,WAAW;SACnB,CAAA;KACF;IAED,mDAAmD;IACnD,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACzC,uBACE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAC7B,WAAW,EACf;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,KAAK,EAAE,YAAY;KACpB,CAAA;AACH,CAAC;AAED,SAAgB,iBAAiB,CAC/B,MAAiB,EACjB,OAKK;IASL,IAAI,QAA4B,CAAA;IAEhC,IAAI,OAAO,EAAE;QACX,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,gBAAgB,EAAE;YAChD,IAAI,QAAQ,GAAG,OAAO,CAAA;SACvB;aAAM;YACL,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;YACrC,IAAI,QAAQ,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAA;SAChE;KACF;IAED,IAAI,EAAE,UAAU,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;IACnD,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,QAAQ,EAAE;QACZ,OAAO,GAAG,IAAA,mCAAa,EAAC,OAAO,EAAE;YAC/B;gBACE,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,KAAK,EAAE,QAAQ;aAChB;SACF,CAAC,CAAA;KACH;IAED,IAAI,UAAU;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAA;IACvE,IAAI,QAAQ;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAA;IAChE,IAAI,OAAO;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;IAE1E,OAAO,MAAM,CAAA;AACf,CAAC;AA7CD,8CA6CC","sourcesContent":["import { Between, Equal, FindOperator, ILike, In, IsNull, Like, Not, Raw } from 'typeorm'\n\nimport { Filter, ListParam, Pagination, Sorting } from '../service/common-types'\nimport { Domain } from '../service/domain/domain'\nimport { adjustFilters } from './list-param-adjuster'\n\nconst OPERATION_FUNCTION_MAP: { [operator: string]: (value: any) => FindOperator<any> } = {\n  search: value => ILike(value),\n  eq: value => Equal(value),\n  noteq: value => Not(Equal(value)),\n  like: value => Like(value),\n  i_like: value => ILike(value),\n  nlike: value => Not(Like(value)),\n  i_nlike: value => Not(ILike(value)),\n  lt: value => Raw(alias => `${alias} < ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  gt: value => Raw(alias => `${alias} > ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  lte: value => Raw(alias => `${alias} <= ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  gte: value => Raw(alias => `${alias} >= ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  in: value => In(value),\n  notin: value => Not(In(value)),\n  is_null: () => IsNull(),\n  is_not_null: () => Not(IsNull()),\n  is_false: () => Raw(alias => `${alias} IS FALSE`),\n  in_true: () => Raw(alias => `${alias} IS TRUE`),\n  is_not_true: () => Raw(alias => `${alias} IS NOT TRUE`),\n  is_present: () => Raw(alias => `${alias} IS PRESENT`),\n  is_blank: () => Raw(alias => `${alias} IS BLANK`),\n  is_empty_num_id: () => Raw(alias => `${alias} IS EMPTY NUMERIC ID`),\n  between: value => Between(value[0], value[1])\n}\n\nfunction getOperatorFunction({ operator, value }: Filter): FindOperator<any> {\n  return OPERATION_FUNCTION_MAP[operator](value)\n}\n\nfunction makePaginationParams(pagination: Pagination): { skip?: number; take?: number } {\n  var result = {} as { skip?: number; take?: number }\n  if (pagination) {\n    var { page = 0, limit = 0 } = pagination\n    var skip = 0\n    var take = 0\n\n    if (limit > 0) {\n      skip = Math.max(page - 1, 0) * limit\n      take = limit\n      Object.assign(result, {\n        skip,\n        take\n      })\n    }\n  }\n\n  return result\n}\n\nfunction makeSortingParams(sortings: Sorting[]): { order?: { [name: string]: 'DESC' | 'ASC' } } {\n  var result = {} as { order?: { [name: string]: 'DESC' | 'ASC' } }\n  if (sortings) {\n    var order = {} as { [name: string]: 'DESC' | 'ASC' }\n    sortings.forEach(s => {\n      order[s.name] = s.desc ? 'DESC' : 'ASC'\n    })\n\n    Object.assign(result, {\n      order\n    })\n  }\n\n  return result\n}\n\nfunction makeFilterParams(\n  filters: Filter[],\n  searchables?: string[]\n): {\n  where: { [name: string]: FindOperator<any> } | { [name: string]: FindOperator<any> }[]\n} {\n  /* for where AND clauses */\n  const columnFilters =\n    filters?.filter(filter => {\n      if (filter.operator === 'search') {\n        return false\n      }\n      if (filter.operator.toLowerCase().includes('like') && (!searchables || !searchables.includes(filter.name))) {\n        return false\n      }\n      return true\n    }) || []\n\n  const searchFilters =\n    searchables instanceof Array\n      ? filters?.filter(filter => {\n          if (filter.operator !== 'search') {\n            return false\n          }\n          if (!searchables.includes(filter.name)) {\n            console.warn(\n              '\"searchables\" setting is required for like searches with a heavy database query load',\n              filter.name\n            )\n            return false\n          }\n          return true\n        }) || []\n      : []\n\n  const columnWhere = columnFilters.reduce((where, f) => {\n    where[f.name] = getOperatorFunction(f)\n    return where\n  }, {} as { [name: string]: FindOperator<any> })\n\n  if (searchFilters.length === 0) {\n    return {\n      where: columnWhere\n    }\n  }\n\n  /* for fulltext searching ... OR-AND composition */\n  const searchWheres = searchFilters.map(f => {\n    return {\n      [f.name]: getOperatorFunction(f),\n      ...columnWhere\n    }\n  })\n\n  return {\n    where: searchWheres\n  }\n}\n\nexport function convertListParams(\n  params: ListParam,\n  options?:\n    | string\n    | {\n        domain?: string | Domain\n        searchables?: string[]\n      }\n): {\n  where?: { [name: string]: FindOperator<any> }\n  order?: {\n    [name: string]: 'DESC' | 'ASC'\n  }\n  skip?: number\n  take?: number\n} {\n  var domainId: string | undefined\n\n  if (options) {\n    if (typeof options === 'string' /* for 하위 호환성 */) {\n      var domainId = options\n    } else {\n      var { domain, searchables } = options\n      var domainId = typeof domain === 'string' ? domain : domain?.id\n    }\n  }\n\n  var { pagination, filters = [], sortings } = params\n  var result = {}\n\n  if (domainId) {\n    filters = adjustFilters(filters, [\n      {\n        name: 'domain',\n        operator: 'eq',\n        value: domainId\n      }\n    ])\n  }\n\n  if (pagination) Object.assign(result, makePaginationParams(pagination))\n  if (sortings) Object.assign(result, makeSortingParams(sortings))\n  if (filters) Object.assign(result, makeFilterParams(filters, searchables))\n\n  return result\n}\n"]}
+{"version":3,"file":"list-params-converter.js","sourceRoot":"","sources":["../../server/utils/list-params-converter.ts"],"names":[],"mappings":";;;AAAA,qCAAyF;AAIzF,+DAAqD;AAErD,MAAM,sBAAsB,GAA8D;IACxF,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IAC7B,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC;IACjC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,cAAI,EAAC,KAAK,CAAC;IAC1B,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,KAAK,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,cAAI,EAAC,KAAK,CAAC,CAAC;IAChC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC;IACnC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAChG,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAChG,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAClG,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAClG,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,YAAE,EAAC,KAAK,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,YAAE,EAAC,KAAK,CAAC,CAAC;IAC9B,OAAO,EAAE,GAAG,EAAE,CAAC,IAAA,gBAAM,GAAE;IACvB,WAAW,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,IAAA,gBAAM,GAAE,CAAC;IAChC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;IACjD,OAAO,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,UAAU,CAAC;IAC/C,WAAW,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,cAAc,CAAC;IACvD,UAAU,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC;IACrD,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;IACjD,eAAe,EAAE,GAAG,EAAE,CAAC,IAAA,aAAG,EAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,sBAAsB,CAAC;IACnE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAA;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAU;IACtD,OAAO,sBAAsB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAS,oBAAoB,CAAC,UAAsB;IAClD,IAAI,MAAM,GAAG,EAAsC,CAAA;IACnD,IAAI,UAAU,EAAE;QACd,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,UAAU,CAAA;QACxC,IAAI,IAAI,GAAG,CAAC,CAAA;QACZ,IAAI,IAAI,GAAG,CAAC,CAAA;QAEZ,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAA;YACpC,IAAI,GAAG,KAAK,CAAA;YACZ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;gBACpB,IAAI;gBACJ,IAAI;aACL,CAAC,CAAA;SACH;KACF;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,QAAmB;IAC5C,IAAI,MAAM,GAAG,EAAoD,CAAA;IACjE,IAAI,QAAQ,EAAE;QACZ,IAAI,KAAK,GAAG,EAAwC,CAAA;QACpD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACnB,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAA;QACzC,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACpB,KAAK;SACN,CAAC,CAAA;KACH;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,OAAiB,EACjB,WAAsB;IAItB,2BAA2B;IAC3B,MAAM,aAAa,GACjB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;QACvB,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,OAAO,KAAK,CAAA;SACb;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;YAC1G,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,KAAI,EAAE,CAAA;IAEV,MAAM,aAAa,GACjB,WAAW,YAAY,KAAK;QAC1B,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YACvB,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAChC,OAAO,KAAK,CAAA;aACb;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,sFAAsF,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;gBACjH,OAAO,KAAK,CAAA;aACb;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,KAAI,EAAE;QACV,CAAC,CAAC,EAAE,CAAA;IAER,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QACpD,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAA;QACtC,OAAO,KAAK,CAAA;IACd,CAAC,EAAE,EAA2C,CAAC,CAAA;IAE/C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,OAAO;YACL,KAAK,EAAE,WAAW;SACnB,CAAA;KACF;IAED,mDAAmD;IACnD,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACzC,uBACE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAC7B,WAAW,EACf;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,KAAK,EAAE,YAAY;KACpB,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,MAAiB,EACjB,OAKK;IASL,IAAI,QAA4B,CAAA;IAEhC,IAAI,OAAO,EAAE;QACX,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,gBAAgB,EAAE;YAChD,IAAI,QAAQ,GAAG,OAAO,CAAA;SACvB;aAAM;YACL,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;YACrC,IAAI,QAAQ,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAA;SAChE;KACF;IAED,IAAI,EAAE,UAAU,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAA;IACnD,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,QAAQ,EAAE;QACZ,OAAO,GAAG,IAAA,mCAAa,EAAC,OAAO,EAAE;YAC/B;gBACE,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,KAAK,EAAE,QAAQ;aAChB;SACF,CAAC,CAAA;KACH;IAED,IAAI,UAAU;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAA;IACvE,IAAI,QAAQ;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAA;IAChE,IAAI,OAAO;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;IAE1E,OAAO,MAAM,CAAA;AACf,CAAC;AA7CD,8CA6CC","sourcesContent":["import { Between, Equal, FindOperator, ILike, In, IsNull, Like, Not, Raw } from 'typeorm'\n\nimport { Filter, ListParam, Pagination, Sorting } from '../service/common-types'\nimport { Domain } from '../service/domain/domain'\nimport { adjustFilters } from './list-param-adjuster'\n\nconst OPERATION_FUNCTION_MAP: { [operator: string]: (value: any) => FindOperator<any> } = {\n  search: value => ILike(value),\n  eq: value => Equal(value),\n  noteq: value => Not(Equal(value)),\n  like: value => Like(value),\n  i_like: value => ILike(value),\n  nlike: value => Not(Like(value)),\n  i_nlike: value => Not(ILike(value)),\n  lt: value => Raw(alias => `${alias} < ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  gt: value => Raw(alias => `${alias} > ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  lte: value => Raw(alias => `${alias} <= ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  gte: value => Raw(alias => `${alias} >= ${typeof value === 'string' ? \"'\" + value + \"'\" : value}`),\n  in: value => In(value),\n  notin: value => Not(In(value)),\n  is_null: () => IsNull(),\n  is_not_null: () => Not(IsNull()),\n  is_false: () => Raw(alias => `${alias} IS FALSE`),\n  in_true: () => Raw(alias => `${alias} IS TRUE`),\n  is_not_true: () => Raw(alias => `${alias} IS NOT TRUE`),\n  is_present: () => Raw(alias => `${alias} IS PRESENT`),\n  is_blank: () => Raw(alias => `${alias} IS BLANK`),\n  is_empty_num_id: () => Raw(alias => `${alias} IS EMPTY NUMERIC ID`),\n  between: value => Between(value[0], value[1])\n}\n\n/**\n * Get the TypeORM FindOperator function for a given filter.\n * @param {Filter} filter - The filter object containing operator and value.\n * @returns {FindOperator<any>} - The corresponding FindOperator function.\n */\nfunction getOperatorFunction({ operator, value }: Filter): FindOperator<any> {\n  return OPERATION_FUNCTION_MAP[operator](value)\n}\n\n/**\n * Create pagination parameters for a TypeORM query.\n * @param {Pagination} pagination - The pagination object.\n * @returns {{ skip?: number; take?: number }} - The pagination parameters.\n */\nfunction makePaginationParams(pagination: Pagination): { skip?: number; take?: number } {\n  var result = {} as { skip?: number; take?: number }\n  if (pagination) {\n    var { page = 0, limit = 0 } = pagination\n    var skip = 0\n    var take = 0\n\n    if (limit > 0) {\n      skip = Math.max(page - 1, 0) * limit\n      take = limit\n      Object.assign(result, {\n        skip,\n        take\n      })\n    }\n  }\n\n  return result\n}\n\n/**\n * Create sorting parameters for a TypeORM query.\n * @param {Sorting[]} sortings - The array of sorting objects.\n * @returns {{ order?: { [name: string]: 'DESC' | 'ASC' } }} - The sorting parameters.\n */\nfunction makeSortingParams(sortings: Sorting[]): { order?: { [name: string]: 'DESC' | 'ASC' } } {\n  var result = {} as { order?: { [name: string]: 'DESC' | 'ASC' } }\n  if (sortings) {\n    var order = {} as { [name: string]: 'DESC' | 'ASC' }\n    sortings.forEach(s => {\n      order[s.name] = s.desc ? 'DESC' : 'ASC'\n    })\n\n    Object.assign(result, {\n      order\n    })\n  }\n\n  return result\n}\n\n/**\n * Create filter parameters for a TypeORM query.\n * @param {Filter[]} filters - The array of filter objects.\n * @param {string[]} searchables - The array of searchable field names.\n * @returns {{ where: { [name: string]: FindOperator<any> } | { [name: string]: FindOperator<any> }[] }} - The filter parameters.\n */\nfunction makeFilterParams(\n  filters: Filter[],\n  searchables?: string[]\n): {\n  where: { [name: string]: FindOperator<any> } | { [name: string]: FindOperator<any> }[]\n} {\n  /* for where AND clauses */\n  const columnFilters =\n    filters?.filter(filter => {\n      if (filter.operator === 'search') {\n        return false\n      }\n      if (filter.operator.toLowerCase().includes('like') && (!searchables || !searchables.includes(filter.name))) {\n        return false\n      }\n      return true\n    }) || []\n\n  const searchFilters =\n    searchables instanceof Array\n      ? filters?.filter(filter => {\n          if (filter.operator !== 'search') {\n            return false\n          }\n          if (!searchables.includes(filter.name)) {\n            console.warn('\"searchables\" setting is required for like searches with a heavy database query load', filter.name)\n            return false\n          }\n          return true\n        }) || []\n      : []\n\n  const columnWhere = columnFilters.reduce((where, f) => {\n    where[f.name] = getOperatorFunction(f)\n    return where\n  }, {} as { [name: string]: FindOperator<any> })\n\n  if (searchFilters.length === 0) {\n    return {\n      where: columnWhere\n    }\n  }\n\n  /* for fulltext searching ... OR-AND composition */\n  const searchWheres = searchFilters.map(f => {\n    return {\n      [f.name]: getOperatorFunction(f),\n      ...columnWhere\n    }\n  })\n\n  return {\n    where: searchWheres\n  }\n}\n\n/**\n * Convert ListParam object to TypeORM query parameters.\n * @param {ListParam} params - The ListParam object containing pagination, sorting, and filtering options.\n * @param {string | { domain?: string | Domain; searchables?: string[] }} options - Optional domain and searchables parameters.\n * @returns {{ where?: { [name: string]: FindOperator<any> }; order?: { [name: string]: 'DESC' | 'ASC' }; skip?: number; take?: number }} - The TypeORM query parameters.\n */\nexport function convertListParams(\n  params: ListParam,\n  options?:\n    | string\n    | {\n        domain?: string | Domain\n        searchables?: string[]\n      }\n): {\n  where?: { [name: string]: FindOperator<any> }\n  order?: {\n    [name: string]: 'DESC' | 'ASC'\n  }\n  skip?: number\n  take?: number\n} {\n  var domainId: string | undefined\n\n  if (options) {\n    if (typeof options === 'string' /* for 하위 호환성 */) {\n      var domainId = options\n    } else {\n      var { domain, searchables } = options\n      var domainId = typeof domain === 'string' ? domain : domain?.id\n    }\n  }\n\n  var { pagination, filters = [], sortings } = params\n  var result = {}\n\n  if (domainId) {\n    filters = adjustFilters(filters, [\n      {\n        name: 'domain',\n        operator: 'eq',\n        value: domainId\n      }\n    ])\n  }\n\n  if (pagination) Object.assign(result, makePaginationParams(pagination))\n  if (sortings) Object.assign(result, makeSortingParams(sortings))\n  if (filters) Object.assign(result, makeFilterParams(filters, searchables))\n\n  return result\n}\n"]}

package/dist-server/utils/list-query-builder.d.ts

@@ -1,6 +1,15 @@
 import { ListParam } from '../service/common-types/list-param';
 /**
- * @deprecated The name of this function does not imply an exact purpose and it is not possible to correspond to a foreign key using the meta information of the table column, so it is recommended to replace it with the getQueryBuilderFromListParams function.
+ * @deprecated This function is recommended to be replaced with the `getQueryBuilderFromListParams` function.
+ *
+ * Builds a TypeORM query using the provided parameters to filter, paginate, and sort the data.
+ *
+ * @param {QueryBuilder} queryBuilder - The TypeORM query builder to build the query on.
+ * @param {ListParam} params - The list parameters to apply to the query.
+ * @param {Object} context - The context object, typically containing information about the user's domain.
+ * @param {boolean|Object} options - Additional options for the query builder.
+ * @param {boolean} options.domainRef - Indicates whether to include domain reference in the query.
+ * @param {string[]} options.searchables - An array of searchable field names.
  */
 export declare const buildQuery: (queryBuilder: any, params: ListParam, context: any, options?: boolean | {
     domainRef?: boolean;

package/dist-server/utils/list-query-builder.js

@@ -5,7 +5,16 @@ const typeorm_1 = require("typeorm");
 const condition_builder_1 = require("./condition-builder");
 const list_param_1 = require("../service/common-types/list-param");
 /**
- * @deprecated The name of this function does not imply an exact purpose and it is not possible to correspond to a foreign key using the meta information of the table column, so it is recommended to replace it with the getQueryBuilderFromListParams function.
+ * @deprecated This function is recommended to be replaced with the `getQueryBuilderFromListParams` function.
+ *
+ * Builds a TypeORM query using the provided parameters to filter, paginate, and sort the data.
+ *
+ * @param {QueryBuilder} queryBuilder - The TypeORM query builder to build the query on.
+ * @param {ListParam} params - The list parameters to apply to the query.
+ * @param {Object} context - The context object, typically containing information about the user's domain.
+ * @param {boolean|Object} options - Additional options for the query builder.
+ * @param {boolean} options.domainRef - Indicates whether to include domain reference in the query.
+ * @param {string[]} options.searchables - An array of searchable field names.
  */
 const buildQuery = function (queryBuilder, params, context, options) {
     var _a, _b;

package/dist-server/utils/list-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-query-builder.js","sourceRoot":"","sources":["../../server/utils/list-query-builder.ts"],"names":[],"mappings":";;;AAAA,qCAAkC;AAElC,2DAAoD;AACpD,mEAA0F;AAE1F;;GAEG;AACI,MAAM,UAAU,GAAG,UACxB,YAAiB,EACjB,MAAiB,EACjB,OAAY,EACZ,OAKK;;IAEL,0CAA0C;IAC1C,IAAI,SAAS,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;IAE7D,kDAAkD;IAClD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,IAAI,EAAE,SAAS,GAAG,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;KAChD;IAED,MAAM,aAAa,GACjB,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;QAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,OAAO,KAAK,CAAA;SACb;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;YAC1G,OAAO,CAAC,IAAI,CACV,sFAAsF,EACtF,MAAM,CAAC,IAAI,CACZ,CAAA;YACD,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,KAAI,EAAE,CAAA;IAEV,MAAM,aAAa,GACjB,WAAW,YAAY,KAAK;QAC1B,CAAC,CAAC,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAChC,OAAO,KAAK,CAAA;aACb;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACtC,OAAO,CAAC,IAAI,CACV,sFAAsF,EACtF,MAAM,CAAC,IAAI,CACZ,CAAA;gBACD,OAAO,KAAK,CAAA;aACb;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,KAAI,EAAE;QACV,CAAC,CAAC,EAAE,CAAA;IAER,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;IACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IAChC,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,MAAM,CAAA;IAEpC,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7C,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAA,kCAAc,EAC9B,YAAY,CAAC,KAAK,EAClB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,CAAC,MAAM,CACjD,CAAA;YAED,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM;gBAAE,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC9D,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU;gBAAE,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,CAAA;KACH;IAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,YAAY,CAAC,QAAQ,CACnB,IAAI,kBAAQ,CAAC,EAAE,CAAC,EAAE;YAChB,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACtC,MAAM,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,IAAI,EAAE,CAAA;gBAC1E,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,CAAA;gBAElD,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YAC7E,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CACH,CAAA;KACF;IAED,IAAI,SAAS,EAAE;QACb,MAAM,SAAS,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,KAAI,+BAAkB,CAAC,IAAI,CAAA;QAE9D,IAAI,CAAC,SAAS,IAAI,SAAS,IAAI,+BAAkB,CAAC,IAAI,EAAE;YACtD,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;SACvF;aAAM,IAAI,SAAS,IAAI,+BAAkB,CAAC,OAAO,EAAE;YAClD,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,yBAAyB,EAAE;gBACpE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;aACtD,CAAC,CAAA;SACH;aAAM,IAAI,SAAS,IAAI,+BAAkB,CAAC,IAAI,EAAE;YAC/C,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,IAAI,YAAY,EAAE,CAAC,CAAA;SAC7G;aAAM;YACL,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;SAC1F;KACF;IAED,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,EAAE;QAC7D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAA;QAC3D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KACpC;IAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACnC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,CAAA;YAC7G,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;aAC/D;iBAAM;gBACL,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;aAClE;QACH,CAAC,CAAC,CAAA;KACH;AACH,CAAC,CAAA;AAnHY,QAAA,UAAU,cAmHtB","sourcesContent":["import { Brackets } from 'typeorm'\n\nimport { buildCondition } from './condition-builder'\nimport { Filter, ListParam, InheritedValueType } from '../service/common-types/list-param'\n\n/**\n * @deprecated The name of this function does not imply an exact purpose and it is not possible to correspond to a foreign key using the meta information of the table column, so it is recommended to replace it with the getQueryBuilderFromListParams function.\n */\nexport const buildQuery = function (\n  queryBuilder: any,\n  params: ListParam,\n  context: any,\n  options?:\n    | boolean\n    | {\n        domainRef?: boolean\n        searchables?: string[]\n      }\n) {\n  /* default value of domainRef is 'true' */\n  var domainRef = typeof options === 'boolean' ? options : true\n\n  /* for backwards compatibility of function spec */\n  if (typeof options === 'object') {\n    var { domainRef = true, searchables } = options\n  }\n\n  const columnFilters: Filter[] =\n    params.filters?.filter(filter => {\n      if (filter.operator === 'search') {\n        return false\n      }\n      if (filter.operator.toLowerCase().includes('like') && (!searchables || !searchables.includes(filter.name))) {\n        console.warn(\n          '\"searchables\" setting is required for like searches with a heavy database query load',\n          filter.name\n        )\n        return false\n      }\n      return true\n    }) || []\n\n  const searchFilters =\n    searchables instanceof Array\n      ? params.filters?.filter(filter => {\n          if (filter.operator !== 'search') {\n            return false\n          }\n          if (!searchables.includes(filter.name)) {\n            console.warn(\n              '\"searchables\" setting is required for like searches with a heavy database query load',\n              filter.name\n            )\n            return false\n          }\n          return true\n        }) || []\n      : []\n\n  const pagination = params.pagination\n  const sortings = params.sortings\n  const domain = context?.state.domain\n\n  if (columnFilters && columnFilters.length > 0) {\n    columnFilters.forEach(filter => {\n      const condition = buildCondition(\n        queryBuilder.alias,\n        filter.name,\n        filter.operator,\n        filter.value,\n        filter.relation,\n        Object.keys(queryBuilder.getParameters()).length\n      )\n\n      if (condition?.clause) queryBuilder.andWhere(condition.clause)\n      if (condition?.parameters) queryBuilder.setParameters(condition.parameters)\n    })\n  }\n\n  if (searchFilters.length > 0) {\n    queryBuilder.andWhere(\n      new Brackets(qb => {\n        searchFilters.forEach((filter, index) => {\n          const clause = `${queryBuilder.alias}.${filter.name} LIKE :${filter.name}`\n          const parameters = { [filter.name]: filter.value }\n\n          index === 0 ? qb.where(clause, parameters) : qb.orWhere(clause, parameters)\n        })\n      })\n    )\n  }\n\n  if (domainRef) {\n    const inherited = params?.inherited || InheritedValueType.None\n\n    if (!inherited || inherited == InheritedValueType.None) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: domain.id })\n    } else if (inherited == InheritedValueType.Include) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain In(:...domains)`, {\n        domains: [domain.id, domain.parentId].filter(Boolean)\n      })\n    } else if (inherited == InheritedValueType.Only) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: domain.parentId || 'Impossible' })\n    } else {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: 'Impossible' })\n    }\n  }\n\n  if (pagination && pagination.page > 0 && pagination.limit > 0) {\n    queryBuilder.skip(pagination.limit * (pagination.page - 1))\n    queryBuilder.take(pagination.limit)\n  }\n\n  if (sortings && sortings.length > 0) {\n    sortings.forEach((sorting, index) => {\n      const sortField = sorting.name.split('.').length > 1 ? sorting.name : `${queryBuilder.alias}.${sorting.name}`\n      if (index === 0) {\n        queryBuilder.orderBy(sortField, sorting.desc ? 'DESC' : 'ASC')\n      } else {\n        queryBuilder.addOrderBy(sortField, sorting.desc ? 'DESC' : 'ASC')\n      }\n    })\n  }\n}\n"]}
+{"version":3,"file":"list-query-builder.js","sourceRoot":"","sources":["../../server/utils/list-query-builder.ts"],"names":[],"mappings":";;;AAAA,qCAAkC;AAElC,2DAAoD;AACpD,mEAA0F;AAE1F;;;;;;;;;;;GAWG;AACI,MAAM,UAAU,GAAG,UACxB,YAAiB,EACjB,MAAiB,EACjB,OAAY,EACZ,OAKK;;IAEL,0CAA0C;IAC1C,IAAI,SAAS,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;IAE7D,kDAAkD;IAClD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,IAAI,EAAE,SAAS,GAAG,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAA;KAChD;IAED,MAAM,aAAa,GACjB,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;QAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,OAAO,KAAK,CAAA;SACb;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;YAC1G,OAAO,CAAC,IAAI,CAAC,sFAAsF,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;YACjH,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,KAAI,EAAE,CAAA;IAEV,MAAM,aAAa,GACjB,WAAW,YAAY,KAAK;QAC1B,CAAC,CAAC,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBAChC,OAAO,KAAK,CAAA;aACb;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,sFAAsF,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;gBACjH,OAAO,KAAK,CAAA;aACb;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,KAAI,EAAE;QACV,CAAC,CAAC,EAAE,CAAA;IAER,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;IACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IAChC,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,MAAM,CAAA;IAEpC,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7C,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAA,kCAAc,EAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,CAAA;YAEnK,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM;gBAAE,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC9D,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU;gBAAE,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,CAAA;KACH;IAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,YAAY,CAAC,QAAQ,CACnB,IAAI,kBAAQ,CAAC,EAAE,CAAC,EAAE;YAChB,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACtC,MAAM,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,IAAI,EAAE,CAAA;gBAC1E,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,CAAA;gBAElD,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YAC7E,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CACH,CAAA;KACF;IAED,IAAI,SAAS,EAAE;QACb,MAAM,SAAS,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,KAAI,+BAAkB,CAAC,IAAI,CAAA;QAE9D,IAAI,CAAC,SAAS,IAAI,SAAS,IAAI,+BAAkB,CAAC,IAAI,EAAE;YACtD,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;SACvF;aAAM,IAAI,SAAS,IAAI,+BAAkB,CAAC,OAAO,EAAE;YAClD,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,yBAAyB,EAAE;gBACpE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;aACtD,CAAC,CAAA;SACH;aAAM,IAAI,SAAS,IAAI,+BAAkB,CAAC,IAAI,EAAE;YAC/C,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,IAAI,YAAY,EAAE,CAAC,CAAA;SAC7G;aAAM;YACL,YAAY,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,mBAAmB,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;SAC1F;KACF;IAED,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,EAAE;QAC7D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAA;QAC3D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;KACpC;IAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACnC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,CAAA;YAC7G,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;aAC/D;iBAAM;gBACL,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;aAClE;QACH,CAAC,CAAC,CAAA;KACH;AACH,CAAC,CAAA;AAtGY,QAAA,UAAU,cAsGtB","sourcesContent":["import { Brackets } from 'typeorm'\n\nimport { buildCondition } from './condition-builder'\nimport { Filter, ListParam, InheritedValueType } from '../service/common-types/list-param'\n\n/**\n * @deprecated This function is recommended to be replaced with the `getQueryBuilderFromListParams` function.\n *\n * Builds a TypeORM query using the provided parameters to filter, paginate, and sort the data.\n *\n * @param {QueryBuilder} queryBuilder - The TypeORM query builder to build the query on.\n * @param {ListParam} params - The list parameters to apply to the query.\n * @param {Object} context - The context object, typically containing information about the user's domain.\n * @param {boolean|Object} options - Additional options for the query builder.\n * @param {boolean} options.domainRef - Indicates whether to include domain reference in the query.\n * @param {string[]} options.searchables - An array of searchable field names.\n */\nexport const buildQuery = function (\n  queryBuilder: any,\n  params: ListParam,\n  context: any,\n  options?:\n    | boolean\n    | {\n        domainRef?: boolean\n        searchables?: string[]\n      }\n) {\n  /* default value of domainRef is 'true' */\n  var domainRef = typeof options === 'boolean' ? options : true\n\n  /* for backwards compatibility of function spec */\n  if (typeof options === 'object') {\n    var { domainRef = true, searchables } = options\n  }\n\n  const columnFilters: Filter[] =\n    params.filters?.filter(filter => {\n      if (filter.operator === 'search') {\n        return false\n      }\n      if (filter.operator.toLowerCase().includes('like') && (!searchables || !searchables.includes(filter.name))) {\n        console.warn('\"searchables\" setting is required for like searches with a heavy database query load', filter.name)\n        return false\n      }\n      return true\n    }) || []\n\n  const searchFilters =\n    searchables instanceof Array\n      ? params.filters?.filter(filter => {\n          if (filter.operator !== 'search') {\n            return false\n          }\n          if (!searchables.includes(filter.name)) {\n            console.warn('\"searchables\" setting is required for like searches with a heavy database query load', filter.name)\n            return false\n          }\n          return true\n        }) || []\n      : []\n\n  const pagination = params.pagination\n  const sortings = params.sortings\n  const domain = context?.state.domain\n\n  if (columnFilters && columnFilters.length > 0) {\n    columnFilters.forEach(filter => {\n      const condition = buildCondition(queryBuilder.alias, filter.name, filter.operator, filter.value, filter.relation, Object.keys(queryBuilder.getParameters()).length)\n\n      if (condition?.clause) queryBuilder.andWhere(condition.clause)\n      if (condition?.parameters) queryBuilder.setParameters(condition.parameters)\n    })\n  }\n\n  if (searchFilters.length > 0) {\n    queryBuilder.andWhere(\n      new Brackets(qb => {\n        searchFilters.forEach((filter, index) => {\n          const clause = `${queryBuilder.alias}.${filter.name} LIKE :${filter.name}`\n          const parameters = { [filter.name]: filter.value }\n\n          index === 0 ? qb.where(clause, parameters) : qb.orWhere(clause, parameters)\n        })\n      })\n    )\n  }\n\n  if (domainRef) {\n    const inherited = params?.inherited || InheritedValueType.None\n\n    if (!inherited || inherited == InheritedValueType.None) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: domain.id })\n    } else if (inherited == InheritedValueType.Include) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain In(:...domains)`, {\n        domains: [domain.id, domain.parentId].filter(Boolean)\n      })\n    } else if (inherited == InheritedValueType.Only) {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: domain.parentId || 'Impossible' })\n    } else {\n      queryBuilder.andWhere(`${queryBuilder.alias}.domain = :domain`, { domain: 'Impossible' })\n    }\n  }\n\n  if (pagination && pagination.page > 0 && pagination.limit > 0) {\n    queryBuilder.skip(pagination.limit * (pagination.page - 1))\n    queryBuilder.take(pagination.limit)\n  }\n\n  if (sortings && sortings.length > 0) {\n    sortings.forEach((sorting, index) => {\n      const sortField = sorting.name.split('.').length > 1 ? sorting.name : `${queryBuilder.alias}.${sorting.name}`\n      if (index === 0) {\n        queryBuilder.orderBy(sortField, sorting.desc ? 'DESC' : 'ASC')\n      } else {\n        queryBuilder.addOrderBy(sortField, sorting.desc ? 'DESC' : 'ASC')\n      }\n    })\n  }\n}\n"]}

package/dist-server/utils/publish-progress.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Publishes a progress update message to the 'data' channel in the Pub/Sub system.
+ *
+ * @param {Object} param - The progress update parameters.
+ * @param {string} param.domain - The domain or category of the progress update.
+ * @param {string} param.tag - The tag or identifier for the progress update.
+ * @param {number} param.progress - The progress value indicating the completion percentage.
+ * @param {string} param.message - A message or description of the progress update.
+ */
 export declare function publishProgress({ domain, tag, progress, message }: {
     domain: any;
     tag: any;

package/dist-server/utils/publish-progress.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.publishProgress = void 0;
 const pubsub_1 = require("../pubsub");
+/**
+ * Publishes a progress update message to the 'data' channel in the Pub/Sub system.
+ *
+ * @param {Object} param - The progress update parameters.
+ * @param {string} param.domain - The domain or category of the progress update.
+ * @param {string} param.tag - The tag or identifier for the progress update.
+ * @param {number} param.progress - The progress value indicating the completion percentage.
+ * @param {string} param.message - A message or description of the progress update.
+ */
 function publishProgress({ domain, tag, progress, message }) {
     pubsub_1.pubsub.publish('data', {
         data: {

package/dist-server/utils/publish-progress.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish-progress.js","sourceRoot":"","sources":["../../server/utils/publish-progress.ts"],"names":[],"mappings":";;;AAAA,sCAAkC;AAElC,SAAgB,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE;IAChE,eAAM,CAAC,OAAO,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE;YACJ,MAAM;YACN,GAAG;YACH,IAAI,EAAE;gBACJ,QAAQ;gBACR,OAAO;aACR;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AAXD,0CAWC","sourcesContent":["import { pubsub } from '../pubsub'\n\nexport function publishProgress({ domain, tag, progress, message }) {\n  pubsub.publish('data', {\n    data: {\n      domain,\n      tag,\n      data: {\n        progress,\n        message\n      }\n    }\n  })\n}\n"]}
+{"version":3,"file":"publish-progress.js","sourceRoot":"","sources":["../../server/utils/publish-progress.ts"],"names":[],"mappings":";;;AAAA,sCAAkC;AAElC;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE;IAChE,eAAM,CAAC,OAAO,CAAC,MAAM,EAAE;QACrB,IAAI,EAAE;YACJ,MAAM;YACN,GAAG;YACH,IAAI,EAAE;gBACJ,QAAQ;gBACR,OAAO;aACR;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AAXD,0CAWC","sourcesContent":["import { pubsub } from '../pubsub'\n\n/**\n * Publishes a progress update message to the 'data' channel in the Pub/Sub system.\n *\n * @param {Object} param - The progress update parameters.\n * @param {string} param.domain - The domain or category of the progress update.\n * @param {string} param.tag - The tag or identifier for the progress update.\n * @param {number} param.progress - The progress value indicating the completion percentage.\n * @param {string} param.message - A message or description of the progress update.\n */\nexport function publishProgress({ domain, tag, progress, message }) {\n  pubsub.publish('data', {\n    data: {\n      domain,\n      tag,\n      data: {\n        progress,\n        message\n      }\n    }\n  })\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/shell",
-  "version": "6.2.84",
+  "version": "6.2.96",
   "description": "Core module for framework",
   "bin": {
     "things-factory": "bin/things-factory",
@@ -60,11 +60,11 @@
     "@operato/shell": "^1.0.1",
     "@operato/typeorm-history": "^1.1.65",
     "@operato/utils": "^1.0.1",
-    "@things-factory/ejs-remote": "^6.2.33",
-    "@things-factory/env": "^6.2.33",
+    "@things-factory/ejs-remote": "^6.2.96",
+    "@things-factory/env": "^6.2.96",
     "@things-factory/operato-license-checker": "^4.0.4",
-    "@things-factory/styles": "^6.2.33",
-    "@things-factory/utils": "^6.2.48",
+    "@things-factory/styles": "^6.2.96",
+    "@things-factory/utils": "^6.2.96",
     "@webcomponents/webcomponentsjs": "^2.6.0",
     "args": "^5.0.0",
     "broadcastchannel-polyfill": "^1.0.1",
@@ -134,5 +134,5 @@
     "pg": "^8.7.3",
     "sqlite3": "^5.0.8"
   },
-  "gitHead": "3c272e989acc14bbd02f4ec79624dfd7dc4e6acd"
+  "gitHead": "1b99f2ee4cd91db25748b376648b2905869e7a33"
 }

package/server/graphql-local-client.ts

@@ -1,3 +1,7 @@
+/**
+ * Apollo Client configuration for a local GraphQL schema.
+ * This class provides a static method `init` to initialize the client with a schema and an app context.
+ */
 import { ApolloClient, InMemoryCache, NormalizedCacheObject } from '@apollo/client'
 import { SchemaLink } from '@apollo/client/link/schema'
 
@@ -18,9 +22,25 @@ const defaultOptions: any = {
 const cache = new InMemoryCache({
   addTypename: false
 })
+
+/**
+ * GraphqlLocalClient is a utility class for initializing an Apollo Client for a local GraphQL schema.
+ * It provides a static `init` method for setting up the client with a schema and an app context.
+ */
 export class GraphqlLocalClient {
+  /**
+   * Apollo Client instance for local GraphQL schema.
+   * @static
+   * @type {ApolloClient<NormalizedCacheObject>}
+   */
   static client: ApolloClient<NormalizedCacheObject>
 
+  /**
+   * Initializes the Apollo Client for a local GraphQL schema.
+   * @static
+   * @param {object} schema - The GraphQL schema to use.
+   * @param {object} app - The application context to be passed in as part of the execution context.
+   */
   static init(schema, app) {
     GraphqlLocalClient.client = new ApolloClient({
       defaultOptions,

package/server/initializers/database.ts

@@ -13,26 +13,52 @@ try {
 
 const dataSources: { [name: string]: DataSource } = {}
 
+/**
+ * Returns the specified DataSource by name.
+ * @param {string} name - The name of the DataSource.
+ * @returns {DataSource} - The DataSource with the specified name.
+ */
 export function getDataSource(name?: string): DataSource {
   return dataSources[name || 'default']
 }
 
+/**
+ * Adds a new DataSource with the specified name.
+ * @param {string} name - The name of the DataSource to add.
+ * @param {DataSource} dataSource - The DataSource to add.
+ */
 export function addDataSource(name: string, dataSource: DataSource) {
   dataSources[name] = dataSource
 }
 
+/**
+ * Removes a DataSource with the specified name.
+ * @param {string} name - The name of the DataSource to remove.
+ */
 export function removeDataSource(name: string) {
   delete dataSources[name]
 }
 
+/**
+ * Returns an array of all registered DataSource names.
+ * @returns {string[]} - An array of DataSource names.
+ */
 export function getDataSourceNames() {
   return Object.keys(dataSources)
 }
 
+/**
+ * Returns a repository for the specified entity.
+ * @param {EntityTarget<X>} target - The target entity for which to get the repository.
+ * @returns {Repository<X>} - The repository for the specified entity.
+ */
 export function getRepository<X>(target: EntityTarget<X>): Repository<X> {
   return getDataSource('default').getRepository<X>(target)
 }
 
+/**
+ * Initializes the database connections and data sources.
+ */
 export const databaseInitializer = async () => {
   try {
     const readConnectionConfig = config.get('ormconfig')

package/server/pubsub-log-transport.ts

@@ -2,11 +2,35 @@ import camelCase from 'lodash/camelCase'
 import Transport from 'winston-transport'
 import { pubsub } from './pubsub'
 
+/**
+ * PubSubLogTransport is a custom Winston transport that publishes log messages to a GraphQL Pub/Sub topic.
+ */
 export class PubSubLogTransport extends Transport {
+  /**
+   * The source object providing the log messages.
+   * @type {object}
+   */
   source: object
+
+  /**
+   * The Pub/Sub topic to which log messages will be published.
+   * @type {string}
+   */
   topic: string
+
+  /**
+   * The name of the field resolver for log messages.
+   * @type {string}
+   */
   resolver: string /* field resolver name */
 
+  /**
+   * Creates an instance of PubSubLogTransport.
+   * @param {object} opts - Options for configuring the transport.
+   * @param {string} opts.topic - The Pub/Sub topic to which log messages will be published.
+   * @param {object} opts.source - The source object providing the log messages.
+   * @param {string} opts.resolver - The name of the field resolver for log messages (default: derived from the topic).
+   */
   constructor(opts) {
     super(opts)
 
@@ -15,6 +39,11 @@ export class PubSubLogTransport extends Transport {
     this.resolver = opts.resolver || camelCase(this.topic)
   }
 
+  /**
+   * Publishes a log message to the configured Pub/Sub topic.
+   * @param {object} info - The log message information.
+   * @param {Function} callback - The callback function to be called after publishing the message.
+   */
   log(info, callback) {
     setImmediate(() => {
       pubsub.publish(this.topic, {

package/server/pubsub.ts

@@ -1,3 +1,11 @@
+/**
+ * @module pubsub
+ * @description
+ * This module provides a Pub/Sub (Publish/Subscribe) mechanism for handling messages and events.
+ * Developers can use various middleware options such as MQTT, Redis, Redis Cluster, or Kafka
+ * to implement Pub/Sub functionality.
+ */
+
 import { MQTTPubSub } from 'graphql-mqtt-subscriptions'
 import { RedisPubSub } from 'graphql-redis-subscriptions'
 import { PubSub } from 'graphql-subscriptions'
@@ -12,6 +20,7 @@ let pubsub: any
 
 switch (middleware) {
   case 'mqtt':
+    //@ts-ignore
     pubsub = new MQTTPubSub({
       client: connect('mqtt://' + host, {
         reconnectPeriod: 1000,
@@ -29,6 +38,7 @@ switch (middleware) {
       },
       ...options
     }
+    //@ts-ignore
     pubsub = new RedisPubSub({
       publisher: new Redis(redisOption),
       subscriber: new Redis(redisOption)
@@ -36,6 +46,7 @@ switch (middleware) {
     break
   case 'redisCluster':
     const cluster = new Redis.Cluster(nodes, options)
+    //@ts-ignore
     pubsub = new RedisPubSub({
       publisher: cluster,
       subscriber: cluster
@@ -65,8 +76,10 @@ switch (middleware) {
 
 // kafka pubsub keeps connection and app port with 'ctrl+c' termination.
 const exitHandler = async evt => {
+  //@ts-ignore
   if (pubsub.close) {
     try {
+      //@ts-ignore
       await pubsub.close()
     } catch (err) {
       logger.error(err)

package/server/schema.ts

@@ -9,6 +9,10 @@ import { deepMerge } from '@things-factory/utils'
 
 const path = require('path')
 
+/**
+ * Generates and returns a GraphQL schema by merging schemas and resolvers from various modules.
+ * @returns {GraphQLSchema} The merged GraphQL schema.
+ */
 export async function schema() {
   const schemas = orderedModuleNames
     .map(dep => loader(dep).schema)

package/server/typeorm/encrypt-transform.ts

@@ -8,11 +8,32 @@ const KEY_LENGTH = 32
 const SALT_LENGTH = 16
 const IV_LENGTH = 16
 
+/**
+ * ValueTransformer object for encrypting and decrypting database entity field values.
+ * Used in TypeORM entities to encrypt field values before storing them in the database
+ * and decrypt values when retrieving them from the database.
+ */
 export const encryptTransformer: ValueTransformer = {
+  /**
+   * Encrypts the entity field value before storing it in the database.
+   * @param {string} entityValue - Unencrypted entity field value
+   * @returns {string} - Encrypted string
+   */
   to: (entityValue: string) => encrypt(entityValue), // DB에 저장하기 전에 암호화
+
+  /**
+   * Decrypts the encrypted database value when retrieving it from the database.
+   * @param {string} databaseValue - Encrypted database field value
+   * @returns {string} - Decrypted string
+   */
   from: (databaseValue: string) => decrypt(databaseValue) // DB에서 값을 가져올 때 복호화
 }
 
+/**
+ * Encrypts the given text using the AES-256-CBC algorithm.
+ * @param {string} text - Text to encrypt
+ * @returns {string} - Encrypted string
+ */
 function encrypt(text: string): string {
   if (!text) {
     return null
@@ -25,6 +46,11 @@ function encrypt(text: string): string {
   return `${iv.toString('hex')}:${encrypted.toString('hex')}`
 }
 
+/**
+ * Decrypts the given encrypted text.
+ * @param {string} text - Encrypted text to decrypt
+ * @returns {string} - Decrypted string
+ */
 function decrypt(text: string): string {
   if (!text) {
     return null

package/server/utils/condition-builder.ts

@@ -1,13 +1,17 @@
 import _ from 'lodash'
 
-export const buildCondition = function (
-  alias: string,
-  fieldName: string,
-  operator: string,
-  value: any,
-  relation: boolean | string,
-  seq: number
-) {
+/**
+ * Generates and returns a condition clause based on the provided parameters.
+ *
+ * @param alias {string} Alias or table name of the entity.
+ * @param fieldName {string} Field or column name.
+ * @param operator {string} Comparison operator.
+ * @param value {any} Value or an array of values to compare.
+ * @param relation {boolean | string} Indicates if it's a related field or the name of the relation (optional).
+ * @param seq {number} Integer representing the order of condition generation (internal use).
+ * @returns {Object} An object containing the generated condition clause and parameters.
+ */
+export const buildCondition = function (alias: string, fieldName: string, operator: string, value: any, relation: boolean | string, seq: number) {
   seq++
 
   fieldName = _.snakeCase(fieldName)