lucid-extension-sdk 0.0.331 → 0.0.334

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

@@ -2,6 +2,7 @@ import { isObject, isString } from '../../checks';
 import { SerializedDataItems } from '../serializedfield/serializeddataitems';
 import { SerializedSchema, isSerializedSchema } from '../serializedfield/serializedschema';
 import { SerializedDataSourceProperties } from './serializeddatasourceproperties';
+import { UpdateCreationPermission } from './updatecreationpermission';
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedImportedMetadataCollection {
     'Name': string;
@@ -44,6 +45,7 @@ export declare const isSerializedImportedCollection: (subject: unknown) => subje
 export interface SerializedImportedDataSource {
     'Properties': SerializedDataSourceProperties;
     'Collections': SerializedImportedCollection[];
+    'CreationPermission'?: UpdateCreationPermission | undefined;
 }
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare const isSerializedImportedDataSource: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
@@ -53,11 +55,10 @@ export declare const isSerializedImportedDataSource: (subject: unknown) => subje
             SourceType: (x: unknown) => x is import("./datasourcetype").DataSourceType;
             UpdateType: (x: unknown) => x is import("./upstreamupdatetype").UpstreamUpdateType;
             PatchType: (x: unknown) => x is import("./upstreampatchtype").UpstreamPatchType | null | undefined;
-            IsSyncingPaused: (x: unknown) => x is true | undefined;
+            IsSyncingPaused: (x: unknown) => x is true | undefined; /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
             SourceConfig: typeof isObject;
         }> | null | undefined;
         SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
-            /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
             Id: typeof isString;
             SourceFields: (p1: unknown) => p1 is string[];
             RelationshipType: (x: unknown) => x is string | undefined;
@@ -93,11 +94,10 @@ export declare const isSerializedPreviewData: (subject: unknown) => subject is i
             SourceType: (x: unknown) => x is import("./datasourcetype").DataSourceType;
             UpdateType: (x: unknown) => x is import("./upstreamupdatetype").UpstreamUpdateType;
             PatchType: (x: unknown) => x is import("./upstreampatchtype").UpstreamPatchType | null | undefined;
-            IsSyncingPaused: (x: unknown) => x is true | undefined;
+            IsSyncingPaused: (x: unknown) => x is true | undefined; /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
             SourceConfig: typeof isObject;
         }> | null | undefined;
         SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
-            /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
             Id: typeof isString;
             SourceFields: (p1: unknown) => p1 is string[];
             RelationshipType: (x: unknown) => x is string | undefined;

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

@@ -0,0 +1,21 @@
+/**
+ * UpdateCreationPermission is used by data source updates from third party data integrations to indicate
+ * how much data that particular request is allowed to create. If the data source update would require creating
+ * something at a higher level of permission, the request will fail.
+ *
+ * The levels are 'DataSource', 'Collection', 'Item', and 'None'. 'DataSource' is the most permissive, allowing the
+ * update to create new data sources and anything contained in them (i.e. collections and items). 'Collection' allows
+ * the update to create new collections and items only in existing data sources. 'Item' allows the update to modify the contents
+ * of existing on-document collections, but not to create the collections or data sources needed to hold them.
+ *
+ * The original purpose of this parameter was to make it so that in-flight patches to edit on-document data could not
+ * accidentally re-create a collection that the user had manually deleted while the patch was in-flight.
+ */
+declare const creationPermissionOrdering: readonly ['DataSource', 'Collection', 'Item', 'None'];
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export type UpdateCreationPermission = (typeof creationPermissionOrdering)[number];
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare const isUpdateCreationPermission: (x: unknown) => x is "DataSource" | "Collection" | "Item" | "None";
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare function isAsPermissiveAs(permission: UpdateCreationPermission, targetPermission: UpdateCreationPermission): boolean;
+export {};

package/core/data/datasource/updatecreationpermission.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * UpdateCreationPermission is used by data source updates from third party data integrations to indicate
+ * how much data that particular request is allowed to create. If the data source update would require creating
+ * something at a higher level of permission, the request will fail.
+ *
+ * The levels are 'DataSource', 'Collection', 'Item', and 'None'. 'DataSource' is the most permissive, allowing the
+ * update to create new data sources and anything contained in them (i.e. collections and items). 'Collection' allows
+ * the update to create new collections and items only in existing data sources. 'Item' allows the update to modify the contents
+ * of existing on-document collections, but not to create the collections or data sources needed to hold them.
+ *
+ * The original purpose of this parameter was to make it so that in-flight patches to edit on-document data could not
+ * accidentally re-create a collection that the user had manually deleted while the patch was in-flight.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAsPermissiveAs = exports.isUpdateCreationPermission = void 0;
+const creationPermissionOrdering = [
+    'DataSource',
+    'Collection',
+    'Item',
+    'None',
+];
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+const isUpdateCreationPermission = (x) => creationPermissionOrdering.find((p) => p === x) !== undefined;
+exports.isUpdateCreationPermission = isUpdateCreationPermission;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+function isAsPermissiveAs(permission, targetPermission) {
+    for (const p of creationPermissionOrdering) {
+        if (p === permission) {
+            return true;
+        }
+        else if (p === targetPermission) {
+            return false;
+        }
+    }
+    return false;
+}
+exports.isAsPermissiveAs = isAsPermissiveAs;

