@takeshape/schema 11.52.0 → 11.55.0

package/dist/types/src/schema-util.d.ts

@@ -1,210 +0,0 @@
-import { type Maybe } from '@takeshape/util';
-import type { FieldMapping, ProjectSchemaJSON, PropertySchema, QueryJSON, ServiceConfig, ShapeJSON, ShapeMap, ShapeSchema } from './project-schema';
-import { type RefItem, type RefItemWithPath, type ServicesContext, type ServicesShapesContext } from './refs';
-import { type LatestProjectSchemaWithServices, type LayerSchema, type SchemaPath, type SchemaPropertyName, type SchemaPropertyNode, type SchemaWithArgs, type SchemaWithRef, type ServiceMap } from './types';
-export declare function isBuiltinShape(shapeName: string): boolean;
-export declare function isBuiltinQuery(name: string): boolean;
-export declare function isBuiltinMutation(name: string): boolean;
-export declare function isBuiltinType(projectSchema: ProjectSchemaJSON, refSchema: SchemaWithRef): boolean;
-export declare const schemaMetadataKeys: readonly ["$comment", "title", "description", "@l10n", "@deprecationReason", "@tag", "@tags", "@syncLocaleStructure", "@sensitive"];
-export declare const commonSchemaKeys: readonly ["type", "default", "readOnly", "$comment", "title", "description", "@l10n", "@deprecationReason", "@tag", "@tags", "@syncLocaleStructure", "@sensitive"];
-export declare const scalarSchemaKeys: readonly ["type", "default", "readOnly", "$comment", "title", "description", "@l10n", "@deprecationReason", "@tag", "@tags", "@syncLocaleStructure", "@sensitive", "format", "oneOf", "multipleOf", "maximum", "exclusiveMaximum", "minimum", "exclusiveMinimum", "maxLength", "minLength", "pattern"];
-export declare const objectSchemaKeys: readonly ["type", "default", "readOnly", "$comment", "title", "description", "@l10n", "@deprecationReason", "@tag", "@tags", "@syncLocaleStructure", "@sensitive", "properties", "required"];
-export declare const arraySchemaKeys: readonly ["type", "default", "readOnly", "$comment", "title", "description", "@l10n", "@deprecationReason", "@tag", "@tags", "@syncLocaleStructure", "@sensitive", "items", "additionalItems", "maxItems", "minItems", "uniqueItems"];
-export declare const multipleRelationshipSchemaKeys: string[];
-export declare const nonStructuralSchemaKeys: string[];
-export declare function getServiceIdFieldName(serviceFieldName: string): string;
-export declare function getGeneratorVersion(generator: string): string;
-export declare function pathBetween(fromShape: ShapeJSON, toShape: ShapeJSON, projectSchema: ProjectSchemaJSON, depthLimit?: number): string[];
-type ShapeModelInfo = Pick<ShapeJSON, 'name' | 'model'>;
-export declare function getShapeQueriesAndMutations(shapes: ShapeModelInfo | ShapeModelInfo[]): Pick<ProjectSchemaJSON, 'queries' | 'mutations'>;
-export declare function getCommonBuiltInProperties(shape: Pick<ShapeJSON, 'id'>): Record<string, PropertySchema>;
-export declare const DEFAULT_ID_FIELD = "id";
-export declare function getIdField(obj?: {
-    idField?: string;
-}): string;
-export declare function getModelBuiltInProperties(projectSchema: Partial<Pick<ProjectSchemaJSON, 'apiVersion' | 'workflows'>>, shape: Pick<ShapeJSON, 'id' | 'workflow'>): Record<string, PropertySchema>;
-/**
- * Return all the built in property names,
- */
-export declare function getBuiltInPropertyNames(profile?: BuiltInPropertiesProfile): Set<string>;
-export declare enum BuiltInPropertiesProfile {
-    Model = 0,
-    Cached = 1,
-    None = 2
-}
-export declare const isBuiltInPropertyName: (name: string, profile?: BuiltInPropertiesProfile) => boolean;
-export declare function applyBuiltinPropertiesToShape(projectSchema: ProjectSchemaJSON, shape: ShapeJSON): ShapeJSON;
-/**
- * Get all built-in shapes that are depended on by the given project schema.
- * Required built-in shapes are always included.
- */
-export declare function getBuiltinsUsed(projectSchema: ProjectSchemaJSON): ShapeMap;
-export declare function applyDefaultsToSchema<T extends ProjectSchemaJSON>(projectSchema: T): T;
-export declare function getShapeByRef(projectSchema: ServicesShapesContext, shapeRef: string): ShapeJSON | undefined;
-export declare function getArgsReference(projectSchema: ServicesContext, argsSchema: SchemaWithArgs): Maybe<RefItem>;
-export declare function getArgsReferenceWithPath(context: ServicesContext, argsSchema: SchemaWithArgs, schemaPath?: SchemaPath): Maybe<RefItemWithPath>;
-export declare function getArgsShapeSchema(context: ServicesShapesContext, argsSchema: SchemaWithArgs): Maybe<ShapeSchema>;
-export declare function shapeToPropertySchema(projectSchema: ProjectSchemaJSON, shape: ShapeJSON): PropertySchema;
-export declare function projectSchemaToJSONSchema(projectSchema: ProjectSchemaJSON): {
-    definitions: Record<string, PropertySchema>;
-};
-export declare function getShapeDependencies(projectSchema: ProjectSchemaJSON, shape: ShapeJSON, predicate?: (propSchema: PropertySchema) => boolean): string[];
-type GetRelevantShapesParams = {
-    shapeNames?: string[];
-    shapeIds?: string[];
-    byId?: boolean;
-    includeDependencies?: boolean;
-};
-export declare function getRelevantShapes(projectSchema: ProjectSchemaJSON, params: GetRelevantShapesParams): ShapeMap;
-/**
- * Visitor callback return false to stop iterating
- */
-export type PropertyVisitorCallback = ((schema: PropertySchema, path: SchemaPath) => boolean) | ((schema: PropertySchema, path: SchemaPath) => void);
-export declare function visitSchemaProperties(root: PropertySchema, path: SchemaPath, callback: PropertyVisitorCallback): void;
-export declare function visitShapeProperties(shapes: ShapeMap, callback: PropertyVisitorCallback): void;
-export type RefPredicate = (ref: RefItemWithPath) => boolean;
-/**
- * Walk through a `ProjectSchemaJSON` and collect all the `ref`s.
- */
-export declare function getAllRefsInShapes(projectSchema: ServicesShapesContext, predicate?: RefPredicate): RefItemWithPath[];
-/**
- * Get all refs
- */
-export declare function getAllRefsInQuery(projectSchema: ServicesShapesContext, queryPath: string[], query: QueryJSON, predicate?: (ref: RefItemWithPath) => boolean): RefItemWithPath[];
-/**
- * Collect refs from `queries` or `mutations`.
- */
-export declare function getAllRefsInQueries(projectSchema: Pick<ProjectSchemaJSON, 'queries' | 'mutations' | 'shapes' | 'services'>, rootPropertyName: 'queries' | 'mutations', predicate?: RefPredicate): RefItemWithPath[];
-/**
- * Get all refs in a ProjectSchemaJSON
- * @param predicate return true to include the ref in
- */
-export declare function getAllRefs(projectSchema: Pick<ProjectSchemaJSON, 'queries' | 'mutations' | 'shapes' | 'services'>, predicate?: RefPredicate): RefItemWithPath[];
-export declare function isValidRefItem(refItem: RefItem): boolean;
-/**
- * Get all valid refs in a ProjectSchemaJSON
- * @param predicate return true to include the ref in
- */
-export declare function getAllValidRefs(projectSchema: Pick<ProjectSchemaJSON, 'queries' | 'mutations' | 'shapes' | 'services'>, predicate?: RefPredicate): RefItemWithPath[];
-export type Mapping = {
-    providerId: string;
-    serviceId: string;
-    shapeName: string;
-    key: string;
-};
-export declare function parseMapping(mapping: string): Mapping;
-export declare function splitMapping(mapping: string): string[];
-export declare function findMapping(schema: PropertySchema, predicate: (mappingStr: string) => boolean): string | undefined;
-export declare function getFirstMapping(schema: PropertySchema): string | undefined;
-export declare function getFullyQualifiedShapeName(schema: PropertySchema): string | undefined;
-/**
- * Find key for use storing data in ShapeDB or API Indexing this allows renaming of properties without db migration
- * Mapping must be using the shapedb service id
- * @param schema
- */
-export declare function getStorageKey(schema: PropertySchema): string | undefined;
-export declare function getPropertyService(schema: PropertySchema): string | undefined;
-export declare function emptySchema(projectId: string): ProjectSchemaJSON;
-export declare function createLayerSchema(partialSchema?: Partial<LayerSchema>): LayerSchema;
-export declare function getShapesById(projectSchema: ProjectSchemaJSON): ShapeMap;
-/**
- * Walk through the project schema and return an array of all
- * referenced shape names that are in a service namespace.
- *
- * @param projectSchema A V3 project schema.
- *
- * @returns A `string` array with all the shapes that are in namespaces.
- */
-export declare function getAllNamespaceShapes(projectSchema: ProjectSchemaJSON): string[];
-/**
- * Returns a list of all shape names in a service namespace, excluding any
- * that have been set directly in the project schema
- *
- * @todo It's unsound to discard dependencies in this way, should avoid
- *       collisions with aliases or similar any remote shape that collides,
- *       e.g., Shopify_Product -> Shopify_Product_2
- *
- * @param projectSchema A V3 project schema with remote service configs.
- *
- * @returns A `Set` of shape names.
- */
-export declare function getNamespacedShapeNameList(projectSchema: LatestProjectSchemaWithServices): Set<string>;
-/**
- * Filter the service map to return only services passing the GraphQL Service
- * typeguard.
- *
- * @param serviceMap A service map.
- *
- * @returns A new map with the filtered list of services
- */
-export declare function filterGraphQLServiceMap(serviceMap: ServiceMap): Map<string, ServiceConfig>;
-/**
- * Creates a schema property list chainable fn, allowing you to manipulate and
- * iterate the properties in a schema.
- */
-export declare const createSchemaPropertyList: import("lodash").CurriedFunction2<ServicesShapesContext, PropertySchema | ShapeJSON, {
-    _propertyIterator: Map<string, PropertySchema>;
-    orderBy: (iteratees?: ((n: SchemaPropertyNode) => string)[], orders?: ("asc" | "desc")[]) => /*elided*/ any;
-    sortWith: (comparator?: (a: SchemaPropertyNode, b: SchemaPropertyNode) => number) => /*elided*/ any;
-    sortByNamesWithList: (comparatorArray?: string[]) => /*elided*/ any;
-    filterBy: (predicate: (n: SchemaPropertyNode) => boolean) => /*elided*/ any;
-    forEach: (iteratee: (n: SchemaPropertyNode) => void) => /*elided*/ any;
-    getNodes: () => SchemaPropertyNode[];
-    getObject: () => Record<string, PropertySchema>;
-    getNames: () => SchemaPropertyName[];
-    getValues: () => PropertySchema[];
-}>;
-declare class SchemaPropertyAccessor {
-    private readonly schema;
-    private readonly properties;
-    private readonly entries;
-    constructor(context: ServicesShapesContext, shapeOrSchema: PropertySchema | ShapeJSON);
-    getValue(propertyName: SchemaPropertyName): Maybe<PropertySchema>;
-    findValue(predicate: (n: SchemaPropertyNode) => boolean): Maybe<PropertySchema>;
-    findName(predicate: (n: SchemaPropertyNode) => boolean): Maybe<SchemaPropertyName>;
-    getKey(propertyName: SchemaPropertyName): Maybe<string>;
-}
-export type { SchemaPropertyAccessor };
-/**
- * Creates a schema property accessor, allowing you to safely access schema
- * properties.
- */
-export declare const createSchemaPropertyAccessor: import("lodash").CurriedFunction2<ServicesShapesContext, PropertySchema | ShapeJSON, SchemaPropertyAccessor>;
-export type QueryMutationSlice = Pick<ProjectSchemaJSON, 'queries' | 'mutations'>;
-/**
- * Find the query in the schema that corresponds to the given shape and resolver.
- */
-export declare const findQueryByShape: (projectSchema: QueryMutationSlice, shapeName: string, resolver: string) => string | undefined;
-/**
- * Find the query in the schema that corresponds to the given shape and resolver.
- */
-export declare const findMutationByShape: (projectSchema: QueryMutationSlice, shapeName: string, resolver: string) => string | undefined;
-/**
- * Find the query in the schema that corresponds to the given shape and resolver.
- * Throw an error if that query does not exist
- */
-export declare const ensureQueryByShape: (projectSchema: QueryMutationSlice, shapeName: string, resolver: string) => string;
-/**
- * Find the mutation in the schema that corresponds to the given shape and resolver.
- * Throw an error if that mutation does not exist
- */
-export declare const ensureMutationByShape: (projectSchema: QueryMutationSlice, shapeName: string, resolver: string) => string;
-export type ResolverWithDefaultMutation = 'shapedb:create' | 'shapedb:update' | 'shapedb:delete' | 'shapedb:duplicate';
-/**
- * Find the query in the schema that corresponds to the given shape and resolver.
- */
-export declare const getDefaultMutationName: (shapeName: string, resolver: ResolverWithDefaultMutation) => string;
-export declare function createShape(name: string, schema: ShapeSchema, rest?: Partial<ShapeJSON>): ShapeJSON;
-export declare function queryToPropertySchema(projectSchema: ProjectSchemaJSON, query: QueryJSON): PropertySchema;
-export declare function getQueriesShape(projectSchema: ProjectSchemaJSON, operation: 'query' | 'mutation'): ShapeJSON;
-export declare function fieldMappingContainsKey(fieldMapping: FieldMapping, key: string): boolean;
-/**
- * Return true if `schemaWithRef` is a ref to a shape named `shapeName`
- */
-export declare function schemaMatchesShapeName(workingCopy: ProjectSchemaJSON, propertySchema: PropertySchema, shapeName: string): boolean;
-/**
- * Return true if `shape` has a property that is an array of refs to `shapeName`
- */
-export declare const shapeHasArrayPropOfShape: (projectSchema: ProjectSchemaJSON, shape: ShapeJSON, shapeName: string) => boolean;
-export declare const getQueryMapName: (type: "query" | "mutation") => "queries" | "mutations";

