@trackunit/shared-utils 1.11.1 → 1.11.3
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.
- package/index.cjs.js +53 -0
- package/index.esm.js +53 -1
- package/package.json +1 -1
- package/src/index.d.ts +1 -0
- package/src/storyContentUtils.d.ts +56 -0
package/index.cjs.js
CHANGED
|
@@ -1099,6 +1099,58 @@ const booleanCompare = (a, b) => {
|
|
|
1099
1099
|
return 0;
|
|
1100
1100
|
};
|
|
1101
1101
|
|
|
1102
|
+
/**
|
|
1103
|
+
* Collection of unique Lorem ipsum paragraphs (10 unique paragraphs)
|
|
1104
|
+
*/
|
|
1105
|
+
const LOREM_IPSUM_PARAGRAPHS = [
|
|
1106
|
+
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
|
|
1107
|
+
"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.",
|
|
1108
|
+
"Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur.",
|
|
1109
|
+
"Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur. At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident.",
|
|
1110
|
+
"Similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus.",
|
|
1111
|
+
"Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.",
|
|
1112
|
+
"Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Cras mattis consectetur purus sit amet fermentum. Donec sed odio dui. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Nullam id dolor id nibh ultricies vehicula ut id elit.",
|
|
1113
|
+
"Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ullamcorper nulla non metus auctor fringilla. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis.",
|
|
1114
|
+
"Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Curabitur blandit tempus porttitor. Nullam quis risus eget urna mollis ornare vel eu leo. Nullam id dolor id nibh ultricies vehicula ut id elit.",
|
|
1115
|
+
"Vestibulum id ligula porta felis euismod semper. Maecenas sed diam eget risus varius blandit sit amet non magna. Donec ullamcorper nulla non metus auctor fringilla. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.",
|
|
1116
|
+
];
|
|
1117
|
+
/**
|
|
1118
|
+
* Short Lorem ipsum text for compact displays
|
|
1119
|
+
*/
|
|
1120
|
+
const LOREM_IPSUM_SHORT = "Lorem ipsum dolor sit amet consectetur adipisicing elit.";
|
|
1121
|
+
/**
|
|
1122
|
+
* Very short Lorem ipsum text (just a few words)
|
|
1123
|
+
*/
|
|
1124
|
+
const LOREM_IPSUM_VERY_SHORT = "Lorem ipsum dolor sit amet.";
|
|
1125
|
+
function getLoremIpsum({ paragraphs = 1, asArray = false } = {}) {
|
|
1126
|
+
// Handle fraction strings for shorter text
|
|
1127
|
+
if (paragraphs === "1/4") {
|
|
1128
|
+
return LOREM_IPSUM_SHORT;
|
|
1129
|
+
}
|
|
1130
|
+
if (paragraphs === "1/8") {
|
|
1131
|
+
return LOREM_IPSUM_VERY_SHORT;
|
|
1132
|
+
}
|
|
1133
|
+
if (paragraphs === "1/2") {
|
|
1134
|
+
// Split first paragraph by sentences and return first half
|
|
1135
|
+
const firstParagraph = LOREM_IPSUM_PARAGRAPHS[0];
|
|
1136
|
+
if (!firstParagraph) {
|
|
1137
|
+
return "";
|
|
1138
|
+
}
|
|
1139
|
+
const sentences = firstParagraph.split(/\. /).filter(s => s.length > 0);
|
|
1140
|
+
const halfLength = Math.ceil(sentences.length / 2);
|
|
1141
|
+
const halfText = sentences.slice(0, halfLength).join(". ") + ".";
|
|
1142
|
+
return halfText;
|
|
1143
|
+
}
|
|
1144
|
+
// Handle numeric paragraphs
|
|
1145
|
+
const paragraphCount = typeof paragraphs === "number" ? paragraphs : 1;
|
|
1146
|
+
if (paragraphCount <= 0 || paragraphCount > LOREM_IPSUM_PARAGRAPHS.length) {
|
|
1147
|
+
return asArray ? [] : "";
|
|
1148
|
+
}
|
|
1149
|
+
// Use slice to get the requested number of paragraphs (ensures type safety)
|
|
1150
|
+
const selectedParagraphs = LOREM_IPSUM_PARAGRAPHS.slice(0, paragraphCount);
|
|
1151
|
+
return asArray ? selectedParagraphs : selectedParagraphs.join("\n\n");
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1102
1154
|
/**
|
|
1103
1155
|
* Capitalizes the first letter of a string
|
|
1104
1156
|
*
|
|
@@ -1515,6 +1567,7 @@ exports.getDifferenceBetweenDates = getDifferenceBetweenDates;
|
|
|
1515
1567
|
exports.getEndOfDay = getEndOfDay;
|
|
1516
1568
|
exports.getFirstLevelObjectPropertyDifferences = getFirstLevelObjectPropertyDifferences;
|
|
1517
1569
|
exports.getISOStringFromDate = getISOStringFromDate;
|
|
1570
|
+
exports.getLoremIpsum = getLoremIpsum;
|
|
1518
1571
|
exports.getMimeTypeFromDataURL = getMimeTypeFromDataURL;
|
|
1519
1572
|
exports.getResizedDimensions = getResizedDimensions;
|
|
1520
1573
|
exports.getStartOfDay = getStartOfDay;
|
package/index.esm.js
CHANGED
|
@@ -1097,6 +1097,58 @@ const booleanCompare = (a, b) => {
|
|
|
1097
1097
|
return 0;
|
|
1098
1098
|
};
|
|
1099
1099
|
|
|
1100
|
+
/**
|
|
1101
|
+
* Collection of unique Lorem ipsum paragraphs (10 unique paragraphs)
|
|
1102
|
+
*/
|
|
1103
|
+
const LOREM_IPSUM_PARAGRAPHS = [
|
|
1104
|
+
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
|
|
1105
|
+
"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.",
|
|
1106
|
+
"Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur.",
|
|
1107
|
+
"Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur. At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident.",
|
|
1108
|
+
"Similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus.",
|
|
1109
|
+
"Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.",
|
|
1110
|
+
"Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Cras mattis consectetur purus sit amet fermentum. Donec sed odio dui. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Nullam id dolor id nibh ultricies vehicula ut id elit.",
|
|
1111
|
+
"Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ullamcorper nulla non metus auctor fringilla. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis.",
|
|
1112
|
+
"Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Curabitur blandit tempus porttitor. Nullam quis risus eget urna mollis ornare vel eu leo. Nullam id dolor id nibh ultricies vehicula ut id elit.",
|
|
1113
|
+
"Vestibulum id ligula porta felis euismod semper. Maecenas sed diam eget risus varius blandit sit amet non magna. Donec ullamcorper nulla non metus auctor fringilla. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.",
|
|
1114
|
+
];
|
|
1115
|
+
/**
|
|
1116
|
+
* Short Lorem ipsum text for compact displays
|
|
1117
|
+
*/
|
|
1118
|
+
const LOREM_IPSUM_SHORT = "Lorem ipsum dolor sit amet consectetur adipisicing elit.";
|
|
1119
|
+
/**
|
|
1120
|
+
* Very short Lorem ipsum text (just a few words)
|
|
1121
|
+
*/
|
|
1122
|
+
const LOREM_IPSUM_VERY_SHORT = "Lorem ipsum dolor sit amet.";
|
|
1123
|
+
function getLoremIpsum({ paragraphs = 1, asArray = false } = {}) {
|
|
1124
|
+
// Handle fraction strings for shorter text
|
|
1125
|
+
if (paragraphs === "1/4") {
|
|
1126
|
+
return LOREM_IPSUM_SHORT;
|
|
1127
|
+
}
|
|
1128
|
+
if (paragraphs === "1/8") {
|
|
1129
|
+
return LOREM_IPSUM_VERY_SHORT;
|
|
1130
|
+
}
|
|
1131
|
+
if (paragraphs === "1/2") {
|
|
1132
|
+
// Split first paragraph by sentences and return first half
|
|
1133
|
+
const firstParagraph = LOREM_IPSUM_PARAGRAPHS[0];
|
|
1134
|
+
if (!firstParagraph) {
|
|
1135
|
+
return "";
|
|
1136
|
+
}
|
|
1137
|
+
const sentences = firstParagraph.split(/\. /).filter(s => s.length > 0);
|
|
1138
|
+
const halfLength = Math.ceil(sentences.length / 2);
|
|
1139
|
+
const halfText = sentences.slice(0, halfLength).join(". ") + ".";
|
|
1140
|
+
return halfText;
|
|
1141
|
+
}
|
|
1142
|
+
// Handle numeric paragraphs
|
|
1143
|
+
const paragraphCount = typeof paragraphs === "number" ? paragraphs : 1;
|
|
1144
|
+
if (paragraphCount <= 0 || paragraphCount > LOREM_IPSUM_PARAGRAPHS.length) {
|
|
1145
|
+
return asArray ? [] : "";
|
|
1146
|
+
}
|
|
1147
|
+
// Use slice to get the requested number of paragraphs (ensures type safety)
|
|
1148
|
+
const selectedParagraphs = LOREM_IPSUM_PARAGRAPHS.slice(0, paragraphCount);
|
|
1149
|
+
return asArray ? selectedParagraphs : selectedParagraphs.join("\n\n");
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1100
1152
|
/**
|
|
1101
1153
|
* Capitalizes the first letter of a string
|
|
1102
1154
|
*
|
|
@@ -1476,4 +1528,4 @@ const formatUsCustomaryDistance = (value) => {
|
|
|
1476
1528
|
}
|
|
1477
1529
|
};
|
|
1478
1530
|
|
|
1479
|
-
export { DateTimeFormat, HoursAndMinutesFormat, UnitsOfMeasurementSI, UnitsOfMeasurementUSCustomary, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToKilometers, convertMetersToYards, convertYardsToMeters, convertYardsToMiles, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, formatSiDistance, formatUsCustomaryDistance, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, preload, removeLeftPadding, removeProperties, removeProperty, replaceNullableNumbersWithZero, resizeBlob, resizeImage, rgb2hex, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, svgToPNG, titleCase, toID, toIDs, toPNG, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };
|
|
1531
|
+
export { DateTimeFormat, HoursAndMinutesFormat, UnitsOfMeasurementSI, UnitsOfMeasurementUSCustomary, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToKilometers, convertMetersToYards, convertYardsToMeters, convertYardsToMiles, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, formatSiDistance, formatUsCustomaryDistance, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getLoremIpsum, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, preload, removeLeftPadding, removeProperties, removeProperty, replaceNullableNumbersWithZero, resizeBlob, resizeImage, rgb2hex, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, svgToPNG, titleCase, toID, toIDs, toPNG, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };
|
package/package.json
CHANGED
package/src/index.d.ts
CHANGED
|
@@ -19,6 +19,7 @@ export * from "./pathUtils";
|
|
|
19
19
|
export * from "./pictureUtils/pictureUtils";
|
|
20
20
|
export * from "./sorting/sorting";
|
|
21
21
|
export * from "./storybookUtils";
|
|
22
|
+
export * from "./storyContentUtils";
|
|
22
23
|
export * from "./stringUtils";
|
|
23
24
|
export * from "./svgTools";
|
|
24
25
|
export * from "./translationUtils";
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Paragraph count can be a number or a fraction string for shorter text
|
|
3
|
+
*/
|
|
4
|
+
export type ParagraphCount = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | "1/2" | "1/4" | "1/8";
|
|
5
|
+
/**
|
|
6
|
+
* Options for generating Lorem ipsum text
|
|
7
|
+
*/
|
|
8
|
+
export type LoremIpsumOptions = {
|
|
9
|
+
/**
|
|
10
|
+
* Number of paragraphs to generate, or a fraction for shorter text.
|
|
11
|
+
* - Numbers (1-10): Full paragraphs (each paragraph is unique, no repetition)
|
|
12
|
+
* - "1/2": Half a paragraph (first half of sentences)
|
|
13
|
+
* - "1/4": Quarter paragraph (short sentence)
|
|
14
|
+
* - "1/8": Very short text (just a few words)
|
|
15
|
+
*
|
|
16
|
+
* @default 1
|
|
17
|
+
*/
|
|
18
|
+
paragraphs?: ParagraphCount;
|
|
19
|
+
/**
|
|
20
|
+
* If true, returns an array of paragraph strings. If false, returns a single string with paragraphs separated by double newlines.
|
|
21
|
+
*
|
|
22
|
+
* @default false
|
|
23
|
+
*/
|
|
24
|
+
asArray?: boolean;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Generates Lorem ipsum placeholder text for use in stories and demos.
|
|
28
|
+
*
|
|
29
|
+
* @param options - Configuration options for text generation
|
|
30
|
+
* @param options.paragraphs - Number of paragraphs (1-10) or fraction string ("1/2", "1/4", "1/8")
|
|
31
|
+
* @param options.asArray - If true, returns an array of strings instead of a single string
|
|
32
|
+
* @returns {string | Array<string>} Lorem ipsum text as a string or array of strings
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* Single paragraph
|
|
36
|
+
* const text = getLoremIpsum();
|
|
37
|
+
*
|
|
38
|
+
* Short sentence for compact displays
|
|
39
|
+
* const shortText = getLoremIpsum({ paragraphs: "1/4" });
|
|
40
|
+
*
|
|
41
|
+
* Half paragraph
|
|
42
|
+
* const halfText = getLoremIpsum({ paragraphs: "1/2" });
|
|
43
|
+
*
|
|
44
|
+
* Multiple paragraphs as string
|
|
45
|
+
* const longText = getLoremIpsum({ paragraphs: 5 });
|
|
46
|
+
*
|
|
47
|
+
* Multiple paragraphs as array
|
|
48
|
+
* const paragraphs = getLoremIpsum({ paragraphs: 3, asArray: true });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
export declare function getLoremIpsum(options?: Omit<LoremIpsumOptions, "asArray"> & {
|
|
52
|
+
asArray?: false;
|
|
53
|
+
}): string;
|
|
54
|
+
export declare function getLoremIpsum(options: Omit<LoremIpsumOptions, "asArray"> & {
|
|
55
|
+
asArray: true;
|
|
56
|
+
}): Array<string>;
|