@adonisjs/inertia 1.0.0-0 → 1.0.0-2

package/build/src/version_cache.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { AssetsVersion } from './types.js';
-/**
- * VersionCache is used to cache the version of the assets.
- *
- * If the user has provided a version, it will be used.
- * Otherwise, we will compute a hash from the manifest file
- * and cache it.
- */
-export declare class VersionCache {
-    #private;
-    protected appRoot: URL;
-    protected assetsVersion?: AssetsVersion;
-    constructor(appRoot: URL, assetsVersion?: AssetsVersion);
-    /**
-     * Pre-compute the version
-     */
-    computeVersion(): Promise<this>;
-    /**
-     * Returns the current assets version
-     */
-    getVersion(): string | number;
-    /**
-     * Set the assets version
-     */
-    setVersion(version: AssetsVersion): Promise<void>;
-}

package/build/src/version_cache.js

@@ -1,68 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import crc32 from 'crc-32';
-import { readFile } from 'node:fs/promises';
-/**
- * VersionCache is used to cache the version of the assets.
- *
- * If the user has provided a version, it will be used.
- * Otherwise, we will compute a hash from the manifest file
- * and cache it.
- */
-export class VersionCache {
-    appRoot;
-    assetsVersion;
-    #cachedVersion;
-    constructor(appRoot, assetsVersion) {
-        this.appRoot = appRoot;
-        this.assetsVersion = assetsVersion;
-        this.#cachedVersion = assetsVersion;
-    }
-    /**
-     * Compute the hash of the manifest file and cache it
-     */
-    async #getManifestHash() {
-        try {
-            const manifestPath = new URL('public/assets/manifest.json', this.appRoot);
-            const manifestFile = await readFile(manifestPath, 'utf-8');
-            this.#cachedVersion = crc32.str(manifestFile);
-            return this.#cachedVersion;
-        }
-        catch {
-            /**
-             * If the manifest file does not exist, it probably means that we are in
-             * development mode
-             */
-            this.#cachedVersion = '1';
-            return this.#cachedVersion;
-        }
-    }
-    /**
-     * Pre-compute the version
-     */
-    async computeVersion() {
-        if (!this.assetsVersion)
-            await this.#getManifestHash();
-        return this;
-    }
-    /**
-     * Returns the current assets version
-     */
-    getVersion() {
-        if (!this.#cachedVersion)
-            throw new Error('Version has not been computed yet');
-        return this.#cachedVersion;
-    }
-    /**
-     * Set the assets version
-     */
-    async setVersion(version) {
-        this.#cachedVersion = version;
-    }
-}

package/build/stubs/main.d.ts

@@ -1 +0,0 @@
-export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { getDirname } from '@poppinss/utils';
-export const stubsRoot = getDirname(import.meta.url);

package/providers/inertia_provider.ts

@@ -1,66 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { HttpContext } from '@adonisjs/core/http'
-import type { ApplicationService } from '@adonisjs/core/types'
-
-import { Inertia } from '../src/inertia.js'
-import type { InertiaConfig } from '../src/types.js'
-import { VersionCache } from '../src/version_cache.js'
-import InertiaMiddleware from '../src/inertia_middleware.js'
-
-/**
- * HttpContext augmentations
- */
-declare module '@adonisjs/core/http' {
-  export interface HttpContext {
-    inertia: Inertia
-  }
-}
-
-/**
- * Inertia provider
- */
-export default class InertiaProvider {
-  constructor(protected app: ApplicationService) {}
-
-  /**
-   * Registers edge plugin when edge is installed
-   */
-  protected async registerEdgePlugin() {
-    try {
-      const edgeExports = await import('edge.js')
-      const { edgePluginInertia } = await import('../src/plugins/edge.js')
-
-      edgeExports.default.use(edgePluginInertia())
-    } catch {}
-  }
-
-  /**
-   * Register Inertia middleware, edge plugin, and add
-   * `inertia` property to the HttpContext
-   */
-  async boot() {
-    const appRoot = this.app.appRoot
-    const config = this.app.config.get<InertiaConfig>('inertia', { view: 'app' })
-
-    const versionCache = await new VersionCache(appRoot, config.assetsVersion).computeVersion()
-    this.app.container.singleton(InertiaMiddleware, () => new InertiaMiddleware(versionCache))
-
-    HttpContext.getter(
-      'inertia',
-      function inertia(this: HttpContext) {
-        return new Inertia(this, config, versionCache.getVersion())
-      },
-      false
-    )
-
-    await this.registerEdgePlugin()
-  }
-}

