@forgecart/sdk 1.0.0 → 1.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vendure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/admin-namespace.d.ts

@@ -4,7 +4,7 @@
  * This file was automatically generated and should not be manually edited.
  * To regenerate, run: npm run codegen:ts
  *
- * Generated at: 2025-12-12T11:13:16.730Z
+ * Generated at: 2025-12-15T07:01:16.361Z
  * Generator version: 1.0.0
  *
  * 🤖 Generated with ForgeCart SDK Generator
@@ -23,6 +23,8 @@ export interface SDKConfig {
     headers?: Record<string, string>;
     /** Custom WebSocket implementation (optional, auto-detected if not provided) */
     webSocketImpl?: unknown;
+    /** Use HTTP only, skip WebSocket initialization (default: false) */
+    httpOnly?: boolean;
 }
 export type ActiveAdministratorQueryVariables = Types.ActiveAdministratorQueryVariables;
 export type ActiveAdministratorQuery = Types.ActiveAdministratorQuery;
@@ -456,12 +458,51 @@ export type UpdateCustomerNoteMutationResult = Types.UpdateCustomerNoteMutation;
 export type DeleteCustomerNoteMutationVariables = Types.DeleteCustomerNoteMutationVariables;
 export type DeleteCustomerNoteMutation = Types.DeleteCustomerNoteMutation;
 export type DeleteCustomerNoteMutationResult = Types.DeleteCustomerNoteMutation;
+export type DeploymentsQueryVariables = Types.DeploymentsQueryVariables;
+export type DeploymentsQuery = Types.DeploymentsQuery;
+export type DeploymentsQueryResult = Types.DeploymentsQuery;
+export type DeploymentQueryVariables = Types.DeploymentQueryVariables;
+export type DeploymentQuery = Types.DeploymentQuery;
+export type DeploymentQueryResult = Types.DeploymentQuery;
+export type DeploymentEnvQueryVariables = Types.DeploymentEnvQueryVariables;
+export type DeploymentEnvQuery = Types.DeploymentEnvQuery;
+export type DeploymentEnvQueryResult = Types.DeploymentEnvQuery;
+export type ChannelInfoQueryVariables = Types.ChannelInfoQueryVariables;
+export type ChannelInfoQuery = Types.ChannelInfoQuery;
+export type ChannelInfoQueryResult = Types.ChannelInfoQuery;
+export type ValidateChannelTokenQueryVariables = Types.ValidateChannelTokenQueryVariables;
+export type ValidateChannelTokenQuery = Types.ValidateChannelTokenQuery;
+export type ValidateChannelTokenQueryResult = Types.ValidateChannelTokenQuery;
+export type CreateDeploymentMutationVariables = Types.CreateDeploymentMutationVariables;
+export type CreateDeploymentMutation = Types.CreateDeploymentMutation;
+export type CreateDeploymentMutationResult = Types.CreateDeploymentMutation;
+export type DeleteDeploymentMutationVariables = Types.DeleteDeploymentMutationVariables;
+export type DeleteDeploymentMutation = Types.DeleteDeploymentMutation;
+export type DeleteDeploymentMutationResult = Types.DeleteDeploymentMutation;
+export type ScaleDeploymentMutationVariables = Types.ScaleDeploymentMutationVariables;
+export type ScaleDeploymentMutation = Types.ScaleDeploymentMutation;
+export type ScaleDeploymentMutationResult = Types.ScaleDeploymentMutation;
+export type SetDeploymentEnvMutationVariables = Types.SetDeploymentEnvMutationVariables;
+export type SetDeploymentEnvMutation = Types.SetDeploymentEnvMutation;
+export type SetDeploymentEnvMutationResult = Types.SetDeploymentEnvMutation;
+export type UnsetDeploymentEnvMutationVariables = Types.UnsetDeploymentEnvMutationVariables;
+export type UnsetDeploymentEnvMutation = Types.UnsetDeploymentEnvMutation;
+export type UnsetDeploymentEnvMutationResult = Types.UnsetDeploymentEnvMutation;
+export type RefreshDeploymentStatusMutationVariables = Types.RefreshDeploymentStatusMutationVariables;
+export type RefreshDeploymentStatusMutation = Types.RefreshDeploymentStatusMutation;
+export type RefreshDeploymentStatusMutationResult = Types.RefreshDeploymentStatusMutation;
+export type DeploymentLogsSubscriptionVariables = Types.DeploymentLogsSubscriptionVariables;
+export type DeploymentLogsSubscription = Types.DeploymentLogsSubscription;
+export type DeploymentLogsSubscriptionResult = Types.DeploymentLogsSubscription;
 export type EntityDuplicatorsQueryVariables = Types.EntityDuplicatorsQueryVariables;
 export type EntityDuplicatorsQuery = Types.EntityDuplicatorsQuery;
 export type EntityDuplicatorsQueryResult = Types.EntityDuplicatorsQuery;
 export type DuplicateEntityMutationVariables = Types.DuplicateEntityMutationVariables;
 export type DuplicateEntityMutation = Types.DuplicateEntityMutation;
 export type DuplicateEntityMutationResult = Types.DuplicateEntityMutation;
