@samva/markup 0.8.0 → 0.10.0

package/dist/edit.d.ts

@@ -0,0 +1,234 @@
+import { i as completeJsxSourceLocation, n as JsxSource, r as JsxSourceLocation, t as JSX_SOURCE_LOCATION_PROP } from "./source-locations-C8wCsiAy.js";
+import { n as WhatsAppCategory, r as WhatsAppHeaderType, t as SmsCategory } from "./channel-specs-C2feJwuP.js";
+//#region src/source-edit.d.ts
+/** One exact source replacement; before text guards against concurrent changes. */
+interface SourceReplacement {
+  readonly start: number;
+  readonly end: number;
+  readonly before: string;
+  readonly after: string;
+}
+type SourceEditResult = {
+  readonly ok: true;
+  readonly source: string;
+} | {
+  readonly ok: false;
+  readonly reason: string;
+};
+interface SourceProperty {
+  readonly name: string;
+  readonly kind: "literal" | "binding" | "computed";
+  readonly value: string;
+  readonly literalType: "string" | "number" | "boolean";
+  readonly start: number;
+  readonly end: number;
+  readonly syntax: "attribute" | "child" | "value";
+}
+interface SourceElement {
+  readonly start: number;
+  readonly end: number;
+  readonly contentStart: number | null;
+  readonly contentEnd: number | null;
+  readonly tag: string;
+  readonly attributeInsertion: number;
+  readonly hasSpread: boolean;
+  readonly properties: readonly SourceProperty[];
+  readonly structural: boolean;
+  /** The JSX element sibling directly before / after this one, when both share a JSX parent. */
+  readonly previous: SourceRange | null;
+  readonly next: SourceRange | null;
+}
+interface SourceRange {
+  readonly start: number;
+  readonly end: number;
+}
+/** Resolve a renderer origin against the unchanged authored entry, never against HTML offsets. */
+declare const inspectSourceElement: (source: string, file: string, origin: JsxSourceLocation) => SourceElement | null;
+/** Literal controls cannot overwrite a binding or computed expression. */
+declare const literalReplacement: (source: string, field: SourceProperty, value: string) => SourceReplacement | null;
+/** Explicit expression changes are proposals: callers show before/after and require Apply. */
+declare const expressionReplacement: (source: string, field: SourceProperty, expression: string) => SourceReplacement;
+/**
+ * Where an edited file sits in its template project. Every edit of a template is checked against
+ * the static profile: one that would leave it is refused, so a visual edit can never produce a
+ * template the compiler rejects.
+ */
+interface ProfileGuard {
+  /** The template entry the profile check reads. */
+  readonly entry: string;
+  /** The file the edit changes; the entry when omitted. A partial names itself here. */
+  readonly file?: string | undefined;
+  /** The project's other files, when the edited file is not the entry. */
+  readonly files?: Readonly<Record<string, string>> | undefined;
+}
+interface ApplyOptions {
+  readonly profile?: ProfileGuard | undefined;
+}
+/** Apply exact, nonoverlapping edits and refuse syntax damage without changing the original. */
+declare const applySourceReplacements: (source: string, edits: readonly SourceReplacement[], options?: ApplyOptions) => SourceEditResult;
+type SourceProposal = {
+  readonly ok: true;
+  readonly edits: readonly SourceReplacement[];
+} | {
+  readonly ok: false;
+  readonly reason: string;
+};
+/** Structural edits name a whole authored block; loop iterations are never source nodes. */
+declare const structuralReplacements: (source: string, element: SourceElement, operation: {
+  readonly kind: "delete";
+} | {
+  readonly kind: "duplicate";
+} | {
+  readonly kind: "reorder";
+  readonly direction: "before" | "after";
+} | {
+  readonly kind: "insert";
+  readonly tsx: string;
+} | {
+  readonly kind: "move";
+  readonly destination: SourceElement;
+}) => readonly SourceReplacement[] | null;
+interface SourceFixture {
+  readonly name: string;
+  readonly start: number;
+  readonly end: number;
+  readonly source: string;
+}
+/** Declared fixture values are separate source targets from body bindings and literals. */
+declare const inspectSourceFixtures: (source: string) => readonly SourceFixture[];
+type ClassNameOperation = {
+  readonly kind: "set";
+  readonly value: string;
+} | {
+  readonly kind: "add";
+  readonly tokens: string;
+} | {
+  readonly kind: "remove";
+  readonly tokens: string;
+};
+/**
+ * Edit an element's class list where it is written. A literal `className` is replaced, extended or
+ * trimmed in place; a missing one is added; one that is a condition or any other expression is
+ * refused, because rewriting it would discard the choice the author encoded.
+ */
+declare const classNameEdit: (source: string, element: SourceElement, operation: ClassNameOperation) => SourceProposal;
+//#endregion
+//#region src/channel-edit.d.ts
+/** A run of body text between two locked segments. It is empty when nothing sits between them. */
+interface TextSegment {
+  readonly kind: "text";
+  readonly text: string;
+  /** The source range the text is written back over. */
+  readonly start: number;
+  readonly end: number;
+}
+/** An expression, conditional or element the form does not edit, kept as authored. */
+interface LockedSegment {
+  readonly kind: "locked";
+  /** The authored source, shortened for display. */
+  readonly summary: string;
+  readonly start: number;
+  readonly end: number;
+}
+type ChannelSegment = TextSegment | LockedSegment;
+/** How an attribute appears on an element. Only a literal is editable. */
+type AttributeState = {
+  readonly kind: "absent";
+} | {
+  readonly kind: "literal";
+  readonly value: string;
+} | {
+  readonly kind: "expression";
+  readonly source: string;
+};
+interface SmsChannelForm {
+  readonly category: AttributeState;
+  readonly segments: readonly ChannelSegment[];
+  /** The input fields the body reads, as dotted paths. */
+  readonly variables: readonly string[];
+}
+type WhatsAppButtonKind = "quick-reply" | "url" | "phone" | "copy-code";
+type WhatsAppButtonRow = {
+  readonly kind: "editable";
+  readonly type: WhatsAppButtonKind;
+  /** The label, or the copied code for a copy-code button. */
+  readonly text: string;
+  readonly url: AttributeState;
+  readonly phone: AttributeState;
+} | {
+  /** A conditional, or a button whose label reads the input. */
+  readonly kind: "locked";
+  readonly summary: string;
+};
+interface WhatsAppChannelForm {
+  readonly name: AttributeState;
+  readonly language: AttributeState;
+  readonly category: AttributeState;
+  /** Null when the template has no header. */
+  readonly header: readonly ChannelSegment[] | null;
+  readonly headerType: AttributeState;
+  readonly body: readonly ChannelSegment[];
+  /** Null when the template has no footer. */
+  readonly footer: readonly ChannelSegment[] | null;
+  readonly buttons: readonly WhatsAppButtonRow[];
+  readonly variables: readonly string[];
+}
+type ChannelEditResult = {
+  readonly ok: true;
+  readonly edits: readonly SourceReplacement[];
+} | {
+  readonly ok: false;
+  readonly reason: string;
+};
+type SmsEdit = {
+  readonly kind: "category";
+  readonly value: SmsCategory | undefined;
+} | {
+  readonly kind: "text";
+  readonly segment: number;
+  readonly text: string;
+};
+type WhatsAppPart = "header" | "body" | "footer";
+type WhatsAppEdit = {
+  readonly kind: "attribute";
+  readonly name: "name" | "language" | "category";
+  readonly value: string | undefined;
+} | {
+  readonly kind: "headerType";
+  readonly value: WhatsAppHeaderType;
+} | {
+  readonly kind: "text";
+  readonly part: WhatsAppPart;
+  readonly segment: number;
+  readonly text: string;
+} | {
+  readonly kind: "buttonText";
+  readonly button: number;
+  readonly text: string;
+} | {
+  readonly kind: "buttonAttribute";
+  readonly button: number;
+  readonly name: "url" | "phone";
+  readonly value: string;
+} | {
+  readonly kind: "buttonType";
+  readonly button: number;
+  readonly type: WhatsAppButtonKind;
+} | {
+  readonly kind: "buttonAdd";
+  readonly type: WhatsAppButtonKind;
+} | {
+  readonly kind: "buttonRemove";
+  readonly button: number;
+};
+/** The form model of the template's SMS body, or null when it is not a `<Sms>` written in place. */
+declare const readSmsChannel: (source: string) => SmsChannelForm | null;
+/** The source replacements that apply one form change to the SMS body. */
+declare const editSmsChannel: (source: string, edit: SmsEdit) => ChannelEditResult;
+/** The form model of the template's WhatsApp body, or null when it is not a `<WhatsApp>` written in place. */
+declare const readWhatsAppChannel: (source: string) => WhatsAppChannelForm | null;
+/** The source replacements that apply one form change to the WhatsApp body. */
+declare const editWhatsAppChannel: (source: string, edit: WhatsAppEdit) => ChannelEditResult;
+//#endregion
+export { ApplyOptions, AttributeState, ChannelEditResult, ChannelSegment, ClassNameOperation, JSX_SOURCE_LOCATION_PROP, JsxSource, JsxSourceLocation, LockedSegment, ProfileGuard, type SmsCategory, SmsChannelForm, SmsEdit, SourceEditResult, SourceElement, SourceFixture, SourceProperty, SourceProposal, SourceRange, SourceReplacement, TextSegment, WhatsAppButtonKind, WhatsAppButtonRow, type WhatsAppCategory, WhatsAppChannelForm, WhatsAppEdit, type WhatsAppHeaderType, WhatsAppPart, applySourceReplacements, classNameEdit, completeJsxSourceLocation, editSmsChannel, editWhatsAppChannel, expressionReplacement, inspectSourceElement, inspectSourceFixtures, literalReplacement, readSmsChannel, readWhatsAppChannel, structuralReplacements };
+//# sourceMappingURL=edit.d.ts.map