@resistdesign/voltra 3.0.0-alpha.0 → 3.0.0-alpha.10

package/Types-C7XjUjoF.d.ts

@@ -0,0 +1,240 @@
+import { B as BaseItemRelationshipInfo, L as ListRelationshipsConfig, a as ListItemsResults, I as ItemRelationshipInfo, T as TypeInfoDataItem, b as ListItemsConfig, c as TypeOperation } from './SearchTypes-DjN6YQzE.js';
+
+/**
+ * @packageDocumentation
+ *
+ * Shared TypeInfoORM API types, route paths, and error enums used by services
+ * and clients.
+ */
+
+/**
+ * A set of possible operations for a {@link ItemRelationshipInfo}.
+ * */
+declare enum RelationshipOperation {
+    /**
+     * Read relationship info.
+     * */
+    GET = "GET",
+    /**
+     * Create or update a relationship.
+     * */
+    SET = "SET",
+    /**
+     * Remove a relationship.
+     * */
+    UNSET = "UNSET"
+}
+/**
+ * A set groups of possible operations for a type, field value or relationship.
+ * */
+declare enum OperationGroup {
+    /**
+     * All possible operations.
+     * */
+    ALL_OPERATIONS = "ALL_OPERATIONS",
+    /**
+     * All item CRUD operations.
+     * */
+    ALL_ITEM_OPERATIONS = "ALL_ITEM_OPERATIONS",
+    /**
+     * All relationship operations.
+     * */
+    ALL_RELATIONSHIP_OPERATIONS = "ALL_RELATIONSHIP_OPERATIONS"
+}
+/**
+ * A set of possible ORM operations.
+ * */
+type ORMOperation = TypeOperation | RelationshipOperation | OperationGroup;
+/**
+ * Error types for a TypeInfoORM service.
+ * */
+declare enum TypeInfoORMServiceError {
+    /**
+     * No data drivers were supplied.
+     * */
+    NO_DRIVERS_SUPPLIED = "NO_DRIVERS_SUPPLIED",
+    /**
+     * No relationship drivers were supplied.
+     * */
+    NO_RELATIONSHIP_DRIVERS_SUPPLIED = "NO_RELATIONSHIP_DRIVERS_SUPPLIED",
+    /**
+     * Missing required primary field value.
+     * */
+    NO_PRIMARY_FIELD_VALUE_SUPPLIED = "NO_PRIMARY_FIELD_VALUE_SUPPLIED",
+    /**
+     * Driver type is not supported for the request.
+     * */
+    INVALID_DRIVER = "INVALID_DRIVER",
+    /**
+     * Relationship driver type is not supported for the request.
+     * */
+    INVALID_RELATIONSHIP_DRIVER = "INVALID_RELATIONSHIP_DRIVER",
+    /**
+     * TypeInfo definition was not found or invalid.
+     * */
+    INVALID_TYPE_INFO = "INVALID_TYPE_INFO",
+    /**
+     * TypeInfo missing a primary field definition.
+     * */
+    TYPE_INFO_MISSING_PRIMARY_FIELD = "TYPE_INFO_MISSING_PRIMARY_FIELD",
+    /**
+     * Relationship payload is invalid.
+     * */
+    INVALID_RELATIONSHIP = "INVALID_RELATIONSHIP",
+    /**
+     * Operation is not supported.
+     * */
+    INVALID_OPERATION = "INVALID_OPERATION",
+    /**
+     * Indexing criteria is not supported.
+     * */
+    INDEXING_UNSUPPORTED_CRITERIA = "INDEXING_UNSUPPORTED_CRITERIA",
+    /**
+     * Indexing criteria combination is not supported.
+     * */
+    INDEXING_UNSUPPORTED_COMBINATION = "INDEXING_UNSUPPORTED_COMBINATION",
+    /**
+     * Required index field is missing.
+     * */
+    INDEXING_MISSING_INDEX_FIELD = "INDEXING_MISSING_INDEX_FIELD",
+    /**
+     * Indexing backend dependency is missing.
+     * */
+    INDEXING_MISSING_BACKEND = "INDEXING_MISSING_BACKEND",
+    /**
+     * Indexing operations require criteria to be provided.
+     * */
+    INDEXING_REQUIRES_CRITERIA = "INDEXING_REQUIRES_CRITERIA"
+}
+/**
+ * A collection of kebab-case route paths for a TypeInfoORM API.
+ * */
+declare enum TypeInfoORMAPIRoutePaths {
+    /**
+     * Create item route.
+     * */
+    CREATE = "create",
+    /**
+     * Read item route.
+     * */
+    READ = "read",
+    /**
+     * Update item route.
+     * */
+    UPDATE = "update",
+    /**
+     * Delete item route.
+     * */
+    DELETE = "delete",
+    /**
+     * List item route.
+     * */
+    LIST = "list",
+    /**
+     * Create relationship route.
+     * */
+    CREATE_RELATIONSHIP = "create-relationship",
+    /**
+     * Delete relationship route.
+     * */
+    DELETE_RELATIONSHIP = "delete-relationship",
+    /**
+     * List relationships route.
+     * */
+    LIST_RELATIONSHIPS = "list-relationships",
+    /**
+     * List related items route.
+     * */
+    LIST_RELATED_ITEMS = "list-related-items"
+}
+/**
+ * The results of a delete relationship operation.
+ */
+type DeleteRelationshipResults = {
+    /**
+     * Whether the delete operation succeeded.
+     * */
+    success: boolean;
+    /**
+     * Whether related items still exist after deletion.
+     * */
+    remainingItemsExist: boolean;
+};
+/**
+ * The API type for TypeInfoORM providers to implement.
+ * */
+type TypeInfoORMAPI = {
+    /**
+     * Create a relationship record.
+     *
+     * @param relationshipItem - Relationship payload to create.
+     * @returns Whether the create succeeded.
+     */
+    createRelationship: (relationshipItem: BaseItemRelationshipInfo) => Promise<boolean>;
+    /**
+     * Delete a relationship record.
+     *
+     * @param relationshipItem - Relationship payload to delete.
+     * @returns Results describing deletion outcome.
+     */
+    deleteRelationship: (relationshipItem: BaseItemRelationshipInfo) => Promise<DeleteRelationshipResults>;
+    /**
+     * List relationships matching the query.
+     *
+     * @param config - Relationship list configuration.
+     * @returns Relationship list results.
+     */
+    listRelationships: (config: ListRelationshipsConfig) => Promise<ListItemsResults<ItemRelationshipInfo>>;
+    /**
+     * List related items for a relationship query.
+     *
+     * @param config - Relationship list configuration.
+     * @param selectedFields - Optional fields to project.
+     * @returns Related item list results.
+     */
+    listRelatedItems: (config: ListRelationshipsConfig, selectedFields?: (keyof TypeInfoDataItem)[]) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
+    /**
+     * Create an item.
+     *
+     * @param typeName - Type name to create.
+     * @param item - Item payload to create.
+     * @returns The created item result.
+     */
+    create: (typeName: string, item: TypeInfoDataItem) => Promise<any>;
+    /**
+     * Read an item by primary field value.
+     *
+     * @param typeName - Type name to read.
+     * @param primaryFieldValue - Primary field value to lookup.
+     * @param selectedFields - Optional fields to project.
+     * @returns Retrieved item data.
+     */
+    read: (typeName: string, primaryFieldValue: any, selectedFields?: (keyof TypeInfoDataItem)[]) => Promise<Partial<TypeInfoDataItem>>;
+    /**
+     * Update an item.
+     *
+     * @param typeName - Type name to update.
+     * @param item - Updated item payload.
+     * @returns Whether the update succeeded.
+     */
+    update: (typeName: string, item: TypeInfoDataItem) => Promise<boolean>;
+    /**
+     * Delete an item by primary field value.
+     *
+     * @param typeName - Type name to delete.
+     * @param primaryFieldValue - Primary field value to delete.
+     * @returns Whether the delete succeeded.
+     */
+    delete: (typeName: string, primaryFieldValue: any) => Promise<boolean>;
+    /**
+     * List items matching the configuration.
+     *
+     * @param typeName - Type name to list.
+     * @param config - List configuration.
+     * @param selectedFields - Optional fields to project.
+     * @returns List results.
+     */
+    list: (typeName: string, config: ListItemsConfig, selectedFields?: (keyof TypeInfoDataItem)[]) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
+};
+
+export { type DeleteRelationshipResults as D, type ORMOperation as O, RelationshipOperation as R, type TypeInfoORMAPI as T, TypeInfoORMServiceError as a, TypeInfoORMAPIRoutePaths as b };

