@cratis/arc 18.0.0

package/queries/for_QueryFor/when_performing/with_valid_arguments.ts

@@ -0,0 +1,87 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { a_query_for } from '../given/a_query_for';
+import { given } from '../../../given';
+import * as sinon from 'sinon';
+import { QueryResult } from '../../QueryResult';
+
+describe('with valid arguments', given(a_query_for, context => {
+    let result: QueryResult<string>;
+    let fetchStub: sinon.SinonStub;
+    const mockResponse = {
+        data: 'test-result',
+        isSuccess: true,
+        isAuthorized: true,
+        isValid: true,
+        hasExceptions: false,
+        validationResults: [],
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: {
+            totalItems: 0,
+            totalPages: 0,
+            page: 0,
+            size: 0
+        }
+    };
+
+    beforeEach(async () => {
+        // Setup fetch mock
+        fetchStub = sinon.stub(global, 'fetch');
+        fetchStub.resolves({
+            json: sinon.stub().resolves(mockResponse),
+            ok: true,
+            status: 200
+        } as unknown as Response);
+
+        context.query.setOrigin('https://api.example.com');
+        context.query.setApiBasePath('/api/v1');
+        context.query.setMicroservice('test-service');
+
+        // Call perform with valid arguments
+        result = await context.query.perform({ id: 'test-id' });
+    });
+
+    afterEach(() => {
+        fetchStub.restore();
+    });
+
+    it('should return successful result', () => {
+        result.isSuccess.should.be.true;
+    });
+
+    it('should return correct data', () => {
+        result.data.should.equal('test-result');
+    });
+
+    it('should have data', () => {
+        result.hasData.should.be.true;
+    });
+
+    it('should call fetch with correct URL', () => {
+        fetchStub.should.have.been.calledOnce;
+        const call = fetchStub.getCall(0);
+        call.args[0].href.should.equal('https://api.example.com/api/v1/api/test/test-id');
+    });
+
+    it('should call fetch with correct headers', () => {
+        const call = fetchStub.getCall(0);
+        const options = call.args[1];
+        options.headers['Accept'].should.equal('application/json');
+        options.headers['Content-Type'].should.equal('application/json');
+        options.headers['x-cratis-microservice'].should.equal('test-service');
+    });
+
+    it('should call fetch with GET method', () => {
+        const call = fetchStub.getCall(0);
+        const options = call.args[1];
+        options.method.should.equal('GET');
+    });
+
+    it('should set abort controller signal', () => {
+        const call = fetchStub.getCall(0);
+        const options = call.args[1];
+        options.signal.should.not.be.undefined;
+    });
+}));

package/queries/for_QueryFor/when_setting_api_base_path.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { a_query_for } from './given/a_query_for';
+import { given } from '../../given';
+
+describe('when setting api base path', given(a_query_for, context => {
+    const apiBasePath = '/api/v1';
+
+    beforeEach(() => {
+        context.query.setApiBasePath(apiBasePath);
+    });
+
+    it('should set the api base path', () => {
+        // Access the private field through type assertion to test internal state
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ((context.query as any)._apiBasePath).should.equal(apiBasePath);
+    });
+}));

package/queries/for_QueryFor/when_setting_microservice.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { a_query_for } from './given/a_query_for';
+import { given } from '../../given';
+
+describe('when setting microservice', given(a_query_for, context => {
+    const microservice = 'my-microservice';
+
+    beforeEach(() => {
+        context.query.setMicroservice(microservice);
+    });
+
+    it('should set the microservice', () => {
+        // Access the private field through type assertion to test internal state
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ((context.query as any)._microservice).should.equal(microservice);
+    });
+}));

package/queries/for_QueryFor/when_setting_origin.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { a_query_for } from './given/a_query_for';
+import { given } from '../../given';
+
+describe('when setting origin', given(a_query_for, context => {
+    const origin = 'https://api.example.com';
+
+    beforeEach(() => {
+        context.query.setOrigin(origin);
+    });
+
+    it('should set the origin', () => {
+        // Access the private field through type assertion to test internal state
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ((context.query as any)._origin).should.equal(origin);
+    });
+}));

package/queries/for_QueryResult/when_asking_has_data/and_it_an_array_with_items.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { QueryResult } from '../../QueryResult';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+describe("when asking has data and it is an array with items", () => {
+    const queryResult = new QueryResult<object>({
+        isSuccess: true,
+        isAuthorized: true,
+        isValid: true,
+        hasExceptions: false,
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: {
+            totalItems: 0,
+            totalPages: 0,
+            page: 0,
+            items: 0
+        },
+        validationResults: [],
+        data: [{}, {}]
+    }, Object, true);
+
+    it('should consider having data', () => queryResult.hasData.should.be.true);
+});

package/queries/for_QueryResult/when_asking_has_data/and_it_is_defined_instance.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { QueryResult } from '../../QueryResult';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+describe("when asking has data and it is defined instance", () => {
+    const queryResult = new QueryResult<any>({
+        isSuccess: true,
+        isAuthorized: true,
+        isValid: true,
+        hasExceptions: false,
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: {
+            totalItems: 0,
+            totalPages: 0,
+            page: 0,
+            items: 0
+        },
+        validationResults: [],
+        data: {}
+    }, Object, false);
+
+    it('should considered to have data', () => queryResult.hasData.should.be.true);
+});

