convex-verify 1.0.5 → 1.2.2

package/dist/plugin-BjJ7yjrc.d.ts

@@ -1,141 +0,0 @@
-import { GenericMutationCtx, SchemaDefinition, GenericSchema } from 'convex/server';
-import { GenericId } from 'convex/values';
-import { a as OnFailCallback } from './types-_64SXyva.js';
-
-/**
- * Context passed to validate plugin functions.
- *
- * Provides access to:
- * - `ctx` - Full Convex mutation context (includes `ctx.db` for queries)
- * - `tableName` - The table being operated on
- * - `operation` - 'insert' or 'patch'
- * - `patchId` - Document ID (only for patch operations)
- * - `onFail` - Callback to report validation failures before throwing
- * - `schema` - Optional schema reference (if provided by verifyConfig)
- */
-type ValidateContext<TN extends string = string> = {
-    /** Full Convex mutation context - use ctx.db for database queries */
-    ctx: Omit<GenericMutationCtx<any>, never>;
-    /** Table name being operated on */
-    tableName: TN;
-    /** Operation type: 'insert' or 'patch' */
-    operation: 'insert' | 'patch';
-    /** Document ID (only available for patch operations) */
-    patchId?: GenericId<any>;
-    /** Callback for validation failures - call before throwing to provide details */
-    onFail?: OnFailCallback<any>;
-    /** Schema reference (if provided to verifyConfig) */
-    schema?: SchemaDefinition<GenericSchema, boolean>;
-};
-/**
- * A validate plugin that can check data during insert/patch operations.
- *
- * Validate plugins:
- * - Run AFTER transform plugins (like defaultValues)
- * - Can be async (use await for API calls, db queries, etc.)
- * - Can throw errors to prevent the operation
- * - Should return the data unchanged (validation only, no transformation)
- * - Do NOT affect the TypeScript types of the input data
- *
- * @example
- * ```ts
- * // Simple sync plugin
- * const requiredFields = createValidatePlugin(
- *   'requiredFields',
- *   { fields: ['title', 'content'] },
- *   {
- *     insert: (context, data) => {
- *       for (const field of config.fields) {
- *         if (!data[field]) {
- *           throw new ConvexError({ message: `Missing required field: ${field}` });
- *         }
- *       }
- *       return data;
- *     },
- *   }
- * );
- *
- * // Async plugin with database query
- * const checkOwnership = createValidatePlugin(
- *   'checkOwnership',
- *   {},
- *   {
- *     patch: async (context, data) => {
- *       const existing = await context.ctx.db.get(context.patchId);
- *       if (existing?.ownerId !== getCurrentUserId()) {
- *         throw new ConvexError({ message: 'Not authorized' });
- *       }
- *       return data;
- *     },
- *   }
- * );
- * ```
- */
-interface ValidatePlugin<Type extends string = string, Config = unknown> {
-    /** Unique identifier for this plugin */
-    readonly _type: Type;
-    /** Plugin configuration */
-    readonly config: Config;
-    /** Verify functions for insert and/or patch operations */
-    verify: {
-        /**
-         * Validate data for insert operations.
-         * Can be sync or async.
-         *
-         * @param context - Plugin context with ctx, tableName, schema, etc.
-         * @param data - The data to validate (after transforms applied)
-         * @returns The data unchanged (or Promise resolving to data)
-         * @throws ConvexError if validation fails
-         */
-        insert?: (context: ValidateContext, data: any) => Promise<any> | any;
-        /**
-         * Validate data for patch operations.
-         * Can be sync or async.
-         *
-         * @param context - Plugin context with ctx, tableName, patchId, schema, etc.
-         * @param data - The partial data to validate
-         * @returns The data unchanged (or Promise resolving to data)
-         * @throws ConvexError if validation fails
-         */
-        patch?: (context: ValidateContext, data: any) => Promise<any> | any;
-    };
-}
-/**
- * Type guard to check if something is a ValidatePlugin
- */
-declare function isValidatePlugin(obj: unknown): obj is ValidatePlugin;
-/**
- * A collection of validate plugins
- */
-type ValidatePluginRecord = Record<string, ValidatePlugin>;
-/**
- * Run all validate plugins for an operation.
- * Plugins are run in order and each receives the output of the previous.
- * All plugin verify functions are awaited (supports async plugins).
- */
-declare function runValidatePlugins(plugins: ValidatePlugin[], context: ValidateContext, data: any): Promise<any>;
-/**
- * Helper to create a validate plugin with proper typing.
- *
- * @param type - Unique identifier for this plugin type
- * @param config - Plugin configuration data
- * @param verify - Object with insert and/or patch verify functions
- * @returns A ValidatePlugin instance
- *
- * @example
- * ```ts
- * const myPlugin = createValidatePlugin(
- *   'myPlugin',
- *   { maxLength: 100 },
- *   {
- *     insert: async (context, data) => {
- *       // Validation logic here
- *       return data;
- *     },
- *   }
- * );
- * ```
- */
-declare function createValidatePlugin<Type extends string, Config>(type: Type, config: Config, verify: ValidatePlugin<Type, Config>['verify']): ValidatePlugin<Type, Config>;
-
-export { type ValidateContext as V, type ValidatePlugin as a, type ValidatePluginRecord as b, createValidatePlugin as c, isValidatePlugin as i, runValidatePlugins as r };

