@microsoft/sp-odata-types - npm Package Compare versions

Comparing version 1.3.4 to 1.4.0

CHANGELOG.json

@@ -5,2 +5,17 @@ {
     {
+      "version": "1.4.0",
+      "tag": "@microsoft/sp-odata-types_v1.4.0",
+      "date": "Mon, 04 Dec 2017 18:15:58 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Replace @types/es6-collections with the typescript compiler's built-in es2015.collection library"
+          },
+          {
+            "comment": "Remove beta tags from some APIs that are now officially supported"
+          }
+        ]
+      }
+    },
+    {
       "version": "1.3.4",
@@ -7,0 +22,0 @@ "tag": "@microsoft/sp-odata-types_v1.3.4",

CHANGELOG.md

 # Change Log - @microsoft/sp-odata-types
 
-This log was last generated on Tue, 31 Oct 2017 17:41:22 GMT and should not be manually modified.
+This log was last generated on Mon, 04 Dec 2017 21:55:28 GMT and should not be manually modified.
 
+## 1.4.0
+Mon, 04 Dec 2017 18:15:58 GMT
+
+### Patches
+
+- Replace @types/es6-collections with the typescript compiler's built-in es2015.collection library
+- Remove beta tags from some APIs that are now officially supported
+
 ## 1.3.4
 Thu, 26 Oct 2017 17:35:39 GMT
 
-*Changes not tracked*
+*Version update only*
 
@@ -13,3 +21,3 @@ ## 1.3.0
 
-*Changes not tracked*
+*Version update only*
 
@@ -16,0 +24,0 @@ ## 1.2.0

dist/sp-odata-types.api.json

@@ -6,4 +6,4 @@ {
     {
-      "kind": "textDocElement",
-      "value": "TypeScript interfaces for working with SharePoint REST APIs"
+      "kind": "text",
+      "text": "TypeScript interfaces for working with SharePoint REST APIs."
     }
@@ -13,4 +13,4 @@ ],
     {
-      "kind": "textDocElement",
-      "value": "This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package has no performance cost because it does not contain any runtime code; it consists only of type definitions."
+      "kind": "text",
+      "text": "This package defines TypeScript interfaces that describe various ODATA objects returned by SharePoint REST APIs. It is useful when implementing data layers that interpret these types. This package does not contain any runtime code; it consists only of type definitions."
     }
@@ -27,4 +27,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Data used for creating a SPPermission object."
+          "kind": "text",
+          "text": "Data used for creating a SPPermission object."
         }
@@ -37,2 +37,3 @@ ],
           "kind": "property",
+          "signature": "High: number;",
           "isOptional": false,
@@ -49,2 +50,3 @@ "isReadOnly": false,
           "kind": "property",
+          "signature": "Low: number;",
           "isOptional": false,
@@ -69,15 +71,18 @@ "isReadOnly": false,
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.ChangeToken object. For more information about this object"
+          "kind": "text",
+          "text": "Represents an OData SP.ChangeToken object. For more information about this object, see "
         },
         {
-          "kind": "seeDocElement",
-          "seeElements": [
+          "kind": "web-link",
+          "elements": [
             {
-              "kind": "linkDocElement",
-              "referenceType": "href",
-              "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx",
-              "value": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+              "kind": "text",
+              "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
             }
-          ]
+          ],
+          "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+        },
+        {
+          "kind": "text",
+          "text": ""
         }
@@ -90,2 +95,3 @@ ],
           "kind": "property",
+          "signature": "StringValue: string;",
           "isOptional": false,
@@ -98,4 +104,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: { StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }"
+              "kind": "text",
+              "text": "Example: { StringValue: \"1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721\" }"
             }
@@ -116,15 +122,18 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.ContextWebInformation object. For more information about this object"
+          "kind": "text",
+          "text": "Represents an OData SP.ContextWebInformation object. For more information about this object, see "
         },
         {
-          "kind": "seeDocElement",
-          "seeElements": [
+          "kind": "web-link",
+          "elements": [
             {
-              "kind": "linkDocElement",
-              "referenceType": "href",
-              "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx",
-              "value": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+              "kind": "text",
+              "text": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
             }
-          ]
+          ],
+          "targetUrl": "https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+        },
+        {
+          "kind": "text",
+          "text": ""
         }
@@ -137,2 +146,3 @@ ],
           "kind": "property",
