fix!: renamed timestamp name methods

Renamed the following:
getDeletedAtColumn -> getDeletedAtName
getCreatedAtColumn -> getCreatedAtName
getUpdatedAtColumn -> getUpdatedAtName

Author: nandi95

src/Calliope/Concerns/BuildsQuery.ts

@@ -1037,7 +1037,7 @@ export default class BuildsQuery extends HasAttributes {
      * @return {this}
      */
     public latest(column?: string): this {
-        column = column ?? (this as unknown as Model).getCreatedAtColumn();
+        column = column ?? (this as unknown as Model).getCreatedAtName();
 
         return this.orderBy(this.setServerStringCase(column), 'desc');
     }
@@ -1063,7 +1063,7 @@ export default class BuildsQuery extends HasAttributes {
      * @return {this}
      */
     public oldest(column?: string): this {
-        column = column ?? (this as unknown as Model).getCreatedAtColumn();
+        column = column ?? (this as unknown as Model).getCreatedAtName();
 
         return this.orderBy(this.setServerStringCase(column), 'asc');
     }

src/Calliope/Concerns/HasTimestamps.ts

@@ -34,7 +34,7 @@ export default class HasTimestamps extends HasRelations {
      *
      * @return {string}
      */
-    public getCreatedAtColumn(): string {
+    public getCreatedAtName(): string {
         return this.setStringCase((this.constructor as unknown as HasTimestamps).createdAt as string);
     }
 
@@ -43,7 +43,7 @@ export default class HasTimestamps extends HasRelations {
      *
      * @return {string}
      */
-    public getUpdatedAtColumn(): string {
+    public getUpdatedAtName(): string {
         return this.setStringCase((this.constructor as unknown as HasTimestamps).updatedAt as string);
     }
 
@@ -69,7 +69,7 @@ export default class HasTimestamps extends HasRelations {
         // @ts-expect-error
         (this as unknown as Model).throwIfModelDoesntExistsWhenCalling('touch');
 
-        const updatedAt = this.getUpdatedAtColumn();
+        const updatedAt = this.getUpdatedAtName();
 
         return this.setEndpoint(finish(this.getEndpoint(), '/') + String((this as unknown as Model).getKey()))
             .patch({ [updatedAt]: new Date().toISOString() })
@@ -95,8 +95,8 @@ export default class HasTimestamps extends HasRelations {
         // @ts-expect-error
         (this as unknown as Model).throwIfModelDoesntExistsWhenCalling('freshTimestamps');
 
-        const createdAt = this.getCreatedAtColumn();
-        const updatedAt = this.getUpdatedAtColumn();
+        const createdAt = this.getCreatedAtName();
+        const updatedAt = this.getUpdatedAtName();
 
         return this.select([createdAt, updatedAt])
             .whereKey((this as unknown as Model).getKey()!)

src/Calliope/Concerns/SoftDeletes.ts

@@ -26,15 +26,15 @@ export default class SoftDeletes extends HasTimestamps {
      * @return {boolean}
      */
     public trashed(): boolean {
-        return !!this.getAttribute(this.getDeletedAtColumn());
+        return !!this.getAttribute(this.getDeletedAtName());
     }
 
     /**
      * Get the name of the deleted at attribute.
      *
      * @return {string}
      */
-    public getDeletedAtColumn(): string {
+    public getDeletedAtName(): string {
         return this.setStringCase((this.constructor as unknown as SoftDeletes).deletedAt as string);
     }
 
@@ -59,7 +59,7 @@ export default class SoftDeletes extends HasTimestamps {
             return super.delete(data);
         }
 
-        const deletedAt = this.getDeletedAtColumn();
+        const deletedAt = this.getDeletedAtName();
 
         if (this.getAttribute(deletedAt)) {
             return this as unknown as T;
@@ -84,7 +84,7 @@ export default class SoftDeletes extends HasTimestamps {
      * @return {Promise<this>}
      */
     public async restore(): Promise<this> {
-        if (!this.usesSoftDeletes() || !this.getAttribute(this.getDeletedAtColumn())) {
+        if (!this.usesSoftDeletes() || !this.getAttribute(this.getDeletedAtName())) {
             return this;
         }
 
@@ -96,9 +96,9 @@ export default class SoftDeletes extends HasTimestamps {
         }
 
         return this.setEndpoint(finish(this.getEndpoint(), '/') + String((this as unknown as Model).getKey()))
-            .patch({ [this.getDeletedAtColumn()]: null })
+            .patch({ [this.getDeletedAtName()]: null })
             .then(model => {
-                const deletedAt = this.getDeletedAtColumn();
+                const deletedAt = this.getDeletedAtName();
 
                 return this.setAttribute(deletedAt, model.getAttribute(deletedAt, null)).syncOriginal(deletedAt);
             });

src/Calliope/Factory/FactoryBuilder.ts

@@ -317,12 +317,12 @@ export default class FactoryBuilder<T extends Model> {
         }
 
         if (model.usesTimestamps()) {
-            if (!model.getAttribute(model.getCreatedAtColumn())) {
-                model.setAttribute(model.getCreatedAtColumn(), new Date().toISOString());
+            if (!model.getAttribute(model.getCreatedAtName())) {
+                model.setAttribute(model.getCreatedAtName(), new Date().toISOString());
             }
 
-            if (!model.getAttribute(model.getUpdatedAtColumn())) {
-                model.setAttribute(model.getUpdatedAtColumn(), new Date().toISOString());
+            if (!model.getAttribute(model.getUpdatedAtName())) {
+                model.setAttribute(model.getUpdatedAtName(), new Date().toISOString());
             }
         }
 
@@ -404,12 +404,12 @@ export default class FactoryBuilder<T extends Model> {
             });
 
             if (this.model.usesTimestamps()) {
-                attributes[this.model.getCreatedAtColumn()] = attributes[this.model.getCreatedAtColumn()] ?? null;
-                attributes[this.model.getUpdatedAtColumn()] = attributes[this.model.getUpdatedAtColumn()] ?? null;
+                attributes[this.model.getCreatedAtName()] = attributes[this.model.getCreatedAtName()] ?? null;
+                attributes[this.model.getUpdatedAtName()] = attributes[this.model.getUpdatedAtName()] ?? null;
             }
 
             if (this.model.usesSoftDeletes()) {
-                attributes[this.model.getDeletedAtColumn()] = attributes[this.model.getDeletedAtColumn()] ?? null;
+                attributes[this.model.getDeletedAtName()] = attributes[this.model.getDeletedAtName()] ?? null;
             }
 
             compiledAttributeArray.push(this.resolveAttributes(attributes, compiledAttributes));

src/Calliope/Model.ts

@@ -30,11 +30,11 @@ export default class Model extends SoftDeletes implements HasFactory {
         const lastSyncedAt = '_' + this.setStringCase('last_synced_at');
 
         if (boolean && this.usesTimestamps()) {
-            boolean = !!this.getAttribute(this.getCreatedAtColumn());
+            boolean = !!this.getAttribute(this.getCreatedAtName());
         }
 
         if (boolean && this.usesSoftDeletes()) {
-            boolean = !this.getAttribute(this.getDeletedAtColumn());
+            boolean = !this.getAttribute(this.getDeletedAtName());
         }
 
         return boolean && lastSyncedAt in this && !!this[lastSyncedAt];
@@ -92,9 +92,9 @@ export default class Model extends SoftDeletes implements HasFactory {
     public replicate(except?: MaybeArray<string>): this {
         const excluded = new Set([
             this.getKeyName(),
-            this.getCreatedAtColumn(),
-            this.getUpdatedAtColumn(),
-            this.getDeletedAtColumn()
+            this.getCreatedAtName(),
+            this.getUpdatedAtName(),
+            this.getDeletedAtName()
         ]);
 
         if (except) {

tests/Calliope/Concerns/BuildsQuery.test.ts

@@ -946,7 +946,7 @@ describe('BuildsQuery', () => {
         it('should be able to be called statically', () => {
             // it will be present when used from the model
             // eslint-disable-next-line jest/unbound-method,@typescript-eslint/unbound-method
-            BuildsQuery.prototype.getCreatedAtColumn = builder.getCreatedAtColumn;
+            BuildsQuery.prototype.getCreatedAtName = builder.getCreatedAtName;
 
             builder = BuildsQuery.latest();
             // @ts-expect-error
@@ -972,7 +972,7 @@ describe('BuildsQuery', () => {
         it('should be able to be called statically', () => {
             // it will be present when used from the model
             // eslint-disable-next-line jest/unbound-method,@typescript-eslint/unbound-method
-            BuildsQuery.prototype.getCreatedAtColumn = builder.getCreatedAtColumn;
+            BuildsQuery.prototype.getCreatedAtName = builder.getCreatedAtName;
 
             builder = BuildsQuery.oldest();
             // @ts-expect-error

tests/Calliope/Concerns/HasTimestamps.test.ts

@@ -14,14 +14,14 @@ describe('HasTimestamps', () => {
         fetchMock.mockResponseOnce(async () => Promise.resolve(
             buildResponse(User.factory()
                 .create()
-                .only([hasTimestamps.getCreatedAtColumn(), hasTimestamps.getUpdatedAtColumn()])
+                .only([hasTimestamps.getCreatedAtName(), hasTimestamps.getUpdatedAtName()])
             )
         ));
     });
 
     describe('getCreatedAtColumn', () => {
         it('should return the createdAt column', () => {
-            expect(hasTimestamps.getCreatedAtColumn()).toBe('createdAt');
+            expect(hasTimestamps.getCreatedAtName()).toBe('createdAt');
         });
 
         it('should return the createdAt column correctly if overridden', () => {
@@ -30,13 +30,13 @@ describe('HasTimestamps', () => {
             }
             hasTimestamps = new MyUser;
 
-            expect(hasTimestamps.getCreatedAtColumn()).toBe('myCreatedAt');
+            expect(hasTimestamps.getCreatedAtName()).toBe('myCreatedAt');
         });
     });
 
     describe('getUpdatedAtColumn', () => {
         it('should return the updatedAt column', () => {
-            expect(hasTimestamps.getUpdatedAtColumn()).toBe('updatedAt');
+            expect(hasTimestamps.getUpdatedAtName()).toBe('updatedAt');
         });
 
         it('should return the updatedAt column correctly if overridden', () => {
@@ -45,7 +45,7 @@ describe('HasTimestamps', () => {
             }
             hasTimestamps = new MyUser;
 
-            expect(hasTimestamps.getUpdatedAtColumn()).toBe('myUpdatedAt');
+            expect(hasTimestamps.getUpdatedAtName()).toBe('myUpdatedAt');
         });
     });
 
@@ -75,14 +75,14 @@ describe('HasTimestamps', () => {
         });
 
         it('should update the timestamps', async () => {
-            const createdAt = hasTimestamps.getAttribute(hasTimestamps.getCreatedAtColumn());
-            const updatedAt = hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtColumn());
+            const createdAt = hasTimestamps.getAttribute(hasTimestamps.getCreatedAtName());
+            const updatedAt = hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtName());
 
             jest.advanceTimersByTime(1000);
             await hasTimestamps.touch();
 
-            expect(hasTimestamps.getAttribute(hasTimestamps.getCreatedAtColumn())).toBe(createdAt);
-            expect(hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtColumn())).not.toBe(updatedAt);
+            expect(hasTimestamps.getAttribute(hasTimestamps.getCreatedAtName())).toBe(createdAt);
+            expect(hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtName())).not.toBe(updatedAt);
         });
 
         it('should throw an error if updated at column is not in the response',  async () => {
@@ -93,7 +93,7 @@ describe('HasTimestamps', () => {
             const failingFunc = jest.fn(async () => hasTimestamps.touch());
 
             await expect(failingFunc).rejects.toThrow(new InvalidArgumentException(
-                '\'' + hasTimestamps.getUpdatedAtColumn() + '\' is not found in the response model.'
+                '\'' + hasTimestamps.getUpdatedAtName() + '\' is not found in the response model.'
             ));
         });
 
@@ -141,14 +141,14 @@ describe('HasTimestamps', () => {
                 buildResponse({ updated_at: new Date().toISOString(), created_at: new Date().toISOString() })
             ));
 
-            const createdAt = hasTimestamps.getAttribute(hasTimestamps.getCreatedAtColumn());
-            const updatedAt = hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtColumn());
+            const createdAt = hasTimestamps.getAttribute(hasTimestamps.getCreatedAtName());
+            const updatedAt = hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtName());
 
             jest.advanceTimersByTime(1000);
             await hasTimestamps.freshTimestamps();
 
-            expect(hasTimestamps.getAttribute(hasTimestamps.getCreatedAtColumn())).not.toBe(createdAt);
-            expect(hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtColumn())).not.toBe(updatedAt);
+            expect(hasTimestamps.getAttribute(hasTimestamps.getCreatedAtName())).not.toBe(createdAt);
+            expect(hasTimestamps.getAttribute(hasTimestamps.getUpdatedAtName())).not.toBe(updatedAt);
         });
 
         it('should return itself instead of new instance', async () => {
@@ -166,7 +166,7 @@ describe('HasTimestamps', () => {
             const failingFunc = jest.fn(async () => hasTimestamps.freshTimestamps());
 
             await expect(failingFunc).rejects.toThrow(new InvalidArgumentException(
-                '\'' + hasTimestamps.getCreatedAtColumn() + '\' is not found in the response model.'
+                '\'' + hasTimestamps.getCreatedAtName() + '\' is not found in the response model.'
             ));
         });
 
@@ -178,7 +178,7 @@ describe('HasTimestamps', () => {
             const failingFunc = jest.fn(async () => hasTimestamps.freshTimestamps());
 
             await expect(failingFunc).rejects.toThrow(new InvalidArgumentException(
-                '\'' + hasTimestamps.getUpdatedAtColumn() + '\' is not found in the response model.'
+                '\'' + hasTimestamps.getUpdatedAtName() + '\' is not found in the response model.'
             ));
         });