@forgecart/sdk 1.2.6 → 1.202606151453.0

package/src/error-utils.d.ts

@@ -0,0 +1,25 @@
+export interface ExtractedError {
+    code: string;
+    variables: Record<string, string>;
+    classification: string;
+    message?: string;
+}
+/**
+ * Extract the structured error code from a ClientError.
+ * Returns null if the error has no GraphQL error code.
+ */
+export declare function extractErrorCode(error: unknown): string | null;
+/**
+ * Extract full structured error info from a ClientError.
+ * Returns null if the error has no GraphQL extensions.
+ */
+export declare function extractError(error: unknown): ExtractedError | null;
+/**
+ * Extract the localized error message from a ClientError.
+ * Returns null if the error has no localized message.
+ */
+export declare function extractErrorMessage(error: unknown): string | null;
+/**
+ * Check if an error has a specific error code.
+ */
+export declare function isErrorCode(error: unknown, code: string): boolean;

package/src/hook-event-map.generated.d.ts

@@ -0,0 +1,243 @@
+/**
+ * AUTO-GENERATED FILE — DO NOT EDIT
+ *
+ * This file was generated by @forgecart/client-sdk-generators.
+ * Any manual changes will be overwritten on the next generation run.
+ */
+import type { AddIdentityToSegmentInput, Administrator, Asset, AudienceMembership, AudienceSegment, Channel, ChannelPlugin, Collection, Country, CreateAdministratorInput, CreateAssetInput, CreateAudienceSegmentInput, CreateChannelInput, CreateCollectionInput, CreateCountryInput, CreateCustomerGroupInput, CreateCustomerInput, CreateFacetInput, CreateFacetValueInput, CreateFulfillmentInput, CreateProductInput, CreateProductVariantInput, CreatePromotionInput, CreateRoleInput, CreateSellerInput, CreateStockLocationInput, CreateTaxCategoryInput, CreateTaxRateInput, CreateZoneInput, Customer, CustomerGroup, Facet, FacetValue, Fulfillment, HistoryEntry, Order, Product, ProductVariant, Promotion, RegisterCustomerInput, RemoveIdentityFromSegmentInput, Role, Seller, StockLocation, TaxCategory, TaxRate, UpdateAdministratorInput, UpdateAssetInput, UpdateAudienceSegmentInput, UpdateChannelInput, UpdateChannelPluginConfigInput, UpdateCollectionInput, UpdateCountryInput, UpdateCustomerGroupInput, UpdateCustomerInput, UpdateFacetInput, UpdateFacetValueInput, UpdateProductInput, UpdateProductVariantInput, UpdatePromotionInput, UpdateRoleInput, UpdateSellerInput, UpdateStockLocationInput, UpdateTaxCategoryInput, UpdateTaxRateInput, UpdateZoneInput, Zone } from './admin-types.generated';
+import type { TransactionContext } from './client.generated';
+export interface AdminHookEventMap {
+    'asset.create.before': CreateAssetInput;
+    'asset.create.after': Asset;
+    'asset.create.async': Asset;
+    'asset.update.before': UpdateAssetInput;
+    'asset.update.after': Asset;
+    'asset.update.async': Asset;
+    'asset.executeSingleAssetDelete.before': void;
+    'asset.executeSingleAssetDelete.after': Asset;
+    'asset.executeSingleAssetDelete.async': Asset;
+    'asset.createFromUrl.before': string;
+    'asset.createFromUrl.after': Asset;
+    'asset.createFromUrl.async': Asset;
+    'administrator.create.before': CreateAdministratorInput;
+    'administrator.create.after': Administrator;
+    'administrator.create.async': Administrator;
+    'administrator.update.before': UpdateAdministratorInput;
+    'administrator.update.after': Administrator;
+    'administrator.update.async': Administrator;
+    'administrator.softDelete.before': string;
+    'administrator.softDelete.after': Administrator;
+    'administrator.softDelete.async': Administrator;
+    'administrator.inviteExistingUser.before': void;
+    'administrator.inviteExistingUser.after': Administrator;
+    'administrator.inviteExistingUser.async': Administrator;
+    'administrator.inviteNewUser.before': void;
+    'administrator.inviteNewUser.after': Administrator;
+    'administrator.inviteNewUser.async': Administrator;
+    'authentication.attemptLogin.before': unknown;
+    'authentication.attemptLogin.after': unknown;
+    'authentication.attemptLogin.async': unknown;
+    'role.create.before': CreateRoleInput;
+    'role.create.after': Role;
+    'role.create.async': Role;
+    'role.update.before': UpdateRoleInput;
+    'role.update.after': Role;
+    'role.update.async': Role;
+    'role.executeRoleDelete.before': void;
+    'role.executeRoleDelete.after': Role;
+    'role.executeRoleDelete.async': Role;
+    'collection.create.before': CreateCollectionInput;
+    'collection.create.after': Collection;
+    'collection.create.async': Collection;
+    'collection.update.before': UpdateCollectionInput;
+    'collection.update.after': Collection;
+    'collection.update.async': Collection;
+    'collection.executeCollectionDelete.before': void;
+    'collection.executeCollectionDelete.after': Collection;
+    'collection.executeCollectionDelete.async': Collection;
+    'facet.create.before': CreateFacetInput;
+    'facet.create.after': Facet;
+    'facet.create.async': Facet;
+    'facet.update.before': UpdateFacetInput;
+    'facet.update.after': Facet;
+    'facet.update.async': Facet;
+    'facet.executeFacetDelete.before': void;
+    'facet.executeFacetDelete.after': Facet;
+    'facet.executeFacetDelete.async': Facet;
+    'facetValue.create.before': CreateFacetValueInput;
+    'facetValue.create.after': FacetValue;
+    'facetValue.create.async': FacetValue;
+    'facetValue.update.before': UpdateFacetValueInput;
+    'facetValue.update.after': FacetValue;
+    'facetValue.update.async': FacetValue;
+    'facetValue.executeFacetValueDelete.before': void;
+    'facetValue.executeFacetValueDelete.after': FacetValue;
+    'facetValue.executeFacetValueDelete.async': FacetValue;
+    'channel.create.before': CreateChannelInput;
+    'channel.create.after': Channel;
+    'channel.create.async': Channel;
+    'channel.update.before': UpdateChannelInput;
+    'channel.update.after': Channel;
+    'channel.update.async': Channel;
+    'channel.delete.before': string;
+    'channel.delete.after': Channel;
+    'channel.delete.async': Channel;
+    'customer.create.before': CreateCustomerInput;
+    'customer.create.after': Customer;
+    'customer.create.async': Customer;
+    'customer.update.before': UpdateCustomerInput;
+    'customer.update.after': Customer;
+    'customer.update.async': Customer;
+    'customer.performSoftDelete.before': string;
+    'customer.performSoftDelete.after': Customer;
+    'customer.performSoftDelete.async': Customer;
+    'customer.registerCustomerAccount.before': RegisterCustomerInput;
+    'customer.registerCustomerAccount.after': Customer;
+    'customer.registerCustomerAccount.async': Customer;
+    'customer.createCustomerForRegistration.before': void;
+    'customer.createCustomerForRegistration.after': Customer;
+    'customer.createCustomerForRegistration.async': Customer;
+    'customerGroup.create.before': CreateCustomerGroupInput;
+    'customerGroup.create.after': CustomerGroup;
+    'customerGroup.create.async': CustomerGroup;
+    'customerGroup.update.before': UpdateCustomerGroupInput;
+    'customerGroup.update.after': CustomerGroup;
+    'customerGroup.update.async': CustomerGroup;
+    'customerGroup.executeCustomerGroupDelete.before': void;
+    'customerGroup.executeCustomerGroupDelete.after': CustomerGroup;
+    'customerGroup.executeCustomerGroupDelete.async': CustomerGroup;
+    'country.create.before': CreateCountryInput;
+    'country.create.after': Country;
+    'country.create.async': Country;
+    'country.update.before': UpdateCountryInput;
+    'country.update.after': Country;
+    'country.update.async': Country;
+    'country.executeCountryDelete.before': void;
+    'country.executeCountryDelete.after': Country;
+    'country.executeCountryDelete.async': Country;
+    'zone.create.before': CreateZoneInput;
+    'zone.create.after': Zone;
+    'zone.create.async': Zone;
+    'zone.update.before': UpdateZoneInput;
+    'zone.update.after': Zone;
+    'zone.update.async': Zone;
+    'zone.delete.before': string;
+    'zone.delete.after': Zone;
+    'zone.delete.async': Zone;
+    'product.create.before': CreateProductInput;
+    'product.create.after': Product;
+    'product.create.async': Product;
+    'product.update.before': UpdateProductInput;
+    'product.update.after': Product;
+    'product.update.async': Product;
+    'product.executeProductDelete.before': void;
+    'product.executeProductDelete.after': Product;
+    'product.executeProductDelete.async': Product;
+    'productVariant.createSingleVariant.before': CreateProductVariantInput;
+    'productVariant.createSingleVariant.after': ProductVariant;
+    'productVariant.createSingleVariant.async': ProductVariant;
+    'productVariant.updateSingleVariant.before': UpdateProductVariantInput;
+    'productVariant.updateSingleVariant.after': ProductVariant;
+    'productVariant.updateSingleVariant.async': ProductVariant;
+    'productVariant.deleteSingleVariant.before': string;
+    'productVariant.deleteSingleVariant.after': ProductVariant;
+    'productVariant.deleteSingleVariant.async': ProductVariant;
+    'promotion.create.before': CreatePromotionInput;
+    'promotion.create.after': Promotion;
+    'promotion.create.async': Promotion;
+    'promotion.update.before': UpdatePromotionInput;
+    'promotion.update.after': Promotion;
+    'promotion.update.async': Promotion;
+    'promotion.executePromotionDelete.before': void;
+    'promotion.executePromotionDelete.after': Promotion;
+    'promotion.executePromotionDelete.async': Promotion;
+    'seller.create.before': CreateSellerInput;
+    'seller.create.after': Seller;
+    'seller.create.async': Seller;
+    'seller.update.before': UpdateSellerInput;
+    'seller.update.after': Seller;
+    'seller.update.async': Seller;
+    'seller.softDelete.before': string;
+    'seller.softDelete.after': Seller;
+    'seller.softDelete.async': Seller;
+    'stockLocation.create.before': CreateStockLocationInput;
+    'stockLocation.create.after': StockLocation;
+    'stockLocation.create.async': StockLocation;
+    'stockLocation.update.before': UpdateStockLocationInput;
+    'stockLocation.update.after': StockLocation;
+    'stockLocation.update.async': StockLocation;
+    'stockLocation.executeStockLocationDelete.before': void;
+    'stockLocation.executeStockLocationDelete.after': StockLocation;
+    'stockLocation.executeStockLocationDelete.async': StockLocation;
+    'taxCategory.create.before': CreateTaxCategoryInput;
+    'taxCategory.create.after': TaxCategory;
+    'taxCategory.create.async': TaxCategory;
+    'taxCategory.update.before': UpdateTaxCategoryInput;
+    'taxCategory.update.after': TaxCategory;
+    'taxCategory.update.async': TaxCategory;
+    'taxCategory.executeTaxCategoryDelete.before': void;
+    'taxCategory.executeTaxCategoryDelete.after': TaxCategory;
+    'taxCategory.executeTaxCategoryDelete.async': TaxCategory;
+    'taxRate.create.before': CreateTaxRateInput;
+    'taxRate.create.after': TaxRate;
+    'taxRate.create.async': TaxRate;
+    'taxRate.update.before': UpdateTaxRateInput;
+    'taxRate.update.after': TaxRate;
+    'taxRate.update.async': TaxRate;
+    'taxRate.delete.before': string;
+    'taxRate.delete.after': TaxRate;
+    'taxRate.delete.async': TaxRate;
+    'fulfillment.createFulfillment.before': CreateFulfillmentInput;
+    'fulfillment.createFulfillment.after': Fulfillment;
+    'fulfillment.createFulfillment.async': Fulfillment;
+    'fulfillment.executeFulfillmentTransition.before': unknown;
+    'fulfillment.executeFulfillmentTransition.after': unknown;
+    'fulfillment.executeFulfillmentTransition.async': unknown;
+    'order.createDraft.before': void;
+    'order.createDraft.after': Order;
+    'order.createDraft.async': Order;
+    'order.create.before': void;
+    'order.create.after': Order;
+    'order.create.async': Order;
+    'payment.executePaymentTransition.before': unknown;
+    'payment.executePaymentTransition.after': unknown;
+    'payment.executePaymentTransition.async': unknown;
+    'channelPlugin.enable.before': string;
+    'channelPlugin.enable.after': ChannelPlugin;
+    'channelPlugin.enable.async': ChannelPlugin;
+    'channelPlugin.disable.before': string;
+    'channelPlugin.disable.after': ChannelPlugin;
+    'channelPlugin.disable.async': ChannelPlugin;
+    'channelPlugin.updateConfiguration.before': UpdateChannelPluginConfigInput;
+    'channelPlugin.updateConfiguration.after': ChannelPlugin;
+    'channelPlugin.updateConfiguration.async': ChannelPlugin;
+    'history.createForOrder.before': unknown;
+    'history.createForOrder.after': HistoryEntry;
+    'history.createForOrder.async': HistoryEntry;
+    'history.createForCustomer.before': unknown;
+    'history.createForCustomer.after': HistoryEntry;
+    'history.createForCustomer.async': HistoryEntry;
+    'history.updateEntry.before': unknown;
+    'history.updateEntry.after': HistoryEntry;
+    'history.updateEntry.async': HistoryEntry;
+    'history.deleteEntry.before': string;
+    'history.deleteEntry.after': HistoryEntry;
+    'history.deleteEntry.async': HistoryEntry;
+    'audienceSegment.create.before': CreateAudienceSegmentInput;
+    'audienceSegment.create.after': AudienceSegment;
+    'audienceSegment.create.async': AudienceSegment;
+    'audienceSegment.update.before': UpdateAudienceSegmentInput;
+    'audienceSegment.update.after': AudienceSegment;
+    'audienceSegment.update.async': AudienceSegment;
+    'audienceSegment.delete.before': string;
+    'audienceSegment.delete.after': AudienceSegment;
+    'audienceSegment.delete.async': AudienceSegment;
+    'audienceMembership.addIdentityToSegment.before': AddIdentityToSegmentInput;
+    'audienceMembership.addIdentityToSegment.after': AudienceMembership;
+    'audienceMembership.addIdentityToSegment.async': AudienceMembership;
+    'audienceMembership.removeIdentityFromSegment.before': RemoveIdentityFromSegmentInput;
+    'audienceMembership.removeIdentityFromSegment.after': AudienceMembership;
+    'audienceMembership.removeIdentityFromSegment.async': AudienceMembership;
+}
+export type AdminHookPoint = keyof AdminHookEventMap;
+export type AdminHookHandler<K extends AdminHookPoint> = AdminHookEventMap[K] extends void ? (ctx: TransactionContext) => Promise<void> : (ctx: TransactionContext, payload: AdminHookEventMap[K]) => Promise<void>;