package/dataconnector/actions/action.d.ts

@@ -13,6 +13,8 @@ export declare class DataConnectorActionContext {
     packageVersion: string;
     /** The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with */
     userCredential: string;
+    /** @ignore Boolean indicating whether to use a proxy server when making a request to third party */
+    useOutboundProxy: boolean | undefined;
     /** The data connector name from manifest.json that triggered this action */
     dataConnectorName: string;
     /** The installation id of the extension/user that triggered this action */
@@ -32,6 +34,8 @@ export declare class DataConnectorActionContext {
     packageVersion: string, 
     /** The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with */
     userCredential: string, 
+    /** @ignore Boolean indicating whether to use a proxy server when making a request to third party */
+    useOutboundProxy: boolean | undefined, 
     /** The data connector name from manifest.json that triggered this action */
     dataConnectorName: string, 
     /** The installation id of the extension/user that triggered this action */

package/dataconnector/actions/action.js

@@ -13,6 +13,8 @@ class DataConnectorActionContext {
     packageVersion, 
     /** The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with */
     userCredential, 
+    /** @ignore Boolean indicating whether to use a proxy server when making a request to third party */
+    useOutboundProxy, 
     /** The data connector name from manifest.json that triggered this action */
     dataConnectorName, 
     /** The installation id of the extension/user that triggered this action */
@@ -26,6 +28,7 @@ class DataConnectorActionContext {
         this.packageId = packageId;
         this.packageVersion = packageVersion;
         this.userCredential = userCredential;
+        this.useOutboundProxy = useOutboundProxy;
         this.dataConnectorName = dataConnectorName;
         this.installationId = installationId;
         this.documentCollections = documentCollections;

package/dataconnector/actions/patch.d.ts

@@ -1,3 +1,4 @@
+import { UpdateCreationPermission } from '../../core/data/datasource/updatecreationpermission';
 import { FieldTypeDefinition } from '../../core/data/fieldtypedefinition/fieldtypedefinition';
 import { CollectionId, PatchItems } from './action';
 import { PatchChange, PatchChangeCollection } from './patchresponsebody';
@@ -18,7 +19,7 @@ export declare abstract class Patch {
     syncSourceId: string, 
     /** The syncCollectionId of the changed collection */
     syncCollectionId: CollectionId);
-    getChange(collections?: PatchChangeCollection[]): PatchChange;
+    getChange(collections?: PatchChangeCollection[], creationPermission?: UpdateCreationPermission | undefined): PatchChange;
     abstract toJSON(): object;
     abstract clone(): this;
 }

package/dataconnector/actions/patch.js

@@ -24,8 +24,8 @@ class Patch {
         this.syncSourceId = syncSourceId;
         this.syncCollectionId = syncCollectionId;
     }
-    getChange(collections = []) {
-        return new patchresponsebody_1.PatchChange(this.id, this.syncSourceId, collections);
+    getChange(collections = [], creationPermission = undefined) {
+        return new patchresponsebody_1.PatchChange(this.id, this.syncSourceId, collections, creationPermission);
     }
 }
 exports.Patch = Patch;

package/dataconnector/actions/patchresponsebody.d.ts

@@ -1,3 +1,4 @@
+import { UpdateCreationPermission } from '../../core/data/datasource/updatecreationpermission';
 import { SchemaDefinition } from '../../data/schemadefinition';
 import { ItemsPatch, SerializedItemsPatch, SerializedSchemaForApi } from '../datasourceupdatetypes';
 export type PatchChangeCollection = {
@@ -12,8 +13,9 @@ export declare class PatchChange {
     patchId: string;
     syncId: string;
     collections: PatchChangeCollection[];
+    creationPermission?: "DataSource" | "Collection" | "Item" | "None" | undefined;
     private errors;
-    constructor(patchId: string, syncId: string, collections: PatchChangeCollection[]);
+    constructor(patchId: string, syncId: string, collections: PatchChangeCollection[], creationPermission?: "DataSource" | "Collection" | "Item" | "None" | undefined);
     setError(primaryKey: string, fieldName: string, error: string): void;
     setTooltipError(primaryKey: string, error: string): void;
     getErrors(): Record<string, Record<string, string>>;
@@ -31,6 +33,7 @@ export type SerializedPatchChange = {
         'itemsPatch': SerializedItemsPatch;
         'schema'?: SerializedSchemaForApi;
     }[];
+    'creationPermission'?: UpdateCreationPermission | undefined;
 };
 /** Wire format for "Patch" Action responses */
 export type SerializedPatchResponseBody = {

package/dataconnector/actions/patchresponsebody.js

@@ -7,10 +7,11 @@ const datasourceupdatetypes_1 = require("../datasourceupdatetypes");
  * Reports a completed change back to Lucid
  */
 class PatchChange {
-    constructor(patchId, syncId, collections) {
+    constructor(patchId, syncId, collections, creationPermission) {
         this.patchId = patchId;
         this.syncId = syncId;
         this.collections = collections;
+        this.creationPermission = creationPermission;
         this.errors = {};
     }
     setError(primaryKey, fieldName, error) {
@@ -36,6 +37,7 @@ function serializePatchResponse(patchChange) {
         'collections': patchChange.collections.map((c) => {
             return Object.assign({ 'collectionId': c.collectionId, 'itemsPatch': (0, datasourceupdatetypes_1.serializeItemsPatch)(c.itemsPatch) }, (c.schema != null ? { 'schema': (0, datasourceupdatetypes_1.serializeSchemaForApi)(c.schema) } : undefined));
         }),
+        'creationPermission': patchChange.creationPermission,
     };
 }
 exports.serializePatchResponse = serializePatchResponse;

package/dataconnector/actions/serializedactions.js

@@ -17,6 +17,7 @@ const serializedActionsBaseValidator = (0, validators_1.objectValidator)({
     dataConnectorName: checks_1.isString,
     installationId: (0, validators_1.nullableOption)(checks_1.isString),
     userCredential: (0, validators_1.nullableOption)(checks_1.isString),
+    useOutboundProxy: (0, validators_1.option)(checks_1.isBoolean),
     documentUpdateToken: (0, validators_1.nullableOption)(checks_1.isString),
     documentCollections: (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
     updateFilterType: (0, validators_1.enumValidator)(dataupdatefiltertype_1.DataUpdateFilterType),
@@ -29,6 +30,7 @@ const serializedPatchDataValidator = (0, validators_1.objectValidator)({
         id: checks_1.isString,
     })),
     userCredential: checks_1.isString,
+    useOutboundProxy: (0, validators_1.option)(checks_1.isBoolean),
     documentUpdateToken: checks_1.isString,
     timezone: (0, validators_1.nullableOption)(checks_1.isString),
 });
@@ -62,7 +64,8 @@ function deserializeActions(client, actions, patchParser) {
         }
         const parsedData = data
             .map((item) => {
-            const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], item['packageVersion'], item['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
+            const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], item['packageVersion'], item['userCredential'], item['useOutboundProxy'], // Use from action data and ignores the useOutboundProxy boolean in parsedActions
+            parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
             const patches = parseSerializedPatches(item['patches'], patchParser);
             if (patches.length < item['patches'].length) {
                 return undefined;
@@ -84,7 +87,7 @@ function deserializeActions(client, actions, patchParser) {
         if (!serializedPatchDataValidator(data)) {
             return;
         }
-        const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
+        const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['useOutboundProxy'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
         const parsedPatches = parseSerializedPatches(data['patches'], patchParser);
         if (parsedPatches.length < data['patches'].length) {
             console.log(`Failing validation step`);
@@ -94,7 +97,7 @@ function deserializeActions(client, actions, patchParser) {
             new action_1.DataConnectorPatchAction(context, parsedPatches, client.getDataSourceClient(data['documentUpdateToken']), dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch),
         ];
     }
-    const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
+    const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['useOutboundProxy'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType'], parsedActions['timezone']);
     if (name == 'ManageWebhook') {
         if (!serializedManageWebhookDataValidator(data)) {
             return;

package/dataconnector/datasourceclient.js

@@ -25,7 +25,7 @@ class DataSourceClient {
         const dataSyncUrl = urls.dataSync;
         this.metadataUrl = (0, checks_1.isString)(dataSyncUrl) ? `${dataSyncUrl}dataSource/metadata` : undefined;
     }
-    formatBody({ dataSourceName, collections, updateFilterType, dataSourceConfiguration, sourceForeignKeys, }) {
+    formatBody({ dataSourceName, collections, updateFilterType, dataSourceConfiguration, sourceForeignKeys, creationPermission, }) {
         const updateData = {};
         for (const collectionId in collections) {
             updateData[collectionId] = (0, datasourceupdatetypes_1.serializeCollectionPatch)(collections[collectionId]);
@@ -43,6 +43,7 @@ class DataSourceClient {
             'name': dataSourceName,
             'upstreamConfig': (0, upstreamconfig_1.serializeUpstreamConfig)(upstreamConfig),
             'sourceForeignKeys': foreignKeys,
+            'creationPermission': creationPermission,
         };
     }
     /** 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,5 +1,6 @@
 import { SemanticCollection } from '../core/data/datasource/semanticcollection';
 import { SourceForeignKey } from '../core/data/datasource/sourceforeignkeys';
+import { UpdateCreationPermission } from '../core/data/datasource/updatecreationpermission';
 import { UpstreamPatchType } from '../core/data/datasource/upstreampatchtype';
 import { SerializedFieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
 import { LucidFields } from '../core/data/fieldtypedefinition/lucidfields';
@@ -28,6 +29,8 @@ export type DataSourceRequest = {
     };
     /** Configuration for relationships between collections in the data source */
     sourceForeignKeys?: SourceForeignKey[];
+    /** The level of permission the request has to create data */
+    creationPermission?: UpdateCreationPermission;
 };
 type SerializedFieldConstraintForApi = {
     'type': FieldConstraintType;

package/package.json

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