@sforsoftware/inhandel-frontend-abstractions

inHandel.Frontend.Abstractions

Current version: 2.0.39
NPM url: https://www.npmjs.com/package/@sforsoftware/inhandel-frontend-abstractions
Alles is getest?: Ja

Table of Contents

• Hoe te gebruiken
• Injectables
  • Helpers
  • API services
    • Management API
    • ParcelSender API
    • PIM API
    • SalesApp API
    • Overige API's
• Domain classes
  • Article domain
  • Catalog domain
  • Category domain
  • Customer domain
  • Order domain
  • ParcelSender domain
  • Pipeline domain
  • Settings domain
  • Supplier domain
• Overige classes
• Ondersteunde pakketverzenders

Hoe te gebruiken:

Installeer de package met npm i @sforsoftware/inhandel-frontend-abstractions
Vervolgens hoef je alleen jou benodige injectable te kiezen en deze te injecten:

import { Injectables, IManagementApiService } from "@sforsoftware/inhandel-frontend-abstractions";

const managementApiService = inject<IManagementApiService>(Injectables.ManagementApiService)!;

Ja, het uitroepteken aan het einde van die regel doet er toe! Dit maakt het geen nullable.

Injectables:

Helpers

• IScopeValidator
  • Valideert de opgegeven scopes met de scopes die de ingelogde user heeft
• ISessionStorageHelper
  • Voor het setten en ophalen van diverse session storage keys
• ITokenDecoder
  • Decodes een Jwt token

Standaard services

• AbstractApiService
  • Wordt in elke Api Service gebruikt om de standaard functionaliteit op één centraal punt te houden. Via de overschreven TokenPrefix wordt bepaald naar welke API de call toe moet.
• IApiService
  • Te gebruiken voor de calls waar nog geen aparte API Service voor geschreven is.
• IErrorHandler
  • Hier kan een error en 'severity level' (hoe ernstig de error is) aan gegeven worden, om vervolgens de error af te handelen.
• IGraphQLService
  • Voor het versturen van GraphQL requests.
• ToasterService
  • Voor het versturen van popup meldingen.

API services

Management API

• IAppsApiService
• ICountryApiService
• IEmailAccountApiService
• IGridConfigApiService
• iPrinterApiService
• iReportApiService
• IScopesApiService
• IUserApiService

ParcelSender API

• IOrderApiService
• IPackagingApiService
• IParcelSenderApiService
• ISenderApiService
• ISettingsApiService
• IShipmentApiService
• IUndeliverableArticleApiService

PIM API

• IArticleApiService
• ICatalogApiService
• ICategoryApiService
• IFreeFieldApiService

SalesApp API

• IArticleApiService
• ICatalogApiService
• ICategoryApiService
• IFreeFieldApiService
• IOrderApiService
• ISettingsApiService

Overige niet uitelkaar getrokken API's

• ICustomerApiService
• IOrderApiService
• IPipelineApiService
• IReturnApiService
• ISupplierApiService

Alle injectables worden in de host geïmplementeerd in de map dependencies.

Domain classes

Article

• Article
• ArticleParentChild
• BTWPercentage
• Category
• CategoryLanguage

Catalog

• Article
• BTWPercentage
• Catalog
• CatalogArticle
• CatalogField
• CatalogSettings
• Category
• CategoryLanguage

Category

• Article
• Category
• CategoryLanguage
• CategorySettings

Customer

• Address
• Country
• Customer
• MailSending

Order

• Address
• Article
• Country
• Customer
• Order
• OrderLine
• OrderLineType
• Paid
• PipelineOrder
• Return
• ReturnLine
• ReturnOrder
• ReturnStatus
• Status

ParcelSenders

• ParcelOptions (zie 'Ondersteunde pakketverzenders')
  • IParcelOptions
• ShipmentOptions (zie 'Ondersteunde pakketverzenders')
  • IShipmentOptions
• CustomerInfo
• DefaultParcelSender
• OrderLine
• Packaging
• Parcel
• ParcelSender
• ParcelSenderEnum
• Sender
• Settings
• Shipment
• ShipmentLine
• TenantParcelSender
• UndeliverableArticle

Pipelines

• ActionClasses
  • ActionReturn
  • ChangeStatusAction
  • PrintAction
  • RegisterParcelAction
  • SendEmailAction
  • StatusUpdateInDiffPipelineAction
• Action
• ActionType
• Domain
• DomainObjectIdentifier
• DomainObjectIdentifierRequest
• DraggableActionList
• Notification
• ObjectStatus
• Order
• Pipeline
• PipelineQueue
• QueueStatus
• Status
• Workflow

Settings

• GenericEmailAccount
• Office365EmailAccount
• SalesAppSettings
• SalesAppViewType
• SendGridEmailAccount
• SmtpEmailAccount
• Status

Supplier

• Address
• Country
• MailSending
• Supplier

Overige classes

• Enums

  • AppEnum
  • EntityEnum
  • GraphQLApis
  • SalesAppViewType

• ScopeEnums

  • InHandelScopes
  • LogistiekScopes
  • PIMScopes
  • SalesAppScopes

• AddOn

• Address

• AddressDisabled

• APIException

• App

• AppsTenant

• Article

• ArticleParentChild

• BlobImage

• BTWPercentage

• Catalog

• CatalogAndCategorySettings

• CatalogArticle

• CatalogField

• Category

• CategoryLanguage

• Country

• Customer

• DefaultCatalogField

• DefaultReport

• DisabledMailSending

• DomainObject

• Entity

• FreeField

• FreeFieldGroup

• IGraphQLResult

• Injectables

• InvoiceBy

• License

• MailSending

• Order

• OrderLine

• Paid

• PrinterBody

• Printer

• PrintNodePrinter

• ReportArray

• ReportTemplate

• Return

• ReturnLine

• ReturnStatus

• SalesAppSettings

• ShoppingCartOrder

• ShoppingCartOrderLine

• SignalRConnection

• Status

• Subscription

• Supplier

• Tenant

• TokenPrefix

• User

• APIError

• APIResponse

• BlobImage

• DefaultCatalogField

• DefaultProperties

• Defaults

• FreeField

• FreeFieldDefinitions

• FreeFieldGroup

• FreeFieldValueType

• SeverityLevel

Ondersteunde pakketverzenders

BOL	FedEx	KeenDelivery
DHL	DPost	MyParcel
DPD	PostNL	SendCloud
GLS	Roona	ShopsUnited
UPS		TransMission