@ebarooni/capacitor-calendar - npm Package Compare versions

Comparing version 0.11.0 to 0.12.0

dist/docs.json

@@ -303,3 +303,3 @@ {
             "name": "permissions",
-            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> writeCalendar</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> writeCalendar</li>\n  <li><strong>Android:</strong> readCalendar, writeCalendar</li>\n</ul>"
+            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS:</strong> writeCalendar</li>\n  <li><strong>Android:</strong> readCalendar, writeCalendar</li>\n</ul>"
           },
@@ -386,3 +386,3 @@ {
         "name": "createReminder",
-        "signature": "(options: { title: string; listId?: string; priority?: number; isCompleted?: boolean; startDate?: number; dueDate?: number; completionDate?: number; notes?: string; url?: string; location?: string; recurrence?: ReminderRecurrenceRule; }) => Promise<{ reminderCreated: boolean; }>",
+        "signature": "(options: { title: string; listId?: string; priority?: number; isCompleted?: boolean; startDate?: number; dueDate?: number; completionDate?: number; notes?: string; url?: string; location?: string; recurrence?: ReminderRecurrenceRule; }) => Promise<{ result: string; }>",
         "parameters": [
@@ -395,3 +395,3 @@ {
         ],
-        "returns": "Promise<{ reminderCreated: boolean; }>",
+        "returns": "Promise<{ result: string; }>",
         "tags": [
@@ -403,2 +403,6 @@ {
           {
+            "name": "since",
+            "text": "0.5.0"
+          },
+          {
             "name": "platform",
@@ -408,2 +412,6 @@ "text": "iOS"
           {
+            "name": "permissions",
+            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS:</strong> writeReminders</li>\n</ul>"
+          },
+          {
             "name": "param",
@@ -414,7 +422,7 @@ "text": "options - Options for creating the reminder."
             "name": "returns",
-            "text": "A Promise that resolves with an object indicating whether the reminder was created successfully.\nThe resolved object has a property 'reminderCreated' which is a boolean value representing whether the reminder was created."
+            "text": "A Promise that resolves with the id of the created reminder"
           },
           {
             "name": "example",
-            "text": "const now = Date.now();\nconst rules: ReminderRecurrenceRule = {\n    frequency: ReminderRecurrenceFrequency.MONTHLY,\n    interval: 10,\n    end: Date.now()\n}\nconst reminderOptions = {\n  title: 'Buy cucumber',\n  listId: 'ABC12',\n  priority: 5,\n  isCompleted: false,\n  startDateComponents: now,\n  notes: 'Also buy tomatoes',\n  url: 'https://capacitor-calendar.pages.dev/',\n  location: 'My Local Supermarket',\n  recurrence: rules\n};\nconst { reminderCreated } = await createReminder(reminderOptions);\nconsole.log(reminderCreated); // true"
+            "text": "const now = Date.now();\nconst rules: ReminderRecurrenceRule = {\n    frequency: ReminderRecurrenceFrequency.MONTHLY,\n    interval: 10,\n    end: Date.now()\n}\nconst reminderOptions = {\n  title: 'Buy cucumber',\n  listId: 'ABC12',\n  priority: 5,\n  isCompleted: false,\n  startDateComponents: now,\n  notes: 'Also buy tomatoes',\n  url: 'https://capacitor-calendar.pages.dev/',\n  location: 'My Local Supermarket',\n  recurrence: rules\n};\nconst { result } = await createReminder(reminderOptions);\nconsole.log(result); // 'ID_1'"
           }
@@ -516,3 +524,3 @@ ],
             "name": "permissions",
-            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> readCalendar</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> readCalendar</li>\n  <li><strong>Android:</strong> readCalendar</li>\n</ul>"
+            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS:</strong> readCalendar</li>\n  <li><strong>Android:</strong> readCalendar</li>\n</ul>"
           },
@@ -564,3 +572,3 @@ {
             "name": "permissions",
-            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> writeCalendar</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> writeCalendar</li>\n  <li><strong>Android:</strong> writeCalendar</li>\n</ul>"
+            "text": "<h3>Runtime Permissions:</h3>\n<ul>\n  <li><strong>iOS:</strong> writeCalendar</li>\n  <li><strong>Android:</strong> writeCalendar</li>\n</ul>"
           },
@@ -574,2 +582,6 @@ {
             "text": "A promise that resolves to an object with two properties:\n - deleted: string[] - An array of IDs that were successfully deleted.\n - failed: string[] - An array of IDs that could not be deleted."
+          },
+          {
+            "name": "example",
+            "text": "const idsToDelete = ['ID_1', 'ID_2', 'ID_DOES_NOT_EXIST'];\nconst { result } = await CapacitorCalendar.deleteEventsById(idsToDelete)\nconsole.log(result.deleted)  // ['ID_1', 'ID_2']\nconsole.log(result.failed) // ['ID_DOES_NOT_EXIST']"
           }
@@ -925,3 +937,3 @@ ],
             {
-              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>\n  <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>\n</ul>",
+              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>\n  <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>\n  <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>\n</ul>",
               "name": "permissions"
@@ -941,3 +953,3 @@ }
             {
-              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>\n  <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>\n</ul>",
+              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>\n  <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>\n  <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>\n</ul>",
               "name": "permissions"
@@ -957,3 +969,3 @@ }
             {
-              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>\n</ul>",
+              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>\n  <li><strong>10 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>\n</ul>",
               "name": "permissions"
@@ -973,3 +985,3 @@ }
             {
-              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>\n  <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>\n</ul>",
+              "text": "<h3>Manifest Permissions:</h3>\n<ul>\n  <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>\n  <li><strong>13 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>\n</ul>",
               "name": "permissions"
@@ -976,0 +988,0 @@ }

dist/esm/definitions.d.ts

@@ -144,4 +144,3 @@ import { CalendarChooserDisplayStyle } from './schemas/enums/calendar-chooser-display-style';
      * <ul>
-     *   <li><strong>iOS 17 &le;:</strong> writeCalendar</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> writeCalendar</li>
+     *   <li><strong>iOS:</strong> writeCalendar</li>
      *   <li><strong>Android:</strong> readCalendar, writeCalendar</li>
@@ -211,3 +210,9 @@ * </ul>
      * @method createReminder
+     * @since 0.5.0
      * @platform iOS
+     * @permissions
+     * <h3>Runtime Permissions:</h3>
+     * <ul>
+     *   <li><strong>iOS:</strong> writeReminders</li>
+     * </ul>
      * @param {object} options - Options for creating the reminder.
@@ -227,4 +232,3 @@ * @param {string} options.title - The title of the reminder.
      * @param {string} [options.recurrence] - The rules for the recurrence of the reminder. (Optional)
-     * @returns {Promise<{ reminderCreated: boolean }>} A Promise that resolves with an object indicating whether the reminder was created successfully.
-     * The resolved object has a property 'reminderCreated' which is a boolean value representing whether the reminder was created.
+     * @returns {Promise<{ result: string }>} A Promise that resolves with the id of the created reminder
      * @example
@@ -248,4 +252,4 @@ * const now = Date.now();
      * };
-     * const { reminderCreated } = await createReminder(reminderOptions);
-     * console.log(reminderCreated); // true
+     * const { result } = await createReminder(reminderOptions);
+     * console.log(result); // 'ID_1'
      */
@@ -265,3 +269,3 @@ createReminder(options: {
     }): Promise<{
-        reminderCreated: boolean;
+        result: string;
     }>;
@@ -302,4 +306,3 @@ /**
      * <ul>
-     *   <li><strong>iOS 17 &le;:</strong> readCalendar</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> readCalendar</li>
+     *   <li><strong>iOS:</strong> readCalendar</li>
      *   <li><strong>Android:</strong> readCalendar</li>
@@ -332,4 +335,3 @@ * </ul>
      * <ul>
-     *   <li><strong>iOS 17 &le;:</strong> writeCalendar</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> writeCalendar</li>
+     *   <li><strong>iOS:</strong> writeCalendar</li>
      *   <li><strong>Android:</strong> writeCalendar</li>
@@ -343,3 +345,7 @@ * </ul>
      *  - failed: string[] - An array of IDs that could not be deleted.
-     *
+     * @example
+     * const idsToDelete = ['ID_1', 'ID_2', 'ID_DOES_NOT_EXIST'];
+     * const { result } = await CapacitorCalendar.deleteEventsById(idsToDelete)
+     * console.log(result.deleted)  // ['ID_1', 'ID_2']
+     * console.log(result.failed) // ['ID_DOES_NOT_EXIST']
      */
@@ -346,0 +352,0 @@ deleteEventsById(options: {

dist/esm/schemas/enums/plugin-permission.d.ts

@@ -16,3 +16,3 @@ /**
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>
@@ -30,3 +30,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>
@@ -44,3 +44,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>10 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -57,3 +57,3 @@ */
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -60,0 +60,0 @@ */

dist/esm/schemas/enums/plugin-permission.js

@@ -17,3 +17,3 @@ /**
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>
@@ -31,3 +31,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>
@@ -45,3 +45,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>10 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -58,3 +58,3 @@ */
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -61,0 +61,0 @@ */

dist/esm/web.d.ts

@@ -57,3 +57,3 @@ import { PermissionState, WebPlugin } from '@capacitor/core';
     }): Promise<{
-        reminderCreated: boolean;
+        result: string;
     }>;
@@ -60,0 +60,0 @@ getDefaultRemindersList(): Promise<{

dist/plugin.cjs.js

@@ -57,3 +57,3 @@ 'use strict';
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>
@@ -71,3 +71,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
      *   <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>
@@ -85,3 +85,3 @@ * </ul>
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>10 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -98,3 +98,3 @@ */
      *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-     *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+     *   <li><strong>13 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
      * </ul>
@@ -101,0 +101,0 @@ */

dist/plugin.js

@@ -56,3 +56,3 @@ var capacitorCapacitorCalendar = (function (exports, core) {
          *   <li><strong>iOS 17 &le;:</strong> NSCalendarsFullAccessUsageDescription</li>
-         *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+         *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
          *   <li><strong>Android:</strong> android.permission.READ_CALENDAR</li>
@@ -70,3 +70,3 @@ * </ul>
          *   <li><strong>iOS 17 &le;:</strong> NSCalendarsWriteOnlyAccessUsageDescription</li>
-         *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSCalendarsUsageDescription</li>
+         *   <li><strong>13 &le; iOS &le; 16:</strong> NSCalendarsUsageDescription</li>
          *   <li><strong>Android:</strong> android.permission.WRITE_CALENDAR</li>
@@ -84,3 +84,3 @@ * </ul>
          *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-         *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+         *   <li><strong>10 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
          * </ul>
@@ -97,3 +97,3 @@ */
          *   <li><strong>iOS 17 &le;:</strong> NSRemindersFullAccessUsageDescription</li>
-         *   <li><strong>iOS 10 &le; x &le; iOS 16:</strong> NSRemindersUsageDescription</li>
+         *   <li><strong>13 &le; iOS &le; 16:</strong> NSRemindersUsageDescription</li>
          * </ul>
@@ -100,0 +100,0 @@ */

package.json

 {
   "name": "@ebarooni/capacitor-calendar",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "The Capacitor Calendar Plugin enables full calendar functionality on iOS and Android, with added reminder support for iOS devices.",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -256,3 +256,3 @@ <p align="center">
 ```typescript
-createReminder(options: { title: string; listId?: string; priority?: number; isCompleted?: boolean; startDate?: number; dueDate?: number; completionDate?: number; notes?: string; url?: string; location?: string; recurrence?: ReminderRecurrenceRule; }) => Promise<{ reminderCreated: boolean; }>
+createReminder(options: { title: string; listId?: string; priority?: number; isCompleted?: boolean; startDate?: number; dueDate?: number; completionDate?: number; notes?: string; url?: string; location?: string; recurrence?: ReminderRecurrenceRule; }) => Promise<{ result: string; }>
 ```
@@ -266,4 +266,6 @@
 
-**Returns:** <code>Promise&lt;{ reminderCreated: boolean; }&gt;</code>
+**Returns:** <code>Promise&lt;{ result: string; }&gt;</code>
 
+**Since:** 0.5.0
+
 --------------------
@@ -270,0 +272,0 @@

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

Lines of code

2307

increased by0.74%

Number of lines in readme file

433

increased by0.46%

Worsened metrics

Total package byte prevSize

223716

decreased by-0.03%

No dependency changes