Vendure

https://docs.vendure.io
Admin
Vendure is a headless commerce platform with modular architecture for companies with complex...
Tokens:905,224
Snippets:9,417
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start MinIO Server (Direct Installation)

Source: https://docs.vendure.io/current/core/how-to/s3-asset-storage

If not using Docker, download and install MinIO, then start the server with this command, specifying the data directory and console address.

```bash
minio server /data --console-address ":9001"
```

--------------------------------

### Quick setup example (global mode)

Source: https://docs.vendure.io/plugins/elastic-search-synonyms

Configures the ElasticSearchSynonymsPlugin in global mode and integrates it with the ElasticsearchPlugin using default helpers.

```typescript
import { ElasticsearchPlugin } from '@vendure-community/elasticsearch-plugin'
import {
  ElasticSearchSynonymsPlugin,
  defaultSynonymAnalyzer,
  defaultSynonymFilters,
  defaultSynonymIndexMappingProperties,
} from '@haus-tech/elastic-search-synonyms'

export const config = {
  plugins: [
    ElasticSearchSynonymsPlugin.init({
      channelSpecificSynonyms: false,
      synonymsSetId: 'vendure-synonyms',
    }),
    ElasticsearchPlugin.init({
      indexSettings: {
        analysis: {
          analyzer: {
            ...defaultSynonymAnalyzer,
          },
          filter: {
            ...defaultSynonymFilters,
          },
        },
      },
      indexMappingProperties: {
        ...defaultSynonymIndexMappingProperties,
      },
    }),
  ],
}
```

--------------------------------

### Implementing the init Hook

Source: https://docs.vendure.io/current/core/reference/typescript-api/common/injectable-strategy

Example of how to implement the init hook to perform setup logic using the provided Injector.

```typescript
async init(injector: Injector) {
  const myService = injector.get(MyService);
  await myService.doSomething();
}
```

--------------------------------

### Full instrumentation setup

Source: https://docs.vendure.io/current/core/reference/core-plugins/telemetry-plugin/get-sdk-configuration

Example of configuring custom exporters and processors for traces and logs within an instrumentation file.

```typescript
// instrumentation.ts
import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-proto';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { BatchLogRecordProcessor } from '@opentelemetry/sdk-logs';
import { NodeSDK } from '@opentelemetry/sdk-node';
import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { getSdkConfiguration } from '@vendure/telemetry-plugin/preload';

process.env.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://localhost:3100/otlp';
process.env.OTEL_LOGS_EXPORTER = 'otlp';
process.env.OTEL_RESOURCE_ATTRIBUTES = 'service.name=vendure-dev-server';

const traceExporter = new OTLPTraceExporter({
    url: 'http://localhost:4318/v1/traces',
});
const logExporter = new OTLPLogExporter();

const config = getSdkConfiguration({
    config: {
        spanProcessors: [new BatchSpanProcessor(traceExporter)],
        logRecordProcessors: [new BatchLogRecordProcessor(logExporter)],
    },
});

const sdk = new NodeSDK(config);

sdk.start();
```

--------------------------------

### Install MinIO Server with Docker Compose

Source: https://docs.vendure.io/current/core/how-to/s3-asset-storage

Use this command to start the MinIO server using Docker Compose. Ensure you have a docker-compose.yml file configured for MinIO.

```bash
docker compose up -d minio
```

--------------------------------

### Fetch documentation via AI agent

Source: https://docs.vendure.io/

Use this prompt with an AI coding assistant to fetch and scaffold a project based on the installation guide.

```text
Fetch https://docs.vendure.io/current/core/getting-started/installation.md and scaffold a new Vendure project
```

--------------------------------

### SettingsStoreService Usage Example

Source: https://docs.vendure.io/current/core/reference/typescript-api/services/settings-store-service

Demonstrates how to get and set individual settings, as well as retrieve multiple settings using the SettingsStoreService.

```typescript
import { RequestContext } from '@vendure/core';

// Assuming this.settingsStoreService is available in the current service context

// Get a specific setting
const userTheme = await this.settingsStoreService.get('dashboard.theme', ctx);

// Set a specific setting
await this.settingsStoreService.set('dashboard.theme', 'dark', ctx);

// Get multiple settings
const settings = await this.settingsStoreService.getMany([
  'dashboard.theme',
  'dashboard.tableFilters'
], ctx);
```

--------------------------------

