@murumets-ee/settings 0.1.5 → 0.1.6

package/dist/schema.d.mts

@@ -0,0 +1,318 @@
+import * as _$drizzle_orm_pg_core0 from "drizzle-orm/pg-core";
+
+//#region src/schema.d.ts
+/**
+ * Drizzle schema for settings tables.
+ *
+ * Two tables:
+ * - toolkit_settings: typed key-value settings grouped by namespace and scope
+ * - toolkit_view_state: schemaless user-scoped JSON blobs with optional TTL
+ *
+ * Usage in drizzle.config.ts:
+ * ```typescript
+ * import type { Config } from 'drizzle-kit'
+ * export default {
+ *   schema: ['./generated/schema.ts', '@murumets-ee/settings/schema'],
+ *   // ...
+ * } satisfies Config
+ * ```
+ */
+/**
+ * Typed settings table.
+ *
+ * Stores key-value pairs grouped by namespace and scoped
+ * to global, team, or user contexts.
+ *
+ * scopeId uses '__global__' sentinel for global scope to avoid
+ * PostgreSQL's NULL != NULL behavior in unique constraints.
+ */
+declare const toolkitSettings: _$drizzle_orm_pg_core0.PgTableWithColumns<{
+  name: "toolkit_settings";
+  schema: undefined;
+  columns: {
+    id: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "id";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgUUID";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: true;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    namespace: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "namespace";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 100;
+    }>;
+    scope: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "scope";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 20;
+    }>;
+    scopeId: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "scope_id";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 100;
+    }>;
+    key: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "key";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 255;
+    }>;
+    locale: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "locale";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 10;
+    }>;
+    value: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "value";
+      tableName: "toolkit_settings";
+      dataType: "json";
+      columnType: "PgJsonb";
+      data: unknown;
+      driverParam: unknown;
+      notNull: false;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    updatedAt: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "updated_at";
+      tableName: "toolkit_settings";
+      dataType: "date";
+      columnType: "PgTimestamp";
+      data: Date;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    updatedBy: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "updated_by";
+      tableName: "toolkit_settings";
+      dataType: "string";
+      columnType: "PgUUID";
+      data: string;
+      driverParam: string;
+      notNull: false;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+  };
+  dialect: "pg";
+}>;
+/**
+ * View state table.
+ *
+ * Stores schemaless user-scoped JSON blobs for persisting
+ * UI state (table filters, column order, etc.) with optional TTL.
+ */
+declare const toolkitViewState: _$drizzle_orm_pg_core0.PgTableWithColumns<{
+  name: "toolkit_view_state";
+  schema: undefined;
+  columns: {
+    id: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "id";
+      tableName: "toolkit_view_state";
+      dataType: "string";
+      columnType: "PgUUID";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: true;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    userId: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "user_id";
+      tableName: "toolkit_view_state";
+      dataType: "string";
+      columnType: "PgUUID";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    viewKey: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "view_key";
+      tableName: "toolkit_view_state";
+      dataType: "string";
+      columnType: "PgVarchar";
+      data: string;
+      driverParam: string;
+      notNull: true;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: [string, ...string[]];
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {
+      length: 255;
+    }>;
+    state: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "state";
+      tableName: "toolkit_view_state";
+      dataType: "json";
+      columnType: "PgJsonb";
+      data: unknown;
+      driverParam: unknown;
+      notNull: true;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    expiresAt: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "expires_at";
+      tableName: "toolkit_view_state";
+      dataType: "date";
+      columnType: "PgTimestamp";
+      data: Date;
+      driverParam: string;
+      notNull: false;
+      hasDefault: false;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+    updatedAt: _$drizzle_orm_pg_core0.PgColumn<{
+      name: "updated_at";
+      tableName: "toolkit_view_state";
+      dataType: "date";
+      columnType: "PgTimestamp";
+      data: Date;
+      driverParam: string;
+      notNull: true;
+      hasDefault: true;
+      isPrimaryKey: false;
+      isAutoincrement: false;
+      hasRuntimeDefault: false;
+      enumValues: undefined;
+      baseColumn: never;
+      identity: undefined;
+      generated: undefined;
+    }, {}, {}>;
+  };
+  dialect: "pg";
+}>;
+//#endregion
+export { toolkitSettings, toolkitViewState };
+//# sourceMappingURL=schema.d.mts.map

package/dist/schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.mts","names":[],"sources":["../src/schema.ts"],"mappings":";;;;;;AA4BA;;;;;;;;;;;;;;;;;;;;;;cAAa,eAAA,yBAAe,kBAAA;;;;QAsB3B,sBAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAQY,gBAAA,yBAAgB,kBAAA;;;;QAa5B,sBAAA,CAAA,QAAA"}

package/dist/schema.mjs

