@kwiz/common 1.0.2 → 1.0.3

package/src/utils/sharepoint.rest/listutils/GetListItemsById.ts

@@ -1,265 +0,0 @@
-import { IRestItem, chunkArray, getGlobal, isBoolean, isNotEmptyArray, isNullOrEmptyArray, isNullOrUndefined, isNumber, jsonClone, jsonTypes } from "../../_dependencies";
-import { GetJson, GetJsonSync } from "../../rest";
-import { GetListRestUrl } from "../list";
-
-let g_cache = getGlobal<{ getItemsByIdCache: { [cachekey: string]: IRestItem[]; }; }>("SharePoint_Rest_List_Cache", {
-    getItemsByIdCache: {}
-});
-
-/** return array will use the item ID as indexer, not a real array */
-export async function GetItemsById<T extends IRestItem>(siteUrl: string, listIdOrTitle: string, itemIds: number[], options?: {
-    expand?: string[];
-    select?: string[];
-    refreshCache?: boolean;
-    jsonMetadata?: jsonTypes;
-}) {
-    try {
-        let baseParams = _parseItemsByIdParams<T>(siteUrl, listIdOrTitle, itemIds, { ...options, batchRequests: itemIds.length > 1 });
-
-        const { results, allowCache, queue } = baseParams;
-        let cacheKey = baseParams.cacheKey;
-
-        if (options && !isNullOrUndefined(options.jsonMetadata)) {
-            cacheKey += "|jsonMetadata=" + options.jsonMetadata
-        }
-
-        if (queue.length > 0) {
-            let promises = queue.map(batchRequestUrl => {
-                return GetJson<tGetItemsByIdResult<T>>(batchRequestUrl, null, {
-                    //do not allow cache. modern forms have apply option which will need this to reload the item
-                    //it is cached in _restListItems anyways so this is not needed.
-                    allowCache: allowCache === true,
-                    includeDigestInGet: true,
-                    jsonMetadata: options && options.jsonMetadata
-                }).then(obj => {
-                    if (!isNullOrUndefined(obj)) {
-                        //no-metadata will return a value, as a single result or array
-                        //otherwise, it'll go into "d"
-                        let items: T[] = [];
-
-                        if (isNoMetaDataResult(obj)) {
-                            items = isNotEmptyArray(obj.value)
-                                ? obj.value
-                                : [obj.value];
-                        }
-                        else if (isVerboseResult(obj)) {
-                            items = Array.isArray(obj.d.results)
-                                ? obj.d.results
-                                : [obj.d];
-                        }
-                        else if (isSingleResult(obj)) {
-                            // Issue 1471: If only single item returns it not an array and just object
-                            items.push(obj);
-                        }
-
-                        items.forEach((restItem) => {
-                            results[Number(restItem.Id)] = restItem;
-                            _addCacheItem(cacheKey, restItem);
-                        });
-                    }
-                });
-            });
-
-            await Promise.all(promises);
-        }
-
-        return results;
-    } catch (e) {
-        throw new Error("Could not retrieve rest item from list");
-    }
-}
-
-export function GetItemsByIdSync<T extends IRestItem>(siteUrl: string, listIdOrTitle: string, itemIds: number[], options?: {
-    expand?: string[];
-    select?: string[];
-    refreshCache?: boolean;
-    jsonMetadata?: jsonTypes;
-}) {
-    try {
-        let baseParams = _parseItemsByIdParams<T>(siteUrl, listIdOrTitle, itemIds, { ...options, batchRequests: itemIds.length > 1 });
-
-        const { results, allowCache, queue } = baseParams;
-        let cacheKey = baseParams.cacheKey;
-
-        if (options && !isNullOrUndefined(options.jsonMetadata)) {
-            cacheKey += "|jsonMetadata=" + options.jsonMetadata
-        }
-
-        if (queue.length > 0) {
-            queue.forEach((batchRequestUrl) => {
-                let response = GetJsonSync<tGetItemsByIdResult<T>>(batchRequestUrl, null, {
-                    //do not allow cache. modern forms have apply option which will need this to reload the item
-                    //it is cached in _restListItems anyways so this is not needed.
-                    allowCache: allowCache === true,
-                    includeDigestInGet: true,
-                    jsonMetadata: options && options.jsonMetadata
-                });
-
-                if (response && response.success && response.result) {
-                    //no-metadata will return a value, as a single result or array
-                    //otherwise, it'll go into "d"
-                    let items: T[] = [];
-                    if (isNoMetaDataResult(response.result)) {
-                        items = isNotEmptyArray(response.result.value)
-                            ? response.result.value
-                            : [response.result.value];
-                    }
-                    else if (isVerboseResult(response.result)) {
-                        items = Array.isArray(response.result.d.results)
-                            ? response.result.d.results
-                            : [response.result.d];
-                    }
-                    else if (isSingleResult(response.result)) {
-                        // Issue 1471: If only single item returns it not an array and just object
-                        items.push(response.result);
-                    }
-
-                    items.forEach((restItem) => {
-                        results[Number(restItem.Id)] = restItem;
-                        _addCacheItem(cacheKey, restItem);
-                    });
-                }
-            });
-        }
-
-        return results;
-    } catch (e) {
-        throw new Error("Could not retrieve rest item from list");
-    }
-}
-
-function _addCacheItem<T extends IRestItem>(cacheKey: string, item: T) {
-    if (isNullOrUndefined(g_cache.getItemsByIdCache[cacheKey])) {
-        g_cache.getItemsByIdCache[cacheKey] = [];
-    }
-    g_cache.getItemsByIdCache[cacheKey][item.Id] = jsonClone(item);
-}
-
-function _getCacheItem<T extends IRestItem>(cacheKey: string, itemId: number) {
-    if (isNullOrUndefined(g_cache.getItemsByIdCache[cacheKey])) {
-        g_cache.getItemsByIdCache[cacheKey] = [];
-    }
-
-    if (!isNullOrUndefined(g_cache.getItemsByIdCache[cacheKey][Number(itemId)])) {
-        return jsonClone(g_cache.getItemsByIdCache[cacheKey][Number(itemId)]) as T;
-    }
-
-    return null;
-}
-
-function _refreshCache(cacheKey: string) {
-    g_cache.getItemsByIdCache[cacheKey] = [];
-}
-
-function _getItemsByIdBaseUrl(siteUrl: string, listIdOrTitle: string) {
-    return `${GetListRestUrl(siteUrl, listIdOrTitle)}/items`;
-}
-
-function _parseItemsByIdParams<T extends IRestItem>(siteUrl: string, listIdOrTitle: string, itemIds: number[], options?: {
-    expand?: string[];
-    select?: string[];
-    refreshCache?: boolean;
-    batchRequests?: boolean;
-}) {
-    let baseUrl = _getItemsByIdBaseUrl(siteUrl, listIdOrTitle);
-
-    let expand: string[] = [];
-    let select: string[] = [];
-    let allowCache = true;
-    let results: T[] = [];
-    let queue: string[] = [];
-
-    if (!isNullOrUndefined(options)) {
-        if (!isNullOrEmptyArray(options.select)) {
-            select = options.select.sort();
-        }
-
-        if (!isNullOrEmptyArray(options.expand)) {
-            expand = options.expand.sort();
-        }
-
-        if (isBoolean(options.refreshCache)) {
-            allowCache = options.refreshCache !== true;
-        }
-    }
-
-    let cacheKey = [baseUrl, select.join(",").toLowerCase(), expand.join(",").toLowerCase()].join("|");
-
-    if (allowCache === true) {
-        itemIds.forEach((itemId) => {
-            let cachedItem = _getCacheItem<T>(cacheKey, itemId);
-            if (!isNullOrUndefined(cachedItem)) {
-                results[itemId] = cachedItem;
-            }
-        });
-    } else {
-        _refreshCache(cacheKey);
-    }
-
-    //remove item ids that were retrieved from cache
-    itemIds = itemIds.filter((itemId) => {
-        return !results.some((result) => {
-            return Number(itemId) === Number(result.Id);
-        });
-    });
-
-    if (itemIds.length !== 0) {
-        let selectExpand: string[] = [];
-
-        if (select.length) {
-            selectExpand.push(`$select=${select.join(",")}`);
-        }
-        if (expand.length) {
-            selectExpand.push(`$expand=${expand.join(",")}`);
-        }
-
-        let selectExpandQS = selectExpand.join("&");
-
-        if (options.batchRequests === false) {
-            itemIds.forEach((itemId) => {
-                let getItemsRequestUrl = `${baseUrl}(${itemId})?${selectExpandQS}`;
-                queue.push(getItemsRequestUrl);
-            });
-        } else {
-            let chunks = chunkArray(itemIds, 60);
-            for (var chunkIndex = 0; chunkIndex < chunks.length; chunkIndex++) {
-                let chunk = chunks[chunkIndex];
-
-                let filter = chunk.map((id) => {
-                    return `(ID eq ${id})`;
-                }).join("or");
-
-                let getItemsRequestUrl = `${baseUrl}?${[`$filter=${filter}`, selectExpandQS].join("&")}`;
-                queue.push(getItemsRequestUrl);
-            }
-        }
-    }
-
-    return {
-        results: results,
-        allowCache: allowCache,
-        queue: queue,
-        cacheKey: cacheKey
-    };
-}
-
-type tGetItemsByIdResult_Single<T> = T;
-type tGetItemsByIdResult_Verbose<T> = {
-    d: T | {
-        results: T[];
-    }
-}
-type tGetItemsByIdResult_NoMetadata<T> = {
-    value: T | T[]
-}
-type tGetItemsByIdResult<T> = tGetItemsByIdResult_Single<T> | tGetItemsByIdResult_Verbose<T> | tGetItemsByIdResult_NoMetadata<T>;
-
-function isVerboseResult<T extends IRestItem>(result: tGetItemsByIdResult<T>): result is tGetItemsByIdResult_Verbose<T> {
-    return !isNullOrUndefined((result as tGetItemsByIdResult_Verbose<T>).d);
-}
-function isNoMetaDataResult<T extends IRestItem>(result: tGetItemsByIdResult<T>): result is tGetItemsByIdResult_NoMetadata<T> {
-    return !isNullOrUndefined((result as tGetItemsByIdResult_NoMetadata<T>).value);
-}
-function isSingleResult<T extends IRestItem>(result: tGetItemsByIdResult<T>): result is tGetItemsByIdResult_Single<T> {
-    return isNumber((result as tGetItemsByIdResult_Single<T>).Id);
-}

