hysteria-orm 10.4.0 → 10.4.2

package/lib/index.d.cts

@@ -1078,9 +1078,32 @@ type AdminJsInstance = {
 };
 
 interface CacheAdapter {
+    /**
+     * @description Gets a value from the cache
+     * @param key The key to get the value from
+     * @returns The value from the cache
+     */
     get<T = void>(key: string): Promise<T>;
+    /**
+     * @description Sets a value in the cache
+     * @param key The key to set the value to
+     * @param data The value to set in the cache
+     * @param ttl The time to live for the value in milliseconds
+     */
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * @description Invalidates a value from the cache
+     * @param key The key to invalidate the value from
+     */
     invalidate(key: string): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAll(key: string): Promise<void>;
+    /**
+     * @description Disconnects from the cache adapter if needed when the data source disconnects
+     */
     disconnect?(): Promise<void>;
 }
 
@@ -4009,6 +4032,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     invalidCache<K extends keyof C>(key: K, ...args: Parameters<C[K]>): Promise<void>;
     invalidCache<K extends keyof C>(key: K): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAllCache(key: string): Promise<void>;
     /**
      * @description Clones the SqlDataSource instance
      * @param options.shouldRecreatePool Whether to recreate the pool of connections for the given driver, by default it's false
@@ -5099,7 +5127,10 @@ declare function view(statement: (query: ModelQueryBuilder<any>) => void): Class
 declare function column(options?: ColumnOptions): PropertyDecorator;
 declare namespace column {
     var primary: typeof primaryKeyColumn;
-    var date: typeof dateColumn;
+    var date: typeof dateOnlyColumn;
+    var datetime: typeof datetimeColumn;
+    var timestamp: typeof timestampColumn;
+    var time: typeof timeOnlyColumn;
     var boolean: typeof booleanColumn;
     var json: typeof jsonColumn;
     var uuid: typeof uuidColumn;
@@ -5168,18 +5199,57 @@ declare function asymmetric(options: Omit<AsymmetricEncryptionOptions, "prepare"
  */
 declare function booleanColumn(options?: Omit<ColumnOptions, "prepare" | "serialize">): PropertyDecorator;
 /**
- * @description Decorator to define a date column in the model
- * @description This will automatically convert the date to the correct format for the database
- * @description Supports both ISO format (YYYY-MM-DD HH:mm:ss) and Unix timestamp
+ * @description Decorator to define a DATE_ONLY column in the model (YYYY-MM-DD)
+ * @description This will automatically convert the date to DATE_ONLY format
  * @description Handles timezone conversion between UTC and local time
  * @description Can automatically update/create timestamps
  * @param options Configuration options for the date column
- * @param options.format The format to store dates in ('ISO' or 'TIMESTAMP')
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the date on record updates
+ * @param options.autoCreate Whether to automatically set the date on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function dateOnlyColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a DATETIME column in the model (YYYY-MM-DD HH:mm:ss)
+ * @description This will automatically convert the date to ISO format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the datetime column
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the timestamp on record updates
+ * @param options.autoCreate Whether to automatically set the timestamp on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function datetimeColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a TIMESTAMP column in the model (Unix timestamp)
+ * @description This will automatically convert the date to Unix timestamp format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the timestamp column
  * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
  * @param options.autoUpdate Whether to automatically update the timestamp on record updates
  * @param options.autoCreate Whether to automatically set the timestamp on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function timestampColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a TIME_ONLY column in the model (HH:mm:ss)
+ * @description This will automatically convert the date to TIME_ONLY format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the time column
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the time on record updates
+ * @param options.autoCreate Whether to automatically set the time on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
  */
-declare function dateColumn(options?: Omit<DateColumnOptions, "prepare" | "serialize">): PropertyDecorator;
+declare function timeOnlyColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
 /**
  * @description Decorator to define a json column in the model
  * @description This will automatically convert the json to the correct format for the database
@@ -5299,6 +5369,7 @@ declare class InMemoryAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
 }
 
 declare class RedisCacheAdapter implements CacheAdapter {
@@ -5309,6 +5380,7 @@ declare class RedisCacheAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
     private serializeData;
     private deserializeData;
     disconnect(): Promise<void>;

package/lib/index.d.ts

@@ -1078,9 +1078,32 @@ type AdminJsInstance = {
 };
 
 interface CacheAdapter {
+    /**
+     * @description Gets a value from the cache
+     * @param key The key to get the value from
+     * @returns The value from the cache
+     */
     get<T = void>(key: string): Promise<T>;
