convex-verify 1.0.5 → 1.2.2

package/dist/core/index.d.mts

@@ -1,88 +1,17 @@
-import { GenericSchema, DataModelFromSchemaDefinition, SchemaDefinition, TableNamesInDataModel, DocumentByName, GenericMutationCtx, WithoutSystemFields } from 'convex/server';
-import { GenericId } from 'convex/values';
-import { a as ValidatePlugin } from '../plugin-mHMV2-SG.mjs';
-export { V as ValidateContext, b as ValidatePluginRecord, c as createValidatePlugin, i as isValidatePlugin, r as runValidatePlugins } from '../plugin-mHMV2-SG.mjs';
-import { V as VerifyConfigInput, H as HasKey, M as MakeOptional, b as OptionalKeysForTable, a as OnFailCallback, d as ProtectedKeysForTable } from '../types-_64SXyva.mjs';
-export { B as BaseConfigReturn, k as DMGeneric, D as DefaultValuesConfigData, l as DefaultValuesInput, E as ExtractDefaultValuesConfig, c as ExtractProtectedColumnsConfig, I as IndexConfigBaseOptions, j as IndexConfigEntry, N as NormalizedIndexConfig, O as OnFailArgs, P as Prettify, m as ProtectedColumnsInput, g as UniqueColumnConfigData, h as UniqueColumnConfigEntry, i as UniqueColumnConfigOptions, U as UniqueRowConfigData, e as UniqueRowConfigEntry, f as UniqueRowConfigOptions, n as normalizeIndexConfigEntry } from '../types-_64SXyva.mjs';
+import { c as createExtension$1, i as isExtension$1, r as runExtensions$1 } from '../verifyConfig-Kn3Ikj00.mjs';
+export { d as Extension, E as ExtensionContext, a as ExtensionInput, b as ExtensionInputForSchema, e as ExtensionRecord, S as SchemaExtension, v as verifyConfig } from '../verifyConfig-Kn3Ikj00.mjs';
+export { v as BaseConfigReturn, B as BuiltinConfigKey, C as ConfigRegistry, w as DMGeneric, D as DataModelForSchema, c as DefaultValuesConfigData, d as DefaultValuesConfigInput, k as DefaultValuesVerifyFn, m as ExtensionStyleVerifyFn, E as ExtractDefaultValuesConfig, g as ExtractProtectedColumnsConfig, H as HasKey, I as IndexConfigBaseOptions, u as IndexConfigEntry, M as MakeOptional, a as MutationCtxForSchema, N as NormalizedIndexConfig, O as OnFailArgs, b as OnFailCallback, f as OptionalKeysForTable, P as Prettify, e as ProtectedColumnsConfigData, l as ProtectedColumnsVerifyFn, h as ProtectedKeysForTable, q as UniqueColumnConfigData, r as UniqueColumnConfigEntry, s as UniqueColumnConfigOptions, U as UniqueRowConfigData, o as UniqueRowConfigEntry, p as UniqueRowConfigOptions, V as VerifyConfigInput, i as VerifyInsertInput, j as VerifyPatchInput, n as VerifyRegistry, t as normalizeIndexConfigEntry } from '../types-B8ZkLuJ2.mjs';
+import 'convex/server';
+import 'convex/values';
 
