MVP-274: Added types to docs (#107)

.github/workflows/publish-techdocs.yaml

@@ -8,7 +8,7 @@ on:
         branches: [ main ]
         paths:
             - "mkdocs.yml"
-            - "techdocs/docs/*"
+            - "techdocs/docs/**"
             - "catalog-info.yaml"
 
 jobs:

techdocs/docs/using-the-package/apis-&-components/provider.md

@@ -34,6 +34,12 @@ root.render(
 );
 ```
 
+## TypeScript Type
+
+```TypeScript
+(props: SSOProviderProps) => react_jsx_runtime.JSX.Element;
+```
+
 ## Props
 
 An API reference for the props of the `SSOProvider` component.

techdocs/docs/using-the-package/apis-&-components/usesso-actions/has-roles.md

@@ -33,6 +33,12 @@ export const RoleMessage = () => {
     By default, all roles in the array will be required.  
     If you wish to require only one of a list of roles, add the options parameter with `requireAllRoles` property set to `false`.
 
+## TypeScript Type
+
+```TypeScript
+(roles: string[], options?: HasRolesOptions) => boolean;
+```
+
 ## Parameters
 
 An API reference for the parameters of the `hasRoles` function.

techdocs/docs/using-the-package/apis-&-components/usesso-actions/login.md

@@ -22,6 +22,12 @@ export const LoginButton = () => {
 }
 ```
 
+## TypeScript Type
+
+```TypeScript
+(options?: LoginProps) => void;
+```
+
 ## Parameters
 
 An API reference for the parameters of the `login` function.

techdocs/docs/using-the-package/apis-&-components/usesso-actions/logout.md

@@ -22,6 +22,12 @@ export const LogoutButton = () => {
 }
 ```
 
+## TypeScript Type
+
+```TypeScript
+(backendURL?: string) => void;
+```
+
 ## Parameters
 
 An API reference for the parameters of the `logout` function.

techdocs/docs/using-the-package/apis-&-components/usesso-actions/user.md

@@ -24,12 +24,31 @@ export const UserInfo = () => {
 }
 ```
 
+## TypeScript Type
+
+Type is `SSOUser`.
+
+```TypeScript
+{
+  guid: string;
+  preferred_username: string; // Use as unique identifier for user.
+  username: string;
+  first_name: string;
+  last_name: string;
+  display_name: string;
+  email: string;
+  identity_provider: IdentityProvider;
+  client_roles?: string[];
+  scope?: string;
+  name?: string;
+  originalData: OriginalSSOUser;
+};
+```
+
 ## Properties
 
 An API reference for the properties of the `user` state.
 
-`user` is of type `SSOUser`.
-
 <table>
   <!-- Table columns -->
   <thead>
@@ -42,7 +61,7 @@ An API reference for the properties of the `user` state.
 
   <!-- Table rows -->
   <tbody>
-  <tr>
+    <tr>
       <td>guid</td>
       <td>string</td>
       <td>Unique user identifier string.</td>

techdocs/docs/using-the-package/apis-&-components/usesso.md

@@ -93,6 +93,12 @@ export const UserInfo = () => {
 }
 ```
 
+## TypeScript Type
+
+```TypeScript
+() => AuthService;
+```
+
 ## Hook Actions
 
 An API reference for the actions of the `useSSO` hook.