lucid-extension-sdk 0.0.412 → 0.0.414

package/core/data/luciduseravatar.d.ts

@@ -0,0 +1,10 @@
+import { SerializedLucidDictionary } from './serializedfield/serializedfields';
+/**
+ * Creates avatar data as a SerializedLucidDictionary.
+ * Useful for creating user avatars in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
+ *
+ * @param icon - The URL for the user's avatar
+ * @param userName - Used for tooltip on the avatar
+ * @returns A SerializedLucidDictionary with the keys: avatarUrl and userName
+ */
+export declare function createLucidUserAvatar(avatarUrl: string, userName: string): SerializedLucidDictionary;

package/core/data/luciduseravatar.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLucidUserAvatar = void 0;
+/**
+ * Creates avatar data as a SerializedLucidDictionary.
+ * Useful for creating user avatars in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
+ *
+ * @param icon - The URL for the user's avatar
+ * @param userName - Used for tooltip on the avatar
+ * @returns A SerializedLucidDictionary with the keys: avatarUrl and userName
+ */
+function createLucidUserAvatar(avatarUrl, userName) {
+    return {
+        dict: {
+            avatarUrl: avatarUrl,
+            userName: userName,
+        },
+    };
+}
+exports.createLucidUserAvatar = createLucidUserAvatar;

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

@@ -93,6 +93,12 @@ export declare const isSerializedLucidCurrency: (subject: unknown) => subject is
     a: typeof isNumber;
     t: typeof isString;
 }>;
+export declare const isSerializedLucidAvatarDataDictionary: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    dict: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+        avatarUrl: (x: unknown) => x is string | undefined;
+        userName: typeof isString;
+    }>;
+}>;
 export declare const isSerializedMillisecondsDateObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
     ms: typeof isNumber;
     isDateOnly: (x: unknown) => x is boolean | 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.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.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) {
@@ -20,6 +20,12 @@ exports.isSerializedLucidCurrency = (0, validators_1.objectValidator)({
     'a': checks_1.isNumber,
     't': checks_1.isString,
 });
+exports.isSerializedLucidAvatarDataDictionary = (0, validators_1.objectValidator)({
+    'dict': (0, validators_1.objectValidator)({
+        'avatarUrl': (0, validators_1.option)(checks_1.isString),
+        'userName': checks_1.isString,
+    }),
+});
 exports.isSerializedMillisecondsDateObject = (0, validators_1.objectValidator)({
     'ms': checks_1.isNumber,
     'isDateOnly': (0, validators_1.option)(checks_1.isBoolean),
@@ -52,7 +58,8 @@ function isSerializedFieldType(value) {
         (0, exports.isSerializedLucidDateObject)(value) ||
         (0, exports.isSerializedTimeObject)(value) ||
         isSerializedColorObjectFieldType(value) ||
-        (0, exports.isSerializedLucidIconDataDictionary)(value));
+        (0, exports.isSerializedLucidIconDataDictionary)(value) ||
+        (0, exports.isSerializedLucidAvatarDataDictionary)(value));
 }
 exports.isSerializedFieldType = isSerializedFieldType;
 function isSerializedJsonFieldType(value) {

package/document/documentelement/documentelementtype.d.ts

@@ -18,5 +18,6 @@ export declare enum DocumentElementType {
     ShapeSpecificDefaultProperties = "ShapeSpecificDefaultProperties",
     TrackedFormulaLocation = "TrackedFormulaLocation",
     ElementAlias = "ElementAlias",
-    GeneratorCardSyncConfig = "GeneratorCardSyncConfig"
+    GeneratorCardSyncConfig = "GeneratorCardSyncConfig",
+    ScenarioSet = "ScenarioSet"
 }

package/document/documentelement/documentelementtype.js

@@ -23,4 +23,5 @@ var DocumentElementType;
     DocumentElementType["TrackedFormulaLocation"] = "TrackedFormulaLocation";
     DocumentElementType["ElementAlias"] = "ElementAlias";
     DocumentElementType["GeneratorCardSyncConfig"] = "GeneratorCardSyncConfig";
+    DocumentElementType["ScenarioSet"] = "ScenarioSet";
 })(DocumentElementType || (exports.DocumentElementType = DocumentElementType = {}));

package/package.json

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