lucid-extension-sdk 0.0.437 → 0.0.438

package/commandtypes.d.ts

@@ -908,9 +908,9 @@ export type AddCardIntegrationQuery = {
         'cb': string;
     } | undefined;
     /**
-     * whether the user has access to items
+     * Whether the user can edit an item in the data source.
      */
-    'hait'?: string | undefined;
+    'cei'?: string | undefined;
 };
 export type AddCardIntegrationResult = undefined;
 /** @ignore */
@@ -1398,8 +1398,13 @@ export type GetDataItemFieldQuery = {
     'c': string;
     /** Primary key of the data item to read */
     'pk': string;
-    /** Name of field to read */
+    /** Name of field (or field label, if 'l' is true) to read */
     'f': string;
+    /**
+     * "label" - If true, get the field by label, not name
+     * (Labels are specified by `FieldLabelOverrides` in `SerializedSchema`)
+     * */
+    'l'?: boolean | undefined;
 };
 export type GetDataItemFieldResult = SerializedFieldType;
 export type GetDeveloperModeStatusQuery = void;
@@ -1631,6 +1636,8 @@ export type ListDataItemsResult = string[];
 export type ListCollectionFieldsQuery = {
     /** Collection ID to query */
     'id': string;
+    /** "labels" - If true, list field labels. Otherwise, list field names (default) */
+    'l'?: boolean | undefined;
 };
 export type ListCollectionFieldsResult = string[];
 export type ListDataSourcesQuery = undefined;

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -1,8 +1,18 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+/**
+ * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
+ * {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
+ * value.
+ */
+export declare const AutoSyncPaginationSize = 50;
+/**
+ * This config defines variables and methods required to implement query sync for various container objects in Lucid
+ * (e.g. timelines).
+ */
 export interface CardIntegrationAutoSyncConfig {
     /**
-     * The header to display for the integration. For example, the Jira integration displays "JQL query sync"
+     * The header to display for the integration in the autosync modal.
      */
     header: string;
     /**
@@ -14,12 +24,13 @@ export interface CardIntegrationAutoSyncConfig {
      */
     getSyncDataSourceIdField: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
     /**
-     * Perform a search on the query string. This should support pagination.
+     * Perform a search on the query string. This should support pagination (See {@link AutoSyncPaginationSize}).
      *
      * The syncDataSourceIdNonce is provided in otherFields
-     * @returns either an error AutoSyncError or an array of issues / tasks / cards represented as an AutoSyncRow
+     * @param pageNumber If undefined, will return all results from the search
+     * @returns the search results after searching using the given query string.
      */
-    searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number, nextPageToken: string | undefined) => Promise<SearchResult>;
+    searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number | undefined, nextPageToken: string | undefined) => Promise<SearchResult>;
     /**
      * @returns the ImportResult for the query string.
      */

package/core/cardintegration/cardintegrationautosyncconfig.js

@@ -1,2 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoSyncPaginationSize = void 0;
+/**
+ * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
+ * {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
+ * value.
+ */
+exports.AutoSyncPaginationSize = 50;

package/core/cardintegration/cardintegrationparams.d.ts

