@prismatic-io/spectral 10.5.0 → 10.5.1

package/dist/types/TriggerPayload.d.ts

@@ -1,23 +1,27 @@
 import { InstanceAttributes, CustomerAttributes, UserAttributes, IntegrationAttributes, FlowAttributes } from ".";
 /** Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution. */
 export interface TriggerPayload {
+    /** The headers sent in the webhook request. */
     headers: {
         [key: string]: string;
     };
+    /** The search parameters included in the URL of the webhook request. */
     queryParameters: {
         [key: string]: string;
     };
+    /** The unparsed body of the webhook request. */
     rawBody: {
         data: unknown;
         contentType?: string;
     };
+    /** The parsed body of the webhook request. */
     body: {
         data: unknown;
         contentType?: string;
     };
-    /** Extended path information from the webhook trigger */
+    /** Extended path information from the webhook trigger. */
     pathFragment: string;
-    /** The webhook URLs assigned to this integration's flows upon instance deploy */
+    /** The webhook URLs assigned to this integration's flows upon instance deploy. */
     webhookUrls: {
         [key: string]: string;
     };

package/dist/types/TriggerResult.d.ts

@@ -4,15 +4,15 @@ import { HttpResponse } from "./HttpResponse";
 export interface TriggerBaseResult<TPayload extends TriggerPayload> {
     /** The payload in the request that invoked the Integration, which is returned as a result for later use. */
     payload: TPayload;
-    /** Optional HTTP response to the request that invoked the integration. */
+    /** HTTP response to the request that invoked the integration. */
     response?: HttpResponse;
-    /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions. */
     instanceState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions. */
     crossFlowState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution. */
     executionState?: Record<string, unknown>;
-    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions. */
     integrationState?: Record<string, unknown>;
     /** A field populated by the Prismatic platform which indicates whether the trigger failed with an error during execution. */
     failed?: boolean;
@@ -26,5 +26,5 @@ export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends
     /** Name of the Branch to take. */
     branch: string;
 }
-/** Required return type of all trigger perform functions */
+/** Required return type of all trigger perform functions. */
 export type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;

package/dist/types/UserAttributes.d.ts

@@ -1,7 +1,17 @@
-/** Contains attributes of the User for whom a User Level Configuration is being used. */
+/**
+ * Contains attributes of the User whose user-level configuration is being used. See
+ * https://prismatic.io/docs/integrations/config-wizard/user-level-configuration/
+ */
 export interface UserAttributes {
+    /** Programmatic ID of the user whose user-level configuration is being used. */
     id: string;
+    /** The email address (or embedded ID) of the user whose user-level configuration is being used. */
     email: string;
+    /** The name of the user whose user-level configuration is being used. */
     name: string;
+    /**
+     * The external ID you assign to the user whose user-level configuration is being used. See
+     * https://prismatic.io/docs/embed/authenticate-users/#create-and-sign-a-jwt
+     */
     externalId: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.5.0",
+  "version": "10.5.1",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",