DouglasNeuroInformatics / OpenDataCapture

An electronic data capture platform for administering remote and in-person clinical instruments
https://opendatacapture.org
Apache License 2.0
103 stars 12 forks source link

add new features #1048

Closed joshunrau closed 4 days ago

joshunrau commented 4 days ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 4 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces multiple changes across various files in the project. Key modifications include the addition of new scripts in the package.json for the API module, updates to logging mechanisms by replacing the Logger with a LoggingService in several services and guards, and adjustments to import paths for the CryptoService. Additionally, enhancements to the InstrumentCard and InstrumentShowcase components are made, focusing on the inclusion of supported languages. Documentation for version 1.7.0 is also added, detailing new features related to series instruments.

Changes

File Change Summary
apps/api/package.json Added scripts: _dev, _dev:test.
apps/api/scripts/build.ts Updated type declaration for options.
apps/api/src/ability/ability.factory.ts Replaced Logger with LoggingService in AbilityFactory.
apps/api/src/app.module.ts Updated import paths for CryptoModule and LoggingModule.
apps/api/src/auth/tests/auth.integration.spec.ts Updated import path for CryptoService.
apps/api/src/auth/tests/auth.service.spec.ts Updated import path for CryptoService.
apps/api/src/auth/auth.service.ts Updated import path for CryptoService.
apps/api/src/auth/guards/authentication.guard.ts Replaced Logger with LoggingService in AuthenticationGuard.
apps/api/src/auth/guards/authorization.guard.ts Replaced Logger with LoggingService in AuthorizationGuard.
apps/api/src/auth/strategies/jwt.strategy.ts Replaced Logger with LoggingService in JwtStrategy.
apps/api/src/demo/demo.service.ts Replaced Logger with LoggingService in DemoService.
apps/api/src/gateway/gateway.service.ts Replaced Logger with LoggingService in GatewayService.
apps/api/src/gateway/gateway.synchronizer.ts Replaced Logger with LoggingService in GatewaySynchronizer.
apps/api/src/instrument-records/instrument-measures.service.ts Replaced Logger with LoggingService in InstrumentMeasuresService.
apps/api/src/instruments/tests/instruments.integration.spec.ts Updated import path for CryptoService.
apps/api/src/instruments/tests/instruments.service.spec.ts Updated import path for CryptoService.
apps/api/src/instruments/instruments.service.ts Updated import path for CryptoService and added LoggingService.
apps/api/src/main.ts Updated logging mechanism to use JSONLogger.
apps/api/src/prisma/prisma.factory.ts Replaced Logger with JSONLogger.
apps/api/src/prisma/prisma.module.ts Replaced Logger with JSONLogger.
apps/api/src/prisma/prisma.service.ts Replaced Logger with LoggingService.
apps/api/src/sessions/sessions.service.ts Replaced Logger with LoggingService in SessionsService.
apps/api/src/setup/setup.service.ts Updated getState method to use getReleaseInfo.
apps/api/src/subjects/tests/subjects.integration.spec.ts Updated import path for CryptoService.
apps/api/src/subjects/tests/subjects.service.spec.ts Updated import path for CryptoService.
apps/api/src/typings/global.d.ts Removed __RELEASE__ constant, added ImportMeta interface.
apps/api/src/users/tests/users.integration.spec.ts Updated import path for CryptoService.
apps/api/src/users/users.service.ts Updated import path for CryptoService.
apps/outreach/astro.config.ts Added new entry in sidebar for documentation.
apps/outreach/src/plugins/starlight-plugin-typedoc/theme.ts Updated #addDeprecatedAside method signature.
apps/web/package.json Added dependency: @opendatacapture/licenses.
apps/web/src/features/instruments/components/InstrumentCard/InstrumentCard.stories.tsx Updated Default story for InstrumentCard.
apps/web/src/features/instruments/components/InstrumentCard/InstrumentCard.tsx Enhanced InstrumentCard with new properties and rendering logic.
apps/web/src/features/instruments/components/InstrumentShowcase/InstrumentShowcase.tsx Updated filteredInstruments state type.
apps/web/src/hooks/useInstrumentInfoQuery.ts Modified return structure of useInstrumentInfoQuery.
docs/en/6-updating/v1.7.0.md Added documentation for version 1.7.0.
packages/instrument-library/src/forms/happiness-questionnaire/index.ts Added clientDetails property to instrument definition.
packages/instrument-renderer/src/components/InstrumentOverview/InstrumentOverview.tsx Simplified rendering logic in InstrumentOverview.
packages/instrument-renderer/src/components/InteractiveContent/InteractiveContent.tsx Added full-screen functionality.
packages/instrument-utils/src/translate.ts Added new translation functions and updated existing ones.
packages/runtime-core/src/types/instrument.base.d.ts Added new types for client instrument details.
packages/runtime-core/src/types/instrument.form.d.ts Removed details property from FormInstrument.
packages/runtime-core/src/types/instrument.interactive.d.ts Made details optional in InteractiveInstrument.
packages/schemas/src/instrument/instrument.base.ts Introduced new types for client instrument details.
packages/schemas/src/instrument/instrument.form.ts Removed details from $FormInstrument.
packages/schemas/src/instrument/instrument.interactive.ts Made details optional in $InteractiveInstrument.
pnpm-workspace.yaml Updated version for @douglasneuroinformatics/libnest to latest.
runtime/v1/package.json Updated version from 1.5.0 to 1.6.1.
runtime/v1/runtime.config.js Updated dependency version for @jspsych/plugin-html-button-response to 2.x.

Poem

In the garden where code does bloom,
Scripts added, like flowers in full plume.
Logging's new tune, a service so bright,
Instruments dance in the soft moonlight.
With each change, a hop and a cheer,
The project grows, year after year! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.