@uniformdev/mesh-sdk 18.17.1-alpha.13 → 18.19.0

package/dist/index.d.ts

@@ -367,6 +367,7 @@ interface paths {
                 query: {
                     projectId: string;
                     type?: string;
+                    exactType?: boolean | null;
                     teamSpecificType?: boolean | null;
                 };
             };
@@ -410,6 +411,8 @@ interface paths {
                          * @description The project ID
                          */
                         projectId: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
+                        exactType?: boolean | null;
                         type: string;
                         data?: {
                             [key: string]: unknown;
@@ -441,6 +444,8 @@ interface paths {
                         projectId: string;
                         /** @description The integration type to remove */
                         type: string;
+                        /** @description Whether to match the passed type exactly or to treat the type as a prefix */
+                        exactType?: boolean | null;
                     };
                 };
             };

package/dist/index.esm.js

@@ -19,11 +19,13 @@ var _IntegrationDefinitionClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all mesh apps for a team (and optionally also those shared across teams) */
   async get(options) {
     const { teamId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url), { ...options, teamId });
     return await this.apiClient(fetchUri);
   }
+  /** Creates or updates a mesh app definition on a team */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     return await this.apiClient(fetchUri, {
@@ -31,6 +33,7 @@ var _IntegrationDefinitionClient = class extends ApiClient {
       body: JSON.stringify({ ...body, teamId: this.options.teamId })
     });
   }
+  /** Deletes a mesh app from a team */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     await this.apiClient(fetchUri, {
@@ -51,11 +54,13 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
   constructor(options) {
     super(options);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async getOne(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
@@ -65,6 +70,7 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
     }
     return response.results[0];
   }
+  /** Updates or creates (based on id) a IntegrationInstallation */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -73,6 +79,7 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
       expectNoContent: true
     });
   }
+  /** Deletes a IntegrationInstallation */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -215,9 +222,15 @@ var SharedClient = class {
       this.logger.log(reason);
     });
   }
+  /**
+   * Sends an event to the opposite client
+   */
   async send(eventType, data) {
     return this.postMessage("event" /* EVENT */, eventType, data);
   }
+  /**
+   * Subscribes an event handler for the given eventType. Returns an unsubscribe hook
+   */
   on(eventType, handler) {
     if (!this.eventSubscriptions[eventType]) {
       this.eventSubscriptions[eventType] = {};
@@ -230,6 +243,10 @@ var SharedClient = class {
       this.logger.log(`Unsubscribed handler for event ${eventType}`);
     };
   }
+  /**
+   * Sends a request to the opposite client. There must be an accompanying request handler
+   * subscribed with `onRequest`. Resolves with the returned data or times out.
+   */
   async request(requestKey, data, options = {}) {
     const sentMessage = await this.postMessage("request" /* REQUEST */, requestKey, data);
     const requestId = sentMessage.id;
@@ -264,6 +281,12 @@ var SharedClient = class {
       }, options.timeout || this.requestTimeout);
     });
   }
