@visulima/ansi 4.0.0-alpha.2 → 4.0.0-alpha.4

package/dist/iterm2.d.ts

@@ -0,0 +1,58 @@
+import type { IITerm2Payload } from './iterm2/iterm2-properties.d.ts';
+export type { IITerm2Payload, ITerm2FileProperties } from './iterm2/iterm2-properties.d.ts';
+export { IT2_AUTO, it2Cells, it2Percent, it2Pixels } from './iterm2/iterm2-properties.d.ts';
+export { ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart } from './iterm2/iterm2-sequences.d.ts';
+/**
+ * Generates a complete iTerm2 proprietary escape sequence (OSC 1337).
+ *
+ * This function serves as a general-purpose constructor for iTerm2 escape codes.
+ * It takes a payload object that conforms to the {@link IITerm2Payload} interface.
+ * The `toString()` method of this payload object is responsible for generating the
+ * specific command and arguments part of the sequence (e.g., `File=...`, `ShellIntegrationVersion=...`).
+ *
+ * The overall structure of the generated sequence is: `OSC 1337 ; <PAYLOAD_STRING> BEL`
+ * (`OSC` is `\x1b]`, `BEL` is `\x07`).
+ * @param payload An object that implements the {@link IITerm2Payload} interface.
+ * This object must have a `toString()` method that returns the string representation
+ * of the iTerm2 command-specific payload.
+ * Examples include instances of `ITerm2File`, `ITerm2MultipartFileStart`, etc.
+ * @returns The fully formed ANSI escape sequence for the iTerm2 command.
+ * Returns an empty string if the provided `payload` is invalid (e.g., null, undefined,
+ * lacks a proper `toString` method, or its `toString` method is the generic `Object.prototype.toString`).
+ * @see {@link https://iterm2.com/documentation-escape-codes.html iTerm2 Escape Codes Documentation}
+ * for a comprehensive list of supported commands and their payloads.
+ * @see {@link IITerm2Payload} for the interface requirement.
+ * @see Classes like {@link ITerm2File}, {@link ITerm2MultipartFileStart}, {@link ITerm2FilePart}, {@link ITerm2FileEnd}
+ * for concrete examples of payload objects.
+ * @example
+ * ```typescript
+ * import { iTerm2, ITerm2File, ITerm2FileProps } from '@visulima/ansi/iterm2'; // ITerm2FileProps can be used for options
+ * import { Buffer } from 'node:buffer';
+ *
+ * // Example 1: Sending a file inline (like an image)
+ * const imageName = "my_image.png";
+ * const imageData = Buffer.from("dummyimagecontent"); // Replace with actual Uint8Array image data
+ * const imageFileProps: ITerm2FileProps = { // Use ITerm2FileProps for broader options
+ *   name: Buffer.from(imageName).toString("base64"), // Name should be base64 encoded
+ *   inline: true,
+ *   width: "50%",
+ *   height: "auto",
+ *   ignoreAspectRatio: false, // Equivalent to preserveAspectRatio: true
+ * };
+ * const filePayload = new ITerm2File(imageFileProps, imageData);
+ * const imageSequence = iTerm2(filePayload);
+ * console.log(imageSequence);
+ * // Expected output (simplified, actual base64 will be longer):
+ * // OSC1337;File=name=bXlfaW1hZ2UucG5n;inline=1;width=50%;height=auto:ZHVtbXlpbWFnZWNvbnRlbnQ=BEL
+ * // Note: if ignoreAspectRatio was true, preserveAspectRatio=0 would be in the sequence.
+ *
+ * // Example 2: A hypothetical simple command (e.g., shell integration handshake)
+ * const shellIntegrationPayload: IITerm2Payload = {
+ *   toString: () => "ShellIntegrationVersion=15;Shell=zsh"
+ * };
+ * const shellSequence = iTerm2(shellIntegrationPayload);
+ * console.log(shellSequence);
+ * // Output: OSC1337;ShellIntegrationVersion=15;Shell=zshBEL
+ * ```
+ */
+export declare const iTerm2: (payload: IITerm2Payload) => string;

package/dist/iterm2.js

@@ -0,0 +1 @@
+var i=Object.defineProperty;var r=(t,e)=>i(t,"name",{value:e,configurable:!0});import{O as o,B as m}from"./packem_shared/constants-D12jy2Zh.js";import{IT2_AUTO as I,it2Cells as c,it2Percent as s,it2Pixels as S}from"./packem_shared/IT2_AUTO-BYrffRAq.js";import{ITerm2File as g,ITerm2FileEnd as y,ITerm2FilePart as O,ITerm2MultipartFileStart as P}from"./packem_shared/ITerm2File-C88DBJC-.js";var n=Object.defineProperty,a=r((t,e)=>n(t,"name",{value:e,configurable:!0}),"t");const T=a(t=>{if(!t||typeof t.toString!="function"||t.toString===Object.prototype.toString)throw new Error("Invalid payload: must implement IITerm2Payload with a custom toString method");return`${o}1337;${t.toString()}${m}`},"iTerm2");export{I as IT2_AUTO,g as ITerm2File,y as ITerm2FileEnd,O as ITerm2FilePart,P as ITerm2MultipartFileStart,T as iTerm2,c as it2Cells,s as it2Percent,S as it2Pixels};