@kwiz/common 1.0.1

package/dist/utils/sharepoint.rest/list.d.ts

@@ -0,0 +1,228 @@
+import { BaseTypes, FieldTypeAsString, FieldTypes, GeListItemsFoldersBehaviour, IFieldInfo, IFieldInfoEX, IFieldInfoExHash, IFieldJsonSchema, IListWorkflowAssociation, IRestItem, ISPEventReceiver, ListExperienceOptions, ListTemplateTypes, PageType, SPBasePermissionKind, iContentType, iList, iListView, jsonTypes } from "../_dependencies";
+/** returns /_api/web/lists/getById() or /_api/web/lists/getByTitle() */
+export declare function GetListRestUrl(siteUrl: string, listIdOrTitle: string): string;
+export declare function GetListId(siteUrl: string, listIdOrTitle: string): string;
+/** get the list ID from a list page, such as a list view or an item form */
+export declare function GetListIdFromPageSync(siteUrl: string, listPageUrl: string): string;
+interface IGetSiteAssetLibraryResult {
+    Id: string;
+    Name: string;
+    ServerRelativeUrl: string;
+}
+/** ensures the site assets library exists and return its info. on errors - it will return null. */
+export declare function EnsureAssetLibrary(siteUrl: string): Promise<IGetSiteAssetLibraryResult>;
+export declare function GetSiteAssetLibrary(siteUrl: string, sync?: false): Promise<IGetSiteAssetLibraryResult>;
+export declare function GetSiteAssetLibrary(siteUrl: string, sync: true): IGetSiteAssetLibraryResult;
+/** Return the list Title */
+export declare function GetListTitle(siteUrl: string, listIdOrTitle: string): Promise<string>;
+/** Return the list */
+export declare function GetList(siteUrlOrId: string, listIdOrTitle: string, options?: {
+    includeViews?: boolean;
+    viewOptions?: IListViewOptions;
+    includeContentTypes?: boolean;
+    includeRootFolder?: boolean;
+    includeEventReceivers?: boolean;
+}): Promise<iList>;
+/** Return the list */
+export declare function GetListSync(siteUrl: string, listIdOrTitle: string): iList;
+export declare function GetListNameSync(webUrl: string, listIdOrTitle: string): string;
+export declare function GetListName(webUrl: string, listIdOrTitle: string): Promise<string>;
+export declare function GetListRootFolder(siteUrlOrId: string, listIdOrTitle: string): Promise<{
+    ServerRelativeUrl: string;
+    Name: string;
+}>;
+export declare function GetListRootFolderSync(siteUrlOrId: string, listIdOrTitle: string): {
+    ServerRelativeUrl: string;
+    Name: string;
+};
+export declare function GetListField(siteUrlOrId: string, listIdOrTitle: string, fieldIdOrName: string, refreshCache?: boolean): Promise<IFieldInfo>;
+/** Gets ID, Title, ContentType Author, Editor, Created and Modified fields */
+export declare function GetStandardListFields(siteUrlOrId: string, listIdOrTitle: string, refreshCache?: boolean): Promise<IFieldInfoEX[]>;
+export interface IGetListFieldsOptions {
+    refreshCache?: boolean;
+    /** fieldNames that should be returned with the request */
+    fieldNames?: string[];
+}
+export declare function GetListFields(siteUrlOrId: string, listIdOrTitle: string, options?: IGetListFieldsOptions): Promise<IFieldInfoEX[]>;
+export declare function GetListFieldsSync(siteUrlOrId: string, listIdOrTitle: string, options?: IGetListFieldsOptions): IFieldInfoEX[];
+export declare function GetListFieldsAsHash(siteUrlOrId: string, listIdOrTitle: string, refreshCache?: boolean): Promise<IFieldInfoExHash>;
+export declare function GetListFieldsAsHashSync(siteUrlOrId: string, listIdOrTitle: string, refreshCache?: boolean): IFieldInfoExHash;
+export declare function GetListWorkflows(siteUrl: string, listIdOrTitle: string, refreshCache?: boolean): Promise<IListWorkflowAssociation[]>;
+export declare function UserHasManagePermissions(siteUrl: string, listIdOrTitle: string): Promise<boolean>;
+export declare function UserHasEditPermissions(siteUrl: string, listIdOrTitle: string): Promise<boolean>;
+export declare function UserHasPermissions(siteUrlOrId: string, listIdOrTitle: string, permissionKind: SPBasePermissionKind): Promise<boolean>;
+export declare function UserHasPermissionsSync(siteUrlOrId: string, listIdOrTitle: string, permissionKind: SPBasePermissionKind): boolean;
+/** create a new column and try to add it to default view. Send either Title and Type, or SchemaXml. Create with SchemaXml also adds to all content types */
+export declare function CreateField(siteUrl: string, listIdOrTitle: string, options: {
+    Title?: string;
+    Type?: FieldTypes;
+    Required?: boolean;
+    SchemaXml?: string;
+    SchemaXmlSpecificInternalName?: boolean;
+    SkipAddToDefaultView?: boolean;
+    ClientSideComponentId?: string;
+    ClientSideComponentProperties?: string;
+}): Promise<IFieldInfoEX>;
+/** Update field SchemaXml OR Title, only 1 update at a time supported. */
+export declare function UpdateField(siteUrlOrId: string, listIdOrTitle: string, fieldInternalName: string, options: {
+    Title?: string;
+    SchemaXml?: string;
+    FieldType?: FieldTypeAsString;
+    Required?: boolean;
+    Hidden?: boolean;
+    ClientSideComponentId?: string;
+    ClientSideComponentProperties?: string;
+}): Promise<IFieldInfoEX>;
+export declare function DeleteField(siteUrl: string, listIdOrTitle: string, fieldInternalName: string, options?: {
+    DeleteHiddenField?: boolean;
+}): Promise<boolean>;
+export interface IListViewOptions {
+    includeViewFields?: boolean;
+}
+export declare function GetListViews(siteUrl: string, listIdOrTitle: string, options?: IListViewOptions): Promise<iListView[]>;
+export declare function GetListViewsSync(siteUrl: string, listIdOrTitle: string): iListView[];
+export declare function AddViewFieldToListView(siteUrl: string, listIdOrTitle: string, viewId: string, viewField: string): Promise<boolean>;
+export declare function GetListContentTypes(siteUrl: string, listIdOrTitle: string, options?: {
+    ignoreFolders?: boolean;
+    ignoreHidden?: boolean;
+    includeFields?: boolean;
+}): Promise<iContentType[]>;
+export declare function GetListContentTypesSync(siteUrl: string, listIdOrTitle: string, options?: {
+    ignoreFolders?: boolean;
+    ignoreHidden?: boolean;
+    includeFields?: boolean;
+}): iContentType[];
+/** generic version. for the KWIZ forms version that supports action id call GetListFormUrlAppsWeb instead */
+export declare function GetListFormUrl(siteUrl: string, listId: string, pageType: PageType, params?: {
+    contentTypeId?: string;
+    itemId?: number | string;
+}): string;
+export declare function GetFieldSchemaSync(siteUrl: string, listIdOrTitle: string, fieldInternalName: string, refreshCache?: boolean): IFieldJsonSchema;
+export declare function GetFieldSchema(siteUrl: string, listIdOrTitle: string, fieldInternalName: string, refreshCache?: boolean): Promise<IFieldJsonSchema>;
+export declare function GetListItems(siteUrl: string, listIdOrTitle: string, options: {
+    /** Optional, default: 1000. 0: get all items. */
+    rowLimit?: number;
+    /** Id, Title, Modified, FileLeafRef, FileDirRef, FileRef, FileSystemObjectType */
+    columns: (string | IFieldInfoEX)[];
+    foldersBehaviour?: GeListItemsFoldersBehaviour;
+    /** Optional, request to expand some columns. */
+    expand?: string[];
+    /** allow to change the jsonMetadata for this request, default: verbose */
+    jsonMetadata?: jsonTypes;
+    refreshCache?: boolean;
+    /** allow to send a filter statement */
+    $filter?: string;
+}): Promise<IRestItem[]>;
+export declare function GetListItemsSync(siteUrl: string, listIdOrTitle: string, options: {
+    /** Optional, default: 1000. 0: get all items. */
+    rowLimit?: number;
+    /** Id, Title, Modified, FileLeafRef, FileDirRef, FileRef, FileSystemObjectType */
+    columns: (string | IFieldInfoEX)[];
+    foldersBehaviour?: GeListItemsFoldersBehaviour;
+    /** Optional, request to expand some columns. */
+    expand?: string[];
+    /** allow to send a filter statement */
+    $filter?: string;
+}): IRestItem[];
+/** Find an item by id, even if it is nested in a sub-folder */
+export declare function FindListItemById(items: IRestItem[], itemId: number): IRestItem;
+export declare function GetListEventReceivers(siteUrl: string, listIdOrTitle: string, refreshCache?: boolean): Promise<ISPEventReceiver[]>;
+export declare function AddListEventReceiver(siteUrl: string, listIdOrTitle: string, eventReceiverDefinition: Pick<ISPEventReceiver, "EventType" | "ReceiverName" | "ReceiverUrl" | "SequenceNumber">): Promise<ISPEventReceiver>;
+export declare function DeleteListEventReceiver(siteUrl: string, listIdOrTitle: string, eventReceiverId: string): Promise<boolean>;
+/** timestamp of changes:
+ * - item updates
+ * - changes to columns
+ * - content types
+ * - list versioning settings
+ * - list title/description
+ * - content approval settings
+ * does not track:
+ * - Changes to views
+ * - changing list/items permissions
+ */
+export declare function GetListLastItemModifiedDate(siteUrl: string, listIdOrTitle: string, options: {
+    sync: true;
+    refreshCache?: boolean;
+    /** ignore system changes */
+    userChangesOnly?: boolean;
+}): string;
+/** timestamp of changes:
+ * - item updates
+ * - changes to columns
+ * - content types
+ * - list versioning settings
+ * - list title/description
+ * - content approval settings
+ * does not track:
+ * - Changes to views
+ * - changing list/items permissions
+ */
+export declare function GetListLastItemModifiedDate(siteUrl: string, listIdOrTitle: string, options?: {
+    sync?: false;
+    refreshCache?: boolean;
+    /** ignore system changes */
+    userChangesOnly?: boolean;
+}): Promise<string>;
+export declare function ReloadListLastModified(siteUrl: string, listIdOrTitle: string): Promise<void>;
+export declare function ListHasUniquePermissions(siteUrl: string, listIdOrTitle: string): Promise<boolean>;
+export declare function BreakListbPermissionInheritance(siteUrl: string, listIdOrTitle: string, clear?: boolean): Promise<void>;
+export declare function AssignListPermission(siteUrl: string, listIdOrTitle: string, principalId: number, roleId: number): Promise<void>;
+export declare function RemoveListPermission(siteUrl: string, listIdOrTitle: string, principalId: number, roleId: number): Promise<void>;
+interface iCreateListResult {
+    AllowContentTypes: boolean;
+    BaseTemplate: ListTemplateTypes;
+    BaseType: BaseTypes;
+    ContentTypesEnabled: boolean;
+    Created: string;
+    DefaultItemOpenUseListSetting: boolean;
+    Description: string;
+    DisableCommenting: boolean;
+    DisableGridEditing: boolean;
+    DocumentTemplateUrl: string;
+    DraftVersionVisibility: 0;
+    EnableAttachments: boolean;
+    EnableFolderCreation: boolean;
+    EnableMinorVersions: boolean;
+    EnableModeration: false;
+    EnableRequestSignOff: boolean;
+    EnableVersioning: boolean;
+    EntityTypeName: string;
+    ExemptFromBlockDownloadOfNonViewableFiles: boolean;
+    FileSavePostProcessingEnabled: boolean;
+    ForceCheckout: boolean;
+    HasExternalDataSource: boolean;
+    Hidden: boolean;
+    Id: string;
+    ImagePath: {
+        DecodedUrl: string;
+    };
+    ImageUrl: string;
+    IsApplicationList: boolean;
+    IsCatalog: boolean;
+    IsPrivate: boolean;
+    ItemCount: 0;
+    LastItemDeletedDate: string;
+    LastItemModifiedDate: string;
+    LastItemUserModifiedDate: string;
+    ListExperienceOptions: ListExperienceOptions;
+    ListItemEntityTypeFullName: string;
+    MajorVersionLimit: number;
+    MajorWithMinorVersionsLimit: number;
+    MultipleDataList: boolean;
+    NoCrawl: boolean;
+    ParentWebPath: {
+        DecodedUrl: string;
+    };
+    ParentWebUrl: string;
+    ParserDisabled: boolean;
+    ServerTemplateCanCreateFolders: boolean;
+    TemplateFeatureId: string;
+    Title: string;
+}
+export declare function CreateList(siteUrl: string, info: {
+    title: string;
+    description: string;
+    type: BaseTypes;
+    template: ListTemplateTypes;
+}): Promise<iCreateListResult>;
+export {};