lucid-extension-sdk 0.0.237 → 0.0.239

package/core/data/datasource/datasourceutils.js

@@ -6,6 +6,7 @@ const checks_1 = require("../../checks");
 const scalarfieldtype_1 = require("../fieldtypedefinition/scalarfieldtype");
 const alphabet_1 = require("./alphabet");
 const datasourcetype_1 = require("./datasourcetype");
+const spreadsheetpossibledatatypes_1 = require("./spreadsheetpossibledatatypes");
 const upstreamupdatetype_1 = require("./upstreamupdatetype");
 /** @ignore */
 function _alphabetize(n) {
@@ -77,7 +78,7 @@ function makePrimaryCollectionSchema(rawSchemaFields, data, schemaFromData) {
     schemaFields.forEach((field, index) => {
         const finalFieldName = makeNameReadablyUnique(field, usedFieldsNormalized);
         usedFieldsNormalized.add(normalizeName(finalFieldName));
-        fields.push({ 'Name': finalFieldName, 'Type': scalarfieldtype_1.ScalarFieldTypeEnum.ANY });
+        fields.push({ 'Name': finalFieldName, 'Type': spreadsheetpossibledatatypes_1.SpreadSheetPossibleDataTypes });
         oldToNewFields.set(rawSchemaFields[index], finalFieldName);
     });
     const oldPrimaryKeys = (_b = schemaFromData === null || schemaFromData === void 0 ? void 0 : schemaFromData.primaryKey) !== null && _b !== void 0 ? _b : [];

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/core/data/datasource/spreadsheetpossibledatatypes.d.ts

@@ -0,0 +1,2 @@
+import { ScalarFieldTypeEnum } from '../fieldtypedefinition/scalarfieldtype';
+export declare const SpreadSheetPossibleDataTypes: ScalarFieldTypeEnum[];

package/core/data/datasource/spreadsheetpossibledatatypes.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpreadSheetPossibleDataTypes = void 0;
+const scalarfieldtype_1 = require("../fieldtypedefinition/scalarfieldtype");
+exports.SpreadSheetPossibleDataTypes = [
+    scalarfieldtype_1.ScalarFieldTypeEnum.BOOLEAN,
+    scalarfieldtype_1.ScalarFieldTypeEnum.NUMBER,
+    scalarfieldtype_1.ScalarFieldTypeEnum.STRING,
+    scalarfieldtype_1.ScalarFieldTypeEnum.NULL,
+    scalarfieldtype_1.ScalarFieldTypeEnum.CURRENCY,
+    scalarfieldtype_1.ScalarFieldTypeEnum.DATE,
+    scalarfieldtype_1.ScalarFieldTypeEnum.COLOR,
+];

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 {
     /**
@@ -64,8 +69,9 @@ export declare class ItemsPatchInexhaustive {
 }
 export declare class ItemsPatchExhaustive {
     items: Map<string, SerializedFields>;
+    renamingMap?: Map<string, string | null> | undefined;
     errors?: Map<string, SerializedLucidDictionary> | undefined;
-    constructor(items: Map<string, SerializedFields>, errors?: Map<string, SerializedLucidDictionary> | undefined);
+    constructor(items: Map<string, SerializedFields>, renamingMap?: Map<string, string | null> | undefined, errors?: Map<string, SerializedLucidDictionary> | undefined);
 }
 export type ItemsPatch = {
     /**
@@ -84,6 +90,7 @@ export type SerializedItemsPatch = {
     'errors'?: Record<string, SerializedLucidDictionary>;
 } | {
     'exhaustiveItems': Record<string, SerializedFields>;
+    'renamingMap'?: Record<string, string | null>;
     'errors'?: Record<string, SerializedLucidDictionary>;
 };
 export declare function serializeItemsPatch(patch: ItemsPatch): SerializedItemsPatch;
@@ -105,6 +112,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

@@ -20,24 +20,23 @@ class ItemsPatchInexhaustive {
 }
 exports.ItemsPatchInexhaustive = ItemsPatchInexhaustive;
 class ItemsPatchExhaustive {
-    constructor(items, errors) {
+    constructor(items, renamingMap, errors) {
         this.items = items;
+        this.renamingMap = renamingMap;
         this.errors = errors;
     }
 }
 exports.ItemsPatchExhaustive = ItemsPatchExhaustive;
 function serializeErrors(errors) {
-    if (!errors) {
-        return undefined;
-    }
-    const serializedErrors = {};
-    errors.forEach((dictionary, key) => (serializedErrors[key] = dictionary));
-    return { 'errors': serializedErrors };
+    return errors && { 'errors': (0, object_1.fromEntries)(errors) };
+}
+function serializeRenamingMap(renamingMap) {
+    return renamingMap && { 'renamingMap': (0, object_1.fromEntries)(renamingMap) };
 }
 function serializeItemsPatch(patch) {
     var _a;
     if (patch instanceof ItemsPatchExhaustive) {
-        return Object.assign({ 'exhaustiveItems': (0, object_1.fromEntries)(patch.items.entries()) }, serializeErrors(patch.errors));
+        return Object.assign(Object.assign({ 'exhaustiveItems': (0, object_1.fromEntries)(patch.items.entries()) }, serializeRenamingMap(patch.renamingMap)), serializeErrors(patch.errors));
     }
     else {
         return Object.assign({ 'items': (0, object_1.fromEntries)(patch.items.entries()), 'itemsDeleted': (_a = patch.itemsDeleted) !== null && _a !== void 0 ? _a : [] }, serializeErrors(patch.errors));
@@ -68,10 +67,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.239",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",