+          "signature": "FormDigestTimeoutSeconds: number;",
           "isOptional": false,
@@ -145,4 +155,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: 1800"
+              "kind": "text",
+              "text": "Example: 1800"
             }
@@ -155,2 +165,3 @@ ],
           "kind": "property",
+          "signature": "FormDigestValue: string;",
           "isOptional": false,
@@ -163,4 +174,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"0x61B31CBF4C76C...B0,20 Jan 2016 02:24:43 -0000\""
+              "kind": "text",
+              "text": "Example: \"0x61B31CBF4C76C...B0,20 Jan 2016 02:24:43 -0000\""
             }
@@ -173,2 +184,3 @@ ],
           "kind": "property",
+          "signature": "LibraryVersion: string;",
           "isOptional": false,
@@ -181,4 +193,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"16.0.4919.3000\""
+              "kind": "text",
+              "text": "Example: \"16.0.4919.3000\""
             }
@@ -191,2 +203,3 @@ ],
           "kind": "property",
+          "signature": "SiteFullUrl: string;",
           "isOptional": false,
@@ -199,4 +212,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\""
+              "kind": "text",
+              "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\""
             }
@@ -209,2 +222,3 @@ ],
           "kind": "property",
+          "signature": "SupportedSchemaVersions: string[];",
           "isOptional": false,
@@ -217,4 +231,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: [ \"14.0.0.0\", \"15.0.0.0\" ]"
+              "kind": "text",
+              "text": "Example: [ \"14.0.0.0\", \"15.0.0.0\" ]"
             }
@@ -227,2 +241,3 @@ ],
           "kind": "property",
+          "signature": "WebFullUrl: string;",
           "isOptional": false,
@@ -235,4 +250,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\""
+              "kind": "text",
+              "text": "Example: \"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\""
             }
@@ -253,4 +268,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+          "kind": "text",
+          "text": "Represents an OData SP.List object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
         }
@@ -263,2 +278,3 @@ ],
           "kind": "property",
+          "signature": "BaseTemplate: number;",
           "isOptional": false,
@@ -271,4 +287,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "The list definition type on which the list is based."
+              "kind": "text",
+              "text": "The list definition type on which the list is based."
             }
@@ -281,2 +297,3 @@ ],
           "kind": "property",
+          "signature": "Created: string;",
           "isOptional": false,
@@ -289,4 +306,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Date(1453294804000)/\""
+              "kind": "text",
+              "text": "Example: \"/Date(1453294804000)/\""
             }
@@ -299,2 +316,3 @@ ],
           "kind": "property",
+          "signature": "CurrentChangeToken: IODataChangeToken;",
           "isOptional": false,
@@ -307,4 +325,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "The change token that will be used in logging the next change to the list."
+              "kind": "text",
+              "text": "The change token that will be used in logging the next change to the list."
             }
@@ -317,2 +335,3 @@ ],
           "kind": "property",
+          "signature": "Description: string;",
           "isOptional": false,
@@ -325,4 +344,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "A description of the List."
+              "kind": "text",
+              "text": "A description of the List."
             }
@@ -335,2 +354,3 @@ ],
           "kind": "property",
+          "signature": "EntityTypeName: string;",
           "isOptional": false,
@@ -343,4 +363,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"MyListTitleList\""
+              "kind": "text",
+              "text": "Example: \"MyListTitleList\""
             }
@@ -353,2 +373,3 @@ ],
           "kind": "property",
+          "signature": "Hidden: boolean;",
           "isOptional": false,
@@ -361,4 +382,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields."
+              "kind": "text",
+              "text": "A hidden list does not appear on the Documents and Lists page, Quick Launch bar, the Modify Site Content page, or the Add Column page as an option for lookup fields."
             }
@@ -371,2 +392,3 @@ ],
           "kind": "property",
+          "signature": "Id: string;",
           "isOptional": false,
@@ -379,4 +401,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\""
+              "kind": "text",
+              "text": "Example: \"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\""
             }
@@ -389,2 +411,3 @@ ],
           "kind": "property",
