92a5f075b6
Adds Payload SDK package, which can be used to query Payload REST API in
a fully type safe way. Has support for all necessary operations,
including auth, type safe `select`, `populate`, `joins` properties and
simplified file uploading.
Its interface is _very_ similar to the Local API, can't even notice the
difference:
Example:
```ts
import { PayloadSDK } from '@payloadcms/sdk'
import type { Config } from './payload-types'
// Pass your config from generated types as generic
const sdk = new PayloadSDK<Config>({
baseURL: 'https://example.com/api',
})
// Find operation
const posts = await sdk.find({
collection: 'posts',
draft: true,
limit: 10,
locale: 'en',
page: 1,
where: { _status: { equals: 'published' } },
})
// Find by ID operation
const posts = await sdk.findByID({
id,
collection: 'posts',
draft: true,
locale: 'en',
})
// Auth login operation
const result = await sdk.login({
collection: 'users',
data: {
email: 'dev@payloadcms.com',
password: '12345',
},
})
// Create operation
const result = await sdk.create({
collection: 'posts',
data: { text: 'text' },
})
// Create operation with a file
// `file` can be either a Blob | File object or a string URL
const result = await sdk.create({ collection: 'media', file, data: {} })
// Count operation
const result = await sdk.count({ collection: 'posts', where: { id: { equals: post.id } } })
// Update (by ID) operation
const result = await sdk.update({
collection: 'posts',
id: post.id,
data: {
text: 'updated-text',
},
})
// Update (bulk) operation
const result = await sdk.update({
collection: 'posts',
where: {
id: {
equals: post.id,
},
},
data: { text: 'updated-text-bulk' },
})
// Delete (by ID) operation
const result = await sdk.delete({ id: post.id, collection: 'posts' })
// Delete (bulk) operation
const result = await sdk.delete({ where: { id: { equals: post.id } }, collection: 'posts' })
// Find Global operation
const result = await sdk.findGlobal({ slug: 'global' })
// Update Global operation
const result = await sdk.updateGlobal({ slug: 'global', data: { text: 'some-updated-global' } })
// Auth Login operation
const result = await sdk.login({
collection: 'users',
data: { email: 'dev@payloadcms.com', password: '123456' },
})
// Auth Me operation
const result = await sdk.me(
{ collection: 'users' },
{
headers: {
Authorization: `JWT ${user.token}`,
},
},
)
// Auth Refresh Token operation
const result = await sdk.refreshToken(
{ collection: 'users' },
{ headers: { Authorization: `JWT ${user.token}` } },
)
// Auth Forgot Password operation
const result = await sdk.forgotPassword({
collection: 'users',
data: { email: user.email },
})
// Auth Reset Password operation
const result = await sdk.resetPassword({
collection: 'users',
data: { password: '1234567', token: resetPasswordToken },
})
// Find Versions operation
const result = await sdk.findVersions({
collection: 'posts',
where: { parent: { equals: post.id } },
})
// Find Version by ID operation
const result = await sdk.findVersionByID({ collection: 'posts', id: version.id })
// Restore Version operation
const result = await sdk.restoreVersion({
collection: 'posts',
id,
})
// Find Global Versions operation
const result = await sdk.findGlobalVersions({
slug: 'global',
})
// Find Global Version by ID operation
const result = await sdk.findGlobalVersionByID({ id: version.id, slug: 'global' })
// Restore Global Version operation
const result = await sdk.restoreGlobalVersion({
slug: 'global',
id
})
```
Every operation has optional 3rd parameter which is used to add
additional data to the RequestInit object (like headers):
```ts
await sdk.me({
collection: "users"
}, {
// RequestInit object
headers: {
Authorization: `JWT ${token}`
}
})
```
To query custom endpoints, you can use the `request` method, which is
used internally for all other methods:
```ts
await sdk.request({
method: 'POST',
path: '/send-data',
json: {
id: 1,
},
})
```
Custom `fetch` implementation and `baseInit` for shared `RequestInit`
properties:
```ts
const sdk = new PayloadSDK<Config>({
baseInit: { credentials: 'include' },
baseURL: 'https://example.com/api',
fetch: async (url, init) => {
console.log('before req')
const response = await fetch(url, init)
console.log('after req')
return response
},
})
```
123 lines
3.3 KiB
YAML
123 lines
3.3 KiB
YAML
name: pr-title
|
|
|
|
on:
|
|
pull_request_target:
|
|
types:
|
|
- opened
|
|
- edited
|
|
|
|
permissions:
|
|
pull-requests: write
|
|
|
|
jobs:
|
|
main:
|
|
name: lint-pr-title
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: amannn/action-semantic-pull-request@v6
|
|
id: lint_pr_title
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
with:
|
|
types: |
|
|
build
|
|
chore
|
|
ci
|
|
docs
|
|
examples
|
|
feat
|
|
fix
|
|
perf
|
|
refactor
|
|
revert
|
|
style
|
|
templates
|
|
test
|
|
scopes: |
|
|
cpa
|
|
db-\*
|
|
db-mongodb
|
|
db-postgres
|
|
db-vercel-postgres
|
|
db-sqlite
|
|
drizzle
|
|
email-\*
|
|
email-nodemailer
|
|
email-resend
|
|
eslint
|
|
graphql
|
|
live-preview
|
|
live-preview-react
|
|
next
|
|
payload-cloud
|
|
plugin-cloud
|
|
plugin-cloud-storage
|
|
plugin-form-builder
|
|
plugin-import-export
|
|
plugin-multi-tenant
|
|
plugin-nested-docs
|
|
plugin-redirects
|
|
plugin-search
|
|
plugin-sentry
|
|
plugin-seo
|
|
plugin-stripe
|
|
richtext-\*
|
|
richtext-lexical
|
|
richtext-slate
|
|
sdk
|
|
storage-\*
|
|
storage-azure
|
|
storage-gcs
|
|
storage-uploadthing
|
|
storage-vercel-blob
|
|
storage-s3
|
|
translations
|
|
ui
|
|
templates
|
|
examples(\/(\w|-)+)?
|
|
deps
|
|
|
|
# Disallow uppercase letters at the beginning of the subject
|
|
subjectPattern: ^(?![A-Z]).+$
|
|
subjectPatternError: |
|
|
The subject "{subject}" found in the pull request title "{title}"
|
|
didn't match the configured pattern. Please ensure that the subject
|
|
doesn't start with an uppercase character.
|
|
|
|
- uses: marocchino/sticky-pull-request-comment@v2
|
|
# When the previous steps fails, the workflow would stop. By adding this
|
|
# condition you can continue the execution with the populated error message.
|
|
if: always() && (steps.lint_pr_title.outputs.error_message != null)
|
|
with:
|
|
header: pr-title-lint-error
|
|
message: |
|
|
Pull Request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and have valid scopes.
|
|
|
|
${{ steps.lint_pr_title.outputs.error_message }}
|
|
|
|
```
|
|
feat(ui): add Button component
|
|
^ ^ ^
|
|
| | |__ Subject
|
|
| |_______ Scope
|
|
|____________ Type
|
|
```
|
|
|
|
# Delete a previous comment when the issue has been resolved
|
|
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
|
|
uses: marocchino/sticky-pull-request-comment@v2
|
|
with:
|
|
header: pr-title-lint-error
|
|
delete: true
|
|
|
|
label-pr-on-open:
|
|
name: label-pr-on-open
|
|
runs-on: ubuntu-24.04
|
|
if: github.event.action == 'opened'
|
|
steps:
|
|
- name: Tag with 2.x branch with v2
|
|
if: github.event.pull_request.base.ref == '2.x'
|
|
uses: actions-ecosystem/action-add-labels@v1
|
|
with:
|
|
labels: v2
|