@meistrari/audit-sdk 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/client.d.ts +10 -1
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +10 -1
  4. package/package.json +29 -29
package/dist/client.d.ts CHANGED
@@ -24,7 +24,16 @@ export declare class AuditClient {
24
24
  private timeoutMs;
25
25
  private maxRetries;
26
26
  private sourceApp;
27
- constructor(config: AuditClientConfig);
27
+ /**
28
+ * Creates a new AuditClient instance.
29
+ *
30
+ * @param config - Configuration options for the client.
31
+ * @param config.baseUrl - Base URL of the Audit API. Falls back to the `AUDIT_API_BASE_URL` environment variable.
32
+ * @param config.timeoutMs - Request timeout in milliseconds. Defaults to `5000`.
33
+ * @param config.maxRetries - Maximum number of retry attempts for failed requests. Defaults to `3`.
34
+ * @param config.sourceApp - The source application sending the events. Falls back to the `AUDIT_SOURCE_APP` environment variable.
35
+ */
36
+ constructor(config?: AuditClientConfig);
28
37
  track(dataToken: string, event: AuditEvent): Promise<void>;
29
38
  trackMany(dataToken: string, events: AuditEvent[]): Promise<void>;
30
39
  private logFailure;
package/dist/client.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAA;AAEjD,KAAK,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAC9C,KAAK,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE9C,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,WAAW,CAAA;IACnB,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,IAAI,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,SAAS,CAAC,EAAE,SAAS,CAAA;CACxB;AAED,qBAAa,WAAW;IACpB,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,SAAS,CAAQ;gBAEb,MAAM,EAAE,iBAAiB;IAmB/B,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAI1C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE;IA6CvD,OAAO,CAAC,UAAU;YAWJ,KAAK;CAGtB;AAED,qBAAa,UAAW,SAAQ,KAAK;IACG,OAAO,CAAC,EAAE,OAAO;gBAAzC,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,OAAO,YAAA;CAIxD"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAA;AAEjD,KAAK,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAC9C,KAAK,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE9C,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,WAAW,CAAA;IACnB,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,IAAI,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,SAAS,CAAA;CACxB;AAED,qBAAa,WAAW;IACpB,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;;;;;OAQG;gBACS,MAAM,GAAE,iBAAsB;IAmBpC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAI1C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE;IA6CvD,OAAO,CAAC,UAAU;YAWJ,KAAK;CAGtB;AAED,qBAAa,UAAW,SAAQ,KAAK;IACG,OAAO,CAAC,EAAE,OAAO;gBAAzC,OAAO,EAAE,MAAM,EAAS,OAAO,CAAC,EAAE,OAAO,YAAA;CAIxD"}
package/dist/client.js CHANGED
@@ -2,7 +2,16 @@ import process from 'node:process';
2
2
  import pino from '@meistrari/logger';
3
3
  const logger = pino();
4
4
  export class AuditClient {
5
- constructor(config) {
5
+ /**
6
+ * Creates a new AuditClient instance.
7
+ *
8
+ * @param config - Configuration options for the client.
9
+ * @param config.baseUrl - Base URL of the Audit API. Falls back to the `AUDIT_API_BASE_URL` environment variable.
10
+ * @param config.timeoutMs - Request timeout in milliseconds. Defaults to `5000`.
11
+ * @param config.maxRetries - Maximum number of retry attempts for failed requests. Defaults to `3`.
12
+ * @param config.sourceApp - The source application sending the events. Falls back to the `AUDIT_SOURCE_APP` environment variable.
13
+ */
14
+ constructor(config = {}) {
6
15
  const baseUrl = config.baseUrl || process.env.AUDIT_API_BASE_URL;
7
16
  if (!baseUrl) {
8
17
  throw new Error('AuditClient requires a baseUrl');
package/package.json CHANGED
@@ -1,31 +1,31 @@
1
1
  {
2
- "name": "@meistrari/audit-sdk",
3
- "version": "0.2.1",
4
- "type": "module",
5
- "main": "dist/index.js",
6
- "description": "",
7
- "repository": {
8
- "type": "git",
9
- "url": "git+https://github.com/meistrari/audit-service.git"
10
- },
11
- "types": "dist/index.d.ts",
12
- "files": [
13
- "dist"
14
- ],
15
- "scripts": {
16
- "build": "tsc -p tsconfig.json",
17
- "postinstall": "mise-en-place postinstall",
18
- "clean": "rm -rf dist"
19
- },
20
- "engines": {
21
- "node": ">=18"
22
- },
23
- "devDependencies": {
24
- "@meistrari/mise-en-place": "^2.10.2",
25
- "@types/node": "^25.2.3",
26
- "typescript": "^5.3.3"
27
- },
28
- "dependencies": {
29
- "@meistrari/logger": "^2.1.3"
30
- }
2
+ "name": "@meistrari/audit-sdk",
3
+ "version": "0.3.0",
4
+ "type": "module",
5
+ "main": "dist/index.js",
6
+ "description": "",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/meistrari/audit-service.git"
10
+ },
11
+ "types": "dist/index.d.ts",
12
+ "files": [
13
+ "dist"
14
+ ],
15
+ "scripts": {
16
+ "build": "tsc -p tsconfig.json",
17
+ "prepare": "mise-en-place postinstall",
18
+ "clean": "rm -rf dist"
19
+ },
20
+ "engines": {
21
+ "node": ">=18"
22
+ },
23
+ "devDependencies": {
24
+ "@meistrari/mise-en-place": "^2.10.3",
25
+ "@types/node": "^25.2.3",
26
+ "typescript": "^5.3.3"
27
+ },
28
+ "dependencies": {
29
+ "@meistrari/logger": "^2.1.3"
30
+ }
31
31
  }