@inneropen/marvin-sdk 3.0.0 → 3.1.0-next.1

package/dist/{marvin-BmbMUJXh.d.ts → marvin-C_TihjE2.d.ts}

@@ -1,4 +1,4 @@
-import { PublishedEntryType, MarvinResource, MarvinEntry, MarvinAsset, MarvinCollection, MarvinEntryType, MarvinSite, GetResourcesOptions as GetResourcesOptions$1 } from './types/index.js';
+import { m as PublishedEntryType, h as MarvinResource, M as MarvinAsset, c as MarvinCollection, e as MarvinEntryListItem, j as PublishedCollectionSummary, d as MarvinEntry, k as PublishedEntryAsset, l as PublishedEntryResource, i as MarvinSite, n as components, b as GetResourcesOptions$1 } from './index-BLIrbIHf.js';
 import { H as HttpClient } from './HttpClient-CdF3IHM1.js';
 
 /**
@@ -212,30 +212,17 @@ declare class RenderersModule {
 
 declare class Resource {
     private data;
-    private http;
-    private workspaceSlug;
-    constructor(data: MarvinResource, http: MarvinHttpClient, workspaceSlug: string);
-    get id(): string;
+    constructor(data: MarvinResource);
     get name(): string;
     get slug(): string;
-    get resourceType(): string | undefined;
-    get description(): string | undefined;
-    get externalId(): string | undefined;
-    get url(): string | undefined;
-    get metadata(): Record<string, unknown> | undefined;
-    get createdAt(): string;
-    get updatedAt(): string;
-    /**
-     * Get all entries that reference this resource
-     */
-    entries(): Promise<MarvinEntry[]>;
-    /**
-     * Get assets related to this resource (future)
-     */
-    assets(): Promise<MarvinAsset[]>;
-    /**
-     * Get raw resource data
-     */
+    get resourceType(): string;
+    get description(): string | null | undefined;
+    get externalId(): string | null | undefined;
+    get url(): string | null | undefined;
+    get metadataJson(): {
+        [key: string]: unknown;
+    } | null | undefined;
+    get entries(): string[];
     toJSON(): MarvinResource;
 }
 
@@ -261,9 +248,9 @@ declare class ResourcesModule {
      */
     get(slug: string): Promise<Resource>;
     /**
-     * Get entries that reference this resource
+     * Get entry slugs that reference this resource
      */
-    entries(slug: string): Promise<MarvinEntry[]>;
+    entries(slug: string): Promise<string[]>;
 }
 
 /**
@@ -307,35 +294,19 @@ declare class AssetsModule {
 
 declare class Collection {
     private data;
-    private http;
-    private workspaceSlug;
-    constructor(data: MarvinCollection, http: MarvinHttpClient, workspaceSlug: string);
-    get id(): string;
+    constructor(data: MarvinCollection);
     get name(): string;
     get slug(): string;
-    get description(): string | undefined;
-    get icon(): string | undefined;
-    get color(): string | undefined;
-    get sortOrder(): number;
+    get description(): string | null | undefined;
     get isSmart(): boolean;
-    get smartRules(): Record<string, unknown> | undefined;
-    get createdAt(): string;
-    get updatedAt(): string;
-    /**
-     * Get all entries in this collection
-     */
-    entries(): Promise<MarvinEntry[]>;
-    /**
-     * Get assets in this collection (future)
-     */
-    assets(): Promise<MarvinAsset[]>;
-    /**
-     * Get collection metadata (future)
-     */
-    metadata(): Promise<any>;
-    /**
-     * Get raw collection data
-     */
+    get smartRules(): {
+        [key: string]: unknown;
+    } | null | undefined;
+    get metadataJson(): {
+        [key: string]: unknown;
+    } | null | undefined;
+    get entryCount(): number;
+    get entries(): MarvinEntryListItem[];
     toJSON(): MarvinCollection;
 }
 
