@pallasoft/ps-utilities 2.16.0 → 2.17.0

package/dist/common/constants/index.d.ts

@@ -16,3 +16,4 @@ export * from './http-header';
 export * from './http-method';
 export * from './relative-time-config';
 export * from './request-client-config';
+export * from './portable-text-config';

package/dist/common/constants/index.js

@@ -32,3 +32,4 @@ __exportStar(require("./http-header"), exports);
 __exportStar(require("./http-method"), exports);
 __exportStar(require("./relative-time-config"), exports);
 __exportStar(require("./request-client-config"), exports);
+__exportStar(require("./portable-text-config"), exports);

package/dist/common/constants/portable-text-config.d.ts

@@ -0,0 +1,19 @@
+export declare const PortableTextConfig: {
+    readonly linkRel: "noopener noreferrer";
+    readonly linkTarget: "_blank";
+    readonly paragraphSeparator: "\n\n";
+    readonly lineSeparator: "\n";
+    readonly paragraphSplitPattern: RegExp;
+    readonly lineBreakPattern: RegExp;
+    readonly bulletPrefix: "- ";
+    readonly quotePrefix: "> ";
+    readonly numberSuffix: ". ";
+    readonly keyPrefix: {
+        readonly block: "b";
+        readonly span: "s";
+    };
+    readonly normalStyle: "normal";
+    readonly quoteStyle: "blockquote";
+    readonly bulletItem: "bullet";
+    readonly numberItem: "number";
+};

package/dist/common/constants/portable-text-config.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortableTextConfig = void 0;
+var ps_models_1 = require("@pallasoft/ps-models");
+exports.PortableTextConfig = {
+    linkRel: 'noopener noreferrer',
+    linkTarget: '_blank',
+    paragraphSeparator: '\n\n',
+    lineSeparator: '\n',
+    paragraphSplitPattern: /\n[ \t]*\n/,
+    lineBreakPattern: /\r\n?/g,
+    bulletPrefix: '- ',
+    quotePrefix: '> ',
+    numberSuffix: '. ',
+    keyPrefix: { block: 'b', span: 's' },
+    normalStyle: ps_models_1.Common.PortableTextConfig.styles[0],
+    quoteStyle: ps_models_1.Common.PortableTextConfig.styles[1],
+    bulletItem: ps_models_1.Common.PortableTextConfig.listItems[0],
+    numberItem: ps_models_1.Common.PortableTextConfig.listItems[1],
+};

package/dist/common/index.d.ts

@@ -24,3 +24,4 @@ export * from './error-response-service';
 export * from './relative-time-service';
 export * from './request-client-service';
 export * from './json-service';
+export * from './portable-text-service';

package/dist/common/index.js

@@ -40,3 +40,4 @@ __exportStar(require("./error-response-service"), exports);
 __exportStar(require("./relative-time-service"), exports);
 __exportStar(require("./request-client-service"), exports);
 __exportStar(require("./json-service"), exports);
+__exportStar(require("./portable-text-service"), exports);

package/dist/common/portable-text-service.d.ts

@@ -0,0 +1,9 @@
+import type { PortableTextBlock } from '@portabletext/types';
+export declare class PortableTextService {
+    static toPlainText(blocks: PortableTextBlock[]): string;
+    static fromPlainText(text: string): PortableTextBlock[];
+    static isEmpty(blocks: PortableTextBlock[] | null | undefined): boolean;
+    static toHtml(blocks: PortableTextBlock[]): string;
+    private static blockText;
+    private static isSafeLink;
+}

