@apinecka/logs-client 0.0.0-stage → 1.1.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 (75) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +189 -2
  3. package/dist/client.d.ts +68 -0
  4. package/dist/client.js +372 -0
  5. package/dist/client.js.map +1 -0
  6. package/dist/conform.d.ts +39 -0
  7. package/dist/conform.js +187 -0
  8. package/dist/conform.js.map +1 -0
  9. package/dist/context.d.ts +60 -0
  10. package/dist/context.js +118 -0
  11. package/dist/context.js.map +1 -0
  12. package/dist/error.d.ts +8 -0
  13. package/dist/error.js +58 -0
  14. package/dist/error.js.map +1 -0
  15. package/dist/index.d.ts +5 -0
  16. package/dist/index.js +22 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/nest/index.d.ts +1 -0
  19. package/dist/nest/index.js +18 -0
  20. package/dist/nest/index.js.map +1 -0
  21. package/dist/nest/logs.logger.d.ts +39 -0
  22. package/dist/nest/logs.logger.js +199 -0
  23. package/dist/nest/logs.logger.js.map +1 -0
  24. package/dist/schema/index.d.ts +7 -0
  25. package/dist/schema/index.js +9 -0
  26. package/dist/schema/index.js.map +1 -0
  27. package/dist/schema/models/createLog.d.ts +53 -0
  28. package/dist/schema/models/createLog.js +3 -0
  29. package/dist/schema/models/createLog.js.map +1 -0
  30. package/dist/schema/models/createLogBatch.d.ts +15 -0
  31. package/dist/schema/models/createLogBatch.js +3 -0
  32. package/dist/schema/models/createLogBatch.js.map +1 -0
  33. package/dist/schema/models/createLogBatchResult.d.ts +13 -0
  34. package/dist/schema/models/createLogBatchResult.js +10 -0
  35. package/dist/schema/models/createLogBatchResult.js.map +1 -0
  36. package/dist/schema/models/createLogMeta.d.ts +13 -0
  37. package/dist/schema/models/createLogMeta.js +10 -0
  38. package/dist/schema/models/createLogMeta.js.map +1 -0
  39. package/dist/schema/models/createLogTags.d.ts +13 -0
  40. package/dist/schema/models/createLogTags.js +10 -0
  41. package/dist/schema/models/createLogTags.js.map +1 -0
  42. package/dist/schema/models/index.d.ts +21 -0
  43. package/dist/schema/models/index.js +38 -0
  44. package/dist/schema/models/index.js.map +1 -0
  45. package/dist/schema/models/logContexts.d.ts +15 -0
  46. package/dist/schema/models/logContexts.js +3 -0
  47. package/dist/schema/models/logContexts.js.map +1 -0
  48. package/dist/schema/models/logError.d.ts +21 -0
  49. package/dist/schema/models/logError.js +3 -0
  50. package/dist/schema/models/logError.js.map +1 -0
  51. package/dist/schema/models/logLevel.d.ts +16 -0
  52. package/dist/schema/models/logLevel.js +19 -0
  53. package/dist/schema/models/logLevel.js.map +1 -0
  54. package/dist/schema/models/logRequestContext.d.ts +28 -0
  55. package/dist/schema/models/logRequestContext.js +3 -0
  56. package/dist/schema/models/logRequestContext.js.map +1 -0
  57. package/dist/schema/models/logRequestContextHeaders.d.ts +13 -0
  58. package/dist/schema/models/logRequestContextHeaders.js +10 -0
  59. package/dist/schema/models/logRequestContextHeaders.js.map +1 -0
  60. package/dist/schema/models/logRequestContextQuery.d.ts +13 -0
  61. package/dist/schema/models/logRequestContextQuery.js +10 -0
  62. package/dist/schema/models/logRequestContextQuery.js.map +1 -0
  63. package/dist/schema/models/logRuntimeContext.d.ts +20 -0
  64. package/dist/schema/models/logRuntimeContext.js +10 -0
  65. package/dist/schema/models/logRuntimeContext.js.map +1 -0
  66. package/dist/schema/models/logStackFrame.d.ts +17 -0
  67. package/dist/schema/models/logStackFrame.js +10 -0
  68. package/dist/schema/models/logStackFrame.js.map +1 -0
  69. package/dist/schema/models/logUser.d.ts +13 -0
  70. package/dist/schema/models/logUser.js +10 -0
  71. package/dist/schema/models/logUser.js.map +1 -0
  72. package/dist/types.d.ts +63 -0
  73. package/dist/types.js +3 -0
  74. package/dist/types.js.map +1 -0
  75. package/package.json +69 -5
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Generated by orval 🍺
3
+ * Do not edit manually.
4
+ * Apinecka Logs API
5
+ * Apinecka Logs API
6
+ * OpenAPI spec version: 1.0.0
7
+ */
8
+ /**
9
+ * Parsed query string
10
+ */
11
+ export type LogRequestContextQuery = {
12
+ [key: string]: unknown;
13
+ };
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval 🍺
4
+ * Do not edit manually.
5
+ * Apinecka Logs API
6
+ * Apinecka Logs API
7
+ * OpenAPI spec version: 1.0.0
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ //# sourceMappingURL=logRequestContextQuery.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logRequestContextQuery.js","sourceRoot":"","sources":["../../../src/schema/models/logRequestContextQuery.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Generated by orval 🍺
3
+ * Do not edit manually.
4
+ * Apinecka Logs API
5
+ * Apinecka Logs API
6
+ * OpenAPI spec version: 1.0.0
7
+ */
8
+ export interface LogRuntimeContext {
9
+ hostname?: string;
10
+ pid?: number;
11
+ nodeVersion?: string;
12
+ platform?: string;
13
+ arch?: string;
14
+ /** Resident set size in bytes */
15
+ memoryRssBytes?: number;
16
+ /** Used heap in bytes */
17
+ heapUsedBytes?: number;
18
+ /** Process uptime in seconds */
19
+ uptimeSeconds?: number;
20
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval 🍺
4
+ * Do not edit manually.
5
+ * Apinecka Logs API
6
+ * Apinecka Logs API
7
+ * OpenAPI spec version: 1.0.0
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ //# sourceMappingURL=logRuntimeContext.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logRuntimeContext.js","sourceRoot":"","sources":["../../../src/schema/models/logRuntimeContext.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Generated by orval 🍺
3
+ * Do not edit manually.
4
+ * Apinecka Logs API
5
+ * Apinecka Logs API
6
+ * OpenAPI spec version: 1.0.0
7
+ */
8
+ export interface LogStackFrame {
9
+ /** Function or method name */
10
+ function?: string;
11
+ /** File path or URL */
12
+ module?: string;
13
+ line?: number;
14
+ column?: number;
15
+ /** Whether the frame is the app's own code (not a dependency or runtime internals) */
16
+ inApp?: boolean;
17
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval 🍺
4
+ * Do not edit manually.
5
+ * Apinecka Logs API
6
+ * Apinecka Logs API
7
+ * OpenAPI spec version: 1.0.0
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ //# sourceMappingURL=logStackFrame.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logStackFrame.js","sourceRoot":"","sources":["../../../src/schema/models/logStackFrame.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Generated by orval 🍺
3
+ * Do not edit manually.
4
+ * Apinecka Logs API
5
+ * Apinecka Logs API
6
+ * OpenAPI spec version: 1.0.0
7
+ */
8
+ export interface LogUser {
9
+ /** @maxLength 128 */
10
+ id?: string;
11
+ email?: string;
12
+ username?: string;
13
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval 🍺
4
+ * Do not edit manually.
5
+ * Apinecka Logs API
6
+ * Apinecka Logs API
7
+ * OpenAPI spec version: 1.0.0
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ //# sourceMappingURL=logUser.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logUser.js","sourceRoot":"","sources":["../../../src/schema/models/logUser.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
@@ -0,0 +1,63 @@
1
+ import type { CreateLog } from './schema/models';
2
+ /** Queue and batching limits of {@link LogsClient.enqueue}. */
3
+ export interface LogsBatchingOptions {
4
+ /** Entries held in memory; on overflow the oldest are dropped. Default 1000. */
5
+ maxQueueItems?: number;
6
+ /** JSON size of the queue; on overflow the oldest entries are dropped. Default 5 MB. */
7
+ maxQueueBytes?: number;
8
+ /** A batch is sent as soon as this many entries are queued. Default 100. */
9
+ maxBatchItems?: number;
10
+ /** JSON size budget of one batch request. Default 4 MB (the server accepts 5 MB). */
11
+ maxBatchBytes?: number;
12
+ /** Queued entries are flushed at least this often. Default 2000 ms. */
13
+ flushIntervalMs?: number;
14
+ }
15
+ /** Retry policy for failed batch requests (network errors, timeouts, 5xx). */
16
+ export interface LogsRetryOptions {
17
+ /** Retries of one batch before it is dropped. Default 8. */
18
+ maxRetries?: number;
19
+ /** Base of the exponential backoff (full jitter). Default 1000 ms. */
20
+ baseDelayMs?: number;
21
+ /** Cap of the backoff. Default 60000 ms. */
22
+ maxDelayMs?: number;
23
+ /** Pause after a 429 without a usable `Retry-After`. Default 30000 ms. */
24
+ rateLimitPauseMs?: number;
25
+ }
26
+ /** Flood protection of {@link LogsClient.enqueue}: repeated entries are collapsed into one with `meta._suppressed`. */
27
+ export interface LogsSamplingOptions {
28
+ /** Entries per key (level + context + error type + message start) that pass per window. Default 20. */
29
+ maxPerKey?: number;
30
+ /** Window length. Default 60000 ms. */
31
+ windowMs?: number;
32
+ }
33
+ /**
34
+ * Sends one request. Must throw an axios-like error (`response.status`, `response.headers`) on failure.
35
+ * Meant for tests; the default uses axios.
36
+ */
37
+ export type LogsTransport = (path: string, body: unknown) => Promise<unknown>;
38
+ export interface LogsClientOptions {
39
+ /** Base URL of logs-api, e.g. `https://logs.apinecka.com`. */
40
+ baseUrl: string;
41
+ /** An ingest token (sent as a Bearer token) - it decides the account and the default env of the logs. */
42
+ apiKey?: string;
43
+ /** Per-request timeout, default 5000 ms. */
44
+ timeoutMs?: number;
45
+ /** App version added to entries without one. Default `process.env.LOGS_RELEASE ?? process.env.GIT_SHA`. */
46
+ release?: string;
47
+ /** Env added to entries without one (otherwise the env of the ingest token applies). */
48
+ env?: string;
49
+ /** Tags added to every entry (the entry's and the active context's own tags win). */
50
+ defaultTags?: Record<string, string>;
51
+ /** Attach `contexts.runtime` (host, pid, node version, memory, uptime) to enqueued entries. Default true. */
52
+ runtimeContext?: boolean;
53
+ batching?: LogsBatchingOptions;
54
+ retry?: LogsRetryOptions;
55
+ /** Flood protection, `false` disables it. */
56
+ sampling?: LogsSamplingOptions | false;
57
+ /** Replaces the HTTP transport (tests). */
58
+ transport?: LogsTransport;
59
+ }
60
+ /** @deprecated Name from the pre-package era, use {@link LogsClientOptions}. */
61
+ export type ApiClientOptions = LogsClientOptions;
62
+ /** The body of `POST /logs`. */
63
+ export type CreateLogRequest = CreateLog;
package/dist/types.js ADDED
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,70 @@
1
1
  {
2
- "name": "@apinecka/logs-client",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
2
+ "name": "@apinecka/logs-client",
3
+ "version": "1.1.0",
4
+ "description": "Client for the Apinecka logs-api ingest endpoint: a small HTTP client and a NestJS logger that ships logs to it.",
5
+ "keywords": [
6
+ "logs",
7
+ "logging",
8
+ "nestjs",
9
+ "logger",
10
+ "apinecka"
11
+ ],
12
+ "main": "dist/index.js",
13
+ "types": "dist/index.d.ts",
14
+ "exports": {
15
+ ".": {
16
+ "types": "./dist/index.d.ts",
17
+ "default": "./dist/index.js"
18
+ },
19
+ "./nest": {
20
+ "types": "./dist/nest/index.d.ts",
21
+ "default": "./dist/nest/index.js"
22
+ }
23
+ },
24
+ "typesVersions": {
25
+ "*": {
26
+ "nest": ["dist/nest/index.d.ts"]
27
+ }
28
+ },
29
+ "files": [
30
+ "dist",
31
+ "README.md",
32
+ "LICENSE"
33
+ ],
34
+ "scripts": {
35
+ "build": "tsc -p tsconfig.build.json",
36
+ "clean": "del-cli dist",
37
+ "test": "jest",
38
+ "prepublishOnly": "npm run clean && npm test && npm run build"
39
+ },
40
+ "author": "Tomáš Cupák <tomcupak@gmail.com>",
41
+ "license": "MIT",
42
+ "publishConfig": {
43
+ "access": "public"
44
+ },
45
+ "engines": {
46
+ "node": ">=20"
47
+ },
48
+ "dependencies": {
49
+ "axios": "^1.10.0"
50
+ },
51
+ "peerDependencies": {
52
+ "@nestjs/common": "^11.0.0"
53
+ },
54
+ "peerDependenciesMeta": {
55
+ "@nestjs/common": {
56
+ "optional": true
57
+ }
58
+ },
59
+ "devDependencies": {
60
+ "@nestjs/common": "^11.1.7",
61
+ "@types/jest": "^30.0.0",
62
+ "@types/node": "^22.15.33",
63
+ "del-cli": "^7.0.0",
64
+ "jest": "^30.0.2",
65
+ "reflect-metadata": "^0.2.2",
66
+ "rxjs": "^7.8.2",
67
+ "ts-jest": "^29.4.0",
68
+ "typescript": "^5.8.3"
69
+ }
70
+ }