web/maintenance: lint pass to add missing HTMLElementTagNameMap entries

kensternberg-authentik · kensternberg-authentik · commit bfca8bc772bc · 2025-12-18T14:07:10.000-08:00
# What

This code mechanically adds HTMLElementTagNameMap entries to those files that were missing it.

Every entry in the report is in this format:

    ./src/elements/ak-table/stories/ak-select-table.stories.ts

        'ak-select-table-test-sort' has not been registered on HTMLElementTagNameMap
        84:  export class SimpleTableSortTest extends LitElem
        no-missing-element-type-definition

It was trivial to create a Perl script that extracted the file name, the tag name, and the class name, and turn that into a “Open this file and append the HTMLElementTagNameMap definition to the end,” then run `prettier` and `build` to validate that nothing broke.

I also had to hand-edit the JSDoc for `Form`. It is not, by itself, an element. It is an abstract class from which you can derive elements. The `@element` tag there confused lit-analyze, and lit-analyze was correct to call it out.

# Why

These entries help Typescript &amp; Lit-Analyze lint our product, validating that each element is being used correctly and that the types being passed to it are correct.
diff --git a/web/src/admin/AdminInterface/AboutModal.ts b/web/src/admin/AdminInterface/AboutModal.ts
@@ -133,3 +133,9 @@ export class AboutModal extends WithLicenseSummary(WithBrandConfig(ModalButton))
         </div>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-about-modal": AboutModal;
