@webstudio-is/protocol 0.274.4 → 0.275.0

package/lib/types/builder-api/operations.d.ts

@@ -1,21 +1,26 @@
-import { type PublicApiOperationNamespace, type PublicRuntimeOperationId } from "./runtime-contracts";
-export type { PublicApiOperationNamespace } from "./runtime-contracts";
+import { publicApiOperationDocumentation } from "./operation-docs";
+import { type InputJsonSchema, type PublicApiOperationNamespace, type PublicApiOperationPermit, type PublicRuntimeOperationId } from "./runtime-contracts";
+export type { PublicApiOperationNamespace, PublicApiOperationPermit, } from "./runtime-contracts";
 export type PublicApiOperationMethod = "query" | "mutation";
-export type PublicApiOperationPermit = "api" | "view" | "build" | "edit" | "admin";
-type PublicApiOperationInput = {
-    command: string;
+export type PublicApiCommand = (typeof publicApiOperationDocumentation)[number]["command"];
+type PublicApiOperationInput<Command extends string = string> = {
+    command: Command;
     id: string;
     method: PublicApiOperationMethod;
     path?: string;
     client: string;
     permit?: PublicApiOperationPermit;
     invalidatesNamespaces?: readonly PublicApiOperationNamespace[];
+    inputSchema?: InputJsonSchema;
 };
 export type PublicApiOperation<Command extends string = string> = Omit<PublicApiOperationInput, "command" | "permit"> & {
     command: Command;
     permit: PublicApiOperationPermit;
     description: string;
     inputFields: readonly string[];
+    requiredInputFields: readonly string[];
+    inputFieldTypes: Partial<Record<string, "array">>;
+    inputSchema: InputJsonSchema;
     requiredOptions?: readonly string[];
     examples: readonly string[];
     localCapable: boolean;
@@ -25,482 +30,9 @@ export type PublicApiOperation<Command extends string = string> = Omit<PublicApi
     writeNamespaces: readonly PublicApiOperationNamespace[];
     invalidatesNamespaces: readonly PublicApiOperationNamespace[];
     retryOnConflict: boolean;
+    requiresAssets: boolean;
+    requiresConfirm: boolean;
 };
-declare const publicApiOperationInputs: readonly [{
-    readonly command: "whoami";
-    readonly id: "auth.me";
-    readonly method: "query";
-    readonly path: "api.auth.me";
-    readonly client: "getApiTokenInfo";
-    readonly permit: "view";
-}, {
-    readonly command: "permissions";
-    readonly id: "projects.permissions";
-    readonly method: "query";
-    readonly path: "api.projects.permissions";
-    readonly client: "getProjectPermissions";
-}, {
-    readonly command: "inspect";
-    readonly id: "projects.get";
-    readonly method: "query";
-    readonly path: "api.projects.get";
-    readonly client: "getProjectInfo";
-}, {
-    readonly command: "snapshot";
-    readonly id: "build.get";
-    readonly method: "query";
-    readonly path: "api.build.get";
-    readonly client: "getBuildSnapshot";
-}, {
-    readonly command: "apply-patch";
-    readonly id: "build.patch";
-    readonly method: "mutation";
-    readonly path: "api.build.patch";
-    readonly client: "applyBuildPatch";
-    readonly invalidatesNamespaces: readonly ["pages", "instances", "props", "styles", "styleSources", "styleSourceSelections", "dataSources", "resources", "assets", "breakpoints", "marketplaceProduct"];
-}, {
-    readonly command: "list-pages";
-    readonly id: "pages.list";
-    readonly method: "query";
-    readonly path: "api.pages.list";
-    readonly client: "listPages";
-}, {
-    readonly command: "get-page";
-    readonly id: "pages.get";
-    readonly method: "query";
-    readonly path: "api.pages.get";
-    readonly client: "getPage";
-}, {
-    readonly command: "get-page-by-path";
-    readonly id: "pages.getByPath";
-    readonly method: "query";
-    readonly path: "api.pages.getByPath";
-    readonly client: "getPageByPath";
-}, {
-    readonly command: "create-page";
-    readonly id: "pages.create";
-    readonly method: "mutation";
-    readonly path: "api.pages.create";
-    readonly client: "createPage";
-}, {
-    readonly command: "update-page";
-    readonly id: "pages.update";
-    readonly method: "mutation";
-    readonly path: "api.pages.update";
-    readonly client: "updatePage";
-}, {
-    readonly command: "get-project-settings";
-    readonly id: "projectSettings.get";
-    readonly method: "query";
-    readonly path: "api.projectSettings.get";
-    readonly client: "getProjectSettings";
-}, {
-    readonly command: "update-project-settings";
-    readonly id: "projectSettings.update";
-    readonly method: "mutation";
-    readonly path: "api.projectSettings.update";
-    readonly client: "updateProjectSettings";
-}, {
-    readonly command: "list-redirects";
-    readonly id: "redirects.list";
-    readonly method: "query";
-    readonly path: "api.redirects.list";
-    readonly client: "listRedirects";
-}, {
-    readonly command: "create-redirect";
-    readonly id: "redirects.create";
-    readonly method: "mutation";
-    readonly path: "api.redirects.create";
-    readonly client: "createRedirect";
-}, {
-    readonly command: "update-redirect";
-    readonly id: "redirects.update";
-    readonly method: "mutation";
-    readonly path: "api.redirects.update";
-    readonly client: "updateRedirect";
-}, {
-    readonly command: "delete-redirect";
-    readonly id: "redirects.delete";
-    readonly method: "mutation";
-    readonly path: "api.redirects.delete";
-    readonly client: "deleteRedirect";
-}, {
-    readonly command: "list-breakpoints";
-    readonly id: "breakpoints.list";
-    readonly method: "query";
-    readonly path: "api.breakpoints.list";
-    readonly client: "listBreakpoints";
-}, {
-    readonly command: "create-breakpoint";
-    readonly id: "breakpoints.create";
-    readonly method: "mutation";
-    readonly path: "api.breakpoints.create";
-    readonly client: "createBreakpoint";
-}, {
-    readonly command: "update-breakpoint";
-    readonly id: "breakpoints.update";
-    readonly method: "mutation";
-    readonly path: "api.breakpoints.update";
-    readonly client: "updateBreakpoint";
-}, {
-    readonly command: "delete-breakpoint";
-    readonly id: "breakpoints.delete";
-    readonly method: "mutation";
-    readonly path: "api.breakpoints.delete";
-    readonly client: "deleteBreakpoint";
-}, {
-    readonly command: "delete-page";
-    readonly id: "pages.delete";
-    readonly method: "mutation";
-    readonly path: "api.pages.delete";
-    readonly client: "deletePage";
-}, {
-    readonly command: "duplicate-page";
-    readonly id: "pages.duplicate";
-    readonly method: "mutation";
-    readonly path: "api.pages.duplicate";
-    readonly client: "duplicatePage";
-}, {
-    readonly command: "list-page-templates";
-    readonly id: "pageTemplates.list";
-    readonly method: "query";
-    readonly path: "api.pageTemplates.list";
-    readonly client: "listPageTemplates";
-}, {
-    readonly command: "create-page-from-template";
-    readonly id: "pageTemplates.createPage";
-    readonly method: "mutation";
-    readonly path: "api.pageTemplates.createPage";
-    readonly client: "createPageFromTemplate";
-}, {
-    readonly command: "list-folders";
-    readonly id: "folders.list";
-    readonly method: "query";
-    readonly path: "api.folders.list";
-    readonly client: "listFolders";
-}, {
-    readonly command: "create-folder";
-    readonly id: "folders.create";
-    readonly method: "mutation";
-    readonly path: "api.folders.create";
-    readonly client: "createFolder";
-}, {
-    readonly command: "update-folder";
-    readonly id: "folders.update";
-    readonly method: "mutation";
-    readonly path: "api.folders.update";
-    readonly client: "updateFolder";
-}, {
-    readonly command: "delete-folder";
-    readonly id: "folders.delete";
-    readonly method: "mutation";
-    readonly path: "api.folders.delete";
-    readonly client: "deleteFolder";
-}, {
-    readonly command: "list-instances";
-    readonly id: "instances.list";
-    readonly method: "query";
-    readonly path: "api.instances.list";
-    readonly client: "listInstances";
-}, {
-    readonly command: "inspect-instance";
-    readonly id: "instances.inspect";
-    readonly method: "query";
-    readonly path: "api.instances.inspect";
-    readonly client: "inspectInstance";
-}, {
-    readonly command: "append-instance";
-    readonly id: "instances.append";
-    readonly method: "mutation";
-    readonly path: "api.instances.append";
-    readonly client: "appendInstance";
-}, {
-    readonly command: "move-instance";
-    readonly id: "instances.move";
-    readonly method: "mutation";
-    readonly path: "api.instances.move";
-    readonly client: "moveInstance";
-}, {
-    readonly command: "clone-instance";
-    readonly id: "instances.clone";
-    readonly method: "mutation";
-    readonly path: "api.instances.clone";
-    readonly client: "cloneInstance";
-}, {
-    readonly command: "delete-instance";
-    readonly id: "instances.delete";
-    readonly method: "mutation";
-    readonly path: "api.instances.delete";
-    readonly client: "deleteInstance";
-}, {
-    readonly command: "update-props";
-    readonly id: "instances.updateProps";
-    readonly method: "mutation";
-    readonly path: "api.instances.updateProps";
-    readonly client: "updateProps";
-    readonly permit: "edit";
-}, {
-    readonly command: "delete-props";
-    readonly id: "instances.deleteProps";
-    readonly method: "mutation";
-    readonly path: "api.instances.deleteProps";
-    readonly client: "deleteProps";
-    readonly permit: "edit";
-}, {
-    readonly command: "bind-props";
-    readonly id: "instances.bindProps";
-    readonly method: "mutation";
-    readonly path: "api.instances.bindProps";
-    readonly client: "bindProps";
-}, {
-    readonly command: "list-texts";
-    readonly id: "instances.listTexts";
-    readonly method: "query";
-    readonly path: "api.instances.listTexts";
-    readonly client: "listTexts";
-}, {
-    readonly command: "update-text";
-    readonly id: "instances.updateText";
-    readonly method: "mutation";
-    readonly path: "api.instances.updateText";
-    readonly client: "updateText";
-    readonly permit: "edit";
-}, {
-    readonly command: "get-styles";
-    readonly id: "styles.getDeclarations";
-    readonly method: "query";
-    readonly path: "api.styles.getDeclarations";
-    readonly client: "getStyleDeclarations";
-}, {
-    readonly command: "update-styles";
-    readonly id: "styles.updateDeclarations";
-    readonly method: "mutation";
-    readonly path: "api.styles.updateDeclarations";
-    readonly client: "updateStyleDeclarations";
-}, {
-    readonly command: "delete-styles";
-    readonly id: "styles.deleteDeclarations";
-    readonly method: "mutation";
-    readonly path: "api.styles.deleteDeclarations";
-    readonly client: "deleteStyleDeclarations";
-}, {
-    readonly command: "replace-styles";
-    readonly id: "styles.replaceValues";
-    readonly method: "mutation";
-    readonly path: "api.styles.replaceValues";
-    readonly client: "replaceStyleValues";
-}, {
-    readonly command: "list-design-tokens";
-    readonly id: "designTokens.list";
-    readonly method: "query";
-    readonly path: "api.designTokens.list";
-    readonly client: "listDesignTokens";
-}, {
-    readonly command: "create-design-token";
-    readonly id: "designTokens.create";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.create";
-    readonly client: "createDesignTokens";
-}, {
-    readonly command: "update-design-token-styles";
-    readonly id: "designTokens.updateStyles";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.updateStyles";
-    readonly client: "updateDesignTokenStyles";
-}, {
-    readonly command: "delete-design-token-styles";
-    readonly id: "designTokens.deleteStyles";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.deleteStyles";
-    readonly client: "deleteDesignTokenStyles";
-}, {
-    readonly command: "attach-design-token";
-    readonly id: "designTokens.attach";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.attach";
-    readonly client: "attachDesignToken";
-}, {
-    readonly command: "detach-design-token";
-    readonly id: "designTokens.detach";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.detach";
-    readonly client: "detachDesignToken";
-}, {
-    readonly command: "extract-design-token";
-    readonly id: "designTokens.extract";
-    readonly method: "mutation";
-    readonly path: "api.designTokens.extract";
-    readonly client: "extractDesignToken";
-}, {
-    readonly command: "list-css-variables";
-    readonly id: "cssVariables.list";
-    readonly method: "query";
-    readonly path: "api.cssVariables.list";
-    readonly client: "listCssVariables";
-}, {
-    readonly command: "define-css-variable";
-    readonly id: "cssVariables.define";
-    readonly method: "mutation";
-    readonly path: "api.cssVariables.define";
-    readonly client: "defineCssVariables";
-}, {
-    readonly command: "delete-css-variable";
-    readonly id: "cssVariables.delete";
-    readonly method: "mutation";
-    readonly path: "api.cssVariables.delete";
-    readonly client: "deleteCssVariables";
-}, {
-    readonly command: "rewrite-css-variable-refs";
-    readonly id: "cssVariables.rewriteRefs";
-    readonly method: "mutation";
-    readonly path: "api.cssVariables.rewriteRefs";
-    readonly client: "rewriteCssVariableRefs";
-}, {
-    readonly command: "list-variables";
-    readonly id: "variables.list";
-    readonly method: "query";
-    readonly path: "api.variables.list";
-    readonly client: "listVariables";
-}, {
-    readonly command: "create-variable";
-    readonly id: "variables.create";
-    readonly method: "mutation";
-    readonly path: "api.variables.create";
-    readonly client: "createVariable";
-}, {
-    readonly command: "update-variable";
-    readonly id: "variables.update";
-    readonly method: "mutation";
-    readonly path: "api.variables.update";
-    readonly client: "updateVariable";
-}, {
-    readonly command: "delete-variable";
-    readonly id: "variables.delete";
-    readonly method: "mutation";
-    readonly path: "api.variables.delete";
-    readonly client: "deleteVariable";
-}, {
-    readonly command: "list-resources";
-    readonly id: "resources.list";
-    readonly method: "query";
-    readonly path: "api.resources.list";
-    readonly client: "listResources";
-}, {
-    readonly command: "create-resource";
-    readonly id: "resources.create";
-    readonly method: "mutation";
-    readonly path: "api.resources.create";
-    readonly client: "createResource";
-}, {
-    readonly command: "update-resource";
-    readonly id: "resources.update";
-    readonly method: "mutation";
-    readonly path: "api.resources.update";
-    readonly client: "updateResource";
-}, {
-    readonly command: "delete-resource";
-    readonly id: "resources.delete";
-    readonly method: "mutation";
-    readonly path: "api.resources.delete";
-    readonly client: "deleteResource";
-}, {
-    readonly command: "publish";
-    readonly id: "publish.create";
-    readonly method: "mutation";
-    readonly path: "api.publish.create";
-    readonly client: "publish";
-    readonly permit: "edit";
-}, {
-    readonly command: "list-publishes";
-    readonly id: "publish.list";
-    readonly method: "query";
-    readonly path: "api.publish.list";
-    readonly client: "listPublishes";
-}, {
-    readonly command: "get-publish-job";
-    readonly id: "publish.getJob";
-    readonly method: "query";
-    readonly path: "api.publish.getJob";
-    readonly client: "getPublishJob";
-}, {
-    readonly command: "unpublish";
-    readonly id: "publish.unpublish";
-    readonly method: "mutation";
-    readonly path: "api.publish.unpublish";
-    readonly client: "unpublish";
-    readonly permit: "edit";
-}, {
-    readonly command: "list-domains";
-    readonly id: "domains.list";
-    readonly method: "query";
-    readonly path: "api.domains.list";
-    readonly client: "listDomains";
-}, {
-    readonly command: "create-domain";
-    readonly id: "domains.create";
-    readonly method: "mutation";
-    readonly path: "api.domains.create";
-    readonly client: "createDomain";
-    readonly permit: "admin";
-}, {
-    readonly command: "update-domain";
-    readonly id: "domains.update";
-    readonly method: "mutation";
-    readonly path: "api.domains.update";
-    readonly client: "updateDomain";
-    readonly permit: "admin";
-}, {
-    readonly command: "delete-domain";
-    readonly id: "domains.delete";
-    readonly method: "mutation";
-    readonly path: "api.domains.delete";
-    readonly client: "deleteDomain";
-    readonly permit: "admin";
-}, {
-    readonly command: "verify-domain";
-    readonly id: "domains.verify";
-    readonly method: "mutation";
-    readonly path: "api.domains.verify";
-    readonly client: "verifyDomain";
-    readonly permit: "admin";
-}, {
-    readonly command: "list-assets";
-    readonly id: "assets.list";
-    readonly method: "query";
-    readonly path: "api.assets.list";
-    readonly client: "listAssets";
-}, {
-    readonly command: "upload-asset";
-    readonly id: "assets.upload";
-    readonly method: "mutation";
-    readonly client: "uploadProjectAsset";
-    readonly invalidatesNamespaces: readonly ["assets"];
-}, {
-    readonly command: "upload-assets";
-    readonly id: "assets.uploadMany";
-    readonly method: "mutation";
-    readonly client: "uploadProjectAssets";
-    readonly invalidatesNamespaces: readonly ["assets"];
-}, {
-    readonly command: "find-asset-usage";
-    readonly id: "assets.findUsage";
-    readonly method: "query";
-    readonly path: "api.assets.findUsage";
-    readonly client: "findAssetUsage";
-}, {
-    readonly command: "replace-asset";
-    readonly id: "assets.replace";
-    readonly method: "mutation";
-    readonly path: "api.assets.replace";
-    readonly client: "replaceAsset";
-}, {
-    readonly command: "delete-asset";
-    readonly id: "assets.delete";
-    readonly method: "mutation";
-    readonly path: "api.assets.delete";
-    readonly client: "deleteAssets";
-}];
-export declare const publicApiOperations: PublicApiOperation<"whoami" | "permissions" | "inspect" | "snapshot" | "apply-patch" | "list-pages" | "get-page" | "get-page-by-path" | "create-page" | "update-page" | "get-project-settings" | "update-project-settings" | "list-redirects" | "create-redirect" | "update-redirect" | "delete-redirect" | "list-breakpoints" | "create-breakpoint" | "update-breakpoint" | "delete-breakpoint" | "delete-page" | "duplicate-page" | "list-page-templates" | "create-page-from-template" | "list-folders" | "create-folder" | "update-folder" | "delete-folder" | "list-instances" | "inspect-instance" | "append-instance" | "move-instance" | "clone-instance" | "delete-instance" | "update-props" | "delete-props" | "bind-props" | "list-texts" | "update-text" | "get-styles" | "update-styles" | "delete-styles" | "replace-styles" | "list-design-tokens" | "create-design-token" | "update-design-token-styles" | "delete-design-token-styles" | "attach-design-token" | "detach-design-token" | "extract-design-token" | "list-css-variables" | "define-css-variable" | "delete-css-variable" | "rewrite-css-variable-refs" | "list-variables" | "create-variable" | "update-variable" | "delete-variable" | "list-resources" | "create-resource" | "update-resource" | "delete-resource" | "publish" | "list-publishes" | "get-publish-job" | "unpublish" | "list-domains" | "create-domain" | "update-domain" | "delete-domain" | "verify-domain" | "list-assets" | "upload-asset" | "upload-assets" | "find-asset-usage" | "replace-asset" | "delete-asset">[];
-export type PublicApiCommand = (typeof publicApiOperationInputs)[number]["command"];
-export declare const getPublicApiOperation: (command: PublicApiCommand) => PublicApiOperation<"whoami" | "permissions" | "inspect" | "snapshot" | "apply-patch" | "list-pages" | "get-page" | "get-page-by-path" | "create-page" | "update-page" | "get-project-settings" | "update-project-settings" | "list-redirects" | "create-redirect" | "update-redirect" | "delete-redirect" | "list-breakpoints" | "create-breakpoint" | "update-breakpoint" | "delete-breakpoint" | "delete-page" | "duplicate-page" | "list-page-templates" | "create-page-from-template" | "list-folders" | "create-folder" | "update-folder" | "delete-folder" | "list-instances" | "inspect-instance" | "append-instance" | "move-instance" | "clone-instance" | "delete-instance" | "update-props" | "delete-props" | "bind-props" | "list-texts" | "update-text" | "get-styles" | "update-styles" | "delete-styles" | "replace-styles" | "list-design-tokens" | "create-design-token" | "update-design-token-styles" | "delete-design-token-styles" | "attach-design-token" | "detach-design-token" | "extract-design-token" | "list-css-variables" | "define-css-variable" | "delete-css-variable" | "rewrite-css-variable-refs" | "list-variables" | "create-variable" | "update-variable" | "delete-variable" | "list-resources" | "create-resource" | "update-resource" | "delete-resource" | "publish" | "list-publishes" | "get-publish-job" | "unpublish" | "list-domains" | "create-domain" | "update-domain" | "delete-domain" | "verify-domain" | "list-assets" | "upload-asset" | "upload-assets" | "find-asset-usage" | "replace-asset" | "delete-asset">;
+export declare const publicApiOperations: PublicApiOperation<string>[];
+export declare const getPublicApiOperation: (command: PublicApiCommand) => PublicApiOperation<string>;
 export declare const getPublicApiOperationPath: (command: PublicApiCommand) => string;

package/lib/types/builder-api/runtime-contracts.d.ts

@@ -1,11 +1,24 @@
+import { runtimeOperationContracts } from "@webstudio-is/project-build/contracts/builder-runtime";
+import type { InputJsonSchema } from "@webstudio-is/sdk";
+export type { InputJsonSchema };
 export declare const publicApiOperationNamespaces: readonly ["pages", "instances", "props", "styles", "styleSources", "styleSourceSelections", "dataSources", "resources", "assets", "breakpoints", "marketplaceProduct"];
 export type PublicApiOperationNamespace = (typeof publicApiOperationNamespaces)[number];
-export type PublicRuntimeOperationId = string;
+export declare const publicApiOperationPermits: readonly ["api", "view", "edit", "build", "admin"];
+export type PublicApiOperationPermit = (typeof publicApiOperationPermits)[number];
+export type PublicApiOperationKind = "read" | "mutation";
+export type PublicRuntimeOperationId = (typeof runtimeOperationContracts)[number]["id"];
 export type PublicRuntimeOperationContract = {
     id: PublicRuntimeOperationId;
+    command: string;
+    client: string;
+    permit?: PublicApiOperationPermit;
+    kind: PublicApiOperationKind;
+    inputSchema: InputJsonSchema;
     readNamespaces: readonly PublicApiOperationNamespace[];
     writeNamespaces: readonly PublicApiOperationNamespace[];
     invalidatesNamespaces: readonly PublicApiOperationNamespace[];
     retryOnConflict: boolean;
+    requiresAssets: boolean;
+    requiresConfirm: boolean;
 };
 export declare const publicRuntimeOperationContracts: readonly PublicRuntimeOperationContract[];