@capacitor-community/advertising-id - npm Package Compare versions

Comparing version 2.0.0-0 to 4.0.0-0

dist/docs.json

@@ -10,8 +10,10 @@ {
         "name": "requestTracking",
-        "signature": "() => Promise<{ value: string; }>",
+        "signature": "() => Promise<{ value: AdvertisingStatus; }>",
         "parameters": [],
-        "returns": "Promise<{ value: string; }>",
+        "returns": "Promise<{ value: AdvertisingStatus; }>",
         "tags": [],
         "docs": "",
-        "complexTypes": [],
+        "complexTypes": [
+          "AdvertisingStatus"
+        ],
         "slug": "requesttracking"
@@ -21,8 +23,10 @@ },
         "name": "getAdvertisingId",
-        "signature": "() => Promise<{ id: string; status: string; }>",
+        "signature": "() => Promise<{ id: string; status: AdvertisingStatus; }>",
         "parameters": [],
-        "returns": "Promise<{ id: string; status: string; }>",
+        "returns": "Promise<{ id: string; status: AdvertisingStatus; }>",
         "tags": [],
         "docs": "",
-        "complexTypes": [],
+        "complexTypes": [
+          "AdvertisingStatus"
+        ],
         "slug": "getadvertisingid"
@@ -32,8 +36,10 @@ },
         "name": "getAdvertisingStatus",
-        "signature": "() => Promise<{ status: string; }>",
+        "signature": "() => Promise<{ status: AdvertisingStatus; }>",
         "parameters": [],
-        "returns": "Promise<{ status: string; }>",
+        "returns": "Promise<{ status: AdvertisingStatus; }>",
         "tags": [],
         "docs": "",
-        "complexTypes": [],
+        "complexTypes": [
+          "AdvertisingStatus"
+        ],
         "slug": "getadvertisingstatus"
@@ -46,4 +52,28 @@ }
   "enums": [],
-  "typeAliases": [],
+  "typeAliases": [
+    {
+      "name": "AdvertisingStatus",
+      "slug": "advertisingstatus",
+      "docs": "",
+      "types": [
+        {
+          "text": "'Authorized'",
+          "complexTypes": []
+        },
+        {
+          "text": "'Denied'",
+          "complexTypes": []
+        },
+        {
+          "text": "'Not Determined'",
+          "complexTypes": []
+        },
+        {
+          "text": "'Restricted'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
   "pluginConfigs": []
 }

dist/esm/definitions.d.ts

 export interface AdvertisingIdPlugin {
     requestTracking(): Promise<{
-        value: string;
+        value: AdvertisingStatus;
     }>;
     getAdvertisingId(): Promise<{
         id: string;
-        status: string;
+        status: AdvertisingStatus;
     }>;
     getAdvertisingStatus(): Promise<{
-        status: string;
+        status: AdvertisingStatus;
     }>;
 }
+export declare type AdvertisingStatus = 'Authorized' | 'Denied' | 'Not Determined' | 'Restricted';

dist/esm/web.d.ts

 import { WebPlugin } from '@capacitor/core';
-import type { AdvertisingIdPlugin } from './definitions';
+import type { AdvertisingIdPlugin, AdvertisingStatus } from './definitions';
 export declare class AdvertisingIdWeb extends WebPlugin implements AdvertisingIdPlugin {
     requestTracking(): Promise<{
-        value: string;
+        value: AdvertisingStatus;
     }>;
     getAdvertisingId(): Promise<{
         id: string;
-        status: string;
+        status: AdvertisingStatus;
     }>;
     getAdvertisingStatus(): Promise<{
-        status: string;
+        status: AdvertisingStatus;
     }>;
 }

package.json

 {
   "name": "@capacitor-community/advertising-id",
-  "version": "2.0.0-0",
+  "version": "4.0.0-0",
   "description": "Allows access to the IDFA (iOS) and AAID (Android)",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -12,2 +12,8 @@ # @capacitor-community/advertising-id
 
+## iOS
+
+iOS requires the following usage description be added and filled out for your app in `Info.plist` to use the `requestTracking()` method:
+
+- `NSUserTrackingUsageDescription` (`Privacy - Tracking Usage Description`)
+
 ## API
@@ -20,2 +26,3 @@
 * [`getAdvertisingStatus()`](#getadvertisingstatus)
+* [Type Aliases](#type-aliases)
 
@@ -30,6 +37,6 @@ </docgen-index>
 ```typescript
-requestTracking() => Promise<{ value: string; }>
+requestTracking() => Promise<{ value: AdvertisingStatus; }>
 ```
 
-**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
+**Returns:** <code>Promise&lt;{ value: <a href="#advertisingstatus">AdvertisingStatus</a>; }&gt;</code>
 
@@ -42,6 +49,6 @@ --------------------
 ```typescript
-getAdvertisingId() => Promise<{ id: string; status: string; }>
+getAdvertisingId() => Promise<{ id: string; status: AdvertisingStatus; }>
 ```
 
-**Returns:** <code>Promise&lt;{ id: string; status: string; }&gt;</code>
+**Returns:** <code>Promise&lt;{ id: string; status: <a href="#advertisingstatus">AdvertisingStatus</a>; }&gt;</code>
 
@@ -54,9 +61,17 @@ --------------------
 ```typescript
-getAdvertisingStatus() => Promise<{ status: string; }>
+getAdvertisingStatus() => Promise<{ status: AdvertisingStatus; }>
 ```
 
-**Returns:** <code>Promise&lt;{ status: string; }&gt;</code>
+**Returns:** <code>Promise&lt;{ status: <a href="#advertisingstatus">AdvertisingStatus</a>; }&gt;</code>
 
 --------------------
 
+
+### Type Aliases
+
+
+#### AdvertisingStatus
+
+<code>'Authorized' | 'Denied' | 'Not Determined' | 'Restricted'</code>
+
 </docgen-api>

New 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

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

23661

increased by6.02%

Lines of code

172

increased by21.99%

Number of lines in readme file

73

increased by25.86%

No dependency changes