@capacitor-community/media - npm Package Compare versions

Comparing version 4.0.1 to 4.1.0

dist/docs.json

@@ -10,3 +10,3 @@ {
         "name": "getMedias",
-        "signature": "(options?: MediaFetchOptions | undefined) => Promise<MediaResponse>",
+        "signature": "(options?: MediaFetchOptions | undefined) => any",
         "parameters": [
@@ -19,8 +19,8 @@ {
         ],
-        "returns": "Promise<MediaResponse>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "MediaResponse",
-          "MediaFetchOptions"
+          "MediaFetchOptions",
+          "MediaResponse"
         ],
@@ -31,5 +31,5 @@ "slug": "getmedias"
         "name": "getAlbums",
-        "signature": "() => Promise<MediaAlbumResponse>",
+        "signature": "() => any",
         "parameters": [],
-        "returns": "Promise<MediaAlbumResponse>",
+        "returns": "any",
         "tags": [],
@@ -44,3 +44,3 @@ "docs": "",
         "name": "savePhoto",
-        "signature": "(options?: MediaSaveOptions | undefined) => Promise<PhotoResponse>",
+        "signature": "(options?: MediaSaveOptions | undefined) => any",
         "parameters": [
@@ -53,8 +53,8 @@ {
         ],
-        "returns": "Promise<PhotoResponse>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PhotoResponse",
-          "MediaSaveOptions"
+          "MediaSaveOptions",
+          "PhotoResponse"
         ],
@@ -65,3 +65,3 @@ "slug": "savephoto"
         "name": "saveVideo",
-        "signature": "(options?: MediaSaveOptions | undefined) => Promise<PhotoResponse>",
+        "signature": "(options?: MediaSaveOptions | undefined) => any",
         "parameters": [
@@ -74,8 +74,8 @@ {
         ],
-        "returns": "Promise<PhotoResponse>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PhotoResponse",
-          "MediaSaveOptions"
+          "MediaSaveOptions",
+          "PhotoResponse"
         ],
@@ -86,3 +86,3 @@ "slug": "savevideo"
         "name": "saveGif",
-        "signature": "(options?: MediaSaveOptions | undefined) => Promise<PhotoResponse>",
+        "signature": "(options?: MediaSaveOptions | undefined) => any",
         "parameters": [
@@ -95,8 +95,8 @@ {
         ],
-        "returns": "Promise<PhotoResponse>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "PhotoResponse",
-          "MediaSaveOptions"
+          "MediaSaveOptions",
+          "PhotoResponse"
         ],
@@ -107,3 +107,3 @@ "slug": "savegif"
         "name": "createAlbum",
-        "signature": "(options: MediaAlbumCreate) => Promise<void>",
+        "signature": "(options: MediaAlbumCreate) => any",
         "parameters": [
@@ -116,3 +116,3 @@ {
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
@@ -130,2 +130,88 @@ "docs": "",
     {
+      "name": "MediaFetchOptions",
+      "slug": "mediafetchoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "quantity",
+          "tags": [],
+          "docs": "The number of photos to fetch, sorted by last created date descending",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "thumbnailWidth",
+          "tags": [],
+          "docs": "The width of thumbnail to return",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "thumbnailHeight",
+          "tags": [],
+          "docs": "The height of thumbnail to return",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "thumbnailQuality",
+          "tags": [],
+          "docs": "The quality of thumbnail to return as JPEG (0-100)",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "types",
+          "tags": [],
+          "docs": "Which types of assets to return (currently only supports \"photos\")",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "albumIdentifier",
+          "tags": [],
+          "docs": "Which album identifier to query in (get identifier with getAlbums())",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "sort",
+          "tags": [],
+          "docs": "Sort order of returned assets by field and ascending/descending",
+          "complexTypes": [
+            "MediaField",
+            "MediaSort"
+          ],
+          "type": "{} | \"meidaType\" | \"mediaSubtypes\" | \"sourceType\" | \"pixelWidth\" | \"pixelHeight\" | \"creationDate\" | \"modificationDate\" | \"duration\" | \"isFavorite\" | \"hasAdjustments\" | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MediaSort",
+      "slug": "mediasort",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "key",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "MediaField"
+          ],
+          "type": "\"meidaType\" | \"mediaSubtypes\" | \"sourceType\" | \"pixelWidth\" | \"pixelHeight\" | \"creationDate\" | \"modificationDate\" | \"duration\" | \"isFavorite\" | \"hasAdjustments\""
+        },
+        {
+          "name": "ascending",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
       "name": "MediaResponse",
@@ -144,3 +230,3 @@ "slug": "mediaresponse",
           ],
-          "type": "MediaAsset[]"
+          "type": "{}"
         }
@@ -261,53 +347,2 @@ ]
     {
-      "name": "MediaFetchOptions",
-      "slug": "mediafetchoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "quantity",
-          "tags": [],
-          "docs": "The number of photos to fetch, sorted by last created date descending",
-          "complexTypes": [],
-          "type": "number | undefined"
-        },
-        {
-          "name": "thumbnailWidth",
-          "tags": [],
-          "docs": "The width of thumbnail to return",
-          "complexTypes": [],
-          "type": "number | undefined"
-        },
-        {
-          "name": "thumbnailHeight",
-          "tags": [],
-          "docs": "The height of thumbnail to return",
-          "complexTypes": [],
-          "type": "number | undefined"
-        },
-        {
-          "name": "thumbnailQuality",
-          "tags": [],
-          "docs": "The quality of thumbnail to return as JPEG (0-100)",
-          "complexTypes": [],
-          "type": "number | undefined"
-        },
-        {
-          "name": "types",
-          "tags": [],
-          "docs": "Which types of assets to return (currently only supports \"photos\")",
-          "complexTypes": [],
-          "type": "string | undefined"
-        },
-        {
-          "name": "albumIdentifier",
-          "tags": [],
-          "docs": "Which album identifier to query in (get identifier with getAlbums())",
-          "complexTypes": [],
-          "type": "string | undefined"
-        }
-      ]
-    },
-    {
       "name": "MediaAlbumResponse",
@@ -326,3 +361,3 @@ "slug": "mediaalbumresponse",
           ],