+    /**
+     * @description Sets a value in the cache
+     * @param key The key to set the value to
+     * @param data The value to set in the cache
+     * @param ttl The time to live for the value in milliseconds
+     */
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
+    /**
+     * @description Invalidates a value from the cache
+     * @param key The key to invalidate the value from
+     */
     invalidate(key: string): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAll(key: string): Promise<void>;
+    /**
+     * @description Disconnects from the cache adapter if needed when the data source disconnects
+     */
     disconnect?(): Promise<void>;
 }
 
@@ -4009,6 +4032,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     invalidCache<K extends keyof C>(key: K, ...args: Parameters<C[K]>): Promise<void>;
     invalidCache<K extends keyof C>(key: K): Promise<void>;
+    /**
+     * @description Invalidates all values from the cache starting with the given key
+     * @param key The key to invalidate the values from
+     */
+    invalidateAllCache(key: string): Promise<void>;
     /**
      * @description Clones the SqlDataSource instance
      * @param options.shouldRecreatePool Whether to recreate the pool of connections for the given driver, by default it's false
@@ -5099,7 +5127,10 @@ declare function view(statement: (query: ModelQueryBuilder<any>) => void): Class
 declare function column(options?: ColumnOptions): PropertyDecorator;
 declare namespace column {
     var primary: typeof primaryKeyColumn;
-    var date: typeof dateColumn;
+    var date: typeof dateOnlyColumn;
+    var datetime: typeof datetimeColumn;
+    var timestamp: typeof timestampColumn;
+    var time: typeof timeOnlyColumn;
     var boolean: typeof booleanColumn;
     var json: typeof jsonColumn;
     var uuid: typeof uuidColumn;
@@ -5168,18 +5199,57 @@ declare function asymmetric(options: Omit<AsymmetricEncryptionOptions, "prepare"
  */
 declare function booleanColumn(options?: Omit<ColumnOptions, "prepare" | "serialize">): PropertyDecorator;
 /**
- * @description Decorator to define a date column in the model
- * @description This will automatically convert the date to the correct format for the database
- * @description Supports both ISO format (YYYY-MM-DD HH:mm:ss) and Unix timestamp
+ * @description Decorator to define a DATE_ONLY column in the model (YYYY-MM-DD)
+ * @description This will automatically convert the date to DATE_ONLY format
  * @description Handles timezone conversion between UTC and local time
  * @description Can automatically update/create timestamps
  * @param options Configuration options for the date column
- * @param options.format The format to store dates in ('ISO' or 'TIMESTAMP')
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the date on record updates
+ * @param options.autoCreate Whether to automatically set the date on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function dateOnlyColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a DATETIME column in the model (YYYY-MM-DD HH:mm:ss)
+ * @description This will automatically convert the date to ISO format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the datetime column
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the timestamp on record updates
+ * @param options.autoCreate Whether to automatically set the timestamp on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function datetimeColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a TIMESTAMP column in the model (Unix timestamp)
+ * @description This will automatically convert the date to Unix timestamp format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the timestamp column
  * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
  * @param options.autoUpdate Whether to automatically update the timestamp on record updates
  * @param options.autoCreate Whether to automatically set the timestamp on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
+ */
+declare function timestampColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
+/**
+ * @description Decorator to define a TIME_ONLY column in the model (HH:mm:ss)
+ * @description This will automatically convert the date to TIME_ONLY format
+ * @description Handles timezone conversion between UTC and local time
+ * @description Can automatically update/create timestamps
+ * @param options Configuration options for the time column
+ * @param options.timezone The timezone to use ('UTC' or 'LOCAL')
+ * @param options.autoUpdate Whether to automatically update the time on record updates
+ * @param options.autoCreate Whether to automatically set the time on record creation
+ * @param options.prepare Optional custom prepare function that receives the pre-handled value
+ * @param options.serialize Optional custom serialize function that receives the pre-handled value
  */
-declare function dateColumn(options?: Omit<DateColumnOptions, "prepare" | "serialize">): PropertyDecorator;
+declare function timeOnlyColumn(options?: Omit<DateColumnOptions, "format">): PropertyDecorator;
 /**
  * @description Decorator to define a json column in the model
  * @description This will automatically convert the json to the correct format for the database
@@ -5299,6 +5369,7 @@ declare class InMemoryAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
 }
 
 declare class RedisCacheAdapter implements CacheAdapter {
@@ -5309,6 +5380,7 @@ declare class RedisCacheAdapter implements CacheAdapter {
     get<T = void>(key: string): Promise<T>;
     set<T = any>(key: string, data: T, ttl?: number): Promise<void>;
     invalidate(key: string): Promise<void>;
+    invalidateAll(key: string): Promise<void>;
     private serializeData;
     private deserializeData;
     disconnect(): Promise<void>;