@lifestreamdynamics/vault-sdk 1.0.0

package/dist/resources/vaults.d.ts

@@ -0,0 +1,144 @@
+import type { KyInstance } from 'ky';
+/** A vault object returned by the API. */
+export interface Vault {
+    /** Unique vault identifier. */
+    id: string;
+    /** Display name of the vault. */
+    name: string;
+    /** URL-friendly slug, unique per user. */
+    slug: string;
+    /** Optional vault description. */
+    description: string | null;
+    /** Whether client-side encryption is enabled for this vault. */
+    encryptionEnabled: boolean;
+    /** ISO 8601 creation timestamp. */
+    createdAt: string;
+    /** ISO 8601 last-updated timestamp. */
+    updatedAt: string;
+}
+/**
+ * Resource for managing vaults.
+ *
+ * Vaults are isolated document storage containers. Each vault has a unique
+ * slug and can hold an arbitrary number of Markdown documents organized
+ * in a directory structure.
+ *
+ * @example
+ * ```typescript
+ * const vaults = await client.vaults.list();
+ * const vault = await client.vaults.create({ name: 'My Notes' });
+ * ```
+ */
+export declare class VaultsResource {
+    private http;
+    constructor(http: KyInstance);
+    /**
+     * Lists all vaults accessible to the authenticated user.
+     *
+     * @returns Array of vault objects
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vaults = await client.vaults.list();
+     * for (const vault of vaults) {
+     *   console.log(vault.name, vault.slug);
+     * }
+     * ```
+     */
+    list(): Promise<Vault[]>;
+    /**
+     * Retrieves a single vault by ID.
+     *
+     * @param vaultId - The unique identifier of the vault
+     * @returns The vault object
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vault = await client.vaults.get('vault-uuid');
+     * console.log(vault.name);
+     * ```
+     */
+    get(vaultId: string): Promise<Vault>;
+    /**
+     * Creates a new vault.
+     *
+     * A URL-friendly slug is automatically generated from the vault name.
+     *
+     * @param params - Vault creation parameters
+     * @param params.name - Display name for the vault (required)
+     * @param params.description - Optional description of the vault's purpose
+     * @returns The newly created vault object
+     * @throws {ValidationError} If the name is empty or the generated slug conflicts with an existing vault
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vault = await client.vaults.create({
+     *   name: 'Work Documents',
+     *   description: 'Team documentation and notes',
+     * });
+     * console.log(vault.id, vault.slug);
+     * ```
+     *
+     * @see {@link VaultsResource.update} to modify an existing vault
+     */
+    create(params: {
+        name: string;
+        description?: string;
+        encryptionEnabled?: boolean;
+    }): Promise<Vault>;
+    /**
+     * Updates an existing vault's metadata.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     * Set `description` to `null` to clear it.
+     *
+     * @param vaultId - The unique identifier of the vault to update
+     * @param params - Fields to update
+     * @param params.name - New display name for the vault
+     * @param params.description - New description, or `null` to clear
+     * @returns The updated vault object
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {ValidationError} If the new name produces a conflicting slug
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.vaults.update('vault-uuid', {
+     *   name: 'Renamed Vault',
+     *   description: null,
+     * });
+     * ```
+     *
+     * @see {@link VaultsResource.create} to create a new vault
+     */
+    update(vaultId: string, params: {
+        name?: string;
+        description?: string | null;
+    }): Promise<Vault>;
+    /**
+     * Permanently deletes a vault and all its documents.
+     *
+     * This action is irreversible. All documents within the vault will be
+     * removed from both the filesystem and the database.
+     *
+     * @param vaultId - The unique identifier of the vault to delete
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.vaults.delete('vault-uuid');
+     * ```
+     */
+    delete(vaultId: string): Promise<void>;
+}
+//# sourceMappingURL=vaults.d.ts.map

package/dist/resources/vaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../src/resources/vaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGrC,0CAA0C;AAC1C,MAAM,WAAW,KAAK;IACpB,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gEAAgE;IAChE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;OAcG;IACG,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAS9B;;;;;;;;;;;;;;OAcG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAQ1C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAQzG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAQrG;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO7C"}

