@ff-admin/webapi-client (1.4.0)

Published 2026-05-06 05:57:19 +00:00 by jkeffects in FF-Admin/ff-admin-webapi-client

Setup this registry in your project .npmrc file:

@ff-admin:registry=

To install the package using npm, run the following command:

npm install @ff-admin/webapi-client@1.4.0

or add it to the package.json file:

"@ff-admin/webapi-client": "1.4.0"

For more information on the npm registry, see the documentation.

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:

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

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(() => {});

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

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

ID	Version
axios	^1.16.0
ms	^2.1.3
qs	^6.15.1
typeorm	^0.3.28

Development dependencies

ID	Version
@types/ms	^2.1.0
@types/node	^25.6.0
@types/qs	^6.15.0
typescript	^6.0.3

Feuerwehr ff-admin

Details

npm

FF-Admin/ff-admin-webapi-client

2026-05-06 05:57:19 +00:00

JK Effects

Project website

AGPL-3.0-only

latest

58 KiB

Assets (1)

webapi-client-1.4.0.tgz 58 KiB

Versions (9) View all

1.4.0

2026-05-06

1.3.8

2026-04-24

1.3.7

2026-03-15

1.3.6

2026-03-06

1.3.5

2026-03-04

Issues

@ff-admin/webapi-client (1.4.0)

Installation

About this package

ff-admin-webapi-client

Dependencies

Keywords