@opra/sqb 1.0.0-alpha.9 → 1.0.0-beta.2

package/types/index.d.cts

@@ -0,0 +1,7 @@
+import './augmentation/datatype-factory.augmentation.js';
+import './augmentation/mapped-type.augmentation.js';
+import './augmentation/mixin-type.augmentation.js';
+export * from './sqb-adapter.js';
+export * from './sqb-collection-service.js';
+export * from './sqb-entity-service.js';
+export * from './sqb-singleton-service.js';

package/types/sqb-collection-service.d.ts

@@ -1,4 +1,4 @@
-import { PartialDTO, PatchDTO, Type } from 'ts-gems';
+import type { PartialDTO, PatchDTO, RequiredSome, Type } from 'ts-gems';
 import { SQBAdapter } from './sqb-adapter.js';
 import { SqbEntityService } from './sqb-entity-service.js';
 /**
@@ -7,7 +7,7 @@ import { SqbEntityService } from './sqb-entity-service.js';
 export declare namespace SqbCollectionService {
     interface Options extends SqbEntityService.Options {
         defaultLimit?: SqbCollectionService<any>['defaultLimit'];
-        interceptor?: SqbCollectionService<any>['$interceptor'];
+        interceptor?: SqbCollectionService<any>['interceptor'];
     }
     /**
      * Represents options for "create" operation
@@ -70,14 +70,14 @@ export declare namespace SqbCollectionService {
      *
      * @interface
      */
-    interface UpdateOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOptions extends SqbEntityService.UpdateOneOptions {
     }
     /**
      * Represents options for "updateOnly" operation
      *
      * @interface
      */
-    interface UpdateOnlyOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOnlyOptions extends SqbEntityService.UpdateOneOptions {
     }
     /**
      * Represents options for "updateMany" operation
@@ -122,7 +122,17 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
      * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created resource
      * @throws {Error} if an unknown error occurs while creating the resource
      */
-    create(input: PartialDTO<T>, options?: SqbCollectionService.CreateOptions): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options: RequiredSome<SqbCollectionService.CreateOptions, 'projection'>): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: SqbCollectionService.CreateOptions): Promise<T>;
+    /**
+     * Creates a new resource
+     *
+     * @param {PartialDTO<T>} input - The input data
+     * @param {SqbCollectionService.CreateOptions} [options] - The options object
+     * @returns {Promise<void>} A promise that resolves create operation result
+     * @throws {Error} if an unknown error occurs while creating the resource
+     */
+    createOnly(input: PartialDTO<T>, options?: SqbCollectionService.CreateOptions): Promise<void>;
     /**
      * Returns the count of records based on the provided options
      *
@@ -163,11 +173,11 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
     /**
      * Finds a record by ID.
      *
-     * @param {SQBAdapter.Id} id - The ID of the record.
+     * @param {SQBAdapter.IdOrIds} id - The ID of the record.
      * @param {SqbCollectionService.FindOneOptions} [options] - The options for the find query.
      * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
      */
