@adobe-commerce/aio-toolkit 1.2.0 → 1.2.2

package/dist/index.d.ts

@@ -203,6 +203,99 @@ declare class FileRepository {
     private getFiles;
 }
 
+declare enum AbdbColumnType {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    BOOLEAN = "BOOLEAN",
+    DATETIME = "DATETIME"
+}
+interface AbdbColumnOptions {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: boolean;
+}
+interface AbdbColumnJson {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: true;
+}
+
+declare class AbdbColumn {
+    private readonly _name;
+    private readonly _type;
+    private readonly _description;
+    private readonly _isRequired;
+    constructor(options: AbdbColumnOptions);
+    getName(): string;
+    getType(): AbdbColumnType;
+    getDescription(): string | undefined;
+    getIsRequired(): boolean;
+    toJSON(): AbdbColumnJson;
+    clone(overrides?: Partial<AbdbColumnOptions>): AbdbColumn;
+    validate(value: unknown): void;
+    private _isMissingValue;
+    private _validateStringValue;
+    private _validateNumberValue;
+    private _validateBooleanValue;
+    private _validateDateTimeValue;
+}
+
+type AddColumnOptions = Omit<AbdbColumnOptions, 'name' | 'type'>;
+type AbdbRunCallback<T = unknown> = (collection: DbCollection, client: DbClient) => Promise<T>;
+
+type AbdbCollectionCallback = (collection: AbdbCollection) => void;
+declare class AbdbCollection {
+    private readonly _name;
+    private readonly _columns;
+    constructor(name: string, callback?: AbdbCollectionCallback);
+    getName(): string;
+    addColumn(name: string, type: AbdbColumnType, options?: AddColumnOptions): this;
+    addColumn(name: string, type: AbdbColumnType, description?: string, isRequired?: boolean): this;
+    getColumns(): AbdbColumn[];
+    getColumn(name: string): AbdbColumn | undefined;
+    hasColumn(name: string): boolean;
+    validate(record: Record<string, unknown>): void;
+    validateAll(record: Record<string, unknown>): string[];
+    run<T>(callback: AbdbRunCallback<T>, token: string, region?: string): Promise<T>;
+    private _validateCollectionName;
+    private _validateColumnName;
+    private _validateIdentifier;
+}
+
+interface AbdbRecord {
+    _id?: string;
+    _created_at?: string;
+    _updated_at?: string;
+    [key: string]: unknown;
+}
+type AbdbRepositoryFilter = Record<string, unknown>;
+
+declare class AbdbRepository<T extends AbdbRecord = AbdbRecord> {
+    private readonly _collection;
+    private readonly _token;
+    private readonly _region;
+    constructor(collection: AbdbCollection, token: string, region?: string);
+    getName(): string;
+    getCollection(): AbdbCollection;
+    find(filter?: AbdbRepositoryFilter): Promise<T[]>;
+    findOne(filter: AbdbRepositoryFilter): Promise<T | null>;
+    findById(id: string): Promise<T | null>;
+    delete(filter?: AbdbRepositoryFilter): Promise<Record<string, any>>;
+    deleteOne(filter?: AbdbRepositoryFilter): Promise<Record<string, any>>;
+    deleteById(id: string): Promise<Record<string, any>>;
+    insert(payloads: Array<Partial<T>>): Promise<Record<string, any>>;
+    insertOne(payload: Partial<T>): Promise<Record<string, any>>;
+    update(payload: Partial<T>, filter?: AbdbRepositoryFilter, options?: Record<string, any>): Promise<Record<string, any>>;
+    updateOne(payload: Partial<T>, filter?: AbdbRepositoryFilter, options?: Record<string, any>): Promise<Record<string, any>>;
+    save(payload?: Partial<T>, id?: string): Promise<Record<string, any>>;
+    isIdExists(id: string): Promise<boolean>;
+    exists(filter?: AbdbRepositoryFilter, options?: Record<string, any>): Promise<boolean>;
+    count(filter?: AbdbRepositoryFilter, options?: Record<string, any>): Promise<number>;
+    private _validatePartial;
+}
+
 interface EventData {
     type: string;
     data: any;
@@ -328,67 +421,6 @@ declare class RuntimeApiGatewayService {
     delete(endpoint: string, additionalHeaders?: Record<string, string>): Promise<any>;
 }
 
-declare enum AbdbColumnType {
-    STRING = "STRING",
-    NUMBER = "NUMBER",
-    BOOLEAN = "BOOLEAN",
-    DATETIME = "DATETIME"
-}
-interface AbdbColumnOptions {
-    name: string;
-    type: AbdbColumnType;
-    description?: string;
-    isRequired?: boolean;
-}
-interface AbdbColumnJson {
-    name: string;
-    type: AbdbColumnType;
-    description?: string;
-    isRequired?: true;
-}
-
-declare class AbdbColumn {
-    private readonly _name;
-    private readonly _type;
-    private readonly _description;
-    private readonly _isRequired;
-    constructor(options: AbdbColumnOptions);
-    getName(): string;
-    getType(): AbdbColumnType;
-    getDescription(): string | undefined;
-    getIsRequired(): boolean;
-    toJSON(): AbdbColumnJson;
-    clone(overrides?: Partial<AbdbColumnOptions>): AbdbColumn;
-    validate(value: unknown): void;
-    private _isMissingValue;
-    private _validateStringValue;
-    private _validateNumberValue;
-    private _validateBooleanValue;
-    private _validateDateTimeValue;
-}
-
-type AddColumnOptions = Omit<AbdbColumnOptions, 'name' | 'type'>;
-type AbdbRunCallback<T = unknown> = (collection: DbCollection, client: DbClient) => Promise<T>;
-
-type AbdbCollectionCallback = (collection: AbdbCollection) => void;
-declare class AbdbCollection {
-    private readonly _name;
-    private readonly _columns;
-    constructor(name: string, callback?: AbdbCollectionCallback);
-    getName(): string;
-    addColumn(name: string, type: AbdbColumnType, options?: AddColumnOptions): this;
-    addColumn(name: string, type: AbdbColumnType, description?: string, isRequired?: boolean): this;
-    getColumns(): AbdbColumn[];
-    getColumn(name: string): AbdbColumn | undefined;
-    hasColumn(name: string): boolean;
-    validate(record: Record<string, unknown>): void;
-    validateAll(record: Record<string, unknown>): string[];
-    run<T>(callback: AbdbRunCallback<T>, token: string, region?: string): Promise<T>;
-    private _validateCollectionName;
-    private _validateColumnName;
-    private _validateIdentifier;
-}
-
 declare class TelemetryInputError extends Error {
     constructor(message: string);
 }
@@ -1051,4 +1083,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AbdbCollection, type AbdbCollectionCallback, AbdbColumn, type AbdbColumnJson, type AbdbColumnOptions, AbdbColumnType, type AbdbRunCallback, type AddColumnOptions, AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };
+export { AbdbCollection, type AbdbCollectionCallback, AbdbColumn, type AbdbColumnJson, type AbdbColumnOptions, AbdbColumnType, type AbdbRecord, AbdbRepository, type AbdbRepositoryFilter, type AbdbRunCallback, type AddColumnOptions, AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };