@infinitetoken/lumber-kit 0.4.22 → 0.4.23

package/README.md

@@ -53,6 +53,15 @@ import { LogLevel, LogRecord, LogEncrypted, LogPayload, LogsQuery } from '@infin
 | `TeamRecord` | interface | API response shape for a team |
 | `TeamMemberRecord` | interface | Team membership record |
 
+### API keys
+
+| Export | Kind | Purpose |
+|--------|------|---------|
+| `joinApiKey` | function | Joins an app's API token and its encryption key as `<token>.<encryptionKey>`, the one secret a plugin is configured with |
+| `splitApiKey` | function | Splits an API key into `{ token, encryptionKey? }`; a bare token, as keys were before they were joined, has no encryption key |
+
+A plugin sends only the token to the API (`Authorization: Bearer <token>`) and encrypts with the rest, so the encryption key never leaves it.
+
 ## Wire format
 
 All log content is E2E encrypted before leaving the client. `LogRecord` contains only:

package/dist/index.d.mts

@@ -355,5 +355,16 @@ declare const isValidDeviceLinkStatus: (value: unknown) => value is DeviceLinkSt
 declare const isValidTeamMemberRole: (value: unknown) => value is TeamMemberRecord["role"];
 /** Accepts any valid absolute URL (https://..., http://..., etc.). */
 declare const isValidImageUrl: (value: unknown) => value is string;
+/**
+ * The API key the Lumber app hands out: an app's API token and its encryption key, joined as `<token>.<encryptionKey>`,
+ * so a plugin is configured with one secret. A plugin sends only the token to the API (`Authorization: Bearer <token>`)
+ * and encrypts with the rest, so the encryption key never leaves it. Neither half can contain a `.` (hex and base64).
+ */
+declare const joinApiKey: (token: string, encryptionKey: string) => string;
+/** Splits an API key into its token and encryption key. A bare token, as keys were before they were joined, has no encryption key. */
+declare const splitApiKey: (apiKey: string) => {
+    token: string;
+    encryptionKey?: string;
+};
 
-export { type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppRecord, type Appearance, type AppsQuery, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type LogContext, type LogEncrypted, LogLevel, type LogLevelName, type LogPayload, type LogRecord, type LogTimeseriesQuery, type LogsQuery, type NoteEncrypted, type NoteRecord, type NotesQuery, type NotificationPreference, type NotificationPreferences, type PushToken, type ResponseMetadata, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, logLevelNameToLevel, logLevelToName, logLevels, subscriptionLevelToName, subscriptionLevels, subscriptionLimits };
+export { type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppRecord, type Appearance, type AppsQuery, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type LogContext, type LogEncrypted, LogLevel, type LogLevelName, type LogPayload, type LogRecord, type LogTimeseriesQuery, type LogsQuery, type NoteEncrypted, type NoteRecord, type NotesQuery, type NotificationPreference, type NotificationPreferences, type PushToken, type ResponseMetadata, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelNameToLevel, logLevelToName, logLevels, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits };

package/dist/index.d.ts

@@ -355,5 +355,16 @@ declare const isValidDeviceLinkStatus: (value: unknown) => value is DeviceLinkSt
 declare const isValidTeamMemberRole: (value: unknown) => value is TeamMemberRecord["role"];
 /** Accepts any valid absolute URL (https://..., http://..., etc.). */
 declare const isValidImageUrl: (value: unknown) => value is string;
+/**
+ * The API key the Lumber app hands out: an app's API token and its encryption key, joined as `<token>.<encryptionKey>`,
+ * so a plugin is configured with one secret. A plugin sends only the token to the API (`Authorization: Bearer <token>`)
+ * and encrypts with the rest, so the encryption key never leaves it. Neither half can contain a `.` (hex and base64).
+ */
+declare const joinApiKey: (token: string, encryptionKey: string) => string;
+/** Splits an API key into its token and encryption key. A bare token, as keys were before they were joined, has no encryption key. */
+declare const splitApiKey: (apiKey: string) => {
+    token: string;
+    encryptionKey?: string;
+};
 
