Major Update! NocoBase V1.0 Officially Released

V1.0 Milestone

After 3 years of development, NocoBase has reached its first major version upgrade, transitioning from version 0.x to 1.0. This marks a significant milestone.

• During the 0.x phase: The core API and features underwent rapid changes, with each new version potentially introducing incompatible changes.
• During the 1.x phase: The core API has stabilized, and NocoBase will focus on adding new plugins, optimizing security, and enhancing performance while maintaining stability.

New Features

• Theme editor can configure page and modal padding, block spacing, and block corner radius.
• When adding blocks, collections support filtering.
• Relationship records supports sorting.
• Improved interactivity of data visualization.
• Support for adding chart blocks on mobile devices.
• Chart filter blocks support setting field data scope.
• Add more variables, see details.
• Blocks from any collections can be added in popups.
• Workflows: “Post-action event” can be triggered by buttons inside association blocks.
• Automatic refresh of data in the parent container when data changes within a popup.
• Significant performance improvements in table blocks.
• Substantial increase in test coverage.

New Plugins

• Field: Markdown (Vditor)
  • Used to store Markdown and render it using Vditor editor, supports common Markdown syntax and supports uploading images, recordings, etc.It also allows for instant rendering, where what you see is what you get.
• Comments
  • Provides comment collection template and block to add commenting functionality for any collection.

Full Changelog

• feat(plugin-workflow): refresh the list after sync #4177
• feat(plugin-workflow): show workflow key as tooltip on title #4178
• test(plugin-workflow): add test cases #4199
• chore: api cache control header #4203
• feat: load vditor dep from local #4190
• test: input number separator test #4204
• fix: number field shuold support separator setting #4197
• fix(plugin-workflow): refine experience #4195
• chore: optimize warning wordings of import & export #4196
• refactor: external data source collection manager #4193
• fix: env bug #4191
• fix: empty operator with association field #4189
• chore: add e2e #4184
• fix: vditor version #4183
• refactor: form data template locale improve #4188
• test: add automated testing #4098
• chore: data source logger instance #4181
• chore: get database instance in relation repository #4179
• chore: add e2e for variables #4152
• chore: define collection debug message #4176
• chore: unsupportedFields in view collection #4155
• feat: add plugin-field-markdown-vditor #4065
• fix: bulk edit form acl action error #4166
• fix: auto create uuid foreign key in relation field #4160
• fix(plugin-fm): fix confusing size limit hint #4153
• fix(users): improve users
  #4162