@@ -0,0 +1,2 @@
+import{jsonb as e,pgTable as t,timestamp as n,unique as r,uuid as i,varchar as a}from"drizzle-orm/pg-core";const o=t(`toolkit_settings`,{id:i(`id`).primaryKey().defaultRandom(),namespace:a(`namespace`,{length:100}).notNull(),scope:a(`scope`,{length:20}).notNull().default(`global`),scopeId:a(`scope_id`,{length:100}).notNull().default(`__global__`),key:a(`key`,{length:255}).notNull(),locale:a(`locale`,{length:10}).notNull().default(`_default`),value:e(`value`),updatedAt:n(`updated_at`,{withTimezone:!0}).notNull().defaultNow(),updatedBy:i(`updated_by`)},e=>({uniqueSetting:r().on(e.namespace,e.scope,e.scopeId,e.key,e.locale)})),s=t(`toolkit_view_state`,{id:i(`id`).primaryKey().defaultRandom(),userId:i(`user_id`).notNull(),viewKey:a(`view_key`,{length:255}).notNull(),state:e(`state`).notNull(),expiresAt:n(`expires_at`,{withTimezone:!0}),updatedAt:n(`updated_at`,{withTimezone:!0}).notNull().defaultNow()},e=>({uniqueUserView:r().on(e.userId,e.viewKey)}));export{o as toolkitSettings,s as toolkitViewState};
+//# sourceMappingURL=schema.mjs.map

package/dist/schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.mjs","names":[],"sources":["../src/schema.ts"],"sourcesContent":["/**\n * Drizzle schema for settings tables.\n *\n * Two tables:\n * - toolkit_settings: typed key-value settings grouped by namespace and scope\n * - toolkit_view_state: schemaless user-scoped JSON blobs with optional TTL\n *\n * Usage in drizzle.config.ts:\n * ```typescript\n * import type { Config } from 'drizzle-kit'\n * export default {\n *   schema: ['./generated/schema.ts', '@murumets-ee/settings/schema'],\n *   // ...\n * } satisfies Config\n * ```\n */\n\nimport { jsonb, pgTable, timestamp, unique, uuid, varchar } from 'drizzle-orm/pg-core'\n\n/**\n * Typed settings table.\n *\n * Stores key-value pairs grouped by namespace and scoped\n * to global, team, or user contexts.\n *\n * scopeId uses '__global__' sentinel for global scope to avoid\n * PostgreSQL's NULL != NULL behavior in unique constraints.\n */\nexport const toolkitSettings = pgTable(\n  'toolkit_settings',\n  {\n    id: uuid('id').primaryKey().defaultRandom(),\n    namespace: varchar('namespace', { length: 100 }).notNull(),\n    scope: varchar('scope', { length: 20 }).notNull().default('global'),\n    scopeId: varchar('scope_id', { length: 100 }).notNull().default('__global__'),\n    key: varchar('key', { length: 255 }).notNull(),\n    locale: varchar('locale', { length: 10 }).notNull().default('_default'),\n    value: jsonb('value'),\n    updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().defaultNow(),\n    updatedBy: uuid('updated_by'),\n  },\n  (table) => ({\n    uniqueSetting: unique().on(\n      table.namespace,\n      table.scope,\n      table.scopeId,\n      table.key,\n      table.locale,\n    ),\n  }),\n)\n\n/**\n * View state table.\n *\n * Stores schemaless user-scoped JSON blobs for persisting\n * UI state (table filters, column order, etc.) with optional TTL.\n */\nexport const toolkitViewState = pgTable(\n  'toolkit_view_state',\n  {\n    id: uuid('id').primaryKey().defaultRandom(),\n    userId: uuid('user_id').notNull(),\n    viewKey: varchar('view_key', { length: 255 }).notNull(),\n    state: jsonb('state').notNull(),\n    expiresAt: timestamp('expires_at', { withTimezone: true }),\n    updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().defaultNow(),\n  },\n  (table) => ({\n    uniqueUserView: unique().on(table.userId, table.viewKey),\n  }),\n)\n"],"mappings":"2GA4BA,MAAa,EAAkB,EAC7B,mBACA,CACE,GAAI,EAAK,KAAK,CAAC,YAAY,CAAC,eAAe,CAC3C,UAAW,EAAQ,YAAa,CAAE,OAAQ,IAAK,CAAC,CAAC,SAAS,CAC1D,MAAO,EAAQ,QAAS,CAAE,OAAQ,GAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,SAAS,CACnE,QAAS,EAAQ,WAAY,CAAE,OAAQ,IAAK,CAAC,CAAC,SAAS,CAAC,QAAQ,aAAa,CAC7E,IAAK,EAAQ,MAAO,CAAE,OAAQ,IAAK,CAAC,CAAC,SAAS,CAC9C,OAAQ,EAAQ,SAAU,CAAE,OAAQ,GAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,WAAW,CACvE,MAAO,EAAM,QAAQ,CACrB,UAAW,EAAU,aAAc,CAAE,aAAc,GAAM,CAAC,CAAC,SAAS,CAAC,YAAY,CACjF,UAAW,EAAK,aAAa,CAC9B,CACA,IAAW,CACV,cAAe,GAAQ,CAAC,GACtB,EAAM,UACN,EAAM,MACN,EAAM,QACN,EAAM,IACN,EAAM,OACP,CACF,EACF,CAQY,EAAmB,EAC9B,qBACA,CACE,GAAI,EAAK,KAAK,CAAC,YAAY,CAAC,eAAe,CAC3C,OAAQ,EAAK,UAAU,CAAC,SAAS,CACjC,QAAS,EAAQ,WAAY,CAAE,OAAQ,IAAK,CAAC,CAAC,SAAS,CACvD,MAAO,EAAM,QAAQ,CAAC,SAAS,CAC/B,UAAW,EAAU,aAAc,CAAE,aAAc,GAAM,CAAC,CAC1D,UAAW,EAAU,aAAc,CAAE,aAAc,GAAM,CAAC,CAAC,SAAS,CAAC,YAAY,CAClF,CACA,IAAW,CACV,eAAgB,GAAQ,CAAC,GAAG,EAAM,OAAQ,EAAM,QAAQ,CACzD,EACF"}

