@ebarooni/capacitor-calendar - npm Package Compare versions

Comparing version 6.0.0 to 6.1.0

dist/docs.json

@@ -144,4 +144,10 @@ {
         "name": "createEventWithPrompt",
-        "signature": "() => Promise<{ result: string[]; }>",
-        "parameters": [],
+        "signature": "(options: { title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; alertOffsetInMinutes?: number; }) => Promise<{ result: string[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options for creating the event.",
+            "type": "{ title: string; calendarId?: string | undefined; location?: string | undefined; startDate?: number | undefined; endDate?: number | undefined; isAllDay?: boolean | undefined; alertOffsetInMinutes?: number | undefined; }"
+          }
+        ],
         "returns": "Promise<{ result: string[]; }>",
@@ -153,2 +159,6 @@ "tags": [
           {
+            "name": "since",
+            "text": "0.1.0"
+          },
+          {
             "name": "platform",
@@ -162,2 +172,6 @@ "text": "iOS, Android"
           {
+            "name": "param",
+            "text": "options - Options for creating the event."
+          },
+          {
             "name": "returns",
@@ -172,3 +186,3 @@ "text": "A promise that resolves with an array of the ids of created events."
             "name": "example",
-            "text": "if (capacitor.getPlatform() === 'android') {\n    await this.requestPermission({ alias: 'readCalendar' });\n    { result } = result = await this.createEventWithPrompt();\n} else {\n    { result } = await this.createEventWithPrompt();\n}"
+            "text": "if (capacitor.getPlatform() === 'android') {\n    await this.requestPermission({ alias: 'readCalendar' });\n    { result } = result = await this.createEventWithPrompt({\n       title: 'Title',\n       alertOffsetInMinutes: 5,\n    });\n} else {\n    { result } = result = await this.createEventWithPrompt({\n       title: 'Title',\n       alertOffsetInMinutes: 5,\n    });\n}"
           }
@@ -287,3 +301,3 @@ ],
         "name": "createEvent",
-        "signature": "(options: { title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; }) => Promise<{ result: string; }>",
+        "signature": "(options: { title: string; calendarId?: string; location?: string; startDate?: number; endDate?: number; isAllDay?: boolean; alertOffsetInMinutes?: number; }) => Promise<{ result: string; }>",
         "parameters": [
@@ -293,3 +307,3 @@ {
             "docs": "- Options for creating the event.",
-            "type": "{ title: string; calendarId?: string | undefined; location?: string | undefined; startDate?: number | undefined; endDate?: number | undefined; isAllDay?: boolean | undefined; }"
+            "type": "{ title: string; calendarId?: string | undefined; location?: string | undefined; startDate?: number | undefined; endDate?: number | undefined; isAllDay?: boolean | undefined; alertOffsetInMinutes?: number | undefined; }"
           }
@@ -321,3 +335,3 @@ ],
             "name": "example",
-            "text": "const now = Date.now();\nconst eventOptions = {\n  title: 'Team Meeting',\n  location: 'Conference Room A',\n  startDate: now,\n  endDate: now + 2 * 60 * 60 * 1000,\n  isAllDay: false\n};\nconst { result } = await createEvent(eventOptions);"
+            "text": "const now = Date.now();\nconst eventOptions = {\n  title: 'Team Meeting',\n  location: 'Conference Room A',\n  startDate: now,\n  endDate: now + 2 * 60 * 60 * 1000,\n  isAllDay: false,\n  alertOffsetInMinutes: 5,\n};\nconst { result } = await createEvent(eventOptions);"
           }
@@ -324,0 +338,0 @@ ],

dist/esm/definitions.d.ts

@@ -67,2 +67,3 @@ import { CalendarChooserDisplayStyle } from './schemas/enums/calendar-chooser-display-style';
      * @method
+     * @since 0.1.0
      * @platform iOS, Android
@@ -74,2 +75,12 @@ * @permissions
      * </ul>
