@noya-app/noya-api-client-react 0.1.35 → 0.1.37

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { NoyaAPI } from '@noya-app/noya-api';
 export * from '@noya-app/noya-api';
-import * as _noya_app_noya_sketch_file from '@noya-app/noya-sketch-file';
-import * as _noya_app_noya_component from '@noya-app/noya-component';
+import { Static } from '@noya-app/noya-multiplayer-react';
+import { Resource, ActivityEvent } from '@noya-app/noya-schemas';
+import { SelectConfig, SelectedShape } from '@noya-app/observable';
+import { Table, EntitySchema, TableFetchOptions, RefetchFunction } from '@noya-app/observable-store';
 
 type NoyaAPIContextValue = NoyaAPI.Client;
 declare const NoyaAPIProvider: React.Provider<NoyaAPIContextValue | undefined>;
@@ -13,109 +15,30 @@ declare function useOptionalNoyaClient(): NoyaAPIContextValue | undefined;
  */
 declare function useNoyaClientOrFallback(): NoyaAPIContextValue;
 
-declare function useNoyaFiles(): {
-    files: NoyaAPI.File[];
-    loading: boolean;
-    reload: () => Promise<void>;
-};
-declare function useNoyaFile(fileId?: string): {
-    data: {
-        document: _noya_app_noya_component.DS;
-        schemaVersion: "0.1.0";
-    } | {
-        document: _noya_app_noya_sketch_file.SketchFile;
-        schemaVersion: "0.1.0";
-    } | {
-        schemaVersion: "0.1.0";
-        document?: unknown;
-    } | {
-        schemaVersion: "0.1.0";
-        document?: unknown;
-    } | {
-        schemaVersion: "0.1.0";
-        document?: unknown;
-    };
-    icon: string | null;
-    name: string | null;
-    version: number;
-    id: string;
-    description: string | null;
-    toolId: string;
-    createdAt: string;
-    updatedAt: string;
-    access: "private" | "read" | "write";
-    workspaceAccess: "private" | "read" | "write";
-    workspaceId: string;
-    inputs: ({
-        required: boolean;
-        name: string;
-        id: string;
-        description: string | null;
-        kind: "file";
-        toolId: string | null;
-        stableId: string;
-    } | {
-        required: boolean;
-        name: string;
-        id: string;
-        description: string | null;
-        kind: "data";
-        stableId: string;
-        schema?: any;
-    } | {
-        required: boolean;
-        name: string;
-        id: string;
-        description: string | null;
-        kind: "secret";
-        stableId: string;
-        authProvider: "github" | "figma" | null;
-        authScope: string | null;
-    })[];
-    user?: {
-        name: string | null;
-        image: string | null;
-    } | undefined;
-    tool?: {
-        name: string;
-        id: string;
-    } | undefined;
-    userId?: string | undefined;
-    accessibleByFiles?: any[] | undefined;
-    accessibleFiles?: any[] | undefined;
-    primarySite?: {
-        url: string;
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        subdomain: string | null;
-    } | null | undefined;
-} | undefined;
-declare function useNoyaIsOwnFile(fileId?: string): boolean;
 declare function useNoyaTools(initial?: NoyaAPI.Tool[]): {
     tools: {
         addedById?: string | undefined;
+        id: string;
         name: string;
+        createdAt: string;
         url: string;
-        id: string;
         description: string | null;
+        updatedAt: string;
         tags: {
             toolCount?: number | undefined;
-            name: string;
             id: string;
+            name: string;
             rank: number;
         }[];
-        createdAt: string;
-        updatedAt: string;
+        assets: string[];
         slug: string | null;
         tagline: string | null;
-        assets: string[];
         homepageUrl: string | null;
         platform: "noya" | "external";
         verificationStatus: "pending" | "approved" | "rejected";
         creator: {
-            name: string;
             id: string;
+            name: string;
             image: string | null;
             slug: string | null;
         } | null;
@@ -125,27 +48,27 @@ declare function useNoyaTools(initial?: NoyaAPI.Tool[]): {
 declare function useOptionalNoyaTools(initial?: NoyaAPI.Tool[]): {
     tools: {
         addedById?: string | undefined;
+        id: string;
         name: string;
+        createdAt: string;
         url: string;
-        id: string;
         description: string | null;
+        updatedAt: string;
         tags: {
             toolCount?: number | undefined;
-            name: string;
             id: string;
+            name: string;
             rank: number;
         }[];
-        createdAt: string;
-        updatedAt: string;
+        assets: string[];
         slug: string | null;
         tagline: string | null;
-        assets: string[];
         homepageUrl: string | null;
         platform: "noya" | "external";
         verificationStatus: "pending" | "approved" | "rejected";
         creator: {
-            name: string;
             id: string;
+            name: string;
             image: string | null;
             slug: string | null;
         } | null;
@@ -155,8 +78,8 @@ declare function useOptionalNoyaTools(initial?: NoyaAPI.Tool[]): {
 declare function useNoyaTags(): {
     tags: {
         toolCount?: number | undefined;
-        name: string;
         id: string;
+        name: string;
         rank: number;
     }[];
     loading: boolean;
@@ -164,16 +87,16 @@ declare function useNoyaTags(): {
 declare function useOptionalNoyaTags(): {
     tags: {
         toolCount?: number | undefined;
-        name: string;
         id: string;
+        name: string;
         rank: number;
     }[];
     loading: boolean;
 };
 declare function useNoyaCreators(): {
     creators: {
-        name: string;
         id: string;
+        name: string;
         image: string | null;
         slug: string | null;
     }[];
@@ -181,8 +104,8 @@ declare function useNoyaCreators(): {
 };
 declare function useOptionalNoyaCreators(): {
     creators: {
-        name: string;
         id: string;
+        name: string;
         image: string | null;
         slug: string | null;
     }[];
@@ -190,8 +113,25 @@ declare function useOptionalNoyaCreators(): {
 };
 declare function useNoyaAssets(fileId?: string): {
     assets: {
+        width: number | null;
+        height: number | null;
         id: string;
         createdAt: string;
+        userId: string | null;
+        url?: string | undefined;
+        size?: number | undefined;
+        contentType?: string | undefined;
+    }[];
+    loading: boolean;
+};
+declare function useNoyaAssetsByFileVersionId(fileVersionId: string): {
+    assets: {
+        width: number | null;
+        height: number | null;
+        id: string;
+        createdAt: string;
+        userId: string | null;
+        url?: string | undefined;
         size?: number | undefined;
         contentType?: string | undefined;
     }[];
@@ -199,40 +139,41 @@ declare function useNoyaAssets(fileId?: string): {
 };
 declare function useNoyaSecrets(fileId?: string): {
     secrets: {
-        name: string;
         id: string;
-        stableId: string;
+        name: string;
         fileId: string;
+        stableId: string;
     }[];
     loading: boolean;
 };
 declare function useNoyaSession(): {
     user: {
-        name: string | null;
         id: string;
-        image: string | null;
+        name: string | null;
         email: string | null;
+        image: string | null;
     };
     expires: string;
 } | null;
 declare function useOptionalNoyaSession(): {
     user: {
-        name: string | null;
         id: string;
-        image: string | null;
+        name: string | null;
         email: string | null;
+        image: string | null;
     };
     expires: string;
 } | null | undefined;
 declare function useNoyaBilling(): {
     subscriptions: {
+        id: string;
         items: {
             id: string;
             created: string;
             price: {
                 type: string;
-                active: boolean;
                 id: string;
+                active: boolean;
                 currency: string;
                 nickname: string | null;
                 recurringInterval: string;
@@ -243,7 +184,6 @@ declare function useNoyaBilling(): {
             };
             quantity: number;
         }[];
-        id: string;
         status: string;
         currency: string;
         created: string;
@@ -258,15 +198,15 @@ declare function useNoyaBilling(): {
     }[];
     portalUrl: string | null;
     availableProducts: {
-        active: boolean;
-        name: string;
         id: string;
+        name: string;
         description: string | null;
+        active: boolean;
         created: string;
         prices: {
             type: string;
-            active: boolean;
             id: string;
+            active: boolean;
             currency: string;
             nickname: string | null;
             recurringInterval: string;
@@ -287,9 +227,9 @@ declare function useNoyaWorkspaceBilling(workspaceId: string): {
 };
 declare function useNoyaEmailLists(): {
     emailLists: {
+        id: string;
         name: string;
         url: string;
-        id: string;
         description: string | null;
         optIn: boolean;
     }[];
@@ -303,9 +243,9 @@ declare function useNoyaUserData(): {
             value?: unknown;
         }[];
         emailLists: {
+            id: string;
             name: string;
             url: string;
-            id: string;
             description: string | null;
             optIn: boolean;
         }[];
@@ -322,9 +262,9 @@ declare function useOptionalNoyaUserData(): {
             value?: unknown;
         }[];
         emailLists: {
+            id: string;
             name: string;
             url: string;
-            id: string;
             description: string | null;
             optIn: boolean;
         }[];
@@ -351,14 +291,14 @@ declare function useGeneratedComponentDescription(name: string): {
 };
 declare function useRandomImages(): {
     images: Record<string, {
+        metadata: {
+            color: string;
+        };
         url: string;
         source: {
             name: string;
             url: string;
         };
-        metadata: {
-            color: string;
-        };
         user: {
             name: string;
             url: string;
@@ -393,16 +333,24 @@ declare function useGeneratedPageNames(): EnhancedGeneratedPageName[];
 declare function useGeneratedPageComponentNames(): EnhancedGeneratedPageName[];
 declare function useNoyaSites(): {
     sites: {
-        url?: string | null | undefined;
+        publishedDeploymentId?: string | null | undefined;
+        publishedDeployment?: {
+            id: string;
+            createdAt: string;
+            fileVersionId: string | null;
+            siteId: string;
+            updatedAt: string;
+        } | undefined;
         id: string;
+        subdomain: string | null;
         createdAt: string;
         updatedAt: string;
-        subdomain: string | null;
         deployments: {
             id: string;
             createdAt: string;
-            updatedAt: string;
+            fileVersionId: string | null;
             siteId: string;
+            updatedAt: string;
         }[];
     }[];
     loading: boolean;
@@ -411,23 +359,32 @@ declare function useNoyaDeployments(): {
     deployments: {
         id: string;
         createdAt: string;
-        updatedAt: string;
+        fileVersionId: string | null;
         siteId: string;
+        updatedAt: string;
     }[];
     loading: boolean;
 };
 declare function useNoyaSite(siteId: string): {
     site: {
-        url?: string | null | undefined;
+        publishedDeploymentId?: string | null | undefined;
+        publishedDeployment?: {
+            id: string;
+            createdAt: string;
+            fileVersionId: string | null;
+            siteId: string;
+            updatedAt: string;
+        } | undefined;
         id: string;
+        subdomain: string | null;
         createdAt: string;
         updatedAt: string;
-        subdomain: string | null;
         deployments: {
             id: string;
             createdAt: string;
-            updatedAt: string;
+            fileVersionId: string | null;
             siteId: string;
+            updatedAt: string;
         }[];
     };
 };
@@ -435,8 +392,8 @@ declare function useNoyaPersonalAccessTokens(): {
     personalAccessTokens: {
         token?: string | undefined;
         rawToken?: string | undefined;
-        name: string;
         id: string;
+        name: string;
         createdAt: string;
         lastUsedAt: string | null;
     }[];
@@ -444,36 +401,39 @@ declare function useNoyaPersonalAccessTokens(): {
 };
 declare function useNoyaWorkspaces(): {
     workspaces: {
-        name: string;
         id: string;
+        name: string;
         createdAt: string;
         updatedAt: string;
         members: {
             id: string;
+            createdAt: string;
+            workspaceId: string;
+            userId: string;
+            updatedAt: string;
             role: "OWNER" | "ADMIN" | "MEMBER";
             user: {
-                name: string | null;
                 id: string;
-                image: string | null;
+                name: string | null;
                 email: string | null;
+                image: string | null;
             };
-            createdAt: string;
-            userId: string;
-            updatedAt: string;
-            workspaceId: string;
         }[];
     }[];
     loading: boolean;
 };
+declare function useNoyaMultiplayerRoomToken(fileId: string): {
+    access: "read" | "write";
+} | undefined;
 declare function useNoyaWorkspaceInvitations(workspaceId: string): {
     invitations: {
         id: string;
-        role: "OWNER" | "ADMIN" | "MEMBER";
         email: string;
-        token: string;
         createdAt: string;
-        updatedAt: string;
         workspaceId: string;
+        updatedAt: string;
+        role: "OWNER" | "ADMIN" | "MEMBER";
+        token: string;
         invitedById: string;
         acceptedAt: string | null;
         expiresAt: string | null;
@@ -482,48 +442,87 @@ declare function useNoyaWorkspaceInvitations(workspaceId: string): {
 };
 declare function useNoyaOwnedFileVersions(fileId: string): {
     fileVersions: NoyaAPI.FileVersion[];
-    loading: NoyaAPI.DataLoadingState;
+    loading: NoyaAPI.FetchStatus;
     reload: () => Promise<void>;
 };
 declare function useNoyaTemplates(): {
     templates: {
-        name: string;
         id: string;
-        description: string | null;
-        status: "pending" | "approved" | "rejected";
-        createdAt: string;
-        updatedAt: string;
-        workspaceId: string;
-        fileId: string | null;
-        fileVersionId: string;
-        createdByUserId: string;
+        name: string;
         fileVersion: {
             data?: any;
-            icon: string | null;
-            name: string;
-            version: number;
             id: string;
-            description: string | null;
-            toolId: string;
+            name: string;
             createdAt: string;
+            fileId: string | null;
             userId: string;
+            toolId: string;
+            description: string | null;
             updatedAt: string;
+            icon: string | null;
+            version: number;
             access: "private" | "read" | "write";
-            fileId: string | null;
             dataCid: string;
             ownedByFileId: string | null;
         };
+        createdAt: string;
+        workspaceId: string;
         workspace: {
-            name: string;
             id: string;
+            name: string;
         };
+        fileId: string | null;
+        fileVersionId: string;
+        description: string | null;
+        updatedAt: string;
+        status: "pending" | "approved" | "rejected";
+        createdByUserId: string;
         createdByUser: {
-            name: string | null;
             id: string;
+            name: string | null;
             image: string | null;
         };
     }[];
     loading: boolean;
 };
 
-export { type EnhancedGeneratedPageName, NoyaAPIProvider, useGeneratedComponentDescription, useGeneratedComponentDescriptions, useGeneratedComponentNames, useGeneratedPageComponentNames, useGeneratedPageNames, useIsBeta, useMetadata, useNetworkRequests, useNoyaAssets, useNoyaBilling, useNoyaClient, useNoyaClientOrFallback, useNoyaCreators, useNoyaDeployments, useNoyaEmailLists, useNoyaFile, useNoyaFiles, useNoyaIsOwnFile, useNoyaOwnedFileVersions, useNoyaPersonalAccessTokens, useNoyaSecrets, useNoyaSession, useNoyaSite, useNoyaSites, useNoyaTags, useNoyaTemplates, useNoyaTools, useNoyaUserData, useNoyaWorkspaceBilling, useNoyaWorkspaceInvitations, useNoyaWorkspaces, useOptionalNoyaClient, useOptionalNoyaCreators, useOptionalNoyaSession, useOptionalNoyaTags, useOptionalNoyaTools, useOptionalNoyaUserData, useRandomIcons, useRandomImages };
+type GetRowType<TTable extends Table<EntitySchema>> = Static<TTable["schema"]>;
+type GetSelectConfig<TTable extends Table<EntitySchema>> = SelectConfig<GetRowType<TTable>[]>;
+type UseTableOptions = Omit<TableFetchOptions, "autoStart">;
+declare function useTable<TTable extends Table<any>, Config extends GetSelectConfig<TTable>>(table: TTable | null | undefined, { where, select, }: {
+    where?: Partial<Record<string, any>> & {
+        id?: string | null;
+    };
+    select: Config;
+}, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<GetRowType<TTable>, Config>[];
+    refetch: () => void;
+};
+declare function useFileList<Config extends SelectConfig<NoyaAPI.FileListItem>>(select: Config, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<NoyaAPI.FileListItem, Config>[];
+    refetch: RefetchFunction;
+};
+declare function useFileListItem<Config extends SelectConfig<NoyaAPI.FileListItem>>(id: string | undefined, select: Config, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<NoyaAPI.FileListItem, Config> | undefined;
+    refetch: RefetchFunction;
+};
+declare function useResourcesList<Config extends SelectConfig<Resource>>(fileId: string, select: Config, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<Resource, Config>[];
+    refetch: RefetchFunction;
+};
+declare function useUser<Config extends SelectConfig<NoyaAPI.PublicUser>>(id: string | null | undefined, select: Config, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<NoyaAPI.PublicUser, Config> | undefined;
+    refetch: RefetchFunction;
+};
+declare function useActivityEventsList<Config extends SelectConfig<ActivityEvent>>(fileId: string, select: Config, options?: UseTableOptions): {
+    status: NoyaAPI.FetchStatus;
+    data: SelectedShape<ActivityEvent, Config>[];
+    refetch: RefetchFunction;
+};
+
+export { type EnhancedGeneratedPageName, NoyaAPIProvider, useActivityEventsList, useFileList, useFileListItem, useGeneratedComponentDescription, useGeneratedComponentDescriptions, useGeneratedComponentNames, useGeneratedPageComponentNames, useGeneratedPageNames, useIsBeta, useMetadata, useNetworkRequests, useNoyaAssets, useNoyaAssetsByFileVersionId, useNoyaBilling, useNoyaClient, useNoyaClientOrFallback, useNoyaCreators, useNoyaDeployments, useNoyaEmailLists, useNoyaMultiplayerRoomToken, useNoyaOwnedFileVersions, useNoyaPersonalAccessTokens, useNoyaSecrets, useNoyaSession, useNoyaSite, useNoyaSites, useNoyaTags, useNoyaTemplates, useNoyaTools, useNoyaUserData, useNoyaWorkspaceBilling, useNoyaWorkspaceInvitations, useNoyaWorkspaces, useOptionalNoyaClient, useOptionalNoyaCreators, useOptionalNoyaSession, useOptionalNoyaTags, useOptionalNoyaTools, useOptionalNoyaUserData, useRandomIcons, useRandomImages, useResourcesList, useTable, useUser };