@vendure-platform/create 0.5.0 → 1.0.0-major.202609091053.0.0

package/dist/assets/storefront/src/lib/vendure/capability-schema.ts

@@ -0,0 +1,358 @@
+import {
+    buildSchema,
+    Kind,
+    parse,
+    print,
+    type DefinitionNode,
+    type DocumentNode,
+    type GraphQLSchema,
+    type InputObjectTypeDefinitionNode,
+    type InterfaceTypeDefinitionNode,
+    type ObjectTypeDefinitionNode,
+} from 'graphql';
+
+/** A capability-owned type, or a field on an otherwise shared type. */
+export interface SchemaContribution {
+    /** Whole types the module adds to the schema. */
+    types?: readonly string[];
+    /** Fields the module adds to a type it shares with other modules. */
+    fields?: Readonly<Record<string, readonly string[]>>;
+}
+
+/**
+ * The two configurator schema sections, mirroring
+ * `libs/configurator/src/api/api-extensions.ts`. Removing both sections from
+ * the full schema reproduces a deployment without the configurator grant.
+ */
+export const CONFIGURATOR_FORMS_CONTRIBUTION: SchemaContribution = {
+    types: [
+        'FieldType',
+        'ConfiguratorField',
+        'ConfiguratorFieldTranslation',
+        'ConfiguratorFieldOption',
+        'ConfiguratorFieldOptionTranslation',
+        'ConfiguratorModule',
+        'ConfiguratorModuleTranslation',
+        'ConfiguratorSystem',
+        'ConfiguratorSystemTranslation',
+        'ProductConfiguration',
+        'ProductConfigurationFieldValue',
+        'ProductConfigurationEvaluation',
+        'EvaluatedField',
+        'EvaluatedFieldOption',
+        'EvaluatedFieldMessage',
+        'ConfiguratorValueInput',
+        'EvaluateProductConfigurationInput',
+        'AddProductConfigurationToOrderInput',
+        'UpdateProductConfigurationOnOrderInput',
+    ],
+    fields: {
+        Query: ['configuratorSystem', 'configuratorSystems', 'evaluateProductConfiguration'],
+        Mutation: [
+            'addProductConfigurationToOrder',
+            'updateProductConfigurationOnOrder',
+            'removeProductConfigurationFromOrder',
+        ],
+        Order: ['productConfigurations'],
+        OrderLineCustomFields: ['productConfiguration', 'productConfigurationId'],
+        ProductCustomFields: ['configuratorSystemCode'],
+        ProductFilterParameter: ['configuratorSystemCode'],
+        ProductSortParameter: ['configuratorSystemCode'],
+    },
+};
+
+export const CONFIGURATOR_RULES_CONTRIBUTION: SchemaContribution = {
+    types: [
+        'ProductConfigurationLine',
+        'EvaluatedProductConfigurationLine',
+        'ProductConfigurationEvaluationTotals',
+        'CalculationError',
+        'ExecutedRule',
+    ],
+    fields: {
+        ProductConfigurationEvaluation: ['lines', 'errors', 'executedRules', 'totals'],
+        ProductConfiguration: ['lines'],
+        OrderLineCustomFields: ['productConfigurationLine', 'productConfigurationLineId'],
+    },
+};
+
+/** Shop API fields contributed by capability modules used in storefront documents. */
+export const STOREFRONT_CAPABILITY_CONTRIBUTIONS: Readonly<Record<string, SchemaContribution>> = {
+    'org.accounts': {
+        fields: {
+            Query: [
+                'activeCompanyUser',
+                'companyAccount',
+                'shopCompanyUsers',
+                'companyRoles',
+                'companyAddresses',
+                'companyPaymentMethods',
+                'companyInvitation',
+                'companyOrders',
+            ],
+            Mutation: [
+                'registerCompany',
+                'updateCompanyAccount',
+                'createCompanyAddress',
+                'updateCompanyAddress',
+                'deleteCompanyAddress',
+                'inviteCompanyUser',
+                'updateCompanyUser',
+                'removeCompanyUser',
+                'assignCompanyUserRole',
+                'acceptCompanyInvitation',
+            ],
+            Customer: ['companyUsers'],
+        },
+    },
+    'org.hierarchy': {
+        fields: {
+            Query: ['companyBusinessUnits'],
+            Mutation: [
+                'createCompanyBusinessUnit',
+                'updateCompanyBusinessUnit',
+                'deleteCompanyBusinessUnit',
+                'switchBusinessUnit',
+            ],
+            Company: ['businessUnits'],
+            CompanyAccount: ['activeBusinessUnit'],
+            CompanyUser: ['businessUnits'],
+            CompanyAddress: ['businessUnit'],
+            CreateCompanyAddressShopInput: ['businessUnitId'],
+            UpdateCompanyAddressShopInput: ['businessUnitId'],
+            InviteCompanyUserInput: ['businessUnitIds'],
+            UpdateCompanyUserShopInput: ['businessUnitIds'],
+        },
+    },
+    'tax-id.validation': {
+        fields: {
+            Query: ['taxIds'],
+            Mutation: ['addTaxId', 'removeTaxId', 'setDefaultTaxId'],
+        },
+    },
+    'quote.requests': {
+        fields: {
+            Query: ['myQuotes', 'myQuote', 'quoteStockCheck'],
+            Mutation: [
+                'requestQuote',
+                'requestQuoteFromCart',
+                'submitQuoteRequest',
+                'acceptQuote',
+                'rejectQuote',
+                'acceptAndConvertQuote',
+                'cancelQuoteCheckout',
+            ],
+            OrderCustomFields: ['sourceQuoteId'],
+            OrderFilterParameter: ['sourceQuoteId'],
+            OrderSortParameter: ['sourceQuoteId'],
+        },
+    },
+    'quote.negotiation': {
+        fields: {
+            Mutation: ['requestQuoteChanges', 'addQuoteComment'],
+            Quote: ['comments', 'versions'],
+        },
+    },
+    'shopping-list.personal': {
+        fields: {
+            Query: ['activeUserShoppingList', 'activeUserShoppingLists'],
+            Mutation: [
+                'addToShoppingList',
+                'removeFromShoppingList',
+                'updateShoppingListItem',
+                'createShoppingList',
+                'updateShoppingList',
+                'deleteShoppingList',
+                'addShoppingListItemsToOrder',
+                'moveShoppingListItems',
+            ],
+            ProductVariant: ['appearsInShoppingLists'],
+        },
+    },
+    'shopping-list.managed': {
+        fields: {
+            Query: ['publicShoppingList'],
+            Mutation: ['setShoppingListVisibility'],
+            ShoppingList: ['isPublic', 'publicCode', 'customer'],
+            ShoppingListItem: ['purchased', 'lastPurchasedAt'],
+        },
+    },
+    'quick-order': {
+        fields: {
+            Query: ['quickOrderSearch'],
+            Mutation: ['validateQuickOrderItems', 'addQuickOrderItemsToOrder'],
+        },
+    },
+    reorder: {
+        fields: {
+            Query: ['previewReorder'],
+            Mutation: ['addReorderToActiveOrder'],
+        },
+    },
+    'store-credit.balance': {
+        fields: {
+            Query: ['myStoreCredits'],
+            Mutation: [
+                'applyStoreCreditToOrder',
+                'removeStoreCreditFromOrder',
+                'claimStoreCredit',
+                'addPaymentToOrderWithStoreCredit',
+            ],
+            Order: ['storeCreditsApplied', 'totalWithTaxAfterStoreCredit'],
+        },
+    },
+    'store-credit.gift-cards': {
+        fields: {
+            Query: ['giftCardTemplates'],
+            Mutation: ['addGiftCardToOrder'],
+            OrderLine: ['giftCardInput'],
+            ProductCustomFields: ['isGiftCard'],
+            ProductFilterParameter: ['isGiftCard'],
+            ProductSortParameter: ['isGiftCard'],
+        },
+    },
+    'packaging-units': {
+        fields: {
+            ProductVariant: ['packagingUnits'],
+            OrderLineCustomFields: ['packagingUnit', 'packagingUnitConversionFactor'],
+            OrderLineCustomFieldsInput: [
+                'packagingUnitId',
+                'packagingUnitConversionFactor',
+                'packagingUnitName',
+            ],
+        },
+    },
+    'shared-carts.collaboration': {
+        fields: {
+            Query: ['mySharedCarts', 'sharedCart', 'companySharedCarts'],
+            Mutation: [
+                'createSharedCart',
+                'updateSharedCart',
+                'deleteSharedCart',
+                'addItemToSharedCart',
+                'adjustSharedCartLine',
+                'removeSharedCartLine',
+                'addSharedCartMember',
+                'removeSharedCartMember',
+                'setSharedCartMemberRole',
+                'transferSharedCartOwnership',
+                'initiateSharedCartCheckout',
+            ],
+        },
+    },
+    'content.history': { fields: { Query: ['contentVersioningProductVariant'] } },
+    'approval.orders': {
+        fields: {
+            Query: ['myApprovalRequests', 'approvalHistoryForEntity'],
+            Mutation: ['submitApprovalDecision', 'batchSubmitApprovalDecisions'],
+        },
+    },
+    'pricing.contract': {
+        fields: {
+            ProductVariant: ['priceTiers'],
+            ShopProductVariantPackagingUnit: ['priceTiers'],
+        },
+    },
+    'search.foundation': {
+        fields: {
+            Query: ['searchCollections'],
+            SearchResult: ['highlights'],
+        },
+    },
+    'search.analytics.clickhouse': {
+        fields: {
+            Mutation: ['logSearchListViewed', 'logSearchResultClicked'],
+            SearchResponse: ['queryId'],
+        },
+    },
+    'configurator.forms': {
+        fields: {
+            ...CONFIGURATOR_FORMS_CONTRIBUTION.fields,
+            ...CONFIGURATOR_RULES_CONTRIBUTION.fields,
+            OrderLineCustomFields: [
+                'productConfiguration',
+                'productConfigurationId',
+                'productConfigurationLine',
+                'productConfigurationLineId',
+            ],
+        },
+    },
+    punchout: {
+        fields: {
+            Query: ['activePunchoutSession'],
+            Mutation: ['activatePunchoutSession', 'transferPunchoutCart'],
+            AuthenticationInput: ['punchout'],
+            ProductCustomFields: ['unspscCode'],
+            ProductFilterParameter: ['unspscCode'],
+            ProductSortParameter: ['unspscCode'],
+        },
+    },
+};
+
+/** Build the Shop API schema for an explicit grant set. */
+export function buildSchemaForCapabilities(fullSdl: string, grants: ReadonlySet<string>): GraphQLSchema {
+    return buildSchemaWithout(
+        fullSdl,
+        Object.entries(STOREFRONT_CAPABILITY_CONTRIBUTIONS)
+            .filter(([capability]) => !grants.has(capability))
+            .map(([, contribution]) => contribution),
+    );
+}
+
+function removeContribution(document: DocumentNode, contribution: SchemaContribution): DocumentNode {
+    const droppedTypes = new Set(contribution.types ?? []);
+    const droppedFields = contribution.fields ?? {};
+
+    const definitions: DefinitionNode[] = [];
+    for (const definition of document.definitions) {
+        if (!('name' in definition) || !definition.name) {
+            definitions.push(definition);
+            continue;
+        }
+        const typeName = definition.name.value;
+        if (droppedTypes.has(typeName)) {
+            continue;
+        }
+        const fieldsToDrop = droppedFields[typeName];
+        if (!fieldsToDrop) {
+            definitions.push(definition);
+            continue;
+        }
+        if (
+            definition.kind === Kind.OBJECT_TYPE_DEFINITION ||
+            definition.kind === Kind.INTERFACE_TYPE_DEFINITION
+        ) {
+            const node = definition as ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode;
+            definitions.push({
+                ...node,
+                fields: (node.fields ?? []).filter((field) => !fieldsToDrop.includes(field.name.value)),
+            });
+            continue;
+        }
+        if (definition.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION) {
+            const node = definition as InputObjectTypeDefinitionNode;
+            definitions.push({
+                ...node,
+                fields: (node.fields ?? []).filter((field) => !fieldsToDrop.includes(field.name.value)),
+            });
+            continue;
+        }
+        definitions.push(definition);
+    }
+    return { ...document, definitions };
+}
+
+/**
+ * Builds the Shop API schema a deployment serves when the listed capability
+ * contributions are absent.
+ */
+export function buildSchemaWithout(
+    fullSdl: string,
+    contributions: readonly SchemaContribution[],
+): GraphQLSchema {
+    let document = parse(fullSdl);
+    for (const contribution of contributions) {
+        document = removeContribution(document, contribution);
+    }
+    return buildSchema(print(document));
+}

package/dist/assets/storefront/src/lib/vendure/capability-ui.ts

@@ -0,0 +1,15 @@
+/** Makes capability-pruned quote activity safe for UI consumers. */
+export function getQuoteNegotiationData<Comment, Version>(quote: {
+    comments?: Comment[];
+    versions?: Version[];
+}): { comments: Comment[]; versions: Version[] } {
+    return {
+        comments: quote.comments ?? [],
+        versions: quote.versions ?? [],
+    };
+}
+
+/** Makes capability-pruned search highlights safe for product cards. */
+export function getSearchHighlights<Highlight>(product: { highlights?: Highlight[] }): Highlight[] {
+    return product.highlights ?? [];
+}