@pushwoosh/rpc-v2-http-api-data 0.2.389 → 0.2.390

package/data.js

@@ -30744,6 +30744,128 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.plugin_auth.PluginAuthService": {
+        "type": "S",
+        "key": "pluginAuth",
+        "methods": {
+            "GetSession": {
+                "request": "pushwoosh.rpc_v2.plugin_auth.GetPluginSessionRequest",
+                "response": "pushwoosh.rpc_v2.plugin_auth.GetPluginSessionResponse",
+                "method": "get",
+                "path": "/api/plugin-connections/sessions/{user_code}"
+            },
+            "ApproveSession": {
+                "request": "pushwoosh.rpc_v2.plugin_auth.ApprovePluginSessionRequest",
+                "response": "pushwoosh.rpc_v2.plugin_auth.ApprovePluginSessionResponse",
+                "method": "post",
+                "path": "/api/plugin-connections/sessions/{user_code}/approve"
+            },
+            "ListConnections": {
+                "request": "pushwoosh.rpc_v2.plugin_auth.ListPluginConnectionsRequest",
+                "response": "pushwoosh.rpc_v2.plugin_auth.ListPluginConnectionsResponse",
+                "method": "get",
+                "path": "/api/plugin-connections"
+            },
+            "RevokeConnection": {
+                "request": "pushwoosh.rpc_v2.plugin_auth.RevokePluginConnectionRequest",
+                "response": "pushwoosh.rpc_v2.plugin_auth.RevokePluginConnectionResponse",
+                "method": "delete",
+                "path": "/api/plugin-connections/{id}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.GetPluginSessionRequest": {
+        "type": "I",
+        "fields": {
+            "userCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.GetPluginSessionResponse": {
+        "type": "I",
+        "fields": {
+            "client": {
+                "type": "string"
+            },
+            "createdAt": {
+                "type": "Date"
+            },
+            "ip": {
+                "type": "string"
+            },
+            "userAgent": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.ApprovePluginSessionRequest": {
+        "type": "I",
+        "fields": {
+            "userCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.ApprovePluginSessionResponse": {
+        "type": "I",
+        "fields": {
+            "connection": {
+                "type": "pushwoosh.rpc_v2.plugin_auth.PluginConnection"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.ListPluginConnectionsRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.plugin_auth.ListPluginConnectionsResponse": {
+        "type": "I",
+        "fields": {
+            "connections": {
+                "type": "pushwoosh.rpc_v2.plugin_auth.PluginConnection",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.RevokePluginConnectionRequest": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.plugin_auth.RevokePluginConnectionResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.plugin_auth.PluginConnection": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "client": {
+                "type": "string"
+            },
+            "createdAt": {
+                "type": "Date"
+            },
+            "lastUsedAt": {
+                "type": "Date"
+            },
+            "expiresAt": {
+                "type": "Date"
+            },
+            "ip": {
+                "type": "string"
+            },
+            "userAgent": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc.popup_forms.v3.PopupFormsServiceErrors": {
         "type": "E",
         "values": [

package/index.d.ts

@@ -55,6 +55,7 @@ import { MediaFilesService as pushwoosh_rpc_v2_media_files_MediaFilesService } f
 import { MessagesService as pushwoosh_rpc_v2_messages_MessagesService } from './messages';
 import { NewsService as pushwoosh_rpc_v2_news_NewsService } from './news';
 import { RestrictionValuesCrudService as pushwoosh_objects_restrictionValues_v1_RestrictionValuesCrudService } from './pushwoosh_objects_restrictionValues_v1';
+import { PluginAuthService as pushwoosh_rpc_v2_plugin_auth_PluginAuthService } from './plugin_auth';
 import { PopupFormsService as pushwoosh_rpc_popup_forms_v3_PopupFormsService } from './pushwoosh_rpc_popup_forms_v3';
 import { PopupFormsContentsService as pushwoosh_rpc_popup_forms_contents_v3_PopupFormsContentsService } from './pushwoosh_rpc_popup_forms_contents_v3';
 import { presetsService as pushwoosh_rpc_v2_presets_presetsService } from './presets';
@@ -135,6 +136,7 @@ export type API = {
     messages: pushwoosh_rpc_v2_messages_MessagesService;
     news: pushwoosh_rpc_v2_news_NewsService;
     restrictionValuesCrud: pushwoosh_objects_restrictionValues_v1_RestrictionValuesCrudService;
+    pluginAuth: pushwoosh_rpc_v2_plugin_auth_PluginAuthService;
     popupForms: pushwoosh_rpc_popup_forms_v3_PopupFormsService;
     popupFormsContents: pushwoosh_rpc_popup_forms_contents_v3_PopupFormsContentsService;
     presets: pushwoosh_rpc_v2_presets_presetsService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.389",
+  "version": "0.2.390",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",

package/plugin_auth.d.ts

@@ -0,0 +1,60 @@
+import { RpcMethod } from './commonTypes';
+export type PluginAuthService_GetSession = RpcMethod<GetPluginSessionRequest, GetPluginSessionResponse>;
+export type PluginAuthService_ApproveSession = RpcMethod<ApprovePluginSessionRequest, ApprovePluginSessionResponse>;
+export type PluginAuthService_ListConnections = RpcMethod<ListPluginConnectionsRequest, ListPluginConnectionsResponse>;
+export type PluginAuthService_RevokeConnection = RpcMethod<RevokePluginConnectionRequest, RevokePluginConnectionResponse>;
+/**
+ * PluginAuthService connects the Figma plugin to a signed-in user: the user enters the code the plugin
+ * shows, and the plugin gets its own token, accepted only by the plugin endpoints, never an SSO token.
+ */
+export interface PluginAuthService {
+    /** Describes a pending plugin sign-in by the code the plugin shows: which plugin, when and from where it started. Use to show the consent screen before approve_plugin_session. Signed-in users only. */
+    GetSession: PluginAuthService_GetSession;
+    /** Approves a pending plugin sign-in by its code, giving that plugin a token that can list the user's applications and upload images to their Media Library. Signed-in users only; a code works once. */
+    ApproveSession: PluginAuthService_ApproveSession;
+    /** Lists the plugins the calling user has connected, newest first. Use for the connected apps settings page. */
+    ListConnections: PluginAuthService_ListConnections;
+    /** Disconnects one of the calling user's plugins: its token stops working at once and the plugin asks to sign in again. */
+    RevokeConnection: PluginAuthService_RevokeConnection;
+}
+export type GetPluginSessionRequest = {
+    /** Code the plugin shows, e.g. "BCDF-2345"; case, spaces and the dash are ignored. */
+    userCode?: string;
+};
+export type GetPluginSessionResponse = {
+    /** Plugin that started the sign-in, e.g. "figma". */
+    client: string;
+    createdAt: Date;
+    /** Address the plugin started the sign-in from, to compare with the user's own. */
+    ip: string;
+    userAgent: string;
+};
+export type ApprovePluginSessionRequest = {
+    /** Code the plugin shows, e.g. "BCDF-2345"; case, spaces and the dash are ignored. */
+    userCode?: string;
+};
+export type ApprovePluginSessionResponse = {
+    connection: PluginConnection;
+};
+export type ListPluginConnectionsRequest = {};
+export type ListPluginConnectionsResponse = {
+    connections: PluginConnection[];
+};
+export type RevokePluginConnectionRequest = {
+    /** Connection id from list_plugin_connections. */
+    id?: string;
+};
+export type RevokePluginConnectionResponse = {};
+/** PluginConnection is one plugin token of the user; the token itself is never shown again. */
+export type PluginConnection = {
+    id: string;
+    /** Plugin holding the token, e.g. "figma". */
+    client: string;
+    createdAt: Date;
+    lastUsedAt: Date;
+    /** The token stops working at this time unless used before; it never outlives created_at plus 90 days. */
+    expiresAt: Date;
+    /** Address and user agent of the sign-in. */
+    ip: string;
+    userAgent: string;
+};

package/plugin_auth.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};