@inneropen/marvin-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,430 @@
+import { MarvinResource, MarvinEntry, MarvinAsset, MarvinCollection, MarvinEntryType, MarvinSite, GetResourcesOptions as GetResourcesOptions$1 } from './types/index.js';
+export { GetAssetsOptions, GetEntriesOptions, MarvinPublishResponse } from './types/index.js';
+
+/**
+ * Marvin SDK Configuration
+ */
+interface MarvinConfig {
+    apiUrl: string;
+    siteClientToken: string;
+    workspaceSlug: string;
+    /** Enable automatic initialization on client creation */
+    autoInitialize?: boolean;
+    /** Cache duration in milliseconds (default: 5 minutes) */
+    cacheDuration?: number;
+}
+declare function createConfigFromEnv(overrides?: Partial<MarvinConfig>): MarvinConfig;
+
+/**
+ * HTTP Client for Marvin API
+ */
+
+declare class MarvinHttpClient {
+    private config;
+    constructor(config: MarvinConfig);
+    fetch<T>(endpoint: string): Promise<T>;
+    buildQueryString(params: Record<string, string | number | undefined>): string;
+}
+
+/**
+ * Resource - Rich object representing a single resource
+ */
+
+declare class Resource {
+    private data;
+    private http;
+    private workspaceSlug;
+    constructor(data: MarvinResource, http: MarvinHttpClient, workspaceSlug: string);
+    get id(): string;
+    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
+     */
+    toJSON(): MarvinResource;
+}
+
+/**
+ * Resources Module - Manage resources
+ */
+
+interface GetResourcesOptions {
+    resourceType?: string;
+    limit?: number;
+    offset?: number;
+}
+declare class ResourcesModule {
+    private http;
+    private workspaceSlug;
+    constructor(http: MarvinHttpClient, workspaceSlug: string);
+    /**
+     * Get all published resources
+     */
+    list(options?: GetResourcesOptions): Promise<MarvinResource[]>;
+    /**
+     * Get a single resource by slug
+     */
+    get(slug: string): Promise<Resource>;
+    /**
+     * Get entries that reference this resource
+     */
+    entries(slug: string): Promise<MarvinEntry[]>;
+}
+
+/**
+ * Assets Module - Manage assets
+ */
+
+interface GetAssetsOptions {
+    type?: string;
+    limit?: number;
+    offset?: number;
+}
+declare class AssetsModule {
+    private http;
+    private workspaceSlug;
+    constructor(http: MarvinHttpClient, workspaceSlug: string);
+    /**
+     * Get all published assets
+     */
+    list(options?: GetAssetsOptions): Promise<MarvinAsset[]>;
+    /**
+     * Convenience: Get all images
+     */
+    images(options?: Omit<GetAssetsOptions, 'type'>): Promise<MarvinAsset[]>;
+    /**
+     * Convenience: Get all videos
+     */
+    videos(options?: Omit<GetAssetsOptions, 'type'>): Promise<MarvinAsset[]>;
+    /**
+     * Convenience: Get all documents
+     */
+    documents(options?: Omit<GetAssetsOptions, 'type'>): Promise<MarvinAsset[]>;
+}
+
+/**
+ * Collection - Rich object representing a single collection
+ */
+
+declare class Collection {
+    private data;
+    private http;
+    private workspaceSlug;
+    constructor(data: MarvinCollection, http: MarvinHttpClient, workspaceSlug: string);
+    get id(): string;
+    get name(): string;
+    get slug(): string;
+    get description(): string | undefined;
+    get icon(): string | undefined;
+    get color(): string | undefined;
+    get sortOrder(): number;
+    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
+     */
+    toJSON(): MarvinCollection;
+}
+
+/**
+ * Collections Module - Manage collections
+ */
+
+declare class CollectionsModule {
+    private http;
+    private workspaceSlug;
+    constructor(http: MarvinHttpClient, workspaceSlug: string);
+    /**
+     * Get all collections
+     */
+    list(): Promise<MarvinCollection[]>;
+    /**
+     * Get a single collection by slug
+     */
+    get(slug: string): Promise<Collection>;
+    /**
+     * Get entries in a collection
+     */
+    entries(slug: string): Promise<MarvinEntry[]>;
+}
+
+declare class Entry {
+    private data;
+    private http;
+    private workspaceSlug;
+    constructor(data: MarvinEntry, http: MarvinHttpClient, workspaceSlug: string);
+    get id(): string;
+    get title(): string;
+    get slug(): string;
+    get summary(): string | undefined;
+    get description(): string | undefined;
+    get contentMarkdown(): string | 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 related entries (future)
+     */
+    relatedEntries(): Promise<MarvinEntry[]>;
+    /**
+     * Get raw entry data
+     */
+    toJSON(): MarvinEntry;
+}
+
+/**
+ * Entries Module - Manage entries
+ */
+
+interface GetEntriesOptions {
+    entryType?: string;
+    collection?: string;
+    limit?: number;
+    offset?: number;
+    status?: string;
+}
+declare class EntriesModule {
+    private http;
+    private workspaceSlug;
+    constructor(http: MarvinHttpClient, workspaceSlug: string);
+    /**
+     * Get all published entries
+     */
+    list(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    /**
+     * Get a single entry by slug
+     */
+    get(slug: string): Promise<Entry>;
+    /**
+     * Convenience: Get all pages
+     */
+    pages(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+    /**
+     * Convenience: Get all blog posts
+     */
+    posts(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+    /**
+     * Convenience: Get all projects
+     */
+    projects(options?: Omit<GetEntriesOptions, 'entryType'>): Promise<MarvinEntry[]>;
+}
+
+/**
+ * Workspace - First-class object representing a Marvin workspace
+ */
+
+declare class Workspace {
+    private http;
+    private _site;
+    private _slug;
+    entries: EntriesModule;
+    collections: CollectionsModule;
+    assets: AssetsModule;
+    resources: ResourcesModule;
+    constructor(http: MarvinHttpClient, slug: string);
+    /**
+     * Get workspace slug
+     */
+    get slug(): string;
+    /**
+     * Get site configuration (cached after first load)
+     */
+    get site(): MarvinSite | null;
+    /**
+     * Load site configuration
+     */
+    loadSite(): Promise<MarvinSite>;
+    /**
+     * Get workspace info (name and slug only)
+     */
+    getInfo(): Promise<{
+        slug: string;
+        name: string;
+    }>;
+    /**
+     * Get workspace settings (future)
+     */
+    settings(): Promise<any>;
+}
+
+declare class MarvinClient {
+    private config;
+    private http;
+    private cache;
+    private workspace;
+    private initialized;
+    constructor(config: MarvinConfig);
+    /**
+     * Initialize the SDK
+     * Preloads site configuration and metadata
+     */
+    initialize(): Promise<void>;
+    /**
+     * Get the workspace object
+     */
+    getWorkspace(): Promise<Workspace>;
+    /**
+     * Get site configuration (cached)
+     */
+    get site(): MarvinSite | null;
+    /**
+     * Get workspace info (name and slug)
+     */
+    getWorkspaceInfo(): Promise<{
+        slug: string;
+        name: string;
+    }>;
+    /**
+     * Get entries module
+     */
+    get entries(): EntriesModule;
+    /**
+     * Get collections module
+     */
+    get collections(): CollectionsModule;
+    /**
+     * Get assets module
+     */
+    get assets(): AssetsModule;
+    /**
+     * Get resources module
+     */
+    get resources(): ResourcesModule;
+    /**
+     * Get a single entry by slug
+     */
+    entry(slug: string): Promise<Entry>;
+    /**
+     * Get a single collection by slug
+     */
+    collection(slug: string): Promise<Collection>;
+    /**
+     * Get all pages
+     */
+    pages(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    /**
+     * Get all blog posts
+     */
+    posts(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    /**
+     * Get all projects
+     */
+    projects(options?: GetEntriesOptions): Promise<MarvinEntry[]>;
+    /**
+     * Get a single resource by slug
+     */
+    resource(slug: string): Promise<Resource>;
+    /**
+     * @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[]>;
+    /**
+     * @deprecated Use workspace.entries.get() instead
+     * Get a single published entry by slug
+     */
+    getEntry(slug: string): Promise<MarvinEntry>;
+    /**
+     * @deprecated Use workspace.collections.list() instead
+     * Get all collections
+     */
+    getCollections(): Promise<MarvinCollection[]>;
+    /**
+     * @deprecated Use workspace.collections.get() instead
+     * Get a single collection by slug
+     */
+    getCollection(slug: string): Promise<MarvinCollection>;
+    /**
+     * @deprecated Use workspace.collections.entries() instead
+     * Get all entries in a collection
+     */
+    getCollectionEntries(slug: string): Promise<MarvinEntry[]>;
+    /**
+     * @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[]>;
+}
+
+/**
+ * Create a Marvin client instance from environment variables
+ *
+ * @param config - Optional configuration overrides
+ * @returns Configured Marvin client
+ *
+ * @example
+ * ```ts
+ * // From environment variables
+ * const marvin = createMarvinClient();
+ *
+ * // With overrides
+ * const marvin = createMarvinClient({
+ *   apiUrl: 'https://marvin.example.com',
+ *   autoInitialize: true
+ * });
+ * ```
+ */
+declare function createMarvinClient(config?: Partial<MarvinConfig>): MarvinClient;
+
+export { Collection, Entry, GetResourcesOptions$1 as GetResourcesOptions, MarvinAsset, MarvinClient, MarvinCollection, type MarvinConfig, MarvinEntry, MarvinEntryType, MarvinResource, MarvinSite, Resource, Workspace, createConfigFromEnv, createMarvinClient };