convex-cms 0.0.15 → 0.0.16

package/admin/dist/types/src/component/lib/slugGenerator.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Slug Generator Utility
+ *
+ * Generates URL-friendly slugs from content titles.
+ * Handles special characters, unicode, and ensures slug format consistency.
+ */
+/**
+ * Options for slug generation
+ */
+export interface SlugOptions {
+    /** Maximum length of the generated slug (default: 100) */
+    maxLength?: number;
+    /** Separator character to use (default: '-') */
+    separator?: string;
+    /** Whether to lowercase the slug (default: true) */
+    lowercase?: boolean;
+    /** Custom replacements for specific characters */
+    customReplacements?: Record<string, string>;
+}
+/**
+ * Generates a URL-friendly slug from a given title string.
+ *
+ * @param title - The input string to convert to a slug
+ * @param options - Optional configuration for slug generation
+ * @returns A URL-friendly slug string
+ *
+ * @example
+ * ```typescript
+ * generateSlug("Hello World!") // "hello-world"
+ * generateSlug("Café & Restaurant") // "cafe-and-restaurant"
+ * generateSlug("日本語タイトル") // "ri-ben-yu-taitoru"
+ * generateSlug("  Multiple   Spaces  ") // "multiple-spaces"
+ * ```
+ */
+export declare function generateSlug(title: string, options?: SlugOptions): string;
+/**
+ * Validates if a string is a valid slug format
+ *
+ * @param slug - The string to validate
+ * @param separator - The separator character (default: '-')
+ * @returns True if the string is a valid slug
+ *
+ * @example
+ * ```typescript
+ * isValidSlug("hello-world") // true
+ * isValidSlug("Hello World") // false
+ * isValidSlug("hello--world") // false
+ * isValidSlug("-hello-world") // false
+ * ```
+ */
+export declare function isValidSlug(slug: string, separator?: string): boolean;
+/**
+ * Generates a unique slug by appending a numeric suffix if needed.
+ * This is a helper that can be used with a uniqueness check function.
+ *
+ * @param baseSlug - The base slug to make unique
+ * @param isUnique - Async function that checks if a slug is unique
+ * @param maxAttempts - Maximum number of suffix attempts (default: 100)
+ * @returns A unique slug
+ *
+ * @example
+ * ```typescript
+ * const checkUnique = async (slug: string) => {
+ *   return !(await db.query("entries").withSlug(slug).first());
+ * };
+ * const uniqueSlug = await generateUniqueSlug("hello-world", checkUnique);
+ * // Returns "hello-world" if unique, or "hello-world-1", "hello-world-2", etc.
+ * ```
+ */
+export declare function generateUniqueSlug(baseSlug: string, isUnique: (slug: string) => Promise<boolean>, maxAttempts?: number): Promise<string>;
+//# sourceMappingURL=slugGenerator.d.ts.map

package/admin/dist/types/src/component/lib/slugGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugGenerator.d.ts","sourceRoot":"","sources":["../../../../../../src/component/lib/slugGenerator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7C;AA2ED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,MAAM,CAoD7E;AAiCD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,MAAY,GAAG,OAAO,CAW1E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,EAC5C,WAAW,GAAE,MAAY,GACxB,OAAO,CAAC,MAAM,CAAC,CAiBjB"}

