@nanostores/logger 0.2.1 → 0.2.3

package/build-creator-logger/index.d.ts

@@ -0,0 +1,57 @@
+import type { AnyStore, MapStore } from 'nanostores'
+
+interface CreatorLoggerOptionsMessages {
+  /**
+   * Disable build logs.
+   */
+  build?: boolean
+}
+
+export interface CreatorLoggerOptions {
+  messages?: CreatorLoggerOptionsMessages
+
+  /**
+   * Custom name getter for stores built with creators.
+   *
+   * @param creatorName Name of the creator.
+   * @param store Store built by the creator.
+   * @returns Custom store name.
+   */
+  nameGetter?: (creatorName: string, store: MapStore) => string
+}
+
+interface EventBuildStartPayload {
+  creatorName: string
+  store: MapStore
+  storeName: string
+}
+
+interface BuildCreatorLoggerEvents {
+  build: (payload: EventBuildPayloadBase) => void
+}
+
+/**
+ * Builds logger of map creators for Nano Stores.
+ *
+ * ```js
+ * import { buildCreatorLogger } from '@nanostores/logger'
+ * import { $profile } from './stores/index.js'
+ *
+ * let destroy = buildLogger($profile, 'Profile', {
+ *   build: ({ creatorName, store, storeName }) => {
+ *     console.log(`${storeName} was built by ${creatorName}`, store)
+ *   }
+ * })
+ * ```
+ *
+ * @param store Creator for logging.
+ * @param storeName Store name.
+ * @param events Events to log.
+ * @param opts Logger options.
+ */
+export function buildCreatorLogger(
+  store: AnyStore,
+  storeName: string,
+  events: BuildCreatorLoggerEvents,
+  opts?: CreatorLoggerOptions
+): () => void

package/build-creator-logger/index.js

@@ -0,0 +1,38 @@
+function onBuild(creator, listener) {
+  let originBuild = creator.build
+  creator.build = (...args) => {
+    let store = originBuild(...args)
+    listener(store)
+    return store
+  }
+  return () => {
+    creator.build = originBuild
+  }
+}
+
+const defaultNameGetter = (creatorName, store) => {
+  return `${creatorName}:${store.value.id}`
+}
+
+export function buildCreatorLogger(creator, creatorName, events, opts = {}) {
+  opts = {
+    nameGetter: defaultNameGetter,
+    ...opts
+  }
+
+  let messages = opts.messages || {}
+  let unbind = []
+
+  if (messages.build !== false) {
+    unbind.push(
+      onBuild(creator, store => {
+        let storeName = opts.nameGetter(creatorName, store)
+        events.build({ creatorName, store, storeName })
+      })
+    )
+  }
+
+  return () => {
+    for (let i of unbind) i()
+  }
+}

package/creator-logger/index.d.ts

@@ -1,18 +1,8 @@
-import type { MapCreator, MapStore } from 'nanostores'
+import type { MapCreator } from 'nanostores'
 
+import type { CreatorLoggerOptions } from '../build-creator-logger/index.js'
 import type { LoggerOptions } from '../build-logger/index.js'
 
-interface CreatorLoggerOptions extends LoggerOptions {
-  /**
-   * Custom name getter for stores built with creators.
-   *
-   * @param creatorName Name of the creator.
-   * @param store Store built by the creator.
-   * @returns Custom store name.
-   */
-  nameGetter: (creatorName: string, store: MapStore) => string
-}
-
 /**
  * Displays Nano Stores events in browser console.
  *
@@ -21,5 +11,5 @@ interface CreatorLoggerOptions extends LoggerOptions {
  */
 export function creatorLogger(
   creators: { [key: string]: MapCreator },
-  opts?: CreatorLoggerOptions
+  opts?: CreatorLoggerOptions & LoggerOptions
 ): () => void

package/creator-logger/index.js

@@ -1,38 +1,32 @@
+import { buildCreatorLogger } from '../build-creator-logger/index.js'
 import { logger } from '../logger/index.js'
 import { log } from '../printer/index.js'
 
-function onBuild(creator, listener) {
-  let originBuild = creator.build
-  creator.build = (...args) => {
-    let store = originBuild(...args)
-    listener(store)
-    return store
-  }
-  return () => {
-    creator.build = originBuild
-  }
-}
-
 function createCreatorLogger(creator, creatorName, opts) {
   let unbind = []
 
   unbind.push(
-    onBuild(creator, store => {
-      let storeName = opts.nameGetter(creatorName, store)
-
-      log({
-        logo: true,
-        message: [
-          ['bold', storeName],
-          ['regular', 'store was built by'],
-          ['bold', creatorName],
-          ['regular', 'creator']
-        ],
-        type: 'build'
-      })
-
-      unbind.push(logger({ [storeName]: store }, opts))
-    })
+    buildCreatorLogger(
+      creator,
+      creatorName,
+      {
+        build: ({ store, storeName }) => {
+          log({
+            logo: true,
+            message: [
+              ['bold', storeName],
+              ['regular', 'store was built by'],
+              ['bold', creatorName],
+              ['regular', 'creator']
+            ],
+            type: 'build'
+          })
+
+          unbind.push(logger({ [storeName]: store }, opts))
+        }
+      },
+      opts
+    )
   )
 
   return () => {
@@ -40,15 +34,7 @@ function createCreatorLogger(creator, creatorName, opts) {
   }
 }
 
-const defaultNameGetter = (creatorName, store) => {
-  return `${creatorName}:${store.value.id}`
-}
-
 export function creatorLogger(creators, opts = {}) {
-  opts = {
-    nameGetter: defaultNameGetter,
-    ...opts
-  }
   let unbind = Object.entries(creators).map(([creatorName, creator]) =>
     createCreatorLogger(creator, creatorName, opts)
   )

package/index.d.ts

@@ -1,4 +1,8 @@
-export { buildLogger } from './build-logger/index.js'
+export {
+  buildCreatorLogger,
+  CreatorLoggerOptions
+} from './build-creator-logger/index.js'
+export { buildLogger, LoggerOptions } from './build-logger/index.js'
 export { creatorLogger } from './creator-logger/index.js'
 export { logger } from './logger/index.js'
 export { group, groupEnd, log } from './printer/index.js'

package/index.js

@@ -1,3 +1,4 @@
+export { buildCreatorLogger } from './build-creator-logger/index.js'
 export { buildLogger } from './build-logger/index.js'
 export { creatorLogger } from './creator-logger/index.js'
 export { logger } from './logger/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nanostores/logger",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Pretty logger of lifecycles, changes and actions for Nano Stores",
   "keywords": [
     "nanostores",