@mikezimm/fps-core-v7/lib/restAPIs/lists/fields/getSourceFieldsAPI.js

Library of reusable core interfaces, types and constants migrated from fps-library-v2

import { doSpHttpFetchOrPostAndCheck } from '../../../components/molecules/SpHttp/Sp/doSpHttpFetch';
import { SourcePropsNoListTitle, SourcePropsNoWebUrl } from '../../../components/molecules/source-props/ISourceProps';
import { check4This, Check4 } from '../../../logic/Links/CheckSearch';
import { createErrorFpsListReturn } from '../../../components/molecules/process-results/createErrorFpsListItemsReturn';
import { getAbsoluteWebUrlFromSourceProps } from '../../../logic/Strings/getAbssoluteWebUrlFromSourceProps';
/**
 * getSourceFieldsAPI will get all the fields information for a list
 *    import { getSourceFieldsAPI, getSourceFieldByInternalNameOrTitleAPI } from '@mikezimm/fps-core-v7/lib/restAPIs/lists/fields/getSourceFieldsAPI';
 *
 *    Replaces fetchFieldsD from pnp2
 *
 * @param sourceProps
 * @param alertMe
 * @param consoleLog
 * @returns
 */
export async function getSourceFieldsAPI(sourceProps, alertMe, consoleLog, fieldNameTitle = '') {
    // const { performanceSettings } = sourceProps;
    // 2024-09-15:  Change to null as any to pass linting when migrating from fps-library-v2
    // const fetchOp = performanceSettings ? startPerformOpV2( performanceSettings ) : null as any;
    const { listTitle, orderBy, orderBy2, restFilter, } = sourceProps;
    let { selectThese, } = sourceProps;
    // 2024-12-05:  Added this because some places like PivotTiles had absoluteWebUrl in webUrl prop... so just taking care of differences
    const useUrl = getAbsoluteWebUrlFromSourceProps(sourceProps);
    if (!useUrl || !listTitle) {
        // NO WebURL... Throw Alert
        if (alertMe === true)
            alert(`${listTitle ? listTitle : SourcePropsNoListTitle} ${SourcePropsNoWebUrl}`);
        const results = createErrorFpsListReturn(useUrl, listTitle);
        return results;
    }
    let fetchAPI = `${useUrl}/_api/web/lists/getbytitle('${listTitle}')/fields?`;
    if (!selectThese || selectThese.length === 0)
        selectThese = ['*'];
    if (selectThese)
        fetchAPI += `&$select= ${selectThese.join(',')}`;
    const orderBys = [];
    /**
     *  2025-02-09:  Updated the orderBy for when there is no orderBy.prop or .order
     *    https://github.com/mikezimm/PageInfo/issues/178
     */
    if (orderBy && orderBy.prop)
        orderBys.push(`${orderBy.prop} ${orderBy.order ? orderBy.order : 'asc'}`);
    if (orderBy2 && orderBy2.prop)
        orderBys.push(`${orderBy2.prop} ${orderBy2.order ? orderBy2.order : 'asc'}`);
    if (orderBys.length > 0)
        fetchAPI += `&$orderby=${orderBys.join(',')}`;
    if (fieldNameTitle) {
        const fieldFilter = `Title eq '${fieldNameTitle}' or InternalName eq '${fieldNameTitle}'`;
        fetchAPI += `&$filter= ${fieldFilter}`;
    }
    else if (restFilter)
        fetchAPI += `&$filter= ${restFilter}`;
    const result = await doSpHttpFetchOrPostAndCheck(fetchAPI, 'GET', sourceProps.fpsSpService, '', alertMe, consoleLog, fieldNameTitle ? 'field' : 'fields', false, null);
    if (check4This(Check4.fpsShowFetchResults_Eq_true) === true) {
        console.log(`fps-core-v7 COMPLETE: getSourceFieldsAPI ~ 47`, result);
    }
    ;
    return result;
}
//# sourceMappingURL=getSourceFieldsAPI.js.map