@takeshape/schema 11.144.1 → 11.154.2

package/dist/project-schema/v3.1.0.d.ts

@@ -1,621 +0,0 @@
-/**
- * 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_1_0 = string | ContentObjectSchemaV3_1_0;
-export type ContentObjectSchemaV3_1_0 = AllOfSchemaV3_1_0 | OneOfSchemaV3_1_0 | RefSchemaV3_1_0 | RefSchemaLegacyV3_1_0 | ObjectSchemaV3_1_0 | ArraySchemaV3_1_0;
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "ref".
- */
-export type RefV3_1_0 = string;
-export type ObjectSchemaV3_1_0 = ContentSchemaV3_1_0 & {
-    type: 'object';
-    properties: {
-        [k: string]: ContentSchemaV3_1_0;
-    };
-};
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "fieldMapping".
- */
-export type FieldMappingV3_1_0 = string | string[];
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "resolver".
- */
-export type ResolverV3_1_0 = BasicResolverV3_1_0 | ComposeResolverV3_1_0;
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "directiveConfig".
- */
-export type DirectiveConfigV3_1_0 = [DirectiveNameV3_1_0, DirectiveOptionsV3_1_0];
-export type DirectiveNameV3_1_0 = string;
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "arraySchema".
- */
-export type ArraySchemaV3_1_0 = ContentSchemaV3_1_0 & {
-    type: 'array';
-    items: ContentObjectSchemaV3_1_0;
-};
-export type ModelTypeV3_1_0 = 'single' | 'multiple' | 'taxonomy';
-/**
- * Human-readable id for use in the UI
- */
-export type WorkflowNameV3_1_0 = string;
-/**
- * machine-readable slug
- */
-export type NameV3_1_0 = string;
-/**
- * Human-readable id for use in the UI
- */
-export type TitleV3_1_0 = string;
-export type DescriptionV3_1_0 = string;
-/**
- * Hex color code
- */
-export type ColorV3_1_0 = string;
-/**
- * Value to indicate whether items in the state should be returned in list queries
- */
-export type LiveV3_1_0 = boolean;
-/**
- * machine-readable id
- */
-export type KeyV3_1_0 = string;
-export type StepsV3_1_0 = WorkflowStepV3_1_0[];
-/**
- * The general type of this service, specifying how and where it will be utilized.
- *
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "serviceType".
- */
-export type ServiceTypeV3_1_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'unknown';
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "shapeWithObjectSchema".
- */
-export type ShapeWithObjectSchemaV3_1_0 = ShapeJSONV3_1_0 & {
-    schema: ObjectSchemaV3_1_0;
-};
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "searchParamsAuthentication".
- */
-export type SearchParamsAuthenticationV3_1_0 = {
-    name: string;
-    value: string;
-}[];
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "serviceAuthentication".
- */
-export type ServiceAuthenticationV3_1_0 = OAuth2AuthenticationV3_1_0 | OAuth2BearerAuthenticationV3_1_0 | BearerAuthenticationV3_1_0 | BasicAuthenticationV3_1_0 | SearchParamsAuthenticationV3_1_0;
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "anyServiceConfig".
- */
-export type AnyServiceConfigV3_1_0 = ServiceConfigJSONV3_1_0 | ServiceConfigV3_1_0;
-export interface ProjectSchemaJSONV3_1_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.1.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_1_0;
-    mutations: QueryMapV3_1_0;
-    shapes: ShapeMapV3_1_0;
-    forms?: FormMapV3_1_0;
-    workflows: WorkflowMapV3_1_0;
-    dataKey?: string;
-    services?: ServiceMapJSONV3_1_0;
-}
-export interface QueryMapV3_1_0 {
-    [k: string]: QueryJSONV3_1_0;
-}
-/**
- * This interface was referenced by `QueryMapV3_1_0`'s JSON-Schema definition
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
- */
-export interface QueryJSONV3_1_0 {
-    args?: ArgsV3_1_0;
-    resolver: ResolverV3_1_0;
-    /**
-     * Specifies which shape is returned by the query or mutation. The shape can refer to a shape in the schema's "shapes" object or a shape that's available on a service schema.
-     */
-    shape: string;
-    /**
-     * 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_1_0 {
-    allOf: (RefSchemaV3_1_0 | RefSchemaLegacyV3_1_0 | ObjectSchemaV3_1_0)[];
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "refSchema".
- */
-export interface RefSchemaV3_1_0 {
-    '@ref': RefV3_1_0;
-    [k: string]: any;
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "refSchemaLegacy".
- */
-export interface RefSchemaLegacyV3_1_0 {
-    $ref: RefV3_1_0;
-    [k: string]: any;
-}
-export interface ContentSchemaV3_1_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_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeInteger".
-     */
-    maxLength?: number;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeIntegerDefault0".
-     */
-    minLength?: number;
-    pattern?: string;
-    additionalItems?: ContentSchemaV3_1_0;
-    items?: ContentSchemaV3_1_0;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeInteger".
-     */
-    maxItems?: number;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeIntegerDefault0".
-     */
-    minItems?: number;
-    uniqueItems?: boolean;
-    contains?: ContentSchemaV3_1_0;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeInteger".
-     */
-    maxProperties?: number;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "nonNegativeIntegerDefault0".
-     */
-    minProperties?: number;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "stringArray".
-     */
-    required?: string[];
-    additionalProperties?: ContentSchemaV3_1_0;
-    definitions?: {
-        [k: string]: ContentSchemaV3_1_0;
-    };
-    properties?: {
-        [k: string]: ContentSchemaV3_1_0;
-    };
-    patternProperties?: {
-        [k: string]: ContentSchemaV3_1_0;
-    };
-    dependencies?: {
-        [k: string]: ContentSchemaV3_1_0 | string[];
-    };
-    propertyNames?: ContentSchemaV3_1_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_1_0;
-    then?: ContentSchemaV3_1_0;
-    else?: ContentSchemaV3_1_0;
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "schemaArray".
-     */
-    allOf?: ContentSchemaV3_1_0[];
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "schemaArray".
-     */
-    anyOf?: ContentSchemaV3_1_0[];
-    /**
-     * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
-     * via the `definition` "schemaArray".
-     */
-    oneOf?: ContentSchemaV3_1_0[];
-    not?: ContentSchemaV3_1_0;
-    '@relationship'?: RelationshipV3_1_0;
-    '@syncLocaleStructure'?: boolean;
-    '@sensitive'?: boolean;
-    '@draftjs'?: boolean;
-    '@l10n'?: boolean;
-    '@key'?: string;
-    '@workflow'?: string;
-    '@mapping'?: FieldMappingV3_1_0;
-    '@tag'?: string;
-    '@tags'?: string[];
-    '@deprecationReason'?: string;
-    '@user'?: boolean;
-    '@args'?: ArgsV3_1_0;
-    '@resolver'?: ResolverV3_1_0;
-    '@ref'?: RefV3_1_0;
-    value?: string;
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "relationship".
- */
-export interface RelationshipV3_1_0 {
-    shapeIds: string[];
-    type?: string;
-    relatedName?: string;
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "basicResolver".
- */
-export interface BasicResolverV3_1_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?: DirectiveMapV3_1_0 | DirectiveConfigV3_1_0[];
-    /**
-     * Maps a service endpoint's response results to the expected shape of the query's response.
-     */
-    resultsMapping?: DirectiveMapV3_1_0 | DirectiveConfigV3_1_0[];
-    options?: {
-        model?: string;
-        [k: string]: any;
-    };
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "directiveMap".
- */
-export interface DirectiveMapV3_1_0 {
-    /**
-     * This interface was referenced by `DirectiveMapV3_1_0`'s JSON-Schema definition
-     * via the `patternProperty` "[0-9A-Za-z_-]+".
-     */
-    [k: string]: DirectiveConfigV3_1_0[];
-}
-export interface DirectiveOptionsV3_1_0 {
-    [k: string]: any;
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "composeResolver".
- */
-export interface ComposeResolverV3_1_0 {
-    compose: BasicResolverV3_1_0[];
-    resultsMapping?: DirectiveMapV3_1_0 | DirectiveConfigV3_1_0[];
-}
-/**
- * This interface was referenced by `ContentSchemaV3_1_0`'s JSON-Schema
- * via the `definition` "oneOfSchema".
- */
-export interface OneOfSchemaV3_1_0 {
-    oneOf: (RefSchemaV3_1_0 | RefSchemaLegacyV3_1_0 | ObjectSchemaV3_1_0)[];
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "shapeMap".
- */
-export interface ShapeMapV3_1_0 {
-    [k: string]: ShapeJSONV3_1_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_1_0`'s JSON-Schema definition
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
- *
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "shape".
- */
-export interface ShapeJSONV3_1_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_1_0;
-    };
-    workflow?: string;
-    schema: ContentObjectSchemaV3_1_0;
-    [k: string]: any;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "formMap".
- */
-export interface FormMapV3_1_0 {
-    [k: string]: FormsConfigV3_1_0;
-}
-/**
- * This interface was referenced by `FormMapV3_1_0`'s JSON-Schema definition
- * via the `patternProperty` "[0-9A-Za-z_-]+".
- *
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "formsConfig".
- */
-export interface FormsConfigV3_1_0 {
-    default: FormConfigV3_1_0;
-    [k: string]: FormConfigV3_1_0;
-}
-/**
- * This interface was referenced by `FormsConfigV3_1_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_1_0`'s JSON-Schema
- * via the `definition` "formConfig".
- */
-export interface FormConfigV3_1_0 {
-    [k: string]: any;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "workflowMap".
- */
-export interface WorkflowMapV3_1_0 {
-    [k: string]: WorkflowV3_1_0;
-}
-/**
- * This interface was referenced by `WorkflowMapV3_1_0`'s JSON-Schema definition
- * via the `patternProperty` "[0-9A-Za-z_-]+".
- *
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "workflow".
- */
-export interface WorkflowV3_1_0 {
-    /**
-     * machine-readable id
-     */
-    name: string;
-    title: WorkflowNameV3_1_0;
-    steps: StepsV3_1_0;
-    [k: string]: any;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "workflowStep".
- */
-export interface WorkflowStepV3_1_0 {
-    name: NameV3_1_0;
-    title: TitleV3_1_0;
-    description?: DescriptionV3_1_0;
-    color: ColorV3_1_0;
-    live: LiveV3_1_0;
-    key: KeyV3_1_0;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "storedServiceMap".
- */
-export interface ServiceMapJSONV3_1_0 {
-    [k: string]: ServiceConfigJSONV3_1_0;
-}
-/**
- * This interface was referenced by `ServiceMapJSONV3_1_0`'s JSON-Schema definition
- * via the `patternProperty` "[0-9A-Za-z_-]+".
- *
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "storedServiceConfig".
- */
-export interface ServiceConfigJSONV3_1_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_1_0;
-    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'none' | 'unknown';
-    authentication?: string;
-    webhookId?: string;
-    /**
-     * Configuration options passed to and handled by the provider.
-     */
-    options?: {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "[a-zA-Z][a-zA-Z0-9]*".
-         */
-        [k: string]: string;
-    };
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "formScalarConfig".
- */
-export interface FormScalarConfigV3_1_0 {
-    widget: string;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "formObjectConfig".
- */
-export interface FormObjectConfigV3_1_0 {
-    widget?: string;
-    order?: string[];
-    properties?: {
-        [k: string]: FormConfigV3_1_0;
-    };
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "formArrayConfig".
- */
-export interface FormArrayConfigV3_1_0 {
-    widget: string;
-    items: FormConfigV3_1_0;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "bearerAuthentication".
- */
-export interface BearerAuthenticationV3_1_0 {
-    token?: string;
-    prefix?: string;
-    header?: string;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "oauth2BearerAuthentication".
- */
-export interface OAuth2BearerAuthenticationV3_1_0 {
-    token?: string;
-    prefix?: string;
-    header?: string;
-    scope?: string;
-    expiresAt?: string;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "basicAuthentication".
- */
-export interface BasicAuthenticationV3_1_0 {
-    username?: string;
-    password?: string;
-    useIso8859?: boolean;
-}
-/**
- * This interface was referenced by `ProjectSchemaJSONV3_1_0`'s JSON-Schema
- * via the `definition` "oauth2Authentication".
- */
-export interface OAuth2AuthenticationV3_1_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_1_0`'s JSON-Schema
- * via the `definition` "serviceConfig".
- */
-export interface ServiceConfigV3_1_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_1_0;
-    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'none' | 'unknown';
-    authentication?: ServiceAuthenticationV3_1_0;
-    webhookId?: string;
-    /**
-     * Configuration options passed to and handled by the provider.
-     */
-    options?: {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "[a-zA-Z][a-zA-Z0-9]*".
-         */
-        [k: string]: string;
-    };
-}

package/dist/project-schema/v3.1.0.js

@@ -1,7 +0,0 @@
-/* tslint:disable */
-/**
- * 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 {};