lucid-extension-sdk 0.0.420 → 0.0.423

package/core/data/fieldspecification.d.ts

@@ -7,10 +7,10 @@ import { LucidFields } from './fieldtypedefinition/lucidfields';
 import { ScalarFieldTypeEnum } from './fieldtypedefinition/scalarfieldtype';
 import { SemanticFields } from './fieldtypedefinition/semanticfields';
 import { SemanticKind } from './fieldtypedefinition/semantickind';
-import { SerializedColorObject, SerializedLucidCurrency, SerializedLucidDateObject, SerializedLucidDictionary } from './serializedfield/serializedfields';
+import { SerializedColorObject, SerializedLucidCurrency, SerializedLucidDateObject, SerializedLucidDateRangeObject, SerializedLucidDictionary } from './serializedfield/serializedfields';
 type TsTypeOf<X> = X extends ScalarFieldTypeEnum.ANY ? unknown : X extends ScalarFieldTypeEnum.NUMBER ? number : X extends ScalarFieldTypeEnum.BOOLEAN ? boolean : X extends ScalarFieldTypeEnum.STRING ? string : X extends ScalarFieldTypeEnum.COLOR ? SerializedColorObject : X extends ScalarFieldTypeEnum.DATE ? SerializedLucidDateObject : X extends ScalarFieldTypeEnum.NULL ? null : X extends ScalarFieldTypeEnum.DICTIONARY ? SerializedLucidDictionary : X extends FieldTypeArray<infer Inner> ? TsTypeOf<Inner>[] : X extends ScalarFieldTypeEnum.CURRENCY ? SerializedLucidCurrency : X extends ScalarFieldTypeEnum.DATEONLY ? SerializedLucidDateObject & {
     isDateOnly: true;
-} : X extends CollectionEnumFieldType ? string : X extends DeserializedMapEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
+} : X extends ScalarFieldTypeEnum.DATERANGE ? SerializedLucidDateRangeObject : X extends CollectionEnumFieldType ? string : X extends DeserializedMapEnumFieldType ? string : X extends readonly [infer Inner, ...infer Others] ? TsTypeOf<Inner> | TsTypeOf<Others> : never;
 /**
  * Specifies all the fields that this itegration will be sending to the data-sync service.
  * Give you well typed methods to convert from `YourType[]` to `{[PrimaryKey:string]: YourType}`

package/core/data/fieldtypedefinition/scalarfieldtype.d.ts

@@ -9,7 +9,8 @@ export declare enum ScalarFieldTypeEnum {
     DICTIONARY = 7,
     CURRENCY = 8,
     DATEONLY = 9,
-    TIMEONLY = 10
+    TIMEONLY = 10,
+    DATERANGE = 11
 }
 export declare const AnyScalarFieldType: ScalarFieldTypeEnum[];
 export declare const isScalarFieldTypeEnum: (fieldType: any) => fieldType is ScalarFieldTypeEnum;

package/core/data/fieldtypedefinition/scalarfieldtype.js

@@ -14,6 +14,7 @@ var ScalarFieldTypeEnum;
     ScalarFieldTypeEnum[ScalarFieldTypeEnum["CURRENCY"] = 8] = "CURRENCY";
     ScalarFieldTypeEnum[ScalarFieldTypeEnum["DATEONLY"] = 9] = "DATEONLY";
     ScalarFieldTypeEnum[ScalarFieldTypeEnum["TIMEONLY"] = 10] = "TIMEONLY";
+    ScalarFieldTypeEnum[ScalarFieldTypeEnum["DATERANGE"] = 11] = "DATERANGE";
 })(ScalarFieldTypeEnum || (exports.ScalarFieldTypeEnum = ScalarFieldTypeEnum = {}));
 exports.AnyScalarFieldType = [
     ScalarFieldTypeEnum.ANY,
@@ -27,6 +28,7 @@ exports.AnyScalarFieldType = [
     ScalarFieldTypeEnum.DICTIONARY,
     ScalarFieldTypeEnum.CURRENCY,
     ScalarFieldTypeEnum.TIMEONLY,
+    ScalarFieldTypeEnum.DATERANGE,
 ];
 const AnyScalarFieldTypeSet = new Set(exports.AnyScalarFieldType);
 const isScalarFieldTypeEnum = (fieldType) => {

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

@@ -1,5 +1,5 @@
 import { isNumber, isString } from '../../checks';
-export type SerializedFieldType = number | boolean | string | null | SerializedLucidDateObject | SerializedTimeObject | SerializedColorObjectFieldType | SerializedLucidDictionary | SerializedLucidCurrency | undefined | Array<SerializedFieldType>;
+export type SerializedFieldType = number | boolean | string | null | SerializedLucidDateObject | SerializedLucidDateRangeObject | SerializedTimeObject | SerializedColorObjectFieldType | SerializedLucidDictionary | SerializedLucidCurrency | undefined | Array<SerializedFieldType>;
 export type SerializedJsonFieldType = number | boolean | string | null | undefined | Array<SerializedJsonFieldType> | {
     [index: string]: SerializedJsonFieldType;
 };
@@ -30,6 +30,10 @@ export type SerializedMillisecondsDateObject = {
     'isDateOnly'?: boolean;
 };
 export type SerializedLucidDateObject = SerializedMillisecondsDateObject | SerializedIsoDateObject;
+export type SerializedLucidDateRangeObject = {
+    'startDate': SerializedLucidDateObject;
+    'endDate': SerializedLucidDateObject;
+};
 export type SerializedTimeObject = {
     'hours': number;
     'minutes'?: number | undefined;
@@ -114,6 +118,22 @@ export declare const isSerializedLucidDateObject: (x: unknown) => x is import(".
     isoDate: typeof isString;
     displayTimezone: (x: unknown) => x is string | null | undefined;
 }>;
+export declare const isSerializedLucidDateRangeObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    startDate: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
+        ms: typeof isNumber;
+        isDateOnly: (x: unknown) => x is boolean | undefined;
+    }> | import("../../guards").DestructureGuardedTypeObj<{
+        isoDate: typeof isString;
+        displayTimezone: (x: unknown) => x is string | null | undefined;
+    }>;
+    endDate: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
+        ms: typeof isNumber;
+        isDateOnly: (x: unknown) => x is boolean | undefined;
+    }> | import("../../guards").DestructureGuardedTypeObj<{
+        isoDate: typeof isString;
+        displayTimezone: (x: unknown) => x is string | null | undefined;
+    }>;
+}>;
 export declare const isSerializedTimeObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
     hours: typeof isNumber;
     minutes: (x: unknown) => x is number | undefined;

package/core/data/serializedfield/serializedfields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
+exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateRangeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
 const checks_1 = require("../../checks");
 const validators_1 = require("../../validators/validators");
 function isSerializedColorObjectFieldType(value) {
@@ -35,6 +35,10 @@ exports.isSerializedIsoDateObject = (0, validators_1.objectValidator)({
     'displayTimezone': (0, validators_1.nullableOption)(checks_1.isString),
 });
 exports.isSerializedLucidDateObject = (0, validators_1.either)(exports.isSerializedMillisecondsDateObject, exports.isSerializedIsoDateObject);
+exports.isSerializedLucidDateRangeObject = (0, validators_1.objectValidator)({
+    'startDate': exports.isSerializedLucidDateObject,
+    'endDate': exports.isSerializedLucidDateObject,
+});
 exports.isSerializedTimeObject = (0, validators_1.objectValidator)({
     'hours': checks_1.isNumber,
     'minutes': (0, validators_1.option)(checks_1.isNumber),
@@ -56,6 +60,7 @@ function isSerializedFieldType(value) {
         (0, exports.isSerializedLucidCurrency)(value) ||
         ((0, checks_1.isArray)(value) && value.every(isSerializedFieldType)) ||
         (0, exports.isSerializedLucidDateObject)(value) ||
+        (0, exports.isSerializedLucidDateRangeObject)(value) ||
         (0, exports.isSerializedTimeObject)(value) ||
         isSerializedColorObjectFieldType(value) ||
         (0, exports.isSerializedLucidIconDataDictionary)(value) ||

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -12,7 +12,16 @@ import { SerializedFieldType, SerializedLucidDictionary, isSerializedFieldType }
 export interface ExtensionCardFieldOption {
     label: string;
     value: SerializedFieldType;
+    /**
+     * URL used for displaying the icon in dropdowns and on the card.
+     */
     iconUrl?: string | undefined;