• fix(client): get api url #4161
• feat: remove plugin-ui-routes-storage #4140
• fix: lock cytoscape version #4158
• refactor: collection template support presetFieldsDisabled #4159
• fix: grid schema #4157
• client unit test #4150
• fix: update belongs to many association that target key is not primary key #4146
• refactor: form data template locale improve #4148
• fix(database): column name in array field #4110
• test: refresh on action e2e test #4147
• fix(custom-request): support configuring content type #4144
• chore: deprecate the current record variable from the form #4063
• feat(Theme): add some tokens #4137
• fix(client): fix some warnings #4143
• style: tableActionColumn style improve #4138
• fix: actionBar style improve #4123
• chore: warning message if on delete conflict #4141
• fix(plugin-workflow-manual): allow pass node when no assignee #4139
• chore: datasource manager api #4124
• fix(plugin-workflow-manual): fix assignees parsing bug #4125
• fix: load association field in collection #4122
• perf: remove all Skeleton animation #4113
• test: add e2e #4121
• chore(data-vi): adjust api #4116
• fix: scheduleEventTrigger #4114
• feat(plugin-workflow): add checker for intervally dispatching #4119
• feat: add filterOtherRecordsCollection for DataBlockInitializer #4117
• refactor: optimize CollectionField #4111
• fix: improve sort field migration #4112
• fix: field component #4102
• fix: association select support add mode #4108
• fix: createdBy & updatedBy target option #4109
• fix(linkage-rule): linkage rule support empty condiction #4103
• fix: add SanitizedCollectionProvider #4100
• fix: tree collection target error #4105
• fix: add ClearCollectionFieldContext #4101
• feat: improve form block #4099
• chore: migrate sortable options to sort field #4011
• feat: support sort option in appends #4056
• feat(data-vi): allows pie chart to accept negative numbers, fix T-4075 #4094
• fix(data-vi): number becomes string after precision transformation #4092
• fix: encode url params #4055
• test(plugin-workflow): add test case for duplicated triggering schedule workflow #3817
• perf(LinkageRules): solve lagging problems #4090
• fix(subTable): should not display Allow add new data option #4086
• fix: missing fields #4083
• fix: table select pagination error #4078
• fix: reset page when setting block data scope #4081
• fix: custom request role list #4074
• fix: parse iso week #4068
• fix(sourceId): avoid error #4077
• fix(sql-collection): can’t select interface when setting fields #4079
• fix: load with source field #4075
• fix: deletion of operation linkage rules does not take effect in real time #4058
• fix(core): fix round bug in formula evaluator #4070
• test: add e2e for data loading mode #4069
• fix(filterForm): avoid duplicate names #4071
• chore: optimize block title #4040
• fix: sync default value in view #4067
• fix(defaultValue): fix the issue of default values disappearing after refreshing the page #4066
• refactor: gantt block #4059
• fix: sub-table big field should support variable default value #4062
• chore(Theme): set the default font size of the Compact theme to 16 #4064
• test: add e2e for actions #4053
• fix(variable): missing variables and invalid translations #4054
• test: add backend unit tests #4000
• fix: improve card item #4036
• chore(acl): disable register association fields actions #4014
• fix(variable): fix parent record variable reporting errors in data scope #4039
• test(e2e): add assertions on field values #4034
• feat(Variable): add a new variable #4025
• feat: run e2e with pro plugins #3890
• fix: bug #4038
• fix: array operator with camel case field #4032
• fix: scopeKeyOptions should be obtained in real-time #4029
• fix(addText): should use FormItemSchemaToolbar instead of BlockSchema… #3963
• feat: register once hook in datasource manager #4024
• fix: snippets #4030
• fix: vitest single bug #4031
• feat(data-vi): improved user experiences (refer to pr) #4013
• test: add frontend unit test #3991
• feat: support Others option in popup #4015
• fix(collection-manager): no refresh after override the field #4022
• chore: add export & import warnings #4027
• refactor: third party data source support sort field grouped sorting edit #4023
• fix(plugin-acl): pm.acl.roles snippet #4026
• test: association name block e2e test #4021
• fix: get api url #4020
• fix(Sub-details): the initializer button is not displayed when the field value is empty #4019
• fix: initializer use useAassociationName #4018
• fix(auth): cas login bug when use subdirectory deployment #4017
• fix(TreeTable): add child error #4008
• fix: remove active field should not clear value #4012
• fix(plugin-acl): datasource roles snippet #4016
• fix: after selecting all, bulk update prompts for unselected data #4010
• refactor: tree table is not enabled by default #4001
• feat(plugin-workflow-action-trigger): support association actions to trigger #4007
• Update application.ts #4006
• fix: tag filed setting #4009
• fix(users): remove phone validation due to incorrect check of foreign phone numebrs #4005
• fix: association block action permission verification failed #3994
• refactor: fields for table sorting cannot select sorting fields with scopekey #3984
• fix(Form): invalid parentRecord #3998
• fix(plugin-workflow): adjust locale #3993
• fix: sub -table support allowSelectExistingRecord setting #4004
• fix(auth): sign up page not found when entering with url directly #4002
• chore(database): set null value when field is unique and value is empty string #3997
• chore(gateway): report error with cause message #3999
• chore(error-handler): display message cause the error #3996
• fix: restore with table name in camel case #3995
• refactor(plugin-workflow): adjust comments #3990
• fix: gantt collapse & expand #3982
• fix(BulkForm): should be required when switching to ‘Changed to’ #3965
• fix: move action #3985
• refactor: sort field should not has defaultValue #3986
• chore: update class names of plugins #3981
• feat(plugin-workflow-sync): add sync when multi-app-share-collection enabled #3969
• fix(localization): incorrect locale when first entering #3968
• chore: adjust and add api comments #3951
• refactor: select options configuration #3964
• fix(GridCard): set the count of columns displayed in a row #3960
• refactor: only numerical formula fields support format #3962
• chore(plugin-workflow): add comments #3959
• chore: remove legacy formula plugins #3939
• fix(LinkageRules): should be effective immediately #3958
• fix(Picker): should display Allow add new data option #3957
• fix(connect-data-blocks): should immediately show in the drop-down menu #3953
• fix: left menu title modify #3956
• fix: template list provider bug #3950
• refactor: nanoid &uuid autoFill #3955
• feat: getParentJsonSchema in ui schema repository #3690
• fix: save uuid & nano id field value with sequelize validation #3952
• fix: throughCollection support fuzzy search #3949
• fix: getSourceKeyByAssocation #3947
• fix(RichText): unify style #3946
• fix(connectDataBlocks): should add FilterBlockProvider to Grid #3944
• chore: add appVersion to Schema #3936
• fix: collectionFieldInterfaceSelect #3945
• fix: fix sourceId of templates #3941
• fix(collection manager): collection manager primarykey & nanoid & uuid suport index setting #3943
• fix(plugin-formula-field): fix component context #3937
• fix: nanoid availableTypes #3942
• fix: automatically generate default values #3940
• fix: formula field caluation error #3938
• fix: formula field support format #3928
• refactor: unify tab initailizer naming #3932
• fix: add zIndex to Lightbox overlay style #3934
• fix(Table): fix the problem that the content of the association field is not displayed #3930
• fix(evaluators): fix array flatten #3931
• refactor: main data source view collection support filterTargetKey #3818
• fix: formula field calculation error #3929
• fix: load view collection belongs to association with source options #3912
• fix: edit form unchanged should not appear unSaveed warning when cloas modal #3920
• fix(Collapse): fix error for chinaRegions #3925
• fix: number display format #3924
• fix(defaultValue): should immediate effect when set default value #3923
• feat: action support refreshDataBlockRequest configuration #3882
• refactor: formBlockProvider & detailBlockProvider #3898
• feat(data-vi): allows to add charts for mobile client #3922
• chore: add API comments #3919
• fix: fix Pagination #3921
• test(plugin-error-handler): middleware #3909
• fix: update plugin #3895
• fix: gantt block pagination #3918
• fix: source id null #3917
• fix(Table): fix Pagination #3916
• fix: get the correct sourceId #3897
• fix(DataScope): fix no immediate effect issue after saving #3910
• fix: select field options initialValue #3911
• fix: external link click #3908
• fix(inputNumber): loss of accuracy in inputNumber #3902
• feat(plugin-workflow-action-trigger): add global action events #3883
• docs: add api comment #3868
• fix: vitest config bug #3907
• fix: table fixed bug #3901
• fix: list data undefined error #3905
• fix: lazy render bug #3886
• fix: sort params missing #3906
• refactor: change useProps to x-use-component-props #3853
• fix(withDynamicSchemaProps): change deep merge to shallow merge #3899
• fix: history block add print button, click print button to report error #3900
• fix: tar bug #3891
• chore: return bigInt as string type #3887
• feat(data-vi): data scope for chart filter fields #3894
• feat: adjust menu of add new #3884
• fix(plugin-custom-request): fix edit button dialog #3893
• fix: fieldNames missing when setting data scope #3892
• fix: deps check error when dev add production plugin #3848
• fix: workflow tabs not exists #3889
• fix: association field support data scope linkage #3888
• fix: templateBlockProvider support association field append #3866
• chore: main datasource api #3880
• feat: run vitest with coverage #3802
• fix: avoid duplicate menu keys #3885
• fix(data-vi): dual axes chart displays abnormally #3881
• fix: reject update when filter is empty object #3777
• chore: update field with primary key attribute #3852
• refactor: uuid & nanoid support default value configuration #3830
• feat: table performance #3791
• fix: setFormValueChanged undefined #3879
• fix(client): fix diabled in filter dynamic component #3874
• fix(plugin-workflow-parallel): fix locale #3876
• fix(formula-field): formula field set form value change #3873
• fix: formBlockProvider block display #3877
• refactor(plugin-workflow): change to #3871
• fix: kanban card modal display abnormal #3863
• fix: filterTargetKey only support view collection #3872

