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.

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

Build new API methods that use Typescript types #412

Closed
8 of 17 tasks
eyeseast opened this issue Jan 25, 2024 · 2 comments
Closed
8 of 17 tasks

Build new API methods that use Typescript types #412

eyeseast opened this issue Jan 25, 2024 · 2 comments
Assignees
Labels
backend Needs related fixes on the backend dependencies Pull requests that update a dependency file

Comments

@eyeseast
Copy link
Collaborator

eyeseast commented Jan 25, 2024

The current API setup uses helpers in src/api that return Svue objects from src/structure. As we build out the sveltekit branch, we need to migrate over API helpers to return plain objects matching TS types. Some of this has been done on master, some on sveltekit.

Making a list here to capture what's on the sveltekit branch:

Documents

  • Document
  • Note
  • Section
  • Page
  • Data
  • Redaction
  • Modification
  • Entity
  • Revision

Users & Orgs

Projects

  • Project
  • EditAccess view | edit | admin
  • Collaborator

Add-Ons

  • AddOn

Add-On types are all in src/addons, since that part of the codebase is self-contained.

@eyeseast eyeseast added this to the SvelteKit milestone Jan 25, 2024
@eyeseast eyeseast added dependencies Pull requests that update a dependency file backend Needs related fixes on the backend labels Feb 2, 2024
@eyeseast eyeseast changed the title Replace stores in src/structure with concrete classes or TS types Build new API methods that use Typescript types Feb 13, 2024
@eyeseast
Copy link
Collaborator Author

These should have tests, too.

@eyeseast eyeseast self-assigned this Feb 14, 2024
@eyeseast
Copy link
Collaborator Author

Closing this, as it's happening in the context of more specific issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Needs related fixes on the backend dependencies Pull requests that update a dependency file
Projects
None yet
Development

No branches or pull requests

1 participant