-/**
- * Extended config input that includes optional validate plugins
- */
-type VerifyConfigInputWithPlugins = VerifyConfigInput & {
-    /**
-     * Unique row validation config.
-     * Enforces uniqueness across multiple columns using composite indexes.
-     *
-     * Can also be added to the `plugins` array.
-     */
-    uniqueRow?: ValidatePlugin<"uniqueRow", any>;
-    /**
-     * Unique column validation config.
-     * Enforces uniqueness on single columns using indexes.
-     *
-     * Can also be added to the `plugins` array.
-     */
-    uniqueColumn?: ValidatePlugin<"uniqueColumn", any>;
-    /**
-     * Additional validate plugins to run after transforms.
-     * These plugins can validate data but don't affect input types.
-     *
-     * Built-in plugins (uniqueRow, uniqueColumn) can be added here
-     * as an alternative to using their dedicated config keys.
-     */
-    plugins?: ValidatePlugin[];
-};
-/**
- * Configure type-safe insert and patch functions with validation and transforms.
- *
- * @param schema - Your Convex schema definition
- * @param configs - Configuration object with transforms, configs, and plugins
- * @returns Object with `insert`, `patch`, and `dangerouslyPatch` functions
- *
- * @example
- * ```ts
- * import {
- *   verifyConfig,
- *   defaultValuesConfig,
- *   protectedColumnsConfig,
- *   uniqueRowConfig,
- *   uniqueColumnConfig,
- * } from 'convex-verify';
- * import schema from './schema';
- *
- * export const { insert, patch, dangerouslyPatch } = verifyConfig(schema, {
- *   // Type-affecting configs
- *   defaultValues: defaultValuesConfig(schema, () => ({
- *     posts: { status: 'draft', views: 0 },
- *   })),
- *   protectedColumns: protectedColumnsConfig(schema, {
- *     posts: ['authorId'],
- *   }),
- *
- *   // Built-in validation configs
- *   uniqueRow: uniqueRowConfig(schema, {
- *     posts: ['by_author_slug'],
- *   }),
- *   uniqueColumn: uniqueColumnConfig(schema, {
- *     users: ['by_email', 'by_username'],
- *   }),
- *
- *   // Custom/third-party plugins
- *   plugins: [myCustomPlugin()],
- * });
- * ```
- */
-declare const verifyConfig: <S extends GenericSchema, DataModel extends DataModelFromSchemaDefinition<SchemaDefinition<S, boolean>>, const VC extends VerifyConfigInputWithPlugins>(_schema: SchemaDefinition<S, boolean>, configs: VC) => {
-    insert: <const TN extends TableNamesInDataModel<DataModel>, const D extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, data: HasKey<VC, "defaultValues"> extends true ? MakeOptional<WithoutSystemFields<D>, OptionalKeysForTable<VC, TN> & keyof WithoutSystemFields<D>> : WithoutSystemFields<D>, options?: {
-        onFail?: OnFailCallback<D>;
-    }) => Promise<GenericId<TN>>;
-    patch: <const TN extends TableNamesInDataModel<DataModel>, const D_1 extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, id: GenericId<TN>, data: HasKey<VC, "protectedColumns"> extends true ? Omit<Partial<WithoutSystemFields<D_1>>, ProtectedKeysForTable<VC, TN> & keyof WithoutSystemFields<D_1>> : Partial<WithoutSystemFields<D_1>>, options?: {
-        onFail?: OnFailCallback<D_1>;
-    }) => Promise<void>;
-    dangerouslyPatch: <const TN extends TableNamesInDataModel<DataModel>, const D_2 extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, id: GenericId<TN>, data: Partial<WithoutSystemFields<D_2>>, options?: {
-        onFail?: OnFailCallback<D_2>;
-    }) => Promise<void>;
-    configs: VC;
+type ProtectedColumnsLike = Record<string, readonly PropertyKey[] | undefined>;
+declare const stripProtectedPatchColumns: <T extends Record<string, any>>(protectedColumns: ProtectedColumnsLike, tableName: string, data: T) => {
+    filteredData: T;
+    removedColumns: string[];
 };
 
-export { HasKey, MakeOptional, OnFailCallback, OptionalKeysForTable, ProtectedKeysForTable, ValidatePlugin, VerifyConfigInput, verifyConfig };
+declare const createExtension: typeof createExtension$1;
+declare const isExtension: typeof isExtension$1;
+declare const runExtensions: typeof runExtensions$1;
+
+export { createExtension, isExtension, runExtensions, stripProtectedPatchColumns };

