@open-tender/store 0.1.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Open Tender Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Open Tender Store
+
+An library of hooks, reducers, utility functions, and types for use with Open Tender applications that utilize our in-store POS API.

package/dist/cjs/app/hooks.d.ts

@@ -0,0 +1,34 @@
+import { TypedUseSelectorHook } from 'react-redux';
+import type { RootState } from './store';
+export declare const useAppDispatch: () => import("redux-thunk").ThunkDispatch<import("redux").CombinedState<{
+    alerts: import("..").Alerts;
+    arrivals: import("..").ArrivalsState;
+    checkout: import("..").CheckoutState;
+    completedOrders: import("..").CompletedOrdersState;
+    config: import("..").ConfigState;
+    discounts: import("..").DiscountsState;
+    errorAlerts: import("..").ErrorAlertsState;
+    kds: {
+        sidebar: boolean;
+        page: null;
+        view: null;
+        order: null;
+        businessDate: null;
+        alarm: boolean;
+    };
+    menu: import("..").MenuState;
+    menuPages: import("..").MenuPagesState;
+    modal: import("..").ModalState;
+    notifications: import("..").Notifications;
+    offlineAuths: import("..").OfflineAuthsState;
+    order: import("..").OrderState;
+    orders: import("..").OrdersState;
+    pos: import("..").PosState;
+    punches: import("..").PunchesState;
+    refund: import("..").RefundState;
+    settings: import("..").SettingsState;
+    sidebar: import("..").SidebarState;
+    surcharges: import("..").SurchargesState;
+    taxes: import("..").TaxesState;
+}>, undefined, import("redux").AnyAction> & import("redux").Dispatch<import("redux").Action<any>>;
+export declare const useAppSelector: TypedUseSelectorHook<RootState>;

package/dist/cjs/app/hooks.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAppSelector = exports.useAppDispatch = void 0;
+var react_redux_1 = require("react-redux");
+// Use throughout your app instead of plain `useDispatch` and `useSelector`
+var useAppDispatch = function () { return (0, react_redux_1.useDispatch)(); };
+exports.useAppDispatch = useAppDispatch;
+exports.useAppSelector = react_redux_1.useSelector;
+//# sourceMappingURL=hooks.js.map

package/dist/cjs/app/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/app/hooks.ts"],"names":[],"mappings":";;;AAAA,2CAA6E;AAG7E,2EAA2E;AACpE,IAAM,cAAc,GAAG,cAAM,OAAA,IAAA,yBAAW,GAAe,EAA1B,CAA0B,CAAC;AAAlD,QAAA,cAAc,kBAAoC;AAClD,QAAA,cAAc,GAAoC,yBAAW,CAAC"}

package/dist/cjs/app/index.d.ts

@@ -0,0 +1 @@
+export * from './store';

package/dist/cjs/app/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./store"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/app/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/index.ts"],"names":[],"mappings":";;;AAAA,kDAAuB"}

package/dist/cjs/app/store.d.ts

