Add doc annotation

astro/src/components/api/AvailableSince.astro

@@ -3,9 +3,34 @@ interface Props {
   since: string
 }
 
-const { since }: Props = Astro.props;
+const { since, showSince }: Props = Astro.props;
+
 if (!since) {
   throw new Error("No since field");
 }
+
+const semverToPaddedNumber = function (semver) {
+  const [major, minor, patch] = semver.split('.').map(Number);
+
+  if (isNaN(major) || isNaN(minor) || isNaN(patch)) {
+    throw new Error("Invalid semver format");
+  }
+
+  return `${major}${String(minor).padStart(3, '0')}${String(patch).padStart(2, '0')}`;
+};
+
+// showSince is a 6 digit number
+// the first one is the major version
+// the next three are the minor version
+// the last two are the patch version
+// it is used to only show availableSince on feature doc that were created before this field was added.
+// If the field was added before the feature was added, availableSince makes no sense.
+
+// For example, the user.login.suspicious event was added in 1.30.0 and returns an authentication type. But some of those authentication types (Apple) were added before this event was added.
+// in this case, we'd provide showSince of 1.30.0 and only authentication types added after 1.30.0 would show the available since value
+
+const alwaysShow = showSince === undefined;
+const show = alwaysShow || (semverToPaddedNumber(since) > semverToPaddedNumber(showSince));
+
 ---