### Bootstrap JobQueueService

Source: https://docs.vendure.io/current/core/reference/typescript-api/job-queue/in-memory-job-queue-strategy

This example shows how to bootstrap the Vendure application and start the JobQueueService, which is necessary for the InMemoryJobQueueStrategy to function.

```typescript
bootstrap(config)
  .then(app => app.get(JobQueueService).start());
```

--------------------------------

### Build and Start Commands

Source: https://docs.vendure.io/current/core/deployment/deploy-to-render

Standard commands for building and starting a Vendure project on Render.

```bash
yarn; yarn build
```

```bash
npm install; npm run build
```

```bash
node ./dist/index.js
```

--------------------------------

### Project Setup Completion Message

Source: https://docs.vendure.io/current/core/getting-started/installation

The final output displayed after the project scaffold is created and dependencies are installed, showing the project structure and access points.

```console
◇  Setup complete! ─────────────────────────────────────╮
│                                                       │
│  Your new Vendure project was created!                │
│  /Users/username/path/my-shop                         │
│                                                       │
│                                                       │
│  This is a monorepo with the following apps:          │
│    apps/server     - Vendure backend                  │
│    apps/storefront - TanStack Start frontend          │
│                                                       │
│                                                       │
│  Next, run:                                           │
│  $ cd my-shop                                         │
│  $ npm run dev                                        │
│                                                       │
│                                                       │
│  This will start both the server and storefront.      │
│                                                       │
│                                                       │
│  Access points:                                       │
│    Dashboard:  http://localhost:3000/dashboard        │
│    Storefront: http://localhost:3001                  │
│                                                       │
│                                                       │
│  Use the following credentials to log in:             │
│  Username: superadmin                                 │
│  Password: superadmin                                 │
│                                                       │
│                                                       │
│  ➡️ Docs: https://docs.vendure.io                     │
│  ➡️ Discord community: https://vendure.io/community   │
│  ➡️ Star us on GitHub:                                │
│     https://github.com/vendurehq/vendure      │
│                                                       │
├───────────────────────────────────────────────────────╯
│
└  Happy hacking!
```

--------------------------------

### Install MyParcel Plugin

Source: https://docs.vendure.io/plugins/myparcel

Install the plugin via npm.

```bash
npm install @pinelab/vendure-plugin-myparcel
```

--------------------------------

### Install Loyalty Points Plugin

Source: https://docs.vendure.io/current/core/how-to/publish-plugin

Install the loyalty points plugin using npm.

```bash
npm install @acme/vendure-plugin-loyalty-points
```

--------------------------------

### Install via yarn

Source: https://docs.vendure.io/plugins/quotations

Command to install the plugin using yarn.

```bash
yarn add @huloglobal/vendure-plugin-quotations
```

--------------------------------

### Install Limited Products Plugin

Source: https://docs.vendure.io/plugins/limited-products

Use your preferred package manager to install the plugin.

```bash
npm install @pinelab/vendure-plugin-limited-products
```

--------------------------------

### Install via npm

Source: https://docs.vendure.io/plugins/quotations

Command to install the plugin using npm.

```bash
npm install @huloglobal/vendure-plugin-quotations
```

--------------------------------

### Install PunchOutGatewayPlugin

Source: https://docs.vendure.io/current/community-plugins/punch-out-gateway-plugin

Install the plugin using npm.

```bash
npm install @vendure-community/punchout-gateway-plugin
```

--------------------------------

### Install Klaviyo Plugin

Source: https://docs.vendure.io/plugins/klaviyo

Install the plugin package using npm.

```bash
npm install @pinelab/vendure-plugin-klaviyo
```

--------------------------------

### Install Coinbase Plugin

Source: https://docs.vendure.io/plugins/coinbase

Install the plugin package using your preferred package manager.

```bash
npm install @pinelab/vendure-plugin-coinbase
```

--------------------------------

### Install via npm

Source: https://docs.vendure.io/plugins/visitor-analytics

Command to install the visitor analytics plugin using npm.

```bash
npm install @huloglobal/vendure-plugin-visitor-analytics
```

--------------------------------

### Install @haus-tech/product-import-export-plugin

Source: https://docs.vendure.io/plugins/product-import-export

Use this command to install the plugin via npm.

```bash
npm install @haus-tech/product-import-export-plugin
```

--------------------------------

### productFieldMapping Example