package/dist/types/src/service-dependencies.d.ts

@@ -1,13 +0,0 @@
-import type { ProjectSchemaJSON, PropertySchema } from './project-schema';
-import { type ServicesContext } from './refs';
-import { type ServiceLayers } from './types';
-/**
- * Add all referenced shape names to the refSet meant to be used as a callback to visitSchemaProperties
- */
-export declare function collectReferencedShapeNames(context: ServicesContext, shapeNames: Set<string>): (schema: PropertySchema) => void;
-/**
- * Returns a schema with all of its dependencies resolved.
- * SHOULD only return the minimum set of remote dependencies required to enable
- * the local shape definitions.
- */
-export declare function resolveSchemaShapeDependencies(projectSchema: ProjectSchemaJSON, serviceLayers: ServiceLayers): ProjectSchemaJSON;

package/dist/types/src/services/services.d.ts

@@ -1,31 +0,0 @@
-import type { Overwrite } from '@takeshape/util';
-import { SERVICE_OBJECT_PATTERN_NAME } from '../constants';
-import type { ProjectSchemaJSON, ServiceConfig, ServiceConfigJSON, ServiceMapJSON, ShapeJSON } from '../project-schema';
-import type { PatternGenerator, ServiceConfigUpdate, ServiceInfo, ServiceMap } from '../types/types';
-import type { DecryptFn, EncryptFn } from './types';
-/**
- * Given a `StoredServiceConfig` returns a usable `ServiceConfig` with the
- * authentication object decrypted.
- */
-export declare function decryptServiceConfig(decryptFn: DecryptFn, storedServiceConfig: ServiceConfigJSON): ServiceConfig;
-/**
- * Given a `ServiceMapJSON` returns a usable `ServiceMap` with all the
- * authentication objects decrypted.
- */
-export declare function decryptServiceMap(decryptFn: DecryptFn, ServiceMapJSON: ServiceMapJSON): Promise<ServiceMap>;
-/**
- * Validates a `ServiceConfig` validator based on the JSON-schema.
- */
-export declare function validateServiceConfig(maybeServiceConfig: unknown): ServiceConfigJSON;
-/**
- * Prepare a `ServiceConfig` object update, validating the overall structure
- * and encrypting the `ServiceAuthentication` object.
- */
-export declare function prepareServiceUpdate(encryptFn: EncryptFn, decryptFn: DecryptFn, projectSchema: ProjectSchemaJSON, serviceConfigUpdate: ServiceConfigUpdate, serviceKey: string): ServiceConfigJSON;
-export type ServiceInfoWithServiceObject = Overwrite<ServiceInfo, {
-    generators: {
-        [SERVICE_OBJECT_PATTERN_NAME]: PatternGenerator;
-    };
-}>;
-export declare function getServiceObjectFields(projectSchema: ProjectSchemaJSON, shape: ShapeJSON, provider: string): ServiceInfoWithServiceObject[];
-export declare function getServiceInfo(projectSchema: ProjectSchemaJSON, shape: ShapeJSON): Record<string, ServiceInfo[]>;