package/dist/view-state.d.mts

@@ -0,0 +1,48 @@
+import { Logger } from "@murumets-ee/core";
+import { PostgresJsDatabase } from "drizzle-orm/postgres-js";
+
+//#region src/view-state.d.ts
+interface ViewStateClientConfig {
+  /** Database client (read-write) */
+  db: PostgresJsDatabase;
+  /** User ID for scoping */
+  userId: string;
+  /** Logger instance */
+  logger?: Logger;
+  /** Default TTL in seconds for view state entries. Defaults to 30 days. */
+  defaultTtl?: number;
+}
+declare class ViewStateClient {
+  private db;
+  private userId;
+  private logger?;
+  private defaultTtl;
+  constructor(config: ViewStateClientConfig);
+  /**
+   * Save view state (upsert).
+   */
+  save<T extends Record<string, unknown>>(viewKey: string, state: T, options?: {
+    ttl?: number;
+  }): Promise<void>;
+  /**
+   * Load view state. Returns null if not found or expired.
+   */
+  load<T extends Record<string, unknown> = Record<string, unknown>>(viewKey: string): Promise<T | null>;
+  /**
+   * Clear a specific view state entry.
+   */
+  clear(viewKey: string): Promise<void>;
+  /**
+   * Clear all expired view state entries (maintenance task).
+   * Call periodically (e.g., from a cron job or queue task).
+   * Returns the number of entries removed.
+   */
+  clearExpired(): Promise<number>;
+}
+/**
+ * Factory function following toolkit conventions.
+ */
+declare function createViewStateClient(config: ViewStateClientConfig): ViewStateClient;
+//#endregion
+export { ViewStateClient, ViewStateClientConfig, createViewStateClient };
+//# sourceMappingURL=view-state.d.mts.map

package/dist/view-state.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-state.d.mts","names":[],"sources":["../src/view-state.ts"],"mappings":";;;;UA2BiB,qBAAA;EAkEgC;EAhE/C,EAAA,EAAI,kBAAA;EAkED;EAhEH,MAAA;EAsGsB;EApGtB,MAAA,GAAS,MAAA;EAoGoB;EAlG7B,UAAA;AAAA;AAAA,cAMW,eAAA;EAAA,QACH,EAAA;EAAA,QACA,MAAA;EAAA,QACA,MAAA;EAAA,QACA,UAAA;cAEI,MAAA,EAAQ,qBAAA;EAcT;;;EAAL,IAAA,WAAe,MAAA,kBAAA,CACnB,OAAA,UACA,KAAA,EAAO,CAAA,EACP,OAAA;IAAY,GAAA;EAAA,IACX,OAAA;EADD;;;EA6BI,IAAA,WAAe,MAAA,oBAA0B,MAAA,kBAAA,CAC7C,OAAA,WACC,OAAA,CAAQ,CAAA;EAFU;;;EA2Bf,KAAA,CAAM,OAAA,WAAkB,OAAA;EAzBnB;;;;;EAsCL,YAAA,CAAA,GAAgB,OAAA;AAAA;;AAiBxB;;iBAAgB,qBAAA,CAAsB,MAAA,EAAQ,qBAAA,GAAwB,eAAA"}

package/dist/view-state.mjs

