@owlmeans/module 0.1.0

package/build/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAE7D,eAAO,MAAM,MAAM,EAAE,qBAAqB,CAAC,YAAY,CAoFtD,CAAA;AAED,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,UAAU,CAAC,iBAAiB,MAAM,YAAY,MAAM,KAAG,CAcpH,CAAA"}

package/build/module.js

@@ -0,0 +1,79 @@
+import { appendContextual } from '@owlmeans/context';
+export const module = (route, opts) => {
+    let guards = null;
+    let gates = null;
+    const module = appendContextual(route.route.alias, {
+        _module: true,
+        sticky: false,
+        route,
+        getAlias: () => module.route.route.alias,
+        getPath: () => module.route.route.path,
+        getParentAlias: () => module.route.route.parent ?? null,
+        hasParent: () => module.getParentAlias() != null,
+        resolve: async () => {
+            if (module.ctx == null) {
+                throw new SyntaxError(`Module has no context yet - ${module.getAlias()}`);
+            }
+            await module.route.resolve(module.ctx);
+            return module;
+        },
+        getParent: () => {
+            const parent = module.getParentAlias();
+            if (parent == null) {
+                throw new SyntaxError(`Module has no parent - ${module.getAlias()}`);
+            }
+            if (module.ctx == null) {
+                throw new SyntaxError(`Module has no context yet - ${module.getAlias()}`);
+            }
+            return module.ctx.module(parent);
+        },
+        setService: service => {
+            if (module.route.route.resolved) {
+                throw new SyntaxError(`Cannot update a resolved module - ${module.getAlias()}`);
+            }
+            module.route.route.service = service;
+        },
+        getGuards: () => {
+            if (guards != null) {
+                return guards;
+            }
+            guards = module.guards ?? [];
+            if (module.hasParent()) {
+                guards.push(...module.getParent().getGuards().filter(guard => !guards?.includes(guard)));
+            }
+            return guards;
+        },
+        getGates: () => {
+            if (gates != null) {
+                return gates;
+            }
+            gates = module.gate != null ? [[
+                    module.gate, module.gateParams == null
+                        ? [] : Array.isArray(module.gateParams)
+                        ? module.gateParams : [module.gateParams]
+                ]] : [];
+            if (module.hasParent()) {
+                gates.push(...module.getParent().getGates()
+                    .filter(([gate]) => !gates?.some(([g]) => g === gate)));
+            }
+            return gates;
+        },
+        ...opts
+    });
+    return module;
+};
+export const parent = (module, aliasOrParent, _parent) => {
+    if (Array.isArray(module)) {
+        if (_parent == null) {
+            throw SyntaxError('Elevating parent requires parent name to be specified');
+        }
+        module = module.find(module => module.route.route.alias === aliasOrParent);
+        if (module == null) {
+            throw SyntaxError(`Module not found ${aliasOrParent}`);
+        }
+        return parent(module, _parent);
+    }
+    module.route.route.parent = aliasOrParent;
+    return module;
+};
+//# sourceMappingURL=module.js.map

