Loading System Purposes from JSON file, overriding default data.ts va… #128

syberkitten · 2023-06-19T10:55:30Z

Loading System Purposes from JSON file, overriding default data.ts values,
allows to extend without changing sourcecode.

Add Teacher and Default system purposes, update API host, and load systemPurposes from JSON file
Add .env.* to .gitignore
Modify src/data.ts to load systemPurposes from systemPurposes.json
Add Teacher and Default system purposes in systemPurposes.json

…lues, allows to extend without changing sourcecode. - Add Teacher and Default system purposes, update API host, and load systemPurposes from JSON file - Add .env.* to .gitignore - Modify src/data.ts to load systemPurposes from systemPurposes.json - Add Teacher and Default system purposes in systemPurposes.json

vercel · 2023-06-19T10:55:33Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
big-agi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 9, 2023 0:06am

syberkitten · 2023-06-19T11:01:18Z

Hi Guys,
Amazing project!!!

by the way It may be preferred to put the systemPurposes.json inside the env vars section
such as:
OVERRIDE_SYSTEM_PURPOSES="systemPurposes.json"
so that it will be overloaded (extended) only when it exists.

Basically this idea comes from the fact that I'm using BigAGI in tandem with another
project and i want to get the latest features while still extending it
without having to have code collisions.

Ideas are welcome and I'll be glad to assist... )

enricoros · 2023-06-19T16:23:57Z

Thanks @syberkitten, good idea, smart implementation. Do you know whether the loading code runs at build time or runtime, and client or server? that 'require' is dark magic to me :)

enricoros · 2023-06-19T17:08:58Z

Another question @syberkitten: what do you think if we had the current SystemPurposes inside the JSON, with maybe 1-2 as fallback in case the JSON is loaded incorrectly?

This would allow for greater customization, since the current impl wouldn't allow removal, only add/override.

Also, there's an 'invisible' list of IDs in the store-purposes... maybe that should be loaded from a JSON the first time..

syberkitten · 2023-06-20T19:47:56Z

Thanks for the feedback @enricoros
As to the first question the require('../systemPurposes.json') dark magic is used on the server side during the build process.

When the code is bundled and built, the server will attempt to load the systemPurposes.json file and merge its contents with the SystemPurposes object which should be available on both the server and client sides after the build process.

I will also add the JSON validation and error handling so that if the json is malformed An error will be printed
and only the valid fields will be used.

As to the second question I'll give it a further dive and get back to you :)

syberkitten · 2023-06-20T19:51:38Z

@enricoros can you please specify which fallback purposes would you have as fallback??

enricoros · 2023-06-23T07:49:43Z

@enricoros can you please specify which fallback purposes would you have as fallback??

Good point, no need for those. Sorry for the lag, I had a few other changes to bring in before this. I've tried and it works.

DeFiFoFum · 2023-06-29T21:29:23Z

I'm also a fan of being able to drop in agent purposes with a JSON and to be able to back it up easily and share. 🔥

… folder instead of the root folder.

- Updated bpTileSize values in PurposeSelector.tsx - Imported system-purposes.json in store-purposes.ts - Updated hiddenPurposeIDs in usePurposeStore function - Updated title in SystemPurposes object in data.ts - Updated systemPurposesJson and validatedSystemPurposes in data.ts

syberkitten · 2023-07-04T11:12:42Z

Ok, I've made final changes to the Pull Request including these features:

