• This repository has been archived on 01/Sep/2022
  • Stars
    star
    270
  • Rank 146,288 (Top 3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🔌 Official JavaScript SDK for APIs built with Strapi.

⚠️ This package not up to date and maintained ⚠️

We recommend you not to use this package. We stopped to maintained it by lack of time and also because the features provided by this SDK are the same as a good HTTP client well configured. So I suggest you use the best HTTP client for the technology you use. To configure it to target your Strapi API. Here so usefull ressources to help you:


The official Strapi SDK for JavaScript, available for browsers or Node.js backends.



Install

npm install strapi-sdk-javascript

Start now

New instance

import Strapi from 'strapi-sdk-javascript';

const strapi = new Strapi('http://localhost:1337');

Authentications

Local

await strapi.login('username_or_email', 's3cr3t');
// Redirect your user to the provider's authentication page.
window.location = strapi.getProviderAuthenticationUrl('facebook');

Once authorized, the provider will redirects the user to your app with an access token in the URL.

// Complete the authentication: (The SDK will store the access token for you)
await strapi.authenticateProvider('facebook');

You can now fetch private APIs

const posts = await strapi.getEntries('posts');

Files management

Browser

const form = new FormData();
form.append('files', fileInputElement.files[0], 'file-name.ext');
form.append('files', fileInputElement.files[1], 'file-2-name.ext');
const files = await strapi.upload(form);

Node.js

const FormData = require('form-data');
const fs = require('fs');
const form = new FormData();
form.append('files', fs.createReadStream('./file-name.ext'), 'file-name.ext');
const files = await strapi.upload(form, {
  headers: form.getHeaders()
});

API

Strapi(baseURL, storeConfig, requestConfig)

request(method, url, requestConfig)

register(username, email, password)

login(identifier, password)

forgotPassword(email, url)

resetPassword(code, password, passwordConfirmation)

getProviderAuthenticationUrl(provider)

authenticateProvider(provider, params)

setToken(token, comesFromStorage)

clearToken(token)

getEntries(contentTypePluralized, params)

getEntry(contentTypePluralized, id)

getEntryCount(contentTypePluralized, params)

createEntry(contentTypePluralized, data)

updateEntry(contentTypePluralized, id, data)

deleteEntry(contentTypePluralized, id)

searchFiles(query)

getFiles(params)

getFile(id)

upload(data)

requestConfig

Custom axios request configuration. See documentation

Resources

Roadmap

  • GraphQL
  • Attach/Detach entry relationship
  • Real time with Socket.io

Credits

License

MIT

More Repositories

1

strapi

🚀 Strapi is the leading open-source headless CMS. It’s 100% JavaScript/TypeScript, fully customizable and developer-first.
TypeScript
59,511
star
2

strapi-examples

🎓 List of examples using Strapi
1,339
star
3

strapi-docker

Install and run your first Strapi project using Docker
JavaScript
1,153
star
4

foodadvisor

🥘 THE Strapi demo application
JavaScript
1,017
star
5

documentation

Strapi Documentation
JavaScript
917
star
6

nextjs-corporate-starter

Strapi Demo application for Corporate Websites using Next.js
TypeScript
784
star
7

community-content

Contribute and collaborate on educational content for the Strapi Community
JavaScript
562
star
8

buffet

Buffet.js — React Components Library made with styled-components
JavaScript
536
star
9

design-system

Strapi.io's design system 🚀
TypeScript
412
star
10

strapi-starter-next-blog

Strapi Starter Next Blog
JavaScript
377
star
11

strapi-starter-next-corporate

Next.js starter for creating a corporate site with Strapi.
JavaScript
344
star
12

starters-and-templates

Monorepo for all official Strapi v4 templates
JavaScript
308
star
13

strapi-starter-next-ecommerce

Strapi Starter Next.js E-commerce
JavaScript
210
star
14

strapi-starter-nuxt-blog

Strapi Starter Nuxt Blog
Vue
181
star
15

strapi-starter-nuxt-e-commerce

Strapi Starter Nuxt.js E-commerce
Vue
177
star
16

strapi-starter-gatsby-blog

Updated version of the first Gatsby starter with much more features
JavaScript
139
star
17

strapi-starter-react-blog

Strapi Starter React Blog
JavaScript
120
star
18

strapi-legacy-gatsby-blog

Strapi Starter Gatsby Blog
JavaScript
101
star
19

strapi-legacy-blog

Starter for creating a simple blog with Strapi.
JavaScript
96
star
20

strapi-heroku-template

Strapi official template for Heroku 1 click deploy button
JavaScript
93
star
21

strapi-template-corporate

Template to create Strapi projects pre-configured for corporate sites
JavaScript
83
star
22

strapi-plugin-seo

The official plugin to make your Strapi content SEO friendly
JavaScript
81
star
23

rfcs

RFCs for Strapi future changes
69
star
24

waterline-graphql

GraphQL adapter for the Waterline ORM.
JavaScript
69
star
25

strapi-starter-angular-blog

Strapi Starter Angular Blog
TypeScript
66
star
26

strapi-starter-vue-blog

Strapi Starter Vue Blog
Vue
64
star
27

strapi-next-14-dashboard-demo

TypeScript
60
star
28

strapi-template-blog

Template to create Strapi projects pre-configured for blogs
JavaScript
60
star
29

strapi-template-ecommerce

Template to create Strapi projects pre-configured for e-commerce apps
JavaScript
58
star
30

migration-scripts

Collection of Strapi Migration scripts
JavaScript
57
star
31

blocks-react-renderer

A React renderer for the Strapi's Blocks rich text editor
TypeScript
57
star
32

one-click-deploy

Shell
56
star
33

codemods

A set of scripts to help migrate Strapi plugins (and in some cases Strapi applications) from v3 to v4
JavaScript
42
star
34

strapi-heroku-cms-demo

Repository for "CMS" from the Gatsby / Strapi Video Tuturial Series
JavaScript
35
star
35

strapi-starter-gridsome-blog

Build blog sites using Strapi and Gridsome
Vue
32
star
36

strapi-starter-gridsome-portfolio

Build portfolio sites using Strapi and Gridsome
Vue
32
star
37

strapi-starter-gatsby-catalog

Strapi Starter Gatsby Catalog
JavaScript
27
star
38

strapi-starter-gatsby-corporate

JavaScript
26
star
39

strapi-docs

The Strapi documentation.
24
star
40

strapi-template-event-vercel

Template to create Strapi projects pre-configured for event using the Vercel Event kit
JavaScript
22
star
41

strapi-conf-next-template

TypeScript
20
star
42

strapi-plugin-open-ai

The official plugin that allows you to create Open AI completion from a prompt
JavaScript
16
star
43

strapi-meetups

Learn, share and collaborate with the community at Strapi meetups. Contributions welcome.
15
star
44

bookshelf-cache-redis

🔥 A robust, performance-focused caching solution for Bookshelf based on top of Redis.
JavaScript
15
star
45

strapi-studio

The official open-source repository of the Strapi Studio.
12
star
46

strapi-generate-admin

Generate the default admin panel inside your Strapi application.
JavaScript
12
star
47

community-resources

Explore and learn a diverse range of ways to contribute to the Strapi Community
11
star
48

strapi-conf-admin-template

Template for the StrapiConf Admin
JavaScript
10
star
49

strapi-template-portfolio

Template to create Strapi projects pre-configured for portfolio sites
JavaScript
10
star
50

strapi-plugin-gatsby-preview

JavaScript
9
star
51

components

Official Strapi components library
9
star
52

strapi-generate-users

Generate user features for your Strapi application.
JavaScript
8
star
53

strapi-generate-upload

Generate the default upload features for a Strapi application.
JavaScript
6
star
54

strapi-generate-email

Generate the default email features for a Strapi application.
JavaScript
6
star
55

eslint-config

Strapi eslint config
JavaScript
6
star
56

strapi-template-next-example

JavaScript
5
star
57

.github

Community health files for the @strapi organization
4
star
58

strapi-template-catalog

JavaScript
4
star
59

strapi-settings-manager

Strapi plugin built to let you easily configure your Strapi applications.
JavaScript
3
star
60

best-practices-samples

Sample project code for Strapi Best Practice calls
JavaScript
3
star
61

security-patches

Patch-package patches for TID2212
2
star
62

plugin-rfc-examples

JavaScript
2
star
63

strapi-generate

JavaScript
2
star
64

strapi-generate-api

JavaScript
2
star
65

strapi-generate-new

JavaScript
2
star
66

javascript

Strapi Javascript Style Guide
1
star
67

foodadvisor-migration-example

JavaScript
1
star
68

internal-lms

Strapi's Internal Learning Management System
JavaScript
1
star
69

strapi-cloud-template-blog

JavaScript
1
star