All files / src/store types.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74                                                                                                                                                   
/*
 * Copyright 2019 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
import { Action } from 'redux';
import { ThunkAction } from 'redux-thunk';
import RestServiceClient from './rest/RestServiceClient';
import { TenantData } from 'store/tenant/types';
import { SkillList } from 'store/skill/types';
import { SpotList } from 'store/spot/types';
import { ContractList } from './contract/types';
import { EmployeeList } from './employee/types';
import { CurrentRosterState, CurrentShiftRoster, CurrentAvailabilityRoster, CurrentSolverState } from './roster/types';
import { AlertList } from './alert/types';
import { ShiftTemplateList } from './rotation/types';
 
/**
 * ThunkCommand is a ThunkAction that has no result (it's typically something like
 * `Promise<ActionAfterDataFetched>`, but sending messages over WebSocket usually has no response
 * (with the exception of subscribe), so most of our operations are void).
 *
 * @template A Type of action(s) allowed to be dispatched.
 */
export type ThunkCommand<A extends Action> = ThunkAction<any, AppState, RestServiceClient, A>;
 
/**
 * Factory method that takes a value and creates an @type {Action}.
 *
 * @template V value type
 * @template A action type
 */
export type ActionFactory<V, A extends Action> = V extends void ?
  // https://stackoverflow.com/questions/55646272/conditional-method-parameters-based-on-generic-type
  () => A : // nullary
  V extends boolean?
    (value: boolean) => A : // boolean unary
    (value: V) => A; // unary
 
/**
 * Factory method that takes a value and creates a @type {ThunkCommand}.
 *
 * @template V value type
 * @template A action type
 */
export type ThunkCommandFactory<V, A extends Action> = V extends void ?
  () => ThunkCommand<A> : // nullary
  (value: V) => ThunkCommand<A>; // unary
 
export interface AppState {
  readonly tenantData: TenantData;
  readonly skillList: SkillList;
  readonly spotList: SpotList;
  readonly contractList: ContractList;
  readonly employeeList: EmployeeList;
  readonly shiftTemplateList: ShiftTemplateList;
  readonly rosterState: CurrentRosterState;
  readonly shiftRoster: CurrentShiftRoster;
  readonly availabilityRoster: CurrentAvailabilityRoster;
  readonly solverState: CurrentSolverState;
  readonly alerts: AlertList;
}