-export { type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppRecord, type Appearance, type AppsQuery, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type LogContext, type LogEncrypted, LogLevel, type LogLevelName, type LogPayload, type LogRecord, type LogTimeseriesQuery, type LogsQuery, type NoteEncrypted, type NoteRecord, type NotesQuery, type NotificationPreference, type NotificationPreferences, type PushToken, type ResponseMetadata, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, logLevelNameToLevel, logLevelToName, logLevels, subscriptionLevelToName, subscriptionLevels, subscriptionLimits };
+export { type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppRecord, type Appearance, type AppsQuery, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type LogContext, type LogEncrypted, LogLevel, type LogLevelName, type LogPayload, type LogRecord, type LogTimeseriesQuery, type LogsQuery, type NoteEncrypted, type NoteRecord, type NotesQuery, type NotificationPreference, type NotificationPreferences, type PushToken, type ResponseMetadata, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelNameToLevel, logLevelToName, logLevels, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits };

package/dist/index.js

@@ -29,9 +29,11 @@ __export(index_exports, {
   isValidLogLevel: () => isValidLogLevel,
   isValidSubscriptionLevel: () => isValidSubscriptionLevel,
   isValidTeamMemberRole: () => isValidTeamMemberRole,
+  joinApiKey: () => joinApiKey,
   logLevelNameToLevel: () => logLevelNameToLevel,
   logLevelToName: () => logLevelToName,
   logLevels: () => logLevels,
+  splitApiKey: () => splitApiKey,
   subscriptionLevelToName: () => subscriptionLevelToName,
   subscriptionLevels: () => subscriptionLevels,
   subscriptionLimits: () => subscriptionLimits
@@ -104,6 +106,13 @@ var isValidImageUrl = (value) => {
     return false;
   }
 };
+var joinApiKey = (token, encryptionKey) => `${token}.${encryptionKey}`;
+var splitApiKey = (apiKey) => {
+  const value = apiKey.trim();
+  const dot = value.indexOf(".");
+  if (dot === -1) return { token: value };
+  return { token: value.slice(0, dot), encryptionKey: value.slice(dot + 1) };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LogLevel,
@@ -115,9 +124,11 @@ var isValidImageUrl = (value) => {
   isValidLogLevel,
   isValidSubscriptionLevel,
   isValidTeamMemberRole,
+  joinApiKey,
   logLevelNameToLevel,
   logLevelToName,
   logLevels,
+  splitApiKey,
   subscriptionLevelToName,
   subscriptionLevels,
   subscriptionLimits

package/dist/index.mjs

@@ -64,6 +64,13 @@ var isValidImageUrl = (value) => {
     return false;
   }
 };
+var joinApiKey = (token, encryptionKey) => `${token}.${encryptionKey}`;
+var splitApiKey = (apiKey) => {
+  const value = apiKey.trim();
+  const dot = value.indexOf(".");
+  if (dot === -1) return { token: value };
+  return { token: value.slice(0, dot), encryptionKey: value.slice(dot + 1) };
+};
 export {
   LogLevel,
   SubscriptionLevel,
@@ -74,9 +81,11 @@ export {
   isValidLogLevel,
   isValidSubscriptionLevel,
   isValidTeamMemberRole,
+  joinApiKey,
   logLevelNameToLevel,
   logLevelToName,
   logLevels,
+  splitApiKey,
   subscriptionLevelToName,
   subscriptionLevels,
   subscriptionLimits

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infinitetoken/lumber-kit",
-  "version": "0.4.22",
+  "version": "0.4.23",
   "description": "Shared TypeScript types and wire format contracts for the Lumber cloud logging suite",
   "keywords": [
     "lumber",
@@ -56,9 +56,9 @@
   },
   "prettier": "@infinitetoken/eslint-config/prettier",
   "devDependencies": {
-    "@infinitetoken/eslint-config": "^0.1.6",
-    "@infinitetoken/jest-config": "^0.1.3",
-    "@infinitetoken/tsconfig": "^0.3.0",
+    "@infinitetoken/eslint-config": "^0.2.1",
+    "@infinitetoken/jest-config": "^0.5.2",
+    "@infinitetoken/tsconfig": "^0.6.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.0",
     "eslint": "^10.2.1",