+          "signature": "LastItemDeletedDate: string;",
           "isOptional": false,
@@ -397,4 +420,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Date(1453294809000)/\""
+              "kind": "text",
+              "text": "Example: \"/Date(1453294809000)/\""
             }
@@ -407,2 +430,3 @@ ],
           "kind": "property",
+          "signature": "LastItemModifiedDate: string;",
           "isOptional": false,
@@ -415,4 +439,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Date(1453294809000)/\""
+              "kind": "text",
+              "text": "Example: \"/Date(1453294809000)/\""
             }
@@ -425,2 +449,3 @@ ],
           "kind": "property",
+          "signature": "ListItemEntityTypeFullName: string;",
           "isOptional": false,
@@ -433,4 +458,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"SP.Data.MyListTitleListItem\""
+              "kind": "text",
+              "text": "Example: \"SP.Data.MyListTitleListItem\""
             }
@@ -443,2 +468,3 @@ ],
           "kind": "property",
+          "signature": "ParentWebUrl: string;",
           "isOptional": false,
@@ -451,4 +477,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/sites/PubSite\""
+              "kind": "text",
+              "text": "Example: \"/sites/PubSite\""
             }
@@ -461,2 +487,3 @@ ],
           "kind": "property",
+          "signature": "TemplateFeatureId: string;",
           "isOptional": false,
@@ -469,4 +496,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\""
+              "kind": "text",
+              "text": "Example: \"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\""
             }
@@ -479,2 +506,3 @@ ],
           "kind": "property",
+          "signature": "Title: string;",
           "isOptional": false,
@@ -487,4 +515,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"Pages\""
+              "kind": "text",
+              "text": "Example: \"Pages\""
             }
@@ -505,4 +533,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+          "kind": "text",
+          "text": "Represents an OData SP.ListItem object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
         }
@@ -515,2 +543,3 @@ ],
           "kind": "property",
+          "signature": "ContentTypeId:",
           "isOptional": false,
@@ -523,4 +552,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: { StrinValue: \"0x010100C5...\" }"
+              "kind": "text",
+              "text": "Example: { StringValue: \"0x010100C5...\" }"
             }
@@ -533,2 +562,3 @@ ],
           "kind": "property",
+          "signature": "ID: number;",
           "isOptional": false,
@@ -545,2 +575,3 @@ "isReadOnly": false,
           "kind": "property",
+          "signature": "Title: string;",
           "isOptional": false,
@@ -553,4 +584,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Title of the List Item"
+              "kind": "text",
+              "text": "Title of the List Item"
             }
@@ -563,2 +594,3 @@ ],
           "kind": "property",
+          "signature": "UniqueId: string;",
           "isOptional": false,
@@ -571,4 +603,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\""
+              "kind": "text",
+              "text": "Example: \"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\""
             }
@@ -589,4 +621,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx"
+          "kind": "text",
+          "text": "Represents an OData SP.NavigationNode object. https://msdn.microsoft.com/en-us/library/office/jj246311.aspx"
         }
@@ -599,2 +631,3 @@ ],
           "kind": "property",
+          "signature": "Children?: IODataNavigationNode[];",
           "isOptional": true,
@@ -607,4 +640,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets an array of Navigation Nodes that are children to the current node."
+              "kind": "text",
+              "text": "Gets or sets an array of Navigation Nodes that are children to the current node."
             }
@@ -617,2 +650,3 @@ ],
           "kind": "property",
+          "signature": "Id?: number;",
           "isOptional": true,
@@ -625,4 +659,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies the identifier for the navigation node."
+              "kind": "text",
+              "text": "Gets a value that specifies the identifier for the navigation node."
             }
@@ -635,2 +669,3 @@ ],
           "kind": "property",
+          "signature": "IsDocLib?: boolean;",
           "isOptional": true,
@@ -647,2 +682,3 @@ "isReadOnly": false,
           "kind": "property",
+          "signature": "IsExternal?: boolean;",
           "isOptional": true,
@@ -655,4 +691,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies whether the navigation node URL potentially corresponds to pages outside of the site collection."
             }
@@ -665,2 +701,3 @@ ],
           "kind": "property",