package/dist/plugin-mHMV2-SG.d.mts

@@ -1,141 +0,0 @@
-import { GenericMutationCtx, SchemaDefinition, GenericSchema } from 'convex/server';
-import { GenericId } from 'convex/values';
-import { a as OnFailCallback } from './types-_64SXyva.mjs';
-
-/**
- * Context passed to validate plugin functions.
- *
- * Provides access to:
- * - `ctx` - Full Convex mutation context (includes `ctx.db` for queries)
- * - `tableName` - The table being operated on
- * - `operation` - 'insert' or 'patch'
- * - `patchId` - Document ID (only for patch operations)
- * - `onFail` - Callback to report validation failures before throwing
- * - `schema` - Optional schema reference (if provided by verifyConfig)
- */
-type ValidateContext<TN extends string = string> = {
-    /** Full Convex mutation context - use ctx.db for database queries */
-    ctx: Omit<GenericMutationCtx<any>, never>;
-    /** Table name being operated on */
-    tableName: TN;
-    /** Operation type: 'insert' or 'patch' */
-    operation: 'insert' | 'patch';
-    /** Document ID (only available for patch operations) */
-    patchId?: GenericId<any>;
-    /** Callback for validation failures - call before throwing to provide details */
-    onFail?: OnFailCallback<any>;
-    /** Schema reference (if provided to verifyConfig) */
-    schema?: SchemaDefinition<GenericSchema, boolean>;
-};
-/**
- * A validate plugin that can check data during insert/patch operations.
- *
- * Validate plugins:
- * - Run AFTER transform plugins (like defaultValues)
- * - Can be async (use await for API calls, db queries, etc.)
- * - Can throw errors to prevent the operation
- * - Should return the data unchanged (validation only, no transformation)
- * - Do NOT affect the TypeScript types of the input data
- *
- * @example
- * ```ts
- * // Simple sync plugin
- * const requiredFields = createValidatePlugin(
- *   'requiredFields',
- *   { fields: ['title', 'content'] },
- *   {
- *     insert: (context, data) => {
- *       for (const field of config.fields) {
- *         if (!data[field]) {
- *           throw new ConvexError({ message: `Missing required field: ${field}` });
- *         }
- *       }
- *       return data;
- *     },
- *   }
- * );
- *
- * // Async plugin with database query
- * const checkOwnership = createValidatePlugin(
- *   'checkOwnership',
- *   {},
- *   {
- *     patch: async (context, data) => {
- *       const existing = await context.ctx.db.get(context.patchId);
- *       if (existing?.ownerId !== getCurrentUserId()) {
- *         throw new ConvexError({ message: 'Not authorized' });
- *       }
- *       return data;
- *     },
- *   }
- * );
- * ```
- */
-interface ValidatePlugin<Type extends string = string, Config = unknown> {
-    /** Unique identifier for this plugin */
-    readonly _type: Type;
-    /** Plugin configuration */
-    readonly config: Config;
-    /** Verify functions for insert and/or patch operations */
-    verify: {
-        /**
-         * Validate data for insert operations.
-         * Can be sync or async.
-         *
-         * @param context - Plugin context with ctx, tableName, schema, etc.
-         * @param data - The data to validate (after transforms applied)
-         * @returns The data unchanged (or Promise resolving to data)
-         * @throws ConvexError if validation fails
-         */
-        insert?: (context: ValidateContext, data: any) => Promise<any> | any;
-        /**
-         * Validate data for patch operations.
-         * Can be sync or async.
-         *
-         * @param context - Plugin context with ctx, tableName, patchId, schema, etc.
-         * @param data - The partial data to validate
-         * @returns The data unchanged (or Promise resolving to data)
-         * @throws ConvexError if validation fails
-         */
-        patch?: (context: ValidateContext, data: any) => Promise<any> | any;
-    };
-}
-/**
- * Type guard to check if something is a ValidatePlugin
- */
-declare function isValidatePlugin(obj: unknown): obj is ValidatePlugin;
-/**
- * A collection of validate plugins
- */
-type ValidatePluginRecord = Record<string, ValidatePlugin>;
-/**
- * Run all validate plugins for an operation.
- * Plugins are run in order and each receives the output of the previous.
- * All plugin verify functions are awaited (supports async plugins).
- */
-declare function runValidatePlugins(plugins: ValidatePlugin[], context: ValidateContext, data: any): Promise<any>;
-/**
- * Helper to create a validate plugin with proper typing.
- *
- * @param type - Unique identifier for this plugin type
- * @param config - Plugin configuration data
- * @param verify - Object with insert and/or patch verify functions
- * @returns A ValidatePlugin instance
- *
- * @example
- * ```ts
- * const myPlugin = createValidatePlugin(
- *   'myPlugin',
- *   { maxLength: 100 },
- *   {
- *     insert: async (context, data) => {
- *       // Validation logic here
- *       return data;
- *     },
- *   }
- * );
- * ```
- */
-declare function createValidatePlugin<Type extends string, Config>(type: Type, config: Config, verify: ValidatePlugin<Type, Config>['verify']): ValidatePlugin<Type, Config>;
-
-export { type ValidateContext as V, type ValidatePlugin as a, type ValidatePluginRecord as b, createValidatePlugin as c, isValidatePlugin as i, runValidatePlugins as r };

