diff --git a/dist/pnp.d.ts b/dist/pnp.d.ts
new file mode 100644
index 00000000..63e98369
--- /dev/null
+++ b/dist/pnp.d.ts
@@ -0,0 +1,4700 @@
+///
+declare module "collections/collections" {
+ /**
+ * Interface defining an object with a known property type
+ */
+ export interface TypedHash {
+ [key: string]: T;
+ }
+ /**
+ * Generic dictionary
+ */
+ export class Dictionary {
+ private keys;
+ private values;
+ /**
+ * Creates a new instance of the Dictionary class
+ *
+ * @constructor
+ */
+ constructor(keys?: string[], values?: T[]);
+ /**
+ * Gets a value from the collection using the specified key
+ *
+ * @param key The key whose value we want to return, returns null if the key does not exist
+ */
+ get(key: string): T;
+ /**
+ * Adds the supplied key and value to the dictionary
+ *
+ * @param key The key to add
+ * @param o The value to add
+ */
+ add(key: string, o: T): void;
+ /**
+ * Merges the supplied typed hash into this dictionary instance. Existing values are updated and new ones are created as appropriate.
+ */
+ merge(source: TypedHash | Dictionary): void;
+ /**
+ * Removes a value from the dictionary
+ *
+ * @param key The key of the key/value pair to remove. Returns null if the key was not found.
+ */
+ remove(key: string): T;
+ /**
+ * Returns all the keys currently in the dictionary as an array
+ */
+ getKeys(): string[];
+ /**
+ * Returns all the values currently in the dictionary as an array
+ */
+ getValues(): T[];
+ /**
+ * Clears the current dictionary
+ */
+ clear(): void;
+ /**
+ * Gets a count of the items currently in the dictionary
+ */
+ count(): number;
+ }
+}
+declare module "utils/logging" {
+ /**
+ * A set of logging levels
+ *
+ */
+ export enum LogLevel {
+ Verbose = 0,
+ Info = 1,
+ Warning = 2,
+ Error = 3,
+ Off = 99,
+ }
+ /**
+ * Interface that defines a log entry
+ *
+ */
+ export interface LogEntry {
+ /**
+ * The main message to be logged
+ */
+ message: string;
+ /**
+ * The level of information this message represents
+ */
+ level: LogLevel;
+ /**
+ * Any associated data that a given logging listener may choose to log or ignore
+ */
+ data?: any;
+ }
+ /**
+ * Interface that defines a log listner
+ *
+ */
+ export interface LogListener {
+ /**
+ * Any associated data that a given logging listener may choose to log or ignore
+ *
+ * @param entry The information to be logged
+ */
+ log(entry: LogEntry): void;
+ }
+ /**
+ * Class used to subscribe ILogListener and log messages throughout an application
+ *
+ */
+ export class Logger {
+ private static _instance;
+ static activeLogLevel: LogLevel;
+ private static readonly instance;
+ /**
+ * Adds ILogListener instances to the set of subscribed listeners
+ *
+ * @param listeners One or more listeners to subscribe to this log
+ */
+ static subscribe(...listeners: LogListener[]): void;
+ /**
+ * Clears the subscribers collection, returning the collection before modifiction
+ */
+ static clearSubscribers(): LogListener[];
+ /**
+ * Gets the current subscriber count
+ */
+ static readonly count: number;
+ /**
+ * Writes the supplied string to the subscribed listeners
+ *
+ * @param message The message to write
+ * @param level [Optional] if supplied will be used as the level of the entry (Default: LogLevel.Verbose)
+ */
+ static write(message: string, level?: LogLevel): void;
+ /**
+ * Writes the supplied string to the subscribed listeners
+ *
+ * @param json The json object to stringify and write
+ * @param level [Optional] if supplied will be used as the level of the entry (Default: LogLevel.Verbose)
+ */
+ static writeJSON(json: any, level?: LogLevel): void;
+ /**
+ * Logs the supplied entry to the subscribed listeners
+ *
+ * @param entry The message to log
+ */
+ static log(entry: LogEntry): void;
+ /**
+ * Logs performance tracking data for the the execution duration of the supplied function using console.profile
+ *
+ * @param name The name of this profile boundary
+ * @param f The function to execute and track within this performance boundary
+ */
+ static measure(name: string, f: () => T): T;
+ }
+ /**
+ * Implementation of ILogListener which logs to the browser console
+ *
+ */
+ export class ConsoleListener implements LogListener {
+ /**
+ * Any associated data that a given logging listener may choose to log or ignore
+ *
+ * @param entry The information to be logged
+ */
+ log(entry: LogEntry): void;
+ /**
+ * Formats the message
+ *
+ * @param entry The information to format into a string
+ */
+ private format(entry);
+ }
+ /**
+ * Implementation of ILogListener which logs to the supplied function
+ *
+ */
+ export class FunctionListener implements LogListener {
+ private method;
+ /**
+ * Creates a new instance of the FunctionListener class
+ *
+ * @constructor
+ * @param method The method to which any logging data will be passed
+ */
+ constructor(method: (entry: LogEntry) => void);
+ /**
+ * Any associated data that a given logging listener may choose to log or ignore
+ *
+ * @param entry The information to be logged
+ */
+ log(entry: LogEntry): void;
+ }
+}
+declare module "utils/decorators" {
+ export function deprecated(message: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+}
+declare module "utils/storage" {
+ /**
+ * A wrapper class to provide a consistent interface to browser based storage
+ *
+ */
+ export class PnPClientStorageWrapper implements PnPClientStore {
+ private store;
+ defaultTimeoutMinutes: number;
+ /**
+ * True if the wrapped storage is available; otherwise, false
+ */
+ enabled: boolean;
+ /**
+ * Creates a new instance of the PnPClientStorageWrapper class
+ *
+ * @constructor
+ */
+ constructor(store: Storage, defaultTimeoutMinutes?: number);
+ /**
+ * Get a value from storage, or null if that value does not exist
+ *
+ * @param key The key whose value we want to retrieve
+ */
+ get(key: string): T;
+ /**
+ * Adds a value to the underlying storage
+ *
+ * @param key The key to use when storing the provided value
+ * @param o The value to store
+ * @param expire Optional, if provided the expiration of the item, otherwise the default is used
+ */
+ put(key: string, o: any, expire?: Date): void;
+ /**
+ * Deletes a value from the underlying storage
+ *
+ * @param key The key of the pair we want to remove from storage
+ */
+ delete(key: string): void;
+ /**
+ * Gets an item from the underlying storage, or adds it if it does not exist using the supplied getter function
+ *
+ * @param key The key to use when storing the provided value
+ * @param getter A function which will upon execution provide the desired value
+ * @param expire Optional, if provided the expiration of the item, otherwise the default is used
+ */
+ getOrPut(key: string, getter: () => Promise, expire?: Date): Promise;
+ /**
+ * Used to determine if the wrapped storage is available currently
+ */
+ private test();
+ /**
+ * Creates the persistable to store
+ */
+ private createPersistable(o, expire?);
+ }
+ /**
+ * Interface which defines the operations provided by a client storage object
+ */
+ export interface PnPClientStore {
+ /**
+ * True if the wrapped storage is available; otherwise, false
+ */
+ enabled: boolean;
+ /**
+ * Get a value from storage, or null if that value does not exist
+ *
+ * @param key The key whose value we want to retrieve
+ */
+ get(key: string): any;
+ /**
+ * Adds a value to the underlying storage
+ *
+ * @param key The key to use when storing the provided value
+ * @param o The value to store
+ * @param expire Optional, if provided the expiration of the item, otherwise the default is used
+ */
+ put(key: string, o: any, expire?: Date): void;
+ /**
+ * Deletes a value from the underlying storage
+ *
+ * @param key The key of the pair we want to remove from storage
+ */
+ delete(key: string): void;
+ /**
+ * Gets an item from the underlying storage, or adds it if it does not exist using the supplied getter function
+ *
+ * @param key The key to use when storing the provided value
+ * @param getter A function which will upon execution provide the desired value
+ * @param expire Optional, if provided the expiration of the item, otherwise the default is used
+ */
+ getOrPut(key: string, getter: Function, expire?: Date): any;
+ }
+ /**
+ * A class that will establish wrappers for both local and session storage
+ */
+ export class PnPClientStorage {
+ /**
+ * Provides access to the local storage of the browser
+ */
+ local: PnPClientStore;
+ /**
+ * Provides access to the session storage of the browser
+ */
+ session: PnPClientStore;
+ /**
+ * Creates a new instance of the PnPClientStorage class
+ *
+ * @constructor
+ */
+ constructor();
+ }
+}
+declare module "sharepoint/caching" {
+ import { ODataParser } from "sharepoint/odata";
+ import { PnPClientStore, PnPClientStorage } from "utils/storage";
+ export interface ICachingOptions {
+ expiration?: Date;
+ storeName?: "session" | "local";
+ key: string;
+ }
+ export class CachingOptions implements ICachingOptions {
+ key: string;
+ protected static storage: PnPClientStorage;
+ expiration: Date;
+ storeName: "session" | "local";
+ constructor(key: string);
+ readonly store: PnPClientStore;
+ }
+ export class CachingParserWrapper implements ODataParser {
+ private _parser;
+ private _cacheOptions;
+ constructor(_parser: ODataParser, _cacheOptions: CachingOptions);
+ parse(response: Response): Promise;
+ }
+}
+declare module "utils/exceptions" {
+ /**
+ * Represents an exception with an HttpClient request
+ *
+ */
+ export class ProcessHttpClientResponseException extends Error {
+ readonly status: number;
+ readonly statusText: string;
+ readonly data: any;
+ constructor(status: number, statusText: string, data: any);
+ }
+ export class NoCacheAvailableException extends Error {
+ constructor(msg?: string);
+ }
+ export class APIUrlException extends Error {
+ constructor(msg?: string);
+ }
+ export class AuthUrlException extends Error {
+ constructor(data: any, msg?: string);
+ }
+ export class NodeFetchClientUnsupportedException extends Error {
+ constructor(msg?: string);
+ }
+ export class SPRequestExecutorUndefinedException extends Error {
+ constructor();
+ }
+ export class MaxCommentLengthException extends Error {
+ constructor(msg?: string);
+ }
+ export class NotSupportedInBatchException extends Error {
+ constructor(operation?: string);
+ }
+ export class ODataIdException extends Error {
+ constructor(data: any, msg?: string);
+ }
+ export class BatchParseException extends Error {
+ constructor(msg: string);
+ }
+ export class AlreadyInBatchException extends Error {
+ constructor(msg?: string);
+ }
+ export class FunctionExpectedException extends Error {
+ constructor(msg?: string);
+ }
+ export class UrlException extends Error {
+ constructor(msg: string);
+ }
+}
+declare module "sharepoint/queryablerequest" {
+ import { ODataParser, ODataBatch } from "sharepoint/odata";
+ import { ICachingOptions } from "sharepoint/caching";
+ import { FetchOptions } from "net/httpclient";
+ /**
+ * Defines the context for a given request to be processed in the pipeline
+ */
+ export interface RequestContext {
+ batch: ODataBatch;
+ batchDependency: () => void;
+ cachingOptions: ICachingOptions;
+ isBatched: boolean;
+ isCached: boolean;
+ requestAbsoluteUrl: string;
+ verb: string;
+ options: FetchOptions;
+ parser: ODataParser;
+ hasResult?: boolean;
+ result?: T;
+ requestId: string;
+ }
+ /**
+ * Processes a given context through the request pipeline
+ *
+ * @param context The request context we are processing
+ */
+ export function pipe(context: RequestContext): Promise;
+}
+declare module "sharepoint/queryable" {
+ import { Dictionary } from "collections/collections";
+ import { FetchOptions } from "net/httpclient";
+ import { ODataParser, ODataBatch } from "sharepoint/odata";
+ import { ICachingOptions } from "sharepoint/caching";
+ export interface QueryableConstructor {
+ new (baseUrl: string | Queryable, path?: string): T;
+ }
+ /**
+ * Queryable Base Class
+ *
+ */
+ export class Queryable {
+ /**
+ * Tracks the query parts of the url
+ */
+ protected _query: Dictionary;
+ /**
+ * Tracks the batch of which this query may be part
+ */
+ private _batch;
+ /**
+ * Tracks the url as it is built
+ */
+ private _url;
+ /**
+ * Stores the parent url used to create this instance, for recursing back up the tree if needed
+ */
+ private _parentUrl;
+ /**
+ * Explicitly tracks if we are using caching for this request
+ */
+ private _useCaching;
+ /**
+ * Any options that were supplied when caching was enabled
+ */
+ private _cachingOptions;
+ /**
+ * Directly concatonates the supplied string to the current url, not normalizing "/" chars
+ *
+ * @param pathPart The string to concatonate to the url
+ */
+ concat(pathPart: string): void;
+ /**
+ * Appends the given string and normalizes "/" chars
+ *
+ * @param pathPart The string to append
+ */
+ protected append(pathPart: string): void;
+ /**
+ * Blocks a batch call from occuring, MUST be cleared by calling the returned function
+ */
+ protected addBatchDependency(): () => void;
+ /**
+ * Indicates if the current query has a batch associated
+ *
+ */
+ protected readonly hasBatch: boolean;
+ /**
+ * Gets the parent url used when creating this instance
+ *
+ */
+ protected readonly parentUrl: string;
+ /**
+ * Provides access to the query builder for this url
+ *
+ */
+ readonly query: Dictionary;
+ /**
+ * Creates a new instance of the Queryable class
+ *
+ * @constructor
+ * @param baseUrl A string or Queryable that should form the base part of the url
+ *
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Adds this query to the supplied batch
+ *
+ * @example
+ * ```
+ *
+ * let b = pnp.sp.createBatch();
+ * pnp.sp.web.inBatch(b).get().then(...);
+ * b.execute().then(...)
+ * ```
+ */
+ inBatch(batch: ODataBatch): this;
+ /**
+ * Enables caching for this request
+ *
+ * @param options Defines the options used when caching this request
+ */
+ usingCaching(options?: ICachingOptions): this;
+ /**
+ * Gets the currentl url, made absolute based on the availability of the _spPageContextInfo object
+ *
+ */
+ toUrl(): string;
+ /**
+ * Gets the full url with query information
+ *
+ */
+ toUrlAndQuery(): string;
+ /**
+ * Gets a parent for this instance as specified
+ *
+ * @param factory The contructor for the class to create
+ */
+ protected getParent(factory: QueryableConstructor, baseUrl?: string | Queryable, path?: string): T;
+ /**
+ * Executes the currently built request
+ *
+ * @param parser Allows you to specify a parser to handle the result
+ * @param getOptions The options used for this request
+ */
+ get(parser?: ODataParser, getOptions?: FetchOptions): Promise;
+ getAs(parser?: ODataParser, getOptions?: FetchOptions): Promise;
+ protected post(postOptions?: FetchOptions, parser?: ODataParser): Promise;
+ protected postAs(postOptions?: FetchOptions, parser?: ODataParser): Promise;
+ protected patch(patchOptions?: FetchOptions, parser?: ODataParser): Promise;
+ protected delete(deleteOptions?: FetchOptions, parser?: ODataParser): Promise;
+ private toRequestContext(verb, options, parser);
+ }
+ /**
+ * Represents a REST collection which can be filtered, paged, and selected
+ *
+ */
+ export class QueryableCollection extends Queryable {
+ /**
+ * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
+ *
+ * @param filter The string representing the filter query
+ */
+ filter(filter: string): this;
+ /**
+ * Choose which fields to return
+ *
+ * @param selects One or more fields to return
+ */
+ select(...selects: string[]): this;
+ /**
+ * Expands fields such as lookups to get additional data
+ *
+ * @param expands The Fields for which to expand the values
+ */
+ expand(...expands: string[]): this;
+ /**
+ * Orders based on the supplied fields ascending
+ *
+ * @param orderby The name of the field to sort on
+ * @param ascending If false DESC is appended, otherwise ASC (default)
+ */
+ orderBy(orderBy: string, ascending?: boolean): this;
+ /**
+ * Skips the specified number of items
+ *
+ * @param skip The number of items to skip
+ */
+ skip(skip: number): this;
+ /**
+ * Limits the query to only return the specified number of items
+ *
+ * @param top The query row limit
+ */
+ top(top: number): this;
+ }
+ /**
+ * Represents an instance that can be selected
+ *
+ */
+ export class QueryableInstance extends Queryable {
+ /**
+ * Choose which fields to return
+ *
+ * @param selects One or more fields to return
+ */
+ select(...selects: string[]): this;
+ /**
+ * Expands fields such as lookups to get additional data
+ *
+ * @param expands The Fields for which to expand the values
+ */
+ expand(...expands: string[]): this;
+ }
+}
+declare module "sharepoint/odata" {
+ import { QueryableConstructor } from "sharepoint/queryable";
+ export function extractOdataId(candidate: any): string;
+ export interface ODataParser {
+ parse(r: Response): Promise;
+ }
+ export abstract class ODataParserBase implements ODataParser {
+ parse(r: Response): Promise;
+ protected handleError(r: Response, reject: (reason?: any) => void): boolean;
+ protected parseODataJSON(json: any): U;
+ }
+ export class ODataDefaultParser extends ODataParserBase {
+ }
+ export class ODataRawParserImpl implements ODataParser {
+ parse(r: Response): Promise;
+ }
+ export let ODataRaw: ODataRawParserImpl;
+ export function ODataValue(): ODataParser;
+ export function ODataEntity(factory: QueryableConstructor): ODataParser;
+ export function ODataEntityArray(factory: QueryableConstructor): ODataParser;
+ /**
+ * Manages a batch of OData operations
+ */
+ export class ODataBatch {
+ private baseUrl;
+ private _batchId;
+ private _batchDependencies;
+ private _requests;
+ constructor(baseUrl: string, _batchId?: string);
+ /**
+ * Adds a request to a batch (not designed for public use)
+ *
+ * @param url The full url of the request
+ * @param method The http method GET, POST, etc
+ * @param options Any options to include in the request
+ * @param parser The parser that will hadle the results of the request
+ */
+ add(url: string, method: string, options: any, parser: ODataParser): Promise;
+ /**
+ * Adds a dependency insuring that some set of actions will occur before a batch is processed.
+ * MUST be cleared using the returned resolve delegate to allow batches to run
+ */
+ addBatchDependency(): () => void;
+ /**
+ * Execute the current batch and resolve the associated promises
+ *
+ * @returns A promise which will be resolved once all of the batch's child promises have resolved
+ */
+ execute(): Promise;
+ private executeImpl();
+ /**
+ * Parses the response from a batch request into an array of Response instances
+ *
+ * @param body Text body of the response from the batch request
+ */
+ private _parseResponse(body);
+ }
+ export class TextFileParser implements ODataParser {
+ parse(r: Response): Promise;
+ }
+ export class BlobFileParser implements ODataParser {
+ parse(r: Response): Promise;
+ }
+ export class JSONFileParser implements ODataParser {
+ parse(r: Response): Promise;
+ }
+ export class BufferFileParser implements ODataParser {
+ parse(r: any): Promise;
+ }
+}
+declare module "net/digestcache" {
+ import { Dictionary } from "collections/collections";
+ import { HttpClient } from "net/httpclient";
+ export class CachedDigest {
+ expiration: Date;
+ value: string;
+ }
+ export class DigestCache {
+ private _httpClient;
+ private _digests;
+ constructor(_httpClient: HttpClient, _digests?: Dictionary);
+ getDigest(webUrl: string): Promise;
+ clear(): void;
+ }
+}
+declare module "net/httpclient" {
+ export interface FetchOptions {
+ method?: string;
+ headers?: string[][] | {
+ [key: string]: string;
+ };
+ body?: BodyInit;
+ mode?: string | RequestMode;
+ credentials?: string | RequestCredentials;
+ cache?: string | RequestCache;
+ }
+ export class HttpClient {
+ private _digestCache;
+ private _impl;
+ constructor();
+ fetch(url: string, options?: FetchOptions): Promise;
+ fetchRaw(url: string, options?: FetchOptions): Promise;
+ get(url: string, options?: FetchOptions): Promise;
+ post(url: string, options?: FetchOptions): Promise;
+ patch(url: string, options?: FetchOptions): Promise;
+ delete(url: string, options?: FetchOptions): Promise;
+ private mergeHeaders(target, source);
+ }
+ export interface HttpClientImpl {
+ fetch(url: string, options: FetchOptions): Promise;
+ }
+}
+declare module "net/fetchclient" {
+ import { HttpClientImpl } from "net/httpclient";
+ /**
+ * Makes requests using the fetch API
+ */
+ export class FetchClient implements HttpClientImpl {
+ fetch(url: string, options: any): Promise;
+ }
+}
+declare module "configuration/pnplibconfig" {
+ import { TypedHash } from "collections/collections";
+ import { HttpClientImpl } from "net/httpclient";
+ export interface LibraryConfiguration {
+ /**
+ * Any headers to apply to all requests
+ */
+ headers?: TypedHash;
+ /**
+ * Allows caching to be global disabled, default: false
+ */
+ globalCacheDisable?: boolean;
+ /**
+ * Defines the default store used by the usingCaching method, default: session
+ */
+ defaultCachingStore?: "session" | "local";
+ /**
+ * Defines the default timeout in seconds used by the usingCaching method, default 30
+ */
+ defaultCachingTimeoutSeconds?: number;
+ /**
+ * Defines a factory method used to create fetch clients
+ */
+ fetchClientFactory?: () => HttpClientImpl;
+ /**
+ * The base url used for all requests
+ */
+ baseUrl?: string;
+ /**
+ * Used to supply the current context from an SPFx webpart to the library
+ */
+ spfxContext?: any;
+ }
+ export class RuntimeConfigImpl {
+ private _headers;
+ private _defaultCachingStore;
+ private _defaultCachingTimeoutSeconds;
+ private _globalCacheDisable;
+ private _fetchClientFactory;
+ private _baseUrl;
+ private _spfxContext;
+ constructor();
+ set(config: LibraryConfiguration): void;
+ readonly headers: TypedHash;
+ readonly defaultCachingStore: "session" | "local";
+ readonly defaultCachingTimeoutSeconds: number;
+ readonly globalCacheDisable: boolean;
+ readonly fetchClientFactory: () => HttpClientImpl;
+ readonly baseUrl: string;
+ }
+ export let RuntimeConfig: RuntimeConfigImpl;
+ export function setRuntimeConfig(config: LibraryConfiguration): void;
+}
+declare module "utils/util" {
+ import { TypedHash } from "collections/collections";
+ export class Util {
+ /**
+ * Gets a callback function which will maintain context across async calls.
+ * Allows for the calling pattern getCtxCallback(thisobj, method, methodarg1, methodarg2, ...)
+ *
+ * @param context The object that will be the 'this' value in the callback
+ * @param method The method to which we will apply the context and parameters
+ * @param params Optional, additional arguments to supply to the wrapped method when it is invoked
+ */
+ static getCtxCallback(context: any, method: Function, ...params: any[]): Function;
+ /**
+ * Tests if a url param exists
+ *
+ * @param name The name of the url paramter to check
+ */
+ static urlParamExists(name: string): boolean;
+ /**
+ * Gets a url param value by name
+ *
+ * @param name The name of the paramter for which we want the value
+ */
+ static getUrlParamByName(name: string): string;
+ /**
+ * Gets a url param by name and attempts to parse a bool value
+ *
+ * @param name The name of the paramter for which we want the boolean value
+ */
+ static getUrlParamBoolByName(name: string): boolean;
+ /**
+ * Inserts the string s into the string target as the index specified by index
+ *
+ * @param target The string into which we will insert s
+ * @param index The location in target to insert s (zero based)
+ * @param s The string to insert into target at position index
+ */
+ static stringInsert(target: string, index: number, s: string): string;
+ /**
+ * Adds a value to a date
+ *
+ * @param date The date to which we will add units, done in local time
+ * @param interval The name of the interval to add, one of: ['year', 'quarter', 'month', 'week', 'day', 'hour', 'minute', 'second']
+ * @param units The amount to add to date of the given interval
+ *
+ * http://stackoverflow.com/questions/1197928/how-to-add-30-minutes-to-a-javascript-date-object
+ */
+ static dateAdd(date: Date, interval: string, units: number): Date;
+ /**
+ * Loads a stylesheet into the current page
+ *
+ * @param path The url to the stylesheet
+ * @param avoidCache If true a value will be appended as a query string to avoid browser caching issues
+ */
+ static loadStylesheet(path: string, avoidCache: boolean): void;
+ /**
+ * Combines an arbitrary set of paths ensuring that the slashes are normalized
+ *
+ * @param paths 0 to n path parts to combine
+ */
+ static combinePaths(...paths: string[]): string;
+ /**
+ * Gets a random string of chars length
+ *
+ * @param chars The length of the random string to generate
+ */
+ static getRandomString(chars: number): string;
+ /**
+ * Gets a random GUID value
+ *
+ * http://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript
+ */
+ static getGUID(): string;
+ /**
+ * Determines if a given value is a function
+ *
+ * @param candidateFunction The thing to test for being a function
+ */
+ static isFunction(candidateFunction: any): boolean;
+ /**
+ * @returns whether the provided parameter is a JavaScript Array or not.
+ */
+ static isArray(array: any): boolean;
+ /**
+ * Determines if a string is null or empty or undefined
+ *
+ * @param s The string to test
+ */
+ static stringIsNullOrEmpty(s: string): boolean;
+ /**
+ * Provides functionality to extend the given object by doing a shallow copy
+ *
+ * @param target The object to which properties will be copied
+ * @param source The source object from which properties will be copied
+ * @param noOverwrite If true existing properties on the target are not overwritten from the source
+ *
+ */
+ static extend(target: any, source: TypedHash, noOverwrite?: boolean): any;
+ /**
+ * Determines if a given url is absolute
+ *
+ * @param url The url to check to see if it is absolute
+ */
+ static isUrlAbsolute(url: string): boolean;
+ /**
+ * Attempts to make the supplied relative url absolute based on the _spPageContextInfo object, if available
+ *
+ * @param url The relative url to make absolute
+ */
+ static makeUrlAbsolute(url: string): string;
+ /**
+ * Ensures that a given url is absolute for the current web based on context
+ *
+ * @param candidateUrl The url to make absolute
+ *
+ */
+ static toAbsoluteUrl(candidateUrl: string): Promise;
+ }
+}
+declare module "configuration/configuration" {
+ import { TypedHash } from "collections/collections";
+ /**
+ * Interface for configuration providers
+ *
+ */
+ export interface IConfigurationProvider {
+ /**
+ * Gets the configuration from the provider
+ */
+ getConfiguration(): Promise>;
+ }
+ /**
+ * Class used to manage the current application settings
+ *
+ */
+ export class Settings {
+ /**
+ * The settings currently stored in this instance
+ */
+ private _settings;
+ /**
+ * Creates a new instance of the settings class
+ *
+ * @constructor
+ */
+ constructor();
+ /**
+ * Adds a new single setting, or overwrites a previous setting with the same key
+ *
+ * @param {string} key The key used to store this setting
+ * @param {string} value The setting value to store
+ */
+ add(key: string, value: string): void;
+ /**
+ * Adds a JSON value to the collection as a string, you must use getJSON to rehydrate the object when read
+ *
+ * @param {string} key The key used to store this setting
+ * @param {any} value The setting value to store
+ */
+ addJSON(key: string, value: any): void;
+ /**
+ * Applies the supplied hash to the setting collection overwriting any existing value, or created new values
+ *
+ * @param {TypedHash} hash The set of values to add
+ */
+ apply(hash: TypedHash): Promise;
+ /**
+ * Loads configuration settings into the collection from the supplied provider and returns a Promise
+ *
+ * @param {IConfigurationProvider} provider The provider from which we will load the settings
+ */
+ load(provider: IConfigurationProvider): Promise;
+ /**
+ * Gets a value from the configuration
+ *
+ * @param {string} key The key whose value we want to return. Returns null if the key does not exist
+ * @return {string} string value from the configuration
+ */
+ get(key: string): string;
+ /**
+ * Gets a JSON value, rehydrating the stored string to the original object
+ *
+ * @param {string} key The key whose value we want to return. Returns null if the key does not exist
+ * @return {any} object from the configuration
+ */
+ getJSON(key: string): any;
+ }
+}
+declare module "sharepoint/search" {
+ import { Queryable, QueryableInstance } from "sharepoint/queryable";
+ /**
+ * Describes the SearchQuery interface
+ */
+ export interface SearchQuery {
+ /**
+ * A string that contains the text for the search query.
+ */
+ Querytext: string;
+ /**
+ * A string that contains the text that replaces the query text, as part of a query transform.
+ */
+ QueryTemplate?: string;
+ /**
+ * A Boolean value that specifies whether the result tables that are returned for
+ * the result block are mixed with the result tables that are returned for the original query.
+ */
+ EnableInterleaving?: boolean;
+ /**
+ * A Boolean value that specifies whether stemming is enabled.
+ */
+ EnableStemming?: boolean;
+ /**
+ * A Boolean value that specifies whether duplicate items are removed from the results.
+ */
+ TrimDuplicates?: boolean;
+ /**
+ * A Boolean value that specifies whether the exact terms in the search query are used to find matches, or if nicknames are used also.
+ */
+ EnableNicknames?: boolean;
+ /**
+ * A Boolean value that specifies whether the query uses the FAST Query Language (FQL).
+ */
+ EnableFql?: boolean;
+ /**
+ * A Boolean value that specifies whether the phonetic forms of the query terms are used to find matches.
+ */
+ EnablePhonetic?: boolean;
+ /**
+ * A Boolean value that specifies whether to perform result type processing for the query.
+ */
+ BypassResultTypes?: boolean;
+ /**
+ * A Boolean value that specifies whether to return best bet results for the query.
+ * This parameter is used only when EnableQueryRules is set to true, otherwise it is ignored.
+ */
+ ProcessBestBets?: boolean;
+ /**
+ * A Boolean value that specifies whether to enable query rules for the query.
+ */
+ EnableQueryRules?: boolean;
+ /**
+ * A Boolean value that specifies whether to sort search results.
+ */
+ EnableSorting?: boolean;
+ /**
+ * Specifies whether to return block rank log information in the BlockRankLog property of the interleaved result table.
+ * A block rank log contains the textual information on the block score and the documents that were de-duplicated.
+ */
+ GenerateBlockRankLog?: boolean;
+ /**
+ * The result source ID to use for executing the search query.
+ */
+ SourceId?: string;
+ /**
+ * The ID of the ranking model to use for the query.
+ */
+ RankingModelId?: string;
+ /**
+ * The first row that is included in the search results that are returned.
+ * You use this parameter when you want to implement paging for search results.
+ */
+ StartRow?: number;
+ /**
+ * The maximum number of rows overall that are returned in the search results.
+ * Compared to RowsPerPage, RowLimit is the maximum number of rows returned overall.
+ */
+ RowLimit?: number;
+ /**
+ * The maximum number of rows to return per page.
+ * Compared to RowLimit, RowsPerPage refers to the maximum number of rows to return per page,
+ * and is used primarily when you want to implement paging for search results.
+ */
+ RowsPerPage?: number;
+ /**
+ * The managed properties to return in the search results.
+ */
+ SelectProperties?: string[];
+ /**
+ * The locale ID (LCID) for the query.
+ */
+ Culture?: number;
+ /**
+ * The set of refinement filters used when issuing a refinement query (FQL)
+ */
+ RefinementFilters?: string[];
+ /**
+ * The set of refiners to return in a search result.
+ */
+ Refiners?: string;
+ /**
+ * The additional query terms to append to the query.
+ */
+ HiddenConstraints?: string;
+ /**
+ * The list of properties by which the search results are ordered.
+ */
+ SortList?: Sort[];
+ /**
+ * The amount of time in milliseconds before the query request times out.
+ */
+ Timeout?: number;
+ /**
+ * The properties to highlight in the search result summary when the property value matches the search terms entered by the user.
+ */
+ HithighlightedProperties?: string[];
+ /**
+ * The type of the client that issued the query.
+ */
+ ClientType?: string;
+ /**
+ * The GUID for the user who submitted the search query.
+ */
+ PersonalizationData?: string;
+ /**
+ * The URL for the search results page.
+ */
+ ResultsURL?: string;
+ /**
+ * Custom tags that identify the query. You can specify multiple query tags
+ */
+ QueryTag?: string[];
+ /**
+ * Properties to be used to configure the search query
+ */
+ Properties?: SearchProperty[];
+ /**
+ * A Boolean value that specifies whether to return personal favorites with the search results.
+ */
+ ProcessPersonalFavorites?: boolean;
+ /**
+ * The location of the queryparametertemplate.xml file. This file is used to enable anonymous users to make Search REST queries.
+ */
+ QueryTemplatePropertiesUrl?: string;
+ /**
+ * Special rules for reordering search results.
+ * These rules can specify that documents matching certain conditions are ranked higher or lower in the results.
+ * This property applies only when search results are sorted based on rank.
+ */
+ ReorderingRules?: ReorderingRule[];
+ /**
+ * The number of properties to show hit highlighting for in the search results.
+ */
+ HitHighlightedMultivaluePropertyLimit?: number;
+ /**
+ * A Boolean value that specifies whether the hit highlighted properties can be ordered.
+ */
+ EnableOrderingHitHighlightedProperty?: boolean;
+ /**
+ * The managed properties that are used to determine how to collapse individual search results.
+ * Results are collapsed into one or a specified number of results if they match any of the individual collapse specifications.
+ * In a collapse specification, results are collapsed if their properties match all individual properties in the collapse specification.
+ */
+ CollapseSpecification?: string;
+ /**
+ * The locale identifier (LCID) of the user interface
+ */
+ UIlanguage?: number;
+ /**
+ * The preferred number of characters to display in the hit-highlighted summary generated for a search result.
+ */
+ DesiredSnippetLength?: number;
+ /**
+ * The maximum number of characters to display in the hit-highlighted summary generated for a search result.
+ */
+ MaxSnippetLength?: number;
+ /**
+ * The number of characters to display in the result summary for a search result.
+ */
+ SummaryLength?: number;
+ }
+ /**
+ * Describes the search API
+ *
+ */
+ export class Search extends QueryableInstance {
+ /**
+ * Creates a new instance of the Search class
+ *
+ * @param baseUrl The url for the search context
+ * @param query The SearchQuery object to execute
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * .......
+ * @returns Promise
+ */
+ execute(query: SearchQuery): Promise;
+ }
+ /**
+ * Describes the SearchResults class, which returns the formatted and raw version of the query response
+ */
+ export class SearchResults {
+ PrimarySearchResults: any;
+ RawSearchResults: any;
+ RowCount: number;
+ TotalRows: number;
+ TotalRowsIncludingDuplicates: number;
+ ElapsedTime: number;
+ /**
+ * Creates a new instance of the SearchResult class
+ *
+ */
+ constructor(rawResponse: any);
+ /**
+ * Formats a search results array
+ *
+ * @param rawResults The array to process
+ */
+ protected formatSearchResults(rawResults: Array | any): SearchResult[];
+ }
+ /**
+ * Describes the SearchResult class
+ */
+ export class SearchResult {
+ /**
+ * Creates a new instance of the SearchResult class
+ *
+ */
+ constructor(rawItem: any);
+ }
+ /**
+ * Defines how search results are sorted.
+ */
+ export interface Sort {
+ /**
+ * The name for a property by which the search results are ordered.
+ */
+ Property: string;
+ /**
+ * The direction in which search results are ordered.
+ */
+ Direction: SortDirection;
+ }
+ /**
+ * Defines one search property
+ */
+ export interface SearchProperty {
+ Name: string;
+ Value: SearchPropertyValue;
+ }
+ /**
+ * Defines one search property value
+ */
+ export interface SearchPropertyValue {
+ StrVal: string;
+ QueryPropertyValueTypeIndex: QueryPropertyValueType;
+ }
+ /**
+ * defines the SortDirection enum
+ */
+ export enum SortDirection {
+ Ascending = 0,
+ Descending = 1,
+ FQLFormula = 2,
+ }
+ /**
+ * Defines how ReorderingRule interface, used for reordering results
+ */
+ export interface ReorderingRule {
+ /**
+ * The value to match on
+ */
+ MatchValue: string;
+ /**
+ * The rank boosting
+ */
+ Boost: number;
+ /**
+ * The rank boosting
+ */
+ MatchType: ReorderingRuleMatchType;
+ }
+ /**
+ * defines the ReorderingRuleMatchType enum
+ */
+ export enum ReorderingRuleMatchType {
+ ResultContainsKeyword = 0,
+ TitleContainsKeyword = 1,
+ TitleMatchesKeyword = 2,
+ UrlStartsWith = 3,
+ UrlExactlyMatches = 4,
+ ContentTypeIs = 5,
+ FileExtensionMatches = 6,
+ ResultHasTag = 7,
+ ManualCondition = 8,
+ }
+ /**
+ * Specifies the type value for the property
+ */
+ export enum QueryPropertyValueType {
+ None = 0,
+ StringType = 1,
+ Int32TYpe = 2,
+ BooleanType = 3,
+ StringArrayType = 4,
+ UnSupportedType = 5,
+ }
+}
+declare module "sharepoint/searchsuggest" {
+ import { Queryable, QueryableInstance } from "sharepoint/queryable";
+ /**
+ * Defines a query execute against the search/suggest endpoint (see https://msdn.microsoft.com/en-us/library/office/dn194079.aspx)
+ */
+ export interface SearchSuggestQuery {
+ /**
+ * A string that contains the text for the search query.
+ */
+ querytext: string;
+ /**
+ * The number of query suggestions to retrieve. Must be greater than zero (0). The default value is 5.
+ */
+ count?: number;
+ /**
+ * The number of personal results to retrieve. Must be greater than zero (0). The default value is 5.
+ */
+ personalCount?: number;
+ /**
+ * A Boolean value that specifies whether to retrieve pre-query or post-query suggestions. true to return pre-query suggestions; otherwise, false. The default value is false.
+ */
+ preQuery?: boolean;
+ /**
+ * A Boolean value that specifies whether to hit-highlight or format in bold the query suggestions. true to format in bold the terms in the returned query suggestions
+ * that match terms in the specified query; otherwise, false. The default value is true.
+ */
+ hitHighlighting?: boolean;
+ /**
+ * A Boolean value that specifies whether to capitalize the first letter in each term in the returned query suggestions. true to capitalize the first letter in each term;
+ * otherwise, false. The default value is false.
+ */
+ capitalize?: boolean;
+ /**
+ * The locale ID (LCID) for the query (see https://msdn.microsoft.com/en-us/library/cc233982.aspx).
+ */
+ culture?: string;
+ /**
+ * A Boolean value that specifies whether stemming is enabled. true to enable stemming; otherwise, false. The default value is true.
+ */
+ stemming?: boolean;
+ /**
+ * A Boolean value that specifies whether to include people names in the returned query suggestions. true to include people names in the returned query suggestions;
+ * otherwise, false. The default value is true.
+ */
+ includePeople?: boolean;
+ /**
+ * A Boolean value that specifies whether to turn on query rules for this query. true to turn on query rules; otherwise, false. The default value is true.
+ */
+ queryRules?: boolean;
+ /**
+ * A Boolean value that specifies whether to return query suggestions for prefix matches. true to return query suggestions based on prefix matches, otherwise, false when
+ * query suggestions should match the full query word.
+ */
+ prefixMatch?: boolean;
+ }
+ export class SearchSuggest extends QueryableInstance {
+ constructor(baseUrl: string | Queryable, path?: string);
+ execute(query: SearchSuggestQuery): Promise;
+ private mapQueryToQueryString(query);
+ }
+ export class SearchSuggestResult {
+ PeopleNames: string[];
+ PersonalResults: PersonalResultSuggestion[];
+ Queries: any[];
+ constructor(json: any);
+ }
+ export interface PersonalResultSuggestion {
+ HighlightedTitle?: string;
+ IsBestBet?: boolean;
+ Title?: string;
+ TypeId?: string;
+ Url?: string;
+ }
+}
+declare module "sharepoint/siteusers" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import { SiteGroups } from "sharepoint/sitegroups";
+ import { TypedHash } from "collections/collections";
+ /**
+ * Properties that provide both a getter, and a setter.
+ *
+ */
+ export interface UserUpdateResult {
+ user: SiteUser;
+ data: any;
+ }
+ /**
+ * Describes a collection of all site collection users
+ *
+ */
+ export class SiteUsers extends QueryableCollection {
+ /**
+ * Creates a new instance of the Users class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this user collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a user from the collection by email
+ *
+ * @param email The email of the user
+ */
+ getByEmail(email: string): SiteUser;
+ /**
+ * Gets a user from the collection by id
+ *
+ * @param id The id of the user
+ */
+ getById(id: number): SiteUser;
+ /**
+ * Gets a user from the collection by login name
+ *
+ * @param loginName The email address of the user
+ */
+ getByLoginName(loginName: string): SiteUser;
+ /**
+ * Removes a user from the collection by id
+ *
+ * @param id The id of the user
+ */
+ removeById(id: number | Queryable): Promise;
+ /**
+ * Removes a user from the collection by login name
+ *
+ * @param loginName The login name of the user
+ */
+ removeByLoginName(loginName: string): Promise;
+ /**
+ * Add a user to a group
+ *
+ * @param loginName The login name of the user to add to the group
+ *
+ */
+ add(loginName: string): Promise;
+ }
+ /**
+ * Describes a single user
+ *
+ */
+ export class SiteUser extends QueryableInstance {
+ /**
+ * Creates a new instance of the User class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, passes the path to the user
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Get's the groups for this user.
+ *
+ */
+ readonly groups: SiteGroups;
+ /**
+ * Updates this user instance with the supplied properties
+ *
+ * @param properties A plain object of property names and values to update for the user
+ */
+ update(properties: TypedHash): Promise;
+ /**
+ * Delete this user
+ *
+ */
+ delete(): Promise;
+ }
+ /**
+ * Represents the current user
+ */
+ export class CurrentUser extends QueryableInstance {
+ constructor(baseUrl: string | Queryable, path?: string);
+ }
+}
+declare module "sharepoint/sitegroups" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import { SiteUsers } from "sharepoint/siteusers";
+ import { TypedHash } from "collections/collections";
+ /**
+ * Principal Type enum
+ *
+ */
+ export enum PrincipalType {
+ None = 0,
+ User = 1,
+ DistributionList = 2,
+ SecurityGroup = 4,
+ SharePointGroup = 8,
+ All = 15,
+ }
+ /**
+ * Result from adding a group.
+ *
+ */
+ export interface GroupUpdateResult {
+ group: SiteGroup;
+ data: any;
+ }
+ /**
+ * Results from updating a group
+ *
+ */
+ export interface GroupAddResult {
+ group: SiteGroup;
+ data: any;
+ }
+ /**
+ * Describes a collection of site users
+ *
+ */
+ export class SiteGroups extends QueryableCollection {
+ /**
+ * Creates a new instance of the SiteUsers class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this user collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Adds a new group to the site collection
+ *
+ * @param props The properties to be updated
+ */
+ add(properties: TypedHash): Promise;
+ /**
+ * Gets a group from the collection by name
+ *
+ * @param email The name of the group
+ */
+ getByName(groupName: string): SiteGroup;
+ /**
+ * Gets a group from the collection by id
+ *
+ * @param id The id of the group
+ */
+ getById(id: number): SiteGroup;
+ /**
+ * Removes the group with the specified member ID from the collection.
+ *
+ * @param id The id of the group to remove
+ */
+ removeById(id: number): Promise;
+ /**
+ * Removes a user from the collection by login name
+ *
+ * @param loginName The login name of the user
+ */
+ removeByLoginName(loginName: string): Promise;
+ }
+ /**
+ * Describes a single group
+ *
+ */
+ export class SiteGroup extends QueryableInstance {
+ /**
+ * Creates a new instance of the Group class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this site group
+ * @param path Optional, passes the path to the group
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Get's the users for this group
+ *
+ */
+ readonly users: SiteUsers;
+ /**
+ * Updates this group instance with the supplied properties
+ *
+ * @param properties A GroupWriteableProperties object of property names and values to update for the user
+ */
+ update(properties: TypedHash): Promise;
+ }
+ export interface SiteGroupAddResult {
+ group: SiteGroup;
+ data: any;
+ }
+}
+declare module "sharepoint/types" {
+ /**
+ * Represents the unique sequential location of a change within the change log.
+ */
+ export interface ChangeToken {
+ /**
+ * Gets or sets a string value that contains the serialized representation of the change token generated by the protocol server.
+ */
+ StringValue: string;
+ }
+ /**
+ * Defines a query that is performed against the change log.
+ */
+ export interface ChangeQuery {
+ /**
+ * Gets or sets a value that specifies whether add changes are included in the query.
+ */
+ Add?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to alerts are included in the query.
+ */
+ Alert?: boolean;
+ /**
+ * Gets or sets a value that specifies the end date and end time for changes that are returned through the query.
+ */
+ ChangeTokenEnd?: ChangeToken;
+ /**
+ * Gets or sets a value that specifies the start date and start time for changes that are returned through the query.
+ */
+ ChangeTokenStart?: ChangeToken;
+ /**
+ * Gets or sets a value that specifies whether changes to content types are included in the query.
+ */
+ ContentType?: boolean;
+ /**
+ * Gets or sets a value that specifies whether deleted objects are included in the query.
+ */
+ DeleteObject?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to fields are included in the query.
+ */
+ Field?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to files are included in the query.
+ */
+ File?: boolean;
+ /**
+ * Gets or sets value that specifies whether changes to folders are included in the query.
+ */
+ Folder?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to groups are included in the query.
+ */
+ Group?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding users to groups is included in the query.
+ */
+ GroupMembershipAdd?: boolean;
+ /**
+ * Gets or sets a value that specifies whether deleting users from the groups is included in the query.
+ */
+ GroupMembershipDelete?: boolean;
+ /**
+ * Gets or sets a value that specifies whether general changes to list items are included in the query.
+ */
+ Item?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to lists are included in the query.
+ */
+ List?: boolean;
+ /**
+ * Gets or sets a value that specifies whether move changes are included in the query.
+ */
+ Move?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to the navigation structure of a site collection are included in the query.
+ */
+ Navigation?: boolean;
+ /**
+ * Gets or sets a value that specifies whether renaming changes are included in the query.
+ */
+ Rename?: boolean;
+ /**
+ * Gets or sets a value that specifies whether restoring items from the recycle bin or from backups is included in the query.
+ */
+ Restore?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding role assignments is included in the query.
+ */
+ RoleAssignmentAdd?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding role assignments is included in the query.
+ */
+ RoleAssignmentDelete?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding role assignments is included in the query.
+ */
+ RoleDefinitionAdd?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding role assignments is included in the query.
+ */
+ RoleDefinitionDelete?: boolean;
+ /**
+ * Gets or sets a value that specifies whether adding role assignments is included in the query.
+ */
+ RoleDefinitionUpdate?: boolean;
+ /**
+ * Gets or sets a value that specifies whether modifications to security policies are included in the query.
+ */
+ SecurityPolicy?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to site collections are included in the query.
+ */
+ Site?: boolean;
+ /**
+ * Gets or sets a value that specifies whether updates made using the item SystemUpdate method are included in the query.
+ */
+ SystemUpdate?: boolean;
+ /**
+ * Gets or sets a value that specifies whether update changes are included in the query.
+ */
+ Update?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to users are included in the query.
+ */
+ User?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to views are included in the query.
+ */
+ View?: boolean;
+ /**
+ * Gets or sets a value that specifies whether changes to Web sites are included in the query.
+ */
+ Web?: boolean;
+ }
+ /**
+ * Specifies a Collaborative Application Markup Language (CAML) query on a list or joined lists.
+ */
+ export interface CamlQuery {
+ /**
+ * Gets or sets a value that indicates whether the query returns dates in Coordinated Universal Time (UTC) format.
+ */
+ DatesInUtc?: boolean;
+ /**
+ * Gets or sets a value that specifies the server relative URL of a list folder from which results will be returned.
+ */
+ FolderServerRelativeUrl?: string;
+ /**
+ * Gets or sets a value that specifies the information required to get the next page of data for the list view.
+ */
+ ListItemCollectionPosition?: ListItemCollectionPosition;
+ /**
+ * Gets or sets value that specifies the XML schema that defines the list view.
+ */
+ ViewXml?: string;
+ }
+ /**
+ * Specifies the information required to get the next page of data for a list view.
+ */
+ export interface ListItemCollectionPosition {
+ /**
+ * Gets or sets a value that specifies information, as name-value pairs, required to get the next page of data for a list view.
+ */
+ PagingInfo: string;
+ }
+ /**
+ * Represents the input parameter of the GetListItemChangesSinceToken method.
+ */
+ export interface ChangeLogitemQuery {
+ /**
+ * The change token for the request.
+ */
+ ChangeToken?: string;
+ /**
+ * The XML element that defines custom filtering for the query.
+ */
+ Contains?: string;
+ /**
+ * The records from the list to return and their return order.
+ */
+ Query?: string;
+ /**
+ * The options for modifying the query.
+ */
+ QueryOptions?: string;
+ /**
+ * RowLimit
+ */
+ RowLimit?: string;
+ /**
+ * The names of the fields to include in the query result.
+ */
+ ViewFields?: string;
+ /**
+ * The GUID of the view.
+ */
+ ViewName?: string;
+ }
+ /**
+ * Determines the display mode of the given control or view
+ */
+ export enum ControlMode {
+ Display = 1,
+ Edit = 2,
+ New = 3,
+ }
+ /**
+ * Represents properties of a list item field and its value.
+ */
+ export interface ListItemFormUpdateValue {
+ /**
+ * The error message result after validating the value for the field.
+ */
+ ErrorMessage?: string;
+ /**
+ * The internal name of the field.
+ */
+ FieldName?: string;
+ /**
+ * The value of the field, in string format.
+ */
+ FieldValue?: string;
+ /**
+ * Indicates whether there was an error result after validating the value for the field.
+ */
+ HasException?: boolean;
+ }
+ /**
+ * Specifies the type of the field.
+ */
+ export enum FieldTypes {
+ Invalid = 0,
+ Integer = 1,
+ Text = 2,
+ Note = 3,
+ DateTime = 4,
+ Counter = 5,
+ Choice = 6,
+ Lookup = 7,
+ Boolean = 8,
+ Number = 9,
+ Currency = 10,
+ URL = 11,
+ Computed = 12,
+ Threading = 13,
+ Guid = 14,
+ MultiChoice = 15,
+ GridChoice = 16,
+ Calculated = 17,
+ File = 18,
+ Attachments = 19,
+ User = 20,
+ Recurrence = 21,
+ CrossProjectLink = 22,
+ ModStat = 23,
+ Error = 24,
+ ContentTypeId = 25,
+ PageSeparator = 26,
+ ThreadIndex = 27,
+ WorkflowStatus = 28,
+ AllDayEvent = 29,
+ WorkflowEventType = 30,
+ }
+ export enum DateTimeFieldFormatType {
+ DateOnly = 0,
+ DateTime = 1,
+ }
+ /**
+ * Specifies the control settings while adding a field.
+ */
+ export enum AddFieldOptions {
+ /**
+ * Specify that a new field added to the list must also be added to the default content type in the site collection
+ */
+ DefaultValue = 0,
+ /**
+ * Specify that a new field added to the list must also be added to the default content type in the site collection.
+ */
+ AddToDefaultContentType = 1,
+ /**
+ * Specify that a new field must not be added to any other content type
+ */
+ AddToNoContentType = 2,
+ /**
+ * Specify that a new field that is added to the specified list must also be added to all content types in the site collection
+ */
+ AddToAllContentTypes = 4,
+ /**
+ * Specify adding an internal field name hint for the purpose of avoiding possible database locking or field renaming operations
+ */
+ AddFieldInternalNameHint = 8,
+ /**
+ * Specify that a new field that is added to the specified list must also be added to the default list view
+ */
+ AddFieldToDefaultView = 16,
+ /**
+ * Specify to confirm that no other field has the same display name
+ */
+ AddFieldCheckDisplayName = 32,
+ }
+ export interface XmlSchemaFieldCreationInformation {
+ Options?: AddFieldOptions;
+ SchemaXml: string;
+ }
+ export enum CalendarType {
+ Gregorian = 1,
+ Japan = 3,
+ Taiwan = 4,
+ Korea = 5,
+ Hijri = 6,
+ Thai = 7,
+ Hebrew = 8,
+ GregorianMEFrench = 9,
+ GregorianArabic = 10,
+ GregorianXLITEnglish = 11,
+ GregorianXLITFrench = 12,
+ KoreaJapanLunar = 14,
+ ChineseLunar = 15,
+ SakaEra = 16,
+ UmAlQura = 23,
+ }
+ export enum UrlFieldFormatType {
+ Hyperlink = 0,
+ Image = 1,
+ }
+ export interface BasePermissions {
+ Low: string;
+ High: string;
+ }
+ export interface FollowedContent {
+ FollowedDocumentsUrl: string;
+ FollowedSitesUrl: string;
+ }
+ export interface UserProfile {
+ /**
+ * An object containing the user's FollowedDocumentsUrl and FollowedSitesUrl.
+ */
+ FollowedContent?: FollowedContent;
+ /**
+ * The account name of the user. (SharePoint Online only)
+ */
+ AccountName?: string;
+ /**
+ * The display name of the user. (SharePoint Online only)
+ */
+ DisplayName?: string;
+ /**
+ * The FirstRun flag of the user. (SharePoint Online only)
+ */
+ O15FirstRunExperience?: number;
+ /**
+ * The personal site of the user.
+ */
+ PersonalSite?: string;
+ /**
+ * The capabilities of the user's personal site. Represents a bitwise PersonalSiteCapabilities value:
+ * None = 0; Profile Value = 1; Social Value = 2; Storage Value = 4; MyTasksDashboard Value = 8; Education Value = 16; Guest Value = 32.
+ */
+ PersonalSiteCapabilities?: number;
+ /**
+ * The error thrown when the user's personal site was first created, if any. (SharePoint Online only)
+ */
+ PersonalSiteFirstCreationError?: string;
+ /**
+ * The date and time when the user's personal site was first created. (SharePoint Online only)
+ */
+ PersonalSiteFirstCreationTime?: Date;
+ /**
+ * The status for the state of the personal site instantiation
+ */
+ PersonalSiteInstantiationState?: number;
+ /**
+ * The date and time when the user's personal site was last created. (SharePoint Online only)
+ */
+ PersonalSiteLastCreationTime?: Date;
+ /**
+ * The number of attempts made to create the user's personal site. (SharePoint Online only)
+ */
+ PersonalSiteNumberOfRetries?: number;
+ /**
+ * Indicates whether the user's picture is imported from Exchange.
+ */
+ PictureImportEnabled?: boolean;
+ /**
+ * The public URL of the personal site of the current user. (SharePoint Online only)
+ */
+ PublicUrl?: string;
+ /**
+ * The URL used to create the user's personal site.
+ */
+ UrlToCreatePersonalSite?: string;
+ }
+ export interface HashTag {
+ /**
+ * The hash tag's internal name.
+ */
+ Name?: string;
+ /**
+ * The number of times that the hash tag is used.
+ */
+ UseCount?: number;
+ }
+ export interface HashTagCollection {
+ Items: HashTag[];
+ }
+ export interface UserIdInfo {
+ NameId?: string;
+ NameIdIssuer?: string;
+ }
+ export enum PrincipalType {
+ None = 0,
+ User = 1,
+ DistributionList = 2,
+ SecurityGroup = 4,
+ SharePointGroup = 8,
+ All = 15,
+ }
+ export interface DocumentLibraryInformation {
+ AbsoluteUrl?: string;
+ Modified?: Date;
+ ModifiedFriendlyDisplay?: string;
+ ServerRelativeUrl?: string;
+ Title?: string;
+ }
+ export interface ContextInfo {
+ FormDigestTimeoutSeconds?: number;
+ FormDigestValue?: number;
+ LibraryVersion?: string;
+ SiteFullUrl?: string;
+ SupportedSchemaVersions?: string[];
+ WebFullUrl?: string;
+ }
+ export interface RenderListData {
+ Row: any[];
+ FirstRow: number;
+ FolderPermissions: string;
+ LastRow: number;
+ FilterLink: string;
+ ForceNoHierarchy: string;
+ HierarchyHasIndention: string;
+ }
+ export enum PageType {
+ Invalid = -1,
+ DefaultView = 0,
+ NormalView = 1,
+ DialogView = 2,
+ View = 3,
+ DisplayForm = 4,
+ DisplayFormDialog = 5,
+ EditForm = 6,
+ EditFormDialog = 7,
+ NewForm = 8,
+ NewFormDialog = 9,
+ SolutionForm = 10,
+ PAGE_MAXITEMS = 11,
+ }
+ export interface ListFormData {
+ ContentType?: string;
+ Title?: string;
+ Author?: string;
+ Editor?: string;
+ Created?: Date;
+ Modified: Date;
+ Attachments?: any;
+ ListSchema?: any;
+ FormControlMode?: number;
+ FieldControlModes?: {
+ Title?: number;
+ Author?: number;
+ Editor?: number;
+ Created?: number;
+ Modified?: number;
+ Attachments?: number;
+ };
+ WebAttributes?: {
+ WebUrl?: string;
+ EffectivePresenceEnabled?: boolean;
+ AllowScriptableWebParts?: boolean;
+ PermissionCustomizePages?: boolean;
+ LCID?: number;
+ CurrentUserId?: number;
+ };
+ ItemAttributes?: {
+ Id?: number;
+ FsObjType?: number;
+ ExternalListItem?: boolean;
+ Url?: string;
+ EffectiveBasePermissionsLow?: number;
+ EffectiveBasePermissionsHigh?: number;
+ };
+ ListAttributes?: {
+ Id?: string;
+ BaseType?: number;
+ Direction?: string;
+ ListTemplateType?: number;
+ DefaultItemOpen?: number;
+ EnableVersioning?: boolean;
+ };
+ CSRCustomLayout?: boolean;
+ PostBackRequired?: boolean;
+ PreviousPostBackHandled?: boolean;
+ UploadMode?: boolean;
+ SubmitButtonID?: string;
+ ItemContentTypeName?: string;
+ ItemContentTypeId?: string;
+ JSLinks?: string;
+ }
+}
+declare module "sharepoint/roles" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import { SiteGroups } from "sharepoint/sitegroups";
+ import { BasePermissions } from "sharepoint/types";
+ import { TypedHash } from "collections/collections";
+ /**
+ * Describes a set of role assignments for the current scope
+ *
+ */
+ export class RoleAssignments extends QueryableCollection {
+ /**
+ * Creates a new instance of the RoleAssignments class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Adds a new role assignment with the specified principal and role definitions to the collection.
+ *
+ * @param principalId The ID of the user or group to assign permissions to
+ * @param roleDefId The ID of the role definition that defines the permissions to assign
+ *
+ */
+ add(principalId: number, roleDefId: number): Promise;
+ /**
+ * Removes the role assignment with the specified principal and role definition from the collection
+ *
+ * @param principalId The ID of the user or group in the role assignment.
+ * @param roleDefId The ID of the role definition in the role assignment
+ *
+ */
+ remove(principalId: number, roleDefId: number): Promise;
+ /**
+ * Gets the role assignment associated with the specified principal ID from the collection.
+ *
+ * @param id The id of the role assignment
+ */
+ getById(id: number): RoleAssignment;
+ }
+ export class RoleAssignment extends QueryableInstance {
+ /**
+ * Creates a new instance of the RoleAssignment class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ readonly groups: SiteGroups;
+ /**
+ * Get the role definition bindings for this role assignment
+ *
+ */
+ readonly bindings: RoleDefinitionBindings;
+ /**
+ * Delete this role assignment
+ *
+ */
+ delete(): Promise;
+ }
+ export class RoleDefinitions extends QueryableCollection {
+ /**
+ * Creates a new instance of the RoleDefinitions class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path
+ *
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the role definition with the specified ID from the collection.
+ *
+ * @param id The ID of the role definition.
+ *
+ */
+ getById(id: number): RoleDefinition;
+ /**
+ * Gets the role definition with the specified name.
+ *
+ * @param name The name of the role definition.
+ *
+ */
+ getByName(name: string): RoleDefinition;
+ /**
+ * Gets the role definition with the specified type.
+ *
+ * @param name The name of the role definition.
+ *
+ */
+ getByType(roleTypeKind: number): RoleDefinition;
+ /**
+ * Create a role definition
+ *
+ * @param name The new role definition's name
+ * @param description The new role definition's description
+ * @param order The order in which the role definition appears
+ * @param basePermissions The permissions mask for this role definition
+ *
+ */
+ add(name: string, description: string, order: number, basePermissions: BasePermissions): Promise;
+ }
+ export class RoleDefinition extends QueryableInstance {
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Updates this web intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the web
+ */
+ update(properties: TypedHash): Promise;
+ /**
+ * Delete this role definition
+ *
+ */
+ delete(): Promise;
+ }
+ export interface RoleDefinitionUpdateResult {
+ definition: RoleDefinition;
+ data: any;
+ }
+ export interface RoleDefinitionAddResult {
+ definition: RoleDefinition;
+ data: any;
+ }
+ export class RoleDefinitionBindings extends QueryableCollection {
+ constructor(baseUrl: string | Queryable, path?: string);
+ }
+}
+declare module "sharepoint/queryablesecurable" {
+ import { RoleAssignments } from "sharepoint/roles";
+ import { Queryable, QueryableInstance } from "sharepoint/queryable";
+ export class QueryableSecurable extends QueryableInstance {
+ /**
+ * Gets the set of role assignments for this item
+ *
+ */
+ readonly roleAssignments: RoleAssignments;
+ /**
+ * Gets the closest securable up the security hierarchy whose permissions are applied to this list item
+ *
+ */
+ readonly firstUniqueAncestorSecurableObject: QueryableInstance;
+ /**
+ * Gets the effective permissions for the user supplied
+ *
+ * @param loginName The claims username for the user (ex: i:0#.f|membership|user@domain.com)
+ */
+ getUserEffectivePermissions(loginName: string): Queryable;
+ /**
+ * Breaks the security inheritance at this level optinally copying permissions and clearing subscopes
+ *
+ * @param copyRoleAssignments If true the permissions are copied from the current parent scope
+ * @param clearSubscopes Optional. true to make all child securable objects inherit role assignments from the current object
+ */
+ breakRoleInheritance(copyRoleAssignments?: boolean, clearSubscopes?: boolean): Promise;
+ /**
+ * Removes the local role assignments so that it re-inherit role assignments from the parent object.
+ *
+ */
+ resetRoleInheritance(): Promise;
+ }
+}
+declare module "sharepoint/webparts" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ export class LimitedWebPartManager extends Queryable {
+ /**
+ * Creates a new instance of the LimitedWebPartManager class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the set of web part definitions contained by this web part manager
+ *
+ */
+ readonly webparts: WebPartDefinitions;
+ /**
+ * Exports a webpart definition
+ *
+ * @param id the GUID id of the definition to export
+ */
+ export(id: string): Promise;
+ /**
+ * Imports a webpart
+ *
+ * @param xml webpart definition which must be valid XML in the .dwp or .webpart format
+ */
+ import(xml: string): Promise;
+ }
+ export class WebPartDefinitions extends QueryableCollection {
+ /**
+ * Creates a new instance of the WebPartDefinitions class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a web part definition from the collection by id
+ *
+ * @param id GUID id of the web part definition to get
+ */
+ getById(id: string): WebPartDefinition;
+ }
+ export class WebPartDefinition extends QueryableInstance {
+ /**
+ * Creates a new instance of the WebPartDefinition class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the webpart information associated with this definition
+ */
+ readonly webpart: WebPart;
+ /**
+ * Removes a webpart from a page, all settings will be lost
+ */
+ delete(): Promise;
+ }
+ export class WebPart extends QueryableInstance {
+ /**
+ * Creates a new instance of the WebPart class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ }
+}
+declare module "sharepoint/files" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ import { LimitedWebPartManager } from "sharepoint/webparts";
+ export interface ChunkedFileUploadProgressData {
+ stage: "starting" | "continue" | "finishing";
+ blockNumber: number;
+ totalBlocks: number;
+ chunkSize: number;
+ currentPointer: number;
+ fileSize: number;
+ }
+ /**
+ * Describes a collection of File objects
+ *
+ */
+ export class Files extends QueryableCollection {
+ /**
+ * Creates a new instance of the Files class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a File by filename
+ *
+ * @param name The name of the file, including extension.
+ */
+ getByName(name: string): File;
+ /**
+ * Uploads a file.
+ *
+ * @param url The folder-relative url of the file.
+ * @param content The file contents blob.
+ * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
+ * @returns The new File and the raw response.
+ */
+ add(url: string, content: Blob, shouldOverWrite?: boolean): Promise;
+ /**
+ * Uploads a file.
+ *
+ * @param url The folder-relative url of the file.
+ * @param content The Blob file content to add
+ * @param progress A callback function which can be used to track the progress of the upload
+ * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
+ * @param chunkSize The size of each file slice, in bytes (default: 10485760)
+ * @returns The new File and the raw response.
+ */
+ addChunked(url: string, content: Blob, progress?: (data: ChunkedFileUploadProgressData) => void, shouldOverWrite?: boolean, chunkSize?: number): Promise;
+ /**
+ * Adds a ghosted file to an existing list or document library.
+ *
+ * @param fileUrl The server-relative url where you want to save the file.
+ * @param templateFileType The type of use to create the file.
+ * @returns The template file that was added and the raw response.
+ */
+ addTemplateFile(fileUrl: string, templateFileType: TemplateFileType): Promise;
+ }
+ /**
+ * Describes a single File instance
+ *
+ */
+ export class File extends QueryableInstance {
+ /**
+ * Creates a new instance of the File class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a value that specifies the list item field values for the list item corresponding to the file.
+ *
+ */
+ readonly listItemAllFields: QueryableCollection;
+ /**
+ * Gets a collection of versions
+ *
+ */
+ readonly versions: Versions;
+ /**
+ * Approves the file submitted for content approval with the specified comment.
+ * Only documents in lists that are enabled for content approval can be approved.
+ *
+ * @param comment The comment for the approval.
+ */
+ approve(comment: string): Promise;
+ /**
+ * Stops the chunk upload session without saving the uploaded data.
+ * If the file doesn’t already exist in the library, the partially uploaded file will be deleted.
+ * Use this in response to user action (as in a request to cancel an upload) or an error or exception.
+ * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+ * This method is currently available only on Office 365.
+ *
+ * @param uploadId The unique identifier of the upload session.
+ */
+ cancelUpload(uploadId: string): Promise;
+ /**
+ * Checks the file in to a document library based on the check-in type.
+ *
+ * @param comment A comment for the check-in. Its length must be <= 1023.
+ * @param checkinType The check-in type for the file.
+ */
+ checkin(comment?: string, checkinType?: CheckinType): Promise;
+ /**
+ * Checks out the file from a document library.
+ */
+ checkout(): Promise;
+ /**
+ * Copies the file to the destination url.
+ *
+ * @param url The absolute url or server relative url of the destination file path to copy to.
+ * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
+ */
+ copyTo(url: string, shouldOverWrite?: boolean): Promise;
+ /**
+ * Delete this file.
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ /**
+ * Denies approval for a file that was submitted for content approval.
+ * Only documents in lists that are enabled for content approval can be denied.
+ *
+ * @param comment The comment for the denial.
+ */
+ deny(comment?: string): Promise;
+ /**
+ * Specifies the control set used to access, modify, or add Web Parts associated with this Web Part Page and view.
+ * An exception is thrown if the file is not an ASPX page.
+ *
+ * @param scope The WebPartsPersonalizationScope view on the Web Parts page.
+ */
+ getLimitedWebPartManager(scope?: WebPartsPersonalizationScope): LimitedWebPartManager;
+ /**
+ * Moves the file to the specified destination url.
+ *
+ * @param url The absolute url or server relative url of the destination file path to move to.
+ * @param moveOperations The bitwise MoveOperations value for how to move the file.
+ */
+ moveTo(url: string, moveOperations?: MoveOperations): Promise;
+ /**
+ * Submits the file for content approval with the specified comment.
+ *
+ * @param comment The comment for the published file. Its length must be <= 1023.
+ */
+ publish(comment?: string): Promise;
+ /**
+ * Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+ *
+ * @returns The GUID of the recycled file.
+ */
+ recycle(): Promise;
+ /**
+ * Reverts an existing checkout for the file.
+ *
+ */
+ undoCheckout(): Promise;
+ /**
+ * Removes the file from content approval or unpublish a major version.
+ *
+ * @param comment The comment for the unpublish operation. Its length must be <= 1023.
+ */
+ unpublish(comment?: string): Promise;
+ /**
+ * Gets the contents of the file as text
+ *
+ */
+ getText(): Promise;
+ /**
+ * Gets the contents of the file as a blob, does not work in Node.js
+ *
+ */
+ getBlob(): Promise;
+ /**
+ * Gets the contents of a file as an ArrayBuffer, works in Node.js
+ */
+ getBuffer(): Promise;
+ /**
+ * Gets the contents of a file as an ArrayBuffer, works in Node.js
+ */
+ getJSON(): Promise;
+ /**
+ * Sets the content of a file, for large files use setContentChunked
+ *
+ * @param content The file content
+ *
+ */
+ setContent(content: string | ArrayBuffer | Blob): Promise;
+ /**
+ * Sets the contents of a file using a chunked upload approach
+ *
+ * @param file The file to upload
+ * @param progress A callback function which can be used to track the progress of the upload
+ * @param chunkSize The size of each file slice, in bytes (default: 10485760)
+ */
+ setContentChunked(file: Blob, progress?: (data: ChunkedFileUploadProgressData) => void, chunkSize?: number): Promise;
+ /**
+ * Starts a new chunk upload session and uploads the first fragment.
+ * The current file content is not changed when this method completes.
+ * The method is idempotent (and therefore does not change the result) as long as you use the same values for uploadId and stream.
+ * The upload session ends either when you use the CancelUpload method or when you successfully
+ * complete the upload session by passing the rest of the file contents through the ContinueUpload and FinishUpload methods.
+ * The StartUpload and ContinueUpload methods return the size of the running total of uploaded data in bytes,
+ * so you can pass those return values to subsequent uses of ContinueUpload and FinishUpload.
+ * This method is currently available only on Office 365.
+ *
+ * @param uploadId The unique identifier of the upload session.
+ * @param fragment The file contents.
+ * @returns The size of the total uploaded data in bytes.
+ */
+ private startUpload(uploadId, fragment);
+ /**
+ * Continues the chunk upload session with an additional fragment.
+ * The current file content is not changed.
+ * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+ * This method is currently available only on Office 365.
+ *
+ * @param uploadId The unique identifier of the upload session.
+ * @param fileOffset The size of the offset into the file where the fragment starts.
+ * @param fragment The file contents.
+ * @returns The size of the total uploaded data in bytes.
+ */
+ private continueUpload(uploadId, fileOffset, fragment);
+ /**
+ * Uploads the last file fragment and commits the file. The current file content is changed when this method completes.
+ * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+ * This method is currently available only on Office 365.
+ *
+ * @param uploadId The unique identifier of the upload session.
+ * @param fileOffset The size of the offset into the file where the fragment starts.
+ * @param fragment The file contents.
+ * @returns The newly uploaded file.
+ */
+ private finishUpload(uploadId, fileOffset, fragment);
+ }
+ /**
+ * Describes a collection of Version objects
+ *
+ */
+ export class Versions extends QueryableCollection {
+ /**
+ * Creates a new instance of the File class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a version by id
+ *
+ * @param versionId The id of the version to retrieve
+ */
+ getById(versionId: number): Version;
+ /**
+ * Deletes all the file version objects in the collection.
+ *
+ */
+ deleteAll(): Promise;
+ /**
+ * Deletes the specified version of the file.
+ *
+ * @param versionId The ID of the file version to delete.
+ */
+ deleteById(versionId: number): Promise;
+ /**
+ * Deletes the file version object with the specified version label.
+ *
+ * @param label The version label of the file version to delete, for example: 1.2
+ */
+ deleteByLabel(label: string): Promise;
+ /**
+ * Creates a new file version from the file specified by the version label.
+ *
+ * @param label The version label of the file version to restore, for example: 1.2
+ */
+ restoreByLabel(label: string): Promise;
+ }
+ /**
+ * Describes a single Version instance
+ *
+ */
+ export class Version extends QueryableInstance {
+ /**
+ * Creates a new instance of the Version class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Delete a specific version of a file.
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ }
+ export enum CheckinType {
+ Minor = 0,
+ Major = 1,
+ Overwrite = 2,
+ }
+ export interface FileAddResult {
+ file: File;
+ data: any;
+ }
+ export enum WebPartsPersonalizationScope {
+ User = 0,
+ Shared = 1,
+ }
+ export enum MoveOperations {
+ Overwrite = 1,
+ AllowBrokenThickets = 8,
+ }
+ export enum TemplateFileType {
+ StandardPage = 0,
+ WikiPage = 1,
+ FormPage = 2,
+ }
+}
+declare module "sharepoint/folders" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ import { Files } from "sharepoint/files";
+ /**
+ * Describes a collection of Folder objects
+ *
+ */
+ export class Folders extends QueryableCollection {
+ /**
+ * Creates a new instance of the Folders class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a folder by folder name
+ *
+ */
+ getByName(name: string): Folder;
+ /**
+ * Adds a new folder to the current folder (relative) or any folder (absolute)
+ *
+ * @param url The relative or absolute url where the new folder will be created. Urls starting with a forward slash are absolute.
+ * @returns The new Folder and the raw response.
+ */
+ add(url: string): Promise;
+ }
+ /**
+ * Describes a single Folder instance
+ *
+ */
+ export class Folder extends QueryableInstance {
+ /**
+ * Creates a new instance of the Folder class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Specifies the sequence in which content types are displayed.
+ *
+ */
+ readonly contentTypeOrder: QueryableCollection;
+ /**
+ * Gets this folder's files
+ *
+ */
+ readonly files: Files;
+ /**
+ * Gets this folder's sub folders
+ *
+ */
+ readonly folders: Folders;
+ /**
+ * Gets this folder's list item field values
+ *
+ */
+ readonly listItemAllFields: QueryableCollection;
+ /**
+ * Gets the parent folder, if available
+ *
+ */
+ readonly parentFolder: Folder;
+ /**
+ * Gets this folder's properties
+ *
+ */
+ readonly properties: QueryableInstance;
+ /**
+ * Gets this folder's server relative url
+ *
+ */
+ readonly serverRelativeUrl: Queryable;
+ /**
+ * Gets a value that specifies the content type order.
+ *
+ */
+ readonly uniqueContentTypeOrder: QueryableCollection;
+ /**
+ * Delete this folder
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ /**
+ * Moves the folder to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+ */
+ recycle(): Promise;
+ }
+ export interface FolderAddResult {
+ folder: Folder;
+ data: any;
+ }
+}
+declare module "sharepoint/contenttypes" {
+ import { TypedHash } from "collections/collections";
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ /**
+ * Describes a collection of content types
+ *
+ */
+ export class ContentTypes extends QueryableCollection {
+ /**
+ * Creates a new instance of the ContentTypes class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this content types collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a ContentType by content type id
+ */
+ getById(id: string): ContentType;
+ /**
+ * Adds an existing contenttype to a content type collection
+ *
+ * @param contentTypeId in the following format, for example: 0x010102
+ */
+ addAvailableContentType(contentTypeId: string): Promise;
+ /**
+ * Adds a new content type to the collection
+ *
+ * @param id The desired content type id for the new content type (also determines the parent content type)
+ * @param name The name of the content type
+ * @param description The description of the content type
+ * @param group The group in which to add the content type
+ * @param additionalSettings Any additional settings to provide when creating the content type
+ *
+ */
+ add(id: string, name: string, description?: string, group?: string, additionalSettings?: TypedHash): Promise;
+ }
+ /**
+ * Describes a single ContentType instance
+ *
+ */
+ export class ContentType extends QueryableInstance {
+ /**
+ * Creates a new instance of the ContentType class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this content type instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the column (also known as field) references in the content type.
+ */
+ readonly fieldLinks: FieldLinks;
+ /**
+ * Gets a value that specifies the collection of fields for the content type.
+ */
+ readonly fields: QueryableCollection;
+ /**
+ * Gets the parent content type of the content type.
+ */
+ readonly parent: ContentType;
+ /**
+ * Gets a value that specifies the collection of workflow associations for the content type.
+ */
+ readonly workflowAssociations: QueryableCollection;
+ }
+ export interface ContentTypeAddResult {
+ contentType: ContentType;
+ data: any;
+ }
+ /**
+ * Represents a collection of field link instances
+ */
+ export class FieldLinks extends QueryableCollection {
+ /**
+ * Creates a new instance of the ContentType class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this content type instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a FieldLink by GUID id
+ *
+ * @param id The GUID id of the field link
+ */
+ getById(id: string): FieldLink;
+ }
+ /**
+ * Represents a field link instance
+ */
+ export class FieldLink extends QueryableInstance {
+ /**
+ * Creates a new instance of the ContentType class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this content type instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ }
+}
+declare module "sharepoint/attachmentfiles" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ /**
+ * Describes a collection of Item objects
+ *
+ */
+ export class AttachmentFiles extends QueryableCollection {
+ /**
+ * Creates a new instance of the AttachmentFiles class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this attachments collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a Attachment File by filename
+ *
+ * @param name The name of the file, including extension.
+ */
+ getByName(name: string): AttachmentFile;
+ /**
+ * Adds a new attachment to the collection
+ *
+ * @param name The name of the file, including extension.
+ * @param content The Base64 file content.
+ */
+ add(name: string, content: string | Blob | ArrayBuffer): Promise;
+ }
+ /**
+ * Describes a single attachment file instance
+ *
+ */
+ export class AttachmentFile extends QueryableInstance {
+ /**
+ * Creates a new instance of the AttachmentFile class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this attachment file
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the contents of the file as text
+ *
+ */
+ getText(): Promise;
+ /**
+ * Gets the contents of the file as a blob, does not work in Node.js
+ *
+ */
+ getBlob(): Promise;
+ /**
+ * Gets the contents of a file as an ArrayBuffer, works in Node.js
+ */
+ getBuffer(): Promise;
+ /**
+ * Gets the contents of a file as an ArrayBuffer, works in Node.js
+ */
+ getJSON(): Promise;
+ /**
+ * Sets the content of a file
+ *
+ * @param content The value to set for the file contents
+ */
+ setContent(content: string | ArrayBuffer | Blob): Promise;
+ /**
+ * Delete this attachment file
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ }
+ export interface AttachmentFileAddResult {
+ file: AttachmentFile;
+ data: any;
+ }
+}
+declare module "sharepoint/items" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ import { QueryableSecurable } from "sharepoint/queryablesecurable";
+ import { Folder } from "sharepoint/folders";
+ import { File } from "sharepoint/files";
+ import { ContentType } from "sharepoint/contenttypes";
+ import { TypedHash } from "collections/collections";
+ import * as Types from "sharepoint/types";
+ import { AttachmentFiles } from "sharepoint/attachmentfiles";
+ /**
+ * Describes a collection of Item objects
+ *
+ */
+ export class Items extends QueryableCollection {
+ /**
+ * Creates a new instance of the Items class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets an Item by id
+ *
+ * @param id The integer id of the item to retrieve
+ */
+ getById(id: number): Item;
+ /**
+ * Skips the specified number of items (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#sectionSection6)
+ *
+ * @param skip The starting id where the page should start, use with top to specify pages
+ */
+ skip(skip: number): this;
+ /**
+ * Gets a collection designed to aid in paging through data
+ *
+ */
+ getPaged(): Promise>;
+ /**
+ * Adds a new item to the collection
+ *
+ * @param properties The new items's properties
+ */
+ add(properties?: TypedHash, listItemEntityTypeFullName?: string): Promise;
+ }
+ /**
+ * Descrines a single Item instance
+ *
+ */
+ export class Item extends QueryableSecurable {
+ /**
+ * Creates a new instance of the Items class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the set of attachments for this item
+ *
+ */
+ readonly attachmentFiles: AttachmentFiles;
+ /**
+ * Gets the content type for this item
+ *
+ */
+ readonly contentType: ContentType;
+ /**
+ * Gets the effective base permissions for the item
+ *
+ */
+ readonly effectiveBasePermissions: Queryable;
+ /**
+ * Gets the effective base permissions for the item in a UI context
+ *
+ */
+ readonly effectiveBasePermissionsForUI: Queryable;
+ /**
+ * Gets the field values for this list item in their HTML representation
+ *
+ */
+ readonly fieldValuesAsHTML: QueryableInstance;
+ /**
+ * Gets the field values for this list item in their text representation
+ *
+ */
+ readonly fieldValuesAsText: QueryableInstance;
+ /**
+ * Gets the field values for this list item for use in editing controls
+ *
+ */
+ readonly fieldValuesForEdit: QueryableInstance;
+ /**
+ * Gets the folder associated with this list item (if this item represents a folder)
+ *
+ */
+ readonly folder: Folder;
+ /**
+ * Gets the folder associated with this list item (if this item represents a folder)
+ *
+ */
+ readonly file: File;
+ /**
+ * Updates this list intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the list
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ update(properties: TypedHash, eTag?: string): Promise;
+ /**
+ * Delete this item
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ /**
+ * Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+ */
+ recycle(): Promise;
+ /**
+ * Gets a string representation of the full URL to the WOPI frame.
+ * If there is no associated WOPI application, or no associated action, an empty string is returned.
+ *
+ * @param action Display mode: 0: view, 1: edit, 2: mobileView, 3: interactivePreview
+ */
+ getWopiFrameUrl(action?: number): Promise;
+ /**
+ * Validates and sets the values of the specified collection of fields for the list item.
+ *
+ * @param formValues The fields to change and their new values.
+ * @param newDocumentUpdate true if the list item is a document being updated after upload; otherwise false.
+ */
+ validateUpdateListItem(formValues: Types.ListItemFormUpdateValue[], newDocumentUpdate?: boolean): Promise;
+ }
+ export interface ItemAddResult {
+ item: Item;
+ data: any;
+ }
+ export interface ItemUpdateResult {
+ item: Item;
+ data: ItemUpdateResultData;
+ }
+ export interface ItemUpdateResultData {
+ "odata.etag": string;
+ }
+ /**
+ * Provides paging functionality for list items
+ */
+ export class PagedItemCollection {
+ private nextUrl;
+ results: T;
+ constructor(nextUrl: string, results: T);
+ /**
+ * If true there are more results available in the set, otherwise there are not
+ */
+ readonly hasNext: boolean;
+ /**
+ * Gets the next set of results, or resolves to null if no results are available
+ */
+ getNext(): Promise>;
+ }
+}
+declare module "sharepoint/views" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ import { TypedHash } from "collections/collections";
+ /**
+ * Describes the views available in the current context
+ *
+ */
+ export class Views extends QueryableCollection {
+ /**
+ * Creates a new instance of the Views class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable);
+ /**
+ * Gets a view by guid id
+ *
+ * @param id The GUID id of the view
+ */
+ getById(id: string): View;
+ /**
+ * Gets a view by title (case-sensitive)
+ *
+ * @param title The case-sensitive title of the view
+ */
+ getByTitle(title: string): View;
+ /**
+ * Adds a new view to the collection
+ *
+ * @param title The new views's title
+ * @param personalView True if this is a personal view, otherwise false, default = false
+ * @param additionalSettings Will be passed as part of the view creation body
+ */
+ add(title: string, personalView?: boolean, additionalSettings?: TypedHash): Promise;
+ }
+ /**
+ * Describes a single View instance
+ *
+ */
+ export class View extends QueryableInstance {
+ /**
+ * Creates a new instance of the View class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ readonly fields: ViewFields;
+ /**
+ * Updates this view intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the view
+ */
+ update(properties: TypedHash): Promise;
+ /**
+ * Delete this view
+ *
+ */
+ delete(): Promise;
+ /**
+ * Returns the list view as HTML.
+ *
+ */
+ renderAsHtml(): Promise;
+ }
+ export class ViewFields extends QueryableCollection {
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a value that specifies the XML schema that represents the collection.
+ */
+ getSchemaXml(): Promise;
+ /**
+ * Adds the field with the specified field internal name or display name to the collection.
+ *
+ * @param fieldTitleOrInternalName The case-sensitive internal name or display name of the field to add.
+ */
+ add(fieldTitleOrInternalName: string): Promise;
+ /**
+ * Moves the field with the specified field internal name to the specified position in the collection.
+ *
+ * @param fieldInternalName The case-sensitive internal name of the field to move.
+ * @param index The zero-based index of the new position for the field.
+ */
+ move(fieldInternalName: string, index: number): Promise;
+ /**
+ * Removes all the fields from the collection.
+ */
+ removeAll(): Promise;
+ /**
+ * Removes the field with the specified field internal name from the collection.
+ *
+ * @param fieldInternalName The case-sensitive internal name of the field to remove from the view.
+ */
+ remove(fieldInternalName: string): Promise;
+ }
+ export interface ViewAddResult {
+ view: View;
+ data: any;
+ }
+ export interface ViewUpdateResult {
+ view: View;
+ data: any;
+ }
+}
+declare module "sharepoint/fields" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ import { TypedHash } from "collections/collections";
+ import * as Types from "sharepoint/types";
+ /**
+ * Describes a collection of Field objects
+ *
+ */
+ export class Fields extends QueryableCollection {
+ /**
+ * Creates a new instance of the Fields class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a field from the collection by title
+ *
+ * @param title The case-sensitive title of the field
+ */
+ getByTitle(title: string): Field;
+ /**
+ * Gets a field from the collection by using internal name or title
+ *
+ * @param name The case-sensitive internal name or title of the field
+ */
+ getByInternalNameOrTitle(name: string): Field;
+ /**
+ * Gets a list from the collection by guid id
+ *
+ * @param title The Id of the list
+ */
+ getById(id: string): Field;
+ /**
+ * Creates a field based on the specified schema
+ */
+ createFieldAsXml(xml: string | Types.XmlSchemaFieldCreationInformation): Promise;
+ /**
+ * Adds a new list to the collection
+ *
+ * @param title The new field's title
+ * @param fieldType The new field's type (ex: SP.FieldText)
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ add(title: string, fieldType: string, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldText to the collection
+ *
+ * @param title The field title
+ * @param maxLength The maximum number of characters allowed in the value of the field.
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ addText(title: string, maxLength?: number, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldCalculated to the collection
+ *
+ * @param title The field title.
+ * @param formula The formula for the field.
+ * @param dateFormat The date and time format that is displayed in the field.
+ * @param outputType Specifies the output format for the field. Represents a FieldType value.
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ addCalculated(title: string, formula: string, dateFormat: Types.DateTimeFieldFormatType, outputType?: Types.FieldTypes, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldDateTime to the collection
+ *
+ * @param title The field title
+ * @param displayFormat The format of the date and time that is displayed in the field.
+ * @param calendarType Specifies the calendar type of the field.
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ addDateTime(title: string, displayFormat?: Types.DateTimeFieldFormatType, calendarType?: Types.CalendarType, friendlyDisplayFormat?: number, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldNumber to the collection
+ *
+ * @param title The field title
+ * @param minValue The field's minimum value
+ * @param maxValue The field's maximum value
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ addNumber(title: string, minValue?: number, maxValue?: number, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldCurrency to the collection
+ *
+ * @param title The field title
+ * @param minValue The field's minimum value
+ * @param maxValue The field's maximum value
+ * @param currencyLocalId Specifies the language code identifier (LCID) used to format the value of the field
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ */
+ addCurrency(title: string, minValue?: number, maxValue?: number, currencyLocalId?: number, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldMultiLineText to the collection
+ *
+ * @param title The field title
+ * @param numberOfLines Specifies the number of lines of text to display for the field.
+ * @param richText Specifies whether the field supports rich formatting.
+ * @param restrictedMode Specifies whether the field supports a subset of rich formatting.
+ * @param appendOnly Specifies whether all changes to the value of the field are displayed in list forms.
+ * @param allowHyperlink Specifies whether a hyperlink is allowed as a value of the field.
+ * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+ *
+ */
+ addMultilineText(title: string, numberOfLines?: number, richText?: boolean, restrictedMode?: boolean, appendOnly?: boolean, allowHyperlink?: boolean, properties?: TypedHash): Promise;
+ /**
+ * Adds a new SP.FieldUrl to the collection
+ *
+ * @param title The field title
+ */
+ addUrl(title: string, displayFormat?: Types.UrlFieldFormatType, properties?: TypedHash): Promise;
+ }
+ /**
+ * Describes a single of Field instance
+ *
+ */
+ export class Field extends QueryableInstance {
+ /**
+ * Creates a new instance of the Field class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this field instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Updates this field intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the list
+ * @param fieldType The type value, required to update child field type properties
+ */
+ update(properties: TypedHash, fieldType?: string): Promise;
+ /**
+ * Delete this fields
+ *
+ */
+ delete(): Promise;
+ /**
+ * Sets the value of the ShowInDisplayForm property for this field.
+ */
+ setShowInDisplayForm(show: boolean): Promise;
+ /**
+ * Sets the value of the ShowInEditForm property for this field.
+ */
+ setShowInEditForm(show: boolean): Promise;
+ /**
+ * Sets the value of the ShowInNewForm property for this field.
+ */
+ setShowInNewForm(show: boolean): Promise;
+ }
+ export interface FieldAddResult {
+ data: any;
+ field: Field;
+ }
+ export interface FieldUpdateResult {
+ data: any;
+ field: Field;
+ }
+}
+declare module "sharepoint/forms" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ /**
+ * Describes a collection of Field objects
+ *
+ */
+ export class Forms extends QueryableCollection {
+ /**
+ * Creates a new instance of the Fields class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a form by id
+ *
+ * @param id The guid id of the item to retrieve
+ */
+ getById(id: string): Form;
+ }
+ /**
+ * Describes a single of Form instance
+ *
+ */
+ export class Form extends QueryableInstance {
+ /**
+ * Creates a new instance of the Form class
+ *
+ * @param baseUrl The url or Queryable which is the parent of this form instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ }
+}
+declare module "sharepoint/subscriptions" {
+ import { Queryable, QueryableCollection, QueryableInstance } from "sharepoint/queryable";
+ /**
+ * Describes a collection of webhook subscriptions
+ *
+ */
+ export class Subscriptions extends QueryableCollection {
+ /**
+ * Creates a new instance of the Subscriptions class
+ *
+ * @param baseUrl - The url or Queryable which forms the parent of this webhook subscriptions collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Returns all the webhook subscriptions or the specified webhook subscription
+ *
+ */
+ getById(subscriptionId: string): Subscription;
+ /**
+ * Create a new webhook subscription
+ *
+ */
+ add(notificationUrl: string, expirationDate: string, clientState?: string): Promise;
+ }
+ /**
+ * Describes a single webhook subscription instance
+ *
+ */
+ export class Subscription extends QueryableInstance {
+ /**
+ * Creates a new instance of the Subscription class
+ *
+ * @param baseUrl - The url or Queryable which forms the parent of this webhook subscription instance
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Update a webhook subscription
+ *
+ */
+ update(expirationDate: string): Promise;
+ /**
+ * Remove a webhook subscription
+ *
+ */
+ delete(): Promise;
+ }
+ export interface SubscriptionAddResult {
+ subscription: Subscription;
+ data: any;
+ }
+ export interface SubscriptionUpdateResult {
+ subscription: Subscription;
+ data: any;
+ }
+}
+declare module "sharepoint/usercustomactions" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import { TypedHash } from "collections/collections";
+ export class UserCustomActions extends QueryableCollection {
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Returns the custom action with the specified identifier.
+ *
+ * @param id The GUID ID of the user custom action to get.
+ */
+ getById(id: string): UserCustomAction;
+ /**
+ * Create a custom action
+ *
+ * @param creationInfo The information which defines the new custom action
+ *
+ */
+ add(properties: TypedHash): Promise;
+ /**
+ * Deletes all custom actions in the collection.
+ *
+ */
+ clear(): Promise;
+ }
+ export class UserCustomAction extends QueryableInstance {
+ constructor(baseUrl: string | Queryable, path?: string);
+ update(properties: TypedHash): Promise;
+ /**
+ * Remove a custom action
+ *
+ */
+ delete(): Promise;
+ }
+ export interface UserCustomActionAddResult {
+ data: any;
+ action: UserCustomAction;
+ }
+ export interface UserCustomActionUpdateResult {
+ data: any;
+ action: UserCustomAction;
+ }
+}
+declare module "sharepoint/lists" {
+ import { Items } from "sharepoint/items";
+ import { Views, View } from "sharepoint/views";
+ import { ContentTypes } from "sharepoint/contenttypes";
+ import { Fields } from "sharepoint/fields";
+ import { Forms } from "sharepoint/forms";
+ import { Subscriptions } from "sharepoint/subscriptions";
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import { QueryableSecurable } from "sharepoint/queryablesecurable";
+ import { TypedHash } from "collections/collections";
+ import { ControlMode, RenderListData, ChangeQuery, CamlQuery, ChangeLogitemQuery, ListFormData } from "sharepoint/types";
+ import { UserCustomActions } from "sharepoint/usercustomactions";
+ /**
+ * Describes a collection of List objects
+ *
+ */
+ export class Lists extends QueryableCollection {
+ /**
+ * Creates a new instance of the Lists class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a list from the collection by title
+ *
+ * @param title The title of the list
+ */
+ getByTitle(title: string): List;
+ /**
+ * Gets a list from the collection by guid id
+ *
+ * @param id The Id of the list (GUID)
+ */
+ getById(id: string): List;
+ /**
+ * Adds a new list to the collection
+ *
+ * @param title The new list's title
+ * @param description The new list's description
+ * @param template The list template value
+ * @param enableContentTypes If true content types will be allowed and enabled, otherwise they will be disallowed and not enabled
+ * @param additionalSettings Will be passed as part of the list creation body
+ */
+ add(title: string, description?: string, template?: number, enableContentTypes?: boolean, additionalSettings?: TypedHash): Promise;
+ /**
+ * Ensures that the specified list exists in the collection (note: this method not supported for batching)
+ *
+ * @param title The new list's title
+ * @param description The new list's description
+ * @param template The list template value
+ * @param enableContentTypes If true content types will be allowed and enabled, otherwise they will be disallowed and not enabled
+ * @param additionalSettings Will be passed as part of the list creation body or used to update an existing list
+ */
+ ensure(title: string, description?: string, template?: number, enableContentTypes?: boolean, additionalSettings?: TypedHash): Promise;
+ /**
+ * Gets a list that is the default asset location for images or other files, which the users upload to their wiki pages.
+ */
+ ensureSiteAssetsLibrary(): Promise;
+ /**
+ * Gets a list that is the default location for wiki pages.
+ */
+ ensureSitePagesLibrary(): Promise;
+ }
+ /**
+ * Describes a single List instance
+ *
+ */
+ export class List extends QueryableSecurable {
+ /**
+ * Creates a new instance of the Lists class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ * @param path Optional, if supplied will be appended to the supplied baseUrl
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the content types in this list
+ *
+ */
+ readonly contentTypes: ContentTypes;
+ /**
+ * Gets the items in this list
+ *
+ */
+ readonly items: Items;
+ /**
+ * Gets the views in this list
+ *
+ */
+ readonly views: Views;
+ /**
+ * Gets the fields in this list
+ *
+ */
+ readonly fields: Fields;
+ /**
+ * Gets the forms in this list
+ *
+ */
+ readonly forms: Forms;
+ /**
+ * Gets the default view of this list
+ *
+ */
+ readonly defaultView: QueryableInstance;
+ /**
+ * Get all custom actions on a site collection
+ *
+ */
+ readonly userCustomActions: UserCustomActions;
+ /**
+ * Gets the effective base permissions of this list
+ *
+ */
+ readonly effectiveBasePermissions: Queryable;
+ /**
+ * Gets the event receivers attached to this list
+ *
+ */
+ readonly eventReceivers: QueryableCollection;
+ /**
+ * Gets the related fields of this list
+ *
+ */
+ readonly relatedFields: Queryable;
+ /**
+ * Gets the IRM settings for this list
+ *
+ */
+ readonly informationRightsManagementSettings: Queryable;
+ /**
+ * Gets the webhook subscriptions of this list
+ *
+ */
+ readonly subscriptions: Subscriptions;
+ /**
+ * Gets a view by view guid id
+ *
+ */
+ getView(viewId: string): View;
+ /**
+ * Updates this list intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the list
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ update(properties: TypedHash, eTag?: string): Promise;
+ /**
+ * Delete this list
+ *
+ * @param eTag Value used in the IF-Match header, by default "*"
+ */
+ delete(eTag?: string): Promise;
+ /**
+ * Returns the collection of changes from the change log that have occurred within the list, based on the specified query.
+ */
+ getChanges(query: ChangeQuery): Promise;
+ /**
+ * Returns a collection of items from the list based on the specified query.
+ *
+ * @param CamlQuery The Query schema of Collaborative Application Markup
+ * Language (CAML) is used in various ways within the context of Microsoft SharePoint Foundation
+ * to define queries against list data.
+ * see:
+ *
+ * https://msdn.microsoft.com/en-us/library/office/ms467521.aspx
+ *
+ * @param expands A URI with a $expand System Query Option indicates that Entries associated with
+ * the Entry or Collection of Entries identified by the Resource Path
+ * section of the URI must be represented inline (i.e. eagerly loaded).
+ * see:
+ *
+ * https://msdn.microsoft.com/en-us/library/office/fp142385.aspx
+ *
+ * http://www.odata.org/documentation/odata-version-2-0/uri-conventions/#ExpandSystemQueryOption
+ */
+ getItemsByCAMLQuery(query: CamlQuery, ...expands: string[]): Promise;
+ /**
+ * See: https://msdn.microsoft.com/en-us/library/office/dn292554.aspx
+ */
+ getListItemChangesSinceToken(query: ChangeLogitemQuery): Promise;
+ /**
+ * Moves the list to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+ */
+ recycle(): Promise;
+ /**
+ * Renders list data based on the view xml provided
+ */
+ renderListData(viewXml: string): Promise;
+ /**
+ * Gets the field values and field schema attributes for a list item.
+ */
+ renderListFormData(itemId: number, formId: string, mode: ControlMode): Promise;
+ /**
+ * Reserves a list item ID for idempotent list item creation.
+ */
+ reserveListItemId(): Promise;
+ /**
+ * Returns the ListItemEntityTypeFullName for this list, used when adding/updating list items
+ *
+ */
+ getListItemEntityTypeFullName(): Promise;
+ }
+ export interface ListAddResult {
+ list: List;
+ data: any;
+ }
+ export interface ListUpdateResult {
+ list: List;
+ data: any;
+ }
+ export interface ListEnsureResult {
+ list: List;
+ created: boolean;
+ data: any;
+ }
+}
+declare module "sharepoint/navigation" {
+ import { TypedHash } from "collections/collections";
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ export interface NavigationNodeAddResult {
+ data: any;
+ node: NavigationNode;
+ }
+ export interface NavigationNodeUpdateResult {
+ data: any;
+ node: NavigationNode;
+ }
+ /**
+ * Represents a collection of navigation nodes
+ *
+ */
+ export class NavigationNodes extends QueryableCollection {
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a navigation node by id
+ *
+ * @param id The id of the node
+ */
+ getById(id: number): NavigationNode;
+ /**
+ * Adds a new node to the collection
+ *
+ * @param title Display name of the node
+ * @param url The url of the node
+ * @param visible If true the node is visible, otherwise it is hidden (default: true)
+ */
+ add(title: string, url: string, visible?: boolean): Promise;
+ /**
+ * Moves a node to be after another node in the navigation
+ *
+ * @param nodeId Id of the node to move
+ * @param previousNodeId Id of the node after which we move the node specified by nodeId
+ */
+ moveAfter(nodeId: number, previousNodeId: number): Promise;
+ }
+ export class NavigationNode extends QueryableInstance {
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Represents the child nodes of this node
+ */
+ readonly children: NavigationNodes;
+ /**
+ * Updates this node based on the supplied properties
+ *
+ * @param properties The hash of key/value pairs to update
+ */
+ update(properties: TypedHash): Promise;
+ /**
+ * Deletes this node and any child nodes
+ */
+ delete(): Promise;
+ }
+ /**
+ * Exposes the navigation components
+ *
+ */
+ export class Navigation extends Queryable {
+ /**
+ * Creates a new instance of the Lists class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the quicklaunch navigation for the current context
+ *
+ */
+ readonly quicklaunch: NavigationNodes;
+ /**
+ * Gets the top bar navigation navigation for the current context
+ *
+ */
+ readonly topNavigationBar: NavigationNodes;
+ }
+}
+declare module "sharepoint/features" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ /**
+ * Describes a collection of List objects
+ *
+ */
+ export class Features extends QueryableCollection {
+ /**
+ * Creates a new instance of the Lists class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets a list from the collection by guid id
+ *
+ * @param id The Id of the feature (GUID)
+ */
+ getById(id: string): Feature;
+ /**
+ * Adds a new list to the collection
+ *
+ * @param id The Id of the feature (GUID)
+ * @param force If true the feature activation will be forced
+ */
+ add(id: string, force?: boolean): Promise;
+ /**
+ * Removes (deactivates) a feature from the collection
+ *
+ * @param id The Id of the feature (GUID)
+ * @param force If true the feature deactivation will be forced
+ */
+ remove(id: string, force?: boolean): Promise;
+ }
+ export class Feature extends QueryableInstance {
+ /**
+ * Creates a new instance of the Lists class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Removes (deactivates) a feature from the collection
+ *
+ * @param force If true the feature deactivation will be forced
+ */
+ deactivate(force?: boolean): Promise;
+ }
+ export interface FeatureAddResult {
+ data: any;
+ feature: Feature;
+ }
+}
+declare module "sharepoint/webs" {
+ import { Queryable, QueryableCollection } from "sharepoint/queryable";
+ import { QueryableSecurable } from "sharepoint/queryablesecurable";
+ import { Lists } from "sharepoint/lists";
+ import { Fields } from "sharepoint/fields";
+ import { Navigation } from "sharepoint/navigation";
+ import { SiteGroups } from "sharepoint/sitegroups";
+ import { ContentTypes } from "sharepoint/contenttypes";
+ import { Folders, Folder } from "sharepoint/folders";
+ import { RoleDefinitions } from "sharepoint/roles";
+ import { File } from "sharepoint/files";
+ import { TypedHash } from "collections/collections";
+ import * as Types from "sharepoint/types";
+ import { List } from "sharepoint/lists";
+ import { SiteUsers, SiteUser, CurrentUser } from "sharepoint/siteusers";
+ import { UserCustomActions } from "sharepoint/usercustomactions";
+ import { ODataBatch } from "sharepoint/odata";
+ import { Features } from "sharepoint/features";
+ export class Webs extends QueryableCollection {
+ constructor(baseUrl: string | Queryable, webPath?: string);
+ /**
+ * Adds a new web to the collection
+ *
+ * @param title The new web's title
+ * @param url The new web's relative url
+ * @param description The web web's description
+ * @param template The web's template
+ * @param language The language code to use for this web
+ * @param inheritPermissions If true permissions will be inherited from the partent web
+ * @param additionalSettings Will be passed as part of the web creation body
+ */
+ add(title: string, url: string, description?: string, template?: string, language?: number, inheritPermissions?: boolean, additionalSettings?: TypedHash): Promise;
+ }
+ /**
+ * Describes a web
+ *
+ */
+ export class Web extends QueryableSecurable {
+ constructor(baseUrl: string | Queryable, path?: string);
+ readonly webs: Webs;
+ /**
+ * Get the content types available in this web
+ *
+ */
+ readonly contentTypes: ContentTypes;
+ /**
+ * Get the lists in this web
+ *
+ */
+ readonly lists: Lists;
+ /**
+ * Gets the fields in this web
+ *
+ */
+ readonly fields: Fields;
+ /**
+ * Gets the active features for this web
+ *
+ */
+ readonly features: Features;
+ /**
+ * Gets the available fields in this web
+ *
+ */
+ readonly availablefields: Fields;
+ /**
+ * Get the navigation options in this web
+ *
+ */
+ readonly navigation: Navigation;
+ /**
+ * Gets the site users
+ *
+ */
+ readonly siteUsers: SiteUsers;
+ /**
+ * Gets the site groups
+ *
+ */
+ readonly siteGroups: SiteGroups;
+ /**
+ * Gets the current user
+ */
+ readonly currentUser: CurrentUser;
+ /**
+ * Get the folders in this web
+ *
+ */
+ readonly folders: Folders;
+ /**
+ * Get all custom actions on a site
+ *
+ */
+ readonly userCustomActions: UserCustomActions;
+ /**
+ * Gets the collection of RoleDefinition resources.
+ *
+ */
+ readonly roleDefinitions: RoleDefinitions;
+ /**
+ * Creates a new batch for requests within the context of context this web
+ *
+ */
+ createBatch(): ODataBatch;
+ /**
+ * Get a folder by server relative url
+ *
+ * @param folderRelativeUrl the server relative path to the folder (including /sites/ if applicable)
+ */
+ getFolderByServerRelativeUrl(folderRelativeUrl: string): Folder;
+ /**
+ * Get a file by server relative url
+ *
+ * @param fileRelativeUrl the server relative path to the file (including /sites/ if applicable)
+ */
+ getFileByServerRelativeUrl(fileRelativeUrl: string): File;
+ /**
+ * Get a list by server relative url (list's root folder)
+ *
+ * @param listRelativeUrl the server relative path to the list's root folder (including /sites/ if applicable)
+ */
+ getList(listRelativeUrl: string): List;
+ /**
+ * Updates this web intance with the supplied properties
+ *
+ * @param properties A plain object hash of values to update for the web
+ */
+ update(properties: TypedHash): Promise;
+ /**
+ * Delete this web
+ *
+ */
+ delete(): Promise;
+ /**
+ * Applies the theme specified by the contents of each of the files specified in the arguments to the site.
+ *
+ * @param colorPaletteUrl Server-relative URL of the color palette file.
+ * @param fontSchemeUrl Server-relative URL of the font scheme.
+ * @param backgroundImageUrl Server-relative URL of the background image.
+ * @param shareGenerated true to store the generated theme files in the root site, or false to store them in this site.
+ */
+ applyTheme(colorPaletteUrl: string, fontSchemeUrl: string, backgroundImageUrl: string, shareGenerated: boolean): Promise;
+ /**
+ * Applies the specified site definition or site template to the Web site that has no template applied to it.
+ *
+ * @param template Name of the site definition or the name of the site template
+ */
+ applyWebTemplate(template: string): Promise;
+ /**
+ * Returns whether the current user has the given set of permissions.
+ *
+ * @param perms The high and low permission range.
+ */
+ doesUserHavePermissions(perms: Types.BasePermissions): Promise;
+ /**
+ * Checks whether the specified login name belongs to a valid user in the site. If the user doesn't exist, adds the user to the site.
+ *
+ * @param loginName The login name of the user (ex: i:0#.f|membership|user@domain.onmicrosoft.com)
+ */
+ ensureUser(loginName: string): Promise;
+ /**
+ * Returns a collection of site templates available for the site.
+ *
+ * @param language The LCID of the site templates to get.
+ * @param true to include language-neutral site templates; otherwise false
+ */
+ availableWebTemplates(language?: number, includeCrossLanugage?: boolean): QueryableCollection;
+ /**
+ * Returns the list gallery on the site.
+ *
+ * @param type The gallery type - WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114,
+ * MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125
+ */
+ getCatalog(type: number): Promise;
+ /**
+ * Returns the collection of changes from the change log that have occurred within the list, based on the specified query.
+ */
+ getChanges(query: Types.ChangeQuery): Promise;
+ /**
+ * Gets the custom list templates for the site.
+ *
+ */
+ readonly customListTemplate: QueryableCollection;
+ /**
+ * Returns the user corresponding to the specified member identifier for the current site.
+ *
+ * @param id The ID of the user.
+ */
+ getUserById(id: number): SiteUser;
+ /**
+ * Returns the name of the image file for the icon that is used to represent the specified file.
+ *
+ * @param filename The file name. If this parameter is empty, the server returns an empty string.
+ * @param size The size of the icon: 16x16 pixels = 0, 32x32 pixels = 1.
+ * @param progId The ProgID of the application that was used to create the file, in the form OLEServerName.ObjectName
+ */
+ mapToIcon(filename: string, size?: number, progId?: string): Promise;
+ }
+ export interface WebAddResult {
+ data: any;
+ web: Web;
+ }
+ export interface WebUpdateResult {
+ data: any;
+ web: Web;
+ }
+ export interface GetCatalogResult {
+ data: any;
+ list: List;
+ }
+}
+declare module "sharepoint/site" {
+ import { Queryable, QueryableInstance } from "sharepoint/queryable";
+ import { Web } from "sharepoint/webs";
+ import { UserCustomActions } from "sharepoint/usercustomactions";
+ import { ContextInfo, DocumentLibraryInformation } from "sharepoint/types";
+ import { ODataBatch } from "sharepoint/odata";
+ import { Features } from "sharepoint/features";
+ /**
+ * Describes a site collection
+ *
+ */
+ export class Site extends QueryableInstance {
+ /**
+ * Creates a new instance of the RoleAssignments class
+ *
+ * @param baseUrl The url or Queryable which forms the parent of this fields collection
+ */
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * Gets the root web of the site collection
+ *
+ */
+ readonly rootWeb: Web;
+ /**
+ * Gets the active features for this site
+ *
+ */
+ readonly features: Features;
+ /**
+ * Get all custom actions on a site collection
+ *
+ */
+ readonly userCustomActions: UserCustomActions;
+ /**
+ * Gets the context information for the site.
+ */
+ getContextInfo(): Promise;
+ /**
+ * Gets the document libraries on a site. Static method. (SharePoint Online only)
+ *
+ * @param absoluteWebUrl The absolute url of the web whose document libraries should be returned
+ */
+ getDocumentLibraries(absoluteWebUrl: string): Promise;
+ /**
+ * Gets the site URL from a page URL.
+ *
+ * @param absolutePageUrl The absolute url of the page
+ */
+ getWebUrlFromPageUrl(absolutePageUrl: string): Promise;
+ /**
+ * Creates a new batch for requests within the context of context this site
+ *
+ */
+ createBatch(): ODataBatch;
+ }
+}
+declare module "utils/files" {
+ /**
+ * Reads a blob as text
+ *
+ * @param blob The data to read
+ */
+ export function readBlobAsText(blob: Blob): Promise;
+ /**
+ * Reads a blob into an array buffer
+ *
+ * @param blob The data to read
+ */
+ export function readBlobAsArrayBuffer(blob: Blob): Promise;
+}
+declare module "sharepoint/userprofiles" {
+ import { Queryable, QueryableInstance, QueryableCollection } from "sharepoint/queryable";
+ import * as Types from "sharepoint/types";
+ export class UserProfileQuery extends QueryableInstance {
+ private profileLoader;
+ constructor(baseUrl: string | Queryable, path?: string);
+ /**
+ * The URL of the edit profile page for the current user.
+ */
+ readonly editProfileLink: Promise;
+ /**
+ * A Boolean value that indicates whether the current user's People I'm Following list is public.
+ */
+ readonly isMyPeopleListPublic: Promise;
+ /**
+ * A Boolean value that indicates whether the current user's People I'm Following list is public.
+ *
+ * @param loginName The account name of the user
+ */
+ amIFollowedBy(loginName: string): Promise;
+ /**
+ * Checks whether the current user is following the specified user.
+ *
+ * @param loginName The account name of the user
+ */
+ amIFollowing(loginName: string): Promise;
+ /**
+ * Gets tags that the user is following.
+ *
+ * @param maxCount The maximum number of tags to get.
+ */
+ getFollowedTags(maxCount?: number): Promise