@powerhousedao/pieces-framework 6.2.3-dev.23 → 6.2.3-dev.25

package/README.md

@@ -87,6 +87,39 @@ import { httpClient, HttpMethod } from "@powerhousedao/pieces-framework/common";
    Powerhouse documents is the reactor piece's job, and a workflow composes the
    two as separate steps.
 
+   To give a connection a status and an account label in Connect, declare
+   `validate` and `getConnectionIdentifier` on the auth. Both are handed the
+   flat auth value (here the props themselves, not `{ type, props }`):
+
+   ```ts
+   const invoicesAuth = PieceAuth.CustomAuth({
+     displayName: "Invoices",
+     required: true,
+     props: {
+       base_url: Property.ShortText({
+         displayName: "Base URL",
+         required: true,
+       }),
+       token: PieceAuth.SecretText({ displayName: "Token", required: true }),
+     },
+     validate: async ({ auth }) => {
+       try {
+         await clientFor(auth).ping();
+         return { valid: true };
+       } catch (error) {
+         return { valid: false, error: String(error) };
+       }
+     },
+     getConnectionIdentifier: async ({ auth }) =>
+       (await clientFor(auth).me()).email,
+   });
+   ```
+
+   A reactor runs `validate` for the check's result and, when it passes,
+   `getConnectionIdentifier` for the account label. The label is best-effort:
+   returning `undefined` or throwing keeps the previous label and still passes
+   the check.
+
 3. **Register it.** List the piece in `pieces/index.ts` as a `PackagePiece`
    and in the package manifest under `"pieces"`:
 

package/UPSTREAM.md

@@ -43,16 +43,20 @@ Left out: `mime-db-min.cjs` (upstream's bundler alias that keeps `mime-db`,
 pulled in through `form-data`, out of piece bundles; aliasing is the piece
 build's job, so `ph build` may adopt it later) and upstream's unused `ai` and
 `semver` dependencies.
-Of the engine's own tests only `test/variables/props-validator.test.ts` and
-`test/variables/file-processor.test.ts` come along: the rest need
-`@activepieces/shared`, `props-resolver` or `FlowExecutorContext`.
+Of the engine's own tests only those that exercise vendored code come along:
+`test/variables/{props-validator,file-processor,dynamic-prop-keys}.test.ts`,
+`test/helper/polling-helper.test.ts` and
+`test/http/formdata-multipart-claim-verify.test.ts` (which guards the patched
+`fetch-http-client.ts`). The rest need `@activepieces/shared`,
+`props-resolver` or `FlowExecutorContext`.
 
 `@activepieces/shared` (8k lines of platform entities) is not vendored. The four
 piece packages never import it; the engine files do, so the codemod re-homes
 each symbol they use — `AUTHENTICATION_PROPERTY_NAME` and `AppConnectionValue`
 to `upstream/core-piece-types/`, which really defines them, and `PropertySettings`
-to `src/host/shared-shim.ts`, a Powerhouse-owned declaration of the minimal
-shape `props-processor.ts` reads. An unmapped symbol fails the sync.
+and `PropertyExecutionType` to `src/host/shared-shim.ts`, a Powerhouse-owned
+declaration of the minimal shapes `props-processor.ts` and its tests read. An
+unmapped symbol fails the sync.
 
 `deepmerge-ts` is a devDependency only: `core-utils` imports it in
 `deepMergeAndCast`, which the framework barrel never re-exports, so the source
@@ -87,11 +91,11 @@ Upstream is CommonJS with extensionless imports; this package is ESM under
    resolver will not infer for a subpath of a dependency with no `"exports"`
    map (`dayjs/plugin/utc` becomes `dayjs/plugin/utc.js`).
 4. Prepends a two-line header naming the upstream path and the tag.
-5. Runs `eslint --fix` with `scripts/sync-upstream.eslint.config.mjs`
-   (`consistent-type-imports`, `consistent-type-exports`, prettier) so
-   type-only imports and re-exports satisfy `verbatimModuleSyntax` and
-   `isolatedModules`. Unused-directive reporting is off there, so upstream's
-   `eslint-disable` comments survive even though their rules do not run.
+5. Marks type-only imports and re-exports with ts-morph
+   (`scripts/sync-upstream-type-only.mts`, a port of typescript-eslint's
+   `consistent-type-imports` and `consistent-type-exports` fixes) so they
+   satisfy `verbatimModuleSyntax` and `isolatedModules`, then formats the tree
+   with the repo's prettier config.
 6. Splits an `@activepieces/shared` import across the modules that really own
    each symbol, per `SHARED_SYMBOL_HOMES`.
 7. Applies the literal patches listed in `PATCHES` in
@@ -149,6 +153,11 @@ Current patches:
   `Property.MarkDown` always writes one and the exported type declares it,
   but the schema had no such key, so zod silently stripped
   `WARNING`/`TIP`/`BORDERLESS` variants on parse.
+- `upstream/framework/lib/trigger/trigger.ts`: give `createTrigger`'s switch a
+  `default` that throws, naming the trigger and its `type`. The switch had none,
+  so a missing or misspelt strategy returned `undefined`, and the piece failed
+  later wherever that trigger was first read. TypeScript already rejects it;
+  this covers code that bypasses the types.
 - `upstream/framework/index.ts` and `upstream/framework/lib/property/index.ts`:
   re-export `SeekPage`, `McpAuthConfig` and `InputProperty` as values instead
   of `export type`. Each is a zod schema merged with a type; rolldown-plugin-dts
@@ -156,8 +165,14 @@ Current patches:
   type-only re-export let `import { SeekPage }` typecheck and then fail at link
   time. The runtime gains three exports upstream's lacks; `test/dist.test.ts`
   holds the d.ts to the runtime.
+- `upstream/engine/lib/variables/props-processor.ts`: export
+  `validateProperty`, the validator half of `applyProcessorsAndValidators`.
+  A host that coerces values with its own processors first (reactor-workflow
+  hydrates FILE props itself) validates the result with it.
 - `test/upstream/framework/test/connection-identifier-flag.test.ts`: pass
   `authors: []` to `createPiece` (upstream does not typecheck its tests).
+- `test/upstream/engine/test/variables/dynamic-prop-keys.test.ts`: pass
+  `auth: undefined` to `Property.DynamicProperties`, which requires it.
 - `test/upstream/core-utils/test/ai-provider-health.test.ts`: make the outcome
   reporter return `void` instead of `Array.prototype.push`'s number (three
   sites).
