@goodz-core/sdk 0.1.0 → 0.3.0

package/dist/commerce/index.d.ts

@@ -0,0 +1,407 @@
+import { X as TransportConfig } from '../transport-BOlScYEv.js';
+
+/**
+ * @goodz-core/sdk — Commerce / Shops API Type Definitions
+ *
+ * Hand-crafted types mirroring the GoodZ.Commerce MCP tool surface.
+ * These cover shop management, batches, gacha pools, campaigns,
+ * wholesale, purchases, and settlement.
+ *
+ * @module
+ */
+type CampaignStatus = "draft" | "active" | "paused" | "ended" | "sold_out";
+type SaleMode = "blind_box" | "ichiban_kuji" | "direct_sale" | "gacha";
+type AuthorizationMode = "open" | "whitelist" | "approved_only";
+type IntegrationMode = "hosted" | "custom";
+interface CommerceCreateShopInput {
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    userId?: number;
+}
+interface CommerceShop {
+    id: number;
+    name: string;
+    description: string | null;
+    imageUrl: string | null;
+    ownerId: number;
+    createdAt: string;
+}
+interface CommerceGetShopDashboardInput {
+    shopId?: number;
+    userId?: number;
+}
+interface CommerceShopDashboard {
+    shop: CommerceShop;
+    stats: {
+        totalOrders: number;
+        totalRevenue: number;
+        platformFees: number;
+        creatorShare: number;
+        shopShare: number;
+        activeCampaigns: number;
+    };
+    recentOrders: any[];
+}
+interface CommerceBatchTier {
+    tierName: string;
+    coreCardId: number;
+    quantity: number;
+    retailPriceCents: number;
+    imageUrl?: string;
+}
+interface CommerceCreateBatchInput {
+    shopId?: number;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    saleMode: SaleMode;
+    tiers: CommerceBatchTier[];
+    userId?: number;
+}
+interface CommerceBatch {
+    id: number;
+    name: string;
+    description: string | null;
+    saleMode: SaleMode;
+    status: string;
+    tiers: CommerceBatchTier[];
+    createdAt: string;
+}
+interface CommerceGachaItem {
+    coreCardId: number;
+    name?: string;
+    imageUrl?: string;
+    weight: number;
+    rarity?: string;
+    quantity?: number;
+}
+interface CommercePityConfig {
+    softPityStart?: number;
+    hardPityAt?: number;
+    stepUpGuarantee?: number;
+    guaranteedRarity?: string;
+}
+interface CommerceCreateGachaPoolInput {
+    shopId?: number;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    pricePerDrawCents: number;
+    isLimited: boolean;
+    totalDraws?: number;
+    items?: CommerceGachaItem[];
+    pityConfig?: CommercePityConfig;
+    userId?: number;
+}
+interface CommerceGachaPool {
+    id: number;
+    name: string;
+    description: string | null;
+    pricePerDrawCents: number;
+    isLimited: boolean;
+    totalDraws: number | null;
+    remainingDraws: number | null;
+    items: CommerceGachaItem[];
+    pityConfig: CommercePityConfig | null;
+    createdAt: string;
+}
+interface CommerceLaunchCampaignInput {
+    shopId?: number;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    batchId?: number;
+    gachaPoolId?: number;
+    isProcured?: boolean;
+    procurementId?: number;
+    startsAt?: string;
+    endsAt?: string;
+    userId?: number;
+}
+interface CommerceCampaign {
+    id: number;
+    name: string;
+    description: string | null;
+    imageUrl: string | null;
+    status: CampaignStatus;
+    batchId: number | null;
+    gachaPoolId: number | null;
+    startsAt: string | null;
+    endsAt: string | null;
+    createdAt: string;
+}
+interface CommerceActivateCampaignInput {
+    campaignId: number;
+    userId?: number;
+}
+interface CommercePauseCampaignInput {
+    campaignId: number;
+    userId?: number;
+}
+interface CommerceEndCampaignInput {
+    campaignId: number;
+    userId?: number;
+}
+interface CommerceUpdateCampaignInput {
+    campaignId: number;
+    name?: string;
+    description?: string;
+    imageUrl?: string;
+    startsAt?: string;
+    endsAt?: string;
+    userId?: number;
+}
+interface CommerceGetCampaignInfoInput {
+    campaignId: number;
+}
+interface CommerceGetCampaignItemsInput {
+    campaign_id: number;
+    enrich_images?: boolean;
+}
+interface CommerceCampaignItem {
+    sourceType: "batch" | "gacha";
+    coreCardId: number;
+    name: string | null;
+    imageUrl: string | null;
+    quantity: number | null;
+    probability: number | null;
+    retailPriceCents: number | null;
+    rarity: string | null;
+}
+interface CommerceExecutePurchaseInput {
+    campaignId: number;
+    quantity?: number;
+    tierId?: number;
+    userId?: number;
+}
+interface CommerceDrawResult {
+    orderId: number;
+    items: Array<{
+        cardId: number;
+        cardName: string | null;
+        imageUrl: string | null;
+        instanceId: number;
+        instanceCode: string;
+        rarity: string | null;
+        tierName: string | null;
+    }>;
+    totalCharged: number;
+    platformFee: number;
+}
+interface CommerceGetMyOrdersInput {
+    userId?: number;
+    limit?: number;
+}
+interface CommerceOrder {
+    id: number;
+    campaignId: number;
+    campaignName: string;
+    quantity: number;
+    totalPaid: number;
+    status: string;
+    createdAt: string;
+    items: any[];
+}
+interface CommercePublishToWholesaleInput {
+    batchId: number;
+    wholesalePriceCents?: number;
+    channelMarginBps?: number;
+    totalStock?: number;
+    authorizationMode?: AuthorizationMode;
+    userId?: number;
+}
+interface CommerceBrowseWholesaleInput {
+    keyword?: string;
+    minPrice?: number;
+    maxPrice?: number;
+    authorizationMode?: AuthorizationMode;
+    creatorId?: string;
+    saleMode?: string;
+    limit?: number;
+}
+interface CommerceWholesaleListing {
+    id: number;
+    batchId: number;
+    batchName: string;
+    wholesalePriceCents: number | null;
+    channelMarginBps: number | null;
+    totalStock: number | null;
+    remainingStock: number | null;
+    authorizationMode: AuthorizationMode;
+    saleMode: SaleMode;
+    creatorId: string;
+}
+interface CommerceProcureBatchInput {
+    listingId: number;
+    quantity?: number;
+    shopId?: number;
+    userId?: number;
+}
+interface CommerceManageInventoryInput {
+    action?: "list" | "sync";
+    shopId?: number;
+    userId?: number;
+}
+interface CommerceRegisterInstancesInput {
+    shopId?: number;
+    instanceIds: number[];
+    userId?: number;
+}
+interface CommerceMintToInventoryInput {
+    shopId?: number;
+    coreCardId: number;
+    quantity?: number;
+    userId?: number;
+}
+interface CommerceGetSettlementReportInput {
+    shopId?: number;
+    userId?: number;
+    period?: string;
+}
+interface CommerceSearchMarketplaceInput {
+    keyword?: string;
+    saleMode?: SaleMode;
+    minPrice?: number;
+    maxPrice?: number;
+    limit?: number;
+    offset?: number;
+}
+interface CommerceGetShopsByBlueprintInput {
+    coreCardId: number;
+    limit?: number;
+}
+interface CommerceRedeemPhysicalInput {
+    orderItemId: number;
+    shippingName: string;
+    shippingAddress: string;
+    shippingPhone: string;
+    coreCardId?: number;
+    userId?: number;
+}
+interface CommerceRegisterWebhookInput {
+    url: string;
+    events: string[];
+    shop_id?: number;
+}
+interface CommerceWebhook {
+    id: number;
+    url: string;
+    events: string[];
+    status: string;
+    failureCount: number;
+    signingSecret?: string;
+}
+interface CommerceTestWebhookInput {
+    webhook_id: number;
+}
+interface CommerceDeleteWebhookInput {
+    webhook_id: number;
+}
+interface CommerceRegisterAppInput {
+    appName: string;
+    redirectUris?: string[];
+    coreScopes?: string[];
+    commerceScopes?: string[];
+    userId?: number;
+}
+interface CommerceUpdateAppInput {
+    clientId: string;
+    appName?: string;
+    description?: string;
+    websiteUrl?: string;
+    iconUrl?: string;
+    redirectUris?: string[];
+    coreScopes?: string[];
+    commerceScopes?: string[];
+    integrationMode?: IntegrationMode;
+    userId?: number;
+}
+interface CommerceListMyAppsInput {
+    userId?: number;
+}
+interface CommerceGetAuthUrlInput {
+    callbackUrl?: string;
+}
+
+/**
+ * @goodz-core/sdk — Commerce / Shops Namespace
+ *
+ * Provides typed access to GoodZ.Commerce MCP tools:
+ * shop management, batches, gacha pools, campaigns,
+ * wholesale, purchases, settlement, and webhooks.
+ *
+ * @module
+ */
+
+interface CommerceNamespace {
+    /** Create a new shop. */
+    createShop(input: CommerceCreateShopInput): Promise<CommerceShop>;
+    /** Get shop dashboard with stats, revenue, and recent orders. */
+    getShopDashboard(input?: CommerceGetShopDashboardInput): Promise<CommerceShopDashboard>;
+    /** Create a batch (product assembly with tiers). Supports blind_box, ichiban_kuji, direct_sale. */
+    createBatch(input: CommerceCreateBatchInput): Promise<CommerceBatch>;
+    /** Create a gacha pool with weighted probabilities and optional pity mechanics. */
+    createGachaPool(input: CommerceCreateGachaPoolInput): Promise<CommerceGachaPool>;
+    /** Launch a sales campaign in draft status. Connect a Batch or Gacha pool to the storefront. */
+    launchCampaign(input: CommerceLaunchCampaignInput): Promise<CommerceCampaign>;
+    /** Activate a draft/paused campaign — makes it live and purchasable. */
+    activateCampaign(input: CommerceActivateCampaignInput): Promise<CommerceCampaign>;
+    /** Pause an active campaign. Existing orders unaffected. */
+    pauseCampaign(input: CommercePauseCampaignInput): Promise<CommerceCampaign>;
+    /** Permanently end a campaign (terminal state). */
+    endCampaign(input: CommerceEndCampaignInput): Promise<CommerceCampaign>;
+    /** Update campaign configuration (editable fields depend on status). */
+    updateCampaign(input: CommerceUpdateCampaignInput): Promise<CommerceCampaign>;
+    /** Get detailed campaign info including batch/gacha config and tiers. */
+    getCampaignInfo(input: CommerceGetCampaignInfoInput): Promise<any>;
+    /** Get unified campaign items list (works for both batch and gacha campaigns). */
+    getCampaignItems(input: CommerceGetCampaignItemsInput): Promise<CommerceCampaignItem[]>;
+    /** Execute a purchase or draw. Handles payment, draw mechanics, settlement, and ownership transfer. */
+    executePurchase(input: CommerceExecutePurchaseInput): Promise<CommerceDrawResult>;
+    /** Get the authenticated user's order history. */
+    getMyOrders(input?: CommerceGetMyOrdersInput): Promise<CommerceOrder[]>;
+    /** Publish a batch to the wholesale market for other shopkeepers to procure. */
+    publishToWholesale(input: CommercePublishToWholesaleInput): Promise<any>;
+    /** Browse available wholesale listings. */
+    browseWholesale(input?: CommerceBrowseWholesaleInput): Promise<CommerceWholesaleListing[]>;
+    /** Procure goods from the wholesale market. */
+    procureBatch(input: CommerceProcureBatchInput): Promise<any>;
+    /** View and manage shop inventory (list or sync from Core). */
+    manageInventory(input?: CommerceManageInventoryInput): Promise<any>;
+    /** Register existing Core instances into shop inventory. */
+    registerInstances(input: CommerceRegisterInstancesInput): Promise<any>;
+    /** Mint new instances directly into shop inventory. */
+    mintToInventory(input: CommerceMintToInventoryInput): Promise<any>;
+    /** Get settlement report with revenue breakdown. */
+    getSettlementReport(input?: CommerceGetSettlementReportInput): Promise<any>;
+    /** Search the marketplace for campaigns. */
+    searchMarketplace(input?: CommerceSearchMarketplaceInput): Promise<any[]>;
+    /** Find shops selling a specific GoodZ card. */
+    getShopsByBlueprint(input: CommerceGetShopsByBlueprintInput): Promise<any[]>;
+    /** Request physical redemption for a purchased item. */
+    redeemPhysical(input: CommerceRedeemPhysicalInput): Promise<any>;
+    /** Register a webhook URL to receive shop event notifications. */
+    registerWebhook(input: CommerceRegisterWebhookInput): Promise<CommerceWebhook>;
+    /** List all registered webhook endpoints. */
+    listWebhooks(): Promise<CommerceWebhook[]>;
+    /** Send a test ping to a webhook endpoint. */
+    testWebhook(input: CommerceTestWebhookInput): Promise<any>;
+    /** Delete a webhook endpoint. */
+    deleteWebhook(input: CommerceDeleteWebhookInput): Promise<any>;
+    /** Register a new OAuth application with Commerce scopes. */
+    registerApp(input: CommerceRegisterAppInput): Promise<any>;
+    /** Update an existing OAuth application. */
+    updateApp(input: CommerceUpdateAppInput): Promise<any>;
+    /** List all OAuth applications owned by the user. */
+    listMyApps(input?: CommerceListMyAppsInput): Promise<any[]>;
+    /** Generate an OAuth authorization URL. */
+    getAuthUrl(input?: CommerceGetAuthUrlInput): Promise<{
+        url: string;
+    }>;
+    /** Call a raw MCP tool by name. Escape hatch for tools not yet in the typed API. */
+    rawTool<T = any>(toolName: string, args?: Record<string, any>): Promise<T>;
+}
+declare function createCommerceNamespace(transport: TransportConfig): CommerceNamespace;
+
+export { type AuthorizationMode, type CampaignStatus, type CommerceActivateCampaignInput, type CommerceBatch, type CommerceBatchTier, type CommerceBrowseWholesaleInput, type CommerceCampaign, type CommerceCampaignItem, type CommerceCreateBatchInput, type CommerceCreateGachaPoolInput, type CommerceCreateShopInput, type CommerceDeleteWebhookInput, type CommerceDrawResult, type CommerceEndCampaignInput, type CommerceExecutePurchaseInput, type CommerceGachaItem, type CommerceGachaPool, type CommerceGetAuthUrlInput, type CommerceGetCampaignInfoInput, type CommerceGetCampaignItemsInput, type CommerceGetMyOrdersInput, type CommerceGetSettlementReportInput, type CommerceGetShopDashboardInput, type CommerceGetShopsByBlueprintInput, type CommerceLaunchCampaignInput, type CommerceListMyAppsInput, type CommerceManageInventoryInput, type CommerceMintToInventoryInput, type CommerceNamespace, type CommerceOrder, type CommercePauseCampaignInput, type CommercePityConfig, type CommerceProcureBatchInput, type CommercePublishToWholesaleInput, type CommerceRedeemPhysicalInput, type CommerceRegisterAppInput, type CommerceRegisterInstancesInput, type CommerceRegisterWebhookInput, type CommerceSearchMarketplaceInput, type CommerceShop, type CommerceShopDashboard, type CommerceTestWebhookInput, type CommerceUpdateAppInput, type CommerceUpdateCampaignInput, type CommerceWebhook, type CommerceWholesaleListing, type IntegrationMode, type SaleMode, createCommerceNamespace };

package/dist/commerce/index.js

@@ -0,0 +1,4 @@
+export { createCommerceNamespace } from '../chunk-MUZDYQ67.js';
+import '../chunk-4SU7SU7K.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/commerce/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}