@adobe-commerce/aio-toolkit 1.0.2 → 1.0.4

package/dist/index.d.mts

@@ -126,19 +126,111 @@ 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;
 }
 
+interface EventData {
+    type: string;
+    data: any;
+    subject?: string;
+}
+interface PublishEventResult {
+    eventId: string;
+    status: 'published' | 'failed';
+    publishedAt: string;
+    error?: string;
+}
+
+declare class PublishEvent {
+    private readonly imsOrgId;
+    private readonly apiKey;
+    private readonly accessToken;
+    private readonly customLogger;
+    constructor(imsOrgId: string, apiKey: string, accessToken: string, logger?: any);
+    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;
@@ -402,9 +494,8 @@ declare class ImsConnection implements Connection {
     private technicalAccountEmail;
     private imsOrgId;
     private scopes;
-    private logger;
-    private currentContext;
-    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, logger?: any, currentContext?: string);
+    private customLogger;
+    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, logger?: any);
     extend(commerceGot: any): Promise<any>;
 }
 
@@ -423,12 +514,74 @@ declare class GenerateBasicAuthToken {
     constructor(baseUrl: string, username: string, password: string, logger?: any);
     execute(): Promise<string | null>;
     getCommerceToken(): Promise<TokenResult | null>;
+    createTokenEndpoint(): string;
     createEndpoint(endpoint: string): string;
     setValue(result: TokenResult): Promise<boolean>;
     getValue(): Promise<string | null>;
     getState(): Promise<any>;
 }
 
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
+interface ShippingCarrierMethodAdditionalData {
+    key: string;
+    value: any;
+}
+interface ShippingCarrierMethodData {
+    carrier_code: string;
+    method: string;
+    method_title: string;
+    price: number;
+    cost: number;
+    additional_data: ShippingCarrierMethodAdditionalData[];
+}
+
+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;
+    reset(code: string, callback?: (builder: ShippingCarrier) => void): this;
+    getData(): ShippingCarrierData;
+}
+
+declare class ShippingCarrierResponse {
+    private carrier;
+    constructor(carrier: ShippingCarrier);
+    generate(): WebhookActionResponseType[];
+}
+
 interface AdobeIMSConfig {
     client_id: string;
     client_secrets: string[];
@@ -632,4 +785,34 @@ interface GetRegistrationQueryParams {
     registrationId: string;
 }
 
-export { AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, 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, Oauth1aConnection, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, Openwhisk, OpenwhiskAction, Parameters, type Provider, type ProviderInputModel, ProviderManager, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, type SuccessResponse, type TokenResult, Validator };
+interface MenuItem {
+    id: string;
+    title: string;
+    sortOrder: number;
+    parent?: string;
+    isSection?: boolean;
+}
+interface Page {
+    title: string;
+}
+interface AdminUiSdkRegistration {
+    registration: {
+        menuItems?: MenuItem[];
+        page?: Page;
+    };
+}
+
+declare class AdminUiSdk {
+    private extensionId;
+    private menuItems;
+    private pageTitle?;
+    constructor(extensionId: string);
+    private isValidExtensionId;
+    private isValidMenuId;
+    addMenuItem(id: string, title: string, sortOrder: number, parent?: string): void;
+    addMenuSection(id: string, title: string, sortOrder: number, parent?: string): void;
+    addPage(title: string): void;
+    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 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 };

package/dist/index.d.ts

@@ -126,19 +126,111 @@ 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;
 }
 
+interface EventData {
+    type: string;
+    data: any;
+    subject?: string;
+}
+interface PublishEventResult {
+    eventId: string;
+    status: 'published' | 'failed';
+    publishedAt: string;
+    error?: string;
+}
+
+declare class PublishEvent {
+    private readonly imsOrgId;
+    private readonly apiKey;
+    private readonly accessToken;
+    private readonly customLogger;
+    constructor(imsOrgId: string, apiKey: string, accessToken: string, logger?: any);
+    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;
@@ -402,9 +494,8 @@ declare class ImsConnection implements Connection {
     private technicalAccountEmail;
     private imsOrgId;
     private scopes;
-    private logger;
-    private currentContext;
-    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, logger?: any, currentContext?: string);
+    private customLogger;
+    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, logger?: any);
     extend(commerceGot: any): Promise<any>;
 }
 
@@ -423,12 +514,74 @@ declare class GenerateBasicAuthToken {
     constructor(baseUrl: string, username: string, password: string, logger?: any);
     execute(): Promise<string | null>;
     getCommerceToken(): Promise<TokenResult | null>;
+    createTokenEndpoint(): string;
     createEndpoint(endpoint: string): string;
     setValue(result: TokenResult): Promise<boolean>;
     getValue(): Promise<string | null>;
     getState(): Promise<any>;
 }
 
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
+interface ShippingCarrierMethodAdditionalData {
+    key: string;
+    value: any;
+}
+interface ShippingCarrierMethodData {
+    carrier_code: string;
+    method: string;
+    method_title: string;
+    price: number;
+    cost: number;
+    additional_data: ShippingCarrierMethodAdditionalData[];
+}
+
+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;
+    reset(code: string, callback?: (builder: ShippingCarrier) => void): this;
+    getData(): ShippingCarrierData;
+}
+
+declare class ShippingCarrierResponse {
+    private carrier;
+    constructor(carrier: ShippingCarrier);
+    generate(): WebhookActionResponseType[];
+}
+
 interface AdobeIMSConfig {
     client_id: string;
     client_secrets: string[];
@@ -632,4 +785,34 @@ interface GetRegistrationQueryParams {
     registrationId: string;
 }
 
-export { AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, 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, Oauth1aConnection, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, Openwhisk, OpenwhiskAction, Parameters, type Provider, type ProviderInputModel, ProviderManager, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, type SuccessResponse, type TokenResult, Validator };
+interface MenuItem {
+    id: string;
+    title: string;
+    sortOrder: number;
+    parent?: string;
+    isSection?: boolean;
+}
+interface Page {
+    title: string;
+}
+interface AdminUiSdkRegistration {
+    registration: {
+        menuItems?: MenuItem[];
+        page?: Page;
+    };
+}
+
+declare class AdminUiSdk {
+    private extensionId;
+    private menuItems;
+    private pageTitle?;
+    constructor(extensionId: string);
+    private isValidExtensionId;
+    private isValidMenuId;
+    addMenuItem(id: string, title: string, sortOrder: number, parent?: string): void;
+    addMenuSection(id: string, title: string, sortOrder: number, parent?: string): void;
+    addPage(title: string): void;
+    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 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 };