@takeshape/schema 11.40.0 → 11.41.0

package/dist/types/src/project-schema/v3.5.0.d.ts

@@ -0,0 +1,649 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export type ArgsV3_5_0 = string | ContentObjectSchemaV3_5_0;
+export type ContentObjectSchemaV3_5_0 = AllOfSchemaV3_5_0 | OneOfSchemaV3_5_0 | RefSchemaV3_5_0 | RefSchemaLegacyV3_5_0 | ObjectSchemaV3_5_0 | ArraySchemaV3_5_0;
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "ref".
+ */
+export type RefV3_5_0 = string;
+export type ObjectSchemaV3_5_0 = ContentSchemaV3_5_0 & {
+    type: 'object';
+    properties: {
+        [k: string]: ContentSchemaV3_5_0;
+    };
+};
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "fieldMapping".
+ */
+export type FieldMappingV3_5_0 = string | string[];
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "resolver".
+ */
+export type ResolverV3_5_0 = BasicResolverV3_5_0 | ComposeResolverV3_5_0;
+/**
+ * A tuple with a string directive name, and options to pass to the directive
+ *
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "directiveConfigItem".
+ */
+export type DirectiveConfigItemV3_5_0 = [DirectiveNameV3_5_0, DirectiveOptionsV3_5_0];
+export type DirectiveNameV3_5_0 = string;
+/**
+ * An array of individual directive config items to process in order
+ *
+ * This interface was referenced by `DirectiveMappingMapV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "directiveConfig".
+ */
+export type DirectiveConfigV3_5_0 = DirectiveConfigItemV3_5_0[];
+/**
+ * A tuple with a string key and a directive config to evaluate
+ *
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "directiveMappingArrayItem".
+ */
+export type DirectiveMappingArrayItemV3_5_0 = [string, DirectiveConfigV3_5_0];
+/**
+ * An array of key / value or directive config tuples
+ *
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "directiveMappingArray".
+ */
+export type DirectiveMappingArrayV3_5_0 = DirectiveMappingArrayItemV3_5_0[];
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "arraySchema".
+ */
+export type ArraySchemaV3_5_0 = ContentSchemaV3_5_0 & {
+    type: 'array';
+    items: ContentObjectSchemaV3_5_0;
+};
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "returnShape".
+ */
+export type ReturnShapeV3_5_0 = string | ArraySchemaV3_5_0;
+export type ModelTypeV3_5_0 = 'single' | 'multiple' | 'taxonomy';
+/**
+ * Human-readable id for use in the UI
+ */
+export type WorkflowNameV3_5_0 = string;
+/**
+ * machine-readable slug
+ */
+export type NameV3_5_0 = string;
+/**
+ * Human-readable id for use in the UI
+ */
+export type TitleV3_5_0 = string;
+export type DescriptionV3_5_0 = string;
+/**
+ * Hex color code
+ */
+export type ColorV3_5_0 = string;
+/**
+ * Value to indicate whether items in the state should be returned in list queries
+ */
+export type LiveV3_5_0 = boolean;
+/**
+ * machine-readable id
+ */
+export type KeyV3_5_0 = string;
+export type StepsV3_5_0 = WorkflowStepV3_5_0[];
+/**
+ * The general type of this service, specifying how and where it will be utilized.
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "serviceType".
+ */
+export type ServiceTypeV3_5_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'unknown';
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "shapeWithObjectSchema".
+ */
+export type ShapeWithObjectSchemaV3_5_0 = ShapeJSONV3_5_0 & {
+    schema: ObjectSchemaV3_5_0;
+};
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "searchParamsAuthentication".
+ */
+export type SearchParamsAuthenticationV3_5_0 = {
+    name: string;
+    value: string;
+}[];
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "serviceAuthentication".
+ */
+export type ServiceAuthenticationV3_5_0 = OAuth2AuthenticationV3_5_0 | OAuth2BearerAuthenticationV3_5_0 | BearerAuthenticationV3_5_0 | BasicAuthenticationV3_5_0 | SearchParamsAuthenticationV3_5_0 | CustomAuthenticationV3_5_0;
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "anyServiceConfig".
+ */
+export type AnyServiceConfigV3_5_0 = ServiceConfigJSONV3_5_0 | ServiceConfigV3_5_0;
+export interface ProjectSchemaJSONV3_5_0 {
+    $schema?: string;
+    /**
+     * This is the revision number of your schema. Every time your project schema is updated, this value should be incremented.
+     */
+    version: number;
+    /**
+     * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
+     */
+    apiVersion: string;
+    /**
+     * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
+     */
+    schemaVersion: '3.5.0';
+    /**
+     * The ID of the TakeShape project this schema belongs to.
+     */
+    projectId: string;
+    /**
+     * The ID of the TakeShape user who created the schema.
+     */
+    author?: string;
+    /**
+     * The date the schema was created
+     */
+    created: string;
+    /**
+     * The date the schema was last updated
+     */
+    updated: string;
+    deactivated?: number;
+    /**
+     * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
+     */
+    defaultLocale: string;
+    locales: string[];
+    queries: QueryMapV3_5_0;
+    mutations: QueryMapV3_5_0;
+    shapes: ShapeMapV3_5_0;
+    forms?: FormMapV3_5_0;
+    workflows: WorkflowMapV3_5_0;
+    dataKey: string;
+    services?: ServiceMapJSONV3_5_0;
+}
+export interface QueryMapV3_5_0 {
+    [k: string]: QueryJSONV3_5_0;
+}
+/**
+ * This interface was referenced by `QueryMapV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
+ */
+export interface QueryJSONV3_5_0 {
+    args?: ArgsV3_5_0;
+    resolver: ResolverV3_5_0;
+    shape: ReturnShapeV3_5_0;
+    /**
+     * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
+     */
+    description?: string;
+    [k: string]: any;
+}
+export interface AllOfSchemaV3_5_0 {
+    allOf: (RefSchemaV3_5_0 | RefSchemaLegacyV3_5_0 | ObjectSchemaV3_5_0)[];
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "refSchema".
+ */
+export interface RefSchemaV3_5_0 {
+    '@ref': RefV3_5_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "refSchemaLegacy".
+ */
+export interface RefSchemaLegacyV3_5_0 {
+    $ref: RefV3_5_0;
+    [k: string]: any;
+}
+export interface ContentSchemaV3_5_0 {
+    $id?: string;
+    $schema?: string;
+    $ref?: string;
+    $comment?: string;
+    title?: string;
+    description?: string;
+    default?: any;
+    readOnly?: boolean;
+    examples?: any[];
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number;
+    minimum?: number;
+    exclusiveMinimum?: number;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeInteger".
+     */
+    maxLength?: number;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeIntegerDefault0".
+     */
+    minLength?: number;
+    pattern?: string;
+    additionalItems?: ContentSchemaV3_5_0;
+    items?: ContentSchemaV3_5_0;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeInteger".
+     */
+    maxItems?: number;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeIntegerDefault0".
+     */
+    minItems?: number;
+    uniqueItems?: boolean;
+    contains?: ContentSchemaV3_5_0;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeInteger".
+     */
+    maxProperties?: number;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "nonNegativeIntegerDefault0".
+     */
+    minProperties?: number;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "stringArray".
+     */
+    required?: string[];
+    additionalProperties?: ContentSchemaV3_5_0;
+    definitions?: {
+        [k: string]: ContentSchemaV3_5_0;
+    };
+    properties?: {
+        [k: string]: ContentSchemaV3_5_0;
+    };
+    patternProperties?: {
+        [k: string]: ContentSchemaV3_5_0;
+    };
+    dependencies?: {
+        [k: string]: ContentSchemaV3_5_0 | string[];
+    };
+    propertyNames?: ContentSchemaV3_5_0;
+    const?: any;
+    enum?: any[];
+    type?: ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string') | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string')[];
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    if?: ContentSchemaV3_5_0;
+    then?: ContentSchemaV3_5_0;
+    else?: ContentSchemaV3_5_0;
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "schemaArray".
+     */
+    allOf?: ContentSchemaV3_5_0[];
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "schemaArray".
+     */
+    anyOf?: ContentSchemaV3_5_0[];
+    /**
+     * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+     * via the `definition` "schemaArray".
+     */
+    oneOf?: ContentSchemaV3_5_0[];
+    not?: ContentSchemaV3_5_0;
+    '@relationship'?: RelationshipV3_5_0;
+    '@syncLocaleStructure'?: boolean;
+    '@sensitive'?: boolean;
+    '@draftjs'?: boolean;
+    '@l10n'?: boolean;
+    '@key'?: string;
+    '@workflow'?: string;
+    '@mapping'?: FieldMappingV3_5_0;
+    '@tag'?: string;
+    '@tags'?: string[];
+    '@deprecationReason'?: string;
+    '@user'?: boolean;
+    '@args'?: ArgsV3_5_0;
+    '@resolver'?: ResolverV3_5_0;
+    '@ref'?: RefV3_5_0;
+    value?: string;
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "relationship".
+ */
+export interface RelationshipV3_5_0 {
+    shapeIds: string[];
+    type?: string;
+    relatedName?: string;
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "basicResolver".
+ */
+export interface BasicResolverV3_5_0 {
+    if?: string;
+    id?: string;
+    /**
+     * The name of the built-in resolver your query or mutation should use.
+     */
+    name: string;
+    /**
+     * Specifies the service configuration the resolver should use, identified by a connected service's slug. This configuration contains the endpoint and authentication necessary to make API calls.
+     */
+    service: string;
+    /**
+     * Maps a query's input args to the input expected by the service's endpoint.
+     */
+    argsMapping?: DirectiveMappingMapV3_5_0 | DirectiveConfigV3_5_0;
+    searchParamsMapping?: DirectiveMappingArrayV3_5_0;
+    /**
+     * Maps a service endpoint's response results to the expected shape of the query's response.
+     */
+    resultsMapping?: DirectiveMappingMapV3_5_0 | DirectiveConfigV3_5_0;
+    options?: {
+        model?: string;
+        [k: string]: any;
+    };
+}
+/**
+ * An map of object keys / key paths to directive configs
+ *
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "directiveMappingMap".
+ */
+export interface DirectiveMappingMapV3_5_0 {
+    [k: string]: DirectiveConfigV3_5_0;
+}
+export interface DirectiveOptionsV3_5_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "composeResolver".
+ */
+export interface ComposeResolverV3_5_0 {
+    compose: BasicResolverV3_5_0[];
+    resultsMapping?: DirectiveMappingMapV3_5_0 | DirectiveConfigV3_5_0;
+}
+/**
+ * This interface was referenced by `ContentSchemaV3_5_0`'s JSON-Schema
+ * via the `definition` "oneOfSchema".
+ */
+export interface OneOfSchemaV3_5_0 {
+    oneOf: (RefSchemaV3_5_0 | RefSchemaLegacyV3_5_0 | ObjectSchemaV3_5_0)[];
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "shapeMap".
+ */
+export interface ShapeMapV3_5_0 {
+    [k: string]: ShapeJSONV3_5_0;
+}
+/**
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
+ *
+ * This interface was referenced by `ShapeMapV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "shape".
+ */
+export interface ShapeJSONV3_5_0 {
+    /**
+     * The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations
+     */
+    name: string;
+    /**
+     * The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used  database as a stable "table name" and changing it will result in orphaning that data.
+     */
+    id: string;
+    /**
+     * The human-readable name for a Shape for use in a UI.
+     */
+    title: string;
+    description?: string;
+    /**
+     * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
+     */
+    model?: {
+        type: ModelTypeV3_5_0;
+    };
+    workflow?: string;
+    schema: ContentObjectSchemaV3_5_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formMap".
+ */
+export interface FormMapV3_5_0 {
+    [k: string]: FormsConfigV3_5_0;
+}
+/**
+ * This interface was referenced by `FormMapV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formsConfig".
+ */
+export interface FormsConfigV3_5_0 {
+    default: FormConfigV3_5_0;
+    [k: string]: FormConfigV3_5_0;
+}
+/**
+ * This interface was referenced by `FormsConfigV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formConfig".
+ */
+export interface FormConfigV3_5_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "workflowMap".
+ */
+export interface WorkflowMapV3_5_0 {
+    [k: string]: WorkflowV3_5_0;
+}
+/**
+ * This interface was referenced by `WorkflowMapV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "workflow".
+ */
+export interface WorkflowV3_5_0 {
+    /**
+     * machine-readable id
+     */
+    name: string;
+    title: WorkflowNameV3_5_0;
+    steps: StepsV3_5_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "workflowStep".
+ */
+export interface WorkflowStepV3_5_0 {
+    name: NameV3_5_0;
+    title: TitleV3_5_0;
+    description?: DescriptionV3_5_0;
+    color: ColorV3_5_0;
+    live: LiveV3_5_0;
+    key: KeyV3_5_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "storedServiceMap".
+ */
+export interface ServiceMapJSONV3_5_0 {
+    [k: string]: ServiceConfigJSONV3_5_0;
+}
+/**
+ * This interface was referenced by `ServiceMapJSONV3_5_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "storedServiceConfig".
+ */
+export interface ServiceConfigJSONV3_5_0 {
+    /**
+     * Machine-readable identifier, should typically be the same as the property name on the services object.
+     */
+    id: string;
+    /**
+     * Human-readable name for this service.
+     */
+    title: string;
+    /**
+     * The service provider id.
+     */
+    provider: string;
+    /**
+     * A namespace to use for the imported types tied to this service.
+     */
+    namespace?: string;
+    serviceType: ServiceTypeV3_5_0;
+    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'none' | 'unknown';
+    authentication?: string;
+    webhookId?: string;
+    /**
+     * Configuration options passed to and handled by the provider.
+     */
+    options?: {
+        [k: string]: any;
+    };
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formScalarConfig".
+ */
+export interface FormScalarConfigV3_5_0 {
+    widget: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formObjectConfig".
+ */
+export interface FormObjectConfigV3_5_0 {
+    widget?: string;
+    order?: string[];
+    properties?: {
+        [k: string]: FormConfigV3_5_0;
+    };
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "formArrayConfig".
+ */
+export interface FormArrayConfigV3_5_0 {
+    widget: string;
+    items: FormConfigV3_5_0;
+}
+/**
+ * For use with a custom auth handler on a service provider.
+ *
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "customAuthentication".
+ */
+export interface CustomAuthenticationV3_5_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "bearerAuthentication".
+ */
+export interface BearerAuthenticationV3_5_0 {
+    token?: string;
+    prefix?: string;
+    header?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "oauth2BearerAuthentication".
+ */
+export interface OAuth2BearerAuthenticationV3_5_0 {
+    token?: string;
+    prefix?: string;
+    header?: string;
+    scope?: string;
+    expiresAt?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "basicAuthentication".
+ */
+export interface BasicAuthenticationV3_5_0 {
+    username?: string;
+    password?: string;
+    useIso8859?: boolean;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "oauth2Authentication".
+ */
+export interface OAuth2AuthenticationV3_5_0 {
+    grantType?: 'authorizationCode' | 'clientCredentials';
+    authorizationUrl?: string;
+    accessTokenUrl?: string;
+    clientId?: string;
+    clientSecret?: string;
+    scope?: string;
+    usePkce?: boolean;
+    redirectUrl?: string;
+    headerPrefix?: string;
+    audience?: string;
+    resource?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaJSONV3_5_0`'s JSON-Schema
+ * via the `definition` "serviceConfig".
+ */
+export interface ServiceConfigV3_5_0 {
+    /**
+     * Machine-readable identifier, should typically be the same as the property name on the services object.
+     */
+    id: string;
+    /**
+     * Human-readable name for this service.
+     */
+    title: string;
+    /**
+     * The service provider id.
+     */
+    provider: string;
+    /**
+     * A namespace to use for the imported types tied to this service.
+     */
+    namespace?: string;
+    serviceType: ServiceTypeV3_5_0;
+    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'none' | 'unknown';
+    authentication?: ServiceAuthenticationV3_5_0;
+    webhookId?: string;
+    /**
+     * Configuration options passed to and handled by the provider.
+     */
+    options?: {
+        [k: string]: any;
+    };
+}