@infinitetoken/lumber-kit 0.1.0

package/README.md

@@ -0,0 +1,60 @@
+# @infinitetoken/lumber-kit
+
+Shared TypeScript types, wire format contract, and query interfaces for the [Lumber](https://github.com/infinitetoken/Lumber) cloud logging suite.
+
+## Install
+
+```
+npm install @infinitetoken/lumber-kit
+```
+
+## Usage
+
+```typescript
+import { LogLevel, LogRecord, EncryptedPayload, LogQuery } from '@infinitetoken/lumber-kit'
+```
+
+## Exports
+
+| Export | Kind | Purpose |
+|--------|------|---------|
+| `LogLevel` | `const enum` | Log severity: Debug=0 Info=1 Warn=2 Error=3 Fatal=4 |
+| `SubscriptionLevel` | `const enum` | User tier: Hobby=0 Dev=1 Pro=2 |
+| `LogPayload` | interface | Plaintext fields before encryption |
+| `EncryptedPayload` | interface | Wire format: `{ payload: string, v: number }` |
+| `LogRecord` | interface | API response shape for a stored log |
+| `AppRecord` | interface | API response shape for an app (no encryption_key) |
+| `AppCreatedRecord` | interface | POST /apps 201 response only (includes encryption_key once) |
+| `UserRecord` | interface | API response shape for a user (no password_digest) |
+| `LogQuery` | interface | GET /logs filter params |
+| `AppQuery` | interface | GET /apps filter params |
+
+## Wire Format
+
+`EncryptedPayload.payload` is `base64(IV[12 bytes] + AuthTag[16 bytes] + ciphertext)`.
+
+The `v` field is always `1` for the current wire format. Changes to this format are semver major.
+
+## const enum and Babel Consumers
+
+`LogLevel` is a TypeScript `const enum`. TypeScript consumers have values inlined at compile time (zero runtime overhead).
+
+If your project uses Babel, esbuild, or `isolatedModules: true`, the runtime enum object is available because Lumber-Kit is compiled with `preserveConstEnums: true`. No special configuration is needed in your project.
+
+## Local Development (yalc)
+
+Do NOT use `npm link` — it creates symlinks that break Metro in the Expo client.
+
+```bash
+# In Lumber-Kit:
+npm run build
+yalc publish
+
+# In a consumer repo (Lumber-API, Lumber-Node, Lumber Expo client):
+yalc add @infinitetoken/lumber-kit
+npm install
+
+# After updating Lumber-Kit:
+npm run build
+yalc push   # propagates to all linked consumers
+```

package/dist/cjs/constants/index.d.ts

@@ -0,0 +1,15 @@
+/** Log severity level. Numeric values match the existing Lumber-API level field. */
+export declare const enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3,
+    Fatal = 4
+}
+/** User subscription tier. Mirrors User.subscription_level in Lumber-API. */
+export declare const enum SubscriptionLevel {
+    Hobby = 0,
+    Dev = 1,
+    Pro = 2
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/constants/index.ts"],"names":[],"mappings":"AAEA,oFAAoF;AACpF,0BAAkB,QAAQ;IACxB,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;CACV;AAED,6EAA6E;AAC7E,0BAAkB,iBAAiB;IACjC,KAAK,IAAI;IACT,GAAG,IAAI;IACP,GAAG,IAAI;CACR"}

package/dist/cjs/constants/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// Source: D-01, D-02 (locked decisions — do not change numeric values without a semver major bump)
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionLevel = exports.LogLevel = void 0;
+/** Log severity level. Numeric values match the existing Lumber-API level field. */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["Debug"] = 0] = "Debug";
+    LogLevel[LogLevel["Info"] = 1] = "Info";
+    LogLevel[LogLevel["Warn"] = 2] = "Warn";
+    LogLevel[LogLevel["Error"] = 3] = "Error";
+    LogLevel[LogLevel["Fatal"] = 4] = "Fatal";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+/** User subscription tier. Mirrors User.subscription_level in Lumber-API. */
+var SubscriptionLevel;
+(function (SubscriptionLevel) {
+    SubscriptionLevel[SubscriptionLevel["Hobby"] = 0] = "Hobby";
+    SubscriptionLevel[SubscriptionLevel["Dev"] = 1] = "Dev";
+    SubscriptionLevel[SubscriptionLevel["Pro"] = 2] = "Pro";
+})(SubscriptionLevel || (exports.SubscriptionLevel = SubscriptionLevel = {}));

