go/pocketbase
1
0
Fork 0
mirror of https://github.com/pocketbase/pocketbase.git synced 2024-11-24 17:07:00 +02:00
Code Issues Releases Activity
3122223a71
pocketbase/CHANGELOG.md

63 KiB
Raw Blame History

v0.16.4-WIP

  • Fixed the selfupdate command not working on Windows due to missing .exe in the extracted binary path (#2589).

  • Added int64, int32, uint, uint64 and uint32 support when scanning types.DateTime (#2602)

v0.16.3

  • Fixed schema fields sort not working on Safari/Gnome Web (#2567).

  • Fixed default PRAGMAs not being applied for new connections (#2570).

v0.16.2

  • Fixed backups archive not excluding the local backups directory on Windows (#2548).

  • Changed file field to not use dataTransfer.effectAllowed when dropping files since it is not reliable and consistent across different OS and browsers (#2541).

  • Auto register the initial generated snapshot migration to prevent incorrectly reapplying the snapshot on Docker restart (#2551).

  • Fixed missing view id field error message typo.

v0.16.1

  • Fixed backup restore not working in a container environment when pb_data is mounted as volume (#2519).

  • Fixed Dart SDK realtime API preview example (#2523; thanks @xFrann).

  • Fixed typo in the backups create panel (#2526; thanks @dschissler).

  • Removed unnecessary slice length check in list.ExistInSlice (#2527; thanks @KunalSin9h).

  • Avoid mutating the cached request data on OAuth2 user create (#2535).

  • Fixed Export Collections "Download as JSON" (#2540).

  • Fixed file field drag and drop not working in Firefox and Safari (#2541).

v0.16.0

  • Added automated backups (+ cron rotation) APIs and UI for the pb_data directory. The backups can be also initialized programmatically using app.CreateBackup("backup.zip"). There is also experimental restore method - app.RestoreBackup("backup.zip") (currently works only on UNIX systems as it relies on execve). The backups can be stored locally or in external S3 storage (it has its own configuration, separate from the file uploads storage filesystem).

  • Added option to limit the returned API fields using the ?fields query parameter. The "fields picker" is applied for SearchResult.Items and every other JSON response. For example:

    // original: {"id": "RECORD_ID", "name": "abc", "description": "...something very big...", "items": ["id1", "id2"], "expand": {"items": [{"id": "id1", "name": "test1"}, {"id": "id2", "name": "test2"}]}}
// output:   {"name": "abc", "expand": {"items": [{"name": "test1"}, {"name": "test2"}]}}
const result = await pb.collection("example").getOne("RECORD_ID", {
  expand: "items",
  fields: "name,expand.items.name",
})

  • Added new ./pocketbase update command to selfupdate the prebuilt executable (with option to generate a backup of your pb_data).

  • Added new ./pocketbase admin console command:

    // creates new admin account
./pocketbase admin create test@example.com 123456890

// changes the password of an existing admin account
./pocketbase admin update test@example.com 0987654321

// deletes single admin account (if exists)
./pocketbase admin delete test@example.com

  • Added apis.Serve(app, options) helper to allow starting the API server programmatically.

  • Updated the schema fields Admin UI for "tidier" fields visualization.

  • Updated the logs "real" user IP to check for Fly-Client-IP header and changed the X-Forward-For header to use the first non-empty leftmost-ish IP as it the closest to the "real IP".

  • Added new tools/archive helper subpackage for managing archives (currently works only with zip).

  • Added new tools/cron helper subpackage for scheduling task using cron-like syntax (this eventually may get exported in the future in a separate repo).

  • Added new Filesystem.List(prefix) helper to retrieve a flat list with all files under the provided prefix.

  • Added new App.NewBackupsFilesystem() helper to create a dedicated filesystem abstraction for managing app data backups.

  • Added new App.OnTerminate() hook (executed right before app termination, eg. on SIGTERM signal).

  • Added accept file field attribute with the field MIME types (#2466; thanks @Nikhil1920).

  • Added support for multiple files sort in the Admin UI (#2445).

  • Added support for multiple relations sort in the Admin UI.

  • Added meta.isNew to the OAuth2 auth JSON response to indicate a newly OAuth2 created PocketBase user.

v0.15.3

  • Updated the Admin UI to use the latest JS SDK to resolve the isNew record field conflict (#2385).

  • Fixed editor field fullscreen z-index (#2410).

  • Inserts the default app settings as part of the system init migration so that they are always available when accessed from within a user defined migration (#2423).

v0.15.2

  • Fixed View query SELECT DISTINCT identifiers parsing (#2349-5706019).

  • Fixed View collection schema incorrectly resolving multiple aliased fields originating from the same field source (#2349-5707675).

  • Added OAuth2 redirect fallback message to notify the user to go back to the app in case the browser window is not auto closed.

v0.15.1

  • Trigger the related Record model realtime subscription events on custom model struct save (#2325).

  • Fixed Ctrl + S in the editor field not propagating the quick save shortcut to the parent form.

  • Added ⌘ + S alias for the record quick save shortcut (I have no Mac device to test it but it should work based on e.metaKey docs).

  • Enabled RTL for the TinyMCE editor (#2327).

  • Reduced the record form vertical layout shifts and slightly improved the rendering speed when loading multiple relation fields.

  • Enabled Admin UI assets cache.

v0.15.0

  • Simplified the OAuth2 authentication flow in a single "all in one" call (#55). Requires JS SDK v0.14.0+ or Dart SDK v0.9.0+. The manual code-token exchange flow is still supported but the SDK method is renamed to authWithOAuth2Code() (to minimize the breaking changes the JS SDK has a function overload that will proxy the existing authWithOauth2 calls to authWithOAuth2Code). For more details and example, you could check https://pocketbase.io/docs/authentication/#oauth2-integration.

  • Added support for protected files (#215). Requires JS SDK v0.14.0+ or Dart SDK v0.9.0+. It works with a short lived (~5min) file token passed as query param with the file url. For more details and example, you could check https://pocketbase.io/docs/files-handling/#protected-files.

  • ! Fixed typo in Record.WithUnkownData() -> Record.WithUnknownData().

  • Added simple loose wildcard search term support in the Admin UI.

  • Added auto "draft" to allow restoring previous record state in case of accidental reload or power outage.

  • Added Ctrl + S shortcut to save the record changes without closing the panel.

  • Added "drop files" support for the file upload field.

  • Refreshed the OAuth2 Admin UI.

v0.14.5

  • Added checks for nil hooks in forms.RecordUpsert when used with custom Dao (#2277).

  • Fixed unique detailed field error not returned on record create failure (#2287).

v0.14.4

  • Fixed concurrent map write pannic on list.ExistInSliceWithRegex() cache (#2272).

v0.14.3

  • Fixed Admin UI Logs meta visualization in Firefox (#2221).

  • Downgraded to v1 of the aws/aws-sdk-go package since v2 has compatibility issues with GCS (#2231).

  • Upgraded the GitHub action to use min Go 1.20.3 for the prebuilt executable since it contains some minor net/http security fixes.

v0.14.2

  • Reverted part of the old COALESCE handling as a fallback to support empty string comparison with missing joined relation fields.

v0.14.1

  • Fixed realtime events firing before the files upload completion.

  • Updated the underlying S3 lib to use aws-sdk-go-v2 (#1346; thanks @yuxiang-gao).

  • Updated TinyMCE to v6.4.1.

  • Updated the godoc of Dao.Save* methods.

v0.14.0

  • Added experimental Apple OAuth2 integration.

  • Added @request.headers.* filter rule support.

  • Added support for advanced unique constraints and indexes management (#345, #544)

  • Simplified the collections fields UI to allow easier and quicker scaffolding of the data schema.

  • Deprecated SchemaField.Unique. Unique constraints are now managed via indexes. The Unique field is a no-op and will be removed in future version.

  • Removed the COALESCE wrapping from some of the generated filter conditions to make better use of the indexes (#1939).

  • Detect id aliased view columns as single relation fields (#2029).

  • Optimized single relation lookups.

  • Normalized record values on maxSelect field option change (select, file, relation). When changing from single to multiple all already inserted single values are converted to an array. When changing from multiple to single only the last item of the already inserted array items is kept.

  • Changed the cost/round factor of bcrypt hash generation from 13 to 12 since several users complained about the slow authWithPassword responses on lower spec hardware. The change will affect only new users. Depending on the demand, we might make it configurable from the auth options.

  • Simplified the default mail template styles to allow more control over the template layout (#1904).

  • Added option to explicitly set the record id from the Admin UI (#2118).

  • Added migrate history-sync command to clean _migrations history table from deleted migration files references.

  • Added new fields to the core.RecordAuthWithOAuth2Event struct:

    IsNewRecord     bool,          // boolean field indicating whether the OAuth2 action created a new auth record
ProviderName    string,        // the name of the OAuth2 provider (eg. "google")
ProviderClient  auth.Provider, // the loaded Provider client instance

  • Added CGO linux target for the prebuilt executable.

  • ! Renamed daos.GetTableColumns() to daos.TableColumns() for consistency with the other Dao table related helpers.

  • ! Renamed daos.GetTableInfo() to daos.TableInfo() for consistency with the other Dao table related helpers.

  • ! Changed types.JsonArray to support specifying a generic type, aka. types.JsonArray[T]. If you have previously used types.JsonArray, you'll have to update it to types.JsonArray[any].

  • ! Registered the RemoveTrailingSlash middleware only for the /api/* routes since it is causing issues with subpath file serving endpoints (#2072).

  • ! Changed the request logs method value to UPPERCASE, eg. "get" => "GET" (#1956).

  • Other minor UI improvements.

v0.13.4

  • Removed eager unique collection name check to support lazy validation during bulk import.

v0.13.3

  • Fixed view collections import (#2044).

  • Updated the records picker Admin UI to show properly view collection relations.

v0.13.2

  • Fixed Admin UI js error when selecting multiple file field as relation "Display fields" (#1989).

v0.13.1

  • Added HEAD request method support for the /api/files/:collection/:recordId/:filename route (#1976).

v0.13.0

  • Added new "View" collection type allowing you to create a read-only collection from a custom SQL SELECT statement. It supports:

    • aggregations (COUNT(), MIN(), MAX(), GROUP BY, etc.)
    • column and table aliases
    • CTEs and subquery expressions
    • auto relation fields association
    • file fields proxying (up to 5 linked relations, eg. view1->view2->...->base)
    • filter, sort and expand
    • List and View API rules

  • Added auto fail/retry (default to 8 attempts) for the SELECT queries to gracefully handle the database is locked errors (#1795). The default max attempts can be accessed or changed via Dao.MaxLockRetries.

  • Added default max query execution timeout (30s). The default timeout can be accessed or changed via Dao.ModelQueryTimeout. For the prebuilt executables it can be also changed via the --queryTimeout=10 flag.

  • Added support for dao.RecordQuery(collection) to scan directly the One() and All() results in *models.Record or []*models.Record without the need of explicit NullStringMap.

  • Added support to overwrite the default file serve headers if an explicit response header is set.

  • Added file thumbs when visualizing relation display file fields.

  • Added "Min select" relation field option.

  • Enabled process.env in JS migrations to allow accessing os.Environ().

  • Added UploadedFiles field to the RecordCreateEvent and RecordUpdateEvent event structs.

  • ! Moved file upload after the record persistent to allow setting custom record id safely from the OnModelBeforeCreate hook.

  • ! Changed System.GetFile() to return directly *blob.Reader instead of the io.ReadCloser interface.

  • ! Changed To, Cc and Bcc of mailer.Message to []mail.Address for consistency and to allow multiple recipients and optional name.

    If you are sending custom emails, you'll have to replace:

    message := &mailer.Message{
  ...

  // (old) To: mail.Address{Address: "to@example.com"}
  To: []mail.Address{{Address: "to@example.com", Name: "Some optional name"}},

  // (old) Cc: []string{"cc@example.com"}
  Cc: []mail.Address{{Address: "cc@example.com", Name: "Some optional name"}},

  // (old) Bcc: []string{"bcc@example.com"}
  Bcc: []mail.Address{{Address: "bcc@example.com", Name: "Some optional name"}},

  ...
}

  • ! Refactored the Authentik integration as a more generic "OpenID Connect" provider (oidc) to support any OIDC provider (Okta, Keycloak, etc.). If you've previously used Authentik, make sure to rename the provider key in your code to oidc. To enable more than one OIDC provider you can use the additional oidc2 and oidc3 provider keys.

  • ! Removed the previously deprecated Dao.Block() and Dao.Continue() helpers in favor of Dao.NonconcurrentDB().

  • Updated the internal redirects to allow easier subpath deployment when behind a reverse proxy.

  • Other minor Admin UI improvements.

v0.12.3

  • Fixed "Toggle column" reactivity when navigating between collections (#1836).

  • Logged the current datetime on server start (#1822).

v0.12.2

  • Fixed the "Clear" button of the datepicker component not clearing the value (#1730).

  • Increased slightly the fields contrast (#1742).

  • Auto close the multi-select dropdown if "Max select" is reached.

v0.12.1

  • Fixed js error on empty relation save.

  • Fixed overlay-active css class not being removed on nested overlay panel close (#1718).

  • Added the collection name in the page title (#1711).

v0.12.0

  • Refactored the relation picker UI to allow server-side search, sort, create, update and delete of relation records (#976).

  • Added new RelationOptions.DisplayFields option to specify custom relation field(s) visualization in the Admin UI.

  • Added Authentik OAuth2 provider (#1377; thanks @pr0ton11).

  • Added LiveChat OAuth2 provider (#1573; thanks @mariosant).

  • Added Gitea OAuth2 provider (#1643; thanks @hlanderdev).

  • Added PDF file previews (#1548; thanks @mjadobson).

  • Added video and audio file previews.

  • Added rich text editor (editor) field for HTML content based on TinyMCE (#370). Currently the new field doesn't have any configuration options or validations but this may change in the future depending on how devs ended up using it.

  • Added "Duplicate" Collection and Record options in the Admin UI (#1656).

  • Added filesystem.GetFile() helper to read files through the FileSystem abstraction (#1578; thanks @avarabyeu).

  • Added new auth event hooks for finer control and more advanced auth scenarios handling:

    // auth record
OnRecordBeforeAuthWithPasswordRequest()
OnRecordAfterAuthWithPasswordRequest()
OnRecordBeforeAuthWithOAuth2Request()
OnRecordAfterAuthWithOAuth2Request()
OnRecordBeforeAuthRefreshRequest()
OnRecordAfterAuthRefreshRequest()

// admin
OnAdminBeforeAuthWithPasswordRequest()
OnAdminAfterAuthWithPasswordRequest()
OnAdminBeforeAuthRefreshRequest()
OnAdminAfterAuthRefreshRequest()
OnAdminBeforeRequestPasswordResetRequest()
OnAdminAfterRequestPasswordResetRequest()
OnAdminBeforeConfirmPasswordResetRequest()
OnAdminAfterConfirmPasswordResetRequest()

  • Added models.Record.CleanCopy() helper that creates a new record copy with only the latest data state of the existing one and all other options reset to their defaults.

  • Added new helper apis.RecordAuthResponse(app, httpContext, record, meta) to return a standard Record auth API response (#1623).

  • Refactored models.Record expand and data change operations to be concurrent safe.

  • Refactored all forms Submit interceptors to use a generic data type as their payload.

  • Added several store.Store helpers:

    store.Reset(newData map[string]T)
store.Length() int
store.GetAll() map[string]T

  • Added "tags" support for all Record and Model related event hooks.

    The "tags" allow registering event handlers that will be called only on matching table name(s) or colleciton id(s)/name(s). For example:

    app.OnRecordBeforeCreateRequest("articles").Add(func(e *core.RecordCreateEvent) error {
  // called only on "articles" record creation
  log.Println(e.Record)
  return nil
})

    For all those event hooks *hook.Hook was replaced with *hooks.TaggedHook, but the hook methods signatures are the same so it should behave as it was previously if no tags were specified.

  • ! Fixed the json field string value normalization (#1703).

    In order to support seamlessly both application/json and multipart/form-data requests, the following normalization rules are applied if the json field is a plain string value:

    • "true" is converted to the json true
    • "false" is converted to the json false
    • "null" is converted to the json null
    • "[1,2,3]" is converted to the json [1,2,3]
    • "{"a":1,"b":2}" is converted to the json {"a":1,"b":2}
    • numeric strings are converted to json number
    • double quoted strings are left as they are (aka. without normalizations)
    • any other string (empty string too) is double quoted

    Additionally, the "Nonempty" json field constraint now checks for null, [], {} and "" (empty string).

  • Added aria-label to some of the buttons in the Admin UI for better accessibility (#1702; thanks @ndarilek).

  • Updated the filename extension checks in the Admin UI to be case-insensitive (#1707; thanks @hungcrush).

  • Other minor improvements (more detailed API file upload errors, UI optimizations, docs improvements, etc.)

v0.11.4

  • Fixed cascade delete for rel records with the same id as the main record (#1689).

v0.11.3

  • Fix realtime API panic on concurrent clients iteration (#1628)

    • app.SubscriptionsBroker().Clients() now returns a shallow copy of the underlying map.

    • Added Discard() and IsDiscarded() helper methods to the subscriptions.Client interface.

    • Slow clients should no longer "block" the main action completion.

v0.11.2

  • Fixed fs.DeleteByPrefix() hang on invalid S3 settings (#1575).

  • Updated file(s) delete to run in the background on record/collection delete to avoid blocking the delete model transaction. Currently the cascade files delete operation is treated as "non-critical" and in case of an error it is just logged during debug. This will be improved in the near future with the planned async job queue implementation.

v0.11.1

  • Unescaped path parameter values (#1552).

v0.11.0

  • Added + and - body field modifiers for number, files, select and relation fields.

    {
  // oldValue + 2
  "someNumber+": 2,

  // oldValue + ["id1", "id2"] - ["id3"]
  "someRelation+": ["id1", "id2"],
  "someRelation-": ["id3"],

  // delete single file by its name (file fields supports only the "-" modifier!)
  "someFile-": "filename.png",
}

    Note1: @request.data.someField will contain the final resolved value.

    Note2: The old index ("field.0":null) and filename ("field.filename.png":null) based suffixed syntax for deleting files is still supported.

  • ! Added support for multi-match/match-all request data and collection multi-valued fields (select, relation) conditions. If you want a "at least one of" type of condition, you can prefix the operator with ?.

    // for each someRelA.someRelB record require the "status" field to be "active"
someRelA.someRelB.status = "active"

// OR for "at least one of" condition
someRelA.someRelB.status ?= "active"

    Note: Previously the behavior for multi-valued fields was as the "at least one of" type. The release comes with system db migration that will update your existing API rules (if needed) to preserve the compatibility. If you have multi-select or multi-relation filter checks in your client-side code and want to preserve the old behavior, you'll have to prefix with ? your operators.

  • Added support for querying @request.data.someRelField.* relation fields.

    // example submitted data: {"someRel": "REL_RECORD_ID"}
@request.data.someRel.status = "active"

  • Added :isset modifier for the static request data fields.

    // prevent changing the "role" field
@request.data.role:isset = false

  • Added :length modifier for the arrayable request data and collection fields (select, file, relation).

    // example submitted data: {"someSelectField": ["val1", "val2"]}
@request.data.someSelectField:length = 2

// check existing record field length
someSelectField:length = 2

  • Added :each modifier support for the multi-select request data and collection field.

    // check if all selected rows has "pb_" prefix
roles:each ~ 'pb_%'

  • Improved the Admin UI filters autocomplete.

  • Added @random sort key for RANDOM() sorted list results.

  • Added Strava OAuth2 provider (#1443; thanks @szsascha).

  • Added Gitee OAuth2 provider (#1448; thanks @yuxiang-gao).

  • Added IME status check to the textarea keydown handler (#1370; thanks @tenthree).

  • Added filesystem.NewFileFromBytes() helper (#1420; thanks @dschissler).

  • Added support for reordering uploaded multiple files.

  • Added webp to the default images mime type presets list (#1469; thanks @khairulhaaziq).

  • Added the OAuth2 refresh token to the auth meta response (#1487).

  • Fixed the text wrapping in the Admin UI listing searchbar (#1416).

  • Fixed number field value output in the records listing (#1447).

  • Fixed duplicated settings view pages caused by uncompleted transitions (#1498).

  • Allowed sending Authorization header with the /auth-with-password record and admin login requests (#1494).

  • migrate down now reverts migrations in the applied order.

  • Added additional list-bucket check in the S3 config test API.

  • Other minor improvements.

v0.10.4

  • Fixed Record.MergeExpand panic when the main model expand map is not initialized (#1365).

v0.10.3

  • ! Renamed the metadata key original_filename to original-filename due to an S3 file upload error caused by the underscore character (#1343; thanks @yuxiang-gao).

  • Fixed request verification docs api url (#1332; thanks @JoyMajumdar2001)

  • Excluded collectionId and collectionName from the displayable relation props list (1322; thanks @dhall2).

v0.10.2

  • Fixed nested multiple expands with shared path (#586). A new helper method models.Record.MergeExpand(map[string]any) was also added to simplify the expand handling and unit testing.

v0.10.1

  • Fixed nested transactions deadlock when authenticating with OAuth2 (#1291).

v0.10.0

  • Added /api/health endpoint (thanks @MarvinJWendt).

  • Added support for SMTP LOGIN auth for Microsoft/Outlook and other providers that don't support the PLAIN auth method (#1217).

  • Reduced memory consumption (you can expect ~20% less allocated memory).

  • Added support for split (concurrent and nonconcurrent) DB connections pool increasing even further the concurrent throughput without blocking reads on heavy write load.

  • Improved record references delete performance.

  • Removed the unnecessary parenthesis in the generated filter SQL query, reducing the "parse stack overflow" errors.

  • Fixed ~ expressions backslash literal escaping (#1231).

  • Refactored the core.app.Bootstrap() to be called before starting the cobra commands (#1267).

  • ! Changed pocketbase.NewWithConfig(config Config) to pocketbase.NewWithConfig(config *Config) and added 4 new config settings:

    DataMaxOpenConns int // default to core.DefaultDataMaxOpenConns
DataMaxIdleConns int // default to core.DefaultDataMaxIdleConns
LogsMaxOpenConns int // default to core.DefaultLogsMaxOpenConns
LogsMaxIdleConns int // default to core.DefaultLogsMaxIdleConns

  • Added new helper method core.App.IsBootstrapped() to check the current app bootstrap state.

  • ! Changed core.NewBaseApp(dir, encryptionEnv, isDebug) to NewBaseApp(config *BaseAppConfig).

  • ! Removed rest.UploadedFile struct (see below filesystem.File).

  • Added generic file resource struct that allows loading and uploading file content from different sources (at the moment multipart/form-data requests and from the local filesystem).

    filesystem.File{}
filesystem.NewFileFromPath(path)
filesystem.NewFileFromMultipart(multipartHeader)
filesystem/System.UploadFile(file)

  • Refactored forms.RecordUpsert to allow more easily loading and removing files programmatically.

    forms.RecordUpsert.AddFiles(key, filesystem.File...) // add new filesystem.File to the form for upload
forms.RecordUpsert.RemoveFiles(key, filenames...)     // marks the filenames for deletion

  • Trigger the password validators if any of the others password change fields is set.

v0.9.2

  • Fixed field column name conflict on record deletion (#1220).

v0.9.1

  • Moved the record file upload and delete out of the db transaction to minimize the locking times.

  • Added Dao query semaphore and base fail/retry handling to improve the concurrent writes throughput (#1187).

  • Fixed records cascade deletion when there are "A<->B" relation references.

  • Replaced c.QueryString() with c.QueryParams().Encode() to allow loading middleware modified query parameters in the default crud actions (#1210).

  • Fixed the datetime field not triggering the onChange event on manual field edit and added a "Clear" button (#1219).

  • Updated the GitHub goreleaser action to use go 1.19.4 since it comes with some security fixes.

v0.9.0

  • Fixed concurrent multi-relation cascade update/delete (#1138).

  • Added the raw OAuth2 user data (meta.rawUser) and OAuth2 access token (meta.accessToken) to the auth response (#654).

  • BaseModel.UnmarkAsNew() method was renamed to BaseModel.MarkAsNotNew(). Additionally, to simplify the insert model queries with custom IDs, it is no longer required to call MarkAsNew() for manually initialized models with set ID since now this is the default state. When the model is populated with values from the database (eg. after row Scan) it will be marked automatically as "not new".

  • Added Record.OriginalCopy() method that returns a new Record copy populated with the initially loaded record data (useful if you want to compare old and new field values).

  • Added new event hooks:

    app.OnBeforeBootstrap()
app.OnAfterBootstrap()
app.OnBeforeApiError()
app.OnAfterApiError()
app.OnRealtimeDisconnectRequest()
app.OnRealtimeBeforeMessageSend()
app.OnRealtimeAfterMessageSend()
app.OnRecordBeforeRequestPasswordResetRequest()
app.OnRecordAfterRequestPasswordResetRequest()
app.OnRecordBeforeConfirmPasswordResetRequest()
app.OnRecordAfterConfirmPasswordResetRequest()
app.OnRecordBeforeRequestVerificationRequest()
app.OnRecordAfterRequestVerificationRequest()
app.OnRecordBeforeConfirmVerificationRequest()
app.OnRecordAfterConfirmVerificationRequest()
app.OnRecordBeforeRequestEmailChangeRequest()
app.OnRecordAfterRequestEmailChangeRequest()
app.OnRecordBeforeConfirmEmailChangeRequest()
app.OnRecordAfterConfirmEmailChangeRequest()

  • The original uploaded file name is now stored as metadata under the original_filename key. It could be accessed via:

    fs, _ := app.NewFilesystem()
defer fs.Close()

attrs, _ := fs.Attributes(fikeKey)
attrs.Metadata["original_name"]

  • Added support for Partial/Range file requests (#1125). This is a minor breaking change if you are using filesystem.Serve (eg. as part of a custom OnFileDownloadRequest hook):

    // old
filesystem.Serve(res, e.ServedPath, e.ServedName)

// new
filesystem.Serve(res, req, e.ServedPath, e.ServedName)

  • Refactored the migrate command to support external JavaScript migration files using an embedded JS interpreter (goja). This allow writing custom migration scripts such as programmatically creating collections, initializing default settings, running data imports, etc., with a JavaScript API very similar to the Go one (more documentation will be available soon).

    The migrate command is available by default for the prebuilt executable, but if you use PocketBase as framework you need register it manually:

    migrationsDir := "" // default to "pb_migrations" (for js) and "migrations" (for go)

// load js files if you want to allow loading external JavaScript migrations
jsvm.MustRegisterMigrations(app, &jsvm.MigrationsOptions{
  Dir: migrationsDir,
})

// register the `migrate` command
migratecmd.MustRegister(app, app.RootCmd, &migratecmd.Options{
  TemplateLang: migratecmd.TemplateLangJS, // or migratecmd.TemplateLangGo (default)
  Dir:          migrationsDir,
  Automigrate:  true,
})

    The refactoring also comes with automigrations support.

    If Automigrate is enabled (true by default for the prebuilt executable; can be disabled with --automigrate=0), PocketBase will generate seamlessly in the background JS (or Go) migration file with your collection changes. The directory with the JS migrations can be committed to your git repo. All migrations (Go and JS) are automatically executed on server start. Also note that the auto generated migrations are granural (in contrast to the migrate collections snapshot command) and allow multiple developers to do changes on the collections independently (even editing the same collection) miniziming the eventual merge conflicts. Here is a sample JS migration file that will be generated if you for example edit a single collection name:

    // pb_migrations/1669663597_updated_posts_old.js
migrate((db) => {
  // up
  const dao = new Dao(db)
  const collection = dao.findCollectionByNameOrId("lngf8rb3dqu86r3")
  collection.name = "posts_new"
  return dao.saveCollection(collection)
}, (db) => {
  // down
  const dao = new Dao(db)
  const collection = dao.findCollectionByNameOrId("lngf8rb3dqu86r3")
  collection.name = "posts_old"
  return dao.saveCollection(collection)
})

  • Added new Dao helpers to make it easier fetching and updating the app settings from a migration:

    dao.FindSettings([optEncryptionKey])
dao.SaveSettings(newSettings, [optEncryptionKey])

  • Moved core.Settings to models/settings.Settings:

    core.Settings{}           -> settings.Settings{}
core.NewSettings()        -> settings.New()
core.MetaConfig{}         -> settings.MetaConfig{}
core.LogsConfig{}         -> settings.LogsConfig{}
core.SmtpConfig{}         -> settings.SmtpConfig{}
core.S3Config{}           -> settings.S3Config{}
core.TokenConfig{}        -> settings.TokenConfig{}
core.AuthProviderConfig{} -> settings.AuthProviderConfig{}

  • Changed the mailer.Mailer interface (minor breaking if you are sending custom emails):

    // Old:
app.NewMailClient().Send(from, to, subject, html, attachments?)

// New:
app.NewMailClient().Send(&mailer.Message{
  From: from,
  To: to,
  Subject: subject,
  HTML: html,
  Attachments: attachments,
  // new configurable fields
  Bcc: []string{"bcc1@example.com", "bcc2@example.com"},
  Cc: []string{"cc1@example.com", "cc2@example.com"},
  Headers: map[string]string{"Custom-Header": "test"},
  Text: "custom plain text version",
})

    The new *mailer.Message struct is also now a member of the MailerRecordEvent and MailerAdminEvent events.

  • Other minor UI fixes and improvements

v0.8.0

⚠️ This release contains breaking changes and requires some manual migration steps!

The biggest change is the merge of the User models and the profiles collection per #376. There is no longer user type field and the users are just an "auth" collection (we now support collection types, currently only "base" and "auth"). This should simplify the users management and at the same time allow us to have unlimited multiple "auth" collections each with their own custom fields and authentication options (eg. staff, client, etc.).

In addition to the Users and profiles merge, this release comes with several other improvements:

  • Added indirect expand support #312.

  • The json field type now supports filtering and sorting #423.

  • The relation field now allows unlimited maxSelect (aka. without upper limit).

  • Added support for combined email/username + password authentication (see below authWithPassword()).

  • Added support for full "manager-subordinate" users management, including a special API rule to allow directly changing system fields like email, password, etc. without requiring oldPassword or other user verification.

  • Enabled OAuth2 account linking on authorized request from the same auth collection (this is useful for example if the OAuth2 provider doesn't return an email and you want to associate it with the current logged in user).

  • Added option to toggle the record columns visibility from the table listing.

  • Added support for collection schema fields reordering.

  • Added several new OAuth2 providers (Microsoft Azure AD, Spotify, Twitch, Kakao).

  • Improved memory usage on large file uploads #835.

  • More detailed API preview docs and site documentation (the repo is located at https://github.com/pocketbase/site).

  • Other minor performance improvements (mostly related to the search apis).

Migrate from v0.7.x

Data

The merge of users and profiles comes with several required db changes. The easiest way to apply them is to use the new temporary upgrade command:

# make sure to have a copy of your pb_data in case something fails
cp -r ./pb_data ./pb_data_backup

# run the upgrade command
./pocketbase08 upgrade

# start the application as usual
./pocketbase08 serve

The upgrade command:

  • Creates a new users collection with merged fields from the _users table and the profiles collection. The new user records will have the ids from the profiles collection.
  • Changes all user type fields to relation and update the references to point to the new user ids.
  • Renames all @collection.profiles.*, @request.user.* and @request.user.profile.* filters to @collection.users.* and @request.auth.*.
  • Appends 2 to all schema field names and api filter rules that conflicts with the new system reserved ones: 
    collectionId   => collectionId2
collectionName => collectionName2
expand         => expand2

// only for the "profiles" collection fields:
username               => username2
email                  => email2
emailVisibility        => emailVisibility2
verified               => verified2
tokenKey               => tokenKey2
passwordHash           => passwordHash2
lastResetSentAt        => lastResetSentAt2
lastVerificationSentAt => lastVerificationSentAt2

SDKs

Please check the individual SDK package changelog and apply the necessary changes in your code:

API

You don't have to read this if you are using an official SDK.

  • The authorization schema is no longer necessary. Now it is auto detected from the JWT token payload:

    Old New
    Authorization: Admin TOKEN Authorization: TOKEN
    Authorization: User TOKEN Authorization: TOKEN

  • All datetime stings are now returned in ISO8601 format - with Z suffix and space as separator between the date and time part:

    Old New
    2022-01-02 03:04:05.678 2022-01-02 03:04:05.678Z

  • Removed the @ prefix from the system record fields for easier json parsing:

    Old New
    @collectionId collectionId
    @collectionName collectionName
    @expand expand

  • All users api handlers are moved under /api/collections/:collection/:

    Old New
    GET /api/users/auth-methods GET /api/collections/:collection/auth-methods
    POST /api/users/refresh POST /api/collections/:collection/auth-refresh
    POST /api/users/auth-via-oauth2 POST /api/collections/:collection/auth-with-oauth2
    You can now also pass optional createData object on OAuth2 sign-up.
    Also please note that now required user/profile fields are properly validated when creating new auth model on OAuth2 sign-up.
    POST /api/users/auth-via-email POST /api/collections/:collection/auth-with-password
    Handles username/email + password authentication.
    {"identity": "usernameOrEmail", "password": "123456"}
    POST /api/users/request-password-reset POST /api/collections/:collection/request-password-reset
    POST /api/users/confirm-password-reset POST /api/collections/:collection/confirm-password-reset
    POST /api/users/request-verification POST /api/collections/:collection/request-verification
    POST /api/users/confirm-verification POST /api/collections/:collection/confirm-verification
    POST /api/users/request-email-change POST /api/collections/:collection/request-email-change
    POST /api/users/confirm-email-change POST /api/collections/:collection/confirm-email-change
    GET /api/users GET /api/collections/:collection/records
    GET /api/users/:id GET /api/collections/:collection/records/:id
    POST /api/users POST /api/collections/:collection/records
    PATCH /api/users/:id PATCH /api/collections/:collection/records/:id
    DELETE /api/users/:id DELETE /api/collections/:collection/records/:id
    GET /api/users/:id/external-auths GET /api/collections/:collection/records/:id/external-auths
    DELETE /api/users/:id/external-auths/:provider DELETE /api/collections/:collection/records/:id/external-auths/:provider

    In relation to the above changes, the user property in the auth response is renamed to record.

  • The admins api was also updated for consistency with the users api changes:

    Old New
    POST /api/admins/refresh POST /api/admins/auth-refresh
    POST /api/admins/auth-via-email POST /api/admins/auth-with-password
    {"identity": "test@example.com", "password": "123456"}
    (notice that the email body field was renamed to identity)

  • To prevent confusion with the auth method responses, the following endpoints now returns 204 with empty body (previously 200 with token and auth model):

    POST /api/admins/confirm-password-reset
POST /api/collections/:collection/confirm-password-reset
POST /api/collections/:collection/confirm-verification
POST /api/collections/:collection/confirm-email-change

  • Renamed the "user" related settings fields returned by GET /api/settings:

    Old New
    userAuthToken recordAuthToken
    userPasswordResetToken recordPasswordResetToken
    userEmailChangeToken recordEmailChangeToken
    userVerificationToken recordVerificationToken

Internals

You don't have to read this if you are not using PocketBase as framework.

  • Removed forms.New*WithConfig() factories to minimize ambiguities. If you need to pass a transaction Dao you can use the new SetDao(dao) method available to the form instances.

  • forms.RecordUpsert.LoadData(data map[string]any) now can bulk load external data from a map. To load data from a request instance, you could use forms.RecordUpsert.LoadRequest(r, optKeysPrefix = "").

  • schema.RelationOptions.MaxSelect has new type *int (you can use the new types.Pointer(123) helper to assign pointer values).

  • Renamed the constant apis.ContextUserKey ("user") to apis.ContextAuthRecordKey ("authRecord").

  • Replaced user related middlewares with their auth record alternative:

    Old New
    apis.RequireUserAuth() apis.RequireRecordAuth(optCollectionNames ...string)
    apis.RequireAdminOrUserAuth() apis.RequireAdminOrRecordAuth(optCollectionNames ...string)
    N/A RequireSameContextRecordAuth()
    (requires the auth record to be from the same context collection)

  • The following record Dao helpers now uses the collection id or name instead of *models.Collection instance to reduce the verbosity when fetching records:

    Old New
    dao.FindRecordById(collection, ...) dao.FindRecordById(collectionNameOrId, ...)
    dao.FindRecordsByIds(collection, ...) dao.FindRecordsByIds(collectionNameOrId, ...)
    dao.FindRecordsByExpr(collection, ...) dao.FindRecordsByExpr(collectionNameOrId, ...)
    dao.FindFirstRecordByData(collection, ...) dao.FindFirstRecordByData(collectionNameOrId, ...)
    dao.IsRecordValueUnique(collection, ...) dao.IsRecordValueUnique(collectionNameOrId, ...)

  • Replaced all User related Dao helpers with Record equivalents:

    Old New
    dao.UserQuery() dao.RecordQuery(collection)
    dao.FindUserById(id) dao.FindRecordById(collectionNameOrId, id)
    dao.FindUserByToken(token, baseKey) dao.FindAuthRecordByToken(token, baseKey)
    dao.FindUserByEmail(email) dao.FindAuthRecordByEmail(collectionNameOrId, email)
    N/A dao.FindAuthRecordByUsername(collectionNameOrId, username)

  • Moved the formatted ApiError struct and factories to the github.com/pocketbase/pocketbase/apis subpackage:

    Old New
    Import path
    github.com/pocketbase/pocketbase/tools/rest github.com/pocketbase/pocketbase/apis
    Fields
    rest.ApiError{} apis.ApiError{}
    rest.NewNotFoundError() apis.NewNotFoundError()
    rest.NewBadRequestError() apis.NewBadRequestError()
    rest.NewForbiddenError() apis.NewForbiddenError()
    rest.NewUnauthorizedError() apis.NewUnauthorizedError()
    rest.NewApiError() apis.NewApiError()

  • Renamed models.Record helper getters:

    Old New
    SetDataValue Set
    GetDataValue Get
    GetBoolDataValue GetBool
    GetStringDataValue GetString
    GetIntDataValue GetInt
    GetFloatDataValue GetFloat
    GetTimeDataValue GetTime
    GetDateTimeDataValue GetDateTime
    GetStringSliceDataValue GetStringSlice

  • Added new auth collection models.Record helpers:

    func (m *Record) Username() string
func (m *Record) SetUsername(username string) error
func (m *Record) Email() string
func (m *Record) SetEmail(email string) error
func (m *Record) EmailVisibility() bool
func (m *Record) SetEmailVisibility(visible bool) error
func (m *Record) IgnoreEmailVisibility(state bool)
func (m *Record) Verified() bool
func (m *Record) SetVerified(verified bool) error
func (m *Record) TokenKey() string
func (m *Record) SetTokenKey(key string) error
func (m *Record) RefreshTokenKey() error
func (m *Record) LastResetSentAt() types.DateTime
func (m *Record) SetLastResetSentAt(dateTime types.DateTime) error
func (m *Record) LastVerificationSentAt() types.DateTime
func (m *Record) SetLastVerificationSentAt(dateTime types.DateTime) error
func (m *Record) ValidatePassword(password string) bool
func (m *Record) SetPassword(password string) error

  • Added option to return serialized custom models.Record fields data:

    func (m *Record) UnknownData() map[string]any
func (m *Record) WithUnknownData(state bool)

  • Deleted model.User. Now the user data is stored as an auth models.Record.

    Old New
    User.Email Record.Email()
    User.TokenKey Record.TokenKey()
    User.Verified Record.Verified()
    User.SetPassword() Record.SetPassword()
    User.RefreshTokenKey() Record.RefreshTokenKey()
    etc.

  • Replaced User related event hooks with their Record alternative:

    Old New
    OnMailerBeforeUserResetPasswordSend() *hook.Hook[*MailerUserEvent] OnMailerBeforeRecordResetPasswordSend() *hook.Hook[*MailerRecordEvent]
    OnMailerAfterUserResetPasswordSend() *hook.Hook[*MailerUserEvent] OnMailerAfterRecordResetPasswordSend() *hook.Hook[*MailerRecordEvent]
    OnMailerBeforeUserVerificationSend() *hook.Hook[*MailerUserEvent] OnMailerBeforeRecordVerificationSend() *hook.Hook[*MailerRecordEvent]
    OnMailerAfterUserVerificationSend() *hook.Hook[*MailerUserEvent] OnMailerAfterRecordVerificationSend() *hook.Hook[*MailerRecordEvent]
    OnMailerBeforeUserChangeEmailSend() *hook.Hook[*MailerUserEvent] OnMailerBeforeRecordChangeEmailSend() *hook.Hook[*MailerRecordEvent]
    OnMailerAfterUserChangeEmailSend() *hook.Hook[*MailerUserEvent] OnMailerAfterRecordChangeEmailSend() *hook.Hook[*MailerRecordEvent]
    OnUsersListRequest() *hook.Hook[*UserListEvent] OnRecordsListRequest() *hook.Hook[*RecordsListEvent]
    OnUserViewRequest() *hook.Hook[*UserViewEvent] OnRecordViewRequest() *hook.Hook[*RecordViewEvent]
    OnUserBeforeCreateRequest() *hook.Hook[*UserCreateEvent] OnRecordBeforeCreateRequest() *hook.Hook[*RecordCreateEvent]
    OnUserAfterCreateRequest() *hook.Hook[*UserCreateEvent] OnRecordAfterCreateRequest() *hook.Hook[*RecordCreateEvent]
    OnUserBeforeUpdateRequest() *hook.Hook[*UserUpdateEvent] OnRecordBeforeUpdateRequest() *hook.Hook[*RecordUpdateEvent]
    OnUserAfterUpdateRequest() *hook.Hook[*UserUpdateEvent] OnRecordAfterUpdateRequest() *hook.Hook[*RecordUpdateEvent]
    OnUserBeforeDeleteRequest() *hook.Hook[*UserDeleteEvent] OnRecordBeforeDeleteRequest() *hook.Hook[*RecordDeleteEvent]
    OnUserAfterDeleteRequest() *hook.Hook[*UserDeleteEvent] OnRecordAfterDeleteRequest() *hook.Hook[*RecordDeleteEvent]
    OnUserAuthRequest() *hook.Hook[*UserAuthEvent] OnRecordAuthRequest() *hook.Hook[*RecordAuthEvent]
    OnUserListExternalAuths() *hook.Hook[*UserListExternalAuthsEvent] OnRecordListExternalAuths() *hook.Hook[*RecordListExternalAuthsEvent]
    OnUserBeforeUnlinkExternalAuthRequest() *hook.Hook[*UserUnlinkExternalAuthEvent] OnRecordBeforeUnlinkExternalAuthRequest() *hook.Hook[*RecordUnlinkExternalAuthEvent]
    OnUserAfterUnlinkExternalAuthRequest() *hook.Hook[*UserUnlinkExternalAuthEvent] OnRecordAfterUnlinkExternalAuthRequest() *hook.Hook[*RecordUnlinkExternalAuthEvent]

  • Replaced forms.UserEmailLogin{} with forms.RecordPasswordLogin{} (for both username and email depending on which is enabled for the collection).

  • Renamed user related core.Settings fields:

    Old New
    core.Settings.UserAuthToken{} core.Settings.RecordAuthToken{}
    core.Settings.UserPasswordResetToken{} core.Settings.RecordPasswordResetToken{}
    core.Settings.UserEmailChangeToken{} core.Settings.RecordEmailChangeToken{}
    core.Settings.UserVerificationToken{} core.Settings.RecordVerificationToken{}

  • Marked as "Deprecated" and will be removed in v0.9+:

    core.Settings.EmailAuth{}
core.EmailAuthConfig{}
schema.FieldTypeUser
schema.UserOptions{}

  • The second argument of apis.StaticDirectoryHandler(fileSystem, enableIndexFallback) now is used to enable/disable index.html forwarding on missing file (eg. in case of SPA).