Moved the system-purposes.json (now it's called such to be more in par with naming conventions)
the file is now inside a new folder called 'customization' so not to clutter the root. - other customizations can go there later on such as for branding etc....
@enricoros system-purposes.json now has Settings key, with the hidden purposes IDS which are loaded from the json if they exist otherwise a default value inside store-purposes.ts will be used
As a game I've added another purpose, you heard of DAN? it's now hidden and can be enabled with the normal "Edit" when selecting a purpose. (coming from the system-purposes.json)
I've Enlarged a bit the purpose boxes so that a longer title will fit when editing them, perhaps it needs some more adjustment to look better, I'm not strong on the react layout side, yet....

Let me know if you have other remarks or ideas, looking forward to see this in as I've already started working on more stuff, so next PR is coming soon.... :)

… different breakpoints.

…, added try-catch block to handle file import error, and updated default state and toggleHiddenPurposeId action.

syberkitten · 2023-07-09T12:07:15Z

Hi @enricoros and @DeFiFoFum
I've added another fix to make sure that default "hiddenPurposeIDs" work even if the system-purposes.json is missing.

DeFiFoFum · 2023-07-13T18:31:07Z

Hi @enricoros and @DeFiFoFum I've added another fix to make sure that default "hiddenPurposeIDs" work even if the system-purposes.json is missing.

@syberkitten This looks like a great start, but I would hope that users who are not building the application themselves would be able to upload their own custom configs (and also be able to save and back them up).

syberkitten · 2023-07-17T19:46:46Z

Hi @DeFiFoFum
Yes for new users and old, we need to document this feature, so it'll be clear how to change such Personas.
so I will add a section to the readme.md or equivalent section.

Other then this, I wish is to be able to customize both branding as well.
a kind of a "snap in" plugin system that will allow the project be used for different use cases, would be amazing.

Some of the features here (for my use case) are not really needed, but they are "backed"
and make the project more complex to maintain.... I was actually pursuing just a simple chatGPT
client for React JS when I found out about BigAgi.

enricoros · 2023-07-24T07:31:42Z

@syberkitten I started merging this, but then went down a rabbit hole of trying to make an editing system. So can't merge yet as I wanted.
I'll probably have to restart on this from scratch as I accumulated too much experimental code but your request is quite straightforward.

I started using Zod for type validation, then did an overlay (instead of append) of the purposes, then renamed to personas, then changed the data structure, move to a 'zustand store' for user customization, etc etc.. -- basically, tried to boil the ocean and aren't done yet. I should probably land a minimal version of your patch first, and then restart with the big personas change.

enricoros · 2023-11-17T09:04:58Z

Hi @syberkitten, closing this as will be tracked with a new system of making personas dynamic. #35

vercel bot deployed to Preview June 19, 2023 10:56 View deployment

Add validation for systemPurposes.json and improve error handling

4b33e5c

vercel bot deployed to Preview June 20, 2023 20:15 View deployment

enricoros self-requested a review June 25, 2023 00:01

DMTarmey approved these changes Jun 28, 2023

View reviewed changes

Refactor data.ts to import systemPurposes.json from the customization…

28863f3

… folder instead of the root folder.

vercel bot deployed to Preview July 4, 2023 09:43 View deployment

vercel bot deployed to Preview July 4, 2023 11:05 View deployment

Updated bpTileSize in PurposeSelector.tsx to adjust the tile size for…

8628053

… different breakpoints.

vercel bot deployed to Preview July 4, 2023 11:17 View deployment

Refactored purpose-selector store to handle system-purposes.json file…

eae89b9

…, added try-catch block to handle file import error, and updated default state and toggleHiddenPurposeId action.

vercel bot deployed to Preview July 9, 2023 12:06 View deployment

enricoros closed this Nov 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Loading System Purposes from JSON file, overriding default data.ts va… #128

Loading System Purposes from JSON file, overriding default data.ts va… #128

syberkitten commented Jun 19, 2023

vercel bot commented Jun 19, 2023 •

edited

Loading

syberkitten commented Jun 19, 2023

enricoros commented Jun 19, 2023

enricoros commented Jun 19, 2023

syberkitten commented Jun 20, 2023 •

edited

Loading

syberkitten commented Jun 20, 2023 •

edited

Loading

enricoros commented Jun 23, 2023

DeFiFoFum commented Jun 29, 2023

syberkitten commented Jul 4, 2023 •

edited

Loading

syberkitten commented Jul 9, 2023

DeFiFoFum commented Jul 13, 2023

syberkitten commented Jul 17, 2023

enricoros commented Jul 24, 2023 •

edited

Loading

enricoros commented Nov 17, 2023

Loading System Purposes from JSON file, overriding default data.ts va… #128

Loading System Purposes from JSON file, overriding default data.ts va… #128

Conversation

syberkitten commented Jun 19, 2023

vercel bot commented Jun 19, 2023 • edited Loading

syberkitten commented Jun 19, 2023

enricoros commented Jun 19, 2023

enricoros commented Jun 19, 2023

syberkitten commented Jun 20, 2023 • edited Loading

syberkitten commented Jun 20, 2023 • edited Loading

enricoros commented Jun 23, 2023

DeFiFoFum commented Jun 29, 2023

syberkitten commented Jul 4, 2023 • edited Loading

syberkitten commented Jul 9, 2023

DeFiFoFum commented Jul 13, 2023

syberkitten commented Jul 17, 2023

enricoros commented Jul 24, 2023 • edited Loading

enricoros commented Nov 17, 2023

vercel bot commented Jun 19, 2023 •

edited

Loading

syberkitten commented Jun 20, 2023 •

edited

Loading

syberkitten commented Jun 20, 2023 •

edited

Loading

syberkitten commented Jul 4, 2023 •

edited

Loading

enricoros commented Jul 24, 2023 •

edited

Loading