@mikezimm/npmfunctions
Version:
Functions used in my SPFx webparts
195 lines (159 loc) • 10.8 kB
text/typescript
/***
* db d888888b .d8888. d888888b .d8888.
* 88 `88' 88' YP `~~88~~' 88' YP
* 88 88 `8bo. 88 `8bo.
* 88 88 `Y8b. 88 `Y8b.
* 88booo. .88. db 8D 88 db 8D
* Y88888P Y888888P `8888Y' YP `8888Y'
*
*
import { SystemLists, TempSysLists, TempContLists, entityMaps, EntityMapsNames }
from '@mikezimm/npmfunctions/dist/Lists/Constants';
import { IPickedWebBasic, IPickedList, IPickedView, IZBasicItemInfo, }
from '@mikezimm/npmfunctions/dist/Lists/IListInterfaces';
*/
/**
* Copied from Easy Constants for grouping "System Lists".
* Re-using in Pivot Tiles as well because it also has a setting to hide/show system lists.
* Technically SystemLists could be under List Types but that is more focused on interfaces and functions
* where as this is just a list of List Titles for easy use of filtering.
*
*/
/***
* db d8b db .d8b. d8888b. d8b db d888888b d8b db d888b db db db
* 88 I8I 88 d8' `8b 88 `8D 888o 88 `88' 888o 88 88' Y8b 88 88 88
* 88 I8I 88 88ooo88 88oobY' 88V8o 88 88 88V8o 88 88 YP YP YP
* Y8 I8I 88 88~~~88 88`8b 88 V8o88 88 88 V8o88 88 ooo
* `8b d8'8b d8' 88 88 88 `88. 88 V888 .88. 88 V888 88. ~8~ db db db
* `8b8' `8d8' YP YP 88 YD VP V8P Y888888P VP V8P Y888P YP YP YP
*
*
* WARNING ON Using SystemLists array:
* If you are using this entire array to build rest filter query, it will cause a 404 error because the length of the query string becomes to long.
* From trial and error, I found that 1500 charaters in the string for a short site URL did not throw an error. But due to unkowns, be cautious and maybe
* only include 1350 or less characters in the rest filter and manually filter out the rest.
* AS OF 2021-03-01 version (v0.0.0.25, 1500 characters means do not include anything starting with OData and beyond.)
*/
//2020-11-17: Copied from genericSolution listsFunctions.ts
//Usage: if ( SystemLists.indexOf(theList.EntityTypeName) > -1 ) { ... }
export const SystemLists = ["WorkflowTasks", "Style Library",
"Sharing Links", "Composed Looks", "Master Page Gallery",
"SitePages", "SiteAssets", "ReusableContent", "Pages", "SearchConfigList", "OData__catalogs/masterpage", "OData__catalogs/design",
"TeamSiteFooterQL1List", "TeamSiteFooterQL2List",
"SiteCollectionImages", "SiteCollectionDocuments", "FormServerTemplates", "Reports List", "PublishingImages",
"AEInspiredTilesItemsList", "AEInspiredTilesAssetsList", "PublishedFeedList", "Workflow TasksList", "AEGoalThermometerAssetsList", "AEMetroGridAssetsList", "AEMetroGridItemsList", "AEMetroGridPicLibList", "AESwipeGalleryAssetsList",
"AESwipeGalleryDefaultImagesList", "Workflows", "Workflow HistoryList", "OData__catalogs/fpdatasources", "IWConvertedForms", "Access Requests", "Style Library",
"PreservationHoldLibrary",
"OData__catalogs/appdata","OData__catalogs/appfiles","OData__catalogs/lt","OData__catalogs/solutions","OData__catalogs/theme","OData__catalogs/wp",
"CCSAdvancedApprovalLogList","CCSWFHistory_Common_ErrorLogsList","CrowCanyonAppsEmailsList","CrowCanyonMailTemplatesList","Send MailsList","CrowCanyonAppsLib","NITROUserPreferencesList",
"OData__catalogs/hubsite","OData__catalogs/MaintenanceLogs",
"Content and Structure Reports", //The static name for this is Reports List and because Reports could be normal list, I'm not going to filter for it.
"Apps for SharePoint", "AppCatalog",
//Added these 2021-11-01 after troubleshooting PivotTiles load error (aka hub search not working for me)
'Content type publishing error log','SharePointHomeCacheList','TaxonomyHiddenList','User Information List',
];
/**
* This is originally used in Easy Contents to get list of lists that were part of Template sites.
* They are grouped in the webpart with similar lists to keep them separate from what a user might create.
*/
export const TempSysLists = ["OurGroupsList", "OurTilesList", "TemplateHistoryList", "Template HistoryList",
"TemplateReferenceList", "AE KPI ListList", "PnpPanelList",
"SiteLaunchCheckListList", "EmailSettingsList", "YearView ConfigurationList", "SubscribeList","ProjectsList","TrackMyTimeList"
];
/**
* This is originally used in Easy Contents to get list of lists that were part of Template sites but are considered user content.
* They are grouped in the webpart with similar lists to keep them separate from what a user might create.
*/
export const TempContLists = ["ActionRegisterList", "AgendasList", "AutoOnBoardList", "BringOnBoardList", "BudgetDeptList", "BudgetFiles", "CalendarDocs", "CalendarList", "CustomerComplaints", "CustRequirements", "Deliverables", "DeskInstructions",
"Documents2", "Documents3", "Documents4", "Documents5", "Emails", "EventDocs", "EventsList", "FAQsList", "FinanceDocs2", "FinanceDocs3", "FinanceDocs4", "FinanceDocs5", "Itineraries", "LaunchThisSiteChecklistList", "ManufacturingRecords",
"Media", "OurForms", "OurOnBoardingList", "OurPNsList", "OurTasksList", "OurWiki", "PartTrackerList", "Performance", "PresentationLinksList", "Presentations", "ProcessProductionEquipment", "ProjectOverviewList", "QualityRecords",
"QualitySysReporting", "ReportFiles", "RequestsList", "RFQDocs2", "RFQDocs3", "RFQDocs4", "RFQDocs5", "SerialDocuments", "Shared Documents", "SiteLaunchCheckListList", "SuggestionsList", "TasksList", "TimelineList", "ToolTrackerList",
"TrainingRecords", "VehicleVolumesList",
"Smile1List", "Smile2List", "Smile3List", "Smile4List", "Smile5List", "Smile6List", "Smile7List", "Smile8List", "Smile9List", "Smile10List", "Smile11List", "Smile12List",
"Attachments00", "Attachments01", "Attachments02", "Attachments03", "Attachments04", "Attachments05", "Attachments06", "Attachments07", "Attachments08", "Attachments09",
"Attachments10", "Attachments11", "Attachments12", "LessonsLearned", "ReadAcrossList", "YokotensList",
"FilesYMCat","FilesYMCatU"
];
/**
* This is originally used in Easy Contents to get list of lists that were part of System List
* But also have a mapping to the URL since they didn't always match. especially ones that were buried as pages like ReusableContent.
*/
export const entityMaps = [
{ name: 'ReusableContent' , url: 'ReusableContent/Content Preview.aspx' },
{ name: 'Style Library', url: 'Style Library' },
{ name: 'MicroFeed', url: '/Lists/PublishedFeed/' },
{ name: 'Long Running Operation Status', url: 'Long Running Operation Status' },
{ name: 'Notification Pages', url: 'Notification Pages' },
{ name: 'UserInfo', url: '_layouts/15/people.aspx' },
{ name: 'Reports List', url: 'Reports List' },
{ name: 'DeviceChannels', url: 'Device Channels' },
{ name: 'Cache Profiles', url: 'Cache Profiles' },
{ name: 'ProjectPolicyItemList', url: 'ProjectPolicyItemList' },
{ name: 'Quick Deploy Items', url: 'Quick Deploy Items' },
{ name: 'Relationships List', url: 'Relationships List' },
{ name: 'SharePointHomeCacheListList', url: 'SharePointHomeCacheList' },
{ name: 'PublishedLinks', url: 'PublishedLinks' },
{ name: 'Translation Packages', url: 'Translation Packages' },
{ name: 'Translation Status', url: 'Translation Status' },
{ name: 'TaxonomyHiddenListList', url: 'Lists/TaxonomyHiddenList' },
{ name: 'Variation Labels', url: 'Variation Labels' },
{ name: 'IWConvertedForms', url: 'IWConvertedForms' },
{ name: 'FormServerTemplates', url: 'FormServerTemplates' },
{ name: 'Access Requests', url: 'Access Requests/pendingreq.aspx?mbypass=1' },
{ name: 'ClientSideAssets', url: 'ClientSideAssets' },
{ name: 'ComponentManifestsList', url: 'Lists/ComponentManifests' },
{ name: 'ContentTypeSyncLogList', url: 'Lists/ContentTypeSyncLog' },
{ name: 'SiteCollectionAppCatalogsList', url: 'SiteCollectionAppCatalogsList' },
{ name: 'WebApiPermissionRequestsList', url: 'WebApiPermissionRequestsList' },
{ name: 'AppRequests', url: 'AppRequests' },
{ name: 'AgaveCatalog', url: 'AgaveCatalog' },
{ name: 'AppCatalog', url: 'AppCatalog' },
{ name: 'TenantWideExtensionsList', url: 'Lists/TaxonomyHiddenList' },
{ name: 'PreservationHoldLibrary', url: 'PreservationHoldLibrary' },
{ name: '_catalogs/appdata', url: '_catalogs/appdata' },
{ name: '_catalogs/appfiles', url: '_catalogs/appfiles' },
{ name: '_catalogs/design', url: '_catalogs/design' },
{ name: '_catalogs/masterpage', url: '_catalogs/masterpage' },
{ name: '_catalogs/lt', url: '_catalogs/lt' },
{ name: '_catalogs/MaintenanceLogs', url: '_catalogs/MaintenanceLogs' },
{ name: '_catalogs/solutions', url: '_catalogs/solutions' },
{ name: '_catalogs/theme', url: '_catalogs/theme' },
{ name: '_catalogs/wp', url: '_catalogs/wp' },
{ name: '_catalogs/hubsite', url: '_catalogs/hubsite' },
{ name: '', url: '' },
{ name: '', url: '' },
{ name: 'CrowCanyonAppsLib', url: 'CrowCanyonAppsLib' },
{ name: 'NITROUserPreferences', url: 'NITROUserPreferencesList' },
{ name: '', url: '' },
{ name: '', url: '' },
{ name: '', url: '' },
{ name: '', url: '' },
{ name: '', url: '' },
];
export const EntityMapsNames = entityMaps.map( e => {
return e.name;
});
/**
* Originally created for https://github.com/mikezimm/pivottiles7/issues/66
*/
export const SystemPages = [
//Added for compatibility with: https://www.crowcanyon.com/nitro-studio/
'CCSBrandingSettings', 'CCSDisplayForm', 'CCSEditForm', 'CCSMSTeamsUtils', 'CCSNewForm',
'Workflow-Errors-Dashboard','Workflow-Logs-Dashboard',
];
export const SystemPagesLowerCase: string[] = [
//These are Nitro Studio system pages
'ccsbrandingsettings', 'ccsdisplayform', 'ccseditform', 'ccsmsteamsutils', 'ccsnewform',
'workflow-errors-dashboard','workflow-logs-dashboard',
];
export function isPageSystemPage( url: string ) {
let urlLC = url.toLowerCase();
let pageName = urlLC.replace('.aspx','').split('/sitepages/');
let isSystemPage = false;
if ( pageName.length > 1 ) {
if ( SystemPagesLowerCase.indexOf( pageName[1] ) > -1 ) { isSystemPage = true ; }
} else {
if ( SystemPagesLowerCase.indexOf( pageName[0] ) > -1 ) { isSystemPage = true ; }
}
return isSystemPage;
}