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

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import { NoyaAPI } from '@noya-app/noya-api';
 export * from '@noya-app/noya-api';
+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>;
@@ -16,17 +19,17 @@ declare function useNoyaTools(initial?: NoyaAPI.Tool[]): {
     tools: {
         addedById?: string | undefined;
         id: string;
-        description: string | null;
         name: string;
+        createdAt: string;
         url: string;
+        description: string | null;
+        updatedAt: string;
         tags: {
             toolCount?: number | undefined;
             id: string;
             name: string;
             rank: number;
         }[];
-        createdAt: string;
-        updatedAt: string;
         assets: string[];
         slug: string | null;
         tagline: string | null;
@@ -46,17 +49,17 @@ declare function useOptionalNoyaTools(initial?: NoyaAPI.Tool[]): {
     tools: {
         addedById?: string | undefined;
         id: string;
-        description: string | null;
         name: string;
+        createdAt: string;
         url: string;
+        description: string | null;
+        updatedAt: string;
         tags: {
             toolCount?: number | undefined;
             id: string;
             name: string;
             rank: number;
         }[];
-        createdAt: string;
-        updatedAt: string;
         assets: string[];
         slug: string | null;
         tagline: string | null;
@@ -110,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;
     }[];
@@ -130,8 +150,8 @@ declare function useNoyaSession(): {
     user: {
         id: string;
         name: string | null;
-        image: string | null;
         email: string | null;
+        image: string | null;
     };
     expires: string;
 } | null;
@@ -139,15 +159,14 @@ declare function useOptionalNoyaSession(): {
     user: {
         id: string;
         name: string | null;
-        image: string | null;
         email: string | null;
+        image: string | null;
     };
     expires: string;
 } | null | undefined;
 declare function useNoyaBilling(): {
     subscriptions: {
         id: string;
-        status: string;
         items: {
             id: string;
             created: string;
@@ -165,6 +184,7 @@ declare function useNoyaBilling(): {
             };
             quantity: number;
         }[];
+        status: string;
         currency: string;
         created: string;
         cancelAtPeriodEnd: boolean;
@@ -179,9 +199,9 @@ declare function useNoyaBilling(): {
     portalUrl: string | null;
     availableProducts: {
         id: string;
+        name: string;
         description: string | null;
         active: boolean;
-        name: string;
         created: string;
         prices: {
             type: string;
@@ -208,9 +228,9 @@ declare function useNoyaWorkspaceBilling(workspaceId: string): {
 declare function useNoyaEmailLists(): {
     emailLists: {
         id: string;
-        description: string | null;
         name: string;
         url: string;
+        description: string | null;
         optIn: boolean;
     }[];
     loading: boolean;
@@ -224,9 +244,9 @@ declare function useNoyaUserData(): {
         }[];
         emailLists: {
             id: string;
-            description: string | null;
             name: string;
             url: string;
+            description: string | null;
             optIn: boolean;
         }[];
         experiments: {};
@@ -243,9 +263,9 @@ declare function useOptionalNoyaUserData(): {
         }[];
         emailLists: {
             id: string;
-            description: string | null;
             name: string;
             url: string;
+            description: string | null;
             optIn: boolean;
         }[];
         experiments: {};
@@ -271,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;
@@ -313,15 +333,24 @@ declare function useGeneratedPageNames(): EnhancedGeneratedPageName[];
 declare function useGeneratedPageComponentNames(): EnhancedGeneratedPageName[];
 declare function useNoyaSites(): {
     sites: {
+        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;
@@ -330,22 +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: {
+        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;
         }[];
     };
 };
@@ -368,17 +407,17 @@ declare function useNoyaWorkspaces(): {
         updatedAt: string;
         members: {
             id: string;
-            role: "OWNER" | "ADMIN" | "MEMBER";
             createdAt: string;
+            workspaceId: string;
+            userId: string;
+            updatedAt: string;
+            role: "OWNER" | "ADMIN" | "MEMBER";
             user: {
                 id: string;
                 name: string | null;
-                image: string | null;
                 email: string | null;
+                image: string | null;
             };
-            updatedAt: string;
-            workspaceId: string;
-            userId: string;
         }[];
     }[];
     loading: boolean;
@@ -389,12 +428,12 @@ declare function useNoyaMultiplayerRoomToken(fileId: string): {
 declare function useNoyaWorkspaceInvitations(workspaceId: string): {
     invitations: {
         id: string;
-        role: "OWNER" | "ADMIN" | "MEMBER";
-        createdAt: string;
         email: string;
-        token: string;
-        updatedAt: string;
+        createdAt: string;
         workspaceId: string;
+        updatedAt: string;
+        role: "OWNER" | "ADMIN" | "MEMBER";
+        token: string;
         invitedById: string;
         acceptedAt: string | null;
         expiresAt: string | null;
@@ -409,35 +448,35 @@ declare function useNoyaOwnedFileVersions(fileId: string): {
 declare function useNoyaTemplates(): {
     templates: {
         id: string;
-        description: string | null;
-        status: "pending" | "approved" | "rejected";
         name: string;
-        createdAt: string;
-        fileId: string | null;
-        updatedAt: string;
-        workspaceId: string;
-        fileVersionId: string;
-        createdByUserId: string;
         fileVersion: {
             data?: any;
             id: string;
-            description: string | null;
-            icon: string | null;
             name: string;
-            version: number;
             createdAt: string;
             fileId: string | null;
+            userId: string;
             toolId: string;
+            description: string | null;
             updatedAt: string;
+            icon: string | null;
+            version: number;
             access: "private" | "read" | "write";
-            userId: string;
             dataCid: string;
             ownedByFileId: string | null;
         };
+        createdAt: string;
+        workspaceId: string;
         workspace: {
             id: string;
             name: string;
         };
+        fileId: string | null;
+        fileVersionId: string;
+        description: string | null;
+        updatedAt: string;
+        status: "pending" | "approved" | "rejected";
+        createdByUserId: string;
         createdByUser: {
             id: string;
             name: string | null;
@@ -447,19 +486,43 @@ declare function useNoyaTemplates(): {
     loading: boolean;
 };
 
-type FileListTableOptions = {
-    policy?: NoyaAPI.FetchPolicy;
-    debug?: boolean;
+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?: FileListTableOptions): {
+declare function useFileList<Config extends SelectConfig<NoyaAPI.FileListItem>>(select: Config, options?: UseTableOptions): {
     status: NoyaAPI.FetchStatus;
     data: SelectedShape<NoyaAPI.FileListItem, Config>[];
-    refetch: () => void;
+    refetch: RefetchFunction;
 };
-declare function useFileListItem<Config extends SelectConfig<NoyaAPI.FileListItem>>(id: string | undefined, select: Config, options?: FileListTableOptions): {
+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: () => void;
+    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, useFileList, useFileListItem, useGeneratedComponentDescription, useGeneratedComponentDescriptions, useGeneratedComponentNames, useGeneratedPageComponentNames, useGeneratedPageNames, useIsBeta, useMetadata, useNetworkRequests, useNoyaAssets, 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 };
+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 };