Source: https://docs.vendure.io/current/community-plugins/punch-out-gateway-plugin/punch-out-gateway-plugin-options

An example configuration for mapping product fields to custom fields.

```typescript
productFieldMapping: {
    unit: { customField: 'punchOutUnit', default: 'PCE' },
    unit_name: { customField: 'punchOutUnitName', default: 'Piece' },
    weight: { customField: 'productWeight', default: 0 },
}
```

--------------------------------

### Install via yarn

Source: https://docs.vendure.io/plugins/visitor-analytics

Command to install the visitor analytics plugin using yarn.

```bash
yarn add @huloglobal/vendure-plugin-visitor-analytics
```

--------------------------------

### Install Facet Suggestions Plugin

Source: https://docs.vendure.io/plugins/facet-suggestions

Command to install the plugin via npm.

```bash
npm install @pinelab/vendure-plugin-facet-suggestions
```

--------------------------------

### Install Popularity Scores Plugin

Source: https://docs.vendure.io/plugins/popularity-scores

Use npm to install the plugin package.

```bash
npm install @pinelab/vendure-plugin-popularity-scores
```

--------------------------------

### Install Drop Off Points Plugin

Source: https://docs.vendure.io/plugins/drop-off-points

Install the plugin package using npm.

```bash
npm install @pinelab/vendure-plugin-drop-off-points
```

--------------------------------

### Install BullMQ Package

Source: https://docs.vendure.io/current/core/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy

To use this strategy, you need to manually install the `bullmq` package.

```shell
npm install bullmq@^5.4.2
```

--------------------------------

### Install Accept Blue plugin

Source: https://docs.vendure.io/plugins/accept-blue

Installation command for the Accept Blue plugin using npm.

```bash
npm install @pinelab/vendure-plugin-accept-blue
```

--------------------------------

### Install Stripe Plugin and Library

Source: https://docs.vendure.io/current/community-plugins/reference/stripe-plugin

Install the required Stripe plugin and the Stripe Node library.

```bash
npm install @vendure-community/stripe-plugin stripe
```

--------------------------------

### Install GoedGepickt Plugin

Source: https://docs.vendure.io/plugins/goedgepickt

Use npm to install the GoedGepickt plugin package.

```bash
npm install @pinelab/vendure-plugin-goedgepickt
```

--------------------------------

### Install Stripe JS Library

Source: https://docs.vendure.io/current/community-plugins/reference/stripe-plugin

Install the Stripe JS library for storefront usage.

```bash
npm install @stripe/stripe-js
```

--------------------------------

### Install Selectable Gifts Plugin

Source: https://docs.vendure.io/plugins/selectable-gifts

Use the package manager to install the plugin dependency.

```bash
npm install @pinelab/vendure-plugin-selectable-gifts
```

--------------------------------

### Install UTM Tracker Plugin

Source: https://docs.vendure.io/plugins/utm-tracker

Use the package manager of your choice to install the plugin.

```bash
npm install @pinelab/vendure-plugin-utm-tracker
```

--------------------------------

### Install Store Credit Plugin via npm

Source: https://docs.vendure.io/plugins/store-credit

Command to install the plugin package.

```bash
npm install @pinelab/vendure-plugin-store-credit
```

--------------------------------

### Select Quick Start option

Source: https://docs.vendure.io/current/core/getting-started/installation

Choose the 'Quick Start' option in the CLI prompt to automatically configure the server and database.

```console
┌  Let's create a Vendure App ✨
│
◆  How should we proceed?
│  ● Quick Start (Get up and running in a single step) # [!code highlight]
│  ○ Manual Configuration
└
```

--------------------------------

### Get Buffer Sizes Example

Source: https://docs.vendure.io/current/core/reference/typescript-api/job-queue/job-buffer-storage-strategy

Demonstrates how to retrieve the number of buffered jobs for specific buffer IDs. Pass an empty array to get sizes for all buffers.

```typescript
const sizes = await myJobBufferStrategy.bufferSize(['buffer-1', 'buffer-2']);

// sizes = { 'buffer-1': 12, 'buffer-2': 3 }
```

--------------------------------

### Install Google Storage Assets plugin

Source: https://docs.vendure.io/plugins/google-storage-assets

Command to install the plugin via npm.

```bash
npm install @pinelab/vendure-plugin-google-storage-assets
```

--------------------------------

### Run Migration and Start Server

Source: https://docs.vendure.io/guides/developer-guide/plugins