package/dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './constants';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA"}

package/dist/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./types"), exports);

package/dist/cjs/types/index.d.ts

@@ -0,0 +1,93 @@
+import { LogLevel, SubscriptionLevel } from '../constants';
+/**
+ * Plaintext log fields before encryption.
+ * Lumber-Node and Lumber-Python serialize this object, then encrypt it
+ * into EncryptedPayload.payload using AES-256-GCM.
+ */
+export interface LogPayload {
+    message?: string;
+    code?: string;
+    line?: number;
+    column?: number;
+    method?: string;
+    note?: string;
+}
+/**
+ * Encrypted wire format.
+ * payload = base64(IV[12 bytes] + AuthTag[16 bytes] + ciphertext)
+ * v = wire format version — always 1 in v1. Changes here are semver major.
+ */
+export interface EncryptedPayload {
+    payload: string;
+    v: number;
+}
+/**
+ * API response shape for a stored log.
+ * payload is the ciphertext — level and flagged are stored unencrypted for server-side filtering.
+ * Source: D-06, ENCRYPT-05, ENCRYPT-06
+ */
+export interface LogRecord {
+    id: string;
+    app_id: string;
+    level: LogLevel;
+    flagged: boolean;
+    payload: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * API response shape for a listed or fetched app.
+ * encryption_key is intentionally absent — it is returned once (in AppCreatedRecord) and never again.
+ * Source: D-06, ENCRYPT-02, ENCRYPT-03
+ */
+export interface AppRecord {
+    id: string;
+    user_id: string;
+    name: string;
+    token: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * App creation response only (POST /apps 201).
+ * Includes encryption_key once; subsequent GET /apps and GET /apps/:id responses use AppRecord.
+ * Source: D-06, ENCRYPT-02
+ */
+export interface AppCreatedRecord extends AppRecord {
+    encryption_key: string;
+}
+/**
+ * API response shape for an authenticated user.
+ * password_digest is intentionally absent.
+ */
+export interface UserRecord {
+    id: string;
+    email: string;
+    subscription_level: SubscriptionLevel;
+    agreed_to_terms: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Filter params for GET /logs.
+ * Source: D-06
+ */
+export interface LogQuery {
+    level?: LogLevel;
+    flagged?: boolean;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    from?: string;
+    to?: string;
+}
+/**
+ * Filter params for GET /apps.
+ * Source: D-06
+ */
+export interface AppQuery {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,EAAE,MAAM,CAAA;CACV;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,QAAQ,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,kBAAkB,EAAE,iBAAiB,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/dist/cjs/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/constants/index.d.ts

@@ -0,0 +1,15 @@
+/** Log severity level. Numeric values match the existing Lumber-API level field. */
+export declare const enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3,
+    Fatal = 4
+}
+/** User subscription tier. Mirrors User.subscription_level in Lumber-API. */
+export declare const enum SubscriptionLevel {
+    Hobby = 0,
+    Dev = 1,
+    Pro = 2
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/constants/index.ts"],"names":[],"mappings":"AAEA,oFAAoF;AACpF,0BAAkB,QAAQ;IACxB,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;CACV;AAED,6EAA6E;AAC7E,0BAAkB,iBAAiB;IACjC,KAAK,IAAI;IACT,GAAG,IAAI;IACP,GAAG,IAAI;CACR"}

package/dist/esm/constants/index.js

@@ -0,0 +1,17 @@
+// Source: D-01, D-02 (locked decisions — do not change numeric values without a semver major bump)
+/** Log severity level. Numeric values match the existing Lumber-API level field. */
+export var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["Debug"] = 0] = "Debug";
+    LogLevel[LogLevel["Info"] = 1] = "Info";
+    LogLevel[LogLevel["Warn"] = 2] = "Warn";
+    LogLevel[LogLevel["Error"] = 3] = "Error";
+    LogLevel[LogLevel["Fatal"] = 4] = "Fatal";
+})(LogLevel || (LogLevel = {}));
+/** User subscription tier. Mirrors User.subscription_level in Lumber-API. */
+export var SubscriptionLevel;
+(function (SubscriptionLevel) {
+    SubscriptionLevel[SubscriptionLevel["Hobby"] = 0] = "Hobby";
+    SubscriptionLevel[SubscriptionLevel["Dev"] = 1] = "Dev";
+    SubscriptionLevel[SubscriptionLevel["Pro"] = 2] = "Pro";
+})(SubscriptionLevel || (SubscriptionLevel = {}));

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './constants';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './types';

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

package/dist/esm/types/index.d.ts

@@ -0,0 +1,93 @@
+import { LogLevel, SubscriptionLevel } from '../constants';
+/**
+ * Plaintext log fields before encryption.
+ * Lumber-Node and Lumber-Python serialize this object, then encrypt it
+ * into EncryptedPayload.payload using AES-256-GCM.
+ */
+export interface LogPayload {
+    message?: string;
+    code?: string;
+    line?: number;
+    column?: number;
+    method?: string;
+    note?: string;
+}
+/**
+ * Encrypted wire format.
+ * payload = base64(IV[12 bytes] + AuthTag[16 bytes] + ciphertext)
+ * v = wire format version — always 1 in v1. Changes here are semver major.
+ */
+export interface EncryptedPayload {
+    payload: string;
+    v: number;
+}
+/**
+ * API response shape for a stored log.
+ * payload is the ciphertext — level and flagged are stored unencrypted for server-side filtering.
+ * Source: D-06, ENCRYPT-05, ENCRYPT-06
+ */
+export interface LogRecord {
+    id: string;
+    app_id: string;
+    level: LogLevel;
+    flagged: boolean;
+    payload: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * API response shape for a listed or fetched app.
+ * encryption_key is intentionally absent — it is returned once (in AppCreatedRecord) and never again.
+ * Source: D-06, ENCRYPT-02, ENCRYPT-03
+ */
+export interface AppRecord {
+    id: string;
+    user_id: string;
+    name: string;
+    token: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * App creation response only (POST /apps 201).
+ * Includes encryption_key once; subsequent GET /apps and GET /apps/:id responses use AppRecord.
+ * Source: D-06, ENCRYPT-02
+ */
+export interface AppCreatedRecord extends AppRecord {
+    encryption_key: string;
+}
+/**
+ * API response shape for an authenticated user.
+ * password_digest is intentionally absent.
+ */
+export interface UserRecord {
+    id: string;
+    email: string;
+    subscription_level: SubscriptionLevel;
+    agreed_to_terms: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Filter params for GET /logs.
+ * Source: D-06
+ */
+export interface LogQuery {
+    level?: LogLevel;
+    flagged?: boolean;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    from?: string;
+    to?: string;
+}
+/**
+ * Filter params for GET /apps.
+ * Source: D-06
+ */
+export interface AppQuery {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,EAAE,MAAM,CAAA;CACV;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,QAAQ,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,kBAAkB,EAAE,iBAAiB,CAAA;IACrC,eAAe,EAAE,OAAO,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/dist/esm/types/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@infinitetoken/lumber-kit",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types and wire format contracts for the Lumber cloud logging suite",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "clean": "rm -rf dist coverage",
+    "test": "jest",
+    "lint": "eslint .",
+    "fix": "eslint . --fix",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.59.1",
+    "@typescript-eslint/parser": "^8.59.1",
+    "eslint": "^10.2.1",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-simple-import-sort": "^13.0.0",
+    "jest": "^30.3.0",
+    "prettier": "^3.8.3",
+    "ts-jest": "^29.4.9",
+    "typescript": "^6.0.3"
+  }
+}