@forge-cms/angular

Who needs it: an Angular/Analog app that talks to a ForgeCMS server. Boundary: browser + SSR (/server is server-rendering only; /vite is build-time only). Status: stable 1.0 candidate; the Analytics exports are experimental. Reference: docs/REFERENCE.md · start here: https://forge-cms.pages.dev/docs/angular-quickstart.

Angular client SDK for ForgeCMS.

pnpm add @forge-cms/angular

import { provideForgeCms } from '@forge-cms/angular';

export const appConfig = {
  // Defaults: same-origin '/api/v1' content, '/api/auth' auth, cookie credentials.
  providers: [provideForgeCms()]
};

Options: baseUrl, authBaseUrl, credentials ('include' | 'omit'), authToken, trustedOrigins (other origins allowed to receive cookies/Bearer — none by default) and transport (inject a fetch-like function). Identifiers are encoded per path segment, writes are never retried, and every failure is a ForgeApiError with kind, status, code and details. A /me outage puts ForgeAuthSession in 'error', not 'anonymous'. Full guide: https://forge-cms.pages.dev/docs/angular-client

Typed client without codegen (spec 076): share the content model's type and call injectForgeClient<SiteSchema>() — slugs, query fields, create/update payloads and read results are checked against the JSON the server sends (ISO date strings, depth: 1 targets or null, access-controlled fields optional, localized maps vs strings). inject(CmsApiService) stays the untyped client for dynamic code.

import type { ForgeSchema } from '@forge-cms/angular';
import type { collections } from '../server/content'; // erased: no server code is bundled
export type SiteSchema = ForgeSchema<typeof collections>;

Exports include CmsApiService, injectForgeClient, ForgeSchema and the projection types, ForgeAuthSession, forgeAuthGuard, provideForgeCms, ForgeApiError, query helpers, typed response shapes, auth role helpers, and signal-based read resources.

Signal resources (collectionResource, documentResource) abort the request they supersede (new params, reload(), idle, destroy), never let an old response overwrite the current one, never turn a cancellation into an error(), and reset value() on a new query, on idle and on every sign-in, sign-out or session expiry — so another user's data is never shown. Nothing is retried. Full contract: https://forge-cms.pages.dev/docs/angular-client#resource-contract

Compatibility

Peers: @angular/core and @angular/router ^21.0.0 || ^22.0.0, proven by strict packed-consumer builds (pnpm release:compat: Angular 21.0.0, 21.2.10, 21.2.25 and 22.2.1). Angular 19/20 are not supported.

This package is compiled as an Angular partial-Ivy library. The Angular CLI links it automatically; a Vite/Analog app must add the linker, or its production build crashes with JIT compiler unavailable:

// vite.config.ts — needs @angular/compiler-cli, @babel/core (7 for Angular 21, 8 for 22) and vite
import { angularLinker } from '@forge-cms/angular/vite';

export default defineConfig({ plugins: [angularLinker(), analog()] });