@@ -0,0 +1,2 @@
+import{toolkitViewState as e}from"./schema.mjs";import{and as t,eq as n,lt as r}from"drizzle-orm";var i=class{db;userId;logger;defaultTtl;constructor(e){if(typeof window<`u`)throw Error(`ViewStateClient cannot be used in browser code.`);this.db=e.db,this.userId=e.userId,this.logger=e.logger,this.defaultTtl=e.defaultTtl??2592e3}async save(t,n,r){this.logger?.debug({userId:this.userId,viewKey:t},`Saving view state`);let i=r?.ttl??this.defaultTtl,a=new Date(Date.now()+i*1e3);await this.db.insert(e).values({userId:this.userId,viewKey:t,state:n,expiresAt:a,updatedAt:new Date}).onConflictDoUpdate({target:[e.userId,e.viewKey],set:{state:n,expiresAt:a,updatedAt:new Date}})}async load(r){this.logger?.debug({userId:this.userId,viewKey:r},`Loading view state`);let i=await this.db.select({state:e.state,expiresAt:e.expiresAt}).from(e).where(t(n(e.userId,this.userId),n(e.viewKey,r))).limit(1);if(i.length===0)return null;let a=i[0];return a.expiresAt&&a.expiresAt<new Date?(await this.clear(r),null):a.state}async clear(r){this.logger?.debug({userId:this.userId,viewKey:r},`Clearing view state`),await this.db.delete(e).where(t(n(e.userId,this.userId),n(e.viewKey,r)))}async clearExpired(){this.logger?.info(`Clearing expired view state entries`);let t=(await this.db.delete(e).where(r(e.expiresAt,new Date)).returning({id:e.id})).length;return this.logger?.info({count:t},`Expired view state entries cleared`),t}};function a(e){return new i(e)}export{i as ViewStateClient,a as createViewStateClient};
+//# sourceMappingURL=view-state.mjs.map