package/dist/plugins/index.d.mts

@@ -1,85 +0,0 @@
-import { SchemaDefinition, GenericSchema, DataModelFromSchemaDefinition } from 'convex/server';
-import { a as ValidatePlugin } from '../plugin-mHMV2-SG.mjs';
-import { U as UniqueRowConfigData, g as UniqueColumnConfigData } from '../types-_64SXyva.mjs';
-export { h as UniqueColumnConfigEntry, i as UniqueColumnConfigOptions, e as UniqueRowConfigEntry, f as UniqueRowConfigOptions } from '../types-_64SXyva.mjs';
-import 'convex/values';
-
-/**
- * Creates a validate plugin that enforces row uniqueness based on database indexes.
- *
- * This plugin checks that the combination of column values defined in your indexes
- * doesn't already exist in the database before allowing insert/patch operations.
- *
- * @param schema - Your Convex schema definition
- * @param config - Object mapping table names to arrays of index configs
- * @returns A ValidatePlugin for use with verifyConfig
- *
- * @example
- * ```ts
- * // Simple shorthand - just index names
- * const uniqueRow = uniqueRowConfig(schema, {
- *   posts: ['by_slug'],
- *   users: ['by_email', 'by_username'],
- * });
- *
- * // With options
- * const uniqueRow = uniqueRowConfig(schema, {
- *   posts: [
- *     { index: 'by_author_slug', identifiers: ['_id', 'authorId'] },
- *   ],
- * });
- *
- * // Use with verifyConfig
- * const { insert, patch } = verifyConfig(schema, {
- *   plugins: [uniqueRow],
- * });
- * ```
- */
-declare const uniqueRowConfig: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, const C extends UniqueRowConfigData<DataModel>>(schema: S, config: C) => ValidatePlugin<"uniqueRow", C>;
-
-/**
- * Creates a validate plugin that enforces column uniqueness using single-column indexes.
- *
- * This is useful when you have a column that must be unique across all rows,
- * like usernames or email addresses.
- *
- * The column name is derived from the index name by removing the 'by_' prefix.
- * For example, 'by_username' checks the 'username' column.
- *
- * @param schema - Your Convex schema definition
- * @param config - Object mapping table names to arrays of index configs
- * @returns A ValidatePlugin for use with verifyConfig
- *
- * @example
- * ```ts
- * // Shorthand: just pass index names as strings
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: ['by_username', 'by_email'],
- *   organizations: ['by_slug'],
- * });
- *
- * // Full config: pass objects with options
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: [
- *     { index: 'by_username', identifiers: ['_id', 'userId'] },
- *     { index: 'by_email', identifiers: ['_id'] },
- *   ],
- * });
- *
- * // Mix and match
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: [
- *     'by_username',  // shorthand
- *     { index: 'by_email', identifiers: ['_id', 'clerkId'] },  // full config
- *   ],
- * });
- *
- * // Use with verifyConfig
- * const { insert, patch } = verifyConfig(schema, {
- *   plugins: [uniqueColumn],
- * });
- * ```
- */
-declare const uniqueColumnConfig: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, const C extends UniqueColumnConfigData<DataModel>>(_schema: S, config: C) => ValidatePlugin<"uniqueColumn", C>;
-
-export { UniqueColumnConfigData, UniqueRowConfigData, uniqueColumnConfig, uniqueRowConfig };

