Detalhes do pacote

@globus/static-data-portal

globus986Apache-2.03.0.0

🧪 BETA 🧪

readme (leia-me)

static-data-portal

🧪 BETA 🧪

This is a Globus-powered research data portal generator created using Next.js.

⚠️ IMPORTANT ⚠️ You only need to interact with this repository if you are improving the generator or using this code to start a self-managed project. If you want to deploy a data portal, copy our template-data-portal and modify the static.json file to suit your needs.

This is a Next.js project bootstrapped with create-next-app.

Developer Documentation

static.json

  • The static.json file is the main configuration file for the data portal.
  • The utils/static.ts file is used to enforce a TypeScript type on this file.
  • All pages and components that source information from the user-provided static.json should use utils/static.ts and its available helpers.
  • Typedoc is configured to generate documentation from utils/static.ts.

The included static.json in this repository is configured toward local development, using a non-production Globus environment (sandbox).

MDX Support

MDX support has been added to the project.

For simple pages, e.g. "Terms and Conditions" and "Privacy Policy" .mdx is used to simplify these files being overwritten by end consumers using a overrides or content directory.

content Directory

An end-user provided content directory can be defined to provide Markdown (or MDX) files that will be added as pages in the Next.js project. This allows for the end-user to provide custom pages without modifying the core project (via overrides). This also allows us to provide backwards compatibility should we decide to move away from Next.js in the future.

changelog (log de mudanças)

Changelog

3.0.0 (2025-04-03)

⚠ BREAKING CHANGES

  • Upgrades core dependencies (Next.js + React) (#451)

Features

  • Adds improved Collection Browser for selecting a destination. (#458) (3cc4ecb)
  • Upgrades core dependencies (Next.js + React) (#451) (6a5dd9b)

2.1.0 (2024-11-15)

Features

  • Adds "Clear Selected" button to the source file browser. (79058b6)
  • Adds "Search All Collections" toggle in the search panel. (79058b6)
  • Updates Destination search to hide collections the user does not have Transfer-related permissions on (by default) (#370) (79058b6)

Fixes

  • Address issue causing the default header image not rendering on deep pages when portal was published. (#369) (ac3b7d2)

2.0.0 (2024-10-29)

⚠ BREAKING CHANGES

  • Use in-memory based storage for authorization tokens, by default. (#347)

Features

  • Use in-memory based storage for authorization tokens, by default. (#347) (c6ac0f8)

1.12.0 (2024-10-25)

Features

  • Adds button to open files in a new tab when collections support HTTPS. (#337) (d6cc729)

Fixes

  • use zustand for state management and resolve various state issues in the File Browser (#335) (6b221e5)

1.11.0 (2024-10-09)

Features

  • Theming: Use "primary" and "secondary" color palettes for theming instead of "brand". (#319) (2a9c5f6)

Fixes

  • Addresses an issue preventing Transfers being initiated to the "server default" path on a destination collection. (#312) (e72ff70)

1.10.2 (2024-10-02)

Fixes

  • Addresses issue preventing HTTPS download button appearing on file entries. (#295) (27effc7)

1.10.1 (2024-09-19)

Fixes

  • Addresses issue causing new folders being prefixed with "undefined", updates file listing to be sorted by "Name" (#278) (1e1431c)

1.10.0 (2024-09-18)

Features

Fixes

  • ensure AuthorizationManager methods are awaited (#263) (1306141)

1.9.0 (2024-08-26)

Features

  • Updates the "Path" field to be editable for easy directory navigation. (#242) (a3a2d03)

Fixes

  • Address scenarios where post-consent an existing (refreshed) token would be used instead of the result of the token response. (a3a2d03)
  • Search: Ensures GCSv5 Endpoints ("nonfunctional" endpoints that do not support transfer) are not displayed in destination collection search results. (#231) (1702e62)

1.8.0 (2024-08-19)

Features

  • adds support for "content" directory (#159) (8a21371)
  • Globus Transfer interactions have been moved to the /transfer route. This allows for custom homepages on / using a index.(mdx/tsx) file. (#204) (c282f81)
  • Improves network request performance and loading states by implementing a cache layer. (#194) (070ab91)
  • support content/assets/ => public/ (2e5945d)
  • upgrade to @globus/sdk 3.8.0 and use new Transfer utility methods (#199) (989cc44)

Fixes

  • content file overrides for well-known pages (e.g. index.*, privacy-policy.*), no longer need to match the generator's extension (#224) (e3754a9)
  • Adds external link icon to external links in the main navigation and reorders custom links. (34b6915)
  • Adds loading states to "Refresh" and "Start Transfer" buttons. (070ab91)
  • adds predev script (runs prebuild) (d027fe4)
  • adds useLayout hook and improves rendering of pages by sharing a Container (#207) (68bccd8)
  • Ensure full hosted base path is used in various image rendering contexts. (#218) (03a3c43)
  • Ensure relative links in Markdown use Next.js Link component for rendering. (#206) (34b6915)
  • ensure relative paths can be used for images in Markdown (#217) (92ebdf3)
  • ensure the /authorization route refreshes tokens (when returning from an authorization_requirements prompt) (#195) (b042a81)
  • Improves base Markdown rendering for various elements (#216) (b3e1f30)
  • improves the loading states of file browsers (#205) (fe58559)
  • Only render "Size" values for files in file browsers. (a89c2d0)
  • Throttles the <CollectionSearch> requests. (070ab91)

1.7.1 (2024-07-11)

Fixes

  • improve header rendering on smaller devices (#154) (3de3e29)

1.7.0 (2024-07-10)

Features

  • Persist collection (destination) selection state in session storage (#128) (d6a0d12)

Fixes

  • build error encountered due to image configurations (bbf2cfc)

1.5.0 (2024-07-10)

Features

Fixes

  • Adds Globus logo to "Powered by Globus" footer. (d74bf52)

1.4.0 (2024-06-18)

Features

  • Adds support for mkdir and rename in destination browser. (#58) (a1e93a4)

1.3.0 (2024-05-01)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.2.3...1.3.0

1.2.3 (2024-04-24)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.2.2...1.2.3

1.2.2 (2024-04-15)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.2.1...1.2.2

1.2.1 (2024-04-15)

Full Changelog: https://github.com/globus/static-data-portal/compare/1.2.0...1.2.1

1.2.0 (2024-04-15)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.1.0...1.2.0

1.1.0 (2024-03-25)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.0.5...1.1.0

1.0.5 (2024-03-25)

What's Changed

Full Changelog: https://github.com/globus/static-data-portal/compare/1.0.4...1.0.5

1.0.4 (2024-03-25)

What's Changed

New Contributors

Full Changelog: https://github.com/globus/static-data-portal/commits/static-data-portal-1.0.4