v2.4.0-beta

Changelog

🎉 Features

• Inline equations!
• ATBD Version lock endpoint, backed by permissions model handling!

🚀 Improvements

• Convert plain_summary and abstract to rich-text type fields
• PDF improvements (ref):
  • Remove date from PDF for non-published ATBDs, display published_at date for published ATBDS
  • Add page break after table of contents
  • Add custom headings (centered and light gray) for both journal and regular PDFs
• Return HTML content with parsed error + full error in dropdown when PDF generation fails
• Update email template (ref)
• Update test user emails in fixture data (loaded when running an instance of the API locally)
• Update cognito user sub regex in data migration upload script to ignore image filenames that have a UUID
• Update deployment script to use new permission boundary (mcp-tenantOperator-APIG)

🐛 Fixes

• Add publication_checklist as parameter when creating a new major version to ensure publication checklist from parent version gets passed to new version
• Ensure whitespaces in hyperref text are respected
• Remove uvicorn requirement to resolve version incompatibility between click and black + pin black code formatter to v22.3.0
• Add file permissions to LaTeX class file when building docker image
• Raise error when ATBD alias is updated (thanks @oliverroick)
• Handle abstract as option in PDF generation

v2.2.3-beta

Changelog

🎉 Features

• GCC deployed!
• Add migration scripts: download.py and upload.py (run python3 [download.py|upload.py] --help from the command line for details on how to use the scripts)

🚀 Improvements

• Add mcp-TennantOperatorBoundary permissions boundary to enable programmatic deployments into the GCC environment
• Add private subnet to the stack's VPC for GCC deployment
  • Note: in non-GCC (ie: non-production) stacks the RDS instance will be placed in the public subnet, with access granted only to the Lambda function's security group. This means that each person who wishes to access the RDS instance should add their WIFI network to the RDS instance's security group ingress rules. In GCC, access to the RDS can only be gained by SSH'ing into an EC2 instance placed within the same VPC (ie: a jumpbox instance).
  • Note: when creating a VPC with just public subnets (like it was in the previous deployment) the VPC's CIDR gets split up between the subnets (one per Availability Zone). Since all IP addresses are allocated, it's not possible to add a private subnet to the VPC. It's also not possible to reduce the CIDR range of an existing subnet, so the VPC (and therefore the whole stack) must be re-deployed.
• Deploy the Lambda function into the VPC to have a security group that can be granted access to the RDS instance
• Add a NAT Gateway to the VPC's public subnet to enable the Lambda function to access the internet/other AWS resources.
• Add SNAPSHOT removal policy to RDS instance (for all stages)
• Add DESTROY removal policy to S3 bucket and ElasticSearch domain for non-prod deployments (to avoid littering AWS environments with unused resources when tearing down and re-building stacks)
• Enable case IN-sensitivity for cognito user pool email attribute (Note: this requires re-deploying the stack)
• Add open source license (Thanks @code-geek!)
• Enable custom domain name for RDS instance for easier resource identification

🐛 Fixes

• Remove unnecessary IAM role granting the Lambda function access to the cloudwatch logs, which was creating a separate, empty lambda function. Lambda functions have access to cloudwatch logs by default.

v2.1.3-beta

v2.1.3-beta

🎉 Features:

• 🦗

🚀 Improvements:

• Enable greek character support in text

🐛 Bugfixes:

• 🦗

v2.1.2-beta

Changelog:

Features 🚀 :

• 🦗

Improvements 🎉 :

• 🦗

Bugfixes 🐛 :

• Skip filtering on empty data access url lists to maintain backward compatibility with published data

v2.1.1-beta

Changelog

🎉 Features

• 🦗

🚀 Improvements

(All of the following improvements have been applied to the Journal PDF)

• Move corresponding author from title page footnote to after affiliations
• List authors with only first initial
• Rename "Data availability" section to "Open Research" and move to before "Discussion"
• Start section numbering at "Introduction"
• Remove "Contacts" section
• Make subsections and sub-subsection non-bold
• Add equation numbering by switching from the math environment to the equation environment
• Add fields to references: report_number, doi, online_resource, other_reference_details, series (series gets changed to journal since series isn't a field used in the @article citation type of apacite)
• Add nolinkurl to hyperref text to ensure that hyperref will wrap long hyperlinks according to the same url wrapping/breaking logic from the url package (ie: break on all symbols like ?,#,&,-,/ as opposed to plain text wrapping, which only breaks on whitespace and hyphens

🐛 Fixes

• Split tables longer than a full page over multiple page

v2.1.0-beta

Changelog

🎉 Features

• Adds application level roles: curator and contributor
• Adds document level roles: owner , authors, reviewers
• Obfuscates user information depending on role of requesting user (eg: author-type user cannot see username and email of reviewer-type user)
• Adds application-level user management functionalities (eg: add user X to ATBD Y as a reviewer)
• Restricts these functionalities to curator type user
• Adds /events endpoint for document state management (eg: request review --> deny review)
• Adds email notification for relevant users when transitioning state
• Adds Comments and Comment Thread functionalities
• Add changelog support
• Adds Publication Units calculation
• Adds GCMD keyword API integration

🚀 Improvements

• Adds filtering for LIST /atbds by user role within the ATBD (eg: "show me all the ATBD where I am a contributor, but not an author")
• Implements agujournal.cls Latex class for improved formatting of Journal PDFs
• Adds Abstract, Plain Language Summary, Keypoints and Keywords to journal PDF
• Adds HTML error response to PDF generation failure

🐛 Fixes

• Fixes ElasticSearch failing to index plain text timestamps

v2.0.0-beta3

Changelog:

🎉 Features

• Add ability to create, update, delete and resolve threads!
• Add ability to create, update, delete comments within threads!
• Add email notifications!

🚀 Improvements

• Implement Bearer token parsing using the fastapi-cloudauth library for native handling of the token parsing and better integration with the FastAPI docs page
• Add a get_token endpoint that allows users to retrieve an ID token directly from the API
• Add user info to created_by and last_updated_by fields of comments, threads, atbds, atbd_versions
• Implement apa style references in PDF document (as specified by the AGU Latex guidelines)
• Update document sections and contact roles
• Add default NO_JOURNAL value for the journal_status field
• Block Atbd Alias update when at least one version has been published

🐛 Fixes

• DataAccessUrls now accepts empty strings as value for either url or description
• Fix bugs with missing user info in /events API endpoint response

v2.0.0-beta2

Changelog:

v2.0.0-beta2 (hotfix):

🎉 Features:

• 🦗

🚀 Improvements:

• Merges the Lambda Docker image and the Local Docker image into a single docker image with different ENTRYPOINT/CMD directives, in order to avoid problems with Latex packages installing differently locally and in the lambda image, since the lambda image used to be centOS based.
• Some improvements to table generation, including table content wrapping, and setting the pandas.max_colwidth property to None to ensure that Pandas doesn't truncate cell content, when generating a latex table from a DataFrame

🐛 Bugfixes:

• Escapes special chars (including the U0A00 , which translates to \nobreakspace in Latex)
• Fixes a typo in journal_discussion

Version 2.0.0-beta1

Deploys all changes made in API V2 up to date:

• Migrate from Postgrest to FastAPI
• Refactor PDF generation
• Migrate from pure cloudformation to CDK
• Migrate from ECS images to Lambda + API Gateway

v1.0.0

Changelog

🎉 Features

• Add Elastic Search
• Add support for Launchpad authentication
• Add support for journal PDF generation
• Add caption support for tables

🚀 Improvements

• Improve PDF generation
• Cloudformation improvements

🐛 Fixes

• General code fixes