@nextcloud/typings - npm Package Compare versions

Comparing version 1.7.0 to 1.8.0

CHANGELOG.md

@@ -5,2 +5,16 @@ # Changelog
 
+## 1.8.0 - 2024-02-23
+### Added
+* enh: Add typings for Nextcloud 28
+* enh: Provide `@nextcloud/typings/ocs` for `OCSResult` type
+
+### Fixed
+* fix: Remove unused travis and renovate config
+* fix: Adjust `OCP.Files` types for `Navigation` and `Router`
+* fix: Use correct exported name `/ocs` instead of `/types`
+
+### Changes
+* chore: update node engines to next LTS (Node 20 + NPM 10)
+* Dependency updates
+
 ## 1.7.0 - 2023-06-13
@@ -7,0 +21,0 @@ ### Added

lib/index.d.ts

@@ -13,1 +13,2 @@ /// <reference path="v16/OC.d.ts" />
 /// <reference path="v27/OC.d.ts" />
+/// <reference path="v28/OC.d.ts" />

lib/v26/OC.d.ts

 declare namespace Nextcloud.v26 {
 
-    interface OC extends Nextcloud.v25.OC {
+	interface OC extends Nextcloud.v25.OC {
 
-    }
+	}
 
-    interface OCP extends Nextcloud.v25.OCP {
+	interface OCP extends Nextcloud.v25.OCP {
 
-    }
+	}
 
-    interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window {
+	interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window {
 
-    }
+	}
 }

lib/v27/OC.d.ts

@@ -1,46 +0,46 @@
-import { Route } from "vue-router";
+import type { Route } from 'vue-router'
 
 declare global {
-    namespace Nextcloud.v27 {
-        interface FilesRouter {
-            /**
-            * Trigger a route change on the files app
-            * 
-            * @param path the url path, eg: '/trashbin?dir=/Deleted'
-            * @param replace replace the current history (default false)
-            * @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location
-            */
-            goTo(path: string, replace?: boolean): Promise<Route>;
-        
-            /**
-             * Trigger a route change on the files App
-             *
-             * @param name the route name
-             * @param params the route parameters
-             * @param query the url query parameters
-             * @param replace replace the current history
-             * @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location
-             */
-            goToRoute(
-                name?: string,
-                params?: Record<string, string>,
-                query?: Record<string, string | (string | null)[] | null | undefined>,
-                replace?: boolean,
-            ): Promise<Route>;
-        }
+	namespace Nextcloud.v27 {
+		interface FilesRouter {
+			/**
+			* Trigger a route change on the files app
+			* 
+			* @param path the url path, eg: '/trashbin?dir=/Deleted'
+			* @param replace replace the current history (default false)
+			* @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location
+			*/
+			goTo(path: string, replace?: boolean): Promise<Route>;
+		
+			/**
+			 * Trigger a route change on the files App
+			 *
+			 * @param name the route name
+			 * @param params the route parameters
+			 * @param query the url query parameters
+			 * @param replace replace the current history
+			 * @see https://router.vuejs.org/guide/essentials/navigation.html#navigate-to-a-different-location
+			 */
+			goToRoute(
+				name?: string,
+				params?: Record<string, string>,
+				query?: Record<string, string | (string | null)[] | null | undefined>,
+				replace?: boolean,
+			): Promise<Route>;
+		}
 
-        interface OC extends Nextcloud.v26.OC {
+		interface OC extends Nextcloud.v26.OC {
 
-        }
+		}
 
-        interface OCP extends Nextcloud.v26.OCP {
-            Files: {
-                Router: FilesRouter
-            }
-        }
+		interface OCP extends Omit<Nextcloud.v26.OCP, 'Files'> {
+			Files: {
+				Router: FilesRouter
+			}
+		}
 
-        interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window {
+		interface WindowWithGlobals extends Nextcloud.Common.DayMonthConstants, Window {
 
-        }
-    }
+		}
+	}
 }

package.json

 {
   "name": "@nextcloud/typings",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Nextcloud TypeScript typings",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts"
+    },
+    "./ocs": {
+      "types": "./dist/ocs.d.ts"
+    }
+  },
   "scripts": {
@@ -34,3 +42,3 @@ "build": "tsc",
     "@types/jquery": "3.5.16",
-    "vue": "^2.7.14",
+    "vue": "^2.7.15",
     "vue-router": "<4"
@@ -41,8 +49,8 @@ },
     "jest": "^29.5.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.3.3"
   },
   "engines": {
-    "node": "^16.0.0",
-    "npm": "^7.0.0 || ^8.0.0"
+    "node": "^20.0.0",
+    "npm": "^10.0.0"
   }
 }

README.md

@@ -23,3 +23,3 @@ # @nextcloud/typings
 
-declare var OC: Nextcloud.v25.OC | Nextcloud.v26.OC | Nextcloud.v27.OC;
+declare var OC: Nextcloud.v26.OC | Nextcloud.v27.OC | Nextcloud.v28.OC;
 
@@ -26,0 +26,0 @@ OC.L10N.translate("app", "text")

tsconfig.json

 {
-    "compilerOptions": {
-        "target": "es6",
-        "module": "commonjs",
-        "declaration": true,
-        "outDir": "./dist",
-        "strict": true,
-        "lib": [
-            "es6",
-            "dom"
-        ]
-    },
-    "include": [
-        "lib"
-    ],
-    "exclude": [
-        "dist",
-        "node_modules",
-        "test"
-    ]
+	"compilerOptions": {
+		"target": "ESNext",
+		"declaration": true,
+		"moduleResolution": "Node",
+		"outDir": "./dist",
+		"strict": true,
+		"lib": [
+			"ESNext",
+			"DOM"
+		]
+	},
+	"include": [
+		"lib"
+	],
+	"exclude": [
+		"dist",
+		"node_modules",
+		"test"
+	]
 }

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

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

67480

increased by9.86%

Number of package files

31

increased by10.71%

Lines of code

673

increased by34.06%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• Updatedvue@^2.7.15