package/Validation-CFP59oIP.d.ts

@@ -0,0 +1,226 @@
+import { d as TypeKeyword, c as TypeOperation, e as TypeInfoField, f as TypeInfoMap, g as TypeInfo } from './SearchTypes-DjN6YQzE.js';
+
+/**
+ * @packageDocumentation
+ *
+ * Validation helpers for TypeInfo values, including relationship rules and
+ * custom type validators.
+ */
+
+/**
+ * Relationship validation behavior for TypeInfo checks.
+ */
+declare enum RelationshipValidationType {
+    /**
+     * Include relationship values in validation.
+     */
+    INCLUDE = "INCLUDE",
+    /**
+     * Exclude relationship values from validation.
+     */
+    EXCLUDE = "EXCLUDE",
+    /**
+     * Disallow relationship values entirely.
+     */
+    STRICT_EXCLUDE = "STRICT_EXCLUDE"
+}
+/**
+ * A custom type info field validator.
+ * */
+type CustomTypeInfoFieldValidator = (value: any) => boolean;
+/**
+ * A map of custom type info field validators.
+ * */
+type CustomTypeInfoFieldValidatorMap = Record<string, CustomTypeInfoFieldValidator>;
+/**
+ * A map of errors.
+ * */
+type ErrorMap = {
+    [key: string]: string[];
+};
+/**
+ * The validation results for type info fields.
+ */
+type TypeInfoValidationResults = {
+    /**
+     * Type name being validated.
+     */
+    typeName: string | null;
+    /**
+     * Whether the validation passed.
+     */
+    valid: boolean;
+    /**
+     * Primary error code when validation fails.
+     */
+    error: string;
+    /**
+     * Field-level error mapping.
+     */
+    errorMap: ErrorMap;
+};
+/**
+ * Error code for custom type validation failures.
+ */
+declare const INVALID_CUSTOM_TYPE = "INVALID_CUSTOM_TYPE";
+/**
+ * Error codes for primitive type validation failures.
+ */
+declare const PRIMITIVE_ERROR_MESSAGE_CONSTANTS: Record<TypeKeyword, string>;
+/**
+ * Error codes for TypeInfo validation failures.
+ */
+declare const ERROR_MESSAGE_CONSTANTS: {
+    MISSING: string;
+    INVALID_OPTION: string;
+    INVALID_FIELD: string;
+    RELATIONSHIP_VALUES_ARE_STRICTLY_EXCLUDED: string;
+    INVALID_TYPE: string;
+    NO_UNION_TYPE_MATCHED: string;
+    TYPE_DOES_NOT_EXIST: string;
+    INVALID_PATTERN: string;
+    VALUE_DOES_NOT_MATCH_PATTERN: string;
+};
+/**
+ * Error codes for denied type operations.
+ */
+declare const DENIED_TYPE_OPERATIONS: Record<TypeOperation, string>;
+/**
+ * Validates a value against a pattern.
+ *
+ * `value` must be a string or not supplied.
+ * `pattern` must be a string or not supplied.
+ *
+ * If either are not supplied, the result is valid.
+ *
+ * @param typeName - Type name for the validation context.
+ * @param value - Value to validate.
+ * @param pattern - Regex pattern to validate against.
+ * @returns Validation results for the pattern.
+ * */
+declare const validateValueMatchesPattern: (typeName: string, value?: any, pattern?: string) => TypeInfoValidationResults;
+/**
+ * Gets the validity value.
+ *
+ * @param existing - Current validity value.
+ * @param pending - New validity value.
+ * @returns Updated validity value.
+ */
+declare const getValidityValue: (existing: boolean, pending: boolean) => boolean;
+/**
+ * The validators for primitive values.
+ */
+declare const TYPE_KEYWORD_VALIDATORS: Record<TypeKeyword, (value: any) => boolean>;
+/**
+ * Checks if a value has a value.
+ *
+ * @param value - Value to check.
+ * @returns Whether the value is present.
+ */
+declare const hasValue: (value: any) => boolean;
+/**
+ * Validates a primitive value.
+ *
+ * @param value - Value to validate.
+ * @param type - Primitive type keyword.
+ * @returns Whether the value matches the type.
+ */
+declare const validateKeywordType: (value: any, type: string) => boolean;
+/**
+ * Validates a custom type.
+ *
+ * @param value - Value to validate.
+ * @param customType - Custom type name.
+ * @param customValidators - Custom validators map.
+ * @returns Whether the value passes custom validation.
+ */
+declare const validateCustomType: (value: any, customType?: string, customValidators?: CustomTypeInfoFieldValidatorMap) => boolean;
+/**
+ * Validates a type info field value.
+ *
+ * @param value - Value to validate.
+ * @param typeInfoField - Field metadata.
+ * @param typeInfoMap - Type info map for referenced types.
+ * @param ignoreArray - Whether to ignore array validation.
+ * @param strict - Whether to validate unknown fields and unions strictly.
+ * @param customValidators - Custom validators map.
+ * @param typeOperation - Operation being validated.
+ * @param relationshipValidationType - Relationship validation behavior.
+ * @param itemIsPartial - Whether the item is partial.
+ * @returns Validation results for the field.
+ */
+declare const validateTypeInfoFieldValue: (value: any, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, ignoreArray?: boolean, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
+/**
+ * Validates an array of type info field values.
+ *
+ * @param values - Values to validate.
+ * @param typeInfoField - Field metadata.
+ * @param typeInfoMap - Type info map for referenced types.
+ * @param strict - Whether to validate unknown fields and unions strictly.
+ * @param customValidators - Custom validators map.
+ * @param typeOperation - Operation being validated.
+ * @param relationshipValidationType - Relationship validation behavior.
+ * @param itemIsPartial - Whether the item is partial.
+ * @returns Validation results for the array.
+ */
+declare const validateArrayOfTypeInfoFieldValues: (values: any[] | undefined, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
+/**
+ * Validates a type info field operation.
+ *
+ * @param fieldName - Field name to validate.
+ * @param fieldOperation - Operation to validate.
+ * @param typeInfoField - Field metadata.
+ * @returns Validation results for the field operation.
+ * */
+declare const validateTypeInfoFieldOperationAllowed: (fieldName: string, fieldOperation?: TypeOperation, typeInfoField?: TypeInfoField) => TypeInfoValidationResults;
+/**
+ * Validates a type info operation.
+ *
+ * @param typeName - Type name to validate.
+ * @param valueFields - Fields included in the operation.
+ * @param typeOperation - Operation to validate.
+ * @param typeInfo - Type info metadata.
+ * @returns Validation results for the type operation.
+ * */
+declare const validateTypeOperationAllowed: (typeName: string, valueFields: string[], typeOperation: TypeOperation, typeInfo: TypeInfo) => TypeInfoValidationResults;
+/**
+ * Validates a type info value.
+ *
+ * @param value - Value to validate.
+ * @param typeInfoFullName - Fully qualified type name.
+ * @param typeInfoMap - Type info map for referenced types.
+ * @param strict - Whether to validate unknown fields and unions strictly.
+ * @param customValidators - Custom validators map.
+ * @param typeOperation - Operation being validated.
+ * @param relationshipValidationType - Relationship validation behavior.
+ * @param itemIsPartial - Whether the item is partial.
+ * @returns Validation results for the value.
+ */
+declare const validateTypeInfoValue: (value: any, typeInfoFullName: string, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
+
+type Validation_CustomTypeInfoFieldValidator = CustomTypeInfoFieldValidator;
+type Validation_CustomTypeInfoFieldValidatorMap = CustomTypeInfoFieldValidatorMap;
+declare const Validation_DENIED_TYPE_OPERATIONS: typeof DENIED_TYPE_OPERATIONS;
+declare const Validation_ERROR_MESSAGE_CONSTANTS: typeof ERROR_MESSAGE_CONSTANTS;
+type Validation_ErrorMap = ErrorMap;
+declare const Validation_INVALID_CUSTOM_TYPE: typeof INVALID_CUSTOM_TYPE;
+declare const Validation_PRIMITIVE_ERROR_MESSAGE_CONSTANTS: typeof PRIMITIVE_ERROR_MESSAGE_CONSTANTS;
+type Validation_RelationshipValidationType = RelationshipValidationType;
+declare const Validation_RelationshipValidationType: typeof RelationshipValidationType;
+declare const Validation_TYPE_KEYWORD_VALIDATORS: typeof TYPE_KEYWORD_VALIDATORS;
+type Validation_TypeInfoValidationResults = TypeInfoValidationResults;
+declare const Validation_getValidityValue: typeof getValidityValue;
+declare const Validation_hasValue: typeof hasValue;
+declare const Validation_validateArrayOfTypeInfoFieldValues: typeof validateArrayOfTypeInfoFieldValues;
+declare const Validation_validateCustomType: typeof validateCustomType;
+declare const Validation_validateKeywordType: typeof validateKeywordType;
+declare const Validation_validateTypeInfoFieldOperationAllowed: typeof validateTypeInfoFieldOperationAllowed;
+declare const Validation_validateTypeInfoFieldValue: typeof validateTypeInfoFieldValue;
+declare const Validation_validateTypeInfoValue: typeof validateTypeInfoValue;
+declare const Validation_validateTypeOperationAllowed: typeof validateTypeOperationAllowed;
+declare const Validation_validateValueMatchesPattern: typeof validateValueMatchesPattern;
+declare namespace Validation {
+  export { type Validation_CustomTypeInfoFieldValidator as CustomTypeInfoFieldValidator, type Validation_CustomTypeInfoFieldValidatorMap as CustomTypeInfoFieldValidatorMap, Validation_DENIED_TYPE_OPERATIONS as DENIED_TYPE_OPERATIONS, Validation_ERROR_MESSAGE_CONSTANTS as ERROR_MESSAGE_CONSTANTS, type Validation_ErrorMap as ErrorMap, Validation_INVALID_CUSTOM_TYPE as INVALID_CUSTOM_TYPE, Validation_PRIMITIVE_ERROR_MESSAGE_CONSTANTS as PRIMITIVE_ERROR_MESSAGE_CONSTANTS, Validation_RelationshipValidationType as RelationshipValidationType, Validation_TYPE_KEYWORD_VALIDATORS as TYPE_KEYWORD_VALIDATORS, type Validation_TypeInfoValidationResults as TypeInfoValidationResults, Validation_getValidityValue as getValidityValue, Validation_hasValue as hasValue, Validation_validateArrayOfTypeInfoFieldValues as validateArrayOfTypeInfoFieldValues, Validation_validateCustomType as validateCustomType, Validation_validateKeywordType as validateKeywordType, Validation_validateTypeInfoFieldOperationAllowed as validateTypeInfoFieldOperationAllowed, Validation_validateTypeInfoFieldValue as validateTypeInfoFieldValue, Validation_validateTypeInfoValue as validateTypeInfoValue, Validation_validateTypeOperationAllowed as validateTypeOperationAllowed, Validation_validateValueMatchesPattern as validateValueMatchesPattern };
+}
+
+export { type CustomTypeInfoFieldValidatorMap as C, type TypeInfoValidationResults as T, Validation as V };

package/api/index.d.ts

@@ -0,0 +1,6 @@
+export { D as DAC, a as Indexing, b as ORM, c as Routing } from '../index-D_EAHMXe.js';
+import '@aws-sdk/client-dynamodb';
+import '@aws-sdk/client-s3';
+import '../SearchTypes-DjN6YQzE.js';
+import '../Validation-CFP59oIP.js';
+import '../Types-C7XjUjoF.js';