Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhancement: Add more useful methods like list, delete, edit, show to ApiClient and ViewHelpers #294

Closed
wojtek-krysiak opened this issue Feb 11, 2020 · 2 comments
Closed

Enhancement: Add more useful methods like list, delete, edit, show to ApiClient and ViewHelpers #294

wojtek-krysiak opened this issue Feb 11, 2020 · 2 comments
Labels
enhancement New feature or request extra small very small issue which can be done in 1-2h or less

Comments

@wojtek-krysiak
Copy link
Contributor

wojtek-krysiak commented Feb 11, 2020 •
edited

Right now ApiClient has functions like recordAction, resourceAction etc. This is totally cool because it relates to the AdminBro architecture but it would be good to have an alias functions.

So instead of calling

api.recordAction({actionName: 'show', recordId: 'xxx', resourceId: 'zzz'})

it would be good to have:

api.show(recordId, resourceId)

the same for list, edit, delete, bulkDelete.
@wojtek-krysiak wojtek-krysiak changed the title add more useful methods like getRecords, delete, update to ApiClient add more useful methods like getRecords, delete, update to ApiClient and ViewHelpers Feb 27, 2020
@wojtek-krysiak wojtek-krysiak changed the title add more useful methods like getRecords, delete, update to ApiClient and ViewHelpers add more useful methods like list, delete, edit, show to ApiClient and ViewHelpers Feb 27, 2020
@wojtek-krysiak wojtek-krysiak added enhancement New feature or request extra small very small issue which can be done in 1-2h or less labels Feb 27, 2020
@wojtek-krysiak wojtek-krysiak added this to the 3.3 milestone Sep 3, 2020
wojtek-krysiak added a commit that referenced this issue Oct 1, 2020
@wojtek-krysiak
feat: add new shortcut methods to ViewHelpers
6915056 
relates to #294
github-actions bot pushed a commit that referenced this issue Oct 1, 2020
@semantic-release-bot
chore(release): 3.3.0-beta.11 [skip ci]
ecbab81 
# [3.3.0-beta.11](v3.3.0-beta.10...v3.3.0-beta.11) (2020-10-01)

### Bug Fixes

* clear BaseRecord#populated when value is undefined ([54dae81](54dae81))
* export missing types ([5e9308f](5e9308f))

### Features

