layoutbridge-spm 0.0.1 → 1.0.0

package/indesign/commands/72-place-text.js

@@ -0,0 +1,366 @@
+/* Wunschliste J2 Nr. 15 (Sitzung 7) – Manuskript einfliessen lassen: place_text_file. */
+
+/* Namen aller Absatzformate (auch in Gruppen) als Nachschlagetabelle. */
+function idcParagraphStyleNames(doc) {
+  var names = {};
+  var all, i;
+  try {
+    all = doc.allParagraphStyles;
+    for (i = 0; i < all.length; i++) { names[String(all[i].name)] = true; }
+  } catch (e) { /* leer */ }
+  return names;
+}
+
+/* Vorgaben eines Einstellungsobjekts merken, setzen und zurueckstellen. */
+function idcWithPreferences(ctx, prefs, values, fn) {
+  var saved = {};
+  var key;
+  if (prefs === null || prefs === undefined) { return fn(); }
+  for (key in values) {
+    if (!IDC.hasOwn(values, key) || values[key] === null || values[key] === undefined) { continue; }
+    try { saved[key] = prefs[key]; } catch (e0) { continue; }
+    try { prefs[key] = values[key]; } catch (e1) { ctx.warn('Could not set import preference ' + key + ': ' + String(e1.message ? e1.message : e1)); }
+  }
+  try {
+    return fn();
+  } finally {
+    for (key in saved) {
+      if (IDC.hasOwn(saved, key)) {
+        try { prefs[key] = saved[key]; } catch (e2) { ctx.warn('Could not restore import preference ' + key + '.'); }
+      }
+    }
+  }
+}
+
+IDC.register('place_text_file', { needs_document: true, read_only: false, ruler: 'none' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var found = idcTextFrameArg(doc, args, 'frame_id');
+    var frame = found.item;
+    var story = idcStoryOf(frame);
+    var path = args.file_path;
+    var mode = args.mode === undefined || args.mode === null ? 'replace' : args.mode;
+    var retain = args.retain_formatting === true;
+    var styleMap = args.style_map === undefined || args.style_map === null ? null : args.style_map;
+    var styleName = args.paragraph_style === undefined || args.paragraph_style === null ? null : args.paragraph_style;
+    var typographersQuotes = args.typographers_quotes !== false;
+    var file, ext, isWord, isText, lengthBefore = 0, lengthAfter = 0, insertAt, namesBefore, namesAfter, added = [];
+    var key, target, targetStyle, targets = {}, mapped = {}, placedRange, paragraphs, i, p, name, count = 0, insertion;
+
+    if (typeof path !== 'string' || path === '') {
+      IDC.fail('invalid_argument', 'file_path is required: a .docx, .doc, .rtf or .txt file on the machine running InDesign.', null);
+    }
+    if (mode !== 'replace' && mode !== 'append') {
+      IDC.fail('invalid_argument', 'mode must be replace (default) or append.', { mode: mode });
+    }
+    var autoflow = args.autoflow === true;
+    var maxPages = idcCountArg(args.max_pages, 'max_pages', 1, 200, 20);
+    /* Sitzung 10 (Demo-Heft-Befund 1): der Autofluss springt auf die neue Seite; Ansicht merken. */
+    var keepView = idcKeepViewArg(args);
+    var view = null, viewRestored = null;
+    ext = (path.match(/\.([A-Za-z0-9]+)$/) || ['', ''])[1].toLowerCase();
+    isWord = ext === 'docx' || ext === 'doc' || ext === 'rtf';
+    isText = ext === 'txt' || ext === 'text' || ext === 'md';
+    if (!isWord && !isText) {
+      IDC.fail('invalid_argument', 'file_path must end in .docx, .doc, .rtf or .txt (got .' + ext + ').', { file_path: path });
+    }
+    file = IDC.fileFor(path);
+    if (!file.exists) {
+      IDC.fail('not_found', 'File not found: ' + path, { file_path: path });
+    }
+    if (IDC.fileSize(file) === 0) {
+      IDC.fail('io_error', 'File is empty (0 bytes) – a cloud placeholder that is not downloaded yet? ' + path, { file_path: path });
+    }
+    if (styleMap !== null) {
+      if (typeof styleMap !== 'object' || IDC.isArray(styleMap)) {
+        IDC.fail('invalid_argument', 'style_map must be an object { "Word style name": "InDesign style name" }.', null);
+      }
+      for (key in styleMap) {
+        if (!IDC.hasOwn(styleMap, key)) { continue; }
+        target = styleMap[key];
+        if (typeof target !== 'string' || target === '') {
+          IDC.fail('invalid_argument', 'style_map values must be style names.', { key: key, value: target });
+        }
+        targetStyle = IDC.paragraphStyleByName(doc, target);
+        if (targetStyle === null) {
+          IDC.fail('not_found', 'Paragraph style "' + target + '" (target of style_map "' + key + '") does not exist.', { style_name: target });
+        }
+        targets[key] = targetStyle;
+      }
+      retain = true;
+    }
+    if (styleName !== null) {
+      targetStyle = IDC.paragraphStyleByName(doc, styleName);
+      if (targetStyle === null) {
+        IDC.fail('not_found', 'Paragraph style "' + styleName + '" not found.', { style_name: styleName });
+      }
+    }
+
+    try { lengthBefore = Number(story.characters.length); } catch (e0) { lengthBefore = 0; }
+    namesBefore = idcParagraphStyleNames(doc);
+
+    if (mode === 'replace' && lengthBefore > 0) {
+      try { story.contents = ''; } catch (e1) {
+        IDC.fail('script_error', 'Could not clear the story before placing: ' + String(e1.message ? e1.message : e1), { frame_id: args.frame_id });
+      }
+      lengthBefore = 0;
+    }
+    insertAt = lengthBefore;
+
+    var wordValues = {
+      removeFormatting: !retain,
+      preserveLocalOverrides: retain,
+      importUnusedStyles: false,
+      useTypographersQuotes: typographersQuotes,
+      preserveGraphics: false,
+      preserveTrackChanges: false,
+      importFootnotes: true,
+      importEndnotes: true,
+      importIndex: false,
+      importTOC: false
+    };
+    if (typeof ResolveStyleClash !== 'undefined') {
+      wordValues.resolveParagraphStyleClash = ResolveStyleClash.RESOLVE_CLASH_USE_EXISTING;
+      wordValues.resolveCharacterStyleClash = ResolveStyleClash.RESOLVE_CLASH_USE_EXISTING;
+    }
+    if (typeof ConvertPageBreaks !== 'undefined') { wordValues.convertPageBreaks = ConvertPageBreaks.NONE; }
+    var textValues = { useTypographersQuotes: typographersQuotes, stripReturnsBetweenLines: false, stripReturnsBetweenParagraphs: false };
+    if (typeof TextImportCharacterSet !== 'undefined') { textValues.characterSet = TextImportCharacterSet.UTF8; }
+
+    var prefs = null;
+    try { prefs = isWord ? app.wordRTFImportPreferences : app.textImportPreferences; } catch (e2) { prefs = null; }
+
+    idcWithPreferences(ctx, prefs, isWord ? wordValues : textValues, function () {
+      try {
+        insertion = story.insertionPoints.item(story.insertionPoints.length - 1);
+        placedRange = insertion.place(file);
+      } catch (e3) {
+        IDC.fail('io_error', 'InDesign could not place ' + path + ': ' + String(e3.message ? e3.message : e3), { file_path: path, frame_id: args.frame_id });
+      }
+    });
+
+    try { lengthAfter = Number(story.characters.length); } catch (e4) { lengthAfter = lengthBefore; }
+    namesAfter = idcParagraphStyleNames(doc);
+    for (name in namesAfter) {
+      if (IDC.hasOwn(namesAfter, name) && !namesBefore[name]) { added.push(name); }
+    }
+
+    /* Absatzformate: erst die Zuordnung Word -> Haus, dann ein Format ueber alles Platzierte. */
+    /*
+     * Ueber story.paragraphs mit Zeichenzaehlung – characters.itemByRange(...)
+     * .paragraphs lieferte am lebenden InDesign 21.5 eine leere Sammlung
+     * (Live-Fund 05.09.2026), deshalb wurde nichts zugeordnet.
+     */
+    try {
+      if (lengthAfter > insertAt) {
+        paragraphs = story.paragraphs;
+        var position = 0, plen;
+        for (i = 0; i < paragraphs.length; i++) {
+          p = paragraphs.item(i);
+          try { plen = Number(p.characters.length); } catch (ep) { plen = 0; }
+          if (position + plen <= insertAt) { position += plen; continue; }
+          position += plen;
+          count += 1;
+          if (styleMap !== null) {
+            name = idcParagraphStyleName(p);
+            if (name !== null && IDC.hasOwn(targets, name)) {
+              p.appliedParagraphStyle = targets[name];
+              mapped[name] = (mapped[name] || 0) + 1;
+            }
+          }
+          if (styleName !== null) { p.appliedParagraphStyle = targetStyle; }
+        }
+      }
+    } catch (e5) {
+      ctx.warn('The text was placed, but the paragraph styles could not be applied: ' + String(e5.message ? e5.message : e5));
+    }
+
+    /*
+     * Zugeordnete Word-Formate wieder entfernen: sie kamen erst mit diesem
+     * Import und sind nach der Zuordnung an keinem Absatz mehr in Gebrauch.
+     * remove(ersatz) haengt eventuelle Reste an das Zielformat.
+     */
+    var removed = [];
+    if (styleMap !== null) {
+      var remaining = [];
+      for (i = 0; i < added.length; i++) {
+        name = added[i];
+        if (IDC.hasOwn(targets, name)) {
+          try {
+            var stray = IDC.paragraphStyleByName(doc, name);
+            if (stray !== null) { stray.remove(targets[name]); removed.push(name); continue; }
+          } catch (e8) { ctx.warn('Imported style "' + name + '" could not be removed: ' + String(e8.message ? e8.message : e8)); }
+        }
+        remaining.push(name);
+      }
+      added = remaining;
+    }
+
+    var overset = null;
+    try {
+      var containers = story.textContainers;
+      overset = containers[containers.length - 1].overflows === true;
+    } catch (e6) { try { overset = story.overflows === true; } catch (e7) { overset = null; } }
+    var flow = null;
+    if (overset === true && autoflow) {
+      if (keepView) { view = idcCaptureView(doc); }
+      flow = idcAutoflow(ctx, doc, story, maxPages);
+      overset = flow.overset;
+      if (view !== null) { viewRestored = view.window === null ? null : idcRestoreView(view); }
+    }
+    if (overset === true) {
+      ctx.warn('The story overflows (Uebersatz) after placing – ' + (autoflow ? 'autoflow stopped at max_pages ' + maxPages + '; raise it or shorten the text.' : 'thread more frames, pass autoflow true, or shorten the text.'));
+    }
+    if (added.length > 0) {
+      ctx.warn('The import added ' + added.length + ' paragraph style(s): ' + added.join(', ') + '.');
+    }
+
+    ctx.changes = { modified_frame_ids: [Number(frame.id)], modified_story_ids: [Number(story.id)] };
+    if (flow !== null && flow.frames_added.length > 0) {
+      ctx.changes.created_frame_ids = [];
+      ctx.changes.created_page_ids = [];
+      for (i = 0; i < flow.frames_added.length; i++) { ctx.changes.created_frame_ids.push(flow.frames_added[i].frame_id); }
+      for (i = 0; i < flow.pages_added.length; i++) { ctx.changes.created_page_ids.push(flow.pages_added[i].page_id); }
+    }
+    return {
+      frame_id: Number(frame.id),
+      story_id: Number(story.id),
+      file_name: String(path).replace(/^.*[\/\\]/, ''),
+      mode: mode,
+      retain_formatting: retain,
+      placed_start_index: insertAt,
+      placed_end_index: lengthAfter,
+      inserted_chars: lengthAfter - insertAt,
+      story_length: lengthAfter,
+      paragraph_count: count,
+      styles_added: added,
+      styles_mapped: mapped,
+      styles_removed: removed,
+      paragraph_style_applied: styleName,
+      overset: overset,
+      autoflow: flow,
+      view_restored: viewRestored
+    };
+  });
+
+/*
+ * Autoflow: solange die Story ueberlaeuft, hinter der Seite des letzten
+ * Rahmens eine Seite (gleiche Musterseite) anlegen, darauf einen Rahmen mit
+ * den Massen und Rahmenoptionen des letzten anlegen und verketten.
+ */
+function idcAutoflow(ctx, doc, story, maxPages) {
+  var out = { pages_added: [], frames_added: [], overset: true, stopped: '' };
+  var round, containers, last, page, rect, newPage, newFrame, prefsCopied, copied;
+  for (round = 0; round < maxPages; round++) {
+    try {
+      containers = story.textContainers;
+      last = IDC.concrete(containers[containers.length - 1]);
+    } catch (e0) { out.stopped = 'last frame unreadable'; return out; }
+    try { if (last.overflows !== true) { out.overset = false; out.stopped = 'fits'; return out; } } catch (e1) { /* weiter */ }
+    page = null;
+    try { page = last.parentPage; } catch (e2) { page = null; }
+    if (page === null || page === undefined || page.isValid !== true) {
+      IDC.fail('invalid_state', 'Autoflow needs the last frame on a document page (it lies on the pasteboard or a parent page).', null);
+    }
+    if (IDC.isOnParentSpread(last)) {
+      IDC.fail('invalid_state', 'Autoflow does not run on parent pages.', null);
+    }
+    rect = IDC.boundsOnPage(doc, last, page);
+    try {
+      newPage = doc.pages.add(LocationOptions.AFTER, page);
+    } catch (e3) {
+      IDC.fail('script_error', 'Autoflow could not add a page: ' + String(e3.message ? e3.message : e3), null);
+    }
+    try {
+      if (page.appliedMaster && page.appliedMaster.isValid === true) { newPage.appliedMaster = page.appliedMaster; }
+    } catch (e4) { /* Vorgabe bleibt */ }
+    newFrame = idcAddItem(doc, newPage, 'textFrames', idcRectToBounds(rect), 'page');
+    /*
+     * Rahmenoptionen einzeln kopieren (Demo-Heft-Befund 4, 05.09.2026): die
+     * Zuweisung von textFramePreferences.properties liess am lebenden
+     * InDesign die Spalten des Ausgangsrahmens weg (neuer Rahmen einspaltig).
+     */
+    copied = idcCopyTextFramePreferences(last, newFrame);
+    prefsCopied = copied.failed.length === 0;
+    try { newFrame.itemLayer = last.itemLayer; } catch (e6) { /* aktive Ebene */ }
+    try {
+      last.nextTextFrame = newFrame;
+    } catch (e7) {
+      IDC.fail('script_error', 'Autoflow could not thread the new frame: ' + String(e7.message ? e7.message : e7), { page_id: Number(newPage.id) });
+    }
+    out.pages_added.push({ page_id: Number(newPage.id), page_name: String(newPage.name) });
+    out.frames_added.push({
+      frame_id: Number(newFrame.id),
+      page_id: Number(newPage.id),
+      bounds_mm: rect,
+      frame_options_copied: prefsCopied,
+      frame_options_failed: copied.failed,
+      frame_options_skipped: copied.skipped,
+      columns: idcReadColumnsOf(newFrame)
+    });
+  }
+  try {
+    containers = story.textContainers;
+    last = IDC.concrete(containers[containers.length - 1]);
+    out.overset = last.overflows === true;
+  } catch (e8) { out.overset = true; }
+  out.stopped = out.overset ? 'max_pages' : 'fits';
+  return out;
+}
+
+/*
+ * Rahmenoptionen eines Textrahmens auf einen anderen uebertragen – Wert fuer
+ * Wert, in der Reihenfolge, die InDesign verlangt (erst die Spaltenart, dann
+ * Zahl, Steg und feste Breite). Liefert copied[] und failed[] (Eigenschaft
+ * samt Meldung); Eigenschaften, die die Laufzeit nicht kennt, zaehlen nicht.
+ */
+/* Adobe-DOM TextFramePreference (geprueft 05.09.2026): alle schreibbar. Automatische Groesse und Spaltenlinien bleiben Vorgabe. */
+var IDC_TEXT_FRAME_PREFS = [
+  'useFixedColumnWidth', 'useFlexibleColumnWidth', 'textColumnCount', 'textColumnGutter', 'textColumnFixedWidth',
+  'textColumnMaxWidth', 'insetSpacing', 'verticalJustification', 'verticalThreshold', 'firstBaselineOffset',
+  'minimumFirstBaselineOffset', 'ignoreWrap', 'verticalBalanceColumns'
+];
+
+function idcCopyTextFramePreferences(source, target) {
+  var out = { copied: [], skipped: [], failed: [] };
+  var from, to, i, key, value, justified = false, fixedWidth = false, flexibleWidth = false;
+  try { from = source.textFramePreferences; to = target.textFramePreferences; } catch (e0) {
+    out.failed.push({ property: 'textFramePreferences', message: String(e0.message ? e0.message : e0) });
+    return out;
+  }
+  /*
+   * Live-Fund 05.09.2026: verticalThreshold laesst sich nur setzen, wenn der
+   * Rahmen vertikal im Blocksatz steht ("Diese Eigenschaft ist im aktuellen
+   * Status nicht zutreffend."); die festen/flexiblen Spaltenbreiten gelten nur
+   * bei der jeweiligen Spaltenart. Was nicht zutrifft, wird uebersprungen.
+   */
+  try { justified = typeof VerticalJustification !== 'undefined' && IDC.enumIs(from.verticalJustification, VerticalJustification.JUSTIFY_ALIGN); } catch (ej) { justified = false; }
+  try { fixedWidth = from.useFixedColumnWidth === true; } catch (ef) { fixedWidth = false; }
+  try { flexibleWidth = from.useFlexibleColumnWidth === true; } catch (ex) { flexibleWidth = false; }
+  for (i = 0; i < IDC_TEXT_FRAME_PREFS.length; i++) {
+    key = IDC_TEXT_FRAME_PREFS[i];
+    if ((key === 'verticalThreshold' && !justified) || (key === 'textColumnFixedWidth' && !fixedWidth) || (key === 'textColumnMaxWidth' && !flexibleWidth)) {
+      out.skipped.push(key);
+      continue;
+    }
+    try { value = from[key]; } catch (e1) { continue; }
+    if (value === undefined) { continue; }
+    if (IDC.isArray(value)) { value = value.slice(0); }
+    try {
+      to[key] = value;
+      out.copied.push(key);
+    } catch (e2) {
+      out.failed.push({ property: key, message: String(e2.message ? e2.message : e2) });
+    }
+  }
+  return out;
+}
+
+/* Spalten eines Textrahmens zum Gegenlesen: {count, gutter_mm}. */
+function idcReadColumnsOf(frame) {
+  var out = { count: null, gutter_mm: null };
+  try { out.count = Number(frame.textFramePreferences.textColumnCount); } catch (e0) { /* bleibt null */ }
+  try { out.gutter_mm = IDC.round(Number(frame.textFramePreferences.textColumnGutter)); } catch (e1) { /* bleibt null */ }
+  return out;
+}