+          "signature": "IsVisible?: boolean;",
           "isOptional": true,
@@ -673,4 +710,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies if the node navigation link should be visible."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies if the node navigation link should be visible."
             }
@@ -683,2 +720,3 @@ ],
           "kind": "property",
+          "signature": "Title?: string;",
           "isOptional": true,
@@ -691,4 +729,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies the anchor text for the node navigation link."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies the anchor text for the node navigation link."
             }
@@ -701,2 +739,3 @@ ],
           "kind": "property",
+          "signature": "Url?: string;",
           "isOptional": true,
@@ -709,4 +748,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies the URL to be stored with the navigation node. It must be a URL of relative form if IsExternal is false. It must be a URL of relative or absolute form."
             }
@@ -727,4 +766,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. https://msdn.microsoft.com/en-us/library/office/ee557907.aspx"
+          "kind": "text",
+          "text": "Represents an OData Microsoft.SharePoint.Navigation.SPNavigation object. https://msdn.microsoft.com/en-us/library/office/ee557907.aspx"
         }
@@ -737,2 +776,3 @@ ],
           "kind": "property",
+          "signature": "quickLaunch: IODataNavigationNode[];",
           "isOptional": false,
@@ -745,4 +785,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site."
+              "kind": "text",
+              "text": "Gets an SPNavigationNode object that contains the nodes in the Quick Launch area of the site."
             }
@@ -755,2 +795,3 @@ ],
           "kind": "property",
+          "signature": "topNav: IODataNavigationNode[];",
           "isOptional": false,
@@ -763,4 +804,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets an SPNavigationNode object that contains the nodes in the top link bar for the website."
+              "kind": "text",
+              "text": "Gets an SPNavigationNode object that contains the nodes in the top link bar for the website."
             }
@@ -781,4 +822,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+          "kind": "text",
+          "text": "Represents an OData SP.User object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
         }
@@ -791,2 +832,3 @@ ],
           "kind": "property",
+          "signature": "Email: string;",
           "isOptional": false,
@@ -799,4 +841,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"[e-mail]\""
+              "kind": "text",
+              "text": "Example: \"[e-mail]\""
             }
@@ -809,2 +851,3 @@ ],
           "kind": "property",
+          "signature": "Id: number;",
           "isOptional": false,
@@ -821,2 +864,3 @@ "isReadOnly": false,
           "kind": "property",
+          "signature": "IsSiteAdmin: boolean;",
           "isOptional": false,
@@ -829,4 +873,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Boolean value that specifies whether the user is a site collection administrator."
+              "kind": "text",
+              "text": "Boolean value that specifies whether the user is a site collection administrator."
             }
@@ -839,2 +883,3 @@ ],
           "kind": "property",
+          "signature": "LoginName: string;",
           "isOptional": false,
@@ -847,4 +892,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"i:0#.w|domain\\user\""
+              "kind": "text",
+              "text": "Example: \"i:0#.w|domain\\user\""
             }
@@ -857,2 +902,3 @@ ],
           "kind": "property",
+          "signature": "PrincipalType: number;",
           "isOptional": false,
@@ -865,7 +911,54 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. None: 0 User: 1 DistributionList: 2 SecurityGroup: 4 SharePointGroup: 8 All: 15"
+              "kind": "text",
+              "text": "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values."
             }
           ],
-          "remarks": [],
+          "remarks": [
+            {
+              "kind": "text",
+              "text": "Values:"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "None: 0"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "User: 1"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "DistributionList: 2"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "SecurityGroup: 4"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "SharePointGroup: 8"
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "All: 15"
+            }
+          ],
           "isBeta": false
@@ -875,2 +968,3 @@ },
           "kind": "property",
+          "signature": "Title: string;",
           "isOptional": false,
@@ -883,4 +977,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Example: \"DOMAIN\\user\""
+              "kind": "text",
+              "text": "Example: \"DOMAIN\\user\""
             }
@@ -893,2 +987,3 @@ ],
           "kind": "property",
+          "signature": "UserId: IODataUserId;",
           "isOptional": false,
@@ -901,4 +996,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier."
+              "kind": "text",
+              "text": "Gets the information of the user that contains the user's name identifier and the issuer of the user's name identifier."
             }