@@ -0,0 +1,98 @@
+import { Action, ThunkAction } from '@reduxjs/toolkit';
+export declare const appReducer: import("redux").Reducer<import("redux").CombinedState<{
+    alerts: import("..").Alerts;
+    arrivals: import("../slices").ArrivalsState;
+    checkout: import("../slices").CheckoutState;
+    completedOrders: import("../slices").CompletedOrdersState;
+    config: import("../slices").ConfigState;
+    discounts: import("../slices").DiscountsState;
+    errorAlerts: import("../slices").ErrorAlertsState;
+    kds: {
+        sidebar: boolean;
+        page: null;
+        view: null;
+        order: null;
+        businessDate: null;
+        alarm: boolean;
+    };
+    menu: import("../slices").MenuState;
+    menuPages: import("../slices").MenuPagesState;
+    modal: import("../slices").ModalState;
+    notifications: import("..").Notifications;
+    offlineAuths: import("../slices").OfflineAuthsState;
+    order: import("../slices").OrderState;
+    orders: import("../slices").OrdersState;
+    pos: import("../slices").PosState;
+    punches: import("../slices").PunchesState;
+    refund: import("../slices").RefundState;
+    settings: import("../slices").SettingsState;
+    sidebar: import("../slices").SidebarState;
+    surcharges: import("../slices").SurchargesState;
+    taxes: import("../slices").TaxesState;
+}>, import("redux").AnyAction>;
+export declare type AppState = ReturnType<typeof appReducer>;
+declare const store: import("@reduxjs/toolkit").EnhancedStore<import("redux").CombinedState<{
+    alerts: import("..").Alerts;
+    arrivals: import("../slices").ArrivalsState;
+    checkout: import("../slices").CheckoutState;
+    completedOrders: import("../slices").CompletedOrdersState;
+    config: import("../slices").ConfigState;
+    discounts: import("../slices").DiscountsState;
+    errorAlerts: import("../slices").ErrorAlertsState;
+    kds: {
+        sidebar: boolean;
+        page: null;
+        view: null;
+        order: null;
+        businessDate: null;
+        alarm: boolean;
+    };
+    menu: import("../slices").MenuState;
+    menuPages: import("../slices").MenuPagesState;
+    modal: import("../slices").ModalState;
+    notifications: import("..").Notifications;
+    offlineAuths: import("../slices").OfflineAuthsState;
+    order: import("../slices").OrderState;
+    orders: import("../slices").OrdersState;
+    pos: import("../slices").PosState;
+    punches: import("../slices").PunchesState;
+    refund: import("../slices").RefundState;
+    settings: import("../slices").SettingsState;
+    sidebar: import("../slices").SidebarState;
+    surcharges: import("../slices").SurchargesState;
+    taxes: import("../slices").TaxesState;
+}>, Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("redux-thunk").ThunkMiddleware<import("redux").CombinedState<{
+    alerts: import("..").Alerts;
+    arrivals: import("../slices").ArrivalsState;
+    checkout: import("../slices").CheckoutState;
+    completedOrders: import("../slices").CompletedOrdersState;
+    config: import("../slices").ConfigState;
+    discounts: import("../slices").DiscountsState;
+    errorAlerts: import("../slices").ErrorAlertsState;
+    kds: {
+        sidebar: boolean;
+        page: null;
+        view: null;
+        order: null;
+        businessDate: null;
+        alarm: boolean;
+    };
+    menu: import("../slices").MenuState;
+    menuPages: import("../slices").MenuPagesState;
+    modal: import("../slices").ModalState;
+    notifications: import("..").Notifications;
+    offlineAuths: import("../slices").OfflineAuthsState;
+    order: import("../slices").OrderState;
+    orders: import("../slices").OrdersState;
+    pos: import("../slices").PosState;
+    punches: import("../slices").PunchesState;
+    refund: import("../slices").RefundState;
+    settings: import("../slices").SettingsState;
+    sidebar: import("../slices").SidebarState;
+    surcharges: import("../slices").SurchargesState;
+    taxes: import("../slices").TaxesState;
+}>, import("redux").AnyAction, undefined>]>>;
+export declare type AppDispatch = typeof store.dispatch;
+export declare type RootState = ReturnType<typeof store.getState>;
+export declare type AppThunk<ReturnType = void> = ThunkAction<ReturnType, RootState, unknown, Action<string>>;
+export {};

package/dist/cjs/app/store.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appReducer = void 0;
+var toolkit_1 = require("@reduxjs/toolkit");
+var slices_1 = require("../slices");
+exports.appReducer = (0, toolkit_1.combineReducers)({
+    alerts: slices_1.alertsReducer,
+    arrivals: slices_1.arrivalsReducer,
+    checkout: slices_1.checkoutReducer,
+    completedOrders: slices_1.completedOrdersReducer,
+    config: slices_1.configReducer,
+    discounts: slices_1.discountsReducer,
+    errorAlerts: slices_1.errorAlertsReducer,
+    kds: slices_1.kdsReducer,
+    menu: slices_1.menuReducer,
+    menuPages: slices_1.menuPagesReducer,
+    modal: slices_1.modalReducer,
+    notifications: slices_1.notificationsReducer,
+    offlineAuths: slices_1.offlineAuthsReducer,
+    order: slices_1.orderReducer,
+    orders: slices_1.ordersReducer,
+    pos: slices_1.posReducer,
+    punches: slices_1.punchesReducer,
+    refund: slices_1.refundReducer,
+    settings: slices_1.settingsReducer,
+    sidebar: slices_1.sidebarReducer,
+    surcharges: slices_1.surchargesReducer,
+    taxes: slices_1.taxesReducer
+});
+var rootReducer = function (state, action) {
+    if (action.type === 'clearState') {
+        // clearState()
+        state = undefined;
+    }
+    return (0, exports.appReducer)(state, action);
+};
+// const persistedState = loadState()
+var store = (0, toolkit_1.configureStore)({
+    reducer: rootReducer,
+    // preloadedState: persistedState,
+    middleware: function (getDefaultMiddleware) {
+        return getDefaultMiddleware({
+            immutableCheck: false,
+            serializableCheck: false
+        });
+    }
+});
+//# sourceMappingURL=store.js.map

