@prismatic-io/spectral 10.19.1-preview.0 → 10.21.0

package/dist/generators/cniComponentManifest/types.d.ts

@@ -47,7 +47,10 @@ export interface InputNode {
     shown: boolean;
     onPremiseControlled: boolean;
 }
-export type FormattedAction = Pick<Action, "key" | "display" | "inputs" | "examplePayload">;
+export type FormattedAction = Pick<Action, "key" | "display" | "inputs" | "examplePayload"> & {
+    /** Emitted verbatim into the generated manifest; shape mirrors `examplePayload`. */
+    outputSchema?: unknown;
+};
 export type FormattedTrigger<TInputs extends Inputs, TActionInputs extends Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerResult<TAllowsBranching, TPayload> = TriggerResult<TAllowsBranching, TPayload>> = Pick<Trigger<TInputs, TActionInputs, TConfigVars, TPayload, TAllowsBranching, TResult>, "key" | "display" | "inputs">;
 export type FormattedDataSource = Pick<DataSource, "key" | "display" | "inputs" | "dataSourceType" | "examplePayload">;
 export type ComponentForManifest<TInputs extends Inputs, TActionInputs extends Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerResult<TAllowsBranching, TPayload> = TriggerResult<TAllowsBranching, TPayload>> = Pick<Component<TInputs, TActionInputs, TConfigVars, TPayload, TAllowsBranching, TResult>, "key" | "public" | "display" | "connections"> & {

package/dist/generators/componentManifest/createActions.js

@@ -44,7 +44,7 @@ const createActions = (_a) => __awaiter(void 0, [_a], void 0, function* ({ compo
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderAction({
-            action: Object.assign(Object.assign({ typeInterface: (0, createTypeInterface_1.createTypeInterface)((_b = action.key) !== null && _b !== void 0 ? _b : actionKey), import: (0, createImport_1.createImport)((_c = action.key) !== null && _c !== void 0 ? _c : actionKey), key: action.key || actionKey, label: action.display.label, description: action.display.description, inputs }, (action.examplePayload ? { examplePayload: action.examplePayload } : {})), { componentKey: component.key }),
+            action: Object.assign(Object.assign(Object.assign({ typeInterface: (0, createTypeInterface_1.createTypeInterface)((_b = action.key) !== null && _b !== void 0 ? _b : actionKey), import: (0, createImport_1.createImport)((_c = action.key) !== null && _c !== void 0 ? _c : actionKey), key: action.key || actionKey, label: action.display.label, description: action.display.description, inputs }, (action.examplePayload ? { examplePayload: action.examplePayload } : {})), (action.outputSchema ? { outputSchema: action.outputSchema } : {})), { componentKey: component.key }),
             imports,
             dryRun,
             verbose,

package/dist/generators/componentManifest/templates/actions/action.ts.ejs

@@ -25,4 +25,7 @@ export const <%= action.import %> = {
   <%_ if (action.examplePayload) { -%>
   examplePayload: <%- typeof action.examplePayload === 'string' ? action.examplePayload : JSON.stringify(action.examplePayload, null, 2) %>,
   <%_ } -%>
+  <%_ if (action.outputSchema) { -%>
+  outputSchema: <%- typeof action.outputSchema === 'string' ? action.outputSchema : JSON.stringify(action.outputSchema, null, 2) %>,
+  <%_ } -%>
 } as const;

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  */
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
-import type { ActionDefinition, ActionPerformReturn, BatchTrigger, ComponentDefinition, ComponentManifest, ConfigPage, ConfigVarResultCollection, ConnectionConfigVar, CustomerActivatedConnectionConfigVar, DataSourceConfigVar, DataSourceDefinition, DataSourceType, DefaultConnectionDefinition, DynamicObjectInputField, Flow, InputFieldDefinition, Inputs, IntegrationDefinition, OAuth2ConnectionDefinition, OnPremConnectionDefinition, OrganizationActivatedConnectionConfigVar, StandardConfigVar, StructuredObjectInputField, TriggerDefinition, TriggerPayload, TriggerResult } from "./types";
+import type { ActionDefinition, ActionPerformReturn, BatchTrigger, ComponentDefinition, ComponentManifest, ConfigPage, ConfigVarResultCollection, ConnectionConfigVar, CustomerActivatedConnectionConfigVar, DataSourceConfigVar, DataSourceDefinition, DataSourceType, DefaultConnectionDefinition, DynamicObjectInputField, Flow, InputFieldDefinition, Inputs, IntegrationDefinition, OAuth2ConnectionDefinition, OnPremConnectionDefinition, OrganizationActivatedConnectionConfigVar, OutputSchema, StandardConfigVar, StructuredObjectInputField, TriggerDefinition, TriggerPayload, TriggerResult } from "./types";
 import type { PollingTriggerDefinition } from "./types/PollingTriggerDefinition";
 /**
  * This function creates a code-native integration object that can be
@@ -383,6 +383,38 @@ export declare const component: <TPublic extends boolean, TKey extends string>(d
  * });
  */
 export declare const action: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>>(definition: ActionDefinition<TInputs, TConfigVars, TAllowsBranching, TReturn>) => ActionDefinition<TInputs, TConfigVars, TAllowsBranching, TReturn>;
+/**
+ * Declares the output schema for an action and preserves its literal types,
+ * so authors don't need a trailing `as const` (or `satisfies OutputSchema`)
+ * to keep the `type` discriminant from widening to `string`.
+ *
+ * Wrapping the schema in this helper lets it be hoisted into a standalone
+ * variable and still satisfy the {@link OutputSchema} discriminated union:
+ *
+ * @example
+ * import { action, outputSchema } from "@prismatic-io/spectral";
+ *
+ * // Hoisted out of the action — no `as const` needed.
+ * const listItemsOutput = outputSchema({
+ *   type: "actionOutput",
+ *   schema: {
+ *     type: "object",
+ *     properties: { items: { type: "array" } },
+ *   },
+ * });
+ *
+ * export const listItems = action({
+ *   display: { label: "List Items", description: "..." },
+ *   inputs: {},
+ *   perform: async () => ({ data: { items: [] } }),
+ *   outputSchema: listItemsOutput,
+ * });
+ *
+ * @param definition An {@link OutputSchema} object — either an `actionOutput`
+ *   single-payload schema or a `branchingOutput` per-branch map.
+ * @returns The same object, typed with its literal discriminant preserved.
+ */
+export declare const outputSchema: <const TOutputSchema extends OutputSchema>(definition: TOutputSchema) => TOutputSchema;
 /**
  * This function creates a trigger object that can be referenced
  * by a custom component. It helps ensure that the shape of the

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.util = exports.testing = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.dynamicObjectInput = exports.structuredObjectInput = exports.input = exports.dataSource = exports.pollingTrigger = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.customerActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.batchFlowTrigger = exports.flow = exports.integration = void 0;
+exports.util = exports.testing = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.dynamicObjectInput = exports.structuredObjectInput = exports.input = exports.dataSource = exports.pollingTrigger = exports.trigger = exports.outputSchema = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.customerActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.batchFlowTrigger = exports.flow = exports.integration = void 0;
 const serverTypes_1 = require("./serverTypes");
 const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
@@ -426,6 +426,39 @@ exports.component = component;
  */
 const action = (definition) => definition;
 exports.action = action;
+/**
+ * Declares the output schema for an action and preserves its literal types,
+ * so authors don't need a trailing `as const` (or `satisfies OutputSchema`)
+ * to keep the `type` discriminant from widening to `string`.
+ *
+ * Wrapping the schema in this helper lets it be hoisted into a standalone
+ * variable and still satisfy the {@link OutputSchema} discriminated union:
+ *
+ * @example
+ * import { action, outputSchema } from "@prismatic-io/spectral";
+ *
+ * // Hoisted out of the action — no `as const` needed.
+ * const listItemsOutput = outputSchema({
+ *   type: "actionOutput",
+ *   schema: {
+ *     type: "object",
+ *     properties: { items: { type: "array" } },
+ *   },
+ * });
+ *
+ * export const listItems = action({
+ *   display: { label: "List Items", description: "..." },
+ *   inputs: {},
+ *   perform: async () => ({ data: { items: [] } }),
+ *   outputSchema: listItemsOutput,
+ * });
+ *
+ * @param definition An {@link OutputSchema} object — either an `actionOutput`
+ *   single-payload schema or a `branchingOutput` per-branch map.
+ * @returns The same object, typed with its literal discriminant preserved.
+ */
+const outputSchema = (definition) => definition;
+exports.outputSchema = outputSchema;
 /**
  * This function creates a trigger object that can be referenced
  * by a custom component. It helps ensure that the shape of the

package/dist/serverTypes/convertComponent.js

@@ -213,14 +213,26 @@ const convertTemplateInput = (key, _a, inputs) => {
     return Object.assign(Object.assign({}, (0, omit_1.default)(rest, ["permissionAndVisibilityType", "visibleToOrgDeployer", "writeOnly"])), { key, type: "template", default: templateValue !== null && templateValue !== void 0 ? templateValue : "", label: typeof label === "string" ? label : label.value, shown: false });
 };
 exports.convertTemplateInput = convertTemplateInput;
+const convertOutputSchema = (outputSchema) => {
+    if (outputSchema.type === "actionOutput") {
+        return { type: "actionOutput", schema: JSON.stringify(outputSchema.schema) };
+    }
+    return {
+        type: "branchingOutput",
+        branchSchemas: Object.entries(outputSchema.branchSchemas).map(([name, schema]) => ({
+            name,
+            schema: JSON.stringify(schema),
+        })),
+    };
+};
 const convertAction = (actionKey, _a, hooks) => {
-    var { inputs = {}, perform } = _a, action = __rest(_a, ["inputs", "perform"]);
+    var { inputs = {}, perform, outputSchema } = _a, action = __rest(_a, ["inputs", "perform", "outputSchema"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     const inputCleaners = Object.entries(inputs).reduce((result, [key, value]) => (Object.assign(Object.assign({}, result), { [key]: (0, exports.cleanerFor)(value) })), {});
-    return Object.assign(Object.assign({}, action), { key: actionKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
+    return Object.assign(Object.assign(Object.assign({}, action), { key: actionKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
-        }) });
+        }) }), (outputSchema ? { outputSchema: convertOutputSchema(outputSchema) } : {}));
 };
 const convertTrigger = (triggerKey, 
 // `any` is load-bearing: the user-facing TriggerDefinition / PollingTriggerDefinition

package/dist/serverTypes/index.d.ts

@@ -40,7 +40,25 @@ export interface Action {
     dynamicBranchInput?: string;
     perform: ActionPerformFunction;
     examplePayload?: unknown;
+    /**
+     * The on-the-wire form of an action's `outputSchema`, as accepted by the
+     * `PublishComponent` mutation. JSON Schemas are serialized to strings and the
+     * branching variant's per-branch map is flattened to a `{ name, schema }`
+     * list (GraphQL input has no map type). Produced by `convertOutputSchema`
+     * from the author-facing `OutputSchema`.
+     */
+    outputSchema?: ServerOutputSchema;
 }
+export type ServerOutputSchema = {
+    type: "actionOutput";
+    schema: string;
+} | {
+    type: "branchingOutput";
+    branchSchemas: Array<{
+        name: string;
+        schema: string;
+    }>;
+};
 export type ActionLoggerFunction = (...args: unknown[]) => void;
 export interface ActionLogger {
     metric: ActionLoggerFunction;

package/dist/types/ActionDefinition.d.ts

@@ -3,6 +3,7 @@ import type { ActionPerformReturn } from "./ActionPerformReturn";
 import type { ComponentManifestAction } from "./ComponentManifest";
 import type { ActionDisplayDefinition } from "./DisplayDefinition";
 import type { ConfigVarResultCollection, Inputs } from "./Inputs";
+import type { OutputSchema } from "./OutputSchema";
 /**
  * ActionDefinition is the type of the object that is passed in to `action` function to
  * define a component action. See
@@ -37,4 +38,18 @@ export interface ActionDefinition<TInputs extends Inputs = Inputs, TConfigVars e
     dynamicBranchInput?: string;
     /** An example of the payload output by this action. */
     examplePayload?: Awaited<ReturnType<this["perform"]>>;
+    /**
+     * Declares the shape of this action's output `data` as a JSON Schema, used by
+     * the Prismatic UI to let integration authors reference this step's output
+     * before a real execution has produced data. A discriminated union:
+     * `{ type: "actionOutput", schema }` for a single payload shape, or
+     * `{ type: "branchingOutput", branchSchemas }` for a per-branch map of shapes.
+     * Descriptive only — it is not enforced at runtime.
+     *
+     * @remarks
+     * Describes the `data` payload only, not the full return envelope
+     * (`statusCode`, `contentType`, state fields). `branchingOutput` requires
+     * `staticBranchNames`; it is not supported with `dynamicBranchInput`.
+     */
+    outputSchema?: OutputSchema;
 }

package/dist/types/ComponentManifest.d.ts

@@ -1,6 +1,7 @@
 import type { CollectionType } from "./ConfigVars";
 import type { DataSourceType } from "./DataSourceResult";
 import type { InputFieldType } from "./Inputs";
+import type { OutputSchema } from "./OutputSchema";
 export interface ComponentManifest {
     key: string;
     public: boolean;
@@ -21,6 +22,8 @@ export interface ComponentManifestAction {
     perform: (values: any) => Promise<unknown>;
     inputs: Record<string, BaseInput>;
     examplePayload?: unknown;
+    /** Declares the shape of this action's output `data` as a JSON Schema (discriminated union: actionOutput | branchingOutput). */
+    outputSchema?: OutputSchema;
 }
 export interface ComponentManifestTrigger {
     key?: string;

package/dist/types/OutputSchema.d.ts

@@ -0,0 +1,35 @@
+import type { JsonSchema } from "./jsonforms/JsonSchema";
+/**
+ * Describes the shape of a non-branching action's output `data` payload as a
+ * JSON Schema. Used by the Prismatic UI to let integration authors reference a
+ * step's output before a real execution has produced data. Descriptive only —
+ * it is not enforced at runtime.
+ */
+export interface ActionOutputSchema {
+    type: "actionOutput";
+    schema: JsonSchema;
+}
+/**
+ * Describes the output `data` payload of a branching action, one JSON Schema
+ * per branch keyed by branch name. A branching action returns `{ branch, data }`,
+ * and the `data` shape may differ per branch, so each branch carries its own
+ * schema. Descriptive only — not enforced at runtime.
+ *
+ * @remarks
+ * Valid only for actions with `staticBranchNames` — a closed, build-time list.
+ * NOT supported with `dynamicBranchInput`, where branch names are computed at
+ * runtime and cannot be enumerated; publishing such a component is rejected
+ * server-side. (Unrelated to `dynamicObject` *inputs*, whose `configurations`
+ * are fully declared at build time — that's an input feature and does not
+ * affect `outputSchema`.)
+ */
+export interface BranchingOutputSchema {
+    type: "branchingOutput";
+    branchSchemas: Record<string, JsonSchema>;
+}
+/**
+ * The output-schema contract declared on an action via `outputSchema`. A
+ * discriminated union on `type`: `actionOutput` for a single payload shape,
+ * `branchingOutput` for a per-branch map of payload shapes.
+ */
+export type OutputSchema = ActionOutputSchema | BranchingOutputSchema;

package/dist/types/OutputSchema.js

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

package/dist/types/index.d.ts

@@ -27,9 +27,9 @@ export * from "./Inputs";
 export * from "./InstanceAttributes";
 export * from "./IntegrationAttributes";
 export * from "./IntegrationDefinition";
+export * from "./OutputSchema";
 export * from "./PollingTriggerDefinition";
 export * from "./ScopedConfigVars";
-export * from "./ScopedConfigVars";
 export * from "./TriggerDefinition";
 export * from "./TriggerEventFunction";
 export * from "./TriggerPayload";

package/dist/types/index.js

@@ -43,9 +43,9 @@ __exportStar(require("./Inputs"), exports);
 __exportStar(require("./InstanceAttributes"), exports);
 __exportStar(require("./IntegrationAttributes"), exports);
 __exportStar(require("./IntegrationDefinition"), exports);
+__exportStar(require("./OutputSchema"), exports);
 __exportStar(require("./PollingTriggerDefinition"), exports);
 __exportStar(require("./ScopedConfigVars"), exports);
-__exportStar(require("./ScopedConfigVars"), exports);
 __exportStar(require("./TriggerDefinition"), exports);
 __exportStar(require("./TriggerEventFunction"), exports);
 __exportStar(require("./TriggerPayload"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.19.1-preview.0",
+  "version": "10.21.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": [
     "prismatic"