@ongov/ontario-design-system-component-library 5.0.0-alpha.6 → 5.0.0

package/dist/cjs/console-message-B2SEf-GP.js

@@ -0,0 +1,99 @@
+'use strict';
+
+exports.ConsoleType = void 0;
+(function (ConsoleType) {
+	ConsoleType['Error'] = 'error';
+	ConsoleType['Info'] = 'info';
+	ConsoleType['Log'] = 'log';
+	ConsoleType['Warning'] = 'warning';
+})(exports.ConsoleType || (exports.ConsoleType = {}));
+var MessageStyle;
+(function (MessageStyle) {
+	MessageStyle['Regular'] = 'regular';
+	MessageStyle['Code'] = 'code';
+})(MessageStyle || (MessageStyle = {}));
+
+// system tag with formatting specifier
+const designSystemTag = 'Ontario Design System';
+// default font size for console messages
+const fontSize = '12px';
+// styles for the system tag in a string format
+// the `background-color`, `color`, `padding` and `border-radius` values are hardcoded because
+// they are specific for console message use case
+const tagStyles = [
+	'background-color: #367A76',
+	'border: none',
+	'color: white',
+	'padding: 2px 5px',
+	'text-align: center',
+	'text-decoration: none',
+	'display: inline-block',
+	'cursor: pointer',
+	'border-radius: 5px',
+].join(';');
+// styles for regular text in string format
+const regularTextStyles = ['font-family: sans-serif', `font-size: ${fontSize}`].join(';');
+// styles for code in string format
+const monospaceTextStyles = ['font-family: monospace', `font-size: ${fontSize}`].join(';');
+function addSpecifier(message) {
+	const styleSpecifier = '%c';
+	return styleSpecifier.concat(message);
+}
+// build and print console message with a fluent interface design
+class ConsoleMessageClass {
+	message;
+	styles;
+	constructor() {
+		this.message = '';
+		this.styles = [];
+	}
+	// add the `Ontario Design System` tag to the beginning of the message
+	// the first call in the chain if a tag is required
+	addDesignSystemTag() {
+		this.message = addSpecifier(designSystemTag);
+		this.styles.push(tagStyles);
+		return this;
+	}
+	// build console message as regular text
+	addRegularText(text) {
+		this.addText(text, regularTextStyles);
+		return this;
+	}
+	// build console message as monospace text
+	addMonospaceText(text) {
+		this.addText(text, monospaceTextStyles);
+		return this;
+	}
+	// print message to console depending on the `ConsoleType`
+	// the last function call in the chain
+	printMessage(consoleType = exports.ConsoleType.Warning) {
+		const messageArray = [this.message, ...this.styles];
+		// pass array of arguments into the console function for printing depending on `consoleType`
+		// the `function.apply()` function handles array of arguments which allows list of arguments to be set programmatically
+		switch (consoleType) {
+			case exports.ConsoleType.Error:
+				console.error.apply(null, messageArray);
+				break;
+			case exports.ConsoleType.Info:
+				console.info.apply(null, messageArray);
+				break;
+			case exports.ConsoleType.Warning:
+				console.warn.apply(null, messageArray);
+				break;
+			default:
+				console.log.apply(null, messageArray);
+		}
+	}
+	// add text to the `message` property and associated styles into the `styles` array
+	addText(text, style) {
+		if (text && text?.trim().length > 0) {
+			this.message += addSpecifier(text);
+			this.styles.push(style);
+		}
+	}
+}
+
+exports.ConsoleMessageClass = ConsoleMessageClass;
+//# sourceMappingURL=console-message-B2SEf-GP.js.map
+
+//# sourceMappingURL=console-message-B2SEf-GP.js.map

