@adobe-commerce/aio-toolkit 1.0.3 → 1.0.5

package/dist/index.d.ts

@@ -126,14 +126,26 @@ interface FileRecord {
     updatedAt: string;
     [key: string]: any;
 }
+interface FileMetadata {
+    name: string;
+    creationTime: Date;
+    lastModified: Date;
+    etag: string;
+    contentLength: number;
+    contentType: string;
+    isDirectory: boolean;
+    isPublic: boolean;
+    url: string;
+}
 
 declare class FileRepository {
     private readonly filepath;
     private files;
     constructor(filepath: string);
     list(): Promise<FileRecord[]>;
+    metadata(id?: string): Promise<FileMetadata | FileMetadata[]>;
     load(id?: string): Promise<FileRecord>;
-    save(payload?: Partial<FileRecord>, id?: string | null): Promise<string | null>;
+    save(payload?: Partial<FileRecord>, id?: string | null, overwrite?: boolean): Promise<string | null>;
     delete(ids?: string[]): Promise<FileRecord[]>;
     private sanitizeFileId;
     private getFiles;
@@ -160,6 +172,65 @@ declare class PublishEvent {
     execute(providerId: string, eventCode: string, payload: any, subject?: string): Promise<PublishEventResult>;
 }
 
+declare enum WebhookActionOperation {
+    SUCCESS = "success",
+    EXCEPTION = "exception",
+    ADD = "add",
+    REPLACE = "replace",
+    REMOVE = "remove"
+}
+interface WebhookActionSuccessResponse {
+    op: typeof WebhookActionOperation.SUCCESS;
+}
+interface WebhookActionExceptionResponse {
+    op: typeof WebhookActionOperation.EXCEPTION;
+    class?: string;
+    message?: string;
+}
+interface WebhookActionAddResponse {
+    op: typeof WebhookActionOperation.ADD;
+    path: string;
+    value: any;
+    instance?: string;
+}
+interface WebhookActionReplaceResponse {
+    op: typeof WebhookActionOperation.REPLACE;
+    path: string;
+    value: any;
+    instance?: string;
+}
+interface WebhookActionRemoveResponse {
+    op: typeof WebhookActionOperation.REMOVE;
+    path: string;
+}
+type WebhookActionResponseType = WebhookActionSuccessResponse | WebhookActionExceptionResponse | WebhookActionAddResponse | WebhookActionReplaceResponse | WebhookActionRemoveResponse;
+
+declare enum SignatureVerification {
+    ENABLED = "enabled",
+    DISABLED = "disabled"
+}
+
+declare class WebhookAction {
+    static execute(name?: string, requiredParams?: string[], requiredHeaders?: string[], signatureVerification?: SignatureVerification, action?: (params: {
+        [key: string]: any;
+    }, ctx: {
+        logger: any;
+        headers: {
+            [key: string]: any;
+        };
+    }) => Promise<WebhookActionResponseType | WebhookActionResponseType[]>): (params: {
+        [key: string]: any;
+    }) => Promise<RuntimeActionResponseType>;
+}
+
+declare class WebhookActionResponse {
+    static success(): WebhookActionSuccessResponse;
+    static exception(message?: string, exceptionClass?: string): WebhookActionExceptionResponse;
+    static add(path: string, value: any, instance?: string): WebhookActionAddResponse;
+    static replace(path: string, value: any, instance?: string): WebhookActionReplaceResponse;
+    static remove(path: string): WebhookActionRemoveResponse;
+}
+
 interface BearerTokenInfo {
     token: string | null;
     tokenLength: number;
@@ -382,12 +453,17 @@ interface Connection {
 interface ExtendedRequestError extends RequestError {
     responseBody?: any;
 }
+interface HttpsOptions {
+    rejectUnauthorized?: boolean;
+    [key: string]: any;
+}
 
 declare class AdobeCommerceClient {
     private baseUrl;
     private connection;
     private logger;
-    constructor(baseUrl: string, connection: Connection, logger?: any);
+    private httpsOptions;
+    constructor(baseUrl: string, connection: Connection, logger?: any, httpsOptions?: HttpsOptions);
     get(endpoint: string, headers?: Record<string, string>): Promise<any>;
     post(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
     put(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
@@ -450,6 +526,68 @@ declare class GenerateBasicAuthToken {
     getState(): Promise<any>;
 }
 
+interface ShippingCarrierMethodAdditionalData {
+    key: string;
+    value: any;
+}
+interface ShippingCarrierMethodData {
+    carrier_code: string;
+    method: string;
+    method_title: string;
+    price: number;
+    cost: number;
+    additional_data: ShippingCarrierMethodAdditionalData[];
+}
+
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
+declare class ShippingCarrierMethod {
+    private methodData;
+    constructor(carrierCode: string, method: string);
+    setMethodTitle(methodTitle: string): this;
+    setPrice(price: number): this;
+    setCost(cost: number): this;
+    addAdditionalData(key: string, value: any): this;
+    getData(): ShippingCarrierMethodData;
+}
+
+declare class ShippingCarrier {
+    private carrierData;
+    private addedMethods;
+    private removedMethods;
+    constructor(code: string, callback?: (builder: ShippingCarrier) => void);
+    private validateCarrierCode;
+    private validateMethodCode;
+    setTitle(title: string): this;
+    setStores(stores: string[]): this;
+    setCountries(countries: string[]): this;
+    setSortOrder(sortOrder: number): this;
+    setActive(active: boolean): this;
+    setTrackingAvailable(trackingAvailable: boolean): this;
+    setShippingLabelsAvailable(shippingLabelsAvailable: boolean): this;
+    setData(carrierData: ShippingCarrierData): this;
+    addMethod(method: string, callback?: (builder: ShippingCarrierMethod) => void): this;
+    removeMethod(method: string): this;
+    getData(): ShippingCarrierData;
+    getAddedMethods(): ShippingCarrierMethodData[];
+    getRemovedMethods(): string[];
+}
+
+declare class ShippingCarrierResponse {
+    private carrier;
+    constructor(carrier: ShippingCarrier);
+    generate(): WebhookActionResponseType[];
+}
+
 interface AdobeIMSConfig {
     client_id: string;
     client_secrets: string[];
@@ -683,4 +821,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, 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 FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, type SuccessResponse, type TokenResult, Validator };
+export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, 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, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, type SuccessResponse, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse };