docs(docs): make permission examples executable

Author: DR-Univer

packages/docs/src/controllers/__tests__/doc-permission.controller.spec.ts

@@ -124,8 +124,9 @@ describe('DocPermissionController', () => {
 
     it('uses section and paragraph ids as hierarchical edit boundaries', async () => {
         const firstSection = document.getSection(0)!;
-        const firstParagraph = document.getParagraph('paragraph-one')!;
+        const firstParagraph = document.getParagraphs()[0];
         const secondParagraph = document.getParagraph('paragraph-two')!;
+        if (!firstParagraph) throw new Error('Paragraph not found.');
 
         await firstSection.getPermission().setReadOnly();
 
@@ -206,9 +207,11 @@ describe('DocPermissionController', () => {
         univer = testBed.univer;
         get = testBed.get;
         document = testBed.univerAPI.getActiveDocument()!;
-        await document.getEntityPermission('', 'drawing', 'drawing-one').setEditable(false);
+        const drawingId = document.getDocumentDataModel().getSnapshot().drawingsOrder?.[0];
+        if (!drawingId) throw new Error('Drawing not found.');
+        await document.getEntityPermission('', 'drawing', drawingId).setReadOnly();
         const actions = JSONX.getInstance().replaceOp(
-            ['drawings', 'drawing-one', 'docTransform', 'angle'],
+            ['drawings', drawingId, 'docTransform', 'angle'],
             0,
             15
         );
@@ -219,7 +222,7 @@ describe('DocPermissionController', () => {
             actions,
             textRanges: [],
         })).toBe(false);
-        expect(document.getDocumentDataModel().getSnapshot().drawings?.['drawing-one'].docTransform?.angle).toBe(0);
+        expect(document.getDocumentDataModel().getSnapshot().drawings?.[drawingId].docTransform?.angle).toBe(0);
     });
 
     it('enforces paragraph permission on direct RichText mutations used by paste and undo/redo', async () => {

packages/docs/src/facade/f-document-permission.ts

@@ -150,7 +150,7 @@ export class FDocumentObjectPermission {
      * @example Restore editing for a paragraph
      * ```ts
      * const document = univerAPI.getActiveDocument();
-     * const paragraph = document?.getParagraph('paragraph-1');
+     * const paragraph = document?.getParagraphs()[0];
      * if (!paragraph) throw new Error('Paragraph not found.');
      * await paragraph.getPermission().setEditable();
      * ```

packages/docs/src/facade/f-document.ts

@@ -207,11 +207,14 @@ export class FDocument extends FBaseInitialable {
      * @param {string} entityType Stable entity type used by the owning Doc feature.
      * @param {string} entityId Stable entity id.
      * @returns {FDocumentObjectPermission} Effective permission facade for the entity.
-     * @example Make one table read-only
+     * @example Make one drawing read-only
      * ```ts
      * const document = univerAPI.getActiveDocument();
      * if (!document) throw new Error('No active Document.');
-     * await document.getEntityPermission('', 'table', 'table-1').setReadOnly();
+     * const snapshot = document.getDocumentDataModel().getSnapshot();
+     * const drawingId = snapshot.drawingsOrder?.[0];
+     * if (!drawingId) throw new Error('Drawing not found.');
+     * await document.getEntityPermission('', 'drawing', drawingId).setReadOnly();
      * ```
      */
     getEntityPermission(segmentId: string, entityType: string, entityId: string): FDocumentObjectPermission {