package/dist/view-state.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-state.mjs","names":[],"sources":["../src/view-state.ts"],"sourcesContent":["/**\n * ViewStateClient — schemaless user-scoped state persistence.\n *\n * Used by admin UI for table filters, column order, panel state, etc.\n * Optional TTL for auto-cleanup of stale state.\n *\n * @example\n * ```typescript\n * import { createViewStateClient } from '@murumets-ee/settings/view-state'\n *\n * const viewState = createViewStateClient({ db, userId: currentUser.id })\n *\n * await viewState.save('articles-table', {\n *   filters: { status: 'published' },\n *   columnOrder: ['title', 'status', 'date'],\n *   sortBy: 'date',\n * })\n *\n * const state = await viewState.load('articles-table')\n * ```\n */\n\nimport type { Logger } from '@murumets-ee/core'\nimport { and, eq, lt } from 'drizzle-orm'\nimport type { PostgresJsDatabase } from 'drizzle-orm/postgres-js'\nimport { toolkitViewState } from './schema.js'\n\nexport interface ViewStateClientConfig {\n  /** Database client (read-write) */\n  db: PostgresJsDatabase\n  /** User ID for scoping */\n  userId: string\n  /** Logger instance */\n  logger?: Logger\n  /** Default TTL in seconds for view state entries. Defaults to 30 days. */\n  defaultTtl?: number\n}\n\n/** 30 days in seconds */\nconst DEFAULT_TTL = 30 * 24 * 60 * 60\n\nexport class ViewStateClient {\n  private db: PostgresJsDatabase\n  private userId: string\n  private logger?: Logger\n  private defaultTtl: number\n\n  constructor(config: ViewStateClientConfig) {\n    if (typeof window !== 'undefined') {\n      throw new Error('ViewStateClient cannot be used in browser code.')\n    }\n\n    this.db = config.db\n    this.userId = config.userId\n    this.logger = config.logger\n    this.defaultTtl = config.defaultTtl ?? DEFAULT_TTL\n  }\n\n  /**\n   * Save view state (upsert).\n   */\n  async save<T extends Record<string, unknown>>(\n    viewKey: string,\n    state: T,\n    options?: { ttl?: number },\n  ): Promise<void> {\n    this.logger?.debug({ userId: this.userId, viewKey }, 'Saving view state')\n\n    const ttlSeconds = options?.ttl ?? this.defaultTtl\n    const expiresAt = new Date(Date.now() + ttlSeconds * 1000)\n\n    await this.db\n      .insert(toolkitViewState)\n      .values({\n        userId: this.userId,\n        viewKey,\n        state,\n        expiresAt,\n        updatedAt: new Date(),\n      })\n      .onConflictDoUpdate({\n        target: [toolkitViewState.userId, toolkitViewState.viewKey],\n        set: {\n          state,\n          expiresAt,\n          updatedAt: new Date(),\n        },\n      })\n  }\n\n  /**\n   * Load view state. Returns null if not found or expired.\n   */\n  async load<T extends Record<string, unknown> = Record<string, unknown>>(\n    viewKey: string,\n  ): Promise<T | null> {\n    this.logger?.debug({ userId: this.userId, viewKey }, 'Loading view state')\n\n    const rows = await this.db\n      .select({ state: toolkitViewState.state, expiresAt: toolkitViewState.expiresAt })\n      .from(toolkitViewState)\n      .where(and(eq(toolkitViewState.userId, this.userId), eq(toolkitViewState.viewKey, viewKey)))\n      .limit(1)\n\n    if (rows.length === 0) return null\n\n    const row = rows[0]\n\n    // Check if expired\n    if (row.expiresAt && row.expiresAt < new Date()) {\n      await this.clear(viewKey)\n      return null\n    }\n\n    return row.state as T\n  }\n\n  /**\n   * Clear a specific view state entry.\n   */\n  async clear(viewKey: string): Promise<void> {\n    this.logger?.debug({ userId: this.userId, viewKey }, 'Clearing view state')\n\n    await this.db\n      .delete(toolkitViewState)\n      .where(and(eq(toolkitViewState.userId, this.userId), eq(toolkitViewState.viewKey, viewKey)))\n  }\n\n  /**\n   * Clear all expired view state entries (maintenance task).\n   * Call periodically (e.g., from a cron job or queue task).\n   * Returns the number of entries removed.\n   */\n  async clearExpired(): Promise<number> {\n    this.logger?.info('Clearing expired view state entries')\n\n    const result = await this.db\n      .delete(toolkitViewState)\n      .where(lt(toolkitViewState.expiresAt, new Date()))\n      .returning({ id: toolkitViewState.id })\n\n    const count = result.length\n    this.logger?.info({ count }, 'Expired view state entries cleared')\n    return count\n  }\n}\n\n/**\n * Factory function following toolkit conventions.\n */\nexport function createViewStateClient(config: ViewStateClientConfig): ViewStateClient {\n  return new ViewStateClient(config)\n}\n"],"mappings":"kGAyCA,IAAa,EAAb,KAA6B,CAC3B,GACA,OACA,OACA,WAEA,YAAY,EAA+B,CACzC,GAAI,OAAO,OAAW,IACpB,MAAU,MAAM,kDAAkD,CAGpE,KAAK,GAAK,EAAO,GACjB,KAAK,OAAS,EAAO,OACrB,KAAK,OAAS,EAAO,OACrB,KAAK,WAAa,EAAO,YAAc,OAMzC,MAAM,KACJ,EACA,EACA,EACe,CACf,KAAK,QAAQ,MAAM,CAAE,OAAQ,KAAK,OAAQ,UAAS,CAAE,oBAAoB,CAEzE,IAAM,EAAa,GAAS,KAAO,KAAK,WAClC,EAAY,IAAI,KAAK,KAAK,KAAK,CAAG,EAAa,IAAK,CAE1D,MAAM,KAAK,GACR,OAAO,EAAiB,CACxB,OAAO,CACN,OAAQ,KAAK,OACb,UACA,QACA,YACA,UAAW,IAAI,KAChB,CAAC,CACD,mBAAmB,CAClB,OAAQ,CAAC,EAAiB,OAAQ,EAAiB,QAAQ,CAC3D,IAAK,CACH,QACA,YACA,UAAW,IAAI,KAChB,CACF,CAAC,CAMN,MAAM,KACJ,EACmB,CACnB,KAAK,QAAQ,MAAM,CAAE,OAAQ,KAAK,OAAQ,UAAS,CAAE,qBAAqB,CAE1E,IAAM,EAAO,MAAM,KAAK,GACrB,OAAO,CAAE,MAAO,EAAiB,MAAO,UAAW,EAAiB,UAAW,CAAC,CAChF,KAAK,EAAiB,CACtB,MAAM,EAAI,EAAG,EAAiB,OAAQ,KAAK,OAAO,CAAE,EAAG,EAAiB,QAAS,EAAQ,CAAC,CAAC,CAC3F,MAAM,EAAE,CAEX,GAAI,EAAK,SAAW,EAAG,OAAO,KAE9B,IAAM,EAAM,EAAK,GAQjB,OALI,EAAI,WAAa,EAAI,UAAY,IAAI,MACvC,MAAM,KAAK,MAAM,EAAQ,CAClB,MAGF,EAAI,MAMb,MAAM,MAAM,EAAgC,CAC1C,KAAK,QAAQ,MAAM,CAAE,OAAQ,KAAK,OAAQ,UAAS,CAAE,sBAAsB,CAE3E,MAAM,KAAK,GACR,OAAO,EAAiB,CACxB,MAAM,EAAI,EAAG,EAAiB,OAAQ,KAAK,OAAO,CAAE,EAAG,EAAiB,QAAS,EAAQ,CAAC,CAAC,CAQhG,MAAM,cAAgC,CACpC,KAAK,QAAQ,KAAK,sCAAsC,CAOxD,IAAM,GALS,MAAM,KAAK,GACvB,OAAO,EAAiB,CACxB,MAAM,EAAG,EAAiB,UAAW,IAAI,KAAO,CAAC,CACjD,UAAU,CAAE,GAAI,EAAiB,GAAI,CAAC,EAEpB,OAErB,OADA,KAAK,QAAQ,KAAK,CAAE,QAAO,CAAE,qCAAqC,CAC3D,IAOX,SAAgB,EAAsB,EAAgD,CACpF,OAAO,IAAI,EAAgB,EAAO"}

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "@murumets-ee/settings",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     },
     "./schema": {
-      "types": "./dist/schema.d.ts",
-      "import": "./dist/schema.js"
+      "types": "./dist/schema.d.mts",
+      "import": "./dist/schema.mjs"
     },
     "./view-state": {
-      "types": "./dist/view-state.d.ts",
-      "import": "./dist/view-state.js"
+      "types": "./dist/view-state.d.mts",
+      "import": "./dist/view-state.mjs"
     },
     "./plugin": {
-      "types": "./dist/plugin.d.ts",
-      "import": "./dist/plugin.js"
+      "types": "./dist/plugin.d.mts",
+      "import": "./dist/plugin.mjs"
     },
     "./admin": {
-      "types": "./dist/admin.d.ts",
-      "import": "./dist/admin.js"
+      "types": "./dist/admin.d.mts",
+      "import": "./dist/admin.mjs"
     }
   },
   "files": [
@@ -32,19 +32,19 @@
     "drizzle-orm": "^0.45.1",
     "zod": "^3.24.1",
     "server-only": "^0.0.1",
-    "@murumets-ee/core": "0.1.5",
-    "@murumets-ee/db": "0.1.4",
-    "@murumets-ee/logging": "0.1.5"
+    "@murumets-ee/core": "0.1.6",
+    "@murumets-ee/db": "0.1.5",
+    "@murumets-ee/logging": "0.1.6"
   },
   "devDependencies": {
     "@types/node": "^22.10.5",
-    "tsup": "^8.3.5",
+    "tsdown": "^0.21.7",
     "typescript": "^5.7.3",
     "vitest": "^2.1.8"
   },
   "scripts": {
-    "build": "rm -rf dist && tsup",
-    "dev": "tsup --watch",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
     "test": "vitest",
     "test:integration": "vitest run --config vitest.integration.config.ts"
   }