Apply the generated migration to the database and then start the development server.

```bash
npx vendure migrate wishlist-plugin
```

```bash
npm run dev
```

--------------------------------

### Bootstrap a Vendure worker

Source: https://docs.vendure.io/current/core/reference/typescript-api/worker/bootstrap-worker

Example usage of the bootstrapWorker function to initialize the worker and start the job queue.

```ts
import { bootstrapWorker } from '@vendure/core';
import { config } from './vendure-config';

bootstrapWorker(config)
  .then(worker => worker.startJobQueue())
  .catch(err => {
    console.log(err);
    process.exit(1);
  });
```

--------------------------------

### Install Address Lookup Plugin

Source: https://docs.vendure.io/plugins/address-lookup

Install the plugin package using your preferred package manager.

```bash
npm install @pinelab/vendure-plugin-address-lookup
```

--------------------------------

### Install SumUp plugin

Source: https://docs.vendure.io/plugins/sumup

Install the SumUp plugin package using your preferred package manager.

```bash
npm install @sumup/vendure-plugin
```

--------------------------------

### Select storefront starter

Source: https://docs.vendure.io/current/core/getting-started/installation

Choose whether to include an official storefront starter like TanStack Start or Next.js, or select 'None' to proceed without one.

```console
┌  Let's create a Vendure App ✨
│
◇  How should we proceed?
│  Quick Start
│
◇  Using port 3000
│
◇  Docker is running
│
◆  Would you like to include a storefront? # [!code highlight]
│  ○ None # [!code highlight]
│  ● TanStack Start # [!code highlight]
│  ○ Next.js # [!code highlight]
└ # [!code highlight]
```

--------------------------------

### Install Asset Server Plugin

Source: https://docs.vendure.io/current/core/reference/core-plugins/asset-server-plugin

Install the Asset Server Plugin using yarn or npm.

```bash
yarn add @vendure/asset-server-plugin
```

```bash
npm install @vendure/asset-server-plugin
```

--------------------------------

### Install Elasticsearch Plugin

Source: https://docs.vendure.io/current/community-plugins/elasticsearch-plugin

Install the required Elasticsearch client and the Vendure plugin package.

```bash
npm install @elastic/elasticsearch @vendure/elasticsearch-plugin
```

--------------------------------

### Install plugin package

Source: https://docs.vendure.io/plugins/elastic-search-synonyms

Install the core plugin package using your preferred package manager.

```bash
npm install @haus-tech/elastic-search-synonyms
```

--------------------------------

### Troubleshoot installation with verbose logging

Source: https://docs.vendure.io/current/core/getting-started/installation

Run the creation command with the --log-level flag set to verbose to debug installation issues.

```bash
npx @vendure/create my-shop --log-level verbose
```

--------------------------------

### Installing the dashboard migration agent skill

Source: https://docs.vendure.io/current/core/extending-the-dashboard/migration

Command to install the migration skill for automated assistance.

```bash
npx skills add vendurehq/vendure --skill vendure-dashboard-migration
```

--------------------------------

### Populate Vendure Server with Initial Data and Products

Source: https://docs.vendure.io/current/core/reference/typescript-api/import-export/populate

This example demonstrates how to use the populate function to bootstrap the Vendure server, provide initial data, and import products from a CSV file. Ensure the necessary imports and configuration are in place.

```typescript
import { bootstrap } from '@vendure/core';
import { populate } from '@vendure/core/cli';
import { config } from './vendure-config.ts'
import { initialData } from './my-initial-data.ts';

const productsCsvFile = path.join(__dirname, 'path/to/products.csv')

populate(
  () => bootstrap(config),
  initialData,
  productsCsvFile,
)
.then(app => app.close())
.then(
  () => process.exit(0),
  err => {
    console.log(err);
    process.exit(1);
  },
);
```

--------------------------------

### Get Buffered Job Sizes

Source: https://docs.vendure.io/current/core/reference/typescript-api/job-queue/job-queue-service

Example of how to retrieve the number of jobs currently buffered for specific job buffers. This can help determine if flushing is necessary.

```typescript
const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');

// sizes = { 'buffer-1': 12, 'buffer-2': 3 }
```

--------------------------------

### PricelistPlugin Initialization Example

Source: https://docs.vendure.io/plugins/pricelist

Demonstrates a full configuration of the PricelistPlugin, including custom purge schedules, pricing strategies, and operational flags.

