@orchestr-sh/orchestr 1.5.2 → 1.5.4

package/dist/Database/Ensemble/Relations/BelongsToMany.d.ts

@@ -0,0 +1,276 @@
+/**
+ * BelongsToMany Relationship
+ *
+ * Represents a many-to-many relationship
+ */
+import { Ensemble } from '../Ensemble';
+import { EnsembleBuilder } from '../EnsembleBuilder';
+import { EnsembleCollection } from '../EnsembleCollection';
+import { Relation } from './Relation';
+export declare class BelongsToMany<TRelated extends Ensemble, TParent extends Ensemble> extends Relation<TRelated, TParent> {
+    /**
+     * The intermediate table for the relation
+     */
+    protected table: string;
+    /**
+     * The foreign key of the parent model
+     */
+    protected foreignPivotKey: string;
+    /**
+     * The associated key of the relation
+     */
+    protected relatedPivotKey: string;
+    /**
+     * The parent key of the relationship
+     */
+    protected parentKey: string;
+    /**
+     * The related key of the relationship
+     */
+    protected relatedKey: string;
+    /**
+     * The name of the relationship
+     */
+    protected relationName: string;
+    /**
+     * The pivot table columns to retrieve
+     */
+    protected pivotColumns: string[];
+    /**
+     * Any pivot table restrictions
+     */
+    protected pivotWheres: Array<{
+        column: string;
+        operator?: string;
+        value?: any;
+        boolean: string;
+    }>;
+    /**
+     * The pivot table values to attach
+     */
+    protected pivotValues: Record<string, any>[];
+    /**
+     * Whether we are using timestamps on the pivot table
+     */
+    protected usingTimestamps: boolean;
+    /**
+     * The custom pivot table model
+     */
+    protected using?: any;
+    /**
+     * The name of the "created at" column
+     */
+    protected pivotCreatedAt?: string;
+    /**
+     * The name of the "updated at" column
+     */
+    protected pivotUpdatedAt?: string;
+    /**
+     * The name of the accessor to use for the pivot relationship
+     */
+    protected accessor: string;
+    /**
+     * Create a new belongs to many relationship instance
+     */
+    constructor(query: EnsembleBuilder<TRelated>, parent: TParent, table: string, foreignPivotKey: string, relatedPivotKey: string, parentKey: string, relatedKey: string, relationName?: string);
+    /**
+     * Set the base constraints on the relation query
+     */
+    addConstraints(): void;
+    /**
+     * Set the join clause for the relation query
+     */
+    protected performJoin(query?: EnsembleBuilder<TRelated>): void;
+    /**
+     * Set the where clause for the relation query
+     */
+    protected addWhereConstraints(): void;
+    /**
+     * Set the constraints for an eager load of the relation
+     */
+    addEagerConstraints(models: TParent[]): void;
+    /**
+     * Initialize the relation on a set of models
+     */
+    initRelation(models: TParent[], relation: string): TParent[];
+    /**
+     * Match the eagerly loaded results to their parents
+     */
+    match(models: TParent[], results: EnsembleCollection<TRelated>, relation: string): TParent[];
+    /**
+     * Build model dictionary keyed by the relation's foreign key
+     */
+    protected buildDictionary(results: EnsembleCollection<TRelated>): Record<any, TRelated[]>;
+    /**
+     * Get the results of the relationship
+     */
+    getResults(): Promise<TRelated[]>;
+    /**
+     * Execute the query and get the models
+     */
+    get(): Promise<TRelated[]>;
+    /**
+     * Get the select columns for the relation query
+     */
+    protected shouldSelect(columns?: string[]): string[];
+    /**
+     * Get the pivot columns for the relation
+     */
+    protected aliasedPivotColumns(): string[];
+    /**
+     * Hydrate the pivot relationship on the models
+     */
+    protected hydratePivotRelation(models: TRelated[]): void;
+    /**
+     * Migrate the pivot attributes from the model to a pivot model
+     */
+    protected migratePivotAttributes(model: TRelated): Record<string, any>;
+    /**
+     * Get the fully qualified foreign key for the relation
+     */
+    protected getQualifiedForeignPivotKeyName(): string;
+    /**
+     * Get the fully qualified "related key" for the relation
+     */
+    protected getQualifiedRelatedPivotKeyName(): string;
+    /**
+     * Get the fully qualified parent key name
+     */
+    protected getQualifiedParentKeyName(): string;
+    /**
+     * Get the fully qualified related key name
+     */
+    protected getQualifiedRelatedKeyName(): string;
+    /**
+     * Specify the pivot table columns to retrieve
+     */
+    withPivot(...columns: string[]): this;
+    /**
+     * Indicate that the pivot table has timestamps
+     */
+    withTimestamps(createdAt?: string, updatedAt?: string): this;
+    /**
+     * Set a where clause for the pivot table
+     */
+    wherePivot(column: string, operator?: any, value?: any): this;
+    /**
+     * Set a "where in" clause for the pivot table
+     */
+    wherePivotIn(column: string, values: any[]): this;
+    /**
+     * Set a "where not in" clause for the pivot table
+     */
+    wherePivotNotIn(column: string, values: any[]): this;
+    /**
+     * Set a "where null" clause for the pivot table
+     */
+    wherePivotNull(column: string): this;
+    /**
+     * Set a "where not null" clause for the pivot table
+     */
+    wherePivotNotNull(column: string): this;
+    /**
+     * Set an "or where" clause for the pivot table
+     */
+    orWherePivot(column: string, operator?: any, value?: any): this;
+    /**
+     * Attach models to the parent
+     */
+    attach(ids: any | any[], attributes?: Record<string, any>): Promise<void>;
+    /**
+     * Detach models from the parent
+     */
+    detach(ids?: any | any[]): Promise<number>;
+    /**
+     * Sync the intermediate tables with a list of IDs
+     */
+    sync(ids: any | any[] | Record<number | string, Record<string, any>>): Promise<{
+        attached: any[];
+        detached: any[];
+        updated: any[];
+    }>;
+    /**
+     * Sync without detaching
+     */
+    syncWithoutDetaching(ids: any | any[] | Record<number | string, Record<string, any>>): Promise<{
+        attached: any[];
+        updated: any[];
+    }>;
+    /**
+     * Toggle models from the parent
+     */
+    toggle(ids: any | any[]): Promise<{
+        attached: any[];
+        detached: any[];
+    }>;
+    /**
+     * Update an existing pivot record on the table
+     */
+    updateExistingPivot(id: any, attributes: Record<string, any>): Promise<number>;
+    /**
+     * Get the currently attached pivot IDs
+     */
+    protected getCurrentlyAttachedPivots(): Promise<any[]>;
+    /**
+     * Attach new records
+     */
+    protected attachNew(records: Array<{
+        id: any;
+        attributes: Record<string, any>;
+    }>, current: any[]): Promise<any[]>;
+    /**
+     * Update existing records
+     */
+    protected updateExisting(records: Array<{
+        id: any;
+        attributes: Record<string, any>;
+    }>, current: any[]): Promise<any[]>;
+    /**
+     * Format the records for attaching
+     */
+    protected formatAttachRecords(ids: any[], attributes: Record<string, any>): Record<string, any>[];
+    /**
+     * Format the sync records
+     */
+    protected formatRecordsList(ids: any[]): Array<{
+        id: any;
+        attributes: Record<string, any>;
+    }>;
+    /**
+     * Parse the IDs from the given value
+     */
+    protected parseIds(value: any): any[];
+    /**
+     * Get the name of the pivot accessor
+     */
+    getPivotAccessor(): string;
+    /**
+     * Set the name of the pivot accessor
+     */
+    as(accessor: string): this;
+    /**
+     * Get the pivot table name
+     */
+    getTable(): string;
+    /**
+     * Get the foreign pivot key name
+     */
+    getForeignPivotKeyName(): string;
+    /**
+     * Get the related pivot key name
+     */
+    getRelatedPivotKeyName(): string;
+    /**
+     * Get the parent key name
+     */
+    getParentKeyName(): string;
+    /**
+     * Get the related key name
+     */
+    getRelatedKeyName(): string;
+    /**
+     * Get the relationship name
+     */
+    getRelationName(): string;
+}
+//# sourceMappingURL=BelongsToMany.d.ts.map