@@ -919,4 +1014,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction"
+          "kind": "text",
+          "text": "Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction"
         }
@@ -929,2 +1024,3 @@ ],
           "kind": "property",
+          "signature": "ClientSideComponentId: string;",
           "isOptional": false,
@@ -937,4 +1033,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "The unique identifier of the client-side component defined with SharePoint Framework"
+              "kind": "text",
+              "text": "The unique identifier of the client-side component defined with SharePoint Framework"
             }
@@ -944,10 +1040,11 @@ ],
             {
-              "kind": "textDocElement",
-              "value": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\""
+              "kind": "text",
+              "text": "Example: \"359af2a7-b73c-4aac-874c-60a865da0be7\""
             }
           ],
-          "isBeta": true
+          "isBeta": false
         },
         "ClientSideComponentProperties": {
           "kind": "property",
+          "signature": "ClientSideComponentProperties: string;",
           "isOptional": false,
@@ -960,4 +1057,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Custom initialization properties for the client-side component."
+              "kind": "text",
+              "text": "Custom initialization properties for the client-side component."
             }
@@ -967,10 +1064,18 @@ ],
             {
-              "kind": "textDocElement",
-              "value": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component. Example: \"{ \\\"maxItemsToShow\\\": 123 }\""
+              "kind": "text",
+              "text": "This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component."
+            },
+            {
+              "kind": "paragraph"
+            },
+            {
+              "kind": "text",
+              "text": "Example: \"{ \\\"maxItemsToShow\\\": 123 }\""
             }
           ],
-          "isBeta": true
+          "isBeta": false
         },
         "CommandUIExtension": {
           "kind": "property",
+          "signature": "CommandUIExtension: string;",
           "isOptional": false,
@@ -983,4 +1088,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action."
             }
@@ -993,2 +1098,3 @@ ],
           "kind": "property",
+          "signature": "Description: string;",
           "isOptional": false,
@@ -1001,4 +1107,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the description of the custom action."
+              "kind": "text",
+              "text": "Gets or sets the description of the custom action."
             }
@@ -1011,2 +1117,3 @@ ],
           "kind": "property",
+          "signature": "Group: string;",
           "isOptional": false,
@@ -1019,4 +1126,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page."
             }
@@ -1029,2 +1136,3 @@ ],
           "kind": "property",
+          "signature": "Id: string;",
           "isOptional": false,
@@ -1037,4 +1145,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies the identifier (GUID) of the custom action. Example: \"48309f28-53aa-43ed-b113-625120e5af6f\""
+              "kind": "text",
+              "text": "Gets a value that specifies the identifier (GUID) of the custom action. Example: \"48309f28-53aa-43ed-b113-625120e5af6f\""
             }
@@ -1047,2 +1155,3 @@ ],
           "kind": "property",
+          "signature": "ImageUrl: string;",
           "isOptional": false,
@@ -1055,4 +1164,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the URL of the image associated with the custom action."
+              "kind": "text",
+              "text": "Gets or sets the URL of the image associated with the custom action."
             }
@@ -1065,2 +1174,3 @@ ],
           "kind": "property",
+          "signature": "Location: string;",
           "isOptional": false,
@@ -1073,4 +1183,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the location of the custom action."
+              "kind": "text",
+              "text": "Gets or sets the location of the custom action."
             }
@@ -1080,4 +1190,4 @@ ],
             {
-              "kind": "textDocElement",
-              "value": "Example: \"ClientSide.Application\""
+              "kind": "text",
+              "text": "Example: \"ClientSide.Application\""
             }
@@ -1089,2 +1199,3 @@ ],
           "kind": "property",
+          "signature": "RegistrationId: string;",
           "isOptional": false,
@@ -1097,4 +1208,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the value that specifies the identifier of the object associated with the custom action."
+              "kind": "text",
+              "text": "Gets or sets the value that specifies the identifier of the object associated with the custom action."
             }
@@ -1107,2 +1218,3 @@ ],
           "kind": "property",
+          "signature": "RegistrationType: number;",
           "isOptional": false,
