@silkline/paramify 0.0.2

package/src/resources/validators.ts

@@ -0,0 +1,691 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Validators extends APIResource {
+  /**
+   * Creates a new validator in the workspace. The validator name must be unique
+   * within the workspace. Provide `type: "AUTOMATED"` with a `regex` and
+   * `validationRules`, or `type: "ATTESTATION"` with `attestationRules`. The created
+   * validator is returned in the same format as the GET endpoints.
+   *
+   * @example
+   * ```ts
+   * const validator = await client.validators.create({
+   *   name: 'name',
+   *   regex: '(\\d+) errors? found',
+   *   statement: 'statement',
+   *   type: 'AUTOMATED',
+   *   validationRules: [
+   *     {
+   *       criteria: 'EQUALS',
+   *       regexOperation: { type: 'MATCH_COUNT' },
+   *       value: { type: 'MATCH_COUNT' },
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  create(body: ValidatorCreateParams, options?: RequestOptions): APIPromise<Validator> {
+    return this._client.post('/validators', { body, ...options });
+  }
+
+  /**
+   * Retrieves a specific validator by its internal ID (UUID). The response shape
+   * depends on the validator type: AUTOMATED validators include a `regex` and
+   * `validationRules`; ATTESTATION validators include `attestationRules` with up to
+   * three layers of nesting.
+   *
+   * @example
+   * ```ts
+   * const validator = await client.validators.retrieve(
+   *   'a033d3c7-4b0a-4404-9131-99745694c1da',
+   * );
+   * ```
+   */
+  retrieve(validatorID: string, options?: RequestOptions): APIPromise<Validator> {
+    return this._client.get(path`/validators/${validatorID}`, options);
+  }
+
+  /**
+   * Returns all validators in the workspace. Each validator is either an AUTOMATED
+   * validator (applies a regex to artifact content and evaluates the result with
+   * validation rules) or an ATTESTATION validator (presents yes/no questions to a
+   * reviewer, optionally with nested follow-up rules).
+   *
+   * @example
+   * ```ts
+   * const validators = await client.validators.list();
+   * ```
+   */
+  list(
+    query: ValidatorListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ValidatorListResponse> {
+    return this._client.get('/validators', { query, ...options });
+  }
+}
+
+export type PostValidator = PostValidator.AutomatedPostValidator | PostValidator.AttestationPostValidator;
+
+export namespace PostValidator {
+  export interface AutomatedPostValidator {
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * The regular expression applied to each incoming artifact.
+     */
+    regex: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * AUTOMATED validators apply a regex to artifact content and evaluate the result
+     * using one or more validation rules.
+     */
+    type: 'AUTOMATED';
+
+    /**
+     * Ordered list of rules that evaluate the regex result. Rules are evaluated in
+     * index order.
+     */
+    validationRules: Array<AutomatedPostValidator.ValidationRule>;
+  }
+
+  export namespace AutomatedPostValidator {
+    export interface ValidationRule {
+      /**
+       * The comparison operator applied between the extracted regex value and the target
+       * value. One of: CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS,
+       * NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN,
+       * LESS_THAN_OR_EQUAL_TO, STARTS_WITH, DOES_NOT_START_WITH.
+       */
+      criteria:
+        | 'CONTAINS'
+        | 'DOES_NOT_CONTAIN'
+        | 'ENDS_WITH'
+        | 'DOES_NOT_END_WITH'
+        | 'EQUALS'
+        | 'NOT_EQUALS'
+        | 'GREATER_THAN'
+        | 'GREATER_THAN_OR_EQUAL_TO'
+        | 'LESS_THAN'
+        | 'LESS_THAN_OR_EQUAL_TO'
+        | 'STARTS_WITH'
+        | 'DOES_NOT_START_WITH'
+        | null;
+
+      /**
+       * Describes how the regex match result is extracted before being compared.
+       * MATCH_COUNT counts the total number of matches; MATCH_GROUP extracts the content
+       * of a specific capture group.
+       */
+      regexOperation: ValidationRule.PostRegexMatchCountOp | ValidationRule.PostRegexMatchGroupOp | null;
+
+      /**
+       * The right-hand side of the criteria comparison. MATCH_COUNT uses the match
+       * count, MATCH_GROUP uses a specific capture group, CUSTOM_TEXT uses a literal
+       * string.
+       */
+      value:
+        | ValidationRule.PostValidationMatchCountValue
+        | ValidationRule.PostValidationMatchGroupValue
+        | ValidationRule.PostValidationCustomTextValue
+        | null;
+    }
+
+    export namespace ValidationRule {
+      export interface PostRegexMatchCountOp {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface PostRegexMatchGroupOp {
+        groupNumber: number;
+
+        type: 'MATCH_GROUP';
+      }
+
+      export interface PostValidationMatchCountValue {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface PostValidationMatchGroupValue {
+        type: 'MATCH_GROUP';
+
+        groupNumber?: number;
+      }
+
+      export interface PostValidationCustomTextValue {
+        type: 'CUSTOM_TEXT';
+
+        customText?: string;
+      }
+    }
+  }
+
+  export interface AttestationPostValidator {
+    /**
+     * Ordered list of yes/no questions for this attestation validator. Rules are
+     * evaluated in index order. Up to three layers of nesting are supported.
+     */
+    attestationRules: Array<AttestationPostValidator.AttestationRule>;
+
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * ATTESTATION validators present a series of yes/no questions to a reviewer. Each
+     * question has a disposition for each answer (PASS, FAIL, or BASED_ON_NESTED).
+     */
+    type: 'ATTESTATION';
+  }
+
+  export namespace AttestationPostValidator {
+    export interface AttestationRule {
+      /**
+       * Nested rules for this attestation rule (up to two more layers deep).
+       */
+      nestedRules: Array<AttestationRule.NestedRule>;
+
+      /**
+       * The outcome when the user answers No.
+       */
+      noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+      /**
+       * The yes/no question presented to the user.
+       */
+      question: string;
+
+      /**
+       * The outcome when the user answers Yes.
+       */
+      yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+    }
+
+    export namespace AttestationRule {
+      export interface NestedRule {
+        /**
+         * Nested rules for this attestation rule (leaf level, no further nesting).
+         */
+        nestedRules: Array<NestedRule.NestedRule>;
+
+        /**
+         * The outcome when the user answers No.
+         */
+        noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+        /**
+         * The yes/no question presented to the user.
+         */
+        question: string;
+
+        /**
+         * The outcome when the user answers Yes.
+         */
+        yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+      }
+
+      export namespace NestedRule {
+        export interface NestedRule {
+          /**
+           * The outcome when the user answers No.
+           */
+          noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+          /**
+           * The yes/no question presented to the user.
+           */
+          question: string;
+
+          /**
+           * The outcome when the user answers Yes.
+           */
+          yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+        }
+      }
+    }
+  }
+}
+
+export type Validator = Validator.AutomatedValidator | Validator.AttestationValidator;
+
+export namespace Validator {
+  export interface AutomatedValidator {
+    /**
+     * A UUID that uniquely identifies this validator within Paramify.
+     */
+    id: string;
+
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * The regular expression applied to each incoming artifact.
+     */
+    regex: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * AUTOMATED validators apply a regex to artifact content and evaluate the result
+     * using one or more validation rules.
+     */
+    type: 'AUTOMATED';
+
+    /**
+     * Ordered list of rules that evaluate the regex result. Rules are evaluated in
+     * index order.
+     */
+    validationRules: Array<AutomatedValidator.ValidationRule>;
+  }
+
+  export namespace AutomatedValidator {
+    export interface ValidationRule {
+      /**
+       * The comparison operator applied between the extracted regex value and the target
+       * value. One of: CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS,
+       * NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN,
+       * LESS_THAN_OR_EQUAL_TO, STARTS_WITH, DOES_NOT_START_WITH.
+       */
+      criteria:
+        | 'CONTAINS'
+        | 'DOES_NOT_CONTAIN'
+        | 'ENDS_WITH'
+        | 'DOES_NOT_END_WITH'
+        | 'EQUALS'
+        | 'NOT_EQUALS'
+        | 'GREATER_THAN'
+        | 'GREATER_THAN_OR_EQUAL_TO'
+        | 'LESS_THAN'
+        | 'LESS_THAN_OR_EQUAL_TO'
+        | 'STARTS_WITH'
+        | 'DOES_NOT_START_WITH'
+        | null;
+
+      /**
+       * Describes how the regex match result is extracted before being compared.
+       * MATCH_COUNT counts the total number of matches; MATCH_GROUP extracts the content
+       * of a specific capture group.
+       */
+      regexOperation: ValidationRule.RegexMatchCountOp | ValidationRule.RegexMatchGroupOp | null;
+
+      /**
+       * The right-hand side of the criteria comparison. MATCH_COUNT uses the match
+       * count, MATCH_GROUP uses a specific capture group, CUSTOM_TEXT uses a literal
+       * string.
+       */
+      value:
+        | ValidationRule.ValidationMatchCountValue
+        | ValidationRule.ValidationMatchGroupValue
+        | ValidationRule.ValidationCustomTextValue
+        | null;
+    }
+
+    export namespace ValidationRule {
+      export interface RegexMatchCountOp {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface RegexMatchGroupOp {
+        groupNumber: number;
+
+        type: 'MATCH_GROUP';
+      }
+
+      export interface ValidationMatchCountValue {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface ValidationMatchGroupValue {
+        type: 'MATCH_GROUP';
+
+        groupNumber?: number;
+      }
+
+      export interface ValidationCustomTextValue {
+        type: 'CUSTOM_TEXT';
+
+        customText?: string;
+      }
+    }
+  }
+
+  export interface AttestationValidator {
+    /**
+     * A UUID that uniquely identifies this validator within Paramify.
+     */
+    id: string;
+
+    /**
+     * Ordered list of yes/no questions for this attestation validator. Rules are
+     * evaluated in index order. Up to three layers of nesting are supported.
+     */
+    attestationRules: Array<AttestationValidator.AttestationRule>;
+
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * ATTESTATION validators present a series of yes/no questions to a reviewer. Each
+     * question has a disposition for each answer (PASS, FAIL, or BASED_ON_NESTED).
+     */
+    type: 'ATTESTATION';
+  }
+
+  export namespace AttestationValidator {
+    export interface AttestationRule {
+      /**
+       * Nested rules for this attestation rule (up to two more layers deep).
+       */
+      nestedRules: Array<AttestationRule.NestedRule>;
+
+      /**
+       * The outcome when the user answers No.
+       */
+      noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+      /**
+       * The yes/no question presented to the user.
+       */
+      question: string;
+
+      /**
+       * The outcome when the user answers Yes.
+       */
+      yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+    }
+
+    export namespace AttestationRule {
+      export interface NestedRule {
+        /**
+         * Nested rules for this attestation rule (leaf level, no further nesting).
+         */
+        nestedRules: Array<NestedRule.NestedRule>;
+
+        /**
+         * The outcome when the user answers No.
+         */
+        noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+        /**
+         * The yes/no question presented to the user.
+         */
+        question: string;
+
+        /**
+         * The outcome when the user answers Yes.
+         */
+        yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+      }
+
+      export namespace NestedRule {
+        export interface NestedRule {
+          /**
+           * The outcome when the user answers No.
+           */
+          noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+          /**
+           * The yes/no question presented to the user.
+           */
+          question: string;
+
+          /**
+           * The outcome when the user answers Yes.
+           */
+          yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+        }
+      }
+    }
+  }
+}
+
+export interface ValidatorListResponse {
+  validators: Array<Validator>;
+}
+
+export type ValidatorCreateParams = ValidatorCreateParams.Variant0 | ValidatorCreateParams.Variant1;
+
+export declare namespace ValidatorCreateParams {
+  export interface Variant0 {
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * The regular expression applied to each incoming artifact.
+     */
+    regex: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * AUTOMATED validators apply a regex to artifact content and evaluate the result
+     * using one or more validation rules.
+     */
+    type: 'AUTOMATED';
+
+    /**
+     * Ordered list of rules that evaluate the regex result. Rules are evaluated in
+     * index order.
+     */
+    validationRules: Array<Variant0.ValidationRule>;
+  }
+
+  export namespace Variant0 {
+    export interface ValidationRule {
+      /**
+       * The comparison operator applied between the extracted regex value and the target
+       * value. One of: CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS,
+       * NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN,
+       * LESS_THAN_OR_EQUAL_TO, STARTS_WITH, DOES_NOT_START_WITH.
+       */
+      criteria:
+        | 'CONTAINS'
+        | 'DOES_NOT_CONTAIN'
+        | 'ENDS_WITH'
+        | 'DOES_NOT_END_WITH'
+        | 'EQUALS'
+        | 'NOT_EQUALS'
+        | 'GREATER_THAN'
+        | 'GREATER_THAN_OR_EQUAL_TO'
+        | 'LESS_THAN'
+        | 'LESS_THAN_OR_EQUAL_TO'
+        | 'STARTS_WITH'
+        | 'DOES_NOT_START_WITH'
+        | null;
+
+      /**
+       * Describes how the regex match result is extracted before being compared.
+       * MATCH_COUNT counts the total number of matches; MATCH_GROUP extracts the content
+       * of a specific capture group.
+       */
+      regexOperation: ValidationRule.PostRegexMatchCountOp | ValidationRule.PostRegexMatchGroupOp | null;
+
+      /**
+       * The right-hand side of the criteria comparison. MATCH_COUNT uses the match
+       * count, MATCH_GROUP uses a specific capture group, CUSTOM_TEXT uses a literal
+       * string.
+       */
+      value:
+        | ValidationRule.PostValidationMatchCountValue
+        | ValidationRule.PostValidationMatchGroupValue
+        | ValidationRule.PostValidationCustomTextValue
+        | null;
+    }
+
+    export namespace ValidationRule {
+      export interface PostRegexMatchCountOp {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface PostRegexMatchGroupOp {
+        groupNumber: number;
+
+        type: 'MATCH_GROUP';
+      }
+
+      export interface PostValidationMatchCountValue {
+        type: 'MATCH_COUNT';
+      }
+
+      export interface PostValidationMatchGroupValue {
+        type: 'MATCH_GROUP';
+
+        groupNumber?: number;
+      }
+
+      export interface PostValidationCustomTextValue {
+        type: 'CUSTOM_TEXT';
+
+        customText?: string;
+      }
+    }
+  }
+
+  export interface Variant1 {
+    /**
+     * Ordered list of yes/no questions for this attestation validator. Rules are
+     * evaluated in index order. Up to three layers of nesting are supported.
+     */
+    attestationRules: Array<Variant1.AttestationRule>;
+
+    /**
+     * The display name of the validator.
+     */
+    name: string;
+
+    /**
+     * A human-readable description of what this validator checks.
+     */
+    statement: string;
+
+    /**
+     * ATTESTATION validators present a series of yes/no questions to a reviewer. Each
+     * question has a disposition for each answer (PASS, FAIL, or BASED_ON_NESTED).
+     */
+    type: 'ATTESTATION';
+  }
+
+  export namespace Variant1 {
+    export interface AttestationRule {
+      /**
+       * Nested rules for this attestation rule (up to two more layers deep).
+       */
+      nestedRules: Array<AttestationRule.NestedRule>;
+
+      /**
+       * The outcome when the user answers No.
+       */
+      noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+      /**
+       * The yes/no question presented to the user.
+       */
+      question: string;
+
+      /**
+       * The outcome when the user answers Yes.
+       */
+      yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+    }
+
+    export namespace AttestationRule {
+      export interface NestedRule {
+        /**
+         * Nested rules for this attestation rule (leaf level, no further nesting).
+         */
+        nestedRules: Array<NestedRule.NestedRule>;
+
+        /**
+         * The outcome when the user answers No.
+         */
+        noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+        /**
+         * The yes/no question presented to the user.
+         */
+        question: string;
+
+        /**
+         * The outcome when the user answers Yes.
+         */
+        yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+      }
+
+      export namespace NestedRule {
+        export interface NestedRule {
+          /**
+           * The outcome when the user answers No.
+           */
+          noDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+
+          /**
+           * The yes/no question presented to the user.
+           */
+          question: string;
+
+          /**
+           * The outcome when the user answers Yes.
+           */
+          yesDisposition: 'PASS' | 'FAIL' | 'BASED_ON_NESTED';
+        }
+      }
+    }
+  }
+}
+
+export interface ValidatorListParams {
+  /**
+   * Filter by validator ID. Multiple IDs can be provided.
+   */
+  ids?: Array<string>;
+
+  /**
+   * Filter by validator type. AUTOMATED or ATTESTATION.
+   */
+  type?: 'AUTOMATED' | 'ATTESTATION';
+}
+
+export declare namespace Validators {
+  export {
+    type PostValidator as PostValidator,
+    type Validator as Validator,
+    type ValidatorListResponse as ValidatorListResponse,
+    type ValidatorCreateParams as ValidatorCreateParams,
+    type ValidatorListParams as ValidatorListParams,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.0.2'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map