convex-verify 1.1.0 → 1.2.2

package/dist/types-DvJMYubf.d.mts

@@ -1,151 +0,0 @@
-import { DataModelFromSchemaDefinition, SchemaDefinition, GenericDocument, WithoutSystemFields, Indexes, NamedTableInfo } from 'convex/server';
-
-type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type MakeOptional<T, K extends PropertyKey> = Prettify<Omit<T, K & keyof T> & Partial<Pick<T, K & keyof T>>>;
-/**
- * Base interface that all config functions should return.
- * Each config type can have its own `verify` signature and additional properties.
- */
-type BaseConfigReturn = {
-    config: Record<string, any>;
-};
-type OnFailArgs<D extends GenericDocument> = {
-    uniqueColumn?: {
-        conflictingColumn: keyof D;
-        existingData: D;
-    };
-    uniqueRow?: {
-        existingData: D | null;
-    };
-    editableColumn?: {
-        removedColumns: string[];
-        filteredData: Partial<WithoutSystemFields<D>>;
-    };
-    requiredColumn?: {
-        missingColumn: keyof D;
-    };
-};
-type OnFailCallback<D extends GenericDocument> = (args: OnFailArgs<D>) => void;
-type DMGeneric = DataModelFromSchemaDefinition<SchemaDefinition<any, boolean>>;
-type DefaultValuesConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: {
-        [column in keyof WithoutSystemFields<DM[K]['document']>]?: DM[K]['document'][column];
-    };
-};
-/**
- * Base options shared by all index-based config entries.
- * Individual extensions can extend this with their own options.
- */
-type IndexConfigBaseOptions = {
-    /** Additional identifiers to check if the existing row is the same document being updated */
-    identifiers?: string[];
-};
-/**
- * A config entry that can be either:
- * - A string (index name) for shorthand
- * - An object with `index` and additional options
- *
- * @example
- * ```ts
- * // These are equivalent:
- * 'by_username'
- * { index: 'by_username' }
- *
- * // With options:
- * { index: 'by_username', identifiers: ['_id', 'userId'] }
- * ```
- */
-type IndexConfigEntry<DM extends DMGeneric, K extends keyof DM, Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> = keyof Indexes<NamedTableInfo<DM, K>> | ({
-    index: keyof Indexes<NamedTableInfo<DM, K>>;
-    identifiers?: (keyof NamedTableInfo<DM, K>['document'])[];
-} & Omit<Options, 'identifiers'>);
-/**
- * Normalized form of an index config entry (always an object)
- */
-type NormalizedIndexConfig<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> = {
-    index: string;
-    identifiers: string[];
-} & Omit<Options, 'identifiers'>;
-/**
- * Normalize a config entry to always have index and identifiers.
- * Works for both string shorthand and full object configs.
- */
-declare function normalizeIndexConfigEntry<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions>(entry: string | ({
-    index: string;
-    identifiers?: string[];
-} & Omit<Options, 'identifiers'>), defaultIdentifiers?: string[]): NormalizedIndexConfig<Options>;
-type UniqueRowConfigOptions = IndexConfigBaseOptions & {
-    queryExistingWithNullish?: boolean;
-};
-type UniqueRowConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<DM, K, UniqueRowConfigOptions>;
-type UniqueRowConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: UniqueRowConfigEntry<DM, K>[];
-};
-type UniqueColumnConfigOptions = IndexConfigBaseOptions;
-type UniqueColumnConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<DM, K, UniqueColumnConfigOptions>;
-type UniqueColumnConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: UniqueColumnConfigEntry<DM, K>[];
-};
-/**
- * Loose input types that accept any return from config functions.
- * We use loose types here to avoid complex generic matching,
- * then extract the specific config types using conditional types.
- */
-type DefaultValuesInput = {
-    _type: 'defaultValues';
-    verify: (tableName: any, data: any) => Promise<any>;
-    config: Record<string, Record<string, any>> | (() => Record<string, Record<string, any>> | Promise<Record<string, Record<string, any>>>);
-};
-/**
- * Loose input type for protectedColumnsConfig return value.
- */
-type ProtectedColumnsInput = {
-    _type: 'protectedColumns';
-    config: Record<string, string[]>;
-};
-/**
- * Config input for verifyConfig.
- *
- * - `defaultValues`: Transform config that makes fields optional (affects types)
- * - `protectedColumns`: Columns that cannot be patched (affects patch() types)
- * Extension-specific options are added by `verifyConfig`.
- */
-type VerifyConfigInput = {
-    defaultValues?: DefaultValuesInput;
-    protectedColumns?: ProtectedColumnsInput;
-};
-/**
- * Extract the config type from defaultValues.config.
- * Handles both direct object and function forms.
- */
-type ExtractDefaultValuesConfig<VC> = VC extends {
-    defaultValues: {
-        config: infer C;
-    };
-} ? C extends () => infer R ? Awaited<R> : C : Record<string, never>;
-/**
- * Compute which keys should be optional for a given table based on all configs.
- * Currently only defaultValues affects optionality.
- */
-type OptionalKeysForTable<VC, TN> = TN extends keyof ExtractDefaultValuesConfig<VC> ? keyof ExtractDefaultValuesConfig<VC>[TN] : never;
-/**
- * Helper to check if a key exists in a type
- */
-type HasKey<T, K extends PropertyKey> = K extends keyof T ? true : false;
-/**
- * Extract the config type from protectedColumns.config
- */
-type ExtractProtectedColumnsConfig<VC> = VC extends {
-    protectedColumns: {
-        config: infer C;
-    };
-} ? C : Record<string, never>;
-/**
- * Get protected column keys for a specific table.
- * Returns the column names that should be omitted from patch() input.
- */
-type ProtectedKeysForTable<VC, TN> = TN extends keyof ExtractProtectedColumnsConfig<VC> ? ExtractProtectedColumnsConfig<VC>[TN] extends readonly (infer K)[] ? K : never : never;
-
-export { type BaseConfigReturn as B, type DefaultValuesConfigData as D, type ExtractDefaultValuesConfig as E, type HasKey as H, type IndexConfigBaseOptions as I, type MakeOptional as M, type NormalizedIndexConfig as N, type OnFailArgs as O, type Prettify as P, type UniqueRowConfigData as U, type VerifyConfigInput as V, type OnFailCallback as a, type OptionalKeysForTable as b, type ExtractProtectedColumnsConfig as c, type ProtectedKeysForTable as d, type UniqueRowConfigEntry as e, type UniqueRowConfigOptions as f, type UniqueColumnConfigData as g, type UniqueColumnConfigEntry as h, type UniqueColumnConfigOptions as i, type IndexConfigEntry as j, type DMGeneric as k, type DefaultValuesInput as l, type ProtectedColumnsInput as m, normalizeIndexConfigEntry as n };

