convex-verify 0.1.0

package/dist/types-_64SXyva.d.mts

@@ -0,0 +1,151 @@
+import { DataModelFromSchemaDefinition, SchemaDefinition, 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> = {
+    uniqueColumn?: {
+        conflictingColumn: keyof D;
+        existingData: D;
+    };
+    uniqueRow?: {
+        existingData: D | null;
+    };
+    editableColumn?: {
+        removedColumns: string[];
+        filteredData: D;
+    };
+    requiredColumn?: {
+        missingColumn: keyof D;
+    };
+};
+type OnFailCallback<D> = (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 plugins 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 plugin that makes fields optional (affects types)
+ * - `protectedColumns`: Columns that cannot be patched (affects patch() types)
+ * - `plugins`: Array of validate plugins (use for uniqueRow, uniqueColumn, custom plugins, etc.)
+ */
+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-_64SXyva.d.ts

@@ -0,0 +1,151 @@
+import { DataModelFromSchemaDefinition, SchemaDefinition, 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> = {
+    uniqueColumn?: {
+        conflictingColumn: keyof D;
+        existingData: D;
+    };
+    uniqueRow?: {
+        existingData: D | null;
+    };
+    editableColumn?: {
+        removedColumns: string[];
+        filteredData: D;
+    };
+    requiredColumn?: {
+        missingColumn: keyof D;
+    };
+};
+type OnFailCallback<D> = (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 plugins 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 plugin that makes fields optional (affects types)
+ * - `protectedColumns`: Columns that cannot be patched (affects patch() types)
+ * - `plugins`: Array of validate plugins (use for uniqueRow, uniqueColumn, custom plugins, etc.)
+ */
+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/utils/index.d.mts

@@ -0,0 +1,36 @@
+import { SchemaDefinition, GenericSchema, DataModelFromSchemaDefinition, TableNamesInDataModel, DocumentByName } from 'convex/server';
+import { I as IndexConfigBaseOptions, U as UniqueRowConfigData, N as NormalizedIndexConfig } from '../types-_64SXyva.mjs';
+export { j as IndexConfigEntry, n as normalizeIndexConfigEntry } from '../types-_64SXyva.mjs';
+
+/**
+ * Get Table indexes helper
+ *
+ * Note: this is using an experimental API in convex-js
+ * https://github.com/get-convex/convex-js/commit/04c3b44cab54c4d2230cce9312bdff074d54ab04
+ */
+declare const getTableIndexes: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>>(schema: S, tableName: TN) => {
+    indexDescriptor: string;
+    fields: string[];
+}[];
+/**
+ * Generate column data from fields and data object
+ */
+declare const constructColumnData: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>, D extends Partial<DocumentByName<DataModel, TN>>>(fields: string[], data: D, { allowNullishValue, allOrNothing, }: {
+    allowNullishValue?: boolean;
+    allOrNothing?: boolean;
+}) => {
+    column: string;
+    value: DocumentByName<DataModel, TN>[string] | undefined;
+}[] | null;
+/**
+ * Construct index data from schema and config.
+ * Handles both string shorthand and full object config entries.
+ *
+ * @returns Array of normalized index configs with resolved field names from schema
+ */
+declare const constructIndexData: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>, Options extends IndexConfigBaseOptions = IndexConfigBaseOptions>(schema: S, tableName: TN, indexConfig?: UniqueRowConfigData<DataModel>) => (NormalizedIndexConfig<Options> & {
+    name: string;
+    fields: string[];
+})[] | undefined;
+
+export { IndexConfigBaseOptions, NormalizedIndexConfig, constructColumnData, constructIndexData, getTableIndexes };

package/dist/utils/index.d.ts

@@ -0,0 +1,36 @@
+import { SchemaDefinition, GenericSchema, DataModelFromSchemaDefinition, TableNamesInDataModel, DocumentByName } from 'convex/server';
+import { I as IndexConfigBaseOptions, U as UniqueRowConfigData, N as NormalizedIndexConfig } from '../types-_64SXyva.js';
+export { j as IndexConfigEntry, n as normalizeIndexConfigEntry } from '../types-_64SXyva.js';
+
+/**
+ * Get Table indexes helper
+ *
+ * Note: this is using an experimental API in convex-js
+ * https://github.com/get-convex/convex-js/commit/04c3b44cab54c4d2230cce9312bdff074d54ab04
+ */
+declare const getTableIndexes: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>>(schema: S, tableName: TN) => {
+    indexDescriptor: string;
+    fields: string[];
+}[];
+/**
+ * Generate column data from fields and data object
+ */
+declare const constructColumnData: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>, D extends Partial<DocumentByName<DataModel, TN>>>(fields: string[], data: D, { allowNullishValue, allOrNothing, }: {
+    allowNullishValue?: boolean;
+    allOrNothing?: boolean;
+}) => {
+    column: string;
+    value: DocumentByName<DataModel, TN>[string] | undefined;
+}[] | null;
+/**
+ * Construct index data from schema and config.
+ * Handles both string shorthand and full object config entries.
+ *
+ * @returns Array of normalized index configs with resolved field names from schema
+ */
+declare const constructIndexData: <S extends SchemaDefinition<GenericSchema, boolean>, DataModel extends DataModelFromSchemaDefinition<S>, TN extends TableNamesInDataModel<DataModel>, Options extends IndexConfigBaseOptions = IndexConfigBaseOptions>(schema: S, tableName: TN, indexConfig?: UniqueRowConfigData<DataModel>) => (NormalizedIndexConfig<Options> & {
+    name: string;
+    fields: string[];
+})[] | undefined;
+
+export { IndexConfigBaseOptions, NormalizedIndexConfig, constructColumnData, constructIndexData, getTableIndexes };

package/dist/utils/index.js

@@ -0,0 +1,113 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/utils/index.ts
+var utils_exports = {};
+__export(utils_exports, {
+  constructColumnData: () => constructColumnData,
+  constructIndexData: () => constructIndexData,
+  getTableIndexes: () => getTableIndexes,
+  normalizeIndexConfigEntry: () => normalizeIndexConfigEntry
+});
+module.exports = __toCommonJS(utils_exports);
+
+// src/core/types.ts
+function normalizeIndexConfigEntry(entry, defaultIdentifiers = ["_id"]) {
+  if (typeof entry === "string") {
+    return {
+      index: entry,
+      identifiers: defaultIdentifiers
+    };
+  }
+  const { index, identifiers, ...rest } = entry;
+  return {
+    index: String(index),
+    identifiers: identifiers?.map(String) ?? defaultIdentifiers,
+    ...rest
+  };
+}
+
+// src/utils/helpers.ts
+var getTableIndexes = (schema, tableName) => {
+  return schema.tables[tableName][" indexes"]();
+};
+var constructColumnData = (fields, data, {
+  allowNullishValue = false,
+  allOrNothing = true
+}) => {
+  const lengthOfFields = fields.length;
+  const columnData = fields.map((_, index) => {
+    const column = fields?.[index];
+    const value = data?.[column];
+    if (!column || !allowNullishValue && !value) {
+      return;
+    }
+    return {
+      column,
+      value
+    };
+  }).filter((e) => !!e);
+  if (allOrNothing && columnData.length !== lengthOfFields) {
+    console.warn(
+      "The index was NOT supplied with the same amount data as there was fields. This warning only appears when setting `allOrNothing` to `true`.",
+      "`fields: `",
+      fields,
+      "`columnData: `",
+      columnData
+    );
+    return null;
+  }
+  return columnData.length > 0 ? columnData : null;
+};
+var constructIndexData = (schema, tableName, indexConfig) => {
+  if (!indexConfig) {
+    return;
+  }
+  const tableConfig = indexConfig?.[tableName];
+  if (!tableConfig) {
+    return;
+  }
+  return tableConfig.map((entry) => {
+    const normalized = normalizeIndexConfigEntry(entry);
+    const { index, identifiers, ...rest } = normalized;
+    const fields = getTableIndexes(schema, tableName).find(
+      (i) => i.indexDescriptor == index
+    )?.fields;
+    if (!fields) {
+      throw new Error(`Error in 'constructIndexData()'. No fields found for index: [${index}]`);
+    }
+    const identifierMap = new Map(
+      [...identifiers, "_id"].map((i) => [String(i), String(i)])
+    );
+    return {
+      name: index,
+      fields,
+      identifiers: Array.from(identifierMap.values()),
+      ...rest
+    };
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  constructColumnData,
+  constructIndexData,
+  getTableIndexes,
+  normalizeIndexConfigEntry
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/index.ts","../../src/core/types.ts","../../src/utils/helpers.ts"],"sourcesContent":["export { getTableIndexes, constructColumnData, constructIndexData } from './helpers';\n\n// Re-export types from core for convenience\nexport { normalizeIndexConfigEntry } from '../core/types';\nexport type {\n\tNormalizedIndexConfig,\n\tIndexConfigBaseOptions,\n\tIndexConfigEntry,\n} from '../core/types';\n","import {\n\tDataModelFromSchemaDefinition,\n\tIndexes,\n\tNamedTableInfo,\n\tSchemaDefinition,\n\tWithoutSystemFields,\n} from 'convex/server';\n\n// =============================================================================\n// Utility Types\n// =============================================================================\n\nexport type Prettify<T> = { [K in keyof T]: T[K] } & {};\n\nexport type MakeOptional<T, K extends PropertyKey> = Prettify<\n\tOmit<T, K & keyof T> & Partial<Pick<T, K & keyof T>>\n>;\n\n// =============================================================================\n// Base Types for Config Functions\n// =============================================================================\n\n/**\n * Base interface that all config functions should return.\n * Each config type can have its own `verify` signature and additional properties.\n */\nexport type BaseConfigReturn = {\n\tconfig: Record<string, any>;\n};\n\n// =============================================================================\n// OnFail Types\n// =============================================================================\n\nexport type OnFailArgs<D> = {\n\tuniqueColumn?: {\n\t\tconflictingColumn: keyof D;\n\t\texistingData: D;\n\t};\n\tuniqueRow?: {\n\t\texistingData: D | null;\n\t};\n\teditableColumn?: {\n\t\tremovedColumns: string[];\n\t\tfilteredData: D;\n\t};\n\trequiredColumn?: {\n\t\tmissingColumn: keyof D;\n\t};\n};\n\nexport type OnFailCallback<D> = (args: OnFailArgs<D>) => void;\n\n// =============================================================================\n// Config Data Types (what the user provides)\n// =============================================================================\n\nexport type DMGeneric = DataModelFromSchemaDefinition<SchemaDefinition<any, boolean>>;\n\nexport type DefaultValuesConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: {\n\t\t[column in keyof WithoutSystemFields<DM[K]['document']>]?: DM[K]['document'][column];\n\t};\n};\n\n// =============================================================================\n// Index-Based Config Types (shared between uniqueRow, uniqueColumn, etc.)\n// =============================================================================\n\n/**\n * Base options shared by all index-based config entries.\n * Individual plugins can extend this with their own options.\n */\nexport type IndexConfigBaseOptions = {\n\t/** Additional identifiers to check if the existing row is the same document being updated */\n\tidentifiers?: string[];\n};\n\n/**\n * A config entry that can be either:\n * - A string (index name) for shorthand\n * - An object with `index` and additional options\n *\n * @example\n * ```ts\n * // These are equivalent:\n * 'by_username'\n * { index: 'by_username' }\n *\n * // With options:\n * { index: 'by_username', identifiers: ['_id', 'userId'] }\n * ```\n */\nexport type IndexConfigEntry<\n\tDM extends DMGeneric,\n\tK extends keyof DM,\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n> =\n\t| keyof Indexes<NamedTableInfo<DM, K>>\n\t| ({\n\t\t\tindex: keyof Indexes<NamedTableInfo<DM, K>>;\n\t\t\tidentifiers?: (keyof NamedTableInfo<DM, K>['document'])[];\n\t  } & Omit<Options, 'identifiers'>);\n\n/**\n * Normalized form of an index config entry (always an object)\n */\nexport type NormalizedIndexConfig<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> =\n\t{\n\t\tindex: string;\n\t\tidentifiers: string[];\n\t} & Omit<Options, 'identifiers'>;\n\n/**\n * Normalize a config entry to always have index and identifiers.\n * Works for both string shorthand and full object configs.\n */\nexport function normalizeIndexConfigEntry<\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n>(\n\tentry: string | ({ index: string; identifiers?: string[] } & Omit<Options, 'identifiers'>),\n\tdefaultIdentifiers: string[] = ['_id']\n): NormalizedIndexConfig<Options> {\n\tif (typeof entry === 'string') {\n\t\treturn {\n\t\t\tindex: entry,\n\t\t\tidentifiers: defaultIdentifiers,\n\t\t} as NormalizedIndexConfig<Options>;\n\t}\n\n\tconst { index, identifiers, ...rest } = entry;\n\treturn {\n\t\tindex: String(index),\n\t\tidentifiers: identifiers?.map(String) ?? defaultIdentifiers,\n\t\t...rest,\n\t} as NormalizedIndexConfig<Options>;\n}\n\n// =============================================================================\n// UniqueRow Config Types\n// =============================================================================\n\nexport type UniqueRowConfigOptions = IndexConfigBaseOptions & {\n\tqueryExistingWithNullish?: boolean;\n};\n\nexport type UniqueRowConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<\n\tDM,\n\tK,\n\tUniqueRowConfigOptions\n>;\n\nexport type UniqueRowConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: UniqueRowConfigEntry<DM, K>[];\n};\n\n// =============================================================================\n// UniqueColumn Config Types\n// =============================================================================\n\nexport type UniqueColumnConfigOptions = IndexConfigBaseOptions;\n\nexport type UniqueColumnConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<\n\tDM,\n\tK,\n\tUniqueColumnConfigOptions\n>;\n\nexport type UniqueColumnConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: UniqueColumnConfigEntry<DM, K>[];\n};\n\n// =============================================================================\n// Input Types (loose types for verifyConfig to accept)\n// =============================================================================\n\n/**\n * Loose input types that accept any return from config functions.\n * We use loose types here to avoid complex generic matching,\n * then extract the specific config types using conditional types.\n */\nexport type DefaultValuesInput = {\n\t_type: 'defaultValues';\n\tverify: (tableName: any, data: any) => Promise<any>;\n\tconfig:\n\t\t| Record<string, Record<string, any>>\n\t\t| (() => Record<string, Record<string, any>> | Promise<Record<string, Record<string, any>>>);\n};\n\n/**\n * Loose input type for protectedColumnsConfig return value.\n */\nexport type ProtectedColumnsInput = {\n\t_type: 'protectedColumns';\n\tconfig: Record<string, string[]>;\n};\n\n// =============================================================================\n// Object-Based Types (for verifyConfig)\n// =============================================================================\n\n/**\n * Config input for verifyConfig.\n *\n * - `defaultValues`: Transform plugin that makes fields optional (affects types)\n * - `protectedColumns`: Columns that cannot be patched (affects patch() types)\n * - `plugins`: Array of validate plugins (use for uniqueRow, uniqueColumn, custom plugins, etc.)\n */\nexport type VerifyConfigInput = {\n\tdefaultValues?: DefaultValuesInput;\n\tprotectedColumns?: ProtectedColumnsInput;\n};\n\n// =============================================================================\n// Type Extraction Helpers\n// =============================================================================\n\n/**\n * Extract the config type from defaultValues.config.\n * Handles both direct object and function forms.\n */\nexport type ExtractDefaultValuesConfig<VC> = VC extends {\n\tdefaultValues: { config: infer C };\n}\n\t? C extends () => infer R\n\t\t? Awaited<R>\n\t\t: C\n\t: Record<string, never>;\n\n/**\n * Compute which keys should be optional for a given table based on all configs.\n * Currently only defaultValues affects optionality.\n */\nexport type OptionalKeysForTable<VC, TN> = TN extends keyof ExtractDefaultValuesConfig<VC>\n\t? keyof ExtractDefaultValuesConfig<VC>[TN]\n\t: never;\n\n/**\n * Helper to check if a key exists in a type\n */\nexport type HasKey<T, K extends PropertyKey> = K extends keyof T ? true : false;\n\n// =============================================================================\n// Protected Columns Type Extraction\n// =============================================================================\n\n/**\n * Extract the config type from protectedColumns.config\n */\nexport type ExtractProtectedColumnsConfig<VC> = VC extends {\n\tprotectedColumns: { config: infer C };\n}\n\t? C\n\t: Record<string, never>;\n\n/**\n * Get protected column keys for a specific table.\n * Returns the column names that should be omitted from patch() input.\n */\nexport type ProtectedKeysForTable<VC, TN> = TN extends keyof ExtractProtectedColumnsConfig<VC>\n\t? ExtractProtectedColumnsConfig<VC>[TN] extends readonly (infer K)[]\n\t\t? K\n\t\t: never\n\t: never;\n","import {\n\tDataModelFromSchemaDefinition,\n\tDocumentByName,\n\tGenericSchema,\n\tSchemaDefinition,\n\tTableNamesInDataModel,\n} from 'convex/server';\n\nimport {\n\tIndexConfigBaseOptions,\n\tNormalizedIndexConfig,\n\tnormalizeIndexConfigEntry,\n\tUniqueRowConfigData,\n} from '../core/types';\n\n/**\n * Get Table indexes helper\n *\n * Note: this is using an experimental API in convex-js\n * https://github.com/get-convex/convex-js/commit/04c3b44cab54c4d2230cce9312bdff074d54ab04\n */\nexport const getTableIndexes = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n>(\n\tschema: S,\n\ttableName: TN\n) => {\n\treturn schema.tables[tableName][' indexes']();\n};\n\n/**\n * Generate column data from fields and data object\n */\nexport const constructColumnData = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n\tD extends Partial<DocumentByName<DataModel, TN>>,\n>(\n\tfields: string[],\n\tdata: D,\n\t{\n\t\tallowNullishValue = false,\n\t\tallOrNothing = true,\n\t}: {\n\t\tallowNullishValue?: boolean;\n\t\tallOrNothing?: boolean;\n\t}\n) => {\n\tconst lengthOfFields = fields.length;\n\n\tconst columnData = fields\n\t\t.map((_, index) => {\n\t\t\tconst column = fields?.[index];\n\t\t\tconst value = data?.[column];\n\n\t\t\tif (!column || (!allowNullishValue && !value)) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\tcolumn,\n\t\t\t\tvalue,\n\t\t\t};\n\t\t})\n\t\t.filter((e) => !!e);\n\n\tif (allOrNothing && columnData.length !== lengthOfFields) {\n\t\tconsole.warn(\n\t\t\t'The index was NOT supplied with the same amount data as there was fields. This warning only appears when setting `allOrNothing` to `true`.',\n\t\t\t'`fields: `',\n\t\t\tfields,\n\t\t\t'`columnData: `',\n\t\t\tcolumnData\n\t\t);\n\t\treturn null;\n\t}\n\n\treturn columnData.length > 0 ? columnData : null;\n};\n\n/**\n * Construct index data from schema and config.\n * Handles both string shorthand and full object config entries.\n *\n * @returns Array of normalized index configs with resolved field names from schema\n */\nexport const constructIndexData = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n>(\n\tschema: S,\n\ttableName: TN,\n\tindexConfig?: UniqueRowConfigData<DataModel>\n): (NormalizedIndexConfig<Options> & { name: string; fields: string[] })[] | undefined => {\n\tif (!indexConfig) {\n\t\treturn;\n\t}\n\n\tconst tableConfig = indexConfig?.[tableName];\n\tif (!tableConfig) {\n\t\treturn;\n\t}\n\n\treturn tableConfig.map((entry) => {\n\t\t// Normalize the entry (handles both string and object forms)\n\t\tconst normalized = normalizeIndexConfigEntry<Options>(entry as any);\n\t\tconst { index, identifiers, ...rest } = normalized;\n\n\t\tconst fields = getTableIndexes(schema, tableName).find(\n\t\t\t(i) => i.indexDescriptor == index\n\t\t)?.fields;\n\n\t\tif (!fields) {\n\t\t\tthrow new Error(`Error in 'constructIndexData()'. No fields found for index: [${index}]`);\n\t\t}\n\n\t\t// Create a unique map in case there is any overlap in identifiers\n\t\t// Always include '_id' as a fallback identifier\n\t\tconst identifierMap = new Map<string, string>(\n\t\t\t[...identifiers, '_id'].map((i) => [String(i), String(i)])\n\t\t);\n\n\t\treturn {\n\t\t\tname: index,\n\t\t\tfields,\n\t\t\tidentifiers: Array.from(identifierMap.values()),\n\t\t\t...rest,\n\t\t} as NormalizedIndexConfig<Options> & { name: string; fields: string[] };\n\t});\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACqHO,SAAS,0BAGf,OACA,qBAA+B,CAAC,KAAK,GACJ;AACjC,MAAI,OAAO,UAAU,UAAU;AAC9B,WAAO;AAAA,MACN,OAAO;AAAA,MACP,aAAa;AAAA,IACd;AAAA,EACD;AAEA,QAAM,EAAE,OAAO,aAAa,GAAG,KAAK,IAAI;AACxC,SAAO;AAAA,IACN,OAAO,OAAO,KAAK;AAAA,IACnB,aAAa,aAAa,IAAI,MAAM,KAAK;AAAA,IACzC,GAAG;AAAA,EACJ;AACD;;;ACnHO,IAAM,kBAAkB,CAK9B,QACA,cACI;AACJ,SAAO,OAAO,OAAO,SAAS,EAAE,UAAU,EAAE;AAC7C;AAKO,IAAM,sBAAsB,CAMlC,QACA,MACA;AAAA,EACC,oBAAoB;AAAA,EACpB,eAAe;AAChB,MAII;AACJ,QAAM,iBAAiB,OAAO;AAE9B,QAAM,aAAa,OACjB,IAAI,CAAC,GAAG,UAAU;AAClB,UAAM,SAAS,SAAS,KAAK;AAC7B,UAAM,QAAQ,OAAO,MAAM;AAE3B,QAAI,CAAC,UAAW,CAAC,qBAAqB,CAAC,OAAQ;AAC9C;AAAA,IACD;AAEA,WAAO;AAAA,MACN;AAAA,MACA;AAAA,IACD;AAAA,EACD,CAAC,EACA,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAEnB,MAAI,gBAAgB,WAAW,WAAW,gBAAgB;AACzD,YAAQ;AAAA,MACP;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD;AACA,WAAO;AAAA,EACR;AAEA,SAAO,WAAW,SAAS,IAAI,aAAa;AAC7C;AAQO,IAAM,qBAAqB,CAMjC,QACA,WACA,gBACyF;AACzF,MAAI,CAAC,aAAa;AACjB;AAAA,EACD;AAEA,QAAM,cAAc,cAAc,SAAS;AAC3C,MAAI,CAAC,aAAa;AACjB;AAAA,EACD;AAEA,SAAO,YAAY,IAAI,CAAC,UAAU;AAEjC,UAAM,aAAa,0BAAmC,KAAY;AAClE,UAAM,EAAE,OAAO,aAAa,GAAG,KAAK,IAAI;AAExC,UAAM,SAAS,gBAAgB,QAAQ,SAAS,EAAE;AAAA,MACjD,CAAC,MAAM,EAAE,mBAAmB;AAAA,IAC7B,GAAG;AAEH,QAAI,CAAC,QAAQ;AACZ,YAAM,IAAI,MAAM,gEAAgE,KAAK,GAAG;AAAA,IACzF;AAIA,UAAM,gBAAgB,IAAI;AAAA,MACzB,CAAC,GAAG,aAAa,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;AAAA,IAC1D;AAEA,WAAO;AAAA,MACN,MAAM;AAAA,MACN;AAAA,MACA,aAAa,MAAM,KAAK,cAAc,OAAO,CAAC;AAAA,MAC9C,GAAG;AAAA,IACJ;AAAA,EACD,CAAC;AACF;","names":[]}

package/dist/utils/index.mjs

@@ -0,0 +1,83 @@
+// src/core/types.ts
+function normalizeIndexConfigEntry(entry, defaultIdentifiers = ["_id"]) {
+  if (typeof entry === "string") {
+    return {
+      index: entry,
+      identifiers: defaultIdentifiers
+    };
+  }
+  const { index, identifiers, ...rest } = entry;
+  return {
+    index: String(index),
+    identifiers: identifiers?.map(String) ?? defaultIdentifiers,
+    ...rest
+  };
+}
+
+// src/utils/helpers.ts
+var getTableIndexes = (schema, tableName) => {
+  return schema.tables[tableName][" indexes"]();
+};
+var constructColumnData = (fields, data, {
+  allowNullishValue = false,
+  allOrNothing = true
+}) => {
+  const lengthOfFields = fields.length;
+  const columnData = fields.map((_, index) => {
+    const column = fields?.[index];
+    const value = data?.[column];
+    if (!column || !allowNullishValue && !value) {
+      return;
+    }
+    return {
+      column,
+      value
+    };
+  }).filter((e) => !!e);
+  if (allOrNothing && columnData.length !== lengthOfFields) {
+    console.warn(
+      "The index was NOT supplied with the same amount data as there was fields. This warning only appears when setting `allOrNothing` to `true`.",
+      "`fields: `",
+      fields,
+      "`columnData: `",
+      columnData
+    );
+    return null;
+  }
+  return columnData.length > 0 ? columnData : null;
+};
+var constructIndexData = (schema, tableName, indexConfig) => {
+  if (!indexConfig) {
+    return;
+  }
+  const tableConfig = indexConfig?.[tableName];
+  if (!tableConfig) {
+    return;
+  }
+  return tableConfig.map((entry) => {
+    const normalized = normalizeIndexConfigEntry(entry);
+    const { index, identifiers, ...rest } = normalized;
+    const fields = getTableIndexes(schema, tableName).find(
+      (i) => i.indexDescriptor == index
+    )?.fields;
+    if (!fields) {
+      throw new Error(`Error in 'constructIndexData()'. No fields found for index: [${index}]`);
+    }
+    const identifierMap = new Map(
+      [...identifiers, "_id"].map((i) => [String(i), String(i)])
+    );
+    return {
+      name: index,
+      fields,
+      identifiers: Array.from(identifierMap.values()),
+      ...rest
+    };
+  });
+};
+export {
+  constructColumnData,
+  constructIndexData,
+  getTableIndexes,
+  normalizeIndexConfigEntry
+};
+//# sourceMappingURL=index.mjs.map

package/dist/utils/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/types.ts","../../src/utils/helpers.ts"],"sourcesContent":["import {\n\tDataModelFromSchemaDefinition,\n\tIndexes,\n\tNamedTableInfo,\n\tSchemaDefinition,\n\tWithoutSystemFields,\n} from 'convex/server';\n\n// =============================================================================\n// Utility Types\n// =============================================================================\n\nexport type Prettify<T> = { [K in keyof T]: T[K] } & {};\n\nexport type MakeOptional<T, K extends PropertyKey> = Prettify<\n\tOmit<T, K & keyof T> & Partial<Pick<T, K & keyof T>>\n>;\n\n// =============================================================================\n// Base Types for Config Functions\n// =============================================================================\n\n/**\n * Base interface that all config functions should return.\n * Each config type can have its own `verify` signature and additional properties.\n */\nexport type BaseConfigReturn = {\n\tconfig: Record<string, any>;\n};\n\n// =============================================================================\n// OnFail Types\n// =============================================================================\n\nexport type OnFailArgs<D> = {\n\tuniqueColumn?: {\n\t\tconflictingColumn: keyof D;\n\t\texistingData: D;\n\t};\n\tuniqueRow?: {\n\t\texistingData: D | null;\n\t};\n\teditableColumn?: {\n\t\tremovedColumns: string[];\n\t\tfilteredData: D;\n\t};\n\trequiredColumn?: {\n\t\tmissingColumn: keyof D;\n\t};\n};\n\nexport type OnFailCallback<D> = (args: OnFailArgs<D>) => void;\n\n// =============================================================================\n// Config Data Types (what the user provides)\n// =============================================================================\n\nexport type DMGeneric = DataModelFromSchemaDefinition<SchemaDefinition<any, boolean>>;\n\nexport type DefaultValuesConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: {\n\t\t[column in keyof WithoutSystemFields<DM[K]['document']>]?: DM[K]['document'][column];\n\t};\n};\n\n// =============================================================================\n// Index-Based Config Types (shared between uniqueRow, uniqueColumn, etc.)\n// =============================================================================\n\n/**\n * Base options shared by all index-based config entries.\n * Individual plugins can extend this with their own options.\n */\nexport type IndexConfigBaseOptions = {\n\t/** Additional identifiers to check if the existing row is the same document being updated */\n\tidentifiers?: string[];\n};\n\n/**\n * A config entry that can be either:\n * - A string (index name) for shorthand\n * - An object with `index` and additional options\n *\n * @example\n * ```ts\n * // These are equivalent:\n * 'by_username'\n * { index: 'by_username' }\n *\n * // With options:\n * { index: 'by_username', identifiers: ['_id', 'userId'] }\n * ```\n */\nexport type IndexConfigEntry<\n\tDM extends DMGeneric,\n\tK extends keyof DM,\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n> =\n\t| keyof Indexes<NamedTableInfo<DM, K>>\n\t| ({\n\t\t\tindex: keyof Indexes<NamedTableInfo<DM, K>>;\n\t\t\tidentifiers?: (keyof NamedTableInfo<DM, K>['document'])[];\n\t  } & Omit<Options, 'identifiers'>);\n\n/**\n * Normalized form of an index config entry (always an object)\n */\nexport type NormalizedIndexConfig<Options extends IndexConfigBaseOptions = IndexConfigBaseOptions> =\n\t{\n\t\tindex: string;\n\t\tidentifiers: string[];\n\t} & Omit<Options, 'identifiers'>;\n\n/**\n * Normalize a config entry to always have index and identifiers.\n * Works for both string shorthand and full object configs.\n */\nexport function normalizeIndexConfigEntry<\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n>(\n\tentry: string | ({ index: string; identifiers?: string[] } & Omit<Options, 'identifiers'>),\n\tdefaultIdentifiers: string[] = ['_id']\n): NormalizedIndexConfig<Options> {\n\tif (typeof entry === 'string') {\n\t\treturn {\n\t\t\tindex: entry,\n\t\t\tidentifiers: defaultIdentifiers,\n\t\t} as NormalizedIndexConfig<Options>;\n\t}\n\n\tconst { index, identifiers, ...rest } = entry;\n\treturn {\n\t\tindex: String(index),\n\t\tidentifiers: identifiers?.map(String) ?? defaultIdentifiers,\n\t\t...rest,\n\t} as NormalizedIndexConfig<Options>;\n}\n\n// =============================================================================\n// UniqueRow Config Types\n// =============================================================================\n\nexport type UniqueRowConfigOptions = IndexConfigBaseOptions & {\n\tqueryExistingWithNullish?: boolean;\n};\n\nexport type UniqueRowConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<\n\tDM,\n\tK,\n\tUniqueRowConfigOptions\n>;\n\nexport type UniqueRowConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: UniqueRowConfigEntry<DM, K>[];\n};\n\n// =============================================================================\n// UniqueColumn Config Types\n// =============================================================================\n\nexport type UniqueColumnConfigOptions = IndexConfigBaseOptions;\n\nexport type UniqueColumnConfigEntry<DM extends DMGeneric, K extends keyof DM> = IndexConfigEntry<\n\tDM,\n\tK,\n\tUniqueColumnConfigOptions\n>;\n\nexport type UniqueColumnConfigData<DM extends DMGeneric> = {\n\t[K in keyof DM]?: UniqueColumnConfigEntry<DM, K>[];\n};\n\n// =============================================================================\n// Input Types (loose types for verifyConfig to accept)\n// =============================================================================\n\n/**\n * Loose input types that accept any return from config functions.\n * We use loose types here to avoid complex generic matching,\n * then extract the specific config types using conditional types.\n */\nexport type DefaultValuesInput = {\n\t_type: 'defaultValues';\n\tverify: (tableName: any, data: any) => Promise<any>;\n\tconfig:\n\t\t| Record<string, Record<string, any>>\n\t\t| (() => Record<string, Record<string, any>> | Promise<Record<string, Record<string, any>>>);\n};\n\n/**\n * Loose input type for protectedColumnsConfig return value.\n */\nexport type ProtectedColumnsInput = {\n\t_type: 'protectedColumns';\n\tconfig: Record<string, string[]>;\n};\n\n// =============================================================================\n// Object-Based Types (for verifyConfig)\n// =============================================================================\n\n/**\n * Config input for verifyConfig.\n *\n * - `defaultValues`: Transform plugin that makes fields optional (affects types)\n * - `protectedColumns`: Columns that cannot be patched (affects patch() types)\n * - `plugins`: Array of validate plugins (use for uniqueRow, uniqueColumn, custom plugins, etc.)\n */\nexport type VerifyConfigInput = {\n\tdefaultValues?: DefaultValuesInput;\n\tprotectedColumns?: ProtectedColumnsInput;\n};\n\n// =============================================================================\n// Type Extraction Helpers\n// =============================================================================\n\n/**\n * Extract the config type from defaultValues.config.\n * Handles both direct object and function forms.\n */\nexport type ExtractDefaultValuesConfig<VC> = VC extends {\n\tdefaultValues: { config: infer C };\n}\n\t? C extends () => infer R\n\t\t? Awaited<R>\n\t\t: C\n\t: Record<string, never>;\n\n/**\n * Compute which keys should be optional for a given table based on all configs.\n * Currently only defaultValues affects optionality.\n */\nexport type OptionalKeysForTable<VC, TN> = TN extends keyof ExtractDefaultValuesConfig<VC>\n\t? keyof ExtractDefaultValuesConfig<VC>[TN]\n\t: never;\n\n/**\n * Helper to check if a key exists in a type\n */\nexport type HasKey<T, K extends PropertyKey> = K extends keyof T ? true : false;\n\n// =============================================================================\n// Protected Columns Type Extraction\n// =============================================================================\n\n/**\n * Extract the config type from protectedColumns.config\n */\nexport type ExtractProtectedColumnsConfig<VC> = VC extends {\n\tprotectedColumns: { config: infer C };\n}\n\t? C\n\t: Record<string, never>;\n\n/**\n * Get protected column keys for a specific table.\n * Returns the column names that should be omitted from patch() input.\n */\nexport type ProtectedKeysForTable<VC, TN> = TN extends keyof ExtractProtectedColumnsConfig<VC>\n\t? ExtractProtectedColumnsConfig<VC>[TN] extends readonly (infer K)[]\n\t\t? K\n\t\t: never\n\t: never;\n","import {\n\tDataModelFromSchemaDefinition,\n\tDocumentByName,\n\tGenericSchema,\n\tSchemaDefinition,\n\tTableNamesInDataModel,\n} from 'convex/server';\n\nimport {\n\tIndexConfigBaseOptions,\n\tNormalizedIndexConfig,\n\tnormalizeIndexConfigEntry,\n\tUniqueRowConfigData,\n} from '../core/types';\n\n/**\n * Get Table indexes helper\n *\n * Note: this is using an experimental API in convex-js\n * https://github.com/get-convex/convex-js/commit/04c3b44cab54c4d2230cce9312bdff074d54ab04\n */\nexport const getTableIndexes = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n>(\n\tschema: S,\n\ttableName: TN\n) => {\n\treturn schema.tables[tableName][' indexes']();\n};\n\n/**\n * Generate column data from fields and data object\n */\nexport const constructColumnData = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n\tD extends Partial<DocumentByName<DataModel, TN>>,\n>(\n\tfields: string[],\n\tdata: D,\n\t{\n\t\tallowNullishValue = false,\n\t\tallOrNothing = true,\n\t}: {\n\t\tallowNullishValue?: boolean;\n\t\tallOrNothing?: boolean;\n\t}\n) => {\n\tconst lengthOfFields = fields.length;\n\n\tconst columnData = fields\n\t\t.map((_, index) => {\n\t\t\tconst column = fields?.[index];\n\t\t\tconst value = data?.[column];\n\n\t\t\tif (!column || (!allowNullishValue && !value)) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\tcolumn,\n\t\t\t\tvalue,\n\t\t\t};\n\t\t})\n\t\t.filter((e) => !!e);\n\n\tif (allOrNothing && columnData.length !== lengthOfFields) {\n\t\tconsole.warn(\n\t\t\t'The index was NOT supplied with the same amount data as there was fields. This warning only appears when setting `allOrNothing` to `true`.',\n\t\t\t'`fields: `',\n\t\t\tfields,\n\t\t\t'`columnData: `',\n\t\t\tcolumnData\n\t\t);\n\t\treturn null;\n\t}\n\n\treturn columnData.length > 0 ? columnData : null;\n};\n\n/**\n * Construct index data from schema and config.\n * Handles both string shorthand and full object config entries.\n *\n * @returns Array of normalized index configs with resolved field names from schema\n */\nexport const constructIndexData = <\n\tS extends SchemaDefinition<GenericSchema, boolean>,\n\tDataModel extends DataModelFromSchemaDefinition<S>,\n\tTN extends TableNamesInDataModel<DataModel>,\n\tOptions extends IndexConfigBaseOptions = IndexConfigBaseOptions,\n>(\n\tschema: S,\n\ttableName: TN,\n\tindexConfig?: UniqueRowConfigData<DataModel>\n): (NormalizedIndexConfig<Options> & { name: string; fields: string[] })[] | undefined => {\n\tif (!indexConfig) {\n\t\treturn;\n\t}\n\n\tconst tableConfig = indexConfig?.[tableName];\n\tif (!tableConfig) {\n\t\treturn;\n\t}\n\n\treturn tableConfig.map((entry) => {\n\t\t// Normalize the entry (handles both string and object forms)\n\t\tconst normalized = normalizeIndexConfigEntry<Options>(entry as any);\n\t\tconst { index, identifiers, ...rest } = normalized;\n\n\t\tconst fields = getTableIndexes(schema, tableName).find(\n\t\t\t(i) => i.indexDescriptor == index\n\t\t)?.fields;\n\n\t\tif (!fields) {\n\t\t\tthrow new Error(`Error in 'constructIndexData()'. No fields found for index: [${index}]`);\n\t\t}\n\n\t\t// Create a unique map in case there is any overlap in identifiers\n\t\t// Always include '_id' as a fallback identifier\n\t\tconst identifierMap = new Map<string, string>(\n\t\t\t[...identifiers, '_id'].map((i) => [String(i), String(i)])\n\t\t);\n\n\t\treturn {\n\t\t\tname: index,\n\t\t\tfields,\n\t\t\tidentifiers: Array.from(identifierMap.values()),\n\t\t\t...rest,\n\t\t} as NormalizedIndexConfig<Options> & { name: string; fields: string[] };\n\t});\n};\n"],"mappings":";AAqHO,SAAS,0BAGf,OACA,qBAA+B,CAAC,KAAK,GACJ;AACjC,MAAI,OAAO,UAAU,UAAU;AAC9B,WAAO;AAAA,MACN,OAAO;AAAA,MACP,aAAa;AAAA,IACd;AAAA,EACD;AAEA,QAAM,EAAE,OAAO,aAAa,GAAG,KAAK,IAAI;AACxC,SAAO;AAAA,IACN,OAAO,OAAO,KAAK;AAAA,IACnB,aAAa,aAAa,IAAI,MAAM,KAAK;AAAA,IACzC,GAAG;AAAA,EACJ;AACD;;;ACnHO,IAAM,kBAAkB,CAK9B,QACA,cACI;AACJ,SAAO,OAAO,OAAO,SAAS,EAAE,UAAU,EAAE;AAC7C;AAKO,IAAM,sBAAsB,CAMlC,QACA,MACA;AAAA,EACC,oBAAoB;AAAA,EACpB,eAAe;AAChB,MAII;AACJ,QAAM,iBAAiB,OAAO;AAE9B,QAAM,aAAa,OACjB,IAAI,CAAC,GAAG,UAAU;AAClB,UAAM,SAAS,SAAS,KAAK;AAC7B,UAAM,QAAQ,OAAO,MAAM;AAE3B,QAAI,CAAC,UAAW,CAAC,qBAAqB,CAAC,OAAQ;AAC9C;AAAA,IACD;AAEA,WAAO;AAAA,MACN;AAAA,MACA;AAAA,IACD;AAAA,EACD,CAAC,EACA,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAEnB,MAAI,gBAAgB,WAAW,WAAW,gBAAgB;AACzD,YAAQ;AAAA,MACP;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD;AACA,WAAO;AAAA,EACR;AAEA,SAAO,WAAW,SAAS,IAAI,aAAa;AAC7C;AAQO,IAAM,qBAAqB,CAMjC,QACA,WACA,gBACyF;AACzF,MAAI,CAAC,aAAa;AACjB;AAAA,EACD;AAEA,QAAM,cAAc,cAAc,SAAS;AAC3C,MAAI,CAAC,aAAa;AACjB;AAAA,EACD;AAEA,SAAO,YAAY,IAAI,CAAC,UAAU;AAEjC,UAAM,aAAa,0BAAmC,KAAY;AAClE,UAAM,EAAE,OAAO,aAAa,GAAG,KAAK,IAAI;AAExC,UAAM,SAAS,gBAAgB,QAAQ,SAAS,EAAE;AAAA,MACjD,CAAC,MAAM,EAAE,mBAAmB;AAAA,IAC7B,GAAG;AAEH,QAAI,CAAC,QAAQ;AACZ,YAAM,IAAI,MAAM,gEAAgE,KAAK,GAAG;AAAA,IACzF;AAIA,UAAM,gBAAgB,IAAI;AAAA,MACzB,CAAC,GAAG,aAAa,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;AAAA,IAC1D;AAEA,WAAO;AAAA,MACN,MAAM;AAAA,MACN;AAAA,MACA,aAAa,MAAM,KAAK,cAAc,OAAO,CAAC;AAAA,MAC9C,GAAG;AAAA,IACJ;AAAA,EACD,CAAC;AACF;","names":[]}