package/indesign/commands/74-stories.js

@@ -0,0 +1,116 @@
+/* Wunschliste J Nr. 10 (Sitzung 8) – Story-Uebersicht: list_stories. */
+
+function idcStoryFrames(doc, story) {
+  var out = [], containers, i, frame, landing, entry;
+  try { containers = story.textContainers; } catch (e0) { containers = null; }
+  if (containers === null || containers === undefined) { return out; }
+  for (i = 0; i < containers.length; i++) {
+    try { frame = IDC.concrete(containers[i]); } catch (e1) { continue; }
+    landing = IDC.landing(frame);
+    entry = {
+      frame_id: null,
+      index: i,
+      page_id: landing.page_id,
+      page_name: landing.page_name,
+      on_pasteboard: landing.on_pasteboard,
+      on_parent_page: IDC.isOnParentSpread(frame),
+      class_name: IDC.className(frame),
+      bounds_mm: null
+    };
+    try { entry.frame_id = Number(frame.id); } catch (e2) { /* null */ }
+    try { entry.bounds_mm = idcItemBounds(doc, frame); } catch (e3) { entry.bounds_mm = null; }
+    out.push(entry);
+  }
+  return out;
+}
+
+function idcStoryOverset(story, frames) {
+  var last;
+  try { if (story.overflows === true) { return true; } } catch (e0) { /* weiter */ }
+  try {
+    last = story.textContainers[story.textContainers.length - 1];
+    if (last && last.overflows === true) { return true; }
+  } catch (e1) { /* unbekannt */ }
+  return frames.length === 0 ? null : false;
+}
+
+function idcDescribeStory(doc, story, snippetChars) {
+  var frames = idcStoryFrames(doc, story);
+  var ids = [], i;
+  var out = {
+    story_id: null,
+    frame_ids: ids,
+    frame_count: frames.length,
+    frames: frames,
+    character_count: null,
+    paragraph_count: null,
+    table_count: null,
+    overset: idcStoryOverset(story, frames),
+    on_parent_page: frames.length > 0 ? frames[0].on_parent_page : false,
+    first_page_id: frames.length > 0 ? frames[0].page_id : null,
+    first_page_name: frames.length > 0 ? frames[0].page_name : '',
+    first_paragraph_style: null,
+    snippet: ''
+  };
+  for (i = 0; i < frames.length; i++) { ids.push(frames[i].frame_id); }
+  try { out.story_id = Number(story.id); } catch (e0) { /* null */ }
+  try { out.character_count = Number(story.characters.length); } catch (e1) { /* null */ }
+  try { out.paragraph_count = Number(story.paragraphs.length); } catch (e2) { /* null */ }
+  try { out.table_count = Number(story.tables.length); } catch (e3) { /* null */ }
+  try {
+    if (out.paragraph_count !== null && out.paragraph_count > 0) {
+      out.first_paragraph_style = idcParagraphStyleName(story.paragraphs.item(0));
+    }
+  } catch (e4) { out.first_paragraph_style = null; }
+  try { out.snippet = idcSnippet(story.contents, snippetChars); } catch (e5) { out.snippet = ''; }
+  return out;
+}
+
+IDC.register('list_stories', { needs_document: true, read_only: true, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var includeParents = args.include_parent_pages === true;
+    var includeEmpty = args.include_empty !== false;
+    var snippetChars = idcCountArg(args.snippet_chars, 'snippet_chars', 0, 2000, 80);
+    var pageId = args.page_id === undefined || args.page_id === null ? null : args.page_id;
+    var out = [], i, j, story, entry, oversetCount = 0, parentsSkipped = 0, emptySkipped = 0, total = 0, onPage;
+
+    if (pageId !== null && (typeof pageId !== 'number' || Math.floor(pageId) !== pageId)) {
+      IDC.fail('invalid_argument', 'page_id must be a whole number.', { page_id: pageId });
+    }
+    if (pageId !== null && IDC.pageById(doc, pageId) === null) {
+      IDC.fail('not_found', 'No page with page_id ' + pageId + ' in this document.', { page_id: pageId });
+    }
+
+    try { total = Number(doc.stories.length); } catch (e0) { total = 0; }
+    for (i = 0; i < total; i++) {
+      try { story = doc.stories.item(i); } catch (e1) { continue; }
+      entry = idcDescribeStory(doc, story, snippetChars);
+      if (entry.on_parent_page && !includeParents) { parentsSkipped += 1; continue; }
+      if (entry.character_count === 0 && !includeEmpty) { emptySkipped += 1; continue; }
+      if (pageId !== null) {
+        onPage = false;
+        for (j = 0; j < entry.frames.length; j++) {
+          if (entry.frames[j].page_id === pageId) { onPage = true; break; }
+        }
+        if (!onPage) { continue; }
+      }
+      if (entry.overset === true) { oversetCount += 1; }
+      out.push(entry);
+    }
+    if (oversetCount > 0) {
+      ctx.warn(oversetCount + ' story/stories overflow (Übersatz) – enlarge the last frame or thread another one.');
+    }
+    return {
+      stories: out,
+      count: out.length,
+      total_stories: total,
+      overset_count: oversetCount,
+      parent_page_stories_skipped: parentsSkipped,
+      empty_stories_skipped: emptySkipped,
+      page_id: pageId,
+      include_parent_pages: includeParents,
+      include_empty: includeEmpty
+    };
+  });