npm - @genesislcap/foundation-logger - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-logger 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md +6 -47
package/package.json +4 -5
package/docs/api/foundation-logger.createlogger.md +0 -102
package/docs/api/foundation-logger.defaultloggeroptions.md +0 -13
package/docs/api/foundation-logger.logger.deprecated.md +0 -105
package/docs/api/foundation-logger.logger.md +0 -45
package/docs/api/foundation-logger.loggeroptions.md +0 -15
package/docs/api/foundation-logger.md +0 -95
package/docs/api/index.md +0 -30
package/docs/api-report.md.api.md +0 -37

package/README.md CHANGED Viewed

@@ -1,66 +1,25 @@
-# Genesis Foundation Logger
+# @genesislcap/foundation-logger
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
-`foundation-logger` provides a logging utility that currently wraps version 2 of [consola](https://github.com/unjs/consola).
+**Docs: [Utility methods](https://docs.genesis.global/docs/develop/client-capabilities/utility-methods/)**
 ## Installation
-To enable this module in your application, follow the steps below.
-1. Add `@genesislcap/foundation-logger` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-logger": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
-2. Create a logger in my-package/utils/logger.ts for example.
-```ts
-import { createLogger } from '@genesislcap/foundation-logger';
-export const logger = createLogger('my-package');
-```
-The logger will be set to `LogLevel.Debug` by default, however you can pass options as the second parameter to tailor this.
-```ts
-export const logger = createLogger('my-package', { level: LogLevel.Debug, ... });
-```
-`LoggerOptions` type extends the `ConsolaOptions` type.
-3. Use the logger in your package.
-```ts
-import { logger } from '../utils';
-...
-logger.debug('Checks complete');
-```
-4. Explicitly set the log level of an imported foundation package when needed.
-```ts
-import { logger as commsLogger } from '@genesislcap/foundation-comms';
-import { logger as storeLogger } from '@genesislcap/foundation-store';
-import { LogLevel } from '@genesislcap/foundation-logger';
-commsLogger.level = LogLevel.Warn;
-storeLogger.level = LogLevel.Silent;
-```
-## [API Docs](./docs/api/index.md)
 ## License
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 ### Licensed components
 Genesis low-code platform

package/package.json CHANGED Viewed

@@ -1,18 +1,17 @@
 {
   "name": "@genesislcap/foundation-logger",
   "description": "Genesis Foundation Logger",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/dts/index.d.ts",
   "scripts": {
     "api:extract": "api-extractor run",
-    "api:document": "api-documenter markdown -i dist -o docs/api",
-    "build": "npm run clean && tsc -b ./tsconfig.json && npm run api:extract && npm run api:document",
+    "build": "npm run clean && tsc -b ./tsconfig.json && npm run api:extract",
     "circular": "npx -y madge --extensions ts --circular ./src",
     "clean": "rimraf dist temp tsconfig.tsbuildinfo",
-    "dev": "tsc -b ./tsconfig.json -w",
+    "dev": "genx dev -b ts",
     "lint": "genx lint --profile",
     "lint:fix": "genx lint --fix"
   },
@@ -34,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-logger.createlogger.md DELETED Viewed

@@ -1,102 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md) &gt; [createLogger](./foundation-logger.createlogger.md)
-## createLogger() function
-Creates a logger with the given name and options.
-**Signature:**
-```typescript
-export declare function createLogger(name: string, options?: LoggerOptions): Logger;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-name
-</td><td>
-string
-</td><td>
-The name to give the logger.
-</td></tr>
-<tr><td>
-options
-</td><td>
-[LoggerOptions](./foundation-logger.loggeroptions.md)
-</td><td>
-_(Optional)_ The options to use when creating the logger.
-</td></tr>
-</tbody></table>
-**Returns:**
-[Logger](./foundation-logger.logger.md)
-The resulting logger.
-## Example 1
-Create a logger in my-package/utils.
-```ts
-import { createLogger } from '@genesislcap/foundation-logger';
-export const logger = createLogger('my-package');
-```
-## Example 2
-Using the logger within my-package.
-```ts
-import { logger } from '../utils';
-logger.debug(`Data retrieved from ${resourceName}`);
-logger.info(this.toggled ? 'On' : 'Off');
-logger.warn('Not available in this browser.');
-```
-## Example 3
-Explicitly set the level of an imported package.
-```ts
-import { logger as commsLogger } from '@genesislcap/foundation-comms';
-import { LogLevel } from '@genesislcap/foundation-logger';
-commsLogger.level = LogLevel.Warn;
-```

package/docs/api/foundation-logger.defaultloggeroptions.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md) &gt; [defaultLoggerOptions](./foundation-logger.defaultloggeroptions.md)
-## defaultLoggerOptions variable
-The default logger options.
-**Signature:**
-```typescript
-defaultLoggerOptions: LoggerOptions
-```

package/docs/api/foundation-logger.logger.deprecated.md DELETED Viewed

@@ -1,105 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md) &gt; [Logger](./foundation-logger.logger.md) &gt; [deprecated](./foundation-logger.logger.deprecated.md)
-## Logger.deprecated() method
-A logger method for deprecated symbols.
-**Signature:**
-```typescript
-deprecated(symbol: string, instruction?: string, removalVersionTarget?: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-symbol
-</td><td>
-string
-</td><td>
-The deprecated symbol.
-</td></tr>
-<tr><td>
-instruction
-</td><td>
-string
-</td><td>
-_(Optional)_ An optional alternative instruction. Defaults to `Consult docs for better alternative.`
-</td></tr>
-<tr><td>
-removalVersionTarget
-</td><td>
-string
-</td><td>
-_(Optional)_ An optional target removal version number.
-</td></tr>
-</tbody></table>
-**Returns:**
-void
-## Remarks
-Pair with a deprecated tag. See [https://tsdoc.org/pages/tags/deprecated/](https://tsdoc.org/pages/tags/deprecated/) for more information.
-## Example 1
-```ts
-logger.deprecated('someSymbol');
-```
-## Example 2
-With a custom instruction and target removal version.
-```ts
-logger.deprecated('routeButtons', 'Use the default slot instead.', '20.0.0');
-```

package/docs/api/foundation-logger.logger.md DELETED Viewed

@@ -1,45 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md) &gt; [Logger](./foundation-logger.logger.md)
-## Logger interface
-A logger that extends the `Consola` logger.
-**Signature:**
-```typescript
-export interface Logger extends Consola
-```
-**Extends:** Consola
-## Remarks
-This logger is part of the package's API but may still be subject to changes and improvements.
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[deprecated(symbol, instruction, removalVersionTarget)](./foundation-logger.logger.deprecated.md)
-</td><td>
-A logger method for deprecated symbols.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-logger.loggeroptions.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md) &gt; [LoggerOptions](./foundation-logger.loggeroptions.md)
-## LoggerOptions interface
-Options for creating a logger.
-**Signature:**
-```typescript
-export interface LoggerOptions extends ConsolaOptions
-```
-**Extends:** ConsolaOptions

package/docs/api/foundation-logger.md DELETED Viewed

@@ -1,95 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-logger](./foundation-logger.md)
-## foundation-logger package
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[createLogger(name, options)](./foundation-logger.createlogger.md)
-</td><td>
-Creates a logger with the given name and options.
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Logger](./foundation-logger.logger.md)
-</td><td>
-A logger that extends the `Consola` logger.
-</td></tr>
-<tr><td>
-[LoggerOptions](./foundation-logger.loggeroptions.md)
-</td><td>
-Options for creating a logger.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[defaultLoggerOptions](./foundation-logger.defaultloggeroptions.md)
-</td><td>
-The default logger options.
-</td></tr>
-</tbody></table>

package/docs/api/index.md DELETED Viewed

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md)
-## API Reference
-## Packages
-<table><thead><tr><th>
-Package
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[@genesislcap/foundation-logger](./foundation-logger.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api-report.md.api.md DELETED Viewed

@@ -1,37 +0,0 @@
-## API Report File for "@genesislcap/foundation-logger"
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-```ts
-import { Consola } from 'consola';
-import { ConsolaOptions } from 'consola';
-import { LogLevel } from 'consola';
-import { logType } from 'consola';
-// @public
-export function createLogger(name: string, options?: LoggerOptions): Logger;
-// @public
-export const defaultLoggerOptions: LoggerOptions;
-// @public
-export interface Logger extends Consola {
-    deprecated(symbol: string, instruction?: string, removalVersionTarget?: string): void;
-}
-// @public
-export interface Logger extends Consola {
-}
-// @public
-export interface LoggerOptions extends ConsolaOptions {
-}
-export { LogLevel }
-export { logType }
-// (No @packageDocumentation comment for this package)
-```