Merge branch 'release/0.x' into feat/various

Author: nandi95

.github/workflows/deploy-api-docs.yml

@@ -24,8 +24,7 @@ jobs:
           git add -f assets
           git add -f classes
           git add -f interfaces
-          touch .nojekyll
-          git add -f .nojekyll
+          git add -f '.nojekyll'
           git add -f index.html
           git add -f modules.html
           git commit -m "Updates from ${{ github.ref }}" --no-verify

docs/calliope/readme.md

@@ -170,7 +170,7 @@ Bundlers/minifier options examples:
 #### create
 <Badge text="static" type="warning"/>
 
-The `create` method instantiates your model while setting up attributes and relations. This will mass assign attributes to the model while respecting the [guarding](./attributes#guarding) settings.
+The `create` method instantiates your model while setting up attributes and relations.
 
 ```ts
 import User from '@Models/User';
@@ -181,18 +181,6 @@ const user = User.create({ name: 'User Name' }); // User
 Constructing a new class like `new User({...})` is **not** acceptable. This will not overwrite your class fields with default values if the same key has been passed in due to how JavaScript first constructs the parent class and only then the subclasses. However, you can still use it to call instance methods. Furthermore, it will not cause unexpected results if using it with the [setAttribute](./attributes.md#setattribute) method or call methods that under the hood uses the [setAttribute](./attributes.md#setattribute).
 :::
 
-::: tip
-When creating an instance and passing in another instance of the model:
-```js
-import User from '@Models/User';
-import Shift from '@Models/Shift';
-
-const user = User.create({ name: 'John Doe' });
-const newUser = User.create(user);
-```
-It will clone the [raw attributes](./attributes#getrawattributes) and the [relationships](./relationships.md#getrelations) of the model.
-:::
-
 #### replicate
 
 The `replicate` method copies the instance into a non-existent instance. Meaning primary key and the timestamps won't be copied.

docs/testing.md

@@ -105,7 +105,7 @@ import type { Attributes } from '@upfrontjs/framework';
 import type User from './src/Models/User';
 
 export default UserFactory extends Factory<User> {
-    public definition(model: T, index: number): Attributes<User> {
+    definition(model: T, index: number): Attributes<User> {
         return {
             name: 'user name',
             someUuid: String.uuid()

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@upfrontjs/framework",
-    "version": "0.9.0",
+    "version": "0.8.2",
     "description": "Data handling framework complementary to backend model systems.",
     "main": "index.min.js",
     "module": "index.es.min.js",

package.json

@@ -204,7 +204,7 @@ export default class CallsApi extends BuildsQuery {
      * @return
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
-    public async post<T extends Model = this>(data: FormData | SimpleAttributes | SimpleAttributes<this>): Promise<T> {
+    public async post<T extends Model = this>(data: Attributes | FormData): Promise<T> {
         return this.call('POST', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
@@ -217,7 +217,7 @@ export default class CallsApi extends BuildsQuery {
      * @return
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
-    public async put<T extends Model = this>(data: FormData | SimpleAttributes | SimpleAttributes<this>): Promise<T> {
+    public async put<T extends Model = this>(data: Attributes | FormData): Promise<T> {
         return this.call('PUT', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
@@ -230,7 +230,7 @@ export default class CallsApi extends BuildsQuery {
      * @return
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
-    public async patch<T extends Model = this>(data: FormData | SimpleAttributes | SimpleAttributes<this>): Promise<T> {
+    public async patch<T extends Model = this>(data: Attributes | FormData): Promise<T> {
         return this.call('PATCH', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }
@@ -244,9 +244,7 @@ export default class CallsApi extends BuildsQuery {
      * @return {Promise<boolean>}
      */
     // @ts-expect-error - despite TS2526, it still infers correctly
-    public async delete<T extends Model = this>(
-        data?: FormData | SimpleAttributes | SimpleAttributes<this>
-    ): Promise<T> {
+    public async delete<T extends Model = this>(data?: Attributes | FormData): Promise<T> {
         return this.call('DELETE', data)
             .then(responseData => this.getResponseModel<T>(this.getDataFromResponse(responseData)));
     }

src/Calliope/Concerns/CallsApi.ts

@@ -448,8 +448,8 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {any}
      */
-    public getOriginal<K extends SimpleAttributeKeys<this> | string, T extends this[K]>(key: K, defaultValue?: T): T;
-    public getOriginal(): SimpleAttributes<this>;
+    public getOriginal<K extends AttributeKeys<this> | string, T extends this[K]>(key: K, defaultValue?: T): T;
+    public getOriginal(): Attributes<this>;
     public getOriginal(key?: string, defaultValue?: unknown): unknown {
         const getOriginalValue = (attributeKey: string) => {
             if (this.hasGetAccessor(attributeKey)) {
@@ -480,8 +480,8 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {any}
      */
-    public getRawOriginal<K extends SimpleAttributeKeys<this> | string, T extends this[K]>(key: K, defaultValue?: T): T;
-    public getRawOriginal(): SimpleAttributes<this>;
+    public getRawOriginal<K extends AttributeKeys<this> | string, T extends this[K]>(key: K, defaultValue?: T): T;
+    public getRawOriginal(): Attributes<this>;
     public getRawOriginal(key?: string, defaultValue?: unknown): unknown {
         if (key) {
             return this.original.hasOwnProperty(key) ? cloneDeep(this.original[key]) : defaultValue;
@@ -497,9 +497,9 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {object}
      */
-    public getChanges<K extends SimpleAttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
-    public getChanges(key?: string): Partial<SimpleAttributes<this>>;
-    public getChanges(key?: string): SimpleAttributes {
+    public getChanges<K extends AttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
+    public getChanges(key?: string): Partial<Attributes<this>>;
+    public getChanges(key?: string): Attributes {
         if (key) {
             if (isEqual(this.getRawOriginal(key), this.attributes[key])) {
                 return {};
@@ -528,9 +528,9 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {object}
      */
-    public getDeletedAttributes<K extends SimpleAttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
-    public getDeletedAttributes(key?: string): Partial<SimpleAttributes<this>>;
-    public getDeletedAttributes(key?: string): SimpleAttributes {
+    public getDeletedAttributes<K extends AttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
+    public getDeletedAttributes(key?: string): Partial<Attributes<this>>;
+    public getDeletedAttributes(key?: string): Attributes {
         if (key) {
             if (key in this.original) {
                 if (key in this.attributes) {
@@ -564,9 +564,9 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {object}
      */
-    public getNewAttributes<K extends SimpleAttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
-    public getNewAttributes(key?: string): Partial<SimpleAttributes<this>>;
-    public getNewAttributes(key?: string): SimpleAttributes {
+    public getNewAttributes<K extends AttributeKeys<this>>(key: K): Record<K, this[K] | undefined>;
+    public getNewAttributes(key?: string): Partial<Attributes<this>>;
+    public getNewAttributes(key?: string): Attributes {
         if (key) {
             if (key in this.attributes) {
                 if (key in this.original) {
@@ -640,11 +640,11 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      * @return {object}
      */
     public only<
-        K extends SimpleAttributeKeys<this>[],
-        R = { [P in K[number]]?: SimpleAttributes<this>[P] }
+        K extends AttributeKeys<this>[],
+        R = { [P in K[number]]?: Attributes<this>[P] }
     >(attributes: K): R;
-    public only<K extends SimpleAttributeKeys<this>, R = Record<K, this[K]>>(attributes: K): R;
-    public only(attributes: MaybeArray<string>): SimpleAttributes {
+    public only<K extends AttributeKeys<this>, R = Record<K, this[K]>>(attributes: K): R;
+    public only(attributes: MaybeArray<string>): Attributes {
         attributes = Array.isArray(attributes) ? attributes : [attributes];
         const result: Attributes = {};
 
@@ -664,9 +664,9 @@ export default class HasAttributes extends GuardsAttributes implements Jsonable,
      *
      * @return {object}
      */
-    public except<K extends SimpleAttributeKeys<this>[], R = Omit<SimpleAttributes<this>, K[number]>>(attributes: K): R;
-    public except<K extends SimpleAttributeKeys<this> | string, R = Omit<SimpleAttributes<this>, K>>(attributes: K): R;
-    public except(attributes: MaybeArray<string>): SimpleAttributes {
+    public except<K extends AttributeKeys<this>[], R = Omit<Attributes<this>, K[number]>>(attributes: K): R;
+    public except<K extends AttributeKeys<this> | string, R = Omit<Attributes<this>, K>>(attributes: K): R;
+    public except(attributes: MaybeArray<string>): Attributes {
         const result: Attributes = {};
 
         attributes = Array.isArray(attributes) ? attributes : [attributes];

src/Calliope/Concerns/HasAttributes.ts

@@ -4,7 +4,7 @@ import type HasFactory from '../Contracts/HasFactory';
 import type { Attributes, AttributeKeys, SimpleAttributes } from './Concerns/HasAttributes';
 import ModelCollection from './ModelCollection';
 import LogicException from '../Exceptions/LogicException';
-import { finish } from '../Support/string';
+import { finish, isUuid } from '../Support/string';
 import type { MaybeArray, StaticToThis } from '../Support/type';
 import { cloneDeep } from 'lodash';
 import { isObjectLiteral } from '../Support/function';
@@ -79,7 +79,7 @@ export default class Model extends SoftDeletes implements HasFactory {
      *
      * @return {this}
      */
-    public new(attributes?: Attributes<this> | this): this {
+    public new(attributes?: Attributes<this> | Model): this {
         return (this.constructor as typeof Model).create(attributes) as this;
     }
 
@@ -100,10 +100,10 @@ export default class Model extends SoftDeletes implements HasFactory {
         if (attributes instanceof Model) {
             // if creating by passing a model, we'll take the attributes
             // in their current state, not the original.
-            const allProperties = attributes.getRawAttributes() as Attributes<T>;
+            const allProperties = (attributes as T).getRawAttributes();
 
-            if (isObjectLiteral(attributes.relations)) {
-                Object.assign(allProperties, attributes.getRelations());
+            if (isObjectLiteral((attributes as T).relations)) {
+                Object.assign(allProperties, cloneDeep((attributes as T).relations));
             }
 
             attributes = allProperties;

src/Calliope/Model.ts

@@ -419,7 +419,7 @@ export default class ModelCollection<T extends Model> extends Collection<T> {
     /**
      * @inheritDoc
      */
-    public override toJSON<R extends ReturnType<typeof JSON.parse> = RawAttributes<T>>(): { elements: R[] } {
+    public override toJSON(): { elements: ReturnType<T['toJSON']>[] } {
         // eslint-disable-next-line max-len
         // https://security.stackexchange.com/questions/7001/how-should-web-app-developers-defend-against-json-hijacking/7003#7003
         return { elements: this.toArray().map(model => model.toJSON()) };

src/Calliope/ModelCollection.ts

@@ -42,7 +42,7 @@ export default class API implements ApiCaller {
         url: string,
         method: 'HEAD' | 'head',
         data?: FormData | Record<string, unknown>,
-        customHeaders?: CustomHeaders,
+        customHeaders?: Record<string, MaybeArray<string>>,
         queryParameters?: Record<string, unknown>
     ): Promise<ApiResponse & { request: { method: 'HEAD' } }>;
     public async call<T>(
@@ -56,7 +56,7 @@ export default class API implements ApiCaller {
         url: string,
         method: Method,
         data?: FormData | Record<string, unknown>,
-        customHeaders?: CustomHeaders,
+        customHeaders?: Record<string, MaybeArray<string>>,
         queryParameters?: Record<string, unknown>
     ): Promise<ApiResponse> {
         const config = await this.initConfig(url, method, data, customHeaders, queryParameters);

src/Services/API.ts

@@ -37,8 +37,7 @@ import type { QueryParams } from './Calliope/Concerns/BuildsQuery';
 import type FormatsQueryParameters from './Contracts/FormatsQueryParameters';
 import type { ApiResponse } from './Contracts/HandlesApiResponse';
 import type { Events, Listener } from './Support/EventEmitter';
-import type { Method, CustomHeaders } from './Calliope/Concerns/CallsApi';
-import type { ResolvableAttributes } from './Calliope/Factory/FactoryBuilder';
+import type { Method } from './Calliope/Concerns/CallsApi';
 
 export type {
     AttributeCaster,
@@ -54,12 +53,7 @@ export type {
     Events,
     Listener,
     AttributeKeys,
-    Method,
-    SimpleAttributes,
-    SimpleAttributeKeys,
-    CustomHeaders,
-    RawAttributes,
-    ResolvableAttributes
+    Method
 };
 
 export * from './Support/type';

src/index.ts

@@ -218,7 +218,7 @@ describe('CallsApi', () => {
         });
 
         it('should send all the given data', async () => {
-            mockUserModelResponse(User.factory().makeOne());
+            fetchMock.mockResponseOnce(async () => Promise.resolve(buildResponse(User.factory().raw())));
             await caller.call('POST', {
                 falsyKey1: null,
                 falsyKey2: undefined,

tests/Calliope/Concerns/CallsApi.test.ts

@@ -318,7 +318,7 @@ describe('HasAttributes', () => {
 
         it('should overwrite existing descriptors', () => {
             class ModelWithProperties extends User {
-                public attribute1?: string;
+                public attribute1?: string;
 
                 public attribute2 = 1;
 

tests/Calliope/Concerns/HasAttributes.test.ts

@@ -60,11 +60,6 @@ describe('FactoryBuilder', () => {
         });
 
         it('should throw an error if the given state is not a function', () => {
-            class FakeFactory extends Factory<User> {
-                // @ts-expect-error
-                public scopeAsProperty = 0;
-            }
-
             // @ts-expect-error
             User.prototype.factory = () => new FakeFactory();
 
@@ -80,12 +75,6 @@ describe('FactoryBuilder', () => {
         });
 
         it('should throw an error if the given state is not a returning an object', () => {
-            class FakeFactory extends Factory<User> {
-                public invalidScope() {
-                    return null;
-                }
-            }
-
             // @ts-expect-error
             User.prototype.factory = () => new FakeFactory();
 

tests/Calliope/Factory/FactoryBuilder.test.ts

@@ -1,6 +1,6 @@
 import API from '../../src/Services/API';
 import { config as globalConfig } from '../setupTests';
-import type { CustomHeaders, Method } from '../../src/Calliope/Concerns/CallsApi';
+import type { Method } from '../../src/Calliope/Concerns/CallsApi';
 import { finish } from '../../src/Support/string';
 import InvalidArgumentException from '../../src/Exceptions/InvalidArgumentException';