@enonic-types/lib-auditlog 7.11.0-B1 → 7.11.0-B4

package/README.md

@@ -5,38 +5,23 @@
 ## Install
 
 ```bash
-npm i --save-dev @enonic/lib-auditlog
+npm i --save-dev @enonic-types/lib-auditlog
 ```
 
 ## Use
 
-Add the corresponding types to your `tsconfig.json` file that is used for application's server-side TypeScript code.
-
-`tsconfig.json`
-
-```json
-{
-  "compilerOptions": {
-    "types": [
-      "@enonic-types/lib-auditlog"
-    ]
-  }
-}
-```
-
 ### Require and custom imports
 
-To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP global
-objects, e.g. `log`, `app`, `__`, etc, requiring library by the default path will return typed object.
+To make `require` work out of the box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
+global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default path will return typed object.
 
 `tsconfig.json`
 
-```diff
+```json
 {
   "compilerOptions": {
     "types": [
-+     "@enonic-types/global"
-      "@enonic-types/lib-auditlog"
+      "@enonic-types/global"
     ]
   }
 }
@@ -49,7 +34,7 @@ const {log, get, find} = require('/lib/xp/auditlog');
 ```
 
 More detailed explanation on how it works and how to type custom import function can be
-found [here](https://github.com/enonic/xp/tree/master/modules/lib/typescript/README.md).
+found [here](https://developer.enonic.com/docs/xp/stable/api).
 
 ### ES6-style import
 
@@ -58,16 +43,13 @@ types mapping to your configuration.
 
 `tsconfig.json`
 
-```diff
+```json
 {
   "compilerOptions": {
-    "types": [
-      "@enonic-types/lib-auditlog"
-    ]
-+   "baseUrl": "./",
-+   "paths": {
-+     "/lib/xp/auditlog": ["node_modules/@enonic-types/lib-auditlog"],
-+   }
+    "baseUrl": "./",
+    "paths": {
+      "/lib/xp/auditlog": ["node_modules/@enonic-types/lib-auditlog"]
+    }
   }
 }
 ```

package/auditlog.d.ts

@@ -1,13 +1,23 @@
+/**
+ * Functions to log and find audit logs.
+ *
+ * @example
+ * var auditLib = require('/lib/xp/auditlog');
+ *
+ * @module audit
+ */
 declare global {
     interface XpLibraries {
         '/lib/xp/auditlog': typeof import('./auditlog');
     }
 }
+import type { UserKey } from '@enonic-types/core';
+export type { UserKey } from '@enonic-types/core';
 export interface AuditLogParams {
     type: string;
     time?: string;
     source?: string;
-    user?: string;
+    user?: UserKey;
     objects?: string[];
     data?: Record<string, unknown>;
 }
@@ -16,7 +26,7 @@ export interface AuditLog {
     type: string;
     time: string;
     source: string;
-    user: string;
+    user: UserKey;
     objects: string[];
     data: Record<string, unknown>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-auditlog",
-    "version": "7.11.0-B1",
+    "version": "7.11.0-B4",
     "description": "Type definitions for lib-auditlog.",
     "types": "auditlog.d.ts",
     "files": [
@@ -26,6 +26,9 @@
         "url": "https://github.com/enonic/xp/issues"
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "dependencies": {
+        "@enonic-types/core": "7.11.0-B4"
+    },
     "publishConfig": {
         "access": "public"
     }