ranuts 0.4.0-alpha.5 → 0.4.1-alpha.2

package/dist/src/utils/str.d.ts

@@ -13,6 +13,17 @@ export declare const strParse: (str?: string, sep?: string | RegExp, eq?: string
  */
 export declare const clearBr: (str?: string) => string;
 export declare const isString: (obj: unknown) => boolean;
+/**
+ * @description: A short random-ish string prefixed with the current timestamp.
+ *
+ * **Not cryptographically secure** — it draws from `Math.random()`, whose output is
+ * predictable from previous values. Good for a DOM id, a message correlation key or a cache
+ * buster; never for a token, code or anything an attacker benefits from guessing. Use
+ * `secureRandomString` / `secureToken` for those.
+ *
+ * @param {number} len characters of randomness after the timestamp
+ * @return {string}
+ */
 export declare function randomString(len?: number): string;
 interface ClearStrOption {
     urlencoded?: boolean;
@@ -102,6 +113,15 @@ export declare const transformText: (content: string | ArrayBuffer) => Transform
  * @returns The MD5 hash as a hexadecimal string
  */
 export declare const md5: (str: string) => string;
+/**
+ * @description: A short random-ish base-36 string.
+ *
+ * **Not cryptographically secure** — `Math.random()` based, like `randomString`. Use
+ * `secureRandomString` / `secureToken` when the value must be unguessable.
+ *
+ * @param {number} len
+ * @return {string}
+ */
 export declare const getRandomString: (len?: number) => string;
 type FileChunk = {
     name: string;
@@ -260,4 +280,59 @@ export declare const MessageCodec: {
      */
     decodeFileChunked(chunks: FileChunk[]): Promise<File>;
 };
+/**
+ * @description: Cut text to `max` characters and mark that it was cut.
+ *
+ * Different from `truncate`, which is for display: that one keeps a head and a tail around an
+ * ellipsis so a path or a name stays recognisable. This one is for text about to cross a
+ * boundary — a log line into a database row, tool output into a message, a field into a
+ * fixed-size frame — where the job is to respect a hard ceiling and leave evidence that
+ * something was dropped. Silent truncation is the failure this prevents: a reader who cannot
+ * tell a short answer from a cut-off one will trust the cut-off one.
+ *
+ * @param {string} text
+ * @param {number} max maximum characters to keep, before the marker
+ * @param {string} marker appended when anything was dropped
+ * @return {string}
+ */
+export declare const truncateWithMarker: (text: string, max: number, marker?: string) => string;
+/**
+ * @description: Wrap text in a Markdown code fence long enough to survive backticks inside it.
+ *
+ * A fixed ``` fence breaks the moment the body contains one — the block ends early and the
+ * rest of the document renders as prose, which is exactly what happens when you paste a
+ * Markdown snippet or a transcript into a report. CommonMark closes a fence only on a run at
+ * least as long as the opening one, so the fix is to measure the longest run in the body and
+ * open with one backtick more.
+ *
+ * @param {string} body
+ * @param {string} lang info string for the opening fence
+ * @return {string}
+ */
+export declare const fenceCode: (body: string, lang?: string) => string;
+/**
+ * @description: Reduce text to a lowercase `a-z0-9-` slug, safe as a filename on every
+ * filesystem and as a URL segment.
+ *
+ * Non-ASCII is dropped rather than transliterated: a guess at romanisation is wrong often
+ * enough that an empty slug — which the caller can detect and replace — beats a confidently
+ * mangled one. Callers that need CJK titles preserved should keep the original alongside.
+ *
+ * @param {string} text
+ * @param {number} maxLength longest slug to return; trailing dashes are trimmed after cutting
+ * @return {string} the slug, or `''` when nothing survived
+ */
+export declare const slugify: (text: string, maxLength?: number) => string;
+/**
+ * @description: Escape one CSV field: doubles any quote and wraps the value when it contains
+ * a comma, a quote or a newline (RFC 4180).
+ *
+ * A leading `=`, `+`, `-` or `@` is also prefixed with a quote, because spreadsheet software
+ * treats those as formulas — the "CSV injection" that turns an exported username into a
+ * command when someone opens the file.
+ *
+ * @param {string | number} value
+ * @return {string}
+ */
+export declare const csvEscape: (value: string | number) => string;
 export {};

package/dist/test/budget.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/conversation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/diff.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/formatBytes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/scroll.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/stream.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/utils/secure.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/utils/text-boundary.test.d.ts

@@ -0,0 +1 @@
+export {};