package/dist/plugins/index.d.ts

@@ -1,85 +0,0 @@
-import { SchemaDefinition, GenericSchema, DataModelFromSchemaDefinition } from 'convex/server';
-import { a as ValidatePlugin } from '../plugin-BjJ7yjrc.js';
-import { U as UniqueRowConfigData, g as UniqueColumnConfigData } from '../types-_64SXyva.js';
-export { h as UniqueColumnConfigEntry, i as UniqueColumnConfigOptions, e as UniqueRowConfigEntry, f as UniqueRowConfigOptions } from '../types-_64SXyva.js';
-import 'convex/values';
-
-/**
- * Creates a validate plugin that enforces row uniqueness based on database indexes.
- *
- * This plugin checks that the combination of column values defined in your indexes
- * doesn't already exist in the database before allowing insert/patch operations.
- *
- * @param schema - Your Convex schema definition
- * @param config - Object mapping table names to arrays of index configs
- * @returns A ValidatePlugin for use with verifyConfig
- *
- * @example
- * ```ts
- * // Simple shorthand - just index names
- * const uniqueRow = uniqueRowConfig(schema, {
- *   posts: ['by_slug'],
- *   users: ['by_email', 'by_username'],
- * });
- *
- * // With options
- * const uniqueRow = uniqueRowConfig(schema, {
- *   posts: [
- *     { index: 'by_author_slug', identifiers: ['_id', 'authorId'] },
- *   ],
- * });
- *
- * // Use with verifyConfig
- * const { insert, patch } = verifyConfig(schema, {
- *   plugins: [uniqueRow],
- * });
- * ```
- */
-declare const uniqueRowConfig: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, const C extends UniqueRowConfigData<DataModel>>(schema: S, config: C) => ValidatePlugin<"uniqueRow", C>;
-
-/**
- * Creates a validate plugin that enforces column uniqueness using single-column indexes.
- *
- * This is useful when you have a column that must be unique across all rows,
- * like usernames or email addresses.
- *
- * The column name is derived from the index name by removing the 'by_' prefix.
- * For example, 'by_username' checks the 'username' column.
- *
- * @param schema - Your Convex schema definition
- * @param config - Object mapping table names to arrays of index configs
- * @returns A ValidatePlugin for use with verifyConfig
- *
- * @example
- * ```ts
- * // Shorthand: just pass index names as strings
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: ['by_username', 'by_email'],
- *   organizations: ['by_slug'],
- * });
- *
- * // Full config: pass objects with options
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: [
- *     { index: 'by_username', identifiers: ['_id', 'userId'] },
- *     { index: 'by_email', identifiers: ['_id'] },
- *   ],
- * });
- *
- * // Mix and match
- * const uniqueColumn = uniqueColumnConfig(schema, {
- *   users: [
- *     'by_username',  // shorthand
- *     { index: 'by_email', identifiers: ['_id', 'clerkId'] },  // full config
- *   ],
- * });
- *
- * // Use with verifyConfig
- * const { insert, patch } = verifyConfig(schema, {
- *   plugins: [uniqueColumn],
- * });
- * ```
- */
-declare const uniqueColumnConfig: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, const C extends UniqueColumnConfigData<DataModel>>(_schema: S, config: C) => ValidatePlugin<"uniqueColumn", C>;
-
-export { UniqueColumnConfigData, UniqueRowConfigData, uniqueColumnConfig, uniqueRowConfig };