@mokup/shared 1.0.1 → 1.0.2

package/dist/index.d.cts

@@ -1,15 +1,91 @@
+/**
+ * Directory input for mock scanning.
+ *
+ * @example
+ * import type { DirInput } from '@mokup/shared'
+ *
+ * const dir: DirInput = ['mock', 'fixtures']
+ */
 type DirInput = string | string[] | ((root: string) => string | string[]) | undefined;
+/**
+ * Shared entry options for mokup scanners and plugins.
+ *
+ * @example
+ * import type { MockEntryOptions } from '@mokup/shared'
+ *
+ * const entry: MockEntryOptions = {
+ *   dir: 'mock',
+ *   prefix: '/api',
+ *   watch: true,
+ * }
+ */
 interface MockEntryOptions {
+    /**
+     * Directory (or directories) to scan for mock routes.
+     *
+     * @default "mock" (resolved by Vite/webpack plugins)
+     */
     dir?: DirInput;
+    /**
+     * Request path prefix to mount mock routes under.
+     *
+     * @default ""
+     */
     prefix?: string;
+    /**
+     * Include filter for files to scan.
+     *
+     * @default undefined
+     */
     include?: RegExp | RegExp[];
+    /**
+     * Exclude filter for files to scan.
+     *
+     * @default undefined
+     */
     exclude?: RegExp | RegExp[];
+    /**
+     * Ignore file or folder prefixes when scanning.
+     *
+     * @default ["."]
+     */
     ignorePrefix?: string | string[];
+    /**
+     * Enable file watching for live route updates.
+     *
+     * @default true
+     */
     watch?: boolean;
+    /**
+     * Enable mokup logging.
+     *
+     * @default true
+     */
     log?: boolean;
 }
+/**
+ * Playground configuration input.
+ *
+ * @example
+ * import type { PlaygroundOptionsInput } from '@mokup/shared'
+ *
+ * const playground: PlaygroundOptionsInput = {
+ *   path: '/__mokup',
+ *   enabled: true,
+ * }
+ */
 type PlaygroundOptionsInput = boolean | {
+    /**
+     * Base path for the playground UI.
+     *
+     * @default "/__mokup"
+     */
     path?: string;
+    /**
+     * Enable or disable the playground routes.
+     *
+     * @default true
+     */
     enabled?: boolean;
 } | undefined;
 

package/dist/index.d.mts

@@ -1,15 +1,91 @@
+/**
+ * Directory input for mock scanning.
+ *
+ * @example
+ * import type { DirInput } from '@mokup/shared'
+ *
+ * const dir: DirInput = ['mock', 'fixtures']
+ */
 type DirInput = string | string[] | ((root: string) => string | string[]) | undefined;
+/**
+ * Shared entry options for mokup scanners and plugins.
+ *
+ * @example
+ * import type { MockEntryOptions } from '@mokup/shared'
+ *
+ * const entry: MockEntryOptions = {
+ *   dir: 'mock',
+ *   prefix: '/api',
+ *   watch: true,
+ * }
+ */
 interface MockEntryOptions {
+    /**
+     * Directory (or directories) to scan for mock routes.
+     *
+     * @default "mock" (resolved by Vite/webpack plugins)
+     */
     dir?: DirInput;
+    /**
+     * Request path prefix to mount mock routes under.
+     *
+     * @default ""
+     */
     prefix?: string;
+    /**
+     * Include filter for files to scan.
+     *
+     * @default undefined
+     */
     include?: RegExp | RegExp[];
+    /**
+     * Exclude filter for files to scan.
+     *
+     * @default undefined
+     */
     exclude?: RegExp | RegExp[];
+    /**
+     * Ignore file or folder prefixes when scanning.
+     *
+     * @default ["."]
+     */
     ignorePrefix?: string | string[];
+    /**
+     * Enable file watching for live route updates.
+     *
+     * @default true
+     */
     watch?: boolean;
+    /**
+     * Enable mokup logging.
+     *
+     * @default true
+     */
     log?: boolean;
 }