+export type EntityEventSubscriptionVariables = Types.EntityEventSubscriptionVariables;
+export type EntityEventSubscription = Types.EntityEventSubscription;
+export type EntityEventSubscriptionResult = Types.EntityEventSubscription;
 export type FacetQueryVariables = Types.FacetQueryVariables;
 export type FacetQuery = Types.FacetQuery;
 export type FacetQueryResult = Types.FacetQuery;
@@ -991,6 +1032,28 @@ declare class BaseGraphQLClient {
      */
     dispose(): void;
 }
+export type EventCallback<T = EntityEventPayload> = (event: T) => void;
+export type BlockingEventCallback<T = EntityEventPayload> = (event: T) => Promise<void>;
+export interface EventSubscription {
+    unsubscribe: () => void;
+}
+export interface EntityEventPayload {
+    channelId: string;
+    eventName: string;
+    eventClass: string;
+    type: string;
+    entityId: string | null;
+    entity: unknown;
+    input: unknown;
+    timestamp: string;
+}
+export declare const ProductEvents: readonly ["product.created", "product.updated", "product.deleted", "product.variant.created", "product.variant.updated", "product.variant.deleted", "product.option.created", "product.option.updated", "product.option.deleted", "product.optionGroup.created", "product.optionGroup.updated", "product.optionGroup.deleted", "product.variant.price.updated"];
+export declare const OrderEvents: readonly ["order.stateTransition", "order.placementStateTransition", "order.line.event", "order.paymentStateTransition", "order.refundStateTransition", "order.coupon.applied", "order.coupon.removed"];
+export declare const CustomerEvents: readonly ["customer.created", "customer.updated", "customer.deleted", "customer.address.created", "customer.address.updated", "customer.address.deleted", "customer.groupChange", "customer.login", "customer.loginfail"];
+export declare const FulfillmentEvents: readonly ["fulfillment.created", "fulfillment.stateTransition"];
+export declare const PaymentEvents: readonly ["payment.stateTransition", "payment.method.created", "payment.method.updated", "payment.method.deleted"];
+export declare const CatalogEvents: readonly ["collection.created", "collection.updated", "collection.deleted", "collection.modification", "facet.created", "facet.updated", "facet.deleted", "facetValue.created", "facetValue.updated", "facetValue.deleted", "asset.created", "asset.updated", "asset.deleted"];
+export declare const AllEvents: readonly ["product.created", "product.updated", "product.deleted", "product.variant.created", "product.variant.updated", "product.variant.deleted", "product.option.created", "product.option.updated", "product.option.deleted", "product.optionGroup.created", "product.optionGroup.updated", "product.optionGroup.deleted", "product.variant.price.updated", "order.stateTransition", "order.placementStateTransition", "order.line.event", "order.paymentStateTransition", "order.refundStateTransition", "order.coupon.applied", "order.coupon.removed", "customer.created", "customer.updated", "customer.deleted", "customer.address.created", "customer.address.updated", "customer.address.deleted", "customer.groupChange", "customer.login", "customer.loginfail", "fulfillment.created", "fulfillment.stateTransition", "payment.stateTransition", "payment.method.created", "payment.method.updated", "payment.method.deleted", "collection.created", "collection.updated", "collection.deleted", "collection.modification", "facet.created", "facet.updated", "facet.deleted", "facetValue.created", "facetValue.updated", "facetValue.deleted", "asset.created", "asset.updated", "asset.deleted"];
 /**
  * Administrator operations
  */
@@ -1019,6 +1082,7 @@ declare class AdministratorOperations {
     authenticate(variables: Types.AuthenticateMutationVariables): Promise<Types.AuthenticateMutation>;
     /**
      * login mutation
+     * Automatically sets the auth token on successful login
      */
     login(variables: Types.LoginMutationVariables): Promise<Types.LoginMutation>;
     /**
@@ -1637,6 +1701,61 @@ declare class CustomerOperations {
      */
     deleteCustomerNote(variables: Types.DeleteCustomerNoteMutationVariables): Promise<Types.DeleteCustomerNoteMutation>;
 }