package/dist/types-DvJMYubf.d.ts

@@ -1,151 +0,0 @@
-import { DataModelFromSchemaDefinition, SchemaDefinition, GenericDocument, WithoutSystemFields, Indexes, NamedTableInfo } from 'convex/server';
-
-type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type MakeOptional<T, K extends PropertyKey> = Prettify<Omit<T, K & keyof T> & Partial<Pick<T, K & keyof T>>>;
-/**
- * Base interface that all config functions should return.
- * Each config type can have its own `verify` signature and additional properties.
- */
-type BaseConfigReturn = {
-    config: Record<string, any>;
-};
-type OnFailArgs<D extends GenericDocument> = {
-    uniqueColumn?: {
-        conflictingColumn: keyof D;
-        existingData: D;
-    };
-    uniqueRow?: {
-        existingData: D | null;
-    };
-    editableColumn?: {
-        removedColumns: string[];
-        filteredData: Partial<WithoutSystemFields<D>>;
-    };
-    requiredColumn?: {
-        missingColumn: keyof D;
-    };
-};
-type OnFailCallback<D extends GenericDocument> = (args: OnFailArgs<D>) => void;
-type DMGeneric = DataModelFromSchemaDefinition<SchemaDefinition<any, boolean>>;
-type DefaultValuesConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: {
-        [column in keyof WithoutSystemFields<DM[K]['document']>]?: DM[K]['document'][column];
-    };
-};
-/**
- * Base options shared by all index-based config entries.
- * Individual extensions can extend this with their own options.
- */
-type IndexConfigBaseOptions = {
-    /** Additional identifiers to check if the existing row is the same document being updated */
-    identifiers?: string[];
-};
-/**
- * A config entry that can be either:
- * - A string (index name) for shorthand
- * - An object with `index` and additional options
- *
- * @example
- * ```ts
- * // These are equivalent:
- * 'by_username'
- * { index: 'by_username' }
- *
- * // With options:
- * { index: 'by_username', identifiers: ['_id', 'userId'] }
- * ```
- */
-type IndexConfigEntry<DM extends DMGeneric, K extends keyof DM, Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> = keyof Indexes<NamedTableInfo<DM, K>> | ({
-    index: keyof Indexes<NamedTableInfo<DM, K>>;
-    identifiers?: (keyof NamedTableInfo<DM, K>['document'])[];
-} & Omit<Options, 'identifiers'>);
-/**
- * Normalized form of an index config entry (always an object)
- */
-type NormalizedIndexConfig<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> = {
-    index: string;
-    identifiers: string[];
-} & Omit<Options, 'identifiers'>;
-/**
- * Normalize a config entry to always have index and identifiers.
- * Works for both string shorthand and full object configs.
- */
-declare function normalizeIndexConfigEntry<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions>(entry: string | ({
-    index: string;
-    identifiers?: string[];
-} & Omit<Options, 'identifiers'>), defaultIdentifiers?: string[]): NormalizedIndexConfig<Options>;
-type UniqueRowConfigOptions = IndexConfigBaseOptions & {
-    queryExistingWithNullish?: boolean;
-};
-type UniqueRowConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<DM, K, UniqueRowConfigOptions>;
-type UniqueRowConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: UniqueRowConfigEntry<DM, K>[];
-};
-type UniqueColumnConfigOptions = IndexConfigBaseOptions;
-type UniqueColumnConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<DM, K, UniqueColumnConfigOptions>;
-type UniqueColumnConfigData<DM extends DMGeneric> = {
-    [K in keyof DM]?: UniqueColumnConfigEntry<DM, K>[];
-};
-/**
- * Loose input types that accept any return from config functions.
- * We use loose types here to avoid complex generic matching,
- * then extract the specific config types using conditional types.
- */
-type DefaultValuesInput = {
-    _type: 'defaultValues';
-    verify: (tableName: any, data: any) => Promise<any>;
-    config: Record<string, Record<string, any>> | (() => Record<string, Record<string, any>> | Promise<Record<string, Record<string, any>>>);
-};
-/**
- * Loose input type for protectedColumnsConfig return value.
- */
-type ProtectedColumnsInput = {
-    _type: 'protectedColumns';
-    config: Record<string, string[]>;
-};
-/**
- * Config input for verifyConfig.
- *
- * - `defaultValues`: Transform config that makes fields optional (affects types)
- * - `protectedColumns`: Columns that cannot be patched (affects patch() types)
- * Extension-specific options are added by `verifyConfig`.
- */
-type VerifyConfigInput = {
-    defaultValues?: DefaultValuesInput;
-    protectedColumns?: ProtectedColumnsInput;
-};
-/**
- * Extract the config type from defaultValues.config.
- * Handles both direct object and function forms.
- */
-type ExtractDefaultValuesConfig<VC> = VC extends {
-    defaultValues: {
-        config: infer C;
-    };
-} ? C extends () => infer R ? Awaited<R> : C : Record<string, never>;
-/**
- * Compute which keys should be optional for a given table based on all configs.
- * Currently only defaultValues affects optionality.
- */
-type OptionalKeysForTable<VC, TN> = TN extends keyof ExtractDefaultValuesConfig<VC> ? keyof ExtractDefaultValuesConfig<VC>[TN] : never;
-/**
- * Helper to check if a key exists in a type
- */
-type HasKey<T, K extends PropertyKey> = K extends keyof T ? true : false;
-/**
- * Extract the config type from protectedColumns.config
- */
-type ExtractProtectedColumnsConfig<VC> = VC extends {
-    protectedColumns: {
-        config: infer C;
-    };
-} ? C : Record<string, never>;
-/**
- * Get protected column keys for a specific table.
- * Returns the column names that should be omitted from patch() input.
- */
-type ProtectedKeysForTable<VC, TN> = TN extends keyof ExtractProtectedColumnsConfig<VC> ? ExtractProtectedColumnsConfig<VC>[TN] extends readonly (infer K)[] ? K : never : never;
-
-export { type BaseConfigReturn as B, type DefaultValuesConfigData as D, type ExtractDefaultValuesConfig as E, type HasKey as H, type IndexConfigBaseOptions as I, type MakeOptional as M, type NormalizedIndexConfig as N, type OnFailArgs as O, type Prettify as P, type UniqueRowConfigData as U, type VerifyConfigInput as V, type OnFailCallback as a, type OptionalKeysForTable as b, type ExtractProtectedColumnsConfig as c, type ProtectedKeysForTable as d, type UniqueRowConfigEntry as e, type UniqueRowConfigOptions as f, type UniqueColumnConfigData as g, type UniqueColumnConfigEntry as h, type UniqueColumnConfigOptions as i, type IndexConfigEntry as j, type DMGeneric as k, type DefaultValuesInput as l, type ProtectedColumnsInput as m, normalizeIndexConfigEntry as n };