+    /**
+     * Optional override for iconUrl used when saving an icon's URL to a collection. Use when the URL to save differs
+     * from the URL to display (e.g., when using an image proxy), or to avoid processing the URL (e.g., to skip URL
+     * decoding).
+     */
+    iconUrlForCollection?: string | undefined;
 }
 export interface ExtensionCardFieldDefinition extends FieldDefinition {
     /** The label to display in the UI */
@@ -71,6 +80,7 @@ export type SerializedCardFieldOption = {
     'l': string;
     'v'?: SerializedFieldType;
     'i'?: string | undefined;
+    'ic'?: string | undefined;
 };
 /** @ignore */
 export declare function serializeCardFieldOption(option: ExtensionCardFieldOption): SerializedCardFieldOption;

package/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -27,11 +27,7 @@ exports.isSerializedCardUserData = (0, validators_1.objectValidator)({
 exports.isSerializedCardUserDataArray = (0, validators_1.arrayValidator)(exports.isSerializedCardUserData);
 /** @ignore */
 function serializeCardFieldOption(option) {
-    return {
-        'l': option.label,
-        'v': option.value,
-        'i': option.iconUrl,
-    };
+    return Object.assign({ 'l': option.label, 'v': option.value, 'i': option.iconUrl }, ((0, checks_1.isDefAndNotNull)(option.iconUrlForCollection) && { 'ic': option.iconUrlForCollection }));
 }
 exports.serializeCardFieldOption = serializeCardFieldOption;
 /** @ignore */
@@ -47,11 +43,7 @@ function serializeCardFieldArrayDefinition(fields) {
 exports.serializeCardFieldArrayDefinition = serializeCardFieldArrayDefinition;
 /** @ignore */
 function deserializeFieldOption(option) {
-    return {
-        label: option['l'],
-        value: option['v'],
-        iconUrl: option['i'],
-    };
+    return Object.assign({ label: option['l'], value: option['v'], iconUrl: option['i'] }, ((0, checks_1.isDefAndNotNull)(option['ic']) && { iconUrlForCollection: option['ic'] }));
 }
 exports.deserializeFieldOption = deserializeFieldOption;
 exports.isSerializedFieldOption = (0, validators_1.objectValidator)({

package/package.json

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