+/**
+ * Playground configuration input.
+ *
+ * @example
+ * import type { PlaygroundOptionsInput } from '@mokup/shared'
+ *
+ * const playground: PlaygroundOptionsInput = {
+ *   path: '/__mokup',
+ *   enabled: true,
+ * }
+ */
 type PlaygroundOptionsInput = boolean | {
+    /**
+     * Base path for the playground UI.
+     *
+     * @default "/__mokup"
+     */
     path?: string;
+    /**
+     * Enable or disable the playground routes.
+     *
+     * @default true
+     */
     enabled?: boolean;
 } | undefined;
 

package/dist/index.d.ts

@@ -1,15 +1,91 @@
+/**
+ * Directory input for mock scanning.
+ *
+ * @example
+ * import type { DirInput } from '@mokup/shared'
+ *
+ * const dir: DirInput = ['mock', 'fixtures']
+ */
 type DirInput = string | string[] | ((root: string) => string | string[]) | undefined;
+/**
+ * Shared entry options for mokup scanners and plugins.
+ *
+ * @example
+ * import type { MockEntryOptions } from '@mokup/shared'
+ *
+ * const entry: MockEntryOptions = {
+ *   dir: 'mock',
+ *   prefix: '/api',
+ *   watch: true,
+ * }
+ */
 interface MockEntryOptions {
+    /**
+     * Directory (or directories) to scan for mock routes.
+     *
+     * @default "mock" (resolved by Vite/webpack plugins)
+     */
     dir?: DirInput;
+    /**
+     * Request path prefix to mount mock routes under.
+     *
+     * @default ""
+     */
     prefix?: string;
+    /**
+     * Include filter for files to scan.
+     *
+     * @default undefined
+     */
     include?: RegExp | RegExp[];
+    /**
+     * Exclude filter for files to scan.
+     *
+     * @default undefined
+     */
     exclude?: RegExp | RegExp[];
+    /**
+     * Ignore file or folder prefixes when scanning.
+     *
+     * @default ["."]
+     */
     ignorePrefix?: string | string[];
+    /**
+     * Enable file watching for live route updates.
+     *
+     * @default true
+     */
     watch?: boolean;
+    /**
+     * Enable mokup logging.
+     *
+     * @default true
+     */
     log?: boolean;
 }
+/**
+ * Playground configuration input.
+ *
+ * @example
+ * import type { PlaygroundOptionsInput } from '@mokup/shared'
+ *
+ * const playground: PlaygroundOptionsInput = {
+ *   path: '/__mokup',
+ *   enabled: true,
+ * }
+ */
 type PlaygroundOptionsInput = boolean | {
+    /**
+     * Base path for the playground UI.
+     *
+     * @default "/__mokup"
+     */
     path?: string;
+    /**
+     * Enable or disable the playground routes.
+     *
+     * @default true
+     */
     enabled?: boolean;
 } | undefined;
 

package/dist/logger.browser.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+const browser = require('consola/browser');
+
+const silentLogger = {
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: () => {
+  },
+  log: () => {
+  }
+};
+function createLogger(options = true) {
+  const resolvedOptions = typeof options === "boolean" ? { enabled: options } : options;
+  const enabled = resolvedOptions?.enabled ?? true;
+  if (!enabled) {
+    return silentLogger;
+  }
+  const tag = resolvedOptions?.tag ?? "mokup";
+  const logger = browser.consola.withTag(tag);
+  return {
+    info: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.info(first, ...rest);
+    },
+    warn: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.warn(first, ...rest);
+    },
+    error: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.error(first, ...rest);
+    },
+    log: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.log(first, ...rest);
+    }
+  };
+}
+
+exports.createLogger = createLogger;

