lucid-extension-sdk 0.0.237 → 0.0.238

package/core/data/datasource/semanticcollection.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Used to define what a collection implicitly represents.
+ *
+ * SemanticCollection.Items indicates that the collection's contents should be visualized as distinct elements (such as cards) that can be compared.
+ *
+ * We currently only have one value in this enum. More will be added in the future.
+ *
+ * The values in this enum are purposely generic.
+ */
+export declare enum SemanticCollection {
+    Items = "Items"
+}
+export declare const isSemanticCollection: (x: unknown) => x is SemanticCollection.Items;

package/core/data/datasource/semanticcollection.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSemanticCollection = exports.SemanticCollection = void 0;
+const validators_1 = require("../../validators/validators");
+/**
+ * Used to define what a collection implicitly represents.
+ *
+ * SemanticCollection.Items indicates that the collection's contents should be visualized as distinct elements (such as cards) that can be compared.
+ *
+ * We currently only have one value in this enum. More will be added in the future.
+ *
+ * The values in this enum are purposely generic.
+ */
+var SemanticCollection;
+(function (SemanticCollection) {
+    SemanticCollection["Items"] = "Items";
+})(SemanticCollection || (exports.SemanticCollection = SemanticCollection = {}));
+exports.isSemanticCollection = (0, validators_1.enumValidator)(SemanticCollection);

package/dataconnector/datasourceupdatetypes.d.ts

@@ -1,3 +1,4 @@
+import { SemanticCollection } from '../core/data/datasource/semanticcollection';
 import { UpstreamPatchType } from '../core/data/datasource/upstreampatchtype';
 import { SerializedFieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
 import { SemanticFields } from '../core/data/fieldtypedefinition/semanticfields';
@@ -40,9 +41,13 @@ type SerializedSchemaForApi = {
     'primaryKey': string[];
     'fieldLabelOverrides'?: SerializedLabelOverrides | undefined;
 };
+type serializedPropertiesForApi = {
+    'Represents': SemanticCollection[];
+};
 export interface SerializedCollectionPatch {
     'schema'?: SerializedSchemaForApi;
     'itemsPatch': SerializedItemsPatch;
+    'properties'?: serializedPropertiesForApi;
 }
 export declare class ItemsPatchInexhaustive {
     /**
@@ -105,6 +110,8 @@ export interface CollectionPatch {
     schema?: SchemaDefinition;
     /** The patch to apply to the collection */
     patch: ItemsPatch;
+    /** What the collection implicitly represents **/
+    represents?: SemanticCollection[];
 }
 /** @ignore */
 export declare function serializeFieldDefinitionForApi(field: FieldDefinition): SerializedFieldDefinitionForApi;

package/dataconnector/datasourceupdatetypes.js

@@ -68,10 +68,16 @@ function serializeSchemaForApi(schema) {
         'fieldLabelOverrides': schema.fieldLabels,
     };
 }
+function serializeRepresentsAsPropertyForApi(represents) {
+    return {
+        'Represents': represents, // key needs to match 'Represents' key in cake/app/webroot/ts/property/collection/collectionproperties.ts
+    };
+}
 function serializeCollectionPatch(patch) {
     return {
         'schema': patch.schema && serializeSchemaForApi(patch.schema),
         'itemsPatch': serializeItemsPatch(patch.patch),
+        'properties': patch.represents && serializeRepresentsAsPropertyForApi(patch.represents),
     };
 }
 exports.serializeCollectionPatch = serializeCollectionPatch;

package/package.json

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