package/dist/cjs/app/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../../src/app/store.ts"],"names":[],"mappings":";;;AAAA,4CAKyB;AACzB,oCAuBkB;AAEL,QAAA,UAAU,GAAG,IAAA,yBAAe,EAAC;IACxC,MAAM,EAAE,sBAAa;IACrB,QAAQ,EAAE,wBAAe;IACzB,QAAQ,EAAE,wBAAe;IACzB,eAAe,EAAE,+BAAsB;IACvC,MAAM,EAAE,sBAAa;IACrB,SAAS,EAAE,yBAAgB;IAC3B,WAAW,EAAE,2BAAkB;IAC/B,GAAG,EAAE,mBAAU;IACf,IAAI,EAAE,oBAAW;IACjB,SAAS,EAAE,yBAAgB;IAC3B,KAAK,EAAE,qBAAY;IACnB,aAAa,EAAE,6BAAoB;IACnC,YAAY,EAAE,4BAAmB;IACjC,KAAK,EAAE,qBAAY;IACnB,MAAM,EAAE,sBAAa;IACrB,GAAG,EAAE,mBAAU;IACf,OAAO,EAAE,uBAAc;IACvB,MAAM,EAAE,sBAAa;IACrB,QAAQ,EAAE,wBAAe;IACzB,OAAO,EAAE,uBAAc;IACvB,UAAU,EAAE,0BAAiB;IAC7B,KAAK,EAAE,qBAAY;CACpB,CAAC,CAAA;AAIF,IAAM,WAAW,GAAG,UAAC,KAA2B,EAAE,MAAc;IAC9D,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE;QAChC,eAAe;QACf,KAAK,GAAG,SAAS,CAAA;KAClB;IACD,OAAO,IAAA,kBAAU,EAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAClC,CAAC,CAAA;AAED,qCAAqC;AAErC,IAAM,KAAK,GAAG,IAAA,wBAAc,EAAC;IAC3B,OAAO,EAAE,WAAW;IACpB,kCAAkC;IAClC,UAAU,EAAE,UAAA,oBAAoB;QAC9B,OAAA,oBAAoB,CAAC;YACnB,cAAc,EAAE,KAAK;YACrB,iBAAiB,EAAE,KAAK;SACzB,CAAC;IAHF,CAGE;CACL,CAAC,CAAA"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,5 @@
+import { appReducer } from './app/store';
+export * from './slices';
+export * from './types';
+export * from './utils';
+export { appReducer };