-    findById(id: SQBAdapter.Id, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    findById(id: SQBAdapter.IdOrIds, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds a record in the collection that matches the specified options.
      *
@@ -196,13 +206,13 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
     /**
      * Retrieves a records from the collection by its ID. Throws error if not found.
      *
-     * @param {SQBAdapter.Id} id - The ID of the document to retrieve.
+     * @param {SQBAdapter.IdOrIds} id - The ID of the document to retrieve.
      * @param {SqbCollectionService.FindOneOptions} [options] - Optional options for the findOne operation.
      * @returns {Promise<PartialDTO<T>>} - A promise that resolves to the retrieved document,
      *    or rejects with a ResourceNotFoundError if the document does not exist.
      * @throws {ResourceNotAvailableError} - If the document with the specified ID does not exist.
      */
-    get(id: SQBAdapter.Id, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T>>;
+    get(id: SQBAdapter.IdOrIds, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T>>;
     /**
      * Updates a record with the given id in the collection.
      *
@@ -221,7 +231,7 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
      * @param {SqbCollectionService.UpdateOptions} options - The options for updating the document.
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
-    updateOnly(id: SQBAdapter.Id, input: PatchDTO<T>, options?: SqbCollectionService.UpdateOnlyOptions): Promise<number>;
+    updateOnly(id: SQBAdapter.IdOrIds, input: PatchDTO<T>, options?: SqbCollectionService.UpdateOnlyOptions): Promise<number>;
     /**
      * Updates multiple records in the collection based on the specified input and options.
      *

package/types/sqb-entity-service.d.ts

@@ -1,8 +1,8 @@
 import { ComplexType } from '@opra/common';
-import { ServiceBase } from '@opra/core';
+import { HttpContext, ServiceBase } from '@opra/core';
 import { EntityMetadata, Repository, SqbClient, SqbConnection } from '@sqb/connect';
-import { PartialDTO, PatchDTO, Type } from 'ts-gems';
-import { IsObject } from 'valgen';
+import type { Nullish, PartialDTO, PatchDTO, RequiredSome, StrictOmit, Type } from 'ts-gems';
+import { type IsObject } from 'valgen';
 import { SQBAdapter } from './sqb-adapter.js';
 /**
  * @namespace SqbEntityService
@@ -10,10 +10,10 @@ import { SQBAdapter } from './sqb-adapter.js';
 export declare namespace SqbEntityService {
     interface Options {
         db?: SqbEntityService<any>['db'];
-        resourceName?: SqbEntityService<any>['$resourceName'];
-        onError?: SqbEntityService<any>['$onError'];
-        commonFilter?: SqbEntityService<any>['$commonFilter'];
-        interceptor?: SqbEntityService<any>['$interceptor'];
+        resourceName?: SqbEntityService<any>['resourceName'];
+        onError?: SqbEntityService<any>['onError'];
+        commonFilter?: SqbEntityService<any>['commonFilter'];
+        interceptor?: SqbEntityService<any>['interceptor'];
     }
     type CrudOp = 'create' | 'read' | 'update' | 'delete';
     interface CommandInfo {
@@ -24,6 +24,7 @@ export declare namespace SqbEntityService {
         input?: Record<string, any>;
         options?: Record<string, any>;
     }
+    type CommonFilter = SQBAdapter.FilterInput | ((args: SqbEntityService.CommandInfo, _this: SqbEntityService<any>) => SQBAdapter.FilterInput | Promise<SQBAdapter.FilterInput> | undefined);
     /**
      * Represents options for "create" operation
      *
@@ -85,14 +86,7 @@ export declare namespace SqbEntityService {
      *
      * @interface
      */
-    interface UpdateOptions extends Repository.UpdateOptions {
-    }
-    /**
-     * Represents options for "updateOnly" operation
-     *
-     * @interface
-     */
-    interface UpdateOnlyOptions extends Repository.UpdateOptions {
+    interface UpdateOneOptions extends Repository.UpdateOptions {
     }
     /**
      * Represents options for "updateMany" operation
@@ -101,6 +95,56 @@ export declare namespace SqbEntityService {
      */
     interface UpdateManyOptions extends Repository.UpdateManyOptions {
     }
+    interface CreateCommand<T> extends StrictOmit<RequiredSome<CommandInfo, 'input'>, 'documentId'> {
+        crud: 'create';
+        input: PatchDTO<T>;
+        options?: CreateOptions;
+    }
+    interface CountCommand extends StrictOmit<CommandInfo, 'documentId' | 'input'> {
+        crud: 'read';
+        options?: CountOptions;
+    }
+    interface DeleteOneCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'delete';
+        options?: DeleteOptions;
+    }
+    interface DeleteManyCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'delete';
+        options?: DeleteManyOptions;
+    }
+    interface ExistsCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'read';
+        options?: ExistsOptions;
+    }
+    interface FindOneCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'read';
+        options?: FindOneOptions;
+    }
+    interface FindManyCommand extends StrictOmit<CommandInfo, 'input'> {
+        crud: 'read';
+        options?: FindManyOptions;
+    }
+    interface UpdateOneCommand<T> extends CommandInfo {
+        crud: 'update';
+        input: PatchDTO<T>;
+        options?: UpdateOneOptions;
+    }
+    interface UpdateManyCommand<T> extends CommandInfo {
+        crud: 'update';
+        input: PatchDTO<T>;
+        options?: UpdateManyOptions;
+    }
+}
+export interface SqbEntityService {
+    /**
+     * Interceptor function for handling callback execution with provided arguments.
+     * @type Function
+     * @param next - The callback function to be intercepted.
+     * @param {SqbEntityService.CommandInfo} command - The arguments object containing the following properties:
+     * @param _this - The reference to the current object.
+     * @returns - The promise that resolves to the result of the callback execution.
+     */
+    interceptor?(next: () => any, command: SqbEntityService.CommandInfo, _this: any): Promise<any>;
 }
 /**
  * @class SqbEntityService
@@ -108,7 +152,7 @@ export declare namespace SqbEntityService {
  */
 export declare class SqbEntityService<T extends object = object> extends ServiceBase {
     protected _dataType_: Type | string;
-    protected _dataType: ComplexType;
+    protected _dataType?: ComplexType;
     protected _dataTypeClass?: Type;
     protected _entityMetadata?: EntityMetadata;
     protected _inputCodecs: Record<string, IsObject.Validator<T>>;
@@ -116,34 +160,25 @@ export declare class SqbEntityService<T extends object = object> extends Service
     /**
      * Represents a SqbClient or SqbConnection object
      */
-    db?: (SqbClient | SqbConnection) | ((_this: any) => SqbClient | SqbConnection);
+    db?: (SqbClient | SqbConnection) | ((_this: this) => SqbClient | SqbConnection);
     /**
      * Represents the name of a resource.
      * @type {string}
      */
-    $resourceName?: string | ((_this: any) => string);
+    resourceName?: string | ((_this: this) => string);
     /**
      * Represents a common filter function for a service.
      *
      * @type {SqbEntityService.Filter | Function}
      */
-    $commonFilter?: SQBAdapter.FilterInput | ((args: SqbEntityService.CommandInfo, _this: this) => SQBAdapter.FilterInput | Promise<SQBAdapter.FilterInput> | undefined);
-    /**
-     * Interceptor function for handling callback execution with provided arguments.
-     *
-     * @param {Function} callback - The callback function to be intercepted.
-     * @param {SqbEntityService.CommandInfo} info - The arguments object containing the following properties:
-     * @param {SqbEntityService} _this - The reference to the current object.
-     * @returns - The promise that resolves to the result of the callback execution.
-     */
-    $interceptor?: (callback: () => any, info: SqbEntityService.CommandInfo, _this: any) => Promise<any>;
+    commonFilter?: SqbEntityService.CommonFilter | SqbEntityService.CommonFilter[];
     /**
      * Callback function for handling errors.
      *
      * @param {unknown} error - The error object.
      * @param {SqbEntityService} _this - The context object.
      */
-    $onError?: (error: unknown, _this: any) => void | Promise<void>;
+    onError?: (error: unknown, _this: any) => void | Promise<void>;
     /**
      * Constructs a new instance
      *
@@ -170,6 +205,7 @@ export declare class SqbEntityService<T extends object = object> extends Service
      * @throws {TypeError} If metadata is not available
      */
     get entityMetadata(): EntityMetadata;
+    for<C extends HttpContext, P extends Partial<this>>(context: C, overwriteProperties?: Nullish<P>, overwriteContext?: Partial<C>): this & Required<P>;
     /**
      * Retrieves the resource name.
      *
@@ -190,110 +226,106 @@ export declare class SqbEntityService<T extends object = object> extends Service
     /**
      * Insert a new record into database
      *
-     * @param {PartialDTO<T>} input - The input data
-     * @param {SqbEntityService.CreateOptions} [options] - The options object
-     * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created resource
-     * @throws {InternalServerError} if an unknown error occurs while creating the resource
+     * @param command
+     * @returns - A promise that resolves to the created resource
+     * @protected
+     */
+    protected _create(command: SqbEntityService.CreateCommand<T>): Promise<PartialDTO<T>>;
+    /**
+     * Insert a new record into database
+     *
+     * @param command
+     * @returns - A promise that resolves to the created resource
      * @protected
      */
-    protected _create(input: PartialDTO<T>, options?: SqbEntityService.CreateOptions): Promise<PartialDTO<T>>;
+    protected _createOnly(command: SqbEntityService.CreateCommand<T>): Promise<any>;
     /**
      * Returns the count of records based on the provided options
      *
-     * @param {SqbEntityService.CountOptions} options - The options for the count operation.
-     * @return {Promise<number>} - A promise that resolves to the count of records
+     * @param command
+     * @return - A promise that resolves to the count of records
      * @protected
      */
-    protected _count(options?: SqbEntityService.CountOptions): Promise<number>;
+    protected _count(command: SqbEntityService.CountCommand): Promise<number>;
     /**
      * Deletes a record from the collection.
      *
-     * @param {SQBAdapter.IdOrIds} id - The ID of the document to delete.
-     * @param {SqbEntityService.DeleteOptions} [options] - Optional delete options.
-     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
+     * @param command
+     * @return - A Promise that resolves to the number of documents deleted.
      * @protected
      */
-    protected _delete(id: SQBAdapter.IdOrIds, options?: SqbEntityService.DeleteOptions): Promise<number>;
+    protected _delete(command: SqbEntityService.DeleteOneCommand): Promise<number>;
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {SqbEntityService.DeleteManyOptions} options - The options for the delete operation.
-     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
+     * @param command
+     * @return - A promise that resolves to the number of documents deleted.
      * @protected
      */
-    protected _deleteMany(options?: SqbEntityService.DeleteManyOptions): Promise<number>;
+    protected _deleteMany(command: SqbEntityService.DeleteManyCommand): Promise<number>;
     /**
      * Checks if a record with the given id exists.
      *
-     * @param {SQBAdapter.IdOrIds} id - The id of the object to check.
-     * @param {SqbEntityService.ExistsOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     * @param command
      * @protected
      */
-    protected _exists(id: SQBAdapter.IdOrIds, options?: SqbEntityService.ExistsOptions): Promise<boolean>;
+    protected _exists(command: SqbEntityService.ExistsCommand): Promise<boolean>;
     /**
      * Checks if a record with the given arguments exists.
      *
-     * @param {SqbEntityService.ExistsOneOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     * @param command
+     * @return - A Promise that resolves to a boolean indicating whether the record exists or not.
      * @protected
      */
-    protected _existsOne(options?: SqbEntityService.ExistsOptions): Promise<boolean>;
+    protected _existsOne(command: SqbEntityService.ExistsCommand): Promise<boolean>;
     /**
      * Finds a record by ID.
      *
-     * @param {SQBAdapter.Id} id - The ID of the record.
-     * @param {SqbEntityService.FindOneOptions} [options] - The options for the find query.
-     * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
+     * @param command
+     * @return - A promise resolving to the found document, or undefined if not found.
      * @protected
      */
-    protected _findById(id: SQBAdapter.Id, options?: SqbEntityService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    protected _findById(command: SqbEntityService.FindOneCommand): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds a record in the collection that matches the specified options.
      *
-     * @param {SqbEntityService.FindOneOptions} [options] - The options for the query.
-     * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
+     * @param command
+     * @return - A promise that resolves with the found document or undefined if no document is found.
      * @protected
      */
-    protected _findOne(options?: SqbEntityService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    protected _findOne(command: SqbEntityService.FindOneCommand): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds multiple records in collection.
      *
-     * @param {SqbEntityService.FindManyOptions} [options] - The options for the find operation.
-     * @return A Promise that resolves to an array of partial outputs of type T.
+     * @param command
+     * @return - A Promise that resolves to an array of partial outputs of type T.
      * @protected
      */
-    protected _findMany(options?: SqbEntityService.FindManyOptions): Promise<PartialDTO<T>[]>;
+    protected _findMany(command: SqbEntityService.FindManyCommand): Promise<PartialDTO<T>[]>;
     /**
      * Updates a record with the given id in the collection.
      *
-     * @param {SQBAdapter.IdOrIds} id - The id of the document to update.
-     * @param {PatchDTO<T>} input - The partial input object containing the fields to update.
-     * @param {SqbEntityService.UpdateOptions} [options] - The options for the update operation.
-     * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
-     * undefined if the document was not found.
+     * @param command
+     * @returns  A promise that resolves to the updated document or undefined if the document was not found.
      * @protected
      */
-    protected _update(id: SQBAdapter.IdOrIds, input: PatchDTO<T>, options?: SqbEntityService.UpdateOptions): Promise<PartialDTO<T> | undefined>;
+    protected _update(command: SqbEntityService.UpdateOneCommand<T>): Promise<PartialDTO<T> | undefined>;
     /**
      * Updates a record in the collection with the specified ID and returns updated record count
      *
-     * @param {any} id - The ID of the document to update.
-     * @param {PatchDTO<T>} input - The partial input data to update the document with.
-     * @param {SqbEntityService.UpdateOptions} options - The options for updating the document.
-     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
+     * @param command
+     * @returns - A promise that resolves to the number of documents modified.
      * @protected
      */
-    protected _updateOnly(id: SQBAdapter.IdOrIds, input: PatchDTO<T>, options?: SqbEntityService.UpdateOptions): Promise<boolean>;
+    protected _updateOnly(command: SqbEntityService.UpdateOneCommand<T>): Promise<boolean>;
     /**
      * Updates multiple records in the collection based on the specified input and options.
      *
-     * @param {PatchDTO<T>} input - The partial input to update the documents with.
-     * @param {SqbEntityService.UpdateManyOptions} options - The options for updating the documents.
-     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
+     * @param command
+     * @return - A promise that resolves to the number of documents matched and modified.
      * @protected
      */
-    protected _updateMany(input: PatchDTO<T>, options?: SqbEntityService.UpdateManyOptions): Promise<number>;
+    protected _updateMany(command: SqbEntityService.UpdateOneCommand<T>): Promise<number>;
     /**
      * Acquires a connection and performs Repository.create operation
      *
@@ -403,20 +435,16 @@ export declare class SqbEntityService<T extends object = object> extends Service
      * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
      * that resolves to the common filter, or undefined if not available.
      */
-    protected _getCommonFilter(args: {
-        crud: SqbEntityService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: SQBAdapter.IdOrIds;
-        input?: Object;
-        options?: Record<string, any>;
-    }): SQBAdapter.FilterInput | Promise<SQBAdapter.FilterInput> | undefined;
-    protected _intercept(callback: (...args: any[]) => any, args: {
-        crud: SqbEntityService.CrudOp;
-        method: string;
-        byId: boolean;
-        documentId?: any;
-        input?: Object;
-        options?: Record<string, any>;
-    }): Promise<any>;
+    protected _getCommonFilter(command: SqbEntityService.CommandInfo): SQBAdapter.FilterInput | Promise<SQBAdapter.FilterInput> | undefined;
+    protected _executeCommand(command: SqbEntityService.CommandInfo, commandFn: () => any): Promise<any>;
+    protected _beforeCreate(command: SqbEntityService.CreateCommand<T>): Promise<void>;
+    protected _beforeUpdate(command: SqbEntityService.UpdateOneCommand<T>): Promise<void>;
+    protected _beforeUpdateMany(command: SqbEntityService.UpdateManyCommand<T>): Promise<void>;
+    protected _beforeDelete(command: SqbEntityService.DeleteOneCommand): Promise<void>;
+    protected _beforeDeleteMany(command: SqbEntityService.DeleteManyCommand): Promise<void>;
+    protected _afterCreate(command: SqbEntityService.CreateCommand<T>, result: PartialDTO<T>): Promise<void>;
+    protected _afterUpdate(command: SqbEntityService.UpdateOneCommand<T>, result?: PartialDTO<T>): Promise<void>;
+    protected _afterUpdateMany(command: SqbEntityService.UpdateManyCommand<T>, affected: number): Promise<void>;
+    protected _afterDelete(command: SqbEntityService.DeleteOneCommand, affected: number): Promise<void>;
+    protected _afterDeleteMany(command: SqbEntityService.DeleteManyCommand, affected: number): Promise<void>;
 }

package/types/sqb-singleton-service.d.ts

@@ -1,5 +1,4 @@
-import { ColumnFieldMetadata } from '@sqb/connect';
-import { PartialDTO, PatchDTO, Type } from 'ts-gems';
+import type { PartialDTO, PatchDTO, RequiredSome, Type } from 'ts-gems';
 import { SQBAdapter } from './sqb-adapter.js';
 import { SqbEntityService } from './sqb-entity-service.js';
 /**
@@ -42,14 +41,14 @@ export declare namespace SqbSingletonService {
      *
      * @interface
      */
-    interface UpdateOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOptions extends SqbEntityService.UpdateOneOptions {
     }
     /**
      * Represents options for "updateOnly" operation
      *
      * @interface
      */
-    interface UpdateOnlyOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOnlyOptions extends SqbEntityService.UpdateOneOptions {
     }
 }
 /**
@@ -57,12 +56,11 @@ export declare namespace SqbSingletonService {
  * @template T - The data type class type of the resource
  */
 export declare abstract class SqbSingletonService<T extends object = object> extends SqbEntityService {
-    protected _primaryKeyFields?: ColumnFieldMetadata[];
     /**
      * Represents a unique identifier for singleton record
-     * @property {SQBAdapter.Id}
+     * @property {SQBAdapter.IdOrIds}
      */
-    id: SQBAdapter.Id;
+    id: SQBAdapter.IdOrIds;
     /**
      * Constructs a new instance
      *
@@ -86,7 +84,8 @@ export declare abstract class SqbSingletonService<T extends object = object> ext
      * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created resource
      * @throws {Error} if an unknown error occurs while creating the resource
      */
-    create(input: PartialDTO<T>, options?: SqbSingletonService.CreateOptions): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options: RequiredSome<SqbSingletonService.CreateOptions, 'projection'>): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: SqbSingletonService.CreateOptions): Promise<T>;
     /**
      * Deletes the singleton record
      *
@@ -107,7 +106,8 @@ export declare abstract class SqbSingletonService<T extends object = object> ext
      * @param {SqbSingletonService.FindOneOptions} options - The options for the query.
      * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
      */
