liwi-mongo 13.1.1 → 13.3.0

package/dist/definitions/indexes/types.d.ts

@@ -0,0 +1,72 @@
+import type { Criteria, DottedPaths } from "liwi-store";
+import type { CollationOptions, IndexDescription, IndexDescriptionInfo } from "mongodb";
+import type { MongoBaseModel } from "../MongoBaseModel.ts";
+export type MongoIndexDirection = -1 | "2d" | "2dsphere" | "hashed" | "text" | 1;
+export type MongoIndexKey<Model extends MongoBaseModel<any>> = Partial<Record<DottedPaths<Model> | "$**" | `${DottedPaths<Model>}.$**`, MongoIndexDirection>>;
+export interface MongoIndexOptions<Model extends MongoBaseModel<any>> {
+    name?: string;
+    unique?: boolean;
+    sparse?: boolean;
+    hidden?: boolean;
+    expireAfterSeconds?: number;
+    partialFilterExpression?: Criteria<Model>;
+    collation?: CollationOptions;
+    weights?: Partial<Record<DottedPaths<Model>, number>>;
+    default_language?: string;
+    language_override?: string;
+    wildcardProjection?: Record<string, 0 | 1>;
+}
+export interface MongoIndex<Model extends MongoBaseModel<any>> extends MongoIndexOptions<Model> {
+    key: MongoIndexKey<Model>;
+}
+export interface SyncIndexesOptions {
+    dryRun?: boolean;
+    dropUndeclaredIndexes?: boolean;
+}
+export type MongoIndexComparedField = "collation" | "default_language" | "expireAfterSeconds" | "hidden" | "key" | "language_override" | "partialFilterExpression" | "sparse" | "unique" | "weights" | "wildcardProjection";
+export interface MongoIndexDifference {
+    field: MongoIndexComparedField;
+    declared: unknown;
+    existing: unknown;
+}
+export interface MongoIndexCollModChanges {
+    expireAfterSeconds?: number;
+    hidden?: boolean;
+}
+export interface MongoIndexPlanCreate {
+    name: string;
+    index: IndexDescription;
+}
+export interface MongoIndexPlanRecreate {
+    name: string;
+    index: IndexDescription;
+    existing: IndexDescriptionInfo;
+    differences: MongoIndexDifference[];
+}
+export interface MongoIndexPlanCollMod {
+    name: string;
+    changes: MongoIndexCollModChanges;
+    differences: MongoIndexDifference[];
+}
+export interface MongoIndexPlanDrop {
+    name: string;
+    existing: IndexDescriptionInfo;
+}
+export interface MongoIndexPlan {
+    collectionName: string;
+    toCreate: MongoIndexPlanCreate[];
+    toRecreate: MongoIndexPlanRecreate[];
+    toCollMod: MongoIndexPlanCollMod[];
+    toDrop: MongoIndexPlanDrop[];
+    unchanged: string[];
+    undeclaredKept: string[];
+}
+export interface MongoIndexSyncResult {
+    collectionName: string;
+    plan: MongoIndexPlan;
+    dryRun: boolean;
+    created: string[];
+    dropped: string[];
+    modified: string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/definitions/indexes/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/indexes/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAC3B,CAAC,CAAC,GACF,IAAI,GACJ,UAAU,GACV,QAAQ,GACR,MAAM,GACN,CAAC,CAAC;AAEN,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC,IAAI,OAAO,CACpE,MAAM,CACJ,WAAW,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,EACxD,mBAAmB,CACpB,CACF,CAAC;AAEF,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAEtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,UAAU,CACzB,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC,CACjC,SAAQ,iBAAiB,CAAC,KAAK,CAAC;IAChC,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,MAAM,uBAAuB,GAC/B,WAAW,GACX,kBAAkB,GAClB,oBAAoB,GACpB,QAAQ,GACR,KAAK,GACL,mBAAmB,GACnB,yBAAyB,GACzB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,oBAAoB,CAAC;AAEzB,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,uBAAuB,CAAC;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,gBAAgB,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,gBAAgB,CAAC;IACxB,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,wBAAwB,CAAC;IAClC,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,oBAAoB,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,UAAU,EAAE,sBAAsB,EAAE,CAAC;IACrC,SAAS,EAAE,qBAAqB,EAAE,CAAC;IACnC,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}