package/dist/cjs/console-message-B2SEf-GP.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"console-message-B2SEf-GP.js","sources":["src/utils/console-message/console-message.enum.ts","src/utils/console-message/console-message.ts"],"sourcesContent":["export enum ConsoleType {\n\tError = 'error',\n\tInfo = 'info',\n\tLog = 'log',\n\tWarning = 'warning',\n}\n\nexport enum MessageStyle {\n\tRegular = 'regular',\n\tCode = 'code',\n}\n","import { ConsoleMessage } from './console-message.interface';\nimport { ConsoleType, MessageStyle } from './console-message.enum';\n\n// system tag with formatting specifier\nconst designSystemTag = 'Ontario Design System';\n\n// default font size for console messages\nconst fontSize = '12px';\n\n// styles for the system tag in a string format\n// the `background-color`, `color`, `padding` and `border-radius` values are hardcoded because\n// they are specific for console message use case\nconst tagStyles = [\n\t'background-color: #367A76',\n\t'border: none',\n\t'color: white',\n\t'padding: 2px 5px',\n\t'text-align: center',\n\t'text-decoration: none',\n\t'display: inline-block',\n\t'cursor: pointer',\n\t'border-radius: 5px',\n].join(';');\n\n// styles for regular text in string format\nconst regularTextStyles = ['font-family: sans-serif', `font-size: ${fontSize}`].join(';');\n\n// styles for code in string format\nconst monospaceTextStyles = ['font-family: monospace', `font-size: ${fontSize}`].join(';');\n\nfunction addSpecifier(message: string): string {\n\tconst styleSpecifier = '%c';\n\treturn styleSpecifier.concat(message);\n}\n\n// print message to console depending on the `ConsoleType`\nexport function printConsoleMessage(\n\tmessages: ConsoleMessage[] | string,\n\tconsoleType = ConsoleType.Warning,\n\thasDesignSystemTag = true,\n) {\n\t// retrieve message from each object and concatenate them into one single string in order\n\t// if `hasSystemTag` is true then the message string will being with the value stored within `designSystemTag`.\n\tconst message =\n\t\ttypeof messages === 'string' // Note the TypeScript transpiler Stencil is using doesn't like this type guard as a const.\n\t\t\t? `${addSpecifier(designSystemTag)}${addSpecifier(` ${messages}`)}`\n\t\t\t: messages?.reduce(\n\t\t\t\t\t(message: string, currentObject: ConsoleMessage) => (message += addSpecifier(currentObject.message) ?? ''),\n\t\t\t\t\thasDesignSystemTag ? addSpecifier(designSystemTag) : '',\n\t\t\t\t);\n\n\t// array of arguments to be passed into the the console function\n\tconst messageArray: string[] = [];\n\n\t// push message into the array of arguments\n\t// depending on whether the system tag is used (i.e. `hasSystemTag` is true), push `tagStyles` into the array\n\tif (hasDesignSystemTag) {\n\t\tmessageArray.push(message, tagStyles);\n\t} else {\n\t\tmessageArray.push(message);\n\t}\n\n\t// Note the TypeScript transpiler Stencil is using doesn't like this type guard as a const.\n\tif (typeof messages === 'string') {\n\t\tmessageArray.push(regularTextStyles);\n\t} else {\n\t\t// push style of each message into the array of arguments in order\n\t\tmessages?.forEach((message: ConsoleMessage) => {\n\t\t\tmessageArray.push(message.style && message.style === MessageStyle.Code ? monospaceTextStyles : regularTextStyles);\n\t\t});\n\t}\n\n\t// pass array of arguments into the console function for printing depending on `consoleType`\n\t// the `function.apply()` function handles array of arguments which allows list of arguments to be set programmatically\n\tswitch (consoleType) {\n\t\tcase ConsoleType.Error:\n\t\t\treturn console.error.apply(null, messageArray);\n\n\t\tcase ConsoleType.Info:\n\t\t\treturn console.info.apply(null, messageArray);\n\n\t\tcase ConsoleType.Warning:\n\t\t\treturn console.warn.apply(null, messageArray);\n\n\t\tdefault:\n\t\t\treturn console.log.apply(null, messageArray);\n\t}\n}\n\n// build and print console message with a fluent interface design\nexport class ConsoleMessageClass {\n\tmessage: string;\n\tstyles: string[];\n\n\tconstructor() {\n\t\tthis.message = '';\n\t\tthis.styles = [];\n\t}\n\n\t// add the `Ontario Design System` tag to the beginning of the message\n\t// the first call in the chain if a tag is required\n\taddDesignSystemTag() {\n\t\tthis.message = addSpecifier(designSystemTag);\n\t\tthis.styles.push(tagStyles);\n\t\treturn this;\n\t}\n\n\t// build console message as regular text\n\taddRegularText(text: string) {\n\t\tthis.addText(text, regularTextStyles);\n\t\treturn this;\n\t}\n\n\t// build console message as monospace text\n\taddMonospaceText(text: string) {\n\t\tthis.addText(text, monospaceTextStyles);\n\t\treturn this;\n\t}\n\n\t// print message to console depending on the `ConsoleType`\n\t// the last function call in the chain\n\tprintMessage(consoleType = ConsoleType.Warning) {\n\t\tconst messageArray = [this.message, ...this.styles];\n\n\t\t// pass array of arguments into the console function for printing depending on `consoleType`\n\t\t// the `function.apply()` function handles array of arguments which allows list of arguments to be set programmatically\n\t\tswitch (consoleType) {\n\t\t\tcase ConsoleType.Error:\n\t\t\t\tconsole.error.apply(null, messageArray);\n\t\t\t\tbreak;\n\t\t\tcase ConsoleType.Info:\n\t\t\t\tconsole.info.apply(null, messageArray);\n\t\t\t\tbreak;\n\t\t\tcase ConsoleType.Warning:\n\t\t\t\tconsole.warn.apply(null, messageArray);\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\tconsole.log.apply(null, messageArray);\n\t\t}\n\t}\n\n\t// add text to the `message` property and associated styles into the `styles` array\n\tprivate addText(text: string, style: string) {\n\t\tif (text && text?.trim().length > 0) {\n\t\t\tthis.message += addSpecifier(text);\n\t\t\tthis.styles.push(style);\n\t\t}\n\t}\n}\n"],"names":["ConsoleType"],"mappings":";;AAAYA;AAAZ,CAAA,UAAY,WAAW,EAAA;AACtB,IAAA,WAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,WAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACb,IAAA,WAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,WAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACpB,CAAC,EALWA,mBAAW,KAAXA,mBAAW,GAKtB,EAAA,CAAA,CAAA;AAED,IAAY,YAGX;AAHD,CAAA,UAAY,YAAY,EAAA;AACvB,IAAA,YAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,YAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACd,CAAC,EAHW,YAAY,KAAZ,YAAY,GAGvB,EAAA,CAAA,CAAA;;ACPD;AACA,MAAM,eAAe,GAAG,uBAAuB;AAE/C;AACA,MAAM,QAAQ,GAAG,MAAM;AAEvB;AACA;AACA;AACA,MAAM,SAAS,GAAG;IACjB,2BAA2B;IAC3B,cAAc;IACd,cAAc;IACd,kBAAkB;IAClB,oBAAoB;IACpB,uBAAuB;IACvB,uBAAuB;IACvB,iBAAiB;IACjB,oBAAoB;AACpB,CAAA,CAAC,IAAI,CAAC,GAAG,CAAC;AAEX;AACA,MAAM,iBAAiB,GAAG,CAAC,yBAAyB,EAAE,CAAc,WAAA,EAAA,QAAQ,CAAE,CAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAEzF;AACA,MAAM,mBAAmB,GAAG,CAAC,wBAAwB,EAAE,CAAc,WAAA,EAAA,QAAQ,CAAE,CAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAE1F,SAAS,YAAY,CAAC,OAAe,EAAA;IACpC,MAAM,cAAc,GAAG,IAAI;AAC3B,IAAA,OAAO,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC;AACtC;AAwDA;MACa,mBAAmB,CAAA;AAC/B,IAAA,OAAO;AACP,IAAA,MAAM;AAEN,IAAA,WAAA,GAAA;AACC,QAAA,IAAI,CAAC,OAAO,GAAG,EAAE;AACjB,QAAA,IAAI,CAAC,MAAM,GAAG,EAAE;;;;IAKjB,kBAAkB,GAAA;AACjB,QAAA,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC;AAC5C,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAC3B,QAAA,OAAO,IAAI;;;AAIZ,IAAA,cAAc,CAAC,IAAY,EAAA;AAC1B,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC;AACrC,QAAA,OAAO,IAAI;;;AAIZ,IAAA,gBAAgB,CAAC,IAAY,EAAA;AAC5B,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,mBAAmB,CAAC;AACvC,QAAA,OAAO,IAAI;;;;AAKZ,IAAA,YAAY,CAAC,WAAW,GAAGA,mBAAW,CAAC,OAAO,EAAA;AAC7C,QAAA,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;;;QAInD,QAAQ,WAAW;YAClB,KAAKA,mBAAW,CAAC,KAAK;gBACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC;gBACvC;YACD,KAAKA,mBAAW,CAAC,IAAI;gBACpB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC;gBACtC;YACD,KAAKA,mBAAW,CAAC,OAAO;gBACvB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC;gBACtC;AACD,YAAA;gBACC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC;;;;IAKhC,OAAO,CAAC,IAAY,EAAE,KAAa,EAAA;QAC1C,IAAI,IAAI,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;AACpC,YAAA,IAAI,CAAC,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC;AAClC,YAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;;AAGzB;;;;"}