@@ -1115,4 +1227,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the value that specifies the type of object associated with the custom action."
+              "kind": "text",
+              "text": "Gets or sets the value that specifies the type of object associated with the custom action."
             }
@@ -1122,4 +1234,4 @@ ],
             {
-              "kind": "textDocElement",
-              "value": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4."
+              "kind": "text",
+              "text": "Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4."
             }
@@ -1131,2 +1243,3 @@ ],
           "kind": "property",
+          "signature": "Rights: IODataBasePermission;",
           "isOptional": false,
@@ -1139,4 +1252,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the value that specifies the permissions needed for the custom action."
+              "kind": "text",
+              "text": "Gets or sets the value that specifies the permissions needed for the custom action."
             }
@@ -1149,2 +1262,3 @@ ],
           "kind": "property",
+          "signature": "Scope: number;",
           "isOptional": false,
@@ -1157,4 +1271,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies the scope of the custom action."
+              "kind": "text",
+              "text": "Gets a value that specifies the scope of the custom action."
             }
@@ -1167,2 +1281,3 @@ ],
           "kind": "property",
+          "signature": "ScriptBlock: string;",
           "isOptional": false,
@@ -1175,4 +1290,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed."
+              "kind": "text",
+              "text": "Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed."
             }
@@ -1185,2 +1300,3 @@ ],
           "kind": "property",
+          "signature": "ScriptSrc: string;",
           "isOptional": false,
@@ -1193,4 +1309,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page."
             }
@@ -1203,2 +1319,3 @@ ],
           "kind": "property",
+          "signature": "Sequence: number;",
           "isOptional": false,
@@ -1211,4 +1328,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page."
+              "kind": "text",
+              "text": "Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page."
             }
@@ -1221,2 +1338,3 @@ ],
           "kind": "property",
+          "signature": "Title: string;",
           "isOptional": false,
@@ -1229,4 +1347,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the display title of the custom action."
+              "kind": "text",
+              "text": "Gets or sets the display title of the custom action."
             }
@@ -1239,2 +1357,3 @@ ],
           "kind": "property",
+          "signature": "Url: string;",
           "isOptional": false,
@@ -1247,4 +1366,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action."
+              "kind": "text",
+              "text": "Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action."
             }
@@ -1257,2 +1376,3 @@ ],
           "kind": "property",
+          "signature": "VersionOfUserCustomAction: string;",
           "isOptional": false,
@@ -1265,4 +1385,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies an implementation specific version identifier."
+              "kind": "text",
+              "text": "Gets a value that specifies an implementation specific version identifier."
             }
@@ -1272,4 +1392,4 @@ ],
             {
-              "kind": "textDocElement",
-              "value": "Example: \"16.0.1.0\""
+              "kind": "text",
+              "text": "Example: \"16.0.1.0\""
             }
@@ -1289,4 +1409,4 @@ ],
         {
-          "kind": "textDocElement",
-          "value": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
+          "kind": "text",
+          "text": "Represents an OData SP.Web object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/jj860569.aspx"
         }
@@ -1299,2 +1419,3 @@ ],
           "kind": "property",
+          "signature": "Created?: string;",
           "isOptional": true,
@@ -1307,4 +1428,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies when the site was created. Example: \"/Date(2016,0,20,12,58,7,0)/\""
+              "kind": "text",
+              "text": "Gets a value that specifies when the site was created. Example: \"/Date(2016,0,20,12,58,7,0)/\""
             }
@@ -1317,2 +1438,3 @@ ],
           "kind": "property",
+          "signature": "CurrentChangeToken?: IODataChangeToken;",
           "isOptional": true,
@@ -1325,4 +1447,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Represents the unique sequential location of a change within the change log."
+              "kind": "text",
+              "text": "Represents the unique sequential location of a change within the change log."
             }
@@ -1335,2 +1457,3 @@ ],
           "kind": "property",
+          "signature": "CustomMasterUrl?: string;",
           "isOptional": true,
@@ -1343,4 +1466,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the URL for a custom master page file to apply to the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\""
+              "kind": "text",
+              "text": "Gets or sets the URL for a custom master page file to apply to the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\""
             }
@@ -1353,2 +1476,3 @@ ],
           "kind": "property",
+          "signature": "Description?: string;",
           "isOptional": true,
