Merge pull request #237 from docker/cm/better-type

OAuthProvider -> OAuthClient

Author: ColinMcNeil

src/extension/ui/src/components/tabs/OAuthProviders.tsx

@@ -2,7 +2,7 @@ import { v1 } from "@docker/extension-api-client-types";
 import useOAuthProvider from "../../queries/useOAuthProvider";
 import { Alert, Box, Button, Card, CardContent, CardHeader, Chip, CircularProgress, Collapse, Link, Stack, Typography } from "@mui/material";
 import { useState } from "react";
-import { OAuthProvider } from "../../types/oauth/Provider";
+import { OAuthClient } from "../../types/oauth/Client";
 
 const OAuthProviders = ({ client }: { client: v1.DockerDesktopClient }) => {
     const { data, isLoading, error, authorizeOAuthProvider, unauthorizeOAuthProvider } = useOAuthProvider(client);
@@ -25,7 +25,7 @@ const OAuthProviders = ({ client }: { client: v1.DockerDesktopClient }) => {
     }
     if (data.length > 0) {
         return <>
-            {data.map((provider: OAuthProvider) => {
+            {data.map((provider: OAuthClient) => {
                 return <Card>
                     <CardHeader title={provider.app} action={provider.authorized ? <Button variant="contained" color="error" onClick={() => {
                         unauthorizeOAuthProvider.mutateAsync(provider.app);

src/extension/ui/src/components/tile/ConfigEditor.tsx

@@ -29,6 +29,11 @@ const ConfigEditor = ({
   catalogItem: CatalogItemRichened;
   client: v1.DockerDesktopClient;
 }) => {
+
+  if (!catalogItem.config?.[0]) {
+    return null;
+  }
+
   const configSchema = catalogItem.configSchema;
 
   const {
@@ -160,6 +165,9 @@ const ConfigEditor = ({
 };
 
 function sanitizeConfig(config: { [key: string]: any; }, catalogItem: CatalogItemRichened) {
+  if (!catalogItem.config?.[0]) {
+    return config;
+  }
   const newConfig = buildObjectFromFlattenedObject(config);
 
   // Remove all attributes which are optional and which have the defautl value

src/extension/ui/src/queries/useCatalog.ts

@@ -46,7 +46,7 @@ function useCatalog(client: v1.DockerDesktopClient) {
         ...item,
         secrets: secretsWithAssignment,
         configValue: itemConfigValue,
-        configSchema: item.config,
+        configSchema: item.config || {},
         configTemplate,
         missingConfig: unConfigured,
         missingSecrets: missingASecret,

src/extension/ui/src/types/catalog/index.ts

@@ -1,38 +1,42 @@
-import { ReactNode } from "react";
-import { Secret } from "../secrets";
+import { JsonSchema } from "json-schema-library";
 
 /**
  * Interface for a catalog item
  */
 export interface CatalogItem {
-    description?: string;
-    title?: string;
-    source?: string;
-    icon?: string;
-    secrets?: { name: string }[];
-    ref: string;
-    prompts: number;
-    resources: object[];
-    tools: { name: string }[];
-    config?: any; // Configuration type
+  description?: string;
+  title?: string;
+  source?: string;
+  icon?: string;
+  secrets?: { name: string }[];
+  ref: string;
+  prompts: number;
+  resources: object[];
+  tools: { name: string }[];
+  config?: JsonSchema;
 }
 
+// Base Catalog
+export interface CatalogYaml {
+  [itemName: string]: CatalogItem;
+}
+
+// End result when mapping out the catalog keys into a list
 export interface CatalogItemWithName extends CatalogItem {
-    name: string;
+  name: string;
 }
 
-/**
- * Interface for a catalog item with a name
- */
+// Catalog item enrichened with all of the runtime information
 export interface CatalogItemRichened extends CatalogItem {
-    name: string;
-    readme?: string;
-    secrets: { name: string, assigned: boolean }[];
-    configValue: { [key: string]: any };
-    configSchema: any;
-    registered: boolean;
-    canRegister: boolean;
-    missingConfig: boolean;
-    missingSecrets: boolean;
-    configTemplate: { [key: string]: any };
+  name: string;
+  readme?: string;
+  secrets: { name: string; assigned: boolean }[];
+  configValue: { [key: string]: any };
+  configSchema: JsonSchema;
+  config?: JsonSchema;
+  registered: boolean;
+  canRegister: boolean;
+  missingConfig: boolean;
+  missingSecrets: boolean;
+  configTemplate: { [key: string]: any };
 }

src/extension/ui/src/types/oauth/Provider.ts renamed to src/extension/ui/src/types/oauth/Client.ts

@@ -1,4 +1,4 @@
-export interface OAuthProvider {
+export interface OAuthClient {
   app: string;
   authorized: boolean;
   provider: string;

src/extension/ui/src/utils/OAuth.ts

@@ -1,10 +1,11 @@
 import { v1 } from "@docker/extension-api-client-types";
-import { OAuthProvider } from "../types/oauth/Provider";
+import { OAuthClient } from "../types/oauth/Client";
+
 export const listOAuthApps = async (client: v1.DockerDesktopClient) => {
   const output = await client.extension.host?.cli.exec("host-binary", [
     "list-oauth-apps",
   ]);
-  return JSON.parse(output?.stdout || "[]") as OAuthProvider[];
+  return JSON.parse(output?.stdout || "[]") as OAuthClient[];
 };
 
 export const authorizeOAuthApp = async (