@fragus/sam-types 1.2.25 → 1.2.26

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.25",
+  "version": "1.2.26",
   "name": "@fragus/sam-types",
   "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
   "author": "Fragus",

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

@@ -6,6 +6,8 @@ export interface UserRoleProviderInfo {
   id: number
   administrativeName: string
   inactive?: boolean
+  /** True when other providers sit under this one in the provider tree. */
+  hasSubProviders?: boolean
 }
 
 export interface UserRoleRecord {

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

@@ -0,0 +1,34 @@
+import { IContractProviderGroupListItem } from '../../contractProviderGroup'
+
+/** Owners to add to and remove from a blacklist rule; it must keep at least one. */
+export interface IBlacklistOwnersRequest {
+  providerIds: {
+    add: number[]
+    remove: number[]
+  }
+  contractProviderGroupIds: {
+    add: number[]
+    remove: number[]
+  }
+}
+
+/** A provider or a provider group a blacklist rule applies to. */
+export interface IBlacklistOwner {
+  id: number
+  name: string
+}
+
+/** The `debug` of an ALREADY_EXISTS (409) response of either blacklist: the identical rule that exists. */
+export interface IBlacklistConflict {
+  id: number
+}
+
+/** The `debug` of a BLACKLIST_OWNER_COVERED_BY_GROUP (400) response: providers a group owning the rule covers. */
+export interface IBlacklistOwnerCoveredByGroup {
+  providerIds: number[]
+}
+
+/** A provider group as the blacklist forms pick it, with its members to show which providers it covers. */
+export interface IBlacklistGroupOption extends IContractProviderGroupListItem {
+  memberProviderIds: number[]
+}

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

@@ -1,4 +1,4 @@
-import { IBlacklistOwner, IBlacklistOwnersRequest } from '../vehicleBlacklist'
+import { IBlacklistOwner, IBlacklistOwnersRequest } from '../blacklist'
 
 /**
  * The vehicles a product is blacklisted for, matched like a vehicle blacklist entry: `*` in model or fuel type matches
@@ -28,22 +28,15 @@ export interface IBlacklistedProductRequest {
 
 export type IBlacklistedProductOwnersRequest = IBlacklistOwnersRequest
 
-export type IBlacklistedProductOwner = IBlacklistOwner
-
 export interface IBlacklistedProductResponse {
   id: number
   productName: string | null
   v4ProductId: number | null
   vehicle: IBlacklistedProductVehicle | null
-  providers: IBlacklistedProductOwner[]
-  contractProviderGroups: IBlacklistedProductOwner[]
+  providers: IBlacklistOwner[]
+  contractProviderGroups: IBlacklistOwner[]
 }
 
 export type IBlacklistedProductListRecord = IBlacklistedProductResponse
 
-/** The `debug` of a PRODUCT_BLACKLIST_ALREADY_EXISTS (409) response: the identical rule that exists. */
-export interface IBlacklistedProductConflict {
-  id: number
-}
-
 export type BlacklistedProductOrderByType = 'id' | 'productName' | 'v4ProductId'

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

@@ -1,20 +1,4 @@
-/** Owners to add to and remove from a blacklist rule; it must keep at least one. */
-export interface IBlacklistOwnersRequest {
-  providerIds: {
-    add: number[]
-    remove: number[]
-  }
-  contractProviderGroupIds: {
-    add: number[]
-    remove: number[]
-  }
-}
-
-/** A provider or a provider group a blacklist rule applies to. */
-export interface IBlacklistOwner {
-  id: number
-  name: string
-}
+import { IBlacklistOwner } from '../blacklist'
 
 /**
  * A vehicle blacklisted for its owners: the providers and groups, at least one in all. A rule cannot be changed once
@@ -44,9 +28,4 @@ export interface IBlacklistedVehicleResponse {
 
 export type IBlacklistedVehicleListRecord = IBlacklistedVehicleResponse
 
-/** The `debug` of a VEHICLE_BLACKLIST_ALREADY_EXISTS (409) response: the identical rule that exists. */
-export interface IBlacklistedVehicleConflict {
-  id: number
-}
-
 export type BlacklistedVehicleOrderByType = 'id' | 'brand' | 'model' | 'fuelType'

package/types/responseErrors/vehcileBlacklistErrors.d.ts

@@ -1,7 +1,8 @@
 export type VehcileBlacklistErrors =
-  | 'DUPLICATE_RECORD'
   | 'VEHICLE_BLACKLIST_NOT_FOUND'
   | 'VEHICLE_BLACKLIST_ALREADY_EXISTS'
   | 'PRODUCT_BLACKLIST_NOT_FOUND'
   | 'PRODUCT_BLACKLIST_ALREADY_EXISTS'
   | 'CONTRACT_PRODUCT_BLACKLISTED'
+  | 'BLACKLIST_LAST_OWNER'
+  | 'BLACKLIST_OWNER_COVERED_BY_GROUP'

package/types/responseErrors/vehicleBlacklistErrors.d.ts

@@ -1,2 +0,0 @@
-export type VehicleBlacklistErrors = 'DUPLICATE_RECORD'
-    | 'VEHICLE_BLACKLIST_NOT_FOUND'