Plugin Changes

The following plugins are no longer provided as open-source version (users who have been using them in production environments, please contact us for upgrades):

• @nocobase/plugin-auth-cas: Authenticates identity via the CAS protocol.
• @nocobase/plugin-auth-odic: Authenticates identity via OIDC (OpenID Connect) protocol.
• @nocobase/plugin-auth-saml: Authenticates identity via SAML 2.0.

The following plugins have been deprecated and will be removed in upcoming versions:

• @nocobase/plugin-audit-logs: Deprecated, temporarily not removed, won’t be installed in the new version.
• @nocobase/plugin-snapshot-field: Deprecated, temporarily not removed, won’t be installed in the new version.
• @nocobase/plugin-charts: Use @nocobase/plugin-data-visualization instead.
• @nocobase/plugin-excel-formula-field: Use @nocobase/plugin-field-formula instead.
• @nocobase/plugin-math-formula-field: Use @nocobase/plugin-field-formula instead.
• @nocobase/plugin-ui-routes-storage: Deprecated, frontend routes can be extended directly in the frontend.

For the complete list of plugins, please refer to: https://www.nocobase.com/plugins.html

Code Comments

To provide a better development experience, we’ve added comments to some special APIs:

• @internal: Typically used to identify internal implementation details or methods that are not designed for public use but exist for internal use within the code.
• @experimental: Used to identify experimental features or APIs. These APIs are still in development and testing phases, may undergo significant changes, or even be removed or replaced in future versions.
• @deprecated: Used to identify deprecated features, methods, or APIs in the code. Although they are still available, they may be removed in future versions, or there may be better alternative solutions available.