package/src/index.d.ts

@@ -0,0 +1,22 @@
+export { ForgeCartAdminClient } from './client.generated';
+export { ForgeCartShopClient } from './client.generated';
+export { ForgeCartClient, ClientError, QueryObservable } from './client.generated';
+export type { GraphQLErrorResponse } from './client.generated';
+export type { ForgeCartAdminClientConfig } from './client.generated';
+export type { ForgeCartShopClientConfig } from './client.generated';
+export type { ForgeCartClientConfig } from './client.generated';
+export { TransactionContext } from './client.generated';
+export { AdminNamespace } from './admin.generated';
+export { ShopNamespace } from './shop.generated';
+export type { ID, Type, ApiExtension, IRequestContext, HookHandler } from './sdk-types.generated';
+export type { IFulfillmentHandler, FulfillmentHandlerCapabilities, OrderLineInput } from './sdk-types.generated';
+export { SdkError, SdkErrorCode } from './sdk-types.generated';
+export type { ConfigurationItem, ManageableConfig, IHookRegistry } from './sdk-plugin.generated';
+export { ForgeCartPlugin } from './sdk-plugin.generated';
+export type { HookDispatchEvent, HookSubscription } from './sdk-hook-subscription.generated';
+export { hookDispatchDocument, hookRespondDocument, HookSubscriptionManager } from './sdk-hook-subscription.generated';
+export type { AdminHookEventMap, AdminHookPoint, AdminHookHandler } from './hook-event-map.generated';
+export type { AcfFieldType } from './admin-types.generated';
+export { extractErrorCode, extractError, extractErrorMessage, isErrorCode } from './error-utils';
+export type { ExtractedError } from './error-utils';
+export { Observable, firstValueFrom, lastValueFrom } from 'rxjs';

