lemon-core 4.2.7 → 4.3.0

package/README.md

@@ -69,6 +69,7 @@ See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)
 
 | Version   | Description
 |--         |--
+| 4.3.0     | embed cores template layer as extended/cores
 | 4.2.6     | optimized `$protocol.execute()` to support async lambda invocation.
 | 4.2.5     | optimized `isBase64Encoded` to support apigwBinary. (from `4.1.17`)
 | 4.2.4     | optimized `doReportError` to ignore in local dev. (from `4.1.16`)

package/dist/extended/cores/abstract-controllers.d.ts

@@ -0,0 +1,170 @@
+import { GeneralWEBController } from '../../controllers/';
+import { CoreModel, AbstractTransformer, View, Body, NextContext, NextHandler, SimpleSet } from 'lemon-model';
+import { BulkBody, ListResult, PaginatedListResult, PaginateParam } from './types';
+import { MyCoreManager, MyCoreService, MyCoreProxy } from './abstract-services';
+export { CoreModel, AbstractTransformer, GeneralWEBController };
+/**
+ * type: `CRUDCreationOptions`
+ * - options for cunstructor.
+ */
+interface CRUDCreationOptions {
+    /**
+     * (optional) flag to use `identity-token` (known as session) in CRUD
+     * - initialize this as `true` if required to use `identity-token`
+     *
+     * @see proxy.getCurrentSession()
+     */
+    useSession?: boolean;
+    /**
+     * (optional) flag to use `throwable` in `getCurrentSession()`
+     * - default might be `true`
+     *
+     * @see proxy.makeModelBase()
+     */
+    throwable?: boolean;
+}
+/**
+ * class: `AbstractCRUDController`
+ * - abstract high level class not to create directly.
+ */
+export declare abstract class AbstractCRUDController<ModelType extends string, MyModel extends CoreModel<ModelType>, MyView extends View, MyBody extends Body, MyService extends MyCoreService<MyModel, any, MyCoreProxy<any, any>>, MyManager extends MyCoreManager<MyModel, any, MyCoreService<MyModel, any, any>>, MyTransformer extends AbstractTransformer<MyModel, MyView, MyBody>> extends GeneralWEBController {
+    /**
+     * service instances
+     */
+    protected readonly service: MyService;
+    /**
+     * namespace for log(print)
+     */
+    protected readonly logNS: string;
+    /**
+     * my model manager
+     */
+    protected readonly manager: MyManager;
+    /**
+     * transformer between model and view.
+     */
+    protected readonly transformer: MyTransformer;
+    /** options in creation */
+    protected readonly options?: CRUDCreationOptions;
+    /**
+     * public constructor
+     *
+     * @param type - api controller's type name (ex: tests for `/tests`)
+     * @param service - backend service
+     * @param manager - my model manager in backend-service
+     * @param transformer - GeneralCRUDWEBControllerOptions
+     */
+    constructor(type: string, service: MyService, manager: MyManager, transformer: MyTransformer, options?: CRUDCreationOptions);
+    /**
+     * get the manager's type (= model-type)
+     */
+    get modelType(): any;
+    /**
+     * get config of using session.
+     */
+    get confUseSession(): boolean;
+    /**
+     * get config of using session.
+     */
+    get confThrowable(): boolean;
+    /**
+     * model transformer from model to view
+     */
+    modelAsView(model: MyModel, options?: {
+        useOnlyDefined?: boolean;
+        hasCores?: boolean;
+    }): MyView;
+    /**
+     * model transformer from body to body
+     */
+    bodyToModel(body: MyBody, isCreate?: boolean): MyModel;
+    /**
+     * from `identity-token`, make base of model { sid, uid }
+     * @param proxy the current proxy.
+     * @returns base model
+     */
+    protected makeModelBase(proxy: MyCoreProxy<ModelType, any>, options?: {
+        /** use this parent to prepare base-model. (hiher than session) */
+        parent?: CoreModel;
+        /** flag to use session (default as confUseSession) */
+        useSession?: boolean;
+        /** flag to throw error (default true) */
+        throwable?: boolean;
+    }): Promise<MyModel>;
+    /** load yml as model list */
+    loadMockData<T extends object>(name: string, base?: string): Promise<T[]>;
+    /**
+     * load mock-model from `.yml` file.
+     */
+    loadFromFile(file: string): Promise<MyModel & {
+        list: any[];
+    }>;
+    /**
+     * say hello
+     */
+    hello: () => string;
+    /**
+     * GET /<typeName>
+     * - list types
+     *
+     * ```sh
+     * $ http ':8888/<typeName>'
+     */
+    doList: NextHandler<PaginateParam & SimpleSet, PaginatedListResult<MyView>>;
+    /**
+     * list types by id
+     * - id means the search(query) id to use.
+     *
+     * ```sh
+     * $ http ':8888/<typeName>/<id>/list'
+     */
+    doGetList: NextHandler<PaginateParam & SimpleSet, PaginatedListResult<MyView>>;
+    /**
+     * internal admin command
+     */
+    doGetAdmin: NextHandler;
+    /**
+     * read a `MyModel`
+     *
+     * ```sh
+     * $ http ':8888/<typeName>/1'
+     */
+    doGet: NextHandler<any, MyView>;
+    /**
+     * create(or insert) a `MyModel`
+     * - `id` must be empty (or '0')
+     *
+     * ```sh
+     * $ http POST ':8888/<typeName>/0' "key"="modelValue"
+     */
+    doPost(id: string, param: any, body: MyBody, $ctx?: NextContext): Promise<MyView>;
+    /**
+     * create(or insert) multi `MyModel`
+     * - `id` must be empty (or '0')
+     *
+     * ```sh
+     * $ http POST ':8888/<typeName>/0/bulk' "key"="modelValue"
+     */
+    doPostBulk: NextHandler<any, MyView[], BulkBody<MyBody> | MyBody[]>;
+    /**
+     * update a `MyModel`
+     *
+     * ```sh
+     * $ http PUT ':8888/<typeName>/1000002' name="test-update"
+     */
+    doPut: NextHandler<any, MyView, MyBody>;
+    /**
+     * bulk update a `TypeModel`
+     *
+     * ```sh
+     * $ http PUT ':8888/types/0/bulk'
+     */
+    doPutBulk: NextHandler<any, ListResult<MyView>, BulkBody<MyBody> | MyBody[]>;
+    /**
+     * delete a `MyModel`
+     *
+     * ```sh
+     * $ http DELETE ':8888/<typeName>/1000003'
+     */
+    doDelete: NextHandler<any, MyView>;
+}