partial: deprecate FIELDS

cypress/e2e/dashboard.cy.ts

@@ -5,18 +5,18 @@ describe('template spec', () => {
         cy.intercept(
             {
                 method: 'GET',
-                url: `${PATHS.CELL}`,
+                url: `${PATHS.Cell}`,
             },
-            { fixture: PATHS.CELL.replace(/^\//, '') },
+            { fixture: PATHS.Cell.replace(/^\//, '') },
         )
         cy.intercept(
             {
                 method: 'GET',
-                url: `${PATHS.CELL}/*`,
+                url: `${PATHS.Cell}/*`,
             },
             async (req) => {
                 const id = req.url.split('/').pop()
-                const cells = await cy.fixture(PATHS.CELL.replace(/^\//, ''))
+                const cells = await cy.fixture(PATHS.Cell.replace(/^\//, ''))
                 req.reply({
                     body: cells.results.find((cell) => cell.uuid === id),
                 })

src/App.tsx

@@ -118,7 +118,7 @@ export function Core() {
             <Divider component="li" key="div0">
                 {open && 'Outputs'}
             </Divider>
-            {[LOOKUP_KEYS.EXPERIMENT, LOOKUP_KEYS.CYCLER_TEST].map(
+            {[LOOKUP_KEYS.Experiment, LOOKUP_KEYS.CyclerTest].map(
                 (lookupKey) => (
                     <LI key={lookupKey} lookupKey={lookupKey} />
                 ),
@@ -127,33 +127,33 @@ export function Core() {
                 {open && 'Resources'}
             </Divider>
             {[
-                LOOKUP_KEYS.FILE,
-                LOOKUP_KEYS.CELL,
-                LOOKUP_KEYS.EQUIPMENT,
-                LOOKUP_KEYS.SCHEDULE,
-                LOOKUP_KEYS.ARBITRARY_FILE,
+                LOOKUP_KEYS.File,
+                LOOKUP_KEYS.Cell,
+                LOOKUP_KEYS.Equipment,
+                LOOKUP_KEYS.Schedule,
+                LOOKUP_KEYS.ArbitraryFile,
             ].map((lookupKey) => (
                 <LI key={lookupKey} lookupKey={lookupKey} />
             ))}
             <Divider component="li" key="div3">
                 {open && 'Inputs'}
             </Divider>
             {[
-                LOOKUP_KEYS.PATH,
-                LOOKUP_KEYS.VALIDATION_SCHEMA,
-                LOOKUP_KEYS.COLUMN_FAMILY,
-                LOOKUP_KEYS.UNIT,
+                LOOKUP_KEYS.Path,
+                LOOKUP_KEYS.ValidationSchema,
+                LOOKUP_KEYS.ColumnFamily,
+                LOOKUP_KEYS.Unit,
             ].map((lookupKey) => (
                 <LI key={lookupKey} lookupKey={lookupKey} />
             ))}
             <Divider component="li" key="div4">
                 {open && 'Management'}
             </Divider>
             {[
-                LOOKUP_KEYS.LAB,
-                LOOKUP_KEYS.TEAM,
-                LOOKUP_KEYS.HARVESTER,
-                LOOKUP_KEYS.ADDITIONAL_STORAGE,
+                LOOKUP_KEYS.Lab,
+                LOOKUP_KEYS.Team,
+                LOOKUP_KEYS.Harvester,
+                LOOKUP_KEYS.AdditionalStorage,
             ].map((lookupKey) => (
                 <LI key={lookupKey} lookupKey={lookupKey} />
             ))}
@@ -275,7 +275,7 @@ export function Core() {
         return (
             <ResourceCard
                 resourceId={id ?? -1}
-                lookupKey={lookupKey ?? 'CYCLER_TEST'}
+                lookupKey={lookupKey ?? 'CyclerTest'}
                 expanded={true}
                 editing={searchParams.get('editing') === 'true'}
             />
@@ -292,7 +292,7 @@ export function Core() {
             return <></>
         }
 
-        return <ResourceList lookupKey={lookupKey ?? 'CYCLER_TEST'} />
+        return <ResourceList lookupKey={lookupKey ?? 'CyclerTest'} />
     }
 
     /* A <Routes> looks through its children <Route>s and renders the first one that matches the current URL. */
@@ -302,7 +302,7 @@ export function Core() {
                 <Route path={PATHS.DASHBOARD} element={Layout}>
                     {/*<Route path={PATHS.GRAPH} element={<DatasetChart />} />*/}
                     <Route
-                        path={`${PATHS.MAPPING}/:id`}
+                        path={`${PATHS.ColumnMapping}/:id`}
                         element={<Mapping />}
                     />
                     {/* Handle direct resource lookups */}

src/ClientCodeDemo.tsx

@@ -35,7 +35,7 @@ function DatasetSelector({
     fileQueryLimit?: number
 }) {
     const { useListQuery } = useFetchResource()
-    const query = useListQuery(LOOKUP_KEYS.FILE, {
+    const query = useListQuery(LOOKUP_KEYS.File, {
         limit: fileQueryLimit ?? DEFAULT_FETCH_LIMIT,
     })
 

src/Components/ApiResourceContext.tsx

@@ -46,10 +46,14 @@ export const get_select_function =
     <T,>(lookupKey: LookupKey) =>
     (data: AxiosResponse<GalvResource>) => {
         Object.entries(FIELDS[lookupKey]).forEach(([k, v]) => {
-            if (has(v, 'transformation'))
+            if (has(v, 'transformation')) {
+                console.warn(
+                    `[FIELDS deprecation] ${lookupKey}.${k} has a transformation`,
+                )
                 data.data[k as keyof typeof data.data] = v.transformation(
                     data.data[k as keyof typeof data.data],
                 )
+            }
         })
         return data as AxiosResponse<T>
     }

src/Components/AttachmentUploadContext.tsx

@@ -58,11 +58,11 @@ export default function AttachmentUploadContextProvider({
             },
             onSuccess: async (data: AxiosResponse<ArbitraryFile>) => {
                 queryClient.setQueryData(
-                    [LOOKUP_KEYS.ARBITRARY_FILE, data.data.id],
+                    [LOOKUP_KEYS.ArbitraryFile, data.data.id],
                     data.data,
                 )
                 await queryClient.invalidateQueries({
-                    queryKey: [LOOKUP_KEYS.ARBITRARY_FILE, 'list'],
+                    queryKey: [LOOKUP_KEYS.ArbitraryFile, 'list'],
                 })
                 callback(data.data.url)
             },

src/Components/AuthImage.tsx

@@ -30,7 +30,7 @@ export default function AuthImage({
         'Galv-Storage-No-Redirect': true,
     }
     const query = useQuery({
-        queryKey: [LOOKUP_KEYS.FILE, file.id, 'png'],
+        queryKey: [LOOKUP_KEYS.File, file.id, 'png'],
         queryFn: async () => {
             const response = await axios.get(file.png, {
                 headers,

src/Components/CardActionBar.tsx

@@ -32,7 +32,7 @@ import { has_value, id_from_ref_props } from './misc'
 import clsx from 'clsx'
 import UseStyles from '../styles/UseStyles'
 import { useSelectionManagement } from './SelectionManagementContext'
-import { representation } from './Representation'
+import { genericRepresentation } from './representation/GenericRepresentation'
 import SafeTooltip from './SafeTooltip'
 
 export type CardActionBarProps = {
@@ -67,17 +67,33 @@ export type CardActionBarProps = {
  */
 export default function CardActionBar(props: CardActionBarProps) {
     const { classes, theme } = UseStyles()
-    const { apiResource } = useApiResource()
+    const { apiResource, apiResourceDescription } = useApiResource()
     const iconProps: Partial<SvgIconProps> = {
         ...props.iconProps,
     }
     const selectable = props.selectable ?? typeof apiResource?.id === 'string'
     const { toggleSelected, isSelected } = useSelectionManagement()
 
+    // Check differences between FIELDS context and apiResourceDescription context
+    const api_context = Object.values(apiResourceDescription ?? {}).filter(
+        (e) => e.galv_resource,
+    )
+    const fields_context = Object.values(FIELDS[props.lookupKey]).filter((e) =>
+        is_lookupKey(e.type),
+    )
+    // const api_only = api_context.filter((e) => !fields_context.includes(e))
+    const fields_only = fields_context.filter((e) => !api_context.includes(e))
+    if (fields_only.length > 0) {
+        console.warn(
+            `[FIELDS deprecation] FIELD[${props.lookupKey}] has fields not present in apiResourceDescription.`,
+            fields_only,
+        )
+    }
+
     const context_section = (
         <>
-            {Object.entries(FIELDS[props.lookupKey])
-                .filter((e) => is_lookupKey(e[1].type))
+            {Object.entries(apiResourceDescription ?? {})
+                .filter((e) => e[1].galv_resource)
                 .map(([k, v]) => {
                     const relative_lookupKey = v.type as LookupKey
                     let content: ReactNode
@@ -225,7 +241,7 @@ export default function CardActionBar(props: CardActionBarProps) {
 
     const destroy_section = (
         <Stack direction="row" spacing={1} alignItems="center">
-            {props.lookupKey === LOOKUP_KEYS.FILE && props.reimportable && (
+            {props.lookupKey === LOOKUP_KEYS.File && props.reimportable && (
                 <SafeTooltip
                     title="Force the harvester to re-import this file"
                     arrow
@@ -291,7 +307,7 @@ export default function CardActionBar(props: CardActionBarProps) {
             {props.onFork && apiResource && (
                 <SafeTooltip
                     title={`
-            Create your own copy of ${representation({ data: apiResource, lookupKey: props.lookupKey })}
+            Create your own copy of ${genericRepresentation({ data: apiResource, lookupKey: props.lookupKey })}
             `}
                     arrow
                     describeChild

src/Components/CurrentUserContext.tsx

@@ -146,10 +146,10 @@ export default function CurrentUserContextProvider({
     })
 
     const Refresh = useQuery({
-        queryKey: [LOOKUP_KEYS.USER, 'refresh'],
+        queryKey: [LOOKUP_KEYS.User, 'refresh'],
         queryFn: () => {
             if (!user) return
-            const api = new API_HANDLERS[LOOKUP_KEYS.USER](api_config)
+            const api = new API_HANDLERS[LOOKUP_KEYS.User](api_config)
             return api
                 .usersRetrieve({ id: user.id })
                 .then((response: AxiosResponse<User>) => {

src/Components/FetchResourceContext.tsx

@@ -54,7 +54,8 @@ export type FieldDescription = {
         | 'choice'
         | 'json'
         | string
-    many: boolean
+    galv_resource: boolean // Whether the `type` is a Galv Resource
+    many: boolean // Whether the field is a list
     help_text: string
     required: boolean
     read_only: boolean
@@ -558,7 +559,7 @@ export default function FetchResourceContextProvider({
                 queryClient.invalidateQueries({
                     queryKey: [lookupKey, 'list'],
                 })
-                if (lookupKey === LOOKUP_KEYS.LAB) {
+                if (lookupKey === LOOKUP_KEYS.Lab) {
                     refresh_user()
                 }
                 // Invalidate autocomplete cache

src/Components/Mapping.tsx

@@ -166,7 +166,7 @@ function CreateColumnType({
                             onCreate(new_resource_url)
                         }}
                         onDiscard={() => setOpen(false)}
-                        lookupKey={LOOKUP_KEYS.COLUMN_FAMILY}
+                        lookupKey={LOOKUP_KEYS.ColumnFamily}
                     />
                 </UndoRedoProvider>
             </>
@@ -184,7 +184,7 @@ function SelectColumnType({
     reset_name: string
 }) {
     const { useListQuery } = useFetchResource()
-    const query = useListQuery<DataColumnType>(LOOKUP_KEYS.COLUMN_FAMILY)
+    const query = useListQuery<DataColumnType>(LOOKUP_KEYS.ColumnFamily)
     const { classes } = useStyles()
     const [createModalOpen, setCreateModalOpen] = useState(false)
 
@@ -826,7 +826,7 @@ function MappingManager({
     })
     const { classes } = useStyles()
     const { useListQuery, useCreateQuery, useUpdateQuery } = useFetchResource()
-    const col_query = useListQuery<DataColumnType>(LOOKUP_KEYS.COLUMN_FAMILY)
+    const col_query = useListQuery<DataColumnType>(LOOKUP_KEYS.ColumnFamily)
     const [more, setMore] = React.useState(false)
     const [advancedPropertiesOpen, setAdvancedPropertiesOpen] =
         React.useState(false)
@@ -838,14 +838,14 @@ function MappingManager({
         return m ? { ...m } : blank_map()
     })
     const navigate = useNavigate()
-    const updateFileMutation = useUpdateQuery<ObservedFile>(LOOKUP_KEYS.FILE)
+    const updateFileMutation = useUpdateQuery<ObservedFile>(LOOKUP_KEYS.File)
     const updateFile = (new_mapping: DB_MappingResource) =>
         updateFileMutation.mutate(
             { ...file!, mapping: new_mapping.url },
             { onSuccess: () => navigate(0) },
         )
     const createMapMutation = useCreateQuery<DB_MappingResource>(
-        LOOKUP_KEYS.MAPPING,
+        LOOKUP_KEYS.ColumnMapping,
         { after_cache: (r) => updateFile(r.data) },
     )
     const createMap = (data: ApplicableMappingResource) => {
@@ -864,12 +864,12 @@ function MappingManager({
         })
     }
     const updateMapMutation = useUpdateQuery<DB_MappingResource>(
-        LOOKUP_KEYS.MAPPING,
+        LOOKUP_KEYS.ColumnMapping,
     )
     const updateMap = (data: DB_MappingResource) =>
         updateMapMutation.mutate(data, { onSuccess: () => navigate(0) })
     // TODO: Implement deleteMapMutation when backend supplies delete permissions
-    // const deleteMapMutation = useDeleteQuery<DB_MappingResource>(LOOKUP_KEYS.MAPPING)
+    // const deleteMapMutation = useDeleteQuery<DB_MappingResource>(LOOKUP_KEYS.ColumnMapping)
     // const deleteMap = (data: DB_MappingResource) => deleteMapMutation.mutate(data, {onSuccess: () => navigate(0)})
 
     if (col_query?.hasNextPage && !col_query.isFetchingNextPage)
@@ -963,7 +963,7 @@ function MappingManager({
                     {file?.id && (
                         <ResourceChip
                             resourceId={file.id as string}
-                            lookupKey={LOOKUP_KEYS.FILE}
+                            lookupKey={LOOKUP_KEYS.File}
                         />
                     )}
                 </Typography>
@@ -1231,12 +1231,12 @@ Do you wish to continue?`)
                                             <PrettyResource
                                                 target={{
                                                     _type: key_to_type(
-                                                        LOOKUP_KEYS.TEAM,
+                                                        LOOKUP_KEYS.Team,
                                                     ),
                                                     _value: mapping.mapping
                                                         .team,
                                                 }}
-                                                lookupKey={LOOKUP_KEYS.TEAM}
+                                                lookupKey={LOOKUP_KEYS.Team}
                                                 edit_mode={true}
                                                 allow_new={false}
                                                 onChange={(
@@ -1498,7 +1498,7 @@ export default function WrappedMapping() {
         >
             <ApiResourceContextProvider
                 resourceId={id}
-                lookupKey={LOOKUP_KEYS.FILE}
+                lookupKey={LOOKUP_KEYS.File}
             >
                 <Mapping />
             </ApiResourceContextProvider>

src/Components/ResourceChip.tsx

@@ -8,7 +8,7 @@ import QueryWrapper, { QueryWrapperProps } from './QueryWrapper'
 import ErrorChip from './error/ErrorChip'
 import { FAMILY_LOOKUP_KEYS, GalvResource, PATHS } from '../constants'
 import ErrorBoundary from './ErrorBoundary'
-import Representation from './Representation'
+import Representation from './representation/GenericRepresentation'
 import { FilterContext } from './filtering/FilterContext'
 import ApiResourceContextProvider, {
     ApiResourceContextProviderProps,