package/admin/dist/types/src/component/lib/slugUniqueness.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Slug Uniqueness Utilities
+ *
+ * Provides functions for checking slug uniqueness within content type scope
+ * and generating unique slugs with incremental suffixes when conflicts exist.
+ */
+/**
+ * Options for slug uniqueness checking
+ */
+export interface SlugUniquenessOptions {
+    /** Maximum number of suffix attempts before falling back to timestamp (default: 100) */
+    maxAttempts?: number;
+    /** Separator character used in slugs (default: '-') */
+    separator?: string;
+    /** ID of the current entry to exclude from uniqueness check (for updates) */
+    excludeEntryId?: string;
+}
+/**
+ * Result of a slug uniqueness check
+ */
+export interface SlugCheckResult {
+    /** Whether the slug is unique */
+    isUnique: boolean;
+    /** The existing entry ID that has this slug (if not unique) */
+    existingEntryId?: string;
+    /** Suggested alternative slug if not unique */
+    suggestedSlug?: string;
+}
+/**
+ * Entry data structure for uniqueness checking
+ */
+export interface SlugEntry {
+    /** The entry's unique identifier */
+    _id: string;
+    /** The entry's slug */
+    slug: string;
+    /** Soft delete timestamp (null/undefined if not deleted) */
+    deletedAt?: number | null;
+}
+/**
+ * Function type for querying existing entries by slug within a content type
+ */
+export type SlugQueryFn = (slug: string) => Promise<SlugEntry | null>;
+/**
+ * Function type for querying all entries with a slug prefix within a content type
+ * Used for finding the next available suffix number
+ */
+export type SlugPrefixQueryFn = (slugPrefix: string) => Promise<SlugEntry[]>;
+/**
+ * Checks if a slug is unique within a content type scope.
+ *
+ * @param slug - The slug to check
+ * @param queryFn - Function that queries the database for entries with the given slug
+ * @param options - Configuration options
+ * @returns Result indicating uniqueness and suggestions
+ *
+ * @example
+ * ```typescript
+ * // In a Convex mutation
+ * const queryFn = async (slug: string) => {
+ *   return await ctx.db
+ *     .query("contentEntries")
+ *     .withIndex("by_content_type_and_slug", (q) =>
+ *       q.eq("contentTypeId", contentTypeId).eq("slug", slug)
+ *     )
+ *     .filter((q) => q.eq(q.field("deletedAt"), undefined))
+ *     .first();
+ * };
+ *
+ * const result = await checkSlugUniqueness("my-post", queryFn);
+ * if (!result.isUnique) {
+ *   console.log(`Slug conflict with entry ${result.existingEntryId}`);
+ *   console.log(`Suggested alternative: ${result.suggestedSlug}`);
+ * }
+ * ```
+ */
+export declare function checkSlugUniqueness(slug: string, queryFn: SlugQueryFn, options?: SlugUniquenessOptions): Promise<SlugCheckResult>;
+/**
+ * Ensures a slug is unique by generating incremental suffixes if needed.
+ * This is the main function to use when creating or updating content entries.
+ *
+ * @param baseSlug - The desired slug (or title to generate slug from)
+ * @param queryFn - Function that queries the database for entries with a given slug
+ * @param options - Configuration options
+ * @returns A unique slug (either the original or with a numeric suffix)
+ *
+ * @example
+ * ```typescript
+ * // In a Convex mutation for creating a new entry
+ * const queryFn = async (slug: string) => {
+ *   return await ctx.db
+ *     .query("contentEntries")
+ *     .withIndex("by_content_type_and_slug", (q) =>
+ *       q.eq("contentTypeId", contentTypeId).eq("slug", slug)
+ *     )
+ *     .filter((q) => q.eq(q.field("deletedAt"), undefined))
+ *     .first();
+ * };
+ *
+ * const uniqueSlug = await ensureUniqueSlug("my-post", queryFn);
+ * // Returns "my-post" if unique, or "my-post-1", "my-post-2", etc.
+ * ```
+ */
+export declare function ensureUniqueSlug(baseSlug: string, queryFn: SlugQueryFn, options?: SlugUniquenessOptions): Promise<string>;
+/**
+ * Finds the next available slug suffix by analyzing existing slugs.
+ * This is useful when you want to pre-compute the next suffix without
+ * iterating through each number.
+ *
+ * @param baseSlug - The base slug to find the next suffix for
+ * @param prefixQueryFn - Function that returns all entries with slugs starting with the base
+ * @param options - Configuration options
+ * @returns The next available slug with the appropriate suffix
+ *
+ * @example
+ * ```typescript
+ * // If entries exist with slugs: "post", "post-1", "post-2", "post-5"
+ * const nextSlug = await findNextAvailableSlug("post", queryPrefixFn);
+ * // Returns "post-3" (fills the gap)
+ * ```
+ */
+export declare function findNextAvailableSlug(baseSlug: string, prefixQueryFn: SlugPrefixQueryFn, options?: SlugUniquenessOptions): Promise<string>;
+/**
+ * Validates a slug and returns validation errors if any.
+ *
+ * @param slug - The slug to validate
+ * @param separator - The separator character (default: '-')
+ * @returns Array of validation error messages (empty if valid)
+ */
+export declare function validateSlugFormat(slug: string, separator?: string): string[];
+//# sourceMappingURL=slugUniqueness.d.ts.map

package/admin/dist/types/src/component/lib/slugUniqueness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugUniqueness.d.ts","sourceRoot":"","sources":["../../../../../../src/component/lib/slugUniqueness.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,wFAAwF;IACxF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,iCAAiC;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,+DAA+D;IAC/D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,mBAAmB,CACxC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,EACpB,OAAO,GAAE,qBAA0B,GACjC,OAAO,CAAC,eAAe,CAAC,CA2C1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,gBAAgB,CACrC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,WAAW,EACpB,OAAO,GAAE,qBAA0B,GACjC,OAAO,CAAC,MAAM,CAAC,CAuBjB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,qBAAqB,CAC1C,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,iBAAiB,EAChC,OAAO,GAAE,qBAA0B,GACjC,OAAO,CAAC,MAAM,CAAC,CA0DjB;AASD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,MAAY,GACrB,MAAM,EAAE,CA0CV"}

package/admin/dist/types/src/component/lib/softDelete.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Soft-delete utilities for CMS documents.
+ *
+ * Provides type-safe helpers for working with documents that use
+ * the soft-delete pattern (deletedAt timestamp).
+ */
+export interface SoftDeletable {
+    deletedAt?: number;
+}
+export declare function isDeleted<T extends SoftDeletable>(doc: T): boolean;
+export declare function isActive<T extends SoftDeletable>(doc: T): boolean;
+export declare function filterActive<T extends SoftDeletable>(docs: T[]): T[];
+export declare function filterDeleted<T extends SoftDeletable>(docs: T[]): T[];
+export declare function requireNotDeleted<T extends SoftDeletable>(doc: T, errorFactory: () => Error): asserts doc is T & {
+    deletedAt: undefined;
+};
+export declare function requireDeleted<T extends SoftDeletable>(doc: T, errorFactory: () => Error): void;
+//# sourceMappingURL=softDelete.d.ts.map

package/admin/dist/types/src/component/lib/softDelete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"softDelete.d.ts","sourceRoot":"","sources":["../../../../../../src/component/lib/softDelete.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAElE;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,aAAa,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAEjE;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAEpE;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAErE;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,aAAa,EACvD,GAAG,EAAE,CAAC,EACN,YAAY,EAAE,MAAM,KAAK,GACxB,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG;IAAE,SAAS,EAAE,SAAS,CAAA;CAAE,CAI7C;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,aAAa,EACpD,GAAG,EAAE,CAAC,EACN,YAAY,EAAE,MAAM,KAAK,GACxB,IAAI,CAIN"}