@nixxie-cms/core 1.0.0

package/dist/declarations/src/types/config/index.d.ts

@@ -0,0 +1,283 @@
+import type { Server } from 'node:http';
+import type { ListenOptions } from 'node:net';
+import type { ApolloServerOptions } from '@apollo/server';
+import type { Options as BodyParserOptions } from 'body-parser';
+import type { CorsOptions } from 'cors';
+import type express from 'express';
+import type { GraphQLSchema } from 'graphql';
+import type { BaseNixxieTypeInfo, DatabaseProvider, NixxieAuditService, NixxieCacheService, NixxieContext, NixxieEmailService, NixxieHealthService, NixxieJobsService, NixxieRateLimitService, NixxieWebhooksService } from "../index.js";
+import type { SessionStrategy } from "../session.js";
+import type { MaybePromise } from "../utils.js";
+import type { FieldAccessControl, ListAccessControl } from "./access-control.js";
+import type { BaseFields } from "./fields.js";
+import type { FieldHooks, ListHooks } from "./hooks.js";
+import type { IdFieldConfig, ListConfig, MaybeItemFunctionWithFilter, MaybeSessionFunction } from "./lists.js";
+export type * from "./access-control.js";
+export type * from "./fields.js";
+export type * from "./lists.js";
+type PrismaLogLevel = 'info' | 'query' | 'warn' | 'error';
+type PrismaLogDefinition = {
+    level: PrismaLogLevel;
+    emit: 'stdout' | 'event';
+};
+export type NixxieConfigPre<TypeInfo extends BaseNixxieTypeInfo = BaseNixxieTypeInfo> = {
+    types?: {
+        path: string;
+    };
+    db: {
+        provider: DatabaseProvider;
+        url: string;
+        shadowDatabaseUrl?: string;
+        onConnect?: (args: NixxieContext<TypeInfo>) => Promise<void>;
+        enableLogging?: boolean | Array<PrismaLogLevel | PrismaLogDefinition>;
+        idField?: IdFieldConfig;
+        prismaClientPath?: string;
+        prismaSchemaPath?: string;
+        extendPrismaSchema?: (schema: string) => string;
+        extendPrismaClient?: (client: any) => any;
+    };
+    graphql?: {
+        path?: string;
+        cors?: CorsOptions;
+        bodyParser?: BodyParserOptions;
+        /**
+         * - `true` - Add `ApolloServerPluginLandingPageGraphQLPlayground` to the Apollo Server plugins
+         * - `false` - Add `ApolloServerPluginLandingPageDisabled` to the Apollo Server plugins
+         * - `'apollo'` - Do not add any plugins to the Apollo config, this will use [Apollo Sandbox](https://www.apollographql.com/docs/apollo-server/testing/build-run-queries/#apollo-sandbox)
+         * @default process.env.NODE_ENV !== 'production'
+         */
+        playground?: boolean | 'apollo';
+        /**
+         *  Additional options to pass into the ApolloServer constructor.
+         *  @see https://www.apollographql.com/docs/apollo-server/api/apollo-server/#constructor
+         */
+        apolloConfig?: Partial<ApolloServerOptions<NixxieContext<TypeInfo>>>;
+        /**
+         * When an error is returned from the GraphQL API, Apollo can include a stacktrace
+         * indicating where the error occurred. When Nixxie is processing mutations, it
+         * will sometimes captures more than one error at a time, and then group these into
+         * a single error returned from the GraphQL API. Each of these errors will include
+         * a stacktrace.
+         *
+         * In general both categories of stacktrace are useful for debugging while developing,
+         * but should not be exposed in production, and this is the default behaviour of Nixxie.
+         *
+         * You can use the `debug` option to change this behaviour. A use case for this
+         * would be if you need to send the stacktraces to a log, but do not want to return them
+         * from the API. In this case you could set `debug: true` and use
+         * `apolloConfig.formatError` to log the stacktraces and then strip them out before
+         * returning the error.
+         *
+         * ```ts
+         * graphql: {
+         *   debug: true,
+         *   apolloConfig: {
+         *     formatError: err => {
+         *       console.error(err)
+         *       delete err.extensions?.errors
+         *       delete err.extensions?.exception?.errors
+         *       delete err.extensions?.exception?.stacktrace
+         *       return err
+         *     },
+         *   },
+         * }
+         * ```
+         *
+         * @default process.env.NODE_ENV !== 'production'
+         */
+        debug?: boolean;
+        /**
+         * The path to GraphQL schema
+         * @default 'schema.graphql'
+         */
+        schemaPath?: string;
+        /**
+         * A function that receives the Nixxie GraphQL schema for the developer to extend
+         * @default 'schema.graphql'
+         */
+        extendGraphqlSchema?: (schema: GraphQLSchema) => GraphQLSchema;
+    };
+    lists: Record<string, ListConfig<any>>;
+    server?: {
+        /** Configuration options for the cors middleware. Set to `true` to use Nixxie's defaults */
+        cors?: boolean | CorsOptions;
+        /** Maximum upload file size allowed (in bytes) */
+        maxFileSize?: number;
+        /** extend the Express application used by Nixxie */
+        extendExpressApp?: (app: express.Express, context: NixxieContext<TypeInfo>) => MaybePromise<void>;
+        /** extend the node:http server used by Nixxie */
+        extendHttpServer?: (server: Server, context: NixxieContext<TypeInfo>) => MaybePromise<void>;
+    } & ({
+        /** Port number to start the server on. Defaults to process.env.PORT || 3000 */
+        port?: number;
+    } | {
+        /** node http.Server options */
+        options?: ListenOptions;
+    });
+    session?: SessionStrategy<TypeInfo['session'], TypeInfo>;
+    /**
+     * Email service instance created with `createEmail()` from `@nixxie-cms/email`.
+     * Once configured, it is available everywhere as `context.services.email`.
+     *
+     * @example
+     * ```ts
+     * import { createEmail } from '@nixxie-cms/email'
+     * export default config({
+     *   email: createEmail({ transport: { type: 'resend', apiKey: process.env.RESEND_API_KEY! }, from: 'app@example.com' }),
+     * })
+     * ```
+     */
+    email?: NixxieEmailService;
+    /**
+     * Background job scheduler created with `createJobs()` from `@nixxie-cms/jobs`.
+     * Available as `context.services.jobs`. Supports cron expressions and interval-based scheduling.
+     *
+     * @example
+     * ```ts
+     * import { createJobs } from '@nixxie-cms/jobs'
+     * export default config({
+     *   jobs: createJobs({
+     *     jobs: [{ name: 'cleanup', schedule: '0 3 * * *', handler: async () => { ... } }],
+     *   }),
+     * })
+     * ```
+     */
+    jobs?: NixxieJobsService;
+    /**
+     * Cache service created with `createCache()` from `@nixxie-cms/cache`.
+     * Available as `context.services.cache`. Supports in-memory (LRU) and Redis backends.
+     *
+     * @example
+     * ```ts
+     * import { createCache } from '@nixxie-cms/cache'
+     * export default config({
+     *   cache: createCache({ store: 'memory', max: 500, ttl: 60_000 }),
+     * })
+     * ```
+     */
+    cache?: NixxieCacheService;
+    /**
+     * Audit log service created with `createAudit()` from `@nixxie-cms/audit`.
+     * Available as `context.services.audit`. Records who did what and when.
+     *
+     * @example
+     * ```ts
+     * import { createAudit } from '@nixxie-cms/audit'
+     * export default config({
+     *   audit: createAudit({ store: 'memory', maxEntries: 10_000 }),
+     * })
+     * ```
+     */
+    audit?: NixxieAuditService;
+    /**
+     * Outbound webhook service created with `createWebhooks()` from `@nixxie-cms/webhooks`.
+     * Available as `context.services.webhooks`. Manages subscriptions and reliable delivery with retry.
+     *
+     * @example
+     * ```ts
+     * import { createWebhooks } from '@nixxie-cms/webhooks'
+     * export default config({
+     *   webhooks: createWebhooks({ retries: 3, timeout: 10_000 }),
+     * })
+     * ```
+     */
+    webhooks?: NixxieWebhooksService;
+    /**
+     * Rate limiting service created with `createRateLimit()` from `@nixxie-cms/rate-limit`.
+     * Available as `context.services.rateLimit`. Sliding-window counters backed by memory or Redis.
+     *
+     * @example
+     * ```ts
+     * import { createRateLimit } from '@nixxie-cms/rate-limit'
+     * export default config({
+     *   rateLimit: createRateLimit({ store: 'memory' }),
+     * })
+     * ```
+     */
+    rateLimit?: NixxieRateLimitService;
+    /**
+     * Health-check service created with `createHealth()` from `@nixxie-cms/health`.
+     * Available as `context.services.health`. Auto-exposes `/health/live` and `/health/ready`
+     * when mounted via `extendExpressApp`.
+     *
+     * @example
+     * ```ts
+     * import { createHealth } from '@nixxie-cms/health'
+     * export default config({
+     *   health: createHealth(),
+     *   server: {
+     *     extendExpressApp: async (app, context) => {
+     *       context.services.health.register('db', async () => {
+     *         await context.prisma.$queryRaw`SELECT 1`
+     *         return { ok: true }
+     *       })
+     *       app.use('/health', context.services.health.router())
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    health?: NixxieHealthService;
+    /** Telemetry boolean to disable telemetry for this project */
+    telemetry?: boolean;
+    ui?: {
+        /** Completely disables the Admin UI */
+        isDisabled?: boolean;
+        /** A function that can be run to validate that the current session should have access to the Admin UI */
+        isAccessAllowed?: (context: NixxieContext<TypeInfo>) => MaybePromise<boolean>;
+        /** An array of page routes that bypass the isAccessAllowed function */
+        publicPages?: readonly string[];
+        /** The Base Path for Nixxies Admin UI */
+        basePath?: string;
+        getAdditionalFiles?: () => MaybePromise<readonly AdminFileToWrite[]>;
+        /** An async middleware function that can optionally return a redirect */
+        pageMiddleware?: (args: {
+            context: NixxieContext<TypeInfo>;
+            wasAccessAllowed: boolean;
+            basePath: string;
+        }) => MaybePromise<{
+            kind: 'redirect';
+            to: string;
+        } | void>;
+    };
+};
+export type NixxieConfig<TypeInfo extends BaseNixxieTypeInfo = BaseNixxieTypeInfo> = {
+    types: NixxieConfigPre<TypeInfo>['types'];
+    db: Omit<Required<NixxieConfigPre<TypeInfo>['db']>, 'enableLogging'> & {
+        enableLogging: PrismaLogLevel | Array<PrismaLogLevel | PrismaLogDefinition>;
+    };
+    graphql: NonNullable<NixxieConfigPre<TypeInfo>['graphql']> & {
+        path: string;
+    };
+    lists: {
+        [listKey: string]: {
+            listKey: string;
+        } & Required<NixxieConfigPre<TypeInfo>['lists'][string]>;
+    };
+    server: Omit<Required<NonNullable<NixxieConfigPre<TypeInfo>['server']>>, 'cors' | 'port'> & {
+        cors: CorsOptions | null;
+        options: ListenOptions;
+    };
+    session: NixxieConfigPre<TypeInfo>['session'];
+    email: NixxieEmailService | undefined;
+    jobs: NixxieJobsService | undefined;
+    cache: NixxieCacheService | undefined;
+    audit: NixxieAuditService | undefined;
+    webhooks: NixxieWebhooksService | undefined;
+    rateLimit: NixxieRateLimitService | undefined;
+    health: NixxieHealthService | undefined;
+    telemetry: boolean;
+    ui: NonNullable<Required<NixxieConfigPre<TypeInfo>['ui']>>;
+};
+export type { BaseFields, ListConfig, MaybeItemFunctionWithFilter, MaybeSessionFunction };
+export type AdminFileToWrite = {
+    mode: 'write';
+    src: string;
+    outputPath: string;
+} | {
+    mode: 'copy';
+    inputPath: string;
+    outputPath: string;
+};
+export type { FieldAccessControl, FieldHooks, ListAccessControl, ListHooks };
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/types/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../../../src/types/config","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAE7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,MAAM,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,KAAK,EACV,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACtB,oBAAU;AACX,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAgB;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,4BAAwB;AAC7E,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAgB;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,mBAAe;AACpD,OAAO,KAAK,EACV,aAAa,EACb,UAAU,EACV,2BAA2B,EAC3B,oBAAoB,EACrB,mBAAe;AAEhB,yCAAqC;AACrC,iCAA6B;AAC7B,gCAA4B;AAG5B,KAAK,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;AACzD,KAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,cAAc,CAAA;IACrB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,IAAI;IACtF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IAED,EAAE,EAAE;QACF,QAAQ,EAAE,gBAAgB,CAAA;QAC1B,GAAG,EAAE,MAAM,CAAA;QAEX,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QAC5D,aAAa,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC,cAAc,GAAG,mBAAmB,CAAC,CAAA;QACrE,OAAO,CAAC,EAAE,aAAa,CAAA;QACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;QAEzB,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAA;QAC/C,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAA;KAC1C,CAAA;IAED,OAAO,CAAC,EAAE;QAER,IAAI,CAAC,EAAE,MAAM,CAAA;QAGb,IAAI,CAAC,EAAE,WAAW,CAAA;QAClB,UAAU,CAAC,EAAE,iBAAiB,CAAA;QAC9B;;;;;WAKG;QACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;QAC/B;;;WAGG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QACpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACH,KAAK,CAAC,EAAE,OAAO,CAAA;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAA;QAEnB;;;WAGG;QACH,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,aAAa,CAAA;KAC/D,CAAA;IAED,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IACtC,MAAM,CAAC,EAAE;QACP,4FAA4F;QAC5F,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;QAE5B,kDAAkD;QAClD,WAAW,CAAC,EAAE,MAAM,CAAA;QAEpB,oDAAoD;QACpD,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,OAAO,CAAC,OAAO,EACpB,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,KAC7B,YAAY,CAAC,IAAI,CAAC,CAAA;QAEvB,iDAAiD;QACjD,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAA;KAC5F,GAAG,CACA;QACE,+EAA+E;QAC/E,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,GACD;QACE,+BAA+B;QAC/B,OAAO,CAAC,EAAE,aAAa,CAAA;KACxB,CACJ,CAAA;IAED,OAAO,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAA;IAExD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAE1B;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAE1B;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAE1B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAEhC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAE5B,8DAA8D;IAC9D,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB,EAAE,CAAC,EAAE;QACH,uCAAuC;QACvC,UAAU,CAAC,EAAE,OAAO,CAAA;QAEpB,yGAAyG;QACzG,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;QAE7E,uEAAuE;QACvE,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;QAE/B,yCAAyC;QACzC,QAAQ,CAAC,EAAE,MAAM,CAAA;QAEjB,kBAAkB,CAAC,EAAE,MAAM,YAAY,CAAC,SAAS,gBAAgB,EAAE,CAAC,CAAA;QAEpE,yEAAyE;QACzE,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE;YACtB,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;YAChC,gBAAgB,EAAE,OAAO,CAAA;YACzB,QAAQ,EAAE,MAAM,CAAA;SACjB,KAAK,YAAY,CAAC;YAAE,IAAI,EAAE,UAAU,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC,CAAA;KAC5D,CAAA;CACF,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,IAAI;IACnF,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAA;IACzC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,CAAC,GAAG;QACrE,aAAa,EAAE,cAAc,GAAG,KAAK,CAAC,cAAc,GAAG,mBAAmB,CAAC,CAAA;KAC5E,CAAA;IACD,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG;QAC3D,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,KAAK,EAAE;QACL,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,OAAO,EAAE,MAAM,CAAA;SAChB,GAAG,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;KACzD,CAAA;IACD,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG;QAC1F,IAAI,EAAE,WAAW,GAAG,IAAI,CAAA;QACxB,OAAO,EAAE,aAAa,CAAA;KACvB,CAAA;IACD,OAAO,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAA;IAC7C,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACrC,IAAI,EAAE,iBAAiB,GAAG,SAAS,CAAA;IACnC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACrC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACrC,QAAQ,EAAE,qBAAqB,GAAG,SAAS,CAAA;IAC3C,SAAS,EAAE,sBAAsB,GAAG,SAAS,CAAA;IAC7C,MAAM,EAAE,mBAAmB,GAAG,SAAS,CAAA;IACvC,SAAS,EAAE,OAAO,CAAA;IAClB,EAAE,EAAE,WAAW,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;CAC3D,CAAA;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,CAAA;AAEzF,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAA"}