package/dist/common/portable-text-service.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortableTextService = void 0;
+var ps_models_1 = require("@pallasoft/ps-models");
+var to_html_1 = require("@portabletext/to-html");
+var portable_text_config_1 = require("./constants/portable-text-config");
+var PortableTextService = /** @class */ (function () {
+    function PortableTextService() {
+    }
+    PortableTextService.toPlainText = function (blocks) {
+        var _this = this;
+        var lines = [];
+        var counters = {};
+        var previousWasList = false;
+        blocks.forEach(function (block) {
+            if (block._type !== ps_models_1.Common.PortableTextConfig.blockType)
+                return;
+            var text = _this.blockText(block);
+            var level = typeof block.level === 'number' ? block.level : 1;
+            var isNumber = block.listItem === portable_text_config_1.PortableTextConfig.numberItem;
+            var isBullet = block.listItem === portable_text_config_1.PortableTextConfig.bulletItem;
+            var isList = isNumber || isBullet;
+            if (!isList) {
+                counters[level] = 0;
+                if (lines.length > 0)
+                    lines.push(portable_text_config_1.PortableTextConfig.paragraphSeparator);
+                lines.push(block.style === portable_text_config_1.PortableTextConfig.quoteStyle
+                    ? portable_text_config_1.PortableTextConfig.quotePrefix + text
+                    : text);
+                previousWasList = false;
+                return;
+            }
+            counters[level] = isNumber
+                ? (typeof counters[level] === 'number' ? counters[level] : 0) + 1
+                : 0;
+            var prefix = isNumber
+                ? "".concat(counters[level]).concat(portable_text_config_1.PortableTextConfig.numberSuffix)
+                : portable_text_config_1.PortableTextConfig.bulletPrefix;
+            var indent = '  '.repeat(level - 1);
+            if (lines.length > 0)
+                lines.push(previousWasList ? portable_text_config_1.PortableTextConfig.lineSeparator : portable_text_config_1.PortableTextConfig.paragraphSeparator);
+            lines.push(indent + prefix + text);
+            previousWasList = true;
+        });
+        return lines.join('');
+    };
+    PortableTextService.fromPlainText = function (text) {
+        return text
+            .replace(portable_text_config_1.PortableTextConfig.lineBreakPattern, portable_text_config_1.PortableTextConfig.lineSeparator)
+            .split(portable_text_config_1.PortableTextConfig.paragraphSplitPattern)
+            .map(function (paragraph) { return paragraph.trim(); })
+            .filter(function (paragraph) { return paragraph.length > 0; })
+            .map(function (paragraph, index) { return ({
+            _type: ps_models_1.Common.PortableTextConfig.blockType,
+            _key: "".concat(portable_text_config_1.PortableTextConfig.keyPrefix.block).concat(index),
+            style: portable_text_config_1.PortableTextConfig.normalStyle,
+            markDefs: [],
+            children: [
+                {
+                    _type: ps_models_1.Common.PortableTextConfig.spanType,
+                    _key: "".concat(portable_text_config_1.PortableTextConfig.keyPrefix.span).concat(index),
+                    text: paragraph,
+                    marks: [],
+                },
+            ],
+        }); });
+    };
+    PortableTextService.isEmpty = function (blocks) {
+        var _this = this;
+        return (!Array.isArray(blocks) || blocks.every(function (block) { return _this.blockText(block).trim().length === 0; }));
+    };
+    PortableTextService.toHtml = function (blocks) {
+        var _this = this;
+        return (0, to_html_1.toHTML)(blocks, {
+            onMissingComponent: false,
+            components: {
+                marks: {
+                    link: function (_a) {
+                        var children = _a.children, value = _a.value;
+                        var href = typeof (value === null || value === void 0 ? void 0 : value.href) === 'string' ? value.href : '';
+                        return _this.isSafeLink(href)
+                            ? "<a href=\"".concat((0, to_html_1.escapeHTML)(href), "\" rel=\"").concat(portable_text_config_1.PortableTextConfig.linkRel, "\" target=\"").concat(portable_text_config_1.PortableTextConfig.linkTarget, "\">").concat(children, "</a>")
+                            : children;
+                    },
+                },
+            },
+        });
+    };
+    PortableTextService.blockText = function (block) {
+        return Array.isArray(block.children)
+            ? block.children
+                .map(function (child) {
+                return child._type === ps_models_1.Common.PortableTextConfig.spanType && typeof child.text === 'string'
+                    ? child.text
+                    : '';
+            })
+                .join('')
+            : '';
+    };
+    PortableTextService.isSafeLink = function (href) {
+        try {
+            return ps_models_1.Common.PortableTextConfig.linkProtocols.includes(new URL(href).protocol);
+        }
+        catch (_a) {
+            return false;
+        }
+    };
+    return PortableTextService;
+}());
+exports.PortableTextService = PortableTextService;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-utilities",
-	"version": "2.16.0",
+	"version": "2.17.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -77,6 +77,8 @@
 	},
 	"dependencies": {
 		"@esbuild-plugins/tsconfig-paths": "^0.1.2",
+		"@pallasoft/ps-models": "^1.4.0",
+		"@portabletext/to-html": "^4.0.1",
 		"dayjs": "^1.11.19",
 		"esbuild": "^0.27.0",
 		"libphonenumber-js": "^1.13.14"