lucid-extension-sdk 0.0.440 → 0.0.441

package/commandtypes.d.ts

@@ -53,6 +53,7 @@ export declare const enum CommandName {
     CreateCollection = "cc",
     CreateDataSource = "cds",
     CreateDocumentElement = "cde",
+    CreateGraph = "cgr",
     CreateGroup = "cg",
     CreateLine = "cl",
     CreatePage = "cp",
@@ -282,6 +283,10 @@ export type CommandArgs = {
         query: CreateDocumentElementQuery;
         result: CreateDocumentElementResult;
     };
+    [CommandName.CreateGraph]: {
+        query: CreateGraphQuery;
+        result: CreateGraphResult;
+    };
     [CommandName.CreateGroup]: {
         query: CreateGroupQuery;
         result: CreateGroupResult;
@@ -1196,6 +1201,20 @@ export type CreateGroupQuery = {
     'i': string[];
 };
 export type CreateGroupResult = string;
+export type CreateGraphQuery = {
+    /**
+     * By default, we add the graph to the current page. If specified, the
+     * graph will instead be created as a direct child of the given page.
+     */
+    'p'?: string | undefined;
+    /** Type of graph to create, e.g. 'BarGraphCollectionBlock' or 'LineGraphCollectionBlock' */
+    't': string;
+    /** ID of the collection */
+    'col': string;
+    /** Title of the graph */
+    'ti': string;
+};
+export type CreateGraphResult = Promise<string>;
 export type CreateCollectionFieldDefinition = {
     /** Name of the field */
     'n': string;
@@ -1270,6 +1289,9 @@ export type DataActionQuery = {
     's'?: string | undefined;
     /** Data Connector Name */
     'n': string;
+    /**Requested Primary keys or keys of items we
+     * are requesting info for in the data action */
+    'rpk'?: Record<string, string[]> | undefined;
 };
 export type RawDataActionResult = {
     /** The external service responded with this code */

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -29,6 +29,12 @@ export declare enum FieldDisplayType {
      * Given a URL, display a small image cropped into a square in the lower-left of the card.
      */
     SquareImageBadge = "SquareImageBadge",
+    /**
+     * Displays an icon and value as a badge in the bottom-left of the card. Takes an object containing an iconUrl
+     * and value. If value is a string longer than 20 characters, it will be truncated to be a maximum of 20 chars
+     * appending '...' to the given value. If value is a number higher than 999, displays 999.
+     */
+    TagBadge = "TagBadge",
     /**
      * Given a date, display a small calendar icon alongside a very short version of the date
      * as a string, e.g. "Sep 9"

package/core/cardintegration/cardfielddisplaysettings.js

@@ -34,6 +34,12 @@ var FieldDisplayType;
      * Given a URL, display a small image cropped into a square in the lower-left of the card.
      */
     FieldDisplayType["SquareImageBadge"] = "SquareImageBadge";
+    /**
+     * Displays an icon and value as a badge in the bottom-left of the card. Takes an object containing an iconUrl
+     * and value. If value is a string longer than 20 characters, it will be truncated to be a maximum of 20 chars
+     * appending '...' to the given value. If value is a number higher than 999, displays 999.
+     */
+    FieldDisplayType["TagBadge"] = "TagBadge";
     /**
      * Given a date, display a small calendar icon alongside a very short version of the date
      * as a string, e.g. "Sep 9"

package/core/cardintegration/cardintegrationparams.d.ts

@@ -112,7 +112,9 @@ export interface ImportFromSerializedFieldsCallbackParam {
 }
 /** @ignore */
 export interface CanEditItemsParam {
-    'ek': string;
-    'dk'?: string;
+    'i': Array<{
+        'pk': string;
+        'cid': string;
+    }>;
 }
 export {};

package/core/cardintegration/lucidcardintegration.d.ts

@@ -1,4 +1,5 @@
 import { CollectionProxy } from '../../data/collectionproxy';
+import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
@@ -156,7 +157,8 @@ export declare abstract class LucidCardIntegration {
      */
     importFromSerializedFields?: (data: SerializedFields[]) => Promise<ImportCardFromDetails>;
     /**
-     * @experimental When defined, allows the extension to make cards that the user can't edit view-only.
+     * @experimental If specified, allows the extension to check whether the user can edit the given items.
+     * Returns a Map with per-item permission results, keyed by item primary key.
      */
-    canEditItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<UserItemEditPermissions>;
+    canEditItems?: (items: DataItemProxy[]) => Promise<Map<string, UserItemEditPermissions>>;
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -465,10 +465,12 @@ class LucidCardIntegrationRegistry {
         }
         if (cardIntegration.canEditItems) {
             const canEditItemsActionName = LucidCardIntegrationRegistry.nextHookName();
+            const canEditItems = cardIntegration.canEditItems;
             serialized['cei'] = canEditItemsActionName;
-            client.registerAction(canEditItemsActionName, async ({ 'ek': editedKey, 'dk': dependencyKey }) => {
-                const result = await cardIntegration.canEditItems(editedKey, dependencyKey);
-                return (0, useritemeditpermissions_1.serializeUserItemEditPermissions)(result);
+            client.registerAction(canEditItemsActionName, async ({ i }) => {
+                const dataItemProxies = i.map((item) => new dataitemproxy_1.DataItemProxy(item['pk'], new collectionproxy_1.CollectionProxy(item['cid'], client), client));
+                const result = await canEditItems(dataItemProxies);
+                return (0, useritemeditpermissions_1.serializeUserItemEditPermissionsMap)(result);
             });
         }
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);

package/core/cardintegration/useritemeditpermissions.d.ts

@@ -17,10 +17,13 @@ export declare class UserCannotEditItem implements UserItemEditPermissions {
     readonly hasPermission = false;
     constraints: never[];
 }
-export declare function serializeUserItemEditPermissions(result: UserItemEditPermissions): {
-    hp: boolean;
-    c: {
-        fn: string;
-        cs: SerializedFieldConstraint[] | undefined;
+export interface SerializedUserItemEditPermissions {
+    'hp': boolean;
+    'c': {
+        'fn': string;
+        'cs': SerializedFieldConstraint[] | undefined;
     }[];
-};
+}
+export declare function serializeUserItemEditPermissionsMap(map: Map<string, UserItemEditPermissions>): Record<string, SerializedUserItemEditPermissions>;
+export declare function deserializeUserItemEditPermissionsRecord(serializedMap: Record<string, SerializedUserItemEditPermissions>): Map<string, UserItemEditPermissions>;
+export declare function isValidSerializedUserItemEditPermissionsRecord(value: unknown): value is Record<string, SerializedUserItemEditPermissions>;

package/core/cardintegration/useritemeditpermissions.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeUserItemEditPermissions = exports.UserCannotEditItem = exports.UserCanEditItem = void 0;
+exports.isValidSerializedUserItemEditPermissionsRecord = exports.deserializeUserItemEditPermissionsRecord = exports.serializeUserItemEditPermissionsMap = exports.UserCannotEditItem = exports.UserCanEditItem = void 0;
+const checks_1 = require("../checks");
+const serializedfielddefinition_1 = require("../data/serializedfield/serializedfielddefinition");
+const validators_1 = require("../validators/validators");
 class UserCanEditItem {
     constructor() {
         this.hasPermission = true;
@@ -15,6 +18,13 @@ class UserCannotEditItem {
     }
 }
 exports.UserCannotEditItem = UserCannotEditItem;
+const isSerializedUserItemEditPermissions = (0, validators_1.objectValidator)({
+    'hp': checks_1.isBoolean,
+    'c': (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
+        'fn': checks_1.isString,
+        'cs': (0, validators_1.option)((0, validators_1.arrayValidator)(serializedfielddefinition_1.isSerializedFieldConstraint)),
+    })),
+});
 function serializeUserItemEditPermissions(result) {
     return {
         'hp': result.hasPermission,
@@ -24,4 +34,32 @@ function serializeUserItemEditPermissions(result) {
         })),
     };
 }
-exports.serializeUserItemEditPermissions = serializeUserItemEditPermissions;
+function deserializeUserItemEditPermissions(serialized) {
+    return {
+        hasPermission: serialized['hp'],
+        constraints: serialized['c'].map((c) => ({
+            fieldName: c['fn'],
+            constraints: c['cs'],
+        })),
+    };
+}
+function serializeUserItemEditPermissionsMap(map) {
+    const serializedMap = {};
+    for (const [primaryKey, permissions] of map) {
+        serializedMap[primaryKey] = serializeUserItemEditPermissions(permissions);
+    }
+    return serializedMap;
+}
+exports.serializeUserItemEditPermissionsMap = serializeUserItemEditPermissionsMap;
+function deserializeUserItemEditPermissionsRecord(serializedMap) {
+    const map = new Map();
+    for (const [primaryKey, serializedPermissions] of Object.entries(serializedMap)) {
+        map.set(primaryKey, deserializeUserItemEditPermissions(serializedPermissions));
+    }
+    return map;
+}
+exports.deserializeUserItemEditPermissionsRecord = deserializeUserItemEditPermissionsRecord;
+function isValidSerializedUserItemEditPermissionsRecord(value) {
+    return (0, checks_1.isRecord)(isSerializedUserItemEditPermissions)(value);
+}
+exports.isValidSerializedUserItemEditPermissionsRecord = isValidSerializedUserItemEditPermissionsRecord;

package/core/rules/serializedeffect.d.ts

@@ -2,7 +2,7 @@ import { ConditionCombination } from './conditions';
 import { SerializedDataGraphic } from './serializeddatagraphic';
 import { SerializedStencilGraphic } from './serializedstencilgraphic';
 export type FormattingInterface = {
-    [index: string]: string;
+    [index: string]: string | undefined;
 };
 export type SerializedFormatting = {
     'Block'?: FormattingInterface;

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -4,6 +4,7 @@ import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { FieldDefinition } from '../../data/schemadefinition';
 import { FieldDescriptor } from '../cardintegration/lucidcardintegration';
+import { UserItemEditPermissions } from '../cardintegration/useritemeditpermissions';
 import { isArray, isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
 import { SerializedFieldDefinition } from '../data/serializedfield/serializedfielddefinition';
@@ -334,3 +335,10 @@ export declare const isSerializedTagCallbackResult: (subject: unknown) => subjec
 }>;
 /** @ignore */
 export declare function serializeTagCallbackResult(tag: TagCallbackResult): SerializedTagCallbackResult;
+/**
+ * The type for a callback function that returns whether the user can edit the given items.
+ *
+ * @param items - The items to check edit permissions for.
+ * @returns A promise that maps items' primary key to their edit permissions.
+ */
+export type AsyncCanEditItemCallback = (items: DataItemProxy[]) => Promise<Map<string, UserItemEditPermissions>>;

package/core/validators/validators.d.ts

@@ -257,6 +257,10 @@ export declare const isSize: (subject: unknown) => subject is DestructureGuarded
     w: typeof isNumber;
     h: typeof isNumber;
 }>;
+export declare const isPartialSize: (subject: unknown) => subject is Partial<DestructureGuardedTypeObj<{
+    w: typeof isNumber;
+    h: typeof isNumber;
+}>>;
 export declare function isPositiveNumber(x: unknown): x is number;
 export declare function isDate(x: unknown): x is Date;
 export declare function maxLengthValidator(max: number): (x: unknown) => x is string;

package/core/validators/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAssertion = exports.validatorWithMessage = exports.isEmptyObject = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.bothWithInvalidFieldTracking = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullableValidatorWithInvalidElementTracking = exports.nullable = exports.objectOfValidatorWithInvalidFieldTracking = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
+exports.asAssertion = exports.validatorWithMessage = exports.isEmptyObject = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isPartialSize = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isFalse = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.bothWithInvalidFieldTracking = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullableValidatorWithInvalidElementTracking = exports.nullable = exports.objectOfValidatorWithInvalidFieldTracking = exports.objectOfValidator = exports.typedRecordValidator = exports.recordValidator = exports.strictObjectValidator = exports.partialObjectValidator = exports.objectValidatorWithInvalidFieldTracking = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidatorWithInvalidElementTracking = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 /*********************************************************************************
  * Validator generators:  These functions construct new composite validators
@@ -493,6 +493,10 @@ exports.isSize = objectValidator({
     w: checks_1.isNumber,
     h: checks_1.isNumber,
 });
+exports.isPartialSize = partialObjectValidator({
+    w: checks_1.isNumber,
+    h: checks_1.isNumber,
+});
 function isPositiveNumber(x) {
     return (0, checks_1.isNumber)(x) && x >= 0;
 }

package/dataconnector/actions/patch.test.d.ts

@@ -22,6 +22,6 @@ export declare function getRandomItemPatch(settings: RandomPatchSettings, previo
  * @param data The Sheet-type to stringify
  * @returns A custom stringified object
  */
-export declare function orderedStringify(data: unknown): string;
+export declare function orderedStringify(data: unknown): string | undefined;
 export declare function patchesEqual(patchA: Patch, patchB: Patch): boolean;
 export {};

package/dataconnector/dataconnector.d.ts

@@ -41,8 +41,8 @@ export declare class DataConnectorRequestState {
 }
 /** Thrown by any APIs the client didn't recognize when parsing */
 export declare class DataConnectorResponseError extends Error {
-    response: string;
-    constructor(message: string, response: string);
+    response: string | undefined;
+    constructor(message: string, response: string | undefined);
 }
 /** Used to track user collection access when EditorExtensionScope is PERSISTENT_SYNC. */
 export interface AffectedDocumentCollectionsBody {

package/document/graphdefinition.d.ts

@@ -0,0 +1,31 @@
+import { Box } from '../math';
+/**
+ * The information required to create a new graph on the current document
+ */
+export interface GraphDefinition {
+    /**
+     * The type of graph to create, e.g. "LineGraphBlock", "BarGraphBlock".
+     */
+    graphType: GraphType;
+    /**
+     * The ID of the collection to use for the graph data.
+     */
+    collectionId: string;
+    /**
+     * The title of the graph.
+     */
+    title: string;
+    /**
+     * The initial location and size of the graph on the page.
+     */
+    boundingBox?: Box;
+    /**
+     * By default, we add the graph to the current page. If specified, the
+     * graph will instead be created as a direct child of the given page.
+     */
+    pageId?: string | undefined;
+}
+export declare enum GraphType {
+    LineGraph = "LineGraphCollectionBlock",
+    BarGraph = "BarGraphCollectionBlock"
+}

package/document/graphdefinition.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphType = void 0;
+var GraphType;
+(function (GraphType) {
+    GraphType["LineGraph"] = "LineGraphCollectionBlock";
+    GraphType["BarGraph"] = "BarGraphCollectionBlock";
+})(GraphType || (exports.GraphType = GraphType = {}));

package/document/pageproxy.d.ts

@@ -5,6 +5,7 @@ import { BlockDefinition } from './blockdefinition';
 import { BlockProxy } from './blockproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
+import { GraphDefinition } from './graphdefinition';
 import { GroupProxy } from './groupproxy';
 import { ImageDefinition } from './imagedefinition';
 import { ItemProxy } from './itemproxy';
@@ -75,6 +76,17 @@ export declare class PageProxy extends ElementProxy {
      * All blocks, lines, and groups on the page, including ones inside groups
      */
     readonly allItems: MapProxy<string, BlockProxy | LineProxy | GroupProxy>;
+    /**
+     * Add a new graph to this page.
+     *
+     * This method uses the CreateGraph command which provides enhanced graph creation
+     * capabilities with data collection integration. For custom graph implementations,
+     * you may also send a postMessage to the parent window for custom handling.
+     * @experimental
+     * @param graphDefinition The definition of the new graph to add
+     * @returns A promise that resolves to the added graph block
+     */
+    addGraph(graphDefinition: GraphDefinition): Promise<BlockProxy>;
     /**
      * Add a new block to this page.
      *

package/document/pageproxy.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageProxy = void 0;
 const commandtypes_1 = require("../commandtypes");
+const checks_1 = require("../core/checks");
 const ruleproxy_1 = require("./documentelement/ruleproxy");
 const elementproxy_1 = require("./elementproxy");
 const groupproxy_1 = require("./groupproxy");
@@ -97,6 +98,29 @@ class PageProxy extends elementproxy_1.ElementProxy {
             y: result['y'],
         };
     }
+    /**
+     * Add a new graph to this page.
+     *
+     * This method uses the CreateGraph command which provides enhanced graph creation
+     * capabilities with data collection integration. For custom graph implementations,
+     * you may also send a postMessage to the parent window for custom handling.
+     * @experimental
+     * @param graphDefinition The definition of the new graph to add
+     * @returns A promise that resolves to the added graph block
+     */
+    async addGraph(graphDefinition) {
+        const id = await this.client.sendCommand("cgr" /* CommandName.CreateGraph */, {
+            'p': graphDefinition.pageId || this.id,
+            't': graphDefinition.graphType,
+            'col': graphDefinition.collectionId,
+            'ti': graphDefinition.title,
+        });
+        const block = this.client.getBlockProxy(id);
+        if ((0, checks_1.isDefAndNotNull)(graphDefinition.boundingBox)) {
+            block.setBoundingBox(graphDefinition.boundingBox);
+        }
+        return block;
+    }
     /**
      * Add a new block to this page.
      *

package/editorclient.d.ts

@@ -4,6 +4,7 @@ import { JsonObject, UnsafeJsonSerializableOrUndefined } from './core/jsonserial
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { BinaryXHRResponse, OAuthXHRRequest, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
 import { CollectionProxy } from './data/collectionproxy';
+import { CollectionId } from './dataconnector/actions/action';
 import { BlockDefinition } from './document/blockdefinition';
 import { BlockProxy } from './document/blockproxy';
 import { ElementProxy } from './document/elementproxy';
@@ -28,6 +29,7 @@ export type DataActionOptions = {
     actionData?: unknown;
     syncDataSourceIdNonce?: string;
     asynchronous?: boolean;
+    requestedPrimaryKeys?: Record<CollectionId, string[]>;
 };
 export declare class EditorClient {
     private nextId;

package/editorclient.js

@@ -105,6 +105,7 @@ class EditorClient {
         return this.createUserImage(mediaType, data);
     }
     async performDataAction(options) {
+        var _a;
         if (options.asynchronous === undefined) {
             options.asynchronous = true;
         }
@@ -114,6 +115,7 @@ class EditorClient {
             's': options.syncDataSourceIdNonce,
             'fd': options.actionData,
             'n': options.dataConnectorName,
+            'rpk': (_a = options.requestedPrimaryKeys) !== null && _a !== void 0 ? _a : undefined,
         });
         if ('t' in result) {
             return {

package/package.json

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