@lensjs/core 1.0.1 → 1.0.2

package/src/core/lens.ts

@@ -1,147 +0,0 @@
-import type Store from "../abstracts/store";
-import type Adapter from "../abstracts/adapter";
-import Watcher from "./watcher";
-import { ApiController } from "./api_controller";
-import * as path from "node:path";
-import type {
-  LensConfig,
-  RouteDefinitionHandler,
-  WatcherTypeEnum,
-} from "../types/index.ts";
-import { getUiConfig } from "../context/context";
-import Container from "../context/container";
-import { BetterSqliteStore } from "../stores/index";
-import { getMeta } from "../utils/index";
-
-export default class Lens {
-  private static watchers: Map<WatcherTypeEnum, Watcher> = new Map();
-  private static store: Store;
-  private static adapter: Adapter;
-
-  static watch(watcher: Watcher): typeof Lens {
-    this.watchers.set(watcher.name, watcher);
-    return this;
-  }
-
-  static setWatchers(watchers: Watcher[]): typeof Lens {
-    this.watchers = new Map(watchers.map((watcher) => [watcher.name, watcher]));
-    return this;
-  }
-
-  static async start(
-    config: LensConfig = {
-      basePath: "lens",
-      appName: "Lens",
-      enabled: true,
-    },
-  ) {
-    if (!config.enabled) {
-      return;
-    }
-    await this.bindContainerDeps(config);
-
-    let adapter = this.getAdapter();
-
-    adapter.setWatchers(Array.from(this.watchers.values())).setup();
-
-    const { apiRoutes } = this.getRoutes({
-      basePath: config.basePath,
-    });
-
-    adapter.registerRoutes(apiRoutes);
-
-    const { __dirname } = getMeta(import.meta.url);
-    const uiPath = path.resolve(this.normalizeDirName(__dirname), "ui");
-    adapter.serveUI(uiPath, config.basePath, getUiConfig());
-  }
-
-  static setStore(store: Store): typeof Lens {
-    this.store = store;
-    return this;
-  }
-
-  static async getStore(): Promise<Store> {
-    return this.store ?? (await this.getDefaultStore());
-  }
-
-  static setAdapter(adapter: Adapter): typeof Lens {
-    this.adapter = adapter;
-    return this;
-  }
-
-  static getAdapter(): Adapter {
-    if (!this.adapter) {
-      throw new Error("No adapter has been set");
-    }
-
-    return this.adapter;
-  }
-
-  private static async bindContainerDeps(config: LensConfig) {
-    const dbStore = await this.getStore();
-    Container.singleton("store", () => dbStore);
-    Container.singleton("uiConfig", () => {
-      return {
-        appName: config.appName,
-        path: `/${config.basePath}`,
-        api: {
-          requests: `/${config.basePath}/api/requests`,
-          queries: `/${config.basePath}/api/queries`,
-          truncate: `/${config.basePath}/api/truncate`,
-        },
-      };
-    });
-  }
-
-  private static getRoutes({ basePath }: { basePath: string }) {
-    const apiRoutes = [
-      {
-        method: "GET" as const,
-        path: `/lens-config`,
-        handler: () => ApiController.fetchUiConfig(),
-      },
-      {
-        method: "GET" as const,
-        path: `${basePath}/api/requests`,
-        handler: async (data: RouteDefinitionHandler) =>
-          await ApiController.getRequests(data),
-      },
-      {
-        method: "GET" as const,
-        path: `${basePath}/api/requests/:id`,
-        handler: async (data: RouteDefinitionHandler) =>
-          await ApiController.getRequest(data),
-      },
-      {
-        method: "GET" as const,
-        path: `${basePath}/api/queries`,
-        handler: async (data: RouteDefinitionHandler) =>
-          await ApiController.getQueries(data),
-      },
-      {
-        method: "GET" as const,
-        path: `${basePath}/api/queries/:id`,
-        handler: async (data: RouteDefinitionHandler) =>
-          await ApiController.getQuery(data),
-      },
-      {
-        method: "DELETE" as const,
-        path: `${basePath}/api/truncate`,
-        handler: async () => await ApiController.truncate(),
-      },
-    ];
-
-    return { apiRoutes };
-  }
-
-  private static async getDefaultStore(): Promise<Store> {
-    const store = new BetterSqliteStore();
-    await store.initialize();
-
-    return store;
-  }
-
-  private static normalizeDirName(path: string) {
-    return path.replace(/(\/packages\/)[^/]+(?=\/dist)/, "$1core");
-  }
-}

package/src/core/watcher.ts