package/dist/admin.d.ts

@@ -1,100 +0,0 @@
-import { AdminRoute } from '@murumets-ee/core';
-import { ZodType } from 'zod';
-
-/**
- * Setting configuration types and compile-time type inference.
- *
- * Design mirrors the entity field system:
- * - Config interfaces define what each setting type accepts
- * - SettingToTS maps a single config to its TypeScript type
- * - InferSettingValue adds null awareness based on `default` presence
- * - InferSettingsMap maps an entire schema to a typed record
- */
-
-interface BaseSettingConfig {
-    /** Human-readable label for admin UI */
-    label?: string;
-    /** Description / help text */
-    description?: string;
-    /** If true, this setting can have per-locale values (mirrors entity translatable pattern) */
-    translatable?: boolean;
-}
-interface TextSettingConfig extends BaseSettingConfig {
-    type: 'text';
-    default?: string;
-    maxLength?: number;
-    minLength?: number;
-    pattern?: RegExp;
-}
-interface NumberSettingConfig extends BaseSettingConfig {
-    type: 'number';
-    default?: number;
-    min?: number;
-    max?: number;
-    integer?: boolean;
-}
-interface BooleanSettingConfig extends BaseSettingConfig {
-    type: 'boolean';
-    default?: boolean;
-}
-interface SelectSettingConfig<O extends readonly string[] = readonly string[]> extends BaseSettingConfig {
-    type: 'select';
-    options: O;
-    default?: O[number];
-}
-interface JsonSettingConfig<T = unknown> extends BaseSettingConfig {
-    type: 'json';
-    default?: T;
-    /** Optional Zod schema for validation. If provided, values are validated on set. */
-    schema?: ZodType<T>;
-}
-interface MediaSettingConfig extends BaseSettingConfig {
-    type: 'media';
-    accept?: string[];
-}
-type SettingConfig = TextSettingConfig | NumberSettingConfig | BooleanSettingConfig | SelectSettingConfig | JsonSettingConfig | MediaSettingConfig;
-type SettingScope = 'global' | 'team' | 'user';
-interface SettingsDefinition<S extends Record<string, SettingConfig> = Record<string, SettingConfig>> {
-    /** Unique namespace for this settings group */
-    namespace: string;
-    /** Default scope for these settings */
-    scope: SettingScope;
-    /** Setting schema (the shape) */
-    schema: S;
-    /** Human-readable label for admin UI */
-    label?: string;
-}
-
-/**
- * Settings admin routes for the centralized admin API handler.
- *
- * Provides get/update operations for typed settings.
- * All auth, CSRF, and role checks are handled by the parent handler.
- * Settings mutations require admin role (not editor).
- *
- * @example
- * ```typescript
- * import { createAdminApiHandler } from '@murumets-ee/admin-ui/server'
- * import { settingsRoutes } from '@murumets-ee/settings/admin'
- * import { siteSettings } from '@/settings/site'
- *
- * const handler = createAdminApiHandler({
- *   authenticate: async (req) => { ... },
- *   entities: [Article],
- *   routes: [settingsRoutes(siteSettings)],
- * })
- * ```
- */
-
-/**
- * Create admin API routes for settings management.
- *
- * Routes:
- * - `GET   /api/admin/settings`  — Get all settings (query: `?locale=`)
- * - `PATCH /api/admin/settings`  — Update settings (JSON body: `{ values, locale? }`)
- *
- * @param definition - The settings definition (created by defineSettings)
- */
-declare function settingsRoutes<S extends Record<string, SettingConfig>>(definition: SettingsDefinition<S>): AdminRoute;
-
-export { settingsRoutes };

