@lifestreamdynamics/vault-sdk 1.0.0

package/dist/resources/hooks.js

@@ -0,0 +1,166 @@
+import { handleError } from '../handle-error.js';
+/**
+ * Resource for managing vault hooks.
+ *
+ * Hooks are internal event handlers that run automatically when document
+ * events occur within a vault. They can perform actions such as auto-tagging,
+ * template application, and other automated workflows.
+ *
+ * Requires a **pro** or higher subscription tier.
+ *
+ * @example
+ * ```typescript
+ * const hooks = await client.hooks.list('vault-123');
+ * const hook = await client.hooks.create('vault-123', {
+ *   name: 'Auto-tag on create',
+ *   triggerEvent: 'document.create',
+ *   actionType: 'auto-tag',
+ *   actionConfig: { tags: ['new'] },
+ * });
+ * ```
+ */
+export class HooksResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Lists all hooks for a vault.
+     *
+     * @param vaultId - The vault to list hooks for
+     * @returns Array of hook objects
+     * @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 hooks = await client.hooks.list('vault-123');
+     * for (const hook of hooks) {
+     *   console.log(hook.name, hook.triggerEvent, hook.isActive);
+     * }
+     * ```
+     */
+    async list(vaultId) {
+        try {
+            const data = await this.http.get(`vaults/${vaultId}/hooks`).json();
+            return data.hooks;
+        }
+        catch (error) {
+            throw await handleError(error, 'Hooks', vaultId);
+        }
+    }
+    /**
+     * Creates a new hook in a vault.
+     *
+     * @param vaultId - The vault to create the hook in
+     * @param params - Hook creation parameters
+     * @returns The created hook object
+     * @throws {ValidationError} If parameters are invalid
+     * @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 hook = await client.hooks.create('vault-123', {
+     *   name: 'Auto-tag new docs',
+     *   triggerEvent: 'document.create',
+     *   actionType: 'auto-tag',
+     *   actionConfig: { tags: ['new'] },
+     * });
+     * ```
+     */
+    async create(vaultId, params) {
+        try {
+            return await this.http.post(`vaults/${vaultId}/hooks`, { json: params }).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Hook', params.name);
+        }
+    }
+    /**
+     * Updates an existing hook.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     *
+     * @param vaultId - The vault the hook belongs to
+     * @param hookId - The hook to update
+     * @param params - Fields to update
+     * @returns The updated hook object
+     * @throws {ValidationError} If parameters are invalid
+     * @throws {NotFoundError} If the hook 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.hooks.update('vault-123', 'hook-456', {
+     *   name: 'Renamed Hook',
+     *   isActive: false,
+     * });
+     * ```
+     */
+    async update(vaultId, hookId, params) {
+        try {
+            return await this.http.put(`vaults/${vaultId}/hooks/${hookId}`, { json: params }).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Hook', hookId);
+        }
+    }
+    /**
+     * Deletes a hook permanently.
+     *
+     * @param vaultId - The vault the hook belongs to
+     * @param hookId - The hook to delete
+     * @throws {NotFoundError} If the hook 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.hooks.delete('vault-123', 'hook-456');
+     * ```
+     */
+    async delete(vaultId, hookId) {
+        try {
+            await this.http.delete(`vaults/${vaultId}/hooks/${hookId}`);
+        }
+        catch (error) {
+            throw await handleError(error, 'Hook', hookId);
+        }
+    }
+    /**
+     * Lists recent executions for a hook.
+     *
+     * Returns up to 50 most recent execution log entries, ordered by most recent first.
+     *
+     * @param vaultId - The vault the hook belongs to
+     * @param hookId - The hook to get executions for
+     * @returns Array of hook execution log entries
+     * @throws {NotFoundError} If the hook does not exist in the vault
+     * @throws {AuthenticationError} If not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const executions = await client.hooks.listExecutions('vault-123', 'hook-456');
+     * for (const exec of executions) {
+     *   console.log(exec.status, exec.durationMs, exec.createdAt);
+     * }
+     * ```
+     */
+    async listExecutions(vaultId, hookId) {
+        try {
+            const data = await this.http
+                .get(`vaults/${vaultId}/hooks/${hookId}/executions`)
+                .json();
+            return data.executions;
+        }
+        catch (error) {
+            throw await handleError(error, 'Hook', hookId);
+        }
+    }
+}
+//# sourceMappingURL=hooks.js.map

