Remove getSelectedSampleIdsFromSelectionKey, getURLParamsForSampleSelectionKey

Author: labkey-alan

packages/components/releaseNotes/components.md

@@ -7,6 +7,8 @@ Components, models, actions, and utility functions for LabKey applications and p
   - moved to ui-premium
 - Add createSnapshotSelectionKeyStr
 - Remove getJobCreationHref
+- Remove getSelectedSampleIdsFromSelectionKey
+- Remove getURLParamsForSampleSelectionKey
 
 ### version 6.52.4
 *Released*: 30 June 2025

packages/components/src/index.ts

@@ -389,7 +389,6 @@ import {
     getLookupRowIdsFromSelection,
     getSampleSet,
     getSampleTypeDetails,
-    getSelectedSampleIdsFromSelectionKey,
     getSelectionLineageData,
     updateSampleStorageData,
 } from './internal/components/samples/actions';
@@ -412,7 +411,6 @@ import {
     getSampleStatusColor,
     getSampleStatusContainerFilter,
     getSampleStatusType,
-    getURLParamsForSampleSelectionKey,
     isAllSamplesSchema,
     isSampleOperationPermitted,
     isSamplesSchema,
@@ -1442,14 +1440,12 @@ export {
     getSelectedDataDeprecated,
     getSelectedPicklistSamples,
     getSelectedRows,
-    getSelectedSampleIdsFromSelectionKey,
     getSelectionLineageData,
     getSourceDomainDefaultSystemFields,
     getStoredAmountDisplay,
     getTestAPIWrapper,
     getTimelineEntityUrl,
     getUniqueIdColumnMetadata,
-    getURLParamsForSampleSelectionKey,
     getUserProperties,
     getUserRoleDisplay,
     getUsersWithPermissions,

packages/components/src/internal/components/samples/actions.ts

@@ -144,55 +144,6 @@ export async function fetchSamples(
     return data.asImmutable();
 }
 
-/**
- * Get an array of sample RowIds from a URL selectionKey for the following scenarios:
- *  - sample grid
- *  - picklist
- *  - assay
- *  - storage items
- */
-export async function getSelectedSampleIdsFromSelectionKey(searchParams: URLSearchParams): Promise<number[]> {
-    const key = searchParams.get('selectionKey');
-    let sampleIds;
-    const selectionType = searchParams.get('selectionKeyType');
-    const isSnapshot = selectionType === SELECTION_KEY_TYPE.snapshot;
-
-    if (selectionType === SELECTION_KEY_TYPE.inventoryItems) {
-        const response = await getSnapshotSelections(key);
-        sampleIds = await getSelectedItemSamples(response.selected);
-    } else if (searchParams.get('isAssay')) {
-        const schemaName = searchParams.get('assayProtocol');
-        const sampleFieldKey = searchParams.get('sampleFieldKey');
-        const queryName = SCHEMAS.ASSAY_TABLES.RESULTS_QUERYNAME;
-        let response;
-
-        if (isSnapshot) {
-            response = await getSnapshotSelections(key);
-        } else {
-            response = await getSelection(searchParams, schemaName, queryName);
-        }
-
-        sampleIds = await getLookupRowIdsFromSelection(schemaName, queryName, response?.selected, sampleFieldKey);
-    } else {
-        const picklistName = searchParams.get('picklistName');
-        let response;
-
-        if (isSnapshot && key) {
-            response = await getSnapshotSelections(key);
-        } else {
-            response = await getSelection(searchParams, SCHEMAS.PICKLIST_TABLES.SCHEMA, picklistName);
-        }
-
-        if (picklistName) {
-            sampleIds = await getSelectedPicklistSamples(picklistName, response.selected, false, undefined);
-        } else {
-            sampleIds = response.selected.map(Number);
-        }
-    }
-
-    return sampleIds;
-}
-
 export async function getGroupedSampleDomainFields(sampleType: string): Promise<GroupedSampleFields> {
     // use domain fields as we only want to include fields defined by the user, but use queryInfo to map to fieldKey
     const sampleTypeDomain = await getSampleTypeDetails(new SchemaQuery(SCHEMAS.SAMPLE_SETS.SCHEMA, sampleType));

packages/components/src/internal/components/samples/utils.test.ts

@@ -10,10 +10,6 @@ import { SCHEMAS } from '../../schemas';
 import { OperationConfirmationData } from '../entities/models';
 import { SchemaQuery } from '../../../public/SchemaQuery';
 
-import { makeTestQueryModel } from '../../../public/QueryModel/testUtils';
-
-import { QueryInfo } from '../../../public/QueryInfo';
-
 import {
     DEFAULT_AVAILABLE_STATUS_COLOR,
     DEFAULT_CONSUMED_STATUS_COLOR,
@@ -30,7 +26,6 @@ import {
     getSampleStatusColor,
     getSampleStatusLockedMessage,
     getSampleStatusType,
-    getURLParamsForSampleSelectionKey,
     isSampleOperationPermitted,
     isSamplesSchema,
 } from './utils';
@@ -347,40 +342,6 @@ describe('getSampleStatus', () => {
     });
 });
 
-const TEST_SQ = new SchemaQuery('schema', 'query');
-const TEST_QUERY_INFO = new QueryInfo({ schemaQuery: TEST_SQ, pkCols: ['RowId'] });
-const TEST_MODEL = makeTestQueryModel(TEST_SQ, TEST_QUERY_INFO).mutate({ id: 'model-id' });
-
-describe('getURLParamsForSampleSelectionKey', () => {
-    test('default props', () => {
-        expect(getURLParamsForSampleSelectionKey(TEST_MODEL)).toStrictEqual({ selectionKey: 'model-id' });
-    });
-
-    test('picklist', () => {
-        expect(getURLParamsForSampleSelectionKey(TEST_MODEL, 'picklist1')).toStrictEqual({
-            selectionKey: 'model-id',
-            picklistName: 'picklist1',
-        });
-    });
-
-    test('assay', () => {
-        expect(getURLParamsForSampleSelectionKey(TEST_MODEL, undefined, true, 'Name')).toStrictEqual({
-            selectionKey: 'model-id',
-            assayProtocol: 'schema',
-            isAssay: true,
-            sampleFieldKey: 'Name',
-        });
-    });
-
-    test('keyValue', () => {
-        const model = TEST_MODEL.mutate({ keyValue: 123 });
-        expect(getURLParamsForSampleSelectionKey(model)).toStrictEqual({
-            'query.RowId~eq': 123,
-            selectionKey: 'appkey|schema/query|123',
-        });
-    });
-});
-
 describe('getSampleStatusLockedMessage', () => {
     test('no state', () => {
         expect(getSampleStatusLockedMessage(undefined, false)).toBeUndefined();

packages/components/src/internal/components/samples/utils.tsx

@@ -13,12 +13,8 @@ import { caseInsensitive } from '../../util/utils';
 import { ModuleContext } from '../base/ServerContext';
 
 import { SchemaQuery } from '../../../public/SchemaQuery';
-import { QueryModel } from '../../../public/QueryModel/QueryModel';
-import { PICKLIST_SAMPLES_FILTER } from '../picklist/models';
 import { SystemField } from '../domainproperties/models';
 
-import { BOX_SAMPLES_FILTER, LOCATION_SAMPLES_FILTER } from '../../query/filter';
-
 import {
     DEFAULT_AVAILABLE_STATUS_COLOR,
     DEFAULT_CONSUMED_STATUS_COLOR,
@@ -270,52 +266,6 @@ export function isAllSamplesSchema(schemaQuery: SchemaQuery): boolean {
     return false;
 }
 
-export function getURLParamsForSampleSelectionKey(
-    model: QueryModel,
-    picklistName?: string,
-    isAssay?: boolean,
-    sampleFieldKey?: string,
-    ignoreFilter?: boolean
-): Record<string, any> {
-    const { keyValue, queryInfo, selectionKey } = model;
-    let params = {};
-
-    if (queryInfo) {
-        const singleSelect = keyValue !== undefined;
-        const { schemaQuery } = queryInfo;
-        params['selectionKey'] = singleSelect
-            ? SchemaQuery.createAppSelectionKey(schemaQuery, [keyValue])
-            : selectionKey;
-
-        if (!ignoreFilter) {
-            model.filters.forEach(filter => {
-                const filterURLSuffix = filter.getFilterType().getURLSuffix();
-                // We don't need the picklist IN clause here since we're dealing with the samples selected in the grid
-                const isPicklistFilterType = filterURLSuffix === PICKLIST_SAMPLES_FILTER.getURLSuffix();
-                // and we don't need the LSID LineageOf clause either
-                const isLineageOfFilterType = filterURLSuffix === Filter.Types.EXP_LINEAGE_OF.getURLSuffix();
-                const isSampleInLocationFilterType =
-                    filterURLSuffix === LOCATION_SAMPLES_FILTER.getURLSuffix() ||
-                    filterURLSuffix === BOX_SAMPLES_FILTER.getURLSuffix();
-
-                if (!isPicklistFilterType && !isLineageOfFilterType && !isSampleInLocationFilterType) {
-                    params[filter.getURLParameterName()] = filter.getURLParameterValue();
-                }
-            });
-        }
-
-        if (picklistName) {
-            params['picklistName'] = picklistName;
-        }
-
-        if (isAssay && sampleFieldKey) {
-            params = { ...params, ...{ assayProtocol: schemaQuery.schemaName, isAssay: true, sampleFieldKey } };
-        }
-    }
-
-    return params;
-}
-
 export function getSampleDomainDefaultSystemFields(moduleContext?: ModuleContext): SystemField[] {
     return isFreezerManagementEnabled(moduleContext)
         ? SAMPLE_DOMAIN_DEFAULT_SYSTEM_FIELDS.concat(SAMPLE_DOMAIN_INVENTORY_SYSTEM_FIELDS)