package/src/utils/sharepoint.rest/listutils/common.ts

@@ -1,202 +0,0 @@
-import { FileSystemObjectTypes, GeListItemsFoldersBehaviour, IDictionary, IFieldInfoEX, IFieldLookupInfo, IRestItem, isNotEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, jsonTypes, lastIndexOf, toHash } from "../../_dependencies";
-import { ConsoleLogger } from "../../consolelogger";
-import { DecodeFieldValuesAsTextKey, GetFieldNameFromRawValues } from "../common";
-import { GetItemsByIdSync } from "./GetListItemsById";
-
-const logger = ConsoleLogger.get("sharepoint.rest/list/common");
-
-export function __fixGetListItemsResults(siteUrl: string, listIdOrTitle: string, items: IRestItem[], foldersBehaviour?: GeListItemsFoldersBehaviour, expandedLookupFields?: IFieldInfoEX[]): IRestItem[] {
-    let folders: { [folderPath: string]: IRestItem; } = {};
-
-    let itemFileRefMap: IDictionary<{ FileRef: string; FileSystemObjectType: FileSystemObjectTypes }> = {};
-    if (isNotEmptyArray(items) && isNullOrUndefined(items[0].FileRef)) {
-        //customer support ticket - request was missing teh FileRef column!
-        let additionalItems = GetItemsByIdSync(siteUrl, listIdOrTitle, items.map(i => i.Id), {
-            select: ["Id", "FileRef", "FileSystemObjectType"],
-            jsonMetadata: jsonTypes.nometadata
-        });
-        itemFileRefMap = toHash(additionalItems, i => i.Id.toString(10));
-    }
-
-    items.forEach(item => {
-        try {
-            if (itemFileRefMap[item.Id]) {
-                let mappedValue = itemFileRefMap[item.Id];
-                item.FileRef = mappedValue.FileRef;
-                item.FileSystemObjectType = mappedValue.FileSystemObjectType;
-            }
-
-            let fileRef = item.FileRef as string || "";
-            let parts = fileRef.split('/');
-            item.FileLeafRef = parts.pop() || "";
-            item.FileDirRef = parts.join('/');
-            item.FileOrFolderName = item.FileLeafRef.split('.')[0];
-
-            if (item.FileSystemObjectType === 1) {
-                item.FileType = "folder";
-                item.__Items = [];
-                folders[fileRef.toLowerCase()] = item;
-                item.__DisplayTitle = item.FileLeafRef;
-            }
-            else {
-                //issue 8094 file name might have multiple dots
-                let splitDot = item.FileLeafRef.split('.');
-                item.FileType = splitDot.length > 1 ? splitDot.pop().toLowerCase() : "folder";
-                item.__DisplayTitle = splitDot.join('.');
-                if (item.FileType === '000') {
-                    item.FileType = 'listitem';
-                    item.__DisplayTitle = item.Title;
-                    if (isNullOrEmptyString(item.__DisplayTitle))
-                        item.__DisplayTitle = `Item #${item.Id}`;
-                }
-            }
-
-            if (isNotEmptyArray(expandedLookupFields))
-                expandedLookupFields.forEach((f: IFieldLookupInfo) => {
-                    //ISSUE: 1519
-                    let lookupField = f.LookupField;
-
-                    //ISSUE: 1250 - expanded lookup fields with names that start with '_'
-                    //will be returned as OData__name. We have to use the field name returned
-                    //from GetFieldNameFromRawValues without the 'Id' appended to the name because
-                    //the value has been expanded.
-                    let fieldInternalName = f.InternalName;
-                    let rawValue = item[f.InternalName];
-                    if (isNullOrUndefined(rawValue)) {
-                        fieldInternalName = GetFieldNameFromRawValues(f, {
-                            excludeIdFromName: true
-                        });
-
-                        rawValue = item[fieldInternalName];
-                    }
-
-                    if (rawValue) {
-                        item.FieldValuesAsText = item.FieldValuesAsText || {};
-
-                        let value: { Id: number; Title: string;[InternalName: string]: any } | { Id: number; Title: string;[InternalName: string]: any }[] = rawValue;
-                        if (Array.isArray(value))//multi value
-                        {
-                            let id: number[] = [];
-                            let text: string[] = [];
-                            value.forEach(v => {
-                                id.push(v.Id);
-                                if (!isNullOrEmptyString(lookupField) && !isNullOrUndefined(v[lookupField])) {
-                                    text.push(v[lookupField]);
-                                } else {
-                                    text.push(v.Title);
-                                }
-                            });
-                            item[`${fieldInternalName}Id`] = id;
-                            item.FieldValuesAsText[DecodeFieldValuesAsTextKey(fieldInternalName)] = text.join(", ");
-                        }
-                        else if (isNumber(value && value.Id)) {
-                            item[`${fieldInternalName}Id`] = value.Id;
-                            //ISSUE: 1519 - condition to check if lookup field exists and get the value from the rawValue object by string index of lookup field key
-                            if (!isNullOrEmptyString(lookupField) && !isNullOrUndefined(value[lookupField])) {
-                                item.FieldValuesAsText[DecodeFieldValuesAsTextKey(fieldInternalName)] = value[lookupField];
-                            } else {
-                                item.FieldValuesAsText[DecodeFieldValuesAsTextKey(fieldInternalName)] = value.Title;
-                            }
-                        }
-                    }
-                });
-        } catch (e) {
-            logger.error(`Failed to fix list item result ${item && item.Id || 'unknown id'}`);
-        }
-    });
-
-    //loop through items, put them inside folders
-    let itemsInRoot: IRestItem[] = [];
-    items.forEach(item => {
-        let parentFolder = folders[item.FileDirRef.toLowerCase()];
-        if (!isNullOrUndefined(parentFolder)) {
-
-            if (item.FileSystemObjectType === FileSystemObjectTypes.Folder) {
-                //add it before any items, so we have folders first (sorted) and items after
-                let indexOfLastFolder = lastIndexOf(parentFolder.__Items, i => i.FileSystemObjectType === FileSystemObjectTypes.Folder);
-                parentFolder.__Items.splice(indexOfLastFolder + 1, 0, item);
-            } else
-                parentFolder.__Items.push(item);
-            item.__ParentFolder = parentFolder;
-        }
-        else itemsInRoot.push(item);
-    });
-
-    switch (foldersBehaviour) {
-        case GeListItemsFoldersBehaviour.AllItemsNoFolders:
-            return items.filter(r => r.FileSystemObjectType !== 1);
-        case GeListItemsFoldersBehaviour.ItemsInsideFolders:
-            return itemsInRoot;
-        case GeListItemsFoldersBehaviour.ItemsAndFoldersFlat:
-        default:
-            return items;
-    }
-}
-
-export var SkipFields: string[] = [
-    "appauthor",
-    "appeditor",
-    "linktitle",
-    "linktitlenomenu",
-    "linkfilename",
-    "linkfilenamenomenu",
-    "_copysource",
-    "_complianceflags",
-    "_compliancetag",
-    "_compliancetagwrittentime",
-    "_compliancetaguserid",
-    "_isrecord",
-    //issue 5576: allow user to see version column "_uiversionstring",
-    "itemchildcount",
-    "folderchildcount",
-    "complianceassetid",
-    "xd_progid",
-    "xd_signature",
-    "_shortcuturl",
-    "_shortcutsiteid",
-    "_shortcutwebid",
-    "_shortcutuniqueid",
-    "_hascopydestinations",
-    "sortbehavior",
-    "permmask",
-    "syncclientid",
-    "progid",
-    "scopeid",
-    "virusstatus",
-    "_editmenutablestart",
-    "_editmenutablestart2",
-    "_editmenutableend",
-    "linkfilename2",
-    "basename",
-    "metainfo",
-    "_level",
-    "_iscurrentversion",
-    "originatorid",
-    "noexecute",
-    "bsn",
-    "_listschemaversion",
-    "_dirty",
-    "_parsable",
-    "_stubfile",
-    "_virusstatus",
-    "_virusvendorid",
-    "_virusinfo",
-    "_rmstemplateid",
-    "_iplabelid",
-    "_displayname",
-    "smtotalsize",
-    "smlastmodifieddate",
-    "smtotalfilestreamsize",
-    "smtotalfilecount",
-    "selecttitle",
-    "selectfilename",
-    "edit",
-    "workflowversion",
-    "workflowinstanceid",
-    "parentversionstring",
-    "parentleafname",
-    "docconcurrencynumber",
-    "parentuniqueid",
-    "streamhash",
-    "combine",
-    "repairdocument"];