+/**
+ * Deployment operations
+ */
+declare class DeploymentOperations {
+    private client;
+    constructor(client: BaseGraphQLClient);
+    /**
+     * Deployments query
+     */
+    deployments(): Promise<Types.DeploymentsQuery>;
+    /**
+     * Deployment query
+     */
+    deployment(variables: Types.DeploymentQueryVariables): Promise<Types.DeploymentQuery>;
+    /**
+     * DeploymentEnv query
+     */
+    deploymentEnv(variables: Types.DeploymentEnvQueryVariables): Promise<Types.DeploymentEnvQuery>;
+    /**
+     * ChannelInfo query
+     */
+    channelInfo(): Promise<Types.ChannelInfoQuery>;
+    /**
+     * ValidateChannelToken query
+     */
+    validateChannelToken(): Promise<Types.ValidateChannelTokenQuery>;
+    /**
+     * CreateDeployment mutation
+     */
+    createDeployment(variables: Types.CreateDeploymentMutationVariables): Promise<Types.CreateDeploymentMutation>;
+    /**
+     * DeleteDeployment mutation
+     */
+    deleteDeployment(variables: Types.DeleteDeploymentMutationVariables): Promise<Types.DeleteDeploymentMutation>;
+    /**
+     * ScaleDeployment mutation
+     */
+    scaleDeployment(variables: Types.ScaleDeploymentMutationVariables): Promise<Types.ScaleDeploymentMutation>;
+    /**
+     * SetDeploymentEnv mutation
+     */
+    setDeploymentEnv(variables: Types.SetDeploymentEnvMutationVariables): Promise<Types.SetDeploymentEnvMutation>;
+    /**
+     * UnsetDeploymentEnv mutation
+     */
+    unsetDeploymentEnv(variables: Types.UnsetDeploymentEnvMutationVariables): Promise<Types.UnsetDeploymentEnvMutation>;
+    /**
+     * RefreshDeploymentStatus mutation
+     */
+    refreshDeploymentStatus(variables: Types.RefreshDeploymentStatusMutationVariables): Promise<Types.RefreshDeploymentStatusMutation>;
+    /**
+     * DeploymentLogs subscription
+     */
+    deploymentLogs(variables: Types.DeploymentLogsSubscriptionVariables): AsyncIterableIterator<Types.DeploymentLogsSubscription>;
+}
 /**
  * EntityDuplication operations
  */
@@ -1652,6 +1771,17 @@ declare class EntityDuplicationOperations {
      */
     duplicateEntity(variables: Types.DuplicateEntityMutationVariables): Promise<Types.DuplicateEntityMutation>;
 }
+/**
+ * EntityEvents operations
+ */
+declare class EntityEventsOperations {
+    private client;
+    constructor(client: BaseGraphQLClient);
+    /**
+     * entityEvent subscription
+     */
+    entityEvent(variables: Types.EntityEventSubscriptionVariables): AsyncIterableIterator<Types.EntityEventSubscription>;
+}
 /**
  * Facet operations
  */
@@ -2450,7 +2580,9 @@ export declare class AdminNamespace {
     readonly customFields: CustomFieldsOperations;
     readonly customerGroup: CustomerGroupOperations;
     readonly customer: CustomerOperations;
+    readonly deployment: DeploymentOperations;
     readonly entityDuplication: EntityDuplicationOperations;
+    readonly entityEvents: EntityEventsOperations;
     readonly facet: FacetOperations;
     readonly fulfillment: FulfillmentOperations;
     readonly globalSettings: GlobalSettingsOperations;
@@ -2473,6 +2605,13 @@ export declare class AdminNamespace {
     readonly taxRate: TaxRateOperations;
     readonly tax: TaxOperations;
     readonly zone: ZoneOperations;
+    private eventRegistry;
+    private eventSubscription;
+    private isListening;
+    private retryCount;
+    private abortController;
+    private static readonly RECONNECT_CONFIG;
+    private static readonly BLOCKING_TIMEOUT_MS;
     constructor(config: SDKConfig);
     /**
      * Set authentication token
@@ -2487,5 +2626,33 @@ export declare class AdminNamespace {
      * Dispose of the namespace and close all connections
      */
     dispose(): void;
+    /**
+     * Register a non-blocking event handler
+     * The callback will be called for each matching event without waiting
+     */
+    registerEventHandler(eventName: string, callback: EventCallback): EventSubscription;
+    /**
+     * Register a blocking event handler
+     * The callback must complete within 1000ms or it will timeout
+     */
+    registerBlockingEventHandler(eventName: string, callback: BlockingEventCallback): EventSubscription;
+    /**
+     * Start listening to events with retry logic
+     */
+    private ensureEventListening;
+    private startSubscription;
+    private handleReconnect;
+    /**
+     * Dispatch event to registered handlers
+     */
+    private dispatchEvent;
+    /**
+     * Execute promise with timeout
+     */
+    private executeWithTimeout;
+    /**
+     * Stop all event listening
+     */
+    stopEventListening(): void;
 }
 export {};