```typescript
PricelistPlugin.init({
  // soft-delete / purge
  purgePendingDeletionAfterMs: 24 * 60 * 60 * 1000, // 24 hours
  purgePendingDeletionSchedule: cron => cron.every(1).hours(),
  purgePendingDeletionBatchSize: 50,

  // pricing strategies
  selectionStrategy: new CheapestWinsSelectionStrategy(),
  roundingStrategy: new BankersRoundingStrategy(),
  additionalValidityPredicates: [new MyFeatureFlagPredicate()],

  // operational
  killSwitchPerChannel: { 'legacy-channel': true },
  defaultCacheTtlMs: 5 * 60 * 1000, // 5 minutes
  exposeBadgeOnShopApi: false,
  recordOrderLineProvenance: false
});
```

--------------------------------

### init(options: PubSubOptions)

Source: https://docs.vendure.io/current/community-plugins/pub-sub-plugin

Initializes the PubSubPlugin with the provided configuration options.

```APIDOC
## init(options: PubSubOptions)

### Description
Initializes the PubSubPlugin with the required Google Cloud Pub/Sub configuration options.

### Signature
`init(options: PubSubOptions) => Type<PubSubPlugin>`

### Parameters
- **options** (PubSubOptions) - Required - Configuration object for the Pub/Sub plugin.
```

--------------------------------

### Install MinIO Client (mc) on Linux

Source: https://docs.vendure.io/current/core/how-to/s3-asset-storage

Installs the MinIO Client (mc) on Linux by downloading the binary and adding it to the PATH.

```bash
# Linux
curl https://dl.min.io/client/mc/release/linux-amd64/mc \
  --create-dirs -o $HOME/minio-binaries/mc
chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/
```

--------------------------------

### Using usePaginatedList in a Component

Source: https://docs.vendure.io/current/core/reference/dashboard/hooks/use-paginated-list

This example shows how to use the usePaginatedList hook to get the refetch function and call it after a successful mutation to refresh the paginated list data.

```typescript
const { refetchPaginatedList } = usePaginatedList();

const mutation = useMutation({
    mutationFn: api.mutate(updateFacetValueDocument),
    onSuccess: () => {
        refetchPaginatedList();
    },
});
```

--------------------------------

### Synchronous Custom Field Validation

Source: https://docs.vendure.io/current/core/developer-guide/custom-fields

Example of a synchronous validation function for a string custom field. It checks if a URL starts with 'http' and returns localized error messages if invalid.

```typescript
import {
    LanguageCode,
    LocalizedString,
} from '@vendure/core';

const config = {
    // ...
    customFields: {
        Product: [
            {
                name: 'infoUrl',
                type: 'string',
                validate: (value: any) => {
                    if (!value.startsWith('http')) {
                        // If a localized error message is not required, a simple string can be returned.
                        // return 'The URL must start with "http"';

                        // If a localized error message is required, return an array of LocalizedString objects.
                        return [
                            { languageCode: LanguageCode.en, value: 'The URL must start with "http"' },
                            { languageCode: LanguageCode.de, value: 'Die URL muss mit "http" beginnen' },
                            { languageCode: LanguageCode.es, value: 'La URL debe comenzar con "http"' },
                        ];
                    }
                },
            },
        ]
    }
};
```

--------------------------------

### Initialize Strapi Project

Source: https://docs.vendure.io/current/core/how-to/cms-integration-plugin

CLI commands to scaffold a new Strapi application.

```bash
npx create-strapi-app@latest strapi-integration-app
cd strapi-integration-app
```

--------------------------------

### Custom TestDbInitializer Example

Source: https://docs.vendure.io/current/core/reference/typescript-api/testing/test-db-initializer

Implement the TestDbInitializer interface to create custom database setup logic for specific database types. Register your custom initializer using the registerInitializer function.

```typescript
export class CockroachDbInitializer implements TestDbInitializer<CockroachConnectionOptions> {
    // database-specific implementation goes here
}

registerInitializer('cockroachdb', new CockroachDbInitializer());
```

--------------------------------

### Development commands

Source: https://docs.vendure.io/plugins/vendure-plugin-asset-watermark

Standard commands for installing dependencies, running tests, and building the project.

```bash
npm install
npm test
npm run build
```

--------------------------------

### Get Active Order Query

Source: https://docs.vendure.io/current/core/storefront/active-order

