Outerfaces.RevPath (Outerfaces Dependency Distribution (ODD) v0.2.5)

View Source

Canonical URL path builder for rev-pinned assets.

This module provides a single source of truth for building rev-pinned asset URLs. All asset/module URLs should use this format to ensure consistency across the system.

Canonical Format

All rev-pinned URLs follow this structure:

<origin>/__rev/<rev>/<namespace>/<path>

Where:

  • origin - CDN origin (empty string for unified mode, full URL for direct mode)
  • rev - Git SHA or revision identifier
  • namespace - Asset namespace: "spa", "cdn", "apps", etc.
  • path - Asset path relative to namespace

Examples 

# Unified proxy mode (origin = ""):
asset("", "abc123", "cdn", "lib/foo.js")
#=> "/__rev/abc123/cdn/lib/foo.js"

# Direct CDN mode (origin = "http://localhost:60032"):
asset("http://localhost:60032", "abc123", "cdn", "lib/foo.js")
#=> "http://localhost:60032/__rev/abc123/cdn/lib/foo.js"

# SPA assets (always relative):
asset("", "abc123", "spa", "main.js")
#=> "/__rev/abc123/spa/main.js"

Summary

Functions

asset(origin, rev, namespace, path)

Builds a canonical rev-pinned asset URL.

cdn_asset(origin, rev, path)

Builds a canonical rev-pinned CDN asset URL.

spa_asset(rev, path)

Builds a canonical rev-pinned SPA asset URL.

Functions

asset(origin, rev, namespace, path)

@spec asset(String.t(), String.t(), String.t(), String.t()) :: String.t()

Builds a canonical rev-pinned asset URL.

Parameters

  • origin - CDN origin (empty string for same-origin, full URL for cross-origin)
  • rev - Revision identifier (git SHA, etc.)
  • namespace - Asset namespace ("spa", "cdn", "apps", etc.)
  • path - Asset path (should NOT start with "/")

Returns

Canonical rev-pinned URL string

Examples 

iex> Outerfaces.RevPath.asset("", "abc123", "cdn", "lib/foo.js")
"/__rev/abc123/cdn/lib/foo.js"

iex> Outerfaces.RevPath.asset("http://localhost:60032", "abc123", "cdn", "lib/foo.js")
"http://localhost:60032/__rev/abc123/cdn/lib/foo.js"

cdn_asset(origin, rev, path)

@spec cdn_asset(String.t(), String.t(), String.t()) :: String.t()

Builds a canonical rev-pinned CDN asset URL.

Convenience wrapper for asset/4 with namespace="cdn".

Examples 

iex> Outerfaces.RevPath.cdn_asset("", "abc123", "lib/foo.js")
"/__rev/abc123/cdn/lib/foo.js"

spa_asset(rev, path)

@spec spa_asset(String.t(), String.t()) :: String.t()

Builds a canonical rev-pinned SPA asset URL.

Convenience wrapper for asset/4 with namespace="spa". SPA assets are always same-origin (origin is ignored).

Examples 

iex> Outerfaces.RevPath.spa_asset("abc123", "main.js")
"/__rev/abc123/spa/main.js"