lucid-extension-sdk 0.0.305 → 0.0.306

package/commandtypes.d.ts

@@ -25,6 +25,7 @@ import { PanelLocation } from './ui/panel';
  * Before you add a new command bring it up in #api-committee to get feedback.
  */
 export declare const enum CommandName {
+    AddAuthorizationFlowHandler = "aafh",
     AddCardIntegration = "aci",
     AddDiagramFromMermaid = "adfm",
     AddDiagramFromText = "adft",
@@ -166,6 +167,10 @@ export declare const commandTitles: Map<CommandName, string>;
  * IMPORTANT - Before you add a new command bring it up in #api-committee to get feedback
  */
 export type CommandArgs = {
+    [CommandName.AddAuthorizationFlowHandler]: {
+        query: AddAuthorizationFlowHandlerQuery;
+        result: AddAuthorizationFlowHandlerResult;
+    };
     [CommandName.AddCardIntegration]: {
         query: AddCardIntegrationQuery;
         result: AddCardIntegrationResult;
@@ -687,6 +692,22 @@ export type CommandArgs = {
         result: ZOrderResult;
     };
 };
+export type AuthorizationFlowHandlerProvider = string;
+export declare enum AuthorizationFlowHandlerStage {
+    OnFailure = "onFailure"
+}
+export type AddAuthorizationFlowHandlerQuery = {
+    /**
+     * Specifies the callback function to run when the handler is triggered.
+     * String, not a function itself; this is the name of the client's registered action hook
+     */
+    'c': string;
+    /** The name of the auth provider (as specified in the package's manifest.json) that triggers this handler. */
+    'p': AuthorizationFlowHandlerProvider;
+    /** The stage during the auth flow when this handler is triggered. */
+    's': AuthorizationFlowHandlerStage;
+};
+export type AddAuthorizationFlowHandlerResult = undefined;
 export type AddCardIntegrationQuery = {
     /** Title/name */
     'n': string;
@@ -709,7 +730,9 @@ export type AddCardIntegrationQuery = {
         /** Field name -> callback name tuples for searching for legal field values in an enum */
         'fvsc'?: [string, string][] | undefined;
     };
-    /** Show intro if user has not yet authorized this integration */
+    /** Show intro if user has not yet authorized this integration
+     *  String, not function; this is the name of the client's registered action hook
+     */
     'i'?: string | undefined;
     /** Get default config action */
     'gdc': string;

package/commandtypes.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.GetDocumentChunksType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.GetDocumentChunksType = exports.HashAlgorithmEnum = exports.AuthorizationFlowHandlerStage = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
 /** @ignore */
 exports.commandTitles = new Map([
+    ["aafh" /* CommandName.AddAuthorizationFlowHandler */, 'AddAuthorizationFlowHandler'],
     ["aci" /* CommandName.AddCardIntegration */, 'AddCardIntegration'],
     ["adfm" /* CommandName.AddDiagramFromMermaid */, 'AddDiagramFromMermaid'],
     ["adft" /* CommandName.AddDiagramFromText */, 'AddDiagramFromText'],
@@ -129,6 +130,10 @@ exports.commandTitles = new Map([
     ["wsa" /* CommandName.WithSilentActions */, 'WithSilentActions'],
     ["z" /* CommandName.ZOrder */, 'ZOrder'],
 ]);
+var AuthorizationFlowHandlerStage;
+(function (AuthorizationFlowHandlerStage) {
+    AuthorizationFlowHandlerStage["OnFailure"] = "onFailure";
+})(AuthorizationFlowHandlerStage || (exports.AuthorizationFlowHandlerStage = AuthorizationFlowHandlerStage = {}));
 var HashAlgorithmEnum;
 (function (HashAlgorithmEnum) {
     /** Use the SHA 256 hashing algorithm */

package/core/authorizationflowhandlerregistry.d.ts

@@ -0,0 +1,16 @@
+import { AuthorizationFlowHandlerProvider, AuthorizationFlowHandlerStage } from '../commandtypes';
+import { EditorClient } from '../editorclient';
+export declare class AuthorizationFlowHandlerRegistry {
+    private static nextHookId;
+    private static nextHookName;
+    /**
+     * Register a function to be run at a given stage of the authorization flow for a provider.
+     *
+     * @param client A reference to the editor client.
+     * @param callback The function to run when the handler is triggered.
+     * @param stage The stage during the auth flow when this handler is triggered.
+     * @param provider The name of the auth provider (as specified in the package's manifest.json)
+     * that triggers this handler.
+     */
+    static registerAuthorizationFlowHandler(client: EditorClient, callback: () => void, stage: AuthorizationFlowHandlerStage, provider: AuthorizationFlowHandlerProvider): void;
+}

package/core/authorizationflowhandlerregistry.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationFlowHandlerRegistry = void 0;
+class AuthorizationFlowHandlerRegistry {
+    static nextHookName() {
+        return '__authorizationflow__hook' + AuthorizationFlowHandlerRegistry.nextHookId++;
+    }
+    /**
+     * Register a function to be run at a given stage of the authorization flow for a provider.
+     *
+     * @param client A reference to the editor client.
+     * @param callback The function to run when the handler is triggered.
+     * @param stage The stage during the auth flow when this handler is triggered.
+     * @param provider The name of the auth provider (as specified in the package's manifest.json)
+     * that triggers this handler.
+     */
+    static registerAuthorizationFlowHandler(client, callback, stage, provider) {
+        const actionHookName = AuthorizationFlowHandlerRegistry.nextHookName();
+        client.registerAction(actionHookName, callback);
+        const serialized = {
+            'c': actionHookName,
+            's': stage,
+            'p': provider,
+        };
+        client.sendCommand("aafh" /* CommandName.AddAuthorizationFlowHandler */, serialized);
+    }
+}
+exports.AuthorizationFlowHandlerRegistry = AuthorizationFlowHandlerRegistry;
+AuthorizationFlowHandlerRegistry.nextHookId = 0;

package/core/cardintegration/lucidcardintegration.d.ts

@@ -63,8 +63,8 @@ export declare abstract class LucidCardIntegration {
         fieldValueSearchCallbacks?: Map<string, string>;
     };
     /**
-     * If specified, and the user hasn't yet authorized the data connector for this extension,
-     * this should show the user an intro dialog or take some other action.
+     * @deprecated Use AuthorizationFlowHandlerRegistry.registerAuthorizationFlowHandler.
+     * WARNING: Currently unused and does nothing.
      */
     showIntro?: () => void;
     /**

package/package.json

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