package/dist/resources/vaults.js

@@ -0,0 +1,158 @@
+import { handleError } from '../handle-error.js';
+/**
+ * Resource for managing vaults.
+ *
+ * Vaults are isolated document storage containers. Each vault has a unique
+ * slug and can hold an arbitrary number of Markdown documents organized
+ * in a directory structure.
+ *
+ * @example
+ * ```typescript
+ * const vaults = await client.vaults.list();
+ * const vault = await client.vaults.create({ name: 'My Notes' });
+ * ```
+ */
+export class VaultsResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Lists all vaults accessible to the authenticated user.
+     *
+     * @returns Array of vault objects
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vaults = await client.vaults.list();
+     * for (const vault of vaults) {
+     *   console.log(vault.name, vault.slug);
+     * }
+     * ```
+     */
+    async list() {
+        try {
+            const data = await this.http.get('vaults').json();
+            return data.vaults;
+        }
+        catch (error) {
+            throw await handleError(error, 'Vaults', '');
+        }
+    }
+    /**
+     * Retrieves a single vault by ID.
+     *
+     * @param vaultId - The unique identifier of the vault
+     * @returns The vault object
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vault = await client.vaults.get('vault-uuid');
+     * console.log(vault.name);
+     * ```
+     */
+    async get(vaultId) {
+        try {
+            return await this.http.get(`vaults/${vaultId}`).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Vault', vaultId);
+        }
+    }
+    /**
+     * Creates a new vault.
+     *
+     * A URL-friendly slug is automatically generated from the vault name.
+     *
+     * @param params - Vault creation parameters
+     * @param params.name - Display name for the vault (required)
+     * @param params.description - Optional description of the vault's purpose
+     * @returns The newly created vault object
+     * @throws {ValidationError} If the name is empty or the generated slug conflicts with an existing vault
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vault = await client.vaults.create({
+     *   name: 'Work Documents',
+     *   description: 'Team documentation and notes',
+     * });
+     * console.log(vault.id, vault.slug);
+     * ```
+     *
+     * @see {@link VaultsResource.update} to modify an existing vault
+     */
+    async create(params) {
+        try {
+            return await this.http.post('vaults', { json: params }).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Vault', params.name);
+        }
+    }
+    /**
+     * Updates an existing vault's metadata.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     * Set `description` to `null` to clear it.
+     *
+     * @param vaultId - The unique identifier of the vault to update
+     * @param params - Fields to update
+     * @param params.name - New display name for the vault
+     * @param params.description - New description, or `null` to clear
+     * @returns The updated vault object
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {ValidationError} If the new name produces a conflicting slug
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.vaults.update('vault-uuid', {
+     *   name: 'Renamed Vault',
+     *   description: null,
+     * });
+     * ```
+     *
+     * @see {@link VaultsResource.create} to create a new vault
+     */
+    async update(vaultId, params) {
+        try {
+            return await this.http.put(`vaults/${vaultId}`, { json: params }).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Vault', vaultId);
+        }
+    }
+    /**
+     * Permanently deletes a vault and all its documents.
+     *
+     * This action is irreversible. All documents within the vault will be
+     * removed from both the filesystem and the database.
+     *
+     * @param vaultId - The unique identifier of the vault to delete
+     * @throws {NotFoundError} If no vault exists with the given ID
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.vaults.delete('vault-uuid');
+     * ```
+     */
+    async delete(vaultId) {
+        try {
+            await this.http.delete(`vaults/${vaultId}`);
+        }
+        catch (error) {
+            throw await handleError(error, 'Vault', vaultId);
+        }
+    }
+}
+//# sourceMappingURL=vaults.js.map

package/dist/resources/vaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../src/resources/vaults.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAoBjD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,cAAc;IACL;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAuB,CAAC;YACvE,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAC,IAAI,EAAS,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,MAAM,CAAC,MAA2E;QACtF,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAS,CAAC;QACxE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAAsD;QAClF,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAS,CAAC;QAClF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,OAAO,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF"}

