@wix/public-editor-platform-interfaces 1.77.0 → 1.78.0

package/dist/ContextActions.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The named context actions a provider can declare on its manifest
+ * (`EditorContextProvider.actions`). Mirrors the vocabulary of
+ * `@wix/editor-platform-context-actions-service` — `settings` is deliberately
+ * excluded there and therefore never surfaces here.
+ */
+export type ContextActionName = 'addItem' | 'editItem' | 'openItem' | 'openSource';
+/**
+ * What the consumer passes to `execute` — only what is genuinely runtime-known.
+ * The `providerIdentifier` is baked into the command at resolution time;
+ * `openItem`/`editItem` operate on a concrete item and require its id.
+ */
+export type ContextActionExecuteArgsByName = {
+    addItem: [];
+    editItem: [payload: {
+        sourceItemId: string;
+    }];
+    openItem: [payload: {
+        sourceItemId: string;
+    }];
+    openSource: [];
+};
+/**
+ * Commands form a union discriminated on `actionName`, so narrowing the name
+ * narrows what `execute` accepts (e.g. an `openItem` command requires
+ * `sourceItemId` at compile time, while `openSource` takes no arguments).
+ */
+export type ContextActionCommandByName = {
+    [TName in ContextActionName]: {
+        actionName: TName;
+        description?: string;
+        displayName: string;
+        execute: (...args: ContextActionExecuteArgsByName[TName]) => Promise<void>;
+    };
+};
+export type ContextActionCommand<TName extends ContextActionName = ContextActionName> = ContextActionCommandByName[TName];
+export type GetContextActionsOptions = {
+    /** Optional filter — omit to resolve every declared action. */
+    actionNames?: ContextActionName[];
+    providerIdentifier: string;
+};

package/dist/ContextActions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export { DsItem } from './DataItem';
 export { BuilderStyle, Style, StyleRef } from './StyleData';
 export * from './Providers';
 export * from './Bindings';
+export * from './ContextActions';
 export { OpenColorPickerFn, OpenLinkPanelFn, BasePickerOptions, BackgroundFillValue, BackgroundPickerOptions, ColorPickerOptions, ColorPickerMode, } from './Inputs';
 export * as PublicDmTypes from './generated/dm-types';
 export type { SiteLocale } from './generated/dm-types';

package/dist/index.js

@@ -45,5 +45,6 @@ var EventType_1 = require("./EventType");
 Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return EventType_1.EventType; } });
 __exportStar(require("./Providers"), exports);
 __exportStar(require("./Bindings"), exports);
+__exportStar(require("./ContextActions"), exports);
 exports.PublicDmTypes = __importStar(require("./generated/dm-types"));
 __exportStar(require("./sdk"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.77.0",
+  "version": "1.78.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "4c76d936e5c1419fd08de70e26ae49deab0dc31f36bce85d4c41e26b"
+  "falconPackageHash": "230b2d5239325e17ce78a865b6fc66641cc252206ddaddfd955937ca"
 }