lucid-extension-sdk 0.0.384 → 0.0.385

package/core/data/lucidicon.d.ts

@@ -0,0 +1,11 @@
+import { SerializedLucidDictionary } from './serializedfield/serializedfields';
+/**
+ * Creates icon data as a SerializedLucidDictionary.
+ * Useful for creating icons in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
+ *
+ * @param icon - The URL or SVG data for the icon
+ * @param ariaLabel - The accessible label for the icon
+ * @param tooltipLabel - Optional tooltip text
+ * @returns A SerializedLucidDictionary with the keys: icon, ariaLabel, and tooltipLabel (if provided)
+ */
+export declare function createLucidIconData(icon: string, ariaLabel: string, tooltipLabel?: string): SerializedLucidDictionary;

package/core/data/lucidicon.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLucidIconData = void 0;
+/**
+ * Creates icon data as a SerializedLucidDictionary.
+ * Useful for creating icons in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
+ *
+ * @param icon - The URL or SVG data for the icon
+ * @param ariaLabel - The accessible label for the icon
+ * @param tooltipLabel - Optional tooltip text
+ * @returns A SerializedLucidDictionary with the keys: icon, ariaLabel, and tooltipLabel (if provided)
+ */
+function createLucidIconData(icon, ariaLabel, tooltipLabel) {
+    return {
+        ['dict']: Object.assign({ ['icon']: icon, ['ariaLabel']: ariaLabel }, (tooltipLabel ? { ['tooltipLabel']: tooltipLabel } : {})),
+    };
+}
+exports.createLucidIconData = createLucidIconData;

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

@@ -113,6 +113,13 @@ export declare const isSerializedTimeObject: (subject: unknown) => subject is im
     minutes: (x: unknown) => x is number | undefined;
     seconds: (x: unknown) => x is number | undefined;
 }>;
+export declare const isSerializedLucidIconDataDictionary: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    dict: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+        icon: typeof isString;
+        ariaLabel: typeof isString;
+        tooltipLabel: (x: unknown) => x is string | undefined;
+    }>;
+}>;
 export declare function isSerializedFieldType(value: any): value is SerializedFieldType;
 export declare function isSerializedJsonFieldType(value: any): value is SerializedJsonFieldType;
 export declare const isSerializedFields: (x: unknown) => x is Record<string | number, SerializedFieldType>;

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.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
+exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = 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) {
@@ -34,6 +34,13 @@ exports.isSerializedTimeObject = (0, validators_1.objectValidator)({
     'minutes': (0, validators_1.option)(checks_1.isNumber),
     'seconds': (0, validators_1.option)(checks_1.isNumber),
 });
+exports.isSerializedLucidIconDataDictionary = (0, validators_1.objectValidator)({
+    'dict': (0, validators_1.objectValidator)({
+        'icon': checks_1.isString,
+        'ariaLabel': checks_1.isString,
+        'tooltipLabel': (0, validators_1.option)(checks_1.isString),
+    }),
+});
 function isSerializedFieldType(value) {
     return (value == null ||
         (0, checks_1.isNumber)(value) ||
@@ -44,7 +51,8 @@ function isSerializedFieldType(value) {
         ((0, checks_1.isArray)(value) && value.every(isSerializedFieldType)) ||
         (0, exports.isSerializedLucidDateObject)(value) ||
         (0, exports.isSerializedTimeObject)(value) ||
-        isSerializedColorObjectFieldType(value));
+        isSerializedColorObjectFieldType(value) ||
+        (0, exports.isSerializedLucidIconDataDictionary)(value));
 }
 exports.isSerializedFieldType = isSerializedFieldType;
 function isSerializedJsonFieldType(value) {

package/package.json

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