@@ -350,7 +321,7 @@ declare class CollectionsModule {
     /**
      * Get all collections
      */
-    list(): Promise<MarvinCollection[]>;
+    list(): Promise<PublishedCollectionSummary[]>;
     /**
      * Get a single collection by slug
      * Returns null if collection is not found (404)
@@ -360,89 +331,56 @@ declare class CollectionsModule {
      * Get entries in a collection
      * Returns empty array if collection is not found
      */
-    entries(slug: string): Promise<MarvinEntry[]>;
+    entries(slug: string): Promise<MarvinEntryListItem[]>;
     /**
      * Try multiple collection slugs in fallback order
      * Returns the first collection that exists and has entries
-     *
-     * @param slugs - Collection slugs to try in order
-     * @param options - Options for fallback behavior
-     * @returns Entries from the first matching collection, or empty array
-     *
-     * @example
-     * ```ts
-     * // Try bench-notes, then journal, then blog
-     * const entries = await collections.fallback(['bench-notes', 'journal', 'blog']);
-     * ```
      */
     fallback(slugs: string[], options?: {
         requireEntries?: boolean;
-    }): Promise<MarvinEntry[]>;
+    }): Promise<MarvinEntryListItem[]>;
 }
 
+/**
+ * Entry - Rich object representing a single entry
+ */
+
 declare class Entry {
-    private data;
-    private http;
-    private workspaceSlug;
-    constructor(data: MarvinEntry, http: MarvinHttpClient, workspaceSlug: string);
-    get id(): string;
+    private raw;
+    constructor(raw: MarvinEntry);
     get title(): string;
     get slug(): string;
-    get summary(): string | undefined;
-    get description(): string | undefined;
-    /**
-     * @deprecated Use field('body') or dataJson instead. Will be removed in v3.0.0
-     */
-    get contentMarkdown(): string | undefined;
-    /**
-     * Schema-driven content data (replaces contentMarkdown in v2.0.0).
-     * Access specific fields using the field() helper method.
-     * @since 2.0.0
-     */
-    get dataJson(): Record<string, unknown> | undefined;
-    get metadata(): Record<string, unknown> | undefined;
-    get status(): string;
-    get publishedAt(): string | undefined;
-    get createdAt(): string;
-    get updatedAt(): string;
-    get entryTypeId(): string;
-    get entryType(): MarvinEntryType | undefined;
-    /**
-     * Get entry assets
-     */
-    get assets(): MarvinAsset[];
-    /**
-     * Get entry collections
-     */
-    get collections(): MarvinCollection[];
-    /**
-     * Get a specific field value from the entry's schema-driven content (dataJson).
-     *
-     * @param key - Field key as defined in the entry type's schema
-     * @returns The field value, or undefined if not present
-     * @since 2.0.0
-     *
-     * @example
-     * ```typescript
-     * const entry = await client.entries.get('my-entry');
-     * const body = entry.field('body');           // Get markdown body
-     * const difficulty = entry.field('difficulty'); // Get difficulty level
-     * const heroImage = entry.field('heroImage');  // Get hero image UUID
-     * ```
-     */
+    get summary(): string | null | undefined;
+    get entryType(): string;
+    get entryTypeInfo(): {
+        slug: string;
+        renderer?: string | null;
+        package?: string | null;
+        version?: string | null;
+        config?: {
+            [key: string]: unknown;
+        } | null;
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null | undefined;
+    get data(): {
+        [key: string]: unknown;
+    };
+    get metadataJson(): {
+        [key: string]: unknown;
+    } | null | undefined;
+    get publishedAt(): string | null | undefined;
+    get order(): number | null | undefined;
+    get assets(): PublishedEntryAsset[];
+    get collections(): PublishedCollectionSummary[];
+    get resources(): PublishedEntryResource[];
+    asset(role: string): PublishedEntryAsset | undefined;
+    assetsByRole(role: string): PublishedEntryAsset[];
+    resource(role: string): PublishedEntryResource | undefined;
+    resourcesByRole(role: string): PublishedEntryResource[];
     field<T = unknown>(key: string): T | undefined;
-    /**
-     * Get all fields from the entry's schema-driven content.
-     * @since 2.0.0
-     */
     get fields(): Record<string, unknown>;
-    /**
-     * Get related entries (future)
-     */
-    relatedEntries(): Promise<MarvinEntry[]>;
-    /**
-     * Get raw entry data
-     */
     toJSON(): MarvinEntry;
 }
 
@@ -464,7 +402,7 @@ declare class EntriesModule {
     /**
      * Get all published entries
      */
-    list(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    list(options?: GetEntriesOptions): Promise<MarvinEntryListItem[]>;
     /**
      * Get a single entry by slug
      * Returns null if entry is not found (404)
@@ -473,15 +411,15 @@ declare class EntriesModule {
     /**
      * Convenience: Get all pages
      */
-    pages(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+    pages(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntryListItem[]>;
     /**
      * Convenience: Get all blog posts
      */
-    posts(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+    posts(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntryListItem[]>;
     /**
      * Convenience: Get all projects
      */
-    projects(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+    projects(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntryListItem[]>;
 }
 
 /**
@@ -517,14 +455,9 @@ declare class Workspace {
         slug: string;
         name: string;
     }>;
-    /**
-     * Get workspace settings (future)
-     */
-    settings(): Promise<any>;
 }
 
 declare class MarvinClient {
-    private config;
     private http;
     private cache;
     private workspace;
@@ -581,15 +514,63 @@ declare class MarvinClient {
     /**
      * Get all pages
      */
-    pages(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    pages(options?: GetEntriesOptions): Promise<{
+        slug: string;
+        title: string;
+        entryType: string;
+        entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
+        summary?: string | null;
+        publishedAt?: string | null;
+        status: string;
+        collections: string[];
+        assetSlugs: string[];
+        resourceSlugs: string[];
+        metadataJson?: {
+            [key: string]: unknown;
+        } | null;
+        featuredAsset?: components["schemas"]["PublishedAssetRead"] | null;
+        order?: number | null;
+    }[]>;
     /**
      * Get all blog posts
      */
-    posts(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    posts(options?: GetEntriesOptions): Promise<{
+        slug: string;
+        title: string;
+        entryType: string;
+        entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
+        summary?: string | null;
+        publishedAt?: string | null;
+        status: string;
+        collections: string[];
+        assetSlugs: string[];
+        resourceSlugs: string[];
+        metadataJson?: {
+            [key: string]: unknown;
+        } | null;
+        featuredAsset?: components["schemas"]["PublishedAssetRead"] | null;
+        order?: number | null;
+    }[]>;
     /**
      * Get all projects
      */
-    projects(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    projects(options?: GetEntriesOptions): Promise<{
+        slug: string;
+        title: string;
+        entryType: string;
+        entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
+        summary?: string | null;
+        publishedAt?: string | null;
+        status: string;
+        collections: string[];
+        assetSlugs: string[];
+        resourceSlugs: string[];
+        metadataJson?: {
+            [key: string]: unknown;
+        } | null;
+        featuredAsset?: components["schemas"]["PublishedAssetRead"] | null;
+        order?: number | null;
+    }[]>;
     /**
      * Get a single resource by slug
      */
@@ -597,70 +578,50 @@ declare class MarvinClient {
     /**
      * Try multiple collection slugs in fallback order
      * Returns entries from the first collection that exists and has content
-     *
-     * @param slugs - Collection slugs to try in order
-     * @param options - Options for fallback behavior
-     * @returns Entries from the first matching collection, or empty array
-     *
-     * @example
-     * ```ts
-     * // Try bench-notes, then journal, then blog
-     * const entries = await client.collectionFallback(['bench-notes', 'journal', 'blog']);
-     * ```
      */
     collectionFallback(slugs: string[], options?: {
         requireEntries?: boolean;
-    }): Promise<MarvinEntry[]>;
+    }): Promise<MarvinEntryListItem[]>;
     /**
      * @deprecated Use workspace.site or marvin.site instead
-     * Get site configuration
      */
     getSite(): Promise<MarvinSite>;
     /**
      * @deprecated Use workspace.entries.list() instead
-     * Get all published entries
      */
-    getEntries(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    getEntries(options?: GetEntriesOptions): Promise<MarvinEntryListItem[]>;
     /**
      * @deprecated Use workspace.entries.get() instead
-     * Get a single published entry by slug
      */
     getEntry(slug: string): Promise<MarvinEntry | null>;
     /**
      * @deprecated Use workspace.collections.list() instead
-     * Get all collections
      */
-    getCollections(): Promise<MarvinCollection[]>;
+    getCollections(): Promise<PublishedCollectionSummary[]>;
     /**
      * @deprecated Use workspace.collections.get() instead
-     * Get a single collection by slug
      */
     getCollection(slug: string): Promise<MarvinCollection | null>;
     /**
      * @deprecated Use workspace.collections.entries() instead
-     * Get all entries in a collection
      */
-    getCollectionEntries(slug: string): Promise<MarvinEntry[]>;
+    getCollectionEntries(slug: string): Promise<MarvinEntryListItem[]>;
     /**
      * @deprecated Use workspace.assets.list() instead
-     * Get all published assets
      */
     getAssets(options?: GetAssetsOptions): Promise<MarvinAsset[]>;
     /**
      * @deprecated Use workspace.resources.list() instead
-     * Get all published resources
      */
     getResources(options?: GetResourcesOptions$1): Promise<MarvinResource[]>;
     /**
      * @deprecated Use workspace.resources.get() instead
-     * Get a single resource by slug
      */
     getResource(slug: string): Promise<MarvinResource>;
     /**
      * @deprecated Use workspace.resources.entries() instead
-     * Get entries that reference a resource
      */
-    getResourceEntries(slug: string): Promise<MarvinEntry[]>;
+    getResourceEntries(slug: string): Promise<string[]>;
 }
 
 export { Collection as C, Entry as E, type MarvinConfig as M, type PaginatedResponse as P, Resource as R, Workspace as W, MarvinClient as a, MarvinApiError as b, MarvinAuthError as c, MarvinCache as d, MarvinConfigError as e, MarvinError as f, MarvinNetworkError as g, MarvinNotFoundError as h, MarvinServerError as i, MarvinValidationError as j, type PaginationMeta as k, type PaginationParams as l, createConfigFromEnv as m, createPaginatedResponse as n, extractData as o, isPaginatedResponse as p, offsetToPage as q, pageToOffset as r };

package/dist/platform.cjs

@@ -1568,53 +1568,40 @@ var EmailTemplatesClient = class {
   http;
   /**
    * List all email templates for the workspace
-   * @param groupId - Workspace ID
    */
   async list(groupId) {
     return this.http.get(`/api/platform/workspaces/${groupId}/email-templates`);
   }
   /**
    * Get a specific email template
-   * @param groupId - Workspace ID
-   * @param templateId - Template ID
    */
   async get(groupId, templateId) {
     return this.http.get(`/api/platform/workspaces/${groupId}/email-templates/${templateId}`);
   }
   /**
    * Create a new email template
-   * @param groupId - Workspace ID
-   * @param data - Template data
    */
   async create(groupId, data) {
     return this.http.post(`/api/platform/workspaces/${groupId}/email-templates`, data);
   }
   /**
    * Update an email template
-   * @param groupId - Workspace ID
-   * @param templateId - Template ID
-   * @param data - Updated template data
    */
   async update(groupId, templateId, data) {
     return this.http.patch(`/api/platform/workspaces/${groupId}/email-templates/${templateId}`, data);
   }
   /**
    * Delete an email template
-   * @param groupId - Workspace ID
-   * @param templateId - Template ID
    */
   async delete(groupId, templateId) {
     await this.http.delete(`/api/platform/workspaces/${groupId}/email-templates/${templateId}`);
   }
   /**
    * Send a test email using a template
-   * @param groupId - Workspace ID
-   * @param templateId - Template ID
-   * @param recipientEmail - Test recipient email address
    */
   async sendTest(groupId, templateId, recipientEmail) {
     return this.http.post(`/api/platform/workspaces/${groupId}/email-templates/${templateId}/test`, {
-      recipient_email: recipientEmail
+      email: recipientEmail
     });
   }
 };