@infinitetoken/lumber-kit 0.5.0 → 0.5.2

package/README.md

@@ -101,6 +101,17 @@ import { LogLevel, LogRecord, LogEncrypted, LogPayload, LogsQuery } from '@infin
 | `KeyPin` | interface | An account key a user accepted for someone, with its MAC |
 | `HolderKeyCheck`, `ClaimantKeyCheck`, `KeyCheckResult` | interfaces | A key check as the holder and the person being confirmed read it |
 
+### Colors
+
+| Export | Kind | Purpose |
+|--------|------|---------|
+| `logLevelColors` | object | Each `LogLevel`'s color, as the apps and the CLI draw it |
+| `DEFAULT_ACCENT` | constant | The accent until someone picks their own (their account's `color`): amber `#FBBF24` |
+| `APP_COLORS` | array | The twelve colors `nameColor` picks from |
+| `nameColor` | function | A stable color for a name, ignoring case and surrounding spaces, the same on every device |
+| `resolveAppColor` | function | An app's own color, or its name's |
+| `personColor` | function | Someone else's color, from their user id |
+
 ### API keys
 
 | Export | Kind | Purpose |

package/dist/index.d.mts

@@ -1,3 +1,13 @@
+/** Each log level's color: its label in the apps' log list, a level's heat on the heatmap, the CLI's level column. */
+declare const logLevelColors: Record<number, string>;
+/** The accent until someone picks their own (their account's `color`): amber, the wordmark's and the icon's. */
+declare const DEFAULT_ACCENT = "#FBBF24";
+/**
+ * Colors for an app without one of its own, and for other people, picked by `nameColor`: Tailwind's 500s, roughly
+ * evenly spaced around the wheel, vivid and mid-light enough to read on dark and light surfaces.
+ */
+declare const APP_COLORS: readonly ["#EF4444", "#F97316", "#F59E0B", "#84CC16", "#22C55E", "#14B8A6", "#06B6D4", "#3B82F6", "#6366F1", "#8B5CF6", "#D946EF", "#EC4899"];
+
 /**
  * Machine-readable reasons the API refuses a request, sent as `code` beside `message` where one status means more than
  * one thing. Messages are for people and may change; clients decide by the code.
@@ -574,6 +584,8 @@ interface PushToken {
 interface NotificationPreference {
     enabled?: boolean;
     minimumLevel?: number;
+    /** Whether new notes on this app push, over the account's `notes`; missing follows the account's. */
+    notes?: boolean;
     lastReadAt?: string;
 }
 interface NotificationPreferences {
@@ -608,6 +620,15 @@ interface UserRecord {
 declare const isValidAppearance: (value: unknown) => value is Appearance;
 /** Accepts 3- and 6-digit hex color strings (#rgb, #rrggbb). */
 declare const isValidColor: (value: string) => boolean;
+/**
+ * One of APP_COLORS for a name, ignoring case and surrounding spaces. Nothing is stored: every device works out the
+ * same color.
+ */
+declare const nameColor: (name: string) => string;
+/** An app's color: the one its owner picked, or its name's. */
+declare const resolveAppColor: (name: string, color?: string | null) => string;
+/** Someone else's color, from their user id, since their own accent lives on their account. */
+declare const personColor: (userId: string) => string;
 declare const isValidLogLevel: (value: unknown) => value is LogLevel;
 declare const isValidSubscriptionLevel: (value: unknown) => value is SubscriptionLevel;
 declare const isValidDeviceLinkStatus: (value: unknown) => value is DeviceLinkStatus;
@@ -636,4 +657,4 @@ declare const apiErrorCodeOf: (body: unknown) => ApiErrorCode | null;
 /** A push notification's data as PushData, or null for data no Lumber push sends. */
 declare const parsePushData: (data: unknown) => PushData | null;
 
-export { type ApiErrorBody, type ApiErrorCode, type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppKeyUpsertBody, type AppPermission, type AppPersonRecord, type AppRecord, type AppTeamAccess, type Appearance, type AppsQuery, type ClaimantKeyCheck, type ClientToServerEvents, DEFAULT_PUSH_THRESHOLD, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type HolderKeyCheck, type InvitationRecord, type KeyCheckResult, type KeyHolder, type KeyPin, 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, PUSH_OFF, type PendingAppKey, type PushData, type PushThreshold, type PushToken, type PushType, type ResponseMetadata, type ServerToClientEvents, type SocketAppPayload, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type SubscriptionPlan, type SubscriptionPlanRecord, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, apiErrorCodeOf, apiErrorCodes, isApiErrorCode, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelNameToLevel, logLevelToName, logLevels, normalizePushThreshold, parsePushData, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits, subscriptionPlans };
+export { APP_COLORS, type ApiErrorBody, type ApiErrorCode, type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppKeyUpsertBody, type AppPermission, type AppPersonRecord, type AppRecord, type AppTeamAccess, type Appearance, type AppsQuery, type ClaimantKeyCheck, type ClientToServerEvents, DEFAULT_ACCENT, DEFAULT_PUSH_THRESHOLD, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type HolderKeyCheck, type InvitationRecord, type KeyCheckResult, type KeyHolder, type KeyPin, 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, PUSH_OFF, type PendingAppKey, type PushData, type PushThreshold, type PushToken, type PushType, type ResponseMetadata, type ServerToClientEvents, type SocketAppPayload, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type SubscriptionPlan, type SubscriptionPlanRecord, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, apiErrorCodeOf, apiErrorCodes, isApiErrorCode, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelColors, logLevelNameToLevel, logLevelToName, logLevels, nameColor, normalizePushThreshold, parsePushData, personColor, resolveAppColor, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits, subscriptionPlans };

package/dist/index.d.ts

@@ -1,3 +1,13 @@
+/** Each log level's color: its label in the apps' log list, a level's heat on the heatmap, the CLI's level column. */
+declare const logLevelColors: Record<number, string>;
+/** The accent until someone picks their own (their account's `color`): amber, the wordmark's and the icon's. */
+declare const DEFAULT_ACCENT = "#FBBF24";
+/**
+ * Colors for an app without one of its own, and for other people, picked by `nameColor`: Tailwind's 500s, roughly
+ * evenly spaced around the wheel, vivid and mid-light enough to read on dark and light surfaces.
+ */
+declare const APP_COLORS: readonly ["#EF4444", "#F97316", "#F59E0B", "#84CC16", "#22C55E", "#14B8A6", "#06B6D4", "#3B82F6", "#6366F1", "#8B5CF6", "#D946EF", "#EC4899"];
+
 /**
  * Machine-readable reasons the API refuses a request, sent as `code` beside `message` where one status means more than
  * one thing. Messages are for people and may change; clients decide by the code.
@@ -574,6 +584,8 @@ interface PushToken {
 interface NotificationPreference {
     enabled?: boolean;
     minimumLevel?: number;
+    /** Whether new notes on this app push, over the account's `notes`; missing follows the account's. */
+    notes?: boolean;
     lastReadAt?: string;
 }
 interface NotificationPreferences {
@@ -608,6 +620,15 @@ interface UserRecord {
 declare const isValidAppearance: (value: unknown) => value is Appearance;
 /** Accepts 3- and 6-digit hex color strings (#rgb, #rrggbb). */
 declare const isValidColor: (value: string) => boolean;
+/**
+ * One of APP_COLORS for a name, ignoring case and surrounding spaces. Nothing is stored: every device works out the
+ * same color.
+ */
+declare const nameColor: (name: string) => string;
+/** An app's color: the one its owner picked, or its name's. */
+declare const resolveAppColor: (name: string, color?: string | null) => string;
+/** Someone else's color, from their user id, since their own accent lives on their account. */
+declare const personColor: (userId: string) => string;
 declare const isValidLogLevel: (value: unknown) => value is LogLevel;
 declare const isValidSubscriptionLevel: (value: unknown) => value is SubscriptionLevel;
 declare const isValidDeviceLinkStatus: (value: unknown) => value is DeviceLinkStatus;
@@ -636,4 +657,4 @@ declare const apiErrorCodeOf: (body: unknown) => ApiErrorCode | null;
 /** A push notification's data as PushData, or null for data no Lumber push sends. */
 declare const parsePushData: (data: unknown) => PushData | null;
 
-export { type ApiErrorBody, type ApiErrorCode, type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppKeyUpsertBody, type AppPermission, type AppPersonRecord, type AppRecord, type AppTeamAccess, type Appearance, type AppsQuery, type ClaimantKeyCheck, type ClientToServerEvents, DEFAULT_PUSH_THRESHOLD, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type HolderKeyCheck, type InvitationRecord, type KeyCheckResult, type KeyHolder, type KeyPin, 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, PUSH_OFF, type PendingAppKey, type PushData, type PushThreshold, type PushToken, type PushType, type ResponseMetadata, type ServerToClientEvents, type SocketAppPayload, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type SubscriptionPlan, type SubscriptionPlanRecord, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, apiErrorCodeOf, apiErrorCodes, isApiErrorCode, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelNameToLevel, logLevelToName, logLevels, normalizePushThreshold, parsePushData, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits, subscriptionPlans };
+export { APP_COLORS, type ApiErrorBody, type ApiErrorCode, type ApiKeyRecord, type ApiResponse, type AppCreatedRecord, type AppEncryptedKey, type AppKeyUpsertBody, type AppPermission, type AppPersonRecord, type AppRecord, type AppTeamAccess, type Appearance, type AppsQuery, type ClaimantKeyCheck, type ClientToServerEvents, DEFAULT_ACCENT, DEFAULT_PUSH_THRESHOLD, type DeviceLinkCreatedRecord, type DeviceLinkRecord, type DeviceLinkStatus, type FlagRecord, type FlagsQuery, type GuestRecord, type HolderKeyCheck, type InvitationRecord, type KeyCheckResult, type KeyHolder, type KeyPin, 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, PUSH_OFF, type PendingAppKey, type PushData, type PushThreshold, type PushToken, type PushType, type ResponseMetadata, type ServerToClientEvents, type SocketAppPayload, SubscriptionLevel, type SubscriptionLevelName, type SubscriptionLimits, type SubscriptionPlan, type SubscriptionPlanRecord, type TeamMemberRecord, type TeamRecord, type TeamsQuery, type TimeseriesBucket, type TimeseriesResponse, type UserRecord, apiErrorCodeOf, apiErrorCodes, isApiErrorCode, isValidAppearance, isValidColor, isValidDeviceLinkStatus, isValidImageUrl, isValidLogLevel, isValidSubscriptionLevel, isValidTeamMemberRole, joinApiKey, logLevelColors, logLevelNameToLevel, logLevelToName, logLevels, nameColor, normalizePushThreshold, parsePushData, personColor, resolveAppColor, splitApiKey, subscriptionLevelToName, subscriptionLevels, subscriptionLimits, subscriptionPlans };

package/dist/index.js

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  APP_COLORS: () => APP_COLORS,
+  DEFAULT_ACCENT: () => DEFAULT_ACCENT,
   DEFAULT_PUSH_THRESHOLD: () => DEFAULT_PUSH_THRESHOLD,
   LogLevel: () => LogLevel,
   PUSH_OFF: () => PUSH_OFF,
@@ -35,11 +37,15 @@ __export(index_exports, {
   isValidSubscriptionLevel: () => isValidSubscriptionLevel,
   isValidTeamMemberRole: () => isValidTeamMemberRole,
   joinApiKey: () => joinApiKey,
+  logLevelColors: () => logLevelColors,
   logLevelNameToLevel: () => logLevelNameToLevel,
   logLevelToName: () => logLevelToName,
   logLevels: () => logLevels,
+  nameColor: () => nameColor,
   normalizePushThreshold: () => normalizePushThreshold,
   parsePushData: () => parsePushData,
+  personColor: () => personColor,
+  resolveAppColor: () => resolveAppColor,
   splitApiKey: () => splitApiKey,
   subscriptionLevelToName: () => subscriptionLevelToName,
   subscriptionLevels: () => subscriptionLevels,
@@ -48,24 +54,6 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/constants/errors.ts
-var apiErrorCodes = [
-  /** 403: the team's plan has no room for another app. */
-  "APP_LIMIT",
-  /** 403: the team's plan has no room for another member (members and live invitations). */
-  "SEAT_LIMIT",
-  /** 403: the app's team's plan has no room for another guest on it (guests and live invitations). */
-  "GUEST_LIMIT",
-  /** 409: the person invited is already on the team. */
-  "ALREADY_MEMBER",
-  /** 409: the person invited can already read the app. */
-  "ALREADY_READS",
-  /** 409: the address invited already has an open invitation. */
-  "ALREADY_INVITED",
-  /** 409: the address invited already has an account, so invite the person instead. */
-  "HAS_ACCOUNT"
-];
-
 // src/constants/logLevel.ts
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
   LogLevel2[LogLevel2["Debug"] = 0] = "Debug";
@@ -91,6 +79,35 @@ var logLevelNameToLevel = {
 };
 var logLevels = [0 /* Debug */, 1 /* Info */, 2 /* Warn */, 3 /* Error */, 4 /* Fatal */];
 
+// src/constants/colors.ts
+var logLevelColors = {
+  [0 /* Debug */]: "#737373",
+  [1 /* Info */]: "#60A5FA",
+  [2 /* Warn */]: "#FBBF24",
+  [3 /* Error */]: "#F87171",
+  [4 /* Fatal */]: "#E879F9"
+};
+var DEFAULT_ACCENT = "#FBBF24";
+var APP_COLORS = ["#EF4444", "#F97316", "#F59E0B", "#84CC16", "#22C55E", "#14B8A6", "#06B6D4", "#3B82F6", "#6366F1", "#8B5CF6", "#D946EF", "#EC4899"];
+
+// src/constants/errors.ts
+var apiErrorCodes = [
+  /** 403: the team's plan has no room for another app. */
+  "APP_LIMIT",
+  /** 403: the team's plan has no room for another member (members and live invitations). */
+  "SEAT_LIMIT",
+  /** 403: the app's team's plan has no room for another guest on it (guests and live invitations). */
+  "GUEST_LIMIT",
+  /** 409: the person invited is already on the team. */
+  "ALREADY_MEMBER",
+  /** 409: the person invited can already read the app. */
+  "ALREADY_READS",
+  /** 409: the address invited already has an open invitation. */
+  "ALREADY_INVITED",
+  /** 409: the address invited already has an account, so invite the person instead. */
+  "HAS_ACCOUNT"
+];
+
 // src/constants/notifications.ts
 var PUSH_OFF = 5;
 var DEFAULT_PUSH_THRESHOLD = 2 /* Warn */;
@@ -127,6 +144,17 @@ var subscriptionPlans = {
 var appearanceValues = ["system", "dark", "light"];
 var isValidAppearance = (value) => appearanceValues.includes(value);
 var isValidColor = (value) => /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.test(value);
+var hashName = (name) => {
+  let hash = 2166136261;
+  for (const char of name.trim().toLowerCase()) {
+    hash ^= char.codePointAt(0) ?? 0;
+    hash = Math.imul(hash, 16777619);
+  }
+  return hash >>> 0;
+};
+var nameColor = (name) => APP_COLORS[hashName(name) % APP_COLORS.length];
+var resolveAppColor = (name, color) => color && isValidColor(color) ? color : nameColor(name);
+var personColor = (userId) => nameColor(userId);
 var isValidLogLevel = (value) => logLevels.includes(value);
 var isValidSubscriptionLevel = (value) => subscriptionLevels.includes(value);
 var deviceLinkStatuses = ["pending", "approved", "denied"];
@@ -184,6 +212,8 @@ var parsePushData = (data) => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  APP_COLORS,
+  DEFAULT_ACCENT,
   DEFAULT_PUSH_THRESHOLD,
   LogLevel,
   PUSH_OFF,
@@ -199,11 +229,15 @@ var parsePushData = (data) => {
   isValidSubscriptionLevel,
   isValidTeamMemberRole,
   joinApiKey,
+  logLevelColors,
   logLevelNameToLevel,
   logLevelToName,
   logLevels,
+  nameColor,
   normalizePushThreshold,
   parsePushData,
+  personColor,
+  resolveAppColor,
   splitApiKey,
   subscriptionLevelToName,
   subscriptionLevels,

package/dist/index.mjs

@@ -1,21 +1,3 @@
-// src/constants/errors.ts
-var apiErrorCodes = [
-  /** 403: the team's plan has no room for another app. */
-  "APP_LIMIT",
-  /** 403: the team's plan has no room for another member (members and live invitations). */
-  "SEAT_LIMIT",
-  /** 403: the app's team's plan has no room for another guest on it (guests and live invitations). */
-  "GUEST_LIMIT",
-  /** 409: the person invited is already on the team. */
-  "ALREADY_MEMBER",
-  /** 409: the person invited can already read the app. */
-  "ALREADY_READS",
-  /** 409: the address invited already has an open invitation. */
-  "ALREADY_INVITED",
-  /** 409: the address invited already has an account, so invite the person instead. */
-  "HAS_ACCOUNT"
-];
-
 // src/constants/logLevel.ts
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
   LogLevel2[LogLevel2["Debug"] = 0] = "Debug";
@@ -41,6 +23,35 @@ var logLevelNameToLevel = {
 };
 var logLevels = [0 /* Debug */, 1 /* Info */, 2 /* Warn */, 3 /* Error */, 4 /* Fatal */];
 
+// src/constants/colors.ts
+var logLevelColors = {
+  [0 /* Debug */]: "#737373",
+  [1 /* Info */]: "#60A5FA",
+  [2 /* Warn */]: "#FBBF24",
+  [3 /* Error */]: "#F87171",
+  [4 /* Fatal */]: "#E879F9"
+};
+var DEFAULT_ACCENT = "#FBBF24";
+var APP_COLORS = ["#EF4444", "#F97316", "#F59E0B", "#84CC16", "#22C55E", "#14B8A6", "#06B6D4", "#3B82F6", "#6366F1", "#8B5CF6", "#D946EF", "#EC4899"];
+
+// src/constants/errors.ts
+var apiErrorCodes = [
+  /** 403: the team's plan has no room for another app. */
+  "APP_LIMIT",
+  /** 403: the team's plan has no room for another member (members and live invitations). */
+  "SEAT_LIMIT",
+  /** 403: the app's team's plan has no room for another guest on it (guests and live invitations). */
+  "GUEST_LIMIT",
+  /** 409: the person invited is already on the team. */
+  "ALREADY_MEMBER",
+  /** 409: the person invited can already read the app. */
+  "ALREADY_READS",
+  /** 409: the address invited already has an open invitation. */
+  "ALREADY_INVITED",
+  /** 409: the address invited already has an account, so invite the person instead. */
+  "HAS_ACCOUNT"
+];
+
 // src/constants/notifications.ts
 var PUSH_OFF = 5;
 var DEFAULT_PUSH_THRESHOLD = 2 /* Warn */;
@@ -77,6 +88,17 @@ var subscriptionPlans = {
 var appearanceValues = ["system", "dark", "light"];
 var isValidAppearance = (value) => appearanceValues.includes(value);
 var isValidColor = (value) => /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.test(value);
+var hashName = (name) => {
+  let hash = 2166136261;
+  for (const char of name.trim().toLowerCase()) {
+    hash ^= char.codePointAt(0) ?? 0;
+    hash = Math.imul(hash, 16777619);
+  }
+  return hash >>> 0;
+};
+var nameColor = (name) => APP_COLORS[hashName(name) % APP_COLORS.length];
+var resolveAppColor = (name, color) => color && isValidColor(color) ? color : nameColor(name);
+var personColor = (userId) => nameColor(userId);
 var isValidLogLevel = (value) => logLevels.includes(value);
 var isValidSubscriptionLevel = (value) => subscriptionLevels.includes(value);
 var deviceLinkStatuses = ["pending", "approved", "denied"];
@@ -133,6 +155,8 @@ var parsePushData = (data) => {
   }
 };
 export {
+  APP_COLORS,
+  DEFAULT_ACCENT,
   DEFAULT_PUSH_THRESHOLD,
   LogLevel,
   PUSH_OFF,
@@ -148,11 +172,15 @@ export {
   isValidSubscriptionLevel,
   isValidTeamMemberRole,
   joinApiKey,
+  logLevelColors,
   logLevelNameToLevel,
   logLevelToName,
   logLevels,
+  nameColor,
   normalizePushThreshold,
   parsePushData,
+  personColor,
+  resolveAppColor,
   splitApiKey,
   subscriptionLevelToName,
   subscriptionLevels,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infinitetoken/lumber-kit",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Shared TypeScript types and wire format contracts for the Lumber cloud logging suite",
   "keywords": [
     "lumber",