@flowrunner/cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +148 -0
- package/ai-docs/instructions/service-code-format/01-service-structure.md +180 -0
- package/ai-docs/instructions/service-code-format/02-zod-types.md +260 -0
- package/ai-docs/instructions/service-code-format/03-parameters.md +193 -0
- package/ai-docs/instructions/service-code-format/04-http-requests.md +257 -0
- package/ai-docs/instructions/service-code-format/05-dictionaries.md +103 -0
- package/ai-docs/instructions/service-code-format/06-oauth2.md +42 -0
- package/ai-docs/instructions/service-code-format/07-actions.md +171 -0
- package/ai-docs/instructions/service-code-format/08-polling-triggers.md +54 -0
- package/ai-docs/instructions/service-code-format/09-realtime-triggers.md +269 -0
- package/ai-docs/instructions/service-code-format/10-files-api.md +148 -0
- package/ai-docs/instructions/service-code-format/11-output-model.md +142 -0
- package/ai-docs/instructions/service-code-format/12-service-readme.md +69 -0
- package/ai-docs/instructions/service-code-format/13-runtime-contracts.md +193 -0
- package/ai-docs/instructions/service-code-format/14-reference-service.md +341 -0
- package/ai-docs/instructions/service-code-format/15-unit-tests.md +361 -0
- package/ai-docs/instructions/service-code-format/16-gotchas.md +201 -0
- package/ai-docs/instructions/service-code-format/17-client-certificates.md +162 -0
- package/ai-docs/instructions/service-code-format/18-test-recipes.md +160 -0
- package/ai-docs/instructions/service-code-format/README.md +120 -0
- package/ai-docs/providers/claude/agents/flowrunner-service-code-engineer.md +139 -0
- package/ai-docs/providers/claude/agents/flowrunner-service-test-engineer.md +497 -0
- package/ai-docs/providers/claude/main-orchestrator-segment.md +51 -0
- package/bin/flowrunner.js +66 -0
- package/bin/resolve-local.js +98 -0
- package/dist/cli.js +10972 -0
- package/dist/cli.js.map +7 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +10131 -0
- package/dist/index.js.map +7 -0
- package/dist/types/flow-extension-runner/src/common/config.d.ts +12 -0
- package/dist/types/flow-extension-runner/src/common/constants.d.ts +9 -0
- package/dist/types/flow-extension-runner/src/common/context-files.d.ts +107 -0
- package/dist/types/flow-extension-runner/src/common/context.d.ts +6 -0
- package/dist/types/flow-extension-runner/src/common/types.d.ts +11 -0
- package/dist/types/flow-extension-runner/src/errors/base.d.ts +17 -0
- package/dist/types/flow-extension-runner/src/errors/codes.d.ts +17 -0
- package/dist/types/flow-extension-runner/src/errors/errors.d.ts +48 -0
- package/dist/types/flow-extension-runner/src/errors/index.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/global.d.ts +34 -0
- package/dist/types/flow-extension-runner/src/index.d.ts +15 -0
- package/dist/types/flow-extension-runner/src/namespace.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/v1/config.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/v1/constants.d.ts +4 -0
- package/dist/types/flow-extension-runner/src/v1/index.d.ts +11 -0
- package/dist/types/flow-extension-runner/src/v1/namespace.d.ts +9 -0
- package/dist/types/flow-extension-runner/src/v1/service.d.ts +29 -0
- package/dist/types/flow-extension-runner/src/v1/types.d.ts +13 -0
- package/dist/types/flow-extension-runner/src/v2/actions/action-method.d.ts +34 -0
- package/dist/types/flow-extension-runner/src/v2/context/execution-context.d.ts +25 -0
- package/dist/types/flow-extension-runner/src/v2/context/logger.d.ts +2 -0
- package/dist/types/flow-extension-runner/src/v2/context/method-input.d.ts +27 -0
- package/dist/types/flow-extension-runner/src/v2/context/proxies.d.ts +1 -0
- package/dist/types/flow-extension-runner/src/v2/create-extension.d.ts +2 -0
- package/dist/types/flow-extension-runner/src/v2/crypto.d.ts +6 -0
- package/dist/types/flow-extension-runner/src/v2/dictionaries/dictionary-method.d.ts +24 -0
- package/dist/types/flow-extension-runner/src/v2/dictionaries/payload-schema.d.ts +10 -0
- package/dist/types/flow-extension-runner/src/v2/extension.d.ts +51 -0
- package/dist/types/flow-extension-runner/src/v2/index.d.ts +39 -0
- package/dist/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +31 -0
- package/dist/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +17 -0
- package/dist/types/flow-extension-runner/src/v2/loaders/payload-schema.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/v2/method.d.ts +22 -0
- package/dist/types/flow-extension-runner/src/v2/model/field-mapper.d.ts +10 -0
- package/dist/types/flow-extension-runner/src/v2/model/method-model.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/v2/model/model-types.d.ts +70 -0
- package/dist/types/flow-extension-runner/src/v2/model/params-model.d.ts +16 -0
- package/dist/types/flow-extension-runner/src/v2/oauth/method-names.d.ts +5 -0
- package/dist/types/flow-extension-runner/src/v2/oauth/oauth2.d.ts +9 -0
- package/dist/types/flow-extension-runner/src/v2/oauth/system-params.d.ts +6 -0
- package/dist/types/flow-extension-runner/src/v2/oauth/types.d.ts +54 -0
- package/dist/types/flow-extension-runner/src/v2/params/config-params.d.ts +14 -0
- package/dist/types/flow-extension-runner/src/v2/params/files-options.d.ts +58 -0
- package/dist/types/flow-extension-runner/src/v2/params/index.d.ts +19 -0
- package/dist/types/flow-extension-runner/src/v2/params/json/checks.d.ts +26 -0
- package/dist/types/flow-extension-runner/src/v2/params/json/decode.d.ts +24 -0
- package/dist/types/flow-extension-runner/src/v2/params/json/encode.d.ts +20 -0
- package/dist/types/flow-extension-runner/src/v2/params/json/types.d.ts +86 -0
- package/dist/types/flow-extension-runner/src/v2/params/json/values.d.ts +5 -0
- package/dist/types/flow-extension-runner/src/v2/params/method-params.d.ts +17 -0
- package/dist/types/flow-extension-runner/src/v2/params/params.d.ts +26 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/assert-object-schema.d.ts +6 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/assert-supported-schema.d.ts +8 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/coerce.d.ts +54 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/dates.d.ts +40 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/defaults.d.ts +36 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/field-plan.d.ts +33 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/introspect.d.ts +58 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/labels.d.ts +3 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/messages.d.ts +16 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/normalize.d.ts +8 -0
- package/dist/types/flow-extension-runner/src/v2/params/schema/parse.d.ts +7 -0
- package/dist/types/flow-extension-runner/src/v2/params/types.d.ts +29 -0
- package/dist/types/flow-extension-runner/src/v2/params/widget-types.d.ts +40 -0
- package/dist/types/flow-extension-runner/src/v2/params/zod.d.ts +86 -0
- package/dist/types/flow-extension-runner/src/v2/path.d.ts +1 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/mechanisms.d.ts +19 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/method-names.d.ts +1 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/polling-triggers.d.ts +11 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/system-params.d.ts +7 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/trigger-method.d.ts +25 -0
- package/dist/types/flow-extension-runner/src/v2/polling-triggers/types.d.ts +46 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/method-names.d.ts +7 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/realtime-setup.d.ts +10 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/system-params.d.ts +29 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/trigger-method.d.ts +33 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/types.d.ts +147 -0
- package/dist/types/flow-extension-runner/src/v2/realtime-triggers/verify.d.ts +2 -0
- package/dist/types/flow-extension-runner/src/v2/registry.d.ts +20 -0
- package/dist/types/flow-extension-runner/src/v2/result.d.ts +13 -0
- package/dist/types/flow-extension-runner/src/v2/system-method.d.ts +41 -0
- package/dist/types/flow-extension-runner/src/v2/types.d.ts +126 -0
- package/dist/types/jsdoc-parser/src/custom-type-defs/files.d.ts +2 -0
- package/dist/types/jsdoc-parser/src/index.d.ts +2 -0
- package/dist/types/jsdoc-parser/src/lib.d.ts +42 -0
- package/dist/types/jsdoc-parser/src/types.d.ts +2 -0
- package/dist/types/packages/cli/src/api/console-client.d.ts +69 -0
- package/dist/types/packages/cli/src/constants/index.d.ts +5 -0
- package/dist/types/packages/cli/src/constants/packaging.d.ts +7 -0
- package/dist/types/packages/cli/src/constants/project.d.ts +9 -0
- package/dist/types/packages/cli/src/constants/providers.d.ts +30 -0
- package/dist/types/packages/cli/src/constants/server.d.ts +29 -0
- package/dist/types/packages/cli/src/constants/testing.d.ts +32 -0
- package/dist/types/packages/cli/src/errors.d.ts +131 -0
- package/dist/types/packages/cli/src/index.d.ts +29 -0
- package/dist/types/packages/cli/src/operations/deploy/discover-services.d.ts +26 -0
- package/dist/types/packages/cli/src/operations/deploy/hash.d.ts +1 -0
- package/dist/types/packages/cli/src/operations/deploy/index.d.ts +94 -0
- package/dist/types/packages/cli/src/operations/deploy/public-files.d.ts +20 -0
- package/dist/types/packages/cli/src/operations/deploy/select.d.ts +9 -0
- package/dist/types/packages/cli/src/operations/deploy/zip.d.ts +1 -0
- package/dist/types/packages/cli/src/operations/init/answers.d.ts +35 -0
- package/dist/types/packages/cli/src/operations/init/create-service.d.ts +39 -0
- package/dist/types/packages/cli/src/operations/init/index.d.ts +79 -0
- package/dist/types/packages/cli/src/operations/init/testing.d.ts +13 -0
- package/dist/types/packages/cli/src/operations/init-claude/index.d.ts +40 -0
- package/dist/types/packages/cli/src/operations/init-claude/segment.d.ts +25 -0
- package/dist/types/packages/cli/src/operations/login.d.ts +38 -0
- package/dist/types/packages/cli/src/operations/logout.d.ts +19 -0
- package/dist/types/packages/cli/src/operations/pull/extract.d.ts +23 -0
- package/dist/types/packages/cli/src/operations/pull/index.d.ts +87 -0
- package/dist/types/packages/cli/src/operations/server-target.d.ts +14 -0
- package/dist/types/packages/cli/src/operations/types.d.ts +20 -0
- package/dist/types/packages/cli/src/operations/use-server.d.ts +17 -0
- package/dist/types/packages/cli/src/project/auth.d.ts +41 -0
- package/dist/types/packages/cli/src/project/config.d.ts +31 -0
- package/dist/types/packages/cli/src/project/token.d.ts +5 -0
- package/dist/types/packages/cli/src/server/index.d.ts +14 -0
- package/dist/types/packages/cli/src/server/pages.d.ts +2 -0
- package/dist/types/packages/cli/src/server/routes/callback.d.ts +6 -0
- package/dist/types/packages/cli/src/server/types.d.ts +12 -0
- package/dist/types/packages/cli/src/templates/index.d.ts +8 -0
- package/dist/types/packages/cli/src/templates/manifest.d.ts +97 -0
- package/dist/types/packages/cli/src/templates/package-root.d.ts +3 -0
- package/dist/types/packages/cli/src/templates/paths.d.ts +3 -0
- package/dist/types/packages/cli/src/templates/registry.d.ts +13 -0
- package/dist/types/packages/cli/src/templates/render.d.ts +13 -0
- package/dist/types/packages/cli/src/templates/scaffold.d.ts +25 -0
- package/dist/types/packages/cli/src/utils/invocation.d.ts +28 -0
- package/dist/types/packages/cli/src/utils/open-browser.d.ts +2 -0
- package/dist/types/shared/src/constants/ai-agent-tools.d.ts +20 -0
- package/dist/types/shared/src/constants/ai.d.ts +11 -0
- package/dist/types/shared/src/constants/api-keys.d.ts +1 -0
- package/dist/types/shared/src/constants/app.d.ts +58 -0
- package/dist/types/shared/src/constants/billing.d.ts +16 -0
- package/dist/types/shared/src/constants/compliances.d.ts +3 -0
- package/dist/types/shared/src/constants/data-types.d.ts +26 -0
- package/dist/types/shared/src/constants/error-codes.d.ts +16 -0
- package/dist/types/shared/src/constants/flow.d.ts +12 -0
- package/dist/types/shared/src/constants/index.d.ts +16 -0
- package/dist/types/shared/src/constants/knowledge-base.d.ts +13 -0
- package/dist/types/shared/src/constants/notification-types.d.ts +985 -0
- package/dist/types/shared/src/constants/notifications.d.ts +10 -0
- package/dist/types/shared/src/constants/patterns.d.ts +28 -0
- package/dist/types/shared/src/constants/retry-policy.d.ts +30 -0
- package/dist/types/shared/src/constants/severity.d.ts +9 -0
- package/dist/types/shared/src/constants/shared-extensions-search.d.ts +6 -0
- package/dist/types/shared/src/constants/shared-extensions.d.ts +35 -0
- package/dist/types/shared/src/constants/zod.d.ts +2 -0
- package/dist/types/shared/src/errors/api.d.ts +4 -0
- package/dist/types/shared/src/errors/base.d.ts +38 -0
- package/dist/types/shared/src/errors/common.d.ts +39 -0
- package/dist/types/shared/src/errors/index.d.ts +13 -0
- package/dist/types/shared/src/errors/k8s.d.ts +4 -0
- package/dist/types/shared/src/errors/message.d.ts +48 -0
- package/dist/types/shared/src/errors/open-search.d.ts +4 -0
- package/dist/types/shared/src/errors/s3.d.ts +11 -0
- package/dist/types/shared/src/extensions/zod.d.ts +25 -0
- package/dist/types/shared/src/scheme/account/dto.d.ts +60 -0
- package/dist/types/shared/src/scheme/account/index.d.ts +1 -0
- package/dist/types/shared/src/scheme/ai-agent-tools/dto.d.ts +69 -0
- package/dist/types/shared/src/scheme/ai-agent-tools/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/ai-agent-tools/parameters.d.ts +7 -0
- package/dist/types/shared/src/scheme/ai-router/dto.d.ts +23 -0
- package/dist/types/shared/src/scheme/ai-router/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/api-keys/dto.d.ts +28 -0
- package/dist/types/shared/src/scheme/api-keys/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/app/index.d.ts +1 -0
- package/dist/types/shared/src/scheme/app/java.dto.d.ts +6 -0
- package/dist/types/shared/src/scheme/billing/index.d.ts +1 -0
- package/dist/types/shared/src/scheme/billing/java.dto.d.ts +163 -0
- package/dist/types/shared/src/scheme/crm/billing.d.ts +149 -0
- package/dist/types/shared/src/scheme/crm/dto.d.ts +212 -0
- package/dist/types/shared/src/scheme/crm/index.d.ts +3 -0
- package/dist/types/shared/src/scheme/data-types/index.d.ts +1 -0
- package/dist/types/shared/src/scheme/data-types/java.dto.d.ts +23 -0
- package/dist/types/shared/src/scheme/dynamic-forms/dto.d.ts +30 -0
- package/dist/types/shared/src/scheme/dynamic-forms/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/extensions/index.d.ts +1 -0
- package/dist/types/shared/src/scheme/extensions/params-to-zod.d.ts +14 -0
- package/dist/types/shared/src/scheme/flowrunner/custom-elements.d.ts +368 -0
- package/dist/types/shared/src/scheme/flowrunner/index.d.ts +3 -0
- package/dist/types/shared/src/scheme/flowrunner/java.dto.d.ts +628 -0
- package/dist/types/shared/src/scheme/index.d.ts +19 -0
- package/dist/types/shared/src/scheme/integration-connection/dto.d.ts +81 -0
- package/dist/types/shared/src/scheme/integration-connection/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/knowledge-base/dto.d.ts +540 -0
- package/dist/types/shared/src/scheme/knowledge-base/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/mcp-oauth/dto.d.ts +7 -0
- package/dist/types/shared/src/scheme/mcp-oauth/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/notifications/dto.d.ts +111 -0
- package/dist/types/shared/src/scheme/notifications/index.d.ts +3 -0
- package/dist/types/shared/src/scheme/notifications/rest.d.ts +148 -0
- package/dist/types/shared/src/scheme/properties/account.d.ts +3 -0
- package/dist/types/shared/src/scheme/properties/app.d.ts +5 -0
- package/dist/types/shared/src/scheme/properties/billing.d.ts +12 -0
- package/dist/types/shared/src/scheme/properties/common.d.ts +2 -0
- package/dist/types/shared/src/scheme/properties/db.d.ts +8 -0
- package/dist/types/shared/src/scheme/properties/flow-extensions.d.ts +7 -0
- package/dist/types/shared/src/scheme/properties/index.d.ts +7 -0
- package/dist/types/shared/src/scheme/remote-mcp-server/dto.d.ts +278 -0
- package/dist/types/shared/src/scheme/remote-mcp-server/index.d.ts +2 -0
- package/dist/types/shared/src/scheme/shared-extensions/base.d.ts +56 -0
- package/dist/types/shared/src/scheme/shared-extensions/config.d.ts +96 -0
- package/dist/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +485 -0
- package/dist/types/shared/src/scheme/shared-extensions/extension.d.ts +387 -0
- package/dist/types/shared/src/scheme/shared-extensions/flow-extensions.d.ts +64 -0
- package/dist/types/shared/src/scheme/shared-extensions/index.d.ts +15 -0
- package/dist/types/shared/src/scheme/shared-extensions/light.d.ts +38 -0
- package/dist/types/shared/src/scheme/shared-extensions/logs.d.ts +21 -0
- package/dist/types/shared/src/scheme/shared-extensions/methods.d.ts +80 -0
- package/dist/types/shared/src/scheme/shared-extensions/params-schema.d.ts +47 -0
- package/dist/types/shared/src/scheme/shared-extensions/popular-pool.d.ts +11 -0
- package/dist/types/shared/src/scheme/shared-extensions/resolve.d.ts +364 -0
- package/dist/types/shared/src/scheme/shared-extensions/rest.d.ts +9 -0
- package/dist/types/shared/src/scheme/shared-extensions/search.d.ts +177 -0
- package/dist/types/shared/src/scheme/shared-extensions/service-identity.d.ts +10 -0
- package/dist/types/shared/src/scheme/shared-extensions/service-info.d.ts +15 -0
- package/dist/types/shared/src/scheme/workspace/dto.d.ts +40 -0
- package/dist/types/shared/src/scheme/workspace/index.d.ts +1 -0
- package/dist/types/shared/src/utils/object.d.ts +8 -0
- package/dist/types/shared/src/utils/uuid.d.ts +5 -0
- package/dist/types/shared/src/utils/versions.d.ts +4 -0
- package/dist/types/types/backendless-request.d.ts +40 -0
- package/package.json +66 -0
- package/project-files/jest.config.js +38 -0
- package/project-files/jest.setup.js +24 -0
- package/project-files/sandbox/files-mock.js +654 -0
- package/project-files/sandbox/index.js +32 -0
- package/project-files/sandbox/nock-mock.js +600 -0
- package/project-files/sandbox/service.js +145 -0
- package/runtime/index.d.ts +2 -0
- package/runtime/index.js +5665 -0
- package/runtime/index.js.map +7 -0
- package/runtime/types/flow-extension-runner/src/common/config.d.ts +12 -0
- package/runtime/types/flow-extension-runner/src/common/constants.d.ts +9 -0
- package/runtime/types/flow-extension-runner/src/common/context-files.d.ts +107 -0
- package/runtime/types/flow-extension-runner/src/common/context.d.ts +6 -0
- package/runtime/types/flow-extension-runner/src/common/types.d.ts +11 -0
- package/runtime/types/flow-extension-runner/src/errors/base.d.ts +17 -0
- package/runtime/types/flow-extension-runner/src/errors/codes.d.ts +17 -0
- package/runtime/types/flow-extension-runner/src/errors/errors.d.ts +48 -0
- package/runtime/types/flow-extension-runner/src/errors/index.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/global.d.ts +34 -0
- package/runtime/types/flow-extension-runner/src/index.d.ts +15 -0
- package/runtime/types/flow-extension-runner/src/namespace.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/v1/config.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/v1/constants.d.ts +4 -0
- package/runtime/types/flow-extension-runner/src/v1/index.d.ts +11 -0
- package/runtime/types/flow-extension-runner/src/v1/namespace.d.ts +9 -0
- package/runtime/types/flow-extension-runner/src/v1/service.d.ts +29 -0
- package/runtime/types/flow-extension-runner/src/v1/types.d.ts +13 -0
- package/runtime/types/flow-extension-runner/src/v2/actions/action-method.d.ts +34 -0
- package/runtime/types/flow-extension-runner/src/v2/context/execution-context.d.ts +25 -0
- package/runtime/types/flow-extension-runner/src/v2/context/logger.d.ts +2 -0
- package/runtime/types/flow-extension-runner/src/v2/context/method-input.d.ts +27 -0
- package/runtime/types/flow-extension-runner/src/v2/context/proxies.d.ts +1 -0
- package/runtime/types/flow-extension-runner/src/v2/create-extension.d.ts +2 -0
- package/runtime/types/flow-extension-runner/src/v2/crypto.d.ts +6 -0
- package/runtime/types/flow-extension-runner/src/v2/dictionaries/dictionary-method.d.ts +24 -0
- package/runtime/types/flow-extension-runner/src/v2/dictionaries/payload-schema.d.ts +10 -0
- package/runtime/types/flow-extension-runner/src/v2/extension.d.ts +51 -0
- package/runtime/types/flow-extension-runner/src/v2/index.d.ts +39 -0
- package/runtime/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +31 -0
- package/runtime/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +17 -0
- package/runtime/types/flow-extension-runner/src/v2/loaders/payload-schema.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/v2/method.d.ts +22 -0
- package/runtime/types/flow-extension-runner/src/v2/model/field-mapper.d.ts +10 -0
- package/runtime/types/flow-extension-runner/src/v2/model/method-model.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/v2/model/model-types.d.ts +70 -0
- package/runtime/types/flow-extension-runner/src/v2/model/params-model.d.ts +16 -0
- package/runtime/types/flow-extension-runner/src/v2/oauth/method-names.d.ts +5 -0
- package/runtime/types/flow-extension-runner/src/v2/oauth/oauth2.d.ts +9 -0
- package/runtime/types/flow-extension-runner/src/v2/oauth/system-params.d.ts +6 -0
- package/runtime/types/flow-extension-runner/src/v2/oauth/types.d.ts +54 -0
- package/runtime/types/flow-extension-runner/src/v2/params/config-params.d.ts +14 -0
- package/runtime/types/flow-extension-runner/src/v2/params/files-options.d.ts +58 -0
- package/runtime/types/flow-extension-runner/src/v2/params/index.d.ts +19 -0
- package/runtime/types/flow-extension-runner/src/v2/params/json/checks.d.ts +26 -0
- package/runtime/types/flow-extension-runner/src/v2/params/json/decode.d.ts +24 -0
- package/runtime/types/flow-extension-runner/src/v2/params/json/encode.d.ts +20 -0
- package/runtime/types/flow-extension-runner/src/v2/params/json/types.d.ts +86 -0
- package/runtime/types/flow-extension-runner/src/v2/params/json/values.d.ts +5 -0
- package/runtime/types/flow-extension-runner/src/v2/params/method-params.d.ts +17 -0
- package/runtime/types/flow-extension-runner/src/v2/params/params.d.ts +26 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/assert-object-schema.d.ts +6 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/assert-supported-schema.d.ts +8 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/coerce.d.ts +54 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/dates.d.ts +40 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/defaults.d.ts +36 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/field-plan.d.ts +33 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/introspect.d.ts +58 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/labels.d.ts +3 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/messages.d.ts +16 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/normalize.d.ts +8 -0
- package/runtime/types/flow-extension-runner/src/v2/params/schema/parse.d.ts +7 -0
- package/runtime/types/flow-extension-runner/src/v2/params/types.d.ts +29 -0
- package/runtime/types/flow-extension-runner/src/v2/params/widget-types.d.ts +40 -0
- package/runtime/types/flow-extension-runner/src/v2/params/zod.d.ts +86 -0
- package/runtime/types/flow-extension-runner/src/v2/path.d.ts +1 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/mechanisms.d.ts +19 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/method-names.d.ts +1 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/polling-triggers.d.ts +11 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/system-params.d.ts +7 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/trigger-method.d.ts +25 -0
- package/runtime/types/flow-extension-runner/src/v2/polling-triggers/types.d.ts +46 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/method-names.d.ts +7 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/realtime-setup.d.ts +10 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/system-params.d.ts +29 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/trigger-method.d.ts +33 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/types.d.ts +147 -0
- package/runtime/types/flow-extension-runner/src/v2/realtime-triggers/verify.d.ts +2 -0
- package/runtime/types/flow-extension-runner/src/v2/registry.d.ts +20 -0
- package/runtime/types/flow-extension-runner/src/v2/result.d.ts +13 -0
- package/runtime/types/flow-extension-runner/src/v2/system-method.d.ts +41 -0
- package/runtime/types/flow-extension-runner/src/v2/types.d.ts +126 -0
- package/runtime/types/jsdoc-parser/src/custom-type-defs/files.d.ts +2 -0
- package/runtime/types/jsdoc-parser/src/index.d.ts +2 -0
- package/runtime/types/jsdoc-parser/src/lib.d.ts +42 -0
- package/runtime/types/jsdoc-parser/src/types.d.ts +2 -0
- package/runtime/types/packages/cli/src/runtime/index.d.ts +5 -0
- package/runtime/types/shared/src/constants/ai-agent-tools.d.ts +20 -0
- package/runtime/types/shared/src/constants/ai.d.ts +11 -0
- package/runtime/types/shared/src/constants/api-keys.d.ts +1 -0
- package/runtime/types/shared/src/constants/app.d.ts +58 -0
- package/runtime/types/shared/src/constants/billing.d.ts +16 -0
- package/runtime/types/shared/src/constants/compliances.d.ts +3 -0
- package/runtime/types/shared/src/constants/data-types.d.ts +26 -0
- package/runtime/types/shared/src/constants/error-codes.d.ts +16 -0
- package/runtime/types/shared/src/constants/flow.d.ts +12 -0
- package/runtime/types/shared/src/constants/index.d.ts +16 -0
- package/runtime/types/shared/src/constants/knowledge-base.d.ts +13 -0
- package/runtime/types/shared/src/constants/notification-types.d.ts +985 -0
- package/runtime/types/shared/src/constants/notifications.d.ts +10 -0
- package/runtime/types/shared/src/constants/patterns.d.ts +28 -0
- package/runtime/types/shared/src/constants/retry-policy.d.ts +30 -0
- package/runtime/types/shared/src/constants/severity.d.ts +9 -0
- package/runtime/types/shared/src/constants/shared-extensions-search.d.ts +6 -0
- package/runtime/types/shared/src/constants/shared-extensions.d.ts +35 -0
- package/runtime/types/shared/src/constants/zod.d.ts +2 -0
- package/runtime/types/shared/src/errors/api.d.ts +4 -0
- package/runtime/types/shared/src/errors/base.d.ts +38 -0
- package/runtime/types/shared/src/errors/common.d.ts +39 -0
- package/runtime/types/shared/src/errors/index.d.ts +13 -0
- package/runtime/types/shared/src/errors/k8s.d.ts +4 -0
- package/runtime/types/shared/src/errors/message.d.ts +48 -0
- package/runtime/types/shared/src/errors/open-search.d.ts +4 -0
- package/runtime/types/shared/src/errors/s3.d.ts +11 -0
- package/runtime/types/shared/src/extensions/zod.d.ts +25 -0
- package/runtime/types/shared/src/scheme/account/dto.d.ts +60 -0
- package/runtime/types/shared/src/scheme/account/index.d.ts +1 -0
- package/runtime/types/shared/src/scheme/ai-agent-tools/dto.d.ts +69 -0
- package/runtime/types/shared/src/scheme/ai-agent-tools/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/ai-agent-tools/parameters.d.ts +7 -0
- package/runtime/types/shared/src/scheme/ai-router/dto.d.ts +23 -0
- package/runtime/types/shared/src/scheme/ai-router/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/api-keys/dto.d.ts +28 -0
- package/runtime/types/shared/src/scheme/api-keys/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/app/index.d.ts +1 -0
- package/runtime/types/shared/src/scheme/app/java.dto.d.ts +6 -0
- package/runtime/types/shared/src/scheme/billing/index.d.ts +1 -0
- package/runtime/types/shared/src/scheme/billing/java.dto.d.ts +163 -0
- package/runtime/types/shared/src/scheme/crm/billing.d.ts +149 -0
- package/runtime/types/shared/src/scheme/crm/dto.d.ts +212 -0
- package/runtime/types/shared/src/scheme/crm/index.d.ts +3 -0
- package/runtime/types/shared/src/scheme/data-types/index.d.ts +1 -0
- package/runtime/types/shared/src/scheme/data-types/java.dto.d.ts +23 -0
- package/runtime/types/shared/src/scheme/dynamic-forms/dto.d.ts +30 -0
- package/runtime/types/shared/src/scheme/dynamic-forms/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/extensions/index.d.ts +1 -0
- package/runtime/types/shared/src/scheme/extensions/params-to-zod.d.ts +14 -0
- package/runtime/types/shared/src/scheme/flowrunner/custom-elements.d.ts +368 -0
- package/runtime/types/shared/src/scheme/flowrunner/index.d.ts +3 -0
- package/runtime/types/shared/src/scheme/flowrunner/java.dto.d.ts +628 -0
- package/runtime/types/shared/src/scheme/index.d.ts +19 -0
- package/runtime/types/shared/src/scheme/integration-connection/dto.d.ts +81 -0
- package/runtime/types/shared/src/scheme/integration-connection/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/knowledge-base/dto.d.ts +540 -0
- package/runtime/types/shared/src/scheme/knowledge-base/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/mcp-oauth/dto.d.ts +7 -0
- package/runtime/types/shared/src/scheme/mcp-oauth/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/notifications/dto.d.ts +111 -0
- package/runtime/types/shared/src/scheme/notifications/index.d.ts +3 -0
- package/runtime/types/shared/src/scheme/notifications/rest.d.ts +148 -0
- package/runtime/types/shared/src/scheme/properties/account.d.ts +3 -0
- package/runtime/types/shared/src/scheme/properties/app.d.ts +5 -0
- package/runtime/types/shared/src/scheme/properties/billing.d.ts +12 -0
- package/runtime/types/shared/src/scheme/properties/common.d.ts +2 -0
- package/runtime/types/shared/src/scheme/properties/db.d.ts +8 -0
- package/runtime/types/shared/src/scheme/properties/flow-extensions.d.ts +7 -0
- package/runtime/types/shared/src/scheme/properties/index.d.ts +7 -0
- package/runtime/types/shared/src/scheme/remote-mcp-server/dto.d.ts +278 -0
- package/runtime/types/shared/src/scheme/remote-mcp-server/index.d.ts +2 -0
- package/runtime/types/shared/src/scheme/shared-extensions/base.d.ts +56 -0
- package/runtime/types/shared/src/scheme/shared-extensions/config.d.ts +96 -0
- package/runtime/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +485 -0
- package/runtime/types/shared/src/scheme/shared-extensions/extension.d.ts +387 -0
- package/runtime/types/shared/src/scheme/shared-extensions/flow-extensions.d.ts +64 -0
- package/runtime/types/shared/src/scheme/shared-extensions/index.d.ts +15 -0
- package/runtime/types/shared/src/scheme/shared-extensions/light.d.ts +38 -0
- package/runtime/types/shared/src/scheme/shared-extensions/logs.d.ts +21 -0
- package/runtime/types/shared/src/scheme/shared-extensions/methods.d.ts +80 -0
- package/runtime/types/shared/src/scheme/shared-extensions/params-schema.d.ts +47 -0
- package/runtime/types/shared/src/scheme/shared-extensions/popular-pool.d.ts +11 -0
- package/runtime/types/shared/src/scheme/shared-extensions/resolve.d.ts +364 -0
- package/runtime/types/shared/src/scheme/shared-extensions/rest.d.ts +9 -0
- package/runtime/types/shared/src/scheme/shared-extensions/search.d.ts +177 -0
- package/runtime/types/shared/src/scheme/shared-extensions/service-identity.d.ts +10 -0
- package/runtime/types/shared/src/scheme/shared-extensions/service-info.d.ts +15 -0
- package/runtime/types/shared/src/scheme/workspace/dto.d.ts +40 -0
- package/runtime/types/shared/src/scheme/workspace/index.d.ts +1 -0
- package/runtime/types/shared/src/utils/object.d.ts +8 -0
- package/runtime/types/shared/src/utils/uuid.d.ts +5 -0
- package/runtime/types/shared/src/utils/versions.d.ts +4 -0
- package/runtime/types/types/backendless-request.d.ts +40 -0
- package/templates/blank/files/README.md +28 -0
- package/templates/blank/files/package.json +8 -0
- package/templates/blank/files/public/icon.svg +5 -0
- package/templates/blank/files/src/index.js +130 -0
- package/templates/blank/template.json +61 -0
- package/templates/demo-todo-list/files/README.md +54 -0
- package/templates/demo-todo-list/files/package.json +8 -0
- package/templates/demo-todo-list/files/public/icon.svg +8 -0
- package/templates/demo-todo-list/files/src/index.js +590 -0
- package/templates/demo-todo-list/template.json +44 -0
- package/templates/qa-test/files/README.md +88 -0
- package/templates/qa-test/files/package.json +8 -0
- package/templates/qa-test/files/public/icon.svg +8 -0
- package/templates/qa-test/files/src/index.js +755 -0
- package/templates/qa-test/template.json +62 -0
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
# 14 — Reference Service
|
|
2
|
+
|
|
3
|
+
One complete service that exercises the whole surface once: config, `initContext`, `apiRequest`, `helpers`,
|
|
4
|
+
a dictionary, two actions, a polling trigger and two realtime triggers. **Copy the shape, not the domain** —
|
|
5
|
+
including the layout, the naming and the formatting, which are rules rather than taste
|
|
6
|
+
([01-service-structure.md](01-service-structure.md), [03-parameters.md](03-parameters.md)).
|
|
7
|
+
|
|
8
|
+
> **Read this instead of the CLI templates.** The templates that ship with the CLI are project scaffolding,
|
|
9
|
+
> not authoring reference. Do not open `node_modules/flowrunner-cli/templates/`, or anything else inside the
|
|
10
|
+
> package.
|
|
11
|
+
|
|
12
|
+
This file is verified against the runtime: it builds, and the model it produces is the one annotated at the
|
|
13
|
+
bottom. Numbers in comments point at the document that governs the line.
|
|
14
|
+
|
|
15
|
+
This service assumes the standard layout — note that the icon lives in `public/`, not beside `src/`
|
|
16
|
+
(see [01-service-structure.md](01-service-structure.md#folder-layout)):
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
services/notes/
|
|
20
|
+
├── src/index.js
|
|
21
|
+
├── public/icon.svg
|
|
22
|
+
└── README.md
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
```js
|
|
26
|
+
// Reference service — exercises the whole authoring surface once.
|
|
27
|
+
const z = Flowrunner.z
|
|
28
|
+
|
|
29
|
+
const ext = Flowrunner.createExtension({
|
|
30
|
+
id : 'notes',
|
|
31
|
+
name : 'Notes',
|
|
32
|
+
description : 'Reference service — notes, boards and their events.',
|
|
33
|
+
logo : '/icon.svg', // → services/notes/public/icon.svg — the file must exist there
|
|
34
|
+
appearanceColors: ['#2D7FF9', '#B9D5FF'],
|
|
35
|
+
usesFileStorage : false,
|
|
36
|
+
|
|
37
|
+
// 02: widget follows the zod type. .shared() routes to the global tier; a z.number() config field
|
|
38
|
+
// RENDERS as a text box (11) but still reaches the handler as a number — no conversion needed.
|
|
39
|
+
configItems: z.object({
|
|
40
|
+
apiToken : z.string().label('API Token').describe('Personal token from Settings → API'),
|
|
41
|
+
webhookSecret: z.string().optional().label('Webhook Secret'),
|
|
42
|
+
pageSize : z.number().optional().default(50).label('Page Size'),
|
|
43
|
+
}),
|
|
44
|
+
|
|
45
|
+
// 01: runs once per invocation; its return type IS `context` in every handler. Widen it here.
|
|
46
|
+
initContext: ({ config }) => ({
|
|
47
|
+
baseUrl : 'https://api.notes.example/v1',
|
|
48
|
+
token : config.apiToken,
|
|
49
|
+
pageSize: config.pageSize,
|
|
50
|
+
}),
|
|
51
|
+
|
|
52
|
+
// 04: the one place envelope-unwrap, error-normalize and redaction live.
|
|
53
|
+
apiRequest: async ({ url, method = 'get', body, query, context, logger, logTag }) => {
|
|
54
|
+
const fullUrl = `${ context.baseUrl }${ url }`
|
|
55
|
+
|
|
56
|
+
logger?.debug(`[${ logTag ?? 'api' }] ${ method.toUpperCase() } ${ fullUrl }`)
|
|
57
|
+
|
|
58
|
+
try {
|
|
59
|
+
// 04: the verb is a value here, so the constructor form — never Request[method](url).
|
|
60
|
+
const response = await new Flowrunner.Request(fullUrl, method, body)
|
|
61
|
+
.set({ Authorization: `Bearer ${ context.token }` })
|
|
62
|
+
.query(query ?? {})
|
|
63
|
+
|
|
64
|
+
return response?.data ?? response
|
|
65
|
+
} catch (error) {
|
|
66
|
+
// 04: a non-2xx rejects with ResponseError — `message` is the raw body, so normalize it.
|
|
67
|
+
throw new Error(`Notes API ${ error?.status ?? '?' }: ${ describeFailure(error) }`)
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
|
|
71
|
+
// 01: helpers carry real reusable logic. Paging a list endpoint to the end is logic; renaming
|
|
72
|
+
// apiRequest, or wrapping `files`, is not — those are already in every handler bag.
|
|
73
|
+
helpers: ({ apiRequest, context }) => ({
|
|
74
|
+
listAllNotes: async (boardId) => {
|
|
75
|
+
const all = []
|
|
76
|
+
let cursor = null
|
|
77
|
+
|
|
78
|
+
do {
|
|
79
|
+
const page = await apiRequest({
|
|
80
|
+
url : `/boards/${ boardId }/notes`,
|
|
81
|
+
query: { cursor, limit: context.pageSize },
|
|
82
|
+
})
|
|
83
|
+
|
|
84
|
+
all.push(...(page.notes ?? []))
|
|
85
|
+
cursor = page.next ?? null
|
|
86
|
+
} while (cursor)
|
|
87
|
+
|
|
88
|
+
return all
|
|
89
|
+
},
|
|
90
|
+
}),
|
|
91
|
+
})
|
|
92
|
+
|
|
93
|
+
// 05: id starts with `get`, ends with `Dictionary`; the const carries the same name.
|
|
94
|
+
const getBoardsDictionary = ext.dictionary({
|
|
95
|
+
id : 'getBoardsDictionary',
|
|
96
|
+
label : 'Boards',
|
|
97
|
+
description: 'Boards in the workspace',
|
|
98
|
+
criteria : z.object({ workspaceId: z.string().label('Workspace ID') }),
|
|
99
|
+
result : { items: [{ label: 'Roadmap', value: 'brd_1' }], cursor: null },
|
|
100
|
+
execute : async ({ search, cursor, criteria, apiRequest }) => {
|
|
101
|
+
const response = await apiRequest({
|
|
102
|
+
url : `/workspaces/${ criteria.workspaceId }/boards`,
|
|
103
|
+
query: { q: search, cursor },
|
|
104
|
+
})
|
|
105
|
+
|
|
106
|
+
return {
|
|
107
|
+
items : (response.boards ?? []).map(board => ({ label: board.name, value: board.id })),
|
|
108
|
+
cursor: response.next ?? null,
|
|
109
|
+
}
|
|
110
|
+
},
|
|
111
|
+
})
|
|
112
|
+
|
|
113
|
+
// 03: a shared param is named `…Param` and gets one plugin call per line.
|
|
114
|
+
const workspaceIdParam = z.string()
|
|
115
|
+
.label('Workspace ID')
|
|
116
|
+
.describe('Found in the workspace URL')
|
|
117
|
+
|
|
118
|
+
const boardIdParam = z.string()
|
|
119
|
+
.label('Board')
|
|
120
|
+
.dictionary(getBoardsDictionary) // auto dependsOn: ['workspaceId']
|
|
121
|
+
.describe('Board the note belongs to')
|
|
122
|
+
|
|
123
|
+
ext.addAction({
|
|
124
|
+
category : 'Notes',
|
|
125
|
+
id : 'createNote',
|
|
126
|
+
label : 'Create Note',
|
|
127
|
+
description: 'Creates a note on a board.',
|
|
128
|
+
params : z.object({
|
|
129
|
+
workspaceId: workspaceIdParam,
|
|
130
|
+
boardId : boardIdParam,
|
|
131
|
+
body : z.text().label('Body'),
|
|
132
|
+
visibility : z.enum(['private', 'workspace']).default('private').label('Visibility')
|
|
133
|
+
.labels({ private: 'Private', workspace: 'Workspace' }), // UI shows the label, the flow stores the value
|
|
134
|
+
pinned : z.boolean().optional().default(false).label('Pinned'),
|
|
135
|
+
}),
|
|
136
|
+
// 07: the sample object IS the result declaration. No zod schema, no .example() beside it.
|
|
137
|
+
result: {
|
|
138
|
+
id : 'note_1',
|
|
139
|
+
body : 'Ship it',
|
|
140
|
+
visibility: 'private',
|
|
141
|
+
pinned : false,
|
|
142
|
+
boardId : 'brd_1',
|
|
143
|
+
createdAt : '2026-01-01T00:00:00Z',
|
|
144
|
+
},
|
|
145
|
+
// 07: block body with an explicit return, and the API's own response handed back whole.
|
|
146
|
+
execute: async ({ params, apiRequest }) => {
|
|
147
|
+
return apiRequest({
|
|
148
|
+
url : `/boards/${ params.boardId }/notes`,
|
|
149
|
+
method: 'post',
|
|
150
|
+
body : { body: params.body, visibility: params.visibility, pinned: params.pinned },
|
|
151
|
+
logTag: 'createNote',
|
|
152
|
+
})
|
|
153
|
+
},
|
|
154
|
+
})
|
|
155
|
+
|
|
156
|
+
ext.addAction({
|
|
157
|
+
category : 'Notes',
|
|
158
|
+
id : 'listBoardNotes',
|
|
159
|
+
label : 'List Board Notes',
|
|
160
|
+
description: 'Lists every note on a board, following pagination to the end.',
|
|
161
|
+
params : z.object({
|
|
162
|
+
workspaceId: workspaceIdParam,
|
|
163
|
+
boardId : boardIdParam,
|
|
164
|
+
}),
|
|
165
|
+
result: {
|
|
166
|
+
boardId: 'brd_1',
|
|
167
|
+
total : 2,
|
|
168
|
+
notes : [{ id: 'note_1', body: 'Ship it', createdAt: '2026-01-01T00:00:00Z' }],
|
|
169
|
+
},
|
|
170
|
+
// 07: extending the provider's data is fine — dropping any of it is not.
|
|
171
|
+
execute: async ({ params, helpers }) => {
|
|
172
|
+
const notes = await helpers.listAllNotes(params.boardId)
|
|
173
|
+
|
|
174
|
+
return { boardId: params.boardId, total: notes.length, notes }
|
|
175
|
+
},
|
|
176
|
+
})
|
|
177
|
+
|
|
178
|
+
// 08: exactly one mechanism. `params` here are lenient — tolerate a half-configured instance.
|
|
179
|
+
ext.addPollingTrigger({
|
|
180
|
+
category : 'Notes',
|
|
181
|
+
id : 'onNoteCreated',
|
|
182
|
+
label : 'On Note Created',
|
|
183
|
+
description: 'Fires for each new note on a board.',
|
|
184
|
+
params : z.object({ boardId: z.string().optional().label('Board').dictionary(getBoardsDictionary) }),
|
|
185
|
+
result : { id: 'note_1', body: 'Ship it', boardId: 'brd_1', createdAt: '2026-01-01T00:00:00Z' },
|
|
186
|
+
fetch : async ({ params, apiRequest }) => {
|
|
187
|
+
if (!params.boardId) {
|
|
188
|
+
return []
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
const response = await apiRequest({ url: `/boards/${ params.boardId }/notes`, query: { sort: '-createdAt' } })
|
|
192
|
+
|
|
193
|
+
return response.notes ?? []
|
|
194
|
+
},
|
|
195
|
+
watermark: { by: 'createdAt', sortedDesc: true },
|
|
196
|
+
})
|
|
197
|
+
|
|
198
|
+
// 09: one webhook registration, declared once, serving every realtime trigger below.
|
|
199
|
+
ext.setupRealtimeTriggers({
|
|
200
|
+
scope : 'SINGLE_APP',
|
|
201
|
+
extractProviderEventName: 'event',
|
|
202
|
+
extractProviderEventData: 'data',
|
|
203
|
+
verify : {
|
|
204
|
+
header : 'X-Notes-Signature',
|
|
205
|
+
algo : 'sha256',
|
|
206
|
+
encoding: 'hex',
|
|
207
|
+
secret : (config) => config.webhookSecret,
|
|
208
|
+
},
|
|
209
|
+
subscribe: async ({ callbackUrl, triggers, webhookData, apiRequest }) => {
|
|
210
|
+
if (webhookData?.id) {
|
|
211
|
+
await apiRequest({ url: `/hooks/${ webhookData.id }`, method: 'delete' })
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
const events = [...new Set(triggers.map(trigger => trigger.providerEventName))]
|
|
215
|
+
const hook = await apiRequest({ url: '/hooks', method: 'post', body: { url: callbackUrl, events } })
|
|
216
|
+
|
|
217
|
+
return { webhookData: { id: hook.id } }
|
|
218
|
+
},
|
|
219
|
+
unsubscribe: async ({ webhookData, apiRequest }) => {
|
|
220
|
+
if (webhookData?.id) {
|
|
221
|
+
await apiRequest({ url: `/hooks/${ webhookData.id }`, method: 'delete' })
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
return { webhookData: {} }
|
|
225
|
+
},
|
|
226
|
+
})
|
|
227
|
+
|
|
228
|
+
// 09: ONE TRIGGER PER EVENT. Both share the single webhook above; neither takes an event-type param.
|
|
229
|
+
ext.addRealtimeTrigger({
|
|
230
|
+
category : 'Notes',
|
|
231
|
+
id : 'onNoteUpdated',
|
|
232
|
+
label : 'On Note Updated',
|
|
233
|
+
description : 'Fires when a note changes.',
|
|
234
|
+
providerEventName: 'note.updated',
|
|
235
|
+
params : z.object({
|
|
236
|
+
boardId : z.string().optional().label('Board').dictionary(getBoardsDictionary),
|
|
237
|
+
visibility: z.enum(['private', 'workspace']).optional().label('Visibility')
|
|
238
|
+
.labels({ private: 'Private', workspace: 'Workspace' }),
|
|
239
|
+
}),
|
|
240
|
+
result: { id: 'note_1', body: 'Ship it', boardId: 'brd_1', visibility: 'private' },
|
|
241
|
+
// 13: `match` gets the SAVED params — no .default() filled. Normalize by hand, and treat an
|
|
242
|
+
// absent value as "no filter".
|
|
243
|
+
match: ({ params, providerEventData }) => {
|
|
244
|
+
if (params.boardId && params.boardId !== providerEventData.boardId) {
|
|
245
|
+
return false
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
if (params.visibility) {
|
|
249
|
+
const wanted = toApiVisibility(params.visibility)
|
|
250
|
+
|
|
251
|
+
if (wanted !== providerEventData.visibility) {
|
|
252
|
+
return false
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
return true
|
|
257
|
+
},
|
|
258
|
+
extendResult: async ({ providerEventData, apiRequest }) => {
|
|
259
|
+
return {
|
|
260
|
+
...providerEventData,
|
|
261
|
+
board: await apiRequest({ url: `/boards/${ providerEventData.boardId }` }),
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
})
|
|
265
|
+
|
|
266
|
+
ext.addRealtimeTrigger({
|
|
267
|
+
category : 'Notes',
|
|
268
|
+
id : 'onNoteDeleted',
|
|
269
|
+
label : 'On Note Deleted',
|
|
270
|
+
description : 'Fires when a note is deleted.',
|
|
271
|
+
providerEventName: 'note.deleted',
|
|
272
|
+
params : z.object({
|
|
273
|
+
boardId: z.string().optional().label('Board').dictionary(getBoardsDictionary),
|
|
274
|
+
}),
|
|
275
|
+
result: { id: 'note_1', boardId: 'brd_1', deletedAt: '2026-01-02T00:00:00Z' },
|
|
276
|
+
// 09: the declarative form — type-coerced equality per filled param, empty param matches all.
|
|
277
|
+
match : { boardId: 'boardId' },
|
|
278
|
+
})
|
|
279
|
+
|
|
280
|
+
// 01: module-level helpers are function declarations, and they live at the end of the file.
|
|
281
|
+
|
|
282
|
+
const VISIBILITY_BY_LABEL = {
|
|
283
|
+
Private : 'private',
|
|
284
|
+
Workspace: 'workspace',
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
function toApiVisibility(label) {
|
|
288
|
+
// 16: a plain object, guarded at the point of the lookup.
|
|
289
|
+
return Object.hasOwn(VISIBILITY_BY_LABEL, label) ? VISIBILITY_BY_LABEL[label] : label
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
function describeFailure(error) {
|
|
293
|
+
const detail = error?.body?.error?.message ?? error?.message
|
|
294
|
+
|
|
295
|
+
return typeof detail === 'string' ? detail : JSON.stringify(detail)
|
|
296
|
+
}
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
## The model it produces
|
|
300
|
+
|
|
301
|
+
Verified with `buildServiceDefinition` (see [13-runtime-contracts.md](13-runtime-contracts.md)):
|
|
302
|
+
|
|
303
|
+
```
|
|
304
|
+
methods : createNote, listBoardNotes, getBoardsDictionary, onNoteCreated, onNoteUpdated,
|
|
305
|
+
onNoteDeleted, handleTriggerPollingForEvent, handleTriggerUpsertWebhook,
|
|
306
|
+
handleTriggerResolveEvents, handleTriggerSelectMatched, handleTriggerDeleteWebhook
|
|
307
|
+
configItems : apiToken:string, webhookSecret:string, pageSize:string
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
Six authored items, five runtime-owned SYSTEM methods. `handleTriggerRefreshWebhook` is absent because no
|
|
311
|
+
`refresh` was declared — the SYSTEM set follows what you declare
|
|
312
|
+
([09-realtime-triggers.md](09-realtime-triggers.md)).
|
|
313
|
+
|
|
314
|
+
Things in that output worth reading twice:
|
|
315
|
+
|
|
316
|
+
- **`pageSize:string`** — declared `z.number()`, published as `string`. Config fields collapse to five types
|
|
317
|
+
([02-zod-types.md](02-zod-types.md)), which is why `initContext` wraps it in `Number(...)` rather than
|
|
318
|
+
trusting the declared type.
|
|
319
|
+
- **`boardId`** gets `dependsOn: ['workspaceId']` — visible at `metaInfo.args.boardId.dependsOn` — with
|
|
320
|
+
nothing declared at the param. It is derived from the dictionary's `criteria`
|
|
321
|
+
([05-dictionaries.md](05-dictionaries.md)).
|
|
322
|
+
- **`visibility`** shows `Private` / `Workspace` in the dropdown and stores `private` / `workspace`, which
|
|
323
|
+
is what every handler receives — `execute` and a realtime `match` alike. `onNoteUpdated` still normalizes
|
|
324
|
+
by hand because `match` gets no `.default()` ([13-runtime-contracts.md](13-runtime-contracts.md)).
|
|
325
|
+
- **`onNoteUpdated` and `onNoteDeleted` are two triggers, not one** with an event parameter. They share the
|
|
326
|
+
single webhook registered by `setupRealtimeTriggers`, and each carries the `result` its own event actually
|
|
327
|
+
delivers ([09-realtime-triggers.md](09-realtime-triggers.md)).
|
|
328
|
+
|
|
329
|
+
## What the shape is showing you
|
|
330
|
+
|
|
331
|
+
| In the code | Rule |
|
|
332
|
+
|---|---|
|
|
333
|
+
| Helper `function`s at the bottom, not `const` arrows at the top | [01](01-service-structure.md#module-layout) |
|
|
334
|
+
| `helpers.listAllNotes` pages to the end; nothing merely renames `apiRequest` or `files` | [01](01-service-structure.md) |
|
|
335
|
+
| `getBoardsDictionary` — id starts `get`, ends `Dictionary`, const matches | [05](05-dictionaries.md) |
|
|
336
|
+
| `workspaceIdParam` / `boardIdParam` — one plugin call per line | [03](03-parameters.md) |
|
|
337
|
+
| `result` is a sample object, never a zod schema plus `.example()` | [07](07-actions.md) |
|
|
338
|
+
| Every `execute` is a block body with an explicit `return` | [07](07-actions.md) |
|
|
339
|
+
| `createNote` returns the API's response whole; `listBoardNotes` extends without dropping | [07](07-actions.md) |
|
|
340
|
+
| `new Flowrunner.Request(url, method, body)` — never `Request[method](url)` | [04](04-http-requests.md) |
|
|
341
|
+
| `Object.hasOwn` at the lookup, on a plain object literal | [16](16-gotchas.md) |
|