lucid-extension-sdk 0.0.182 → 0.0.184

package/commandtypes.d.ts

@@ -54,6 +54,7 @@ export declare const enum CommandName {
     ElementExists = "ee",
     ExecuteFormula = "ef",
     FindAvailableSpace = "fas",
+    GetOAuthClientId = "goci",
     GetConnectedLines = "gcl",
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
@@ -274,6 +275,10 @@ export type CommandArgs = {
         query: FindAvailableSpaceQuery;
         result: FindAvailableSpaceResult;
     };
+    [CommandName.GetOAuthClientId]: {
+        query: GetOAuthClientIdQuery;
+        result: GetOAuthClientIdResult;
+    };
     [CommandName.GetConnectedLines]: {
         query: GetConnectedLinesQuery;
         result: GetConnectedLinesResult;
@@ -1003,6 +1008,11 @@ export type GetOAuthTokenQuery = {
 export type GetOAuthTokenResult = Promise<string | undefined>;
 export type GetProductQuery = undefined;
 export type GetProductResult = LucidProduct;
+export type GetOAuthClientIdQuery = {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
+export type GetOAuthClientIdResult = Promise<string | undefined>;
 export type GetPropertyQuery = {
     /** ID of the LucidElement to read a property from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;

package/commandtypes.js

@@ -34,6 +34,7 @@ exports.commandTitles = new Map([
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
     ["fas" /* CommandName.FindAvailableSpace */, 'FindAvailableSpace'],
+    ["goci" /* CommandName.GetOAuthClientId */, 'GetOAuthClientId'],
     ["gcl" /* CommandName.GetConnectedLines */, 'GetConnectedLines'],
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],

package/editorclient.d.ts

@@ -139,12 +139,19 @@ export declare class EditorClient {
     oauthXhr(providerName: string, request: OAuthXHRRequest): Promise<XHRResponse>;
     triggerAuthFlow(providerName: string): TriggerAuthFlowResult;
     /**
-     * Fetch the OAuth token if there is one
+     * Returns an OAuth token for the given provider, prompting the user to grant access if necessary
      *
      * @param providerName Name of the OAuth provider
-     * @returns An oauth token or undefined if it doesn't exist
+     * @returns An oauth token, or undefined if a valid token cannot be obtained
      */
     getOAuthToken(providerName: string): Promise<string | undefined>;
+    /**
+     * Fetch the OAuth Client Id if there is one
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns A oauth client id or undefined if it doesn't exist
+     */
+    getOAuthClientId(providerName: string): Promise<string | undefined>;
     /**
      * Make a request with a permanent token like a merge account token or API key.
      * @param providerName The name of the authorization provider from the manifest

package/editorclient.js

@@ -207,14 +207,23 @@ class EditorClient {
         });
     }
     /**
-     * Fetch the OAuth token if there is one
+     * Returns an OAuth token for the given provider, prompting the user to grant access if necessary
      *
      * @param providerName Name of the OAuth provider
-     * @returns An oauth token or undefined if it doesn't exist
+     * @returns An oauth token, or undefined if a valid token cannot be obtained
      */
     async getOAuthToken(providerName) {
         return await this.sendCommand("got" /* CommandName.GetOAuthToken */, { 'p': providerName });
     }
+    /**
+     * Fetch the OAuth Client Id if there is one
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns A oauth client id or undefined if it doesn't exist
+     */
+    async getOAuthClientId(providerName) {
+        return await this.sendCommand("goci" /* CommandName.GetOAuthClientId */, { 'p': providerName });
+    }
     permanentTokenXhr(providerName, request) {
         const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("perm" /* CommandName.SendPermanentTokenRequest */, {

package/package.json

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