package/dist/core/index.d.ts

@@ -1,88 +1,17 @@
-import { GenericSchema, DataModelFromSchemaDefinition, SchemaDefinition, TableNamesInDataModel, DocumentByName, GenericMutationCtx, WithoutSystemFields } from 'convex/server';
-import { GenericId } from 'convex/values';
-import { a as ValidatePlugin } from '../plugin-BjJ7yjrc.js';
-export { V as ValidateContext, b as ValidatePluginRecord, c as createValidatePlugin, i as isValidatePlugin, r as runValidatePlugins } from '../plugin-BjJ7yjrc.js';
-import { V as VerifyConfigInput, H as HasKey, M as MakeOptional, b as OptionalKeysForTable, a as OnFailCallback, d as ProtectedKeysForTable } from '../types-_64SXyva.js';
-export { B as BaseConfigReturn, k as DMGeneric, D as DefaultValuesConfigData, l as DefaultValuesInput, E as ExtractDefaultValuesConfig, c as ExtractProtectedColumnsConfig, I as IndexConfigBaseOptions, j as IndexConfigEntry, N as NormalizedIndexConfig, O as OnFailArgs, P as Prettify, m as ProtectedColumnsInput, g as UniqueColumnConfigData, h as UniqueColumnConfigEntry, i as UniqueColumnConfigOptions, U as UniqueRowConfigData, e as UniqueRowConfigEntry, f as UniqueRowConfigOptions, n as normalizeIndexConfigEntry } from '../types-_64SXyva.js';
+import { c as createExtension$1, i as isExtension$1, r as runExtensions$1 } from '../verifyConfig-CTrtqMr_.js';
+export { d as Extension, E as ExtensionContext, a as ExtensionInput, b as ExtensionInputForSchema, e as ExtensionRecord, S as SchemaExtension, v as verifyConfig } from '../verifyConfig-CTrtqMr_.js';
+export { v as BaseConfigReturn, B as BuiltinConfigKey, C as ConfigRegistry, w as DMGeneric, D as DataModelForSchema, c as DefaultValuesConfigData, d as DefaultValuesConfigInput, k as DefaultValuesVerifyFn, m as ExtensionStyleVerifyFn, E as ExtractDefaultValuesConfig, g as ExtractProtectedColumnsConfig, H as HasKey, I as IndexConfigBaseOptions, u as IndexConfigEntry, M as MakeOptional, a as MutationCtxForSchema, N as NormalizedIndexConfig, O as OnFailArgs, b as OnFailCallback, f as OptionalKeysForTable, P as Prettify, e as ProtectedColumnsConfigData, l as ProtectedColumnsVerifyFn, h as ProtectedKeysForTable, q as UniqueColumnConfigData, r as UniqueColumnConfigEntry, s as UniqueColumnConfigOptions, U as UniqueRowConfigData, o as UniqueRowConfigEntry, p as UniqueRowConfigOptions, V as VerifyConfigInput, i as VerifyInsertInput, j as VerifyPatchInput, n as VerifyRegistry, t as normalizeIndexConfigEntry } from '../types-B8ZkLuJ2.js';
+import 'convex/server';
+import 'convex/values';
 
