layoutbridge-light 0.0.0-stage → 1.0.0

package/indesign/commands/73-story-lock.js

@@ -0,0 +1,157 @@
+/*
+ * Sitzung 38 (A-22 bis A-25, 02.10.2026) – Sperrstatus verwalteter Stories.
+ *
+ * Beleg: docs/spec/Adobe-DOM-Auszug_InCopy-Sperre_2026-10-02.md –
+ * Story.lockState (LockStateValues, r), Story.itemLink (Link, r),
+ * Link.filePath, Link.parent (kann Story sein). Welcher Wert in welchem Fall
+ * auftritt, ist NICHT belegt; das entscheidet der Integrationstest am Mac.
+ * Deshalb sind alle acht Werte abgebildet und die Sperrregel steht an genau
+ * einer Stelle (idcLockStateBlocksWriting).
+ */
+
+/* LockStateValues: DOM-Name, Zahl laut Adobe-Referenz, Rueckgabewert. */
+var IDC_LOCK_STATES = [
+  ['NONE', 1852796517, 'none'],
+  ['UNMANAGED_STORY', 1112700269, 'unmanaged_story'],
+  ['CHECKED_IN_STORY', 1112695657, 'checked_in_story'],
+  ['CHECKED_OUT_STORY', 1112695663, 'checked_out_story'],
+  ['LOCKED_STORY', 1112697963, 'locked_story'],
+  ['EMBEDDED_STORY', 1112696173, 'embedded_story'],
+  ['MISSING_LOCK_STATE', 1112698227, 'missing_lock_state'],
+  ['MIXED_LOCK_STATE', 1112698232, 'mixed_lock_state']
+];
+
+/* Wert von Story.lockState -> Rueckgabename; unbekannt oder nicht lesbar -> null. */
+function idcLockStateName(value) {
+  var i, entry, known = typeof LockStateValues !== 'undefined' && LockStateValues !== null;
+  if (value === null || value === undefined) { return null; }
+  for (i = 0; i < IDC_LOCK_STATES.length; i++) {
+    entry = IDC_LOCK_STATES[i];
+    if (known) {
+      try { if (IDC.enumIs(value, LockStateValues[entry[0]])) { return entry[2]; } } catch (e0) { /* naechster Weg */ }
+    }
+    if (IDC.enumIs(value, entry[1]) || String(value) === entry[0]) { return entry[2]; }
+  }
+  return null;
+}
+
+function idcStoryLockState(story) {
+  try { return idcLockStateName(story.lockState); } catch (e) { return null; }
+}
+
+/*
+ * DIE Sperrregel (Vorschlag Sascha, 02.10.2026; der Integrationstest kann
+ * sie aendern): schreiben verboten bei allem ausser none, unmanaged_story,
+ * checked_out_story und embedded_story. Nicht lesbar (null) gilt als frei –
+ * sonst sperrte eine InDesign-Fassung ohne lockState jedes Schreiben.
+ */
+function idcLockStateBlocksWriting(state) {
+  return state === 'checked_in_story' || state === 'locked_story' ||
+    state === 'missing_lock_state' || state === 'mixed_lock_state';
+}
+
+/* Verwaltet = an eine Redaktionsdatei gebunden (eingecheckt, ausgecheckt, gesperrt, fehlend, gemischt). */
+function idcLockStateIsManaged(state) {
+  return idcLockStateBlocksWriting(state) || state === 'checked_out_story';
+}
+
+/* Pfad der Redaktionsdatei einer verwalteten Story (wie list_links ihn liest), sonst null. */
+function idcStoryManagedFile(story, state) {
+  var link = null, path;
+  if (!idcLockStateIsManaged(state)) { return null; }
+  try { link = story.itemLink; } catch (e0) { link = null; }
+  if (link === null || link === undefined) { return null; }
+  try { if (link.isValid === false) { return null; } } catch (e1) { /* weiter */ }
+  try { path = String(link.filePath); } catch (e2) { return null; }
+  return path === '' ? null : path;
+}
+
+/* { story_id, lock_state, managed, write_locked, managed_file } einer Story. */
+function idcStoryLockInfo(story) {
+  var state = idcStoryLockState(story);
+  var out = {
+    story_id: null,
+    lock_state: state,
+    managed: idcLockStateIsManaged(state),
+    write_locked: idcLockStateBlocksWriting(state),
+    managed_file: idcStoryManagedFile(story, state)
+  };
+  try { out.story_id = Number(story.id); } catch (e) { out.story_id = null; }
+  return out;
+}
+
+/*
+ * Schreibende Textwerkzeuge (A-23): gesperrte Story -> invalid_state mit
+ * details.code "story_locked", analog zu layer_locked (idcRejectLocked).
+ * Liefert die Sperrangaben, damit Aufrufer sie weiterverwenden koennen.
+ */
+function idcRejectStoryLocked(story, frameId, what) {
+  var info;
+  if (story === null || story === undefined) { return null; }
+  info = idcStoryLockInfo(story);
+  if (!info.write_locked) { return info; }
+  IDC.fail('invalid_state', 'The story of frame ' + frameId + ' is locked (lock_state ' + info.lock_state + ': managed by an editorial workflow and not checked out here); ' +
+    what + ' cannot change it. Check the story out in the editorial system or in InCopy first, then call ' + what + ' again.',
+    { code: 'story_locked', frame_id: frameId, story_id: info.story_id, lock_state: info.lock_state, managed_file: info.managed_file });
+  return info;
+}
+
+/* Story, in der ein verankertes Objekt sitzt (Eltern bis zum Zeichen), sonst null. */
+function idcAnchorStoryOf(item) {
+  var current = item, step, name;
+  for (step = 0; step < 8; step++) {
+    try { current = current.parent; } catch (e0) { return null; }
+    if (current === null || current === undefined) { return null; }
+    name = IDC.className(current);
+    if (name === 'Spread' || name === 'MasterSpread' || name === 'Document') { return null; }
+    if (name === 'Character' || name === 'InsertionPoint' || name === 'Text' || name === 'Story') {
+      if (name === 'Story') { return current; }
+      try { return current.parentStory; } catch (e1) { return null; }
+    }
+  }
+  return null;
+}
+
+/* Story, deren Inhalt ein Objekt traegt: Textrahmen -> eigene Story, verankertes Objekt -> Story des Ankers. */
+function idcContentStoryOf(item) {
+  var story = null;
+  if (IDC.isTextFrame(item)) {
+    try { story = item.parentStory; } catch (e0) { story = null; }
+    return story === undefined ? null : story;
+  }
+  return idcAnchorStoryOf(item);
+}
+
+/* Anzahl verwalteter Stories eines Dokuments (A-22, A-24); nicht lesbar -> null. */
+function idcManagedStoryCount(doc) {
+  var count = 0, i, total;
+  try { total = Number(doc.stories.length); } catch (e0) { return null; }
+  for (i = 0; i < total; i++) {
+    try {
+      if (idcLockStateIsManaged(idcStoryLockState(doc.stories.item(i)))) { count += 1; }
+    } catch (e1) { /* naechste Story */ }
+  }
+  return count;
+}
+
+/* Gesperrte Stories eines Dokuments als Liste der Sperrangaben. */
+function idcWriteLockedStories(doc) {
+  var out = [], i, total, info;
+  try { total = Number(doc.stories.length); } catch (e0) { return out; }
+  for (i = 0; i < total; i++) {
+    try {
+      info = idcStoryLockInfo(doc.stories.item(i));
+      if (info.write_locked) { out.push(info); }
+    } catch (e1) { /* naechste Story */ }
+  }
+  return out;
+}
+
+/* Warnung beim Sichern (A-24): Kopie/Paket nicht an den Redaktions-Workflow gebunden. */
+function idcManagedSaveWarning(ctx, doc, what) {
+  var count = idcManagedStoryCount(doc);
+  if (count === null || count < 1) { return 0; }
+  ctx.warn('The document contains ' + count + ' managed story/stories (linked to an editorial workflow). ' + what +
+    ' Saving here does not replace saving or checking in those stories in the editorial system.');
+  return count;
+}

package/indesign/commands/74-stories.js

@@ -0,0 +1,121 @@
+/* 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: '',
+    lock_state: null,
+    managed_file: null
+  };
+  var lockInfo = idcStoryLockInfo(story);
+  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 = ''; }
+  out.lock_state = lockInfo.lock_state;
+  out.managed_file = lockInfo.managed_file;
+  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
+    };
+  });