lucid-extension-sdk 0.0.247 → 0.0.248

package/commandtypes.d.ts

@@ -70,6 +70,7 @@ export declare const enum CommandName {
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
     GetDocumentAccessPermission = "gdap",
+    GetDocumentChunks = "gdc",
     GetDocumentId = "gdid",
     GetElementType = "get",
     GetEnvironmentConfig = "gec",
@@ -342,6 +343,10 @@ export type CommandArgs = {
         query: GetDocumentAccessPermissionQuery;
         result: GetDocumentAccessPermissionResult;
     };
+    [CommandName.GetDocumentChunks]: {
+        query: GetDocumentChunksQuery;
+        result: GetDocumentChunksResult;
+    };
     [CommandName.GetDocumentId]: {
         query: GetDocumentIdQuery;
         result: GetDocumentIdResult;
@@ -1112,6 +1117,29 @@ export type GetDataItemFieldQuery = {
 export type GetDataItemFieldResult = SerializedFieldType;
 export type GetDocumentAccessPermissionQuery = void;
 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;
 export type GetDocumentIdResult = string;
 export type GetItemPageIdQuery = string;
@@ -1684,3 +1712,4 @@ export type ZOrderQuery = {
     'o': ZOrderOperation;
 };
 export type ZOrderResult = undefined;
+export {};

package/commandtypes.js

@@ -1,6 +1,6 @@
 "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");
 /** @ignore */
 exports.commandTitles = new Map([
@@ -46,6 +46,7 @@ exports.commandTitles = new Map([
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
     ["gdap" /* CommandName.GetDocumentAccessPermission */, 'GetDocumentAccessPermission'],
+    ["gdc" /* CommandName.GetDocumentChunks */, 'GetDocumentChunks'],
     ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gec" /* CommandName.GetEnvironmentConfig */, 'GetEnvironmentConfig'],
@@ -131,6 +132,17 @@ var HashAlgorithmEnum;
     /** Use the SHA 256 hashing algorithm */
     HashAlgorithmEnum["sha256"] = "SHA256";
 })(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;
 (function (GetItemsAtSearchType) {
     GetItemsAtSearchType[GetItemsAtSearchType["PossiblyOverlapping"] = 0] = "PossiblyOverlapping";

package/document/documentchunk.d.ts

@@ -0,0 +1,25 @@
+import { Box } from '../math';
+import { ItemProxy } from './itemproxy';
+/**
+ * @ignore
+ * A representation of separated portions of the document
+ */
+export interface DocumentChunk {
+    /**
+     * THe bounding box of all items combined
+     */
+    boundingBox: Box;
+    /**
+     * Items included in the chunk
+     */
+    items: ItemProxy[];
+    /**
+     * All displayed text in the chunk
+     */
+    text: string;
+    /**
+     * Very brief description that helps describe the chunk. This will be used
+     * as part of the page name when writing to pages.
+     */
+    description: string;
+}

package/document/documentchunk.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/document/documentproxy.d.ts

@@ -1,4 +1,6 @@
+import { GetDocumentChunksType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
+import { DocumentChunk } from './documentchunk';
 import { CardConfigProxy } from './documentelement/cardconfigproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
@@ -41,6 +43,8 @@ export declare class DocumentProxy extends ElementProxy {
      * @returns The title of this document
      */
     getTitle(): string;
+    /** @ignore */
+    getDocumentChunks(types: GetDocumentChunksType[]): DocumentChunk[];
     /**
      * Infrequently, you may need to watch for *any* changes to the document. These changes may be
      * the local user adding content, or a data integration sending updated records to a data collection,

package/document/documentproxy.js

@@ -5,6 +5,7 @@ const cardconfigproxy_1 = require("./documentelement/cardconfigproxy");
 const documentelementtype_1 = require("./documentelement/documentelementtype");
 const ruleproxy_1 = require("./documentelement/ruleproxy");
 const elementproxy_1 = require("./elementproxy");
+const itemproxy_1 = require("./itemproxy");
 const mapproxy_1 = require("./mapproxy");
 const pageproxy_1 = require("./pageproxy");
 /**
@@ -70,6 +71,20 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
     getTitle() {
         return this.properties.get('Title');
     }
+    /** @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'],
+            };
+        });
+    }
     /**
      * Infrequently, you may need to watch for *any* changes to the document. These changes may be
      * the local user adding content, or a data integration sending updated records to a data collection,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.247",
+    "version": "0.0.248",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",