package/dist/resources/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/resources/hooks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AA4EjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAa;IACJ;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,QAAQ,CAAC,CAAC,IAAI,EAAqB,CAAC;YACtF,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAAwB;QACpD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAQ,CAAC;QACxF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAAc,EAAE,MAAwB;QACpE,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,OAAO,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAQ,CAAC;QACjG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAAc;QAC1C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,OAAO,UAAU,MAAM,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAAC,OAAe,EAAE,MAAc;QAClD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;iBACzB,GAAG,CAAC,UAAU,OAAO,UAAU,MAAM,aAAa,CAAC;iBACnD,IAAI,EAAmC,CAAC;YAC3C,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;CACF"}

package/dist/resources/publish.d.ts

@@ -0,0 +1,165 @@
+import type { KyInstance } from 'ky';
+/** A published document with SEO metadata. */
+export interface PublishedDocument {
+    /** Unique published document identifier. */
+    id: string;
+    /** ID of the source document. */
+    documentId: string;
+    /** ID of the vault containing the document. */
+    vaultId: string;
+    /** ID of the user who published the document. */
+    publishedBy: string;
+    /** URL-friendly slug for the published page. */
+    slug: string;
+    /** SEO title for the published page, or `null` if not set. */
+    seoTitle: string | null;
+    /** SEO description for the published page, or `null` if not set. */
+    seoDescription: string | null;
+    /** Open Graph image URL, or `null` if not set. */
+    ogImage: string | null;
+    /** Whether the document is currently published. */
+    isPublished: boolean;
+    /** ISO 8601 timestamp when the document was first published. */
+    publishedAt: string;
+    /** ISO 8601 timestamp of the last update to publish settings. */
+    updatedAt: string;
+}
+/** A published document with additional document metadata (returned by `listMine`). */
+export interface PublishedDocumentWithMeta extends PublishedDocument {
+    /** File path of the source document. */
+    documentPath: string;
+    /** Title of the source document, or `null` if not set. */
+    documentTitle: string | null;
+}
+/** Parameters for publishing a document. */
+export interface PublishDocumentParams {
+    /** URL-friendly slug (lowercase alphanumeric with hyphens). */
+    slug: string;
+    /** Optional SEO title (max 200 chars). */
+    seoTitle?: string;
+    /** Optional SEO description (max 500 chars). */
+    seoDescription?: string;
+    /** Optional Open Graph image URL. */
+    ogImage?: string;
+}
+/** Parameters for updating a published document. */
+export interface UpdatePublishParams {
+    /** New slug (required for updates). */
+    slug: string;
+    /** Updated SEO title, or `null` to clear. */
+    seoTitle?: string | null;
+    /** Updated SEO description, or `null` to clear. */
+    seoDescription?: string | null;
+    /** Updated Open Graph image URL, or `null` to clear. */
+    ogImage?: string | null;
+}
+/**
+ * Resource for managing document publishing.
+ *
+ * Published documents are publicly accessible at `/:profileSlug/:docSlug`
+ * with optional SEO metadata. Requires a `pro` or higher subscription tier
+ * with the `publishing` feature enabled.
+ *
+ * @example
+ * ```typescript
+ * const published = await client.publish.create('vault-id', 'blog/first-post.md', {
+ *   slug: 'my-first-post',
+ *   seoTitle: 'My First Post',
+ *   seoDescription: 'An introduction to my vault.',
+ * });
+ * console.log(`Published at: /${published.publishedBy}/${published.slug}`);
+ * ```
+ */
+export declare class PublishResource {
+    private http;
+    constructor(http: KyInstance);
+    /**
+     * Lists all published documents for the authenticated user.
+     *
+     * Returns documents across all vaults, including document path and title
+     * metadata. Does not require vault-level access.
+     *
+     * @param vaultId - A vault ID (required by the route but not filtered on)
+     * @returns Array of published document objects with source document metadata
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const docs = await client.publish.listMine('any-vault-id');
+     * for (const doc of docs) {
+     *   console.log(`${doc.slug} -> ${doc.documentPath} (published: ${doc.isPublished})`);
+     * }
+     * ```
+     */
+    listMine(vaultId: string): Promise<PublishedDocumentWithMeta[]>;
+    /**
+     * Publishes a document, making it publicly accessible.
+     *
+     * If the document is already published, this updates its publish settings
+     * (acts as an upsert).
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the document to publish
+     * @param params - Publish parameters including slug and optional SEO metadata
+     * @returns The published document metadata
+     * @throws {NotFoundError} If the vault or document does not exist
+     * @throws {ConflictError} If the slug is already in use
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {ValidationError} If the parameters are invalid
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const pub = await client.publish.create('vault-id', 'blog/post.md', {
+     *   slug: 'my-post',
+     *   seoTitle: 'My Blog Post',
+     * });
+     * console.log(`Published: ${pub.slug}`);
+     * ```
+     */
+    create(vaultId: string, documentPath: string, params: PublishDocumentParams): Promise<PublishedDocument>;
+    /**
+     * Updates the publish settings of an already-published document.
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the published document
+     * @param params - Updated publish parameters (slug is required)
+     * @returns The updated published document metadata
+     * @throws {NotFoundError} If the vault or document does not exist
+     * @throws {ConflictError} If the new slug is already in use
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {ValidationError} If the parameters are invalid
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.publish.update('vault-id', 'blog/post.md', {
+     *   slug: 'updated-slug',
+     *   seoDescription: 'Updated description for SEO.',
+     * });
+     * ```
+     */
+    update(vaultId: string, documentPath: string, params: UpdatePublishParams): Promise<PublishedDocument>;
+    /**
+     * Unpublishes a document, removing it from public access.
+     *
+     * The document itself is not deleted; only the published state is changed.
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the document to unpublish
+     * @throws {NotFoundError} If the published document does not exist
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.publish.delete('vault-id', 'blog/post.md');
+     * ```
+     */
+    delete(vaultId: string, documentPath: string): Promise<void>;
+}
+//# sourceMappingURL=publish.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../src/resources/publish.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGrC,8CAA8C;AAC9C,MAAM,WAAW,iBAAiB;IAChC,4CAA4C;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,oEAAoE;IACpE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kDAAkD;IAClD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,mDAAmD;IACnD,WAAW,EAAE,OAAO,CAAC;IACrB,gEAAgE;IAChE,WAAW,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,uFAAuF;AACvF,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oDAAoD;AACpD,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,mDAAmD;IACnD,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAWrE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CACV,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC;IAW7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CACV,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IAW7B;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnE"}