+    }
+}
diff --git a/web/src/admin/applications/entitlements/ApplicationEntitlementPage.ts b/web/src/admin/applications/entitlements/ApplicationEntitlementPage.ts
@@ -144,3 +144,9 @@ declare global {
         "ak-application-roles-list": ApplicationEntitlementsPage;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-application-entitlements-list": ApplicationEntitlementsPage;
+    }
+}
diff --git a/web/src/admin/applications/wizard/ak-application-wizard-main.ts b/web/src/admin/applications/wizard/ak-application-wizard-main.ts
@@ -110,3 +110,9 @@ export class AkApplicationWizardMain extends AKElement {
         </ak-wizard-steps>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-application-wizard-main": AkApplicationWizardMain;
+    }
+}
diff --git a/web/src/admin/applications/wizard/steps/ak-application-wizard-bindings-step.ts b/web/src/admin/applications/wizard/steps/ak-application-wizard-bindings-step.ts
@@ -165,3 +165,9 @@ declare global {
         "ak-application-wizard-applications-step": ApplicationWizardBindingsStep;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-application-wizard-bindings-step": ApplicationWizardBindingsStep;
+    }
+}
diff --git a/web/src/admin/applications/wizard/steps/bindings/ak-application-wizard-bindings-edit-button.ts b/web/src/admin/applications/wizard/steps/bindings/ak-application-wizard-bindings-edit-button.ts
@@ -46,3 +46,9 @@ export function makeEditButton(
         ${label}
     </ak-application-wizard-binding-step-edit-button>`;
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-application-wizard-binding-step-edit-button": ApplicationWizardBindingStepEditButton;
+    }
+}
diff --git a/web/src/admin/events/EventMap.ts b/web/src/admin/events/EventMap.ts
@@ -164,3 +164,10 @@ export class EventMap extends AKElement {
         </div>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-map": Map;
+        "ak-events-map": EventMap;
+    }
+}
diff --git a/web/src/admin/policies/geoip/GeoIPPolicyForm.ts b/web/src/admin/policies/geoip/GeoIPPolicyForm.ts
@@ -195,3 +195,9 @@ export class GeoIPPolicyForm extends BasePolicyForm<GeoIPPolicy> {
             </ak-form-group>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-policy-geoip-form": GeoIPPolicyForm;
+    }
+}
diff --git a/web/src/admin/rbac/InitialPermissionsListPage.ts b/web/src/admin/rbac/InitialPermissionsListPage.ts
@@ -115,3 +115,9 @@ declare global {
         "initial-permissions-list": InitialPermissionsListPage;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-initial-permissions-list": InitialPermissionsListPage;
+    }
+}
diff --git a/web/src/components/ak-nav-buttons.ts b/web/src/components/ak-nav-buttons.ts
@@ -213,3 +213,9 @@ export class NavigationButtons extends WithSession(AKElement) {
         </div>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-nav-buttons": NavigationButtons;
+    }
+}
diff --git a/web/src/elements/ak-table/stories/ak-select-table.stories.ts b/web/src/elements/ak-table/stories/ak-select-table.stories.ts
@@ -137,3 +137,9 @@ export const TableWithSorting: Story = {
 export const MultiselectTableWithSorting: Story = {
     render: () => container(html`<ak-select-table-test-sort multiple></ak-select-table-test-sort>`),
 };
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-select-table-test-sort": SimpleTableSortTest;
+    }
+}
diff --git a/web/src/elements/ak-table/stories/ak-simple-table.stories.ts b/web/src/elements/ak-table/stories/ak-simple-table.stories.ts
@@ -146,3 +146,9 @@ export const GroupedTable: Story = {
     render: () =>
         html`<ak-simple-table .columns=${columns} .content=${groupedContent}></ak-simple-table>`,
 };
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-simple-table-test-sort": SimpleTableSortTest;
+    }
+}
diff --git a/web/src/elements/forms/Form.ts b/web/src/elements/forms/Form.ts
@@ -193,7 +193,7 @@ function reportInvalidFields(
  * produce the actual form, or include the form in-line as a slotted element. Bizarrely, this form
  * will not render at all if it's not actually in the viewport?[2]
  *
- * @element ak-form
+ * @class Form
  *
  * @slot - Where the form goes if `renderForm()` returns undefined.
  * @fires eventname - description
diff --git a/web/src/elements/user/UserReputationList.ts b/web/src/elements/user/UserReputationList.ts
@@ -81,3 +81,9 @@ export class UserReputationList extends Table<Reputation> {
         ];
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-user-reputation-list": UserReputationList;
+    }
+}
diff --git a/web/src/flow/providers/SessionEnd.ts b/web/src/flow/providers/SessionEnd.ts
@@ -70,3 +70,9 @@ export class SessionEnd extends BaseStage<SessionEndChallenge, unknown> {
         </ak-flow-card>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-stage-session-end": SessionEnd;
+    }
+}
diff --git a/web/src/flow/stages/endpoint/agent/EndpointAgentStage.ts b/web/src/flow/stages/endpoint/agent/EndpointAgentStage.ts
@@ -82,3 +82,9 @@ export class EndpointAgentStage extends BaseStage<
         </ak-flow-card>`;
     }
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-stage-endpoint-agent": EndpointAgentStage;
+    }
+}
diff --git a/web/src/user/LibraryPage/ak-library-impl.ts b/web/src/user/LibraryPage/ak-library-impl.ts
@@ -414,3 +414,9 @@ export class LibraryPage extends WithSession(AKElement) {
 
     //#endregion
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "ak-library-impl": LibraryPage;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -133,3 +133,9 @@ export class AboutModal extends WithLicenseSummary(WithBrandConfig(ModalButton))`
`133`	`133`	</div>`;
`134`	`134`	`}`
`135`	`135`	`}`
	`136`	`+`
	`137`	`+declare global {`
	`138`	`+ interface HTMLElementTagNameMap {`
	`139`	`+ "ak-about-modal": AboutModal;`
	`140`	`+ }`
	`141`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -144,3 +144,9 @@ declare global {`
`144`	`144`	`"ak-application-roles-list": ApplicationEntitlementsPage;`
`145`	`145`	`}`
`146`	`146`	`}`
	`147`	`+`
	`148`	`+declare global {`
	`149`	`+ interface HTMLElementTagNameMap {`
	`150`	`+ "ak-application-entitlements-list": ApplicationEntitlementsPage;`
	`151`	`+ }`
	`152`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -110,3 +110,9 @@ export class AkApplicationWizardMain extends AKElement {`
`110`	`110`	</ak-wizard-steps>`;
`111`	`111`	`}`
`112`	`112`	`}`
	`113`	`+`
	`114`	`+declare global {`
	`115`	`+ interface HTMLElementTagNameMap {`
	`116`	`+ "ak-application-wizard-main": AkApplicationWizardMain;`
	`117`	`+ }`
	`118`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -165,3 +165,9 @@ declare global {`
`165`	`165`	`"ak-application-wizard-applications-step": ApplicationWizardBindingsStep;`
`166`	`166`	`}`
`167`	`167`	`}`
	`168`	`+`
	`169`	`+declare global {`
	`170`	`+ interface HTMLElementTagNameMap {`
	`171`	`+ "ak-application-wizard-bindings-step": ApplicationWizardBindingsStep;`
	`172`	`+ }`
	`173`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -164,3 +164,10 @@ export class EventMap extends AKElement {`
`164`	`164`	</div>`;
`165`	`165`	`}`
`166`	`166`	`}`
	`167`	`+`
	`168`	`+declare global {`
	`169`	`+ interface HTMLElementTagNameMap {`
	`170`	`+ "ak-map": Map;`
	`171`	`+ "ak-events-map": EventMap;`
	`172`	`+ }`
	`173`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -195,3 +195,9 @@ export class GeoIPPolicyForm extends BasePolicyForm<GeoIPPolicy> {`
`195`	`195`	</ak-form-group>`;
`196`	`196`	`}`
`197`	`197`	`}`
	`198`	`+`
	`199`	`+declare global {`
	`200`	`+ interface HTMLElementTagNameMap {`
	`201`	`+ "ak-policy-geoip-form": GeoIPPolicyForm;`
	`202`	`+ }`
	`203`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -115,3 +115,9 @@ declare global {`
`115`	`115`	`"initial-permissions-list": InitialPermissionsListPage;`
`116`	`116`	`}`
`117`	`117`	`}`
	`118`	`+`
	`119`	`+declare global {`
	`120`	`+ interface HTMLElementTagNameMap {`
	`121`	`+ "ak-initial-permissions-list": InitialPermissionsListPage;`
	`122`	`+ }`
	`123`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -213,3 +213,9 @@ export class NavigationButtons extends WithSession(AKElement) {`
`213`	`213`	</div>`;
`214`	`214`	`}`
`215`	`215`	`}`
	`216`	`+`
	`217`	`+declare global {`
	`218`	`+ interface HTMLElementTagNameMap {`
	`219`	`+ "ak-nav-buttons": NavigationButtons;`
	`220`	`+ }`
	`221`	`+}`