package/src/debug.ts

@@ -1,12 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { debuglog } from 'node:util'
-
-export default debuglog('adonisjs:inertia')

package/src/define_config.ts

@@ -1,17 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import type { InertiaConfig } from './types.js'
-
-/**
- * Define the Inertia configuration
- */
-export function defineConfig(config: InertiaConfig) {
-  return config
-}

package/src/inertia.ts

@@ -1,140 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-/// <reference types="@adonisjs/core/providers/edge_provider" />
-
-import type { HttpContext } from '@adonisjs/core/http'
-import type { InertiaConfig, MaybePromise, PageProps, AssetsVersion } from './types.js'
-
-/**
- * Main class used to interact with Inertia
- */
-export class Inertia {
-  /**
-   * The name of the Edge view that will be used to render the page.
-   */
-  #edgeRootView: string
-
-  /**
-   * Symbol used to identify lazy props
-   */
-  #kLazySymbol = Symbol('lazy')
-
-  constructor(
-    protected ctx: HttpContext,
-    protected config: InertiaConfig = {},
-    protected version: AssetsVersion
-  ) {
-    this.#edgeRootView = config.rootView || 'root'
-  }
-
-  /**
-   * Check if a value is a lazy prop
-   */
-  #isLazyProps(value: any) {
-    return typeof value === 'object' && value && this.#kLazySymbol in value
-  }
-
-  /**
-   * Pick props to resolve based on x-inertia-partial-data header
-   *
-   * If header is not present, resolve all props except lazy props
-   * If header is present, resolve only the props that are listed in the header
-   */
-  #pickPropsToResolve(component: string, props: PageProps) {
-    const partialData = this.ctx.request
-      .header('x-inertia-partial-data')
-      ?.split(',')
-      .filter(Boolean)
-
-    const partialComponent = this.ctx.request.header('x-inertia-partial-component')
-
-    let entriesToResolve = Object.entries(props)
-    if (partialData && partialComponent === component) {
-      entriesToResolve = entriesToResolve.filter(([key]) => partialData.includes(key))
-    } else {
-      entriesToResolve = entriesToResolve.filter(([key]) => !this.#isLazyProps(props[key]))
-    }
-
-    return entriesToResolve
-  }
-
-  /**
-   * Resolve the props that will be sent to the client
-   */
-  async #resolvePageProps(component: string, props: PageProps) {
-    const entriesToResolve = this.#pickPropsToResolve(component, props)
-
-    const entries = entriesToResolve.map(async ([key, value]) => {
-      if (typeof value === 'function') {
-        return [key, await value(this.ctx)]
-      }
-
-      if (this.#isLazyProps(value)) {
-        const lazyValue = (value as any)[this.#kLazySymbol]
-        return [key, await lazyValue()]
-      }
-
-      return [key, value]
-    })
-
-    return Object.fromEntries(await Promise.all(entries))
-  }
-
-  /**
-   * Build the page object that will be returned to the client
-   *
-   * See https://inertiajs.com/the-protocol#the-page-object
-   */
-  async #buildPageObject(component: string, pageProps?: PageProps) {
-    return {
-      component,
-      version: this.version,
-      props: await this.#resolvePageProps(component, { ...this.config.sharedData, ...pageProps }),
-      url: this.ctx.request.url(true),
-    }
-  }
-
-  /**
-   * Render a page using Inertia
-   */
-  async render(component: string, pageProps?: PageProps) {
-    const pageObject = await this.#buildPageObject(component, pageProps)
-    const isInertiaRequest = !!this.ctx.request.header('x-inertia')
-
-    if (!isInertiaRequest) {
-      return this.ctx.view.render(this.#edgeRootView, { page: pageObject })
-    }
-
-    return pageObject
-  }
-
-  /**
-   * Create a lazy prop
-   *
-   * Lazy props are never resolved on first visit, but only when the client
-   * request a partial reload explicitely with this value.
-   *
-   * See https://inertiajs.com/partial-reloads#lazy-data-evaluation
-   */
-  lazy(callback: () => MaybePromise<any>) {
-    return { [this.#kLazySymbol]: callback }
-  }
-
-  /**
-   * This method can be used to redirect the user to an external website
-   * or even a non-inertia route of your application.
-   *
-   * See https://inertiajs.com/redirects#external-redirects
-   */
-  async location(url: string) {
-    this.ctx.response.header('X-Inertia-Location', url)
-    this.ctx.response.status(409)
-  }
-}

package/src/inertia_middleware.ts

@@ -1,54 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import type { HttpContext } from '@adonisjs/core/http'
-import type { NextFn } from '@adonisjs/core/types/http'
-
-import type { VersionCache } from './version_cache.js'
-
-/**
- * Inertia middleware to handle the Inertia requests and
- * set appropriate headers/status
- */
-export default class InertiaMiddleware {
-  constructor(protected version: VersionCache) {}
-
-  async handle({ request, response }: HttpContext, next: NextFn) {
-    await next()
-
-    const isInertiaRequest = !!request.header('x-inertia')
-    if (!isInertiaRequest) return
-
-    response.header('Vary', 'Accept')
-    response.header('X-Inertia', 'true')
-
-    /**
-     * When redirecting a PUT/PATCH/DELETE request, we need to change the
-     * we must use a 303 status code instead of a 302 to force
-     * the browser to use a GET request after redirecting.
-     *
-     * See https://inertiajs.com/redirects
-     */
-    const method = request.method()
-    if (response.getStatus() === 302 && ['PUT', 'PATCH', 'DELETE'].includes(method)) {
-      response.status(303)
-    }
-
-    /**
-     * Handle version change
-     *
-     * See https://inertiajs.com/the-protocol#asset-versioning
-     */
-    const version = this.version.getVersion()
-    if (method === 'GET' && request.header('x-inertia-version', '') !== version) {
-      response.header('x-inertia-location', request.url())
-      response.status(409)
-    }
-  }
-}

package/src/plugins/api_client.ts

@@ -1,127 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import type { PluginFn } from '@japa/runner/types'
-import { ApiRequest, ApiResponse } from '@japa/api-client'
-
-import type { PageProps } from '../types.js'
-
-declare module '@japa/api-client' {
-  export interface ApiRequest {
-    /**
-     * Set `X-Inertia` header on the request
-     */
-    withInertia(): this
-
-    /**
-     * Set `X-Inertia-Partial-Data` and `X-Inertia-Partial-Component` headers on the request
-     */
-    withInertiaPartialReload(component: string, data: string[]): this
-  }
-
-  export interface ApiResponse {
-    /**
-     * The inertia component
-     */
-    inertiaComponent?: string
-
-    /**
-     * The inertia response props
-     */
-    inertiaProps: PageProps
-
-    /**
-     * Assert component name of inertia response
-     */
-    assertInertiaComponent(component: string): this
-
-    /**
-     * Assert props to be exactly the same as the given props
-     */
-    assertInertiaProps(props: PageProps): this
-
-    /**
-     * Assert inertia props contains a subset of the given props
-     */
-    assertInertiaPropsContains(props: PageProps): this
-  }
-}
-
-/**
- * Ensure the response is an inertia response, otherwise throw an error
- */
-function ensureIsInertiaResponse(this: ApiResponse) {
-  if (!this.header('x-inertia')) {
-    throw new Error(
-      'Response is not an Inertia response. Make sure to call `withInertia()` on the request'
-    )
-  }
-}
-
-export function inertiaApiClient(): PluginFn {
-  return () => {
-    ApiRequest.macro('withInertia', function (this: ApiRequest) {
-      this.header('x-inertia', 'true')
-      return this
-    })
-
-    ApiRequest.macro(
-      'withInertiaPartialReload',
-      function (this: ApiRequest, component: string, data: string[]) {
-        this.withInertia()
-        this.header('X-Inertia-Partial-Data', data.join(','))
-        this.header('X-Inertia-Partial-Component', component)
-        return this
-      }
-    )
-
-    /**
-     * Response getters
-     */
-    ApiResponse.getter('inertiaComponent', function (this: ApiResponse) {
-      ensureIsInertiaResponse.call(this)
-      return this.body().component
-    })
-
-    ApiResponse.getter('inertiaProps', function (this: ApiResponse) {
-      ensureIsInertiaResponse.call(this)
-      return this.body().props
-    })
-
-    /**
-     * Response assertions
-     */
-    ApiResponse.macro('assertInertiaComponent', function (this: ApiResponse, component: string) {
-      ensureIsInertiaResponse.call(this)
-
-      this.assert!.deepEqual(this.body().component, component)
-      return this
-    })
-
-    ApiResponse.macro(
-      'assertInertiaProps',
-      function (this: ApiResponse, props: Record<string, unknown>) {
-        this.ensureHasAssert()
-        ensureIsInertiaResponse.call(this)
-        this.assert!.deepEqual(this.body().props, props)
-        return this
-      }
-    )
-
-    ApiResponse.macro(
-      'assertInertiaPropsContains',
-      function (this: ApiResponse, props: Record<string, unknown>) {
-        this.ensureHasAssert()
-        ensureIsInertiaResponse.call(this)
-        this.assert!.containsSubset(this.body().props, props)
-        return this
-      }
-    )
-  }
-}

package/src/plugins/edge.ts

@@ -1,50 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { encode } from 'html-entities'
-import type { PluginFn } from 'edge.js/types'
-
-import debug from '../debug.js'
-
-/**
- * Register the Inertia tags and globals within Edge
- */
-export const edgePluginInertia: () => PluginFn<undefined> = () => {
-  return (edge) => {
-    debug('sharing globals and inertia tags with edge')
-
-    edge.global('inertia', (page: Record<string, unknown> = {}) => {
-      if (page.ssrBody) return page.ssrBody
-      return `<div id="app" data-page="${encode(JSON.stringify(page))}"></div>`
-    })
-
-    edge.global('inertiaHead', (page: Record<string, unknown>) => {
-      const { ssrHead = [] }: { ssrHead?: string[] } = page || {}
-      return ssrHead.join('\n')
-    })
-
-    edge.registerTag({
-      block: false,
-      tagName: 'inertia',
-      seekable: false,
-      compile(_, buffer, { filename, loc }) {
-        buffer.writeExpression(`out += state.inertia(state.page)`, filename, loc.start.line)
-      },
-    })
-
-    edge.registerTag({
-      block: false,
-      tagName: 'inertiaHead',
-      seekable: false,
-      compile(_, buffer, { filename, loc }) {
-        buffer.writeExpression(`out += state.inertiaHead(state.page)`, filename, loc.start.line)
-      },
-    })
-  }
-}

package/src/types.ts

@@ -1,48 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import type { HttpContext } from '@adonisjs/core/http'
-
-export type MaybePromise<T> = T | Promise<T>
-
-/**
- * Props that will be passed to inertia render method
- */
-export type PageProps = Record<string, unknown>
-
-/**
- * Shared data types
- */
-export type Data = string | number | object | boolean
-export type SharedDatumFactory = (ctx: HttpContext) => MaybePromise<Data>
-export type SharedData = Record<string, Data | SharedDatumFactory>
-
-/**
- * Allowed values for the assets version
- */
-export type AssetsVersion = string | number | undefined
-
-export interface InertiaConfig {
-  /**
-   * Path to the Edge view that will be used as the root view for Inertia responses.
-   * @default root (resources/views/root.edge)
-   */
-  rootView?: string
-
-  /**
-   * The version of your assets. Every client request will be checked against this version.
-   * If the version is not the same, the client will do a full reload.
-   */
-  assetsVersion?: AssetsVersion
-
-  /**
-   * Data that should be shared with all rendered pages
-   */
-  sharedData?: SharedData
-}

package/src/version_cache.ts

@@ -1,74 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import crc32 from 'crc-32'
-import { readFile } from 'node:fs/promises'
-
-import type { AssetsVersion } from './types.js'
-
-/**
- * VersionCache is used to cache the version of the assets.
- *
- * If the user has provided a version, it will be used.
- * Otherwise, we will compute a hash from the manifest file
- * and cache it.
- */
-export class VersionCache {
-  #cachedVersion?: AssetsVersion
-
-  constructor(
-    protected appRoot: URL,
-    protected assetsVersion?: AssetsVersion
-  ) {
-    this.#cachedVersion = assetsVersion
-  }
-
-  /**
-   * Compute the hash of the manifest file and cache it
-   */
-  async #getManifestHash(): Promise<AssetsVersion> {
-    try {
-      const manifestPath = new URL('public/assets/manifest.json', this.appRoot)
-      const manifestFile = await readFile(manifestPath, 'utf-8')
-      this.#cachedVersion = crc32.str(manifestFile)
-
-      return this.#cachedVersion
-    } catch {
-      /**
-       * If the manifest file does not exist, it probably means that we are in
-       * development mode
-       */
-      this.#cachedVersion = '1'
-      return this.#cachedVersion
-    }
-  }
-
-  /**
-   * Pre-compute the version
-   */
-  async computeVersion() {
-    if (!this.assetsVersion) await this.#getManifestHash()
-    return this
-  }
-
-  /**
-   * Returns the current assets version
-   */
-  getVersion() {
-    if (!this.#cachedVersion) throw new Error('Version has not been computed yet')
-    return this.#cachedVersion
-  }
-
-  /**
-   * Set the assets version
-   */
-  async setVersion(version: AssetsVersion) {
-    this.#cachedVersion = version
-  }
-}