@tagsamurai/fats-api-services 2.0.0-alpha.16 → 2.0.0-alpha.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tagsamurai/fats-api-services",
-  "version": "2.0.0-alpha.16",
+  "version": "2.0.0-alpha.18",
   "type": "module",
   "author": "Tagsamurai",
   "description": "Fixed Asset Tagsamurai API Services",

package/src/dto/hardware.dto.d.ts

@@ -0,0 +1,123 @@
+import { Tab } from '../types/hardware.type';
+import { TableParams } from './dataTable.dto';
+export interface HandheldFilterRaw extends TableParams {
+    tab?: Tab;
+    deviceName?: string[];
+    type?: string[];
+    status?: string[];
+    sku?: string[];
+    group?: string[];
+    reportedBy?: string[];
+    reportedAt?: number[];
+}
+export interface HandheldOptions {
+    tab?: Tab;
+    deviceNameOptions?: boolean;
+    skuOptions?: boolean;
+    reportedByOptions?: boolean;
+}
+export type DetailTableFilterParams = {
+    createdAt?: string;
+    activity?: string;
+    assetName?: string;
+    assignedTo?: string;
+    borrower?: string;
+    type?: string;
+    condition?: string;
+    reportedBy?: string;
+    staff?: string;
+    manager?: string;
+    group?: string;
+    tag?: string;
+};
+export interface SmartFixedFilterRaw extends TableParams {
+    tab?: Tab;
+    deviceName?: string[];
+    sku?: string[];
+    networkStatus?: string[];
+    brand?: string[];
+    model?: string[];
+    type?: string[];
+    readerGroup?: string[];
+    portGroup?: string[];
+    status?: string[];
+    reportedBy?: string[];
+    reportedAt?: number[];
+}
+export interface SmartFixedOptions {
+    tab?: Tab;
+    deviceNameOptions?: boolean;
+    skuOptions?: boolean;
+    brandOptions?: boolean;
+    modelOptions?: boolean;
+    typeOptions?: boolean;
+    reportedByOptions?: boolean;
+}
+export interface TabletFilterRaw extends TableParams {
+    tab?: Tab;
+    deviceName?: string[];
+    status?: string[];
+    group?: string[];
+    reader?: string[];
+    registeredAt?: number[];
+    reportedBy?: string[];
+    reportedAt?: number[];
+}
+export interface TabletOptions {
+    tab?: Tab;
+    statusOptions?: boolean;
+    deviceNameOptions?: boolean;
+    readerOptions?: boolean;
+    reportedByOptions?: boolean;
+}
+export interface PutEditAliasName {
+    aliasName: string | null;
+}
+export interface PostActivateHardware {
+    serialNumber: string;
+    licenseKey: string;
+    hardwareId: string;
+}
+export interface DeleteHardware {
+    ids: string[];
+}
+export interface PutEditReaderGroup {
+    fixedAssetGroup?: string;
+    supplyAssetGroup?: string;
+}
+export interface PutEditSmartFixedReader {
+    antennaPower: number[];
+    rssi: number;
+}
+export interface SmartFixedReaderBody extends PutEditSmartFixedReader {
+    type: 'Smart Fixed Reader';
+    smartFixedReaderGroup?: SmartFixedReaderGroup;
+    portGroup?: SmartFixedReaderGroup[];
+}
+export interface AssetControlBody extends PutEditSmartFixedReader {
+    type: 'Asset Control';
+    assetControlSize: 'Small' | 'Medium' | 'Large';
+    assetControlReaderGroup: AssetControlReaderGroup;
+    portDirection: string[];
+}
+interface AssetControlReaderGroup {
+    fixedAsset?: FixedAsset;
+    supplyAsset?: FixedAsset;
+}
+interface FixedAsset {
+    group?: string;
+    isRoleRestricted: boolean;
+    receivingGroups: string[];
+}
+export interface SmartFixedReaderGroup {
+    fixedAsset?: string;
+    supplyAsset?: string;
+}
+export interface PostPingReadersBody {
+    ids: string[];
+}
+export interface PutHardwareStatusBody {
+    status: 'Missing' | 'Damaged' | 'Available';
+}
+export type HardwareFormType = PutEditAliasName | PutHardwareStatusBody | PutEditReaderGroup;
+export {};

