feat: Get-JSONLD -As and updates ( Fixes #13, Fixes #16, Fixes #17, Fixes #18, Fixes #19 )

Author: StartAutomating

Commands/Get-JsonLD.ps1

@@ -8,7 +8,7 @@ function Get-JsonLD {
         This is a format used by many websites to provide structured data about their content.
     .EXAMPLE
         # Want to get information about a movie?  Linked Data to the rescue!
-        Get-JsonLD -Url https://www.imdb.com/title/tt0211915/
+        Get-JsonLD -Url https://letterboxd.com/film/amelie/    
     .EXAMPLE
         # Want information about an article?  Lots of news sites use this format.
         Get-JsonLD https://www.thebulwark.com/p/mahmoud-khalil-immigration-detention-first-amendment-free-speech-rights    
@@ -21,9 +21,31 @@ function Get-JsonLD {
     param(
     # The URL that may contain JSON-LD data
     [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+    [Alias('href')]
     [Uri]
     $Url,
 
+    <#
+    
+    If set, will the output as:
+
+    |as|is|
+    |-|-|
+    |html|the response as text|
+    |json|the match as json|
+    |*jsonld`|ld`|linkedData*|the match as linked data|'
+    |script|the script tag|
+    |xml|the script tag, as xml|
+    
+    #>
+
+    [ValidateSet('html', 'json', 'jsonld', 'ld', 'linkedData', 'script', 'xml')]
+    [string]
+    $as = 'jsonld',
+
+    [switch]
+    $RawHtml,
+
     # If set, will force the request to be made even if the URL has already been cached.
     [switch]
     $Force
@@ -46,39 +68,84 @@ application/ld\+json                          # The type that indicates linked d
 '@, 'IgnoreCase,IgnorePatternWhitespace','00:00:00.1')
 
         # Initialize the cache for JSON-LD requests
-        if (-not $script:JsonLDRequestCache) {
-            $script:JsonLDRequestCache = [Ordered]@{}
+        if (-not $script:Cache) {
+            $script:Cache = [Ordered]@{}
         }
     }
 
     process {        
         $restResponse = 
-            if ($Force -or -not $script:JsonLDRequestCache[$url]) {
-                $script:JsonLDRequestCache[$url] = Invoke-RestMethod -Uri $Url
-                $script:JsonLDRequestCache[$url]
+            if ($Force -or -not $script:Cache[$url]) {
+                $script:Cache[$url] = Invoke-RestMethod -Uri $Url
+                $script:Cache[$url]
             } else {
-                $script:JsonLDRequestCache[$url]
+                $script:Cache[$url]
             }
+
+        if ($as -eq 'html') {
+            return $restResponse
+        }
+        
+        
+        # Find all linked data tags within the response
         foreach ($match in $linkedDataRegex.Matches("$restResponse")) {
+            # If we want the result as xml
+            if ($As -eq 'xml') {
+                # try to cast it
+                $matchXml ="$match" -as [xml]
+                if ($matchXml) {
+                    # and output it if found.
+                    $matchXml
+                    continue
+                } else {
+                    # otherwise, fall back to the `<script>` tag
+                    $As = 'script'
+                }
+            }
+
+            # If we want the tag, that should be the whole match
+            if ($As -eq 'script') {
+                "$match"
+                continue
+            }
+            
+            # If we want it as json, we have a match group.
+            if ($As -eq 'json') {
+                $match.Groups['JsonContent'].Value
+                continue
+            }
+            # Otherwise, we want it as linked data, so convert from the json
             foreach ($jsonObject in 
                 $match.Groups['JsonContent'].Value | 
                     ConvertFrom-Json
             ) {
+                # If there was a `@type` property
                 if ($jsonObject.'@type') {
+                    # all we need to do is decorate the object
+                    # If we combine the `@context` and `@type` property, we should have a schema url 
                     $schemaType = $jsonObject.'@context',$jsonObject.'@type' -ne '' -join '/'
+                    # and we can make that the typename
                     $jsonObject.pstypenames.insert(0, $schemaType)
+                    # and show the object.
                     $jsonObject
-                } elseif ($jsonObject.'@graph') {
+                }
+                # If there was a `@graph` property
+                elseif ($jsonObject.'@graph') {
+                    # we can display all items in the graph
                     foreach ($graphObject in $jsonObject.'@graph') {
+                        # each of them will tell us it's `@type`
                         if ($graphObject.'@type') {
+                            # and we can decorate each object appropriately
                             $graphObject.pstypenames.insert(0, $graphObject.'@type')
                         }
                         $graphObject
                     }                    
-                } else {
-                    $jsonObject
                 }
-                
+                # If there is neither a `@type` or a `@graph`
+                else {
+                    # just output the object.
+                    $jsonObject
+                }                
             }
         }        
     }