@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/pricing/index.js

@@ -1,4 +1,7 @@
-import { createPage, errorFromErrorResult, isErrorResult, NotFoundError, ValidationError, } from '@sixtyninecommerce/core';
+import { ConflictError, createPage, errorFromErrorResult, isErrorResult, NotFoundError, UpstreamError, ValidationError, } from '@sixtyninecommerce/core';
+import { fieldOf, vendureListPage, } from '../catalog/types.js';
+import { createPricingBulkCouponsModule } from './bulk-coupons.js';
+import { createPricingPriceListsModule } from './price-lists.js';
 import { createPricingVouchersModule } from './vouchers.js';
 /**
  * The targeting conditions (incentives sprint 2), encoded as the engine stores
@@ -142,6 +145,14 @@ export const promotionActions = {
         return { code: 'mix_and_match', arguments: [] };
     },
 };
+export const PROMOTION_SORT_FIELDS = [
+    'name',
+    'couponCode',
+    'startsAt',
+    'endsAt',
+    'createdAt',
+    'updatedAt',
+];
 const DISCOUNT_FIELDS = 'promotionId adjustmentSource type description amount amountWithTax';
 /** An order's pricing readout; the manual pricing doors (`orders.setLinePrices`, …) answer it too. */
 export const ORDER_DISCOUNTS_FIELDS = /* GraphQL */ `
@@ -223,8 +234,144 @@ export const UPDATE_PROMOTION_MUTATION = /* GraphQL */ `
     }
   }
 `;
+const PROMOTION_ROW_FIELDS = /* GraphQL */ `
+  id
+  name
+  description
+  couponCode
+  enabled
+  startsAt
+  endsAt
+  usageLimit
+  perCustomerUsageLimit
+  createdAt
+  updatedAt
+`;
+export const PROMOTIONS_QUERY = /* GraphQL */ `
+  query StorePromotions($options: PromotionListOptions) {
+    promotions(options: $options) {
+      items {
+        ${PROMOTION_ROW_FIELDS}
+        customFields { combineWithB2b combineWithOtherPromotions priority }
+      }
+      totalItems
+    }
+  }
+`;
+export const PROMOTION_QUERY = /* GraphQL */ `
+  query StorePromotion($id: ID!) {
+    promotion(id: $id) {
+      ${PROMOTION_ROW_FIELDS}
+      translations { id languageCode name description }
+      conditions { code args { name value } }
+      actions { code args { name value } }
+      customFields { combineWithB2b combineWithOtherPromotions priority managedBy }
+    }
+  }
+`;
+export const DELETE_PROMOTION_MUTATION = /* GraphQL */ `
+  mutation DeleteStorePromotion($id: ID!) {
+    deletePromotion(id: $id) {
+      result
+      message
+    }
+  }
+`;
+const DEFINITION_FIELDS = /* GraphQL */ `
+  code
+  description
+  args {
+    name
+    type
+    list
+    required
+    defaultValue
+    label
+    description
+    ui
+  }
+`;
+export const PROMOTION_CONDITION_DEFINITIONS_QUERY = /* GraphQL */ `
+  query PromotionConditionDefinitions {
+    promotionConditions { ${DEFINITION_FIELDS} }
+  }
+`;
+export const PROMOTION_ACTION_DEFINITIONS_QUERY = /* GraphQL */ `
+  query PromotionActionDefinitions {
+    promotionActions { ${DEFINITION_FIELDS} }
+  }
+`;
 /** The condition the dashboard and the admin app put on every promotion they save. */
 export const STACKING_GUARD_CONDITION = 'promotion_stacking_guard';
+/**
+ * The price-list order-rule condition and action (`vendure-plugin-price-list`'s
+ * `order-rule-promotion.ts`): only the store's auto-managed promotion carries them, and the engine
+ * refuses them on any other (`PROMOTION_CONDITION_INVALID`), so they are never offered.
+ */
+const ORDER_RULE_OPERATION = 'price_list_order_rules';
+/** Registered conditions a caller never sets itself (see `conditionDefinitions`). */
+const NOT_OFFERED_CONDITIONS = new Set([
+    STACKING_GUARD_CONDITION,
+    ORDER_RULE_OPERATION,
+]);
+/** Registered actions a caller never sets itself (see `actionDefinitions`). */
+const NOT_OFFERED_ACTIONS = new Set([ORDER_RULE_OPERATION]);
+/**
+ * Every list read asks only for promotions no platform service manages: the store's order-rule
+ * promotion (`customFields.managedBy`) is never a row, on any page or search.
+ */
+const MERCHANT_PROMOTIONS = { managedBy: { isNull: true } };
+function invalidPromotionList(code, message) {
+    return new ValidationError({ code, message, status: 400, service: 'vendure' });
+}
+/** `promotions(options)`'s variables for one page, the filters and the sort checked first. */
+function promotionListVariables(options) {
+    const filter = { ...MERCHANT_PROMOTIONS };
+    const term = options?.term;
+    if (term !== undefined) {
+        if (typeof term !== 'string') {
+            throw invalidPromotionList('INVALID_PROMOTION_FILTER', 'term must be a string.');
+        }
+        const trimmed = term.trim();
+        if (trimmed !== '') {
+            filter._or = [{ name: { contains: trimmed } }, { couponCode: { contains: trimmed } }];
+        }
+    }
+    const enabled = options?.enabled;
+    if (enabled !== undefined) {
+        if (typeof enabled !== 'boolean') {
+            throw invalidPromotionList('INVALID_PROMOTION_FILTER', 'enabled must be true or false.');
+        }
+        filter.enabled = { eq: enabled };
+    }
+    const sort = options?.sort;
+    if (sort !== undefined &&
+        (!PROMOTION_SORT_FIELDS.includes(sort.field) ||
+            (sort.direction !== 'ASC' && sort.direction !== 'DESC'))) {
+        throw invalidPromotionList('INVALID_PROMOTION_SORT', `sort must name one of ${PROMOTION_SORT_FIELDS.join(', ')} and a direction ASC or DESC.`);
+    }
+    return (skip, take) => ({
+        options: {
+            skip,
+            take,
+            filter,
+            ...(sort === undefined ? {} : { sort: { [sort.field]: sort.direction } }),
+        },
+    });
+}
+/** A definitions list read by name: anything but a list is refused, never answered empty. */
+async function definitionsOf(transport, document, field, hidden, options) {
+    const definitions = await fieldOf(transport, document, field, {}, options);
+    if (!Array.isArray(definitions)) {
+        throw new UpstreamError({
+            code: 'UNEXPECTED_RESPONSE',
+            message: `The engine answered "${field}" without a list.`,
+            status: 502,
+            service: 'vendure',
+        });
+    }
+    return definitions.filter((definition) => !hidden.has(definition.code));
+}
 function withStackingGuard(conditions) {
     return conditions.some((condition) => condition.code === STACKING_GUARD_CONDITION)
         ? conditions
@@ -280,6 +427,30 @@ function idVariable(value) {
 export function createPricingModule(transport) {
     return {
         promotions: {
+            // Async, so a refused option rejects the promise like every refusal, never throws.
+            async list(options) {
+                return vendureListPage(transport, PROMOTIONS_QUERY, 'promotions', promotionListVariables(options), options);
+            },
+            get(id, options) {
+                return fieldOf(transport, PROMOTION_QUERY, 'promotion', { id }, options);
+            },
+            async delete(id, options) {
+                const answer = await fieldOf(transport, DELETE_PROMOTION_MUTATION, 'deletePromotion', { id }, options);
+                if (answer.result !== 'DELETED') {
+                    throw new ConflictError({
+                        code: 'PROMOTION_NOT_DELETED',
+                        message: answer.message || `The engine kept promotion ${id}.`,
+                        status: 409,
+                        service: 'vendure',
+                    });
+                }
+            },
+            conditionDefinitions(options) {
+                return definitionsOf(transport, PROMOTION_CONDITION_DEFINITIONS_QUERY, 'promotionConditions', NOT_OFFERED_CONDITIONS, options);
+            },
+            actionDefinitions(options) {
+                return definitionsOf(transport, PROMOTION_ACTION_DEFINITIONS_QUERY, 'promotionActions', NOT_OFFERED_ACTIONS, options);
+            },
             async active(filter, options) {
                 const data = await transport.graphql({
                     api: 'admin',
@@ -319,7 +490,9 @@ export function createPricingModule(transport) {
             },
         },
         vouchers: createPricingVouchersModule(transport),
+        priceLists: createPricingPriceListsModule(transport),
         coupons: {
+            bulk: createPricingBulkCouponsModule(transport),
             async apply(orderId, couponCode, options) {
                 const data = await transport.graphql({
                     api: 'admin',