package/dist/types/src/services/util.d.ts

@@ -1,16 +0,0 @@
-import type { ProjectSchemaJSON, Resolver, ServiceConfig, ServiceConfigJSON } from '../project-schema';
-import type { ServiceKey } from '../types';
-/**
- * Get a service config from a project schema.
- */
-export declare function getStoredServiceConfig(projectSchema: ProjectSchemaJSON, serviceKey: ServiceKey): ServiceConfigJSON | undefined;
-/**
- * Get a `Map` keyed with all the service namespaces.
- *
- * @param context A partial project schema
- *
- * @returns A `Map` with namespaces as keys, and service keys as values.
- */
-export declare function getServiceNamespaces(context: Pick<ProjectSchemaJSON, 'services'>): Map<string, string>;
-export declare function isMissingAuth(service: Pick<ServiceConfig | ServiceConfigJSON, 'authenticationType' | 'authentication'>): boolean;
-export declare function getResolverServices(resolver: Resolver): string[];

package/dist/types/src/taxonomies.d.ts

@@ -1,15 +0,0 @@
-import type { ProjectSchemaJSON, ShapeJSON } from './project-schema';
-export type TaxonomyField = {
-    name: string;
-    key?: string;
-};
-export type Taxonomy = {
-    shapeId: string;
-    field: TaxonomyField;
-};
-export declare function getFirstStringFieldV3(shape: ShapeJSON, projectSchema: ProjectSchemaJSON): {
-    name: string;
-    key?: string;
-} | null;
-export declare const getTaxonomyField: (shape: ShapeJSON, projectSchema: ProjectSchemaJSON) => TaxonomyField | null;
-export declare const getTaxonomies: (projectSchema: ProjectSchemaJSON) => Taxonomy[];

