imean-cassandra-orm 1.0.0

package/dist/mod.d.cts

@@ -0,0 +1,279 @@
+import { Client as Client$1 } from 'cassandra-driver';
+
+type TypeMap = {
+    text: string;
+    int: number;
+    bigint: number;
+    varint: number;
+    boolean: boolean;
+    timestamp: Date;
+    uuid: string;
+    blob: Uint8Array;
+    decimal: number;
+    float: number;
+    double: number;
+    list: any[];
+    set: Set<any>;
+    map: Record<string, any>;
+};
+type InferType<T extends keyof TypeMap> = TypeMap[T];
+type FieldConfig<T extends keyof TypeMap> = {
+    type: T;
+    flags: {
+        partitionKey: boolean;
+        clusteringKey: boolean | {
+            order: "ASC" | "DESC";
+        };
+        optional: boolean;
+    };
+};
+declare class FieldBuilder<T extends keyof TypeMap, F extends {
+    partitionKey: boolean;
+    clusteringKey: boolean | {
+        order: "ASC" | "DESC";
+    };
+    optional: boolean;
+} = {
+    partitionKey: false;
+    clusteringKey: false;
+    optional: false;
+}> {
+    type: T;
+    flags: F;
+    constructor(type: T, flags?: F);
+    partitionKey(): FieldBuilder<T, Omit<F, "partitionKey"> & {
+        partitionKey: true;
+    }>;
+    clusteringKey(order?: "ASC" | "DESC"): FieldBuilder<T, Omit<F, "clusteringKey"> & {
+        clusteringKey: true | {
+            order: "ASC" | "DESC";
+        };
+    }>;
+    optional(): FieldBuilder<T, Omit<F, "optional"> & {
+        optional: true;
+    }>;
+}
+type InferFieldsByFlag<S extends Record<string, FieldConfig<keyof TypeMap>>, Flag extends "partitionKey" | "clusteringKey"> = {
+    [K in keyof S as S[K]["flags"][Flag] extends true | {
+        order: "ASC" | "DESC";
+    } ? K : never]: InferType<S[K]["type"]>;
+};
+type InferFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = {
+    [K in keyof S]: S[K]["flags"]["optional"] extends true ? InferType<S[K]["type"]> | undefined : InferType<S[K]["type"]>;
+};
+declare const Field: {
+    text: () => FieldBuilder<"text", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    uuid: () => FieldBuilder<"uuid", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    int: () => FieldBuilder<"int", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    bigint: () => FieldBuilder<"bigint", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    varint: () => FieldBuilder<"varint", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    decimal: () => FieldBuilder<"decimal", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    float: () => FieldBuilder<"float", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    double: () => FieldBuilder<"double", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    boolean: () => FieldBuilder<"boolean", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    timestamp: () => FieldBuilder<"timestamp", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    blob: () => FieldBuilder<"blob", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    list: () => FieldBuilder<"list", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    set: () => FieldBuilder<"set", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    map: () => FieldBuilder<"map", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+};
+
+/**
+ * 从 Model 实例中推断出原始字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ * }> {}
+ *
+ * type UserType = Infer<User>;
+ * // { id: string; name: string }
+ * ```
+ */
+type Infer<M extends Model<any>> = M extends Model<infer S> ? InferFields<S> : never;
+/**
+ * 推导分区键字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ * }> {}
+ *
+ * type UserPartitionKey = InferPartitionKey<User>;
+ * // { id: string }
+ * ```
+ */
+type InferPartitionKey<M extends Model<any>> = M extends Model<infer S> ? InferFieldsByFlag<S, "partitionKey"> : never;
+/**
+ * 推导聚类键字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text"; flags: { clusteringKey: true } };
+ * }> {}
+ *
+ * type UserClusteringKey = InferClusteringKey<User>;
+ * // { name: string }
+ * ```
+ */
+type InferClusteringKey<M extends Model<any>> = M extends Model<infer S> ? InferFieldsByFlag<S, "clusteringKey"> : never;
+/**
+ * 推导非分区键字段类型
+ *
+ * @typeParam S - 字段配置记录类型
+ *
+ * @example
+ * ```typescript
+ * type UserFields = {
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ *   age: { type: "int" };
+ * };
+ *
+ * type NonPartitionFields = InferNonPartitionFields<UserFields>;
+ * // { name: string; age: number }
+ * ```
+ */
+type InferNonPartitionFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = {
+    [K in keyof S as S[K]["flags"]["partitionKey"] extends true ? never : K]: InferType<S[K]["type"]>;
+};
+type Simplify<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+
+declare class Model<S extends Record<string, FieldConfig<keyof TypeMap>>, P = InferFieldsByFlag<S, "partitionKey">, C = InferFieldsByFlag<S, "clusteringKey">, NP = InferNonPartitionFields<S>, A = InferFields<S>> {
+    private client;
+    private schema;
+    private tableName;
+    private partitionKeys;
+    private clusteringKeys;
+    constructor(client: Client$1, schema: S, tableName: string);
+    getTableSchema(): string;
+    syncSchema(): Promise<void>;
+    private buildWhereClause;
+    private buildQueryParams;
+    private convertResultToType;
+    findAll(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<Simplify<A>[]>;
+    findOne(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<Simplify<A> | null>;
+    create(data: Simplify<P & Partial<NP>>): Promise<void>;
+    update(partitionFields: Simplify<P>, data: Simplify<Partial<NP>>): Promise<void>;
+    delete(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<void>;
+}
+declare const uuid: () => string;
+
+declare class Client {
+    private cassandraClient;
+    private models;
+    constructor(cassandraClient: Client$1);
+    useKeyspace(keyspace: string, options: {
+        class: "SimpleStrategy" | "NetworkTopologyStrategy";
+        replication_factor?: number;
+        datacenters?: Record<string, number>;
+    }): Promise<void>;
+    createModel<S extends Record<string, FieldConfig<keyof TypeMap>>>(schema: S, tableName: string): Model<S>;
+    syncAllSchemas(): Promise<void>;
+    getRawClient(): Client$1;
+    close(): Promise<void>;
+}
+
+type orm_Client = Client;
+declare const orm_Client: typeof Client;
+declare const orm_Field: typeof Field;
+type orm_FieldBuilder<T extends keyof TypeMap, F extends {
+    partitionKey: boolean;
+    clusteringKey: boolean | {
+        order: "ASC" | "DESC";
+    };
+    optional: boolean;
+} = {
+    partitionKey: false;
+    clusteringKey: false;
+    optional: false;
+}> = FieldBuilder<T, F>;
+declare const orm_FieldBuilder: typeof FieldBuilder;
+type orm_FieldConfig<T extends keyof TypeMap> = FieldConfig<T>;
+type orm_Infer<M extends Model<any>> = Infer<M>;
+type orm_InferClusteringKey<M extends Model<any>> = InferClusteringKey<M>;
+type orm_InferFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = InferFields<S>;
+type orm_InferFieldsByFlag<S extends Record<string, FieldConfig<keyof TypeMap>>, Flag extends "partitionKey" | "clusteringKey"> = InferFieldsByFlag<S, Flag>;
+type orm_InferNonPartitionFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = InferNonPartitionFields<S>;
+type orm_InferPartitionKey<M extends Model<any>> = InferPartitionKey<M>;
+type orm_InferType<T extends keyof TypeMap> = InferType<T>;
+type orm_Model<S extends Record<string, FieldConfig<keyof TypeMap>>, P = InferFieldsByFlag<S, "partitionKey">, C = InferFieldsByFlag<S, "clusteringKey">, NP = InferNonPartitionFields<S>, A = InferFields<S>> = Model<S, P, C, NP, A>;
+declare const orm_Model: typeof Model;
+type orm_Simplify<T> = Simplify<T>;
+type orm_TypeMap = TypeMap;
+declare const orm_uuid: typeof uuid;
+declare namespace orm {
+  export { orm_Client as Client, orm_Field as Field, orm_FieldBuilder as FieldBuilder, type orm_FieldConfig as FieldConfig, type orm_Infer as Infer, type orm_InferClusteringKey as InferClusteringKey, type orm_InferFields as InferFields, type orm_InferFieldsByFlag as InferFieldsByFlag, type orm_InferNonPartitionFields as InferNonPartitionFields, type orm_InferPartitionKey as InferPartitionKey, type orm_InferType as InferType, orm_Model as Model, type orm_Simplify as Simplify, type orm_TypeMap as TypeMap, orm_uuid as uuid };
+}
+
+export { Client, Field, FieldBuilder, type FieldConfig, type Infer, type InferClusteringKey, type InferFields, type InferFieldsByFlag, type InferNonPartitionFields, type InferPartitionKey, type InferType, Model, type Simplify, type TypeMap, orm as default, uuid };

package/dist/mod.d.ts

@@ -0,0 +1,279 @@
+import { Client as Client$1 } from 'cassandra-driver';
+
+type TypeMap = {
+    text: string;
+    int: number;
+    bigint: number;
+    varint: number;
+    boolean: boolean;
+    timestamp: Date;
+    uuid: string;
+    blob: Uint8Array;
+    decimal: number;
+    float: number;
+    double: number;
+    list: any[];
+    set: Set<any>;
+    map: Record<string, any>;
+};
+type InferType<T extends keyof TypeMap> = TypeMap[T];
+type FieldConfig<T extends keyof TypeMap> = {
+    type: T;
+    flags: {
+        partitionKey: boolean;
+        clusteringKey: boolean | {
+            order: "ASC" | "DESC";
+        };
+        optional: boolean;
+    };
+};
+declare class FieldBuilder<T extends keyof TypeMap, F extends {
+    partitionKey: boolean;
+    clusteringKey: boolean | {
+        order: "ASC" | "DESC";
+    };
+    optional: boolean;
+} = {
+    partitionKey: false;
+    clusteringKey: false;
+    optional: false;
+}> {
+    type: T;
+    flags: F;
+    constructor(type: T, flags?: F);
+    partitionKey(): FieldBuilder<T, Omit<F, "partitionKey"> & {
+        partitionKey: true;
+    }>;
+    clusteringKey(order?: "ASC" | "DESC"): FieldBuilder<T, Omit<F, "clusteringKey"> & {
+        clusteringKey: true | {
+            order: "ASC" | "DESC";
+        };
+    }>;
+    optional(): FieldBuilder<T, Omit<F, "optional"> & {
+        optional: true;
+    }>;
+}
+type InferFieldsByFlag<S extends Record<string, FieldConfig<keyof TypeMap>>, Flag extends "partitionKey" | "clusteringKey"> = {
+    [K in keyof S as S[K]["flags"][Flag] extends true | {
+        order: "ASC" | "DESC";
+    } ? K : never]: InferType<S[K]["type"]>;
+};
+type InferFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = {
+    [K in keyof S]: S[K]["flags"]["optional"] extends true ? InferType<S[K]["type"]> | undefined : InferType<S[K]["type"]>;
+};
+declare const Field: {
+    text: () => FieldBuilder<"text", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    uuid: () => FieldBuilder<"uuid", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    int: () => FieldBuilder<"int", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    bigint: () => FieldBuilder<"bigint", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    varint: () => FieldBuilder<"varint", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    decimal: () => FieldBuilder<"decimal", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    float: () => FieldBuilder<"float", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    double: () => FieldBuilder<"double", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    boolean: () => FieldBuilder<"boolean", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    timestamp: () => FieldBuilder<"timestamp", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    blob: () => FieldBuilder<"blob", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    list: () => FieldBuilder<"list", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    set: () => FieldBuilder<"set", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+    map: () => FieldBuilder<"map", {
+        partitionKey: false;
+        clusteringKey: false;
+        optional: false;
+    }>;
+};
+
+/**
+ * 从 Model 实例中推断出原始字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ * }> {}
+ *
+ * type UserType = Infer<User>;
+ * // { id: string; name: string }
+ * ```
+ */
+type Infer<M extends Model<any>> = M extends Model<infer S> ? InferFields<S> : never;
+/**
+ * 推导分区键字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ * }> {}
+ *
+ * type UserPartitionKey = InferPartitionKey<User>;
+ * // { id: string }
+ * ```
+ */
+type InferPartitionKey<M extends Model<any>> = M extends Model<infer S> ? InferFieldsByFlag<S, "partitionKey"> : never;
+/**
+ * 推导聚类键字段类型
+ *
+ * @typeParam M - 继承自 Model 的类型
+ *
+ * @example
+ * ```typescript
+ * class User extends Model<{
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text"; flags: { clusteringKey: true } };
+ * }> {}
+ *
+ * type UserClusteringKey = InferClusteringKey<User>;
+ * // { name: string }
+ * ```
+ */
+type InferClusteringKey<M extends Model<any>> = M extends Model<infer S> ? InferFieldsByFlag<S, "clusteringKey"> : never;
+/**
+ * 推导非分区键字段类型
+ *
+ * @typeParam S - 字段配置记录类型
+ *
+ * @example
+ * ```typescript
+ * type UserFields = {
+ *   id: { type: "uuid"; flags: { partitionKey: true } };
+ *   name: { type: "text" };
+ *   age: { type: "int" };
+ * };
+ *
+ * type NonPartitionFields = InferNonPartitionFields<UserFields>;
+ * // { name: string; age: number }
+ * ```
+ */
+type InferNonPartitionFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = {
+    [K in keyof S as S[K]["flags"]["partitionKey"] extends true ? never : K]: InferType<S[K]["type"]>;
+};
+type Simplify<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+
+declare class Model<S extends Record<string, FieldConfig<keyof TypeMap>>, P = InferFieldsByFlag<S, "partitionKey">, C = InferFieldsByFlag<S, "clusteringKey">, NP = InferNonPartitionFields<S>, A = InferFields<S>> {
+    private client;
+    private schema;
+    private tableName;
+    private partitionKeys;
+    private clusteringKeys;
+    constructor(client: Client$1, schema: S, tableName: string);
+    getTableSchema(): string;
+    syncSchema(): Promise<void>;
+    private buildWhereClause;
+    private buildQueryParams;
+    private convertResultToType;
+    findAll(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<Simplify<A>[]>;
+    findOne(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<Simplify<A> | null>;
+    create(data: Simplify<P & Partial<NP>>): Promise<void>;
+    update(partitionFields: Simplify<P>, data: Simplify<Partial<NP>>): Promise<void>;
+    delete(partitionFields: Simplify<P>, clusteringFields?: Simplify<Partial<C>>): Promise<void>;
+}
+declare const uuid: () => string;
+
+declare class Client {
+    private cassandraClient;
+    private models;
+    constructor(cassandraClient: Client$1);
+    useKeyspace(keyspace: string, options: {
+        class: "SimpleStrategy" | "NetworkTopologyStrategy";
+        replication_factor?: number;
+        datacenters?: Record<string, number>;
+    }): Promise<void>;
+    createModel<S extends Record<string, FieldConfig<keyof TypeMap>>>(schema: S, tableName: string): Model<S>;
+    syncAllSchemas(): Promise<void>;
+    getRawClient(): Client$1;
+    close(): Promise<void>;
+}
+
+type orm_Client = Client;
+declare const orm_Client: typeof Client;
+declare const orm_Field: typeof Field;
+type orm_FieldBuilder<T extends keyof TypeMap, F extends {
+    partitionKey: boolean;
+    clusteringKey: boolean | {
+        order: "ASC" | "DESC";
+    };
+    optional: boolean;
+} = {
+    partitionKey: false;
+    clusteringKey: false;
+    optional: false;
+}> = FieldBuilder<T, F>;
+declare const orm_FieldBuilder: typeof FieldBuilder;
+type orm_FieldConfig<T extends keyof TypeMap> = FieldConfig<T>;
+type orm_Infer<M extends Model<any>> = Infer<M>;
+type orm_InferClusteringKey<M extends Model<any>> = InferClusteringKey<M>;
+type orm_InferFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = InferFields<S>;
+type orm_InferFieldsByFlag<S extends Record<string, FieldConfig<keyof TypeMap>>, Flag extends "partitionKey" | "clusteringKey"> = InferFieldsByFlag<S, Flag>;
+type orm_InferNonPartitionFields<S extends Record<string, FieldConfig<keyof TypeMap>>> = InferNonPartitionFields<S>;
+type orm_InferPartitionKey<M extends Model<any>> = InferPartitionKey<M>;
+type orm_InferType<T extends keyof TypeMap> = InferType<T>;
+type orm_Model<S extends Record<string, FieldConfig<keyof TypeMap>>, P = InferFieldsByFlag<S, "partitionKey">, C = InferFieldsByFlag<S, "clusteringKey">, NP = InferNonPartitionFields<S>, A = InferFields<S>> = Model<S, P, C, NP, A>;
+declare const orm_Model: typeof Model;
+type orm_Simplify<T> = Simplify<T>;
+type orm_TypeMap = TypeMap;
+declare const orm_uuid: typeof uuid;
+declare namespace orm {
+  export { orm_Client as Client, orm_Field as Field, orm_FieldBuilder as FieldBuilder, type orm_FieldConfig as FieldConfig, type orm_Infer as Infer, type orm_InferClusteringKey as InferClusteringKey, type orm_InferFields as InferFields, type orm_InferFieldsByFlag as InferFieldsByFlag, type orm_InferNonPartitionFields as InferNonPartitionFields, type orm_InferPartitionKey as InferPartitionKey, type orm_InferType as InferType, orm_Model as Model, type orm_Simplify as Simplify, type orm_TypeMap as TypeMap, orm_uuid as uuid };
+}
+
+export { Client, Field, FieldBuilder, type FieldConfig, type Infer, type InferClusteringKey, type InferFields, type InferFieldsByFlag, type InferNonPartitionFields, type InferPartitionKey, type InferType, Model, type Simplify, type TypeMap, orm as default, uuid };