@ebarooni/capacitor-calendar - npm Package Compare versions

Comparing version 6.6.0 to 6.6.1

dist/esm/definitions.d.ts

@@ -584,3 +584,3 @@ import { CalendarChooserDisplayStyle } from "./schemas/enums/calendar-chooser-display-style";
      * @async
-     * @since 5.6.0
+     * @since 6.6.0
      * @platform iOS, Android
@@ -633,3 +633,3 @@ * @permissions
      * @async
-     * @since 5.6.0
+     * @since 6.6.0
      * @platform iOS, Android
@@ -682,2 +682,7 @@ * @permissions
      * @platform iOS
+     * @permissions
+     * <h3>Runtime Permissions:</h3>
+     * <ul>
+     *   <li><strong>iOS:</strong> writeCalendar, readCalendar</li>
+     * </ul>
      * @returns {Promise<{ result: CalendarSource[] }>} A promise that resolves with an array of
@@ -698,2 +703,7 @@ * calendar sources.
      * @platform iOS
+     * @permissions
+     * <h3>Runtime Permissions:</h3>
+     * <ul>
+     *   <li><strong>iOS:</strong> writeCalendar, readCalendar</li>
+     * </ul>
      * @returns {Promise<{ result: CalendarSource[] }>} A promise that resolves with an array of
@@ -700,0 +710,0 @@ * reminders sources.

package.json

 {
   "name": "@ebarooni/capacitor-calendar",
-  "version": "6.6.0",
+  "version": "6.6.1",
   "description": "The Capacitor Calendar Plugin enables full calendar functionality on iOS and Android, with added reminder support for iOS devices.",
@@ -62,6 +62,7 @@ "main": "dist/plugin.cjs.js",
     "fmt": "npm run fmt:ts-html && npm run fmt:css && npm run fmt:swift && npm run fmt:md && npm run fmt:kt",
-    "docgen:api": "docgen --api CapacitorCalendarPlugin --output-readme documentation.md --output-json dist/docs.json",
+    "docgen:api-reference": "docgen --api CapacitorCalendarPlugin --output-readme docs/api-reference.md --output-json dist/docs.json",
     "docgen:readme": "docgen --api CapacitorCalendarPlugin --output-readme README.md",
+    "typedoc:index": "npx typedoc",
     "clean": "rm -rf ./dist",
-    "build": "npm run clean && npm run docgen:api && npm run docgen:readme && tsc && rollup -c rollup.config.mjs",
+    "build": "npm run clean && npm run docgen:api-reference && npm run docgen:readme && tsc && rollup -c rollup.config.mjs",
     "prepublishOnly": "npm run build",
@@ -77,3 +78,3 @@ "serve": "cd example && npx ng serve"
     "@capacitor/ios": "^6.0.0",
-    "@ebarooni/eslint-config": "^1.0.0",
+    "@ebarooni/eslint-config": "^1.0.1",
     "@ebarooni/prettier-config": "^1.1.0",
@@ -95,4 +96,5 @@ "@ebarooni/stylelint-config": "^1.1.0",
     "swiftlint": "^1.0.2",
+    "typedoc": "^0.26.5",
     "typescript": "~5.4.2",
-    "typescript-eslint": "^8.0.0-alpha.20"
+    "typescript-eslint": "^8.0.1"
   },
@@ -99,0 +101,0 @@ "peerDependencies": {

README.md

@@ -110,7 +110,7 @@ <p align="center">
 
-To be able to use the plugin, you will need to add the required permissions to your app. The required platform-specific
-permissions can be found below:
+To be able to use the plugin, you will need to add the required usage descriptions to your app. The required platform-specific
+usage descriptions can be found below:
 
-- [iOS](./ios/PERMISSIONS.md)
-- [Android](./android/PERMISSIONS.md)
+- [iOS](./docs/usage-descriptions/ios.md)
+- [Android](./docs/usage-descriptions/android.md)
 
@@ -157,6 +157,7 @@ ## 📋 API
 
-For detailed explanations, usage examples, and additional information:
+For comprehensive explanations, usage examples, and additional information, please refer to the following resources:
 
-- **documentation.md**: Autogenerated docs are available in the [documentation](documentation.md) file.
-- **definitions.ts**: Complete documentation with usage examples is available in the [src/definitions.ts](src/definitions.ts) file.
+- **[Online Documentation](https://ebarooni.github.io/capacitor-calendar/)**
+- **[API Reference](docs/api-reference.md)**
+- **[Type Definitions and Examples](src/definitions.ts)**
 
@@ -163,0 +164,0 @@ ## 💙 Contributions

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

1189975

increased by0.09%

Lines of code

4310

increased by0.42%

Number of lines in readme file

173

increased by0.58%

Worsened metrics

Dev dependency count

26

increased by4%

No dependency changes