A collection of composables and utility functions distilling core parts of the Directus App. This package exposes composables and utils from the Directus App source for use in Directus extensions and other integrations within Directus App Studio. The version of this package uses semver with an additional '-app-n.n.n' to denote the version of the distilled Directus App package that it directly correlates to.
The Directus App internally uses a set of composables and utilities that power its components and various functionalities. However, these valuable resources are not exposed to the extensions ecosystem. This package digs into the source and exposes these internal composables and utilities so you can leverage the well-written Directus codebase to build your own extensions. As Directus matures, this package will be updated to reflect those changes.
Make sure you are using pnpm as your package manager:
pnpm add @emahuni/directus.distilled-app-internalsThis package exports different modules that can be imported into your project:
import { composable } from '@emahuni/directus.distilled-app-internals/composables'Effort was made to document composables using Grok 3.
import { utility } from '@emahuni/directus.distilled-app-internals/utils'Effort was made to document utils using Grok 3.
import { specificUtility } from '@emahuni/directus.distilled-app-internals/__utils__'Effort was made to document __utils__ using Grok 3.
- Removing more composables and utils that may actually be of no use in the extensions ecosystem.
- Use more aggressive terser configuration to reduce dist size.
- Certain composables and utils have been intentionally left out as they are App Studio specific and do not benefit the extension ecosystem.
- A few composables and utils could not be exposed and are still being worked on:
-
use-local-storage: This composable currently prevents the build process for unclear reasons and needs further investigation.
-
The package includes several scripts to help with building and development:
-
Build: Clean the distribution folder and build the package.
pnpm run build
-
Development Watch: Clean the distribution folder and watch for changes.
pnpm run dev
-
Sync Clone: Pulls the latest version of the Directus App from the source based on this packages version (* now broken needs fixing).
pnpm run sync-clone
The build process uses Vite and Rollup. The commands clean the dist folder using rimraf before building the bundle. Ensure you have all necessary dependencies installed via pnpm.
Contributions are welcome! Please open an issue or submit a pull request with your improvements.