Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enonic/lib-static
Library for serving static assets through XP, optimized for client caching
https://github.com/enonic/lib-static
Last synced: 18 days ago
JSON representation
Library for serving static assets through XP, optimized for client caching
- Host: GitHub
- URL: https://github.com/enonic/lib-static
- Owner: enonic
- License: apache-2.0
- Created: 2021-02-03T13:57:19.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T06:05:05.000Z (22 days ago)
- Last Synced: 2024-10-17T17:26:53.226Z (21 days ago)
- Language: TypeScript
- Size: 11.8 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lib-static
### Full docs:
👉 [Lib-static usage guide](docs/index.adoc) with [API](docs/index.adoc#api) and [examples](docs/index.adoc#examples) 👈
[Enonic XP](https://enonic.com/developer-tour) library for serving assets from a folder in the application resource structure. Intended for setting up XP endpoints that serve static resources from an XP app's JAR file, in a cache-optimized way. So basically the same thing as `assetUrl`, but with more features and control:
- **Caching behaviour:** With `assetUrl`, you get a URL where the current installation/version of the app is baked in as a hash. It will change whenever the app is updated, forcing browsers to skip their locally cached resources and request new ones, even if the resource wasn't changed during the update. Using lib-static with [immutable assets](docs/index.adoc#mutable-assets) retains stable URLs and has several ways to adapt the header to direct browsers' caching behavior more effectively, even for mutable assets.
- **Endpoint URLs:** make your resource endpoints anywhere,
- **Response headers**: override and control the MIME-type resolution, or the Cache-Control headers more specifically
- **Control resource folders:** As long as the resources are built into the app JAR, resources can be served from anywhere - even with multiple lib-static instances at once: serve from multiple specific-purpose folders, or use multi-instances to specify multiple rules from the same folder.
- Security issues around this are handled in the standard usage: a set root folder is required (and not at the JAR root), and URL navigation out from it is prevented. But if you still REALLY want to circumvent this, there is a lower-level API too.
- **Error handling:** 500-type errors can be set to throw instead of returning an error response - leaving the handling to you.
- **Index fallback:** A URL that refers to the name of a directory that contains a fallback file `index.html`, will fetch the fallback file (if no fallback file is found: regular 404 response).
### Install
Insert into `build.gradle` of your XP project, under `dependencies`, where `` is the latest/requested version of this library - for example `1.0.0`:
```groovy
dependencies {
include 'com.enonic.lib:lib-static:'
}
repositories {
maven {
url 'http://repo.enonic.com/public'
}
}
```
### Import
In any [XP controller](https://developer.enonic.com/docs/xp/stable/framework/controllers), import the library:
```javascript
const libStatic = require('/lib/enonic/static');
```
👉 [Lib-static usage guide](docs/index.adoc) with [API](docs/index.adoc#api) and [examples](docs/index.adoc#examples) 👈
More relevant sources: [web.dev](https://web.dev/http-cache/), [facebook](https://engineering.fb.com/2017/01/26/web/this-browser-tweak-saved-60-of-requests-to-facebook/), [mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching), [imagekit](https://imagekit.io/blog/ultimate-guide-to-http-caching-for-static-assets/), [freecontent.manning.com](https://freecontent.manning.com/caching-assets/).
TODO