package/src/services/hardware.service.d.ts

@@ -0,0 +1,28 @@
+import { AxiosResponse } from 'axios';
+import { FetchDetailResponse, FetchListResponse, FetchOptionResponse, FilterQuery, ShortFetchListResponse } from '../types/fetchResponse.type';
+import { AssetControlBody, DeleteHardware, HandheldFilterRaw, HandheldOptions, PostActivateHardware, PostPingReadersBody, PutEditAliasName, PutEditReaderGroup, PutHardwareStatusBody, SmartFixedFilterRaw, SmartFixedOptions, SmartFixedReaderBody, TabletFilterRaw, TabletOptions } from '../dto/hardware.dto';
+import { HandheldDataType, HandheldDetailDataType, PingSmartFixed, SmartFixedDataType, SmartFixedDetailDataType, Tablet } from '../types/hardware.type';
+declare const HardwareServices: {
+    getHandheldReader: (params?: FilterQuery<HandheldFilterRaw>) => Promise<AxiosResponse<FetchListResponse<HandheldDataType>>>;
+    getHandheldReaderDetail: (handheldId?: string) => Promise<AxiosResponse<FetchDetailResponse<HandheldDetailDataType>>>;
+    getHandheldReaderOptions: (body?: HandheldOptions) => Promise<AxiosResponse<{
+        data: FetchOptionResponse<HandheldOptions>;
+    }>>;
+    putHardwareStatus: (moduleTab: "smart-fixed-readers" | "handheld-readers" | "tablets", ids: string[], body: PutHardwareStatusBody) => Promise<AxiosResponse>;
+    postPingReaders: (body: PostPingReadersBody) => Promise<AxiosResponse<ShortFetchListResponse<PingSmartFixed>>>;
+    putEditReaderGroup: (moduleTab: "smart-fixed-readers" | "handheld-readers", body: PutEditReaderGroup, hardwareId?: string) => Promise<AxiosResponse>;
+    putEditAliasName: (moduleTab: "smart-fixed-readers" | "handheld-readers", body: PutEditAliasName, hardwareId?: string) => Promise<AxiosResponse>;
+    postActivateHardware: (moduleTab: "smart-fixed-readers" | "handheld-readers", body: PostActivateHardware) => Promise<AxiosResponse>;
+    deleteHardware: (moduleTab: "smart-fixed-readers" | "handheld-readers" | "tablets", params?: DeleteHardware) => Promise<AxiosResponse>;
+    getSmartFixedReader: (params?: FilterQuery<SmartFixedFilterRaw>) => Promise<AxiosResponse<FetchListResponse<SmartFixedDataType>>>;
+    getSmartFixedReaderDetail: (smartFixedId?: string) => Promise<AxiosResponse<FetchDetailResponse<SmartFixedDetailDataType>>>;
+    getSmartFixedReaderOptions: (params?: SmartFixedOptions) => Promise<AxiosResponse<{
+        data: FetchOptionResponse<SmartFixedOptions>;
+    }>>;
+    putEditSmartFixedReader: (id: string, body: SmartFixedReaderBody | AssetControlBody) => Promise<AxiosResponse>;
+    getTablet: (params?: FilterQuery<TabletFilterRaw>) => Promise<AxiosResponse<FetchListResponse<Tablet>>>;
+    getTabletOptions: (params?: TabletOptions) => Promise<AxiosResponse<{
+        data: FetchOptionResponse<TabletOptions>;
+    }>>;
+};
+export default HardwareServices;

package/src/types/fetchResponse.type.d.ts

@@ -8,6 +8,15 @@ export type FetchListResponse<T = Data> = {
         totalRecords: number;
     };
 };
