@pensasystems/pensa-react-native 0.1.0-beta.1 → 0.1.1

package/src/index.tsx

@@ -1,4 +1,11 @@
 import { NativeModules, Platform } from 'react-native';
+import type {
+  PensaOnDemandReport,
+  PensaScanStatus,
+  PensaShelfItem,
+  PensaVisitScansStatus,
+} from './types';
+import { PensaReportType } from './types';
 
 const LINKING_ERROR =
   `The package 'pensa-sdk-react-native' doesn't seem to be linked. Make sure: \n\n` +
@@ -73,5 +80,54 @@ export const showStoreChecklist = (
   );
 };
 
+export const showStoreChecklistWithGuid = (
+  globalStoreId: string,
+  guid: string
+): Promise<void> => {
+  return PensaSdkReactNative.showStoreChecklistWithGuid(globalStoreId, guid);
+};
+
+export const fetchScanStatuses = (
+  scanIds: number[]
+): Promise<PensaScanStatus[]> => {
+  return PensaSdkReactNative.fetchScanStatuses(scanIds);
+};
+
+export function fetchOnDemandReports(params: {
+  scanId?: number | null;
+  guid?: string | null;
+  projectId?: number | null;
+  reportTypes?: PensaReportType[];
+}): Promise<PensaOnDemandReport> {
+  const finalReportTypes =
+    params.reportTypes && params.reportTypes.length > 0
+      ? params.reportTypes
+      : [PensaReportType.ITEMS_SEEN];
+
+  return PensaSdkReactNative.fetchOnDemandReports(
+    params.scanId ?? null,
+    params.guid ?? null,
+    params.projectId ?? null,
+    finalReportTypes
+  );
+}
+
+export const fetchVisitScansStatus = (
+  guid: string
+): Promise<PensaVisitScansStatus> => {
+  return PensaSdkReactNative.fetchVisitScansStatus(guid);
+};
+
+export const fetchProductImageBase64 = (productId: number): Promise<string> => {
+  return PensaSdkReactNative.fetchProductImageBase64(productId);
+};
+
+export const fetchShelves = (
+  globalStoreId: string
+): Promise<PensaShelfItem[]> => {
+  return PensaSdkReactNative.fetchShelves(globalStoreId);
+};
+
 export * from './events';
 export * from './types';
+export { PensaReportType } from './types';

package/src/types.ts

@@ -21,9 +21,143 @@ export type OnCantScanReported = {
   reason: string;
 };
 