@@ -170,3 +185,35 @@ Current patches:
 
 The vendored trees are excluded from the root ESLint run: their lint stance is
 upstream's, and the codemod already applies this repo's formatting.
+
+## Conformance suite for reactor-workflow
+
+The same sync also generates
+[`../reactor-workflow/test/upstream/`](../reactor-workflow/test/upstream):
+Activepieces engine tests that run against our engine instead of vendored code.
+It lives in this script rather than a second one so that one run, from one
+checkout, regenerates both trees under one codemod and one patch contract.
+
+`CONFORMANCE` in `scripts/sync-upstream.mts` lists each upstream test and its
+target, optionally cut down to literal `excerpt` segments. For each file the
+sync:
+
+1. Rewrites `@activepieces/pieces-framework` and `@activepieces/pieces-common`
+   to our published `@powerhousedao/pieces-framework` entries.
+2. Rewrites every other upstream import through `IMPORT_REDIRECTS` to an adapter
+   in `../reactor-workflow/test/upstream-adapters/`, which exposes the upstream
+   API (`createContextStore`, `createConnectionResolver`, `ssrfGuard`,
+   `propsProcessor`, the `@activepieces/shared` symbols) over our code. An
+   import with no redirect fails the sync.
+3. Adds the header, formats, and applies `CONFORMANCE_PATCHES`, which carry the
+   same `count` and `why` as `PATCHES`.
+4. Marks each `CONFORMANCE_SKIPS` case `it.skip` and each `KNOWN_DIVERGENCES`
+   case `it.fails`, with a comment giving the reason and, for a divergence, the
+   issue or README item that fixes it; a deliberate divergence names none. A
+   name that no longer matches upstream fails the sync. When a fix lands, its
+   `it.fails` starts failing: drop the entry and re-sync.
+5. Writes `test/upstream/MANIFEST.json` there, with the upstream path and
+   SHA-256 of each original and the lists of divergences and skips.
+
+Nothing is taken from `packages/ee/` or `packages/server/api/src/app/ee`, which
+are not MIT.