strapi-js v2.0.0

strapi-js

A nodejs/browser typescript/javascript sdk for Strapi headless CMS. You can use it to communicate with Strapi-CMS in client-side applications (such as a Vue.js SPA) or server-side applications (such as an SSR server like Nuxt or other NodeJs based applications).

Features

• 📦 TypeScript & Fully Typed APIs
• ✔️ based on Ofetch and Works with Node.js / Browser / Edge
• ⚡️ Fast Build System Vite, pnpm, esbuild
• ⚙️ Unit Testing with Vitest and high test coverage.

🚀 Quick Start

Install:

# npm
npm i strapi-js

# yarn
yarn add strapi-js

Import & Simple Usage:

import { newStrapiSdk } from 'strapi-js'
// CommonJS: const { newStrapiSdk } = require('strapi-js')

// Usage: 1) provide config (the default configuration)
const config = {
  url: 'http://localhost:1337/',
  prefix: '/api',
  version: 'v4',
  logType: 'auto',
  retry: 0, // Number of retries for requests that have encountered an error
}

// Usage: 2) obtain sdk instance
const sdk = newStrapiSdk (config)

// Usage: 3) use it
const { user, jwt } = sdk.auth.login ({
  identifier: 'mgh@gmail.com',
  password: 'pass123'
})

sdk.auth.changePassword({
  currentPassword: 'pass123',
  password: 'pass123456',
  passwordConfirmation: 'pass123456'
})

Docs

Auth Sdk

This sdk i.e. sdk.auth contains APIs of Strapi related to path /api/auth for login, register, change-pass etc:

• login: Login into strapi providing identifier (username/email) and password
• register: Register new user providing username, email and password
• emailConfirmation: Confirm user's account with confirmation code
• sendEmailConfirmation: Resend email confirmation token to registered user
• changePassword: Change user's password providing jwt-token, current-password and new-password
• forgotPassword: Request to reset the password using a registered email address
• resetPassword: Set new password using a code received with email
• utilGetCurrentUser: a utility function to get logged-in user info using the jwt-token (equal to sdk.users.me())

Users Sdk

This sdk i.e. sdk.users contains APIs of Strapi related to path /api/users for getting and setting users:

• me: get logged-in user info using the jwt-token
• getUsers: get list of registered users
• getUserById: get user's data by user's id
• updateUserById: update user's data by user's id
• deleteUserById: delete a user by user's id

Upload Sdk

This sdk i.e. sdk.upload contains APIs of Strapi related to path /api/upload for working with files/media:

• upload: upload a file and link it to a field of an entity
• getFiles: get list of uploaded files
• getFileById: get file data by file id
• deleteFileById: delete a file by file id