package/dist/cjs/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appReducer = void 0;
+var tslib_1 = require("tslib");
+var store_1 = require("./app/store");
+Object.defineProperty(exports, "appReducer", { enumerable: true, get: function () { return store_1.appReducer; } });
+tslib_1.__exportStar(require("./slices"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,qCAAwC;AAM/B,2FANA,kBAAU,OAMA;AAJnB,mDAAwB;AACxB,kDAAuB;AACvB,kDAAuB"}

package/dist/cjs/services/api.d.ts

@@ -0,0 +1,71 @@
+import { Arrivals, CashEvent, CashSummary, Config, CustomerCheckout, CustomerIdentifier, DeviceRead, Discount, Discounts, Employee, Employees, EntityType, ErrorAlert, ErrorAlerts, FetchOrdersAPIArgs, GiftCardBalance, GiftCardCredit, InternalSettings, ItemTypes, LevelUp, Menu, MenuPages, OfflineAuths, OfflineAuthsResult, Order, OrderCreate, Orders, OrderTender, OrderType, OrderUpdate, Punch, Refund, RequestedAt, RevenueCenter, SelectOptions, ServiceType, Settings, Store, Surcharges, Taxes, Tender, TicketStatusUpdate, TicketUpdate } from '../types';
+interface ConfigAPI {
+    apiUrl: string;
+}
+declare class PosAPI {
+    apiUrl: string;
+    constructor(config: ConfigAPI);
+    request: <T>(endpoint: string, method?: string, data?: any) => Promise<T | null | undefined>;
+    post(endpoint: string, data: Record<string, unknown>): Promise<Record<string, unknown> | null | undefined>;
+    getConfig(): Promise<Config | null | undefined>;
+    getStore(): Promise<Store | null | undefined>;
+    getSelectOptions(): Promise<SelectOptions | null | undefined>;
+    getItemTypes(): Promise<ItemTypes | null | undefined>;
+    getLevelUpSettings(): Promise<LevelUp | null | undefined>;
+    getCardRead(): Promise<DeviceRead | null | undefined>;
+    postCardCancel(): Promise<null | undefined>;
+    getBarcodeRead(): Promise<DeviceRead | null | undefined>;
+    postBarcodeCancel(): Promise<null | undefined>;
+    postSettings(entityType: EntityType): Promise<Settings | null | undefined>;
+    getInternalSettings(): Promise<InternalSettings | null | undefined>;
+    postInternalSettings(data: InternalSettings): Promise<InternalSettings | null | undefined>;
+    postGiftCardCredit(data: GiftCardCredit, checkOnly: boolean): Promise<GiftCardCredit | null | undefined>;
+    getGiftCardBalance(code: string | null, cardNumber?: string): Promise<GiftCardBalance | null | undefined>;
+    getEmployee(identifier: string | number): Promise<Employee | null | undefined>;
+    getCashier(): Promise<Employee | null | undefined>;
+    postCardAssign(employeeId: number, code: string): Promise<null | undefined>;
+    postCardUnassign(code: string): Promise<null | undefined>;
+    postTimePunch(data: Punch): Promise<null | undefined>;
+    getTimePunchesReport(businessDate: string, employeeId: number): Promise<Employees | null | undefined>;
+    postPrintShiftSummary(employeeId: number): Promise<null | undefined>;
+    postCashEvent(data: CashEvent): Promise<null | undefined>;
+    getCashSummary(employeeId: number): Promise<CashSummary | null | undefined>;
+    postPrintCashSummary(employeeId: number): Promise<null | undefined>;
+    getAlerts(): Promise<ErrorAlerts | null | undefined>;
+    getAlert(alertId: number): Promise<ErrorAlert | null | undefined>;
+    putAlert(alertId: number, data: ErrorAlert): Promise<ErrorAlert | null | undefined>;
+    deleteAlert(alertId: number): Promise<null | undefined>;
+    getOfflineAuths(): Promise<OfflineAuths | null | undefined>;
+    postOfflineAuths(): Promise<OfflineAuthsResult | null | undefined>;
+    getMenu(revenueCenterId: number, serviceType: ServiceType, requestedAt: RequestedAt): Promise<Menu | null | undefined>;
+    getMenuPages(): Promise<MenuPages | null | undefined>;
+    getSurcharges(serviceType: ServiceType): Promise<Surcharges | null | undefined>;
+    getDiscounts(serviceType: ServiceType, orderType: OrderType): Promise<Discounts | null | undefined>;
+    getDiscount(name: string): Promise<Discount | null | undefined>;
+    getDiscountViaQRCode(code: string): Promise<Discount | null | undefined>;
+    getTaxes(serviceType: ServiceType, orderType: OrderType): Promise<Taxes | null | undefined>;
+    getRevenueCenter(revenueCenterId: number): Promise<RevenueCenter | null | undefined>;
+    postOpenCashDrawer(): Promise<null | undefined>;
+    postTender(orderId: string, data: Tender): Promise<OrderTender | null | undefined>;
+    patchTender(orderId: string, index: number, data: Tender): Promise<OrderTender | null | undefined>;
+    postTenderVoid(orderId: string, index: number): Promise<OrderTender | null | undefined>;
+    postChipDNATender(orderId: string, data: Tender): Promise<unknown>;
+    postChipDNACancel(): Promise<null | undefined>;
+    postChipDNATmsUpdate(): Promise<null | undefined>;
+    postIdentifyCustomer(data: CustomerIdentifier): Promise<CustomerCheckout | null | undefined>;
+    postOrderValidate(order: OrderCreate): Promise<Order | null | undefined>;
+    postOrder(order: OrderCreate): Promise<Order | null | undefined>;
+    deleteOrder(order: OrderCreate): Promise<Order | null | undefined>;
+    getOrders(args: FetchOrdersAPIArgs): Promise<Orders | null | undefined>;
+    patchOrder(orderId: string, data: OrderUpdate): Promise<Order | null | undefined>;
+    postReceipt(orderId: string): Promise<Order | null | undefined>;
+    postTicketsPrint(orderId: string, data: OrderUpdate): Promise<Order | null | undefined>;
+    postTicketsReset(orderId: string): Promise<Order | null | undefined>;
+    postTicketPrint(orderId: string, ticketNo: number, data?: TicketUpdate): Promise<Order | null | undefined>;
+    postTicketStatus(orderId: string, ticketNo: number, status: TicketStatusUpdate): Promise<Order | null | undefined>;
+    getArrivals(): Promise<Arrivals | null | undefined>;
+    postAcknowledgeArrival(orderId: string): Promise<Order | null | undefined>;
+    postRefundValidate(orderId: string, refund: Refund): Promise<Order | null | undefined>;
+    postRefund(orderId: string, refund: Refund): Promise<Order | null | undefined>;
+}
+export default PosAPI;