package/dist/Database/Ensemble/Relations/BelongsToMany.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BelongsToMany.d.ts","sourceRoot":"","sources":["../../../../src/Database/Ensemble/Relations/BelongsToMany.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,qBAAa,aAAa,CAAC,QAAQ,SAAS,QAAQ,EAAE,OAAO,SAAS,QAAQ,CAAE,SAAQ,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IACjH;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,CAAM;IAEtC;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAM;IAEvG;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAM;IAElD;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,OAAO,CAAS;IAE3C;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAW;IAErC;;OAEG;gBAED,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,EAChC,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,MAAM,EACvB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,MAAM;IAYvB;;OAEG;IACH,cAAc,IAAI,IAAI;IAQtB;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,GAAG,IAAI;IAY9D;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAQrC;;OAEG;IACH,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAK5C;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE;IAQ5D;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE;IAiB5F;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC;IAkBzF;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUvC;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUhC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,GAAE,MAAM,EAAU,GAAG,MAAM,EAAE;IAQ3D;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,MAAM,EAAE;IASzC;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI;IAOxD;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAgBtE;;OAEG;IACH,SAAS,CAAC,+BAA+B,IAAI,MAAM;IAInD;;OAEG;IACH,SAAS,CAAC,+BAA+B,IAAI,MAAM;IAInD;;OAEG;IACH,SAAS,CAAC,yBAAyB,IAAI,MAAM;IAI7C;;OAEG;IACH,SAAS,CAAC,0BAA0B,IAAI,MAAM;IAI9C;;OAEG;IACH,SAAS,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IASrC;;OAEG;IACH,cAAc,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAS5D;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI;IAgB7D;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAIjD;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAIpD;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIvC;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI;IAS/D;;OAEG;IACG,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnF;;OAEG;IACG,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBhD;;OAEG;IACG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;QACnF,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,OAAO,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;IAyBF;;OAEG;IACG,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;QACnG,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,OAAO,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;IAeF;;OAEG;IACG,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC;QACtC,QAAQ,EAAE,GAAG,EAAE,CAAC;QAChB,QAAQ,EAAE,GAAG,EAAE,CAAC;KACjB,CAAC;IAyBF;;OAEG;IACG,mBAAmB,CAAC,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAapF;;OAEG;cACa,0BAA0B,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAU5D;;OAEG;cACa,SAAS,CACvB,OAAO,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,EAC5D,OAAO,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,GAAG,EAAE,CAAC;IAejB;;OAEG;cACa,cAAc,CAC5B,OAAO,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,EAC5D,OAAO,EAAE,GAAG,EAAE,GACb,OAAO,CAAC,GAAG,EAAE,CAAC;IAajB;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IA2BjG;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC;IAU5F;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE;IAoBrC;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK1B;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;OAEG;IACH,eAAe,IAAI,MAAM;CAG1B"}