@pnp/sp 2.7.0 → 2.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +25 -25
- package/appcatalog/index.d.ts +8 -8
- package/appcatalog/index.js +30 -30
- package/appcatalog/types.d.ts +81 -81
- package/appcatalog/types.js +177 -177
- package/appcatalog/web.d.ts +16 -16
- package/appcatalog/web.js +6 -6
- package/attachments/index.d.ts +2 -2
- package/attachments/index.js +2 -2
- package/attachments/item.d.ts +12 -12
- package/attachments/item.js +4 -4
- package/attachments/types.d.ts +92 -92
- package/attachments/types.js +240 -240
- package/batch.d.ts +17 -17
- package/batch.js +223 -223
- package/batch.js.map +1 -1
- package/clientside-pages/funcs.d.ts +22 -22
- package/clientside-pages/funcs.js +25 -25
- package/clientside-pages/index.d.ts +2 -2
- package/clientside-pages/index.js +2 -2
- package/clientside-pages/types.d.ts +496 -494
- package/clientside-pages/types.d.ts.map +1 -1
- package/clientside-pages/types.js +1496 -1485
- package/clientside-pages/types.js.map +1 -1
- package/clientside-pages/web.d.ts +41 -41
- package/clientside-pages/web.js +57 -57
- package/column-defaults/folder.d.ts +27 -27
- package/column-defaults/folder.js +82 -82
- package/column-defaults/index.d.ts +3 -3
- package/column-defaults/index.js +2 -2
- package/column-defaults/list.d.ts +19 -19
- package/column-defaults/list.js +198 -198
- package/column-defaults/types.d.ts +21 -21
- package/column-defaults/types.js +1 -1
- package/comments/clientside-page.d.ts +57 -57
- package/comments/clientside-page.d.ts.map +1 -1
- package/comments/clientside-page.js +136 -136
- package/comments/index.d.ts +2 -2
- package/comments/index.js +2 -2
- package/comments/item.d.ts +29 -29
- package/comments/item.js +47 -47
- package/comments/types.d.ts +107 -107
- package/comments/types.d.ts.map +1 -1
- package/comments/types.js +145 -145
- package/comments/types.js.map +1 -1
- package/content-types/index.d.ts +4 -4
- package/content-types/index.js +4 -4
- package/content-types/item.d.ts +12 -12
- package/content-types/item.js +4 -4
- package/content-types/list.d.ts +12 -12
- package/content-types/list.js +4 -4
- package/content-types/types.d.ts +107 -107
- package/content-types/types.js +166 -166
- package/content-types/web.d.ts +12 -12
- package/content-types/web.js +4 -4
- package/decorators.d.ts +11 -11
- package/decorators.js +28 -28
- package/features/index.d.ts +3 -3
- package/features/index.js +3 -3
- package/features/site.d.ts +12 -12
- package/features/site.js +4 -4
- package/features/types.d.ts +47 -47
- package/features/types.js +109 -109
- package/features/web.d.ts +12 -12
- package/features/web.js +4 -4
- package/fields/index.d.ts +4 -4
- package/fields/index.js +4 -4
- package/fields/list.d.ts +12 -12
- package/fields/list.js +4 -4
- package/fields/types.d.ts +368 -361
- package/fields/types.d.ts.map +1 -1
- package/fields/types.js +624 -609
- package/fields/types.js.map +1 -1
- package/fields/web.d.ts +17 -17
- package/fields/web.js +5 -5
- package/files/folder.d.ts +12 -12
- package/files/folder.js +4 -4
- package/files/index.d.ts +4 -4
- package/files/index.js +4 -4
- package/files/item.d.ts +12 -12
- package/files/item.js +4 -4
- package/files/types.d.ts +421 -421
- package/files/types.js +853 -853
- package/files/types.js.map +1 -1
- package/files/web.d.ts +35 -35
- package/files/web.js +15 -15
- package/folders/index.d.ts +4 -4
- package/folders/index.js +4 -4
- package/folders/item.d.ts +9 -9
- package/folders/item.js +4 -4
- package/folders/list.d.ts +12 -12
- package/folders/list.js +4 -4
- package/folders/types.d.ts +207 -207
- package/folders/types.js +433 -433
- package/folders/types.js.map +1 -1
- package/folders/web.d.ts +39 -39
- package/folders/web.js +15 -15
- package/forms/index.d.ts +2 -2
- package/forms/index.js +2 -2
- package/forms/list.d.ts +9 -9
- package/forms/list.js +4 -4
- package/forms/types.d.ts +35 -35
- package/forms/types.js +41 -41
- package/hubsites/index.d.ts +12 -12
- package/hubsites/index.js +15 -15
- package/hubsites/site.d.ts +26 -26
- package/hubsites/site.js +39 -39
- package/hubsites/types.d.ts +55 -55
- package/hubsites/types.js +53 -53
- package/hubsites/web.d.ts +21 -21
- package/hubsites/web.js +23 -23
- package/index.d.ts +14 -14
- package/index.js +13 -13
- package/items/index.d.ts +2 -2
- package/items/index.js +2 -2
- package/items/list.d.ts +9 -9
- package/items/list.js +4 -4
- package/items/types.d.ts +226 -219
- package/items/types.d.ts.map +1 -1
- package/items/types.js +549 -511
- package/items/types.js.map +1 -1
- package/lists/index.d.ts +2 -2
- package/lists/index.js +2 -2
- package/lists/types.d.ts +495 -495
- package/lists/types.js +522 -522
- package/lists/types.js.map +1 -1
- package/lists/web.d.ts +43 -43
- package/lists/web.js +27 -27
- package/navigation/index.d.ts +8 -8
- package/navigation/index.js +14 -14
- package/navigation/types.d.ts +154 -154
- package/navigation/types.js +219 -219
- package/navigation/web.d.ts +13 -13
- package/navigation/web.js +4 -4
- package/odata.d.ts +5 -5
- package/odata.js +90 -90
- package/odata.js.map +1 -1
- package/operations.d.ts +9 -9
- package/operations.js +63 -63
- package/package.json +4 -4
- package/presets/all.d.ts +72 -72
- package/presets/all.js +72 -72
- package/presets/core.d.ts +11 -11
- package/presets/core.js +11 -11
- package/profiles/index.d.ts +7 -7
- package/profiles/index.js +13 -13
- package/profiles/types.d.ts +357 -357
- package/profiles/types.js +454 -454
- package/readme.md +21 -21
- package/regional-settings/content-type.d.ts +7 -7
- package/regional-settings/content-type.js +4 -4
- package/regional-settings/field.d.ts +7 -7
- package/regional-settings/field.js +4 -4
- package/regional-settings/funcs.d.ts +2 -2
- package/regional-settings/funcs.js +8 -8
- package/regional-settings/index.d.ts +6 -6
- package/regional-settings/index.js +6 -6
- package/regional-settings/list.d.ts +7 -7
- package/regional-settings/list.js +4 -4
- package/regional-settings/types.d.ts +111 -111
- package/regional-settings/types.js +159 -159
- package/regional-settings/user-custom-actions.d.ts +7 -7
- package/regional-settings/user-custom-actions.js +4 -4
- package/regional-settings/web.d.ts +12 -12
- package/regional-settings/web.js +7 -7
- package/related-items/index.d.ts +1 -1
- package/related-items/index.js +1 -1
- package/related-items/types.d.ts +76 -76
- package/related-items/types.js +103 -103
- package/related-items/web.d.ts +12 -12
- package/related-items/web.js +9 -9
- package/rest.d.ts +44 -44
- package/rest.js +72 -72
- package/search/index.d.ts +30 -30
- package/search/index.js +25 -25
- package/search/query.d.ts +62 -62
- package/search/query.js +302 -302
- package/search/suggest.d.ts +76 -76
- package/search/suggest.js +66 -66
- package/search/types.d.ts +426 -426
- package/search/types.js +57 -57
- package/security/funcs.d.ts +43 -43
- package/security/funcs.js +142 -142
- package/security/index.d.ts +4 -4
- package/security/index.js +4 -4
- package/security/item.d.ts +7 -7
- package/security/item.js +14 -14
- package/security/list.d.ts +7 -7
- package/security/list.js +14 -14
- package/security/types.d.ts +318 -318
- package/security/types.js +399 -399
- package/security/web.d.ts +9 -9
- package/security/web.js +15 -15
- package/sharepointqueryable.d.ts +135 -135
- package/sharepointqueryable.js +265 -265
- package/sharing/file.d.ts +18 -18
- package/sharing/file.d.ts.map +1 -1
- package/sharing/file.js +116 -15
- package/sharing/file.js.map +1 -1
- package/sharing/folder.d.ts +9 -9
- package/sharing/folder.js +136 -136
- package/sharing/funcs.d.ts +62 -62
- package/sharing/funcs.js +239 -239
- package/sharing/funcs.js.map +1 -1
- package/sharing/index.d.ts +5 -5
- package/sharing/index.js +5 -5
- package/sharing/item.d.ts +16 -16
- package/sharing/item.js +15 -15
- package/sharing/types.d.ts +583 -583
- package/sharing/types.js +113 -113
- package/sharing/web.d.ts +19 -19
- package/sharing/web.js +76 -76
- package/site-designs/index.d.ts +8 -8
- package/site-designs/index.js +14 -14
- package/site-designs/types.d.ts +319 -319
- package/site-designs/types.js +203 -203
- package/site-designs/web.d.ts +25 -25
- package/site-designs/web.js +11 -11
- package/site-groups/index.d.ts +2 -2
- package/site-groups/index.js +2 -2
- package/site-groups/types.d.ts +89 -89
- package/site-groups/types.js +125 -125
- package/site-groups/web.d.ts +40 -40
- package/site-groups/web.js +30 -30
- package/site-scripts/index.d.ts +9 -9
- package/site-scripts/index.js +15 -15
- package/site-scripts/list.d.ts +12 -12
- package/site-scripts/list.js +24 -24
- package/site-scripts/types.d.ts +183 -183
- package/site-scripts/types.js +141 -141
- package/site-scripts/web.d.ts +13 -13
- package/site-scripts/web.js +5 -5
- package/site-users/index.d.ts +2 -2
- package/site-users/index.js +2 -2
- package/site-users/types.d.ts +138 -138
- package/site-users/types.js +122 -122
- package/site-users/web.d.ts +31 -31
- package/site-users/web.js +27 -27
- package/sites/index.d.ts +7 -7
- package/sites/index.js +13 -13
- package/sites/types.d.ts +147 -147
- package/sites/types.js +321 -321
- package/social/index.d.ts +10 -10
- package/social/index.js +13 -13
- package/social/types.d.ts +309 -309
- package/social/types.js +322 -322
- package/sphttpclient.d.ts +18 -18
- package/sphttpclient.js +189 -189
- package/splibconfig.d.ts +22 -22
- package/splibconfig.js +13 -13
- package/sputilities/index.d.ts +7 -7
- package/sputilities/index.js +13 -13
- package/sputilities/types.d.ts +130 -130
- package/sputilities/types.js +118 -118
- package/subscriptions/index.d.ts +2 -2
- package/subscriptions/index.js +2 -2
- package/subscriptions/list.d.ts +13 -13
- package/subscriptions/list.js +4 -4
- package/subscriptions/types.d.ts +54 -54
- package/subscriptions/types.js +111 -111
- package/taxonomy/index.d.ts +7 -7
- package/taxonomy/index.js +13 -13
- package/taxonomy/types.d.ts +200 -200
- package/taxonomy/types.js +347 -347
- package/taxonomy/types.js.map +1 -1
- package/telemetry.d.ts +12 -12
- package/telemetry.js +48 -48
- package/types.d.ts +218 -218
- package/types.js +79 -79
- package/user-custom-actions/index.d.ts +4 -4
- package/user-custom-actions/index.js +4 -4
- package/user-custom-actions/list.d.ts +12 -12
- package/user-custom-actions/list.js +4 -4
- package/user-custom-actions/site.d.ts +12 -12
- package/user-custom-actions/site.js +4 -4
- package/user-custom-actions/types.d.ts +82 -82
- package/user-custom-actions/types.js +93 -93
- package/user-custom-actions/web.d.ts +15 -15
- package/user-custom-actions/web.js +4 -4
- package/utils/escapeQueryStrValue.d.ts +1 -1
- package/utils/escapeQueryStrValue.js +19 -19
- package/utils/extractweburl.d.ts +1 -1
- package/utils/extractweburl.js +15 -15
- package/utils/file-names.d.ts +17 -17
- package/utils/file-names.js +38 -38
- package/utils/metadata.d.ts +5 -5
- package/utils/metadata.js +5 -5
- package/utils/objectToSPKeyValueCollection.d.ts +20 -20
- package/utils/objectToSPKeyValueCollection.js +16 -16
- package/utils/toResourcePath.d.ts +7 -7
- package/utils/toResourcePath.js +6 -6
- package/utils/toabsoluteurl.d.ts +7 -7
- package/utils/toabsoluteurl.js +61 -61
- package/views/index.d.ts +2 -2
- package/views/index.js +2 -2
- package/views/list.d.ts +23 -23
- package/views/list.js +8 -8
- package/views/types.d.ts +140 -140
- package/views/types.js +184 -184
- package/webparts/file.d.ts +15 -15
- package/webparts/file.js +6 -6
- package/webparts/index.d.ts +2 -2
- package/webparts/index.js +2 -2
- package/webparts/types.d.ts +83 -83
- package/webparts/types.js +117 -117
- package/webs/index.d.ts +16 -16
- package/webs/index.js +16 -16
- package/webs/types.d.ts +210 -210
- package/webs/types.js +295 -295
package/security/web.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { IRoleDefinitions, ISecurableMethods } from "./types.js";
|
|
2
|
-
declare module "../webs/types" {
|
|
3
|
-
interface _Web extends ISecurableMethods {
|
|
4
|
-
roleDefinitions: IRoleDefinitions;
|
|
5
|
-
}
|
|
6
|
-
interface IWeb extends ISecurableMethods {
|
|
7
|
-
roleDefinitions: IRoleDefinitions;
|
|
8
|
-
}
|
|
9
|
-
}
|
|
1
|
+
import { IRoleDefinitions, ISecurableMethods } from "./types.js";
|
|
2
|
+
declare module "../webs/types" {
|
|
3
|
+
interface _Web extends ISecurableMethods {
|
|
4
|
+
roleDefinitions: IRoleDefinitions;
|
|
5
|
+
}
|
|
6
|
+
interface IWeb extends ISecurableMethods {
|
|
7
|
+
roleDefinitions: IRoleDefinitions;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
10
|
//# sourceMappingURL=web.d.ts.map
|
package/security/web.js
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { addProp } from "@pnp/odata";
|
|
2
|
-
import { _Web } from "../webs/types.js";
|
|
3
|
-
import { RoleDefinitions, RoleAssignments } from "./types.js";
|
|
4
|
-
import { SharePointQueryableInstance } from "../sharepointqueryable.js";
|
|
5
|
-
import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
|
|
6
|
-
addProp(_Web, "roleDefinitions", RoleDefinitions);
|
|
7
|
-
addProp(_Web, "roleAssignments", RoleAssignments);
|
|
8
|
-
addProp(_Web, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
|
|
9
|
-
_Web.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
|
|
10
|
-
_Web.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
|
|
11
|
-
_Web.prototype.breakRoleInheritance = breakRoleInheritance;
|
|
12
|
-
_Web.prototype.resetRoleInheritance = resetRoleInheritance;
|
|
13
|
-
_Web.prototype.userHasPermissions = userHasPermissions;
|
|
14
|
-
_Web.prototype.currentUserHasPermissions = currentUserHasPermissions;
|
|
15
|
-
_Web.prototype.hasPermissions = hasPermissions;
|
|
1
|
+
import { addProp } from "@pnp/odata";
|
|
2
|
+
import { _Web } from "../webs/types.js";
|
|
3
|
+
import { RoleDefinitions, RoleAssignments } from "./types.js";
|
|
4
|
+
import { SharePointQueryableInstance } from "../sharepointqueryable.js";
|
|
5
|
+
import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
|
|
6
|
+
addProp(_Web, "roleDefinitions", RoleDefinitions);
|
|
7
|
+
addProp(_Web, "roleAssignments", RoleAssignments);
|
|
8
|
+
addProp(_Web, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
|
|
9
|
+
_Web.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
|
|
10
|
+
_Web.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
|
|
11
|
+
_Web.prototype.breakRoleInheritance = breakRoleInheritance;
|
|
12
|
+
_Web.prototype.resetRoleInheritance = resetRoleInheritance;
|
|
13
|
+
_Web.prototype.userHasPermissions = userHasPermissions;
|
|
14
|
+
_Web.prototype.currentUserHasPermissions = currentUserHasPermissions;
|
|
15
|
+
_Web.prototype.hasPermissions = hasPermissions;
|
|
16
16
|
//# sourceMappingURL=web.js.map
|
package/sharepointqueryable.d.ts
CHANGED
|
@@ -1,136 +1,136 @@
|
|
|
1
|
-
import { IFetchOptions } from "@pnp/common";
|
|
2
|
-
import { Queryable, IInvokable, IRequestContext } from "@pnp/odata";
|
|
3
|
-
import { SPBatch } from "./batch.js";
|
|
4
|
-
export interface ISharePointQueryableConstructor<T extends ISharePointQueryable = ISharePointQueryable> {
|
|
5
|
-
new (baseUrl: string | ISharePointQueryable, path?: string): T;
|
|
6
|
-
}
|
|
7
|
-
export declare type ISPInvokableFactory<R extends any> = (baseUrl: string | ISharePointQueryable, path?: string) => R & IInvokable;
|
|
8
|
-
export declare const spInvokableFactory: <R>(f: any) => ISPInvokableFactory<R>;
|
|
9
|
-
/**
|
|
10
|
-
* SharePointQueryable Base Class
|
|
11
|
-
*
|
|
12
|
-
*/
|
|
13
|
-
export declare class _SharePointQueryable<GetType = any> extends Queryable<GetType> {
|
|
14
|
-
protected _forceCaching: boolean;
|
|
15
|
-
/**
|
|
16
|
-
* Creates a new instance of the SharePointQueryable class
|
|
17
|
-
*
|
|
18
|
-
* @constructor
|
|
19
|
-
* @param baseUrl A string or SharePointQueryable that should form the base part of the url
|
|
20
|
-
*
|
|
21
|
-
*/
|
|
22
|
-
constructor(baseUrl: string | ISharePointQueryable, path?: string);
|
|
23
|
-
/**
|
|
24
|
-
* Gets the full url with query information
|
|
25
|
-
*/
|
|
26
|
-
toUrlAndQuery(): string;
|
|
27
|
-
/**
|
|
28
|
-
* Choose which fields to return
|
|
29
|
-
*
|
|
30
|
-
* @param selects One or more fields to return
|
|
31
|
-
*/
|
|
32
|
-
select(...selects: string[]): this;
|
|
33
|
-
get<T = GetType>(options?: IFetchOptions): Promise<T>;
|
|
34
|
-
/**
|
|
35
|
-
* Expands fields such as lookups to get additional data
|
|
36
|
-
*
|
|
37
|
-
* @param expands The Fields for which to expand the values
|
|
38
|
-
*/
|
|
39
|
-
expand(...expands: string[]): this;
|
|
40
|
-
/**
|
|
41
|
-
* Clones this SharePointQueryable into a new SharePointQueryable instance of T
|
|
42
|
-
* @param factory Constructor used to create the new instance
|
|
43
|
-
* @param additionalPath Any additional path to include in the clone
|
|
44
|
-
* @param includeBatch If true this instance's batch will be added to the cloned instance
|
|
45
|
-
* @param includeQuery If true all of the query values will be copied to the cloned instance
|
|
46
|
-
*/
|
|
47
|
-
clone<T extends ISharePointQueryable>(factory: (...args: any[]) => T, additionalPath?: string, includeBatch?: boolean, includeQuery?: boolean): T;
|
|
48
|
-
/**
|
|
49
|
-
* The default action for this object (unless overridden spGet)
|
|
50
|
-
*
|
|
51
|
-
* @param options optional request options
|
|
52
|
-
*/
|
|
53
|
-
defaultAction(options?: IFetchOptions): Promise<GetType>;
|
|
54
|
-
/**
|
|
55
|
-
* Gets a parent for this instance as specified
|
|
56
|
-
*
|
|
57
|
-
* @param factory The contructor for the class to create
|
|
58
|
-
*/
|
|
59
|
-
protected getParent<T extends ISharePointQueryable>(factory: ISPInvokableFactory<any>, baseUrl?: string | ISharePointQueryable, path?: string, batch?: SPBatch): T;
|
|
60
|
-
}
|
|
61
|
-
export interface ISharePointQueryable<GetType = any> extends _SharePointQueryable<GetType> {
|
|
62
|
-
}
|
|
63
|
-
export interface _SharePointQueryable<GetType = any> {
|
|
64
|
-
<T = GetType>(options?: Partial<IRequestContext<T>>): Promise<T>;
|
|
65
|
-
}
|
|
66
|
-
export declare const SharePointQueryable: ISPInvokableFactory<ISharePointQueryable<any>>;
|
|
67
|
-
/**
|
|
68
|
-
* Represents a REST collection which can be filtered, paged, and selected
|
|
69
|
-
*
|
|
70
|
-
*/
|
|
71
|
-
export declare class _SharePointQueryableCollection<GetType = any[]> extends _SharePointQueryable<GetType> {
|
|
72
|
-
/**
|
|
73
|
-
* Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
|
|
74
|
-
*
|
|
75
|
-
* @param filter The string representing the filter query
|
|
76
|
-
*/
|
|
77
|
-
filter(filter: string): this;
|
|
78
|
-
/**
|
|
79
|
-
* Orders based on the supplied fields
|
|
80
|
-
*
|
|
81
|
-
* @param orderby The name of the field on which to sort
|
|
82
|
-
* @param ascending If false DESC is appended, otherwise ASC (default)
|
|
83
|
-
*/
|
|
84
|
-
orderBy(orderBy: string, ascending?: boolean): this;
|
|
85
|
-
/**
|
|
86
|
-
* Skips the specified number of items
|
|
87
|
-
*
|
|
88
|
-
* @param skip The number of items to skip
|
|
89
|
-
*/
|
|
90
|
-
skip(skip: number): this;
|
|
91
|
-
/**
|
|
92
|
-
* Limits the query to only return the specified number of items
|
|
93
|
-
*
|
|
94
|
-
* @param top The query row limit
|
|
95
|
-
*/
|
|
96
|
-
top(top: number): this;
|
|
97
|
-
}
|
|
98
|
-
export interface ISharePointQueryableCollection<GetType = any[]> extends _SharePointQueryableCollection<GetType> {
|
|
99
|
-
}
|
|
100
|
-
export declare const SharePointQueryableCollection: ISPInvokableFactory<ISharePointQueryableCollection<any[]>>;
|
|
101
|
-
/**
|
|
102
|
-
* Represents an instance that can be selected
|
|
103
|
-
*
|
|
104
|
-
*/
|
|
105
|
-
export declare class _SharePointQueryableInstance<GetType = any> extends _SharePointQueryable<GetType> {
|
|
106
|
-
/**
|
|
107
|
-
* Curries the update function into the common pieces
|
|
108
|
-
*
|
|
109
|
-
* @param type
|
|
110
|
-
* @param mapper
|
|
111
|
-
*/
|
|
112
|
-
protected _update<Return, Props = any>(type: string, mapper: (data: any, props: Props) => Return): (props: Props) => Promise<Return>;
|
|
113
|
-
}
|
|
114
|
-
export interface ISharePointQueryableInstance<GetType = any> extends _SharePointQueryableInstance<GetType> {
|
|
115
|
-
}
|
|
116
|
-
export declare const SharePointQueryableInstance: ISPInvokableFactory<ISharePointQueryableInstance<any>>;
|
|
117
|
-
/**
|
|
118
|
-
* Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
|
|
119
|
-
*/
|
|
120
|
-
export declare function deleteable(t: string): (this: ISharePointQueryable) => Promise<void>;
|
|
121
|
-
export interface IDeleteable {
|
|
122
|
-
/**
|
|
123
|
-
* Delete this instance
|
|
124
|
-
*/
|
|
125
|
-
delete(): Promise<void>;
|
|
126
|
-
}
|
|
127
|
-
export declare function deleteableWithETag(t: string): (this: ISharePointQueryable, eTag?: string) => Promise<void>;
|
|
128
|
-
export interface IDeleteableWithETag {
|
|
129
|
-
/**
|
|
130
|
-
* Delete this instance
|
|
131
|
-
*
|
|
132
|
-
* @param eTag Value used in the IF-Match header, by default "*"
|
|
133
|
-
*/
|
|
134
|
-
delete(eTag?: string): Promise<void>;
|
|
135
|
-
}
|
|
1
|
+
import { IFetchOptions } from "@pnp/common";
|
|
2
|
+
import { Queryable, IInvokable, IRequestContext } from "@pnp/odata";
|
|
3
|
+
import { SPBatch } from "./batch.js";
|
|
4
|
+
export interface ISharePointQueryableConstructor<T extends ISharePointQueryable = ISharePointQueryable> {
|
|
5
|
+
new (baseUrl: string | ISharePointQueryable, path?: string): T;
|
|
6
|
+
}
|
|
7
|
+
export declare type ISPInvokableFactory<R extends any> = (baseUrl: string | ISharePointQueryable, path?: string) => R & IInvokable;
|
|
8
|
+
export declare const spInvokableFactory: <R>(f: any) => ISPInvokableFactory<R>;
|
|
9
|
+
/**
|
|
10
|
+
* SharePointQueryable Base Class
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
export declare class _SharePointQueryable<GetType = any> extends Queryable<GetType> {
|
|
14
|
+
protected _forceCaching: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* Creates a new instance of the SharePointQueryable class
|
|
17
|
+
*
|
|
18
|
+
* @constructor
|
|
19
|
+
* @param baseUrl A string or SharePointQueryable that should form the base part of the url
|
|
20
|
+
*
|
|
21
|
+
*/
|
|
22
|
+
constructor(baseUrl: string | ISharePointQueryable, path?: string);
|
|
23
|
+
/**
|
|
24
|
+
* Gets the full url with query information
|
|
25
|
+
*/
|
|
26
|
+
toUrlAndQuery(): string;
|
|
27
|
+
/**
|
|
28
|
+
* Choose which fields to return
|
|
29
|
+
*
|
|
30
|
+
* @param selects One or more fields to return
|
|
31
|
+
*/
|
|
32
|
+
select(...selects: string[]): this;
|
|
33
|
+
get<T = GetType>(options?: IFetchOptions): Promise<T>;
|
|
34
|
+
/**
|
|
35
|
+
* Expands fields such as lookups to get additional data
|
|
36
|
+
*
|
|
37
|
+
* @param expands The Fields for which to expand the values
|
|
38
|
+
*/
|
|
39
|
+
expand(...expands: string[]): this;
|
|
40
|
+
/**
|
|
41
|
+
* Clones this SharePointQueryable into a new SharePointQueryable instance of T
|
|
42
|
+
* @param factory Constructor used to create the new instance
|
|
43
|
+
* @param additionalPath Any additional path to include in the clone
|
|
44
|
+
* @param includeBatch If true this instance's batch will be added to the cloned instance
|
|
45
|
+
* @param includeQuery If true all of the query values will be copied to the cloned instance
|
|
46
|
+
*/
|
|
47
|
+
clone<T extends ISharePointQueryable>(factory: (...args: any[]) => T, additionalPath?: string, includeBatch?: boolean, includeQuery?: boolean): T;
|
|
48
|
+
/**
|
|
49
|
+
* The default action for this object (unless overridden spGet)
|
|
50
|
+
*
|
|
51
|
+
* @param options optional request options
|
|
52
|
+
*/
|
|
53
|
+
defaultAction(options?: IFetchOptions): Promise<GetType>;
|
|
54
|
+
/**
|
|
55
|
+
* Gets a parent for this instance as specified
|
|
56
|
+
*
|
|
57
|
+
* @param factory The contructor for the class to create
|
|
58
|
+
*/
|
|
59
|
+
protected getParent<T extends ISharePointQueryable>(factory: ISPInvokableFactory<any>, baseUrl?: string | ISharePointQueryable, path?: string, batch?: SPBatch): T;
|
|
60
|
+
}
|
|
61
|
+
export interface ISharePointQueryable<GetType = any> extends _SharePointQueryable<GetType> {
|
|
62
|
+
}
|
|
63
|
+
export interface _SharePointQueryable<GetType = any> {
|
|
64
|
+
<T = GetType>(options?: Partial<IRequestContext<T>>): Promise<T>;
|
|
65
|
+
}
|
|
66
|
+
export declare const SharePointQueryable: ISPInvokableFactory<ISharePointQueryable<any>>;
|
|
67
|
+
/**
|
|
68
|
+
* Represents a REST collection which can be filtered, paged, and selected
|
|
69
|
+
*
|
|
70
|
+
*/
|
|
71
|
+
export declare class _SharePointQueryableCollection<GetType = any[]> extends _SharePointQueryable<GetType> {
|
|
72
|
+
/**
|
|
73
|
+
* Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
|
|
74
|
+
*
|
|
75
|
+
* @param filter The string representing the filter query
|
|
76
|
+
*/
|
|
77
|
+
filter(filter: string): this;
|
|
78
|
+
/**
|
|
79
|
+
* Orders based on the supplied fields
|
|
80
|
+
*
|
|
81
|
+
* @param orderby The name of the field on which to sort
|
|
82
|
+
* @param ascending If false DESC is appended, otherwise ASC (default)
|
|
83
|
+
*/
|
|
84
|
+
orderBy(orderBy: string, ascending?: boolean): this;
|
|
85
|
+
/**
|
|
86
|
+
* Skips the specified number of items
|
|
87
|
+
*
|
|
88
|
+
* @param skip The number of items to skip
|
|
89
|
+
*/
|
|
90
|
+
skip(skip: number): this;
|
|
91
|
+
/**
|
|
92
|
+
* Limits the query to only return the specified number of items
|
|
93
|
+
*
|
|
94
|
+
* @param top The query row limit
|
|
95
|
+
*/
|
|
96
|
+
top(top: number): this;
|
|
97
|
+
}
|
|
98
|
+
export interface ISharePointQueryableCollection<GetType = any[]> extends _SharePointQueryableCollection<GetType> {
|
|
99
|
+
}
|
|
100
|
+
export declare const SharePointQueryableCollection: ISPInvokableFactory<ISharePointQueryableCollection<any[]>>;
|
|
101
|
+
/**
|
|
102
|
+
* Represents an instance that can be selected
|
|
103
|
+
*
|
|
104
|
+
*/
|
|
105
|
+
export declare class _SharePointQueryableInstance<GetType = any> extends _SharePointQueryable<GetType> {
|
|
106
|
+
/**
|
|
107
|
+
* Curries the update function into the common pieces
|
|
108
|
+
*
|
|
109
|
+
* @param type
|
|
110
|
+
* @param mapper
|
|
111
|
+
*/
|
|
112
|
+
protected _update<Return, Props = any>(type: string, mapper: (data: any, props: Props) => Return): (props: Props) => Promise<Return>;
|
|
113
|
+
}
|
|
114
|
+
export interface ISharePointQueryableInstance<GetType = any> extends _SharePointQueryableInstance<GetType> {
|
|
115
|
+
}
|
|
116
|
+
export declare const SharePointQueryableInstance: ISPInvokableFactory<ISharePointQueryableInstance<any>>;
|
|
117
|
+
/**
|
|
118
|
+
* Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
|
|
119
|
+
*/
|
|
120
|
+
export declare function deleteable(t: string): (this: ISharePointQueryable) => Promise<void>;
|
|
121
|
+
export interface IDeleteable {
|
|
122
|
+
/**
|
|
123
|
+
* Delete this instance
|
|
124
|
+
*/
|
|
125
|
+
delete(): Promise<void>;
|
|
126
|
+
}
|
|
127
|
+
export declare function deleteableWithETag(t: string): (this: ISharePointQueryable, eTag?: string) => Promise<void>;
|
|
128
|
+
export interface IDeleteableWithETag {
|
|
129
|
+
/**
|
|
130
|
+
* Delete this instance
|
|
131
|
+
*
|
|
132
|
+
* @param eTag Value used in the IF-Match header, by default "*"
|
|
133
|
+
*/
|
|
134
|
+
delete(eTag?: string): Promise<void>;
|
|
135
|
+
}
|
|
136
136
|
//# sourceMappingURL=sharepointqueryable.d.ts.map
|