+export type OnScanCompletedWithGuid = {
+  guid: string | null;
+  tdlinxId: string;
+  scanId: number;
+};
+
 export type PensaEventPayloads = {
   onScanUploadProgressUpdate: OnScanUploadProgressUpdate;
   onScanUploadCompleted: OnScanUploadCompleted;
   onScanUploadFailed: OnScanUploadFailed;
   onCantScanReported: OnCantScanReported;
+  onScanCompletedWithGuid: OnScanCompletedWithGuid;
+};
+
+export type PensaScanMetadata = {
+  guid: string | null;
+  serverUploadStarted: string | null;
+};
+
+export type PensaScanStatus = {
+  created: string | null;
+  fastStatus: string | null;
+  id: number;
+  metadata: PensaScanMetadata | null;
+  scanTimestamp: string | null;
+  scannerId: string | null;
+  status: string | null;
+};
+
+export type PensaOnDemandProduct = {
+  brand: string | null;
+  brandId: number | null;
+  category: string | null;
+  categoryId: number | null;
+  expectedFacings: number | null;
+  facings: number | null;
+  manufacturer: string | null;
+  manufacturerId: number | null;
+  product: string | null;
+  productId: number | null;
+  upc: string | null;
+};
+
+export type PensaOnDemandReportBucket = {
+  productList: PensaOnDemandProduct[];
+};
+
+export type PensaOnDemandScan = {
+  facingsSeen: PensaOnDemandReportBucket | null;
+  fullFacings: PensaOnDemandReportBucket | null;
+  fullFacingsAndProductPositions: PensaOnDemandReportBucket | null;
+  itemsSeen: PensaOnDemandReportBucket | null;
+  newProducts: PensaOnDemandReportBucket | null;
+  newProductPackaging: PensaOnDemandReportBucket | null;
+  missingPriceTag: PensaOnDemandReportBucket | null;
+  noOos: PensaOnDemandReportBucket | null;
+  oos: PensaOnDemandReportBucket | null;
+  productPositions: PensaOnDemandReportBucket | null;
+  scanFailed: PensaOnDemandReportBucket | null;
+  scanRejected: PensaOnDemandReportBucket | null;
+  scanSkipped: PensaOnDemandReportBucket | null;
+  projectId: number | null;
+  projectName: string | null;
+  projectReportId: number | null;
+  projectReportName: string | null;
+  realogramSignedUrl: string | null;
+  scanId: number | null;
+  shelfId: number | null;
+  shelfName: string | null;
+  status: string | null;
+};
+
+export type PensaOnDemandVisit = {
+  endTime: string | null;
+  identifier: string | null;
+  startTime: string | null;
+  storeName: string | null;
+  storeTdlinx: string | null;
+};
+
+export type PensaOnDemandReport = {
+  facingsSeen: PensaOnDemandReportBucket | null;
+  fullFacings: PensaOnDemandReportBucket | null;
+  fullFacingsAndProductPositions: PensaOnDemandReportBucket | null;
+  itemsSeen: PensaOnDemandReportBucket | null;
+  newProducts: PensaOnDemandReportBucket | null;
+  newProductPackaging: PensaOnDemandReportBucket | null;
+  missingPriceTag: PensaOnDemandReportBucket | null;
+  noOos: PensaOnDemandReportBucket | null;
+  oos: PensaOnDemandReportBucket | null;
+  productPositions: PensaOnDemandReportBucket | null;
+  scanFailed: PensaOnDemandReportBucket | null;
+  scanRejected: PensaOnDemandReportBucket | null;
+  scanSkipped: PensaOnDemandReportBucket | null;
+  projectId: number | null;
+  projectName: string | null;
+  projectReportId: number | null;
+  projectReportName: string | null;
+  realogramSignedUrl: string | null;
+  shelfId: number | null;
+  shelfName: string | null;
+  status: string | null;
+  scans: PensaOnDemandScan[] | null;
+  visit: PensaOnDemandVisit | null;
+};
+
+export type PensaVisitScanItem = {
+  created: string | null;
+  fastStatus: string | null;
+  scanId: number | null;
+  status: string | null;
+  uploadCompleted: boolean | null;
+};
+
+export type PensaVisitScansStatus = {
+  guid: string | null;
+  scans: PensaVisitScanItem[] | null;
+  visitStatus: string | null;
+};
+
+export enum PensaReportType {
+  FACINGS_SEEN = 'FACINGS_SEEN',
+  FULL_FACINGS = 'FULL_FACINGS',
+  FULL_FACINGS_AND_PRODUCT_POSITIONS = 'FULL_FACINGS_AND_PRODUCT_POSITIONS',
+  ITEMS_SEEN = 'ITEMS_SEEN',
+  NEW_PRODUCTS = 'NEW_PRODUCTS',
+  NEW_PRODUCT_PACKAGING = 'NEW_PRODUCT_PACKAGING',
+  MISSING_PRICE_TAG = 'MISSING_PRICE_TAG',
+  NO_OOS = 'NO_OOS',
+  OOS = 'OOS',
+  PRODUCT_POSITIONS = 'PRODUCT_POSITIONS',
+  SCAN_FAILED = 'SCAN_FAILED',
+  SCAN_REJECTED = 'SCAN_REJECTED',
+  SCAN_SKIPPED = 'SCAN_SKIPPED',
+}
+
+export type PensaShelfItem = {
+  id: number;
+  name: string | null;
 };