package/dist/resources/webhooks.d.ts

@@ -0,0 +1,187 @@
+import type { KyInstance } from 'ky';
+/** A webhook object returned by the API. */
+export interface Webhook {
+    /** Unique webhook identifier. */
+    id: string;
+    /** Vault this webhook belongs to. */
+    vaultId: string;
+    /** URL that receives webhook deliveries. */
+    url: string;
+    /** Event types this webhook subscribes to (e.g., `['create', 'update', 'delete']`). */
+    events: string[];
+    /** Whether the webhook is currently active. */
+    isActive: boolean;
+    /** ISO 8601 creation timestamp. */
+    createdAt: string;
+    /** ISO 8601 last-updated timestamp. */
+    updatedAt: string;
+}
+/** A webhook with the signing secret included. Only returned on creation. */
+export interface WebhookWithSecret extends Webhook {
+    /** HMAC signing secret for verifying webhook payloads. Only available at creation time. */
+    secret: string;
+}
+/** A webhook delivery log entry. */
+export interface WebhookDelivery {
+    /** Unique delivery identifier. */
+    id: string;
+    /** Webhook this delivery belongs to. */
+    webhookId: string;
+    /** Vault event that triggered the delivery. */
+    eventId: string;
+    /** HTTP status code returned by the endpoint, or `null` if delivery failed. */
+    statusCode: number | null;
+    /** Delivery attempt number. */
+    attempt: number;
+    /** Request body that was sent. */
+    requestBody: unknown;
+    /** Response body from the endpoint, or `null`. */
+    responseBody: string | null;
+    /** Error message if delivery failed, or `null`. */
+    error: string | null;
+    /** ISO 8601 timestamp of successful delivery, or `null`. */
+    deliveredAt: string | null;
+    /** ISO 8601 creation timestamp. */
+    createdAt: string;
+}
+/** Parameters for creating a new webhook. */
+export interface CreateWebhookParams {
+    /** URL to receive webhook deliveries. Must be a publicly accessible HTTPS endpoint. */
+    url: string;
+    /** Event types to subscribe to (e.g., `['create', 'update', 'delete']`). */
+    events: string[];
+}
+/** Parameters for updating an existing webhook. */
+export interface UpdateWebhookParams {
+    /** New URL for the webhook endpoint. */
+    url?: string;
+    /** New set of event types to subscribe to. */
+    events?: string[];
+    /** Whether the webhook should be active. */
+    isActive?: boolean;
+}
+/**
+ * Resource for managing vault webhooks.
+ *
+ * Webhooks send HTTP POST notifications to external URLs when document events
+ * occur in a vault. Payloads are signed with HMAC-SHA256 for verification.
+ *
+ * Requires a **pro** or higher subscription tier.
+ *
+ * @example
+ * ```typescript
+ * const webhooks = await client.webhooks.list('vault-123');
+ * const webhook = await client.webhooks.create('vault-123', {
+ *   url: 'https://example.com/webhook',
+ *   events: ['create', 'update'],
+ * });
+ * console.log('Save this secret:', webhook.secret);
+ * ```
+ */
+export declare class WebhooksResource {
+    private http;
+    constructor(http: KyInstance);
+    /**
+     * Lists all webhooks for a vault.
+     *
+     * @param vaultId - The vault to list webhooks for
+     * @returns Array of webhook objects (without secrets)
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {AuthorizationError} If the user lacks access to the vault
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const webhooks = await client.webhooks.list('vault-123');
+     * for (const wh of webhooks) {
+     *   console.log(wh.url, wh.events, wh.isActive);
+     * }
+     * ```
+     */
+    list(vaultId: string): Promise<Webhook[]>;
+    /**
+     * Creates a new webhook in a vault.
+     *
+     * The signing secret is only returned on creation. Store it securely --
+     * it cannot be retrieved later. Use it to verify HMAC-SHA256 signatures
+     * on incoming webhook payloads.
+     *
+     * @param vaultId - The vault to create the webhook in
+     * @param params - Webhook creation parameters
+     * @returns The created webhook object including the signing secret
+     * @throws {ValidationError} If parameters are invalid or the URL is blocked (SSRF protection)
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {AuthorizationError} If the user lacks access to the vault
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const webhook = await client.webhooks.create('vault-123', {
+     *   url: 'https://example.com/webhook',
+     *   events: ['create', 'update', 'delete'],
+     * });
+     * console.log('Save this secret:', webhook.secret);
+     * ```
+     */
+    create(vaultId: string, params: CreateWebhookParams): Promise<WebhookWithSecret>;
+    /**
+     * Updates an existing webhook.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to update
+     * @param params - Fields to update
+     * @returns The updated webhook object
+     * @throws {ValidationError} If parameters are invalid or the URL is blocked
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.webhooks.update('vault-123', 'wh-456', {
+     *   events: ['create', 'delete'],
+     *   isActive: false,
+     * });
+     * ```
+     */
+    update(vaultId: string, webhookId: string, params: UpdateWebhookParams): Promise<Webhook>;
+    /**
+     * Deletes a webhook permanently.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to delete
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.webhooks.delete('vault-123', 'wh-456');
+     * ```
+     */
+    delete(vaultId: string, webhookId: string): Promise<void>;
+    /**
+     * Lists recent deliveries for a webhook.
+     *
+     * Returns up to 50 most recent delivery log entries, ordered by most recent first.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to get deliveries for
+     * @returns Array of webhook delivery log entries
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const deliveries = await client.webhooks.listDeliveries('vault-123', 'wh-456');
+     * for (const d of deliveries) {
+     *   console.log(d.statusCode, d.attempt, d.deliveredAt);
+     * }
+     * ```
+     */
+    listDeliveries(vaultId: string, webhookId: string): Promise<WebhookDelivery[]>;
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/resources/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/resources/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGrC,4CAA4C;AAC5C,MAAM,WAAW,OAAO;IACtB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,uFAAuF;IACvF,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,QAAQ,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,6EAA6E;AAC7E,MAAM,WAAW,iBAAkB,SAAQ,OAAO;IAChD,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,WAAW,EAAE,OAAO,CAAC;IACrB,kDAAkD;IAClD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,mDAAmD;IACnD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,4DAA4D;IAC5D,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,6CAA6C;AAC7C,MAAM,WAAW,mBAAmB;IAClC,uFAAuF;IACvF,GAAG,EAAE,MAAM,CAAC;IACZ,4EAA4E;IAC5E,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,gBAAgB;IACf,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAS/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAUtF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAU/F;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAUrF"}

package/dist/resources/webhooks.js

@@ -0,0 +1,171 @@
+import { handleError } from '../handle-error.js';
+/**
+ * Resource for managing vault webhooks.
+ *
+ * Webhooks send HTTP POST notifications to external URLs when document events
+ * occur in a vault. Payloads are signed with HMAC-SHA256 for verification.
+ *
+ * Requires a **pro** or higher subscription tier.
+ *
+ * @example
+ * ```typescript
+ * const webhooks = await client.webhooks.list('vault-123');
+ * const webhook = await client.webhooks.create('vault-123', {
+ *   url: 'https://example.com/webhook',
+ *   events: ['create', 'update'],
+ * });
+ * console.log('Save this secret:', webhook.secret);
+ * ```
+ */
+export class WebhooksResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Lists all webhooks for a vault.
+     *
+     * @param vaultId - The vault to list webhooks for
+     * @returns Array of webhook objects (without secrets)
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {AuthorizationError} If the user lacks access to the vault
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const webhooks = await client.webhooks.list('vault-123');
+     * for (const wh of webhooks) {
+     *   console.log(wh.url, wh.events, wh.isActive);
+     * }
+     * ```
+     */
+    async list(vaultId) {
+        try {
+            const data = await this.http.get(`vaults/${vaultId}/webhooks`).json();
+            return data.webhooks;
+        }
+        catch (error) {
+            throw await handleError(error, 'Webhooks', vaultId);
+        }
+    }
+    /**
+     * Creates a new webhook in a vault.
+     *
+     * The signing secret is only returned on creation. Store it securely --
+     * it cannot be retrieved later. Use it to verify HMAC-SHA256 signatures
+     * on incoming webhook payloads.
+     *
+     * @param vaultId - The vault to create the webhook in
+     * @param params - Webhook creation parameters
+     * @returns The created webhook object including the signing secret
+     * @throws {ValidationError} If parameters are invalid or the URL is blocked (SSRF protection)
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {AuthorizationError} If the user lacks access to the vault
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const webhook = await client.webhooks.create('vault-123', {
+     *   url: 'https://example.com/webhook',
+     *   events: ['create', 'update', 'delete'],
+     * });
+     * console.log('Save this secret:', webhook.secret);
+     * ```
+     */
+    async create(vaultId, params) {
+        try {
+            return await this.http
+                .post(`vaults/${vaultId}/webhooks`, { json: params })
+                .json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Webhook', params.url);
+        }
+    }
+    /**
+     * Updates an existing webhook.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to update
+     * @param params - Fields to update
+     * @returns The updated webhook object
+     * @throws {ValidationError} If parameters are invalid or the URL is blocked
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.webhooks.update('vault-123', 'wh-456', {
+     *   events: ['create', 'delete'],
+     *   isActive: false,
+     * });
+     * ```
+     */
+    async update(vaultId, webhookId, params) {
+        try {
+            return await this.http
+                .put(`vaults/${vaultId}/webhooks/${webhookId}`, { json: params })
+                .json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Webhook', webhookId);
+        }
+    }
+    /**
+     * Deletes a webhook permanently.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to delete
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.webhooks.delete('vault-123', 'wh-456');
+     * ```
+     */
+    async delete(vaultId, webhookId) {
+        try {
+            await this.http.delete(`vaults/${vaultId}/webhooks/${webhookId}`);
+        }
+        catch (error) {
+            throw await handleError(error, 'Webhook', webhookId);
+        }
+    }
+    /**
+     * Lists recent deliveries for a webhook.
+     *
+     * Returns up to 50 most recent delivery log entries, ordered by most recent first.
+     *
+     * @param vaultId - The vault the webhook belongs to
+     * @param webhookId - The webhook to get deliveries for
+     * @returns Array of webhook delivery log entries
+     * @throws {NotFoundError} If the webhook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const deliveries = await client.webhooks.listDeliveries('vault-123', 'wh-456');
+     * for (const d of deliveries) {
+     *   console.log(d.statusCode, d.attempt, d.deliveredAt);
+     * }
+     * ```
+     */
+    async listDeliveries(vaultId, webhookId) {
+        try {
+            const data = await this.http
+                .get(`vaults/${vaultId}/webhooks/${webhookId}/deliveries`)
+                .json();
+            return data.deliveries;
+        }
+        catch (error) {
+            throw await handleError(error, 'Webhook', webhookId);
+        }
+    }
+}
+//# sourceMappingURL=webhooks.js.map

package/dist/resources/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/resources/webhooks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAoEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,gBAAgB;IACP;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe;QACxB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,WAAW,CAAC,CAAC,IAAI,EAA2B,CAAC;YAC/F,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAA2B;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI;iBACnB,IAAI,CAAC,UAAU,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iBACpD,IAAI,EAAqB,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,SAAiB,EAAE,MAA2B;QAC1E,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI;iBACnB,GAAG,CAAC,UAAU,OAAO,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iBAChE,IAAI,EAAW,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,SAAiB;QAC7C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,OAAO,aAAa,SAAS,EAAE,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAAC,OAAe,EAAE,SAAiB;QACrD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;iBACzB,GAAG,CAAC,UAAU,OAAO,aAAa,SAAS,aAAa,CAAC;iBACzD,IAAI,EAAqC,CAAC;YAC7C,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF"}