From 50be919022eb2b7589d1c5e69efd42d0c3e041b3 Mon Sep 17 00:00:00 2001 From: Terje Karlsen Date: Wed, 13 Nov 2024 14:35:14 +0100 Subject: [PATCH] Oppdaterer readme --- README.md | 75 +++++++++++++++++++++++++------------------------------ 1 file changed, 34 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index f24d509..850706b 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,27 @@ # nav-dekoratoren-moduler -> NPM-pakke med hjelpefunksjoner for [NAV-dekoratøren](https://github.com/navikt/decorator-next) (header og footer på nav.no) +> NPM-pakke med hjelpefunksjoner for [Nav-dekoratøren](https://github.com/navikt/decorator-next) (header og footer på nav.no) ## Changelog ### 3.1 -- Legger til prop for egendefinert komponent for `script`-elementer fra `fetchDecoratorReact`. Skal nå støtte bruk i next.js app-router layouts, se [fetchDecoratorReact](#fetchdecoratorreact). -- Peer dependencies er ikke lengre optional (med unntak av React). + +- Legger til prop for egendefinert komponent for `script`-elementer fra `fetchDecoratorReact`. Skal nå støtte bruk i next.js app-router layouts, se [fetchDecoratorReact](#fetchdecoratorreact). +- Peer dependencies er ikke lengre optional (med unntak av React). ### 3.0 -- Server-side fetch-funksjoner henter nå ferdige HTML-fragmenter fra `/ssr`-endepunktet, istedenfor å parse hele dekoratørens HTML. -- (breaking) Alle dekoratørens ``-elementer er nå inkludert i det påkrevde fragmentet `DECORATOR_HEAD_ASSETS`. CSS, favicon, etc. -- (breaking) Fjerner `DECORATOR_STYLES`/`Styles` fra responsen for `fetchDecoratorHtml`/`fetchDecoratorReact` (erstattes av `DECORATOR_HEAD_ASSETS`). -- Den innbygde cachen av dekoratørens elementer invalideres nå automatisk når en ny versjon av dekoratøren er tilgjengelig. -- Nye funksjoner: `addDecoratorUpdateListener`, `removeDecoratorUpdateListener`, `getDecoratorVersionId`. Tiltenkt brukt for cache-invalidering i apper som cacher dekoratøren på andre måter. -- Fjerner typer for ubrukte parametre `urlLookupTable` og `enforceLogin` -- (breaking) Fjerner `` -- (breaking) Fjerner `injectDecoratorServerSideDom`. Denne erstattes av `injectDecoratorServerSideDocument`, som tar inn et standard Document DOM-objekt. -- (breaking) Fjerner `getUrlFromLookupTable` og tilhørende url-mappinger -- (breaking) Fjerner `parseDecoratorHTMLToReact` -- (breaking) Alle dependencies er nå optional peer dependencies +- Server-side fetch-funksjoner henter nå ferdige HTML-fragmenter fra `/ssr`-endepunktet, istedenfor å parse hele dekoratørens HTML. +- (breaking) Alle dekoratørens ``-elementer er nå inkludert i det påkrevde fragmentet `DECORATOR_HEAD_ASSETS`. CSS, favicon, etc. +- (breaking) Fjerner `DECORATOR_STYLES`/`Styles` fra responsen for `fetchDecoratorHtml`/`fetchDecoratorReact` (erstattes av `DECORATOR_HEAD_ASSETS`). +- Den innbygde cachen av dekoratørens elementer invalideres nå automatisk når en ny versjon av dekoratøren er tilgjengelig. +- Nye funksjoner: `addDecoratorUpdateListener`, `removeDecoratorUpdateListener`, `getDecoratorVersionId`. Tiltenkt brukt for cache-invalidering i apper som cacher dekoratøren på andre måter. +- Fjerner typer for ubrukte parametre `urlLookupTable` og `enforceLogin` +- (breaking) Fjerner `` +- (breaking) Fjerner `injectDecoratorServerSideDom`. Denne erstattes av `injectDecoratorServerSideDocument`, som tar inn et standard Document DOM-objekt. +- (breaking) Fjerner `getUrlFromLookupTable` og tilhørende url-mappinger +- (breaking) Fjerner `parseDecoratorHTMLToReact` +- (breaking) Alle dependencies er nå optional peer dependencies ### 2.0 @@ -81,10 +82,10 @@ Samtlige funksjoner for fetch av dekoratøren tar inn parametre med følgende ty ```tsx type DecoratorNaisEnv = - | "prod" // For produksjons-instans av dekoratøren - | "dev" // For stabil dev-instans - | "beta" // Beta dev-instanser er ment for internt test-bruk - | "betaTms" // Disse kan være ustabile i lengre perioder + | "prod" // For produksjons-instans av dekoratøren + | "dev" // For stabil dev-instans + | "beta" // Beta dev-instanser er ment for internt test-bruk + | "betaTms"; // Disse kan være ustabile i lengre perioder type DecoratorEnvProps = // Dersom env er satt til localhost, må du selv sette url for dekoratøren. @@ -173,7 +174,7 @@ injectDecoratorServerSideDocument({ env: "prod", document: myDocument, params: { context: "privatperson", simple: true }, -}).then((document: Document) => { +}).then((document: Document) => { const html = document.documentElement.outerHTML; res.send(html); }); @@ -193,12 +194,7 @@ const fragments = await fetchDecoratorHtml({ params: { context: "privatperson" }, }); -const { - DECORATOR_HEAD_ASSETS, - DECORATOR_HEADER, - DECORATOR_FOOTER, - DECORATOR_SCRIPTS, -} = fragments; +const { DECORATOR_HEAD_ASSETS, DECORATOR_HEADER, DECORATOR_FOOTER, DECORATOR_SCRIPTS } = fragments; // Sett inn fragmenter i app-html'en med f.eks. en template engine ``` @@ -212,6 +208,7 @@ Ved behov kan det settes en egendefinert komponent for `