@knkcs/mediahub-ui 0.1.0

package/dist/testing.d.ts

@@ -0,0 +1,487 @@
+declare interface AIConnectionClient {
+    list(workspaceId: string): Promise<AIConnectionInfo[]>;
+    get(id: string): Promise<AIConnectionInfo>;
+    create(params: {
+        workspaceId: string;
+        name: string;
+        provider: string;
+        endpoint: string;
+        deployment: string;
+        apiVersion: string;
+        baseUrl: string;
+        model: string;
+        apiKey: string;
+        description: string;
+    }): Promise<AIConnectionInfo>;
+    update(id: string, patch: {
+        name?: string;
+        endpoint?: string;
+        deployment?: string;
+        apiVersion?: string;
+        baseUrl?: string;
+        model?: string;
+        apiKey?: string;
+        description?: string;
+        active?: boolean;
+    }): Promise<AIConnectionInfo>;
+    delete(id: string): Promise<void>;
+}
+
+declare interface AIConnectionInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    provider: string;
+    endpoint: string;
+    deployment: string;
+    apiVersion: string;
+    baseUrl: string;
+    model: string;
+    description: string;
+    active: boolean;
+    hasApiKey: boolean;
+}
+
+declare interface AIProcessClient {
+    list(assetTypeId: string): Promise<AIProcessInfo[]>;
+    get(id: string): Promise<AIProcessInfo>;
+    create(params: {
+        assetTypeId: string;
+        connectionId: string;
+        name: string;
+        prompt: string;
+        outputs: {
+            key: string;
+            target: string;
+            metadataAccessor: string;
+        }[];
+        position: number;
+        workspaceId: string;
+    }): Promise<AIProcessInfo>;
+    update(id: string, patch: {
+        connectionId?: string;
+        name?: string;
+        prompt?: string;
+        outputs?: {
+            key: string;
+            target: string;
+            metadataAccessor: string;
+        }[];
+        position?: number;
+        active?: boolean;
+    }): Promise<AIProcessInfo>;
+    delete(id: string): Promise<void>;
+}
+
+declare interface AIProcessInfo {
+    id: string;
+    workspaceId: string;
+    assetTypeId: string;
+    connectionId: string;
+    name: string;
+    prompt: string;
+    outputs: {
+        key: string;
+        target: string;
+        metadataAccessor: string;
+    }[];
+    position: number;
+    active: boolean;
+}
+
+declare interface AIProcessRunInfo {
+    id: string;
+    aiProcessId: string;
+    processName: string;
+    status: "queued" | "running" | "succeeded" | "failed" | string;
+    error: string;
+    startedAt?: Date;
+    finishedAt?: Date;
+}
+
+declare interface AssetClient {
+    list(workspaceId: string, filters: AssetFilters): Promise<Page<AssetInfo>>;
+    get(id: string): Promise<AssetInfo>;
+    create(workspaceId: string, params: CreateAssetParams): Promise<AssetInfo>;
+    update(id: string, patch: {
+        name?: string;
+        description?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<AssetInfo>;
+    delete(id: string): Promise<void>;
+    getUploadUrl(params: GetUploadUrlParams): Promise<UploadTarget>;
+    finalizeUpload(versionId: string): Promise<AssetInfo>;
+    getDownloadUrl(assetId: string, versionId: string): Promise<string>;
+    move(id: string, folderId: string): Promise<AssetInfo>;
+    /**
+     * Changes an asset's status (statushub's integration standard §3).
+     * `fromStatusSlug` is the slug the caller last saw: the server makes the
+     * change against it, so a stale screen is refused as a conflict instead of
+     * overwriting whatever happened in between. Pass `""` when there is
+     * nothing to compare against.
+     */
+    transitionStatus(id: string, fromStatusSlug: string, toStatusSlug: string): Promise<AssetInfo>;
+    enhanceMetadata(id: string): Promise<AssetInfo>;
+    listProcessRuns(assetId: string): Promise<AIProcessRunInfo[]>;
+}
+
+declare interface AssetFilters {
+    folderId?: string;
+    assetTypeId?: string;
+    statusSlug?: string;
+    behavior?: AssetStatusBehavior;
+    search?: string;
+    tagIds?: string[];
+    collectionIds?: string[];
+}
+
+declare interface AssetInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    description: string;
+    statusSlug: string;
+    currentVersion: number;
+    metadata: Record<string, unknown>;
+    assetTypeId: string;
+    folderId: string;
+    createdBy: string;
+    updatedBy: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    versions: AssetVersionInfo[];
+    tagIds: string[];
+    collectionIds: string[];
+    analyzeWithAi: boolean;
+}
+
+declare type AssetStatusBehavior = "unspecified" | "active" | "archived" | "inactive" | "deleted";
+
+declare interface AssetSummaryInfo {
+    id: string;
+    name: string;
+    assetTypeName: string;
+    statusName: string;
+    statusColor: string;
+    createdAt?: Date;
+}
+
+declare interface AssetTypeClient {
+    list(workspaceId: string): Promise<AssetTypeInfo[]>;
+    get(id: string): Promise<AssetTypeInfo>;
+    create(params: {
+        workspaceId: string;
+        name: string;
+        slug: string;
+        description: string;
+        allowedMimeTypes: string[];
+        metadataSchema: string;
+    }): Promise<AssetTypeInfo>;
+    update(id: string, patch: {
+        name?: string;
+        description?: string;
+        allowedMimeTypes?: string[];
+        metadataSchema?: string;
+        active?: boolean;
+    }): Promise<AssetTypeInfo>;
+    delete(id: string): Promise<void>;
+}
+
+declare interface AssetTypeInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    slug: string;
+    description: string;
+    allowedMimeTypes: string[];
+    metadataSchema: string;
+    active: boolean;
+}
+
+declare interface AssetVersionInfo {
+    id: string;
+    versionNumber: number;
+    originalFilename: string;
+    storageKey: string;
+    fileSize: number;
+    mimeType: string;
+    createdBy: string;
+    comment: string;
+    createdAt?: Date;
+}
+
+declare interface AuthzClient {
+    /** Whether the current user holds toggle/grant authority — Owner of the
+     * resource or admin of its workspace (mediahub ADR-0001) — over the
+     * resource. A denial answers false; other failures reject so callers can
+     * fail closed without hiding real errors. */
+    canManage(resourceType: GrantResourceType, resourceId: string): Promise<boolean>;
+}
+
+declare interface CollectionClient {
+    list(workspaceId: string): Promise<CollectionInfo[]>;
+    get(id: string): Promise<CollectionInfo>;
+    create(params: {
+        workspaceId: string;
+        name: string;
+        slug: string;
+        description: string;
+        type: CollectionType;
+        rules: string;
+        /** Create as Restricted (creator-only until Grants are issued). @default false */
+        restricted?: boolean;
+    }): Promise<CollectionInfo>;
+    update(id: string, patch: {
+        name?: string;
+        description?: string;
+        rules?: string;
+    }): Promise<CollectionInfo>;
+    delete(id: string): Promise<void>;
+    addAssets(collectionId: string, assetIds: string[]): Promise<void>;
+    removeAssets(collectionId: string, assetIds: string[]): Promise<void>;
+    /** Toggle the Restricted flag (guardian#53). The server refuses with a
+     * leak-guard conflict when the toggle would create a leak state. */
+    setRestricted(id: string, restricted: boolean): Promise<CollectionInfo>;
+}
+
+declare interface CollectionInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    slug: string;
+    description: string;
+    type: CollectionType;
+    rules: string;
+    /** Restricted collections sever Derived Access: only Grants admit anyone. */
+    restricted: boolean;
+}
+
+declare type CollectionType = "unspecified" | "static" | "smart";
+
+declare interface CreateAssetParams {
+    name: string;
+    description?: string;
+    assetTypeId: string;
+    folderId?: string;
+    metadata?: Record<string, unknown>;
+    analyzeWithAi?: boolean;
+}
+
+/**
+ * The stub `MediahubClients`. Mount them in `MediahubProvider`:
+ *
+ * ```tsx
+ * const clients = createStubMediahubClients();
+ * render(
+ *   <MediahubProvider clients={clients} workspaceId={STUB_WORKSPACE_ID}>
+ *     <AssetLibrary />
+ *   </MediahubProvider>,
+ * );
+ * ```
+ *
+ * Pass `overrides` to replace any method of any sub-client for one test:
+ *
+ * ```ts
+ * createStubMediahubClients({ assets: { delete: vi.fn(async () => {}) } });
+ * ```
+ */
+export declare function createStubMediahubClients(overrides?: StubMediahubOverrides): MediahubClients;
+
+declare interface DashboardClient {
+    getWorkspaceStats(workspaceId: string): Promise<WorkspaceStats>;
+    getDashboardLayout(workspaceId: string): Promise<string>;
+    saveDashboardLayout(workspaceId: string, layoutJson: string): Promise<void>;
+}
+
+declare interface DirectoryClient {
+    resolveUsers(ids: string[]): Promise<UserInfo[]>;
+    /** Every member of the workspace (union of admins and members), resolved
+     * display names, sorted by name. Backs the grant picker; deliberately
+     * unpaginated — the member set is workspace-bounded. */
+    listWorkspaceMembers(workspaceId: string): Promise<UserInfo[]>;
+}
+
+declare interface FolderClient {
+    list(workspaceId: string, parentId: string): Promise<FolderInfo[]>;
+    get(id: string): Promise<FolderInfo>;
+    create(params: {
+        workspaceId: string;
+        name: string;
+        slug: string;
+        parentId: string;
+        /** Create as Restricted (creator-only until Grants are issued). @default false */
+        restricted?: boolean;
+    }): Promise<FolderInfo>;
+    update(id: string, name: string): Promise<FolderInfo>;
+    delete(id: string): Promise<void>;
+    move(id: string, parentId: string): Promise<FolderInfo>;
+    /** Toggle the Restricted flag (guardian#53). The server refuses with a
+     * leak-guard conflict when the toggle would create a leak state. */
+    setRestricted(id: string, restricted: boolean): Promise<FolderInfo>;
+}
+
+declare interface FolderInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    slug: string;
+    parentId: string;
+    /** Restricted folders sever Derived Access: only Grants admit anyone. */
+    restricted: boolean;
+}
+
+declare interface GetUploadUrlParams {
+    assetId: string;
+    filename: string;
+    contentType: string;
+    fileSize: number;
+    comment?: string;
+}
+
+/** Manages explicit Grants on assets, folders, and collections. Every call —
+ * mutations and roster reads alike — requires owner on the resource or admin
+ * on its workspace; the server answers PermissionDenied otherwise. */
+declare interface GrantClient {
+    list(resourceType: GrantResourceType, resourceId: string): Promise<GrantRoster>;
+    /** Upserts: a user holds at most one Grant per resource, so granting
+     * replaces any existing Grant at whatever level it had. */
+    grant(resourceType: GrantResourceType, resourceId: string, userId: string, level: GrantLevel): Promise<void>;
+    /** Level-less and idempotent: removes whatever the user held. */
+    revoke(resourceType: GrantResourceType, resourceId: string, userId: string): Promise<void>;
+}
+
+/** One explicit Grant on a roster: a named user holding a grantable level. */
+declare interface GrantEntry {
+    userId: string;
+    level: GrantLevel;
+}
+
+/** A grantable relation. Ownership is structural and never grantable. */
+declare type GrantLevel = "viewer" | "editor";
+
+/** The kinds of resource a Grant applies to (guardian#52). */
+declare type GrantResourceType = "asset" | "folder" | "collection";
+
+/** A resource's roster: the structural Owner plus explicit Grants only —
+ * Derived Access (workspace membership, folder chains, collection
+ * membership) is deliberately absent. */
+declare interface GrantRoster {
+    /** Empty for resources created before their owner tuples were
+     * backfilled — render no Owner row rather than an empty name. */
+    ownerUserId: string;
+    grants: GrantEntry[];
+}
+
+declare interface MediahubClients {
+    assets: AssetClient;
+    folders: FolderClient;
+    collections: CollectionClient;
+    tags: TagClient;
+    assetTypes: AssetTypeClient;
+    directory: DirectoryClient;
+    grants: GrantClient;
+    dashboard: DashboardClient;
+    aiConnection: AIConnectionClient;
+    aiProcess: AIProcessClient;
+    authz: AuthzClient;
+}
+
+declare interface Page<T> {
+    items: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+
+declare interface StatusCountInfo {
+    statusSlug: string;
+    name: string;
+    color: string;
+    behavior: string;
+    count: number;
+}
+
+export declare const STUB_NOW: Date;
+
+export declare const STUB_USER_ID = "user_1";
+
+export declare const STUB_WORKSPACE_ID = "ws_1";
+
+export declare function stubAIConnection(overrides?: Partial<AIConnectionInfo>): AIConnectionInfo;
+
+export declare function stubAIProcess(overrides?: Partial<AIProcessInfo>): AIProcessInfo;
+
+export declare function stubAIProcessRun(overrides?: Partial<AIProcessRunInfo>): AIProcessRunInfo;
+
+export declare function stubAsset(overrides?: Partial<AssetInfo>): AssetInfo;
+
+export declare function stubAssetType(overrides?: Partial<AssetTypeInfo>): AssetTypeInfo;
+
+export declare function stubAssetVersion(overrides?: Partial<AssetVersionInfo>): AssetVersionInfo;
+
+export declare function stubCollection(overrides?: Partial<CollectionInfo>): CollectionInfo;
+
+export declare function stubFolder(overrides?: Partial<FolderInfo>): FolderInfo;
+
+export declare function stubGrantRoster(overrides?: Partial<GrantRoster>): GrantRoster;
+
+/** Per-client replacements for any method — a rejection, a spy, a different payload. */
+export declare interface StubMediahubOverrides {
+    assets?: Partial<AssetClient>;
+    folders?: Partial<FolderClient>;
+    collections?: Partial<CollectionClient>;
+    tags?: Partial<TagClient>;
+    assetTypes?: Partial<AssetTypeClient>;
+    directory?: Partial<DirectoryClient>;
+    grants?: Partial<GrantClient>;
+    dashboard?: Partial<DashboardClient>;
+    aiConnection?: Partial<AIConnectionClient>;
+    aiProcess?: Partial<AIProcessClient>;
+    authz?: Partial<AuthzClient>;
+}
+
+export declare function stubTag(overrides?: Partial<TagInfo>): TagInfo;
+
+export declare function stubUser(overrides?: Partial<UserInfo>): UserInfo;
+
+export declare function stubWorkspaceStats(overrides?: Partial<WorkspaceStats>): WorkspaceStats;
+
+declare interface TagClient {
+    list(workspaceId: string): Promise<TagInfo[]>;
+    create(params: {
+        workspaceId: string;
+        name: string;
+        slug: string;
+    }): Promise<TagInfo>;
+    update(id: string, name: string): Promise<TagInfo>;
+    delete(id: string): Promise<void>;
+    tagAssets(tagId: string, assetIds: string[]): Promise<void>;
+    untagAssets(tagId: string, assetIds: string[]): Promise<void>;
+}
+
+declare interface TagInfo {
+    id: string;
+    workspaceId: string;
+    name: string;
+    slug: string;
+}
+
+declare interface UploadTarget {
+    uploadUrl: string;
+    versionId: string;
+}
+
+declare interface UserInfo {
+    id: string;
+    displayName: string;
+}
+
+declare interface WorkspaceStats {
+    totalAssets: number;
+    totalStorageBytes: number;
+    statusCounts: StatusCountInfo[];
+    recentUploads: AssetSummaryInfo[];
+}
+
+export { }