@@ -1361,4 +1485,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the description for the site."
+              "kind": "text",
+              "text": "Gets or sets the description for the site."
             }
@@ -1371,2 +1495,3 @@ ],
           "kind": "property",
+          "signature": "Id?: string;",
           "isOptional": true,
@@ -1379,4 +1504,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies the site identifier for the site. Example: \"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\""
+              "kind": "text",
+              "text": "Gets a value that specifies the site identifier for the site. Example: \"/Guid(92ea328e-9f50-49a6-9da5-2f2dd5577041)/\""
             }
@@ -1389,2 +1514,3 @@ ],
           "kind": "property",
+          "signature": "IsMultilingual?: boolean;",
           "isOptional": true,
@@ -1397,4 +1523,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Value that represents if the web was"
+              "kind": "text",
+              "text": "Value that represents if the web was"
             }
@@ -1407,2 +1533,3 @@ ],
           "kind": "property",
+          "signature": "Language?: number;",
           "isOptional": true,
@@ -1415,4 +1542,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies the LCID for the language that is used on the site. Example: 1033"
+              "kind": "text",
+              "text": "Gets a value that specifies the LCID for the language that is used on the site. Example: 1033"
             }
@@ -1425,2 +1552,3 @@ ],
           "kind": "property",
+          "signature": "LastItemModifiedDate?: string;",
           "isOptional": true,
@@ -1433,4 +1561,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets a value that specifies when an item was last modified in the site. Example: \"/Date(1453618828000)/\""
+              "kind": "text",
+              "text": "Gets a value that specifies when an item was last modified in the site. Example: \"/Date(1453618828000)/\""
             }
@@ -1443,2 +1571,3 @@ ],
           "kind": "property",
+          "signature": "MasterUrl?: string;",
           "isOptional": true,
@@ -1451,4 +1580,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the URL of the master page that is used for the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\""
+              "kind": "text",
+              "text": "Gets or sets the URL of the master page that is used for the website. Example: \"/sites/PubSite/_catalogs/masterpage/seattle.master\""
             }
@@ -1461,2 +1590,3 @@ ],
           "kind": "property",
+          "signature": "NoCrawl?: boolean;",
           "isOptional": true,
@@ -1469,4 +1599,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Determines if a particular web will be crawled by search or not."
+              "kind": "text",
+              "text": "Determines if a particular web will be crawled by search or not."
             }
@@ -1479,2 +1609,3 @@ ],
           "kind": "property",
+          "signature": "QuickLaunchEnabled?: boolean;",
           "isOptional": true,
@@ -1487,4 +1618,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that specifies whether the Quick Launch area is enabled on the site."
+              "kind": "text",
+              "text": "Gets or sets a value that specifies whether the Quick Launch area is enabled on the site."
             }
@@ -1497,2 +1628,3 @@ ],
           "kind": "property",
+          "signature": "RecycleBinEnabled?: boolean;",
           "isOptional": true,
@@ -1505,4 +1637,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets a value that determines whether the recycle bin is enabled for the website."
+              "kind": "text",
+              "text": "Gets or sets a value that determines whether the recycle bin is enabled for the website."
             }
@@ -1515,2 +1647,3 @@ ],
           "kind": "property",
+          "signature": "ServerRelativeUrl?: string;",
           "isOptional": true,
@@ -1523,4 +1656,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the server-relative URL for the Web site. Example: \"/sites/PubSite\""
+              "kind": "text",
+              "text": "Gets or sets the server-relative URL for the Web site. Example: \"/sites/PubSite\""
             }
@@ -1533,2 +1666,3 @@ ],
           "kind": "property",
+          "signature": "SiteLogoUrl?: string;",
           "isOptional": true,
@@ -1541,4 +1675,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets the url for the logo of this particular site."
+              "kind": "text",
+              "text": "Gets the url for the logo of this particular site."
             }
@@ -1551,2 +1685,3 @@ ],
           "kind": "property",
+          "signature": "Title?: string;",
           "isOptional": true,
@@ -1559,4 +1694,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "The title of the web."
+              "kind": "text",
+              "text": "The title of the web."
             }