-/**
- * Extended config input that includes optional validate plugins
- */
-type VerifyConfigInputWithPlugins = VerifyConfigInput & {
-    /**
-     * Unique row validation config.
-     * Enforces uniqueness across multiple columns using composite indexes.
-     *
-     * Can also be added to the `plugins` array.
-     */
-    uniqueRow?: ValidatePlugin<"uniqueRow", any>;
-    /**
-     * Unique column validation config.
-     * Enforces uniqueness on single columns using indexes.
-     *
-     * Can also be added to the `plugins` array.
-     */
-    uniqueColumn?: ValidatePlugin<"uniqueColumn", any>;
-    /**
-     * Additional validate plugins to run after transforms.
-     * These plugins can validate data but don't affect input types.
-     *
-     * Built-in plugins (uniqueRow, uniqueColumn) can be added here
-     * as an alternative to using their dedicated config keys.
-     */
-    plugins?: ValidatePlugin[];
-};
-/**
- * Configure type-safe insert and patch functions with validation and transforms.
- *
- * @param schema - Your Convex schema definition
- * @param configs - Configuration object with transforms, configs, and plugins
- * @returns Object with `insert`, `patch`, and `dangerouslyPatch` functions
- *
- * @example
- * ```ts
- * import {
- *   verifyConfig,
- *   defaultValuesConfig,
- *   protectedColumnsConfig,
- *   uniqueRowConfig,
- *   uniqueColumnConfig,
- * } from 'convex-verify';
- * import schema from './schema';
- *
- * export const { insert, patch, dangerouslyPatch } = verifyConfig(schema, {
- *   // Type-affecting configs
- *   defaultValues: defaultValuesConfig(schema, () => ({
- *     posts: { status: 'draft', views: 0 },
- *   })),
- *   protectedColumns: protectedColumnsConfig(schema, {
- *     posts: ['authorId'],
- *   }),
- *
- *   // Built-in validation configs
- *   uniqueRow: uniqueRowConfig(schema, {
- *     posts: ['by_author_slug'],
- *   }),
- *   uniqueColumn: uniqueColumnConfig(schema, {
- *     users: ['by_email', 'by_username'],
- *   }),
- *
- *   // Custom/third-party plugins
- *   plugins: [myCustomPlugin()],
- * });
- * ```
- */
-declare const verifyConfig: <S extends GenericSchema, DataModel extends DataModelFromSchemaDefinition<SchemaDefinition<S, boolean>>, const VC extends VerifyConfigInputWithPlugins>(_schema: SchemaDefinition<S, boolean>, configs: VC) => {
-    insert: <const TN extends TableNamesInDataModel<DataModel>, const D extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, data: HasKey<VC, "defaultValues"> extends true ? MakeOptional<WithoutSystemFields<D>, OptionalKeysForTable<VC, TN> & keyof WithoutSystemFields<D>> : WithoutSystemFields<D>, options?: {
-        onFail?: OnFailCallback<D>;
-    }) => Promise<GenericId<TN>>;
-    patch: <const TN extends TableNamesInDataModel<DataModel>, const D_1 extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, id: GenericId<TN>, data: HasKey<VC, "protectedColumns"> extends true ? Omit<Partial<WithoutSystemFields<D_1>>, ProtectedKeysForTable<VC, TN> & keyof WithoutSystemFields<D_1>> : Partial<WithoutSystemFields<D_1>>, options?: {
-        onFail?: OnFailCallback<D_1>;
-    }) => Promise<void>;
-    dangerouslyPatch: <const TN extends TableNamesInDataModel<DataModel>, const D_2 extends DocumentByName<DataModel, TN>>(ctx: Omit<GenericMutationCtx<DataModel>, never>, tableName: TN, id: GenericId<TN>, data: Partial<WithoutSystemFields<D_2>>, options?: {
-        onFail?: OnFailCallback<D_2>;
-    }) => Promise<void>;
-    configs: VC;
+type ProtectedColumnsLike = Record<string, readonly PropertyKey[] | undefined>;
+declare const stripProtectedPatchColumns: <T extends Record<string, any>>(protectedColumns: ProtectedColumnsLike, tableName: string, data: T) => {
+    filteredData: T;
+    removedColumns: string[];
 };
 
-export { HasKey, MakeOptional, OnFailCallback, OptionalKeysForTable, ProtectedKeysForTable, ValidatePlugin, VerifyConfigInput, verifyConfig };
+declare const createExtension: typeof createExtension$1;
+declare const isExtension: typeof isExtension$1;
+declare const runExtensions: typeof runExtensions$1;
+
+export { createExtension, isExtension, runExtensions, stripProtectedPatchColumns };