techsmith-ci-integration SKILL.md View full skill →

Configure TechSmith CI/CD integration with GitHub Actions and testing.

ReadWriteEditBash(gh:*)

TechSmith CI Integration

Overview

Set up CI/CD pipelines for TechSmith integrations with automated testing.

Prerequisites

GitHub repository with Actions enabled
TechSmith test API key
npm/pnpm project configured

Instructions

Step 1: Create GitHub Actions Workflow

Create .github/workflows/techsmith-integration.yml:


name: TechSmith Integration Tests

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  TECHSMITH_API_KEY: ${{ secrets.TECHSMITH_API_KEY }}

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      TECHSMITH_API_KEY: ${{ secrets.TECHSMITH_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'
      - run: npm ci
      - run: npm test -- --coverage
      - run: npm run test:integration

Step 2: Configure Secrets


gh secret set TECHSMITH_API_KEY --body "sk_test_***"

Step 3: Add Integration Tests


describe('TechSmith Integration', () => {
  it.skipIf(!process.env.TECHSMITH_API_KEY)('should connect', async () => {
    const client = getTechSmithClient();
    const result = await client.healthCheck();
    expect(result.status).toBe('ok');
  });
});

Output

Automated test pipeline
PR checks configured
Coverage reports uploaded
Release workflow ready

Error Handling

Issue	Cause	Solution
Secret not found	Missing configuration	Add secret via `gh secret set`
Tests timeout	Network issues	Increase timeout or mock
Auth failures	Invalid key	Check secret value

Examples

Release Workflow


on:
  push:
    tags: ['v*']

jobs:
  release:
    runs-on: ubuntu-latest
    env:
      TECHSMITH_API_KEY: ${{ secrets.TECHSMITH_API_KEY_PROD }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - name: Verify TechSmith production readiness
        run: npm run test:integration
      - run: npm run build
      - run: npm publish

Branch Protection


required_status_checks:
  - "test"
  - "techsmith-integration"

Resources

Next Steps

For dep

techsmith-common-errors SKILL.md View full skill →

Diagnose and fix TechSmith common errors and exceptions.

ReadGrepBash(curl:*)

techsmith-core-workflow-a SKILL.md View full skill →

Execute TechSmith primary workflow: Core Workflow A.

ReadWriteEditBash(npm:*)Grep

techsmith-core-workflow-b SKILL.md View full skill →

Execute TechSmith secondary workflow: Core Workflow B.

ReadWriteEditBash(npm:*)Grep

techsmith-cost-tuning SKILL.md View full skill →

Optimize TechSmith costs through tier selection, sampling, and usage monitoring.

ReadGrep

TechSmith Cost Tuning

Overview

Optimize TechSmith costs through smart tier selection, sampling, and usage monitoring.

Prerequisites

Access to TechSmith billing dashboard
Understanding of current usage patterns
Database for usage tracking (optional)
Alerting system configured (optional)

Pricing Tiers

Tier	Monthly Cost	Included	Overage
Free	$0	1,000 requests	N/A
Pro	$99	100,000 requests	$0.001/request
Enterprise	Custom	Unlimited	Volume discounts

Cost Estimation


interface UsageEstimate {
  requestsPerMonth: number;
  tier: string;
  estimatedCost: number;
  recommendation?: string;
}

function estimateTechSmithCost(requestsPerMonth: number): UsageEstimate {
  if (requestsPerMonth <= 1000) {
    return { requestsPerMonth, tier: 'Free', estimatedCost: 0 };
  }

  if (requestsPerMonth <= 100000) {
    return { requestsPerMonth, tier: 'Pro', estimatedCost: 99 };
  }

  const proOverage = (requestsPerMonth - 100000) * 0.001;
  const proCost = 99 + proOverage;

  return {
    requestsPerMonth,
    tier: 'Pro (with overage)',
    estimatedCost: proCost,
    recommendation: proCost > 500
      ? 'Consider Enterprise tier for volume discounts'
      : undefined,
  };
}

Usage Monitoring


class TechSmithUsageMonitor {
  private requestCount = 0;
  private bytesTransferred = 0;
  private alertThreshold: number;

  constructor(monthlyBudget: number) {
    this.alertThreshold = monthlyBudget * 0.8; // 80% warning
  }

  track(request: { bytes: number }) {
    this.requestCount++;
    this.bytesTransferred += request.bytes;

    if (this.estimatedCost() > this.alertThreshold) {
      this.sendAlert('Approaching TechSmith budget limit');
    }
  }

  estimatedCost(): number {
    return estimateTechSmithCost(this.requestCount).estimatedCost;
  }

  private sendAlert(message: string) {
    // Send to Slack, email, PagerDuty, etc.
  }
}

Cost Reduction Strategies

Step 1: Request Sampling


function shouldSample(samplingRate = 0.1): boolean {
  return Math.random() < samplingRate;
}

// Use for non-critical telemetry
if (shouldSample(0.1)) { // 10% sample
  await techsmithClient.trackEvent(event);
}

Step 2: Batching Requests


// Instead of N individual calls
await Promise.all(ids.map(id => techsmithClient.get(id)));

// Use batch endpoint (1 call)
await techsmithClient.batchGet(ids);

Step 3: Caching (from P16)

Cache frequently accessed data

techsmith-debug-bundle SKILL.md View full skill →

Collect TechSmith debug evidence for support tickets and troubleshooting.

ReadBash(grep:*)Bash(curl:*)Bash(tar:*)Grep

TechSmith Debug Bundle

Overview

Collect all necessary diagnostic information for TechSmith support tickets.

Prerequisites

TechSmith SDK installed
Access to application logs
Permission to collect environment info

Instructions

Step 1: Create Debug Bundle Script


#!/bin/bash
# techsmith-debug-bundle.sh

BUNDLE_DIR="techsmith-debug-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$BUNDLE_DIR"

echo "=== TechSmith Debug Bundle ===" > "$BUNDLE_DIR/summary.txt"
echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"

Step 2: Collect Environment Info


# Environment info
echo "--- Environment ---" >> "$BUNDLE_DIR/summary.txt"
node --version >> "$BUNDLE_DIR/summary.txt" 2>&1
npm --version >> "$BUNDLE_DIR/summary.txt" 2>&1
echo "TECHSMITH_API_KEY: ${TECHSMITH_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt"

Step 3: Gather SDK and Logs


# SDK version
npm list @techsmith/sdk 2>/dev/null >> "$BUNDLE_DIR/summary.txt"

# Recent logs (redacted)
grep -i "techsmith" ~/.npm/_logs/*.log 2>/dev/null | tail -50 >> "$BUNDLE_DIR/logs.txt"

# Configuration (redacted - secrets masked)
echo "--- Config (redacted) ---" >> "$BUNDLE_DIR/summary.txt"
cat .env 2>/dev/null | sed 's/=.*/=***REDACTED***/' >> "$BUNDLE_DIR/config-redacted.txt"

# Network connectivity test
echo "--- Network Test ---" >> "$BUNDLE_DIR/summary.txt"
echo -n "API Health: " >> "$BUNDLE_DIR/summary.txt"
curl -s -o /dev/null -w "%{http_code}" https://api.techsmith.com/health >> "$BUNDLE_DIR/summary.txt"
echo "" >> "$BUNDLE_DIR/summary.txt"

Step 4: Package Bundle


tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR"
echo "Bundle created: $BUNDLE_DIR.tar.gz"

Output

techsmith-debug-YYYYMMDD-HHMMSS.tar.gz archive containing:
summary.txt - Environment and SDK info
logs.txt - Recent redacted logs
config-redacted.txt - Configuration (secrets removed)

Error Handling

techsmith-deploy-integration SKILL.md View full skill →

Deploy TechSmith integrations to Vercel, Fly.

ReadWriteEditBash(vercel:*)Bash(fly:*)Bash(gcloud:*)

TechSmith Deploy Integration

Overview

Deploy TechSmith-powered applications to popular platforms with proper secrets management.

Prerequisites

TechSmith API keys for production environment
Platform CLI installed (vercel, fly, or gcloud)
Application code ready for deployment
Environment variables documented

Vercel Deployment

Environment Setup


# Add TechSmith secrets to Vercel
vercel secrets add techsmith_api_key sk_live_***
vercel secrets add techsmith_webhook_secret whsec_***

# Link to project
vercel link

# Deploy preview
vercel

# Deploy production
vercel --prod

vercel.json Configuration


{
  "env": {
    "TECHSMITH_API_KEY": "@techsmith_api_key"
  },
  "functions": {
    "api/**/*.ts": {
      "maxDuration": 30
    }
  }
}

Fly.io Deployment

fly.toml


app = "my-techsmith-app"
primary_region = "iad"

[env]
  NODE_ENV = "production"

[http_service]
  internal_port = 3000
  force_https = true
  auto_stop_machines = true
  auto_start_machines = true

Secrets


# Set TechSmith secrets
fly secrets set TECHSMITH_API_KEY=sk_live_***
fly secrets set TECHSMITH_WEBHOOK_SECRET=whsec_***

# Deploy
fly deploy

Google Cloud Run

Dockerfile


FROM node:20-slim
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
CMD ["npm", "start"]

Deploy Script


#!/bin/bash
# deploy-cloud-run.sh

PROJECT_ID="${GOOGLE_CLOUD_PROJECT}"
SERVICE_NAME="techsmith-service"
REGION="us-central1"

# Build and push image
gcloud builds submit --tag gcr.io/$PROJECT_ID/$SERVICE_NAME

# Deploy to Cloud Run
gcloud run deploy $SERVICE_NAME \
  --image gcr.io/$PROJECT_ID/$SERVICE_NAME \
  --region $REGION \
  --platform managed \
  --allow-unauthenticated \
  --set-secrets=TECHSMITH_API_KEY=techsmith-api-key:latest

Environment Configuration Pattern


// config/techsmith.ts
interface TechSmithConfig {
  apiKey: string;
  environment: 'development' | 'staging' | 'production';
  webhookSecret?: string;
}

export function getTechSmithConfig(): TechSmithConfig {
  const env = process.env.NODE_ENV || 'development';

  return {
    apiKey: process.env.TECHSMITH_API_KEY!,
    environment: env as TechSmithConfig['environment'],
    webhookSecret: process.env.TECHSMITH_WEBHOOK_SECRET,
  };
}

Health Check Endpoint


// api/health.ts
export async function GET() {
  const techsmithStatus = await checkTech


                
                  
                  
                  techsmith-hello-world
                  SKILL.md
                  View full skill →
                
                
                  Create a minimal working TechSmith example.
                  
                      ReadWriteEdit
                    
                
                
                  TechSmith Hello World
Overview
Minimal working example demonstrating core TechSmith functionality.
Prerequisites

Completed techsmith-install-auth setup
Valid API credentials configured
Development environment ready

Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client

import { TechSmithClient } from '@techsmith/sdk';

const client = new TechSmithClient({
  apiKey: process.env.TECHSMITH_API_KEY,
});

Step 3: Make Your First API Call

async function main() {
  // Your first API call here
}

main().catch(console.error);

Output

Working code file with TechSmith client initialization
Successful API response confirming connection
Console output showing:


Success! Your TechSmith connection is working.

Error Handling

Item	Purpose	Included
Environment versions	Compatibility check	✓
SDK version	Version-specific bugs	✓
Error logs (redacted)	Root cause analysis	✓
Config (redacted)	Configuration issues	✓

Error	Cause	Solution
Import Error	SDK not installed	Verify with `npm list` or `pip show`
Auth Error	Invalid credentials	Check environment variable is set
Timeout	Network issues	Increase timeout or check connectivity
Rate Limit	Too many requests	Wait and retry with exponential backoff


Examples
TypeScript Example

import { TechSmithClient } from '@techsmith/sdk';

const client = new TechSmithClient({
  apiKey: process.env.TECHSMITH_API_KEY,
});

async function main() {
  // Your first API call here
}

main().catch(console.error);

Python Example

from techsmith import TechSmithClient

client = TechSmithClient()

# Your first API call here

Resources

TechSmith Getting Started
TechSmith API Reference
TechSmith Examples

Next Steps
Proceed to techsmith-local-dev-loop for development workflow setup.


                
                  
                  
                  techsmith-install-auth
                  SKILL.md
                  View full skill →
                
                
                  Install and configure TechSmith SDK/CLI authentication.
                  
                      ReadWriteEditBash(npm:*)Bash(pip:*)Grep
                    
                
                
                  TechSmith Install & Auth
Overview
Set up TechSmith SDK/CLI and configure authentication credentials.
Prerequisites

Node.js 18+ or Python 3.10+
Package manager (npm, pnpm, or pip)
TechSmith account with API access
API key from TechSmith dashboard

Instructions
Step 1: Install SDK

# Node.js
npm install @techsmith/sdk

# Python
pip install techsmith

Step 2: Configure Authentication

# Set environment variable
export TECHSMITH_API_KEY="your-api-key"

# Or create .env file
echo 'TECHSMITH_API_KEY=your-api-key' >> .env

Step 3: Verify Connection

// Test connection code here

Output

Installed SDK package in node_modules or site-packages
Environment variable or .env file with API key
Successful connection verification output

Error Handling

Error
Cause
Solution


Invalid API Key
Incorrect or expired key
Verify key in TechSmith dashboard


Rate Limited
Exceeded quota
Check quota at https://docs.techsmith.com


Network Error
Firewall blocking
Ensure outbound HTTPS allowed


Module Not Found
Installation failed
Run npm install or pip install again


Examples
TypeScript Setup

import { TechSmithClient } from '@techsmith/sdk';

const client = new TechSmithClient({
  apiKey: process.env.TECHSMITH_API_KEY,
});

Python Setup

from techsmith import TechSmithClient

client = TechSmithClient(
    api_key=os.environ.get('TECHSMITH_API_KEY')
)

Resources

TechSmith Documentation
TechSmith Dashboard
TechSmith Status

Next Steps
After successful auth, proceed to techsmith-hello-world for your first API call.


                
                  
                  
                  techsmith-local-dev-loop
                  SKILL.md
                  View full skill →
                
                
                  Configure TechSmith local development with hot reload and testing.
                  
                      ReadWriteEditBash(npm:*)Bash(pnpm:*)Grep
                    
                
                
                  TechSmith Local Dev Loop
Overview
Set up a fast, reproducible local development workflow for TechSmith.
Prerequisites

Completed techsmith-install-auth setup
Node.js 18+ with npm/pnpm
Code editor with TypeScript support
Git for version control

Instructions
Step 1: Create Project Structure

my-techsmith-project/
├── src/
│   ├── techsmith/
│   │   ├── client.ts       # TechSmith client wrapper
│   │   ├── config.ts       # Configuration management
│   │   └── utils.ts        # Helper functions
│   └── index.ts
├── tests/
│   └── techsmith.test.ts
├── .env.local              # Local secrets (git-ignored)
├── .env.example            # Template for team
└── package.json

Step 2: Configure Environment

# Copy environment template
cp .env.example .env.local

# Install dependencies
npm install

# Start development server
npm run dev

Step 3: Setup Hot Reload

{
  "scripts": {
    "dev": "tsx watch src/index.ts",
    "test": "vitest",
    "test:watch": "vitest --watch"
  }
}

Step 4: Configure Testing

import { describe, it, expect, vi } from 'vitest';
import { TechSmithClient } from '../src/techsmith/client';

describe('TechSmith Client', () => {
  it('should initialize with API key', () => {
    const client = new TechSmithClient({ apiKey: 'test-key' });
    expect(client).toBeDefined();
  });
});

Output

Working development environment with hot reload
Configured test suite with mocking
Environment variable management
Fast iteration cycle for TechSmith development

Error Handling

Error
Cause
Solution


Module not found
Missing dependency
Run npm install


Port in use
Another process
Kill process or change port


Env not loaded
Missing .env.local
Copy from .env.example


Test timeout
Slow network
Increase test timeout


Examples
Mock TechSmith Responses

vi.mock('@techsmith/sdk', () => ({
  TechSmithClient: vi.fn().mockImplementation(() => ({
    // Mock methods here
  })),
}));

Debug Mode

# Enable verbose logging
DEBUG=TECHSMITH=* npm run dev

Resources

TechSmith SDK Reference
Vitest Documentation

                
                  
                  
                  techsmith-performance-tuning
                  SKILL.md
                  View full skill →
                
                
                  Optimize TechSmith API performance with caching, batching, and connection pooling.
                  
                      ReadWriteEdit
                    
                
                
                  TechSmith Performance Tuning
Overview
Optimize TechSmith API performance with caching, batching, and connection pooling.
Prerequisites

TechSmith SDK installed
Understanding of async patterns
Redis or in-memory cache available (optional)
Performance monitoring in place

Latency Benchmarks

Operation
P50
P95
P99


Read
50ms
150ms
300ms


Write
100ms
250ms
500ms


List
75ms
200ms
400ms


Caching Strategy
Response Caching

import { LRUCache } from 'lru-cache';

const cache = new LRUCache<string, any>({
  max: 1000,
  ttl: 60000, // 1 minute
  updateAgeOnGet: true,
});

async function cachedTechSmithRequest<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttl?: number
): Promise<T> {
  const cached = cache.get(key);
  if (cached) return cached as T;

  const result = await fetcher();
  cache.set(key, result, { ttl });
  return result;
}

Redis Caching (Distributed)

import Redis from 'ioredis';

const redis = new Redis(process.env.REDIS_URL);

async function cachedWithRedis<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttlSeconds = 60
): Promise<T> {
  const cached = await redis.get(key);
  if (cached) return JSON.parse(cached);

  const result = await fetcher();
  await redis.setex(key, ttlSeconds, JSON.stringify(result));
  return result;
}

Request Batching

import DataLoader from 'dataloader';

const techsmithLoader = new DataLoader<string, any>(
  async (ids) => {
    // Batch fetch from TechSmith
    const results = await techsmithClient.batchGet(ids);
    return ids.map(id => results.find(r => r.id === id) || null);
  },
  {
    maxBatchSize: 100,
    batchScheduleFn: callback => setTimeout(callback, 10),
  }
);

// Usage - automatically batched
const [item1, item2, item3] = await Promise.all([
  techsmithLoader.load('id-1'),
  techsmithLoader.load('id-2'),
  techsmithLoader.load('id-3'),
]);

Connection Optimization

import { Agent } from 'https';

// Keep-alive connection pooling
const agent = new Agent({
  keepAlive: true,
  maxSockets: 10,
  maxFreeSockets: 5,
  timeout: 30000,
});

const client = new TechSmithClient({
  apiKey: process.env.TECHSMITH_API_KEY!,
  httpAgent: agent,
});

Pagination Optimization

async function* paginatedTechSmithList<T>(
  fetcher: (cursor?: string) => Promise<{ data: T[]; nextCursor?: string }&

                

              

                
                  
                  
                  techsmith-prod-checklist
                  SKILL.md
                  View full skill →
                
                
                  Execute TechSmith production deployment checklist and rollback procedures.
                  
                      ReadBash(kubectl:*)Bash(curl:*)Grep
                    
                
                
                  TechSmith Production Checklist
Overview
Complete checklist for deploying TechSmith integrations to production.
Prerequisites

Staging environment tested and verified
Production API keys available
Deployment pipeline configured
Monitoring and alerting ready

Instructions
Step 1: Pre-Deployment Configuration

[ ] Production API keys in secure vault
[ ] Environment variables set in deployment platform
[ ] API key scopes are minimal (least privilege)
[ ] Webhook endpoints configured with HTTPS
[ ] Webhook secrets stored securely

Step 2: Code Quality Verification

[ ] All tests passing (npm test)
[ ] No hardcoded credentials
[ ] Error handling covers all TechSmith error types
[ ] Rate limiting/backoff implemented
[ ] Logging is production-appropriate

Step 3: Infrastructure Setup

[ ] Health check endpoint includes TechSmith connectivity
[ ] Monitoring/alerting configured
[ ] Circuit breaker pattern implemented
[ ] Graceful degradation configured

Step 4: Documentation Requirements

[ ] Incident runbook created
[ ] Key rotation procedure documented
[ ] Rollback procedure documented
[ ] On-call escalation path defined

Step 5: Deploy with Gradual Rollout

# Pre-flight checks
curl -f https://staging.example.com/health
curl -s https://status.techsmith.com

# Gradual rollout - start with canary (10%)
kubectl apply -f k8s/production.yaml
kubectl set image deployment/techsmith-integration app=image:new --record
kubectl rollout pause deployment/techsmith-integration

# Monitor canary traffic for 10 minutes
sleep 600
# Check error rates and latency before continuing

# If healthy, continue rollout to 50%
kubectl rollout resume deployment/techsmith-integration
kubectl rollout pause deployment/techsmith-integration
sleep 300

# Complete rollout to 100%
kubectl rollout resume deployment/techsmith-integration
kubectl rollout status deployment/techsmith-integration

Output

Deployed TechSmith integration
Health checks passing
Monitoring active
Rollback procedure documented

Error Handling

Alert
Condition
Severity


API Down
5xx errors > 10/min
P1


High Latency
p99 > 5000ms
P2


Rate Limited
429 errors > 5/min
P2


Auth Failures
401/403 errors > 0
P1


Examples
Health Check Implementation

async function healthCheck(): Promise<{ status: string; tec

                

              

                
                  
                  
                  techsmith-rate-limits
                  SKILL.md
                  View full skill →
                
                
                  Implement TechSmith rate limiting, backoff, and idempotency patterns.
                  
                      ReadWriteEdit
                    
                
                
                  TechSmith Rate Limits
Overview
Handle TechSmith rate limits gracefully with exponential backoff and idempotency.
Prerequisites

TechSmith SDK installed
Understanding of async/await patterns
Access to rate limit headers

Instructions
Step 1: Understand Rate Limit Tiers

Tier
Requests/min
Requests/day
Burst


Free
60
1,000
10


Pro
300
10,000
50


Enterprise
1,000
100,000
200


Step 2: Implement Exponential Backoff with Jitter

async function withExponentialBackoff<T>(
  operation: () => Promise<T>,
  config = { maxRetries: 5, baseDelayMs: 1000, maxDelayMs: 32000, jitterMs: 500 }
): Promise<T> {
  for (let attempt = 0; attempt <= config.maxRetries; attempt++) {
    try {
      return await operation();
    } catch (error: any) {
      if (attempt === config.maxRetries) throw error;
      const status = error.status || error.response?.status;
      if (status !== 429 && (status < 500 || status >= 600)) throw error;

      // Exponential delay with jitter to prevent thundering herd
      const exponentialDelay = config.baseDelayMs * Math.pow(2, attempt);
      const jitter = Math.random() * config.jitterMs;
      const delay = Math.min(exponentialDelay + jitter, config.maxDelayMs);

      console.log(`Rate limited. Retrying in ${delay.toFixed(0)}ms...`);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

Step 3: Add Idempotency Keys

import { v4 as uuidv4 } from 'uuid';
import crypto from 'crypto';

// Generate deterministic key from operation params (for safe retries)
function generateIdempotencyKey(operation: string, params: Record<string, any>): string {
  const data = JSON.stringify({ operation, params });
  return crypto.createHash('sha256').update(data).digest('hex');
}

async function idempotentRequest<T>(
  client: TechSmithClient,
  params: Record<string, any>,
  idempotencyKey?: string  // Pass existing key for retries
): Promise<T> {
  // Use provided key (for retries) or generate deterministic key from params
  const key = idempotencyKey || generateIdempotencyKey(params.method || 'POST', params);
  return client.request({
    ...params,
    headers: { 'Idempotency-Key': key, ...params.headers },
  });
}

Output

Reliable API calls with automatic retry
Idempotent requests preventing duplicates
Rate limit headers properly handled

Error Handling

Header
Description

                
              
                
                  
                  
                  techsmith-reference-architecture
                  SKILL.md
                  View full skill →
                
                
                  Implement TechSmith reference architecture with best-practice project layout.
                  
                      ReadGrep
                    
                
                
                  TechSmith Reference Architecture
Overview
Production-ready architecture patterns for TechSmith integrations.
Prerequisites

Understanding of layered architecture
TechSmith SDK knowledge
TypeScript project setup
Testing framework configured

Project Structure

my-techsmith-project/
├── src/
│   ├── techsmith/
│   │   ├── client.ts           # Singleton client wrapper
│   │   ├── config.ts           # Environment configuration
│   │   ├── types.ts            # TypeScript types
│   │   ├── errors.ts           # Custom error classes
│   │   └── handlers/
│   │       ├── webhooks.ts     # Webhook handlers
│   │       └── events.ts       # Event processing
│   ├── services/
│   │   └── techsmith/
│   │       ├── index.ts        # Service facade
│   │       ├── sync.ts         # Data synchronization
│   │       └── cache.ts        # Caching layer
│   ├── api/
│   │   └── techsmith/
│   │       └── webhook.ts      # Webhook endpoint
│   └── jobs/
│       └── techsmith/
│           └── sync.ts         # Background sync job
├── tests/
│   ├── unit/
│   │   └── techsmith/
│   └── integration/
│       └── techsmith/
├── config/
│   ├── techsmith.development.json
│   ├── techsmith.staging.json
│   └── techsmith.production.json
└── docs/
    └── techsmith/
        ├── SETUP.md
        └── RUNBOOK.md

Layer Architecture

┌─────────────────────────────────────────┐
│             API Layer                    │
│   (Controllers, Routes, Webhooks)        │
├─────────────────────────────────────────┤
│           Service Layer                  │
│  (Business Logic, Orchestration)         │
├─────────────────────────────────────────┤
│          TechSmith Layer        │
│   (Client, Types, Error Handling)        │
├─────────────────────────────────────────┤
│         Infrastructure Layer             │
│    (Cache, Queue, Monitoring)            │
└─────────────────────────────────────────┘

Key Components
Step 1: Client Wrapper

// src/techsmith/client.ts
export class TechSmithService {
  private client: TechSmithClient;
  private cache: Cache;
  private monitor: Monitor;

  constructor(config: TechSmithConfig) {
    this.client = new TechSmithClient(config);
    this.cache = new Cache(config.cacheOptions);
    this.monitor = new Monitor('techsmith');
  }

  async get(id: string): Promise<Resource> {
    return this.cache.getOrFetch(id, () =>
      this.monitor.track('get', () => this.client.get(id))
    );
  }
}

Step 2: Error Boundary

// src/techsmith/errors.ts
export class TechSmithServiceError extends Error {
  constructor(
    message: string,
    public readonly code: string,
    public readonly retryable: boolean,
    public readonly originalError?: Error
  ) {
    super(message);
    t

                

              

                
                  
                  
                  techsmith-sdk-patterns
                  SKILL.md
                  View full skill →
                
                
                  Apply production-ready TechSmith SDK patterns for TypeScript and Python.
                  
                      ReadWriteEdit
                    
                
                
                  TechSmith SDK Patterns
Overview
Production-ready patterns for TechSmith SDK usage in TypeScript and Python.
Prerequisites

Completed techsmith-install-auth setup
Familiarity with async/await patterns
Understanding of error handling best practices

Instructions
Step 1: Implement Singleton Pattern (Recommended)

// src/techsmith/client.ts
import { TechSmithClient } from '@techsmith/sdk';

let instance: TechSmithClient | null = null;

export function getTechSmithClient(): TechSmithClient {
  if (!instance) {
    instance = new TechSmithClient({
      apiKey: process.env.TECHSMITH_API_KEY!,
      // Additional options
    });
  }
  return instance;
}

Step 2: Add Error Handling Wrapper

import { TechSmithError } from '@techsmith/sdk';

async function safeTechSmithCall<T>(
  operation: () => Promise<T>
): Promise<{ data: T | null; error: Error | null }> {
  try {
    const data = await operation();
    return { data, error: null };
  } catch (err) {
    if (err instanceof TechSmithError) {
      console.error({
        code: err.code,
        message: err.message,
      });
    }
    return { data: null, error: err as Error };
  }
}

Step 3: Implement Retry Logic

async function withRetry<T>(
  operation: () => Promise<T>,
  maxRetries = 3,
  backoffMs = 1000
): Promise<T> {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      return await operation();
    } catch (err) {
      if (attempt === maxRetries) throw err;
      const delay = backoffMs * Math.pow(2, attempt - 1);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

Output

Type-safe client singleton
Robust error handling with structured logging
Automatic retry with exponential backoff
Runtime validation for API responses

Error Handling

Pattern
Use Case
Benefit


Safe wrapper
All API calls
Prevents uncaught exceptions


Retry logic
Transient failures
Improves reliability


Type guards
Response validation
Catches API changes


Logging
All operations
Debugging and monitoring


Examples
Factory Pattern (Multi-tenant)

const clients = new Map<string, TechSmithClient>();

export function getClientForTenant(tenantId: string): TechSmithClient {
  if (!clients.has(tenantId)) {
    const apiKey = getTenantApiKey(tenantId);
    clients.set(tenantId, new TechSmithClien

                

              

                
                  
                  
                  techsmith-security-basics
                  SKILL.md
                  View full skill →
                
                
                  Apply TechSmith security best practices for secrets and access control.
                  
                      ReadWriteGrep
                    
                
                
                  TechSmith Security Basics
Overview
Security best practices for TechSmith API keys, tokens, and access control.
Prerequisites

TechSmith SDK installed
Understanding of environment variables
Access to TechSmith dashboard

Instructions
Step 1: Configure Environment Variables

# .env (NEVER commit to git)
TECHSMITH_API_KEY=sk_live_***
TECHSMITH_SECRET=***

# .gitignore
.env
.env.local
.env.*.local

Step 2: Implement Secret Rotation

# 1. Generate new key in TechSmith dashboard
# 2. Update environment variable
export TECHSMITH_API_KEY="new_key_here"

# 3. Verify new key works
curl -H "Authorization: Bearer ${TECHSMITH_API_KEY}" \
  https://api.techsmith.com/health

# 4. Revoke old key in dashboard

Step 3: Apply Least Privilege

Environment
Recommended Scopes


Development
read:*


Staging
read:*, write:limited


Production
Only required scopes


Output

Secure API key storage
Environment-specific access controls
Audit logging enabled

Error Handling

Security Issue
Detection
Mitigation


Exposed API key
Git scanning
Rotate immediately


Excessive scopes
Audit logs
Reduce permissions


Missing rotation
Key age check
Schedule rotation


Examples
Service Account Pattern

const clients = {
  reader: new TechSmithClient({
    apiKey: process.env.TECHSMITH_READ_KEY,
  }),
  writer: new TechSmithClient({
    apiKey: process.env.TECHSMITH_WRITE_KEY,
  }),
};

Webhook Signature Verification

import crypto from 'crypto';

function verifyWebhookSignature(
  payload: string, signature: string, secret: string
): boolean {
  const expected = crypto.createHmac('sha256', secret).update(payload).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}

Security Checklist

[ ] API keys in environment variables
[ ] .env files in .gitignore
[ ] Different keys for dev/staging/prod
[ ] Minimal scopes per environment
[ ] Webhook signatures validated
[ ] Audit logging enabled

Audit Logging

interface AuditEntry {
  timestamp: Date;
  action: string;
  userId: string;
  resource: string;
  result: 'success' | 'f

                

              

                
                  
                  
                  techsmith-upgrade-migration
                  SKILL.md
                  View full skill →
                
                
                  Analyze, plan, and execute TechSmith SDK upgrades with breaking change detection.
                  
                      ReadWriteEditBash(npm:*)Bash(git:*)
                    
                
                
                  TechSmith Upgrade & Migration
Overview
Guide for upgrading TechSmith SDK versions and handling breaking changes.
Prerequisites

Current TechSmith SDK installed
Git for version control
Test suite available
Staging environment

Instructions
Step 1: Check Current Version

npm list @techsmith/sdk
npm view @techsmith/sdk version

Step 2: Review Changelog

open https://github.com/techsmith/sdk/releases

Step 3: Create Upgrade Branch

git checkout -b upgrade/techsmith-sdk-vX.Y.Z
npm install @techsmith/sdk@latest
npm test

Step 4: Handle Breaking Changes
Update import statements, configuration, and method signatures as needed.
Output

Updated SDK version
Fixed breaking changes
Passing test suite
Documented rollback procedure

Error Handling

SDK Version
API Version
Node.js
Breaking Changes


3.x
2024-01
18+
Major refactor


2.x
2023-06
16+
Auth changes


1.x
2022-01
14+
Initial release


Examples
Import Changes

// Before (v1.x)
import { Client } from '@techsmith/sdk';

// After (v2.x)
import { TechSmithClient } from '@techsmith/sdk';

Configuration Changes

// Before (v1.x)
const client = new Client({ key: 'xxx' });

// After (v2.x)
const client = new TechSmithClient({
  apiKey: 'xxx',
});

Rollback Procedure

npm install @techsmith/sdk@1.x.x --save-exact

Deprecation Handling

// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
  process.on('warning', (warning) => {
    if (warning.name === 'DeprecationWarning') {
      console.warn('[TechSmith]', warning.message);
      // Log to tracking system for proactive updates
    }
  });
}

// Common deprecation patterns to watch for:
// - Renamed methods: client.oldMethod() -> client.newMethod()
// - Changed parameters: { key: 'x' } -> { apiKey: 'x' }
// - Removed features: Check release notes before upgrading

Resources

TechSmith Changelog
TechSmith Migration Guide

Next Steps
For CI integration during upgrades, see techsmith-ci-integration.
                
              

                
                  
                  
                  techsmith-webhooks-events
                  SKILL.md
                  View full skill →
                
                
                  Implement TechSmith webhook signature validation and event handling.
                  
                      ReadWriteEditBash(curl:*)
                    
                
                
                  TechSmith Webhooks & Events
Overview
Securely handle TechSmith webhooks with signature validation and replay protection.
Prerequisites

TechSmith webhook secret configured
HTTPS endpoint accessible from internet
Understanding of cryptographic signatures
Redis or database for idempotency (optional)

Webhook Endpoint Setup
Express.js

import express from 'express';
import crypto from 'crypto';

const app = express();

// IMPORTANT: Raw body needed for signature verification
app.post('/webhooks/techsmith',
  express.raw({ type: 'application/json' }),
  async (req, res) => {
    const signature = req.headers['x-techsmith-signature'] as string;
    const timestamp = req.headers['x-techsmith-timestamp'] as string;

    if (!verifyTechSmithSignature(req.body, signature, timestamp)) {
      return res.status(401).json({ error: 'Invalid signature' });
    }

    const event = JSON.parse(req.body.toString());
    await handleTechSmithEvent(event);

    res.status(200).json({ received: true });
  }
);

Signature Verification

function verifyTechSmithSignature(
  payload: Buffer,
  signature: string,
  timestamp: string
): boolean {
  const secret = process.env.TECHSMITH_WEBHOOK_SECRET!;

  // Reject old timestamps (replay attack protection)
  const timestampAge = Date.now() - parseInt(timestamp) * 1000;
  if (timestampAge > 300000) { // 5 minutes
    console.error('Webhook timestamp too old');
    return false;
  }

  // Compute expected signature
  const signedPayload = `${timestamp}.${payload.toString()}`;
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(signedPayload)
    .digest('hex');

  // Timing-safe comparison
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

Event Handler Pattern

type TechSmithEventType = 'resource.created' | 'resource.updated' | 'resource.deleted';

interface TechSmithEvent {
  id: string;
  type: TechSmithEventType;
  data: Record<string, any>;
  created: string;
}

const eventHandlers: Record<TechSmithEventType, (data: any) => Promise<void>> = {
  'resource.created': async (data) => { /* handle */ },
  'resource.updated': async (data) => { /* handle */ },
  'resource.deleted': async (data) => { /* handle */ }
};

async function handleTechSmithEvent(event: TechSmithEvent): Promise<void> {
  const handler = eventHandlers[event.type];

  if (!handler) {
    console.log(`Unhandled event type: ${event.type}`);
    return;
  }

  try {
    await handler(event.data);
    console.log(`Processed ${event.type}: ${event.id}`);
  } catch (error) {
 

                

              

          
        

      
      

      
      

      
      

      
      
  Ready to use techsmith-pack?
  
    
    
  




      
      
          Related Plugins
          
            
                ai-ethics-validator
                AI ethics and fairness validation
              
                ai-experiment-logger
                Track and analyze AI experiments with a web dashboard and MCP tools
              
                ai-ml-engineering-pack
                Professional AI/ML Engineering toolkit: Prompt engineering, LLM integration, RAG systems, AI safety with 12 expert plugins
              
                ai-sdk-agents
                Multi-agent orchestration with AI SDK v5 - handoffs, routing, and coordination for any AI provider (OpenAI, Anthropic, Google)
              
                anomaly-detection-system
                Detect anomalies and outliers in data
              
                automl-pipeline-builder
                Build AutoML pipelines
              
          
        

      
      
          Tags
          
            techsmithsaassdkintegration
          
        
    
  

  

    

    
    
        
            
                Stay in the Loop
                
                    
                    
                    
                
                No spam. Unsubscribe anytime.
            

            
                
                    Product
                    
                        Explore
                        Skills
                        Cowork
                        Compare
                        Tools
                    
                
                
                    Resources
                    
                        Changelog
                        Collections
                        Playbooks
                        Research
                        Learning
                    
                
                
                    Company
                    
                        Community
                        Spotlight
                        GitHub
                    
                
                
                    Legal
                    
                        Privacy
                        Terms
                        Acceptable Use
                    
                
            

            
                Tons of Skills by Intent Solutions. Marine. Citadel Grad. 20 years ops → self-taught dev → AI architect.
                © 2026 Tons of Skills | Intent Solutions

Aspect	Workflow A	Workflow B
Use Case	Primary	Secondary
Complexity	Medium	Lower
Performance	Standard	Optimized

Error	Cause	Solution
Invalid API Key	Incorrect or expired key	Verify key in TechSmith dashboard
Rate Limited	Exceeded quota	Check quota at https://docs.techsmith.com
Network Error	Firewall blocking	Ensure outbound HTTPS allowed
Module Not Found	Installation failed	Run `npm install` or `pip install` again

Error	Cause	Solution
Module not found	Missing dependency	Run `npm install`
Port in use	Another process	Kill process or change port
Env not loaded	Missing .env.local	Copy from .env.example
Test timeout	Slow network	Increase test timeout

Alert	Condition	Severity
API Down	5xx errors > 10/min	P1
High Latency	p99 > 5000ms	P2
Rate Limited	429 errors > 5/min	P2
Auth Failures	401/403 errors > 0	P1

techsmith-pack

Installation

Skills (18)

TechSmith CI Integration

Overview

Prerequisites

Instructions

Step 1: Create GitHub Actions Workflow

Step 2: Configure Secrets

Step 3: Add Integration Tests

Output

Error Handling

Examples

Release Workflow

Branch Protection

Resources

Next Steps

TechSmith Common Errors

Overview

Prerequisites

Instructions

Step 1: Identify the Error

Step 2: Find Matching Error Below

Step 3: Apply Solution

Output

Error Handling

Authentication Failed

Rate Limit Exceeded

Network Timeout

Examples

Quick Diagnostic Commands

Escalation Path

Resources

Next Steps

TechSmith Core Workflow A

Overview

Prerequisites

Instructions

Step 1: Initialize

Step 2: Execute

Step 3: Finalize

Output

Error Handling

Examples

Complete Workflow

Common Variations

Resources

Next Steps

TechSmith Core Workflow B

Overview

Prerequisites

Instructions

Step 1: Setup

Step 2: Process

Step 3: Complete

Output

Error Handling

Examples

Complete Workflow

Error Recovery

Resources

Next Steps

TechSmith Cost Tuning

Overview

Prerequisites

Pricing Tiers

Cost Estimation

Usage Monitoring

Cost Reduction Strategies

Step 1: Request Sampling

Step 2: Batching Requests

Step 3: Caching (from P16)

TechSmith Debug Bundle

Overview

Prerequisites

Instructions

Step 1: Create Debug Bundle Script

Step 2: Collect Environment Info

Step 3: Gather SDK and Logs

Step 4: Package Bundle