package/dist/resources/publish.js

@@ -0,0 +1,150 @@
+import { handleError } from '../handle-error.js';
+/**
+ * Resource for managing document publishing.
+ *
+ * Published documents are publicly accessible at `/:profileSlug/:docSlug`
+ * with optional SEO metadata. Requires a `pro` or higher subscription tier
+ * with the `publishing` feature enabled.
+ *
+ * @example
+ * ```typescript
+ * const published = await client.publish.create('vault-id', 'blog/first-post.md', {
+ *   slug: 'my-first-post',
+ *   seoTitle: 'My First Post',
+ *   seoDescription: 'An introduction to my vault.',
+ * });
+ * console.log(`Published at: /${published.publishedBy}/${published.slug}`);
+ * ```
+ */
+export class PublishResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Lists all published documents for the authenticated user.
+     *
+     * Returns documents across all vaults, including document path and title
+     * metadata. Does not require vault-level access.
+     *
+     * @param vaultId - A vault ID (required by the route but not filtered on)
+     * @returns Array of published document objects with source document metadata
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const docs = await client.publish.listMine('any-vault-id');
+     * for (const doc of docs) {
+     *   console.log(`${doc.slug} -> ${doc.documentPath} (published: ${doc.isPublished})`);
+     * }
+     * ```
+     */
+    async listMine(vaultId) {
+        try {
+            const data = await this.http
+                .get(`vaults/${vaultId}/publish/my`)
+                .json();
+            return data.publishedDocs;
+        }
+        catch (error) {
+            throw await handleError(error, 'Published Documents', '');
+        }
+    }
+    /**
+     * Publishes a document, making it publicly accessible.
+     *
+     * If the document is already published, this updates its publish settings
+     * (acts as an upsert).
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the document to publish
+     * @param params - Publish parameters including slug and optional SEO metadata
+     * @returns The published document metadata
+     * @throws {NotFoundError} If the vault or document does not exist
+     * @throws {ConflictError} If the slug is already in use
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {ValidationError} If the parameters are invalid
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const pub = await client.publish.create('vault-id', 'blog/post.md', {
+     *   slug: 'my-post',
+     *   seoTitle: 'My Blog Post',
+     * });
+     * console.log(`Published: ${pub.slug}`);
+     * ```
+     */
+    async create(vaultId, documentPath, params) {
+        try {
+            const data = await this.http
+                .post(`vaults/${vaultId}/publish/document/${documentPath}`, { json: params })
+                .json();
+            return data.publishedDoc;
+        }
+        catch (error) {
+            throw await handleError(error, 'Published Document', documentPath);
+        }
+    }
+    /**
+     * Updates the publish settings of an already-published document.
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the published document
+     * @param params - Updated publish parameters (slug is required)
+     * @returns The updated published document metadata
+     * @throws {NotFoundError} If the vault or document does not exist
+     * @throws {ConflictError} If the new slug is already in use
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {ValidationError} If the parameters are invalid
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.publish.update('vault-id', 'blog/post.md', {
+     *   slug: 'updated-slug',
+     *   seoDescription: 'Updated description for SEO.',
+     * });
+     * ```
+     */
+    async update(vaultId, documentPath, params) {
+        try {
+            const data = await this.http
+                .put(`vaults/${vaultId}/publish/document/${documentPath}`, { json: params })
+                .json();
+            return data.publishedDoc;
+        }
+        catch (error) {
+            throw await handleError(error, 'Published Document', documentPath);
+        }
+    }
+    /**
+     * Unpublishes a document, removing it from public access.
+     *
+     * The document itself is not deleted; only the published state is changed.
+     *
+     * @param vaultId - The vault ID containing the document
+     * @param documentPath - File path of the document to unpublish
+     * @throws {NotFoundError} If the published document does not exist
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {AuthorizationError} If the user's subscription does not include publishing
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.publish.delete('vault-id', 'blog/post.md');
+     * ```
+     */
+    async delete(vaultId, documentPath) {
+        try {
+            await this.http.delete(`vaults/${vaultId}/publish/document/${documentPath}`);
+        }
+        catch (error) {
+            throw await handleError(error, 'Published Document', documentPath);
+        }
+    }
+}
+//# sourceMappingURL=publish.js.map