Retrieves the current active order using the `activeOrder` query and the predefined `ActiveOrder` fragment. This is the starting point for viewing or modifying the customer's cart.

```graphql
query GetActiveOrder {
  activeOrder {
    ...ActiveOrder
  }
}

```

```graphql
query GetActiveOrder {
  activeOrder {
    ...ActiveOrder
  }
}

```

--------------------------------

### Start Development Server

Source: https://docs.vendure.io/current/core/developer-guide/plugins

Command to launch the Vendure development server.

```bash
npm run dev
```

--------------------------------

### Handle Bearer Token Authentication

Source: https://docs.vendure.io/current/core/storefront/connect-api

This example demonstrates how to manage bearer token authentication by reading tokens from response headers and attaching them to subsequent requests. It assumes a GraphQL client setup and checks for the 'vendure-auth-token' header.

```typescript
let token: string | undefined = localStorage.getItem('token')

export async function request(query: string, variables: any) {
     // If we already know the token, set the Authorization header.
     const headers = token ? { Authorization: `Bearer ${token}` } : {};

     const response = await someGraphQlClient(query, variables, headers);

     // Check the response headers to see if Vendure has set the
     // auth token. The header key "vendure-auth-token" may be set to
     // a custom value with the authOptions.authTokenHeaderKey config option.
     const authToken = response.headers.get('vendure-auth-token');
     if (authToken != null) {
         token = authToken;
     }
     return response.data;
}
```

--------------------------------

### Using useInjector to Inject Services

Source: https://docs.vendure.io/current/core/reference/admin-ui-api/react-hooks/use-injector

Demonstrates how to use the useInjector hook to get an instance of an Angular service (NotificationService) and call its methods within a React component. Ensure the service is correctly provided in your Angular setup.

```typescript
import { useInjector } from '@vendure/admin-ui/react';
import { NotificationService } from '@vendure/admin-ui/core';

export const MyComponent = () => {
    const notificationService = useInjector(NotificationService);

    const handleClick = () => {
        notificationService.success('Hello world!');
    };
    // ...
    return <div>...</div>;
}
```

--------------------------------

### Initialize KeycloakPlugin with configuration options

Source: https://docs.vendure.io/plugins/keycloak

This example demonstrates the full configuration of the Keycloak plugin, including separate client settings for admin and shop APIs and disabling automatic customer registration.

```typescript
KeycloakPlugin.init({
  serverUrl: 'https://keycloak.example.com',
  realm: 'my-realm',

  // back-office users
  adminClient: {
    clientId: 'vendure-admin',
    clientSecret: process.env.KEYCLOAK_ADMIN_SECRET!,
    redirectUri: 'https://shop.example.com/dashboard/keycloak-callback'
  },

  // storefront customers (optional — defaults to adminClient)
  shopClient: {
    clientId: 'vendure-shop',
    clientSecret: process.env.KEYCLOAK_SHOP_SECRET!,
    redirectUri: 'https://www.example.com/auth/callback'
  },

  // require customers to exist in Vendure before they can log in
  autoRegisterShopCustomers: false
});
```

--------------------------------

### Redis Session Cache Strategy Implementation

Source: https://docs.vendure.io/current/core/reference/typescript-api/auth/session-cache-strategy

An example implementation of SessionCacheStrategy using Redis for caching session data. Requires the 'ioredis' package. Initializes a Redis client and provides methods for getting, setting, and deleting cached sessions.