package/dist/logger.browser.d.cts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.cjs';
+
+/**
+ * Create a tagged logger backed by consola for the browser.
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger.browser'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.browser.d.mts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.mjs';
+
+/**
+ * Create a tagged logger backed by consola for the browser.
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger.browser'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.browser.d.ts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.js';
+
+/**
+ * Create a tagged logger backed by consola for the browser.
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger.browser'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.browser.mjs

@@ -0,0 +1,53 @@
+import { consola } from 'consola/browser';
+
+const silentLogger = {
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: () => {
+  },
+  log: () => {
+  }
+};
+function createLogger(options = true) {
+  const resolvedOptions = typeof options === "boolean" ? { enabled: options } : options;
+  const enabled = resolvedOptions?.enabled ?? true;
+  if (!enabled) {
+    return silentLogger;
+  }
+  const tag = resolvedOptions?.tag ?? "mokup";
+  const logger = consola.withTag(tag);
+  return {
+    info: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.info(first, ...rest);
+    },
+    warn: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.warn(first, ...rest);
+    },
+    error: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.error(first, ...rest);
+    },
+    log: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.log(first, ...rest);
+    }
+  };
+}
+
+export { createLogger };

package/dist/logger.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+const consola = require('consola');
+
+const silentLogger = {
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: () => {
+  },
+  log: () => {
+  }
+};
+function createLogger(options = true) {
+  const resolvedOptions = typeof options === "boolean" ? { enabled: options } : options;
+  const enabled = resolvedOptions?.enabled ?? true;
+  if (!enabled) {
+    return silentLogger;
+  }
+  const tag = resolvedOptions?.tag ?? "mokup";
+  const logger = consola.consola.withTag(tag);
+  return {
+    info: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.info(first, ...rest);
+    },
+    warn: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.warn(first, ...rest);
+    },
+    error: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.error(first, ...rest);
+    },
+    log: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.log(first, ...rest);
+    }
+  };
+}
+
+exports.createLogger = createLogger;

package/dist/logger.d.cts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.cjs';
+
+/**
+ * Create a tagged logger backed by consola (Node.js).
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.d.mts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.mjs';
+
+/**
+ * Create a tagged logger backed by consola (Node.js).
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.d.ts

@@ -0,0 +1,21 @@
+import { L as LoggerOptions, a as Logger } from './shared/shared.DazgCdsk.js';
+
+/**
+ * Create a tagged logger backed by consola (Node.js).
+ *
+ * @param options - Logger configuration or a boolean toggle.
+ * @returns A logger implementation that respects the enabled flag.
+ *
+ * @default
+ * @default
+ * @default
+ *
+ * @example
+ * import { createLogger } from '@mokup/shared/logger'
+ *
+ * const logger = createLogger({ tag: 'mokup' })
+ * logger.info('ready')
+ */
+declare function createLogger(options?: LoggerOptions | boolean): Logger;
+
+export { Logger, LoggerOptions, createLogger };

package/dist/logger.mjs

@@ -0,0 +1,53 @@
+import { consola } from 'consola';
+
+const silentLogger = {
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: () => {
+  },
+  log: () => {
+  }
+};
+function createLogger(options = true) {
+  const resolvedOptions = typeof options === "boolean" ? { enabled: options } : options;
+  const enabled = resolvedOptions?.enabled ?? true;
+  if (!enabled) {
+    return silentLogger;
+  }
+  const tag = resolvedOptions?.tag ?? "mokup";
+  const logger = consola.withTag(tag);
+  return {
+    info: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.info(first, ...rest);
+    },
+    warn: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.warn(first, ...rest);
+    },
+    error: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.error(first, ...rest);
+    },
+    log: (...args) => {
+      if (args.length === 0) {
+        return;
+      }
+      const [first, ...rest] = args;
+      logger.log(first, ...rest);
+    }
+  };
+}
+
+export { createLogger };

package/dist/shared/shared.DazgCdsk.d.cts