package/dist/resources/publish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.js","sourceRoot":"","sources":["../../src/resources/publish.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AA4DjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,eAAe;IACN;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;iBACzB,GAAG,CAAC,UAAU,OAAO,aAAa,CAAC;iBACnC,IAAI,EAAkD,CAAC;YAC1D,OAAO,IAAI,CAAC,aAAa,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,YAAoB,EACpB,MAA6B;QAE7B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;iBACzB,IAAI,CAAC,UAAU,OAAO,qBAAqB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iBAC5E,IAAI,EAAuC,CAAC;YAC/C,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,YAAoB,EACpB,MAA2B;QAE3B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI;iBACzB,GAAG,CAAC,UAAU,OAAO,qBAAqB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iBAC3E,IAAI,EAAuC,CAAC;YAC/C,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,YAAoB;QAChD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,OAAO,qBAAqB,YAAY,EAAE,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;CACF"}

package/dist/resources/search.d.ts

@@ -0,0 +1,94 @@
+import type { KyInstance } from 'ky';
+/** A single search result with matched document details. */
+export interface SearchResult {
+    /** Unique identifier of the matched document. */
+    documentId: string;
+    /** ID of the vault containing the document. */
+    vaultId: string;
+    /** Name of the vault containing the document. */
+    vaultName: string;
+    /** File path of the matched document. */
+    path: string;
+    /** Document title, if available. */
+    title: string | null;
+    /** Text snippet with highlighted matches. */
+    snippet: string;
+    /** Tags on the matched document. */
+    tags: string[];
+    /** Relevance rank (higher is more relevant). */
+    rank: number;
+    /** ISO 8601 timestamp of the last file modification. */
+    fileModifiedAt: string;
+}
+/** Response from a full-text search query. */
+export interface SearchResponse {
+    /** Array of matching documents. */
+    results: SearchResult[];
+    /** Total number of matching documents (for pagination). */
+    total: number;
+    /** The original query string. */
+    query: string;
+}
+/**
+ * Resource for full-text search across vaults.
+ *
+ * Uses PostgreSQL `websearch_to_tsquery` syntax for queries, supporting
+ * natural language search, quoted phrases, and boolean operators.
+ *
+ * @example
+ * ```typescript
+ * const results = await client.search.search({ q: 'meeting notes' });
+ * for (const result of results.results) {
+ *   console.log(result.title, result.snippet);
+ * }
+ * ```
+ */
+export declare class SearchResource {
+    private http;
+    constructor(http: KyInstance);
+    /**
+     * Searches for documents matching a full-text query.
+     *
+     * Supports PostgreSQL `websearch_to_tsquery` syntax: plain words for
+     * natural language matching, `"quoted phrases"` for exact matches,
+     * `OR` for alternatives, and `-word` for exclusion.
+     *
+     * @param params - Search parameters
+     * @param params.q - Search query string (required)
+     * @param params.vault - Optional vault ID to restrict search to a single vault
+     * @param params.tags - Optional comma-separated tag filter (e.g., `'work,urgent'`)
+     * @param params.limit - Maximum number of results to return
+     * @param params.offset - Number of results to skip (for pagination)
+     * @returns Search response with matching documents, total count, and the original query
+     * @throws {ValidationError} If the query string is empty
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * // Simple search
+     * const results = await client.search.search({ q: 'project ideas' });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Filtered and paginated search
+     * const results = await client.search.search({
+     *   q: '"quarterly review"',
+     *   vault: 'vault-uuid',
+     *   tags: 'work,reports',
+     *   limit: 10,
+     *   offset: 20,
+     * });
+     * console.log(`Showing ${results.results.length} of ${results.total}`);
+     * ```
+     */
+    search(params: {
+        q: string;
+        vault?: string;
+        tags?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<SearchResponse>;
+}
+//# sourceMappingURL=search.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/resources/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGrC,4DAA4D;AAC5D,MAAM,WAAW,YAAY;IAC3B,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,MAAM,CAAC,MAAM,EAAE;QACnB,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,cAAc,CAAC;CAY5B"}

package/dist/resources/search.js

@@ -0,0 +1,76 @@
+import { handleError } from '../handle-error.js';
+/**
+ * Resource for full-text search across vaults.
+ *
+ * Uses PostgreSQL `websearch_to_tsquery` syntax for queries, supporting
+ * natural language search, quoted phrases, and boolean operators.
+ *
+ * @example
+ * ```typescript
+ * const results = await client.search.search({ q: 'meeting notes' });
+ * for (const result of results.results) {
+ *   console.log(result.title, result.snippet);
+ * }
+ * ```
+ */
+export class SearchResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Searches for documents matching a full-text query.
+     *
+     * Supports PostgreSQL `websearch_to_tsquery` syntax: plain words for
+     * natural language matching, `"quoted phrases"` for exact matches,
+     * `OR` for alternatives, and `-word` for exclusion.
+     *
+     * @param params - Search parameters
+     * @param params.q - Search query string (required)
+     * @param params.vault - Optional vault ID to restrict search to a single vault
+     * @param params.tags - Optional comma-separated tag filter (e.g., `'work,urgent'`)
+     * @param params.limit - Maximum number of results to return
+     * @param params.offset - Number of results to skip (for pagination)
+     * @returns Search response with matching documents, total count, and the original query
+     * @throws {ValidationError} If the query string is empty
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * // Simple search
+     * const results = await client.search.search({ q: 'project ideas' });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Filtered and paginated search
+     * const results = await client.search.search({
+     *   q: '"quarterly review"',
+     *   vault: 'vault-uuid',
+     *   tags: 'work,reports',
+     *   limit: 10,
+     *   offset: 20,
+     * });
+     * console.log(`Showing ${results.results.length} of ${results.total}`);
+     * ```
+     */
+    async search(params) {
+        try {
+            const searchParams = { q: params.q };
+            if (params.vault)
+                searchParams.vault = params.vault;
+            if (params.tags)
+                searchParams.tags = params.tags;
+            if (params.limit !== undefined)
+                searchParams.limit = params.limit;
+            if (params.offset !== undefined)
+                searchParams.offset = params.offset;
+            return await this.http.get('search', { searchParams }).json();
+        }
+        catch (error) {
+            throw await handleError(error, 'Search', params.q);
+        }
+    }
+}
+//# sourceMappingURL=search.js.map

package/dist/resources/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/resources/search.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAkCjD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,cAAc;IACL;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,MAAM,CAAC,MAMZ;QACC,IAAI,CAAC;YACH,MAAM,YAAY,GAAoC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;YACtE,IAAI,MAAM,CAAC,KAAK;gBAAE,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YACpD,IAAI,MAAM,CAAC,IAAI;gBAAE,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACjD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;gBAAE,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YAClE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;gBAAE,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YACrE,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,IAAI,EAAkB,CAAC;QAChF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF"}