Merge pull request #241 from nextcloud-libraries/enh/provide-ocs-result

lib/ocs.ts

@@ -0,0 +1,30 @@
+export interface OCSResponse<T = any> {
+	ocs: {
+		meta: {
+			/**
+			 * Request success or failure state
+			 */
+			status: 'ok' | 'failure'
+
+			/**
+			 * Status code defaults to 100, but often HTTP status codes are used
+			 */
+			statuscode: number
+
+			/**
+			 * Message text
+			 */
+			message: string | undefined
+
+			/**
+			 * Optionally the total number of items available
+			 */
+			totalitems: number | undefined
+			/**
+			 * Optionally the the number of items per page
+			 */
+			itemsperpage: number | undefined
+		}
+		data: T
+	}
+}

lib/v27/OC.d.ts

@@ -1,4 +1,4 @@
-import { Route } from "vue-router";
+import type { Route } from 'vue-router'
 
 declare global {
     namespace Nextcloud.v27 {

package.json

@@ -4,6 +4,10 @@
   "description": "Nextcloud TypeScript typings",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.d.ts",
+    "./types": "./dist/types.d.ts"
+  },
   "scripts": {
     "build": "tsc",
     "test": "jest",
@@ -31,13 +35,13 @@
   },
   "dependencies": {
     "@types/jquery": "3.5.16",
-    "vue": "^2.7.14",
+    "vue": "^2.7.15",
     "vue-router": "<4"
   },
   "devDependencies": {
     "babel-jest": "^29.5.0",
     "jest": "^29.5.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.3.2"
   },
   "engines": {
     "node": "^20.0.0",

tsconfig.json

@@ -1,21 +1,21 @@
 {
-    "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"
+	]
 }