@@ -0,0 +1,49 @@
+/**
+ * Minimal logger contract used by mokup packages.
+ *
+ * @example
+ * import type { Logger } from '@mokup/shared/logger'
+ *
+ * const logger: Logger = {
+ *   info: console.log,
+ *   warn: console.warn,
+ *   error: console.error,
+ * }
+ */
+interface Logger {
+    /** Log an informational message. */
+    info: (...args: unknown[]) => void;
+    /** Log a warning message. */
+    warn: (...args: unknown[]) => void;
+    /** Log an error message. */
+    error: (...args: unknown[]) => void;
+    /** Log a generic message (optional). */
+    log?: (...args: unknown[]) => void;
+}
+/**
+ * Options for creating a tagged logger.
+ *
+ * @example
+ * import type { LoggerOptions } from '@mokup/shared/logger'
+ *
+ * const options: LoggerOptions = {
+ *   enabled: true,
+ *   tag: 'mokup',
+ * }
+ */
+interface LoggerOptions {
+    /**
+     * Enable or disable logging.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Tag prefix attached to each log line.
+     *
+     * @default "mokup"
+     */
+    tag?: string;
+}
+
+export type { LoggerOptions as L, Logger as a };

package/dist/shared/shared.DazgCdsk.d.mts

@@ -0,0 +1,49 @@
+/**
+ * Minimal logger contract used by mokup packages.
+ *
+ * @example
+ * import type { Logger } from '@mokup/shared/logger'
+ *
+ * const logger: Logger = {
+ *   info: console.log,
+ *   warn: console.warn,
+ *   error: console.error,
+ * }
+ */
+interface Logger {
+    /** Log an informational message. */
+    info: (...args: unknown[]) => void;
+    /** Log a warning message. */
+    warn: (...args: unknown[]) => void;
+    /** Log an error message. */
+    error: (...args: unknown[]) => void;
+    /** Log a generic message (optional). */
+    log?: (...args: unknown[]) => void;
+}
+/**
+ * Options for creating a tagged logger.
+ *
+ * @example
+ * import type { LoggerOptions } from '@mokup/shared/logger'
+ *
+ * const options: LoggerOptions = {
+ *   enabled: true,
+ *   tag: 'mokup',
+ * }
+ */
+interface LoggerOptions {
+    /**
+     * Enable or disable logging.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Tag prefix attached to each log line.
+     *
+     * @default "mokup"
+     */
+    tag?: string;
+}
+
+export type { LoggerOptions as L, Logger as a };

package/dist/shared/shared.DazgCdsk.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Minimal logger contract used by mokup packages.
+ *
+ * @example
+ * import type { Logger } from '@mokup/shared/logger'
+ *
+ * const logger: Logger = {
+ *   info: console.log,
+ *   warn: console.warn,
+ *   error: console.error,
+ * }
+ */
+interface Logger {
+    /** Log an informational message. */
+    info: (...args: unknown[]) => void;
+    /** Log a warning message. */
+    warn: (...args: unknown[]) => void;
+    /** Log an error message. */
+    error: (...args: unknown[]) => void;
+    /** Log a generic message (optional). */
+    log?: (...args: unknown[]) => void;
+}
+/**
+ * Options for creating a tagged logger.
+ *
+ * @example
+ * import type { LoggerOptions } from '@mokup/shared/logger'
+ *
+ * const options: LoggerOptions = {
+ *   enabled: true,
+ *   tag: 'mokup',
+ * }
+ */
+interface LoggerOptions {
+    /**
+     * Enable or disable logging.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Tag prefix attached to each log line.
+     *
+     * @default "mokup"
+     */
+    tag?: string;
+}
+
+export type { LoggerOptions as L, Logger as a };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mokup/shared",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Shared dependency exports for mokup.",
   "license": "MIT",
   "homepage": "https://mokup.icebreaker.top",
@@ -31,6 +31,13 @@
       "import": "./dist/hono.mjs",
       "require": "./dist/hono.cjs"
     },
+    "./logger": {
+      "types": "./dist/logger.d.ts",
+      "browser": "./dist/logger.browser.mjs",
+      "worker": "./dist/logger.browser.mjs",
+      "import": "./dist/logger.mjs",
+      "require": "./dist/logger.cjs"
+    },
     "./pathe": {
       "types": "./dist/pathe.d.ts",
       "import": "./dist/pathe.mjs",
@@ -53,6 +60,7 @@
   ],
   "dependencies": {
     "chokidar": "^5.0.0",
+    "consola": "^3.4.2",
     "esbuild": "^0.27.2",
     "hono": "^4.11.5",
     "jsonc-parser": "^3.3.1",