+  /**
+   * Subscribes a request handler for the given request key. The return value
+   * from the subscribed handler is sent back to the opposite client. The handler may be async.
+   * Unlike event handlers, there may be only one request handler per request key. Returns
+   * an unsubscribe hook.
+   */
   onRequest(requestKey, requestHandler) {
     const requestEventHandler = async (requestData, requestMessage) => {
       try {
@@ -278,6 +301,10 @@ var SharedClient = class {
       this.requestSubscriptions = omit(this.requestSubscriptions, requestKey);
     };
   }
+  /**
+   * A wrapper around the channel deferred object that also checks
+   * if the client has been destroyed before returning
+   */
   async getChannel() {
     await this.channel.promise;
     if (this.destroyed) {
@@ -592,6 +619,7 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue(value, options);
           },
+          // DEPRECATED
           getMetadata: () => contextData.locationMetadata,
           metadata: contextData.locationMetadata,
           setValidationResult: async (value) => {
@@ -613,6 +641,10 @@ async function initializeUniformMeshSDK({
         onHeightChange: (height) => {
           parent.resize(height);
         },
+        // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
+        // then we disable autoResizing for the dialog location.
+        // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
+        // developers very sad and confused. No one wants a sad and confused developer.
         autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
@@ -651,6 +683,7 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {

package/dist/index.js

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -52,11 +56,13 @@ var _IntegrationDefinitionClient = class extends import_api.ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all mesh apps for a team (and optionally also those shared across teams) */
   async get(options) {
     const { teamId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url), { ...options, teamId });
     return await this.apiClient(fetchUri);
   }
+  /** Creates or updates a mesh app definition on a team */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     return await this.apiClient(fetchUri, {
@@ -64,6 +70,7 @@ var _IntegrationDefinitionClient = class extends import_api.ApiClient {
       body: JSON.stringify({ ...body, teamId: this.options.teamId })
     });
   }
+  /** Deletes a mesh app from a team */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     await this.apiClient(fetchUri, {
@@ -84,11 +91,13 @@ var _IntegrationInstallationClient = class extends import_api2.ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async getOne(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
@@ -98,6 +107,7 @@ var _IntegrationInstallationClient = class extends import_api2.ApiClient {
     }
     return response.results[0];
   }
+  /** Updates or creates (based on id) a IntegrationInstallation */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -106,6 +116,7 @@ var _IntegrationInstallationClient = class extends import_api2.ApiClient {
       expectNoContent: true
     });
   }
+  /** Deletes a IntegrationInstallation */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -248,9 +259,15 @@ var SharedClient = class {
       this.logger.log(reason);
     });
   }
+  /**
+   * Sends an event to the opposite client
+   */
   async send(eventType, data) {
     return this.postMessage("event" /* EVENT */, eventType, data);
   }
+  /**
+   * Subscribes an event handler for the given eventType. Returns an unsubscribe hook
+   */
   on(eventType, handler) {
     if (!this.eventSubscriptions[eventType]) {
       this.eventSubscriptions[eventType] = {};
@@ -263,6 +280,10 @@ var SharedClient = class {
       this.logger.log(`Unsubscribed handler for event ${eventType}`);
     };
   }
+  /**
+   * Sends a request to the opposite client. There must be an accompanying request handler
+   * subscribed with `onRequest`. Resolves with the returned data or times out.
+   */
   async request(requestKey, data, options = {}) {
     const sentMessage = await this.postMessage("request" /* REQUEST */, requestKey, data);
     const requestId = sentMessage.id;
@@ -297,6 +318,12 @@ var SharedClient = class {
       }, options.timeout || this.requestTimeout);
     });
   }
+  /**
+   * Subscribes a request handler for the given request key. The return value
+   * from the subscribed handler is sent back to the opposite client. The handler may be async.
+   * Unlike event handlers, there may be only one request handler per request key. Returns
+   * an unsubscribe hook.
+   */
   onRequest(requestKey, requestHandler) {
     const requestEventHandler = async (requestData, requestMessage) => {
       try {
@@ -311,6 +338,10 @@ var SharedClient = class {
       this.requestSubscriptions = omit(this.requestSubscriptions, requestKey);
     };
   }
+  /**
+   * A wrapper around the channel deferred object that also checks
+   * if the client has been destroyed before returning
+   */
   async getChannel() {
     await this.channel.promise;
     if (this.destroyed) {
@@ -625,6 +656,7 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue(value, options);
           },
+          // DEPRECATED
           getMetadata: () => contextData.locationMetadata,
           metadata: contextData.locationMetadata,
           setValidationResult: async (value) => {
@@ -646,6 +678,10 @@ async function initializeUniformMeshSDK({
         onHeightChange: (height) => {
           parent.resize(height);
         },
+        // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
+        // then we disable autoResizing for the dialog location.
+        // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
+        // developers very sad and confused. No one wants a sad and confused developer.
         autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
@@ -684,6 +720,7 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {

package/dist/index.mjs

@@ -19,11 +19,13 @@ var _IntegrationDefinitionClient = class extends ApiClient {
   constructor(options) {
     super(options);
   }
+  /** Fetches all mesh apps for a team (and optionally also those shared across teams) */
   async get(options) {
     const { teamId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url), { ...options, teamId });
     return await this.apiClient(fetchUri);
   }
+  /** Creates or updates a mesh app definition on a team */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     return await this.apiClient(fetchUri, {
@@ -31,6 +33,7 @@ var _IntegrationDefinitionClient = class extends ApiClient {
       body: JSON.stringify({ ...body, teamId: this.options.teamId })
     });
   }
+  /** Deletes a mesh app from a team */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationDefinitionClient, _url));
     await this.apiClient(fetchUri, {
@@ -51,11 +54,13 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
   constructor(options) {
     super(options);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async get(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
+  /** Fetches all IntegrationInstallations for a project */
   async getOne(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2), { ...options, projectId });
@@ -65,6 +70,7 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
     }
     return response.results[0];
   }
+  /** Updates or creates (based on id) a IntegrationInstallation */
   async upsert(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -73,6 +79,7 @@ var _IntegrationInstallationClient = class extends ApiClient2 {
       expectNoContent: true
     });
   }
+  /** Deletes a IntegrationInstallation */
   async remove(body) {
     const fetchUri = this.createUrl(__privateGet(_IntegrationInstallationClient, _url2));
     await this.apiClient(fetchUri, {
@@ -215,9 +222,15 @@ var SharedClient = class {
       this.logger.log(reason);
     });
   }
+  /**
+   * Sends an event to the opposite client
+   */
   async send(eventType, data) {
     return this.postMessage("event" /* EVENT */, eventType, data);
   }
+  /**
+   * Subscribes an event handler for the given eventType. Returns an unsubscribe hook
+   */
   on(eventType, handler) {
     if (!this.eventSubscriptions[eventType]) {
       this.eventSubscriptions[eventType] = {};
@@ -230,6 +243,10 @@ var SharedClient = class {
       this.logger.log(`Unsubscribed handler for event ${eventType}`);
     };
   }
+  /**
+   * Sends a request to the opposite client. There must be an accompanying request handler
+   * subscribed with `onRequest`. Resolves with the returned data or times out.
+   */
   async request(requestKey, data, options = {}) {
     const sentMessage = await this.postMessage("request" /* REQUEST */, requestKey, data);
     const requestId = sentMessage.id;
@@ -264,6 +281,12 @@ var SharedClient = class {
       }, options.timeout || this.requestTimeout);
     });
   }
+  /**
+   * Subscribes a request handler for the given request key. The return value
+   * from the subscribed handler is sent back to the opposite client. The handler may be async.
+   * Unlike event handlers, there may be only one request handler per request key. Returns
+   * an unsubscribe hook.
+   */
   onRequest(requestKey, requestHandler) {
     const requestEventHandler = async (requestData, requestMessage) => {
       try {
@@ -278,6 +301,10 @@ var SharedClient = class {
       this.requestSubscriptions = omit(this.requestSubscriptions, requestKey);
     };
   }
+  /**
+   * A wrapper around the channel deferred object that also checks
+   * if the client has been destroyed before returning
+   */
   async getChannel() {
     await this.channel.promise;
     if (this.destroyed) {
@@ -592,6 +619,7 @@ async function initializeUniformMeshSDK({
             sdk.events.emit("onValueChanged", { newValue: value });
             await parent.setValue(value, options);
           },
+          // DEPRECATED
           getMetadata: () => contextData.locationMetadata,
           metadata: contextData.locationMetadata,
           setValidationResult: async (value) => {
@@ -613,6 +641,10 @@ async function initializeUniformMeshSDK({
         onHeightChange: (height) => {
           parent.resize(height);
         },
+        // If we're in a dialog context and the dialog was opened with a specified `contentHeight`,
+        // then we disable autoResizing for the dialog location.
+        // Otherwise, autoResizing will likely "overwrite" the specified `contentHeight` value, making
+        // developers very sad and confused. No one wants a sad and confused developer.
         autoResizingDisabled: ((_a = contextData.dialogContext) == null ? void 0 : _a.contentHeight) ? true : autoResizingDisabled
       }),
       version: contextData.uniformApiVersion,
@@ -651,6 +683,7 @@ async function initializeUniformMeshSDK({
           return;
         }
         return {
+          /** @deprecated don't use this */
           dialogId: result.dialogId,
           value: result.value,
           closeDialog: async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "18.17.1-alpha.13+77f2eaabc",
+  "version": "18.19.0",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -22,7 +22,8 @@
     "test": "jest --maxWorkers=1 --passWithNoTests",
     "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
-    "update-openapi": "tsx ./scripts/update-openapi.cts"
+    "update-openapi": "tsx ./scripts/update-openapi.cts",
+    "document": "api-extractor run --local"
   },
   "files": [
     "/dist"
@@ -31,9 +32,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.17.1-alpha.13+77f2eaabc",
-    "@uniformdev/context": "18.17.1-alpha.13+77f2eaabc",
+    "@uniformdev/canvas": "18.19.0",
+    "@uniformdev/context": "18.19.0",
     "mitt": "^3.0.0"
   },
-  "gitHead": "77f2eaabc380a8251c040f8bdd21d5451351022f"
+  "gitHead": "bd4414826a6d38b928b5ba2ea68e58160b784562"
 }