package/dist/admin.js

@@ -1 +0,0 @@
-function u(t,e=200){return new Response(JSON.stringify(t),{status:e,headers:{"Content-Type":"application/json"}})}function p(t,e){return u({error:t},e)}function d(t){let e=null;function c(){return e||(e=(async()=>{let{getApp:s}=await import("@murumets-ee/core"),{createSettingsClient:i}=await import("./client-factory-OGWK5MKO.js"),o=s();return i(t,{app:o})})()),e}async function g(s,i){let o=await c(),r=new URL(s.url).searchParams.get("locale")??void 0,n=await o.getAll(r?{locale:r}:void 0);return u(n)}async function m(s,{user:i,audit:o}){let l=await c(),r=await s.json(),{values:n,locale:a}=r;return!n||typeof n!="object"?p('Body must contain "values" object',400):(await l.setMany(n,a?{locale:a}:void 0),o?.({action:"settings.update",entityType:"settings",userId:i.id,userName:i.name,changes:{fields:n},metadata:{namespace:t.namespace,...a?{locale:a}:{}}}),u({success:!0}))}return{prefix:"settings",resource:"settings",actions:["view","update"],handlers:{GET:g,PATCH:m}}}export{d as settingsRoutes};

package/dist/chunk-E3K4GXDC.js

@@ -1 +0,0 @@
-import{jsonb as u,pgTable as a,timestamp as o,unique as i,uuid as l,varchar as t}from"drizzle-orm/pg-core";var d=a("toolkit_settings",{id:l("id").primaryKey().defaultRandom(),namespace:t("namespace",{length:100}).notNull(),scope:t("scope",{length:20}).notNull().default("global"),scopeId:t("scope_id",{length:100}).notNull().default("__global__"),key:t("key",{length:255}).notNull(),locale:t("locale",{length:10}).notNull().default("_default"),value:u("value"),updatedAt:o("updated_at",{withTimezone:!0}).notNull().defaultNow(),updatedBy:l("updated_by")},e=>({uniqueSetting:i().on(e.namespace,e.scope,e.scopeId,e.key,e.locale)})),s=a("toolkit_view_state",{id:l("id").primaryKey().defaultRandom(),userId:l("user_id").notNull(),viewKey:t("view_key",{length:255}).notNull(),state:u("state").notNull(),expiresAt:o("expires_at",{withTimezone:!0}),updatedAt:o("updated_at",{withTimezone:!0}).notNull().defaultNow()},e=>({uniqueUserView:i().on(e.userId,e.viewKey)}));export{d as a,s as b};

package/dist/client-factory-OGWK5MKO.js

