@enonic-types/lib-auditlog 0.1.0

package/README.md

@@ -0,0 +1,81 @@
+# Enonic XP lib-auditlog TS types
+
+> TypeScript definitions for `lib-auditlog` library of Enonic XP
+
+## Install
+
+```bash
+npm i --save-dev @enonic/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.
+
+`tsconfig.json`
+
+```diff
+{
+  "compilerOptions": {
+    "types": [
++     "@enonic-types/global"
+      "@enonic-types/lib-auditlog"
+    ]
+  }
+}
+```
+
+`example.ts`
+
+```ts
+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).
+
+### ES6-style import
+
+If you are planning to use `import` in your code and transpile it with the default `tsc` TypeScript compiler, you'll need to add proper
+types mapping to your configuration.
+
+`tsconfig.json`
+
+```diff
+{
+  "compilerOptions": {
+    "types": [
+      "@enonic-types/lib-auditlog"
+    ]
++   "baseUrl": "./",
++   "paths": {
++     "/lib/xp/auditlog": ["node_modules/@enonic-types/lib-auditlog"],
++   }
+  }
+}
+```
+
+`example.ts`
+
+```ts
+import {log, get, find} from '/lib/xp/auditlog';
+```
+
+Setting `baseUrl` and `paths` will allow the `tsc` to keep the valid paths in the resulting JavaScript files.

package/auditlog.d.ts

@@ -0,0 +1,92 @@
+declare global {
+    interface XpLibraries {
+        '/lib/xp/auditlog': typeof import('./auditlog');
+    }
+}
+export interface AuditLogParams {
+    type: string;
+    time?: string;
+    source?: string;
+    user?: string;
+    objects?: string[];
+    data?: Record<string, unknown>;
+}
+export interface AuditLog {
+    _id: string;
+    type: string;
+    time: string;
+    source: string;
+    user: string;
+    objects: string[];
+    data: Record<string, unknown>;
+}
+/**
+ * This function creates a single audit log entry.
+ *
+ * The parameter 'type' is required and all other parameters are optional.
+ *
+ * @example-ref examples/auditlog/log.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.type Type of log entry.
+ * @param {string} [params.time] Log entry timestamp. Defaults to now.
+ * @param {string} [params.source] Log entry source. Defaults to the application ID.
+ * @param {string} [params.user] Log entry user. Defaults to the user of current context.
+ * @param {array}  [params.objects] URIs to objects that relate to this log entry. Defaults to empty array.
+ * @param {object} [params.data] Custom extra data for the this log entry. Defaults to empty object.
+ *
+ * @returns {object} Audit log created as JSON.
+ */
+export declare function log(params: AuditLogParams): AuditLog;
+export interface GetAuditLogParams {
+    id: string;
+}
+/**
+ * This function fetches an audit log.
+ *
+ * @example-ref examples/auditlog/get.js
+ *
+ * @param {object} params     JSON with the parameters.
+ * @param {string} params.id  Id of the audit log.
+ *
+ * @returns {object} Audit log as JSON.
+ */
+export declare function get(params: GetAuditLogParams): AuditLog | null;
+export interface FindAuditLogParams {
+    start?: number;
+    count?: number;
+    ids?: string[];
+    from?: string;
+    to?: string;
+    type?: string;
+    source?: string;
+    users?: string[];
+    objects?: string[];
+}
+export interface AuditLogs {
+    total: number;
+    count: number;
+    hits: AuditLog[];
+}
+/**
+ * This function searches for audit logs.
+ *
+ * All parameters are semi-optional, meaning that you should at least supply one
+ * of them. If no parameters are supplied you will get an empty result.
+ *
+ * @example-ref examples/auditlog/find.js
+ *
+ * @param {object} params     JSON with the parameters.
+ * @param {number} [params.start=0] Start index (used for paging).
+ * @param {number} [params.count=10] Number of contents to fetch.
+ * @param {array} [params.ids] Filter by ids of audit logs.
+ * @param {string} [params.from] Filter by logs younger than from.
+ * @param {string} [params.to] Filter by logs older than to.
+ * @param {string} [params.type] Filter by type.
+ * @param {string} [params.source] Filter by source.
+ * @param {array} [params.users] Filter by user keys.
+ * @param {array} [params.objects] Filter by object URIs.
+ *
+ * @returns {object} Audit log search results.
+ */
+export declare function find(params: FindAuditLogParams): AuditLogs;

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@enonic-types/lib-auditlog",
+    "version": "0.1.0",
+    "description": "Type definitions for lib-auditlog.",
+    "types": "auditlog.d.ts",
+    "files": [
+        "auditlog.d.ts"
+    ],
+    "scripts": {
+        "pre": "npm run --prefix ../ pre",
+        "packlist": "npx npm-packlist"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "lib-auditlog",
+        "auditlog",
+        "types",
+        "typescript"
+    ],
+    "contributors": [
+        "Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
+    ],
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/enonic/xp/issues"
+    },
+    "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "publishConfig": {
+        "access": "public"
+    }
+}