@@ -1,6 +0,0 @@
-import type { WatcherTypeEnum } from "../types";
-
-export default abstract class Watcher {
-  abstract name: WatcherTypeEnum;
-  abstract log(data: any): Promise<void>;
-}

package/src/index.ts

@@ -1,11 +0,0 @@
-export { default as Lens } from "./core/lens";
-
-export * from "./stores";
-export * from "./watchers";
-export * from "./types/index";
-export { default as LensAdapter } from "./abstracts/adapter";
-export { default as LensStore } from "./abstracts/store";
-export { default as LensWatcher } from "./core/watcher";
-export { getStore as getLensStore } from "./context/context";
-export * as lensUtils from "./utils/index";
-export { lensEmitter, lensResource, createEmittery} from "./utils/event_emitter";

package/src/stores/better_sqlite.ts

@@ -1,176 +0,0 @@
-import Store from "../abstracts/store";
-import { randomUUID } from "crypto";
-import {
-  WatcherTypeEnum,
-  type PaginationParams,
-  type LensEntry,
-} from "../types/index";
-import Database from "libsql";
-import { sqlDateTime } from "../utils";
-
-const TABLE_NAME = "lens_entries";
-
-export default class BetterSqliteStore extends Store {
-  protected connection!: Database.Database;
-
-  public async initialize() {
-    this.connection = new Database("lens.db");
-
-    this.setupSchema();
-    console.log("Connected to Lens (SQLite) database.");
-  }
-
-  public async truncate() {
-    this.connection.prepare(`DELETE FROM ${TABLE_NAME};`).run();
-  }
-
-  public async save(entry: {
-    id?: string;
-    data: Record<string, any>;
-    minimal_data?: Record<string, any>;
-    type: WatcherTypeEnum;
-    timestamp?: string;
-    requestId?: string;
-  }) {
-    this.connection
-      .prepare(
-        `INSERT INTO ${TABLE_NAME} (id, data, type, created_at, lens_entry_id, minimal_data) values($id, $data, $type, $created_at, $lens_entry_id, $minimalData)`
-      )
-      .run({
-        id: entry.id ?? randomUUID(),
-        data: JSON.stringify(entry.data),
-        type: entry.type,
-        created_at: entry.timestamp ?? sqlDateTime(),
-        lens_entry_id: entry.requestId || null,
-        minimalData: JSON.stringify(entry.minimal_data ?? {}),
-      });
-  }
-
-  override async getAllQueries<T extends LensEntry[]>(
-    pagination: PaginationParams
-  ) {
-    return await this.paginate<T>(WatcherTypeEnum.QUERY, pagination);
-  }
-
-  override async getAllRequests<T extends Omit<LensEntry, "data">[]>(
-    pagination: PaginationParams
-  ) {
-    return await this.paginate<T>(WatcherTypeEnum.REQUEST, pagination, false);
-  }
-
-  public async allByRequestId(requestId: string, type: WatcherTypeEnum) {
-    const rows = this.connection
-      .prepare(
-        `${this.getSelectedColumns()} FROM ${TABLE_NAME} WHERE type = $type AND lens_entry_id = $requestId ORDER BY created_at DESC`
-      )
-      .all({ type, requestId });
-
-    return this.mapRows(rows);
-  }
-
-  public async paginate<T>(
-    type: WatcherTypeEnum,
-    { page, perPage }: PaginationParams,
-    includeFullData: boolean = true
-  ): Promise<{
-    meta: {
-      total: number;
-      lastPage: number;
-      currentPage: number;
-    };
-    data: T;
-  }> {
-    const offset = (page - 1) * perPage;
-    const query = `${this.getSelectedColumns(
-      includeFullData
-    )} FROM ${TABLE_NAME} WHERE type = ? ORDER BY created_at DESC LIMIT ? OFFSET ?`;
-    const count = await this.count(type);
-    const rows = this.connection.prepare(query).all(type, perPage, offset);
-    const mappedRows = this.mapRows(rows, includeFullData);
-
-    return {
-      meta: {
-        total: count,
-        lastPage: Math.ceil(count / perPage),
-        currentPage: page,
-      },
-      data: mappedRows as T,
-    };
-  }
-
-  override async count(type: WatcherTypeEnum): Promise<number> {
-    const result = this.connection
-      .prepare(`SELECT count(*) as count FROM ${TABLE_NAME} WHERE type = ?`)
-      .get(type) as { count: number };
-
-    return Number(result.count);
-  }
-
-  public async find(type: WatcherTypeEnum, id: string) {
-    const row = this.connection
-      .prepare(
-        `${this.getSelectedColumns()} FROM ${TABLE_NAME} WHERE id = ? AND type = ? LIMIT 1`
-      )
-      .get(id, type);
-
-    if (!row) {
-      return null;
-    }
-
-    return this.mapRow(row, true);
-  }
-
-  private setupSchema() {
-    const createTable = `
-      CREATE TABLE IF NOT EXISTS ${TABLE_NAME} (
-        id TEXT PRIMARY KEY,
-        minimal_data TEXT,
-        data TEXT NOT NULL,
-        type TEXT NOT NULL,
-        created_at TEXT NOT NULL,
-        updated_at TEXT,
-        lens_entry_id TEXT NULL
-      );
-    `;
-
-    const createIndex = `
-      CREATE INDEX IF NOT EXISTS lens_entries_id_type_index
-      ON ${TABLE_NAME} (id, type);
-    `;
-
-    this.connection.exec(createTable);
-    this.connection.exec(createIndex);
-  }
-
-  protected mapRow(row: any, includeFullData = true): LensEntry {
-    let data = includeFullData ? JSON.parse(row.data) : {};
-
-    if (!includeFullData) {
-      data = JSON.parse(row.minimal_data);
-    }
-
-    return {
-      id: row.id,
-      type: row.type,
-      created_at: row.created_at,
-      lens_entry_id: row.lens_entry_id,
-      data: data,
-    };
-  }
-
-  protected mapRows(rows: any[], includeFullData = true) {
-    let mappedRows: LensEntry[] = [];
-
-    for (const row of rows) {
-      mappedRows.push(this.mapRow(row, includeFullData));
-    }
-
-    return mappedRows;
-  }
-
-  protected getSelectedColumns(includeFullData: boolean = true) {
-    return `SELECT id, minimal_data, type, created_at, lens_entry_id ${
-      includeFullData ? ",data" : ""
-    }`;
-  }
-}