@@ -1 +0,0 @@
-import{getApp as L}from"@murumets-ee/core";import{and as S,eq as c,or as k}from"drizzle-orm";import{jsonb as y,pgTable as x,timestamp as w,unique as b,uuid as m,varchar as u}from"drizzle-orm/pg-core";var t=x("toolkit_settings",{id:m("id").primaryKey().defaultRandom(),namespace:u("namespace",{length:100}).notNull(),scope:u("scope",{length:20}).notNull().default("global"),scopeId:u("scope_id",{length:100}).notNull().default("__global__"),key:u("key",{length:255}).notNull(),locale:u("locale",{length:10}).notNull().default("_default"),value:y("value"),updatedAt:w("updated_at",{withTimezone:!0}).notNull().defaultNow(),updatedBy:m("updated_by")},i=>({uniqueSetting:b().on(i.namespace,i.scope,i.scopeId,i.key,i.locale)})),O=x("toolkit_view_state",{id:m("id").primaryKey().defaultRandom(),userId:m("user_id").notNull(),viewKey:u("view_key",{length:255}).notNull(),state:y("state").notNull(),expiresAt:w("expires_at",{withTimezone:!0}),updatedAt:w("updated_at",{withTimezone:!0}).notNull().defaultNow()},i=>({uniqueUserView:b().on(i.userId,i.viewKey)}));var C="__global__",p="_default";import{z as f}from"zod";function I(i){switch(i.type){case"text":{let e=f.string();return i.maxLength&&(e=e.max(i.maxLength)),i.minLength&&(e=e.min(i.minLength)),i.pattern&&(e=e.regex(i.pattern)),e}case"number":{let e=f.number();return i.integer&&(e=e.int()),i.min!==void 0&&(e=e.min(i.min)),i.max!==void 0&&(e=e.max(i.max)),e}case"boolean":return f.boolean();case"select":return f.enum(i.options);case"json":return i.schema??f.unknown();case"media":return f.string().uuid();default:return f.unknown()}}function v(i){let e={};for(let[n,o]of Object.entries(i.schema)){let a=I(o);"default"in o&&o.default!==void 0||(a=a.nullable()),e[n]=a}return e}var h=class{definition;db;logger;scope;scopeId;validators;constructor(e,n){if(typeof window<"u")throw new Error("SettingsClient cannot be used in browser code.");if(this.definition=e,this.db=n.db,this.logger=n.logger,this.scope=n.scope??e.scope,this.scopeId=n.scopeId??C,(this.scope==="team"||this.scope==="user")&&!n.scopeId)throw new Error(`scopeId is required for ${this.scope}-scoped settings (namespace: ${e.namespace})`);this.validators=v(e)}async get(e,n){let o=this.definition.schema[e],a=o?.translatable&&n?.locale?n.locale:null;if(this.logger?.debug({namespace:this.definition.namespace,key:e,locale:a},"Getting setting"),a){let s=await this.db.select({locale:t.locale,value:t.value}).from(t).where(S(...this.baseWhere(),c(t.key,e),k(c(t.locale,a),c(t.locale,p)))),r=s.find(d=>d.locale===a),g=s.find(d=>d.locale===p),l=r??g;if(l&&l.value!==void 0&&l.value!==null)return l.value}else{let s=await this.db.select({value:t.value}).from(t).where(this.whereClause(e)).limit(1);if(s.length>0&&s[0].value!==void 0&&s[0].value!==null)return s[0].value}return o&&"default"in o&&o.default!==void 0?o.default:null}async getAll(e){let n=e?.locale??null;this.logger?.debug({namespace:this.definition.namespace,locale:n},"Getting all settings");let o;n?o=await this.db.select({key:t.key,locale:t.locale,value:t.value}).from(t).where(S(...this.baseWhere(),k(c(t.locale,p),c(t.locale,n)))):o=await this.db.select({key:t.key,locale:t.locale,value:t.value}).from(t).where(S(...this.baseWhere(),c(t.locale,p)));let a=new Map;for(let r of o){let g=a.get(r.key)??{};r.locale===p?g.default=r.value:g.locale=r.value,a.set(r.key,g)}let s={};for(let[r,g]of Object.entries(this.definition.schema)){let l=a.get(r),d;g.translatable&&n&&l?.locale!==void 0&&l?.locale!==null?d=l.locale:l?.default!==void 0&&l?.default!==null&&(d=l.default),d!==void 0?s[r]=d:"default"in g&&g.default!==void 0?s[r]=g.default:s[r]=null}return s}async set(e,n,o){let a=this.resolveLocale(e,o);if(this.logger?.info({namespace:this.definition.namespace,key:e,locale:a},"Setting value"),!(e in this.definition.schema))throw new Error(`Unknown setting key '${e}' in namespace '${this.definition.namespace}'`);let s=this.validators[e];s&&s.parse(n),await this.upsert(e,n,a)}async setMany(e,n){this.logger?.info({namespace:this.definition.namespace,keys:Object.keys(e),locale:n?.locale},"Setting multiple values");for(let[o,a]of Object.entries(e)){if(!(o in this.definition.schema))throw new Error(`Unknown setting key '${o}' in namespace '${this.definition.namespace}'`);let s=this.validators[o];s&&a!==void 0&&s.parse(a)}await this.db.transaction(async o=>{for(let[a,s]of Object.entries(e)){if(s===void 0)continue;let r=this.resolveLocale(a,n);await o.insert(t).values({namespace:this.definition.namespace,scope:this.scope,scopeId:this.scopeId,key:a,locale:r,value:s,updatedAt:new Date}).onConflictDoUpdate({target:[t.namespace,t.scope,t.scopeId,t.key,t.locale],set:{value:s,updatedAt:new Date}})}})}async delete(e,n){let o=this.resolveLocale(e,n);this.logger?.info({namespace:this.definition.namespace,key:e,locale:o},"Deleting setting"),await this.db.delete(t).where(this.whereClause(e,o))}async has(e,n){let o=this.resolveLocale(e,n);return(await this.db.select({key:t.key}).from(t).where(this.whereClause(e,o)).limit(1)).length>0}resolveLocale(e,n){return this.definition.schema[e]?.translatable&&n?.locale?n.locale:p}baseWhere(){return[c(t.namespace,this.definition.namespace),c(t.scope,this.scope),c(t.scopeId,this.scopeId)]}whereClause(e,n=p){return S(...this.baseWhere(),c(t.key,e),c(t.locale,n))}async upsert(e,n,o){await this.db.insert(t).values({namespace:this.definition.namespace,scope:this.scope,scopeId:this.scopeId,key:e,locale:o,value:n,updatedAt:new Date}).onConflictDoUpdate({target:[t.namespace,t.scope,t.scopeId,t.key,t.locale],set:{value:n,updatedAt:new Date}})}};function E(i,e){let n=e?.app??L();return new h(i,{db:n.db.readWrite,logger:n.logger.child({settings:i.namespace}),scope:e?.scope,scopeId:e?.scopeId})}export{E as createSettingsClient};