@datawheel/bespoke 0.9.3 → 1.0.0-beta.1

package/dist/server.d.mts

@@ -0,0 +1,109 @@
+import { Session, NextAuthOptions, AuthOptions } from 'next-auth';
+import * as next from 'next';
+import { NextApiRequest, NextApiResponse, NextApiHandler, GetServerSidePropsContext, GetStaticPathsResult, GetStaticPaths, GetStaticProps, GetServerSideProps } from 'next';
+import { e as BespokeAuthOptions } from './auth-D3PWImeZ.mjs';
+import { h as AppStore } from './store-D5N14riO.mjs';
+export { i as dbApiFactory, u as useDatabaseApi } from './store-D5N14riO.mjs';
+import * as querystring from 'querystring';
+export { v as ReportsDB } from './types-WI9fSG9b.mjs';
+import 'next-auth/react';
+import 'next/app';
+import 'next-redux-wrapper';
+import '@reduxjs/toolkit';
+import 'immer';
+import 'sequelize';
+
+/**
+ * Returns the instance connection to the DB.
+ * This connection is shared through all items in the running server.
+ * The function must run synchronously, so async startup operations are set to
+ * run without `await`ing or monitoring the result.
+ */
+declare const getDB: () => Promise<any>;
+
+type BespokeSession = Session & {
+    source: string;
+};
+declare function getBespokeServerSession(req: NextApiRequest, res: NextApiResponse, authOptions?: BespokeAuthOptions): Promise<BespokeSession>;
+
+declare const handleAuth: (authOptions?: {
+    providers: any[];
+}) => any;
+
+/**
+ *
+ * @param req Next req
+ * @param res Next res
+ * @param settings
+ * @returns
+ */
+declare const updateCurrentUserAppMetadata: (req: NextApiRequest, res: NextApiResponse, authOptions: BespokeAuthOptions, newMetadata: {
+    [key: string]: string;
+}) => Promise<{
+    [key: string]: string;
+}>;
+
+/**
+ *
+ * @param req Next req
+ * @param res Next res
+ * @param settings
+ * @returns
+ */
+declare const updateCurrentUserMetadata: (req: NextApiRequest, res: NextApiResponse, authOptions: BespokeAuthOptions, newMetadata: {
+    [key: string]: string;
+}) => Promise<{
+    [key: string]: string;
+}>;
+
+declare const withApiRoleAuthRequired: (apiRoute: NextApiHandler, allowedRoles: string[], authOptions: NextAuthOptions) => NextApiHandler<any>;
+
+declare const searchUsersByMetadata: (authOptions: BespokeAuthOptions, key: string, value: string) => Promise<any>;
+
+declare function endpointKey(method: string, path: string): string;
+declare function endpointNextJsHandlerFactory(authOptions: NextAuthOptions): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+
+declare const reportsCrosswalkEntrypointFn: (crosswalk: any) => (_req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+
+declare function BespokeManagerServerSideProps(options?: {
+    preResolve?: (store: AppStore, ctx: GetServerSidePropsContext) => Promise<any>;
+    postResolve?: (store: AppStore, ctx: GetServerSidePropsContext) => Promise<any>;
+    /**
+     * The variable name set in the current filename for Dynamic Routes.
+     * @see {@link https://nextjs.org/docs/routing/dynamic-routes#catch-all-routes}
+     */
+    pathSegmentsKey?: string;
+    authOptions: AuthOptions;
+}): next.GetServerSideProps<any, querystring.ParsedUrlQuery, next.PreviewData>;
+
+declare function BespokeRendererStaticPaths(options?: {
+    /**
+     * Enable nextjs getStaticPaths fallback.
+     * Setting this to `false` will disable any other page not found at compile time.
+     * @see {@link https://nextjs.org/docs/api-reference/data-fetching/get-static-paths#fallback-false}
+     * @default true
+     */
+    fallback?: GetStaticPathsResult["fallback"];
+    /**
+     * The max amount of high ranking pages to pre-render PER Variant
+     * @default 50
+     */
+    limit?: number;
+}): GetStaticPaths;
+declare function BespokeRendererStaticProps(options?: {
+    /**
+     * The variable name set in the current filename for Dynamic Routes.
+     * @see {@link https://nextjs.org/docs/routing/dynamic-routes#catch-all-routes}
+     */
+    pathSegmentsKey?: string;
+}): GetStaticProps;
+
+declare function BespokeEmbedServerSideProps(options?: {
+    /**
+     * The variable name set in the current filename for Dynamic Routes.
+     * @see {@link https://nextjs.org/docs/routing/dynamic-routes#catch-all-routes}
+     */
+    pathSegmentsKey?: string;
+}): GetServerSideProps;
+
+export { BespokeEmbedServerSideProps, endpointNextJsHandlerFactory as BespokeEndpointNextJsHandlerFactory, getBespokeServerSession as BespokeGetSession, handleAuth as BespokeHandleAuth, BespokeManagerServerSideProps, BespokeRendererStaticPaths, BespokeRendererStaticProps, searchUsersByMetadata as BespokeSearchUsersByMetadata, updateCurrentUserAppMetadata as BespokeUpdateCurrentUserAppMetadata, updateCurrentUserMetadata as BespokeUpdateCurrentUserMetadata, withApiRoleAuthRequired as BespokeWithApiRoleAuthRequired, reportsCrosswalkEntrypointFn as ReportCrosswalkHandler, endpointKey, getDB };