* add new shortcut methods to ViewHelpers ([6915056](6915056)), closes [#294](#294)
github-actions bot pushed a commit that referenced this issue Oct 30, 2020
@semantic-release-bot
chore(release): 3.3.0-rc-cf.1 [skip ci]
9e42e8e 
# [3.3.0-rc-cf.1](v3.2.5...v3.3.0-rc-cf.1) (2020-10-30)

### Bug Fixes

* add new release tag rc-cf ([66dd243](66dd243))
* allow to bundle slatejs ([26d2c52](26d2c52))
* bring back design-system as a dependency ([cb3fa32](cb3fa32))
* clear BaseRecord#populated when value is undefined ([54dae81](54dae81))
* clicking nav closes the sidebar ([ffc92a6](ffc92a6)), closes [#601](#601)
* create new release ([cbb40cd](cbb40cd))
* duplicated virtual properties for nested keys ([8043757](8043757))
* edit action updates context.record ([d18f296](d18f296))
* error when passing prop: undefined ([748d2ee](748d2ee))
* export missing PropertyType ([1063365](1063365))
* export missing types ([5e9308f](5e9308f))
* filter params set by setRecord in useRecord ([82ea4d5](82ea4d5))
* fix performance issues in large records ([05ea7ee](05ea7ee))
* handle Date when coverting to formData ([5cdd80d](5cdd80d))
* improve filtering params in useRecord ([49da96e](49da96e))
* improve styling for a section in edit component ([6dea8c0](6dea8c0))
* initialize i18n only if its not already, extend otherwise ([e05b2f9](e05b2f9))
* logout button now skips react router ([37cd486](37cd486))
* merging params and customParam in useRecord ([a580eb7](a580eb7))
* missing actions ([c74615b](c74615b))
* multiple style issues ([3161436](3161436))
* new action populates record before returning ([19dd439](19dd439))
* populator fetched references for wrong types ([0528057](0528057))
* pssing params to richtext ([fd6a3b1](fd6a3b1)), closes [#603](#603)
* remove useEffect causing useRecord to reset ([8760ab0](8760ab0)), closes [#624](#624)
* rename data to context ([3d19230](3d19230))
* search by not searchable property ([31bf9d2](31bf9d2))
* sidebar width when content was too big ([18265b7](18265b7))
* wrong company url when assetsCDN is set ([1027e05](1027e05))
* wrong npmignore ignoring all `app` folders ([ed3be71](ed3be71))

### Features

* ability to move resource on top in the navigation ([28e0a5d](28e0a5d))
* add custom property to Action ([9d9f0cc](9d9f0cc))
* add filterOutParams, selectParams to flat ([4ba1552](4ba1552))
* add flat module ([ec7e53d](ec7e53d))
* add isArray to PropertyOptions ([3e21cba](3e21cba)), closes [#576](#576)
* add new get and set functions to BaseRecord ([438b7f1](438b7f1)), closes [#566](#566)
* add new options to useRecord hook ([323ea9a](323ea9a))
* add new props property ([607de55](607de55))
* add new shortcut methods to ViewHelpers ([6915056](6915056)), closes [#294](#294)
* add new useResource hook ([3fe39f7](3fe39f7)), closes [#325](#325)
* add option to create nested schemas in JSONB ([fe543d2](fe543d2)), closes [#157](#157) [#444](#444)
* add useAction hook and rewrite action button ([f1b0123](f1b0123))
* bump design-system version ([ee12a81](ee12a81))
* bump desing-system ([1f306ee](1f306ee))
* change buttons in record in list ([a9bac06](a9bac06))
* change show components ([20cc6a6](20cc6a6))
* define reference in PropertyOptions ([052661d](052661d)), closes [#583](#583) [#416](#416)
* handling onverriding params in BaseRecord ([3dd1747](3dd1747))
* migrate to ButtonGroup ([6ddd2d7](6ddd2d7))
* move populator logic to the adminbro core ([bf7055e](bf7055e)), closes [#587](#587)
* move state of sidebar visibility to the local store ([221fcfa](221fcfa))
* option to nest actions under parents ([0c064c3](0c064c3))
* pass multiple arguments to flat.selectParams ([046292d](046292d))
* pass property.custom to all edit renderers ([7592239](7592239)), closes [#258](#258)
* show/hide label in PropertyOptions ([df110c6](df110c6))
* style post settings ([2680cae](2680cae))
* support for jsonb fields ([bb9de77](bb9de77)), closes [#631](#631) [#628](#628) [#491](#491) [#444](#444)
* update design system ([cae3b84](cae3b84))
* update sidebar to the latest design system ([9cdb33c](9cdb33c))
* wrap bulk actions with ButtonGroup ([203268f](203268f))
github-actions bot pushed a commit that referenced this issue Nov 1, 2020
@semantic-release-bot
chore(release): 3.3.0 [skip ci]
6fc2cf1 
# [3.3.0](v3.2.5...v3.3.0) (2020-11-01)

### Bug Fixes

* allow to bundle slatejs ([26d2c52](26d2c52))
* array manipulaton in deeply nested propertiescloses: [#645](#645) ([7f0bb71](7f0bb71))
* bring back design-system as a dependency ([cb3fa32](cb3fa32))
* chaning Date to objects in flat.set error ([291cb83](291cb83))
* clear BaseRecord#populated when value is undefined ([54dae81](54dae81))
* clicking nav closes the sidebar ([ffc92a6](ffc92a6)), closes [#601](#601)
* duplicated virtual properties for nested keys ([8043757](8043757))
* edit action updates context.record ([d18f296](d18f296))
* error when passing prop: undefined ([748d2ee](748d2ee))
* export missing PropertyType ([1063365](1063365))
* export missing types ([5e9308f](5e9308f))
* filter params set by setRecord in useRecord ([82ea4d5](82ea4d5))
* fix performance issues in large records ([05ea7ee](05ea7ee))
* handle Date when coverting to formData ([5cdd80d](5cdd80d))
* handle wrong value in BaseRecord#populated ([75acbf6](75acbf6))
* improve filtering params in useRecord ([49da96e](49da96e))
* improve styling for a section in edit component ([6dea8c0](6dea8c0))
* initialize i18n only if its not already, extend otherwise ([e05b2f9](e05b2f9))
* logout button now skips react router ([37cd486](37cd486))
* memoize property in BasePropertyComponent ([b7ac269](b7ac269))
* merging params and customParam in useRecord ([a580eb7](a580eb7))
* missing actions ([c74615b](c74615b))
* multiple style issues ([3161436](3161436))
* new action populates record before returning ([19dd439](19dd439))
* old record being rendered in recordAction ([09ebcd0](09ebcd0))
* overlapping error message ([d3d61c1](d3d61c1))
* population logic for deeply nested properties ([1ada282](1ada282)), closes [#645](#645)
* populator fetched references for wrong types ([0528057](0528057))
* pssing params to richtext ([fd6a3b1](fd6a3b1)), closes [#603](#603)
* remove useEffect causing useRecord to reset ([8760ab0](8760ab0)), closes [#624](#624)
* rename data to context ([3d19230](3d19230))
* search by not searchable property ([31bf9d2](31bf9d2))
* sidebar big zIndex don't overlap eveything ([1872408](1872408))
* sidebar width when content was too big ([18265b7](18265b7))
* wrong company url when assetsCDN is set ([1027e05](1027e05))
* wrong npmignore ignoring all `app` folders ([ed3be71](ed3be71))
* **babel:** add babel plugin for styled components ([fa9fb8f](fa9fb8f))
* **bundle:** exit with no zero code on bundle error ([29cabb1](29cabb1))
* **bundle:** fix babel input paths ([b516e9f](b516e9f))
* **bundle:** move to default import ([2660f56](2660f56))

### Features

* ability to move resource on top in the navigation ([28e0a5d](28e0a5d))
* add custom property to Action ([9d9f0cc](9d9f0cc))
* add filterOutParams, selectParams to flat ([4ba1552](4ba1552))
* add flat module ([ec7e53d](ec7e53d))
* add isArray to PropertyOptions ([3e21cba](3e21cba)), closes [#576](#576)
* add new get and set functions to BaseRecord ([438b7f1](438b7f1)), closes [#566](#566)
* add new options to useRecord hook ([323ea9a](323ea9a))
* add new props property ([607de55](607de55))
* add new shortcut methods to ViewHelpers ([6915056](6915056)), closes [#294](#294)
* add new useResource hook ([3fe39f7](3fe39f7)), closes [#325](#325)
* add option to create nested schemas in JSONB ([fe543d2](fe543d2)), closes [#157](#157) [#444](#444)
* add useAction hook and rewrite action button ([f1b0123](f1b0123))
* bump bundled dependencies ([f108eaa](f108eaa))
* bump design system to the latest version ([8c690f9](8c690f9))
* bump design-system version ([ee12a81](ee12a81))
* bump desing-system ([1f306ee](1f306ee))
* change buttons in record in list ([a9bac06](a9bac06))
* change show components ([20cc6a6](20cc6a6))
* define reference in PropertyOptions ([052661d](052661d)), closes [#583](#583) [#416](#416)
* flat.filterOutParams takes more properties ([478af85](478af85))
* handling onverriding params in BaseRecord ([3dd1747](3dd1747))
* migrate to ButtonGroup ([6ddd2d7](6ddd2d7))
* move populator logic to the adminbro core ([bf7055e](bf7055e)), closes [#587](#587)
* move state of sidebar visibility to the local store ([221fcfa](221fcfa))
* option to nest actions under parents ([0c064c3](0c064c3))
* pass multiple arguments to flat.selectParams ([046292d](046292d))
* pass property.custom to all edit renderers ([7592239](7592239)), closes [#258](#258)
* show/hide label in PropertyOptions ([df110c6](df110c6))
* style post settings ([2680cae](2680cae))
* support for jsonb fields ([bb9de77](bb9de77)), closes [#631](#631) [#628](#628) [#491](#491) [#444](#444)
* update design system ([cae3b84](cae3b84))
* update sidebar to the latest design system ([9cdb33c](9cdb33c))
* wrap bulk actions with ButtonGroup ([203268f](203268f))
* **bundle:** allow any external dependecy in custom components ([f069b70](f069b70))
* **bundle:** migrate to new rollup plugins ([3ef7f0b](3ef7f0b))
* **bundler:** allow use jsnext modules ([922e2f7](922e2f7))
@dziraf
Copy link
Contributor

dziraf commented Jun 15, 2022

This is done for ViewHelpers only: https://github.com/SoftwareBrothers/adminjs/blob/master/src/backend/utils/view-helpers/view-helpers.ts#L162

TODO in ApiClient

@dziraf dziraf removed this from the 3.3 milestone Jun 15, 2022
@dziraf dziraf changed the title add more useful methods like list, delete, edit, show to ApiClient and ViewHelpers Enhancement: Add more useful methods like list, delete, edit, show to ApiClient and ViewHelpers Jun 15, 2022
@krzysztofstudniarek
Copy link
Contributor

We don't plan to do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request extra small very small issue which can be done in 1-2h or less
Projects
AdminJS
Status: Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@wojtek-krysiak @krzysztofstudniarek @dziraf