lucid-extension-sdk - npm Package Compare versions

Comparing version 0.0.247 to 0.0.248

commandtypes.d.ts

@@ -73,2 +73,3 @@ import { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
     GetDocumentAccessPermission = "gdap",
+    GetDocumentChunks = "gdc",
     GetDocumentId = "gdid",
@@ -346,2 +347,6 @@ GetElementType = "get",
     };
+    [CommandName.GetDocumentChunks]: {
+        query: GetDocumentChunksQuery;
+        result: GetDocumentChunksResult;
+    };
     [CommandName.GetDocumentId]: {
@@ -1117,2 +1122,25 @@ query: GetDocumentIdQuery;
 export type GetDocumentAccessPermissionResult = DocumentAccessPermission;
+export declare enum GetDocumentChunksType {
+    /**
+     * Breaks up a document into chunks geographically
+     */
+    Geographic = 0,
+    /**
+     * Breaks up a document into chunks by finding containing blocks
+     */
+    Container = 1
+}
+export type GetDocumentChunksQuery = {
+    't': GetDocumentChunksType[];
+};
+export type GetDocumentChunksResult = SerializedDocumentChunk[];
+type SerializedDocumentChunk = {
+    /** Bounding box of all items combined */
+    'bb': Box;
+    /** Ids of the items included in the chunk */
+    'i': string[];
+    't': string;
+    /** Very brief description that helps describe the chunk */
+    'd': string;
+};
 export type GetDocumentIdQuery = void;
@@ -1690,1 +1718,2 @@ export type GetDocumentIdResult = string;
 export type ZOrderResult = undefined;
+export {};

commandtypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.GetDocumentChunksType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
@@ -49,2 +49,3 @@ /** @ignore */
     ["gdap" /* CommandName.GetDocumentAccessPermission */, 'GetDocumentAccessPermission'],
+    ["gdc" /* CommandName.GetDocumentChunks */, 'GetDocumentChunks'],
     ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],
@@ -135,2 +136,13 @@ ["get" /* CommandName.GetElementType */, 'GetElementType'],
 })(HashAlgorithmEnum || (exports.HashAlgorithmEnum = HashAlgorithmEnum = {}));
+var GetDocumentChunksType;
+(function (GetDocumentChunksType) {
+    /**
+     * Breaks up a document into chunks geographically
+     */
+    GetDocumentChunksType[GetDocumentChunksType["Geographic"] = 0] = "Geographic";
+    /**
+     * Breaks up a document into chunks by finding containing blocks
+     */
+    GetDocumentChunksType[GetDocumentChunksType["Container"] = 1] = "Container";
+})(GetDocumentChunksType || (exports.GetDocumentChunksType = GetDocumentChunksType = {}));
 var GetItemsAtSearchType;
@@ -137,0 +149,0 @@ (function (GetItemsAtSearchType) {

document/documentproxy.d.ts

@@ -0,2 +1,4 @@
+import { GetDocumentChunksType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
+import { DocumentChunk } from './documentchunk';
 import { CardConfigProxy } from './documentelement/cardconfigproxy';
@@ -44,2 +46,4 @@ import { RuleProxy } from './documentelement/ruleproxy';
     getTitle(): string;
+    /** @ignore */
+    getDocumentChunks(types: GetDocumentChunksType[]): DocumentChunk[];
     /**
@@ -46,0 +50,0 @@ * Infrequently, you may need to watch for *any* changes to the document. These changes may be

document/documentproxy.js

@@ -8,2 +8,3 @@ "use strict";
 const elementproxy_1 = require("./elementproxy");
+const itemproxy_1 = require("./itemproxy");
 const mapproxy_1 = require("./mapproxy");
@@ -74,2 +75,16 @@ const pageproxy_1 = require("./pageproxy");
     }
+    /** @ignore */
+    getDocumentChunks(types) {
+        const chunks = this.client.sendCommand("gdc" /* CommandName.GetDocumentChunks */, { 't': types });
+        return chunks.map((chunk) => {
+            return {
+                boundingBox: chunk['bb'],
+                items: chunk['i']
+                    .map((id) => this.client.getElementProxy(id))
+                    .filter((element) => element instanceof itemproxy_1.ItemProxy),
+                text: chunk['t'],
+                description: chunk['d'],
+            };
+        });
+    }
     /**
@@ -76,0 +91,0 @@ * Infrequently, you may need to watch for *any* changes to the document. These changes may be

package.json

 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.247",
+    "version": "0.0.248",
     "description": "Utility classes for writing Lucid Software editor extensions",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

747010

increased by0.38%

Number of package files

290

increased by0.69%

Lines of code

17348

increased by0.5%

No dependency changes