@fragus/sam-types 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# SAM-types
+
+SAM types is used to collect and share all interfaces (types) that one or more repositories have in
+common. To facilitate and ensure that repositories use the same types when communicating with each other.
+In most cases, if not all, this is between SAM-api and one or more of the frontend clients like the SAM-admin.
+
+## Conventions
+
+### Request/Response interfaces
+TODO: Fill this out
+
+### Versioning
+
+We use standard [semantic versioning](https://semver.org/)
+
+## Development
+### Dependencies
+The project only has one dependency: `Typescript`
+
+This is to have `tsc` available.
+
+### Compiling
+
+To compile the `index.d.ts` file and the `index.js` file, run `npm run tsc` (or `yarn tsc`). This cleans all existing `.js` files and updates the `index.d.ts` file and the `index.js` file.
+
+### Adding new interfaces, types, and enums
+
+Write your interface or type like you normally would. In order to export it, you need to add it to the `index.ts` file which holds all exported interfaces, types, and enums. The enums (for now) need to be put directly in the `index.ts` file. To fix this we need to setup some Webpack configuration etc.
+
+### Local development
+
+### Using npm
+To use the types locally in an application, add the line below as a dependency in your `package.json` file:
+
+`"sam-types": "file:../SAM-types"`
+
+The path is the relative path to the SAM-types project.
+### Using yarn
+To use the types locally you can use `yarn link`. See docs [here](https://yarnpkg.com/lang/en/docs/cli/link/).
+
+`cd` to the SAM-types folder and type: `yarn link`
+
+Then `cd` to your application and type `yarn link "sam-types"`. Now your application uses your local SAM-types project (using a symlink). To unlink, type `yarn unlink "sam-types"`
+
+This means that you do not have to change anything in your `package.json` file.
+
+### Regular dependency
+To use SAM-types in a project, add the line below as a dependency in your `package.json` file:
+
+`"sam-types": "OmniCar/SAM-types#0.0.1"`
+
+If you need to target something other than a specific release, consider targeting a branch or a commit as shown below:
+
+* `"sam-types": "OmniCar/SAM-types#4727d357ea"`
+* `"sam-types": "OmniCar/SAM-types#feature\/branch"`
+
+## Releasing
+
+### Using GitHub
+
+* Go to [releases](https://github.com/OmniCar/SAM-types/releases) on GitHub
+* Press "Create a new release"
+* Set the "Tag version" to the appropriate version number (see versioning above)
+* Set the "Release title" to "Version <version_number>"
+* Describe the changes. What's new? are there any breaking changes? etc.
+* If you want you can see the changes on `master` compared to a release (for example version `0.0.1`) by typing: `git diff tags/0.0.1 master`
+* Press "Publish release"
+
+### Using [hub cli](https://github.com/github/hub)
+
+If you have installed the hub cli (see link above), you can create a new release with the below command. Please note that it defaults to targeting the main (`master`) branch unless you use the `-t` option (more options [here](https://github.com/github/hub/blob/master/commands/release.go))
+
+`git release create -o -m "Release 0.0.2" "0.0.2"`
+
+If you did not set up the alias for `git = hub` you should write `hub` instead of `git` in the command above.

package/package.json

@@ -0,0 +1,24 @@
+{
+  "version": "1.0.0",
+  "name": "@fragus/sam-types",
+  "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
+  "author": "Fragus",
+  "types": "types/index.d.ts",
+  "files": [
+    "types"
+  ],
+  "main": "types/index.js",
+  "scripts": {
+    "clean-js": "/bin/bash tools/npm-scripts.sh cleanJS",
+    "clean-js-win": "sh tools/npm-scripts.sh cleanJS",
+    "tsc": "npm run clean-js && npx tsc -p ./tsconfig.json",
+    "tsc-win": "npm run clean-js-win && npx tsc -p ./tsconfig.json"
+  },
+  "devDependencies": {
+    "@ianvs/prettier-plugin-sort-imports": "^4.2.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.7",
+    "typescript": "3.3.3"
+  }
+}

package/types/SettlementPaymentType.js

@@ -0,0 +1 @@
+//# sourceMappingURL=SettlementPaymentType.js.map

package/types/SettlementPaymentType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettlementPaymentType.js","sourceRoot":"","sources":["SettlementPaymentType.ts"],"names":[],"mappings":""}

package/types/accessKey/index.d.ts

@@ -0,0 +1,12 @@
+import { AccessKeyPermission, AccessKeyService } from '../index'
+
+export interface IAccessKey {
+  accessKeyId: number
+  apiKey: string
+  keyPermission: AccessKeyPermission
+  service: AccessKeyService
+  createdByUserEmail?: string
+  representativeUserEmail?: string
+  contractProviderIds: number[]
+  allProvidersAllowed: boolean
+}

package/types/address.d.ts

@@ -0,0 +1,18 @@
+import { ICountry, ICountryRequest } from './country'
+
+export interface IAddressRequest {
+  address1: string
+  address2?: string
+  city: string
+  postalCode: string
+  country: ICountry
+}
+
+export interface IAddressResponse {
+  addressId: number
+  address1: string
+  address2?: string
+  city: string
+  postalCode: string
+  country: ICountry
+}

package/types/admin/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './login'
+export * from './roles'

package/types/admin/auth/login.d.ts

@@ -0,0 +1,28 @@
+import { IsoLocale } from '../../locale'
+import { IContractProviderInfo } from '../contractProvider'
+import { IAdminCustomer } from '../customer'
+import { IAdminUserInfo } from '../user/user'
+import { UserRole, UserRoleRecord } from './roles'
+
+export interface ILoginRequest {
+  username: string
+  password: string
+}
+
+export interface ILoginResponse {
+  username: boolean
+  password: boolean
+  role?: UserRole
+  roles?: UserRoleRecord[]
+  token?: string
+  userInfo?: IAdminUserInfo
+  customerInfo?: IAdminCustomer
+  providerInfo?: IContractProviderInfo
+  stripePublicKey?: string
+  webCalcEnabled?: boolean
+  disableContractTemplates?: boolean
+  isSuperAdmin?: boolean
+  isDev?: boolean
+  refreshToken?: string
+  defaultLocale?: IsoLocale
+}

package/types/admin/auth/roles.d.ts

@@ -0,0 +1,10 @@
+export type UserRole = 'system' | 'superadmin' | 'admin' | 'seller' | 'customer' | 'reports' | 'observer'
+
+export interface UserRoleRecord {
+  role: UserRole
+  contractProvider: {
+    id: number
+    administrativeName: string
+    inactive?: boolean
+  }
+}

package/types/admin/chart/contractCharts.d.ts

@@ -0,0 +1,70 @@
+import { IContractFilterDate, PriceSpecification } from '../..'
+import { IChartDateValue, IChartInvoiceValue } from '../../chart'
+import { ContractState } from '../../index'
+
+export interface IPaymentChart {
+  seriesExpectedEarnings: IChartDateValue[] // chart series.
+  seriesEarnings: IChartInvoiceValue[] // chart series.
+  seriesCosts: IChartDateValue[] // chart series.
+  totalExpectedEarnings: PriceSpecification // summary.
+  totalEarnings: PriceSpecification // summary.
+  totalCosts: PriceSpecification // summary.
+  totalBalance: PriceSpecification // summary.
+  contractStartDate: Date | string // chart legend.
+  contractEndDate: Date | string // chart legend.
+  duration: {
+    // chart legend.
+    total: number
+    current: number
+  }
+  // number of expected payments to current or closing date
+  expectedPaymentsToDate: number
+  // number of failed/unpaid payments
+  failedPaymentsToDate: number
+  // total sum of failed/unpaid payments
+  totalFailedPayments: PriceSpecification
+}
+
+export interface IMileageChart {
+  seriesExpectedMileage: IChartDateValue[] // chart series.
+  seriesMileage: IChartDateValue[] // chart series.
+  totalExpectedMileage: number // summary.
+  totalMileage: number // summary.
+  totalBalance: number // summary.
+  contractStartDate: Date | string // chart legend.
+  contractEndDate: Date | string // chart legend.
+  duration: {
+    // chart legend.
+    total: number
+    current: number
+  }
+}
+
+export interface IValueChart {
+  seriesExpectedValue: IChartDateValue[] // chart series.
+  seriesValue: IChartDateValue[] // chart series.
+  totalExpectedValue: number // summary.
+  totalValue: number // summary.
+  totalBalance: number // summary.
+  contractStartDate: Date | string // chart legend.
+  contractEndDate: Date | string // chart legend.
+  contractEndValue?: number
+  duration: {
+    // chart legend.
+    total: number
+    current: number
+  }
+}
+
+export interface IPaymentMileageCharts {
+  paymentChart: IPaymentChart
+  mileageChart: IMileageChart
+  valueChart: IValueChart
+}
+
+export interface IContractChartsFilterParams {
+  contractStates: ContractState[]
+  templates: number[]
+  sellers: number[]
+  created: IContractFilterDate
+}

package/types/admin/chart/dashboardCharts.d.ts

@@ -0,0 +1,57 @@
+import { IContractFilterDate } from '../..'
+import { IChartDateValue, ITopSellerChart } from '../../chart'
+
+export interface IChartCollection {
+  name: string
+  total: number
+  months: IChartDateValue[]
+}
+
+export interface IBalanceChart {
+  seriesInvoiced: IChartCollection
+  seriesCosts: IChartCollection
+  valuation: { totalContractValue: number; date: Date | string }
+}
+
+export interface IDashboardCharts {
+  activeContractsChartCollection: IChartCollection[]
+  sellerChart: ITopSellerChart
+  balanceChart: IBalanceChart
+  monthlyBalanceChart: IBalanceChart
+}
+
+export interface IDashboardQueryParams<Filtering = undefined> {
+  filtering?: Filtering
+}
+
+export interface IDashboardContractChartsResponse<Result, Filtering> {
+  result: Result
+  filtering?: Filtering
+}
+
+export interface ICellDataPoint {
+  x: Date
+  y: number
+}
+
+export interface IContractCharts {
+  sellerId?: number
+  sellerName?: string | any
+  startDate: Date
+  endDate: Date
+  chartsData: ICellDataPoint[]
+}
+
+export interface IDashboardContractCharts {
+  chartType: string
+  chartName: string
+  charts: IContractCharts[]
+}
+
+export interface IDashboardContractChartViews {
+  contract: IDashboardContractCharts[]
+}
+
+export interface IDashboardFilterParams {
+  dateRange: IContractFilterDate
+}

package/types/admin/chart/index.d.ts

@@ -0,0 +1,12 @@
+export { IPaymentChart, IMileageChart, IValueChart, IPaymentMileageCharts, IContractChartsFilterParams } from './contractCharts'
+export {
+  IChartCollection,
+  IBalanceChart,
+  IDashboardCharts,
+  IDashboardQueryParams,
+  IDashboardContractChartsResponse,
+  ICellDataPoint,
+  IDashboardContractChartViews,
+  IDashboardContractCharts,
+  IContractCharts,
+} from './dashboardCharts'

package/types/admin/contactInformation/index.d.ts

@@ -0,0 +1,9 @@
+export interface IContactInformation {
+  id?: number
+  email: string
+  phone: string
+  url: string
+  isoName: string
+}
+
+export type ContactInformation = keyof IContactInformation

package/types/admin/contract/balanceStatistics.d.ts

@@ -0,0 +1,37 @@
+import { PriceSpecification } from '../../index'
+
+export interface ISettlementInvoicesBalance {
+  stripePayment: PriceSpecification
+  cashPayment: PriceSpecification
+  providerPayment: PriceSpecification
+  cashPayout: PriceSpecification
+}
+
+export interface IContractBalanceStatistics {
+  calculatedUnits: number
+  calculationMethod: number
+  closingDate: string
+  monthsAtClosing: number
+  remainingMonths: number
+  remainingCharge: PriceSpecification
+  workshopCosts: PriceSpecification
+  paidInvoicesTotalSum: PriceSpecification
+  contractBalance: PriceSpecification
+  settlementInvoices: ISettlementInvoicesBalance
+  settlementInvoicesTotalSum: PriceSpecification
+  settlementInfo?: ISettlementInfo
+  underOverUnitsBalance?: IUnderOverUnitsInfo
+  pendingInvoicesTotalSum?: PriceSpecification
+}
+
+export interface IUnderOverUnitsInfo {
+  units: number
+  cost: PriceSpecification
+  underUnitsLimit: number
+}
+
+export interface ISettlementInfo {
+  settlementDate: Date
+  userName: string
+  autoSettlement: boolean
+}

package/types/admin/contract/basicInfo.d.ts

@@ -0,0 +1,21 @@
+import { PriceSource } from '../../contractTemplate'
+import { ContractState, ContractType, IIncludedContractOption, PaymentGateway, TV4PTProductType } from '../../index'
+import { IContractHealth } from './health'
+
+export interface IBasicContractInfo {
+  contractState: ContractState
+  contractStateName: string
+  contractType: ContractType
+  contractProductType: null | TV4PTProductType
+  priceSource: PriceSource | null
+  extendedFromId: number | null
+  extendedToId: number | null
+  paymentGateway: PaymentGateway
+  contractName: string // Contract (template) name.
+  templateDescription: string
+  additionalOptions: IIncludedContractOption[]
+  health: IContractHealth[]
+  productHasWarranty: boolean
+  productContract: boolean
+  offerExpirationDate?: string
+}

package/types/admin/contract/contractDetails.d.ts

@@ -0,0 +1,82 @@
+import { TV4PTProductType } from '../../v4PricingTool'
+import { ContractType, ContractValueType, ServiceContractFlag } from './../../admin/contractCreation'
+import { IContactPersonResponse } from './../../contactPerson'
+import { IContractResponse } from './../../contract/contract'
+import { PriceSource } from './../../contractTemplate'
+import { IIncludedContractOption } from './../../includedContractOption'
+import { PaymentGateway } from './../../payment'
+import { PriceSpecification } from './../../priceSpecification'
+
+export interface IContractDetailsRecord {
+  serviceContractId?: number // Note: Do not expose this id for non-Devs/normal users, use the pretty-id for those. For debugging purposes, etc.
+  contractType: ContractType
+  contractProductType: null | TV4PTProductType
+  contractPdfUrl: string
+  duration: number // Duration [months].
+  startMileage?: number // Current meter/odometer-reading [km].
+  mileage: number // Allowed mileage/distance [km] to drive during contract duration [months].
+  startValue?: number
+  startValueType: ContractValueType
+  endValue?: number
+  maxEndValue?: number
+  endMileage: number // End-mileage [km] at end of duration [months].
+  maxEndMileage?: number // Absolute maximum end-mileage [km] for product - Hard mileage cap/limit.
+  expirationDate: Date | string
+  extendedFrom: IContractResponse | null
+  includedOptions: IIncludedContractOption[] | null
+  value?: number
+  valueType: ContractValueType
+  monthlyTemplatePrice: PriceSpecification
+  monthlyPrice: PriceSpecification
+  paymentMethod: PaymentGateway
+  prettyIdentifierShort: string
+  prettyIdentifier: string
+  providerPayments: number
+  providerShare: PriceSpecification
+  reference: string
+  warrantyReference?: string
+  seller?: IContactPersonResponse
+  startDate: Date | string
+  termsPdfUrl: string
+  termsOfTradePdfUrl: string
+  filesContainerAlongContract: null | IFileItem[] // Optional extra files, except the TOS file.
+  totalPrice: PriceSpecification
+  contractTemplateId: null | number
+  contractName: string // Contract (template) name.
+  priceSource: null | PriceSource
+  contractTemplateDescription: string
+  contractTemplateMinPaymentsCount: number | null
+  contractTemplateIsArchived: boolean
+  isProduct: boolean
+  serviceVariantId: string
+  flags: ServiceContractFlag[]
+  stripeCustomerLink: string | null
+  stripeSubscriptionLink: string | null
+  customTerms?: string
+  adjustedFrom?: string
+  adjustedTo?: string
+  createdByProvider?: string
+  provider?: string
+  settledUnits?: number | null
+  overdrivenCharge?: number
+  underdrivenCharge?: number
+  calculationMethod?: number
+  overHoursCharge?: number
+  underHoursCharge?: number
+  overServicesCharge?: number
+  underServicesCharge?: number
+}
+
+export interface IAdminCustomTermsRecord {
+  customTerms: string
+}
+
+export interface IUnitsListResponse {
+  units: number
+  date: Date | string
+}
+
+export interface IFileItem {
+  name: string
+  v4URL: string
+}

package/types/admin/contract/health.d.ts

@@ -0,0 +1 @@
+export type IContractHealth = 'RISK_OF_OVERMILEAGE' | 'NEGATIVE_BALANCE' | 'RISK_OF_OVERHOURS' | 'RISK_OF_OVERSERVICES'

package/types/admin/contract/index.d.ts

@@ -0,0 +1,6 @@
+export * from './basicInfo'
+export * from './contractDetails'
+export * from './health'
+export * from './templateLookup'
+export * from './balanceStatistics'
+export * from './settleContract'

package/types/admin/contract/internalContractNotes.d.ts

@@ -0,0 +1,23 @@
+export interface IInternalContractNoteResponse {
+    internalContractNoteId: number
+    note: string
+    date: Date
+    writtenByUser?: string
+    contractPrettyIdentifier?: string
+    writtenByCurrentUser?: boolean
+    attachments: Attachment[]
+}
+
+export interface IInternalContractNoteRequest {
+    internalContractNoteId?: number
+    note: string
+    date?: Date
+    attachments?: Attachment[]
+}
+
+export interface Attachment {
+    fileName: string
+    originalFileName: string
+    url: string
+    fileType: string
+}

package/types/admin/contract/settleContract.d.ts

@@ -0,0 +1,3 @@
+export interface ISettleContractRequest {
+  attachments?: File
+}

package/types/admin/contract/templateLookup.d.ts

@@ -0,0 +1,20 @@
+import { ContractType, TVehicleDriveType, TVehicleTransmissionType, TVehicleType } from '../../../types'
+
+// TODO: To be switched over to the line below (extending IVehicleInfo)
+// export interface ITemplateLookupRequest extends IVehicleInfo{
+export interface ITemplateLookupRequest {
+  contractType: ContractType
+  regNo?: string
+  vin?: string
+  brand: string
+  model: string
+  fuelType: string
+  regDate: string
+  modelYear?: number
+  engineMaxPower: number | null
+  vehicleType: TVehicleType
+  cylinderVolume: number
+  transmissionType: TVehicleTransmissionType
+  driveType: TVehicleDriveType
+  hasFourWheelDrive?: boolean
+}

package/types/admin/contractCreation/carData.d.ts

@@ -0,0 +1,20 @@
+export interface IFueltypeCollection {
+  name: string
+  id: number
+}
+
+export interface IModelCollection {
+  name: string
+  id: number
+  fuelTypes: IFueltypeCollection[]
+}
+
+export interface IBrandCollection {
+  name: string
+  id: number
+  models: IModelCollection[]
+}
+
+export interface ICarCollection {
+  brands: IBrandCollection[]
+}