-<span class='text-green-500 text-sm italic'>Available since {since}</span>
+<span class='text-green-500 text-sm italic'>{show ? 'Available since ' + since : ''</span>

astro/src/content/docs/_shared/_access-token-claims.mdx

@@ -1,6 +1,6 @@
 import APIBlock from 'src/components/api/APIBlock.astro';
 import APIField from 'src/components/api/APIField.astro';
-import AuthenticationTypeClaimValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import InlineField from 'src/components/InlineField.astro';
 import RemovedSince from 'src/components/api/RemovedSince.astro';
 
@@ -20,7 +20,7 @@ import RemovedSince from 'src/components/api/RemovedSince.astro';
   <APIField name="authenticationType" type="String">
     The method used to authenticate the User which resulted in this JWT being generated. The possible values are:
 
-    <AuthenticationTypeClaimValues show_since="100000" />
+    <AuthenticationTypeValues />
   </APIField>
   <APIField name="auth_time" type="Long" since="1.36.0">
     The time of the initial authentication request, expressed as UNIX time which is the number of seconds since Epoch. This claim will remain the same even when the token has been re-issued through the use of a Refresh Token.

astro/src/content/docs/_shared/_hosted-backend-response-cookies.mdx

@@ -3,7 +3,7 @@ import APIField from 'src/components/api/APIField.astro';
 
 <APIBlock>
   <APIField name="app.at" type="String">
-    The encoded access token. This cookie is written in the response as a `Secure` `HttpOnly` session cookie.
+    The encoded access token. This cookie is written in the response as a `Secure` `HttpOnly` persistent cookie.
   </APIField>
   <APIField name="app.rt" type="String">
     The refresh token. This cookie is written in the response as a `Secure` `HttpOnly` persistent cookie. The cookie expiration is configured in the JWT

astro/src/content/docs/_shared/authentication-type-values.astro

@@ -0,0 +1,15 @@
+---
+import AvailableSince from 'src/components/api/AvailableSince.astro';
+import AuthenticationTypes from 'src/content/json/generated/authenticationtype.json';
+import { parseInline } from 'marked';
+
+const { showSince } = Astro.props;
+---
+
+<ul>
+{AuthenticationTypes.map((type) =>
+  <li>
+      <code>{type.name}</code> - <span set:html={parseInline(type.description)}/> {type.since ? <AvailableSince showSince={showSince} since={type.since} /> : "" }
+  </li>
+)}
+</ul>

astro/src/content/docs/apis/_user-search-request-parameters.mdx

@@ -143,7 +143,7 @@ import SearchPreprocessingWarning from "src/content/docs/_shared/_search-preproc
       </p>
 
       <p>
-      You may search against specific fields like so: <code>email:*fusionauth.io</code>. This will match only users with a <code>fusionauth.io</code> email address. You may find the available fields for matching by retrieving the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/6.3/indices-get-mapping.html">Elasticsearch mapping</a>.
+      You may search against specific fields like so: <code>email:*fusionauth.io</code>. This will match only users with a <code>fusionauth.io</code> email address. Here are <a href='/docs/reference/user-fields'>the available fields for matching</a>.
       </p>
 
       <SearchPreprocessingWarning/>

astro/src/content/docs/apis/entities/_entity-search-request-parameters.mdx

@@ -77,7 +77,7 @@ import SearchPreprocessingWarning from "src/content/docs/_shared/_search-preproc
 
     The match is case-insensitive. Whitespace is allowed in the search, but must be URL escaped; for example, using `%20` for a space character. Elasticsearch compatible regular expressions may be used, so you may search by prefix or suffix using the `*` wildcard.
 
-    You may search against specific fields like so: `name:*API`. This will match only entities with a name ending in a `API`. You may find the available fields for matching by retrieving the [Elasticsearch mapping](https://www.elastic.co/guide/en/elasticsearch/reference/6.3/indices-get-mapping.html).
+    You may search against specific fields like so: `name:*API`. This will match only entities with a name ending in a `API`. Here are [the available fields for matching](/docs/reference/user-fields).
 
     <SearchPreprocessingWarning/>
   </APIField>

astro/src/content/docs/extend/code/lambdas/login-validation.mdx

@@ -6,7 +6,7 @@ section: extend
 subcategory: code
 tertcategory: lambdas
 ---
-import AuthenticationTypeValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import Breadcrumb from 'src/components/Breadcrumb.astro';
 import InlineField from 'src/components/InlineField.astro';
 
@@ -48,7 +48,7 @@ The `result` object contains an [Errors](/docs/apis/errors) object. The `user` a
 
 `authenticationtype` is the method used to authenticate the user. The possible values are:
 
-<AuthenticationTypeValues show_since="105300" />
+<AuthenticationTypeValues showSince="1.53.0" />
 
 The `identityProvider` object in the `context` will only be present when the login request is from a 3rd party Identity Provider.
 

astro/src/content/docs/extend/events-and-webhooks/events/user-login-failed.mdx

@@ -6,7 +6,7 @@ subcategory: events and webhooks
 tertcategory: events
 ---
 import APIField from 'src/components/api/APIField.astro';
-import AuthenticationTypeValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import Event from 'src/content/docs/extend/events-and-webhooks/events/_event.astro';
 import EventBody from 'src/content/docs/extend/events-and-webhooks/events/_event-body.astro';
 import InlineField from 'src/components/InlineField.astro';
@@ -33,7 +33,7 @@ export const eventType = 'user.login.failed';
   <APIField slot="leading-fields" name="event.authenticationType" type="String">
     The type of authentication used in the login request. The possible values are:
 
-    <AuthenticationTypeValues show_since="100600" />
+    <AuthenticationTypeValues showSince="1.6.0" />
   </APIField>
 
   <APIField slot="leading-fields" name="event.createInstant" type="Long">
@@ -78,7 +78,7 @@ export const eventType = 'user.login.failed';
   </APIField>
 
   <APIField slot="trailing-fields" name="event.type" type="String">
-    The event type, this value will always be <code>{eventType}</code>.
+    The event type, this value will always be <code>{eventType}</code>.{/* eslint-disable-line */}
   </APIField>
 
   <APIField slot="trailing-fields" name="event.user" type="Object">

astro/src/content/docs/extend/events-and-webhooks/events/user-login-new-device.mdx

@@ -6,7 +6,7 @@ subcategory: events and webhooks
 tertcategory: events
 ---
 import APIField from 'src/components/api/APIField.astro';
-import AuthenticationTypeValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import Event from 'src/content/docs/extend/events-and-webhooks/events/_event.astro';
 import EventBody from 'src/content/docs/extend/events-and-webhooks/events/_event-body.astro';
 import InlineField from 'src/components/InlineField.astro';
@@ -34,7 +34,7 @@ export const eventType = 'user.login.new-device';
   <APIField slot="leading-fields" name="event.authenticationType" type="String">
     The type of authentication used in the login request. The possible values are:
 
-    <AuthenticationTypeValues show_since="103000" />
+    <AuthenticationTypeValues showSince="1.30.0" />
   </APIField>
 
   <APIField slot="leading-fields" name="event.connectorId" type="UUID">
@@ -62,7 +62,7 @@ export const eventType = 'user.login.new-device';
   </APIField>
 
   <APIField slot="leading-fields" name="event.type" type="String">
-    The event type, this value will always be <code>{eventType}</code>.
+    The event type, this value will always be <code>{eventType}</code>.{/* eslint-disable-line */}
   </APIField>
 
   <APIField slot="leading-fields" name="event.user" type="Object">

astro/src/content/docs/extend/events-and-webhooks/events/user-login-success.mdx

@@ -6,7 +6,7 @@ subcategory: events and webhooks
 tertcategory: events
 ---
 import APIField from 'src/components/api/APIField.astro';
-import AuthenticationTypeValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import Event from 'src/content/docs/extend/events-and-webhooks/events/_event.astro';
 import EventBody from 'src/content/docs/extend/events-and-webhooks/events/_event-body.astro';
 import InlineField from 'src/components/InlineField.astro';
@@ -33,7 +33,7 @@ export const eventType = 'user.login.success';
   <APIField slot="leading-fields" name="event.authenticationType" type="String">
     The type of authentication used in the login request. The possible values are:
 
-    <AuthenticationTypeValues show_since="100600" />
+    <AuthenticationTypeValues showSince="1.6.0" />
   </APIField>
 
   <APIField slot="leading-fields" name="event.connectorId" type="UUID" since="1.18.0">
@@ -67,7 +67,7 @@ export const eventType = 'user.login.success';
   </APIField>
 
   <APIField slot="trailing-fields" name="event.type" type="String">
-    The event type, this value will always be <code>{eventType}</code>.
+    The event type, this value will always be <code>{eventType}</code>.{/* eslint-disable-line */}
   </APIField>
 
   <APIField slot="trailing-fields" name="event.user" type="Object">

astro/src/content/docs/extend/events-and-webhooks/events/user-login-suspicious.mdx

@@ -6,7 +6,7 @@ subcategory: events and webhooks
 tertcategory: events
 ---
 import APIField from 'src/components/api/APIField.astro';
-import AuthenticationTypeValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
 import Event from 'src/content/docs/extend/events-and-webhooks/events/_event.astro';
 import EventBody from 'src/content/docs/extend/events-and-webhooks/events/_event-body.astro';
 import InlineField from 'src/components/InlineField.astro';
@@ -34,7 +34,7 @@ export const eventType = 'user.login.suspicious';
   <APIField slot="leading-fields" name="event.authenticationType" type="String">
     The type of authentication used in the login request. The possible values are:
 
-    <AuthenticationTypeValues show_since="103000" />
+    <AuthenticationTypeValues showSince="1.30.0" />
   </APIField>
 
   <APIField slot="leading-fields" name="event.connectorId" type="UUID">
@@ -70,7 +70,7 @@ export const eventType = 'user.login.suspicious';
   </APIField>
 
   <APIField slot="trailing-fields" name="event.type" type="String">
-    The event type, this value will always be <code>{eventType}</code>.
+    The event type, this value will always be <code>{eventType}</code>.{/* eslint-disable-line */}
   </APIField>
 
   <APIField slot="trailing-fields" name="event.user" type="Object">

astro/src/content/docs/lifecycle/authenticate-users/oauth/tokens.mdx

@@ -10,7 +10,8 @@ import APIBlock from 'src/components/api/APIBlock.astro';
 import APIField from 'src/components/api/APIField.astro';
 import AccessTokenClaims from 'src/content/docs/_shared/_access-token-claims.mdx';
 import Aside from 'src/components/Aside.astro';
-import AuthenticationTypeClaimValues from 'src/content/docs/_shared/_authentication-type-values.mdx';
+import AuthenticationTypeValues from 'src/content/docs/_shared/authentication-type-values.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 import ExampleAccessToken from 'src/content/docs/lifecycle/authenticate-users/oauth/_example_access_token.mdx';
 import ExampleIdToken from 'src/content/docs/lifecycle/authenticate-users/oauth/_example_id_token.mdx';
 import ExampleRefreshToken from 'src/content/docs/lifecycle/authenticate-users/oauth/_example_refresh_token.mdx';
@@ -149,7 +150,7 @@ The Id Token may be returned as part of an Authentication request when the `open
   <APIField name="authenticationType" type="String">
     The method used to authenticate the User which resulted in this JWT being generated. The possible values are:
 
-    <AuthenticationTypeClaimValues show_since="100000" />
+    <AuthenticationTypeValues />
   </APIField>
   <APIField name="auth_time" type="Long" since="1.36.0">
     The time of the initial authentication request expressed as UNIX time which is the number of seconds since Epoch. This claim will remain the same even when the token has been re-issued through the use of a Refresh Token.
@@ -263,7 +264,7 @@ A refresh token is associated with the same set of validated and consented OAuth
 
 To request a refresh token during authentication you must provide the `offline_access` scope. The refresh token is not supported by the Implicit Grant, so if you provide the `offline_access` scope during an Implicit Grant workflow it will be ignored.
 
-If you request the `offline_access` scope and an Refresh Token is not returned, ensure that the FusionAuth application has been configured to generate refresh tokens. Ensure `Generate refresh tokens` is enabled in your application settings. See <strong>Settings -> Applications -> OAuth</strong>. This setting will cause a Refresh Token to be returned when the `offline_access` scope is requested. You will also want to ensure the `Refresh Token` grant is enabled which allows the use of the Refresh Token to be exchanged for a new Access Token.
+If you request the `offline_access` scope and an Refresh Token is not returned, ensure that the FusionAuth application has been configured to generate refresh tokens. Ensure `Generate refresh tokens` is enabled in your application settings. See <Breadcrumb>Settings -> Applications -> OAuth</Breadcrumb>. This setting will cause a Refresh Token to be returned when the `offline_access` scope is requested. You will also want to ensure the `Refresh Token` grant is enabled which allows the use of the Refresh Token to be exchanged for a new Access Token.
 
 ### Sample Refresh Token