Files
directus/docs/dictionary.txt
Brainslug d71b0e94ee SDK Revamp (#18987)
* Setup build chain

* Initial structure

* Typing, exports, fix build

* Reorganize

* prutsen met output types

* Thursday fun times

* failed experiments in feature composition

* got feature flags on the client

* using interfaces instead of literals

* messed with decorators

* split up decorators

* added fetch and ws types

* reintroduced the global.d.ts we'll figure that out later

* reworked composables

* some changes

* experimenting with commands

* got the read item command working again with types

* trying authentication

* basic gql implementation

* Super basic websocket implementation

* renamed websocket composable and removed obsolete code

* Typing relational fields

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>

* fixed recursive type

* SDK revamp revamp (#18916)

* Split up files

* Simplify some more (too much?)

* Oh boy we figured out object extending

* OK JK now we're there

* OK getting somewhere real now

* Start structuring type helpers

* Types werken zowaar!

* Remove unneeded "T"'s for readability

* Added support for array relational types

* split up query nesting logic

* make relational fields optional to support multiple relations

* improved readability

* updated REST

* Move URL to top level

* Remove T

* recursively join fields in params

* cleaning up

* updated graphql implementation

* removing old unused code

---------

Co-authored-by: Brainslug <tim@brainslug.nl>

* Reduce global reuse of rest

* Start messing with output types

* Return it from the rest command

* first level schema output filtering

* It works!! but will need some docs for context

* Added some comments

* removed export keyword from types that do not need to be exported

* cleaned up debug script

* graphql update

* Added dom for WebSocket and Fetch typings

* initial readme setup

* moved some types

* removed accidental commit

* Refactor `useDirectus` and improve token handling (#18966)

* Add comment and reduce code of useDirectus

* Add fabian-hiller to contributors.yml

* Change token handling of useDirectus client

---------

Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>

* Change ClientConfig type back to interface (#18968)

* initial realtime feature

* started on some ws commands and implemented message receiving callback

* disabled rest config for now

* setup auth extension boilerplate

* Added some websocket examples to the readme

* docs: add getting started guide

* docs: add link to previous sdk

* docs: updates

* implemented readItem

* updated readItems

* Added delete commands

* docs: updates to snippets and phrasing

* updated lockfile

* Update dictionary

* docs: removed repeated typescript snippet

* Enrich package.json for SDK

* docs: update snippet

* Fix casing of readme

* added create items commands

* fixed read items output

* removed obsolete types

* added update commands

* updated tsup

* removed unused dependencies

* implemented basic memory storage fallback

* implemented the login function for auth

* implemented refresh and logout auth functions

* docs: update guide

* updated auth refresh logic

* oops, have to actually store the expires at value

* fixed authentication timeout

* added autoRefresh config option

* updated readme

* updated getting started

* docs: updates to guide

* added beta version nr

* removed debug scripts

* added docblocks to the composables

* Added some docblocks

* Added BETA warning to readme

* Added extra type extends object checks

* added a bunch of index files

* updated tsup build entrypoints and exports

* updated import paths

* updated code examples

* docs: removed unnecessary phrases

* Unignore SDK changesets

* Revert "docs: removed unnecessary phrases"

This reverts commit 3559ade873.

* docs: removed unnecessary phrases

* Make sure we export all available functions

* Tweak exports

* Add TypeDoc for new (and old) SDK

* Update docs/guides/sdk/getting-started.md

* Re-add beta version flag in package.json

* Format readme

* Tweaks

* Spellchecker

* v10.4.0

* Add link to TypeDoc of new SDK

* updated query types

* trying to expand the query types

* extending the Query options

* add all exports to the root

* fixed incorrect field mapping

* Abstracted more  of the request logic for more flexibility

* partial error handling, global fetch settings and fetch response options

* reworked the requests for better options control and started on better error handling

* type fix

* Run formatter & linter

* Spell fixes

* added onRequest handler

* updated global request hooks

* expanded ItemType to accept singletons

* updated output types for singletons

* fixed fields type generation

* removed rest globaloptions in favor of onRequest

* started singleton command

* different commands for singletons

* ran prettier

* updated readme

* stateless helpers for tomorrow

* support m2a in field types

* added m2a fields parsing and attempt at output typing

* made the base client stateless

* making sure things are exported as needed

* added minimal core table schema for files and users

* added update singleton command

* Added core user read commands

* merged related commands into the same file

* Added create users commands

* Added user update commands

* added user delete commands

* updated query handling

* ran prettier and bumped version

* ran prettier

* disabled global error handling for now

* fixed output formatting for delete commands

* fixed onResponse handling

* fixed item types for create and update

* added missing partial item for create

* ran prettier

* updated readme

* added missing export

* Publish beta version

* Added a bunch of core collection types

* updated users commands

* added more complex core types

* double checked nullable core fields

* fixed core collection merging with custom properties

* added authentication commands

* ran prettier and fixed line endings

* Added all core read commands

* Added all core create commands

* Added all core delete commands

* Added all core update commands

* ran prettier

* renamed `useDirectus` to `createDirectus` and `.use` to `.with` to prevent naming confusion with reacthooks or express middleware.

* ran prettier

* added more misc core commands

* added schema endpoints

* added server api commands

* ran prettier

* added most utility endpoints

* finished utility endpoints

* checking the command typing and jsdoc

* fixed those pesky relational output types

* ran prettier

* removed obsolete type

* initial aggregation typing

* improved aggregation and grouping typing

* ran prettier

* checked exports

* Beta 4

* fixed the m2a fields regression

* added basic client test

* do query parsing at the latest stage

* extra type comments

* reverted accidental commit and ran prettier

* Adjust tsconfig to updated @directus/tsconfig package

* updated websocket event handling

* fixed capitalization

* removed obsolete queryToParams usage

* implemented websocket reconnecting and some non-happy path fixes

* persist subscription across reconnecting

* updated readme

* ran prettier

* 11.0.0-beta.5

* using plurar for uploadFiles ad removed "D" from updateFiles

* fix incorrect paths

* created new util types file

* extracted output types

* fixed input typing issue (for items)

* extracted functions to its own file

* fixed path for presets

* ran prettier

* Applied typing fix to all commands

* fixed naming error `updatedItems` -> `updateItems`

* fixed type error

* Failing types gracefully if no schema is provided

* beta.6

* Clean-up tsup config

- Use documented way to define config
- Doesn't need to be ts file: not type checked, intellisense available
  in vscode anyway
- remove default & deprecated options

* added other user commands

* added other share commands

* satisfy prettier

* added string array types to webhook core schema

* fixed plain string request output

* keep nullability for relational fields

* Update documentation guides to use new SDK (#19131)

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
Co-authored-by: Kevin Lewis <kvn@lws.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Brainslug <tim@brainslug.nl>

* Fix error messages for core collections

* updated dictionary

* updated partial item input for fields

* Ready, set, go!

---------

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Fabian Hiller <35291865+fabian-hiller@users.noreply.github.com>
Co-authored-by: Esther Agbaje <folasadeagbaje@gmail.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Esther Agbaje <53586167+estheragbaje@users.noreply.github.com>
Co-authored-by: Kevin Lewis <kvn@lws.io>
2023-07-25 14:46:06 -04:00

415 lines
3.7 KiB
Plaintext

.env
.npmrc
(A|a)sync
(A|a)utocomplete
(A|a)xios
(B|b)ackend
(B|b)ackend-as-a-(S|s)ervice
(B|b)alancer
(B|b)asemap
(B|b)lackbox
(B|b)ugfixes
(C|)ancelling
(C|c)ancelled
(C|c)harset
(C|c)heckboxes
(C|c)loudinary
(C|c)loudinary's
(C|c)odebase
(C|c)omposables?
(C|c)onfigs?
(C|c)ustomizable
(D|d)atacenter
(D|d)atastores
(D|d)atetimes?
(D|d)onut
(D|d)ropdown
(D|d)ropdowns
(DN|dn)
(E|e)ntrypoints?
(F|f)ilesystem
(F|f)ormatter
(F|f)rontend
(F|f)rontmatter
(H|h)ardcode
(H|h)ealthcheck
(H|h)ostname
(I|i)nit
(I|i)ntegrations
(M|m)emcache
(M|m)imetype
(M|m)isconfigured
(M|m)ultitenancy
(N|n)atively
(Q|q)uickstart
(R|r)econfigures
(R|r)elink
(R|r)epo
(R|r)ollup
(S|s)chemas?
(S|s)endmail
(S|s)erverless
(S|s)lugify
(S|s)ortable
(S|s)tepline
(S|s)ubheader
(T|t)extarea
(T|t)ooltips?
(T|t)riage
(T|t)riaging
(U|u)narchive
(U|u)narchived
(U|u)narchiving
(U|u)nfilterable
(U|u)nlink
(U|u)psert
(U|u)tils?
(URI|URIs)
(URL|url)
(V|v)ite
(V|v)itest
(W|w)alkthrough
(W|w)ebhook.?
(W|w)ebhooks?
(W|w)ebSocket
(W|w)ebSockets
[0-9]*(KB|MB|GB|K|px|pm|am)
[0-9]*[Kk]i?B
[0-9]*x[0-9]*
[0-9]*x[0-9]*px
[A-Z0-9]{6}
[M|m]onorepo
2FA
45K
ACL
ACS
Alibaba
allowlist
allowList
alwaysdata
anonymized
api
API
APIs
app-centric
architected
Argon2's
argon2(d|i)?
Argon2(d|i)?
auth
Auth
Auth0
authenticator
autoscaling
AWS
backend
Base64
Blackbox
buildout
camelCase
Capterra
Cardgroup
cardinality
CDNs?
changelogs
changeset
changesets
Changesets
CLA
CLI
CloudFront
Cloudinary's
Cloudron
CloudSQL
CMS
CockroachDB
CodeDeploy
CommonJS
composables
config-options
CORS
CPUs?
create-directus-extension
cron
Cron
CRON
crowdin
Crowdin
CrowdIn
Crowdin.
Crowdin's
CRUDS
cryptographic
CSRF
csv
CSV
CTAs?
customizable
customizations
DateTime
DDoS
destructured
Dev
devs
Devtools
DigitalOcean
DigitalOcean's
directus
Directus
directus_(.*)
Directus-(.*)
Directus.
Directus's
Dockerfile
Dockerhub
DOM
double-moustache
dropdown
Duh
e.g.,
EB
EC2
eCommerce
ELB
Elestio
entrypoint
Entrypoint
env
ENV
ESM
EXIF
fallbacks
falsy
FavIcon
filepath
free-form
frontend
G2
Gantt
gcloud
graphql
GCP
GCS
GDPR
geo-coordinates
geospatial
Geospatial
getter
GHCR
glibc
Gmail
granularly
GraphQL
greenlight
GUIs?
headshot
Heya
Hoppscotch
HTTPS?
IAM
IETF
IETF's
IIS
iisnode
incongruent
intwined
IoT
ISO8601
iss
iteratively
Jamstack
Javascript
JPG
JS
JS-SDK
json
JSON
JWT
kanban
Kanban
Keycloak
Knex
Koyeb
KPIs
Kubernetes
LDAP
localhost
lowercased
LTS
M1
M2A
M2As
M2M
M2Ms
M2O
M2Os
Mailgun
Mapbox
MDN
Memorystore
MiB
middleware
misconfiguration
misconfigurations
mixins
Mongo
monorepo's
more_horiz
multitenant
mysql_native_password
namespace
netcup
Netlify
nitty-gritty
no-brainer
node[^\s]*
NodeJS
NoSQL
npm
NPM
npx
nullable
Nuxt
O2M
O2Ms
O2O
OAuth
Okta
omnichannel
on-prem
OpenAPI
OpenID
OracleDB
OracleDB's
OSS
OTP
pageClass
param
paywalled
performant
phpMyAdmin
Phusion
Pinia
Pinia-based
pino
Pino
Plesk
PNG
pnpm
Postgres
Postgres13
PR
pre
pre-configured
pre-defined
pre-existing
pre-formatted
pre-installed
programmatically
Programmatically
ProgressEvent
PRs
pub/sub
px
px.
reactively
readonly
readTime
(R|r)ealtime
(R|r)eal-(T|t)ime
rebase
reconfigurations
reconnection
reframe
REKT
relationally
relationally-linked
repo
repurpose
S3
saml
SAML
scalable
Scalable
SCSS
sdk
SDK
SDL
semver
SemVer
SemVer-like
SendGrid
SEO
SES
sexualized
SFC
siloed
slugification
slugify
slugifying
SMTP
socio-economic
SSG
SSL
SSO
SSR
StackOverflow
stylization
subdirectory
subfolder
substring
(S|s)upabase
SuperAdmins?
superset
Superset
SVG
TablePlus
tfa
TFA
TileJSON
TinyMCE
TLS
toc
TrustRadius
truthy
TTL
TTY
TypeDoc
UI
UID
UIDs
UIs?
unarchives
Ungrouped
unintuitive
unpaused
unselectable
upscaled
upvotes
userbase
uuid
UUID
UUIDs
UUIDv4
UX
v[0-9]{1,2}
varchar
vCPU
Vercel
viewability
VitePress
volta
VPC
Vue
Vue's
WebDAV
webhosting
webpage
whitelabeling
whitespace
wireframe
XSS
yaml
YAML
Zeet