```typescript
import { CachedSession, Logger, SessionCacheStrategy, VendurePlugin } from '@vendure/core';
import { Redis, RedisOptions } from 'ioredis';

export interface RedisSessionCachePluginOptions {
  namespace?: string;
  redisOptions?: RedisOptions;
}
const loggerCtx = 'RedisSessionCacheStrategy';
const DEFAULT_NAMESPACE = 'vendure-session-cache';
const DEFAULT_TTL = 86400;

export class RedisSessionCacheStrategy implements SessionCacheStrategy {
  private client: Redis;
  constructor(private options: RedisSessionCachePluginOptions) {}

  init() {
    this.client = new Redis(this.options.redisOptions as RedisOptions);
    this.client.on('error', err => Logger.error(err.message, loggerCtx, err.stack));
  }

  async destroy() {
    await this.client.quit();
  }

  async get(sessionToken: string): Promise<CachedSession | undefined> {
    try {
      const retrieved = await this.client.get(this.namespace(sessionToken));
      if (retrieved) {
        try {
          return JSON.parse(retrieved);
        } catch (e: any) {
          Logger.error(`Could not parse cached session data: ${e.message}`, loggerCtx);
        }
      }
    } catch (e: any) {
      Logger.error(`Could not get cached session: ${e.message}`, loggerCtx);
    }
  }

  async set(session: CachedSession) {
    try {
      await this.client.set(this.namespace(session.token), JSON.stringify(session), 'EX', DEFAULT_TTL);
    } catch (e: any) {
      Logger.error(`Could not set cached session: ${e.message}`, loggerCtx);
    }
  }

  async delete(sessionToken: string) {
    try {
      await this.client.del(this.namespace(sessionToken));
    } catch (e: any) {
      Logger.error(`Could not delete cached session: ${e.message}`, loggerCtx);
    }
  }

  clear() {
    // not implemented
  }

  private namespace(key: string) {
    return `${this.options.namespace ?? DEFAULT_NAMESPACE}:${key}`;
  }
}

@VendurePlugin({
  configuration: config => {
    config.authOptions.sessionCacheStrategy = new RedisSessionCacheStrategy(
      RedisSessionCachePlugin.options,
    );
    return config;
  },
})
export class RedisSessionCachePlugin {
  static options: RedisSessionCachePluginOptions;
  static init(options: RedisSessionCachePluginOptions) {
    this.options = options;
    return this;
  }
}

```

--------------------------------

### Using useRichTextEditor Hook

Source: https://docs.vendure.io/current/core/reference/admin-ui-api/react-hooks/use-rich-text-editor

This example demonstrates how to use the useRichTextEditor hook to get access to the ProseMirror editor instance. It initializes the editor with custom attributes and an onTextInput callback, and returns a ref to be attached to the editor's container element.

```typescript
import { useRichTextEditor } from '@vendure/admin-ui/react';
import React from 'react';

export function Component() {
    const { ref, editor } = useRichTextEditor({
       attributes: { class: '' },
       onTextInput: (text) => console.log(text),
       isReadOnly: () => false,
    });

    return <div className="w-full" ref={ref} />
}
```

--------------------------------

### Run @vendure/create CLI

Source: https://docs.vendure.io/current/core/getting-started/installation

Execute this command in your terminal to begin the scaffolding process, replacing 'my-shop' with your desired project name.

```bash
npx @vendure/create my-shop
```

--------------------------------

### Asynchronous Custom Field Validation with Injector

Source: https://docs.vendure.io/current/core/developer-guide/custom-fields

Example of an asynchronous validation function for a string custom field. It uses the Injector to get a service and perform an asynchronous validation check, returning a simple string error message if invalid.

```typescript
const config = {
    // ...
    customFields: {
        ProductVariant: [
            {
                name: 'partCode',
                type: 'string',
                validate: async (value, injector, ctx) => {
                    const partCodeService = injector.get(PartCodeService);
                    const isValid = await partCodeService.validateCode(value);
                    if (!isValid) {
                        return `Part code ${value} is not valid`;
                    }
                },
            },
        ]
    }
};
```

--------------------------------

### Install ioredis Package

Source: https://docs.vendure.io/current/core/reference/typescript-api/cache/redis-cache-plugin

To use the RedisCachePlugin, you must manually install the 'ioredis' package. This command installs version 5.3.2 or later.

```shell
npm install ioredis@^5.3.2
```

--------------------------------

### Start Server with Instrumentation

Source: https://docs.vendure.io/current/core/reference/core-plugins/telemetry-plugin

Start the Vendure server using the `--require` flag to load the instrumentation script.

```bash
node --require ./dist/instrumentation.js ./dist/server.js
```

```bash
npx ts-node --require ./src/instrumentation.ts ./src/server.ts
```

--------------------------------

### Implement Lifecycle Hooks in a Plugin

Source: https://docs.vendure.io/current/core/developer-guide/plugins

Demonstrates implementing OnApplicationBootstrap to perform server-only initialization tasks by checking the ProcessContext.

```ts
import { OnApplicationBootstrap } from '@nestjs/common';
import { PluginCommonModule, ProcessContext, VendurePlugin } from '@vendure/core';

@VendurePlugin({
    imports: [PluginCommonModule],
})
export class MyPlugin implements OnApplicationBootstrap {
    constructor(private processContext: ProcessContext) {}

    async onApplicationBootstrap() {
        // Without this guard the work below would run twice: once in the
        // server and once in the worker.
        if (this.processContext.isWorker) {
            return;
        }
        // Do something on the server only
    }
}
```