package/dist/types/src/template-shapes/index.d.ts

@@ -1,7 +0,0 @@
-import type { ProjectSchemaJSON } from '../project-schema';
-import type { ResolvedTemplate } from './types';
-export declare function resolveTemplate(projectSchema: ProjectSchemaJSON, templateName: string, shapeName: string): ResolvedTemplate;
-/**
- * Check if a string is a known template such as `PaginatedList`
- */
-export declare function isValidTemplate(template: string): boolean;

package/dist/types/src/template-shapes/names.d.ts

@@ -1,10 +0,0 @@
-import type { TemplateVerbs } from './types';
-/**
- * Construct a shape name used for a mutation input shape.
- */
-export declare function getMutationInputShapeName(verb: TemplateVerbs): (shapeName: string) => string;
-/**
- * Create a shape name variant for an input.
- */
-export declare function getInputShapeName(shapeName: string): string;
-export declare function getOutputShapeName(name: string): string;

package/dist/types/src/template-shapes/templates.d.ts

@@ -1,32 +0,0 @@
-import type { ObjectSchema, PropertySchema, ShapeJSON } from '../project-schema';
-import { TemplateVerbs } from './types';
-import type { ResolvedTemplate, TemplateContext } from './types';
-export declare const TSGetArgs: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const TSGetSingletonArgs: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const TSListArgs: (context: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const TSSearchArgs: (context: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const CreateArgs: ({ projectSchema }: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const UpdateArgs: ({ projectSchema }: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const DuplicateArgs: ({ projectSchema }: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const DeleteArgs: ({ projectSchema }: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare const PaginatedList: typeof getPaginatedListShape;
-export declare const SearchResults: typeof getSearchResultsShape;
-export declare const CreateResult: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const UpdateResult: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const DuplicateResult: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const DeleteResult: (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const TSSearchSortInput: ShapeJSON;
-export declare const commonSearchProps: Record<string, PropertySchema>;
-export declare const localeProps: ObjectSchema;
-export declare const termsProps: ObjectSchema;
-export declare const TSContentStructureInput: ShapeJSON;
-export declare function getPaginatedListShape(context: unknown, shape: ShapeJSON): ResolvedTemplate;
-export declare function getSearchResultsShape(context: unknown, shape: ShapeJSON): ResolvedTemplate;
-export declare function getIDQueryArgs(templateName: string): (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-/**
- * Construct shapes for a mutation inputs, given source shape info.
- */
-export declare function getMutationArgs(templateName: string, verb: TemplateVerbs): ({ projectSchema }: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare function getMutationResultType(verb: TemplateVerbs): (context: unknown, shape: ShapeJSON) => ResolvedTemplate;
-export declare const commonSearchArgs: ObjectSchema;
-export declare function getShapeListQueryArgs(templateName: string, legacyArgs: boolean): (context: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;

package/dist/types/src/template-shapes/types.d.ts

@@ -1,15 +0,0 @@
-import type { ProjectSchemaJSON, ShapeJSON, ShapeMap } from '../project-schema';
-export type ResolvedTemplate = {
-    shapeName: string;
-    dependencies: ShapeMap;
-};
-export type TemplateContext = {
-    projectSchema: ProjectSchemaJSON;
-};
-export type TemplateShapeFactory = (context: TemplateContext, shape: ShapeJSON) => ResolvedTemplate;
-export declare enum TemplateVerbs {
-    Create = "create",
-    Update = "update",
-    Duplicate = "duplicate",
-    Delete = "delete"
-}

package/dist/types/src/template-shapes/where.d.ts

@@ -1,37 +0,0 @@
-import type { Maybe } from '@takeshape/util';
-import type { ObjectSchema, ProjectSchemaJSON, PropertySchema, ShapeJSON, ShapeMap } from '../project-schema';
-import type { ResolvedTemplate } from './types';
-export declare const MAX_RELATIONSHIP_DEPTH = 1;
-export declare const exceededRelationshipDepth: (depth?: number) => boolean;
-type ComparisonOperatorKey = 'eq' | 'lt' | 'lte' | 'gt' | 'gte' | 'in' | 'match' | 'regexp';
-type ShapeThunk = ShapeJSON | (() => ShapeJSON);
-declare class ShapeCache {
-    thunks: Map<string, ShapeThunk>;
-    unresolved: Set<string>;
-    has(shapeName: string): boolean;
-    set(shapeName: string, thunk: ShapeThunk): void;
-    resolveAll(): ShapeMap;
-}
-export declare const fieldTypeComparison: Record<string, {
-    comparators: ComparisonOperatorKey[];
-    type: 'string' | 'number' | 'integer' | 'boolean';
-}>;
-export declare const comparatorDescriptions: Record<string, string>;
-export declare const booleanOperators: string[];
-export declare const boolOpDescriptionMap: Record<string, string>;
-export declare function getFieldTypeComparison(fieldType: string): Maybe<Record<string, PropertySchema>>;
-export type PropertyContext = {
-    shapeCache: ShapeCache;
-    conflictingProperties?: Set<string>;
-    projectSchema: ProjectSchemaJSON;
-    relationshipDepth: number;
-    booleanOperators?: boolean;
-};
-export declare function getFields(typeName: string, shapes: ShapeJSON[], context: PropertyContext): Record<string, PropertySchema>;
-export declare function getPropertyComparisonType(name: string, prop: PropertySchema, shapeName: string, context: PropertyContext): Maybe<Record<string, PropertySchema>>;
-export declare function getWhereShape(projectSchema: ProjectSchemaJSON, selectedShapes: ShapeJSON[]): ResolvedTemplate;
-export declare function getWhereSearchArg(projectSchema: ProjectSchemaJSON, selectedShapes: ShapeJSON[]): {
-    schema: ObjectSchema;
-    dependencies: ShapeMap;
-};
-export {};

package/dist/types/src/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './utils';
-export * from './transforms';

package/dist/types/src/types/transforms.d.ts

@@ -1,13 +0,0 @@
-import type { PropertySchema, ShapeJSON } from '../project-schema';
-export type ContentTransform = (schema: PropertySchema, obj: unknown, name?: string) => unknown;
-export type SourceKeyTransform = (name: string, schema: PropertySchema, parent: unknown) => string | string[];
-export type KeyTransform = (name: string, schema: PropertySchema, sourceKey?: string) => string;
-export type PropertyTransform = {
-    keyTransform?: KeyTransform;
-    filter(schema: PropertySchema, name: string, shape?: ShapeJSON): boolean;
-    process(value: unknown, schema: PropertySchema, name: string, shape: ShapeJSON | undefined, next: (value: unknown, schema: PropertySchema, name: string) => unknown): unknown;
-};
-export type SchemaType = '*' | 'object' | 'array' | 'string' | 'number' | 'integer' | 'boolean';
-export type PropertyTransformMap = {
-    [key in SchemaType]?: PropertyTransform[];
-};

package/dist/types/src/types/types.d.ts

@@ -1,211 +0,0 @@
-import type { Overwrite } from '@takeshape/util';
-import type { XMLParser } from 'fast-xml-parser';
-import type { Merge, PartialDeep, SetOptional, SetRequired } from 'type-fest';
-import type { SERVICE_OBJECT_PATTERN_NAME } from '../constants';
-import type { AnyProjectSchemaJSON, CachedFragmentConfig, CustomAuthentication, GetQueryLoaderConfig, ListQueryLoaderConfig, OAuth2Authentication, ProjectSchemaJSON, ProjectSchemaJSONV1_0_0, ProjectSchemaJSONV3_0_0, ProjectSchemaJSONV3_1_0, ProjectSchemaJSONV3_2_0, ProjectSchemaJSONV3_3_0, ProjectSchemaJSONV3_4_0, ProjectSchemaJSONV3_5_0, ProjectSchemaJSONV3_5_1, ProjectSchemaJSONV3_6_0, ProjectSchemaJSONV3_7_0, ProjectSchemaJSONV3_8_0, ProjectSchemaJSONV3_9_0, ProjectSchemaJSONV3_10_0, ProjectSchemaJSONV3_11_0, ProjectSchemaJSONV3_12_0, ProjectSchemaJSONV3_12_1, ProjectSchemaJSONV3_12_2, ProjectSchemaJSONV3_12_3, ProjectSchemaJSONV3_13_0, ProjectSchemaJSONV3_14_0, ProjectSchemaJSONV3_15_0, ProjectSchemaJSONV3_16_0, ProjectSchemaJSONV3_17_0, ProjectSchemaJSONV3_17_1, ProjectSchemaJSONV3_18_0, ProjectSchemaJSONV3_18_1, ProjectSchemaJSONV3_18_2, ProjectSchemaJSONV3_19_0, ProjectSchemaJSONV3_20_0, ProjectSchemaJSONV3_21_0, ProjectSchemaJSONV3_22_0, ProjectSchemaJSONV3_23_0, PropertySchema, QueryJSON, Ref, ServiceAuthentication, ServiceConfig, ServiceMapJSON, ShapeJSON } from '../project-schema';
-export type ProjectSchemaJSONWithVersion = ProjectSchemaJSONV3_23_0 | ProjectSchemaJSONV3_22_0 | ProjectSchemaJSONV3_21_0 | ProjectSchemaJSONV3_20_0 | ProjectSchemaJSONV3_19_0 | ProjectSchemaJSONV3_18_2 | ProjectSchemaJSONV3_18_1 | ProjectSchemaJSONV3_18_0 | ProjectSchemaJSONV3_17_1 | ProjectSchemaJSONV3_17_0 | ProjectSchemaJSONV3_16_0 | ProjectSchemaJSONV3_15_0 | ProjectSchemaJSONV3_14_0 | ProjectSchemaJSONV3_13_0 | ProjectSchemaJSONV3_12_3 | ProjectSchemaJSONV3_12_2 | ProjectSchemaJSONV3_12_1 | ProjectSchemaJSONV3_12_0 | ProjectSchemaJSONV3_11_0 | ProjectSchemaJSONV3_10_0 | ProjectSchemaJSONV3_9_0 | ProjectSchemaJSONV3_8_0 | ProjectSchemaJSONV3_7_0 | ProjectSchemaJSONV3_6_0 | ProjectSchemaJSONV3_5_1 | ProjectSchemaJSONV3_5_0 | ProjectSchemaJSONV3_4_0 | ProjectSchemaJSONV3_3_0 | ProjectSchemaJSONV3_2_0 | ProjectSchemaJSONV3_1_0 | ProjectSchemaJSONV3_0_0 | ProjectSchemaJSONV1_0_0;
-export declare const projectSchemaImportOptionalProps: readonly ["projectId", "locales", "defaultLocale", "author"];
-export declare const legacyProjectSchemaImportOptionalProps: readonly ["created", "updated", "version", "dataKey"];
-export type ProjectSchemaImport = SetOptional<AnyProjectSchemaJSON, (typeof projectSchemaImportOptionalProps)[number]>;
-export type Content = {
-    [name: string]: any;
-    _id: string;
-};
-export type ServiceInfo = {
-    service: string;
-    fieldName: string;
-    path: string[];
-    generators: Record<typeof SERVICE_OBJECT_PATTERN_NAME, PatternGenerator | undefined>;
-};
-/**
- * Remote service configuration types
- */
-/**
- * Old service authentication
- * @deprecated
- */
-export type ServiceConfigAccessToken = {
-    accessToken: string;
-    refreshToken?: string;
-    scope?: string;
-};
-export type ServiceKey = string;
-export type ServiceMap = Map<ServiceKey, ServiceConfig>;
-export type PatternGenerator = {
-    version: string;
-    currentVersion: string;
-    idFieldName: string;
-    serviceObjectType: string;
-};
-export type Headers = Record<string, string | string[]>;
-type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'HEAD' | 'DELETE' | 'OPTIONS' | 'TRACE' | 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'options' | 'trace';
-export type AllowedRetryOptions = number | Partial<{
-    limit: number;
-    methods: Method[];
-    statusCodes: number[];
-    errorCodes: string[];
-    maxRetryAfter: number;
-    backoffLimit: number;
-    noise: number;
-}>;
-export type RESTServiceConfig = Overwrite<ServiceConfig, {
-    serviceType: 'rest';
-    options: {
-        [name: string]: any;
-        endpoint: string;
-        headers?: Headers;
-        timeout?: number;
-        retry?: AllowedRetryOptions;
-        fastXmlParser?: ConstructorParameters<typeof XMLParser>[0];
-    };
-}>;
-export type GraphQLServiceConfig = Overwrite<ServiceConfig, {
-    serviceType: 'graphql';
-    options: {
-        [name: string]: any;
-        endpoint: string;
-        headers?: Headers;
-        timeout?: number;
-    };
-}>;
-export type OpenAPIServiceConfig = Merge<ServiceConfig, {
-    serviceType: 'openapi';
-    options: {
-        [name: string]: any;
-        endpoint: string;
-        spec: string;
-        headers?: Headers;
-        timeout?: number;
-        retry?: AllowedRetryOptions;
-        useRestfulNames?: boolean;
-        introspectedAt?: string;
-        transformVersion?: string;
-    };
-}>;
-export type EncryptedServiceConfig = Overwrite<ServiceConfig, {
-    authentication: string;
-}>;
-export type ServiceConfigWithOAuth2Authentication = Merge<ServiceConfig, {
-    authentication: OAuth2Authentication;
-}>;
-export type ServiceConfigWithCustomAuthentication = Merge<ServiceConfig, {
-    authentication: CustomAuthentication;
-}>;
-/**
- * Support null sentinels for authentication
- */
-export type ServiceConfigWithNullSentinelAuthentication = Overwrite<ServiceConfig, {
-    authentication?: ServiceAuthentication | null;
-}>;
-/**
- * A type suitable for service object updates, mostly concerns authentication
- * requirements.
- */
-export type ServiceConfigUpdate = SetRequired<PartialDeep<ServiceConfigWithNullSentinelAuthentication>, 'authenticationType'>;
-export type LatestProjectSchemaWithServices = {
-    services: ServiceMapJSON;
-} & ProjectSchemaJSON;
-/**
- * Types of refs
- */
-export declare enum RefType {
-    '@ref' = "@ref",
-    $ref = "$ref"
-}
-/**
- * Stub of a PropertySchema that may contain a `$ref` or `@ref`.
- */
-export type RefSchemaStub = {
-    items?: RefSchemaStub;
-} & Pick<PropertySchema, RefType>;
-export type SchemaWithRef = PropertySchema | RefSchemaStub;
-/**
- * Types of args
- */
-export declare enum ArgsType {
-    '@args' = "@args",
-    args = "args"
-}
-export type SchemaWithArgs = PropertySchema | QueryJSON;
-/**
- * Types supporting schema iterators
- */
-export type SchemaPropertyName = string;
-export type SchemaPropertyNode = [SchemaPropertyName, PropertySchema];
-export type SchemaPropertyIterator = SchemaPropertyNode[];
-export type ShopifyServiceConfig = Overwrite<ServiceConfig, {
-    serviceType: 'graphql';
-    provider: 'shopify';
-    options: {
-        shop: string;
-        endpoint: string;
-    };
-}>;
-export type SchemaPath = Array<string | number>;
-export type LayerSchema = Pick<ProjectSchemaJSON, 'shapes' | 'queries' | 'mutations' | 'schemaVersion'>;
-export type ServiceLayers = Record<string, LayerState>;
-export type UndefinedLayerState = {
-    id: string;
-    schema: undefined;
-    status: 'disconnected' | 'error' | 'notAvailable';
-};
-export type DefinedLayerState = {
-    id: string;
-    schema: LayerSchema;
-    status: 'ok';
-};
-export type LayerState = UndefinedLayerState | DefinedLayerState;
-export type LayerStatus = LayerState['status'];
-export type UndefinedLayerStatus = UndefinedLayerState['status'];
-/**
- * Shapes
- */
-export type ShapeRefs = Ref[];
-/**
- * Relationships
- */
-export type PropertySchemaWithRelationship = PropertySchema & {
-    '@resolver': {
-        name: 'shapedb:getRelated';
-        service: 'shapedb';
-        options?: {
-            nullable?: boolean;
-        };
-    };
-};
-/**
- * New relationship data, drawn from a PropertySchema.
- */
-export type Relationship = {
-    isMultiple: boolean;
-    refs: ShapeRefs;
-    hasBackreference: boolean;
-    backreferenceName?: string;
-};
-/**
- * The old relationship format, used in client UI.
- */
-export type LegacyRelationship = {
-    shapeIds: string[];
-    type?: 'single' | 'multiple';
-};
-export type RelationshipEnv = {
-    shapeId: string;
-    path: string[];
-    hasBackreference: boolean;
-    relatedName?: string;
-    schema: PropertySchema;
-    shapeName: string;
-};
-export type CachedShape = SetRequired<ShapeJSON, 'loaders' | 'cache'>;
-export type CachedShapeMap = Record<string, CachedShape>;
-export type ListQueryIndexingConfig = CachedFragmentConfig & ListQueryLoaderConfig & {
-    shapeName: string;
-    idField: string;
-};
-export type GetQueryIndexingConfig = CachedFragmentConfig & GetQueryLoaderConfig & {
-    shapeName: string;
-    idField: string;
-};
-export type MeshShape = SetRequired<ShapeJSON, 'joins'>;
-export {};