package/src/index.ts

@@ -2,11 +2,11 @@ export { ForgeCartAdminClient } from './client.generated';
 export { ForgeCartShopClient } from './client.generated';
 export { ForgeCartClient, ClientError, QueryObservable } from './client.generated';
 export type { GraphQLErrorResponse } from './client.generated';
+export type { ErrorHandler, LoginSession, LoginSessionChannel, AdminExternalAuthResult, AdminLoginAdministrator } from './client.generated';
 export type { ForgeCartAdminClientConfig } from './client.generated';
 export type { ForgeCartShopClientConfig } from './client.generated';
 export type { ForgeCartClientConfig } from './client.generated';
 export { TransactionContext } from './client.generated';
-export { ForgeCartGraphQLModule } from './client.generated';
 export { AdminNamespace } from './admin.generated';
 export { ShopNamespace } from './shop.generated';
 export type { ID, Type, ApiExtension, IRequestContext, HookHandler } from './sdk-types.generated';

package/src/nest.generated.ts

@@ -0,0 +1,45 @@
+/* eslint-disable */
+/**
+ * AUTO-GENERATED FILE — DO NOT EDIT
+ *
+ * This file was generated by @forgecart/client-sdk-generators.
+ * Any manual changes will be overwritten on the next generation run.
+ */
+
+
+import { Module, type DynamicModule } from '@nestjs/common';
+import { ForgeCartClient, ForgeCartAdminClient, ForgeCartShopClient } from './client.generated';
+import type { ForgeCartClientConfig, ForgeCartAdminClientConfig, ForgeCartShopClientConfig } from './client.generated';
+
+@Module({})
+export class ForgeCartGraphQLModule {
+  static forAdmin(config: ForgeCartAdminClientConfig): DynamicModule {
+    const client = new ForgeCartAdminClient(config);
+    return {
+      module: ForgeCartGraphQLModule,
+      providers: [{ provide: ForgeCartAdminClient, useValue: client }],
+      exports: [ForgeCartAdminClient],
+    };
+  }
+  static forShop(config: ForgeCartShopClientConfig): DynamicModule {
+    const client = new ForgeCartShopClient(config);
+    return {
+      module: ForgeCartGraphQLModule,
+      providers: [{ provide: ForgeCartShopClient, useValue: client }],
+      exports: [ForgeCartShopClient],
+    };
+  }
+
+  static forRoot(config: ForgeCartClientConfig): DynamicModule {
+    const client = new ForgeCartClient(config);
+    return {
+      module: ForgeCartGraphQLModule,
+      providers: [
+        { provide: ForgeCartClient, useValue: client },
+        { provide: ForgeCartAdminClient, useValue: client.admin },
+        { provide: ForgeCartShopClient, useValue: client.shop },
+      ],
+      exports: [ForgeCartClient, ForgeCartAdminClient, ForgeCartShopClient],
+    };
+  }
+}