package/build/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAGpD,MAAM,CAAC,MAAM,MAAM,GAAwC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACzE,IAAI,MAAM,GAAoB,IAAI,CAAA;IAClC,IAAI,KAAK,GAAgC,IAAI,CAAA;IAC7C,MAAM,MAAM,GAAiB,gBAAgB,CAAe,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;QAC7E,OAAO,EAAE,IAAI;QAEb,MAAM,EAAE,KAAK;QAEb,KAAK;QAEL,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK;QACxC,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI;QACtC,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI;QACvD,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,IAAI,IAAI;QAEhD,OAAO,EAAE,KAAK,IAA4B,EAAE;YAC1C,IAAI,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,WAAW,CAAC,+BAA+B,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YAC3E,CAAC;YAED,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAEtC,OAAO,MAAW,CAAA;QACpB,CAAC;QAED,SAAS,EAAE,GAAG,EAAE;YACd,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAE,CAAA;YACtC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,WAAW,CAAC,0BAA0B,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YACtE,CAAC;YACD,IAAI,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,WAAW,CAAC,+BAA+B,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YAC3E,CAAC;YAED,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAClC,CAAC;QAED,UAAU,EAAE,OAAO,CAAC,EAAE;YACpB,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,WAAW,CAAC,qCAAqC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;YACjF,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAA;QACtC,CAAC;QAED,SAAS,EAAE,GAAG,EAAE;YACd,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,OAAO,MAAM,CAAA;YACf,CAAC;YACD,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAA;YAE5B,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC5E,CAAA;YACH,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC;QAED,QAAQ,EAAE,GAAG,EAAE;YACb,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,KAAK,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC7B,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,IAAI,IAAI;wBACpC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;wBACrC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;iBAC9C,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAEP,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CACR,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE;qBAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CACzD,CAAA;YACH,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,GAAG,IAAI;KACR,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,CAA0C,MAAS,EAAE,aAAqB,EAAE,OAAgB,EAAK,EAAE;IACvH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,WAAW,CAAC,uDAAuD,CAAC,CAAA;QAC5E,CAAC;QACD,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,aAAa,CAAM,CAAA;QAC/E,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,WAAW,CAAC,oBAAoB,aAAa,EAAE,CAAC,CAAA;QACxD,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAA;IAEzC,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,80 @@
+import type { CommonRouteModel } from '@owlmeans/route';
+import type { InitializedService, LazyService, BasicModule } from '@owlmeans/context';
+import type { AnySchemaObject } from 'ajv';
+import type { ModuleOutcome } from './consts.js';
+import type { Auth } from '@owlmeans/auth';
+export interface CommonModule extends BasicModule {
+    route: CommonRouteModel;
+    /**
+     * @property {boolean} - if true — router attaches this module unconditionaly
+     * @default false
+     */
+    sticky: boolean;
+    filter?: Filter;
+    guards?: string[];
+    gate?: string;
+    gateParams?: string | string[];
+    handle?: ModuleHandler;
+    getAlias: () => string;
+    getPath: () => string;
+    getParentAlias: () => string | null;
+    hasParent: () => boolean;
+    resolve: <M extends CommonModule>() => Promise<M>;
+    getParent: <M extends CommonModule>() => M;
+    setService: (service: string) => void;
+    getGuards: () => string[];
+    getGates: () => [string, string[]][];
+}
+export interface CommonModuleOptions extends Partial<CommonModule> {
+}
+export interface ModuleMatch {
+    <R extends AbstractRequest, P extends AbstractResponse<any>>(req: R, res: P): Promise<boolean>;
+}
+export interface ModuleHandler {
+    <T, R extends AbstractRequest<any> = AbstractRequest<any>, P extends AbstractResponse<any> = AbstractResponse<any>>(req: R, res: P): T | Promise<T>;
+}
+export interface ModuleAssert {
+    <R extends AbstractRequest, P extends AbstractResponse<any>>(req: R, res: P, params: string[]): Promise<void>;
+}
+export interface AbstractRequest<T extends {} = {}> {
+    alias: string;
+    auth?: Auth;
+    params: Record<string, string | number | undefined | null> | Partial<T>;
+    body?: Record<string, any> | Partial<T>;
+    headers: Record<string, string[] | string | undefined>;
+    query: Record<string, string | number | undefined | null> | Partial<T>;
+    path: string;
+    original?: any;
+    canceled?: boolean;
+    cancel?: () => void;
+    host?: string;
+    base?: string | boolean;
+}
+export interface AbstractResponse<T> {
+    responseProvider?: any;
+    value?: T;
+    outcome?: ModuleOutcome;
+    error?: Error;
+    resolve: (value: T, outcome?: ModuleOutcome) => void;
+    reject: (error: Error) => void;
+}
+export interface GuardService extends InitializedService {
+    token?: string;
+    authenticated: (req?: Partial<AbstractRequest>) => Promise<string | null>;
+    match: ModuleMatch;
+    handle: ModuleHandler;
+}
+export interface GateService extends LazyService {
+    /**
+     * @throws {Error}
+     */
+    assert: ModuleAssert;
+}
+export interface Filter {
+    query?: AnySchemaObject;
+    params?: AnySchemaObject;
+    body?: AnySchemaObject;
+    response?: AnySchemaObject;
+    headers?: AnySchemaObject;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACrF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,KAAK,EAAE,gBAAgB,CAAA;IACvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,QAAQ,EAAE,MAAM,MAAM,CAAA;IACtB,OAAO,EAAE,MAAM,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAA;IACnC,SAAS,EAAE,MAAM,OAAO,CAAA;IACxB,OAAO,EAAE,CAAC,CAAC,SAAS,YAAY,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;IACjD,SAAS,EAAE,CAAC,CAAC,SAAS,YAAY,OAAO,CAAC,CAAA;IAC1C,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,SAAS,EAAE,MAAM,MAAM,EAAE,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,mBAAoB,SAAQ,OAAO,CAAC,YAAY,CAAC;CAAI;AAEtE,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/F;AAED,MAAM,WAAW,aAAa;IAC5B,CACE,CAAC,EAAE,CAAC,SAAS,eAAe,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,EACxD,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,EACvD,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9G;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE;IAChD,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACvE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAAC,CAAA;IACtD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACtE,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,gBAAgB,CAAC,EAAE,GAAG,CAAA;IACtB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,IAAI,CAAA;IACpD,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IAEtD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAEzE,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C;;OAEG;IACH,MAAM,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,OAAO,CAAC,EAAE,eAAe,CAAA;CAC1B"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/build/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './module.js';
+//# sourceMappingURL=index.d.ts.map

package/build/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/build/utils/index.js

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './module.js';
+//# sourceMappingURL=index.js.map

package/build/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/build/utils/module.d.ts

@@ -0,0 +1,3 @@
+import { CommonModule } from '../types.js';
+export declare const isModule: (module: Object) => module is CommonModule;
+//# sourceMappingURL=module.d.ts.map

package/build/utils/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/utils/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,eAAO,MAAM,QAAQ,WAAY,MAAM,KAAG,MAAM,IAAI,YAAmC,CAAA"}

package/build/utils/module.js

@@ -0,0 +1,2 @@
+export const isModule = (module) => '_module' in module;
+//# sourceMappingURL=module.js.map

package/build/utils/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/utils/module.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAc,EAA0B,EAAE,CAAC,SAAS,IAAI,MAAM,CAAA"}

package/build/utils/types.d.ts

@@ -0,0 +1,6 @@
+import { CommonRouteModel } from '@owlmeans/route';
+import { CommonModuleOptions } from '../types.js';
+export interface CreateModuleSignature<M> {
+    (route: CommonRouteModel, opts?: CommonModuleOptions): M;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAEjD,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,CAAC,CAAC;CAC1D"}

package/build/utils/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@owlmeans/module",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 186 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    },
+    "./utils": {
+      "default": "./build/utils/index.js",
+      "types": "./build/utils/index.js",
+      "import": "./build/utils/index.js",
+      "require": "./build/utils/index.js",
+      "module": "./build/utils/index.js"
+    }
+  },
+  "dependencies": {
+    "@owlmeans/auth": "^0.1.0",
+    "@owlmeans/context": "^0.1.0",
+    "@owlmeans/route": "^0.1.0",
+    "ajv": "^8.17.1"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "npm-check": "^6.0.1",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,7 @@
+
+export enum ModuleOutcome {
+  Ok = 'ok',
+  Accepted = 'accepted',
+  Created = 'created',
+  Finished = 'finished'
+}

package/src/filter.ts

@@ -0,0 +1,26 @@
+import type { JSONSchemaType } from 'ajv'
+import type { Filter } from './types.js'
+
+export const body = <T>(schema: JSONSchemaType<T>, filter?: Filter): Filter => {
+  return { ...filter, body: schema as any }
+}
+
+export const query = <T>(schema: JSONSchemaType<T>, filter?: Filter): Filter => {
+  return { ...filter, query: schema as any }
+}
+
+export const params = <T>(schema: JSONSchemaType<T>, filter?: Filter): Filter => {
+  return { ...filter, params: schema as any }
+}
+
+export const response = <T>(schema: JSONSchemaType<T>, code?: number, filter?: Filter): Filter => {
+  let _schema: any = schema
+  if (filter?.response != null && code != null) {
+    _schema = { ...filter.response, [code]: schema }
+  }
+  return { ...filter, response: _schema }
+}
+
+export const headers = <T>(schema: JSONSchemaType<T>, filter?: Filter): Filter => {
+  return { ...filter, headers: schema as any }
+}

package/src/helper.ts

@@ -0,0 +1,37 @@
+import { route } from '@owlmeans/route'
+import { Filter, CommonModuleOptions, AbstractResponse, CommonModule } from './types.js'
+import { module } from './module.js'
+
+export const filter = (filter: Filter, opts?: CommonModuleOptions): CommonModuleOptions => ({ filter, ...opts })
+
+export const guard = (guard: string, opts?: CommonModuleOptions): CommonModuleOptions =>
+  ({ ...opts, guards: [...new Set([guard, ...(opts?.guards ?? [])])] })
+
+export const gate = (gate: string, params: string | string[], opts?: CommonModuleOptions): CommonModuleOptions =>
+  ({ ...opts, gate, gateParams: params })
+
+export const provideResponse = <T>(originalResponse?: unknown): AbstractResponse<T> => {
+  const hanlder: AbstractResponse<T> = {
+    responseProvider: originalResponse,
+
+    resolve: (value, outcome) => {
+      hanlder.value = value
+      hanlder.outcome = outcome
+    },
+
+    reject: (error) => {
+      hanlder.error = error
+    }
+  }
+
+  return hanlder
+}
+
+export const clone = <M extends CommonModule>(modules: M[], from: string, to: string, service: string) => {
+  const source = modules.find(m => m.alias === from)
+
+  if (source?.route.route != null) {
+    const _route = { ...source.route.route, service, resolved: false, alias: to }
+    modules.push(module(route(to, _route.path, _route)) as M)
+  }
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+
+export type * from './types.js'
+export * from './module.js'
+export * from './filter.js'
+export * from './helper.js'
+export * from './consts.js'

package/src/module.ts

@@ -0,0 +1,105 @@
+import type { CommonModule } from './types.js'
+import { appendContextual } from '@owlmeans/context'
+import type { CreateModuleSignature } from './utils/types.js'
+
+export const module: CreateModuleSignature<CommonModule> = (route, opts) => {
+  let guards: string[] | null = null
+  let gates: [string, string[]][] | null = null
+  const module: CommonModule = appendContextual<CommonModule>(route.route.alias, {
+    _module: true,
+
+    sticky: false,
+
+    route,
+
+    getAlias: () => module.route.route.alias,
+    getPath: () => module.route.route.path,
+    getParentAlias: () => module.route.route.parent ?? null,
+    hasParent: () => module.getParentAlias() != null,
+
+    resolve: async <M extends CommonModule>() => {
+      if (module.ctx == null) {
+        throw new SyntaxError(`Module has no context yet - ${module.getAlias()}`)
+      }
+
+      await module.route.resolve(module.ctx)
+
+      return module as M
+    },
+
+    getParent: () => {
+      const parent = module.getParentAlias()
+      if (parent == null) {
+        throw new SyntaxError(`Module has no parent - ${module.getAlias()}`)
+      }
+      if (module.ctx == null) {
+        throw new SyntaxError(`Module has no context yet - ${module.getAlias()}`)
+      }
+
+      return module.ctx.module(parent)
+    },
+
+    setService: service => {
+      if (module.route.route.resolved) {
+        throw new SyntaxError(`Cannot update a resolved module - ${module.getAlias()}`)
+      }
+      module.route.route.service = service
+    },
+
+    getGuards: () => {
+      if (guards != null) {
+        return guards
+      }
+      guards = module.guards ?? []
+
+      if (module.hasParent()) {
+        guards.push(
+          ...module.getParent().getGuards().filter(guard => !guards?.includes(guard))
+        )
+      }
+
+      return guards
+    },
+
+    getGates: () => {
+      if (gates != null) {
+        return gates
+      }
+      
+      gates = module.gate != null ? [[
+        module.gate, module.gateParams == null
+          ? [] : Array.isArray(module.gateParams)
+            ? module.gateParams : [module.gateParams]
+      ]] : []
+
+      if (module.hasParent()) {
+        gates.push(
+          ...module.getParent().getGates()
+            .filter(([gate]) => !gates?.some(([g]) => g === gate))
+        )
+      }
+
+      return gates
+    },
+
+    ...opts
+  })
+
+  return module
+}
+
+export const parent = <T extends CommonModule | CommonModule[]>(module: T, aliasOrParent: string, _parent?: string): T => {
+  if (Array.isArray(module)) {
+    if (_parent == null) {
+      throw SyntaxError('Elevating parent requires parent name to be specified')
+    }
+    module = module.find(module => module.route.route.alias === aliasOrParent) as T
+    if (module == null) {
+      throw SyntaxError(`Module not found ${aliasOrParent}`)
+    }
+    return parent(module, _parent)
+  }
+  module.route.route.parent = aliasOrParent
+
+  return module
+}

package/src/types.ts

@@ -0,0 +1,93 @@
+import type { CommonRouteModel } from '@owlmeans/route'
+import type { InitializedService, LazyService, BasicModule } from '@owlmeans/context'
+import type { AnySchemaObject } from 'ajv'
+import type { ModuleOutcome } from './consts.js'
+import type { Auth } from '@owlmeans/auth'
+
+export interface CommonModule extends BasicModule {
+  route: CommonRouteModel
+  /**
+   * @property {boolean} - if true — router attaches this module unconditionaly 
+   * @default false
+   */
+  sticky: boolean
+  filter?: Filter
+  guards?: string[]
+  gate?: string
+  gateParams?: string | string[]
+  handle?: ModuleHandler
+  getAlias: () => string
+  getPath: () => string
+  getParentAlias: () => string | null
+  hasParent: () => boolean
+  resolve: <M extends CommonModule>() => Promise<M>
+  getParent: <M extends CommonModule>() => M
+  setService: (service: string) => void
+  getGuards: () => string[]
+  getGates: () => [string, string[]][]
+}
+
+export interface CommonModuleOptions extends Partial<CommonModule> { }
+
+export interface ModuleMatch {
+  <R extends AbstractRequest, P extends AbstractResponse<any>>(req: R, res: P): Promise<boolean>
+}
+
+export interface ModuleHandler {
+  <
+    T, R extends AbstractRequest<any> = AbstractRequest<any>,
+    P extends AbstractResponse<any> = AbstractResponse<any>,
+  >(req: R, res: P): T | Promise<T>
+}
+
+export interface ModuleAssert {
+  <R extends AbstractRequest, P extends AbstractResponse<any>>(req: R, res: P, params: string[]): Promise<void>
+}
+
+export interface AbstractRequest<T extends {} = {}> {
+  alias: string
+  auth?: Auth
+  params: Record<string, string | number | undefined | null> | Partial<T>
+  body?: Record<string, any> | Partial<T>
+  headers: Record<string, string[] | string | undefined>
+  query: Record<string, string | number | undefined | null> | Partial<T>
+  path: string
+  original?: any
+  canceled?: boolean
+  cancel?: () => void
+  host?: string
+  base?: string | boolean
+}
+
+export interface AbstractResponse<T> {
+  responseProvider?: any
+  value?: T,
+  outcome?: ModuleOutcome
+  error?: Error
+  resolve: (value: T, outcome?: ModuleOutcome) => void
+  reject: (error: Error) => void
+}
+
+export interface GuardService extends InitializedService {
+  // Client guard
+  token?: string
+  authenticated: (req?: Partial<AbstractRequest>) => Promise<string | null>
+  // Server guard
+  match: ModuleMatch
+  handle: ModuleHandler
+}
+
+export interface GateService extends LazyService {
+  /**
+   * @throws {Error}
+   */
+  assert: ModuleAssert
+}
+
+export interface Filter {
+  query?: AnySchemaObject
+  params?: AnySchemaObject
+  body?: AnySchemaObject
+  response?: AnySchemaObject
+  headers?: AnySchemaObject
+}

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+
+export * from './types.js'
+export * from './module.js'

package/src/utils/module.ts

@@ -0,0 +1,3 @@
+import { CommonModule } from '../types.js'
+
+export const isModule = (module: Object): module is CommonModule => '_module' in module

package/src/utils/types.ts

@@ -0,0 +1,6 @@
+import { CommonRouteModel } from '@owlmeans/route'
+import { CommonModuleOptions } from '../types.js'
+
+export interface CreateModuleSignature<M> { 
+  (route: CommonRouteModel, opts?: CommonModuleOptions): M,
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "../tsconfig.default.json",
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+    "moduleResolution": "Bundler"
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/consts.ts","./src/filter.ts","./src/helper.ts","./src/index.ts","./src/module.ts","./src/types.ts","./src/utils/index.ts","./src/utils/module.ts","./src/utils/types.ts"],"version":"5.6.3"}