--------------------------------

### Basic Usage of createTestEnvironment

Source: https://docs.vendure.io/current/core/reference/typescript-api/testing/create-test-environment

Demonstrates how to set up and initialize the test environment for end-to-end tests. Ensure to call server.init() and server.destroy() appropriately.

```typescript
import { createTestEnvironment, testConfig } from '@vendure/testing';

describe('some feature to test', () => {

  const { server, adminClient, shopClient } = createTestEnvironment(testConfig);

  beforeAll(async () => {
    await server.init({
        // ... server options
    });
    await adminClient.asSuperAdmin();
  });

  afterAll(async () => {
      await server.destroy();
  });

  // ... end-to-end tests here
});
```

--------------------------------

### Install dataloader package

Source: https://docs.vendure.io/current/core/developer-guide/dataloaders

Install the dataloader npm package.

```bash
npm install dataloader
```

--------------------------------

### Install Mollie plugin and client

Source: https://docs.vendure.io/current/community-plugins/mollie-plugin

Install the necessary packages via npm, pnpm, yarn, or bun.

```bash
npm install @vendure-community/mollie-plugin @mollie/api-client
```

--------------------------------

### Install Google Auth Library

Source: https://docs.vendure.io/current/core/how-to/google-oauth-authentication

Install the Google Auth Library to securely verify ID tokens on the server side.

```bash
npm install google-auth-library
```

--------------------------------

### Install Keycloak Plugin

Source: https://docs.vendure.io/plugins/keycloak

Install the plugin package via npm.

```bash
npm install @datasolution/vendure-plugin-keycloak
```

--------------------------------

### Install Stock Monitoring Plugin via CLI

Source: https://docs.vendure.io/plugins/stock-monitoring-plugin

Use your preferred package manager to install the plugin package.

```bash
npm install @pinelab/vendure-plugin-stock-monitoring
```

--------------------------------

### Install Anonymized Order Plugin

Source: https://docs.vendure.io/plugins/anonymized-order

Install the plugin using npm.

```bash
npm install @pinelab/vendure-plugin-anonymized-order
```

--------------------------------

### Create and Use Cache Instance

Source: https://docs.vendure.io/current/core/reference/typescript-api/cache

Demonstrates how to create a cache instance with custom key generation and options, and then use it to retrieve data, fetching from the source if not found in the cache.

```typescript
const cache = cacheService.createCache({
  getKey: id => `ProductVariantIds:${id}`,
  options: {
    ttl: 1000 * 60 * 60,
    tags: ['products'],
  },
});

// This will fetch the value from the cache if it exists, or
// fetch it from the ProductService if not, and then cache
// using the key 'ProductVariantIds.${id}'.
const variantIds = await cache.get(id, async () => {
  const variants await ProductService.getVariantsByProductId(ctx, id) ;
  // The cached value must be serializable, so we just return the ids
  return variants.map(v => v.id);
});
```

--------------------------------

### Install Vendure CLI

Source: https://docs.vendure.io/current/core/developer-guide/cli

Install the CLI as a development dependency in your project.

```bash
npm install -D @vendure/cli
```

--------------------------------

### Install Sentry Plugin

Source: https://docs.vendure.io/current/community-plugins/reference/sentry-plugin

Install the plugin package using npm.

```bash
npm install @vendure-community/sentry-plugin
```

--------------------------------

### Install Fraud Prevention Plugin

Source: https://docs.vendure.io/plugins/fraud-prevention

Install the plugin package using npm.

```bash
npm i @huloglobal/vendure-plugin-fraud-prevention
```

--------------------------------

### Install Store Credit Plugin via npm (alternative)

Source: https://docs.vendure.io/plugins/store-credit

Alternative command to install the plugin package.

```bash
npm i @pinelab/vendure-plugin-store-credit
```

--------------------------------

### Basic ConfigArgs Example

Source: https://docs.vendure.io/current/core/reference/typescript-api/configurable-operation-def/config-args

Defines basic arguments with string, integer, and boolean types.

```typescript
{
  apiKey: { type: 'string' },
  maxRetries: { type: 'int' },
  logErrors: { type: 'boolean' },
}
```
Tokens:
Raw