package/src/sdk-hook-subscription.generated.d.ts

@@ -0,0 +1,29 @@
+/**
+ * AUTO-GENERATED FILE — DO NOT EDIT
+ *
+ * This file was generated by @forgecart/client-sdk-generators.
+ * Any manual changes will be overwritten on the next generation run.
+ */
+import { Observable } from 'rxjs';
+export interface HookDispatchEvent {
+    id: string;
+    hookPoint: string;
+    transactionToken: string;
+    subscriberId: string;
+    args: unknown[];
+}
+export declare const hookDispatchDocument = "\n  subscription OnHookDispatch($hookPoints: [String!]!) {\n    hookDispatched(hookPoints: $hookPoints) {\n      id\n      hookPoint\n      transactionToken\n      subscriberId\n      args\n    }\n  }\n";
+export declare const hookRespondDocument = "\n  mutation RespondToHook($input: RespondToHookDispatchInput!) {\n    respondToHookDispatch(input: $input)\n  }\n";
+export interface HookSubscription {
+    unsubscribe(): void;
+    readonly closed: Promise<void>;
+}
+export declare class HookSubscriptionManager<TContext = unknown> {
+    private readonly subscribeFn;
+    private readonly respondFn;
+    private readonly createContext;
+    constructor(subscribeFn: (hookPoints: string[]) => Observable<{
+        hookDispatched: HookDispatchEvent;
+    }>, respondFn: (id: string, subscriberId: string, error?: string) => Observable<unknown>, createContext: (transactionToken: string) => TContext);
+    on(hookPoints: string[], handler: (ctx: TContext, payload?: unknown) => Promise<void>): HookSubscription;
+}

package/src/sdk-plugin.generated.d.ts

@@ -0,0 +1,38 @@
+/**
+ * AUTO-GENERATED FILE — DO NOT EDIT
+ *
+ * This file was generated by @forgecart/client-sdk-generators.
+ * Any manual changes will be overwritten on the next generation run.
+ */
+import type { Type, ApiExtension, HookHandler } from './sdk-types.generated';
+export interface ConfigurationItem {
+    readonly code: string;
+    readonly label: string;
+    readonly description?: string;
+    readonly type: 'string' | 'number' | 'boolean' | 'json';
+    readonly defaultValue?: unknown;
+}
+export interface ManageableConfig {
+    readonly description: string;
+    readonly imageUrl?: string;
+    readonly tags: string[];
+    readonly configurationItems: ConfigurationItem[];
+}
+export interface IHookRegistry {
+    on(hookPoint: string, handler: HookHandler, priority?: number): void;
+}
+export declare abstract class ForgeCartPlugin {
+    abstract readonly code: string;
+    abstract readonly name: string;
+    abstract readonly version: string;
+    readonly entities: Type[];
+    readonly services: Type[];
+    readonly resolvers: Type[];
+    readonly controllers: Type[];
+    readonly adminApiExtensions?: ApiExtension;
+    readonly shopApiExtensions?: ApiExtension;
+    register(_hooks: IHookRegistry): void;
+    onBootstrap(): Promise<void>;
+    onShutdown(): Promise<void>;
+    readonly manageable?: ManageableConfig;
+}

