Repository navigation
v0.5.5-beta.1
[0.5.5-beta.1] - 2026-10-26
Added
- SDK HTML interface reads:
PipefyClient.list_html_interfaceslists an organization's HTML interfaces (contentModeHtml). It follows the Interfaces cursor across pages of 50 and never returns portals or grid interfaces, whichlist_portalscannot reach because it filters to portals.PipefyClient.get_html_interfacereads one throughinterface(uuid), becauseget_portal'sportalInterfaceexposes nohtmlDocument. Each page's elements carry their declareddataSources(withid,nameandfilters) and their livehtmlDocument(content,contentHash,createdAt). A grid interface is rejected withValueErrornamingget_portal.PortalElementTypeacceptscustomCode, the element an HTML interface's page renders. - SDK HTML interface write:
PipefyClient.write_html_documentwrites and publishes the HTML document of an HTML interface'scustomCodeelement (writeHtmlDocument). When the API rejects the HTML withHTML_VALIDATION_FAILED, the SDK raisesHtmlValidationError. Itsviolationsholds oneHtmlViolation(code,message,selector,attribute) per rule broken, read fromextensions.violations, and nothing is stored. The classifier reports the code asGraphQLProblemKind.INVALID_ARGUMENTS. For the MCP write tool to come,map_portal_error_to_messagealready formats anHtmlValidationErroras one line per violation with where it is, so an agent can fix them all before writing again. - SDK / MCP
get_interface_html_guidelines:PipefyClient.get_interface_html_guidelinesand the matching MCP tool fetch the HTML/CSS authoring rules and data-source filter format for an HTML interface'scustomCodecontent: allowed tags and attributes, every forbidden tag/attribute/CSS construct with its violation code, the full error-code list, thedata-pfy-*vocabulary (dataPfyVocabulary: what each attribute does, for most which element it goes on, and the value it takes), the filter-tree format (a worked example plus the operators each field type supports), content-size and nesting limits, and adesignSystemsnapshot (a component catalog: tokens, icons and components with usage examples). Both selectdesignSystemonly withinclude_design_system=true(@includein the query, so the API skips the catalog otherwise), because it is most of the response and a client can cut a response that size. The rules are the same for every organization, so the call takes no argument. - SDK HTML interface data sources: three methods let a caller declare an HTML interface's data sources without the interface editor.
PipefyClient.list_interface_reposlists the pipes and tables an element can take as a source (interfaceRepos), across pages of 50, ordered by name; it takes the numeric organization id and rejects a uuid withValueErrorbefore any call, because the API matches only the numeric id. Each repo'suuidis the source'srepoId.PipefyClient.get_interface_repo_fieldslists a repo's custom fields (interfacesRepoStructure); a custom field's source key is itsuuid, and the built-in keys such astitleandcreated_atcome fromget_interface_html_guidelines(filters.fixedColumnNames), not from this list.PipefyClient.set_interface_sourcesreplaces the sources of an HTML interface'scustomCodeelement and returns them. It reads the element first and sends itsmetadataandeditableback unchanged: the update replacesmetadata, and it fails a source with field keys wheneditableis missing. The sources are parsed intoInterfaceDataSourcebefore any call: each needs a uniqueidandname, arepoId, 1 to 30fieldKeys, andfiltersas an object or null, with at most 10 sources. A source read fromget_html_interfacecan be passed back as read. - MCP HTML interface data sources: three tools let an agent declare an HTML interface's data sources:
list_interface_reposlists the pipes and tables the interface can read (numericorganization_id; a uuid returnsINVALID_ARGUMENTS),get_interface_repo_fieldslists a repo's custom fields keyed byuuid, andset_interface_sourcesreplaces acustomCodeelement's sources, keeping itsmetadataandeditable. Sources are checked before the call, and each problem comes back asINVALID_ARGUMENTSnamingdata_sources[index].key. An unknownrepo_uuidorinterface_uuidargument returns a message naming it instead of the API's own text, and a source on a repo the caller cannot bind returns "Permission denied for a data source" pointing atlist_interface_repos. Theinterfacestoolset holds all three, and the auditor profile the two reads. - MCP HTML interface create/read/write:
create_html_interfacecreates an interface with onecustomCodepage and writes its HTML in one call; a write failure after a successful create returns the new interface'suuid,page_idandelement_idwith retry guidance, so the agent does not create a second, orphaned interface.coloris optional and defaults toblue.list_interfaceslists an organization's HTML interfaces (contentModeHtml),get_interface_htmlreads one back with each element's live document and parsedfilters, andwrite_interface_htmlwrites and publishes acustomCodeelement's whole HTML document. An unknown interface uuid returns a message naming it instead of the API's own text. The auditor profile holds the two reads. - HTML interface tools, hosted server and CLI:
list_interface_repos,get_interface_repo_fields,set_interface_sources,list_interfaces,get_interface_html,write_interface_html, andcreate_html_interfaceare now remote-safe and reachable on the hosted server. The CLI gets a matchingpipefy portal html-interfacesub-app:list,get,write,create,repos,repo-fields,set-sources, andguidelines.createtakes--color(defaults toblue, same 12 values as the MCP tool),write/createtake--content-file/--html-fileto read the document from a file instead of a shell argument, andguidelinestakes--include-design-system. Every command's not-found, permission-denied, and HTML-validation failures now print the same clean text as their MCP twins, instead of the raw API response, and a permission denial (whether the SDK already wraps it or not) always exits 2. - Skill
pipefy-html-interfaces: teaches an agent to build and change HTML interfaces through MCP or the CLI: readget_interface_html_guidelinesfirst, pick data withlist_interface_reposandget_interface_repo_fields, create withcreate_html_interface, and change a page by reading it withget_interface_html, thenset_interface_sourcesandwrite_interface_html. It covers recovery when the create succeeds but the write fails (retry the write with the returned ids, never create again). Thepipefy-buildingrouter points HTML interface requests at it.
Fixed
-
SDK
update_portal_element, source handles: an update dropped each data source'sid,nameandfilters. AcustomCodeelement needs anidand anameon every source, so the API rejected any update of one, whether the sources were given or kept withportal_uuid. Sources now keepid,nameandfilters;get_portalreads them so the keep path sends them back, and afiltersobject is sent as an Interfaces Json string. -
CLI tracebacks, local variables: when the
pipefyCLI hit an error it does not turn into a message, it printed a traceback that listed the local variables of each frame. Inpipefy auth login, and in the token refresh that runs before a data command, those variables hold the access and refresh tokens, so up to the first 80 characters of each token went to stderr, and from there to terminal scrollback or a CI log. The traceback now shows the file, line, and error without local variables.