@ff-admin/webapi-client (1.3.3)

Published 2026-02-12 16:03:47 +00:00 by jkeffects in FF-Admin/ff-admin-webapi-client

Installation

@ff-admin:registry=
npm install @ff-admin/webapi-client@1.3.3
"@ff-admin/webapi-client": "1.3.3"

About this package

ff-admin-webapi-client

FF Admin Webapi Client ist ein NPM-Package, welches die Verbindung zu einem FF Admin-Server vereinfacht.

Zur Verfügung gestellt werden Requests mit den benötigten Models, Types und Enums für FF Admin.

Der WebApiClient realisiert den automatischen refresh von Zugangs-Tokens.

Installation:

@ff-admin:registry=https://npm.registry.jk-effects.cloud
//npm.registry.jk-effects.cloud/:_authToken="xxx" # hier optional token einfügen - ff-admin packages sind öffentlich
npm install @ff-admin/webapi-client

Beispiele:

  1. Verwendung des Clients:
import { WebApiClient, AdminRequests } from "@ff-admin/webapi-client"

let myClient = new WebApiClient({ 
  serverAdress: "", 
  webapiToken: "" 
});
myClient.initialize() // asynchrone Funktion - muss vollständig ausgeführt sein, bevor irgendwelche Anfragen gestellt werden
  1. Nutzung der Requests
let data = AdminRequests.MemberRequests.getAllMembers(myClient)
  .then((res) => {
    console.log(res)
  })
  .catch((err) => {
    console.log(err)
  })

let newMemberId = AdminRequests.MemberRequests.createMember(myClient, {
    body: {
      salutationId: "<uuid>",
      firstname: "",
      lastname: "",
      nameaffix: "",
      birthdate: new Date("")
    }
  })
    .then(() => {})
    .catch(() => {});

AdminRequests.MemberRequests.updateMember(myClient, {
  params: { id: "<uuid>" },
  body: {
    salutationId:  "<uuid>",
    firstname: "",
    lastname: "",
    nameaffix: "",
    birthdate: new Date(""),
  },
})
  .then(() => {})
  .catch(() => {});
  1. Zugriff auf Typen, Models und Enums:
import { AdminModels, AdminTypes, AdminEnums } from "@ff-admin/webapi-client"

let model: AdminModels.MemberModels.CreateMemberViewModel;
let type: AdminTypes.DynamicQueries.DynamicQueryStructure
let enum = AdminEnums.NewsletterType.NewsletterConfigType.mail
  1. http Events:
    Es können Events wie Fehler oder Informationen direkt aus der Middleware des Clients angezapft werden.
import { WebApiClient, AdminRequests } from "@ff-admin/webapi-client"

let myClient = new WebApiClient({ 
  serverAdress: "", 
  webapiToken: "" 
});
myClient.initialize()

client.httpEvents.on(<"error" | "info">, (data) => {})

zum Package: https://npm.registry.jk-effects.cloud/-/web/detail/@ff-admin/webapi-client

Dependencies

Dependencies

ID Version
axios ^1.13.5
ms ^2.1.3
typeorm ^0.3.28

Development dependencies

ID Version
@types/ms ^2.1.0
@types/node ^25.2.3
typescript ^5.9.3

Keywords

Feuerwehr ff-admin
Details
npm
2026-02-12 16:03:47 +00:00
9
JK Effects
AGPL-3.0-only
62 KiB
Assets (1)
Versions (4) View all
1.3.4 2026-02-27
1.3.3 2026-02-12
1.3.2 2026-01-14
1.3.1 2026-01-14