Build a Custom Integration with the SDK

npm install @lifestreamdynamics/vault-sdk

import { LifestreamVaultClient } from '@lifestreamdynamics/vault-sdk';

// Authenticate — positional args: baseUrl, email, password
const { client, tokens, refreshToken } = await LifestreamVaultClient.login(
  'https://vault.lifestreamdynamics.com',
  'you@example.com',
  'your-password',
);

console.log('Access token expires at:', tokens.expiresAt);
console.log('Refresh token:', refreshToken);

// Use the client for any subsequent call
const vaults = await client.vaults.list();
console.log('Your vaults:', vaults.map((v) => v.name));

import { LifestreamVaultClient } from '@lifestreamdynamics/vault-sdk';

// Construct a client directly from an API key — no login() call needed
const client = new LifestreamVaultClient({
  baseUrl: 'https://vault.lifestreamdynamics.com',
  apiKey: process.env.VAULT_API_KEY, // e.g. lsv_k_abc123...
});

// Verify connectivity (admin endpoint — requires admin role API key)
const health = await client.admin.getHealth();
console.log('API status:', health.status); // 'healthy'

// List documents in a specific vault
const docs = await client.documents.list('vault-uuid-here');
console.log('Document count:', docs.length);

// Create a new document with frontmatter — put() is an upsert
const doc = await client.documents.put(
  'vault-uuid',
  'projects/q1-plan.md',
  `---
title: Q1 Project Plan
tags: [planning, q1-2026]
due: 2026-03-31
---

# Q1 Project Plan

## Goals

- Launch SDK v2
- Migrate to PostgreSQL 17
- Ship booking analytics
`,
);

console.log('Created document ID:', doc.id);
console.log('Document path:', doc.path);

// Full-text search across all vaults the user can access
const results = await client.search.search({
  q: 'quarterly planning objectives',
  vault: 'vault-uuid',     // optional: restrict to one vault
  tags: 'planning',         // optional: comma-separated tag filter
  limit: 20,
  offset: 0,
});

console.log(`Found ${results.total} results`);

for (const hit of results.results) {
  console.log('---');
  console.log('Path:', hit.path);
  console.log('Title:', hit.title);
  console.log('Snippet:', hit.snippet); // highlighted snippet
  console.log('Score:', hit.rank);
}

import { LifestreamVaultClient } from '@lifestreamdynamics/vault-sdk';
import pLimit from 'p-limit';
import fs from 'fs/promises';
import path from 'path';
import { glob } from 'glob';

const { client } = await LifestreamVaultClient.login(
  'https://vault.lifestreamdynamics.com',
  process.env.VAULT_EMAIL!,
  process.env.VAULT_PASSWORD!,
);

const VAULT_ID = 'vault-uuid';
const SOURCE_DIR = './docs';
const CONCURRENCY = 5; // max simultaneous uploads

const limit = pLimit(CONCURRENCY);
const files = await glob('**/*.md', { cwd: SOURCE_DIR });

console.log(`Uploading ${files.length} files...`);

const results = await Promise.allSettled(
  files.map((file) =>
    limit(async () => {
      const content = await fs.readFile(path.join(SOURCE_DIR, file), 'utf8');
      const doc = await client.documents.put(VAULT_ID, file, content);
      return { file, docId: doc.id };
    }),
  ),
);

const succeeded = results.filter((r) => r.status === 'fulfilled').length;
const failed = results.filter((r) => r.status === 'rejected').length;
console.log(`Done: ${succeeded} succeeded, ${failed} failed.`);

import { LifestreamVaultClient } from '@lifestreamdynamics/vault-sdk';

// Enable HMAC signing — the SDK reads the secret from VAULT_SIGNING_SECRET
const { client } = await LifestreamVaultClient.login(
  'https://vault.lifestreamdynamics.com',
  process.env.VAULT_EMAIL!,
  process.env.VAULT_PASSWORD!,
  {
    enableRequestSigning: true, // activates HMAC-SHA256 on mutating requests
  },
);

// All writes are now signed automatically — no further changes needed
const doc = await client.documents.put(
  'vault-uuid',
  'secure/signed-document.md',
  '# Signed Document\n\nThis write was HMAC-signed.',
);

console.log('Signed document created:', doc.id);

import { LifestreamVaultClient } from '@lifestreamdynamics/vault-sdk';

const { client } = await LifestreamVaultClient.login(
  'https://vault.lifestreamdynamics.com',
  process.env.VAULT_EMAIL!,
  process.env.VAULT_PASSWORD!,
);

// You can run long-lived operations without worrying about token expiry.
// The SDK refreshes the token silently in the background as needed.
for (let i = 0; i < 1000; i++) {
  await client.documents.get('vault-uuid', `doc-${i}.md`);
  // If the token expired mid-loop, the SDK refreshed it automatically
}

import {
  LifestreamVaultClient,
  AuthorizationError,
  NotFoundError,
  RateLimitError,
  SDKError,
} from '@lifestreamdynamics/vault-sdk';

const { client } = await LifestreamVaultClient.login(
  'https://vault.lifestreamdynamics.com',
  process.env.VAULT_EMAIL!,
  process.env.VAULT_PASSWORD!,
);

try {
  const { document: doc } = await client.documents.get(
    'vault-uuid',
    'notes/does-not-exist.md',
  );
  console.log('Found:', doc.title);
} catch (err) {
  if (err instanceof NotFoundError) {
    console.warn('Document not found — creating it...');
    await client.documents.put(
      'vault-uuid',
      'notes/does-not-exist.md',
      '# New Document\n',
    );
  } else if (err instanceof AuthorizationError) {
    console.error('Access denied. Check vault permissions.');
  } else if (err instanceof RateLimitError) {
    console.warn('Rate limited:', err.message);
  } else if (err instanceof SDKError) {
    console.error('API error:', err.message, '(status:', err.statusCode, ')');
  } else {
    throw err; // re-throw unknown errors
  }
}