package/src/stores/index.ts

@@ -1 +0,0 @@
-export { default as BetterSqliteStore } from "./better_sqlite";

package/src/types/index.ts

@@ -1,103 +0,0 @@
-import { SqlLanguage } from "sql-formatter";
-
-export type QueryType = Required<SqlLanguage | "mongodb">;
-export type SqlQueryType = Exclude<QueryType, "mongodb">;
-export type QueryEntry = {
-  data: {
-    query: string;
-    duration: string;
-    createdAt: string;
-    type: QueryType;
-  };
-  requestId?: string;
-};
-
-export type UserEntry = {
-  id: number | string;
-  name: string;
-  email: string;
-};
-
-export type RequestEntry = {
-  request: {
-    id: string;
-    method: HttpMethod;
-    duration: string;
-    path: string;
-    headers: Record<string, any>;
-    body: Record<string, any>;
-    status: number;
-    ip: string;
-    createdAt: string;
-  };
-  response: {
-    json: Record<string, any>;
-    headers: Record<string, string>;
-  };
-  user?: UserEntry | null;
-};
-
-export type Entry =
-  | { type: "query"; data: QueryEntry }
-  | { type: "request"; data: RequestEntry };
-
-export enum WatcherTypeEnum {
-  REQUEST = "request",
-  QUERY = "query",
-}
-
-export type LensConfig = {
-  basePath: string;
-  appName: string;
-  enabled: boolean;
-};
-
-export type LensEntry = {
-  id: string;
-  minimal_data?: Record<string, any>;
-  data: Record<string, any>;
-  type: WatcherTypeEnum;
-  created_at: string;
-  lens_entry_id: string | null;
-};
-
-export type RouteDefinitionHandler = {
-  params: Record<string, any>;
-  qs?: Record<string, any>;
-};
-export type RouteDefinition = {
-  method: "GET" | "POST" | "DELETE";
-  path: string;
-  handler: (data: RouteDefinitionHandler) => any;
-};
-
-export type PaginationParams = {
-  page: number;
-  perPage: number;
-};
-
-export type Paginator<T> = {
-  meta: {
-    total: number;
-    lastPage: number;
-    currentPage: number;
-  };
-  data: T;
-};
-
-export type ApiResponse<T> = {
-  status: number;
-  message: string;
-  data: T | null;
-  meta?: Paginator<T>["meta"];
-};
-
-export type HttpMethod =
-  | "GET"
-  | "POST"
-  | "PUT"
-  | "DELETE"
-  | "PATCH"
-  | "HEAD"
-  | "OPTIONS";
-export type RouteHttpMethod = "get" | "post" | "put" | "delete" | "patch";

package/src/ui/README.md

@@ -1,69 +0,0 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
-
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```