@inneropen/marvin-sdk 2.0.0-next.22 → 2.0.0-next.24

package/dist/types/index.d.cts

@@ -4,81 +4,54 @@
  * TypeScript types for the Marvin publishing API responses.
  */
 interface MarvinSite {
-    id: string;
-    name: string;
-    slug: string;
-    title?: string;
-    tagline?: string;
-    description?: string;
-    canonicalUrl?: string;
-    logo?: string;
-    favicon?: string;
-    locale?: string;
-    timezone?: string;
-    metadata?: Record<string, unknown>;
+    workspace: {
+        slug: string;
+        name: string;
+    };
+    site: {
+        title?: string | null;
+        tagline?: string | null;
+        description?: string | null;
+        canonicalUrl?: string | null;
+        logo?: string | null;
+        favicon?: string | null;
+        locale: string;
+        timezone: string;
+        contactEmail?: string | null;
+        social?: Record<string, unknown> | null;
+        metadataJson?: Record<string, unknown> | null;
+    };
 }
 interface MarvinEntryType {
     id: string;
+    groupId: string | null;
     name: string;
     slug: string;
-    icon?: string;
-    color?: string;
-    description?: string;
+    icon?: string | null;
+    color?: string | null;
+    description?: string | null;
     sortOrder: number;
     isSystem: boolean;
-    /**
-     * Schema definition for this entry type (schema-driven content model).
-     * Defines what fields exist, their types, and validation rules.
-     * @since 2.0.0
-     */
-    schemaJson?: Record<string, unknown>;
-    rendering?: {
-        renderer?: string;
-        package?: string;
-        version?: string;
-        config?: Record<string, unknown>;
-    };
-    capabilities?: {
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
+    isRendered: boolean;
+    schemaJson?: Record<string, unknown> | null;
+    renderingJson?: Record<string, unknown> | null;
+    capabilitiesJson?: Record<string, unknown> | null;
+    createdAt?: string | null;
+    updateAt?: string | null;
+    warnings?: string[] | null;
 }
 interface MarvinAsset {
-    id: string;
-    slug: string;
-    name: string;
-    originalFilename: string;
-    filename: string;
-    extension: string;
-    mimeType: string;
-    assetType: 'image' | 'document' | 'video' | 'audio' | 'archive' | 'svg' | 'other';
-    fileSize: number;
-    checksum: string;
-    width?: number;
-    height?: number;
-    orientation?: number;
-    storageProvider: string;
-    storageKey: string;
-    publicUrl?: string;
-    altText?: string;
-    description?: string;
-    metadata?: Record<string, unknown>;
-    uploadedBy: string;
-    createdAt: string;
-    updatedAt: string;
-}
-interface PublishedAsset {
     slug: string;
     name: string;
     mimeType: string;
     assetType: string;
     fileSize: number;
-    width?: number;
-    height?: number;
-    altText?: string;
-    description?: string;
+    width?: number | null;
+    height?: number | null;
+    altText?: string | null;
+    description?: string | null;
     publicUrl: string;
+    metadataJson?: Record<string, unknown> | null;
 }
 interface AssetUploadRequest {
     slug: string;
@@ -88,72 +61,101 @@ interface AssetUploadRequest {
     metadata?: Record<string, unknown>;
 }
 interface MarvinCollection {
-    id: string;
-    name: string;
     slug: string;
-    description?: string;
-    icon?: string;
-    color?: string;
-    sortOrder: number;
+    name: string;
+    description?: string | null;
     isSmart: boolean;
-    smartRules?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-    entryCount?: number;
-    entries?: MarvinEntry[];
+    smartRules?: Record<string, unknown> | null;
+    metadataJson?: Record<string, unknown> | null;
+    entryCount: number;
+    entries: MarvinEntryListItem[];
 }
 interface MarvinResource {
-    id: string;
+    slug: string;
     name: string;
+    resourceType: string;
+    description?: string | null;
+    url?: string | null;
+    externalId?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    entries: string[];
+}
+interface PublishedCollectionSummary {
     slug: string;
-    resourceType?: string;
-    description?: string;
-    externalId?: string;
-    url?: string;
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
+    name: string;
+    metadataJson?: Record<string, unknown> | null;
+    sortOrder: number;
 }
-interface MarvinEntry {
-    id: string;
-    title: string;
+interface PublishedResourceRead {
     slug: string;
-    summary?: string;
-    description?: string;
-    /**
-     * Schema-driven content data structured according to entry type's schemaJson.
-     * @since 2.0.0
-     */
-    dataJson?: Record<string, unknown>;
-    /**
-     * @deprecated Use dataJson instead. Will be removed in v3.0.0
-     * @since 1.x
-     */
-    contentMarkdown?: string;
-    /**
-     * Custom non-schema metadata (API keys, external IDs, CMS-specific config).
-     * For content fields, use dataJson instead.
-     */
-    metadata?: Record<string, unknown>;
+    name: string;
+    resourceType: string;
+    description?: string | null;
+    url?: string | null;
+    externalId?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    role?: string | null;
+    quantity?: string | null;
+    unit?: string | null;
+    position: number;
+}
+interface PublishedAssetRead {
+    slug: string;
+    name: string;
+    mimeType: string;
+    assetType: string;
+    fileSize: number;
+    width?: number | null;
+    height?: number | null;
+    altText?: string | null;
+    description?: string | null;
+    publicUrl: string;
+    metadataJson?: Record<string, unknown> | null;
+}
+interface MarvinEntryListItem {
+    slug: string;
+    title: string;
+    entryType: string;
+    entryTypeInfo?: {
+        slug: string;
+        renderer?: string | null;
+        package?: string | null;
+        version?: string | null;
+        config?: Record<string, unknown> | null;
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
+    summary?: string | null;
+    publishedAt?: string | null;
     status: string;
-    publishedAt?: string;
-    createdAt: string;
-    updatedAt: string;
+    collections: string[];
+    assetSlugs: string[];
+    resourceSlugs: string[];
+    order?: number | null;
+}
+interface MarvinEntry {
+    slug: string;
+    title: string;
+    entryType: string;
     entryTypeInfo?: {
         slug: string;
-        renderer?: string;
-        package?: string;
-        version?: string;
-        config?: Record<string, unknown>;
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
-    entryTypeId: string;
-    entryType?: MarvinEntryType;
-    collections?: MarvinCollection[];
-    assets?: MarvinAsset[];
-    resources?: MarvinResource[];
+        renderer?: string | null;
+        package?: string | null;
+        version?: string | null;
+        config?: Record<string, unknown> | null;
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
+    summary?: string | null;
+    data: Record<string, unknown>;
+    publishedAt?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    collections: PublishedCollectionSummary[];
+    resources: PublishedResourceRead[];
+    assets: PublishedAssetRead[];
+    order?: number | null;
 }
 interface MarvinPublishResponse<T> {
     data: T;
@@ -191,23 +193,19 @@ interface PublishedEntryType {
         config?: Record<string, unknown>;
     };
     capabilities?: {
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
 }
 interface GetResourcesOptions {
     resourceType?: string;
     limit?: number;
     offset?: number;
 }
-/**
- * Authentication token response
- * Used by auth.login() and auth.refresh()
- */
 interface AuthToken {
     accessToken: string;
     tokenType: string;
 }
 
-export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAsset, PublishedEntryType };
+export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryListItem, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAssetRead, PublishedCollectionSummary, PublishedEntryType, PublishedResourceRead };

package/dist/types/index.d.ts

@@ -4,81 +4,54 @@
  * TypeScript types for the Marvin publishing API responses.
  */
 interface MarvinSite {
-    id: string;
-    name: string;
-    slug: string;
-    title?: string;
-    tagline?: string;
-    description?: string;
-    canonicalUrl?: string;
-    logo?: string;
-    favicon?: string;
-    locale?: string;
-    timezone?: string;
-    metadata?: Record<string, unknown>;
+    workspace: {
+        slug: string;
+        name: string;
+    };
+    site: {
+        title?: string | null;
+        tagline?: string | null;
+        description?: string | null;
+        canonicalUrl?: string | null;
+        logo?: string | null;
+        favicon?: string | null;
+        locale: string;
+        timezone: string;
+        contactEmail?: string | null;
+        social?: Record<string, unknown> | null;
+        metadataJson?: Record<string, unknown> | null;
+    };
 }
 interface MarvinEntryType {
     id: string;
+    groupId: string | null;
     name: string;
     slug: string;
-    icon?: string;
-    color?: string;
-    description?: string;
+    icon?: string | null;
+    color?: string | null;
+    description?: string | null;
     sortOrder: number;
     isSystem: boolean;
-    /**
-     * Schema definition for this entry type (schema-driven content model).
-     * Defines what fields exist, their types, and validation rules.
-     * @since 2.0.0
-     */
-    schemaJson?: Record<string, unknown>;
-    rendering?: {
-        renderer?: string;
-        package?: string;
-        version?: string;
-        config?: Record<string, unknown>;
-    };
-    capabilities?: {
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
+    isRendered: boolean;
+    schemaJson?: Record<string, unknown> | null;
+    renderingJson?: Record<string, unknown> | null;
+    capabilitiesJson?: Record<string, unknown> | null;
+    createdAt?: string | null;
+    updateAt?: string | null;
+    warnings?: string[] | null;
 }
 interface MarvinAsset {
-    id: string;
-    slug: string;
-    name: string;
-    originalFilename: string;
-    filename: string;
-    extension: string;
-    mimeType: string;
-    assetType: 'image' | 'document' | 'video' | 'audio' | 'archive' | 'svg' | 'other';
-    fileSize: number;
-    checksum: string;
-    width?: number;
-    height?: number;
-    orientation?: number;
-    storageProvider: string;
-    storageKey: string;
-    publicUrl?: string;
-    altText?: string;
-    description?: string;
-    metadata?: Record<string, unknown>;
-    uploadedBy: string;
-    createdAt: string;
-    updatedAt: string;
-}
-interface PublishedAsset {
     slug: string;
     name: string;
     mimeType: string;
     assetType: string;
     fileSize: number;
-    width?: number;
-    height?: number;
-    altText?: string;
-    description?: string;
+    width?: number | null;
+    height?: number | null;
+    altText?: string | null;
+    description?: string | null;
     publicUrl: string;
+    metadataJson?: Record<string, unknown> | null;
 }
 interface AssetUploadRequest {
     slug: string;
@@ -88,72 +61,101 @@ interface AssetUploadRequest {
     metadata?: Record<string, unknown>;
 }
 interface MarvinCollection {
-    id: string;
-    name: string;
     slug: string;
-    description?: string;
-    icon?: string;
-    color?: string;
-    sortOrder: number;
+    name: string;
+    description?: string | null;
     isSmart: boolean;
-    smartRules?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-    entryCount?: number;
-    entries?: MarvinEntry[];
+    smartRules?: Record<string, unknown> | null;
+    metadataJson?: Record<string, unknown> | null;
+    entryCount: number;
+    entries: MarvinEntryListItem[];
 }
 interface MarvinResource {
-    id: string;
+    slug: string;
     name: string;
+    resourceType: string;
+    description?: string | null;
+    url?: string | null;
+    externalId?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    entries: string[];
+}
+interface PublishedCollectionSummary {
     slug: string;
-    resourceType?: string;
-    description?: string;
-    externalId?: string;
-    url?: string;
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
+    name: string;
+    metadataJson?: Record<string, unknown> | null;
+    sortOrder: number;
 }
-interface MarvinEntry {
-    id: string;
-    title: string;
+interface PublishedResourceRead {
     slug: string;
-    summary?: string;
-    description?: string;
-    /**
-     * Schema-driven content data structured according to entry type's schemaJson.
-     * @since 2.0.0
-     */
-    dataJson?: Record<string, unknown>;
-    /**
-     * @deprecated Use dataJson instead. Will be removed in v3.0.0
-     * @since 1.x
-     */
-    contentMarkdown?: string;
-    /**
-     * Custom non-schema metadata (API keys, external IDs, CMS-specific config).
-     * For content fields, use dataJson instead.
-     */
-    metadata?: Record<string, unknown>;
+    name: string;
+    resourceType: string;
+    description?: string | null;
+    url?: string | null;
+    externalId?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    role?: string | null;
+    quantity?: string | null;
+    unit?: string | null;
+    position: number;
+}
+interface PublishedAssetRead {
+    slug: string;
+    name: string;
+    mimeType: string;
+    assetType: string;
+    fileSize: number;
+    width?: number | null;
+    height?: number | null;
+    altText?: string | null;
+    description?: string | null;
+    publicUrl: string;
+    metadataJson?: Record<string, unknown> | null;
+}
+interface MarvinEntryListItem {
+    slug: string;
+    title: string;
+    entryType: string;
+    entryTypeInfo?: {
+        slug: string;
+        renderer?: string | null;
+        package?: string | null;
+        version?: string | null;
+        config?: Record<string, unknown> | null;
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
+    summary?: string | null;
+    publishedAt?: string | null;
     status: string;
-    publishedAt?: string;
-    createdAt: string;
-    updatedAt: string;
+    collections: string[];
+    assetSlugs: string[];
+    resourceSlugs: string[];
+    order?: number | null;
+}
+interface MarvinEntry {
+    slug: string;
+    title: string;
+    entryType: string;
     entryTypeInfo?: {
         slug: string;
-        renderer?: string;
-        package?: string;
-        version?: string;
-        config?: Record<string, unknown>;
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
-    entryTypeId: string;
-    entryType?: MarvinEntryType;
-    collections?: MarvinCollection[];
-    assets?: MarvinAsset[];
-    resources?: MarvinResource[];
+        renderer?: string | null;
+        package?: string | null;
+        version?: string | null;
+        config?: Record<string, unknown> | null;
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
+    summary?: string | null;
+    data: Record<string, unknown>;
+    publishedAt?: string | null;
+    metadataJson?: Record<string, unknown> | null;
+    collections: PublishedCollectionSummary[];
+    resources: PublishedResourceRead[];
+    assets: PublishedAssetRead[];
+    order?: number | null;
 }
 interface MarvinPublishResponse<T> {
     data: T;
@@ -191,23 +193,19 @@ interface PublishedEntryType {
         config?: Record<string, unknown>;
     };
     capabilities?: {
-        publishable?: boolean;
-        submittable?: boolean;
-        routable?: boolean;
-    };
+        publishable: boolean;
+        submittable: boolean;
+        routable: boolean;
+    } | null;
 }
 interface GetResourcesOptions {
     resourceType?: string;
     limit?: number;
     offset?: number;
 }
-/**
- * Authentication token response
- * Used by auth.login() and auth.refresh()
- */
 interface AuthToken {
     accessToken: string;
     tokenType: string;
 }
 
-export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAsset, PublishedEntryType };
+export type { AssetUploadRequest, AuthToken, GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryListItem, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite, PublishedAssetRead, PublishedCollectionSummary, PublishedEntryType, PublishedResourceRead };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inneropen/marvin-sdk",
-  "version": "2.0.0-next.22",
+  "version": "2.0.0-next.24",
   "description": "Official TypeScript SDK for Marvin CMS",
   "type": "module",
   "main": "./dist/index.cjs",