-          "type": "MediaAlbum[]"
+          "type": "{}"
         }
@@ -371,4 +406,4 @@ ]
     {
-      "name": "PhotoResponse",
-      "slug": "photoresponse",
+      "name": "MediaSaveOptions",
+      "slug": "mediasaveoptions",
       "docs": "",
@@ -379,3 +414,3 @@ "tags": [],
         {
-          "name": "filePath",
+          "name": "path",
           "tags": [],
@@ -385,2 +420,9 @@ "docs": "",
           "type": "string"
+        },
+        {
+          "name": "album",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
@@ -390,4 +432,4 @@ ]
     {
-      "name": "MediaSaveOptions",
-      "slug": "mediasaveoptions",
+      "name": "PhotoResponse",
+      "slug": "photoresponse",
       "docs": "",
@@ -398,3 +440,3 @@ "tags": [],
         {
-          "name": "path",
+          "name": "filePath",
           "tags": [],
@@ -404,9 +446,2 @@ "docs": "",
           "type": "string"
-        },
-        {
-          "name": "album",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | undefined"
         }
@@ -413,0 +448,0 @@ ]

dist/esm/definitions.d.ts

@@ -38,3 +38,12 @@ export interface MediaPlugin {
     albumIdentifier?: string;
+    /**
+     * Sort order of returned assets by field and ascending/descending
+     */
+    sort?: MediaField | MediaSort[];
 }
+export interface MediaSort {
+    key: MediaField;
+    ascending: boolean;
+}
+export declare type MediaField = 'meidaType' | 'mediaSubtypes' | 'sourceType' | 'pixelWidth' | 'pixelHeight' | 'creationDate' | 'modificationDate' | 'duration' | 'isFavorite' | 'hasAdjustments';
 export interface MediaResponse {
@@ -41,0 +50,0 @@ medias: MediaAsset[];

package.json

 {
   "name": "@capacitor-community/media",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Enable some media features for Capacitor such as create albums, save videos, gifs and more.",
@@ -5,0 +5,0 @@ "author": "Stewan Silva",

README.md

@@ -15,3 +15,3 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
   <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-7-orange?style=flat-square" /></a>
+<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-8-orange?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -113,3 +113,13 @@
 - sign your app at xcode (general tab)
+- add the following to `Info.plist`:
 
+```xml
+<dict>
+  ...
+  <key>NSPhotoLibraryUsageDescription</key>
+  <string>Describe why you need access to user's photos</string>
+  ...
+</dict>
+```
+
 > Tip: every time you change a native code you may need to clean up the cache (Product > Clean build folder) and then run the app again.
@@ -161,2 +171,3 @@
     <td align="center"><a href="https://github.com/Gr1zlY"><img src="https://avatars.githubusercontent.com/u/195971?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Michael</b></sub></a><br /><a href="https://github.com/capacitor-community/media/commits?author=Gr1zlY" title="Code">💻</a></td>
+    <td align="center"><a href="https://www.mtda.me/"><img src="https://avatars.githubusercontent.com/u/2229994?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Matheus Davidson</b></sub></a><br /><a href="https://github.com/capacitor-community/media/commits?author=matheusdavidson" title="Code">💻</a> <a href="https://github.com/capacitor-community/media/commits?author=matheusdavidson" title="Documentation">📖</a></td>
   </tr>
@@ -163,0 +174,0 @@ </table>

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69488

increased by7.57%

Number of package files

27

increased by3.85%

Lines of code

1045

increased by4.4%

Number of lines in readme file

179

increased by6.55%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes