@forgecart/sdk 1.2.3 → 1.2.6

package/dist/admin.js

@@ -1,25 +1,114 @@
 "use strict";
-/**
- * @forgecart/sdk - Admin API
- *
- * Admin namespace and types
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminNamespace = void 0;
-var admin_namespace_js_1 = require("./admin-namespace.js");
-Object.defineProperty(exports, "AdminNamespace", { enumerable: true, get: function () { return admin_namespace_js_1.AdminNamespace; } });
-__exportStar(require("./admin-types.js"), exports);
+exports.ShippingCategory = exports.SellerCategory = exports.SearchCategory = exports.ScheduledJobCategory = exports.RoleCategory = exports.PromotionCategory = exports.ProductCategory = exports.ProductVariantCategory = exports.ProductOptionCategory = exports.OptionCategory = exports.OptionGroupCategory = exports.PluginCategory = exports.ManageableCategory = exports.PaymentCategory = exports.OrderCategory = exports.OrderModificationCategory = exports.NoteCategory = exports.ModificationCategory = exports.DraftCategory = exports.CouponCategory = exports.OnboardingCategory = exports.MarketingIdentityCategory = exports.MarketingEventCategory = exports.MarketingAttributionCategory = exports.HookCategory = exports.HookDispatchCategory = exports.FulfillmentCategory = exports.FulfillmentRequestCategory = exports.FacetCategory = exports.DeploymentCategory = exports.CustomerCategory = exports.CustomerGroupCategory = exports.GroupCategory = exports.AddressCategory = exports.CountryCategory = exports.CollectionCategory = exports.ChannelCategory = exports.SettingsCategory = exports.AuthCategory = exports.AudienceSegmentCategory = exports.AudienceMembershipCategory = exports.AssetCategory = exports.AnalyticsGatewayCategory = exports.AdministratorCategory = exports.AcfCategory = exports.AcfSchemaCategory = exports.PublishCategory = exports.FieldDefinitionCategory = exports.EntryCategory = exports.AdminNamespace = void 0;
+exports.ZoneCategory = exports.TransactionCategory = exports.TaxCategory = exports.SubscriptionCategory = exports.StockCategory = void 0;
+var admin_generated_1 = require("./admin.generated");
+Object.defineProperty(exports, "AdminNamespace", { enumerable: true, get: function () { return admin_generated_1.AdminNamespace; } });
+var admin_generated_2 = require("./admin.generated");
+Object.defineProperty(exports, "EntryCategory", { enumerable: true, get: function () { return admin_generated_2.EntryCategory; } });
+var admin_generated_3 = require("./admin.generated");
+Object.defineProperty(exports, "FieldDefinitionCategory", { enumerable: true, get: function () { return admin_generated_3.FieldDefinitionCategory; } });
+var admin_generated_4 = require("./admin.generated");
+Object.defineProperty(exports, "PublishCategory", { enumerable: true, get: function () { return admin_generated_4.PublishCategory; } });
+var admin_generated_5 = require("./admin.generated");
+Object.defineProperty(exports, "AcfSchemaCategory", { enumerable: true, get: function () { return admin_generated_5.AcfSchemaCategory; } });
+var admin_generated_6 = require("./admin.generated");
+Object.defineProperty(exports, "AcfCategory", { enumerable: true, get: function () { return admin_generated_6.AcfCategory; } });
+var admin_generated_7 = require("./admin.generated");
+Object.defineProperty(exports, "AdministratorCategory", { enumerable: true, get: function () { return admin_generated_7.AdministratorCategory; } });
+var admin_generated_8 = require("./admin.generated");
+Object.defineProperty(exports, "AnalyticsGatewayCategory", { enumerable: true, get: function () { return admin_generated_8.AnalyticsGatewayCategory; } });
+var admin_generated_9 = require("./admin.generated");
+Object.defineProperty(exports, "AssetCategory", { enumerable: true, get: function () { return admin_generated_9.AssetCategory; } });
+var admin_generated_10 = require("./admin.generated");
+Object.defineProperty(exports, "AudienceMembershipCategory", { enumerable: true, get: function () { return admin_generated_10.AudienceMembershipCategory; } });
+var admin_generated_11 = require("./admin.generated");
+Object.defineProperty(exports, "AudienceSegmentCategory", { enumerable: true, get: function () { return admin_generated_11.AudienceSegmentCategory; } });
+var admin_generated_12 = require("./admin.generated");
+Object.defineProperty(exports, "AuthCategory", { enumerable: true, get: function () { return admin_generated_12.AuthCategory; } });
+var admin_generated_13 = require("./admin.generated");
+Object.defineProperty(exports, "SettingsCategory", { enumerable: true, get: function () { return admin_generated_13.SettingsCategory; } });
+var admin_generated_14 = require("./admin.generated");
+Object.defineProperty(exports, "ChannelCategory", { enumerable: true, get: function () { return admin_generated_14.ChannelCategory; } });
+var admin_generated_15 = require("./admin.generated");
+Object.defineProperty(exports, "CollectionCategory", { enumerable: true, get: function () { return admin_generated_15.CollectionCategory; } });
+var admin_generated_16 = require("./admin.generated");
+Object.defineProperty(exports, "CountryCategory", { enumerable: true, get: function () { return admin_generated_16.CountryCategory; } });
+var admin_generated_17 = require("./admin.generated");
+Object.defineProperty(exports, "AddressCategory", { enumerable: true, get: function () { return admin_generated_17.AddressCategory; } });
+var admin_generated_18 = require("./admin.generated");
+Object.defineProperty(exports, "GroupCategory", { enumerable: true, get: function () { return admin_generated_18.GroupCategory; } });
+var admin_generated_19 = require("./admin.generated");
+Object.defineProperty(exports, "CustomerGroupCategory", { enumerable: true, get: function () { return admin_generated_19.CustomerGroupCategory; } });
+var admin_generated_20 = require("./admin.generated");
+Object.defineProperty(exports, "CustomerCategory", { enumerable: true, get: function () { return admin_generated_20.CustomerCategory; } });
+var admin_generated_21 = require("./admin.generated");
+Object.defineProperty(exports, "DeploymentCategory", { enumerable: true, get: function () { return admin_generated_21.DeploymentCategory; } });
+var admin_generated_22 = require("./admin.generated");
+Object.defineProperty(exports, "FacetCategory", { enumerable: true, get: function () { return admin_generated_22.FacetCategory; } });
+var admin_generated_23 = require("./admin.generated");
+Object.defineProperty(exports, "FulfillmentRequestCategory", { enumerable: true, get: function () { return admin_generated_23.FulfillmentRequestCategory; } });
+var admin_generated_24 = require("./admin.generated");
+Object.defineProperty(exports, "FulfillmentCategory", { enumerable: true, get: function () { return admin_generated_24.FulfillmentCategory; } });
+var admin_generated_25 = require("./admin.generated");
+Object.defineProperty(exports, "HookDispatchCategory", { enumerable: true, get: function () { return admin_generated_25.HookDispatchCategory; } });
+var admin_generated_26 = require("./admin.generated");
+Object.defineProperty(exports, "HookCategory", { enumerable: true, get: function () { return admin_generated_26.HookCategory; } });
+var admin_generated_27 = require("./admin.generated");
+Object.defineProperty(exports, "MarketingAttributionCategory", { enumerable: true, get: function () { return admin_generated_27.MarketingAttributionCategory; } });
+var admin_generated_28 = require("./admin.generated");
+Object.defineProperty(exports, "MarketingEventCategory", { enumerable: true, get: function () { return admin_generated_28.MarketingEventCategory; } });
+var admin_generated_29 = require("./admin.generated");
+Object.defineProperty(exports, "MarketingIdentityCategory", { enumerable: true, get: function () { return admin_generated_29.MarketingIdentityCategory; } });
+var admin_generated_30 = require("./admin.generated");
+Object.defineProperty(exports, "OnboardingCategory", { enumerable: true, get: function () { return admin_generated_30.OnboardingCategory; } });
+var admin_generated_31 = require("./admin.generated");
+Object.defineProperty(exports, "CouponCategory", { enumerable: true, get: function () { return admin_generated_31.CouponCategory; } });
+var admin_generated_32 = require("./admin.generated");
+Object.defineProperty(exports, "DraftCategory", { enumerable: true, get: function () { return admin_generated_32.DraftCategory; } });
+var admin_generated_33 = require("./admin.generated");
+Object.defineProperty(exports, "ModificationCategory", { enumerable: true, get: function () { return admin_generated_33.ModificationCategory; } });
+var admin_generated_34 = require("./admin.generated");
+Object.defineProperty(exports, "NoteCategory", { enumerable: true, get: function () { return admin_generated_34.NoteCategory; } });
+var admin_generated_35 = require("./admin.generated");
+Object.defineProperty(exports, "OrderModificationCategory", { enumerable: true, get: function () { return admin_generated_35.OrderModificationCategory; } });
+var admin_generated_36 = require("./admin.generated");
+Object.defineProperty(exports, "OrderCategory", { enumerable: true, get: function () { return admin_generated_36.OrderCategory; } });
+var admin_generated_37 = require("./admin.generated");
+Object.defineProperty(exports, "PaymentCategory", { enumerable: true, get: function () { return admin_generated_37.PaymentCategory; } });
+var admin_generated_38 = require("./admin.generated");
+Object.defineProperty(exports, "ManageableCategory", { enumerable: true, get: function () { return admin_generated_38.ManageableCategory; } });
+var admin_generated_39 = require("./admin.generated");
+Object.defineProperty(exports, "PluginCategory", { enumerable: true, get: function () { return admin_generated_39.PluginCategory; } });
+var admin_generated_40 = require("./admin.generated");
+Object.defineProperty(exports, "OptionGroupCategory", { enumerable: true, get: function () { return admin_generated_40.OptionGroupCategory; } });
+var admin_generated_41 = require("./admin.generated");
+Object.defineProperty(exports, "OptionCategory", { enumerable: true, get: function () { return admin_generated_41.OptionCategory; } });
+var admin_generated_42 = require("./admin.generated");
+Object.defineProperty(exports, "ProductOptionCategory", { enumerable: true, get: function () { return admin_generated_42.ProductOptionCategory; } });
+var admin_generated_43 = require("./admin.generated");
+Object.defineProperty(exports, "ProductVariantCategory", { enumerable: true, get: function () { return admin_generated_43.ProductVariantCategory; } });
+var admin_generated_44 = require("./admin.generated");
+Object.defineProperty(exports, "ProductCategory", { enumerable: true, get: function () { return admin_generated_44.ProductCategory; } });
+var admin_generated_45 = require("./admin.generated");
+Object.defineProperty(exports, "PromotionCategory", { enumerable: true, get: function () { return admin_generated_45.PromotionCategory; } });
+var admin_generated_46 = require("./admin.generated");
+Object.defineProperty(exports, "RoleCategory", { enumerable: true, get: function () { return admin_generated_46.RoleCategory; } });
+var admin_generated_47 = require("./admin.generated");
+Object.defineProperty(exports, "ScheduledJobCategory", { enumerable: true, get: function () { return admin_generated_47.ScheduledJobCategory; } });
+var admin_generated_48 = require("./admin.generated");
+Object.defineProperty(exports, "SearchCategory", { enumerable: true, get: function () { return admin_generated_48.SearchCategory; } });
+var admin_generated_49 = require("./admin.generated");
+Object.defineProperty(exports, "SellerCategory", { enumerable: true, get: function () { return admin_generated_49.SellerCategory; } });
+var admin_generated_50 = require("./admin.generated");
+Object.defineProperty(exports, "ShippingCategory", { enumerable: true, get: function () { return admin_generated_50.ShippingCategory; } });
+var admin_generated_51 = require("./admin.generated");
+Object.defineProperty(exports, "StockCategory", { enumerable: true, get: function () { return admin_generated_51.StockCategory; } });
+var admin_generated_52 = require("./admin.generated");
+Object.defineProperty(exports, "SubscriptionCategory", { enumerable: true, get: function () { return admin_generated_52.SubscriptionCategory; } });
+var admin_generated_53 = require("./admin.generated");
+Object.defineProperty(exports, "TaxCategory", { enumerable: true, get: function () { return admin_generated_53.TaxCategory; } });
+var admin_generated_54 = require("./admin.generated");
+Object.defineProperty(exports, "TransactionCategory", { enumerable: true, get: function () { return admin_generated_54.TransactionCategory; } });
+var admin_generated_55 = require("./admin.generated");
+Object.defineProperty(exports, "ZoneCategory", { enumerable: true, get: function () { return admin_generated_55.ZoneCategory; } });

package/dist/client.generated.d.ts

@@ -0,0 +1,251 @@
+/**
+ * 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';
+import type { HookSubscription } from './sdk-hook-subscription.generated';
+import type { AdminHookPoint, AdminHookHandler } from './hook-event-map.generated';
+import { AdminNamespace } from './admin.generated';
+import type * as Admin from './admin.generated';
+import { ShopNamespace } from './shop.generated';
+import type * as Shop from './shop.generated';
+export interface ForgeCartAdminClientConfig {
+    endpoint: string;
+    channelToken: string;
+    adminSecret?: string;
+    uploadEndpoint?: string;
+    headers?: Record<string, string>;
+}
+export interface ForgeCartShopClientConfig {
+    endpoint: string;
+    channelToken: string;
+    uploadEndpoint?: string;
+    headers?: Record<string, string>;
+}
+export interface ForgeCartClientConfig {
+    endpoint: string;
+    channelToken: string;
+    adminSecret?: string;
+    uploadEndpoint?: string;
+    headers?: Record<string, string>;
+}
+export declare class SDKLogger {
+    private readonly prefix;
+    info(message: string, data?: Record<string, unknown>): void;
+    warn(message: string, data?: Record<string, unknown>): void;
+    error(message: string, data?: Record<string, unknown>): void;
+}
+export interface GraphQLErrorResponse {
+    errors: Array<{
+        message: string;
+        extensions?: Record<string, unknown>;
+    }>;
+}
+export declare class ClientError extends Error {
+    readonly response: GraphQLErrorResponse;
+    constructor(response: GraphQLErrorResponse, message: string);
+}
+export type ErrorHandler = (error: ClientError) => void;
+/**
+ * An Observable that is also PromiseLike, so `await` resolves the first emitted value.
+ * Use `.subscribe()` for streaming, `await` for single-shot request-response.
+ */
+export declare class QueryObservable<T> extends Observable<T> implements PromiseLike<T> {
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
+}
+export interface LoginSessionChannel {
+    id: string;
+    token: string;
+    code: string;
+    permissions: string[];
+}
+export interface LoginSession {
+    id: string;
+    token: string;
+    channels: LoginSessionChannel[];
+}
+export interface AdminLoginAdministrator {
+    id: string;
+    firstName: string;
+    lastName: string;
+    emailAddress: string;
+    avatarUrl: string | null;
+}
+export interface AdminExternalAuthResult {
+    session: LoginSession;
+    administrator: AdminLoginAdministrator;
+    requiresOnboarding: boolean;
+}
+export declare class BaseGraphQLClient {
+    private readonly baseHeaders;
+    private readonly uploadEndpoint?;
+    private readonly logger;
+    private readonly endpoint;
+    private wsClient;
+    private ownsWsClient;
+    private wsClientStale;
+    private authToken;
+    private transactionToken;
+    private errorHandler;
+    constructor(endpoint: string, baseHeaders: Record<string, string>, uploadEndpoint?: string | undefined);
+    private getWsClient;
+    private getHeaders;
+    setAuthToken(token: string): void;
+    clearAuthToken(): void;
+    setTransactionToken(token: string): void;
+    clearTransactionToken(): void;
+    setErrorHandler(handler: ErrorHandler): void;
+    private notifyErrorHandler;
+    query<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    mutate<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    subscribe<T>(document: string, variables?: Record<string, unknown>): Observable<T>;
+    upload<T>(document: string, variables: Record<string, unknown>): QueryObservable<T>;
+    private getPerOperationExtensions;
+    private captureSessionToken;
+    private captureSessionTokenFromUpload;
+    private containsFiles;
+    private resolveUploadEndpoint;
+    private disposeWsClient;
+    dispose(): void;
+    fork(transactionToken: string): BaseGraphQLClient;
+}
+export declare function setAuthToken(client: BaseGraphQLClient, token: string): void;
+export declare function clearAuthToken(client: BaseGraphQLClient): void;
+export declare function setTransactionToken(client: BaseGraphQLClient, token: string): void;
+export declare function clearTransactionToken(client: BaseGraphQLClient): void;
+export declare class TransactionContext {
+    private readonly _admin;
+    private readonly _shop;
+    constructor(admin: AdminNamespace, shop?: ShopNamespace);
+    get admin(): AdminNamespace;
+    get shop(): ShopNamespace;
+}
+export declare class ForgeCartAdminClient {
+    private readonly client;
+    private readonly _namespace;
+    constructor(config: ForgeCartAdminClientConfig);
+    setAuthToken(token: string): void;
+    clearAuthToken(): void;
+    setTransactionToken(token: string): void;
+    clearTransactionToken(): void;
+    setErrorHandler(handler: ErrorHandler): void;
+    dispose(): void;
+    query<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    mutate<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    private shopPeer;
+    setShopPeer(shop: ForgeCartShopClient): void;
+    createScopedNamespace(transactionToken: string): AdminNamespace;
+    withTransaction<T>(fn: (ctx: TransactionContext) => Promise<T>): Promise<T>;
+    private hookManager;
+    on<K extends AdminHookPoint>(hookPoints: K[], handler: AdminHookHandler<K>): HookSubscription;
+    login(emailAddress: string, password: string): Promise<LoginSession>;
+    loginWithExternalStrategy(strategyCode: string, data: Record<string, unknown>): Promise<AdminExternalAuthResult>;
+    logout(): Promise<void>;
+    get entry(): Admin.EntryCategory;
+    get fieldDefinition(): Admin.FieldDefinitionCategory;
+    get publish(): Admin.PublishCategory;
+    get acfSchema(): Admin.AcfSchemaCategory;
+    get acf(): Admin.AcfCategory;
+    get administrator(): Admin.AdministratorCategory;
+    get analyticsGateway(): Admin.AnalyticsGatewayCategory;
+    get asset(): Admin.AssetCategory;
+    get audienceMembership(): Admin.AudienceMembershipCategory;
+    get audienceSegment(): Admin.AudienceSegmentCategory;
+    get auth(): Admin.AuthCategory;
+    get settings(): Admin.SettingsCategory;
+    get channel(): Admin.ChannelCategory;
+    get collection(): Admin.CollectionCategory;
+    get country(): Admin.CountryCategory;
+    get address(): Admin.AddressCategory;
+    get group(): Admin.GroupCategory;
+    get customerGroup(): Admin.CustomerGroupCategory;
+    get customer(): Admin.CustomerCategory;
+    get deployment(): Admin.DeploymentCategory;
+    get facet(): Admin.FacetCategory;
+    get fulfillmentRequest(): Admin.FulfillmentRequestCategory;
+    get fulfillment(): Admin.FulfillmentCategory;
+    get hookDispatch(): Admin.HookDispatchCategory;
+    get hook(): Admin.HookCategory;
+    get marketingAttribution(): Admin.MarketingAttributionCategory;
+    get marketingEvent(): Admin.MarketingEventCategory;
+    get marketingIdentity(): Admin.MarketingIdentityCategory;
+    get onboarding(): Admin.OnboardingCategory;
+    get coupon(): Admin.CouponCategory;
+    get draft(): Admin.DraftCategory;
+    get modification(): Admin.ModificationCategory;
+    get note(): Admin.NoteCategory;
+    get orderModification(): Admin.OrderModificationCategory;
+    get order(): Admin.OrderCategory;
+    get payment(): Admin.PaymentCategory;
+    get manageable(): Admin.ManageableCategory;
+    get plugin(): Admin.PluginCategory;
+    get optionGroup(): Admin.OptionGroupCategory;
+    get option(): Admin.OptionCategory;
+    get productOption(): Admin.ProductOptionCategory;
+    get productVariant(): Admin.ProductVariantCategory;
+    get product(): Admin.ProductCategory;
+    get promotion(): Admin.PromotionCategory;
+    get role(): Admin.RoleCategory;
+    get scheduledJob(): Admin.ScheduledJobCategory;
+    get search(): Admin.SearchCategory;
+    get seller(): Admin.SellerCategory;
+    get shipping(): Admin.ShippingCategory;
+    get stock(): Admin.StockCategory;
+    get subscription(): Admin.SubscriptionCategory;
+    get tax(): Admin.TaxCategory;
+    get transaction(): Admin.TransactionCategory;
+    get zone(): Admin.ZoneCategory;
+}
+export declare class ForgeCartShopClient {
+    private readonly client;
+    private readonly _namespace;
+    constructor(config: ForgeCartShopClientConfig);
+    setAuthToken(token: string): void;
+    clearAuthToken(): void;
+    setTransactionToken(token: string): void;
+    clearTransactionToken(): void;
+    setErrorHandler(handler: ErrorHandler): void;
+    dispose(): void;
+    query<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    mutate<T>(document: string, variables?: Record<string, unknown>): QueryObservable<T>;
+    createScopedNamespace(transactionToken: string): ShopNamespace;
+    login(emailAddress: string, password: string): Promise<LoginSession>;
+    loginWithExternalStrategy(strategyCode: string, data: Record<string, unknown>): Promise<LoginSession>;
+    logout(): Promise<void>;
+    get acf(): Shop.AcfCategory;
+    get auth(): Shop.AuthCategory;
+    get cart(): Shop.CartCategory;
+    get checkout(): Shop.CheckoutCategory;
+    get collection(): Shop.CollectionCategory;
+    get customer(): Shop.CustomerCategory;
+    get facet(): Shop.FacetCategory;
+    get hookDispatch(): Shop.HookDispatchCategory;
+    get hook(): Shop.HookCategory;
+    get marketingEvent(): Shop.MarketingEventCategory;
+    get marketingIdentity(): Shop.MarketingIdentityCategory;
+    get order(): Shop.OrderCategory;
+    get payment(): Shop.PaymentCategory;
+    get product(): Shop.ProductCategory;
+    get search(): Shop.SearchCategory;
+    get shipping(): Shop.ShippingCategory;
+    get subscription(): Shop.SubscriptionCategory;
+}
+export declare class ForgeCartClient {
+    private readonly _admin;
+    private readonly _shop;
+    constructor(config: ForgeCartClientConfig);
+    setAuthToken(token: string): void;
+    clearAuthToken(): void;
+    setTransactionToken(token: string): void;
+    clearTransactionToken(): void;
+    get admin(): ForgeCartAdminClient;
+    get shop(): ForgeCartShopClient;
+}
+import { type DynamicModule } from '@nestjs/common';
+export declare class ForgeCartGraphQLModule {
+    static forAdmin(config: ForgeCartAdminClientConfig): DynamicModule;
+    static forShop(config: ForgeCartShopClientConfig): DynamicModule;
+    static forRoot(config: ForgeCartClientConfig): DynamicModule;
+}