@eggjs/session 4.0.1 → 5.0.0-beta.15

package/dist/esm/config/config.default.d.ts

@@ -1,206 +0,0 @@
-import z from 'zod';
-export declare const SessionConfig: z.ZodObject<z.objectUtil.extendShape<{
-    key: z.ZodDefault<z.ZodString>;
-    maxAge: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodLiteral<"session">]>>;
-    autoCommit: z.ZodDefault<z.ZodBoolean>;
-    overwrite: z.ZodDefault<z.ZodBoolean>;
-    httpOnly: z.ZodDefault<z.ZodBoolean>;
-    signed: z.ZodDefault<z.ZodBoolean>;
-    rolling: z.ZodDefault<z.ZodBoolean>;
-    renew: z.ZodDefault<z.ZodBoolean>;
-    secure: z.ZodOptional<z.ZodBoolean>;
-    sameSite: z.ZodOptional<z.ZodString>;
-    externalKey: z.ZodOptional<z.ZodObject<{
-        get: z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodString>;
-        set: z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodString], z.ZodUnknown>, z.ZodVoid>;
-    }, "strip", z.ZodTypeAny, {
-        set: (args_0: any, args_1: string, ...args: unknown[]) => void;
-        get: (args_0: any, ...args: unknown[]) => string;
-    }, {
-        set: (args_0: any, args_1: string, ...args: unknown[]) => void;
-        get: (args_0: any, ...args: unknown[]) => string;
-    }>>;
-    store: z.ZodOptional<z.ZodObject<{
-        get: z.ZodFunction<z.ZodTuple<[z.ZodString, z.ZodNumber, z.ZodObject<{
-            rolling: z.ZodBoolean;
-            ctx: z.ZodAny;
-        }, "strip", z.ZodTypeAny, {
-            rolling: boolean;
-            ctx?: any;
-        }, {
-            rolling: boolean;
-            ctx?: any;
-        }>], z.ZodUnknown>, z.ZodPromise<z.ZodAny>>;
-        set: z.ZodFunction<z.ZodTuple<[z.ZodString, z.ZodAny, z.ZodNumber, z.ZodObject<{
-            rolling: z.ZodBoolean;
-            changed: z.ZodBoolean;
-            ctx: z.ZodAny;
-        }, "strip", z.ZodTypeAny, {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }, {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }>], z.ZodUnknown>, z.ZodPromise<z.ZodVoid>>;
-        destroy: z.ZodFunction<z.ZodTuple<[z.ZodString, z.ZodObject<{
-            ctx: z.ZodAny;
-        }, "strip", z.ZodTypeAny, {
-            ctx?: any;
-        }, {
-            ctx?: any;
-        }>], z.ZodUnknown>, z.ZodPromise<z.ZodVoid>>;
-    }, "strip", z.ZodTypeAny, {
-        set: (args_0: string, args_1: any, args_2: number, args_3: {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-        get: (args_0: string, args_1: number, args_2: {
-            rolling: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<any>;
-        destroy: (args_0: string, args_1: {
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-    }, {
-        set: (args_0: string, args_1: any, args_2: number, args_3: {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-        get: (args_0: string, args_1: number, args_2: {
-            rolling: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<any>;
-        destroy: (args_0: string, args_1: {
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-    }>>;
-    ContextStore: z.ZodOptional<z.ZodAny>;
-    encode: z.ZodDefault<z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodString>>>;
-    decode: z.ZodDefault<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodAny>>;
-    genid: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodString>>;
-    prefix: z.ZodOptional<z.ZodString>;
-    valid: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodAny>>;
-    beforeSave: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodVoid>>;
-}, {
-    logValue: z.ZodDefault<z.ZodBoolean>;
-}>, "strip", z.ZodTypeAny, {
-    logValue: boolean;
-    key: string;
-    autoCommit: boolean;
-    overwrite: boolean;
-    httpOnly: boolean;
-    signed: boolean;
-    rolling: boolean;
-    renew: boolean;
-    encode: (args_0: any, ...args: unknown[]) => string;
-    decode: (args_0: string, ...args: unknown[]) => any;
-    maxAge?: number | "session" | undefined;
-    secure?: boolean | undefined;
-    sameSite?: string | undefined;
-    externalKey?: {
-        set: (args_0: any, args_1: string, ...args: unknown[]) => void;
-        get: (args_0: any, ...args: unknown[]) => string;
-    } | undefined;
-    store?: {
-        set: (args_0: string, args_1: any, args_2: number, args_3: {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-        get: (args_0: string, args_1: number, args_2: {
-            rolling: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<any>;
-        destroy: (args_0: string, args_1: {
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-    } | undefined;
-    ContextStore?: any;
-    genid?: ((args_0: any, ...args: unknown[]) => string) | undefined;
-    prefix?: string | undefined;
-    valid?: ((args_0: any, args_1: any, ...args: unknown[]) => any) | undefined;
-    beforeSave?: ((args_0: any, args_1: any, ...args: unknown[]) => void) | undefined;
-}, {
-    logValue?: boolean | undefined;
-    key?: string | undefined;
-    maxAge?: number | "session" | undefined;
-    autoCommit?: boolean | undefined;
-    overwrite?: boolean | undefined;
-    httpOnly?: boolean | undefined;
-    signed?: boolean | undefined;
-    rolling?: boolean | undefined;
-    renew?: boolean | undefined;
-    secure?: boolean | undefined;
-    sameSite?: string | undefined;
-    externalKey?: {
-        set: (args_0: any, args_1: string, ...args: unknown[]) => void;
-        get: (args_0: any, ...args: unknown[]) => string;
-    } | undefined;
-    store?: {
-        set: (args_0: string, args_1: any, args_2: number, args_3: {
-            rolling: boolean;
-            changed: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-        get: (args_0: string, args_1: number, args_2: {
-            rolling: boolean;
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<any>;
-        destroy: (args_0: string, args_1: {
-            ctx?: any;
-        }, ...args: unknown[]) => Promise<void>;
-    } | undefined;
-    ContextStore?: any;
-    encode?: ((args_0: any, ...args: unknown[]) => string) | undefined;
-    decode?: ((args_0: string, ...args: unknown[]) => any) | undefined;
-    genid?: ((args_0: any, ...args: unknown[]) => string) | undefined;
-    prefix?: string | undefined;
-    valid?: ((args_0: any, args_1: any, ...args: unknown[]) => any) | undefined;
-    beforeSave?: ((args_0: any, args_1: any, ...args: unknown[]) => void) | undefined;
-}>;
-export type SessionConfig = z.infer<typeof SessionConfig>;
-declare const _default: {
-    session: {
-        logValue: boolean;
-        key: string;
-        autoCommit: boolean;
-        overwrite: boolean;
-        httpOnly: boolean;
-        signed: boolean;
-        rolling: boolean;
-        renew: boolean;
-        encode: (args_0: any, ...args: unknown[]) => string;
-        decode: (args_0: string, ...args: unknown[]) => any;
-        maxAge?: number | "session" | undefined;
-        secure?: boolean | undefined;
-        sameSite?: string | undefined;
-        externalKey?: {
-            set: (args_0: any, args_1: string, ...args: unknown[]) => void;
-            get: (args_0: any, ...args: unknown[]) => string;
-        } | undefined;
-        store?: {
-            set: (args_0: string, args_1: any, args_2: number, args_3: {
-                rolling: boolean;
-                changed: boolean;
-                ctx?: any;
-            }, ...args: unknown[]) => Promise<void>;
-            get: (args_0: string, args_1: number, args_2: {
-                rolling: boolean;
-                ctx?: any;
-            }, ...args: unknown[]) => Promise<any>;
-            destroy: (args_0: string, args_1: {
-                ctx?: any;
-            }, ...args: unknown[]) => Promise<void>;
-        } | undefined;
-        ContextStore?: any;
-        genid?: ((args_0: any, ...args: unknown[]) => string) | undefined;
-        prefix?: string | undefined;
-        valid?: ((args_0: any, args_1: any, ...args: unknown[]) => any) | undefined;
-        beforeSave?: ((args_0: any, args_1: any, ...args: unknown[]) => void) | undefined;
-    };
-};
-export default _default;

package/dist/esm/config/config.default.js

@@ -1,14 +0,0 @@
-import z from 'zod';
-import { SessionOptions } from 'koa-session';
-export const SessionConfig = SessionOptions.extend({
-    logValue: z.boolean().default(true),
-});
-export default {
-    session: SessionConfig.parse({
-        maxAge: 24 * 3600 * 1000, // ms, one day
-        key: 'EGG_SESS',
-        httpOnly: true,
-        encrypt: true,
-    }),
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sQ0FBQyxNQUFNLEtBQUssQ0FBQztBQUNwQixPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRTdDLE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxjQUFjLENBQUMsTUFBTSxDQUFDO0lBQ2pELFFBQVEsRUFBRSxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztDQUNwQyxDQUFDLENBQUM7QUFJSCxlQUFlO0lBQ2IsT0FBTyxFQUFFLGFBQWEsQ0FBQyxLQUFLLENBQUM7UUFDM0IsTUFBTSxFQUFFLEVBQUUsR0FBRyxJQUFJLEdBQUcsSUFBSSxFQUFFLGNBQWM7UUFDeEMsR0FBRyxFQUFFLFVBQVU7UUFDZixRQUFRLEVBQUUsSUFBSTtRQUNkLE9BQU8sRUFBRSxJQUFJO0tBQ2QsQ0FBQztDQUNILENBQUMifQ==

package/dist/esm/index.d.ts

@@ -1,2 +0,0 @@
-import './types.js';
-export * from './config/config.default.js';

package/dist/esm/index.js

@@ -1,3 +0,0 @@
-import './types.js';
-export * from './config/config.default.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUM7QUFFcEIsY0FBYyw0QkFBNEIsQ0FBQyJ9

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/dist/esm/types.d.ts

@@ -1,11 +0,0 @@
-import type { SessionConfig } from './config/config.default.js';
-import type { SessionStoreOrAppSessionStoreClass, SessionStore } from './app/extend/application.js';
-declare module '@eggjs/core' {
-    interface EggAppConfig {
-        session: SessionConfig;
-    }
-    interface EggCore {
-        set sessionStore(store: SessionStoreOrAppSessionStoreClass | null | undefined);
-        get sessionStore(): SessionStore | undefined;
-    }
-}

package/dist/esm/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/package.json

@@ -1,4 +0,0 @@
-{
-  "name": "@eggjs/session",
-  "version": "4.0.1"
-}

package/src/app/extend/application.ts

@@ -1,59 +0,0 @@
-import assert from 'node:assert';
-import { EggCore } from '@eggjs/core';
-import type { SessionConfig } from '../../config/config.default.js';
-
-export type SessionStore = Required<SessionConfig>['store'];
-
-export type SessionStoreOrAppSessionStoreClass = SessionStore | {
-  new(app: Application): SessionStore;
-};
-
-export default class Application extends EggCore {
-  /**
-   * set session external store
-   *
-   * ```js
-   * app.sessionStore = {
-   *   get(key): Promise<unknown>,
-   *   set(key, data): Promise<void>,
-   *   destroy(key): Promise<void>,
-   * };
-   *
-   * app.sessionStore = class SessionStore {
-   *   constructor(app) {
-   *   }
-   *   get(key): Promise<unknown>,
-   *   set(key, data): Promise<void>,
-   *   destroy(key): Promise<void>,
-   * }
-   * ```
-   * @param {Class|Object} store session store class or instance
-   */
-  set sessionStore(store: SessionStoreOrAppSessionStoreClass | null | undefined) {
-    if (this.config.session.store && this.config.env !== 'unittest') {
-      this.coreLogger.warn('[@eggjs/session] sessionStore already exists and will be overwrite');
-    }
-
-    // support this.sessionStore = null to disable external store
-    if (!store) {
-      this.config.session.store = undefined;
-      this.coreLogger.info('[@eggjs/session] sessionStore is disabled');
-      return;
-    }
-
-    if (typeof store === 'function') {
-      store = new store(this);
-    }
-    assert(typeof store.get === 'function', 'store.get must be function');
-    assert(typeof store.set === 'function', 'store.set must be function');
-    assert(typeof store.destroy === 'function', 'store.destroy must be function');
-    this.config.session.store = store;
-  }
-
-  /**
-   * get sessionStore instance
-   */
-  get sessionStore(): SessionStore | undefined {
-    return this.config.session.store;
-  }
-}

package/src/app/middleware/session.ts

@@ -1,3 +0,0 @@
-import { createSession } from 'koa-session';
-
-export default createSession;

package/src/app.ts

@@ -1,30 +0,0 @@
-import type { ILifecycleBoot, EggCore } from '@eggjs/core';
-import { SessionConfig } from './config/config.default.js';
-
-export default class AppBoot implements ILifecycleBoot {
-  private readonly app;
-
-  constructor(app: EggCore) {
-    this.app = app;
-  }
-
-  configWillLoad() {
-    const app = this.app;
-    SessionConfig.parse(app.config.session);
-
-    if (!app.config.session.httpOnly) {
-      app.coreLogger.warn('[@eggjs/session]: please set `config.session.httpOnly` to true. It is very dangerous if session can read by client JavaScript.');
-    }
-    app.config.coreMiddleware.push('session');
-    // listen on session's events
-    app.on('session:missed', ({ ctx, key }) => {
-      ctx.coreLogger.warn('[session][missed] key(%s)', key);
-    });
-    app.on('session:expired', ({ ctx, key, value }) => {
-      ctx.coreLogger.warn('[session][expired] key(%s) value(%j)', key, app.config.session.logValue ? value : '');
-    });
-    app.on('session:invalid', ({ ctx, key, value }) => {
-      ctx.coreLogger.warn('[session][invalid] key(%s) value(%j)', key, app.config.session.logValue ? value : '');
-    });
-  }
-}

package/src/config/config.default.ts

@@ -1,17 +0,0 @@
-import z from 'zod';
-import { SessionOptions } from 'koa-session';
-
-export const SessionConfig = SessionOptions.extend({
-  logValue: z.boolean().default(true),
-});
-
-export type SessionConfig = z.infer<typeof SessionConfig>;
-
-export default {
-  session: SessionConfig.parse({
-    maxAge: 24 * 3600 * 1000, // ms, one day
-    key: 'EGG_SESS',
-    httpOnly: true,
-    encrypt: true,
-  }),
-};

package/src/index.ts

@@ -1,3 +0,0 @@
-import './types.js';
-
-export * from './config/config.default.js';

package/src/types.ts

@@ -1,15 +0,0 @@
-import type { SessionConfig } from './config/config.default.js';
-import type { SessionStoreOrAppSessionStoreClass, SessionStore } from './app/extend/application.js';
-
-declare module '@eggjs/core' {
-  // add EggAppConfig overrides types
-  interface EggAppConfig {
-    session: SessionConfig;
-  }
-
-  interface EggCore {
-    // add EggCore instance property
-    set sessionStore(store: SessionStoreOrAppSessionStoreClass | null | undefined);
-    get sessionStore(): SessionStore | undefined;
-  }
-}

package/src/typings/index.d.ts

@@ -1,4 +0,0 @@
-// make sure to import egg typings and let typescript know about it
-// @see https://github.com/whxaxes/blog/issues/11
-// and https://www.typescriptlang.org/docs/handbook/declaration-merging.html
-import 'egg';