lucid-extension-sdk 0.0.195 → 0.0.197

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

@@ -0,0 +1,19 @@
+import { JsonObject } from '../../jsonserializable';
+import { DataSourceType } from './datasourcetype';
+import { SerializedUpstreamConfig } from './serializedupstreamconfig';
+import { UpstreamPatchType } from './upstreampatchtype';
+import { UpstreamUpdateType } from './upstreamupdatetype';
+export interface UpstreamConfig {
+    dataSourceType: DataSourceType;
+    updateType: UpstreamUpdateType;
+    patchType?: UpstreamPatchType | undefined;
+    sourceConfig: {
+        [index: string]: any;
+    };
+}
+export declare function serializeUpstreamConfig(config: UpstreamConfig): SerializedUpstreamConfig;
+export declare function deserializeUpstreamConfig(config: SerializedUpstreamConfig): UpstreamConfig;
+export interface SerializedSourceConfig {
+    [primaryKey: string]: JsonObject;
+}
+export declare function isSerializedSourceConfig(x: unknown): x is SerializedSourceConfig;

package/core/data/datasource/upstreamconfig.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSerializedSourceConfig = exports.deserializeUpstreamConfig = exports.serializeUpstreamConfig = void 0;
+const checks_1 = require("../../checks");
+function serializeUpstreamConfig(config) {
+    return {
+        'SourceType': config.dataSourceType,
+        'UpdateType': config.updateType,
+        'PatchType': config.patchType,
+        'SourceConfig': config.sourceConfig,
+    };
+}
+exports.serializeUpstreamConfig = serializeUpstreamConfig;
+function deserializeUpstreamConfig(config) {
+    return {
+        dataSourceType: config['SourceType'],
+        updateType: config['UpdateType'],
+        patchType: config['PatchType'] === null ? undefined : config['PatchType'],
+        sourceConfig: config['SourceConfig'],
+    };
+}
+exports.deserializeUpstreamConfig = deserializeUpstreamConfig;
+function isSerializedSourceConfig(x) {
+    return (0, checks_1.isObject)(x);
+}
+exports.isSerializedSourceConfig = isSerializedSourceConfig;

package/dataconnector/datasourceclient.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MockDataSourceClient = exports.DataSourceClient = void 0;
 const checks_1 = require("../core/checks");
+const datasourcetype_1 = require("../core/data/datasource/datasourcetype");
+const upstreamconfig_1 = require("../core/data/datasource/upstreamconfig");
+const upstreamupdatetype_1 = require("../core/data/datasource/upstreamupdatetype");
 const result_1 = require("../core/result");
 const validators_1 = require("../core/validators/validators");
 const dataconnector_1 = require("./dataconnector");
@@ -21,15 +24,21 @@ class DataSourceClient {
         const dataSyncUrl = urls.dataSync;
         this.metadataUrl = (0, checks_1.isString)(dataSyncUrl) ? `${dataSyncUrl}dataSource/metadata` : undefined;
     }
-    formatBody({ dataSourceName, collections }) {
+    formatBody({ dataSourceName, collections, dataSourceConfiguration }) {
         const updateData = {};
         for (const collectionId in collections) {
             updateData[collectionId] = (0, datasourceupdatetypes_1.serializeCollectionPatch)(collections[collectionId]);
         }
+        const upstreamConfig = {
+            dataSourceType: datasourcetype_1.DataSourceType.DataService,
+            updateType: upstreamupdatetype_1.UpstreamUpdateType.EVENTPULL,
+            patchType: dataSourceConfiguration === null || dataSourceConfiguration === void 0 ? void 0 : dataSourceConfiguration.patchType,
+            sourceConfig: {},
+        };
         return {
             'updateData': updateData,
             'name': dataSourceName,
-            // ...upstreamConfig,
+            'upstreamConfig': (0, upstreamconfig_1.serializeUpstreamConfig)(upstreamConfig),
         };
     }
     /** Create or update a datasource. If you create a new collection it must be fully specified in terms of schema and

package/dataconnector/datasourceupdatetypes.d.ts

@@ -1,3 +1,4 @@
+import { UpstreamPatchType } from '../core/data/datasource/upstreampatchtype';
 import { SerializedFieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
 import { SemanticKind } from '../core/data/fieldtypedefinition/semantickind';
 import { FieldConstraintType } from '../core/data/serializedfield/serializedfielddefinition';
@@ -16,6 +17,11 @@ export type DataSourceRequest = {
     dataSourceName: string;
     /** Collections to add or update to the data source */
     collections: Record<string, CollectionPatch>;
+    /** Configuration for the data source to be added or modified */
+    dataSourceConfiguration?: {
+        /** Configures how changes made to the data are pushed to the external source */
+        patchType: UpstreamPatchType;
+    };
 };
 type SerializedFieldConstraintForApi = {
     'type': FieldConstraintType;

package/document/imagedefinition.d.ts

@@ -0,0 +1,15 @@
+import { SimpleImageFill } from '../core/properties/fillcolor';
+import { Box } from '../math';
+/**
+ * The information required to create a new image block on the current document
+ */
+export interface ImageDefinition {
+    /**
+     * The initial location and size of the block on the page.
+     */
+    boundingBox: Box;
+    /**
+     * Settings for using an image as the fill style of a block.
+     */
+    fillStyle: SimpleImageFill;
+}

package/document/imagedefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/document/pageproxy.d.ts

@@ -6,6 +6,7 @@ import { BlockProxy } from './blockproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
 import { GroupProxy } from './groupproxy';
+import { ImageDefinition } from './imagedefinition';
 import { LineDefinition } from './linedefinition';
 import { LineProxy } from './lineproxy';
 import { MapProxy } from './mapproxy';
@@ -72,6 +73,7 @@ export declare class PageProxy extends ElementProxy {
      * @returns The added line
      */
     addLine(def: LineDefinition): LineProxy;
+    addImage(def: ImageDefinition): Promise<BlockProxy>;
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/document/pageproxy.js

@@ -113,6 +113,10 @@ class PageProxy extends elementproxy_1.ElementProxy {
         line.setEndpoint2(def.endpoint2);
         return line;
     }
+    async addImage(def) {
+        await this.client.loadBlockClasses(['UserImage2Block']);
+        return this.addBlock(Object.assign({ className: 'UserImage2Block' }, def));
+    }
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/index.d.ts

@@ -12,6 +12,7 @@ export * from './core/data/datasource/metadatatypes';
 export * from './core/data/datasource/serializeddatasourceproperties';
 export * from './core/data/datasource/serializedimporteddatasource';
 export * from './core/data/datasource/serializedupstreamconfig';
+export * from './core/data/datasource/upstreamconfig';
 export * from './core/data/datasource/upstreampatchtype';
 export * from './core/data/datasource/upstreamupdatetype';
 export * from './core/data/fieldspecification';

package/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./core/data/datasource/metadatatypes"), exports);
 __exportStar(require("./core/data/datasource/serializeddatasourceproperties"), exports);
 __exportStar(require("./core/data/datasource/serializedimporteddatasource"), exports);
 __exportStar(require("./core/data/datasource/serializedupstreamconfig"), exports);
+__exportStar(require("./core/data/datasource/upstreamconfig"), exports);
 __exportStar(require("./core/data/datasource/upstreampatchtype"), exports);
 __exportStar(require("./core/data/datasource/upstreamupdatetype"), exports);
 __exportStar(require("./core/data/fieldspecification"), exports);

package/package.json

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