+export type ShortFetchListResponse<T = Data> = {
+    status: number;
+    message: string;
+    data: T[];
+};
+export type FetchResponse = {
+    status: number;
+    message: string;
+};
 export type FetchDetailResponse<T = Data> = {
     status: number;
     message: string;

package/src/types/hardware.type.d.ts

@@ -0,0 +1,140 @@
+import { FetchResponse } from './fetchResponse.type';
+export type HardwareTabType = 'activity-log' | 'handheld-damaged-missing' | 'handheld' | 'iot-reader' | 'iot-antenna' | 'iot-damaged-missing-reader' | 'iot-damaged-missing-antenna';
+export type HardwareDetailTabType = 'All' | 'Tagging' | 'User' | 'Antenna' | 'Changelog';
+export type ModuleType = 'fixedAsset' | 'supplyAsset';
+export type Tab = 'Available' | 'Damaged/Missing';
+export interface HardwareDetailDataType {
+    _id: string;
+    image: string | null;
+    deviceName: string;
+    sku: string;
+    serialNumber: string;
+    aliasName: string | null;
+}
+export interface HandheldDetailDataType extends HardwareDetailDataType {
+    type: string;
+    status: string;
+    group: ReaderGroup;
+}
+export interface HandheldDataType extends HandheldDetailDataType {
+    reportedBy: string | null;
+    reportedAt: Date | null;
+}
+export interface ReaderGroup {
+    fixedAsset?: {
+        _id: string;
+        name: string;
+    };
+    supplyAsset?: {
+        _id: string;
+        name: string;
+    };
+}
+export interface ListReaderGroup {
+    module: ModuleType;
+    _id: string;
+    name: string;
+}
+export interface SmartFixedGroup {
+    fixedAsset?: string;
+    supplyAsset?: string;
+}
+export interface SmartFixedGroupList {
+    fixedAsset: (string | null)[];
+    supplyAsset: (string | null)[];
+}
+export interface SmartFixedDetailDataType extends HardwareDetailDataType {
+    activePort: string;
+    networkStatus: string;
+    brand: string;
+    model: string;
+    type: string;
+    readerGroup: SmartFixedGroup;
+    rssi: string;
+}
+export interface SmartFixedDataType extends Omit<SmartFixedDetailDataType, 'rssi'> {
+    connectedTablet: number;
+    status: string;
+    portGroup: SmartFixedGroupList;
+    reportedBy: string | null;
+    reportedAt: Date | null;
+}
+export interface Tablet {
+    _id: string;
+    deviceName: string;
+    deviceId: string;
+    status: string;
+    group: ReaderGroup;
+    reader: string | null;
+    aliasName: string | null;
+    registeredAt: Date;
+    reportedBy: string | null;
+    reportedAt: Date | null;
+}
+export interface PingSmartFixed {
+    _id: string;
+    isOnline: boolean;
+}
+export interface HardwareDetailUserActivity {
+    _id: string;
+    createdAt: string;
+    userFullName?: string;
+    user?: string;
+    action?: string;
+    objectName?: string;
+    field?: string;
+    oldValue?: string;
+    newValue?: string;
+    modifiedBy?: string;
+}
+export type TAGResponseType = {
+    _id: string;
+    rfidCode: string | null;
+    nfcCode: string | null;
+    qrCode: string | null;
+    tagType: string;
+    rfidSku: string | null;
+    nfcSku: string | null;
+    type: string;
+    status: string;
+    lastScanned: string;
+};
+export type NotPairedYetCounts = {
+    rfid: {
+        available: number;
+        damagedMissing: number;
+    };
+    nfc: {
+        available: number;
+        damagedMissing: number;
+    };
+};
+export type NotPairedModule = 'RFID' | 'NFC';
+export type AuditTAGDetailResponse = FetchResponse & {
+    data: AuditTAGDetail;
+};
+export type NotPairedYetCountsResponse = FetchResponse & {
+    data: NotPairedYetCounts;
+};
+export type AuditTAGDetail = {
+    found: {
+        total: number;
+        qr: number;
+        rfid: number;
+        nfc: number;
+        rfidNfc: number;
+        rfidQr: number;
+        nfcQr: number;
+        rfidNfcQr: number;
+    };
+    notFound: {
+        total: number;
+        qr: number;
+        rfid: number;
+        nfc: number;
+        rfidNfc: number;
+        rfidQr: number;
+        nfcQr: number;
+        rfidNfcQr: number;
+    };
+};