feat(schema): PDE-5719 split FieldSchema into InputFieldSchema, OutputFieldSchema, and AuthFieldSchema

packages/core/types/zapier.generated.d.ts

@@ -135,6 +135,68 @@ export interface App {
   firehoseWebhooks?: { [k: string]: unknown };
 }
 
+/**
+ * A path to a file that might have content like `module.exports =
+ * (z, bundle) => [{id: 123}];`.
+ *
+ * [Docs: FunctionRequireSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionRequireSchema)
+ */
+export interface FunctionRequire {
+  require: string;
+}
+
+/**
+ * Source code like `{source: "return 1 + 2"}` which the system will
+ * wrap in a function for you.
+ *
+ * [Docs: FunctionSourceSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionSourceSchema)
+ */
+export interface FunctionSource {
+  /**
+   * JavaScript code for the function body. This must end with a
+   * `return` statement.
+   */
+  source: string;
+
+  /**
+   * Function signature. Defaults to `['z', 'bundle']` if not
+   * specified.
+   */
+  args?: string[];
+}
+
+/**
+ * An object whose values can only be primitives
+ *
+ * [Docs: FlatObjectSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FlatObjectSchema)
+ */
+export interface FlatObject {
+  /**
+   * Any key may exist in this flat object as long as its values are
+   * simple.
+   *
+   * This interface was referenced by `FlatObjectSchema`'s JSON-Schema
+   * definition
+   * via the `patternProperty` "[^\s]+".
+   */
+  [k: string]: null | string | number | boolean;
+}
+
+/**
+ * Internal pointer to a function from the original source or the
+ * source code itself. Encodes arity and if `arguments` is used in
+ * the body. Note - just write normal functions and the system will
+ * encode the pointers for you. Or, provide {source: "return 1 + 2"}
+ * and the system will wrap in a function for you.
+ *
+ * [Docs: FunctionSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionSchema)
+ */
+export type Function =
+  | PerformFunction
+  | string
+  | FunctionRequire
+  | FunctionSource;
+
 /**
  * An object describing a labeled choice in a static dropdown.
  * Useful if the value a user picks isn't exactly what the zap uses.
@@ -347,68 +409,6 @@ export interface Field {
   meta?: FieldMeta;
 }
 
-/**
- * A path to a file that might have content like `module.exports =
- * (z, bundle) => [{id: 123}];`.
- *
- * [Docs: FunctionRequireSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionRequireSchema)
- */
-export interface FunctionRequire {
-  require: string;
-}
-
-/**
- * Source code like `{source: "return 1 + 2"}` which the system will
- * wrap in a function for you.
- *
- * [Docs: FunctionSourceSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionSourceSchema)
- */
-export interface FunctionSource {
-  /**
-   * JavaScript code for the function body. This must end with a
-   * `return` statement.
-   */
-  source: string;
-
-  /**
-   * Function signature. Defaults to `['z', 'bundle']` if not
-   * specified.
-   */
-  args?: string[];
-}
-
-/**
- * An object whose values can only be primitives
- *
- * [Docs: FlatObjectSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FlatObjectSchema)
- */
-export interface FlatObject {
-  /**
-   * Any key may exist in this flat object as long as its values are
-   * simple.
-   *
-   * This interface was referenced by `FlatObjectSchema`'s JSON-Schema
-   * definition
-   * via the `patternProperty` "[^\s]+".
-   */
-  [k: string]: null | string | number | boolean;
-}
-
-/**
- * Internal pointer to a function from the original source or the
- * source code itself. Encodes arity and if `arguments` is used in
- * the body. Note - just write normal functions and the system will
- * encode the pointers for you. Or, provide {source: "return 1 + 2"}
- * and the system will wrap in a function for you.
- *
- * [Docs: FunctionSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#FunctionSchema)
- */
-export type Function =
-  | PerformFunction
-  | string
-  | FunctionRequire
-  | FunctionSource;
-
 /**
  * A representation of a HTTP request - you can use the `{{syntax}}`
  * to inject authentication, field or global variables.
@@ -1087,6 +1087,138 @@ export interface BasicActionOperation {
   throttle?: ThrottleObject;
 }
 
+/**
+ * Field schema specialized for output fields.
+ *
+ * [Docs: OutputFieldSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#OutputFieldSchema)
+ */
+export interface OutputField {
+  /** A unique machine readable key for this value (IE: "fname"). */
+  key: string;
+
+  /** A human readable label for this value (IE: "First Name"). */
+  label?: string;
+
+  /**
+   * A human readable description of this value (IE: "The first part
+   * of a full name."). You can use Markdown.
+   */
+  helpText?: string;
+
+  /**
+   * The type of this value. Use `string` for basic text input, `text`
+   * for a large, `<textarea>` style box, and `code` for a
+   * `<textarea>` with a fixed-width font. Field type of `file` will
+   * accept either a file object or a string. If a URL is provided in
+   * the string, Zapier will automatically make a GET for that file.
+   * Otherwise, a .txt file will be generated.
+   */
+  type?:
+    | 'string'
+    | 'text'
+    | 'integer'
+    | 'number'
+    | 'boolean'
+    | 'datetime'
+    | 'file'
+    | 'password'
+    | 'copy'
+    | 'code';
+
+  /** If this value is required or not. */
+  required?: boolean;
+
+  /** An example value that is not saved. */
+  placeholder?: string;
+
+  /**
+   * A default value that is saved the first time a Zap is created.
+   */
+  default?: string;
+
+  /**
+   * Use this field as part of the primary key for deduplication. You
+   * can set multiple fields as "primary", provided they are unique
+   * together. If no fields are set, Zapier will default to using the
+   * `id` field. `primary` only makes sense for `outputFields`; it
+   * will be ignored if set in `inputFields`. It only works in static
+   * `outputFields`; will not work in custom/dynamic `outputFields`.
+   * For more information, see [How deduplication works in
+   * Zapier](https://platform.zapier.com/build/deduplication).
+   */
+  primary?: boolean;
+
+  /**
+   * A reference to a trigger that will power a dynamic dropdown.
+   */
+  dynamic?: RefResource;
+
+  /**
+   * A reference to a search that will guide the user to add a search
+   * step to populate this field when creating a Zap.
+   */
+  search?: RefResource;
+
+  /**
+   * An object of machine keys and human values to populate a static
+   * dropdown.
+   */
+  choices?: FieldChoices;
+
+  /**
+   * Acts differently when used in inputFields vs. when used in
+   * outputFields. In inputFields: Can a user provide multiples of
+   * this field? In outputFields: Does this field return an array of
+   * items of type `type`?
+   */
+  list?: boolean;
+
+  /**
+   * An array of child fields that define the structure of a
+   * sub-object for this field. Usually used for line items.
+   *
+   * @minItems 1
+   */
+  children?: Field[];
+
+  /** Is this field a key/value input? */
+  dict?: boolean;
+
+  /**
+   * Is this field automatically populated (and hidden from the user)?
+   * Note: Only OAuth and Session Auth support fields with this key.
+   */
+  computed?: boolean;
+
+  /**
+   * Does the value of this field affect the definitions of other
+   * fields in the set?
+   */
+  altersDynamicFields?: boolean;
+
+  /**
+   * Prevents triggering on new output until all values for fields
+   * with this property remain unchanged for 2 polls. It can be used
+   * to, e.g., not trigger on a new contact until the contact has
+   * completed typing their name. NOTE that this only applies to the
+   * `outputFields` of polling triggers.
+   */
+  steadyState?: boolean;
+
+  /**
+   * Useful when you expect the input to be part of a longer string.
+   * Put "{{input}}" in place of the user's input (IE:
+   * "https://{{input}}.yourdomain.com").
+   */
+  inputFormat?: string;
+
+  /**
+   * Allows for additional metadata to be stored on the field.
+   * Supports simple key-values only (no sub-objects or arrays).
+   */
+  meta?: FieldMeta;
+}
+
 /**
  * How will we get a single object given a unique identifier/id?
  *
@@ -1160,6 +1292,13 @@ export interface ResourceMethodCreate {
   operation: BasicActionOperation;
 }
 
+/**
+ * An array or collection of output fields.
+ *
+ * [Docs: DynamicOutputFieldsSchema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#DynamicOutputFieldsSchema)
+ */
+export type DynamicOutputFields = (OutputField | Function)[];
+
 /**
  * Represents a resource, which will in turn power triggers,
  * searches, or creates.
@@ -1206,7 +1345,7 @@ export interface Resource {
   create?: ResourceMethodCreate;
 
   /** What fields of data will this return? */
-  outputFields?: DynamicFields;
+  outputFields?: DynamicOutputFields;
 
   /** What does a sample of data look like? */
   sample?: { [k: string]: unknown };