@adearriba/shopify-app-session-storage-cosmosdb NP

Shopify App Session Storage - Azure Cosmos DB

Store Shopify app sessions in Azure Cosmos DB with support for multiple initialization methods, custom partition keys, and robust error handling.

Features

Multiple initialization methods (credentials, connection string, existing client)
Configurable container settings
Custom partition key strategies
Automatic retries with exponential backoff
Bulk operation support

Installation

npm install @shopify/shopify-app-session-storage-cosmosdb

Usage

Basic Usage

import { CosmosDBSessionStorage } from '@shopify/shopify-app-session-storage-cosmosdb';

// Using credentials
const storage = CosmosDBSessionStorage.withCredentials(
    "https://your-account.documents.azure.com",
    "your-key",
    "your-database"
);

// Using connection string
const storage = CosmosDBSessionStorage.withConnectionString(
    "AccountEndpoint=...;AccountKey=...",
    "your-database"
);

// Using existing client
const client = new CosmosClient({...});
const storage = CosmosDBSessionStorage.withClient(client, "your-database");

Advanced Configuration

const storage = CosmosDBSessionStorage.withCredentials(
    "your-endpoint",
    "your-key",
    "your-database",
    {
        containerName: "custom_sessions",
        containerRequest: {
            partitionKey: "/shop",
            uniqueKeyPolicy: {
                uniqueKeys: [
                    { paths: ["/id"] }
                ]
            }
        },
        // Custom partition key resolvers
        getPartitionKeyById: (id) => id.split('_')[0],
        getPartitionKeyByShop: (shop) => shop
    }
);

Configuration Options

Option	Type	Default	Description
`containerName`	`string`	`"shopify_sessions"`	Name of the Cosmos DB container
`containerRequest`	`ContainerRequest`	`{ partitionKey: "/id" }`	Container creation options
`getPartitionKeyById`	`(id: string) => string`	`undefined`	Custom partition key resolver for IDs
`getPartitionKeyByShop`	`(shop: string) => string`	`undefined`	Custom partition key resolver for shops

Performance Tips

Bulk Operations

// Deleting multiple sessions in bulk efficiently
await storage.deleteSessions(['session1', 'session2', 'session3']);

Connection Reuse

// Reuse client 
const client = new CosmosClient({...});
const storage1 = CosmosDBSessionStorage.withClient(client, "db1");
const storage2 = CosmosDBSessionStorage.withClient(client, "db2");