-    find(options?: SqbSingletonService.FindOptions): Promise<PartialDTO<T> | undefined>;
+    find(options: RequiredSome<SqbSingletonService.FindOptions, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    find(options?: SqbSingletonService.FindOptions): Promise<T | undefined>;
     /**
      * Retrieves the singleton record. Throws error if not found.
      *
@@ -116,7 +116,8 @@ export declare abstract class SqbSingletonService<T extends object = object> ext
      *    or rejects with a ResourceNotFoundError if the document does not exist.
      * @throws {ResourceNotAvailableError} - If the document does not exist.
      */
-    get(options?: SqbSingletonService.FindOptions): Promise<PartialDTO<T>>;
+    get(options: RequiredSome<SqbSingletonService.FindOptions, 'projection'>): Promise<PartialDTO<T>>;
+    get(options?: SqbSingletonService.FindOptions): Promise<T>;
     /**
      * Updates the singleton.
      *
@@ -125,7 +126,8 @@ export declare abstract class SqbSingletonService<T extends object = object> ext
      * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
      * undefined if the document was not found.
      */
-    update(input: PatchDTO<T>, options?: SqbSingletonService.UpdateOptions): Promise<PartialDTO<T> | undefined>;
+    update(input: PatchDTO<T>, options: RequiredSome<SqbSingletonService.UpdateOptions, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    update(input: PatchDTO<T>, options?: SqbSingletonService.UpdateOptions): Promise<T | undefined>;
     /**
      * Updates the singleton and  returns updated record count
      *