supabase/spec/common-client-libs.yml

openref: 0.1

info:
  id: reference/common-library-file
  itle: Supabase Client libs common
  description: |

    This file shares info common between the JS and Dart libraries.

functions:
  - id: initializing
    title: initializing

  - id: select
    title: 'Fetching data'
    product: database

  - id: insert
    title: 'Insert data'
    product: 'database'

  - id: update
    title: 'Update data'
    product: 'database'

  - id: upsert
    title: 'Upsert data'
    product: 'database'

  - id: delete
    title: 'Delete data'
    product: 'database'

  - id: rpc
    title: 'Postgres functions'
    product: 'database'

  - id: eq
    title: eq()
    product: 'database'
    parent: 'Filters'

  - id: neq
    title: neq()
    product: 'database'
    parent: 'Filters'

  - id: gt
    title: gt()
    product: 'database'
    parent: 'Filters'

  - id: gte
    title: gte()
    product: 'database'
    parent: 'Filters'

  - id: lt
    title: lt()
    product: 'database'
    parent: 'Filters'

  - id: lte
    title: lte()
    product: 'database'
    parent: 'Filters'

  - id: like
    title: like()
    product: 'database'
    parent: 'Filters'

  - id: ilike
    title: ilike()
    product: 'database'
    parent: 'Filters'

  - id: is
    title: is()
    product: 'database'
    parent: 'Filters'

  - id: in
    title: in()
    product: 'database'
    parent: 'Filters'

  - id: contains
    title: contains()
    product: 'database'
    parent: 'Filters'

  - id: contained-by
    title: containedBy()
    product: 'database'
    parent: 'Filters'

  - id: range-gt
    title: rangeGt()
    product: 'database'
    parent: 'Filters'

  - id: range-gte
    title: rangeGte()
    product: 'database'
    parent: 'Filters'

  - id: range-lt
    title: rangeLt()
    product: 'database'
    parent: 'Filters'

  - id: range-lte
    title: rangeLte()
    product: 'database'
    parent: 'Filters'

  - id: range-adjacent
    title: rangeAdjacent()
    product: 'database'
    parent: 'Filters'

  - id: overlaps
    title: overlaps()
    product: 'database'
    parent: 'Filters'

  - id: text-search
    title: textSearch()
    product: 'database'
    parent: 'Filters'

  - id: match
    title: match()
    product: 'database'
    parent: 'Filters'

  - id: not
    title: not()
    product: 'database'
    parent: 'Filters'

  - id: or
    title: or()
    product: 'database'
    parent: 'Filters'

  - id: filter
    title: filter()
    product: 'database'
    parent: 'Filters'

  - id: using-modifiers
    title: Using Modifiers
    product: 'database'
    parent: 'Modifiers'

  - id: db-modifiers-select
    title: select()
    product: 'database'
    parent: 'Modifiers'

  - id: order
    title: order()
    product: 'database'
    parent: 'Modifiers'

  - id: limit
    title: limit()
    product: 'database'
    parent: 'Modifiers'

  - id: range
    title: range()
    product: 'database'
    parent: 'Modifiers'

  - id: abort-signal
    title: abortSignal()
    product: 'database'
    parent: 'Modifiers'

  - id: single
    title: single()
    product: 'database'
    parent: 'Modifiers'

  - id: maybeSingle
    title: maybeSingle()
    product: 'database'
    parent: 'Modifiers'

  - id: csv
    title: csv()
    product: 'database'
    parent: 'Modifiers'

  - id: sign-up
    title: Sign up
    product: 'auth'

  - id: sign-in-with-password
    title: Sign in with password
    product: 'auth'

  - id: sign-in-with-otp
    title: Sign in with OTP
    product: 'auth'

  - id: sign-in-with-oauth
    title: Sign in with 0auth
    product: 'auth'

  - id: sign-out
    title: signOut()
    product: 'auth'

  - id: verify-otp
    title: verifyOtp()
    product: 'auth'

  - id: get-session
    title: getSession()
    product: 'auth'

  - id: get-user
    title: getUser()
    product: 'auth'

  - id: update-user
    title: updateUser()
    product: 'auth'

  - id: set-session
    title: setSession()
    product: 'auth'

  - id: refresh-session
    title: refreshSession()
    product: 'auth'

  - id: on-auth-state-change
    title: onAuthStateChange()
    product: 'auth'

  - id: admin-api
    title: Overview
    product: 'auth-admin'

  - id: get-user-by-id
    title: getUserById()
    product: 'auth-admin'

  - id: list-users
    title: listUsers()
    product: 'auth-admin'

  - id: create-user
    title: createUser()
    product: 'auth-admin'

  - id: delete-user
    title: deleteUser()
    product: 'auth-admin'

  - id: invite-user-by-email
    title: inviteUserByEmail()
    product: 'auth-admin'

  - id: auth-reset-password-for-email
    title: resetPasswordForEmail()
    product: 'auth-admin'

  - id: generate-link
    title: generateLink()
    product: 'auth-admin'

  - id: update-user-by-id
    title: updateUserById()
    product: 'auth-admin'

  - id: invoke
    title: invoke()
    product: 'functions'

  - id: subscribe
    title: on().subscribe()
    product: 'realtime'

  - id: get-channels
    title: getChannels()
    product: 'realtime'

  - id: remove-channel
    title: removeChannel()
    product: 'realtime'

  - id: remove-all-channels
    title: removeAllChannels()
    product: 'realtime'

  - id: list-buckets
    title: listBuckets()
    product: 'storage'

  - id: get-bucket
    title: getBucket()
    product: 'storage'

  - id: create-bucket
    title: createBucket()
    product: 'storage'

  - id: empty-bucket
    title: emptyBucket()
    product: 'storage'

  - id: update-bucket
    title: updateBucket()
    product: 'storage'

  - id: delete-bucket
    title: deleteBucket()
    product: 'storage'

  - id: from-upload
    title: from.upload()
    product: 'storage'

  - id: from-update
    title: from.update()
    product: 'storage'

  - id: from-move
    title: from.move()
    product: 'storage'

  - id: from-copy
    title: from.copy()
    product: 'storage'

  - id: from-create-signed-url
    title: from.createSignedUrl()
    product: 'storage'

  - id: from-create-signed-urls
    title: from.createSignedUrls()
    product: 'storage'

  - id: from-get-public-url
    title: from.getPublicUrl()
    product: 'storage'

  - id: from-download
    title: from.download()
    product: 'storage'

  - id: from-remove
    title: from.remove()
    product: 'storage'

  - id: from-list
    title: from.list()
    product: 'storage'