+     * @param {object} options - Options for creating the event.
+     * @param {string} options.title - The title of the event.
+     * @param {string} options.calendarId - The id of the destination calendar. (Optional)
+     * @param {string} [options.location] - The location of the event. (Optional)
+     * @param {number} [options.startDate] - The start date and time of the event. (Optional)
+     * @param {number} [options.endDate] - The end date and time of the event. (Optional)
+     * @param {boolean} [options.isAllDay] - Weather the event is for the entire day or not. (Optional)
+     * @param {number} [options.alertOffsetInMinutes] - Ignored on Android. If a number >= 0 is provided,
+     * an alert will be set for the event this many minutes *before* the event.
+     * Negative values are ignored. (Optional)
      * @returns {Promise<{ result: string[] }>} A promise that resolves with an array of the ids of created events.
@@ -80,8 +91,22 @@ * @throws Error If prompt gets cancelled.
      *     await this.requestPermission({ alias: 'readCalendar' });
-     *     { result } = result = await this.createEventWithPrompt();
+     *     { result } = result = await this.createEventWithPrompt({
+     *        title: 'Title',
+     *        alertOffsetInMinutes: 5,
+     *     });
      * } else {
-     *     { result } = await this.createEventWithPrompt();
+     *     { result } = result = await this.createEventWithPrompt({
+     *        title: 'Title',
+     *        alertOffsetInMinutes: 5,
+     *     });
      * }
      */
-    createEventWithPrompt(): Promise<{
+    createEventWithPrompt(options: {
+        title: string;
+        calendarId?: string;
+        location?: string;
+        startDate?: number;
+        endDate?: number;
+        isAllDay?: boolean;
+        alertOffsetInMinutes?: number;
+    }): Promise<{
         result: string[];
@@ -157,2 +182,4 @@ }>;
      * @param {boolean} [options.isAllDay] - Weather the event is for the entire day or not. (Optional)
+     * @param {number} [options.alertOffsetInMinutes] - If a number >= 0 is provided, an alert will be set for the event this many
+     * minutes *before* the event. Negative values are ignored. (Optional)
      * @returns {Promise<{ result: string }>} A promise that resolves with the id of the created event.
@@ -166,3 +193,4 @@ * @example
      *   endDate: now + 2 * 60 * 60 * 1000,
-     *   isAllDay: false
+     *   isAllDay: false,
+     *   alertOffsetInMinutes: 5,
      * };
@@ -178,2 +206,3 @@ * const { result } = await createEvent(eventOptions);
         isAllDay?: boolean;
+        alertOffsetInMinutes?: number;
     }): Promise<{
@@ -180,0 +209,0 @@ result: string;

dist/esm/web.d.ts

@@ -22,3 +22,11 @@ import { PermissionState, WebPlugin } from '@capacitor/core';
     requestAllPermissions(): Promise<PluginPermissionsMap>;
-    createEventWithPrompt(): Promise<{
+    createEventWithPrompt(_options: {
+        title: string;
+        calendarId?: string;
+        location?: string;
+        startDate?: number;
+        endDate?: number;
+        isAllDay?: boolean;
+        alertOffsetInMinutes?: number;
+    }): Promise<{
         result: string[];
@@ -42,2 +50,3 @@ }>;
         isAllDay?: boolean;
+        alertOffsetInMinutes?: number;
     }): Promise<{
@@ -44,0 +53,0 @@ result: string;

dist/esm/web.js

@@ -16,3 +16,3 @@ /* eslint-disable @typescript-eslint/no-unused-vars */
     }
-    createEventWithPrompt() {
+    createEventWithPrompt(_options) {
         throw this.unimplemented(`${this.createEventWithPrompt.name} is not implemented on the web`);
@@ -19,0 +19,0 @@ }

dist/plugin.cjs.js

@@ -145,3 +145,3 @@ 'use strict';
     }
-    createEventWithPrompt() {
+    createEventWithPrompt(_options) {
         throw this.unimplemented(`${this.createEventWithPrompt.name} is not implemented on the web`);
@@ -148,0 +148,0 @@ }

dist/plugin.js

@@ -144,3 +144,3 @@ var capacitorCapacitorCalendar = (function (exports, core) {
         }
-        createEventWithPrompt() {
+        createEventWithPrompt(_options) {
             throw this.unimplemented(`${this.createEventWithPrompt.name} is not implemented on the web`);
@@ -147,0 +147,0 @@ }

package.json

 {
   "name": "@ebarooni/capacitor-calendar",
-  "version": "6.0.0",
+  "version": "6.1.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",

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

219411

increased by4.08%

Lines of code

2360

increased by2.3%

No dependency changes