@@ -26,7 +26,7 @@ export interface SearchParam {
 export interface QuerySearchParam {
     'qs': string;
     'of': [string, SerializedFieldType][];
-    'pn': number;
+    'pn': number | undefined;
     'npt': string | undefined;
 }
 export interface QuerySyncParam {
@@ -101,7 +101,7 @@ export interface ImportFromSerializedFieldsCallbackParam {
     'sf': SerializedFields[];
 }
 /** @ignore */
-export interface HasAccessToItemsParam {
+export interface CanEditItemsParam {
     'ek': string;
     'dk'?: string;
 }

package/core/cardintegration/lucidcardintegration.d.ts

@@ -9,10 +9,10 @@ import { ImportCardFromPastedLinkCallback } from '../importcardfrompastedlink/im
 import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { CardIntegrationAutoSyncConfig } from './cardintegrationautosyncconfig';
 import { CardIntegrationConfig } from './cardintegrationconfig';
-import { CardUserAccessResult } from './carduseraccessresult';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';
+import { UserItemEditPermissions } from './useritemeditpermissions';
 export interface FieldDescriptor {
     name: string;
     label?: string | undefined;
@@ -156,7 +156,7 @@ export declare abstract class LucidCardIntegration {
      */
     importFromSerializedFields?: (data: SerializedFields[]) => Promise<ImportCardFromDetails>;
     /**
-     * @experimental When defined, allows the extension to make cards that the user doesn't have access to view-only.
+     * @experimental When defined, allows the extension to make cards that the user can't edit view-only.
      */
-    hasAccessToItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<CardUserAccessResult>;
+    canEditItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<UserItemEditPermissions>;
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -10,8 +10,8 @@ const checks_1 = require("../checks");
 const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
-const carduseraccessresult_1 = require("./carduseraccessresult");
 const lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
+const useritemeditpermissions_1 = require("./useritemeditpermissions");
 class LucidCardIntegrationRegistry {
     static nextHookName() {
         return '__lucidcard__hook' + LucidCardIntegrationRegistry.nextHookId++;
@@ -430,12 +430,12 @@ class LucidCardIntegrationRegistry {
                 return (0, importcardfromdetails_1.serializeImportCardFromDetails)(result);
             });
         }
-        if (cardIntegration.hasAccessToItems) {
-            const hasAccessToItemsActionName = LucidCardIntegrationRegistry.nextHookName();
-            serialized['hait'] = hasAccessToItemsActionName;
-            client.registerAction(hasAccessToItemsActionName, async ({ 'ek': editedKey, 'dk': dependencyKey }) => {
-                const result = await cardIntegration.hasAccessToItems(editedKey, dependencyKey);
-                return (0, carduseraccessresult_1.serializeCardUserAccessResult)(result);
+        if (cardIntegration.canEditItems) {
+            const canEditItemsActionName = LucidCardIntegrationRegistry.nextHookName();
+            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.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);

package/core/cardintegration/useritemeditpermissions.d.ts

@@ -0,0 +1,26 @@
+import { SerializedFieldConstraint } from '../data/serializedfield/serializedfielddefinition';
+/**
+ * Defines whether the current user can edit an item.
+ */
+export interface UserItemEditPermissions {
+    hasPermission: boolean;
+    constraints: {
+        fieldName: string;
+        constraints?: SerializedFieldConstraint[];
+    }[];
+}
+export declare class UserCanEditItem implements UserItemEditPermissions {
+    readonly hasPermission = true;
+    constraints: never[];
+}
+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;
+    }[];
+};

package/core/cardintegration/useritemeditpermissions.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeUserItemEditPermissions = exports.UserCannotEditItem = exports.UserCanEditItem = void 0;
+class UserCanEditItem {
+    constructor() {
+        this.hasPermission = true;
+        this.constraints = [];
+    }
+}
+exports.UserCanEditItem = UserCanEditItem;
+class UserCannotEditItem {
+    constructor() {
+        this.hasPermission = false;
+        this.constraints = [];
+    }
+}
+exports.UserCannotEditItem = UserCannotEditItem;
+function serializeUserItemEditPermissions(result) {
+    return {
+        'hp': result.hasPermission,
+        'c': result.constraints.map((c) => ({
+            'fn': c.fieldName,
+            'cs': c.constraints,
+        })),
+    };
+}
+exports.serializeUserItemEditPermissions = serializeUserItemEditPermissions;

package/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -13,7 +13,8 @@ export declare enum FieldConstraintType {
     SINGLE_LINE_ONLY = "singleLineOnly",
     NO_WHITESPACE = "noWhitespace",
     UNIQUE_EDIT = "uniqueEditType",
-    MAX_LENGTH = "maxLength"
+    MAX_LENGTH = "maxLength",
+    MAX_DECIMAL_LENGTH = "maxDecimalLength"
 }
 export declare const isFieldConstraintType: (x: unknown) => x is FieldConstraintType;
 export type SerializedFieldConstraint = {

package/core/data/serializedfield/serializedfielddefinition.js

@@ -18,6 +18,7 @@ var FieldConstraintType;
     FieldConstraintType["NO_WHITESPACE"] = "noWhitespace";
     FieldConstraintType["UNIQUE_EDIT"] = "uniqueEditType";
     FieldConstraintType["MAX_LENGTH"] = "maxLength";
+    FieldConstraintType["MAX_DECIMAL_LENGTH"] = "maxDecimalLength";
 })(FieldConstraintType || (exports.FieldConstraintType = FieldConstraintType = {}));
 exports.isFieldConstraintType = (0, validators_1.enumValidator)(FieldConstraintType);
 exports.isSerializedFieldConstraint = (0, validators_1.objectValidator)({

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -154,8 +154,10 @@ export interface SearchResultPerCollection {
  * If you change this interface, check if your changes need to be synced with
  * editorextensioncardintegrationregistry.ts.
  *
- * By specifying the itemsPerSearchResult, you can enable pagination for results in the import modal. The offset and limit
- * parameters in the search function will tell you which page of results to return.
+ * By specifying the itemsPerSearchResult, you can enable pagination for results in the import modal OR the
+ * query sync modal. The offset and limit parameters in the search function will tell you which page of results
+ * to return, whereas the {@link AutoSyncPaginationSize} variable and pageNumber parameter should be used to
+ * calculate which search reults to return for query sync.
  *
  */
 export interface SearchResult {

package/data/dataitemproxy.d.ts

@@ -18,6 +18,10 @@ export declare class DataItemProxy {
      * The fields on this data item, organized by their name.
      */
     readonly fields: MapProxy<string, import("..").SerializedFieldType>;
+    /**
+     * The fields on this data item, organized by their label.
+     */
+    readonly fieldsByLabel: MapProxy<string, import("..").SerializedFieldType>;
     /**
      * @returns True if a data item exists in this collection at this primary key
      */

package/data/dataitemproxy.js

@@ -23,6 +23,15 @@ class DataItemProxy {
             'pk': this.primaryKey,
             'f': name,
         }));
+        /**
+         * The fields on this data item, organized by their label.
+         */
+        this.fieldsByLabel = new mapproxy_1.MapProxy(() => this.client.sendCommand("lcf" /* CommandName.ListCollectionFields */, { 'id': this.collection.id, 'l': true }), (name) => this.client.sendCommand("gdif" /* CommandName.GetDataItemField */, {
+            'c': this.collection.id,
+            'pk': this.primaryKey,
+            'f': name,
+            'l': true,
+        }));
     }
     /**
      * @returns True if a data item exists in this collection at this primary key

package/data/fieldconstraintdefinition.d.ts

@@ -40,15 +40,20 @@ export interface MaxLengthConstraintDefinition {
     value: number;
     reason?: string | undefined;
 }
-export type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition | MaxLengthConstraintDefinition;
+export interface MaxDecimalPlacesConstraintDefinition {
+    type: FieldConstraintType.MAX_DECIMAL_LENGTH;
+    value: number;
+    reason?: string | undefined;
+}
+export type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition | MaxLengthConstraintDefinition | MaxDecimalPlacesConstraintDefinition;
 export declare function createFieldConstraintDefinition(type: FieldConstraintType, value?: number, reason?: string): FieldConstraintDefinition;
-export declare function minMaxFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE | FieldConstraintType.MAX_LENGTH;
+export declare function numericFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE | FieldConstraintType.MAX_LENGTH | FieldConstraintType.MAX_DECIMAL_LENGTH;
 export declare const isFieldConstraintDefinition: (x: unknown) => x is {
     type?: FieldConstraintType | undefined;
 } & {
     type: FieldConstraintType;
 } & (import("..").DestructureGuardedTypeObj<{
-    type: typeof minMaxFieldConstraintValidator;
+    type: typeof numericFieldConstraintValidator;
     value: typeof isNumber;
 }> | import("..").DestructureGuardedTypeObj<{
     type: (x: unknown) => x is FieldConstraintType.REQUIRED | FieldConstraintType.LOCKED | FieldConstraintType.SINGLE_LINE_ONLY | FieldConstraintType.NO_WHITESPACE | FieldConstraintType.UNIQUE_EDIT;

package/data/fieldconstraintdefinition.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.minMaxFieldConstraintValidator = exports.createFieldConstraintDefinition = void 0;
+exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.numericFieldConstraintValidator = exports.createFieldConstraintDefinition = void 0;
 const assertnever_1 = require("../core/assertnever");
 const checks_1 = require("../core/checks");
 const serializedfielddefinition_1 = require("../core/data/serializedfield/serializedfielddefinition");
@@ -13,6 +13,7 @@ function createFieldConstraintDefinition(type, value, reason) {
         case serializedfielddefinition_1.FieldConstraintType.MIN_VALUE:
         case serializedfielddefinition_1.FieldConstraintType.MAX_VALUE:
         case serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH:
+        case serializedfielddefinition_1.FieldConstraintType.MAX_DECIMAL_LENGTH:
             if (value === undefined) {
                 throw new Error('Invalid constraint value');
             }
@@ -29,15 +30,19 @@ function createFieldConstraintDefinition(type, value, reason) {
     }
 }
 exports.createFieldConstraintDefinition = createFieldConstraintDefinition;
-function minMaxFieldConstraintValidator(val) {
+function numericFieldConstraintValidator(val) {
     return (val === serializedfielddefinition_1.FieldConstraintType.MIN_VALUE ||
         val === serializedfielddefinition_1.FieldConstraintType.MAX_VALUE ||
-        val === serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH);
+        val === serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH ||
+        val === serializedfielddefinition_1.FieldConstraintType.MAX_DECIMAL_LENGTH);
 }
-exports.minMaxFieldConstraintValidator = minMaxFieldConstraintValidator;
+exports.numericFieldConstraintValidator = numericFieldConstraintValidator;
 exports.isFieldConstraintDefinition = (0, validators_1.both)((0, validators_1.objectValidator)({
     'type': serializedfielddefinition_1.isFieldConstraintType,
-}), (0, validators_1.either)((0, validators_1.objectValidator)({ 'type': minMaxFieldConstraintValidator, 'value': checks_1.isNumber }), (0, validators_1.objectValidator)({ 'type': (0, validators_1.exclude)(serializedfielddefinition_1.isFieldConstraintType, minMaxFieldConstraintValidator), 'value': checks_1.isUndefined })));
+}), (0, validators_1.either)((0, validators_1.objectValidator)({ 'type': numericFieldConstraintValidator, 'value': checks_1.isNumber }), (0, validators_1.objectValidator)({
+    'type': (0, validators_1.exclude)(serializedfielddefinition_1.isFieldConstraintType, numericFieldConstraintValidator),
+    'value': checks_1.isUndefined,
+})));
 /** @ignore */
 function serializeFieldConstraintDefinition(constraint) {
     return {

package/package.json

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

package/core/cardintegration/carduseraccessresult.d.ts

@@ -1,18 +0,0 @@
-import { SerializedFieldConstraint } from '../data/serializedfield/serializedfielddefinition';
-/**
- * Defines whether the current user has access to an item.
- */
-export interface CardUserAccessResult {
-    hasPermission: boolean;
-    constraints: {
-        fieldName: string;
-        constraints?: SerializedFieldConstraint[];
-    }[];
-}
-export declare function serializeCardUserAccessResult(result: CardUserAccessResult): {
-    hp: boolean;
-    c: {
-        fn: string;
-        cs: SerializedFieldConstraint[] | undefined;
-    }[];
-};

package/core/cardintegration/carduseraccessresult.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCardUserAccessResult = void 0;
-function serializeCardUserAccessResult(result) {
-    return {
-        'hp': result.hasPermission,
-        'c': result.constraints.map((c) => ({
-            'fn': c.fieldName,
-            'cs': c.constraints,
-        })),
-    };
-}
-exports.serializeCardUserAccessResult = serializeCardUserAccessResult;