package/src/sdk-types.generated.d.ts

@@ -0,0 +1,56 @@
+/**
+ * AUTO-GENERATED FILE — DO NOT EDIT
+ *
+ * This file was generated by @forgecart/client-sdk-generators.
+ * Any manual changes will be overwritten on the next generation run.
+ */
+export type ID = string & {
+    readonly __brand?: 'ID';
+};
+export type Type<T = unknown> = new (...args: any[]) => T;
+export interface ApiExtension {
+    schema?: unknown;
+    resolvers?: Type[];
+}
+/** Minimal RequestContext interface for SDK consumers */
+export interface IRequestContext {
+    readonly channelId: string;
+    readonly channelToken: string;
+    readonly apiType: 'admin' | 'shop';
+    readonly languageCode: string;
+    readonly hookDepth: number;
+    /** Cross-process correlation token set by the platform during hook dispatch */
+    readonly transactionToken?: string;
+}
+export type HookHandler = (...args: unknown[]) => Promise<void>;
+export interface FulfillmentHandlerCapabilities {
+    supportsTracking: boolean;
+    requiresShippingAddress: boolean;
+    autoFulfillOnPayment: boolean;
+    autoDeliver: boolean;
+    autoCreateLabel: boolean;
+    supportsReturn: boolean;
+}
+export interface OrderLineInput {
+    orderLineId: ID;
+    variantId: ID;
+    quantity: number;
+}
+export interface IFulfillmentHandler {
+    readonly code: string;
+    readonly name: string;
+    getCapabilities(): FulfillmentHandlerCapabilities;
+    groupLines(ctx: IRequestContext, lines: OrderLineInput[]): Promise<OrderLineInput[][]>;
+    onCreated(ctx: IRequestContext, fulfillment: unknown): Promise<unknown>;
+    onStateTransition(ctx: IRequestContext, fulfillment: unknown, fromState: string, toState: string): Promise<unknown>;
+}
+export declare enum SdkErrorCode {
+    SERVICE_NOT_FOUND = "SERVICE_NOT_FOUND",
+    METHOD_NOT_FOUND = "METHOD_NOT_FOUND",
+    WEBSOCKET_TIMEOUT = "WEBSOCKET_TIMEOUT"
+}
+export declare class SdkError extends Error {
+    readonly code: SdkErrorCode;
+    readonly variables: Record<string, string>;
+    constructor(code: SdkErrorCode, variables?: Record<string, string>);
+}