package/queries/for_QueryResult/when_asking_has_data/and_it_is_empty_array.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { QueryResult } from '../../QueryResult';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+describe("when asking has data and it is empty array", () => {
+    const queryResult = new QueryResult<any>({
+        isSuccess: true,
+        isAuthorized: true,
+        isValid: true,
+        hasExceptions: false,
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: {
+            totalItems: 0,
+            totalPages: 0,
+            page: 0,
+            items: 0
+        },
+        validationResults: [],
+        data: []
+    }, Object, true);
+
+    it('should consider to not having data', () => queryResult.hasData.should.be.false);
+});

package/queries/for_QueryResult/when_asking_has_data/and_it_is_undefined.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { QueryResult } from '../../QueryResult';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+describe("when asking has data and it is undefined", () => {
+    const queryResult = new QueryResult<any>({
+        isSuccess: true,
+        isAuthorized: true,
+        isValid: true,
+        hasExceptions: false,
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: {
+            totalItems: 0,
+            totalPages: 0,
+            page: 0,
+            items: 0
+        },
+        validationResults: [],
+        data:undefined
+    }, Object, true);
+
+    it('should considered to not having data', () => queryResult.hasData.should.be.false);
+});

package/queries/index.ts

@@ -0,0 +1,21 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './IQuery';
+export * from './IQueryFor';
+export * from './Paging';
+export * from './Sorting';
+export * from './SortDirection';
+export * from './SortingActions';
+export * from './SortingActionsForQuery';
+export * from './SortingActionsForObservableQuery';
+export * from './QueryFor';
+export * from './QueryResult';
+export * from './QueryResultWithState';
+export * from './IObservableQueryFor';
+export * from './ObservableQueryFor';
+export * from './IObservableQueryConnection';
+export * from './ObservableQueryConnection';
+export * from './ObservableQuerySubscription';
+export * from './IQueryProvider';
+export * from './QueryProvider';

package/reflection/IHaveParameters.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ParameterDescriptor } from './ParameterDescriptor';
+
+/**
+ * Defines something that has parameters.
+ */
+export interface IHaveParameters {
+    readonly parameterDescriptors: ParameterDescriptor[];
+}

package/reflection/ParameterDescriptor.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Constructor } from '@cratis/fundamentals';
+
+/**
+ * Represents a parameter descriptor.
+ */
+export class ParameterDescriptor {
+    /**
+     * Initializes a new instance of the {@link ParameterDescriptor} class.
+     * @param name Name of the parameter.
+     * @param type Type of the parameter.
+     */
+    constructor(readonly name: string, readonly type: Constructor) {
+    }
+}

package/reflection/ParametersHelper.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { IHaveParameters } from './IHaveParameters';
+
+/**
+ * Helper for working with types that have parameters.
+ */
+export const ParametersHelper = {
+    /**
+     * Collects the parameter values from an instance based on its parameter descriptors.
+     * @param instance The instance to collect parameter values from.
+     * @returns A record of parameter names to their values.
+     */
+    collectParameterValues(instance: IHaveParameters): Record<string, unknown> {
+        const values: Record<string, unknown> = {};
+        for (const descriptor of instance.parameterDescriptors) {
+            const value = (instance as unknown as Record<string, unknown>)[descriptor.name];
+            if (value !== undefined && value !== null) {
+                values[descriptor.name] = value;
+            }
+        }
+        return values;
+    }
+};

package/reflection/PropertyDescriptor.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Constructor } from '@cratis/fundamentals';
+
+/**
+ * Represents a property descriptor.
+ */
+export class PropertyDescriptor {
+    /**
+     * Initializes a new instance of the {@link PropertyDescriptor} class.
+     * @param name Name of the property.
+     * @param type Type of the property.
+     */
+    constructor(readonly name: string, readonly type: Constructor) {
+    }
+}

package/reflection/index.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './IHaveParameters';
+export * from './ParameterDescriptor';
+export * from './ParametersHelper';
+export * from './PropertyDescriptor';

package/validation/ValidationResult.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ValidationResultSeverity } from './ValidationResultSeverity';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * Represents a validation error with a message for one or more members.
+ */
+export class ValidationResult {
+    constructor(readonly severity: ValidationResultSeverity, readonly message: string, readonly members: string[], readonly state: any) {
+    }
+}
+
+

package/validation/ValidationResultSeverity.ts

@@ -0,0 +1,28 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * Holds the values for severity of a validation result.
+ */
+export enum ValidationResultSeverity {
+
+    /**
+     * The validation result is unknown.
+     */
+    Unknown = 0,
+
+    /**
+     * The validation result is a warning.
+     */
+    Information = 1,
+
+    /**
+     * The validation result is a warning.
+     */
+    Warning = 2,
+
+    /**
+     * The validation result is an error.
+     */
+    Error = 3
+}

package/validation/Validator.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * Represents a validator.
+ */
+export class Validator {
+
+    /**
+     * Gets whether or not is valid.
+     */
+    get isValid() {
+        return true;
+    }
+}

package/validation/index.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './Validator';
+export * from './ValidationResult';