@provis/provis-common-be-module 2.6.54 → 2.6.56

package/docs/search-conditions.md

@@ -0,0 +1,218 @@
+# Search Conditions — `findAllAndCount` / `summaryField`
+
+Panduan memakai filter pada `MainRepository` (`src/class/main.repository.ts`).
+
+Semua method query (`findAllAndCount`, `summaryField`) menerima opsi berikut:
+
+| Field               | Tipe                                      | Penggabungan                          |
+| ------------------- | ----------------------------------------- | ------------------------------------- |
+| `search`            | `ISearchQuery[]`                          | semua di-**AND** (filter wajib)       |
+| `additionalSearchOr`| `(ISearchQuery[] \| ISearchOrGroup)[]`    | antar-grup **AND**, isi grup **OR**   |
+| `relations`         | `IMultiJoin[]`                            | join + kondisi                        |
+| `subqueryIns`       | `ISubqueryIn[]`                           | masing-masing di-**AND** ke query     |
+
+Bentuk `ISearchQuery`:
+
+```ts
+interface ISearchQuery {
+  query: string; // fragmen SQL, mis. 'status = :status' atau 'status IN (:...statuses)'
+  key: string;   // nama parameter
+  value: string | number | boolean | Date;
+}
+```
+
+---
+
+## 1. `search` — filter wajib (AND)
+
+```ts
+search: [
+  { query: 'companyId = :companyId', key: 'companyId', value: 10 },
+  { query: 'isDeleted = :isDeleted', key: 'isDeleted', value: false },
+]
+```
+
+```sql
+WHERE model.companyId = :companyId AND model.isDeleted = :isDeleted
+```
+
+---
+
+## 2. `additionalSearchOr` — grup OR
+
+Tiap **grup** di-AND-kan satu sama lain; **anggota dalam satu grup** di-OR-kan. Berguna untuk pencarian kata kunci di beberapa kolom.
+
+```ts
+additionalSearchOr: [
+  [
+    { query: 'policyNumber ILIKE :kw', key: 'kw', value: '%123%' },
+    { query: 'certificateNumber ILIKE :kw2', key: 'kw2', value: '%123%' },
+  ],
+]
+```
+
+```sql
+AND (model.policyNumber ILIKE :kw OR model.certificateNumber ILIKE :kw2)
+```
+
+> Catatan: pakai key parameter yang **unik** per kondisi agar tidak saling menimpa.
+
+---
+
+## 3. `subqueryIns` — `column IN (subquery)`
+
+Mencocokkan kolom table utama terhadap hasil sebuah subquery. Tiap entri di-**AND**-kan ke query utama.
+
+Bentuk `ISubqueryIn`:
+
+```ts
+interface ISubqueryIn {
+  column: string;               // kolom pada table utama (sisi kiri IN)
+  subqueryTable: string;        // table sumber subquery
+  subqueryAlias?: string;       // alias table subquery
+  subquerySelectColumn: string; // kolom yang di-SELECT subquery (sisi kanan IN)
+  searchs?: ISearchQuery[];           // kondisi di dalam subquery, di-AND
+  additionalSearchOr?: ISearchQuery[][]; // kondisi OR di dalam subquery
+}
+```
+
+### Contoh — kondisi AND di dalam subquery
+
+```ts
+subqueryIns: [{
+  column: 'id',
+  subqueryTable: 'declarationAttachment',
+  subqueryAlias: 'da',
+  subquerySelectColumn: 'declarationId',
+  searchs: [
+    { query: 'containerNo = :cn', key: 'cn', value: 'ABC123' },
+    { query: 'isActive = :ia', key: 'ia', value: true },
+  ],
+}]
+```
+
+```sql
+AND model.id IN (
+  SELECT da.declarationId FROM declarationAttachment da
+  WHERE da.containerNo = :cn AND da.isActive = :ia
+)
+```
+
+### Contoh — kondisi OR di dalam subquery
+
+Pakai `additionalSearchOr` (satu grup → anggotanya OR):
+
+```ts
+subqueryIns: [{
+  column: 'id',
+  subqueryTable: 'declarationAttachment',
+  subqueryAlias: 'da',
+  subquerySelectColumn: 'declarationId',
+  additionalSearchOr: [[
+    { query: 'containerNo LIKE :cn', key: 'cn', value: '%X%' },
+    { query: 'sealNo LIKE :sn', key: 'sn', value: '%X%' },
+  ]],
+}]
+```
+
+```sql
+AND model.id IN (
+  SELECT da.declarationId FROM declarationAttachment da
+  WHERE (da.containerNo LIKE :cn OR da.sealNo LIKE :sn)
+)
+```
+
+---
+
+## 4. Subquery sebagai bagian dari grup OR (`ISearchOrGroup`)
+
+Kalau pencarian `IN (subquery)` harus di-**OR**-kan bersama field text search (mis. "cocok kalau field declaration cocok **ATAU** attachment-nya cocok"), masukkan subquery ke dalam grup `additionalSearchOr` berbentuk objek:
+
+```ts
+interface ISearchOrGroup {
+  searchs?: ISearchQuery[];     // kondisi field di table utama
+  subqueryIns?: ISubqueryIn[];  // subquery IN, di-OR-kan dengan searchs
+}
+```
+
+Semua anggota grup (`searchs` + `subqueryIns`) digabung **OR** di dalam satu bracket, lalu bracket itu di-**AND**-kan ke query (jadi filter wajib tetap berlaku).
+
+### Contoh lengkap
+
+```ts
+const attachmentSearchs = [
+  { query: 'containerNo LIKE :cn', key: 'cn', value: '%X%' },
+  { query: 'sealNo LIKE :sn', key: 'sn', value: '%X%' },
+];
+
+const attachmentSubquery = {
+  column: 'id',
+  subqueryTable: 'declarationAttachment',
+  subqueryAlias: 'da',
+  subquerySelectColumn: 'declarationId',
+  additionalSearchOr: [attachmentSearchs], // (da.containerNo LIKE :cn OR da.sealNo LIKE :sn)
+};
+
+const [total, data] = await repo.findAllAndCount({
+  search: [
+    { query: 'companyId = :companyId', key: 'companyId', value: 10 }, // filter wajib (AND)
+  ],
+  additionalSearchOr: [
+    {
+      searchs: [
+        { query: 'policyNumber ILIKE :kw', key: 'kw', value: '%X%' },
+        { query: 'certificateNumber ILIKE :kw2', key: 'kw2', value: '%X%' },
+      ],
+      subqueryIns: [attachmentSubquery],
+    },
+  ],
+});
+```
+
+```sql
+WHERE model.companyId = :companyId          -- filter wajib, AND
+  AND (
+    model.policyNumber ILIKE :kw
+    OR model.certificateNumber ILIKE :kw2
+    OR model.id IN (
+      SELECT da.declarationId FROM declarationAttachment da
+      WHERE (da.containerNo LIKE :cn OR da.sealNo LIKE :sn)
+    )
+  )
+```
+
+### Menyisipkan subquery ke grup `searchOr` yang sudah ada
+
+Kalau grup OR dibangun dari `searchBracket(search.searchOr, ...)`, sisipkan subquery ke grup pertama:
+
+```ts
+const searchOrGroups = search.searchOr
+  ? await repo.searchBracket(search.searchOr, this.searchValueDeclaration)
+  : [];
+
+const additionalSearchOr = (() => {
+  if (attachmentSearchs.length === 0) return searchOrGroups;
+  if (searchOrGroups.length === 0)   return [{ subqueryIns: [attachmentSubquery] }];
+  return searchOrGroups.map((g, i) =>
+    i === 0 ? { searchs: g, subqueryIns: [attachmentSubquery] } : g
+  );
+})();
+
+const [total, data] = await repo.findAllAndCount({
+  search: this.searchValueDeclaration(search, user),
+  additionalSearchOr,
+  maxCount, offset, sortBy: search.sortBy,
+});
+```
+
+---
+
+## Ringkasan AND vs OR
+
+| Mau...                                              | Pakai                                                        |
+| --------------------------------------------------- | ----------------------------------------------------------- |
+| Filter wajib (selalu berlaku)                       | `search`                                                    |
+| OR antar beberapa kolom (search box)                | `additionalSearchOr: [[ ... ]]`                             |
+| `col IN (subquery)`, di-AND ke query                | `subqueryIns: [ ... ]`                                      |
+| OR **di dalam** subquery                            | `subqueryIns[].additionalSearchOr`                          |
+| `col IN (subquery)` di-**OR** dengan field lain     | grup objek `{ searchs, subqueryIns }` di `additionalSearchOr` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@provis/provis-common-be-module",
-  "version": "2.6.54",
+  "version": "2.6.56",
   "description": "This common module for Provis internal backend use lib",
   "main": "dist/index.js",
   "scripts": {

package/dist/constants/bankAccount.d.ts

@@ -1,8 +0,0 @@
-declare const bankAccount: {
-    code: string;
-    desc: {
-        id: string;
-        en: string;
-    };
-}[];
-export default bankAccount;

package/dist/constants/bankAccount.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const bankAccount = [
-    {
-        code: 'BCA2000',
-        desc: {
-            id: 'BCA 5455682000',
-            en: 'BCA 5455682000',
-        }
-    },
-    {
-        code: 'BCA2999',
-        desc: {
-            id: 'BCA 5455682999',
-            en: 'BCA 5455682999',
-        }
-    },
-    {
-        code: 'OCBC371-IDR',
-        desc: {
-            id: 'OCBC IDR 111800004371',
-            en: 'OCBC IDR 111800004371',
-        }
-    },
-    {
-        code: 'OCBC371-USD',
-        desc: {
-            id: 'OCBC USD 111800004371',
-            en: 'OCBC USD 111800004371',
-        }
-    },
-    {
-        code: 'PERMATA4371',
-        desc: {
-            id: 'Permata 0980-9340-683',
-            en: 'Permata 0980-9340-683',
-        }
-    },
-    {
-        code: 'PERMATA4371',
-        desc: {
-            id: 'QNB 1220-004544-001',
-            en: 'QNB 1220-004544-001',
-        }
-    },
-    {
-        code: 'BTPN3068',
-        desc: {
-            id: 'BTPN Syariah 1035883068',
-            en: 'BTPN Syariah 1035883068',
-        }
-    },
-];
-exports.default = bankAccount;

package/dist/constants/product/coretax.d.ts

@@ -1,12 +0,0 @@
-declare const coretax: {
-    STATUS: {
-        DRAFT: string;
-        SUBMIT: string;
-        CANCEL: string;
-    };
-    TYPE_CORETAX: {
-        CREATE: string;
-        UPDATE: string;
-    };
-};
-export default coretax;

package/dist/constants/product/coretax.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const coretax = {
-    STATUS: {
-        DRAFT: "0",
-        SUBMIT: "100",
-        CANCEL: "300",
-    },
-    TYPE_CORETAX: {
-        CREATE: "CREATE",
-        UPDATE: "UPDATE"
-    },
-};
-exports.default = coretax;

package/dist/constants/product/mv.d.ts

@@ -1,30 +0,0 @@
-declare const insuranceType: {
-    code: string;
-    desc: {
-        id: string;
-        en: string;
-    };
-}[];
-declare const regionCode: {
-    code: string;
-    desc: {
-        id: string;
-        en: string;
-    };
-}[];
-declare const vehicleTypeCode: {
-    code: string;
-    desc: {
-        id: string;
-        en: string;
-    };
-}[];
-declare const additionalCoverage: {
-    code: string;
-    desc: {
-        id: string;
-        en: string;
-    };
-    isVisible: boolean;
-}[];
-export { insuranceType, regionCode, vehicleTypeCode, additionalCoverage, };

package/dist/constants/product/mv.js

@@ -1,158 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.additionalCoverage = exports.vehicleTypeCode = exports.regionCode = exports.insuranceType = void 0;
-const insuranceType = [
-    {
-        code: "all-risk",
-        desc: {
-            id: "Komprehensif",
-            en: "Comprehensive",
-        },
-    },
-    {
-        code: "total-loss",
-        desc: {
-            id: "Kerugian Total",
-            en: "Total Loss",
-        },
-    },
-];
-exports.insuranceType = insuranceType;
-const regionCode = [
-    {
-        code: "RC001",
-        desc: {
-            id: "Wilayah 1",
-            en: "Region 1",
-        },
-    },
-    {
-        code: "RC002",
-        desc: {
-            id: "Wilayah 2",
-            en: "Region 2",
-        },
-    },
-    {
-        code: "RC003",
-        desc: {
-            id: "Wilayah 3",
-            en: "Region 3",
-        },
-    },
-];
-exports.regionCode = regionCode;
-const vehicleTypeCode = [
-    {
-        code: "VT001",
-        desc: {
-            id: "Jenis Kendaraan Non Bus dan Non Truk",
-            en: "Types of Non-Bus and Non-Truck Vehicles",
-        },
-    },
-    {
-        code: "VT002",
-        desc: {
-            id: "Jenis Kendaraan Truk dan Pickup",
-            en: "Vehicle Types Truck and Pickup",
-        },
-    },
-    {
-        code: "VT003",
-        desc: {
-            id: "Jenis Kendaraan Bus",
-            en: "Vehicle Types Bus",
-        },
-    },
-    {
-        code: "VT004",
-        desc: {
-            id: "Jenis Kendaraan Roda 2 (dua)",
-            en: "Type of 2 (two) Wheeled Vehicle",
-        },
-    },
-];
-exports.vehicleTypeCode = vehicleTypeCode;
-const additionalCoverage = [
-    {
-        code: "TSFWD",
-        desc: {
-            id: "Topan, Badai, Banjir, Kerusakan Akibat Air",
-            en: "Typhoon, Storm, Flood, Water Damage",
-        },
-        isVisible: true,
-    },
-    {
-        code: "EQVET",
-        desc: {
-            id: "Gempa Bumi, Letusan Gunung Berapi dan Tsunami",
-            en: "Earthquake, Volcanic Eruption and Tsunami",
-        },
-        isVisible: true,
-    },
-    {
-        code: "SRCC",
-        desc: {
-            id: "Mogok Kerja, Kerusuhan dan Kerusuhan Sipil",
-            en: "Strike, Riot & Civil Commotion",
-        },
-        isVisible: true,
-    },
-    {
-        code: "PSATSI",
-        desc: {
-            id: "Terorisme dan Sabotase",
-            en: "Terrorism and Sabotage",
-        },
-        isVisible: true,
-    },
-    {
-        code: "TPL",
-        desc: {
-            id: "Tanggung Jawab Hukum Pihak Ketiga",
-            en: "Third Party Liability",
-        },
-        isVisible: true,
-    },
-    {
-        code: "PAD",
-        desc: {
-            id: "Kecelakaan Pengemudi",
-            en: "Personal Accident Driver",
-        },
-        isVisible: true,
-    },
-    {
-        code: "PAP",
-        desc: {
-            id: " Kcelakaan Penumpang",
-            en: "Personal Accident Passenger",
-        },
-        isVisible: true,
-    },
-    {
-        code: "TBOD",
-        desc: {
-            id: "Biaya Medis, Izin Bengkel, Tunjangan Ambulans, Ban dan Velg",
-            en: "TBOD, Authorize Workshop, Ambulance Allowance, Tire and Wheel",
-        },
-        isVisible: true,
-    },
-    {
-        code: "CASCO",
-        desc: {
-            id: "",
-            en: "",
-        },
-        isVisible: false,
-    },
-    {
-        code: "TLO",
-        desc: {
-            id: "",
-            en: "",
-        },
-        isVisible: false,
-    },
-];
-exports.additionalCoverage = additionalCoverage;

package/dist/constants/product/property/occupation.d.ts

@@ -1,5 +0,0 @@
-declare const ocupation: {
-    id: number;
-    name: string;
-}[];
-export default ocupation;