License Agreement

NocoBase is dual-licensed under AGPL-3.0 and commercial licenses. For details, please refer to the NocoBase License Agreement.

Upgrade Guide

• Always backup your database before upgrading! Always backup your database! Always backup your database!
• You can also backup the entire project code.

Since the Auth: CAS, Auth: OIDC, Auth: SAML three SSO plugins are removed from the open-source code, the upgrade will be divided into two cases.

If you are not using SSO plugins

Please follow the conventional method for upgrading.

If you are using SSO plugins

Please follow these steps to upgrade:

1. Upgrade the Application

Refer to NocoBase Upgrade Overview, and upgrade NocoBase to the latest version.

If you previously enabled CAS, OIDC, SAML plugins, you will see the following prompts during the upgrade:

Command line upgrade terminal prompt:

Docker version interface prompt:

2. Remove Plugins or Obtain Plugin Version 1.0?

If you choose to remove the plugins and continue upgrading:

Remove the plugins according to the prompts

# Main application
yarn pm remove cas oidc saml --force
# If it's a sub-application, add the --app parameter
yarn pm remove cas oidc saml --force --app=sub-app1

Continue upgrading

yarn nocobase upgrade

If you choose to update the plugins to version 1.0

Contact the NocoBase team to obtain version 1.0 of the plugins and continue with the upgrade.

3. CAS, OIDC, SAML Plugin Upgrade Process

At this point, the application interface is no longer accessible, so we need to upgrade manually.

1. Log in with your account at service.nocobase.com to download the latest version of the plugins.
2. Unzip the plugins to the specified directory
   • CAS plugin unzip to ./storage/plugins/@nocobase/plugin-auth-cas
   • OIDC plugin unzip to ./storage/plugins/@nocobase/plugin-auth-oidc
   • SAML plugin unzip to ./storage/plugins/@nocobase/plugin-auth-saml
3. Upgrade the application
   • For Docker version, simply restart the container
   • For source code or create-nocobase-app version
     1. Download dependencies yarn install
     2. Execute upgrade command yarn nocobase upgrade
     3. Restart the application