@pnp/sp - npm Package Compare versions

Comparing version 1.0.4-0 to 1.0.4-1

package.json

 {
     "name": "@pnp/sp",
-    "version": "1.0.4-0",
+    "version": "1.0.4-1",
     "description": "pnp - provides a fluent api for working with SharePoint REST",
@@ -11,5 +11,5 @@ "main": "./dist/sp.es5.umd.js",
     "peerDependencies": {
-        "@pnp/common": "1.0.4-0",
-        "@pnp/logging": "1.0.4-0",
-        "@pnp/odata": "1.0.4-0"
+        "@pnp/common": "1.0.4-1",
+        "@pnp/logging": "1.0.4-1",
+        "@pnp/odata": "1.0.4-1"
     },
@@ -16,0 +16,0 @@ "author": {

src/types.d.ts

@@ -574,16 +574,58 @@ import { TypedHash } from "@pnp/common";
 }
-export declare enum PrincipalType {
+/**
+ * Specifies the type of a principal.
+ */
+export declare const enum PrincipalType {
+    /**
+     * Enumeration whose value specifies no principal type.
+     */
     None = 0,
+    /**
+     * Enumeration whose value specifies a user as the principal type.
+     */
     User = 1,
+    /**
+     * Enumeration whose value specifies a distribution list as the principal type.
+     */
     DistributionList = 2,
+    /**
+     * Enumeration whose value specifies a security group as the principal type.
+     */
     SecurityGroup = 4,
+    /**
+     * Enumeration whose value specifies a group as the principal type.
+     */
     SharePointGroup = 8,
+    /**
+     * Enumeration whose value specifies all principal types.
+     */
     All = 15,
 }
-export declare enum PrincipalSource {
+/**
+ * Specifies the source of a principal.
+ */
+export declare const enum PrincipalSource {
+    /**
+     * Enumeration whose value specifies no principal source.
+     */
     None = 0,
+    /**
+     * Enumeration whose value specifies user information list as the principal source.
+     */
     UserInfoList = 1,
+    /**
+     * Enumeration whose value specifies Active Directory as the principal source.
+     */
     Windows = 2,
+    /**
+     * Enumeration whose value specifies the current membership provider as the principal source.
+     */
     MembershipProvider = 4,
+    /**
+     * Enumeration whose value specifies the current role provider as the principal source.
+     */
     RoleProvider = 8,
+    /**
+     * Enumeration whose value specifies all principal sources.
+     */
     All = 15,
@@ -1316,1 +1358,127 @@ }
 }
+/**
+ * Client people picker query parameters
+ */
+export interface ClientPeoplePickerQueryParameters {
+    /**
+     * Gets or sets a value that specifies whether e-mail addresses can be used to perform search.
+     */
+    AllowEmailAddresses?: boolean;
+    /**
+     * Gets or sets a value that specifies whether multiple entities are allowed.
+     */
+    AllowMultipleEntities?: boolean;
+    /**
+     * Gets or sets a value that specifies whether only e-mail addresses can be used to perform search.
+     */
+    AllowOnlyEmailAddresses?: boolean;
+    /**
+     * Gets or sets a value that specifies whether all URL zones are used to perform search.
+     */
+    AllUrlZones?: boolean;
+    /**
+     * Gets or sets a value that specifies claim providers that are used to perform search.
+     */
+    EnabledClaimProviders?: string;
+    /**
+     * Gets or sets a value that specifies whether claims are forced (if yes, multiple results for single entity can be returned).
+     */
+    ForceClaims?: boolean;
+    /**
+     * Gets or sets a value that specifies limit of results returned.
+     */
+    MaximumEntitySuggestions: number;
+    /**
+     * Gets or sets a value that specifies principal sources to perform search.
+     */
+    PrincipalSource?: PrincipalSource;
+    /**
+     * Gets or sets a value that specifies principal types to search for.
+     */
+    PrincipalType?: PrincipalType;
+    /**
+     * Gets or sets a value that specifies additional query settings.
+     */
+    QuerySettings?: PeoplePickerQuerySettings;
+    /**
+     * Gets or sets a value that specifies the term to search for.
+     */
+    QueryString: string;
+    /**
+     * Gets or sets a value that specifies ID of the SharePoint Group that will be used to perform search.
+     */
+    SharePointGroupID?: number;
+    /**
+     * Gets or sets a value that specifies URL zones that are used to perform search.
+     */
+    UrlZone?: UrlZone;
+    /**
+     * Gets or sets a value that specifies whether search is limited to specific URL zone.
+     */
+    UrlZoneSpecified?: boolean;
+    /**
+     * Gets or sets a value that specifies GUID of the Web Application that is used to perform search.
+     */
+    WebApplicationID?: string;
+}
+/**
+ * People picker query settings
+ */
+export interface PeoplePickerQuerySettings {
+    ExcludeAllUsersOnTenantClaim?: boolean;
+}
+/**
+ * People picker entity
+ */
+export interface PeoplePickerEntity {
+    Description: string;
+    DisplayText: string;
+    EntityData: PeoplePickerEntityData;
+    EntityType: string;
+    IsResolved: boolean;
+    Key: string;
+    MultipleMatches: PeoplePickerEntityData[];
+    ProviderDisplayName: string;
+    ProviderName: string;
+}
+/**
+ * People picker entity data
+ */
+export interface PeoplePickerEntityData {
+    AccountName?: string;
+    Department?: string;
+    Email?: string;
+    IsAltSecIdPresent?: string;
+    MobilePhone?: string;
+    ObjectId?: string;
+    OtherMails?: string;
+    PrincipalType?: string;
+    SPGroupID?: string;
+    SPUserID?: string;
+    Title?: string;
+}
+/**
+ * Specifies the originating zone of a request received.
+ */
+export declare const enum UrlZone {
+    /**
+     * Specifies the default zone used for requests unless another zone is specified.
+     */
+    DefaultZone = 0,
+    /**
+     * Specifies an intranet zone.
+     */
+    Intranet = 1,
+    /**
+     * Specifies an Internet zone.
+     */
+    Internet = 2,
+    /**
+     * Specifies a custom zone.
+     */
+    Custom = 3,
+    /**
+     * Specifies an extranet zone.
+     */
+    Extranet = 4,
+}

src/userprofiles.d.ts

 import { SharePointQueryable, SharePointQueryableInstance, SharePointQueryableCollection } from "./sharepointqueryable";
-import { HashTagCollection, UserProfile } from "./types";
+import { ClientPeoplePickerQueryParameters, HashTagCollection, PeoplePickerEntity, UserProfile } from "./types";
 export declare class UserProfileQuery extends SharePointQueryableInstance {
+    private clientPeoplePickerQuery;
     private profileLoader;
@@ -139,2 +140,14 @@ /**
     shareAllSocialData(share: boolean): Promise<void>;
+    /**
+     * Resolves user or group using specified query parameters
+     *
+     * @param queryParams The query parameters used to perform resolve
+     */
+    clientPeoplePickerResolveUser(queryParams: ClientPeoplePickerQueryParameters): Promise<PeoplePickerEntity>;
+    /**
+     * Searches for users or groups using specified query parameters
+     *
+     * @param queryParams The query parameters used to perform search
+     */
+    clientPeoplePickerSearchUser(queryParams: ClientPeoplePickerQueryParameters): Promise<PeoplePickerEntity[]>;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6323289

increased by0.89%

Lines of code

44794

increased by0.84%

No dependency changes