@@ -1569,2 +1704,3 @@ ],
           "kind": "property",
+          "signature": "UIVersion?: number;",
           "isOptional": true,
@@ -1577,4 +1713,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets or sets the user interface (UI) version of the Web site. Example: 15"
+              "kind": "text",
+              "text": "Gets or sets the user interface (UI) version of the Web site. Example: 15"
             }
@@ -1587,2 +1723,3 @@ ],
           "kind": "property",
+          "signature": "Url?: string;",
           "isOptional": true,
@@ -1595,4 +1732,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets the absolute URL for the website. Example: \"http://example.com/sites/PubSite\""
+              "kind": "text",
+              "text": "Gets the absolute URL for the website. Example: \"http://example.com/sites/PubSite\""
             }
@@ -1605,2 +1742,3 @@ ],
           "kind": "property",
+          "signature": "WebTemplate?: string;",
           "isOptional": true,
@@ -1613,4 +1751,4 @@ "isReadOnly": false,
             {
-              "kind": "textDocElement",
-              "value": "Gets the name of the site definition or site template that was used to create the site. Example: \"BLANKINTERNET\""
+              "kind": "text",
+              "text": "Gets the name of the site definition or site template that was used to create the site. Example: \"BLANKINTERNET\""
             }
@@ -1617,0 +1755,0 @@ ],

lib/IODataListItem.d.ts

@@ -11,3 +11,3 @@ /**
     /**
-     * Example: { StrinValue: "0x010100C5..." }
+     * Example: { StringValue: "0x010100C5..." }
      */
@@ -14,0 +14,0 @@ ContentTypeId: {

lib/IODataUser.d.ts

@@ -42,7 +42,16 @@ /**
      * its member values.
+     * @remarks
+     *
+     * Values:
+     *
      * None: 0
+     *
      * User: 1
+     *
      * DistributionList: 2
+     *
      * SecurityGroup: 4
+     *
      * SharePointGroup: 8
+     *
      * All: 15
@@ -49,0 +58,0 @@ */

lib/IODataUserCustomAction.d.ts

@@ -12,6 +12,5 @@ import IODataBasePermission from './IODataBasePermission';
      * The unique identifier of the client-side component defined with SharePoint Framework
+     *
      * @remarks
      * Example: "359af2a7-b73c-4aac-874c-60a865da0be7"
-     *
-     * @beta
      */
@@ -21,2 +20,3 @@ ClientSideComponentId: string;
      * Custom initialization properties for the client-side component.
+     *
      * @remarks
@@ -28,4 +28,2 @@ * This property is only used when a ClientSideComponentId is specified. It is optional.
      * Example: "{ \"maxItemsToShow\": 123 }"
-     *
-     * @beta
      */
@@ -32,0 +30,0 @@ ClientSideComponentProperties: string;

lib/SmallTypes.d.ts

 /**
- * Represents an OData SP.ChangeToken object.  For more information about this object
- * @see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}
+ * Represents an OData SP.ChangeToken object.  For more information about this object,
+ * see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}
  *
@@ -14,4 +14,4 @@ * @public
 /**
- * Represents an OData SP.ContextWebInformation object.  For more information about this object
- * @see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}
+ * Represents an OData SP.ContextWebInformation object.  For more information about this object,
+ * see {@link https://msdn.microsoft.com/en-us/library/office/jj860569.aspx}
  *
@@ -18,0 +18,0 @@ * @public

package.json

 {
   "name": "@microsoft/sp-odata-types",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "TypeScript interfaces for working with SharePoint REST APIs",
@@ -10,11 +10,11 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER",
   "devDependencies": {
-    "@microsoft/sp-build-node": "~1.3.4",
+    "@microsoft/sp-build-node": "1.4.0",
     "gulp": "~3.9.1"
   },
-  "dependencies": {},
+  "dependencies": {
+    "tslib": "~1.8.0"
+  },
   "scripts": {
-    "build": "gulp",
-    "clean": "gulp clean",
-    "test": "gulp test"
+    "build": "gulp test --clean"
   }
 }

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

1758975

increased by0.27%

Lines of code

2310

increased by7.34%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedtslib@~1.8.0

• + Addedtslib@1.8.1(transitive)